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