Kosmetik
[kivitendo-erp.git] / SL / LXDebug.pm
index 185297b..43ad76a 100644 (file)
@@ -7,20 +7,24 @@ use constant DEBUG2             =>  1 << 2;
 use constant QUERY              =>  1 << 3;
 use constant TRACE              =>  1 << 4;
 use constant BACKTRACE_ON_ERROR =>  1 << 5;
-use constant ALL                => (1 << 6) - 1;
-use constant DEVEL              => INFO | QUERY | TRACE | BACKTRACE_ON_ERROR;
+use constant REQUEST_TIMER      =>  1 << 6;
+use constant ALL                => (1 << 7) - 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");
@@ -35,7 +39,7 @@ sub new {
   my $self = {};
 
   $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;
 
@@ -71,12 +75,13 @@ sub enter_sub {
   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");
   }
@@ -94,19 +99,20 @@ sub leave_sub {
   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;
@@ -128,14 +134,22 @@ 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)) {
+    if ($variable && (('HASH' eq ref $variable) || ('Form' eq ref $variable))) {
       keys %{ $variable };
     }
 
@@ -182,17 +196,22 @@ sub dump_sql_result {
 
 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 {
   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);
@@ -212,4 +231,32 @@ sub level2string {
   join '/', qw(info debug1 debug2 query trace error_call_trace)[ grep { (reverse split //, sprintf "%05b", $_[0])[$_] } 0..5 ]
 }
 
+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 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;
+}
+
 1;