package WebGUI::Asset::File::Image::Photo;

=head1 LEGAL

 -------------------------------------------------------------------
  WebGUI is Copyright 2001-2007 Plain Black Corporation.
 -------------------------------------------------------------------
  Please read the legal notices (docs/legal.txt) and the license
  (docs/license.txt) that came with this distribution before using
  this software.
 -------------------------------------------------------------------
  http://www.plainblack.com                     info@plainblack.com
 -------------------------------------------------------------------

=cut

use strict;
use Tie::IxHash;
use Carp qw( croak );
use base 'WebGUI::Asset::File::Image';
use WebGUI::Utility;


=head1 NAME

WebGUI::Asset::File::Image::Photo

=head1 DESCRIPTION


=head1 SYNOPSIS

use WebGUI::Asset::File::Image::Photo


=head1 METHODS

These methods are available from this class:

=cut

#-------------------------------------------------------------------

=head2 definition ( session, definition )

Define the properties of the Photo asset.

=head3 session

=head3 definition

A hash reference passed in from a subclass definition.

=cut

sub definition {
    my $class       = shift;
    my $session     = shift;
    my $definition  = shift;
    my $i18n        = __PACKAGE__->i18n($session);

    tie my %properties, 'Tie::IxHash', (
        friendsOnly => {
            defaultValue        => 0,
        },
        rating  => {
            defaultValue        => 0,
        },
        storageIdPhoto  => {
            defaultValue        => undef,
        },
    );

    # UserDefined Fields
    for my $i (1 .. 5) {
        $properties{"userDefined".$i} = {
            defaultValue        => undef,
        };
    }

    push @{$definition}, {
        assetName   => $i18n->get('assetName'),
        icon        => 'Image.gif',
        tableName   => 'Photo',
        className   => 'WebGUI::Asset::File::Image::Photo',
        i18n        => 'Asset_Photo',
        properties  => \%properties,
    };
    return $class->SUPER::definition($session, $definition);
}

#----------------------------------------------------------------------------

=head2 appendTemplateVarsForCommentForm ( vars ) 

Add the template variables necessary for the comment form to the given hash
reference. Returns the hash reference for convenience.

=cut

sub appendTemplateVarsForCommentForm {
    my $self        = shift;
    my $vars        = shift;

    # ...

    return $vars;
}

#----------------------------------------------------------------------------

=head2 applyConstraints ( )

Apply the constraints to the original file. Called automatically by C<setFile>
and C<processPropertiesFromFormPost>.

=cut

sub applyConstraints {
    my $self        = shift;
    my $gallery     = $self->getGallery;

    # ...
}

#----------------------------------------------------------------------------

=head2 canEdit ( [userId] )

Returns true if the user can edit this asset. C<userId> is a WebGUI user ID. 
If no userId is passed, check the current user.

Users can edit this Photo if they are the owner or if they are able to edit
the parent Album asset.

=cut

sub canEdit {
    my $self        = shift;
    my $userId      = shift || $self->session->user->userId;
    my $album       = $self->getParent;

    return 1 if $userId eq $self->get("ownerUserId");
    return $album->canEdit($userId);
}

#----------------------------------------------------------------------------

=head2 canView ( [userId] )

Returns true if the user can view this asset. C<userId> is a WebGUI user ID.
If no user is passed, checks the current user.

=cut

# Inherited from superclass

#----------------------------------------------------------------------------

=head2 deleteComment ( commentId )

Delete a comment from this asset. C<id> is the ID of the comment to delete.

=cut

sub deleteComment {
    my $self        = shift;
    my $commentId   = shift;
    
    croak "Photo->deleteComment: No commentId specified."
        unless $commentId;

    return $self->session->db->do(
        "DELETE FROM Photo_comment WHERE assetId=? AND commentId=?",
        [$self->getId, $commentId],
    );
}

#----------------------------------------------------------------------------

=head2 getComment ( commentId )

Get a comment from this asset. C<id> is the ID of the comment to get. Returns
a hash reference of comment information.

=cut

sub getComment {
    my $self        = shift;
    my $commentId   = shift;
    
    return $self->session->db->quickHashRef(
        "SELECT * FROM Photo_comment WHERE assetId=? AND commentId=?",
        [$self->getId, $commentId],
    );
}

#----------------------------------------------------------------------------

=head2 getCommentIds ( )

