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

package RPS::Report::Dynamic::Transactions::LicenseBase;

use strict;
use warnings;

use lib '/app/tools/common/lib';
use lib '/app/tools/rps/lib';
use lib '/app/tools/report/lib';
use Common::Client;

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

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

    my $cols = [];


    # There will be some _slight_ differences (one column, actually) between the CA and US versions
    # of this report.  So I'm going to split the columns into different sections.
    #
    $self->_albumTrackCols($cols);
    $self->_licenseCols($cols);
    $self->_transactionCols($cols);

    return $cols;
}

sub _albumTrackCols
{   
    my ($self, $cols) = @_;

    push @$cols, 
    {
        header => {
            name => 'album-title',
        },
        column => {
            field => 'album_title',
        }
    },
    {
        header => {
            name => 'album-title-version',
        },
        column => {
            field => 'album_title_version',
        }
    },
    {
        header => {
            name => 'catalog-no',
        },
        column => {
            field => 'catalog_no',
        }
    },
    {
        header => {
            name => 'album-artist',
        },
        column => {
            field => 'album_artist',
        }
    },
    {
        header => {
            name => 'label-name',
        },
        column => {
            field => 'label_name',
        }
    },
    {
        header => {
            name => 'track-title',
        },
        column => {
            field => 'track_title',
        }
    },
    {
        header => {
            name => 'track-number',
        },
        column => {
            field => 'track_number',
        }
    },
    {
        header => {
            name => 'track-artist',
        },
        column => {
            field => 'track_artist',
        }
    },
    {
        header => {
            name => 'isrc',
        },
        column => {
            field => 'isrc',
        }
    };
}


sub _licenseCols
{   
    my ($self, $cols) = @_;

    push @$cols, 
    {
        header => {
            name => 'license-type',
        },
        column => {
            field => 'license_type',
            method => '_licenseTypeToString',
        }
    },
    {
        header => {
            name => 'product-type',
        },
        column => {
            field => 'product_type',
            method => '_productTypeIDToString',
        }
    },
    {
        header => {
            name => 'region',
        },
        column => {
            field => 'region',
        }
    },
    {
        header => {
            name => 'share',
        },
        column => {
            field => 'share',
        }
    },
    {
        header => {
            name => 'publisher',
        },
        column => {
            field => 'publisher',
        }
    },
    {
        header => {
            name => 'rs-publisher-id',
        },
        column => {
            field => 'publisher_id',
        }
    },
    {
        header => {
            name => 'client-account-no',
        },
        column => {
            field => 'client_account_no',
        }
    },
    {
        header => {
            name => 'admin',
        },
        column => {
            field => 'admin',
        }
    },
    {
        header => {
            name => 'agent',
        },
        column => {
            field => 'agent',
        }
    },
    {
        header => {
            name => 'publisher-direct',
        },
        column => {
            field => 'publisher_direct',
        }
    },
    {
        header => {
            name => 'crossed',
        },
        column => {
            field => 'crossed',
        }
    },
    {
        header => {
            name => 'status',
        },
        column => {
            field => 'status',
        }
    },
    {
        header => {
            name => 'issuer-licence-id',
        },
        column => {
            field => 'issuer_license_id',
        }
    };
}

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

    my $outString = 'All Products';
    my $typeID = $rowItem->$fieldName();

    return '' if ($typeID eq 'magic');

    # I don't think I want 'All' for the crossed transactions.
    # So I guess I need some magic value to change into a blank...
    #
    if ($typeID)
    {
        # If we haven't cached all the product type ids yet, do that now.
        #
        if (! $gProductTypeIDCache)
        {
            $gProductTypeIDCache = {};
            my $allTypes = RPS::DB::Item::ProductType->GetAll();
            while (my $type = $allTypes->next())
            {
                $gProductTypeIDCache->{ $type->product_type_id() } = $type->description();
            }
            $gProductTypeIDCache->{255} = 'All Physical';
            $gProductTypeIDCache->{254} = 'All Digital';
        }
        $outString = $gProductTypeIDCache->{$typeID};
    }

    return $outString;
}



1;