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 ALL                => (1 << 6) - 1;
  11 use constant DEVEL              => INFO | QUERY | TRACE | BACKTRACE_ON_ERROR;
  12
  13 use constant FILE_TARGET   => 0;
  14 use constant STDERR_TARGET => 1;
  15
  16 use POSIX qw(strftime);
  17
  18 use YAML;
  19
  20 my $data_dumper_available;
  21
  22 our $global_level;
  23 our $watch_form;
  24
  25 BEGIN {
  26   eval("use Data::Dumper");
  27   $data_dumper_available = $@ ? 0 : 1;
  28
  29   $global_level      = NONE;
  30   $watch_form        = 0;
  31 }
  32
  33 sub new {
  34   my $type = shift;
  35   my $self = {};
  36
  37   $self->{"calldepth"}  = 0;
  38   $self->{"file"}       = "/tmp/lx-office-debug.log";
  39   $self->{"target"}     = FILE_TARGET;
  40   $self->{"level"}      = 0;
  41
  42   while ($_[0]) {
  43     $self->{ $_[0] } = $_[1];
  44     shift;
  45     shift;
  46   }
  47
  48   bless($self, $type);
  49 }
  50
  51 sub set_target {
  52   my ($self, $target, $file) = @_;
  53
  54   if ((FILE_TARGET == $target) && $file) {
  55     $self->{"file"}   = $file;
  56     $self->{"target"} = FILE_TARGET;
  57
  58   } elsif (STDERR_TARGET == $target) {
  59     $self->{"target"} = STDERR_TARGET;
  60   }
  61 }
  62
  63 sub enter_sub {
  64   my ($self, $level) = @_;
  65   $level *= 1;
  66
  67   return 1 unless ($global_level & TRACE);          # ignore if traces aren't active
  68   return 1 if $level && !($global_level & $level);  # ignore if level of trace isn't active
  69
  70   my ($package, $filename, $line, $subroutine) = caller(1);
  71   my ($dummy1, $self_filename, $self_line) = caller(0);
  72
  73   my $indent = " " x $self->{"calldepth"}++;
  74
  75   if (!defined($package)) {
  76     $self->_write('sub' . $level, $indent . "\\ top-level?\n");
  77   } else {
  78     $self->_write('sub' . $level, $indent
  79                     . "\\ ${subroutine} in "
  80                     . "${self_filename}:${self_line} called from "
  81                     . "${filename}:${line}\n");
  82   }
  83   return 1;
  84 }
  85
  86 sub leave_sub {
  87   my ($self, $level) = @_;
  88   $level *= 1;
  89
  90   return 1 unless ($global_level & TRACE);           # ignore if traces aren't active
  91   return 1 if $level && !($global_level & $level);   # ignore if level of trace isn't active
  92
  93   my ($package, $filename, $line, $subroutine) = caller(1);
  94   my ($dummy1, $self_filename, $self_line) = caller(0);
  95
  96   my $indent = " " x --$self->{"calldepth"};
  97
  98   if (!defined($package)) {
  99     $self->_write('sub' . $level, $indent . "/ top-level?\n");
 100   } else {
 101     $self->_write('sub' . $level, $indent . "/ ${subroutine} in " . "${self_filename}:${self_line}\n");
 102   }
 103   return 1;
 104 }
 105
 106 sub show_backtrace {
 107   my ($self) = @_;
 108
 109   return 1 unless ($global_level & BACKTRACE_ON_ERROR);
 110
 111   $self->message(BACKTRACE_ON_ERROR, "Starting full caller dump:");
 112   my $level = 0;
 113   while (my ($dummy, $filename, $line, $subroutine) = caller $level) {
 114     $self->message(BACKTRACE_ON_ERROR, "  ${subroutine} from ${filename}:${line}");
 115     $level++;
 116   }
 117
 118   return 1;
 119 }
 120
 121 sub message {
 122   my ($self, $level, $message) = @_;
 123
 124   $self->_write(level2string($level), $message) if (($self->{"level"} | $global_level) & $level || !$level);
 125 }
 126
 127 sub dump {
 128   my ($self, $level, $name, $variable) = @_;
 129
 130   if ($data_dumper_available) {
 131     my $dumper = Data::Dumper->new([$variable]);
 132     $dumper->Sortkeys(1);
 133     $self->message($level, "dumping ${name}:\n" . $dumper->Dump());
 134   } else {
 135     $self->message($level,
 136                    "dumping ${name}: Data::Dumper not available; "
 137                      . "variable cannot be dumped");
 138   }
 139 }
 140
 141 sub dump_yaml {
 142   my ($self, $level, $name, $variable) = @_;
 143
 144   $self->message($level, "dumping ${name}:\n" . YAML::Dump($variable));
 145 }
 146
 147 sub dump_sql_result {
 148   my ($self, $level, $prefix, $results) = @_;
 149
 150   if (!$results || !scalar @{ $results }) {
 151     $self->message($level, "Empty result set");
 152     return;
 153   }
 154
 155   my %column_lengths = map { $_, length $_ } keys %{ $results->[0] };
 156
 157   foreach my $row (@{ $results }) {
 158     map { $column_lengths{$_} = length $row->{$_} if (length $row->{$_} > $column_lengths{$_}) } keys %{ $row };
 159   }
 160
 161   my @sorted_names = sort keys %column_lengths;
 162   my $format       = join '|', map { '%' . $column_lengths{$_} . 's' } @sorted_names;
 163
 164   $prefix .= ' ' if $prefix;
 165
 166   $self->message($level, $prefix . sprintf($format, @sorted_names));
 167   $self->message($level, $prefix . join('+', map { '-' x $column_lengths{$_} } @sorted_names));
 168
 169   foreach my $row (@{ $results }) {
 170     $self->message($level, $prefix . sprintf($format, map { $row->{$_} } @sorted_names));
 171   }
 172   $self->message($level, $prefix . sprintf('(%d row%s)', scalar @{ $results }, scalar @{ $results } > 1 ? 's' : ''));
 173 }
 174
 175 sub enable_sub_tracing {
 176   my ($self) = @_;
 177   $self->{level} | TRACE;
 178 }
 179
 180 sub disable_sub_tracing {
 181   my ($self) = @_;
 182   $self->{level} & ~ TRACE;
 183 }
 184
 185 sub _write {
 186   my ($self, $prefix, $message) = @_;
 187   my $date = strftime("%Y-%m-%d %H:%M:%S $$ ${prefix}: ", localtime(time()));
 188   local *FILE;
 189
 190   chomp($message);
 191
 192   if ((FILE_TARGET == $self->{"target"})
 193       && open(FILE, ">>" . $self->{"file"})) {
 194     print(FILE "${date}${message}\n");
 195     close(FILE);
 196
 197   } elsif (STDERR_TARGET == $self->{"target"}) {
 198     print(STDERR "${date}${message}\n");
 199   }
 200 }
 201
 202 sub level2string {
 203   # use $_[0] as a bit mask and return levelstrings separated by /
 204   join '/', qw(info debug1 debug2 query trace error_call_trace)[ grep { (reverse split //, sprintf "%05b", $_[0])[$_] } 0..5 ]
 205 }
 206
 207 1;