#---------------------------------------------------------------
# ____                   _ _         ____  _
#|  _ \ ___  _   _  __ _| | |_ _   _/ ___|| |__   __ _ _ __ ___
#| |_) / _ \| | | |/ _` | | __| | | \___ \| '_ \ / _` | '__/ _ \
#|  _ < (_) | |_| | (_| | | |_| |_| |___) | | | | (_| | | |  __/
#|_| \_\___/ \__, |\__,_|_|\__|\__, |____/|_| |_|\__,_|_|  \___|
#            |___/             |___/
#
# Copyright (C) 2014 RoyaltyShare, Inc.   All Rights Reserved
#---------------------------------------------------------------
package RPS::Import::Caroline::v15;

use strict;

use Date::Calc qw(Days_in_Month Decode_Month);

use lib '/app/tools/rps/lib';
use RPS::Import::ServiceMap;

use base 'RPS::Import::MapFaceBase';
use base 'RPS::Import::Importer';

sub _fieldMap {
    my $self = shift;
    my $version = $self->_version;

    my %field_map = (
        15 => {
            dateBegin     => 'K',
            dateEnd       => 'K',
            artistName    => 'C',
            countryCode   => 'J',
            units         => 'P',
            upc           => 'F',
            isrc          => 'G',
            price         => 'W',
            serviceID     => 'H',
        },
        18 => {
            dateBegin     => 'K',
            dateEnd       => 'K',
            albumName     => 'B',
            artistName    => 'C',
            countryCode   => 'J',
            units         => 'P',
            upc           => 'F',
            isrc          => 'G',
            price         => 'W',
            serviceID     => 'H',
        },
    );
    return $field_map{$version};
}

sub _unverifiedFieldMap {
    my $self = shift;
    my $version = $self->_version;

    my %field_map = (
        15 => {
            deliveryFormat => 'M',
            deliveryType   => 'L',
            releaseType    => 'E',
            releaseTitle   => 'D',
        },
        18 => {
            deliveryFormat => 'M',
            deliveryType   => 'L',
            releaseType    => 'E',
            releaseTitle   => 'D',
        },
    );
    return $field_map{$version};
}

sub _headerIdentifier { ( dateBegin => 'Calendar Month' ) }

sub serviceID {
    my $self = shift;
    my $service = $self->_getByFieldName('serviceID');
    my $serviceID = $self->getServiceID(lc ($service)) || $RPS::Import::ServiceMap::SERVICE_ALIASES{ lc $service };
    return $serviceID if( $serviceID );
    return $self->handleError("Unknown service: $service", RPS::DB::Item::SaleImportError::kErrorService);
}

sub saleDates {
    my $self  = shift;
    my $sDate  = $self->_getByFieldName('dateBegin');
    my $eDate = $self->_getByFieldName('dateEnd');

    my $dateBegin;
    my $dateEnd;

    if( $sDate =~ /^(\d{4})-(\d{1,2})$/ )
    {
        my $year = $1;
        my $month = $2;
        $dateBegin = sprintf("%04d-%02d-%02d", $year, $month, 1);
        $dateEnd   = sprintf("%04d-%02d-%02d", $year, $month, Days_in_Month($year,  $month ));
    }
    return( $dateBegin, $dateEnd );
}

sub units {
    my $self  = shift;
    my $p = $self->_getByFieldName('price');
    my $u = $self->_getByFieldName('units');

    $u = abs($u);
    return ($p<0) ? -1 * $u : $u;
}

sub currencyCode { 'EUR' }

sub trackName {
    my $self  = shift;
    my $title = $self->_getByFieldName('releaseTitle');
    return( $self->productType eq RPS::File::Sale::TYPE_TRACK ) ? $title : undef;
}

sub albumName {
    my $self  = shift;
    if( exists $self->_fieldMap->{'albumName'} )
    {
        return $self->_getByFieldName('albumName');
    }
    my $title = $self->_getByFieldName('releaseTitle');
    return( $self->productType eq RPS::File::Sale::TYPE_ALBUM ) ? $title : undef;
}

sub formatType {
    my $self  = shift;
    my $dType = $self->_getByFieldName('deliveryType');
    my $dFormat = $self->_getByFieldName('deliveryFormat');

    if( $dType =~ /^streams sales$/i && (
        $dFormat =~ /^ad-funded portable webcasting$/i ||
        $dFormat =~ /^cached plays$/i ||
        $dFormat =~ /^ephemeral play$/i ||
        $dFormat =~ /^fixed plays$/i ||
        $dFormat =~ /^hard bundled subscription plays$/i ||
        $dFormat =~ /^permanent download \(subscription\)$/i ||
        $dFormat =~ /^play \/ stream \(b2b\)$/i ||
        $dFormat =~ /^play \/ stream \(free service\)$/i ||
        $dFormat =~ /^play \/ stream \(subscr\.\)$/i ||
        $dFormat =~ /^play \/ stream \(webcasting\)$/i ||
        $dFormat =~ /^play \/ stream portable \(subscr\.\)$/i ||
        $dFormat =~ /^play \/ stream subscription via mobile application$/i ||
        $dFormat =~ /^premium webcasting$/i ||
        $dFormat =~ /^programmed streaming \(non-royalty bearing\)$/i ||
        $dFormat =~ /^soft bundled subscription plays$/i ||
        $dFormat =~ /^subscription(\xa0|\x20)webcasting$/i ||
        $dFormat =~ /^user Generated content stream$/i ) )
    {
        return RPS::File::Sale::FORMAT_STREAM;
    }
    elsif( $dType =~ /^download$/i && (
        $dFormat =~ /^kiosk$/i ||
        $dFormat =~ /^permanent download \(burnable\)$/i 
    ))
    {
        return RPS::File::Sale::FORMAT_DOWNLOAD;
    }
    return $self->handleError("Unable to determine format type from '$dType' / '$dFormat'", RPS::DB::Item::SaleImportError::kErrorFormatType);
}

