1 package OpenSRF::Utils::Logger;
3 use vars qw($AUTOLOAD @EXPORT_OK %EXPORT_TAGS);
5 use Unix::Syslog qw(:macros :subs);
6 use base qw/OpenSRF Exporter/;
8 use Time::HiRes qw(gettimeofday);
9 use OpenSRF::Utils::Config;
16 my $logger = OpenSRF::Utils::Logger;
17 $logger->error( $msg );
19 For backwards compability, a log level may also be provided to each log
20 function thereby overriding the level defined by the function.
22 i.e. $logger->error( $msg, WARN ); # logs at log level WARN
26 @EXPORT_OK = qw/ NONE ERROR WARN INFO DEBUG INTERNAL /;
27 push @EXPORT_OK, '$logger';
29 %EXPORT_TAGS = ( level => [ qw/ NONE ERROR WARN INFO DEBUG INTERNAL / ], logger => [ '$logger' ] );
31 my $config; # config handle
32 my $loglevel; # global log level
33 my $logfile; # log file
34 my $facility; # syslog facility
35 my $actfac; # activity log syslog facility
36 my $actfile; # activity log file
37 my $service = $0; # default service name
38 my $syslog_enabled = 0; # is syslog enabled?
39 my $act_syslog_enabled = 0; # is syslog enabled?
40 my $logfile_enabled = 1; # are we logging to a file?
41 my $act_logfile_enabled = 1; # are we logging to a file?
42 my $logdir; # log file directory
44 our $logger = "OpenSRF::Utils::Logger";
47 sub ACTIVITY { return -1; }
48 sub NONE { return 0; }
49 sub ERROR { return 1; }
50 sub WARN { return 2; }
51 sub INFO { return 3; }
52 sub DEBUG { return 4; }
53 sub INTERNAL { return 5; }
54 sub ALL { return 100; }
56 my $isclient; # true if we control the osrf_xid
58 # load up our config options
61 return if defined $config;
63 $config = OpenSRF::Utils::Config->current;
64 if( !defined($config) ) {
66 warn "*** Logger found no config. Using STDERR ***\n";
69 $loglevel = $config->bootstrap->debug;
70 if($loglevel =~ /error/i){ $loglevel = ERROR(); }
71 elsif($loglevel =~ /warn/i){ $loglevel = WARN(); }
72 elsif($loglevel =~ /info/i){ $loglevel = INFO(); }
73 elsif($loglevel =~ /debug/i){ $loglevel = DEBUG(); }
74 elsif($loglevel =~ /internal/i){ $loglevel = INTERNAL(); }
75 else{$loglevel= INFO(); }
77 my $logdir = $config->bootstrap->log_dir;
79 $logfile = $config->bootstrap->logfile;
80 if($logfile =~ /^syslog/) {
83 $logfile =~ s/^syslog:?//;
86 $facility = _fac_to_const($facility);
87 openlog($service, 0, $facility);
89 } else { $logfile = "$logdir/$logfile"; }
91 $actfile = $config->bootstrap->actlog;
92 if($actfile =~ /^syslog/) {
93 $act_syslog_enabled = 1;
94 $act_logfile_enabled = 0;
95 $actfile =~ s/^syslog:?//;
96 $actfac = $actfile || "local1";
98 $actfac = _fac_to_const($actfac);
100 } else { $actfile = "$logdir/$actfile"; }
102 $isclient = (OpenSRF::Utils::Config->current->bootstrap->client =~ /^true$/iog) ? 1 : 0;
107 return LOG_LOCAL0 unless $name;
108 return LOG_LOCAL0 if $name =~ /local0/i;
109 return LOG_LOCAL1 if $name =~ /local1/i;
110 return LOG_LOCAL2 if $name =~ /local2/i;
111 return LOG_LOCAL3 if $name =~ /local3/i;
112 return LOG_LOCAL4 if $name =~ /local4/i;
113 return LOG_LOCAL5 if $name =~ /local5/i;
114 return LOG_LOCAL6 if $name =~ /local6/i;
115 return LOG_LOCAL7 if $name =~ /local7/i;
121 return $syslog_enabled;
126 return $act_syslog_enabled;
131 return $logfile_enabled;
136 return $act_logfile_enabled;
140 my( $self, $svc ) = @_;
144 openlog($service, 0, $facility);
149 my( $self, $msg, $level ) = @_;
150 $level = ERROR() unless defined ($level);
151 _log_message( $msg, $level );
155 my( $self, $msg, $level ) = @_;
156 $level = WARN() unless defined ($level);
157 _log_message( $msg, $level );
161 my( $self, $msg, $level ) = @_;
162 $level = INFO() unless defined ($level);
163 _log_message( $msg, $level );
167 my( $self, $msg, $level ) = @_;
168 $level = DEBUG() unless defined ($level);
169 _log_message( $msg, $level );
173 my( $self, $msg, $level ) = @_;
174 $level = INTERNAL() unless defined ($level);
175 _log_message( $msg, $level );
179 my( $self, $msg ) = @_;
180 _log_message( $msg, ACTIVITY() );
183 # for backward compability
185 my( $self, $msg, $level ) = @_;
186 $level = DEBUG() unless defined ($level);
187 _log_message( $msg, $level );
191 # ----------------------------------------------------------------------
192 # creates a new xid if necessary
193 # ----------------------------------------------------------------------
195 my $osrf_xid_inc = 0;
197 return unless $isclient;
199 return $osrf_xid = "$^T${$}$osrf_xid_inc";
203 return if $isclient; # if we're a client, we control our xid
207 sub get_osrf_xid { return $osrf_xid; }
208 # ----------------------------------------------------------------------
212 my( $msg, $level ) = @_;
213 return if $level > $loglevel;
218 if ($level == ERROR()) {$l = LOG_ERR; $n = "ERR "; }
219 elsif ($level == WARN()) {$l = LOG_WARNING; $n = "WARN"; }
220 elsif ($level == INFO()) {$l = LOG_INFO; $n = "INFO"; }
221 elsif ($level == DEBUG()) {$l = LOG_DEBUG; $n = "DEBG"; }
222 elsif ($level == INTERNAL()) {$l = LOG_DEBUG; $n = "INTL"; }
223 elsif ($level == ACTIVITY()) {$l = LOG_INFO; $n = "ACT"; $fac = $actfac; }
225 my( undef, $file, $line_no ) = caller(1);
228 # help syslog with the formatting
229 $msg =~ s/\%/\%\%/gso if( is_act_syslog() or is_syslog() );
231 $msg = "[$n:"."$$".":$file:$line_no:$osrf_xid] $msg";
233 $msg = substr($msg, 0, 1536);
235 if( $level == ACTIVITY() ) {
236 if( is_act_syslog() ) { syslog( $fac | $l, $msg ); }
237 elsif( is_act_filelog() ) { _write_file( $msg, 1 ); }
240 if( is_syslog() ) { syslog( $fac | $l, $msg ); }
241 elsif( is_filelog() ) { _write_file($msg); }
247 my( $msg, $isact) = @_;
249 $file = $actfile if $isact;
250 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
251 $year += 1900; $mon += 1;
252 sysopen( SINK, $file, O_NONBLOCK|O_WRONLY|O_APPEND|O_CREAT )
253 or die "Cannot sysopen $logfile: $!";
254 binmode(SINK, ':utf8');
255 print SINK "[$year-$mon-$mday $hour:$min:$sec] $service $msg\n";