HH::Unispool::Config::File::Token::Comment::Date - date comment token

package HH::Unispool::Config::File::Token::Comment::Date;

use 5.006;
use base qw( HH::Unispool::Config::File::Token::Comment );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);
use HH::Unispool::Config::File::Token qw( :rx :frm );
use Time::Local qw( timelocal );

# Used by _value_is_allowed
our %ALLOW_ISA = (
);

# Used by _value_is_allowed
our %ALLOW_REF = (
);

# Used by _value_is_allowed
our %ALLOW_RX = (
    'time' => [ '^\d+$' ],
);

# Used by _value_is_allowed
our %ALLOW_VALUE = (
);

# Used by _initialize
our %DEFAULT_VALUE = (
    # See _initialize for 'time' default value
);

# Unispool <=> unix conversion
our %UNIX2USP_MONTH = ();

# Unispool <=> unix conversion
our %USP2UNIX_MONTH = (
    jan => 0,
    feb => 1,
    mar => 2,
    apr => 3,
    may => 4,
    jun => 5,
    jul => 6,
    aug => 7,
    sep => 8,
    oct => 9,
    nov => 10,
    dec => 11,
);

# Package version
our ($VERSION) = '$Revision: 0.3 $' =~ /\$Revision:\s+([^\s]+)/;

# Unispool <=> unix conversion
our @UNIX2USP_WDAY = qw( SUN MON TUE WED THU FRI SAT );

# Fill UNIX2USP_MONTH
foreach my $mon ( keys(%USP2UNIX_MONTH) ) {
        $UNIX2USP_MONTH{ $USP2UNIX_MONTH{$mon} } = uc($mon);
}

1;

__END__

sub _initialize {
    my $self = shift;
    my $opt = defined($_[0]) ? shift : {};

    # Check $opt
    ref($opt) eq 'HASH' || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Comment::Date::_initialize, first argument must be 'HASH' reference.");

    # time, SINGLE, with default value
    $self->set_time( exists( $opt->{time} ) ? $opt->{time} : time() );

    # Call the superclass' _initialize
    $self->SUPER::_initialize($opt);

    # Return $self
    return($self);
}

sub _value_is_allowed {
    my $name = shift;

    # Value is allowed if no ALLOW clauses exist for the named attribute
    if ( ! exists( $ALLOW_ISA{$name} ) && ! exists( $ALLOW_REF{$name} ) && ! exists( $ALLOW_RX{$name} ) && ! exists( $ALLOW_VALUE{$name} ) ) {
        return(1);
    }

    # At this point, all values in @_ must to be allowed
    CHECK_VALUES:
    foreach my $val (@_) {
        # Check ALLOW_ISA
        if ( ref($val) && exists( $ALLOW_ISA{$name} ) ) {
            foreach my $class ( @{ $ALLOW_ISA{$name} } ) {
                &UNIVERSAL::isa( $val, $class ) && next CHECK_VALUES;
            }
        }

        # Check ALLOW_REF
        if ( ref($val) && exists( $ALLOW_REF{$name} ) ) {
            exists( $ALLOW_REF{$name}{ ref($val) } ) && next CHECK_VALUES;
        }

        # Check ALLOW_RX
        if ( defined($val) && ! ref($val) && exists( $ALLOW_RX{$name} ) ) {
            foreach my $rx ( @{ $ALLOW_RX{$name} } ) {
                $val =~ /$rx/ && next CHECK_VALUES;
            }
        }

        # Check ALLOW_VALUE
        if ( ! ref($val) && exists( $ALLOW_VALUE{$name} ) ) {
            exists( $ALLOW_VALUE{$name}{$val} ) && next CHECK_VALUES;
        }

        # We caught a not allowed value
        return(0);
    }

    # OK, all values are allowed
    return(1);
}

sub get_time {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Comment_Date}{time} );
}

sub read_string {
    my $self = shift;
    my $line = shift;

    # Parse line
    my ($mon, $mday, $year, $hour, $min, $am_pm) = $line =~ /$USP_DATE_RX/;
    defined($mon) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Comment::Date::read_string, parameter 'LINE' does not match the regular expression for this token's line string.");

    # Make Unix time out of obtained values
    if ( $am_pm =~ /am/i && $hour == 12 ) {
        $hour = 0;
    }
    elsif ( $am_pm =~ /pm/i && $hour < 12 ) {
        $hour += 12;
    }
    $mon = $USP2UNIX_MONTH{ lc($mon) };
    my $time = timelocal ( 0, $min, $hour, $mday, $mon, $year - 1900 );

    # Set attributes
    $self->set_time($time);
}

sub set_time {
    my $self = shift;
    my $val = shift;

    # Value for 'time' is not allowed to be empty
    defined($val) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Comment::Date::set_time, value may not be empty.");

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'time', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Comment::Date::set_time, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Comment_Date}{time} = $val;
}

sub write_string {
    my $self = shift;

    # Make string and return it
    my @time = localtime( $self->get_time() );
    my $am_pm = ($time[2] < 12) ? 'AM' : 'PM';
    my $hour12 = $time[2];
    if ( $time[2] == 0 ) {
        $hour12 = 12;
    }
    elsif ( $time[2] > 12 ) {
        $hour12 = $time[2] - 12;
    }
    return(
        sprintf(
            $USP_DATE_FRM,
            $UNIX2USP_WDAY[ $time[6] ] || '',
            $UNIX2USP_MONTH{ $time[4] } || '',
            $time[3] || 0,
            $time[5] + 1900 || 0,
            $hour12 || 0,
            $time[1] || 0,
            $am_pm || 0,
        )
    );
}