src/perlmods/OpenSRF/Utils/Logger.pm

   1 package OpenSRF::Utils::Logger;
   2 use strict;
   3 use vars qw($AUTOLOAD @EXPORT_OK %EXPORT_TAGS);
   4 use Exporter;
   5 use Unix::Syslog qw(:macros :subs);
   6 use base qw/OpenSRF Exporter/;
   7 use FileHandle;
   8 use Time::HiRes qw(gettimeofday);
   9 use OpenSRF::Utils::Config;
  10 use Fcntl;
  11
  12 =head1
  13
  14 Logger code
  15
  16 my $logger = OpenSRF::Utils::Logger;
  17 $logger->error( $msg );
  18
  19 For backwards compability, a log level may also be provided to each log
  20 function thereby overriding the level defined by the function.
  21
  22 i.e. $logger->error( $msg, WARN );  # logs at log level WARN
  23
  24 =cut
  25
  26 @EXPORT_OK = qw/ NONE ERROR WARN INFO DEBUG INTERNAL /;
  27 push @EXPORT_OK, '$logger';
  28
  29 %EXPORT_TAGS = ( level => [ qw/ NONE ERROR WARN INFO DEBUG INTERNAL / ], logger => [ '$logger' ] );
  30
  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
  43
  44 our $logger = "OpenSRF::Utils::Logger";
  45
  46 # log levels
  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; }
  55
  56 my $isclient;  # true if we control the osrf_xid
  57
  58 # load up our config options
  59 sub set_config {
  60
  61         return if defined $config;
  62
  63         $config = OpenSRF::Utils::Config->current;
  64         if( !defined($config) ) {
  65                 $loglevel = INFO();
  66                 warn "*** Logger found no config.  Using STDERR ***\n";
  67         }
  68
  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(); }
  76
  77         my $logdir = $config->bootstrap->log_dir;
  78
  79         $logfile = $config->bootstrap->logfile;
  80         if($logfile =~ /^syslog/) {
  81                 $syslog_enabled = 1;
  82                 $logfile_enabled = 0;
  83                 $logfile =~ s/^syslog:?//;
  84                 $facility = $logfile;
  85                 $logfile = undef;
  86                 $facility = _fac_to_const($facility);
  87                 openlog($service, 0, $facility);
  88
  89         } else { $logfile = "$logdir/$logfile"; }
  90
  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";
  97                 $actfile = undef;
  98                 $actfac = _fac_to_const($actfac);
  99
 100         } else { $actfile = "$logdir/$actfile"; }
 101
 102         $isclient = (OpenSRF::Utils::Config->current->bootstrap->client =~ /^true$/iog) ?  1 : 0;
 103 }
 104
 105 sub _fac_to_const {
 106         my $name = shift;
 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;
 116         return LOG_LOCAL0;
 117 }
 118
 119 sub is_syslog {
 120         set_config();
 121         return $syslog_enabled;
 122 }
 123
 124 sub is_act_syslog {
 125         set_config();
 126         return $act_syslog_enabled;
 127 }
 128
 129 sub is_filelog {
 130         set_config();
 131         return $logfile_enabled;
 132 }
 133
 134 sub is_act_filelog {
 135         set_config();
 136         return $act_logfile_enabled;
 137 }
 138
 139 sub set_service {
 140         my( $self, $svc ) = @_;
 141         $service = $svc;
 142         if( is_syslog() ) {
 143                 closelog();
 144                 openlog($service, 0, $facility);
 145         }
 146 }
 147
 148 sub error {
 149         my( $self, $msg, $level ) = @_;
 150         $level = ERROR() unless defined ($level);
 151         _log_message( $msg, $level );
 152 }
 153
 154 sub warn {
 155         my( $self, $msg, $level ) = @_;
 156         $level = WARN() unless defined ($level);
 157         _log_message( $msg, $level );
 158 }
 159
 160 sub info {
 161         my( $self, $msg, $level ) = @_;
 162         $level = INFO() unless defined ($level);
 163         _log_message( $msg, $level );
 164 }
 165
 166 sub debug {
 167         my( $self, $msg, $level ) = @_;
 168         $level = DEBUG() unless defined ($level);
 169         _log_message( $msg, $level );
 170 }
 171
 172 sub internal {
 173         my( $self, $msg, $level ) = @_;
 174         $level = INTERNAL() unless defined ($level);
 175         _log_message( $msg, $level );
 176 }
 177
 178 sub activity {
 179         my( $self, $msg ) = @_;
 180         _log_message( $msg, ACTIVITY() );
 181 }
 182
 183 # for backward compability
 184 sub transport {
 185         my( $self, $msg, $level ) = @_;
 186         $level = DEBUG() unless defined ($level);
 187         _log_message( $msg, $level );
 188 }
 189
 190
 191 # ----------------------------------------------------------------------
 192 # creates a new xid if necessary
 193 # ----------------------------------------------------------------------
 194 my $osrf_xid = '';
 195 my $osrf_xid_inc = 0;
 196 sub mk_osrf_xid {
 197    return unless $isclient;
 198    $osrf_xid_inc++;
 199    return $osrf_xid = "$^T${$}$osrf_xid_inc";
 200 }
 201
 202 sub set_osrf_xid {
 203    return if $isclient; # if we're a client, we control our xid
 204    $osrf_xid = $_[1];
 205 }
 206
 207 sub get_osrf_xid { return $osrf_xid; }
 208 # ----------------------------------------------------------------------
 209
 210
 211 sub _log_message {
 212         my( $msg, $level ) = @_;
 213         return if $level > $loglevel;
 214
 215         my $l; my $n;
 216         my $fac = $facility;
 217
 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; }
 224
 225         my( undef, $file, $line_no ) = caller(1);
 226    $file =~ s#/.*/##og;
 227
 228         # help syslog with the formatting
 229         $msg =~ s/\%/\%\%/gso if( is_act_syslog() or is_syslog() );
 230
 231         $msg = "[$n:"."$$".":$file:$line_no:$osrf_xid] $msg";
 232
 233         $msg = substr($msg, 0, 1536);
 234
 235         if( $level == ACTIVITY() ) {
 236                 if( is_act_syslog() ) { syslog( $fac | $l, $msg ); }
 237                 elsif( is_act_filelog() ) { _write_file( $msg, 1 ); }
 238
 239         } else {
 240                 if( is_syslog() ) { syslog( $fac | $l, $msg ); }
 241                 elsif( is_filelog() ) { _write_file($msg); }
 242         }
 243 }
 244
 245
 246 sub _write_file {
 247         my( $msg, $isact) = @_;
 248         my $file = $logfile;
 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";
 256         close( SINK );
 257 }
 258
 259
 260
 261 1;