#------------------------------------------------------------
# Copyright (C) 2011 RoyaltyShare, Inc.   All Rights Reserved
# $Id$
#------------------------------------------------------------
package RPS::Statement::Settings::ArtistSettings;

use strict;
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::DB::Item::ArtistRoyaltyStatementSettings;
use RPS::DB::Item::ArtistRoyaltyRun;

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

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

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

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

    $self->_initProperties( \%properties );

    return $self;
}

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

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

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

    $hrProperties->{artist_royalty_statement_settings_id} = $dbItem->artist_royalty_statement_settings_id;
    $hrProperties->{show_sales_price}                     = $dbItem->show_sales_price;
    $hrProperties->{show_royalty_rate}                    = $dbItem->show_royalty_rate;
    $hrProperties->{date_created}                         = $dbItem->date_created;

    $hrProperties->{show_proration}      = $dbItem->show_proration;
    $hrProperties->{show_prorated_rate}  = $dbItem->show_prorated_rate;
    $hrProperties->{show_rate_reduction} = $dbItem->show_rate_reduction;
    $hrProperties->{show_packaging}      = $dbItem->show_packaging;
    $hrProperties->{show_gross_units}    = $dbItem->show_gross_units;
    $hrProperties->{show_gross_sales}    = $dbItem->show_gross_sales;
    $hrProperties->{show_percent_sales}  = $dbItem->show_percent_sales;
    $hrProperties->{show_free_goods}     = $dbItem->show_free_goods;
    $hrProperties->{show_reserves}       = $dbItem->show_reserves;
    $hrProperties->{show_liquidations}   = $dbItem->show_liquidations;
    $hrProperties->{show_returns}        = $dbItem->show_returns;
    $hrProperties->{show_rate_type}      = $dbItem->show_rate_type;
    $hrProperties->{show_effective_rate} = $dbItem->show_effective_rate;
    $hrProperties->{show_net_sales}      = $dbItem->show_net_sales;
    $hrProperties->{date_inactive}       = $dbItem->date_inactive;
}

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

    $self->{ArtistRoyaltyStatementSettingsID} = $props->{artist_royalty_statement_settings_id};
    $self->{ShowSalesPrice}                   = Common::FormObject::Scalar::Boolean->new( value => $props->{show_sales_price} );
    $self->{ShowRoyaltyRate}                  = Common::FormObject::Scalar::Boolean->new( value => $props->{show_royalty_rate} );
    $self->{DateCreated}                      = Common::FormObject::Scalar::Date->new( value => $props->{date_created}, readOnly => 1 );

    $self->{ShowProration}         = Common::FormObject::Scalar::Boolean->new( value => $props->{show_proration} );
    $self->{ShowProratedRate}      = Common::FormObject::Scalar::Boolean->new( value => $props->{show_prorated_rate} );
    $self->{ShowRateReduction}     = Common::FormObject::Scalar::Boolean->new( value => $props->{show_rate_reduction} );
    $self->{ShowPackaging}         = Common::FormObject::Scalar::Boolean->new( value => $props->{show_packaging} );
    $self->{ShowGrossUnits}        = Common::FormObject::Scalar::Boolean->new( value => $props->{show_gross_units} );
    $self->{ShowGrossSales}        = Common::FormObject::Scalar::Boolean->new( value => $props->{show_gross_sales} );
    $self->{ShowPercentageOfSales} = Common::FormObject::Scalar::Boolean->new( value => $props->{show_percent_sales} );
    $self->{ShowFreeGoods}         = Common::FormObject::Scalar::Boolean->new( value => $props->{show_free_goods} );
    $self->{ShowReserves}          = Common::FormObject::Scalar::Boolean->new( value => $props->{show_reserves} );
    $self->{ShowLiquidations}      = Common::FormObject::Scalar::Boolean->new( value => $props->{show_liquidations} );
    $self->{ShowReturns}           = Common::FormObject::Scalar::Boolean->new( value => $props->{show_returns} );
    $self->{ShowRateType}          = Common::FormObject::Scalar::Boolean->new( value => $props->{show_rate_type} );
    $self->{ShowEffectiveRate}      = Common::FormObject::Scalar::Boolean->new( value => $props->{show_effective_rate} );
    $self->{ShowNetSales}           = Common::FormObject::Scalar::Boolean->new( value => $props->{show_net_sales} );
    $self->{DateInactive} = Common::FormObject::Scalar::Date->new( value => $props->{date_inactive}, readOnly => 1 );
}

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

    $hrProperties->{show_sales_price}  = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowSalesPrice;
    $hrProperties->{show_royalty_rate} = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowRoyaltyRate;

    $hrProperties->{show_proration}      = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowProration;
    $hrProperties->{show_prorated_rate}  = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowProratedRate;
    $hrProperties->{show_rate_reduction} = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowRateReduction;
    $hrProperties->{show_packaging}      = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowPackaging;
    $hrProperties->{show_gross_units}    = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowGrossUnits;
    $hrProperties->{show_gross_sales}    = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowGrossSales;
    $hrProperties->{show_percent_sales}  = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowPercentSales;
    $hrProperties->{show_free_goods}     = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowFreeGoods;
    $hrProperties->{show_reserves}       = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowReserves;
    $hrProperties->{show_liquidations}   = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowLiquidations;
    $hrProperties->{show_returns}        = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowReturns;
    $hrProperties->{show_rate_type}       = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowRateType;
    $hrProperties->{show_effective_rate}   = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowEffectiveRate;
    $hrProperties->{show_net_sales}        = RPS::DB::Item::ArtistRoyaltyStatementSettings::kDefaultShowNetSales;
}

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

    Common::Log::Print("-- ArtistSettings::save");

    my $dbObj;
    if ( $self->ArtistRoyaltyStatementSettingsID() ) {

        # We don't want to allow 'updating' an existing Settings record.
        # The only valid 'save' is when we create a new one.
        #
        assert( 0, "ERROR - attempting to 'save' using ID " . $self->ArtistRoyaltyStatementSettingsID() . ", which is not allowed" );
    } else {
        $dbObj = RPS::DB::Item::ArtistRoyaltyStatementSettings->Create();
    }

    $dbObj->show_sales_price( $self->ShowSalesPrice() );
    $dbObj->show_royalty_rate( $self->ShowRoyaltyRate() );

    $dbObj->show_proration( $self->ShowProration() );
    $dbObj->show_prorated_rate( $self->ShowProratedRate() );
    $dbObj->show_rate_reduction( $self->ShowRateReduction() );
    $dbObj->show_packaging( $self->ShowPackaging() );
    $dbObj->show_gross_units( $self->ShowGrossUnits() );
    $dbObj->show_gross_sales( $self->ShowGrossSales() );
    $dbObj->show_percent_sales( $self->ShowPercentageOfSales() );
    $dbObj->show_free_goods( $self->ShowFreeGoods() );
    $dbObj->show_reserves( $self->ShowReserves() );
    $dbObj->show_liquidations( $self->ShowLiquidations() );
    $dbObj->show_returns( $self->ShowReturns() );
    $dbObj->show_rate_type( $self->ShowRateType() );
    $dbObj->show_effective_rate( $self->ShowEffectiveRate() );
    $dbObj->show_net_sales( $self->ShowNetSales() );

    $dbObj->save();
    $self->_init( _dbItem => $dbObj );

    return 1;
}

# !!! Note that we only want to 'delete' settings in certain special circumstances.
# !!! But we'll put that logic in the Form that uses these things.
#
sub deleteIfUnused {
    my ($self) = @_;

    # If we don't even have an ID, then we don't really exist anyway.
    #
    my $id = $self->ArtistRoyaltyStatementSettingsID();
    return 1 unless $id;

    my $dbItem = RPS::DB::Item::ArtistRoyaltyStatementSettings->Lookup( artist_royalty_statement_settings_id => $id );

    # So, has this setting been around long enough to be in a committed/closed/complete/invalidated run?
    # By design, we call this only for the 'current' settings, so the date range we're interested
    # in runs from the record's date_created to now.
    #
    my $startDate = $dbItem->date_created();
    my $statusInfo = RPS::DB::Item::ArtistRoyaltyRun->GetRunStatusCounts( sinceDate => $startDate );
    if (   $statusInfo->_committed() > 0
        || $statusInfo->_closed() > 0
        || $statusInfo->_invalidated() > 0
        || $statusInfo->_complete() > 0 ) {
        return 1;
    }

    $dbItem->delete();

    return 1;
}

###
1;    #
###