#------------------------------------------------------------
# Copyright (C) 2006 RoyaltyShare, Inc.   All Rights Reserved
# $Id$
#------------------------------------------------------------
package RPS::LabelRoyalty::LabelRoyaltyRun;

use strict;
use warnings;
use Carp;
use Data::Dumper;

use lib '/app/tools/common/lib';
use Common::Assert;
use Common::Log;

use lib '/app/tools/rps/lib';
use RPS::Statement::Label::StatementList;
use RPS::DB::Item::LabelRoyaltyRun;
use RPS::Statement::Label::PDF;
use RPS::RoyaltyRun::RoyaltyRunStatusList;

use Common::FormObject;
use base 'Common::FormObject';

# !!! Convert this to a plain-ole XMLObject.
# !!! It will never appear in an editable form.
#
# JPK - Great idea, except... we need to update the XMLObject to
# support the recursive dereferencing syntax FormObject provides.
# Which is the ability to do this:
# my $value = $form->Album->Artist->Name();
# or this
# $form->Album->Artist->Name($foo)
#
# This is because we are now relying on this syntax in a few places,
# notably the PDF generation scripts...

sub _init {
    my ( $self, %args ) = @_;

    $self->SUPER::_init(%args);

    $self->{_filterBy} = $args{filterBy};
    $self->{_page}     = $args{page};
    $self->{_pageSize} = $args{pageSize};

    my %properties;
    if ( $args{_dbItem} ) {
        $self->_propertiesFromDBItem( \%properties, $args{_dbItem} );
    } elsif ( $args{labelRoyaltyRunID} ) {
        $self->_propertiesFromDB( \%properties, $args{labelRoyaltyRunID} );
    } else {
        $self->_propertiesFromDefaults( \%properties );
    }

    $self->_initProperties( \%properties );
    $self->_initSubs( \%properties );

    return $self;
}

sub _propertiesFromDB {
    my ( $self, $hrProperties, $id ) = @_;

    my $dbItem = RPS::DB::Item::LabelRoyaltyRun->Lookup( label_royalty_run_id => $id );
    return $self->_propertiesFromDBItem( $hrProperties, $dbItem );
}

sub _propertiesFromDBItem {
    my ( $self, $hrProperties, $dbItem ) = @_;

    $hrProperties->{label_royalty_run_id} = $dbItem->label_royalty_run_id;
    $hrProperties->{ending_sale_date}     = $dbItem->ending_sale_date;
    $hrProperties->{label}                = $dbItem->label;
    $hrProperties->{start_time}           = $dbItem->start_time;
    $hrProperties->{end_time}             = $dbItem->end_time;
    $hrProperties->{status}               = $dbItem->status;
    $hrProperties->{pid}                  = $dbItem->pid;
    $hrProperties->{payor_id}             = $dbItem->payor_id;
    $hrProperties->{job_id}               = $dbItem->job_id;
    $hrProperties->{hostname}             = $dbItem->hostname;
    $hrProperties->{created_by}           = $dbItem->created_by;
}

sub _initProperties {
    my ( $self, $props ) = @_;
    my $timer = Common::Timer->new();

    $self->{LabelRoyaltyRunID} = Common::FormObject::Scalar->new( value => $props->{label_royalty_run_id}, readOnly => 1 );
    $self->{EndingSaleDate} = Common::FormObject::Scalar::Date->new( value => $props->{ending_sale_date}, readOnly => 1 );
    $self->{Label} = Common::FormObject::Scalar::String->new( value => $props->{label}, readOnly => 1 );
    $self->{StartTime} = Common::FormObject::Scalar::DateTime->new( value => $props->{start_time}, readOnly => 1 );
    $self->{EndTime}   = Common::FormObject::Scalar::DateTime->new( value => $props->{end_time},   readOnly => 1 );
    $self->{Status}  = Common::FormObject::Scalar->new( value => $props->{status},   readOnly => 1 );
    $self->{PID}     = Common::FormObject::Scalar->new( value => $props->{pid},      readOnly => 1 );
    $self->{PayorID} = Common::FormObject::Scalar->new( value => $props->{payor_id}, readOnly => 1 );
    $self->{JobID}   = Common::FormObject::Scalar->new( value => $props->{job_id},   readOnly => 1 );
    $self->{Hostname} = Common::FormObject::Scalar::String->new( value => $props->{hostname}, readOnly => 1 );
    $self->{CreatedBy} = Common::FormObject::Scalar::UserName->new( value => $props->{created_by}, readOnly => 1 );

    # we need to know the number of statements. we load the statement list in loadSubs,
    # but in the case when loadSubs==0, we still need that info. let's get it here, but
    # we don't want to perform this query twice, so only do it if loadSubs==0. -jff-
    #
    if ( !$self->loadSubs() ) {
        my $numStatements = 0;
        my $coll          = RPS::DB::Item::LabelRoyaltyStatement->GetByLabelRoyaltyRunID( $props->{label_royalty_run_id} );
        if ($coll) {
            $numStatements = $coll->size();
        }
        $self->{NumberOfStatements} = Common::FormObject::Scalar::Integer->new( value => $numStatements, readOnly => 1 );
    }

    # Determine whether we can download the zip file.
    # Basically, if the directory is there, and there's at least
    # 1 file in it, then they can download it.
    #
    my $canDownloadFlag;

    if ( $props->{label_royalty_run_id} ) {
        my $downloadDir = RPS::Statement::Label::PDF::StatementPathFromRunID( $props->{label_royalty_run_id} );

        #my $downloadDir = '/app/data/royalty_statements/label/'.Common::RSApp::GetClientID().'/'.$props->{label_royalty_run_id};
        if ( -d $downloadDir ) {

            # JPK - Over-anxious customers are downloading the files while they are still being regenerated
            # after a commit.   We need to use a semaphore instead.
            #
            if ( -f "$downloadDir/COMPLETE" ) {
                $canDownloadFlag = 1;
            }

        }
    }

    $self->{CanDownload} = $canDownloadFlag;
    $self->{RoyaltyRunStatus} = RPS::RoyaltyRun::RoyaltyRunStatusList->new( label => 1, payorID => $self->PayorID );
}

sub _initSubs {
    my ( $self, $props ) = @_;

    if ( $self->loadSubs() ) {

        # Load the list of statement lines.
        #
        $self->{LabelRoyaltyStatementList} = RPS::Statement::Label::StatementList->new(
            labelRoyaltyRunID => $props->{label_royalty_run_id},
            payorID           => $self->PayorID(),
            filterBy          => $self->{_filterBy},
            page              => $self->{_page},
            pageSize          => $self->{_pageSize},
        );
    }

    return $self;
}

sub _propertiesFromDefaults {
    my ( $self, $hrProperties ) = @_;
}

###
1;    #
###