Line 0
Link Here
|
|
|
1 |
package Koha::Utils::Logger; |
2 |
|
3 |
# Copyright 2012 Biblibre SARL |
4 |
# |
5 |
# This file is part of Koha. |
6 |
# |
7 |
# Koha is free software; you can redistribute it and/or modify it under the |
8 |
# terms of the GNU General Public License as published by the Free Software |
9 |
# Foundation; either version 2 of the License, or (at your option) any later |
10 |
# version. |
11 |
# |
12 |
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY |
13 |
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR |
14 |
# A PARTICULAR PURPOSE. See the GNU General Public License for more details. |
15 |
# |
16 |
# You should have received a copy of the GNU General Public License along |
17 |
# with Koha; if not, write to the Free Software Foundation, Inc., |
18 |
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
19 |
|
20 |
use Modern::Perl; |
21 |
use Log::LogLite; |
22 |
|
23 |
use base 'Exporter'; |
24 |
our @EXPORT_OK = qw($log); |
25 |
|
26 |
my $UNUSABLE_LOG_LEVEL = 1; |
27 |
my $CRITICAL_LOG_LEVEL = 2; |
28 |
my $ERROR_LOG_LEVEL = 3; |
29 |
my $WARNING_LOG_LEVEL = 4; |
30 |
my $NORMAL_LOG_LEVEL = 5; |
31 |
my $INFO_LOG_LEVEL = 6; |
32 |
my $DEBUG_LOG_LEVEL = 7; |
33 |
|
34 |
my $LEVEL_STR = { |
35 |
$UNUSABLE_LOG_LEVEL => 'UNUS ', |
36 |
$CRITICAL_LOG_LEVEL => 'CRIT ', |
37 |
$ERROR_LOG_LEVEL => 'ERROR ', |
38 |
$WARNING_LOG_LEVEL => 'WARN ', |
39 |
$NORMAL_LOG_LEVEL => 'NORMAL', |
40 |
$INFO_LOG_LEVEL => 'INFO ', |
41 |
$DEBUG_LOG_LEVEL => 'DEBUG ', |
42 |
}; |
43 |
|
44 |
use Data::Dumper; |
45 |
|
46 |
our $log = undef; |
47 |
|
48 |
sub new { |
49 |
my ( $proto, $params ) = @_; |
50 |
|
51 |
return $log |
52 |
if $log |
53 |
and ( not defined $params->{file} |
54 |
or not defined $log->{FILE_PATH} |
55 |
or $params->{file} eq $log->{FILE_PATH} ); |
56 |
my $class = ref($proto) || $proto; |
57 |
my $self = {}; |
58 |
my $LOG_PATH = defined $ENV{KOHA_LOG} ? $ENV{KOHA_LOG} : undef; |
59 |
$self->{FILE_PATH} = defined $params->{file} ? $params->{file} : $LOG_PATH; |
60 |
$self->{LEVEL} = defined $params->{level} ? $params->{level} : $INFO_LOG_LEVEL; |
61 |
$self->{LOGGED_MESSAGES} = []; |
62 |
|
63 |
if ( not defined $self->{FILE_PATH} ) { |
64 |
return bless( $self, $class ); |
65 |
} |
66 |
eval { $self->{LOGGER} = Log::LogLite->new( $self->{FILE_PATH}, $self->{LEVEL} ); }; |
67 |
die "Log system is not correctly configured ($@)" if $@; |
68 |
return bless( $self, $class ); |
69 |
} |
70 |
|
71 |
sub write { |
72 |
my ( $self, $msg, $log_level, $dump, $cb ) = @_; |
73 |
|
74 |
if ( not $self->{LOGGER} ) { |
75 |
if ( $log_level <= $self->{LEVEL} ) { |
76 |
print STDERR "[" . localtime() . "] " . "$LEVEL_STR->{$log_level}: " . $msg . ( $cb ? " (" . $cb . ")" : "" ) . "\n"; |
77 |
} |
78 |
return; |
79 |
} |
80 |
my $template = "[<date>] $LEVEL_STR->{$log_level}: <message>"; |
81 |
$template .= " (caller: $cb)" if $cb; |
82 |
$template .= "\n"; |
83 |
$self->{LOGGER}->template($template); |
84 |
$msg = "\n" . Dumper $msg if $dump; |
85 |
$self->{LOGGER}->write( $msg, $log_level ); |
86 |
|
87 |
if ( $log_level <= $self->{LEVEL} ) { |
88 |
my $message = "[" . localtime() . "] " . "$LEVEL_STR->{$log_level}: " . $msg . ( $cb ? " (" . $cb . ")" : "" ) . "\n"; |
89 |
push( @{ $self->{LOGGED_MESSAGES} }, $message ); |
90 |
} |
91 |
} |
92 |
|
93 |
sub unusable { |
94 |
my ( $self, $msg, $dump ) = @_; |
95 |
my $cb = $self->called_by(); |
96 |
$self->write( $msg, $UNUSABLE_LOG_LEVEL, $dump, $cb ); |
97 |
} |
98 |
|
99 |
sub critical { |
100 |
my ( $self, $msg, $dump ) = @_; |
101 |
my $cb = $self->called_by(); |
102 |
$self->write( $msg, $CRITICAL_LOG_LEVEL, $dump, $cb ); |
103 |
} |
104 |
|
105 |
sub error { |
106 |
my ( $self, $msg, $dump ) = @_; |
107 |
my $cb = $self->called_by(); |
108 |
$self->write( $msg, $ERROR_LOG_LEVEL, $dump, $cb ); |
109 |
} |
110 |
|
111 |
sub warning { |
112 |
my ( $self, $msg, $dump ) = @_; |
113 |
my $cb = $self->called_by(); |
114 |
$self->write( $msg, $WARNING_LOG_LEVEL, $dump, $cb ); |
115 |
} |
116 |
|
117 |
sub log { |
118 |
my ( $self, $msg, $dump ) = @_; |
119 |
$self->write( $msg, $NORMAL_LOG_LEVEL, $dump ); |
120 |
} |
121 |
|
122 |
sub normal { |
123 |
my ( $self, $msg, $dump ) = @_; |
124 |
$self->write( $msg, $NORMAL_LOG_LEVEL, $dump ); |
125 |
} |
126 |
|
127 |
sub info { |
128 |
my ( $self, $msg, $dump ) = @_; |
129 |
$self->write( $msg, $INFO_LOG_LEVEL, $dump ); |
130 |
} |
131 |
|
132 |
sub debug { |
133 |
my ( $self, $msg, $dump ) = @_; |
134 |
$self->write( $msg, $DEBUG_LOG_LEVEL, $dump ); |
135 |
} |
136 |
|
137 |
sub level { |
138 |
my $self = shift; |
139 |
|
140 |
return $self->{LOGGER} |
141 |
? $self->{LOGGER}->level(@_) |
142 |
: ( $self->{LEVEL} = @_ ? shift : $self->{LEVEL} ); |
143 |
} |
144 |
|
145 |
sub called_by { |
146 |
my $self = shift; |
147 |
my $depth = 2; |
148 |
my $args; |
149 |
my $pack; |
150 |
my $file; |
151 |
my $line; |
152 |
my $subr; |
153 |
my $has_args; |
154 |
my $wantarray; |
155 |
my $evaltext; |
156 |
my $is_require; |
157 |
my $hints; |
158 |
my $bitmask; |
159 |
my @subr; |
160 |
my $str = ""; |
161 |
|
162 |
while (1) { |
163 |
( $pack, $file, $line, $subr, $has_args, $wantarray, $evaltext, $is_require, $hints, $bitmask ) = caller($depth); |
164 |
unless ( defined($subr) ) { |
165 |
last; |
166 |
} |
167 |
$depth++; |
168 |
$line = (3) ? "$file:" . $line . "-->" : ""; |
169 |
push( @subr, $line . $subr ); |
170 |
} |
171 |
@subr = reverse(@subr); |
172 |
foreach my $sr (@subr) { |
173 |
$str .= $sr; |
174 |
$str .= " > "; |
175 |
} |
176 |
$str =~ s/ > $/: /; |
177 |
return $str; |
178 |
} # of called_by |
179 |
|
180 |
sub get_messages { |
181 |
my $self = shift; |
182 |
|
183 |
return $self->{LOGGED_MESSAGES}; |
184 |
} |
185 |
|
186 |
1; |