3 use constant NONE => 0;
4 use constant INFO => 1;
5 use constant DEBUG1 => 1 << 1;
6 use constant DEBUG2 => 1 << 2;
7 use constant QUERY => 1 << 3;
8 use constant TRACE => 1 << 4;
9 use constant BACKTRACE_ON_ERROR => 1 << 5;
10 use constant REQUEST_TIMER => 1 << 6;
11 use constant WARN => 1 << 7;
12 use constant ALL => (1 << 8) - 1;
13 use constant DEVEL => INFO | QUERY | TRACE | BACKTRACE_ON_ERROR | REQUEST_TIMER;
15 use constant FILE_TARGET => 0;
16 use constant STDERR_TARGET => 1;
18 use POSIX qw(strftime getppid);
19 use Time::HiRes qw(gettimeofday tv_interval);
24 my $data_dumper_available;
31 eval("use Data::Dumper");
32 $data_dumper_available = $@ ? 0 : 1;
42 $self->{"calldepth"} = 0;
43 $self->{"file"} = $file_name || "/tmp/lx-office-debug.log";
44 $self->{"target"} = FILE_TARGET;
48 $self->{ $_[0] } = $_[1];
57 my ($self, $target, $file) = @_;
59 if ((FILE_TARGET == $target) && $file) {
60 $self->{"file"} = $file;
61 $self->{"target"} = FILE_TARGET;
63 } elsif (STDERR_TARGET == $target) {
64 $self->{"target"} = STDERR_TARGET;
70 my $level = shift || 0;
72 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
73 return 1 if $level && !($global_level & $level); # ignore if level of trace isn't active
75 my ($package, $filename, $line, $subroutine) = caller(1);
76 my ($dummy1, $self_filename, $self_line) = caller(0);
78 my $indent = " " x $self->{"calldepth"}++;
79 my $time = $self->get_request_time || '';
81 if (!defined($package)) {
82 $self->_write('sub' . $level, $indent . "\\ $time top-level?\n");
84 $self->_write('sub' . $level, $indent
85 . "\\ $time ${subroutine} in "
86 . "${self_filename}:${self_line} called from "
87 . "${filename}:${line}\n");
94 my $level = shift || 0;
96 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
97 return 1 if $level && !($global_level & $level); # ignore if level of trace isn't active
99 my ($package, $filename, $line, $subroutine) = caller(1);
100 my ($dummy1, $self_filename, $self_line) = caller(0);
102 my $indent = " " x --$self->{"calldepth"};
103 my $time = $self->want_request_timer ? $self->get_request_time : '';
105 if (!defined($package)) {
106 $self->_write('sub' . $level, $indent . "/ $time top-level?\n");
108 $self->_write('sub' . $level, $indent . "/ $time ${subroutine} in " . "${self_filename}:${self_line}\n");
114 my ($self, $force) = @_;
116 return 1 unless ($force || ($global_level & BACKTRACE_ON_ERROR));
118 $self->message(BACKTRACE_ON_ERROR, "Starting full caller dump:");
120 while (my ($dummy, $filename, $line, $subroutine) = caller $level) {
121 $self->message(BACKTRACE_ON_ERROR, " ${subroutine} from ${filename}:${line}");
130 my ($self, $level, $message) = @_;
132 $self->_write(level2string($level), $message) if (($self->{"level"} | $global_level) & $level || !$level);
136 my ($self, $message) = @_;
137 $self->message(WARN, $message);
141 my ($self, $level, $name, $variable) = @_;
143 if ($data_dumper_available) {
145 if ($variable && ('Form' eq ref $variable) && defined $variable->{password}) {
146 $password = $variable->{password};
147 $variable->{password} = 'X' x 8;
150 my $dumper = Data::Dumper->new([$variable]);
151 $dumper->Sortkeys(1);
152 $self->message($level, "dumping ${name}:\n" . $dumper->Dump());
154 $variable->{password} = $password if (defined $password);
156 # Data::Dumper does not reset the iterator belonging to this hash
157 # if 'Sortkeys' is true. Therefore clear the iterator manually.
158 # See "perldoc -f each".
159 if ($variable && (('HASH' eq ref $variable) || ('Form' eq ref $variable))) {
164 $self->message($level,
165 "dumping ${name}: Data::Dumper not available; "
166 . "variable cannot be dumped");
171 my ($self, $level, $name, $variable) = @_;
173 $self->message($level, "dumping ${name}:\n" . YAML::Dump($variable));
176 sub dump_sql_result {
177 my ($self, $level, $prefix, $results) = @_;
179 if (!$results || !scalar @{ $results }) {
180 $self->message($level, "Empty result set");
184 my %column_lengths = map { $_, length $_ } keys %{ $results->[0] };
186 foreach my $row (@{ $results }) {
187 map { $column_lengths{$_} = length $row->{$_} if (length $row->{$_} > $column_lengths{$_}) } keys %{ $row };
190 my @sorted_names = sort keys %column_lengths;
191 my $format = join '|', map { '%' . $column_lengths{$_} . 's' } @sorted_names;
193 $prefix .= ' ' if $prefix;
195 $self->message($level, $prefix . sprintf($format, @sorted_names));
196 $self->message($level, $prefix . join('+', map { '-' x $column_lengths{$_} } @sorted_names));
198 foreach my $row (@{ $results }) {
199 $self->message($level, $prefix . sprintf($format, map { $row->{$_} } @sorted_names));
201 $self->message($level, $prefix . sprintf('(%d row%s)', scalar @{ $results }, scalar @{ $results } > 1 ? 's' : ''));
204 sub enable_sub_tracing {
206 $global_level |= TRACE;
209 sub disable_sub_tracing {
211 $global_level &= ~ TRACE;
214 sub is_tracing_enabled {
216 return $global_level & TRACE;
221 my ($self, $prefix, $message) = @_;
222 my $date = strftime("%Y-%m-%d %H:%M:%S $$ [" . getppid() . "] ${prefix}: ", localtime(time()));
227 if ((FILE_TARGET == $self->{"target"})
228 && open(FILE, ">>" . $self->{"file"})) {
229 print(FILE "${date}${message}\n");
232 } elsif (STDERR_TARGET == $self->{"target"}) {
233 print(STDERR "${date}${message}\n");
239 # use $_[0] as a bit mask and return levelstrings separated by /
240 join '/', qw(info debug1 debug2 query trace error_call_trace request_timer WARNING)[ grep { (reverse split //, sprintf "%08b", $_[0])[$_] } 0..7 ]
245 return 1 unless want_request_timer();
246 $self->set_request_timer;
251 return 1 unless want_request_timer();
252 $self->_write("time", $self->get_request_time);
254 $self->{calldepth} = 0;
259 return 1 unless want_request_timer();
260 $self->_write("time", $self->get_request_time);
263 sub get_request_time {
265 return $self->want_request_timer && $self->{request_start} ? tv_interval($self->{request_start}) : undef;
268 sub set_request_timer {
270 $self->{request_start} = [gettimeofday];
273 sub want_request_timer {
274 $global_level & REQUEST_TIMER;