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);
18 use Time::HiRes qw(gettimeofday tv_interval);
23 my $data_dumper_available;
29 eval("use Data::Dumper");
30 $data_dumper_available = $@ ? 0 : 1;
40 $self->{"calldepth"} = 0;
41 $self->{"file"} = "/tmp/lx-office-debug.log";
42 $self->{"target"} = FILE_TARGET;
46 $self->{ $_[0] } = $_[1];
55 my ($self, $target, $file) = @_;
57 if ((FILE_TARGET == $target) && $file) {
58 $self->{"file"} = $file;
59 $self->{"target"} = FILE_TARGET;
61 } elsif (STDERR_TARGET == $target) {
62 $self->{"target"} = STDERR_TARGET;
67 my ($self, $level) = @_;
70 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
71 return 1 if $level && !($global_level & $level); # ignore if level of trace isn't active
73 my ($package, $filename, $line, $subroutine) = caller(1);
74 my ($dummy1, $self_filename, $self_line) = caller(0);
76 my $indent = " " x $self->{"calldepth"}++;
78 if (!defined($package)) {
79 $self->_write('sub' . $level, $indent . "\\ top-level?\n");
81 $self->_write('sub' . $level, $indent
82 . "\\ ${subroutine} in "
83 . "${self_filename}:${self_line} called from "
84 . "${filename}:${line}\n");
90 my ($self, $level) = @_;
93 return 1 unless ($global_level & TRACE); # ignore if traces aren't active
94 return 1 if $level && !($global_level & $level); # ignore if level of trace isn't active
96 my ($package, $filename, $line, $subroutine) = caller(1);
97 my ($dummy1, $self_filename, $self_line) = caller(0);
99 my $indent = " " x --$self->{"calldepth"};
101 if (!defined($package)) {
102 $self->_write('sub' . $level, $indent . "/ top-level?\n");
104 $self->_write('sub' . $level, $indent . "/ ${subroutine} in " . "${self_filename}:${self_line}\n");
110 my ($self, $force) = @_;
112 return 1 unless ($force || ($global_level & BACKTRACE_ON_ERROR));
114 $self->message(BACKTRACE_ON_ERROR, "Starting full caller dump:");
116 while (my ($dummy, $filename, $line, $subroutine) = caller $level) {
117 $self->message(BACKTRACE_ON_ERROR, " ${subroutine} from ${filename}:${line}");
125 my ($self, $level, $message) = @_;
127 $self->_write(level2string($level), $message) if (($self->{"level"} | $global_level) & $level || !$level);
131 my ($self, $level, $name, $variable) = @_;
133 if ($data_dumper_available) {
135 if ($variable && ('Form' eq ref $variable) && defined $variable->{password}) {
136 $password = $variable->{password};
137 $variable->{password} = 'X' x 8;
140 my $dumper = Data::Dumper->new([$variable]);
141 $dumper->Sortkeys(1);
142 $self->message($level, "dumping ${name}:\n" . $dumper->Dump());
144 $variable->{password} = $password if (defined $password);
146 # Data::Dumper does not reset the iterator belonging to this hash
147 # if 'Sortkeys' is true. Therefore clear the iterator manually.
148 # See "perldoc -f each".
149 if ($variable && (('HASH' eq ref $variable) || ('Form' eq ref $variable))) {
154 $self->message($level,
155 "dumping ${name}: Data::Dumper not available; "
156 . "variable cannot be dumped");
161 my ($self, $level, $name, $variable) = @_;
163 $self->message($level, "dumping ${name}:\n" . YAML::Dump($variable));
166 sub dump_sql_result {
167 my ($self, $level, $prefix, $results) = @_;
169 if (!$results || !scalar @{ $results }) {
170 $self->message($level, "Empty result set");
174 my %column_lengths = map { $_, length $_ } keys %{ $results->[0] };
176 foreach my $row (@{ $results }) {
177 map { $column_lengths{$_} = length $row->{$_} if (length $row->{$_} > $column_lengths{$_}) } keys %{ $row };
180 my @sorted_names = sort keys %column_lengths;
181 my $format = join '|', map { '%' . $column_lengths{$_} . 's' } @sorted_names;
183 $prefix .= ' ' if $prefix;
185 $self->message($level, $prefix . sprintf($format, @sorted_names));
186 $self->message($level, $prefix . join('+', map { '-' x $column_lengths{$_} } @sorted_names));
188 foreach my $row (@{ $results }) {
189 $self->message($level, $prefix . sprintf($format, map { $row->{$_} } @sorted_names));
191 $self->message($level, $prefix . sprintf('(%d row%s)', scalar @{ $results }, scalar @{ $results } > 1 ? 's' : ''));
194 sub enable_sub_tracing {
196 $global_level |= TRACE;
199 sub disable_sub_tracing {
201 $global_level &= ~ TRACE;
204 sub is_tracing_enabled {
206 return $global_level & TRACE;
210 my ($self, $prefix, $message) = @_;
211 my $date = strftime("%Y-%m-%d %H:%M:%S $$ ${prefix}: ", localtime(time()));
216 if ((FILE_TARGET == $self->{"target"})
217 && open(FILE, ">>" . $self->{"file"})) {
218 print(FILE "${date}${message}\n");
221 } elsif (STDERR_TARGET == $self->{"target"}) {
222 print(STDERR "${date}${message}\n");
227 # use $_[0] as a bit mask and return levelstrings separated by /
228 join '/', qw(info debug1 debug2 query trace error_call_trace)[ grep { (reverse split //, sprintf "%05b", $_[0])[$_] } 0..5 ]
233 return 1 unless ($global_level & REQUEST_TIMER);
234 $self->{request_start} = [gettimeofday];
239 return 1 unless ($global_level & REQUEST_TIMER);
240 $self->_write("time", tv_interval($self->{request_start}));
242 $self->{calldepth} = 0;