Get an array reference of comment IDs for this Photo, in chronological order.

=cut

sub getCommentIds {
    my $self        = shift;
    
    return [ 
        $self->session->db->buildArray(
            "SELECT commentId FROM Photo_comment WHERE assetId=?",
            [$self->getId],
        ) 
    ];
}

#----------------------------------------------------------------------------

=head2 getCommentPaginator ( ) 

Get a WebGUI::Paginator for the comments for this Photo.

=cut

sub getCommentPaginator {
    my $self        = shift;
    
    # ...

}

#----------------------------------------------------------------------------

=head2 getDownloadFileUrl ( resolution )

Get the absolute URL to download the requested resolution. Will croak if the
resolution doesn't exist.

=cut

sub getDownloadFileUrl {
    my $self        = shift;
    my $resolution  = shift;

    croak "Photo->getDownloadFileUrl: resolution must be defined"
        unless $resolution;
    croak "Photo->getDownloadFileUrl: resolution doesn't exist for this Photo"
        unless grep /$resolution/, @{ $self->getResolutions };

    # ...
}

#----------------------------------------------------------------------------

=head2 getGallery ( )

Gets the Gallery asset this Photo is a member of. 

=cut

sub getGallery {
    my $self        = shift;
    my $gallery     = $self->getParent->getParent;
    return $gallery if $gallery->isa("WebGUI::Asset::Wobject::Gallery");
    return undef;
}

#----------------------------------------------------------------------------

=head2 getResolutions ( )

Get an array reference of download resolutions that exist for this image. 
Does not include the web view image or the thumbnail image.

=cut

sub getResolutions {
    my $self        = shift;
    my $storage     = $self->getStorageLocation;

    # ...
}

#----------------------------------------------------------------------------

=head2 getTemplateVars ( )

Get a hash reference of template variables shared by all views of this asset.

=cut

sub getTemplateVars {
    my $self        = shift;
    my $vars        = $self->get;

    # ...

    return $vars;
}

#----------------------------------------------------------------------------

=head2 i18n ( [ session ] )

Get a WebGUI::International object for this class. 

Can be called as a class method, in which case a WebGUI::Session object
must be passed in.

NOTE: This method can NOT be inherited, due to a current limitation 
in the i18n system. You must ALWAYS call this with C<__PACKAGE__>

=cut

sub i18n {
    my $self    = shift;
    my $session = shift;
    
    return WebGUI::International->new($session, "Asset_Photo");
}

#----------------------------------------------------------------------------

=head2 makeResolutions ( [resolutions] )

Create the specified resolutions for this Photo. If resolutions is not 
defined, will get the resolutions to make from the Gallery this Photo is 
contained in.

=cut

sub makeResolutions {
    my $self        = shift;
    my $resolutions = shift;

    croak "Photo->makeResolutions: resolutions must be an array reference"
        if $resolutions && ref $resolutions ne "ARRAY";
    
    # Get default if necessary
    $resolutions    ||= $self->getGallery->getImageResolutions;

    for my $res ( @$resolutions ) {
        # carp if resolution is bad
        # ...
    }
}

#----------------------------------------------------------------------------

=head2 makeShortcut ( parentId [, overrides ] )

Make a shortcut to this asset under the specified parent, optionally adding 
the specified overrides.

=cut

sub makeShortcut {
    my $self        = shift;
    my $parentId    = shift;
    my $overrides   = shift;
    my $session     = $self->session;

    croak "Photo->makeShortcut: parentId must be defined"
        unless $parentId;
    croak "Photo->makeShortcut: overrides must be hash reference"
        if $overrides && ref $overrides ne "HASH";

    my $parent      = WebGUI::Asset->newByDynamicClass($session, $parentId)
                    || croak "Photo->makeShortcut: Could not instanciate asset '$parentId'";

    # ...

}

#----------------------------------------------------------------------------

=head2 processPropertiesFromFormPost ( )

Used to process properties from the form posted.  Do custom things with
noFormPost fields here, or do whatever you want.  This method is called
when /yourAssetUrl?func=editSave is requested/posted.

=cut

sub processPropertiesFromFormPost {
    my $self    = shift;
    my $errors  = $self->SUPER::processPropertiesFromFormPost || [];
    
     
}

#----------------------------------------------------------------------------

=head2 setComment ( commentId, properties )

