File Coverage

blib/lib/Mojolicious/Plugin/CustomLog.pm

Criterion	Covered	Total	%
statement	57	70	81.4
branch	4	8	50.0
condition	1	2	50.0
subroutine	13	16	81.2
pod	1	6	16.6
total	76	102	74.5

package Mojolicious::Plugin::CustomLog;

$Mojolicious::Plugin::CustomLog::VERSION = '0.06';

use Mojo::Base 'Mojolicious::Plugin';

use Mojo::Util 'encode';
use Fcntl ':flock';

my $PATH = +{};
my $MODE;

sub register {
    my $self = shift;
    my ($app, $config) = @_;

    $MODE = $app->mode;

    while ( my ($key, $value) = each(%{$config->{path}}) ) {
        my $file = $app->home->rel_file($value . "_" . $MODE . ".log");
        $PATH->{$key} = $file;
    }

    # attach log instance to $app->clog
    # if there is no helper name provided
    $config->{helper} ||= 'clog';
    $app->attr("_clog", sub { return $self; });
    $app->helper(
        $config->{helper} => sub {
            my $self = shift;
            return $self->app->_clog;
        }
    );

    # export alias of this logger
    #
    # alias is very useful when $app can not be easily accessed
    # for example, using $Alias::CLog->debug instead of $app->clog
    #
    # however, this will currupt other namespace
    # so please use this with caution
    if ($config->{alias}) {
        no strict 'refs';
        *{"$config->{alias}::CLog"} = \$self;
    }
}

sub debug {
    my $self = shift;
    my $target = shift;
    my @contents = @_;
    $self->_out($target, 'debug', @contents);
}

sub info {
    my $self = shift;
    my $target = shift;
    my @contents = @_;
    $self->_out($target, 'info', @contents);
}

sub warn {
    my $self = shift;
    my $target = shift;
    my @contents = @_;
    $self->_out($target, 'warn', @contents);
}

sub error {
    my $self = shift;
    my $target = shift;
    my @contents = @_;
    $self->_out($target, 'error', @contents);
}

sub fatal {
    my $self = shift;
    my $target = shift;
    my @contents = @_;
    $self->_out($target, 'fatal', @contents);
}

sub _out {
    my $self = shift;
    my $target = shift;
    my $level = shift;
    my @contents = @_;

    my $path   = $PATH->{$target};

    if (!$path) {
        die "Undefined target: $target. path: $path";
    }

    my $log = join("\t", @contents);

    # remove line break for contents
    # there should always be one line per output
    $log =~ s/\n//g;

    $self->_append($path, $self->_format($level, $log));
}

sub _append {
    my $self = shift;
    my ($path, $log) = @_;

    $path .= "." . _get_local_date();
    open HANDLE, ">>", $path or die "Can not open file $path";

    flock HANDLE, LOCK_EX;
    HANDLE->print(encode('UTF-8', $log)) or die "Can't write to log: $!";
    flock HANDLE, LOCK_UN;

    close HANDLE;
}

sub _format {
    my $self = shift;
    return'[' . localtime . '] [' . shift . '] ' . shift . "\n";
}

sub _get_local_date {
    my ($second, $minute, $hour, $day, $month, $year, $weekday, $yesterday, $is_dst) = localtime;
    return sprintf("%04d%02d%02d", $year + 1900, $month + 1, $day);
}

1;

__END__