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 ALL => (1 << 7) - 1;
12 use constant DEVEL => INFO | QUERY | TRACE | BACKTRACE_ON_ERROR | REQUEST_TIMER;
14 use constant FILE_TARGET => 0;
15 use constant STDERR_TARGET => 1;
17 use POSIX qw(strftime getppid);
18 use Time::HiRes qw(gettimeofday tv_interval);
23 my $data_dumper_available;
30 eval("use Data::Dumper");
31 $data_dumper_available = $@ ? 0 : 1;
41 $self->{"calldepth"} = 0;
42 $self->{"file"} = $file_name || "/tmp/lx-office-debug.log";
43 $self->{"target"} = FILE_TARGET;
47 $self->{ $_[0] } = $_[1];
56 my ($self, $target, $file) = @_;
58 if ((FILE_TARGET == $target) && $file) {
59 $self->{"file"} = $file;
60 $self->{"target"} = FILE_TARGET;
62 } elsif (STDERR_TARGET == $target) {
63 $self->{"target"} = STDERR_TARGET;
68 my ($self, $level) = @_;
71 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
72 return 1 if $level && !($global_level & $level); # ignore if level of trace isn't active
74 my ($package, $filename, $line, $subroutine) = caller(1);
75 my ($dummy1, $self_filename, $self_line) = caller(0);
77 my $indent = " " x $self->{"calldepth"}++;
78 my $time = $self->get_request_time || '';
80 if (!defined($package)) {
81 $self->_write('sub' . $level, $indent . "\\ $time top-level?\n");
83 $self->_write('sub' . $level, $indent
84 . "\\ $time ${subroutine} in "
85 . "${self_filename}:${self_line} called from "
86 . "${filename}:${line}\n");
92 my ($self, $level) = @_;
95 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
96 return 1 if $level && !($global_level & $level); # ignore if level of trace isn't active
98 my ($package, $filename, $line, $subroutine) = caller(1);
99 my ($dummy1, $self_filename, $self_line) = caller(0);
101 my $indent = " " x --$self->{"calldepth"};
102 my $time = $self->want_request_timer ? $self->get_request_time : '';
104 if (!defined($package)) {
105 $self->_write('sub' . $level, $indent . "/ $time top-level?\n");
107 $self->_write('sub' . $level, $indent . "/ $time ${subroutine} in " . "${self_filename}:${self_line}\n");
113 my ($self, $force) = @_;
115 return 1 unless ($force || ($global_level & BACKTRACE_ON_ERROR));
117 $self->message(BACKTRACE_ON_ERROR, "Starting full caller dump:");
119 while (my ($dummy, $filename, $line, $subroutine) = caller $level) {
120 $self->message(BACKTRACE_ON_ERROR, " ${subroutine} from ${filename}:${line}");
128 my ($self, $level, $message) = @_;
130 $self->_write(level2string($level), $message) if (($self->{"level"} | $global_level) & $level || !$level);
134 my ($self, $level, $name, $variable) = @_;
136 if ($data_dumper_available) {
138 if ($variable && ('Form' eq ref $variable) && defined $variable->{password}) {
139 $password = $variable->{password};
140 $variable->{password} = 'X' x 8;
143 my $dumper = Data::Dumper->new([$variable]);
144 $dumper->Sortkeys(1);
145 $self->message($level, "dumping ${name}:\n" . $dumper->Dump());
147 $variable->{password} = $password if (defined $password);
149 # Data::Dumper does not reset the iterator belonging to this hash
150 # if 'Sortkeys' is true. Therefore clear the iterator manually.
151 # See "perldoc -f each".
152 if ($variable && (('HASH' eq ref $variable) || ('Form' eq ref $variable))) {
157 $self->message($level,
158 "dumping ${name}: Data::Dumper not available; "
159 . "variable cannot be dumped");
164 my ($self, $level, $name, $variable) = @_;
166 $self->message($level, "dumping ${name}:\n" . YAML::Dump($variable));
169 sub dump_sql_result {
170 my ($self, $level, $prefix, $results) = @_;
172 if (!$results || !scalar @{ $results }) {
173 $self->message($level, "Empty result set");
177 my %column_lengths = map { $_, length $_ } keys %{ $results->[0] };
179 foreach my $row (@{ $results }) {
180 map { $column_lengths{$_} = length $row->{$_} if (length $row->{$_} > $column_lengths{$_}) } keys %{ $row };
183 my @sorted_names = sort keys %column_lengths;
184 my $format = join '|', map { '%' . $column_lengths{$_} . 's' } @sorted_names;
186 $prefix .= ' ' if $prefix;
188 $self->message($level, $prefix . sprintf($format, @sorted_names));
189 $self->message($level, $prefix . join('+', map { '-' x $column_lengths{$_} } @sorted_names));
191 foreach my $row (@{ $results }) {
192 $self->message($level, $prefix . sprintf($format, map { $row->{$_} } @sorted_names));
194 $self->message($level, $prefix . sprintf('(%d row%s)', scalar @{ $results }, scalar @{ $results } > 1 ? 's' : ''));
197 sub enable_sub_tracing {
199 $global_level |= TRACE;
202 sub disable_sub_tracing {
204 $global_level &= ~ TRACE;
207 sub is_tracing_enabled {
209 return $global_level & TRACE;
213 my ($self, $prefix, $message) = @_;
214 my $date = strftime("%Y-%m-%d %H:%M:%S $$ [" . getppid() . "] ${prefix}: ", localtime(time()));
219 if ((FILE_TARGET == $self->{"target"})
220 && open(FILE, ">>" . $self->{"file"})) {
221 print(FILE "${date}${message}\n");
224 } elsif (STDERR_TARGET == $self->{"target"}) {
225 print(STDERR "${date}${message}\n");
230 # use $_[0] as a bit mask and return levelstrings separated by /
231 join '/', qw(info debug1 debug2 query trace error_call_trace)[ grep { (reverse split //, sprintf "%05b", $_[0])[$_] } 0..5 ]
236 return 1 unless want_request_timer();
237 $self->set_request_timer;
242 return 1 unless want_request_timer();
243 $self->_write("time", $self->get_request_time);
245 $self->{calldepth} = 0;
250 return 1 unless want_request_timer();
251 $self->_write("time", $self->get_request_time);
254 sub get_request_time {
256 return $self->want_request_timer && $self->{request_start} ? tv_interval($self->{request_start}) : undef;
259 sub set_request_timer {
261 $self->{request_start} = [gettimeofday];
264 sub want_request_timer {
265 $global_level & REQUEST_TIMER;