InfoSys::FreeDB::Response::SignOn - FreeDB sign-on response

package InfoSys::FreeDB::Response::SignOn;

use 5.006;
use base qw( InfoSys::FreeDB::Response );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);
use InfoSys::FreeDB::Response qw(:line_parse);

# Used by _initialize
our %DEFAULT_VALUE = (
    'connection_allowed' => 1,
    'read_allowed' => 1,
    'write_allowed' => 1,
);

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

1;

__END__

sub new_from_content_ref {
    my $class = shift;
    my $content_ref = shift;

    # Convert $opt->{content_ref} to @content_ref
    my @content_ref = split(/[\n\r]+/, ${$content_ref} );

    # Parse first line
    my $line = shift(@content_ref);
    my ($code, $tail) = $line =~ /$CODE_RX/;
    defined ($code) ||
        throw Error::Simple ('ERROR: InfoSys::FreeDB::Response::SignOn::new_from_content_ref, first line of specified \'content_ref\' does not contain a code.');
    my %opt;
    my @tail = split(/\s+/, $tail, 7);
    if ($code == 200) {
        %opt = (
            code => $code,
            result => 'OK, read/write allowed',
            hostname => $tail[0],
            version => $tail[3],
            date => $tail[6],
        );
    }
    elsif ($code == 201) {
        %opt = (
            code => $code,
            result => 'OK, read only',
            write_allowed => 0,
            hostname => $tail[0],
            version => $tail[3],
            date => $tail[6],
        );
    }
    elsif ($code == 432) {
        %opt = (
            code => $code,
            result => 'No connections allowed: permission denied',
            connection_allowed => 0,
            read_allowed => 0,
            write_allowed => 0,
            hostname => $tail[0],
            version => $tail[3],
            date => $tail[6],
        );
    }
    elsif ($code == 433) {
        %opt = (
            code => $code,
            result => 'No connections allowed: X users allowed, Y currently active',
            connection_allowed => 0,
            read_allowed => 0,
            write_allowed => 0,
            hostname => $tail[0],
            version => $tail[3],
            date => $tail[6],
        );
    }
    elsif ($code == 434) {
        %opt = (
            code => $code,
            result => 'No connections allowed: system load too high',
            connection_allowed => 0,
            read_allowed => 0,
            write_allowed => 0,
            hostname => $tail[0],
            version => $tail[3],
            date => $tail[6],
        );
    }
    else {
        throw Error::Simple ("ERROR: InfoSys::FreeDB::Response::SignOn::new_from_content_ref, unknown code '$code' returned. Allowed codes are 200, 201, 432, 433 and 434.");
    }

    # Create a new object and return it
    return( $class->new( \%opt ) );
}

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

    # Check $opt
    ref($opt) eq 'HASH' || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::SignOn::_initialize, first argument must be 'HASH' reference.");

    # connection_allowed, BOOLEAN, with default value
    $self->set_connection_allowed( exists( $opt->{connection_allowed} ) ? $opt->{connection_allowed} : $DEFAULT_VALUE{connection_allowed} );

    # date, SINGLE
    exists( $opt->{date} ) && $self->set_date( $opt->{date} );

    # hostname, SINGLE
    exists( $opt->{hostname} ) && $self->set_hostname( $opt->{hostname} );

    # read_allowed, BOOLEAN, with default value
    $self->set_read_allowed( exists( $opt->{read_allowed} ) ? $opt->{read_allowed} : $DEFAULT_VALUE{read_allowed} );

    # version, SINGLE
    exists( $opt->{version} ) && $self->set_version( $opt->{version} );

    # write_allowed, BOOLEAN, with default value
    $self->set_write_allowed( exists( $opt->{write_allowed} ) ? $opt->{write_allowed} : $DEFAULT_VALUE{write_allowed} );

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

    # Return $self
    return($self);
}

sub _value_is_allowed {
    return(1);
}

sub get_date {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response_SignOn}{date} );
}

sub get_hostname {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response_SignOn}{hostname} );
}

sub get_version {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response_SignOn}{version} );
}

sub is_connection_allowed {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response_SignOn}{connection_allowed} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_read_allowed {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response_SignOn}{read_allowed} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_write_allowed {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response_SignOn}{write_allowed} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub set_connection_allowed {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response_SignOn}{connection_allowed} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response_SignOn}{connection_allowed} = 0;
    }
}

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

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'date', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::SignOn::set_date, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response_SignOn}{date} = $val;
}

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

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'hostname', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::SignOn::set_hostname, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response_SignOn}{hostname} = $val;
}

sub set_read_allowed {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response_SignOn}{read_allowed} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response_SignOn}{read_allowed} = 0;
    }
}

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

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'version', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::SignOn::set_version, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response_SignOn}{version} = $val;
}

sub set_write_allowed {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response_SignOn}{write_allowed} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response_SignOn}{write_allowed} = 0;
    }
}