sub mediaType {
    my $self  = shift;
    my $dType = $self->_getByFieldName('deliveryType');
    my $dFormat = $self->_getByFieldName('deliveryFormat');

    if( $dType =~ /^streams sales$/i && (
        $dFormat =~ /^ad-funded portable webcasting$/i ||
        $dFormat =~ /^cached plays$/i ||
        $dFormat =~ /^ephemeral play$/i ||
        $dFormat =~ /^fixed plays$/i ||
        $dFormat =~ /^hard bundled subscription plays$/i ||
        $dFormat =~ /^permanent download \(subscription\)$/i ||
        $dFormat =~ /^play \/ stream \(b2b\)$/i ||
        $dFormat =~ /^play \/ stream \(free service\)$/i ||
        $dFormat =~ /^play \/ stream \(subscr\.\)$/i ||
        $dFormat =~ /^play \/ stream \(webcasting\)$/i ||
        $dFormat =~ /^play \/ stream portable \(subscr\.\)$/i ||
        $dFormat =~ /^play \/ stream subscription via mobile application$/i ||
        $dFormat =~ /^premium webcasting$/i ||
        $dFormat =~ /^programmed streaming \(non-royalty bearing\)$/i ||
        $dFormat =~ /^soft bundled subscription plays$/i ||
        $dFormat =~ /^subscription(\xa0|\x20)webcasting$/i ||
        $dFormat =~ /^user Generated content stream$/i ) )
    {
        return RPS::DB::Item::MediaType::kMediaTypeAudio;
    }
    elsif( $dType =~ /^download$/i && (
        $dFormat =~ /^kiosk$/i ||
        $dFormat =~ /^permanent download \(burnable\)$/i
    ))
    {
        return RPS::DB::Item::MediaType::kMediaTypeAudio;
    }
    return $self->handleError("Unable to determine media type from '$dType' / '$dFormat'", RPS::DB::Item::SaleImportError::kErrorMediaType);
}

sub productType {
    my $self  = shift;
    my $rType = $self->_getByFieldName('releaseType');
    if( $rType =~ /^track$/i )
    {
        return RPS::File::Sale::TYPE_TRACK;
    }
    elsif( $rType =~ /^eSingle Audio\/Multi Track$/i ||
           $rType =~ /^album$/i )
    {
        return RPS::File::Sale::TYPE_ALBUM;
    }
    return $self->handleError("Unable to determine product type from '$rType'", RPS::DB::Item::SaleImportError::kErrorProductType);
}

sub _isValidSaleRecord {
    my $self = shift;
    my $rType = $self->_getByFieldName('releaseTitle');
    my $price = $self->_getByFieldName('price');
    my $units = $self->_getByFieldName('units');

    # The line should be looked at if it has a release title and revenue or units
    #
    return( $rType && ($price || $units ) );
}

sub _processSheet {
    my $self     = shift;
    my $sheet    = shift;
    my $sheetnum = shift;

    my $num = scalar @$sheet;

    # If we have a physical tab, make sure it doesn't have any lines in it.
    # if it's empty then we'll skip it and go on processing the rest of the
    # file, otherwise we'll error out.
    #
    if( $self->{sheetname} =~ /physical/i )
    {
        my $num = scalar @$sheet;
        foreach my $line (@$sheet)
        {
            $self->{line} = $line;
            if( $self->{_headerFound} )
            {
                if( $line->[0] !~ /totals/i )
                {
                    # make sure line is blank
                    return $self->handleError( "Found physical data", RPS::DB::Item::SaleImportError::kErrorNonqualifying )
                        if grep { defined($_) && '' ne $_ } @{$self->{line}};
                }
            } else {
                if( $self->_isHeader() ) {
                    $self->{_headerFound} = 1;
                }
            }
        }

    }
    else
    {
        return $self->SUPER::_processSheet( $sheet, $sheetnum );
    }
}

sub _mapFaceServiceID {
    return('serviceID');
}

sub _mapFaceCountryCode {
    return('countryCode');
}

sub _mapFaceProductType {
    return('releaseType');
}

sub _mapFaceFormatType {
    return('deliveryType', 'deliveryFormat');
}

sub _mapFaceMediaType {
    return('deliveryType', 'deliveryFormat');
}

sub _mapFaceCompatibleVersions {
    return(15,18);
}

###
1;# Play nicely.
###