SL/LXDebug.pm

   1 package LXDebug;
   2
   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;
  13
  14 use constant FILE_TARGET   => 0;
  15 use constant STDERR_TARGET => 1;
  16
  17 use POSIX qw(strftime);
  18 use Time::HiRes qw(gettimeofday tv_interval);
  19 use YAML;
  20
  21 use strict;
  22
  23 my $data_dumper_available;
  24
  25 our $global_level;
  26 our $watch_form;
  27
  28 BEGIN {
  29   eval("use Data::Dumper");
  30   $data_dumper_available = $@ ? 0 : 1;
  31
  32   $global_level      = NONE;
  33   $watch_form        = 0;
  34 }
  35
  36 sub new {
  37   my $type = shift;
  38   my $self = {};
  39
  40   $self->{"calldepth"}  = 0;
  41   $self->{"file"}       = "/tmp/lx-office-debug.log";
  42   $self->{"target"}     = FILE_TARGET;
  43   $self->{"level"}      = 0;
  44
  45   while ($_[0]) {
  46     $self->{ $_[0] } = $_[1];
  47     shift;
  48     shift;
  49   }
  50
  51   bless($self, $type);
  52 }
  53
  54 sub set_target {
  55   my ($self, $target, $file) = @_;
  56
  57   if ((FILE_TARGET == $target) && $file) {
  58     $self->{"file"}   = $file;
  59     $self->{"target"} = FILE_TARGET;
  60
  61   } elsif (STDERR_TARGET == $target) {
  62     $self->{"target"} = STDERR_TARGET;
  63   }
  64 }
  65
  66 sub enter_sub {
  67   my ($self, $level) = @_;
  68   $level *= 1;
  69
  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
  72
  73   my ($package, $filename, $line, $subroutine) = caller(1);
  74   my ($dummy1, $self_filename, $self_line) = caller(0);
  75
  76   my $indent = " " x $self->{"calldepth"}++;
  77
  78   if (!defined($package)) {
  79     $self->_write('sub' . $level, $indent . "\\ top-level?\n");
  80   } else {
  81     $self->_write('sub' . $level, $indent
  82                     . "\\ ${subroutine} in "
  83                     . "${self_filename}:${self_line} called from "
  84                     . "${filename}:${line}\n");
  85   }
  86   return 1;
  87 }
  88
  89 sub leave_sub {
  90   my ($self, $level) = @_;
  91   $level *= 1;
  92
  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
  95
  96   my ($package, $filename, $line, $subroutine) = caller(1);
  97   my ($dummy1, $self_filename, $self_line) = caller(0);
  98
  99   my $indent = " " x --$self->{"calldepth"};
 100
 101   if (!defined($package)) {
 102     $self->_write('sub' . $level, $indent . "/ top-level?\n");
 103   } else {
 104     $self->_write('sub' . $level, $indent . "/ ${subroutine} in " . "${self_filename}:${self_line}\n");
 105   }
 106   return 1;
 107 }
 108
 109 sub show_backtrace {
 110   my ($self, $force) = @_;
 111
 112   return 1 unless ($force || ($global_level & BACKTRACE_ON_ERROR));
 113
 114   $self->message(BACKTRACE_ON_ERROR, "Starting full caller dump:");
 115   my $level = 0;
 116   while (my ($dummy, $filename, $line, $subroutine) = caller $level) {
 117     $self->message(BACKTRACE_ON_ERROR, "  ${subroutine} from ${filename}:${line}");
 118     $level++;
 119   }
 120
 121   return 1;
 122 }
 123
 124 sub message {
 125   my ($self, $level, $message) = @_;
 126
 127   $self->_write(level2string($level), $message) if (($self->{"level"} | $global_level) & $level || !$level);
 128 }
 129
 130 sub dump {
 131   my ($self, $level, $name, $variable) = @_;
 132
 133   if ($data_dumper_available) {
 134     my $password;
 135     if ($variable && ('Form' eq ref $variable) && defined $variable->{password}) {
 136       $password             = $variable->{password};
 137       $variable->{password} = 'X' x 8;
 138     }
 139
 140     my $dumper = Data::Dumper->new([$variable]);
 141     $dumper->Sortkeys(1);
 142     $self->message($level, "dumping ${name}:\n" . $dumper->Dump());
 143
 144     $variable->{password} = $password if (defined $password);
 145
 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))) {
 150       keys %{ $variable };
 151     }
 152
 153   } else {
 154     $self->message($level,
 155                    "dumping ${name}: Data::Dumper not available; "
 156                      . "variable cannot be dumped");
 157   }
 158 }
 159
 160 sub dump_yaml {
 161   my ($self, $level, $name, $variable) = @_;
 162
 163   $self->message($level, "dumping ${name}:\n" . YAML::Dump($variable));
 164 }
 165
 166 sub dump_sql_result {
 167   my ($self, $level, $prefix, $results) = @_;
 168
 169   if (!$results || !scalar @{ $results }) {
 170     $self->message($level, "Empty result set");
 171     return;
 172   }
 173
 174   my %column_lengths = map { $_, length $_ } keys %{ $results->[0] };
 175
 176   foreach my $row (@{ $results }) {
 177     map { $column_lengths{$_} = length $row->{$_} if (length $row->{$_} > $column_lengths{$_}) } keys %{ $row };
 178   }
 179
 180   my @sorted_names = sort keys %column_lengths;
 181   my $format       = join '|', map { '%' . $column_lengths{$_} . 's' } @sorted_names;
 182
 183   $prefix .= ' ' if $prefix;
 184
 185   $self->message($level, $prefix . sprintf($format, @sorted_names));
 186   $self->message($level, $prefix . join('+', map { '-' x $column_lengths{$_} } @sorted_names));
 187
 188   foreach my $row (@{ $results }) {
 189     $self->message($level, $prefix . sprintf($format, map { $row->{$_} } @sorted_names));
 190   }
 191   $self->message($level, $prefix . sprintf('(%d row%s)', scalar @{ $results }, scalar @{ $results } > 1 ? 's' : ''));
 192 }
 193
 194 sub enable_sub_tracing {
 195   my ($self) = @_;
 196   $global_level |= TRACE;
 197 }
 198
 199 sub disable_sub_tracing {
 200   my ($self) = @_;
 201   $global_level &= ~ TRACE;
 202 }
 203
 204 sub is_tracing_enabled {
 205   my ($self) = @_;
 206   return $global_level & TRACE;
 207 }
 208
 209 sub _write {
 210   my ($self, $prefix, $message) = @_;
 211   my $date = strftime("%Y-%m-%d %H:%M:%S $$ ${prefix}: ", localtime(time()));
 212   local *FILE;
 213
 214   chomp($message);
 215
 216   if ((FILE_TARGET == $self->{"target"})
 217       && open(FILE, ">>" . $self->{"file"})) {
 218     print(FILE "${date}${message}\n");
 219     close(FILE);
 220
 221   } elsif (STDERR_TARGET == $self->{"target"}) {
 222     print(STDERR "${date}${message}\n");
 223   }
 224 }
 225
 226 sub level2string {
 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 ]
 229 }
 230
 231 sub begin_request {
 232   my $self = shift;
 233   return 1 unless ($global_level & REQUEST_TIMER);
 234   $self->{request_start} = [gettimeofday];
 235 }
 236
 237 sub end_request {
 238   my $self = shift;
 239   return 1 unless ($global_level & REQUEST_TIMER);
 240   $self->_write("time", tv_interval($self->{request_start}));
 241 }
 242
 243 1;