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 SHOW_CALLER => 1 << 10;
15 use constant ALL => (1 << 11) - 1;
16 use constant DEVEL => INFO | DEBUG1 | QUERY | TRACE | BACKTRACE_ON_ERROR | REQUEST_TIMER;
18 use constant FILE_TARGET => 0;
19 use constant STDERR_TARGET => 1;
22 use POSIX qw(strftime getpid);
23 use Scalar::Util qw(blessed reftype);
24 use Time::HiRes qw(gettimeofday tv_interval);
31 my ($text_diff_available);
33 our $global_level = NONE();
41 _init_globals_from_config();
43 $self->{"calldepth"} = 0;
44 $self->{"file"} = $file_name || "/tmp/lx-office-debug.log";
45 $self->{"target"} = FILE_TARGET;
49 $self->{ $_[0] } = $_[1];
57 my $globals_inited_from_config;
58 sub _init_globals_from_config {
59 return if $globals_inited_from_config;
60 $globals_inited_from_config = 1;
62 my $cfg = $::lx_office_conf{debug} || {};
64 $global_level = NONE() if $cfg->{global_level} =~ /NONE/;
65 foreach my $level (grep { $_} split(m/\s+/, $cfg->{global_level})) {
66 $global_level |= eval "${level}()";
69 $watch_form = $cfg->{watch_form};
70 $file_name = $cfg->{file_name} || "/tmp/lx-office-debug.log";
74 my ($self, $target, $file) = @_;
76 if ((FILE_TARGET == $target) && $file) {
77 $self->{"file"} = $file;
78 $self->{"target"} = FILE_TARGET;
80 } elsif (STDERR_TARGET == $target) {
81 $self->{"target"} = STDERR_TARGET;
87 my $level = shift || 0;
89 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
90 return 1 if $level && !($global_level & TRACE2); # ignore if level of trace isn't active
92 my ($package, $filename, $line, $subroutine) = caller(1);
93 my ($dummy1, $self_filename, $self_line) = caller(0);
95 my $indent = " " x $self->{"calldepth"}++;
96 my $time = $self->get_request_time || '';
98 if (!defined($package)) {
99 $self->_write('sub' . $level, $indent . "\\ $time top-level?\n");
101 $self->_write('sub' . $level, $indent
102 . "\\ $time ${subroutine} in "
103 . "${self_filename}:${self_line} called from "
104 . "${filename}:${line}\n");
111 my $level = shift || 0;
113 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
114 return 1 if $level && !($global_level & TRACE2); # ignore if level of trace isn't active
116 my ($package, $filename, $line, $subroutine) = caller(1);
117 my ($dummy1, $self_filename, $self_line) = caller(0);
119 my $indent = " " x --$self->{"calldepth"};
120 my $time = $self->want_request_timer ? $self->get_request_time || '' : '';
122 if (!defined($package)) {
123 $self->_write('sub' . $level, $indent . "/ $time top-level?\n");
125 $self->_write('sub' . $level, $indent . "/ $time ${subroutine} in " . "${self_filename}:${self_line}\n");
131 my ($self, $force) = @_;
133 return 1 unless ($force || ($global_level & BACKTRACE_ON_ERROR));
135 $self->message(0, "Starting full caller dump:");
137 while (my ($dummy, $filename, $line, $subroutine) = caller $level) {
138 $self->message(0, " ${subroutine} from ${filename}:${line}");
147 my ($self, $level, $message) = @_;
149 my $show_caller = ($level | $global_level) & SHOW_CALLER();
150 $level &= ~SHOW_CALLER();
152 $self->_write(level2string($level), $message, show_caller => $show_caller) if (($self->{"level"} | $global_level) & $level || !$level);
156 my ($self, $message) = @_;
157 $self->message(WARN, $message);
160 sub _clone_for_dump {
163 return undef unless defined($src);
164 return $src->as_debug_info if blessed($src) && $src->can('as_debug_info');
165 return [ map { _clone_for_dump($_) } @{ $src } ] if reftype($src) eq 'ARRAY';
166 return { map { ($_ => _clone_for_dump($src->{$_})) } keys %{ $src } } if reftype($src) eq 'HASH';
171 my ($self, $level, $name, $variable, %options) = @_;
173 $variable = _clone_for_dump($variable);
174 my $dumper = Data::Dumper->new([$variable]);
175 $dumper->Sortkeys(1);
177 $dumper->$_($options{$_}) for keys %options;
178 my $output = $dumper->Dump();
179 $self->message($level, "dumping ${name}:\n" . $output);
185 my ($self, $level, $name, $variable) = @_;
187 $self->message($level, "dumping ${name}:\n" . YAML::Dump($variable));
190 sub dump_sql_result {
191 my ($self, $level, $prefix, $results) = @_;
193 if (!$results || !scalar @{ $results }) {
194 $self->message($level, "Empty result set");
198 my %column_lengths = map { $_, length $_ } keys %{ $results->[0] };
200 foreach my $row (@{ $results }) {
201 map { $column_lengths{$_} = length $row->{$_} if (length $row->{$_} > $column_lengths{$_}) } keys %{ $row };
204 my @sorted_names = sort keys %column_lengths;
205 my $format = join '|', map { '%' . $column_lengths{$_} . 's' } @sorted_names;
207 $prefix .= ' ' if $prefix;
209 $self->message($level, $prefix . sprintf($format, @sorted_names));
210 $self->message($level, $prefix . join('+', map { '-' x $column_lengths{$_} } @sorted_names));
212 foreach my $row (@{ $results }) {
213 $self->message($level, $prefix . sprintf($format, map { $row->{$_} } @sorted_names));
215 $self->message($level, $prefix . sprintf('(%d row%s)', scalar @{ $results }, scalar @{ $results } > 1 ? 's' : ''));
219 my ($self, $level, $item1, $item2, %params) = @_;
221 if (!$self->_load_text_diff) {
222 $self->warn("Perl module Text::Diff is not available");
226 my @texts = map { ref $_ ? YAML::Dump($_) : $_ } ($item1, $item2);
228 $self->message($level, Text::Diff::diff(\$texts[0], \$texts[1], \%params));
231 sub _load_text_diff {
232 $text_diff_available = eval("use Text::Diff (); 1;") ? 1 : 0 unless defined $text_diff_available;
233 return $text_diff_available;
236 sub enable_sub_tracing {
238 $global_level |= TRACE;
241 sub disable_sub_tracing {
243 $global_level &= ~ TRACE;
246 sub is_tracing_enabled {
248 return $global_level & TRACE;
253 my ($self, $prefix, $message, %options) = @_;
255 my @prefixes = ($prefix);
257 if ($options{show_caller}) {
260 my ($package, $filename, $line, $subroutine) = caller($level);
262 if (($filename // '') =~ m{LXDebug\.pm$}) {
267 push @prefixes, "${filename}:${line}";
272 $prefix = join ' ', grep { $_ } @prefixes;
274 my @now = gettimeofday();
275 my $date = strftime("%Y-%m-%d %H:%M:%S." . sprintf('%03d', int($now[1] / 1000)) . " $$ [" . getpid() . "] ${prefix}: ", localtime($now[0]));
279 $self->_write_raw("${date}${message}\n");
283 my ($self, $message) = @_;
285 if ((FILE_TARGET == $self->{"target"})
286 && open(FILE, ">>", $self->{"file"})) {
287 binmode FILE, ":utf8";
291 } elsif (STDERR_TARGET == $self->{"target"}) {
292 print STDERR $message;
298 # use $_[0] as a bit mask and return levelstrings separated by /
299 join '/', qw(info debug1 debug2 query trace error_call_trace request_timer WARNING)[ grep { (reverse split //, sprintf "%08b", $_[0])[$_] } 0..7 ]
304 return 1 unless want_request_timer();
305 $self->set_request_timer;
309 my ($self, %params) = @_;
310 return 1 unless want_request_timer();
312 $self->_write("time", sprintf('%f (%s/%s)', $self->get_request_time, $params{script_name}, $params{action}));
314 $self->{calldepth} = 0;
318 my ($self, @slurp) = @_;
319 return 1 unless want_request_timer();
321 my $now = $self->get_request_time;
322 my $diff = int((($now - ($self->{previous_log_time} // 0)) * 10_000 + 5) / 10);
323 $self->{previous_log_time} = $now;
325 $self->_write("time", "${now}s Δ ${diff}ms" . (@slurp ? " (@slurp)" : ''));
328 sub get_request_time {
330 return $self->want_request_timer && $self->{request_start} ? tv_interval($self->{request_start}) : undef;
333 sub set_request_timer {
335 $self->{request_start} = [gettimeofday];
338 sub want_request_timer {
339 $global_level & REQUEST_TIMER;
343 @_ == 2 ? $_[0]->{file} = $_[1] : $_[0]->{file};
347 my ($self, $level) = @_;
348 my $meth = $self->can(uc $level);
349 die 'unknown level' unless $meth;
354 my ($self, $level, $val) = @_;
356 $global_level |= $self->_by_name($level) if $val;
357 $global_level &= ~$self->_by_name($level) if !$val;
359 return $global_level & $self->_by_name($level);
362 sub is_request_logging_enabled {
364 return $global_level & REQUEST;
367 sub add_request_params {
368 my ($self, $key, $value) = @_;
369 return unless $self->is_request_logging_enabled;
370 return if $key =~ /password/;
372 push @{ $::request->{debug}{PARAMS} ||= [] }, [ $key => $value ];
376 my ($self, $type, $controller, $action) = @_;
377 return unless $self->is_request_logging_enabled;
379 my $session_id = $::auth->create_or_refresh_session;
381 my $template = <<EOL;
382 *************************************
383 $ENV{REQUEST_METHOD} $ENV{SCRIPT_NAME} $session_id ($::myconfig{login})
384 routing: $type, controller: $controller, action: $action
387 $self->_write('Request', $template);
389 my $params = join "\n ", map {
391 } @{ $::request->{debug}{PARAMS} || [] };
393 $self->_write_raw(<<EOL);
409 LXDebug - kivitendo debugging facilities
413 This module provides functions for debugging kivitendo. An instance is
414 always created as the global variable C<$::lxdebug> at the earliest
417 Debugging is mostly logging of information. Each log function has a
418 I<level> and an I<object> to be logged. The configuration file as well
419 as this module's functions determine which levels get logged, and
420 which file they're logged to.
424 The available log levels are:
430 Always output the message regardless of the active levels. Only use
435 Informational, not an error, more important than C<DEBUG1>.
439 Important debugging information.
443 Less important debugging information that occurs often and spams the
448 Log all queries executed by the L<SL::DBUtils> utility methods.
452 Log sub calls and exits via the L<enter_sub>/L<leave_sub> functions,
453 but only if they're called with a log level that is falsish
454 (e.g. none, C<undef>, 0).
458 Log sub calls and exits via the L<enter_sub>/L<leave_sub> functions
459 even if they're called with a log level of 2. Will only have an effect
460 if C<TRACE> is set as well.
462 =item C<BACKTRACE_ON_ERROR>
464 Log a stack trace when an error is output.
466 =item C<REQUEST_TIMER>
468 Log each request's total execution time when it finishes.
480 Shortcut for C<INFO | QUERY | TRACE | BACKTRACE_ON_ERROR | REQUEST_TIMER>.
486 C<SL::LXDebug> gets its configuration from the C<[debug]> section of
487 the C<config/kivitendo.conf> configuration file. The available options
492 =item C<global_level>
494 A string of log level names that should be activated by
495 default. Multiple log levels are separated by C<|>.
499 A boolean (C<1> or C<0>). Turns on the C<$::form> watch facility. If
500 this is enabled then any key inside C<$::form> can be monitored for
501 changes. For example:
503 # Start watching 'action'
504 $::form->{"Watchdog::action"} = 1;
505 # Stop watching 'invtotal'
506 $::form->{"Watchdog::invtotal"} = 0;
508 A log message is written when the watchdog is enabled for a variable
509 and for each subsequent change. The log message includes the place
510 (file name and line number) of the instruction changing the key.
512 Note that this entails a performance penalty. Also only the keys
513 themselves are monitored -- not the references they point to. E.g. the
514 following would not trigger a change:
516 $::form->{"Watchdog::some_hash"} = 1;
518 $::form->{some_hash}->{some_value} = 42;
520 $::form->{some_hash} = { something => 'else' };
522 =item C<keep_temp_files>
524 A boolean (C<1> or C<0>). If turned on then certain temporary files
525 are not removed but kept in the C<users> directory. These include the
526 temporary files used during printing, e.g. LaTeX files.
530 The path and file name of the debug log file. Must be a location
531 writeable by the web server process.
539 =item C<enter_sub [$level]>
541 =item C<leave_sub [$level]>
543 Pairs of these can be put near the beginning/end of a sub. They'll
544 cause a trace to be written to the log file if the C<TRACE> level is
547 If C<$level> is given then the log messages will only be logged if the
548 global log level C<TRACE2> is active as well.
550 =item C<enable_sub_tracing>
552 =item C<disable_sub_tracing>
554 Enables/disables sub tracing with L<enter_sub>/L<leave_sub> temporarily.
556 =item C<is_tracing_enabled>
558 Returns whether or not the C<TRACE> debug level is active.
560 =item C<show_backtrace [$force]>
562 Logs a stack backtrace if C<$force> is trueish or if the log level
563 C<BACKTRACE_ON_ERROR> is active.
565 =item C<message $level, $message>
567 Logs the message C<$message> if the log level C<$level> is active. The
568 message will be prefixed with a word describing the log level.
570 =item C<warn $message>
572 Equivalent to C<message WARN(), $message>.
574 =item C<dump $level, $name, $variable>
576 Logs a message that the variable named C<$name> is dumped along with a
577 dump of the variable C<$variable> created by the L<Data::Dumper>
578 module. Will log a warning if said module is not available. Will only
579 log if the log level C<$level> is active.
581 =item C<dump_yaml $level, $name, $variable>
583 Logs a message that the variable named C<$name> is dumped along with a
584 dump of the variable C<$variable> created by the C<YAML> module. Will
585 only log if the log level C<$level> is active.
587 =item C<dump_sql $level, $prefix, $results>
589 Dumps the result of an SQL query in tabular form. Will only log if the
590 log level C<$level> is active.
592 =item C<show_diff $level, $item1, $item2, %params>
594 Logs a unified diff of the textual representations of C<$item1> and
595 C<$item2>. Requires the module L<Text::Diff> and logs a warning if
596 said module is not available.
598 C<$item1> and C<$item2> are dumped via L<YAML::Dumper> before diffing
599 if they're non-scalars.
601 Will only log if the log level C<$level> is active.
603 =item C<begin_request>
609 =item C<set_request_timer>
611 =item C<want_request_timer>
613 Internal functions used to log the current request's exeuction time
614 (log level C<REQUEST_TIMER>).
616 =item C<get_request_time>
618 Returns the current request's elapsed execution time in seconds.
620 =item C<file [$file_name]>
622 Sets and/or returns the file name this instance logs to.
624 =item C<level_by_name $level[, $val]>
626 Returns if a log level C<$level> is active. C<$level> is a string
627 representation, not one of the level constants from above.
629 If C<$val> is given then said level will be turned on (if C<$val> is
630 trueish) or off (if C<$val> is falsish).
640 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
641 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>