package LXDebug;
-use constant NONE => 0;
-use constant INFO => 1;
-use constant DEBUG1 => 2;
-use constant DEBUG2 => 4;
-use constant QUERY => 8;
-use constant TRACE => 16;
-use constant BACKTRACE_ON_ERROR => 32;
-use constant ALL => 63;
+use constant NONE => 0;
+use constant INFO => 1;
+use constant DEBUG1 => 1 << 1;
+use constant DEBUG2 => 1 << 2;
+use constant QUERY => 1 << 3;
+use constant TRACE => 1 << 4;
+use constant BACKTRACE_ON_ERROR => 1 << 5;
+use constant REQUEST_TIMER => 1 << 6;
+use constant WARN => 1 << 7;
+use constant ALL => (1 << 8) - 1;
+use constant DEVEL => INFO | QUERY | TRACE | BACKTRACE_ON_ERROR | REQUEST_TIMER;
use constant FILE_TARGET => 0;
use constant STDERR_TARGET => 1;
-use POSIX qw(strftime);
-
+use POSIX qw(strftime getppid);
+use Time::HiRes qw(gettimeofday tv_interval);
use YAML;
+use strict;
+
my $data_dumper_available;
our $global_level;
our $watch_form;
+our $file_name;
BEGIN {
eval("use Data::Dumper");
my $type = shift;
my $self = {};
+ _init_globals_from_config();
+
$self->{"calldepth"} = 0;
- $self->{"file"} = "/tmp/lx-office-debug.log";
+ $self->{"file"} = $file_name || "/tmp/lx-office-debug.log";
$self->{"target"} = FILE_TARGET;
$self->{"level"} = 0;
bless($self, $type);
}
+my $globals_inited_from_config;
+sub _init_globals_from_config {
+ return if $globals_inited_from_config;
+ $globals_inited_from_config = 1;
+
+ my $cfg = $::lx_office_conf{debug} || {};
+
+ $global_level = NONE() if $cfg->{global_level} =~ /NONE/;
+ foreach my $level (grep { $_} split(m/\s+/, $cfg->{global_level})) {
+ $global_level |= eval "${level}()";
+ }
+
+ $watch_form = $cfg->{watch_form};
+ $file_name = $cfg->{file_name} || "/tmp/lx-office-debug.log";
+}
+
sub set_target {
my ($self, $target, $file) = @_;
}
sub enter_sub {
- my ($self, $level) = @_;
- $level *= 1;
+ my $self = shift;
+ my $level = shift || 0;
return 1 unless ($global_level & TRACE); # ignore if traces aren't active
return 1 if $level && !($global_level & $level); # ignore if level of trace isn't active
my ($dummy1, $self_filename, $self_line) = caller(0);
my $indent = " " x $self->{"calldepth"}++;
+ my $time = $self->get_request_time || '';
if (!defined($package)) {
- $self->_write('sub' . $level, $indent . "\\ top-level?\n");
+ $self->_write('sub' . $level, $indent . "\\ $time top-level?\n");
} else {
$self->_write('sub' . $level, $indent
- . "\\ ${subroutine} in "
+ . "\\ $time ${subroutine} in "
. "${self_filename}:${self_line} called from "
. "${filename}:${line}\n");
}
}
sub leave_sub {
- my ($self, $level) = @_;
- $level *= 1;
+ my $self = shift;
+ my $level = shift || 0;
return 1 unless ($global_level & TRACE); # ignore if traces aren't active
return 1 if $level && !($global_level & $level); # ignore if level of trace isn't active
my ($dummy1, $self_filename, $self_line) = caller(0);
my $indent = " " x --$self->{"calldepth"};
+ my $time = $self->want_request_timer ? $self->get_request_time : '';
if (!defined($package)) {
- $self->_write('sub' . $level, $indent . "/ top-level?\n");
+ $self->_write('sub' . $level, $indent . "/ $time top-level?\n");
} else {
- $self->_write('sub' . $level, $indent . "/ ${subroutine} in " . "${self_filename}:${self_line}\n");
+ $self->_write('sub' . $level, $indent . "/ $time ${subroutine} in " . "${self_filename}:${self_line}\n");
}
return 1;
}
sub show_backtrace {
- my ($self) = @_;
+ my ($self, $force) = @_;
- return 1 unless ($global_level & BACKTRACE_ON_ERROR);
+ return 1 unless ($force || ($global_level & BACKTRACE_ON_ERROR));
$self->message(BACKTRACE_ON_ERROR, "Starting full caller dump:");
my $level = 0;
}
sub message {
+ no warnings;
my ($self, $level, $message) = @_;
$self->_write(level2string($level), $message) if (($self->{"level"} | $global_level) & $level || !$level);
}
+sub warn {
+ no warnings;
+ my ($self, $message) = @_;
+ $self->message(WARN, $message);
+}
sub dump {
my ($self, $level, $name, $variable) = @_;
if ($data_dumper_available) {
+ my $password;
+ if ($variable && ('Form' eq ref $variable) && defined $variable->{password}) {
+ $password = $variable->{password};
+ $variable->{password} = 'X' x 8;
+ }
+
my $dumper = Data::Dumper->new([$variable]);
$dumper->Sortkeys(1);
$self->message($level, "dumping ${name}:\n" . $dumper->Dump());
+
+ $variable->{password} = $password if (defined $password);
+
+ # Data::Dumper does not reset the iterator belonging to this hash
+ # if 'Sortkeys' is true. Therefore clear the iterator manually.
+ # See "perldoc -f each".
+ if ($variable && (('HASH' eq ref $variable) || ('Form' eq ref $variable))) {
+ keys %{ $variable };
+ }
+
} else {
$self->message($level,
"dumping ${name}: Data::Dumper not available; "
my @sorted_names = sort keys %column_lengths;
my $format = join '|', map { '%' . $column_lengths{$_} . 's' } @sorted_names;
- $prefix =~ s|\s*$||;
- $prefix .= ' ' if $prefix;
+ $prefix .= ' ' if $prefix;
$self->message($level, $prefix . sprintf($format, @sorted_names));
$self->message($level, $prefix . join('+', map { '-' x $column_lengths{$_} } @sorted_names));
sub enable_sub_tracing {
my ($self) = @_;
- $self->{level} | TRACE;
+ $global_level |= TRACE;
}
sub disable_sub_tracing {
my ($self) = @_;
- $self->{level} & ~ TRACE;
+ $global_level &= ~ TRACE;
+}
+
+sub is_tracing_enabled {
+ my ($self) = @_;
+ return $global_level & TRACE;
}
sub _write {
+ no warnings;
my ($self, $prefix, $message) = @_;
- my $date = strftime("%Y-%m-%d %H:%M:%S $$ ${prefix}: ", localtime(time()));
+ my $date = strftime("%Y-%m-%d %H:%M:%S $$ [" . getppid() . "] ${prefix}: ", localtime(time()));
local *FILE;
chomp($message);
}
sub level2string {
+ no warnings;
# use $_[0] as a bit mask and return levelstrings separated by /
- join '/', qw(info debug1 debug2 query trace error_call_trace)[ grep { (reverse split //, sprintf "%05b", $_[0])[$_] } 0..5 ]
+ join '/', qw(info debug1 debug2 query trace error_call_trace request_timer WARNING)[ grep { (reverse split //, sprintf "%08b", $_[0])[$_] } 0..7 ]
+}
+
+sub begin_request {
+ my $self = shift;
+ return 1 unless want_request_timer();
+ $self->set_request_timer;
+}
+
+sub end_request {
+ my $self = shift;
+ return 1 unless want_request_timer();
+ $self->_write("time", $self->get_request_time);
+
+ $self->{calldepth} = 0;
+}
+
+sub log_time {
+ my $self = shift;
+ return 1 unless want_request_timer();
+ $self->_write("time", $self->get_request_time);
+}
+
+sub get_request_time {
+ my $self = shift;
+ return $self->want_request_timer && $self->{request_start} ? tv_interval($self->{request_start}) : undef;
+}
+
+sub set_request_timer {
+ my $self = shift;
+ $self->{request_start} = [gettimeofday];
+}
+
+sub want_request_timer {
+ $global_level & REQUEST_TIMER;
+}
+
+sub file {
+ @_ == 2 ? $_[0]->{file} = $_[1] : $_[0]->{file};
+}
+
+sub _by_name {
+ my ($self, $level) = @_;
+ my $meth = $self->can(uc $level);
+ die 'unknown level' unless $meth;
+ $meth->();
+}
+
+sub level_by_name {
+ my ($self, $level, $val) = @_;
+ if (@_ == 3) {
+ $global_level |= $self->_by_name($level) if $val;
+ $global_level &= ~$self->_by_name($level) if !$val;
+ }
+ return $global_level & $self->_by_name($level);
}
1;