]> scm.dxcluster.org Git - spider.git/blob - perl/DXDebug.pm
lose some of the annoying uninitialised msgs
[spider.git] / perl / DXDebug.pm
1 #
2 # The system variables - those indicated will need to be changed to suit your
3 # circumstances (and callsign)
4 #
5 # Copyright (c) 1998-2019 - Dirk Koopman G1TLH
6 #
7 # Note: Everything is recorded into the ring buffer (in perl terms: a numerically max sized array).
8 #       To allow debugging of a category (e.g. 'chan') but not onto disc (just into the ring buffer)
9 #       do: set/debug chan nologchan
10 #
11 #       To print the current contents into the debug log: show/debug_ring
12 #
13 #       On exit or serious error the ring buffer is printed to the current debug log
14 #
15 # In Progress:
16 #       Expose a localhost listener on port (default) 27755 to things like watchdbg so that they can carry on
17 #       as normal, possibly with a "remember" button to permanently capture stuff observed.
18 #
19 # Future:
20 #       This is likely to be some form of triggering or filtering controlling (some portion
21 #       of) ring_buffer dumping.
22 #
23 #
24
25 package DXDebug;
26
27 require Exporter;
28 @ISA = qw(Exporter);
29 @EXPORT = qw(dbginit dbg dbgadd dbgsub dbglist dbgdump isdbg dbgclose confess croak cluck);
30
31 use strict;
32 use vars qw(%dbglevel $fp $callback $cleandays $keepdays $dbgringlth);
33
34 use DXUtil;
35 use DXLog ();
36 use Carp ();
37 use POSIX qw(isatty);
38
39 %dbglevel = ();
40 $fp = undef;
41 $callback = undef;
42 $keepdays = 10;
43 $cleandays = 100;
44 $dbgringlth = 500;
45
46 our $no_stdout;                                 # set if not running in a terminal
47 our @dbgring;
48
49 # Avoid generating "subroutine redefined" warnings with the following
50 # hack (from CGI::Carp):
51 if (!defined $DB::VERSION) {
52         local $^W=0;
53         eval qq( sub confess { 
54             \$SIG{__DIE__} = 'DEFAULT'; 
55         DXDebug::dbgprintring() if DXDebug::isdbg('nologchan');
56         DXDebug::dbg(\$@);
57                 DXDebug::dbg(Carp::shortmess(\@_));
58             exit(-1); 
59         }
60         sub croak { 
61                 \$SIG{__DIE__} = 'DEFAULT'; 
62         DXDebug::dbgprintring() if DXDebug::isdbg('nologchan');
63         DXDebug::dbg(\$@);
64                 DXDebug::dbg(Carp::longmess(\@_));
65                 exit(-1); 
66         }
67         sub carp { 
68         DXDebug::dbgprintring(25) if DXDebug('nologchan');
69         DXDebug::dbg(Carp::shortmess(\@_)); 
70     }
71         sub cluck { 
72         DXDebug::dbgprintring(25) if DXDebug('nologchan');
73         DXDebug::dbg(Carp::longmess(\@_)); 
74     } );
75
76     CORE::die(Carp::shortmess($@)) if $@;
77 } else {
78     eval qq( sub confess { die Carp::longmess(\@_); }; 
79                          sub croak { die Carp::shortmess(\@_); }; 
80                          sub cluck { warn Carp::longmess(\@_); }; 
81                          sub carp { warn Carp::shortmess(\@_); }; 
82    );
83
84
85
86 my $_isdbg;                                             # current dbg level we are processing
87
88 sub dbg($)
89 {
90         return unless $fp;
91         my $t = time; 
92         for (@_) {
93                 my $r = $_;
94                 chomp $r;
95                 my @l = split /\n/, $r;
96                 for (@l) {
97                         s/([\x00-\x08\x0B-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
98                         print "$_\n" if defined \*STDOUT && !$no_stdout;
99                         my $str = "$t^$_";
100                         &$callback($str) if $callback;
101                         if ($dbgringlth) {
102                                 shift @dbgring while (@dbgring > $dbgringlth);
103                                 push @dbgring, $str;
104                         }
105                         $fp->writeunix($t, $str) unless $dbglevel{"nolog$_isdbg"}; 
106                 }
107         }
108         $_isdbg = '';
109 }
110
111 sub dbginit
112 {
113         $callback = shift;
114         
115         # add sig{__DIE__} handling
116         unless (defined $DB::VERSION) {
117                 $SIG{__WARN__} = sub { 
118                         if ($_[0] =~ /Deep\s+recursion/i) {
119                                 dbg($@);
120                                 dbg(Carp::longmess(@_)); 
121                                 CORE::die;
122                         }
123                         else { 
124                                 dbg($@);
125                                 dbg(Carp::shortmess(@_));
126                         }
127                 };
128                 
129                 $SIG{__DIE__} = sub { dbg($@); dbg(Carp::longmess(@_)); };
130
131                 # switch off STDOUT printing if we are not talking to a TTY
132                 unless ($^O =~ /^MS/ || $^O =~ /^OS-2/) {
133                         unless (isatty(STDOUT->fileno)) {
134                                 ++$no_stdout;
135                         }
136                 }
137         }
138
139         $fp = DXLog::new('debug', 'dat', 'd');
140         dbgclearring();
141 }
142
143 sub dbgclose
144 {
145         $SIG{__DIE__} = $SIG{__WARN__} = 'DEFAULT';
146         if ($fp) {
147                 dbgprintring() if grep /nolog/, keys %dbglevel;
148                 $fp->close();
149         }
150         dbgclearring();
151         undef $fp;
152 }
153
154 sub dbgdump
155 {
156         return unless $fp;
157         
158         my $l = shift;
159         my $m = shift;
160         if ($dbglevel{$l} || $l eq 'err') {
161                 foreach my $l (@_) {
162                         for (my $o = 0; $o < length $l; $o += 16) {
163                                 my $c = substr $l, $o, 16;
164                                 my $h = unpack "H*", $c;
165                                 $c =~ s/[\x00-\x1f\x7f-\xff]/./g;
166                                 my $left = 16 - length $c;
167                                 $h .= ' ' x (2 * $left) if $left > 0;
168                                 dbg($m . sprintf("%4d:", $o) . "$h $c");
169                                 $m = ' ' x (length $m);
170                         }
171                 }
172         }
173 }
174
175 sub dbgadd
176
177         my $entry;
178         
179         foreach $entry (@_) {
180                 $dbglevel{$entry} = 1;
181         }
182 }
183
184 sub dbgsub
185 {
186         my $entry;
187         
188         foreach $entry (@_) {
189                 delete $dbglevel{$entry};
190         }
191 }
192
193 sub dbglist
194 {
195         return keys (%dbglevel);
196 }
197
198 sub isdbg($)
199 {
200         return unless $fp;
201         if ($dbglevel{$_[0]}) {
202                 $_isdbg = $_[0];
203                 return 1;
204     }
205 }
206
207 sub shortmess 
208 {
209         return Carp::shortmess(@_);
210 }
211
212 sub longmess 
213 {
214         return Carp::longmess(@_);
215 }
216
217 sub dbgprintring
218 {
219         return unless $fp;
220         my $count = shift;
221         my $first;
222         my $l;
223         my $i = defined $count ? @dbgring-$count : 0;
224         $count = @dbgring;
225         for ( ; $i < $count; ++$i) {
226                 my ($t, $str) = split /\^/, $dbgring[$i], 2;
227                 next unless $t;
228                 my $lt = time;
229                 unless ($first) {
230                         $fp->writeunix($lt, "$lt^###");
231                         $fp->writeunix($lt, "$lt^### RINGBUFFER START at line $i (zero base)");
232                         $fp->writeunix($lt, "$lt^###");
233                         $first = $t;
234                 }
235                 my $buf = sprintf "%02d:%02d:%02d", (gmtime($t))[2,1,0];
236                 $fp->writeunix($lt, "$lt^RING: $buf^$str");
237         }
238         my $et = time;
239         $fp->writeunix($et, "$et^###");
240         $fp->writeunix($et, "$et^### RINGBUFFER END");
241         $fp->writeunix($et, "$et^###");
242 }
243
244 sub dbgclearring
245 {
246         @dbgring = ();
247 }
248
249 # clean out old debug files, stop when you get a gap of more than a month
250 sub dbgclean
251 {
252         my $date = $fp->unixtoj($main::systime)->sub($keepdays+1);
253         my $i = 0;
254
255         while ($i < 31) {
256                 my $fn = $fp->_genfn($date);
257                 if (-e $fn) {
258                         unlink $fn;
259                         $i = 0;
260                 }
261                 else {
262                         $i++;
263                 }
264                 $date = $date->sub(1);
265         }
266 }
267
268 1;
269 __END__
270
271
272
273
274
275
276