#---------------------------------------------------------------
# ____                   _ _         ____  _
#|  _ \ ___  _   _  __ _| | |_ _   _/ ___|| |__   __ _ _ __ ___
#| |_) / _ \| | | |/ _` | | __| | | \___ \| '_ \ / _` | '__/ _ \
#|  _ < (_) | |_| | (_| | | |_| |_| |___) | | | | (_| | | |  __/
#|_| \_\___/ \__, |\__,_|_|\__|\__, |____/|_| |_|\__,_|_|  \___|
#            |___/             |___/
#
# Copyright (C) 2011 RoyaltyShare, Inc.   All Rights Reserved
#---------------------------------------------------------------

package RPS::Report::Dynamic::Payee::Artist;

use strict;
use warnings;

use lib '/app/tools/common/lib';
use lib '/app/tools/rps/lib';
use RPS::DB::Item::ArtistPayee;
use RPS::DB::Item::ClientOptions;
use RPS::DB::Item::DynamicReport::Payee::Artist;
use Common::Client;

use base 'RPS::Report::Dynamic::Payee::Base';

sub Type           { 'Artist & Producer' }
sub FilenameType   { 'Artist Payees' }
sub ClientTypeMask { return Common::Client::kArtist; }

# defined at the end of this file
#
sub _ParamClass { 'RPS::Report::Dynamic::Payee::Artist::Parameters'; }

sub _columns {
    my ($self) = @_;

    my $cols = [];
    my $showAbacusData = RPS::DB::Item::ClientOptions->Get('show_abacus_data');

    push( @$cols, $self->_getNameColumnHash( 'payee',             'payee' ) );
    push( @$cols, $self->_getNameColumnHash( 'client-account-no', 'client_account_no' ) );
    if ($showAbacusData) {
        push( @$cols, $self->_getNameColumnHash( 'account-id-(abacus)',  'abacus_account_id' ) );
        push( @$cols, $self->_getNameColumnHash( 'contract-id-(abacus)', 'abacus_contract_id' ) );
    }
    push( @$cols, $self->_getNameColumnHash( 'status',            'status' ) );
    push( @$cols, $self->_getNameColumnHash( 'address-1',         'address_1' ) );
    push( @$cols, $self->_getNameColumnHash( 'address-2',         'address_2' ) );
    push( @$cols, $self->_getNameColumnHash( 'address-3',         'address_3' ) );
    push( @$cols, $self->_getNameColumnHash( 'city',              'city' ) );
    push( @$cols, $self->_getNameColumnHash( 'state-province',    'state' ) );
    push( @$cols, $self->_getNameColumnHash( 'zip-postal',        'postal_code' ) );
    push( @$cols, $self->_getNameColumnHash( 'country',           'country' ) );
    push( @$cols, $self->_getNameColumnHash( 'email',             'email' ) );
    push( @$cols, $self->_getNameColumnHash( 'phone',             'phone' ) );
    push( @$cols, $self->_getNameColumnHash( 'fax',               'fax' ) );
    push( @$cols, $self->_getNameColumnHash( 'tax-id',            'tax_id' ) );
    push( @$cols, $self->_getNameColumnHash( 'comments',          'comments' ) );

    push @$cols,
      {
        header => {
            name => 'payee-statement-distribution',
        },
        column => {
            field  => 'distribution',
            method => '_distributionIdToName',
        }
      };

    push( @$cols, $self->_getNameColumnHash( 'payee-statement-distribution-status', 'distribution_status' ) );

    push @$cols,
      {
        header => {
            name => 'payee-date-created',
        },
        column => {
            field  => 'date_created',
            method => '_formatDate',
            excel  => 'date:Y-M-D',
        }
      };
    push @$cols,
      {
        header => {
            name => 'payee-created-by',
        },
        column => {
            field  => 'created_by',
            method => '_userIDToUserName',
        }
      };
    push @$cols,
      {
        header => {
            name => 'payee-date-modified',
        },
        column => {
            field  => 'date_modified',
            method => '_formatDate',
            excel  => 'date:Y-M-D',
        }
      };
    push @$cols,
      {
        header => {
            name => 'payee-modified-by',
        },
        column => {
            field  => 'modified_by',
            method => '_userIDToUserName',
        }
      };
    push( @$cols, $self->_getNameColumnHash( 'rs-payee-id', 'artist_payee_id' ) );

    my $reportType = $self->parameters()->{OptionalData}->ReportType() || '';
    if ( $reportType =~ /^PayeesAndRecipients$/i ) {
        push( @$cols, $self->_getNameColumnHash( 'additional-statement-recipient', 'recipient_name' ) );
        push( @$cols, $self->_getNameColumnHash( 'additional-statement-recipient-email', 'recipient_email' ) );
        push( @$cols, $self->_getNameColumnHash( 'additional-statement-recipient-distribution-status', 'recipient_distribution_status' ) );
        push( @$cols, $self->_getNameColumnHash( 'rs-additional-statement-recipient-id', 'recipient_id' ) );
    }

    return $cols;
}

sub _getCollection {
    my $self = shift;

    my $dateType;
    my $dateTypeParam = $self->parameters()->{Criteria}->DateType();
    if ($dateTypeParam) {
        if ( 'Date Created' eq $dateTypeParam ) {
            $dateType = 'date_created';
        } elsif ( 'Date Modified' eq $dateTypeParam ) {
            $dateType = 'date_modified';
        }
    }

    return RPS::DB::Item::DynamicReport::Payee::Artist->ReportQuery(
        dateType   => $dateType,
        startDate  => $self->parameters()->{Criteria}->StartDate(),
        endDate    => $self->parameters()->{Criteria}->EndDate(),
        reportType => $self->parameters()->{OptionalData}->ReportType(),
        showAbacusData => RPS::DB::Item::ClientOptions->Get('show_abacus_data'),
        #        showProcessed => $self->_showProcessed(),
        #        showUnprocessed => $self->_showUnprocessed(),
    );
}

sub _distributionIdToName {
    my ( $self, %args ) = @_;
    my $rowItem   = $args{row};
    my $fieldName = $args{field};

    my $dist = $rowItem->$fieldName();
    my $distName;
    if ( $dist == RPS::DB::Item::ArtistPayee::kStatementDistributionManual ) {
        $distName = "Manual";
    } elsif ( $dist == RPS::DB::Item::ArtistPayee::kStatementDistributionOnline ) {
        $distName = "Online through Payee Portal";
    }

    return $distName;
}

1;

package RPS::Report::Dynamic::Payee::Artist::Parameters;
use strict;
use warnings;

use lib '/app/tools/common/lib';
use lib '/app/tools/report/lib';
use lib '/app/tools/rps/lib';
use base 'RPS::Report::Dynamic::Payee::Parameters';

sub _OptionalData {
    {
        'ReportType' => {
            type          => Report::Dynamic::Parameters::kTypeRadioGroup,
            order         => 1,
            validValues   => [ 'Payees', 'PayeesAndRecipients' ],
            displayValues => [ 'Payees', 'Payees & Additional Statement Recipients' ],

            #            display => 'Options',
            value => 'Payees',                                 # This sets the _default_ value.
            filename => [ 'wPayees', 'wPayeesAndRecipients' ],
        },
    };
}

1;