Perl SIGHUP handling and config reloading
[OpenSRF.git] / src / perl / lib / 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 = INFO();  # 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 $max_log_msg_len = 1536; # SYSLOG default maximum is 2048
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     my $force = shift;
61
62     return if defined $config and !$force;
63
64     $config = OpenSRF::Utils::Config->current;
65     if( !defined($config) ) {
66         $loglevel = INFO();
67         warn "*** Logger found no config.  Using STDERR ***\n";
68         return;
69     }
70
71     $loglevel =  $config->bootstrap->loglevel; 
72
73     if ($config->bootstrap->loglength) {
74         $max_log_msg_len = $config->bootstrap->loglength;
75     }
76
77     $logfile = $config->bootstrap->logfile;
78     if($logfile =~ /^syslog/) {
79         $syslog_enabled = 1;
80         $logfile_enabled = 0;
81         $logfile = $config->bootstrap->syslog;
82         $facility = $logfile;
83         $logfile = undef;
84         $facility = _fac_to_const($facility);
85         openlog($service, 0, $facility);
86
87     } else { $logfile = "$logfile"; }
88
89
90     if($syslog_enabled) {
91         # --------------------------------------------------------------
92         # if we're syslogging, see if we have a special syslog facility 
93         # for activity logging.  If not, use the syslog facility for
94         # standard logging
95         # --------------------------------------------------------------
96         $act_syslog_enabled = 1;
97         $act_logfile_enabled = 0;
98         $actfac = $config->bootstrap->actlog || $config->bootstrap->syslog;
99         $actfac = _fac_to_const($actfac);
100         $actfile = undef;
101     } else {
102         # --------------------------------------------------------------
103         # we're not syslogging, use any specified activity log file.
104         # Fall back to the standard log file otherwise
105         # --------------------------------------------------------------
106         $act_syslog_enabled = 0;
107         $act_logfile_enabled = 1;
108         $actfile = $config->bootstrap->actlog || $config->bootstrap->logfile;
109     }
110
111     my $client = OpenSRF::Utils::Config->current->bootstrap->client();
112
113     if ($ENV{OSRF_LOG_CLIENT} or $ENV{MOD_PERL}) {
114         $isclient = 1;
115         return;
116     }
117
118     if (!$client) {
119         $isclient = 0;
120         return;
121     }
122     $isclient = ($client =~ /^true$/iog) ?  1 : 0;
123 }
124
125 sub _fac_to_const {
126     my $name = shift;
127     return LOG_LOCAL0 unless $name;
128     return LOG_LOCAL0 if $name =~ /local0/i;
129     return LOG_LOCAL1 if $name =~ /local1/i;
130     return LOG_LOCAL2 if $name =~ /local2/i;
131     return LOG_LOCAL3 if $name =~ /local3/i;
132     return LOG_LOCAL4 if $name =~ /local4/i;
133     return LOG_LOCAL5 if $name =~ /local5/i;
134     return LOG_LOCAL6 if $name =~ /local6/i;
135     return LOG_LOCAL7 if $name =~ /local7/i;
136     return LOG_LOCAL0;
137 }
138
139 sub is_syslog {
140     set_config();
141     return $syslog_enabled;
142 }
143
144 sub is_act_syslog {
145     set_config();
146     return $act_syslog_enabled;
147 }
148
149 sub is_filelog {
150     set_config();
151     return $logfile_enabled;
152 }
153
154 sub is_act_filelog {
155     set_config();
156     return $act_logfile_enabled;
157 }
158
159 sub set_service {
160     my( $self, $svc ) = @_;
161     $service = $svc;    
162     if( is_syslog() ) {
163         closelog();
164         openlog($service, 0, $facility);
165     }
166 }
167
168 sub error {
169     my( $self, $msg, $level ) = @_;
170     $level = ERROR() unless defined ($level);
171     _log_message( $msg, $level );
172 }
173
174 sub warn {
175     my( $self, $msg, $level ) = @_;
176     $level = WARN() unless defined ($level);
177     _log_message( $msg, $level );
178 }
179
180 sub info {
181     my( $self, $msg, $level ) = @_;
182     $level = INFO() unless defined ($level);
183     _log_message( $msg, $level );
184 }
185
186 sub debug {
187     my( $self, $msg, $level ) = @_;
188     $level = DEBUG() unless defined ($level);
189     _log_message( $msg, $level );
190 }
191
192 sub internal {
193     my( $self, $msg, $level ) = @_;
194     $level = INTERNAL() unless defined ($level);
195     _log_message( $msg, $level );
196 }
197
198 sub activity {
199     my( $self, $msg ) = @_;
200     _log_message( $msg, ACTIVITY() );
201 }
202
203 # for backward compability
204 sub transport {
205     my( $self, $msg, $level ) = @_;
206     $level = DEBUG() unless defined ($level);
207     _log_message( $msg, $level );
208 }
209
210
211 # ----------------------------------------------------------------------
212 # creates a new xid if necessary
213 # ----------------------------------------------------------------------
214 my $osrf_xid = '';
215 my $osrf_xid_inc = 0;
216 sub mk_osrf_xid {
217    return unless $isclient;
218    $osrf_xid_inc++;
219    return $osrf_xid = "$^T${$}$osrf_xid_inc";
220 }
221
222 sub set_osrf_xid { 
223    return if $isclient; # if we're a client, we control our xid
224    $osrf_xid = $_[1]; 
225 }
226
227 sub get_osrf_xid { return $osrf_xid; }
228 # ----------------------------------------------------------------------
229
230    
231 sub _log_message {
232     my( $msg, $level ) = @_;
233     return if $level > $loglevel;
234
235     my $l; my $n; 
236     my $fac = $facility;
237
238     if ($level == ERROR())            {$l = LOG_ERR; $n = "ERR "; }
239     elsif ($level == WARN())        {$l = LOG_WARNING; $n = "WARN"; }
240     elsif ($level == INFO())        {$l = LOG_INFO; $n = "INFO"; }    
241     elsif ($level == DEBUG())        {$l = LOG_DEBUG; $n = "DEBG"; }
242     elsif ($level == INTERNAL())    {$l = LOG_DEBUG; $n = "INTL"; }
243     elsif ($level == ACTIVITY())    {$l = LOG_INFO; $n = "ACT"; $fac = $actfac; }
244
245     my( undef, $file, $line_no ) = caller(1);
246    $file =~ s#/.*/##og;
247
248     # help syslog with the formatting
249     $msg =~ s/\%/\%\%/gso if( is_act_syslog() or is_syslog() );
250
251     $msg = "[$n:"."$$".":$file:$line_no:$osrf_xid] $msg";
252
253     # Trim the message to the configured maximum log message length
254     $msg = substr($msg, 0, $max_log_msg_len); 
255
256     if( $level == ACTIVITY() ) {
257         if( is_act_syslog() ) { syslog( $fac | $l, $msg ); } 
258         elsif( is_act_filelog() ) { _write_file( $msg, 1 ); }
259
260     } else {
261         if( is_syslog() ) { syslog( $fac | $l, $msg ); }
262         elsif( is_filelog() ) { _write_file($msg); }
263     }
264
265     return $msg;
266 }
267
268 sub _write_file {
269     my ($msg, $isact) = @_;
270     my $file = $isact ? $actfile : $logfile;
271     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);  
272     $year += 1900; $mon += 1;
273
274     if ($file) {
275         sysopen( SINK, $file, O_NONBLOCK|O_WRONLY|O_APPEND|O_CREAT ) 
276             or die "Cannot sysopen $file: $!";
277     } else {
278         open (SINK, ">&2");  # print to STDERR as warned
279     }
280     binmode(SINK, ':utf8');
281     printf SINK "[%04d-%02d-%02d %02d:%02d:%02d] %s %s\n", $year, $mon, $mday, $hour, $min, $sec, $service, $msg;
282     close( SINK );
283 }
284
285 1;
286