File Coverage

blib/lib/Log/Trivial.pm

Criterion	Covered	Total	%
statement	95	105	90.4
branch	35	44	79.5
condition	13	14	92.8
subroutine	17	19	89.4
pod	9	9	100.0
total	169	191	88.4

#    $Id: Trivial.pm 61 2014-05-23 11:04:17Z adam $

package Log::Trivial;

use 5.010;
use utf8;
use strict;
use warnings;
use Fcntl qw(:DEFAULT :flock :seek);
use Carp;

our $VERSION = '0.40';

#
#    NEW
#

sub new {
    my $class  = shift;
    my %args   = @_;
    my $object = bless {
        _log_tag => $args{log_tag}
          || q{},            # Variable to tag this instance in the log file
        _mode    => 1,       # File logging mode 1=multi thread, 0=single
        _handle  => undef,   # File Handle if in single mode
        _o_sync  => 1,       # Use POSIX O_SYNC for writing, 1=on (default), 0=off
        _file          => $args{log_file} || q{},    # The Log File
        _level         => $args{log_level} || '3',   # Logging level
        _error_message => q{},                       # Store error messages here
        _debug         => undef,                     # debug flag
        _no_date_tag   => $args{no_date_tag}         # Date tagging? (1=off, 0=on)
    }, $class;

    return $object;
}

sub set_log_file {
    my $self     = shift;
    my $log_file = shift;
    if ( $self->_check_file($log_file) ) {
        $self->{_file} = $log_file;
        $self->{_self} = 0;
        return $self;
    }
    else {
        return;
    }
}

sub set_log_mode {
    my $self = shift;
    my $mode = shift;

    if ( $mode =~ /m/imx ) {
        $self->{_mode} = 1;
    }
    else {
        $self->{_mode} = 0;
    }

    return $self;
}

sub set_log_level {
    my $self  = shift;
    my $level = shift;

    $self->{_level} = $level if defined $level;

    return $self;
}

sub set_write_mode {
    my $self = shift;
    my $mode = shift;

    if ( $mode =~ /s/imx ) {
        $self->{_o_sync} = 1;
    }
    else {
        $self->{_o_sync} = 0;
    }
    return $self;
}

sub set_no_date_tag {
    my $self = shift;
    my $mode = shift;

    if ( $mode ) {
        $self->{_no_date_tag} = 1;
    }
    else {
        $self->{_no_date_tag} = 0;
    }
    return $self;
}

sub mark {
    my $self = shift;

    return $self->write( '-- MARK --' );
}

sub write {
    my $self = shift;
    my $message;
    if ( @_ > 1 ) {
        my %args  = @_;
        my $level = $args{level};
        return if $level && $self->{_level} < $level;
        $message = $args{comment} || q{.};
    }
    else {
        $message = shift;
    }

    return $self->_raise_error( 'Nothing message sent to log' )
        unless $message;

    $message = $self->{_log_tag} . "\t" . $message
      if $self->{_log_tag};

    $message = localtime() . "\t" . $message
      unless  $self->{_no_date_tag};

    my $file = $self->{_file};
    return $self->_raise_error( 'No Log file specified yet' ) unless $file;

    if ( -e $file && !-w _ ) {
        return $self->_raise_error(
            "Insufficient permissions to write to: $file" );
    }

    if ( $self->{_mode} ) {
        my $log = $self->_open_log_file( $file );
        if ( $log ) {
            $self->_write_log( $log, $message );
            close $log;
        }
        else {
            return $self->_raise_error( $self->get_error( ) );
        }
    }
    else {
        if ( !$self->{_handle} ) {
            $self->{_handle} = $self->_open_log_file( $file );
        }
        $self->_write_log( $self->{_handle}, $message );
    }
    return $message;
}

sub get_error {
    my $self = shift;
    return $self->{_error_message};
}

#
#    Private Stuff
#

sub _check_file {
    my $self = shift;
    my $file = shift;
    return $self->_raise_error( 'File error: No file name supplied' )
        unless $file;
    return $self;
}

sub _open_log_file {
    my $self = shift;
    my $file = shift;
    my $log;

    if ( $self->{_o_sync} ) {
        sysopen $log, $file, O_WRONLY | O_CREAT | O_SYNC | O_APPEND
            or return $self->_raise_error( "Unable to open Log File: $file" );
    }
    else {
        sysopen $log, $file, O_WRONLY | O_CREAT | O_APPEND
            or return $self->_raise_error( "Unable to open Log File: $file" );
    }
    flock $log, LOCK_EX
        or return $self->_raise_error( "Unable to flock Log file: $file" );

    return $log;

}

sub _write_log {
    my $self   = shift;
    my $handle = shift;
    my $string = shift() . "\n";

    my $bytes = length $string;
    sysseek $handle, 0, SEEK_END;
    syswrite $handle, $string, $bytes;
    return $self->_raise_error( 'Write Error' ) unless $bytes == length $string;
    return $bytes;
}

sub _raise_error {
    my $self    = shift;
    my $message = shift;
    carp $message if $self->{_debug};    # DEBUG:  warn with the message
    $self->{_error_message} = $message;  # NORMAL: set the message
    return;
}

1;

__END__