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

use strict;
use warnings;

use lib '/app/tools/common/lib';
use Common::Assert;
use Common::Util;
use Common::RSApp;
use Common::DB::Item::Client;

use lib '/app/tools/rps/lib';
use RPS::DB::Item::LabelRoyaltyRun;
use RPS::DB::Item::LabelRoyaltyStatement;
use RPS::DB::Item::LabelPayee;

use RPS::Config;


sub _BasePath
{
    my ($class) = @_;

    my $config = RPS::Config->new();
    my $path = $config->get('label_royalty_statement_dir');
    return $path;
#    return '/app/data/royalty_statements/mechanical';
}


sub StatementFileNameFromID
{
    my ($id) = @_;
    assert($id);

    my $statement = RPS::DB::Item::LabelRoyaltyStatement->Lookup(label_royalty_statement_id => $id);
    return StatementFilePathFromDBItem($statement);
}


sub StatementFileNameFromDBItem
{
    my ($statementDBItem) = @_;
    assert($statementDBItem);

    my $labelPayeeID = $statementDBItem->payee_id;
    my $fileName = "$labelPayeeID.pdf";

    return $fileName;
}

sub PrettyStatementFileNameFromID
{
    my ($id) = @_;
    assert($id);

    my $statement = RPS::DB::Item::LabelRoyaltyStatement->Lookup(label_royalty_statement_id => $id);
    return PrettyStatementFilePathFromDBItem($statement);
}


sub PrettyStatementFileNameFromDBItem
{
    my ($statementDBItem) = @_;
    assert($statementDBItem);

    my $runID = $statementDBItem->label_royalty_run_id;
    my $cleanRunLabel = _runLabelClean($runID);

    my $labelPayeeID = $statementDBItem->payee_id;
    my $labelNameClean = _labelNameClean($labelPayeeID);

    my $fileName = $labelNameClean.'_'.$labelPayeeID.'_'.$cleanRunLabel."_summary.pdf";

    return $fileName;
}


# This returns the directory in which statement files can be found.
# client_id is optional - if ommitted, we'll use the current client id.
#
sub StatementPathFromRunID
{
    my ($runID, $clientID) = @_;
    assert($runID);

    $clientID = Common::RSApp::GetClientID() unless $clientID;
    my $clientData = Common::DB::Item::Client->Lookup(client_id => $clientID);
    my $clientName = $clientData->client_name_clean;

    return _BasePath() . "/$clientName/$runID/";
}


# Going to create a little ram cache, since this code will often get called in a loop.
#
my %gRunLabel;
sub _runLabelClean
{
    my ($runID) = @_;

    if (! defined $gRunLabel{$runID})
    {
        my $run = RPS::DB::Item::LabelRoyaltyRun->Lookup(label_royalty_run_id => $runID);
        assert($run, "ERROR - runID $runID is invalid");

        $gRunLabel{$runID} = Common::Util::clean_name($run->label);
    }

    return $gRunLabel{$runID};
}


my %gLabelName;
sub _labelNameClean
{
    my ($labelID) = @_;

    if (! defined $gLabelName{$labelID})
    {
        my $label = RPS::DB::Item::LabelPayee->Lookup(label_payee_id => $labelID);
        assert($label, "ERROR - label payee id $labelID is invalid");

        my $labelName = $label->name;

        # Replace '&' with 'and' - the normal clean function doesn't do that.
        #
        $labelName =~ s/ \& / and /g;
        $gLabelName{$labelID} = Common::Util::clean_name($labelName);
    }

    return $gLabelName{$labelID};
}

1;