=head1 NAME Log::Handler::Simple - A simple handler to log messages to a log file. =head1 SYNOPSIS use Log::Handler; # if you pass any options to new() then a # Log::Handler::Simple object is created my $log = Log::Handler->new(filename => '*STDOUT'); # is the same like my $log = Log::Handler::Simple->new(filename => '*STDOUT'); $log->alert("foo bar"); =head1 DESCRIPTION Maybe you are wondering why this module exists besides C. This module is just for backward compatibilities to the old C - version 0.38. If you install the current version of C you don't need to rewrite your programs. You can use the old style if you wish. =head1 METHODS =head2 new() Call C to create a new log handler object. The C method expected the options for the log file. Each option will be set to a default value if not set. =head2 Log levels There are eigth log levels and thirteen methods to handle this levels: =over 4 =item debug() =item info() =item notice(), note() =item warning(), warn() =item error(), err() =item critical(), crit() =item alert() =item emergency(), emerg() =back C is the highest and C or C is the lowest log level. You can define the log level with the options C and C. The methods C, C, C, C and C are just shortcuts. Example: If you set the option C to C and C to C then the levels emergency, alert, critical, error and warning will be logged. The call of a log level method is very simple: $log->info("Hello World! How are you?"); Or maybe: $log->info("Hello World!", "How are you?"); Both calls write to the log file (provided that the log level INFO would log) Feb 01 12:56:31 [INFO] Hello World! How are you? =head2 is_* methods =over 4 =item is_debug() =item is_info() =item is_notice(), is_note() =item is_warning(), is_warn() =item is_error(), is_err() =item is_critical(), is_crit() =item is_alert() =item is_emergency(), is_emerg() =back These thirteen methods could be very useful if you want to kwow if the current log level would write the message to the log file. All methods returns TRUE if the handler would log it and FALSE if not. Example: $log->debug(Dumper(\%hash)); This example would dump the hash in any case and handoff it to the log handler, but this isn't that what we really want because it could costs a lot of resources. $log->debug(Dumper(\%hash)) if $log->is_debug(); Now we dump the hash only if the current log level would log it. The methods C, C, C, C and C are just shortcuts. =head2 set_prefix() Call C to modifier the option prefix after you called C. my $log = Log::Handler::Simple->new( filename => 'file.log', mode => 'append', prefix => "myhost:$$ [<--LEVEL-->] " ); $log->set_prefix("[<--LEVEL-->] myhost:$$ "); =head2 get_prefix() Call C to get the current prefix if you want to modifier it. # safe the old prefix my $old_prefix = $log->get_prefix(); # set a new one for a code part in your script $log->set_prefix("my new prefix"); # now set the your old prefix again $log->set_prefix($old_prefix); Or you want to add something to the current prefix: $log->set_prefix($log->get_prefix."add something"); =head2 errstr() Call C if you want to get the last error message. That is useful with C. If you set this option to C<0> then the handler wouldn't croak if a simple write operation fails. Set C to control it yourself. C is only useful with C, C and the log level methods. $log->info("Hello World!") or die $log->errstr; Or $error_string = $log->errstr unless $log->info("Hello World!"); The exception is that the handler croaks in any case if the call of C fails because on missing params or wrong settings! my $log = Log::Handler::Simple->new(filename => 'file.log', mode => 'foo bar'); That would croak, because the option C except C or C or C. If you set the option C to 1 - the default - to open the log file permanent and the call of C fails then you can absorb the error. my $log = Log::Handler::Simple->new( filename => 'file.log', die_on_errors => 0 ) or warn Log::Handler::Simple->errstr; =head2 close() Call C if you want to close the log file. This option is only useful if you set the option C to 1 and if you want to close the log file yourself. If you don't call C the log file will be closed automatically before exit. =head2 trace() This method is very useful if you want to print C informations to the log file. In contrast to the log level methods this method prints C informations to the log file in any case and you don't need to activate the debugger with the option C. Example: my $log = Log::Handler::Simple->new( filename => \*STDOUT ); $log->trace("caller informations:"); Jun 05 21:20:32 [TRACE] caller informations CALL(2): package(main) filename(./log-handler-test.pl) line(22) subroutine(Log::Handler::Simple::trace) hasargs(1) CALL(1): package(Log::Handler::Simple) filename(/usr/local/share/perl/5.8.8/Log/Handler.pm) line(941) subroutine(Log::Handler::Simple::_print) hasargs(1) CALL(0): package(Log::Handler::Simple) filename(/usr/local/share/perl/5.8.8/Log/Handler.pm) line(1097) subroutine(Devel::Backtrace::new) hasargs(1) wantarray(0) Maybe you like to print caller informations to the log file if an unexpected error occurs. $SIG{__DIE__} = sub { $log->trace(@_) }; Take a look at the examples of the options C, C and C for more informations. =head1 OPTIONS =head2 filename With C you can set a file name, a GLOBREF or you can set a string as an alias for STDOUT or STDERR. The default is STDOUT for this option. Set a file name: my $log = Log::Handler::Simple->new( filename => 'file.log' ); Set a GLOBREF open FH, '>', 'file.log' or die $!; my $log = Log::Handler::Simple->new( filename => \*FH ); Or the same with open my $fh, '>', 'file.log' or die $!; my $log = Log::Handler::Simple->new( filename => $fh ); Set STDOUT or STDERR my $log = Log::Handler::Simple->new( filename => \*STDOUT ); # or my $log = Log::Handler::Simple->new( filename => \*STDERR ); If the option C is set in a config file and you want to debug to your screen then you can set C<*STDOUT> or C<*STDERR> as a string. my $log = Log::Handler::Simple->new( filename => '*STDOUT' ); # or my $log = Log::Handler::Simple->new( filename => '*STDERR' ); That is not possible: my $log = Log::Handler::Simple->new( filename => '*FH' ); Note that if you set a GLOBREF to C some options will be forced (overwritten) and you have to control the handles yourself. The forced options are fileopen => 1 filelock => 0 reopen => 0 =head2 filelock Maybe it's desirable to lock the log file by each write operation because a lot of processes write at the same time to the log file. You can set the option C to activate or deactivate the locking. 0 - no file lock 1 - exclusive lock (LOCK_EX) and unlock (LOCK_UN) by each write operation (default) =head2 fileopen Open a log file transient or permanent. 0 - open and close the logfile by each write operation 1 - open the logfile if C called and try to reopen the file if C is set to 1 and the inode of the file has changed (default) =head2 reopen This option works only if option C is set to 1. 0 - deactivate 1 - try to reopen the log file if the inode changed (default) =head2 fileopen and reopen Please note that it's better to set C and C to 0 on Windows because Windows unfortunately haven't the faintest idea of inodes. To write your code independent you should control it: my $os_is_win = $^O =~ /win/i ? 0 : 1; my $log = Log::Handler::Simple->new( filename => 'file.log', mode => 'append', fileopen => $os_is_win ); If you set C to 0 then it implies that C has no importance. =head2 mode There are three possible modes to open a log file. append - O_WRONLY | O_APPEND | O_CREAT excl - O_WRONLY | O_EXCL | O_CREAT (default) trunc - O_WRONLY | O_TRUNC | O_CREAT C would open the log file in any case and appends the messages at the end of the log file. C would fail by open the log file if the log file already exists. This is the default option because some security reasons. C would truncate the complete log file if it exists. Please take care to use this option. Take a look to the documentation of C to get more informations. =head2 autoflush 0 - autoflush off 1 - autoflush on (default) =head2 permissions The option C sets the permission of the file if it creates and must be set as a octal value. The permission need to be in octal and are modified by your process's current "umask". That means that you have to use the unix style permissions such as C. C<0640> is the default permission for this option. That means that the owner got read and write permissions and users in the same group got only read permissions. All other users got no access. Take a look to the documentation of C to get more informations. =head2 timeformat You can set C with a date and time format that will be coverted by POSIX::strftime. The default format is "%b %d %H:%M:%S" and looks like Feb 01 12:56:31 As example the format "%Y/%m/%d %H:%M:%S" would looks like 2007/02/01 12:56:31 =head2 newline This helpful option appends a newline to the log message if it not exist. 0 - inactive (default) 1 - active - appends a newline to the log message if not exist =head2 prefix Set C to define your own prefix for each message. The default value is "[<--LEVEL-->] ". "<--LEVEL-->" is replaced with the current message level. Default example: $log->alert("message ..."); would log Feb 01 12:56:31 [ALERT] message ... If you set C to prefix => 'foo <--LEVEL--> bar: ' $log->info("foobar"); then it would log Feb 01 12:56:31 foo INFO bar: foobar Take a look to the EXAMPLES to see more. =head2 maxlevel and minlevel With these options it's possible to set the log levels for your program. The log levels are: 7 - debug 6 - info 5 - notice, note 4 - warning, warn 3 - error, err 2 - critical, crit 1 - alert 0 - emergency, emerg The levels C, C, C and C are just shortcuts. It's possible to set the log level as a string or as number. The default C is 4 and the default C is 0. Example: If C is set to 4 and C to 0 then the levels emergency (emerg), alert, critical (crit) and error (err) are active and would be logged to the log file. You can set both to 8 or C if you don't want to log any message. =head2 rewrite_to_stderr Set this option to 1 if you want that Log::Handler::Simple prints messages to STDERR if the message couldn't print to the log file. The default is 0. =head2 die_on_errors Set C to 0 if you don't want that the handler croaks if normal operations fail. 0 - will not die on errors 1 - will die (e.g. croak) on errors The exception is that the handler croaks in any case if the call of C fails because on missing params or wrong settings. =head2 utf8 If this option is set to 1 then UTF-8 will be set with C on the output filehandle. =head2 debug You can activate a simple debugger that writes C informations for each log level that would log to the log file. The debugger is logging all defined values except C and C. Set C to 1 to activate the debugger. The debugger is set to 0 by default. =head2 debug_mode There are two debug modes: line(1) and block(2) mode. The default mode is 1. The block mode looks like this: use strict; use warnings; use Log::Handler::Simple; my $log = Log::Handler::Simple->new( maxlevel => 'debug', debug => 1, debug_mode => 1 ); sub test1 { $log->debug() } sub test2 { &test1; } &test2; Output: Apr 26 12:54:11 [DEBUG] CALL(4): package(main) filename(./trace.pl) line(15) subroutine(main::test2) hasargs(0) CALL(3): package(main) filename(./trace.pl) line(13) subroutine(main::test1) hasargs(0) CALL(2): package(main) filename(./trace.pl) line(12) subroutine(Log::Handler::Simple::__ANON__) hasargs(1) CALL(1): package(Log::Handler::Simple) filename(/usr/local/share/perl/5.8.8/Log/Handler.pm) line(713) subroutine(Log::Handler::Simple::_print) hasargs(1) CALL(0): package(Log::Handler::Simple) filename(/usr/local/share/perl/5.8.8/Log/Handler.pm) line(1022) subroutine(Devel::Backtrace::new) hasargs(1) wantarray(0) The same code example but the debugger in block mode would looks like this: debug_mode => 2 Output: Apr 26 12:52:17 [DEBUG] CALL(4): package main filename ./trace.pl line 15 subroutine main::test2 hasargs 0 CALL(3): package main filename ./trace.pl line 13 subroutine main::test1 hasargs 0 CALL(2): package main filename ./trace.pl line 12 subroutine Log::Handler::Simple::__ANON__ hasargs 1 CALL(1): package Log::Handler::Simple filename /usr/local/share/perl/5.8.8/Log/Handler.pm line 681 subroutine Log::Handler::Simple::_print hasargs 1 CALL(0): package Log::Handler::Simple filename /usr/local/share/perl/5.8.8/Log/Handler.pm line 990 subroutine Devel::Backtrace::new hasargs 1 wantarray 0 =head2 debug_skip This option let skip the caller informations the count of C. debug_skip => 2 Apr 26 12:55:07 [DEBUG] CALL(2): package(main) filename(./trace.pl) line(16) subroutine(main::test2) hasargs(0) CALL(1): package(main) filename(./trace.pl) line(14) subroutine(main::test1) hasargs(0) CALL(0): package(main) filename(./trace.pl) line(13) subroutine(Log::Handler::Simple::__ANON__) hasargs(1) =head1 EXAMPLES =head2 Simple example to log all level: use Log::Handler::Simple; my $log = Log::Handler::Simple->new( filename => 'file1.log', mode => 'append', newline => 1, maxlevel => 7, minlevel => 0 ); $log->debug("this is a debug message"); $log->info("this is a info message"); $log->notice("this is a notice"); $log->note("this is a notice as well"); $log->warning("this is a warning"); $log->warn("this is a warning as well"); $log->error("this is a error message"); $log->err("this is a error message as well"); $log->critical("this is a critical message"); $log->crit("this is a critical message as well"); $log->alert("this is a alert message"); $log->emergency("this is a emergency message"); $log->emerg("this is a emergency message as well"); Would log Feb 01 12:56:31 [DEBUG] this is a debug message Feb 01 12:56:31 [INFO] this is a info message Feb 01 12:56:31 [NOTICE] this is a notice Feb 01 12:56:31 [NOTE] this is a notice as well Feb 01 12:56:31 [WARNING] this is a warning Feb 01 12:56:31 [WARN] this is a warning Feb 01 12:56:31 [ERROR] this is a error message Feb 01 12:56:31 [ERR] this is a error message as well Feb 01 12:56:31 [CRITICAL] this is a critical message Feb 01 12:56:31 [CRIT] this is a critial message as well Feb 01 12:56:31 [ALERT] this is a alert message Feb 01 12:56:31 [EMERGENCY] this is a emergency message Feb 01 12:56:31 [EMERG] this is a emergency message as well =head2 Just a notice: use Log::Handler::Simple; my $log = Log::Handler::Simple->new( filename => '/var/run/pid-file1', mode => 'trunc', maxlevel => 5, minlevel => 5, prefix => '', timeformat => '' ); $log->note("$$"); Would truncate /var/run/pid-file1 and write just the pid to the logfile. =head2 Selfmade prefix: use Log::Handler::Simple; use Sys::Hostname; my $hostname = hostname; my $pid = $$; my $progname = $0; $progname =~ s@.*[/\\]@@; my $log = Log::Handler::Simple->new( filename => "${progname}.log", mode => 'append', maxlevel => 6, newline => 1, prefix => "${hostname}[$pid] [<--LEVEL-->] $progname: " ); $log->info("Hello World!"); $log->warning("There is something wrong!"); Would log: Feb 01 12:56:31 hostname[8923] [INFO] progname: Hello world Feb 01 12:56:31 hostname[8923] [WARNING] progname: There is something wrong! =head2 is_* example: use Log::Handler::Simple; use Data::Dumper; my $log = Log::Handler::Simple->new( filename => 'file1.log', mode => 'append', maxlevel => 4, ); my %hash = (foo => 1, bar => 2); $log->debug("\n".Dumper(\%hash)) if $log->is_debug(); Would NOT dump %hash to the $log object! =head2 die_on_errors example: use Log::Handler::Simple; use Data::Dumper; my $log = Log::Handler::Simple->new( filename => 'file1.log', mode => 'append', die_on_errors => 0 ) or die Log::Handler::Simple->errstr(); if ($log->is_debug()) { $log->debug("\n".Dumper(\%hash)) or die $log->errstr(); } =head1 PREREQUISITES Fcntl - for flock(), O_APPEND, O_WRONLY, O_EXCL and O_CREATE POSIX - to generate the time stamp with strftime() Params::Validate - to validate all options Devel::Backtrace - to backtrace caller() Carp - to croak() on errors if die_on_errors is active =head1 EXPORTS No exports. =head1 REPORT BUGS Please report all bugs to . =head1 AUTHOR Jonny Schulz . =head1 QUESTIONS Do you have any questions or ideas? MAIL: IRC: irc.perl.org#perlde If you send me a mail then add Log::Handler::Simple into the subject. =head1 COPYRIGHT Copyright (C) 2007 by Jonny Schulz. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =head1 DISCLAIMER OF WARRANTY BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. =cut package # hide from pause Log::Handler::Simple; our $VERSION = '0.40'; use strict; use warnings; use Fcntl qw( :flock O_WRONLY O_APPEND O_TRUNC O_EXCL O_CREAT ); use POSIX qw(strftime); use Params::Validate; use Carp qw(croak); use Devel::Backtrace; use constant EMERGENCY => 0; use constant EMERG => 0; use constant ALERT => 1; use constant CRITICAL => 2; use constant CRIT => 2; use constant ERROR => 3; use constant ERR => 3; use constant WARNING => 4; use constant WARN => 4; use constant NOTICE => 5; use constant NOTE => 5; use constant INFO => 6; use constant DEBUG => 7; use constant NOTHING => 8; $Log::Handler::Simple::ERRSTR = ''; # -------------------------------------------------------------------- # The BEGIN block is used to generate the syslog methods and the is_* # methods. The syslog methods calling _print() with the syslog level # as first uppercase argument. The is_* methods are only used to check # if the current set of max- and minlevel would log the message to the # log file. The levels NOTE, ERR, CRIT and EMERG are just shortcuts. # -------------------------------------------------------------------- BEGIN { for my $level (qw/DEBUG INFO NOTICE NOTE WARNING WARN ERROR ERR CRITICAL CRIT ALERT EMERGENCY EMERG/) { my $routine = lc($level); { # start "no strict 'refs'" block no strict 'refs'; # -------------------------------------------------------------- # Creating the 8 syslog level methods - total 13 with shortcuts: # debug(), info(), notice(), note(), warning(), warn(), error(), # err(), critical(), crit(), alert(), emergency(), emerg() # -------------------------------------------------------------- *{"$routine"} = sub { my $self = shift; return 1 if &{$level} < $self->{minlevel} || &{$level} > $self->{maxlevel}; return $self->_print($level, @_); }; # ------------------------------------------------------------- # Creating the 8 is_ level methods - total 13 with shortcuts: # is_debug(), is_info(), is_notice(), is_note(), is_warning(), # is_warn(), is_error(), is_err(), is_critical(), is_crit() # is_alert(), is_emergency(), is_emerg() # ------------------------------------------------------------- *{"is_$routine"} = sub { my $self = shift; return 1 if &{$level} >= $self->{minlevel} && &{$level} <= $self->{maxlevel}; return undef; }; } # end "no strict 'refs'" block } } sub new { my $class = shift; my %opts = (); my $self = bless \%opts, $class; my $bool = qr/^[10]\z/; my $level = qr/^([0-8]|nothing|debug|info|notice|note|warning|warn |error|err|critical|crit|alert|emergency|emerg)\z/x; %opts = Params::Validate::validate(@_, { filename => { type => Params::Validate::SCALAR | Params::Validate::GLOBREF, default => '*STDOUT', }, filelock => { type => Params::Validate::SCALAR, regex => $bool, default => 1, }, fileopen => { type => Params::Validate::SCALAR, regex => $bool, default => 1, }, reopen => { type => Params::Validate::SCALAR, regex => $bool, default => 1, }, mode => { type => Params::Validate::SCALAR, regex => qr/^(append|excl|trunc)\z/, default => 'excl', }, autoflush => { type => Params::Validate::SCALAR, regex => $bool, default => 1, }, permissions => { type => Params::Validate::SCALAR, regex => qr/^[0-7]{3,4}\z/, default => '0640', }, timeformat => { type => Params::Validate::SCALAR, default => '%b %d %H:%M:%S', }, newline => { type => Params::Validate::SCALAR, regex => $bool, default => 0, }, prefix => { type => Params::Validate::SCALAR, default => '[<--LEVEL-->] ', }, minlevel => { type => Params::Validate::SCALAR, regex => $level, default => 0, }, maxlevel => { type => Params::Validate::SCALAR, regex => $level, default => 4, }, rewrite_to_stderr => { type => Params::Validate::SCALAR, regex => $bool, default => 0, }, die_on_errors => { type => Params::Validate::SCALAR, regex => $bool, default => 1, }, debug => { type => Params::Validate::SCALAR, regex => $bool, default => 0, }, debug_mode => { type => Params::Validate::SCALAR, regex => qr/^[12]\z/, default => 1, }, debug_skip => { type => Params::Validate::SCALAR, regex => qr/^\d+\z/, default => 0, }, utf8 => { type => Params::Validate::SCALAR, regex => $bool, default => 0, }, }); $self->_build_prefix; # convert the level strings to numbers { # start "no strict" block no strict 'refs'; $opts{minlevel} = &{uc($opts{minlevel})} unless $opts{minlevel} =~ /^\d\z/; $opts{maxlevel} = &{uc($opts{maxlevel})} unless $opts{maxlevel} =~ /^\d\z/; } # end "no strict" block # it's possible to set *STDOUT and *STDERR as string if (ref($opts{filename}) eq 'GLOB') { $opts{fh} = $opts{filename}; } elsif ($opts{filename} eq '*STDOUT') { $opts{fh} = \*STDOUT; } elsif ($opts{filename} eq '*STDERR') { $opts{fh} = \*STDERR; } # if filename is a GLOB, then we force some options and return if (defined $opts{fh}) { $opts{fileopen} = 1; # never call _open() and _close() $opts{reopen} = 0; # never try to reopen $opts{filelock} = 0; # no, we won't lock it if ($opts{autoflush}) { my $oldfh = select $opts{fh}; $| = $opts{autoflush}; select $oldfh; } if ($self->{utf8}) { binmode $opts{fh}, ':utf8'; } return $self; } if ($opts{mode} eq 'append') { $opts{mode} = O_WRONLY | O_APPEND | O_CREAT; } elsif ($opts{mode} eq 'excl') { $opts{mode} = O_WRONLY | O_EXCL | O_CREAT; } elsif ($opts{mode} eq 'trunc') { $opts{mode} = O_WRONLY | O_TRUNC | O_CREAT; } $opts{permissions} = oct($opts{permissions}); # open the log file permanent if ($opts{fileopen} == 1) { $self->_open or return undef; if ($opts{reopen}) { $self->{inode} = (stat($self->{filename}))[1]; } } return $self; } sub get_prefix { $_[0]->{prefix} } sub set_prefix { my $self = shift; $self->{prefix} = shift; $self->_build_prefix; } sub trace { my $self = shift; return $self->_print('TRACE', @_); } sub close { my $self = shift; if ($self->{fileopen} == 1) { $self->_close or return undef; } return 1; } # to make it possible to call Log::Handler::Simple->errstr sub errstr { $Log::Handler::Simple::ERRSTR } sub DESTROY { my $self = shift; CORE::close($self->{fh}) if $self->{fh} && !ref($self->{filename}) && $self->{filename} !~ /^\*STDOUT\z|^\*STDERR\z/; } # # private stuff # sub _print { my $self = shift; $self->_pre_print() or return undef; my $msg = $self->_build_message(@_); print {$self->{fh}} $$msg or do { if ($self->{rewrite_to_stderr}) { print STDERR $$msg; } return $self->_raise_error("unable to print to logfile: $!"); }; $self->_post_print() or return undef; return 1; } sub _open { my $self = shift; sysopen(my $fh, $self->{filename}, $self->{mode}, $self->{permissions}) or return $self->_raise_error("unable to open logfile $self->{filename}: $!"); my $oldfh = select $fh; $| = $self->{autoflush}; select $oldfh; binmode $fh, ':utf8' if $self->{utf8}; $self->{fh} = $fh; return 1; } sub _close { my $self = shift; CORE::close($self->{fh}) or return $self->_raise_error("unable to close logfile $self->{filename}: $!"); delete $self->{fh}; return 1; } sub _checkino { my $self = shift; if (-e $self->{filename}) { my $ino = (stat($self->{filename}))[1]; unless ($self->{inode} == $ino) { $self->_close or return undef; $self->_open or return undef; $self->{inode} = $ino; } } else { $self->_close or return undef; $self->_open or return undef; $self->{inode} = (stat($self->{filename}))[1]; } return 1; } sub _lock { my $self = shift; flock($self->{fh}, LOCK_EX) or return $self->_raise_error("unable to lock logfile $self->{filename}: $!"); return 1; } sub _unlock { my $self = shift; flock($self->{fh}, LOCK_UN) or return $self->_raise_error("unable to unlock logfile $self->{filename}: $!"); return 1; } sub _pre_print { my $self = shift; if (!$self->{fileopen}) { $self->_open or return undef; } elsif ($self->{reopen}) { $self->_checkino or return undef; } if ($self->{filelock}) { $self->_lock or return undef; } return 1; } sub _post_print { my $self = shift; if ($self->{filelock}) { $self->_unlock or return undef; } if (!$self->{fileopen}) { $self->_close or return undef; } return 1; } sub _build_message { my $self = shift; my $level = shift; my $message = ''; if ($self->{timeformat}) { $message .= $self->_set_time.' '; } if (length($self->{prefix})) { $message .= join($level, @{$self->{prefixes}}); } if (@_) { $message .= join(' ', @_); } if ($self->{debug} || $level eq 'TRACE') { $message .= "\n" if $message =~ /.\z|^\z/; my $bt = Devel::Backtrace->new($self->{debug_skip}); my $pt = $bt->points - 1; for my $p (reverse 0..$pt) { $message .= ' ' x 3 . "CALL($p):"; my $c = $bt->point($p); for my $k (qw/package filename line subroutine hasargs wantarray evaltext is_require/) { next unless defined $c->{$k}; if ($self->{debug_mode} == 1) { $message .= " $k($c->{$k})"; } elsif ($self->{debug_mode} == 2) { $message .= "\n" . ' ' x 6 . sprintf('%-12s', $k) . $c->{$k}; } } $message .= "\n"; } } elsif ($self->{newline} && $message =~ /.\z|^\z/) { # I hope that works on the most OSs $message .= "\n"; } return \$message; } sub _set_time { my $self = shift; my $time = strftime($self->{timeformat}, localtime); return $time; } sub _build_prefix { my $self = shift; $self->{prefixes} = [ split(/<--LEVEL-->/, $self->{prefix}) ]; } sub _raise_error { my $self = shift; $Log::Handler::Simple::ERRSTR = shift; return undef unless $self->{die_on_errors}; my $class = ref($self); croak "$class: ".$Log::Handler::Simple::ERRSTR; } 1;