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 REQUEST => 1 << 7;
12 use constant WARN => 1 << 8;
13 use constant TRACE2 => 1 << 9;
14 use constant ALL => (1 << 10) - 1;
15 use constant DEVEL => INFO | DEBUG1 | QUERY | TRACE | BACKTRACE_ON_ERROR | REQUEST_TIMER;
17 use constant FILE_TARGET => 0;
18 use constant STDERR_TARGET => 1;
21 use POSIX qw(strftime getppid);
22 use Time::HiRes qw(gettimeofday tv_interval);
28 my ($text_diff_available);
30 our $global_level = NONE();
38 _init_globals_from_config();
40 $self->{"calldepth"} = 0;
41 $self->{"file"} = $file_name || "/tmp/lx-office-debug.log";
42 $self->{"target"} = FILE_TARGET;
46 $self->{ $_[0] } = $_[1];
54 my $globals_inited_from_config;
55 sub _init_globals_from_config {
56 return if $globals_inited_from_config;
57 $globals_inited_from_config = 1;
59 my $cfg = $::lx_office_conf{debug} || {};
61 $global_level = NONE() if $cfg->{global_level} =~ /NONE/;
62 foreach my $level (grep { $_} split(m/\s+/, $cfg->{global_level})) {
63 $global_level |= eval "${level}()";
66 $watch_form = $cfg->{watch_form};
67 $file_name = $cfg->{file_name} || "/tmp/lx-office-debug.log";
71 my ($self, $target, $file) = @_;
73 if ((FILE_TARGET == $target) && $file) {
74 $self->{"file"} = $file;
75 $self->{"target"} = FILE_TARGET;
77 } elsif (STDERR_TARGET == $target) {
78 $self->{"target"} = STDERR_TARGET;
84 my $level = shift || 0;
86 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
87 return 1 if $level && !($global_level & TRACE2); # ignore if level of trace isn't active
89 my ($package, $filename, $line, $subroutine) = caller(1);
90 my ($dummy1, $self_filename, $self_line) = caller(0);
92 my $indent = " " x $self->{"calldepth"}++;
93 my $time = $self->get_request_time || '';
95 if (!defined($package)) {
96 $self->_write('sub' . $level, $indent . "\\ $time top-level?\n");
98 $self->_write('sub' . $level, $indent
99 . "\\ $time ${subroutine} in "
100 . "${self_filename}:${self_line} called from "
101 . "${filename}:${line}\n");
108 my $level = shift || 0;
110 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
111 return 1 if $level && !($global_level & TRACE2); # ignore if level of trace isn't active
113 my ($package, $filename, $line, $subroutine) = caller(1);
114 my ($dummy1, $self_filename, $self_line) = caller(0);
116 my $indent = " " x --$self->{"calldepth"};
117 my $time = $self->want_request_timer ? $self->get_request_time || '' : '';
119 if (!defined($package)) {
120 $self->_write('sub' . $level, $indent . "/ $time top-level?\n");
122 $self->_write('sub' . $level, $indent . "/ $time ${subroutine} in " . "${self_filename}:${self_line}\n");
128 my ($self, $force) = @_;
130 return 1 unless ($force || ($global_level & BACKTRACE_ON_ERROR));
132 $self->message(0, "Starting full caller dump:");
134 while (my ($dummy, $filename, $line, $subroutine) = caller $level) {
135 $self->message(0, " ${subroutine} from ${filename}:${line}");
144 my ($self, $level, $message) = @_;
146 $self->_write(level2string($level), $message) if (($self->{"level"} | $global_level) & $level || !$level);
150 my ($self, $message) = @_;
151 $self->message(WARN, $message);
155 my ($self, $level, $name, $variable, %options) = @_;
158 if ($variable && ('Form' eq ref $variable) && defined $variable->{password}) {
159 $password = $variable->{password};
160 $variable->{password} = 'X' x 8;
163 my $dumper = Data::Dumper->new([$variable]);
164 $dumper->Sortkeys(1);
166 $dumper->$_($options{$_}) for keys %options;
167 my $output = $dumper->Dump();
168 $self->message($level, "dumping ${name}:\n" . $output);
170 $variable->{password} = $password if (defined $password);
172 # Data::Dumper does not reset the iterator belonging to this hash
173 # if 'Sortkeys' is true. Therefore clear the iterator manually.
174 # See "perldoc -f each".
175 if ($variable && (('HASH' eq ref $variable) || ('Form' eq ref $variable))) {
183 my ($self, $level, $name, $variable) = @_;
185 $self->message($level, "dumping ${name}:\n" . YAML::Dump($variable));
188 sub dump_sql_result {
189 my ($self, $level, $prefix, $results) = @_;
191 if (!$results || !scalar @{ $results }) {
192 $self->message($level, "Empty result set");
196 my %column_lengths = map { $_, length $_ } keys %{ $results->[0] };
198 foreach my $row (@{ $results }) {
199 map { $column_lengths{$_} = length $row->{$_} if (length $row->{$_} > $column_lengths{$_}) } keys %{ $row };
202 my @sorted_names = sort keys %column_lengths;
203 my $format = join '|', map { '%' . $column_lengths{$_} . 's' } @sorted_names;
205 $prefix .= ' ' if $prefix;
207 $self->message($level, $prefix . sprintf($format, @sorted_names));
208 $self->message($level, $prefix . join('+', map { '-' x $column_lengths{$_} } @sorted_names));
210 foreach my $row (@{ $results }) {
211 $self->message($level, $prefix . sprintf($format, map { $row->{$_} } @sorted_names));
213 $self->message($level, $prefix . sprintf('(%d row%s)', scalar @{ $results }, scalar @{ $results } > 1 ? 's' : ''));
217 my ($self, $level, $text, $object) = @_;
221 $copy->{$_} = $object->$_ for $object->meta->columns;
224 $self->dump($level, $text, $copy);
228 my ($self, $level, $item1, $item2, %params) = @_;
230 if (!$self->_load_text_diff) {
231 $self->warn("Perl module Text::Diff is not available");
235 my @texts = map { ref $_ ? YAML::Dump($_) : $_ } ($item1, $item2);
237 $self->message($level, Text::Diff::diff(\$texts[0], \$texts[1], \%params));
240 sub _load_text_diff {
241 $text_diff_available = eval("use Text::Diff (); 1;") ? 1 : 0 unless defined $text_diff_available;
242 return $text_diff_available;
245 sub enable_sub_tracing {
247 $global_level |= TRACE;
250 sub disable_sub_tracing {
252 $global_level &= ~ TRACE;
255 sub is_tracing_enabled {
257 return $global_level & TRACE;
262 my ($self, $prefix, $message) = @_;
263 my @now = gettimeofday();
264 my $date = strftime("%Y-%m-%d %H:%M:%S." . sprintf('%03d', int($now[1] / 1000)) . " $$ [" . getppid() . "] ${prefix}: ", localtime($now[0]));
268 $self->_write_raw("${date}${message}\n");
272 my ($self, $message) = @_;
274 if ((FILE_TARGET == $self->{"target"})
275 && open(FILE, ">>", $self->{"file"})) {
279 } elsif (STDERR_TARGET == $self->{"target"}) {
280 print STDERR $message;
286 # use $_[0] as a bit mask and return levelstrings separated by /
287 join '/', qw(info debug1 debug2 query trace error_call_trace request_timer WARNING)[ grep { (reverse split //, sprintf "%08b", $_[0])[$_] } 0..7 ]
292 return 1 unless want_request_timer();
293 $self->set_request_timer;
298 return 1 unless want_request_timer();
299 $self->_write("time", $self->get_request_time);
301 $self->{calldepth} = 0;
305 my ($self, @slurp) = @_;
306 return 1 unless want_request_timer();
308 my $now = $self->get_request_time;
309 my $diff = int((($now - ($self->{previous_log_time} // 0)) * 10_000 + 5) / 10);
310 $self->{previous_log_time} = $now;
312 $self->_write("time", "${now}s Δ ${diff}ms" . (@slurp ? " (@slurp)" : ''));
315 sub get_request_time {
317 return $self->want_request_timer && $self->{request_start} ? tv_interval($self->{request_start}) : undef;
320 sub set_request_timer {
322 $self->{request_start} = [gettimeofday];
325 sub want_request_timer {
326 $global_level & REQUEST_TIMER;
330 @_ == 2 ? $_[0]->{file} = $_[1] : $_[0]->{file};
334 my ($self, $level) = @_;
335 my $meth = $self->can(uc $level);
336 die 'unknown level' unless $meth;
341 my ($self, $level, $val) = @_;
343 $global_level |= $self->_by_name($level) if $val;
344 $global_level &= ~$self->_by_name($level) if !$val;
346 return $global_level & $self->_by_name($level);
349 sub is_request_logging_enabled {
351 return $global_level & REQUEST;
354 sub add_request_params {
355 my ($self, $key, $value) = @_;
356 return unless $self->is_request_logging_enabled;
357 return if $key =~ /password/;
359 push @{ $::request->{debug}{PARAMS} ||= [] }, [ $key => $value ];
363 my ($self, $type, $controller, $action) = @_;
364 return unless $self->is_request_logging_enabled;
366 my $session_id = $::auth->create_or_refresh_session;
368 my $template = <<EOL;
369 *************************************
370 $ENV{REQUEST_METHOD} $ENV{SCRIPT_NAME} $session_id ($::myconfig{login})
371 routing: $type, controller: $controller, action: $action
374 $self->_write('Request', $template);
376 my $params = join "\n ", map {
378 } @{ $::request->{debug}{PARAMS} || [] };
380 $self->_write_raw(<<EOL);
396 LXDebug - kivitendo debugging facilities
400 This module provides functions for debugging kivitendo. An instance is
401 always created as the global variable C<$::lxdebug> at the earliest
404 Debugging is mostly logging of information. Each log function has a
405 I<level> and an I<object> to be logged. The configuration file as well
406 as this module's functions determine which levels get logged, and
407 which file they're logged to.
411 The available log levels are:
417 Always output the message regardless of the active levels. Only use
422 Informational, not an error, more important than C<DEBUG1>.
426 Important debugging information.
430 Less important debugging information that occurs often and spams the
435 Log all queries executed by the L<SL::DBUtils> utility methods.
439 Log sub calls and exits via the L<enter_sub>/L<leave_sub> functions,
440 but only if they're called with a log level that is falsish
441 (e.g. none, C<undef>, 0).
445 Log sub calls and exits via the L<enter_sub>/L<leave_sub> functions
446 even if they're called with a log level of 2. Will only have an effect
447 if C<TRACE> is set as well.
449 =item C<BACKTRACE_ON_ERROR>
451 Log a stack trace when an error is output.
453 =item C<REQUEST_TIMER>
455 Log each request's total execution time when it finishes.
467 Shortcut for C<INFO | QUERY | TRACE | BACKTRACE_ON_ERROR | REQUEST_TIMER>.
473 C<SL::LXDebug> gets its configuration from the C<[debug]> section of
474 the C<config/kivitendo.conf> configuration file. The available options
479 =item C<global_level>
481 A string of log level names that should be activated by
482 default. Multiple log levels are separated by C<|>.
486 A boolean (C<1> or C<0>). Turns on the C<$::form> watch facility. If
487 this is enabled then any key inside C<$::form> can be monitored for
488 changes. For example:
490 # Start watching 'action'
491 $::form->{"Watchdog::action"} = 1;
492 # Stop watching 'invtotal'
493 $::form->{"Watchdog::invtotal"} = 0;
495 A log message is written when the watchdog is enabled for a variable
496 and for each subsequent change. The log message includes the place
497 (file name and line number) of the instruction changing the key.
499 Note that this entails a performance penalty. Also only the keys
500 themselves are monitored -- not the references they point to. E.g. the
501 following would not trigger a change:
503 $::form->{"Watchdog::some_hash"} = 1;
505 $::form->{some_hash}->{some_value} = 42;
507 $::form->{some_hash} = { something => 'else' };
509 =item C<keep_temp_files>
511 A boolean (C<1> or C<0>). If turned on then certain temporary files
512 are not removed but kept in the C<users> directory. These include the
513 temporary files used during printing, e.g. LaTeX files.
517 The path and file name of the debug log file. Must be a location
518 writeable by the web server process.
526 =item C<enter_sub [$level]>
528 =item C<leave_sub [$level]>
530 Pairs of these can be put near the beginning/end of a sub. They'll
531 cause a trace to be written to the log file if the C<TRACE> level is
534 If C<$level> is given then the log messages will only be logged if the
535 global log level C<TRACE2> is active as well.
537 =item C<enable_sub_tracing>
539 =item C<disable_sub_tracing>
541 Enables/disables sub tracing with L<enter_sub>/L<leave_sub> temporarily.
543 =item C<is_tracing_enabled>
545 Returns whether or not the C<TRACE> debug level is active.
547 =item C<show_backtrace [$force]>
549 Logs a stack backtrace if C<$force> is trueish or if the log level
550 C<BACKTRACE_ON_ERROR> is active.
552 =item C<message $level, $message>
554 Logs the message C<$message> if the log level C<$level> is active. The
555 message will be prefixed with a word describing the log level.
557 =item C<warn $message>
559 Equivalent to C<message WARN(), $message>.
561 =item C<dump $level, $name, $variable>
563 Logs a message that the variable named C<$name> is dumped along with a
564 dump of the variable C<$variable> created by the L<Data::Dumper>
565 module. Will log a warning if said module is not available. Will only
566 log if the log level C<$level> is active.
568 =item C<dump_yaml $level, $name, $variable>
570 Logs a message that the variable named C<$name> is dumped along with a
571 dump of the variable C<$variable> created by the C<YAML> module. Will
572 only log if the log level C<$level> is active.
574 =item C<dump_sql $level, $prefix, $results>
576 Dumps the result of an SQL query in tabular form. Will only log if the
577 log level C<$level> is active.
579 =item C<show_diff $level, $item1, $item2, %params>
581 Logs a unified diff of the textual representations of C<$item1> and
582 C<$item2>. Requires the module L<Text::Diff> and logs a warning if
583 said module is not available.
585 C<$item1> and C<$item2> are dumped via L<YAML::Dumper> before diffing
586 if they're non-scalars.
588 Will only log if the log level C<$level> is active.
590 =item C<begin_request>
596 =item C<set_request_timer>
598 =item C<want_request_timer>
600 Internal functions used to log the current request's exeuction time
601 (log level C<REQUEST_TIMER>).
603 =item C<get_request_time>
605 Returns the current request's elapsed execution time in seconds.
607 =item C<file [$file_name]>
609 Sets and/or returns the file name this instance logs to.
611 =item C<level_by_name $level[, $val]>
613 Returns if a log level C<$level> is active. C<$level> is a string
614 representation, not one of the level constants from above.
616 If C<$val> is given then said level will be turned on (if C<$val> is
617 trueish) or off (if C<$val> is falsish).
627 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
628 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>