Set a comment. If C<commentId> is C<"new">, create a new comment. C<properties>
is a hash reference of comment information.

=cut

sub setComment {
    my $self        = shift;
    my $commentId   = shift;
    my $properties  = shift;

    croak "Photo->setComment: commentId must be defined"
        unless $commentId;
    croak "Photo->setComment: properties must be a hash reference"
        unless $properties && ref $properties eq "HASH";

    # ...
}

#----------------------------------------------------------------------------

=head2 view ( )

method called by the container www_view method. 

=cut

sub view {
    my $self    = shift;
    my $session = $self->session;
    my $var     = $self->getTemplateVars;
    $var->{ controls    } = $self->getToolbar;
    $var->{ fileUrl     } = $self->getFileUrl;
    $var->{ fileIcon    } = $self->getFileIconUrl;


    return $self->processTemplate($var,undef, $self->{_viewTemplate});
}


#----------------------------------------------------------------------------

=head2 www_addCommentSave ( )

Save a new comment to the Photo.

=cut

sub www_addCommentSave {
    my $self        = shift;
    my $form        = $self->session;
    
    # ...
}

#----------------------------------------------------------------------------

=head2 www_delete ( )

Show the page to confirm the deletion of this Photo. Show a list of albums
this Photo exists in.

=cut

sub www_delete {
    my $self        = shift;
    
    # ...
}

#----------------------------------------------------------------------------

=head2 www_deleteConfirm ( )

Confirm the deletion of this Photo. Show a message and a link back to the
album.

=cut

sub www_deleteConfirm {
    my $self        = shift;
    
    # ...
}

#----------------------------------------------------------------------------

=head2 www_download

Download the Photo with the specified resolution. If no resolution specified,
download the original file.

=cut

sub www_download {
    my $self        = shift;

# ...
}

#----------------------------------------------------------------------------

=head2 www_edit ( )

Web facing method which is the default edit page

This page is only available to those who can edit this Photo.

=cut

sub www_edit {
    my $self    = shift;
    return $self->session->privilege->insufficient  unless $self->canEdit;
    return $self->session->privilege->locked        unless $self->canEditIfLocked;

    # Prepare the template variables
    my $var     = $self->getTemplateVars;
    
    $var->{ form_header } = WebGUI::Form::formHeader( $session );
    $var->{ form_footer } = WebGUI::Form::formFooter( $session );

    $var->{ form_title  }
        = WebGUI::Form::Text( $session, {
            name        => "title",
            value       => ( $form->get("title") || $self->get("title") ),
        });

    $var->{ form_synopsis }
        = WebGUI::Form::HTMLArea( $session, {
            name        => "synopsis",
            value       => ( $form->get("synopsis") || $self->get("synopsis") ),
            richEditId  => $self->getGallery->get("assetIdRichEditFile"),
        });

    $var->{ form_storageIdPhoto }
        = WebGUI::Form::Image( $session, {
            name        => "storageIdPhoto",
            value       => ( $form->get("storageIdPhoto") || $self->get("storageIdPhoto") ),
            maxAttachments  => 1,
        });
    
    $var->{ form_keywords }
        = WebGUI::Form::Text( $session, {
            name        => "keywords",
            value       => ( $form->get("keywords") || $self->get("keywords") ),
        });

    $var->{ form_location }
        = WebGUI::Form::Text( $session, {
            name        => "location",
            value       => ( $form->get("location") || $self->get("location") ),
        });

    $var->{ form_friendsOnly }
        = WebGUI::Form::yesNo( $session, {
            name            => "friendsOnly",
            value           => ( $form->get("friendsOnly") || $self->get("friendsOnly") ),
            defaultValue    => undef,
        });
}

#----------------------------------------------------------------------------

=head2 www_makeShortcut ( )

Display the form to make a shortcut.

This page is only available to those who can edit this Photo.

=cut

sub www_makeShortcut {
    my $self        = shift;
    
    return $self->session->privilege->insufficient  unless $self->canEdit;

    # ...

}

#----------------------------------------------------------------------------

=head2 www_makeShortcutSave ( )

Make the shortcut.

This page is only available to those who can edit this Photo.

=cut

sub www_makeShortcutSave {
    my $self        = shift;
    my $form        = $self->session->form;

    return $self->session->privilege->insufficient unless $self->canEdit;

#...
}

1;