d779d830f5f5c85723aa4dfae97225f23f0cf92d
[privoxy.git] / tools / privoxy-log-parser.pl
1 #!/usr/bin/perl
2
3 ################################################################################
4 # privoxy-log-parser
5 #
6 # A parser for Privoxy log messages. For incomplete documentation run
7 # perldoc privoxy-log-parser(.pl), for fancy screenshots see:
8 #
9 # https://www.fabiankeil.de/sourcecode/privoxy-log-parser/
10 #
11 # $Id: privoxy-log-parser.pl,v 1.163 2016/08/26 11:19:53 fabiankeil Exp $
12 #
13 # TODO:
14 #       - LOG_LEVEL_CGI, LOG_LEVEL_ERROR, LOG_LEVEL_WRITE content highlighting
15 #       - create fancy statistics
16 #       - grep through Privoxy sources to find unsupported log messages
17 #       - hunt down substitutions that match content from variables which
18 #         can contain stuff like ()?'[]
19 #       - replace $h{'foo'} with h('foo') where possible
20 #       - hunt down XXX comments instead of just creating them
21 #       - add example log lines for every regex and mark them up for
22 #         regression testing
23 #       - Handle incomplete input without Perl warning about undefined variables.
24 #       - Use generic highlighting function that takes a regex and the
25 #         hash key as input.
26 #       - Add --compress and --decompress options.
27 #
28 # Copyright (c) 2007-2013 Fabian Keil <fk@fabiankeil.de>
29 #
30 # Permission to use, copy, modify, and distribute this software for any
31 # purpose with or without fee is hereby granted, provided that the above
32 # copyright notice and this permission notice appear in all copies.
33 #
34 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
35 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
36 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
37 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
38 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
39 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
40 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
41 ################################################################################
42
43 use strict;
44 use warnings;
45 use Getopt::Long;
46
47 use constant {
48     PRIVOXY_LOG_PARSER_VERSION => '0.8',
49     # Feel free to mess with these ...
50     DEFAULT_BACKGROUND => 'black',  # Choose registered colour (like 'black')
51     DEFAULT_TEXT_COLOUR => 'white', # Choose registered colour (like 'black')
52     HEADER_DEFAULT_COLOUR => 'yellow',
53     REGISTER_HEADERS_WITH_THE_SAME_COLOUR => 1,
54
55     CLI_OPTION_DEFAULT_TO_HTML_OUTPUT => 0,
56     CLI_OPTION_TITLE => 'Privoxy-Log-Parser in da house',
57     CLI_OPTION_NO_EMBEDDED_CSS => 0,
58     CLI_OPTION_NO_MSECS => 0,
59     CLI_OPTION_NO_SYNTAX_HIGHLIGHTING => 0,
60     CLI_OPTION_SHORTEN_THREAD_IDS => 0,
61     CLI_OPTION_SHOW_INEFFECTIVE_FILTERS => 0,
62     CLI_OPTION_STATISTICS => 0,
63     CLI_OPTION_STRICT_CHECKS => 0,
64     CLI_OPTION_UNBREAK_LINES_ONLY => 0,
65     CLI_OPTION_URL_STATISTICS_THRESHOLD => 0,
66     CLI_OPTION_HOST_STATISTICS_THRESHOLD => 0,
67     CLI_OPTION_SHOW_COMPLETE_REQUEST_DISTRIBUTION => 0,
68
69     SUPPRESS_SUCCEEDED_FILTER_ADDITIONS => 1,
70     SHOW_SCAN_INTRO => 0,
71     SHOW_FILTER_READIN_IN => 0,
72     SUPPRESS_EMPTY_LINES => 1,
73     SUPPRESS_SUCCESSFUL_CONNECTIONS => 1,
74     SUPPRESS_GIF_NOT_CHANGED => 1,
75     SUPPRESS_NEED_TO_DE_CHUNK_FIRST => 1,
76
77     DEBUG_HEADER_REGISTERING => 0,
78     DEBUG_HEADER_HIGHLIGHTING => 0,
79     DEBUG_TICKS => 0,
80     DEBUG_PAINT_IT => 0,
81     DEBUG_SUPPRESS_LOG_MESSAGES => 0,
82
83     PUNISH_MISSING_LOG_KNOWLEDGE_WITH_DEATH => 0,
84     PUNISH_MISSING_HIGHLIGHT_KNOWLEDGE_WITH_DEATH => 1,
85
86     LOG_UNPARSED_LINES_TO_EXTRA_FILE => 0,
87     ERROR_LOG_FILE => '/var/log/privoxy-log-parser',
88
89     # You better leave these alone unless you know what you're doing.
90     COLOUR_RESET      => "\033[0;0m",
91     ESCAPE => "\033[",
92 };
93
94 # For performance reasons, these are global.
95
96 my $t;
97 my %req; # request data from previous lines
98 my %h;
99 my %thread_colours;
100 my @all_colours;
101 my @time_colours;
102 my $thread_colour_index = 0;
103 my $header_colour_index = 0;
104 my $time_colour_index = 0;
105 my %header_colours;
106 my $no_special_header_highlighting;
107 my %reason_colours;
108 my %h_colours;
109 my $header_highlight_regex = '';
110
111 my $html_output_mode;
112 my $no_msecs_mode; # XXX: should probably be removed
113 my $shorten_thread_ids;
114 my $line_end;
115
116 sub prepare_our_stuff () {
117
118     # Syntax Higlight hash
119     @all_colours = (
120         'red', 'green', 'brown', 'blue', 'purple', 'cyan',
121         'light_gray', 'light_red', 'light_green', 'yellow',
122         'light_blue', 'pink', 'light_cyan', 'white'
123     );
124
125     %h = (
126         # LOG_LEVEL
127         Info            => 'blue',
128         Header          => 'green',
129         Filter          => 'purple', # XXX: Used?
130         'Re-Filter'     => 'purple',
131         Connect         => 'brown',
132         Request         => 'light_cyan',
133         CGI             => 'light_green',
134         Redirect        => 'cyan',
135         Error           => 'light_red',
136         Crunch          => 'cyan',
137         'Fatal error'   => 'light_red',
138         'Gif-Deanimate' => 'blue',
139         Force           => 'red',
140         Writing         => 'light_green',
141         Received        => 'yellow',
142         Actions         => 'yellow',
143         # ----------------------
144         URL                  => 'yellow',
145         path                 => 'brown',
146         request_             => 'brown', # host+path but no protocol
147         'ip-address'         => 'yellow',
148         Number               => 'yellow',
149         Standard             => 'reset',
150         Truncation           => 'light_red',
151         Status               => 'brown',
152         Timestamp            => 'brown',
153         Crunching            => 'light_red',
154         crunched             => 'light_red',
155         'Request-Line'       => 'pink',
156         method               => 'purple',
157         destination          => 'yellow',
158         'http-version'       => 'pink',
159         'crunch-pattern'     => 'pink',
160         not                  => 'brown',
161         file                 => 'brown',
162         signal               => 'yellow',
163         version              => 'green',
164         'program-name'       => 'cyan',
165         port                 => 'red',
166         host                 => 'red',
167         warning              => 'light_red',
168         debug                => 'light_red',
169         filter               => 'green',
170         tag                  => 'green',
171         tagger               => 'green',
172         'status-message'     => 'light_cyan',
173         'status-code'        => 'yellow',
174         'invalid-request'    => 'light_red',
175         'hits'               => 'yellow',
176         error                => 'light_red',
177         'rewritten-URL'      => 'light_red',
178         'pcrs-delimiter'     => 'light_red',
179         'ignored'            => 'light_red',
180         'action-bits-update' => 'light_red',
181         'configuration-line' => 'red',
182         'content-type'       => 'yellow',
183         'HOST'               => HEADER_DEFAULT_COLOUR,
184     );
185
186     %h_colours = %h;
187
188     # Header colours need their own hash so the keys can be accessed properly
189     %header_colours = (
190         # Prefilled with headers that should not appear with default header colours
191         Cookie => 'light_red',
192         'Set-Cookie' => 'light_red',
193         Warning => 'light_red',
194         Default => HEADER_DEFAULT_COLOUR,
195     );
196
197     # Crunch reasons need their own hash as well
198     %reason_colours = (
199         'Unsupported HTTP feature'               => 'light_red',
200         Blocked                                  => 'light_red',
201         Untrusted                                => 'light_red',
202         Redirected                               => 'green',
203         'CGI Call'                               => 'white',
204         'DNS failure'                            => 'red',
205         'Forwarding failed'                      => 'light_red',
206         'Connection failure'                     => 'light_red',
207         'Out of memory (may mask other reasons)' => 'light_red',
208         'No reason recorded'                     => 'light_red',
209     );
210
211     @time_colours = ('white', 'light_gray');
212
213     # Translate highlight strings into highlight code
214     prepare_highlight_hash(\%header_colours);
215     prepare_highlight_hash(\%reason_colours);
216     prepare_highlight_hash(\%h);
217     prepare_colour_array(\@all_colours);
218     prepare_colour_array(\@time_colours);
219     init_css_colours();
220
221     init_stats();
222 }
223
224 sub paint_it ($) {
225 ###############################################################
226 # Takes a colour string and returns an ANSI escape sequence
227 # (unless --no-syntax-highlighting is used).
228 # XXX: The Rolling Stones reference has to go.
229 ###############################################################
230
231     my $colour = shift;
232
233     return "" if cli_option_is_set('no-syntax-highlighting');
234
235     my %light = (
236         black       => 0,
237         red         => 0,
238         green       => 0,
239         brown       => 0,
240         blue        => 0,
241         purple      => 0,
242         cyan        => 0,
243         light_gray  => 0,
244         gray        => 0,
245         dark_gray   => 1,
246         light_red   => 1,
247         light_green => 1,
248         yellow      => 1,
249         light_blue  => 1,
250         pink        => 1,
251         light_cyan  => 1,
252         white       => 1,
253     );
254
255     my %text = (
256         black       => 30,
257         red         => 31,
258         green       => 32,
259         brown       => 33,
260         blue        => 34,
261         purple      => 35,
262         cyan        => 36,
263         gray        => 37,
264         light_gray  => 37,
265         dark_gray   => 30,
266         light_red   => 31,
267         light_green => 32,
268         yellow      => 33,
269         light_blue  => 34,
270         pink        => 35,
271         light_cyan  => 36,
272         white       => 37,
273     );
274
275     my $bg_code = get_background();
276     my $colour_code;
277     our $default = default_colours();
278
279     if (defined($text{$colour})) {
280         $colour_code  = ESCAPE;
281         $colour_code .= $text{$colour};
282         $colour_code .= ";";
283         $colour_code .= $light{$colour} ? "1" : "2";
284         $colour_code .= ";";
285         $colour_code .= $bg_code;
286         $colour_code .= "m";
287         debug_message $colour . " is \'" . $colour_code . $colour . $default . "\'" if DEBUG_PAINT_IT;
288
289     } elsif ($colour =~ /reset/) {
290
291         $colour_code = default_colours();
292
293     } else {
294
295         die "What's $colour supposed to mean?\n";
296     }
297
298     return $colour_code;
299 }
300
301 sub get_semantic_html_markup ($) {
302 ###############################################################
303 # Takes a string and returns a span element
304 ###############################################################
305
306     my $type = shift;
307     my $code;
308
309     if ($type =~ /Standard/) {
310         $code = '</span>';
311     } else {
312         $type = lc($type);
313         $code = '<span title="' . $type . '" class="' . $type . '">';
314     }
315
316     return $code;
317 }
318
319 sub cli_option_is_set ($) {
320
321     our %cli_options;
322     my $cli_option = shift;
323
324     die "Unknown CLI option: $cli_option" unless defined $cli_options{$cli_option};
325
326     return $cli_options{$cli_option};
327 }
328
329 sub get_html_title () {
330
331     our %cli_options;
332     return $cli_options{'title'};
333
334 }
335
336 sub init_css_colours() {
337
338     our %css_colours = (
339         black       => "000",
340         red         => "F00",
341         green       => "0F0",
342         brown       => "C90",
343         blue        => "0F0",
344         purple      => "F06", # XXX: wrong
345         cyan        => "F09", # XXX: wrong
346         light_gray  => "999",
347         gray        => "333",
348         dark_gray   => "222",
349         light_red   => "F33",
350         light_green => "33F",
351         yellow      => "FF0",
352         light_blue  => "30F",
353         pink        => "F0F",
354         light_cyan  => "66F",
355         white       => "FFF",
356     );
357 }
358
359 sub get_css_colour ($) {
360
361    our %css_colours;
362    my $colour = shift;
363
364    die "What's $colour supposed to mean?\n" unless defined($css_colours{$colour});
365
366    return '#' . $css_colours{$colour};
367 }
368
369 sub get_css_line ($) {
370
371     my $class = shift;
372     my $css_line;
373
374     $css_line .= '.' . lc($class) . ' {'; # XXX: lc() shouldn't be necessary
375     die "What's $class supposed to mean?\n" unless defined($h_colours{$class});
376     $css_line .= 'color:' . get_css_colour($h_colours{$class}) . ';';
377     $css_line .= 'background-color:' . get_css_colour(DEFAULT_BACKGROUND) . ';';
378     $css_line .= '}' . "\n";
379
380     return $css_line;
381 }
382
383 sub get_css_line_for_colour ($) {
384
385     my $colour = shift;
386     my $css_line;
387
388     $css_line .= '.' . lc($colour) . ' {'; # XXX: lc() shouldn't be necessary
389     $css_line .= 'color:' . get_css_colour($colour) . ';';
390     $css_line .= 'background-color:' . get_css_colour(DEFAULT_BACKGROUND) . ';';
391     $css_line .= '}' . "\n";
392
393     return $css_line;
394 }
395
396 # XXX: Wrong solution
397 sub get_missing_css_lines () {
398
399     my $css_line;
400
401     $css_line .= '.' . 'default' . ' {';
402     $css_line .= 'color:' . HEADER_DEFAULT_COLOUR . ';';
403     $css_line .= 'background-color:' . get_css_colour(DEFAULT_BACKGROUND) . ';';
404     $css_line .= '}' . "\n";
405
406     return $css_line;
407 }
408
409 sub get_css () {
410
411     our %css_colours; #XXX: Wrong solution
412
413     my $css = '';
414
415     $css .= '.privoxy-log {';
416     $css .= 'color:' . get_css_colour(DEFAULT_TEXT_COLOUR) . ';';
417     $css .= 'background-color:' . get_css_colour(DEFAULT_BACKGROUND) . ';';
418     $css .= '}' . "\n";
419
420     foreach my $key (keys %h_colours) {
421
422         next if ($h_colours{$key} =~ m/reset/); #XXX: Wrong solution.
423         $css .= get_css_line($key);
424
425     }
426
427     foreach my $colour (keys %css_colours) {
428
429         $css .= get_css_line_for_colour($colour);
430
431     }
432
433     $css .= get_missing_css_lines(); #XXX: Wrong solution
434
435     return $css;
436 }
437
438 sub print_intro () {
439
440     my $intro = '';
441
442     if (cli_option_is_set('html-output')) {
443
444         my $title = get_html_title();
445
446         $intro .= '<html><head>';
447         $intro .= '<title>' . $title . '</title>';
448         $intro .= '<style>' . get_css() . '</style>' unless cli_option_is_set('no-embedded-css');
449         $intro .= '</head><body>';
450         $intro .= '<h1>' . $title . '</h1><p class="privoxy-log">';
451
452         print $intro;
453     }
454 }
455
456 sub print_outro () {
457
458     my $outro = '';
459
460     if (cli_option_is_set('html-output')) {
461
462         $outro = '</p></body></html>';
463         print $outro;
464
465     }
466 }
467
468 sub get_line_end () {
469     return cli_option_is_set('html-output') ? "<br>\n" : "\n";
470 }
471
472 sub get_colour_html_markup ($) {
473 ###############################################################
474 # Takes a colour string a span element. XXX: WHAT?
475 # XXX: This function shouldn't be necessary, the
476 # markup should always be semantically correct.
477 ###############################################################
478
479     my $type = shift;
480     my $code;
481
482     if ($type =~ /Standard/) {
483         $code = '</span>';
484     } else {
485         $code = '<span class="' . lc($type) . '">';
486     }
487
488     return $code;
489 }
490
491 sub default_colours () {
492     # XXX: Properly
493     our $bg_code;
494     return reset_colours();
495 }
496
497 sub show_colours () {
498     # XXX: Implement
499 }
500
501 sub reset_colours () {
502     return ESCAPE . "0m";
503 }
504
505 sub set_background ($){
506
507     my $colour = shift;
508     our $bg_code;
509     my %backgrounds = (
510               black       => "40",
511               red         => "41",
512               green       => "42",
513               brown       => "43",
514               blue        => "44",
515               magenta     => "45",
516               cyan        => "46",
517               white       => "47",
518               default     => "49",
519     );
520
521     if (defined($backgrounds{$colour})) {
522         $bg_code = $backgrounds{$colour};
523     } else {
524         die "Invalid background colour: " . $colour;
525     }
526 }
527
528 sub get_background (){
529     return our $bg_code;
530 }
531
532 sub prepare_highlight_hash ($) {
533     my $ref = shift;
534
535     foreach my $key (keys %$ref) {
536         $$ref{$key} = $html_output_mode ?
537             get_semantic_html_markup($key) :
538             paint_it($$ref{$key});
539     }
540 }
541
542 sub prepare_colour_array ($) {
543     my $ref = shift;
544
545     foreach my $i (0 ... @$ref - 1) {
546         $$ref[$i] = $html_output_mode ?
547             get_colour_html_markup($$ref[$i]) :
548             paint_it($$ref[$i]);
549     }
550 }
551
552 sub found_unknown_content ($) {
553
554     my $unknown = shift;
555     my $message;
556
557     return unless cli_option_is_set('strict-checks');
558
559     return if ($unknown =~ /\[too long, truncated\]$/);
560
561     $message = "found_unknown_content: Don't know how to highlight: ";
562     # Break line so the log file can later be parsed as Privoxy log file again
563     $message .= '"' . $unknown . '"' . " in:\n";
564     $message .= $req{$t}{'log-message'};
565     debug_message($message);
566     log_parse_error($req{$t}{'log-message'});
567
568     die "Unworthy content parser" if PUNISH_MISSING_LOG_KNOWLEDGE_WITH_DEATH;
569 }
570
571 sub log_parse_error ($) {
572
573     my $message = shift;
574
575     if (LOG_UNPARSED_LINES_TO_EXTRA_FILE) {
576         open(my $errorlog_fd, ">>", ERROR_LOG_FILE) || die "Writing " . ERROR_LOG_FILE . " failed";
577         print $errorlog_fd $message;
578         close($errorlog_fd);
579     }
580 }
581
582 sub debug_message (@) {
583     my @message = @_;
584
585     print $h{'debug'} . "@message" . $h{'Standard'} . "\n";
586 }
587
588 ################################################################################
589 # highlighter functions that aren't loglevel-specific
590 ################################################################################
591
592 sub h ($) {
593
594     # Get highlight marker
595     my $highlight = shift; # XXX: Stupid name;
596     my $result = '';
597     my $message;
598
599     if (defined($highlight)) {
600
601         $result = $h{$highlight};
602
603     } else {
604
605         $message = "h: Don't recognize highlighter $highlight.";
606         debug_message($message);
607         log_parser_error($message);
608         die "Unworthy highlighter function" if PUNISH_MISSING_HIGHLIGHT_KNOWLEDGE_WITH_DEATH;
609     }
610
611     return $result;
612 }
613
614 sub highlight_known_headers ($) {
615
616     my $content = shift;
617
618     debug_message("Searching $content for things to highlight.") if DEBUG_HEADER_HIGHLIGHTING;
619
620     if ($content =~ m/(?<=\s)($header_highlight_regex):/) {
621         my $header = $1;
622         $content =~ s@(?<=[\s|'])($header)(?=:)@$header_colours{$header}$1$h{'Standard'}@ig;
623         debug_message("Highlighted '$header' in '$content'") if DEBUG_HEADER_HIGHLIGHTING;
624     }
625
626     return $content;
627 }
628
629 sub highlight_matched_request_line ($$) {
630
631     my $result = shift; # XXX: Stupid name;
632     my $regex = shift;
633     if ($result =~ m@(.*)($regex)(.*)@) {
634         $result = $1 . highlight_request_line($2) . $3
635     }
636     return $result;
637 }
638
639 sub highlight_request_line ($) {
640
641     my $rl = shift;
642     my ($method, $url, $http_version);
643
644     #GET http://images.sourceforge.net/sfx/icon_warning.gif HTTP/1.1
645     if ($rl =~ m/Invalid request/) {
646
647         $rl = h('invalid-request') . $rl . h('Standard');
648
649     } elsif ($rl =~ m/^([-\w]+) (.*) (HTTP\/\d+\.\d+)/) {
650
651         # XXX: might not match in case of HTTP method fuzzing.
652         # XXX: save these: ($method, $path, $http_version) = ($1, $2, $3);
653         $rl =~ s@^(\w+)@$h{'method'}$1$h{'Standard'}@;
654         if ($rl =~ /http:\/\//) {
655             $rl = highlight_matched_url($rl, '[^\s]*(?=\sHTTP)');
656         } else {
657             $rl = highlight_matched_pattern($rl, 'request_', '[^\s]*(?=\sHTTP)');
658         }
659
660         $rl =~ s@(HTTP\/\d\.\d)$@$h{'http-version'}$1$h{'Standard'}@;
661
662     } elsif ($rl =~ m/\.\.\. \[too long, truncated\]$/) {
663
664         $rl =~ s@^(\w+)@$h{'method'}$1$h{'Standard'}@;
665         $rl = highlight_matched_url($rl, '[^\s]*(?=\.\.\.)');
666
667     } elsif ($rl =~ m/^ $/) {
668
669         $rl = h('error') . "No request line specified!" . h('Standard');
670
671     } else {
672
673         debug_message ("Can't parse request line: $rl");
674
675     }
676
677     return $rl;
678 }
679
680 sub highlight_response_line ($) {
681
682     my $rl = shift;
683     my ($http_version, $status_code, $status_message);
684
685     #HTTP/1.1 200 OK
686     #ICY 200 OK
687
688     # TODO: Mark different status codes differently
689
690     if ($rl =~ m/((?:HTTP\/\d\.\d|ICY)) (\d+) (.*)/) {
691         ($http_version, $status_code, $status_message) = ($1, $2, $3);
692     } else {
693         debug_message ("Can't parse response line: $rl") and die 'Fix this';
694     }
695
696     # Rebuild highlighted
697     $rl= "";
698     $rl .= h('http-version') . $http_version . h('Standard');
699     $rl .= " ";
700     $rl .= h('status-code') . $status_code . h('Standard');
701     $rl .= " ";
702     $rl .= h('status-message') . $status_message . h('Standard');
703
704     return $rl;
705 }
706
707 sub highlight_matched_url ($$) {
708
709     my $result = shift; # XXX: Stupid name;
710     my $regex = shift;
711
712     #print "Got $result, regex ($regex)\n";
713
714     if ($result =~ m@(.*?)($regex)(.*)@) {
715         $result = $1 . highlight_url($2) . $3;
716         #print "Now the result is $result\n";
717     }
718
719     return $result;
720 }
721
722 sub highlight_matched_host ($$) {
723
724     my ($result, $regex) = @_; # XXX: result ist stupid name;
725
726     if ($result =~ m@(.*?)($regex)(.*)@) {
727         $result = $1 . $h{host} . $2 . $h{Standard} . $3;
728     }
729
730     return $result;
731 }
732
733 sub highlight_matched_pattern ($$$) {
734
735     my $result = shift; # XXX: Stupid name;
736     my $key = shift;
737     my $regex = shift;
738
739     die "Unknown key $key" unless defined $h{$key};
740
741     if ($result =~ m@(.*?)($regex)(.*)@) {
742         $result = $1 . h($key) . $2 . h('Standard') . $3;
743     }
744
745     return $result;
746 }
747
748 sub highlight_matched_path ($$) {
749
750     my $result = shift; # XXX: Stupid name;
751     my $regex = shift;
752
753     if ($result =~ m@(.*?)($regex)(.*)@) {
754         $result = $1 . h('path') . $2 . h('Standard') . $3;
755     }
756
757     return $result;
758 }
759
760 sub highlight_url ($) {
761
762     my $url = shift;
763
764     if ($html_output_mode) {
765
766         $url = '<a href="' . $url . '">' . $url . '</a>';
767
768     } else {
769
770         $url = h('URL') . $url . h('Standard');
771
772     }
773
774     return $url;
775 }
776
777 sub update_header_highlight_regex ($) {
778
779     my $header = shift;
780     my $headers = join ('|', keys %header_colours);
781
782     $header_highlight_regex = qr/$headers/;
783     print "Registering '$header'\n" if DEBUG_HEADER_HIGHLIGHTING;
784 }
785
786 ################################################################################
787 # loglevel-specific highlighter functions
788 ################################################################################
789
790 sub handle_loglevel_header ($) {
791
792     my $c = shift;
793
794     if ($c =~ /^scan:/) {
795
796         if ($c =~ m/^scan: ([^: ]+):/) {
797
798             # Register new headers
799             # scan: Accept: image/png,image/*;q=0.8,*/*;q=0.5
800             my $header = $1;
801             if (!defined($header_colours{$header}) and $header =~ /^[\d\w-]*$/) {
802                 debug_message "Registering previously unknown header $1" if DEBUG_HEADER_REGISTERING;
803
804                 if (REGISTER_HEADERS_WITH_THE_SAME_COLOUR) {
805                     $header_colours{$header} =  $header_colours{'Default'};
806                 } else {
807                     $header_colours{$header} = $all_colours[$header_colour_index % @all_colours];
808                     $header_colour_index++;
809                 }
810                 update_header_highlight_regex($header);
811             }
812
813         } elsif ($c =~ m/^(scan: )(\w+ .+ HTTP\/\d\.\d)/) {
814
815             # scan: GET http://p.p/ HTTP/1.1
816             $c = $1 . highlight_request_line($2);
817
818         } elsif ($c =~ m/^(scan: )((?:HTTP\/\d\.\d|ICY) (\d+) (.*))/) {
819
820             # scan: HTTP/1.1 200 OK
821             $req{$t}{'response_line'} = $2;
822             $req{$t}{'status_code'} = $3;
823             $req{$t}{'status_message'} = $4;
824             $c = $1 . highlight_response_line($req{$t}{'response_line'});
825         }
826
827     } elsif ($c =~ m/^Crunching (?:server|client) header: .* \(contains: ([^\)]*)\)/) {
828
829         # Crunching server header: Set-Cookie: trac_form_token=d5308c34e16d15e9e301a456; (contains: Cookie:)
830         $c =~ s@(?<=contains: )($1)@$h{'crunch-pattern'}$1$h{'Standard'}@;
831         $c =~ s@(Crunching)@$h{$1}$1$h{'Standard'}@;
832
833     } elsif ($c =~ m/^New host is: ([^\s]*)\./) {
834
835         # New host is: trac.vidalia-project.net. Crunching Referer: http://www.vidalia-project.net/!
836         $c = highlight_matched_host($c, '(?<=New host is: )[^\s]+(?=\.)');
837         $c = highlight_matched_url($c, '(?<=Crunching Referer: )[^\s!]+');
838
839     } elsif ($c =~ m/^Text mode enabled by force. (Take cover)!/) {
840
841         # Text mode enabled by force. Take cover!
842         $c =~ s@($1)@$h{'warning'}$1$h{'Standard'}@;
843
844     } elsif ($c =~ m/^(New HTTP Request-Line: )(.*)/) {
845
846         # New HTTP Request-Line: GET http://www.privoxy.org/ HTTP/1.1
847         $c = $1 . highlight_request_line($2);
848
849     } elsif ($c =~ m/^Adjust(ed)? Content-Length to \d+/) {
850
851         # Adjusted Content-Length to 2132
852         # Adjust Content-Length to 33533
853         $c =~ s@(?<=Content-Length to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
854         $c = highlight_known_headers($c);
855
856     } elsif ($c =~ m/^Destination extracted from "Host:" header. New request URL:/) {
857
858         # Destination extracted from "Host:" header. New request URL: http://www.cccmz.de/~ridcully/blog/
859         $c = highlight_matched_url($c, '(?<=New request URL: ).*');
860
861     } elsif ($c =~ m/^Couldn\'t parse:/) {
862
863         # XXX: These should probable be logged with LOG_LEVEL_ERROR
864         # Couldn't parse: If-Modified-Since: Wed, 21 Mar 2007 16:34:50 GMT (crunching!)
865         # Couldn't parse: at, 24 Mar 2007 13:46:21 GMT in If-Modified-Since: Sat, 24 Mar 2007 13:46:21 GMT (crunching!)
866         $c =~ s@^(Couldn\'t parse)@$h{'error'}$1$h{'Standard'}@;
867
868     } elsif ($c =~ /^Tagger \'([^\']*)\' added tag \'([^\']*)\'/ or
869              $c =~ m/^Adding tag \'([^\']*)\' created by header tagger \'([^\']*)\'/) {
870
871         # Adding tag 'GET request' created by header tagger 'method-man' (XXX: no longer used)
872         # Tagger 'revalidation' added tag 'REVALIDATION-REQUEST'. No action bit update necessary.
873         # Tagger 'revalidation' added tag 'REVALIDATION-REQUEST'. Action bits updated accordingly.
874
875         # XXX: Save tag and tagger
876
877         $c =~ s@(?<=^Tagger \')([^\']*)@$h{'tagger'}$1$h{'Standard'}@;
878         $c =~ s@(?<=added tag \')([^\']*)@$h{'tag'}$1$h{'Standard'}@;
879         $c =~ s@(?<=Action bits )(updated)@$h{'action-bits-update'}$1$h{'Standard'}@;
880         $no_special_header_highlighting = 1;
881
882     } elsif ($c =~ /^Tagger \'([^\']*)\' didn['']t add tag \'([^\']*)\'/) {
883
884         # Tagger 'revalidation' didn't add tag 'REVALIDATION-REQUEST'. Tag already present
885         # XXX: Save tag and tagger
886
887         $c =~ s@(?<=^Tagger \')([^\']*)@$h{'tag'}$1$h{'Standard'}@;
888         $c =~ s@(?<=didn['']t add tag \')([^\']*)@$h{'tagger'}$1$h{'Standard'}@;
889
890     } elsif ($c =~ m/^(?:scan:|Randomiz|addh:|Adding:|Removing:|Referer:|Modified:|Accept-Language header|[Cc]ookie)/
891           or $c =~ m/^(Text mode is already enabled|Denied request with NULL byte|Replaced:|add-unique:)/
892           or $c =~ m/^(Crunched (incoming|outgoing) cookie|Suppressed offer|Accepted the client)/
893           or $c =~ m/^(addh-unique|Referer forged to)/
894           or $c =~ m/^Downgraded answer to HTTP\/1.0/
895           or $c =~ m/^Parameter: \+hide-referrer\{[^\}]*\} is a bad idea, but I don\'t care./
896           or $c =~ m/^Referer (?:overwritten|replaced) with: Referer: / #XXX: should this be highlighted?
897           or $c =~ m/^Referer crunched!/
898           or $c =~ m/^crunched x-forwarded-for!/
899           or $c =~ m/^crunched From!/
900           or $c =~ m/^ modified$/
901           or $c =~ m/^Content filtering is enabled. Crunching:/
902           or $c =~ m/^force-text-mode overruled the client/
903           or $c =~ m/^Server time in the future\./
904           or $c =~ m/^content-disposition header crunched and replaced with:/i
905           or $c =~ m/^Reducing white space in /
906           or $c =~ m/^Ignoring single quote in /
907           or $c =~ m/^Converting tab to space in /
908           or $c =~ m/A HTTP\/1\.1 response without/
909           or $c =~ m/Disabled filter mode on behalf of the client/
910           or $c =~ m/Keeping the (?:server|client) header /
911           or $c =~ m/Content modified with no Content-Length header set/
912           or $c =~ m/^Appended client IP address to/
913           or $c =~ m/^Removing 'Connection: close' to imply keep-alive./
914           or $c =~ m/^keep-alive support is disabled/
915           or $c =~ m/^Continue hack in da house/
916           or $c =~ m/^Merged multiple header lines to:/
917           or $c =~ m/^Added header: /
918           or $c =~ m/^Enlisting (?:sorted|left-over) header/
919           or $c =~ m/^Multiple Content-Type headers detected. Removing and ignoring: Content-Type:/
920             )
921     {
922         # XXX: Some of these may need highlighting
923
924         # Modified: User-Agent: Mozilla/5.0 (X11; U; SunOS i86pc; pl-PL; rv:1.8.1.1) Gecko/20070214 Firefox/2.0.0.1
925         # Accept-Language header crunched and replaced with: Accept-Language: pl-pl
926         # cookie 'Set-Cookie: eZSessionCookie=07bfec287c197440d299f81580593c3d; \
927         #  expires=Thursday, 12-Apr-07 15:16:18 GMT; path=/' send by \
928         #  http://wirres.net/article/articleview/4265/1/6/ appears to be using time format 1 (XXX: gone with the wind)
929         # Cookie rewritten to a temporary one: Set-Cookie: NSC_gffe-iuuq-mc-wtfswfs=8efb33a53660;path=/
930         # Text mode is already enabled
931         # Denied request with NULL byte(s) turned into line break(s)
932         # Replaced: 'Connection: Yo, home to Bel Air' with 'Connection: close'
933         # addh-unique: Host: people.freebsd.org
934         # Suppressed offer to compress content
935         # Crunched incoming cookie -- yum!
936         # Accepted the client's request to fetch without filtering.
937         # Crunched outgoing cookie: Cookie: PREF=ID=6cf0abd347b30262:TM=1173357617:LM=1173357617:S=jZypyyJ7LPiwFi1_
938         # addh-unique: Host: subkeys.pgp.net:11371
939         # Referer forged to: Referer: http://10.0.0.1/
940         # Downgraded answer to HTTP/1.0
941         # Parameter: +hide-referrer{pille-palle} is a bad idea, but I don't care.
942         # Referer overwritten with: Referer: pille-palle
943         # Referer replaced with: Referer: pille-palle
944         # crunched x-forwarded-for!
945         # crunched From!
946         #  modified # XXX: pretty stupid log message
947         # Content filtering is enabled. Crunching: 'Range: 1234-5678' to prevent range-mismatch problems
948         # force-text-mode overruled the client's request to fetch without filtering!
949         # Server time in the future.
950         # content-disposition header crunched and replaced with: content-disposition: filename=baz
951         # Content-Disposition header crunched and replaced with: content-disposition: filename=baz
952         # Reducing white space in 'X-LWS-Test: "This  is  quoted" this is not "this  is  " but " this again   is  not'
953         # Ignoring single quote in 'X-LWS-Test: "This  is  quoted" this is not "this  is  " but "  this again   is  not'
954         # Converting tab to space in 'X-LWS-Test:   "This  is  quoted" this   is  not "this  is  "  but  "\
955         #  this again   is  not'
956         # A HTTP/1.1 response without Connection header implies keep-alive.
957         # Disabled filter mode on behalf of the client.
958         # Keeping the server header 'Connection: keep-alive' around.
959         # Keeping the client header 'Connection: close' around. The connection will not be kept alive.
960         # Keeping the client header 'Connection: keep-alive' around. The connection will be kept alive if possible.
961         # Content modified with no Content-Length header set. Creating a fake one for adjustment later on.
962         # Appended client IP address to X-Forwarded-For: 10.0.0.2, 10.0.0.1
963         # Removing 'Connection: close' to imply keep-alive.
964         # keep-alive support is disabled. Crunching: Keep-Alive: 300.
965         # Continue hack in da house.
966         # Merged multiple header lines to: 'X-FORWARDED-PROTO: http X-HOST: 127.0.0.1'
967         # Added header: Content-Encoding: deflate
968         # Enlisting sorted header User-Agent: Mozilla/5.0 (X11; SunOS i86pc; rv:10.0.3) Gecko/20100101 Firefox/10.0.3
969         # Enlisting left-over header Connection: close
970         # Multiple Content-Type headers detected. Removing and ignoring: Content-Type: text/html
971
972     } elsif ($c =~ m/^scanning headers for:/) {
973
974         return '' unless SHOW_SCAN_INTRO;
975
976     } elsif ($c =~ m/^[Cc]runch(ing|ed)|crumble crunched:/) {
977         # crunched User-Agent!
978         # Crunching: Content-Encoding: gzip
979
980         $c =~ s@(Crunching|crunched)@$h{$1}$1$h{'Standard'}@;
981
982     } elsif ($c =~ m/^Offending request data with NULL bytes turned into \'°\' characters:/) {
983
984         # Offending request data with NULL bytes turned into '°' characters: °°n°°(°°°
985
986         $c = h('warning') . $c . h('Standard');
987
988     } elsif ($c =~ m/^(Transforming \")(.*?)(\" to \")(.*?)(\")/) {
989
990         # Transforming "Proxy-Authenticate: Basic realm="Correos Proxy Server"" to\
991         #  "Proxy-Authenticate: Basic realm="Correos Proxy Server""
992
993        $c =~ s@(?<=^Transforming \")(.*)(?=\" to)@$h{'Header'}$1$h{'Standard'}@;
994        $c =~ s@(?<=to \")(.*)(?=\")@$h{'Header'}$1$h{'Standard'}@;
995
996     } elsif ($c =~ m/^Removing empty header/) {
997
998         # Removing empty header
999         # Ignore for now
1000
1001     } elsif ($c =~ m/^Content-Type: .* not replaced/) {
1002
1003         # Content-Type: application/octet-stream not replaced. It doesn't look like text.\
1004         #  Enable force-text-mode if you know what you're doing.
1005         # XXX: Could highlight more here.
1006         $c =~ s@(?<=^Content-Type: )(.*)(?= not replaced)@$h{'content-type'}$1$h{'Standard'}@;
1007
1008     } elsif ($c =~ m/^(Server|Client) keep-alive timeout is/) {
1009
1010        # Server keep-alive timeout is 5. Sticking with 10.
1011        # Client keep-alive timeout is 20. Sticking with 10.
1012
1013        $c =~ s@(?<=timeout is )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1014        $c =~ s@(?<=Sticking with )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1015
1016     } elsif ($c =~ m/^Reducing keep-alive timeout/) {
1017
1018        # Reducing keep-alive timeout from 60 to 10.
1019
1020        $c =~ s@(?<= from )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1021        $c =~ s@(?<= to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1022
1023     } elsif ($c =~ m/^Killed all-caps Host header line: HOST:/) {
1024
1025        # Killed all-caps Host header line: HOST: bestproxydb.com
1026        $c = highlight_matched_host($c, '(?<=HOST: )[^\s]+');
1027        $c = highlight_matched_pattern($c, 'HOST', 'HOST');
1028
1029     } else {
1030
1031         found_unknown_content($c);
1032     }
1033
1034     # Highlight headers
1035     unless ($c =~ m/^Transforming/) {
1036         $c = highlight_known_headers($c) unless $no_special_header_highlighting;
1037     }
1038
1039     return $c;
1040 }
1041
1042 sub handle_loglevel_re_filter ($) {
1043
1044     my $content = shift;
1045     my $c = $content;
1046     my $key;
1047
1048     if ($c =~ m/^(?:re_)?filtering ([^\s]+) \(size (\d+)\) with (?:filter )?\'?([^\s]+?)\'? produced (\d+) hits \(new size (\d+)\)/) {
1049
1050         # XXX: only the second version gets highlighted properly.
1051         # re_filtering www.lfk.de/favicon.ico (size 209) with filter untrackable-hulk produced 0 hits (new size 209).
1052         # filtering aci.blogg.de/ (size 37988) with 'blogg.de' produced 3 hits (new size 38057)
1053         $req{$t}{'content_source'} = $1;
1054         $req{$t}{'content_size'}   = $2;
1055         $req{$t}{'content_filter'} = $3;
1056         $req{$t}{'content_hits'}   = $4;
1057         $req{$t}{'new_content_size'} = $5;
1058         $req{$t}{'content_size_change'} = $req{$t}{'new_content_size'} - $req{$t}{'content_size'};
1059         #return '' if ($req{$t}{'content_hits'} == 0 && !cli_option_is_set('show-ineffective-filters'));
1060         if ($req{$t}{'content_hits'} == 0 and
1061             not (cli_option_is_set('show-ineffective-filters')
1062                  or ($req{$t}{'content_filter'} =~ m/^privoxy-filter-test$/))) {
1063                 return '';
1064         }
1065
1066         $c =~ s@(?<=\(size )(\d+)\)(?= with)@$h{'Number'}$1$h{'Standard'}@;
1067         $c =~ s@(?<=\(new size )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1068         $c =~ s@(?<=produced )(\d+)(?= hits)@$h{'Number'}$1$h{'Standard'}@;
1069
1070         $c =~ s@([^\s]+?)(\'? produced)@$h{'filter'}$1$h{'Standard'}$2@;
1071         $c = highlight_matched_host($c, '(?<=filtering )[^\s]+');
1072
1073         $c =~ s@\.$@ @;
1074         $c .= "(" . $h{'Number'};
1075         $c .= "+" if ($req{$t}{'content_size_change'} >= 0);
1076         $c .= $req{$t}{'content_size_change'} . $h{'Standard'} . ")";
1077         $content = $c;
1078
1079   } elsif ($c =~ /\.{3}$/
1080         and $c =~ m/^(?:re_)?filtering \'?(.*?)\'? \(size (\d*)\) with (?:filter )?\'?([^\s]*?)\'? ?\.{3}$/) {
1081
1082         # Used by Privoxy 3.0.5 and 3.0.6:
1083         # XXX: Fill in ...
1084         # Used by Privoxy 3.0.7:
1085         # filtering 'Connection: close' (size 17) with 'generic-content-ads' ...
1086
1087         $req{$t}{'filtered_header'} = $1;
1088         $req{$t}{'old_header_size'} = $2;
1089         $req{$t}{'header_filter_name'} = $3;
1090
1091         unless (cli_option_is_set('show-ineffective-filters') or
1092                 $req{$t}{'header_filter_name'} =~ m/^privoxy-filter-test$/) {
1093             return '';
1094         }
1095         $content =~ s@(?<=\(size )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1096         $content =~ s@($req{$t}{'header_filter_name'})@$h{'filter'}$1$h{'Standard'}@;
1097
1098     } elsif ($c =~ m/^ ?\.\.\. ?produced (\d*) hits \(new size (\d*)\)\./) {
1099
1100         # ...produced 0 hits (new size 23).
1101         #... produced 1 hits (new size 54).
1102
1103         $req{$t}{'header_filter_hits'} = $1;
1104         $req{$t}{'new_header_size'} = $2;
1105
1106         unless (cli_option_is_set('show-ineffective-filters') or
1107                 (defined($req{$t}{'header_filter_name'}) and
1108                  $req{$t}{'header_filter_name'} =~ m/^privoxy-filter-test$/)) {
1109
1110             if ($req{$t}{'header_filter_hits'} == 0 and
1111                 not (defined($req{$t}{'header_filter_name'}) and
1112                  $req{$t}{'header_filter_name'} =~ m/^privoxy-filter-test$/)) {
1113                 return '';
1114             }
1115             # Reformat including information from the intro
1116             $c = "'" . h('filter') . $req{$t}{'header_filter_name'} . h('Standard') . "'";
1117             $c .= " hit ";
1118             # XXX: Hide behind constant, it may be interesting if LOG_LEVEL_HEADER isn't enabled as well.
1119             # $c .= $req{$t}{'filtered_header'} . " ";
1120             $c .= h('Number') . $req{$t}{'header_filter_hits'}. h('Standard');
1121             $c .= ($req{$t}{'header_filter_hits'} == 1) ? " time, " : " times, ";
1122
1123             if ($req{$t}{'old_header_size'} !=  $req{$t}{'new_header_size'}) {
1124
1125                 $c .= "changing size from ";
1126                 $c .=  h('Number') . $req{$t}{'old_header_size'} . h('Standard');
1127                 $c .= " to ";
1128                 $c .= h('Number') . $req{$t}{'new_header_size'} . h('Standard');
1129                 $c .= ".";
1130
1131             } else {
1132
1133                 $c .= "keeping the size at " . $req{$t}{'old_header_size'};
1134
1135             }
1136
1137             # Highlight from last line (XXX: What?)
1138             # $c =~ s@(?<=produced )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1139             # $c =~ s@($req{$t}{'header_filter_name'})@$h{'filter'}$1$h{'Standard'}@;
1140
1141         } else {
1142
1143            # XXX: Untested
1144            $c =~ s@(?<=produced )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1145            $c =~ s@(?<=new size )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1146
1147         }
1148         $content = $c;
1149
1150     } elsif ($c =~ m/^(Tagger|Filter) ([^\s]*) has empty joblist. Nothing to do./) {
1151
1152         # Filter privoxy-filter-test has empty joblist. Nothing to do.
1153         # Tagger variable-test has empty joblist. Nothing to do.
1154
1155         $content =~ s@(?<=$1 )([^\s]*)@$h{'filter'}$1$h{'Standard'}@;
1156
1157     } elsif ($c =~ m/^De-chunking successful. Shrunk from (\d+) to (\d+)/) {
1158
1159         $req{$t}{'chunked-size'} = $1;
1160         $req{$t}{'dechunked-size'} = $2;
1161         $req{$t}{'dechunk-change'} = $req{$t}{'dechunked-size'} - $req{$t}{'chunked-size'};
1162
1163         $content .= " (" . h('Number') . $req{$t}{'dechunk-change'} . h('Standard') . ")";
1164
1165         $content =~ s@(?<=from )($req{$t}{'chunked-size'})@$h{'Number'}$1$h{'Standard'}@;
1166         $content =~ s@(?<=to )($req{$t}{'dechunked-size'})@$h{'Number'}$1$h{'Standard'}@;
1167
1168     } elsif ($c =~ m/^Decompression successful. Old size: (\d+), new size: (\d+)./) {
1169
1170         # Decompression successful. Old size: 670, new size: 1166.
1171
1172         $req{$t}{'size-compressed'} = $1;
1173         $req{$t}{'size-decompressed'} = $2;
1174         $req{$t}{'decompression-gain'} = $req{$t}{'size-decompressed'} - $req{$t}{'size-compressed'};
1175
1176         $content =~ s@(?<=Old size: )($req{$t}{'size-compressed'})@$h{'Number'}$1$h{'Standard'}@;
1177         $content =~ s@(?<=new size: )($req{$t}{'size-decompressed'})@$h{'Number'}$1$h{'Standard'}@;
1178
1179         # XXX: Create sub get_percentage()
1180         if ($req{$t}{'size-decompressed'}) {
1181             $req{$t}{'decompression-gain-percent'} =
1182                 $req{$t}{'decompression-gain'} / $req{$t}{'size-decompressed'} * 100;
1183
1184             $content .= " (saved: ";
1185             #$content .= h('Number') . $req{$t}{'decompression-gain'} . h('Standard');
1186             #$content .= "/";
1187             $content .= h('Number') . sprintf("%.2f%%", $req{$t}{'decompression-gain-percent'}) . h('Standard');
1188             $content .= ")";
1189         }
1190
1191     } elsif ($c =~ m/^(Need to de-chunk first)/) {
1192
1193         # Need to de-chunk first
1194         return '' if SUPPRESS_NEED_TO_DE_CHUNK_FIRST;
1195
1196     } elsif ($c =~ m/^(Adding (?:dynamic )?re_filter job)/) {
1197
1198         return ''  if (SUPPRESS_SUCCEEDED_FILTER_ADDITIONS && m/succeeded/);
1199
1200         # Adding re_filter job ...
1201         # Adding dynamic re_filter job s@^(?:\w*)\s+.*\s+HTTP/\d\.\d\s*@IP-ADDRESS: $origin@D\
1202         #  to filter client-ip-address succeeded.
1203
1204     } elsif ($c =~ m/^Compressed content from /) {
1205
1206         # Compressed content from 29258 to 8630 bytes. Compression level: 3
1207         $content =~ s@(?<=from )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1208         $content =~ s@(?<=to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1209         $content =~ s@(?<=level: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1210
1211     } elsif ($c =~ m/^Reading in filter/) {
1212
1213         return '' unless SHOW_FILTER_READIN_IN;
1214
1215     } else {
1216
1217         found_unknown_content($content);
1218
1219     }
1220
1221     return $content;
1222 }
1223
1224 sub handle_loglevel_redirect ($) {
1225
1226     my $c = shift;
1227
1228     if ($c =~ m/^Decoding "([^""]*)"/) {
1229
1230          $req{$t}{'original-destination'} = $1;
1231          $c = highlight_matched_path($c, '(?<=Decoding ")[^"]*');
1232          $c =~ s@\"@@g;
1233
1234     } elsif ($c =~ m/^Checking/) {
1235
1236          # Checking /_ylt=A0geu.Z76BRGR9k/**http://search.yahoo.com/search?p=view+odb+presentation+on+freebsd\
1237          #  &ei=UTF-8&xargs=0&pstart=1&fr=moz2&b=11 for redirects.
1238
1239          # TODO: Change colour if really url-decoded
1240          $req{$t}{'decoded-original-destination'} = $1;
1241          $c = highlight_matched_path($c, '(?<=Checking ")[^"]*');
1242          $c =~ s@\"@@g;
1243
1244     } elsif ($c =~ m/^pcrs command "([^""]*)" changed /) {
1245
1246         # pcrs command "s@&from=rss@@" changed \
1247         #  "http://it.slashdot.org/article.pl?sid=07/03/02/1657247&from=rss"\
1248         #  to "http://it.slashdot.org/article.pl?sid=07/03/02/1657247" (1 hit).
1249         $c =~ s@(?<=pcrs command )"([^""]*)"@$h{'filter'}$1$h{'Standard'}@;
1250         $c = highlight_matched_url($c, '(?<=changed ")[^""]*');
1251         $c =~ s@(?<=changed )"([^""]*)"@$1@; # Remove quotes
1252         $c = highlight_matched_url($c, '(?<=to ")[^""]*');
1253         $c =~ s@(?<=to )"([^""]*)"@$1@; # Remove quotes
1254         $c =~ s@(\d+)(?= hits?)@$h{'hits'}$1$h{'Standard'}@;
1255
1256     } elsif ($c =~ m/^pcrs command "([^""]*)" didn\'t change/) {
1257
1258         # pcrs command "s@^http://([^.]+?)/?$@http://www.bing.com/search?q=$1@" didn't \
1259         #  change "http://www.example.org/".
1260         $c =~ s@(?<=pcrs command )"([^""]*)"@$h{'filter'}$1$h{'Standard'}@;
1261         $c = highlight_matched_url($c, '(?<=change ")[^""]*');
1262
1263     } elsif ($c =~ m/(^New URL is: )(.*)/) {
1264
1265         # New URL is: http://it.slashdot.org/article.pl?sid=07/03/04/1511210
1266         # XXX: Use URL highlighter
1267         # XXX: Save?
1268         $c = $1 . h('rewritten-URL') . $2 . h('Standard');
1269
1270     } elsif ($c =~ m/No pcrs command recognized, assuming that/) {
1271         # No pcrs command recognized, assuming that "http://config.privoxy.org/user-manual/favicon.png"\
1272         #  is already properly formatted.
1273         # XXX: assume the same?
1274         $c = highlight_matched_url($c, '(?<=assuming that \")[^"]*');
1275
1276     } elsif ($c =~ m/^Percent-encoding redirect/) {
1277
1278         # Percent-encoding redirect URL: http://www.example.org/\x02
1279         $c = highlight_matched_url($c, '(?<=redirect URL: ).*');
1280
1281     } else {
1282
1283         found_unknown_content($c);
1284
1285     }
1286
1287     return $c;
1288 }
1289
1290 sub handle_loglevel_gif_deanimate ($) {
1291
1292     my $content = shift;
1293
1294     if ($content =~ m/Success! GIF shrunk from (\d+) bytes to (\d+)\./) {
1295
1296         my $bytes_from = $1;
1297         my $bytes_to = $2;
1298         # Gif-Deanimate: Success! GIF shrunk from 205 bytes to 133.
1299         $content =~ s@$bytes_from@$h{'Number'}$bytes_from$h{'Standard'}@;
1300         # XXX: Do we need g in case of ($1 == $2)?
1301         $content =~ s@$bytes_to@$h{'Number'}$bytes_to$h{'Standard'}@;
1302
1303     } elsif ($content =~ m/GIF (not) changed/) {
1304
1305         # Gif-Deanimate: GIF not changed.
1306         return '' if SUPPRESS_GIF_NOT_CHANGED;
1307         $content =~ s@($1)@$h{'not'}$1$h{'Standard'}@;
1308
1309     } elsif ($content =~ m/^failed! \(gif parsing\)/) {
1310
1311         # failed! (gif parsing)
1312         # XXX: Replace this error message with something less stupid
1313         $content =~ s@(failed!)@$h{'error'}$1$h{'Standard'}@;
1314
1315     } elsif ($content =~ m/^Need to de-chunk first/) {
1316
1317         # Need to de-chunk first
1318         return '' if SUPPRESS_NEED_TO_DE_CHUNK_FIRST;
1319
1320     } elsif ($content =~ m/^(?:No GIF header found|failed while parsing)/) {
1321
1322         # No GIF header found (XXX: Did I ever commit this?)
1323         # failed while parsing 195 134747048 (XXX: never committed)
1324
1325         # Ignore these for now
1326
1327     } else {
1328
1329         found_unknown_content($content);
1330
1331     }
1332
1333     return $content;
1334 }
1335
1336 sub handle_loglevel_request ($) {
1337
1338     my $content = shift;
1339
1340     if ($content =~ m/crunch! /) {
1341
1342         # config.privoxy.org/send-stylesheet crunch! (CGI Call)
1343
1344         # Highlight crunch reasons
1345         foreach my $reason (keys %reason_colours) {
1346             $content =~ s@\(($reason)\)@$reason_colours{$reason}($1)$h{'Standard'}@g;
1347         }
1348         # Highlight request URL domain and ditch 'crunch!'
1349         $content = highlight_matched_pattern($content, 'request_', '[^ ]*(?= crunch!)');
1350         $content =~ s@ crunch!@@;
1351
1352     } elsif ($content =~ m/\[too long, truncated\]$/) {
1353
1354         # config.privoxy.org/edit-actions-submit?f=3&v=1176116716&s=7&Submit=Submit[...]&filter... [too long, truncated]
1355         $content = highlight_matched_pattern($content, 'request_', '^.*(?=\.\.\. \[too long, truncated\]$)');
1356
1357     } elsif ($content =~ m/(.*)/) { # XXX: Pretty stupid
1358
1359         # trac.vidalia-project.net/wiki/Volunteer?format=txt
1360         $content = h('request_') . $content . h('Standard');
1361
1362     } else {  # XXX: Nop
1363
1364         found_unknown_content($content);
1365
1366     }
1367
1368     return $content;
1369 }
1370
1371 sub handle_loglevel_crunch ($) {
1372
1373     my $content = shift;
1374
1375     # Highlight crunch reason
1376     foreach my $reason (keys %reason_colours) {
1377         $content =~ s@($reason)@$reason_colours{$reason}$1$h{'Standard'}@g;
1378     }
1379
1380     if ($content =~ m/\[too long, truncated\]$/) {
1381
1382         # Blocked: config.privoxy.org/edit-actions-submit?f=3&v=1176116716&s=7&Submit=Submit\
1383         #  [...]&filter... [too long, truncated]
1384         $content = highlight_matched_pattern($content, 'request_', '^.*(?=\.\.\. \[too long, truncated\]$)');
1385
1386     } else {
1387
1388         # Blocked: http://ads.example.org/
1389         $content = highlight_matched_pattern($content, 'request_', '(?<=: ).*');
1390     }
1391
1392     return $content;
1393 }
1394
1395 sub handle_loglevel_connect ($) {
1396
1397     my $c = shift;
1398
1399     if ($c =~ m/^via [^\s]+ to: [^\s]+/) {
1400
1401         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
1402
1403         $c = highlight_matched_host($c, '(?<=via )[^\s]+');
1404         $c = highlight_matched_host($c, '(?<=to: )[^\s]+');
1405
1406     } elsif ($c =~ m/^connect to: .* failed: .*/) {
1407
1408         # connect to: www.example.org.noconnect failed: Operation not permitted
1409
1410         $c = highlight_matched_host($c, '(?<=connect to: )[^\s]+');
1411
1412         $c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1413
1414     } elsif ($c =~ m/^to ([^\s]*)( successful)?$/) {
1415
1416         # Connect: to www.nzherald.co.nz successful
1417         # Connect: to archiv.radiotux.de
1418
1419         return '' if SUPPRESS_SUCCESSFUL_CONNECTIONS;
1420         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1421
1422     } elsif ($c =~ m/^to ([^\s]*)$/) {
1423
1424         # Connect: to lists.sourceforge.net:443
1425
1426         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1427
1428     } elsif ($c =~ m/^[Aa]ccepted connection from .*/ or
1429              $c =~ m/^OK/) {
1430
1431         # Privoxy 3.0.20:
1432         # Accepted connection from 10.0.0.1 on socket 5
1433         # Privoxy between 3.0.20 and 3.0.6:
1434         # accepted connection from 10.0.0.1( on socket 5)?
1435         # Privoxy 3.0.6 and earlier just say:
1436         # OK
1437         $c = highlight_matched_host($c, '(?<=connection from )[^ ]*');
1438         $c = highlight_matched_pattern($c, 'Number', '(?<=socket )\d+');
1439
1440     } elsif ($c =~ m/^Closing client socket/) {
1441
1442         # Closing client socket 5. Keep-alive: 0, Socket alive: 1. Data available: 0.
1443         # Privoxy 3.0.20 and later
1444         # Closing client socket 8. Keep-alive: 1. Socket alive: 0. Data available: 0. \
1445         #  Configuration file change detected: 0. Requests received: 11.
1446
1447         $c = highlight_matched_pattern($c, 'Number', '(?<=socket )\d+');
1448         $c = highlight_matched_pattern($c, 'Number', '(?<=Keep-alive: )\d+');
1449         $c = highlight_matched_pattern($c, 'Number', '(?<=Socket alive: )\d+');
1450         $c = highlight_matched_pattern($c, 'Number', '(?<=available: )\d+');
1451         $c = highlight_matched_pattern($c, 'Number', '(?<=detected: )\d+');
1452         $c = highlight_matched_pattern($c, 'Number', '(?<=received: )\d+');
1453
1454     } elsif ($c =~ m/^write header to: .* failed:/) {
1455
1456         # write header to: 10.0.0.1 failed: Broken pipe
1457
1458         $c = highlight_matched_host($c, '(?<=write header to: )[^\s]*');
1459         $c =~ s@(?<=failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1460
1461     } elsif ($c =~ m/^write header to client failed:/) {
1462
1463         # write header to client failed: Broken pipe
1464         # XXX: Stil in use?
1465         $c =~ s@(?<=failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1466
1467     } elsif ($c =~ m/^socks4_connect:/) {
1468
1469         # socks4_connect: SOCKS request rejected or failed.
1470         $c =~ s@(?<=socks4_connect: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1471
1472     } elsif ($c =~ m/^Listening for new connections/ or
1473              $c =~ m/^accept connection/) {
1474         # XXX: Highlight?
1475         # Privoxy versions above 3.0.6 say:
1476         # Listening for new connections ...
1477         # earlier versions say:
1478         # accept connection ...
1479         return '';
1480
1481     } elsif ($c =~ m/^accept failed:/) {
1482
1483         $c =~ s@(?<=accept failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1484
1485     } elsif ($c =~ m/^Overriding forwarding settings/) {
1486
1487         # Overriding forwarding settings based on 'forward 10.0.0.1:8123'
1488         $c =~ s@(?<=based on \')(.*)(?=\')@$h{'configuration-line'}$1$h{'Standard'}@;
1489
1490     } elsif ($c =~ m/^Denying suspicious CONNECT request from/) {
1491
1492         # Denying suspicious CONNECT request from 10.0.0.1
1493         $c = highlight_matched_host($c, '(?<=from )[^\s]+'); # XXX: not an URL
1494
1495     } elsif ($c =~ m/^socks5_connect:/) {
1496
1497         $c =~ s@(?<=socks5_connect: )(.*)@$h{'error'}$1$h{'Standard'}@;
1498
1499     } elsif ($c =~ m/^Created new connection to/) {
1500
1501         # Created new connection to www.privoxy.org:80 on socket 11.
1502         $c = highlight_matched_host($c, '(?<=connection to )[^\s]+');
1503         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1504
1505     } elsif ($c =~ m/^Found reusable socket/) {
1506
1507         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
1508         # 3.0.15 and later:
1509         # Found reusable socket 8 for www.privoxy.org:80 in slot 2.\
1510         #  Timestamp made 0 seconds ago. Timeout: 1. Latency: 0.
1511         $c =~ s@(?<=Found reusable socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1512         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1513         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1514         $c =~ s@(?<=made )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1515         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1516         $c =~ s@(?<=Latency: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1517
1518     } elsif ($c =~ m/^Marking open socket/) {
1519
1520         # Marking open socket 9 for www.privoxy.org:80 in slot 0 as unused.
1521         $c =~ s@(?<=Marking open socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1522         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1523         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1524
1525     } elsif ($c =~ m/^No reusable/) {
1526
1527         # No reusable socket for addons.mozilla.org:443 found. Opening a new one.
1528         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1529
1530     } elsif ($c =~ m/^(Remembering|Forgetting) socket/) {
1531
1532         # Remembering socket 13 for www.privoxy.org:80 in slot 0.
1533         # Forgetting socket 38 for www.privoxy.org:80 in slot 5.
1534
1535         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1536         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1537         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1538
1539     } elsif ($c =~ m/^Socket/) {
1540
1541         # Socket 16 already forgotten or never remembered.
1542         $c =~ s@(?<=Socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1543
1544     } elsif ($c =~ m/^The connection to/) {
1545
1546         # The connection to www.privoxy.org:80 in slot 6 timed out. Closing socket 19. Timeout is: 61.
1547         # 3.0.15 and later:
1548         # The connection to 1.bp.blogspot.com:80 in slot 0 timed out. Closing socket 5.\
1549         #  Timeout is: 1. Assumed latency: 4.
1550         # The connection to 10.0.0.1:80 in slot 0 is no longer usable. Closing socket 4.
1551         $c = highlight_matched_host($c, '(?<=connection to )[^\s]+');
1552         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1553         $c =~ s@(?<=Closing socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1554         $c =~ s@(?<=Timeout is: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1555         $c =~ s@(?<=Assumed latency: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1556
1557     } elsif ($c =~ m/^Stopped waiting for the request line/ or
1558              $c =~ m/^No request line on socket \d received in time/ or
1559              $c =~ m/^The client side of the connection on socket \d/) {
1560
1561         # Stopped waiting for the request line. Timeout: 121.
1562         # Privoxy 3.0.19 and later:
1563         # No request line on socket 5 received in time. Timeout: 1.
1564         # The client side of the connection on socket 5 got closed \
1565         #  without sending a complete request line.
1566         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1567         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1568
1569     } elsif ($c =~ m/^Waiting for \d/) {
1570
1571         # Waiting for 1 connections to timeout.
1572         $c =~ s@(?<=^Waiting for )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1573
1574     } elsif ($c =~ m/^Initialized/) {
1575
1576         # Initialized 20 socket slots.
1577         $c =~ s@(?<=Initialized )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1578
1579     } elsif ($c =~ m/^Done reading from server/) {
1580
1581         # Done reading from server. Expected content length: 24892. \
1582         #  Actual content length: 24892. Most recently received: 4412.
1583         # 3.0.15 and later:
1584         # Done reading from server. Expected content length: 24892. \
1585         #  Actual content length: 24892. Bytes most recently read: 4412.
1586         # Done reading from server. Content length: 6018 as expected. \
1587         #  Bytes most recently read: 294.
1588         $c =~ s@(?<=ontent length: )(\d+)@$h{'Number'}$1$h{'Standard'}@g;
1589         $c =~ s@(?<=received: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1590         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1591
1592     } elsif ($c =~ m/^Continuing buffering (?:server )?headers/) {
1593
1594         # Continuing buffering headers. byte_count: 19. header_offset: 517. len: 536.
1595         $c =~ s@(?<=byte_count: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1596         $c =~ s@(?<=header_offset: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1597         $c =~ s@(?<=len: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1598         # 3.0.15 up to 3.0.19:
1599         # Continuing buffering headers. Bytes most recently read: 498.
1600         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1601         # 3.0.20 and later:
1602         # Continuing buffering server headers from socket 5. Bytes most recently read: 498.
1603         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1604
1605     } elsif ($c =~ m/^Received \d+ bytes while/) {
1606
1607         # Received 206 bytes while expecting 12103.
1608         $c =~ s@(?<=Received )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1609         $c =~ s@(?<=expecting )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1610
1611     } elsif ($c =~ m/^(Rejecting c|C)onnection from/) {
1612
1613         # Connection from 81.163.28.218 dropped due to ACL
1614         # Rejecting connection from 178.63.152.227. Maximum number of connections reached.
1615         $c =~ s@(?<=onnection from )((?:\d+\.?){3}\d+)@$h{'Number'}$1$h{'Standard'}@;
1616
1617     } elsif ($c =~ m/^(?:Reusing|Closing) server socket / or
1618              $c =~ m/^No additional client request/) {
1619
1620         # Reusing server socket 4. Opened for 10.0.0.1.
1621         # Closing server socket 2. Opened for 10.0.0.1.
1622         # No additional client request received in time. \
1623         #  Closing server socket 4, initially opened for 10.0.0.1.
1624         # No additional client request received in time on socket 29.
1625         # Privoxy 3.0.20 and later
1626         # Reusing server socket 7 connected to www.privoxy.org. Total requests: 2.
1627         # Closing server socket 6 connected to d.asset.soup.io. Keep-alive: 0.\
1628         #  Tainted: 1. Socket alive: 1. Timeout: 60. Configuration file change detected: 0.
1629
1630         $c =~ s@(?<= socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1631         $c = highlight_matched_host($c, '(?<=for )[^\s]+(?=\.)');
1632         $c = highlight_matched_host($c, '(?<=connected to )[^\s]+(?=\.)');
1633         for my $number_pattern ('requests', 'Keep-alive', 'Tainted', ' alive', 'Timeout', 'detected') {
1634             $c = highlight_matched_pattern($c, 'Number', '(?<='. $number_pattern . ': )\d+');
1635         }
1636
1637     } elsif ($c =~ m/^Connected to /) {
1638
1639         # Connected to tor-jail[10.0.0.2]:9050.
1640
1641         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1642         $c = highlight_matched_host($c, '(?<=Connected to )[^\[\s]+');
1643         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1644
1645     } elsif ($c =~ m/^Could not connect to /) {
1646
1647         # Could not connect to [10.0.0.1]:80.
1648
1649         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1650         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1651
1652     } elsif ($c =~ m/^Waiting for the next client request/ or
1653              $c =~ m/^The connection on server socket/ or
1654              $c =~ m/^Client request (?:\d+ )?(?:arrived in time|has been pipelined) /) {
1655
1656         # Waiting for the next client request on socket 3. Keeping the server \
1657         #  socket 12 to a.fsdn.com open.
1658         # The connection on server socket 6 to upload.wikimedia.org isn't reusable. Closing.
1659         # Privoxy 3.0.20 and later:
1660         # Client request 4 arrived in time on socket 7.
1661         # Used by Privoxy 3.0.18 and 3.0.19:
1662         # Client request arrived in time on socket 21.
1663         # Used by earlier version:
1664         # Client request arrived in time or the client closed the connection on socket 12.
1665         # Client request 8 has been pipelined on socket 7 and the socket is still alive.
1666
1667         $c =~ s@(?<=request )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1668         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1669         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1670         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1671
1672     } elsif ($c =~ m/^Marking the server socket/) {
1673
1674         # Marking the server socket 7 tainted.
1675
1676         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1677
1678     } elsif ($c =~ m/^Reduced expected bytes to /) {
1679
1680         # Reduced expected bytes to 0 to account for the 1542 ones we already got.
1681         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1682         $c =~ s@(?<=for the )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1683
1684     } elsif ($c =~ m/^The client closed socket /) {
1685
1686         # The client closed socket 2 while the server socket 4 is still open.
1687         $c =~ s@(?<=closed socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1688         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1689
1690     } elsif ($c =~ m/^Expected client content length set /) {
1691
1692         # Expected client content length set to 667325411 after reading 4999 bytes.
1693         $c =~ s@(?<=set to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1694         $c =~ s@(?<=reading )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1695
1696     } elsif ($c =~ m/^Reducing expected bytes to /) {
1697
1698         # Reducing expected bytes to 0. Marking the server socket tainted after throwing 4 bytes away.
1699         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1700         $c =~ s@(?<=after throwing )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1701
1702     } elsif ($c =~ m/^Waiting for up to /) {
1703
1704         # Waiting for up to 4999 bytes from the client.
1705         $c =~ s@(?<=up to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1706
1707     } elsif ($c =~ m/^Optimistically sending /) {
1708
1709         # Optimistically sending 318 bytes of client headers intended for www.privoxy.org
1710         $c =~ s@(?<=sending )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1711         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1712
1713     } elsif ($c =~ m/^Stopping to watch the client socket/) {
1714
1715         # Stopping to watch the client socket. There's already another request waiting.
1716         # Privoxy 3.0.20 and later:
1717         # Stopping to watch the client socket 5. There's already another request waiting.
1718         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1719
1720     } elsif ($c =~ m/^Drained \d+ bytes before closing/) {
1721
1722         # Drained 180 bytes before closing socket 6
1723         $c =~ s@(?<=Drained )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1724         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1725
1726     } elsif ($c =~ m/^Tainting client socket/ or
1727              $c =~ m/^Failed to shutdown socket/) {
1728
1729         # Tainting client socket 7 due to unread data.
1730         # Failed to shutdown socket 11: Connection reset by peer
1731
1732         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1733
1734     } elsif ($c =~ m/^Shifting \d+ pipelined bytes/) {
1735
1736         # Shifting 360 pipelined bytes by 360 bytes
1737         $c =~ s@(?<=Shifting )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1738         $c =~ s@(?<=by )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1739
1740     } elsif ($c =~ m/^Looks like we / or
1741              $c =~ m/^Unsetting keep-alive flag/ or
1742              $c =~ m/^No connections to wait/ or
1743              $c =~ m/^Complete client request received/ or
1744              $c =~ m/^Possible pipeline attempt detected./ or
1745              $c =~ m/^POST request detected. The connection will not be kept alive./ or
1746              $c =~ m/^The server still wants to talk, but the client hung up on us./ or
1747              $c =~ m/^The server didn't specify how long the connection will stay open/ or
1748              $c =~ m/^There might be a request body. The connection will not be kept alive/ or
1749              $c =~ m/^There better be a request body./ or
1750              $c =~ m/^Done reading from the client\.$/) {
1751
1752         # Looks like we reached the end of the last chunk. We better stop reading.
1753         # Looks like we read the end of the last chunk together with the server \
1754         #  headers. We better stop reading.
1755         # Looks like we got the last chunk together with the server headers. \
1756         #  We better stop reading.
1757         # Unsetting keep-alive flag.
1758         # No connections to wait for left.
1759         # Client request arrived in time or the client closed the connection.
1760         # Complete client request received
1761         # Possible pipeline attempt detected. The connection will not be \
1762         #  kept alive and we will only serve the first request.
1763         # POST request detected. The connection will not be kept alive.
1764         # The server still wants to talk, but the client hung up on us.
1765         # The server didn't specify how long the connection will stay open. Assume it's only a second.
1766         # There might be a request body. The connection will not be kept alive.
1767         # Privoxy 3.0.20 and later
1768         # There better be a request body.
1769         # Done reading from the client.
1770
1771     } else {
1772
1773         found_unknown_content($c);
1774
1775     }
1776
1777     return $c;
1778 }
1779
1780
1781 sub handle_loglevel_info ($) {
1782
1783     my $c = shift;
1784
1785     if ($c =~ m/^Rewrite detected:/) {
1786
1787         # Rewrite detected: GET http://10.0.0.2:88/blah.txt HTTP/1.1
1788         $c = highlight_matched_request_line($c, '(?<=^Rewrite detected: ).*');
1789
1790     } elsif ($c =~ m/^Decompress(ing deflated|ion didn)/ or
1791              $c =~ m/^Compressed content detected/ or
1792              $c =~ m/^SDCH-compressed content detected/ or
1793              $c =~ m/^Tagger/
1794             ) {
1795         # Decompressing deflated iob: 117
1796         # Decompression didn't result in any content.
1797         # Compressed content detected, content filtering disabled. Consider recompiling Privoxy\
1798         #  with zlib support or enable the prevent-compression action.
1799         # SDCH-compressed content detected, content filtering disabled.\
1800         #  Consider suppressing SDCH offers made by the client.
1801         # Tagger 'complete-url' created empty tag. Ignored.
1802
1803         # Ignored for now
1804
1805     } elsif ($c =~ m/^(Re)?loading configuration file /) {
1806
1807         # loading configuration file '/usr/local/etc/privoxy/config':
1808         # Reloading configuration file '/usr/local/etc/privoxy/config'
1809         $c =~ s@(?<=loading configuration file \')([^\']*)@$h{'file'}$1$h{'Standard'}@;
1810
1811     } elsif ($c =~ m/^Loading (actions|filter|trust) file: /) {
1812
1813         # Loading actions file: /usr/local/etc/privoxy/default.action
1814         # Loading filter file: /usr/local/etc/privoxy/default.filter
1815         # Loading trust file: /usr/local/etc/privoxy/trust
1816
1817         $c =~ s@(?<= file: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1818
1819     } elsif ($c =~ m/^exiting by signal/) {
1820
1821         # exiting by signal 15 .. bye
1822         $c =~ s@(?<=exiting by signal )(\d+)@$h{'signal'}$1$h{'Standard'}@;
1823
1824     } elsif ($c =~ m/^Privoxy version/) {
1825
1826         # Privoxy version 3.0.7
1827         $c =~ s@(?<=^Privoxy version )(\d+\.\d+\.\d+)$@$h{'version'}$1$h{'Standard'}@;
1828
1829     } elsif ($c =~ m/^Program name: /) {
1830
1831         # Program name: /usr/local/sbin/privoxy
1832         $c =~ s@(?<=Program name: )(.*)@$h{'program-name'}$1$h{'Standard'}@;
1833
1834     } elsif ($c =~ m/^Listening on port /) {
1835
1836         # Listening on port 8118 on IP address 10.0.0.1
1837         $c =~ s@(?<=Listening on port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1838         $c =~ s@(?<=on IP address )(.*)@$h{'ip-address'}$1$h{'Standard'}@;
1839
1840     } elsif ($c =~ m/^\(Re-\)Open(?:ing)? logfile/) {
1841
1842         # (Re-)Open logfile /var/log/privoxy/privoxy.log
1843         $c =~ s@(?<=Open logfile )(.*)@$h{'file'}$1$h{'Standard'}@;
1844
1845     } elsif ($c =~ m/^(Request from|Malformed server response detected)/) {
1846
1847         # Request from 10.0.0.1 denied. limit-connect{,} doesn't allow CONNECT requests to port 443.
1848         # Request from 10.0.0.1 marked for blocking. limit-connect{,} doesn't allow CONNECT requests to port 443.
1849         # 3.0.18 and later:
1850         # Request from 10.0.0.1 marked for blocking. limit-connect{0} doesn't allow CONNECT requests to www.example.org:443
1851         # Malformed server response detected. Downgrading to HTTP/1.0 impossible.
1852
1853         $c =~ s@(?<=Request from )([^\s]*)@$h{'ip-address'}$1$h{'Standard'}@;
1854         $c =~ s@(denied|blocking)@$h{'warning'}$1$h{'Standard'}@;
1855         $c =~ s@(CONNECT)@$h{'method'}$1$h{'Standard'}@;
1856         $c =~ s@(?<=to port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1857         $c =~ s@(?<=to )([^\s]+)@$h{'request_'}$1$h{'Standard'}@;
1858
1859     } elsif ($c =~ m/^Status code/) {
1860
1861         # Status code 304 implies no body.
1862         $c =~ s@(?<=Status code )(\d+)@$h{'status-code'}$1$h{'Standard'}@;
1863
1864     } elsif ($c =~ m/^Method/) {
1865
1866         # Method HEAD implies no body.
1867         $c =~ s@(?<=Method )([^\s]+)@$h{'method'}$1$h{'Standard'}@;
1868
1869     } elsif ($c =~ m/^Buffer limit reached while extending /) {
1870
1871         # Buffer limit reached while extending the buffer (iob). Needed: 4197470. Limit: 4194304
1872         $c =~ s@(?<=Needed: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1873         $c =~ s@(?<=Limit: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1874
1875     } elsif ($c =~ m/^File modification detected: /) {
1876
1877         # File modification detected: /usr/local/etc/privoxy/user-agent.action
1878         $c =~ s@(?<= detected: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1879
1880     } elsif ($c =~ m/^No logfile configured/ or
1881              $c =~ m/^Malformerd HTTP headers detected and MS IIS5 hack enabled/ or
1882              $c =~ m/^Invalid \"chunked\" transfer/ or
1883              $c =~ m/^Support for/ or
1884              $c =~ m/^Flushing header and buffers/ or
1885              $c =~ m/^Can not resolve/
1886              ) {
1887
1888         # No logfile configured. Please enable it before reporting any problems.
1889         # Malformerd HTTP headers detected and MS IIS5 hack enabled. Expect an invalid \
1890         #  response or even no response at all.
1891         # No logfile configured. Logging disabled.
1892         # Invalid "chunked" transfer encoding detected and ignored.
1893         # Support for 'Connection: keep-alive' is experimental, incomplete and\
1894         #  known not to work properly in some situations.
1895         # Flushing header and buffers. Stepping back from filtering.
1896         # Can not resolve doesnotexist: hostname nor servname provided, or not known
1897
1898     } else {
1899
1900         found_unknown_content($c);
1901
1902     }
1903
1904     return $c;
1905 }
1906
1907 sub handle_loglevel_cgi ($) {
1908
1909     my $c = shift;
1910
1911     if ($c =~ m/^Granting access to/) {
1912
1913         #Granting access to http://config.privoxy.org/send-stylesheet, referrer http://p.p/ is trustworthy.
1914
1915     } elsif ($c =~ m/^Substituting: s(.)/) {
1916
1917         # Substituting: s/@else-not-FEATURE_ZLIB@.*@endif-FEATURE_ZLIB@//sigTU
1918         # XXX: prone to span several lines
1919
1920         my $delimiter = $1;
1921         #$c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1922         $c =~ s@(?!<=\\)($delimiter)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g; # XXX: Too aggressive
1923         #$c =~ s@(?!<=\\)($1)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g;
1924     }
1925
1926     return $c;
1927 }
1928
1929 sub handle_loglevel_force ($) {
1930
1931     my $c = shift;
1932
1933     if ($c =~ m/^Ignored force prefix in request:/) {
1934
1935         # Ignored force prefix in request: "GET http://10.0.0.1/PRIVOXY-FORCE/block HTTP/1.1"
1936         $c =~ s@^(Ignored)@$h{'ignored'}$1$h{'Standard'}@;
1937         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1938
1939     } elsif ($c =~ m/^Enforcing request:/) {
1940
1941         # Enforcing request: "GET http://10.0.0.1/block HTTP/1.1".
1942         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1943
1944     } else {
1945
1946         found_unknown_content($c);
1947
1948     }
1949
1950     return $c;
1951 }
1952
1953 sub handle_loglevel_error ($) {
1954
1955     my $c = shift;
1956
1957     if ($c =~ m/^(?:Empty|No) server or forwarder response received on socket \d+\./) {
1958
1959         # Empty server or forwarder response received on socket 4.
1960         # Empty server or forwarder response received on socket 3. \
1961         #  Closing client socket 15 without sending data.
1962         # Used by Privoxy 3.0.18 and later:
1963         # No server or forwarder response received on socket 8. \
1964         #  Closing client socket 10 without sending data.
1965
1966         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1967         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1968
1969     } elsif ($c =~ m/^Didn't receive data in time:/) {
1970
1971         # Didn't receive data in time: a.fsdn.com:443
1972         $c =~ s@(?<=in time: )(.*)@$h{'destination'}$1$h{'Standard'}@;
1973     }
1974
1975     # XXX: There are probably more messages that deserve highlighting.
1976
1977     return $c;
1978 }
1979
1980
1981 sub handle_loglevel_ignore ($) {
1982     return shift;
1983 }
1984
1985 sub gather_loglevel_request_stats ($$) {
1986     my $c = shift;
1987     my $thread = shift;
1988     our %stats;
1989
1990     $stats{requests}++;
1991 }
1992
1993 sub gather_loglevel_crunch_stats ($$) {
1994     my $c = shift;
1995     my $thread = shift;
1996     our %stats;
1997
1998     $stats{requests}++;
1999     $stats{crunches}++;
2000
2001     if ($c =~ m/^Redirected:/) {
2002         # Redirected: http://www.example.org/http://p.p/
2003         $stats{'fast-redirections'}++;
2004
2005     } elsif ($c =~ m/^Blocked:/) {
2006         # Blocked: blogger.googleusercontent.com:443
2007         $stats{'blocked'}++;
2008     }
2009 }
2010
2011
2012 sub gather_loglevel_error_stats ($$) {
2013
2014     my $c = shift;
2015     my $thread = shift;
2016     our %stats;
2017     our %thread_data;
2018
2019     if ($c =~ m/^Empty server or forwarder response received on socket \d+./) {
2020
2021         # Empty server or forwarder response received on socket 4.
2022         $stats{'empty-responses'}++;
2023         if ($thread_data{$thread}{'new_connection'}) {
2024             $stats{'empty-responses-on-new-connections'}++;
2025         } else {
2026             $stats{'empty-responses-on-reused-connections'}++;
2027         }
2028     }
2029 }
2030
2031 sub gather_loglevel_connect_stats ($$) {
2032
2033     my ($c, $thread) = @_;
2034     our %thread_data;
2035     our %stats;
2036
2037     if ($c =~ m/^via ([^\s]+) to: [^\s]+/) {
2038
2039         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
2040         $thread_data{$thread}{'forwarder'} = $1; # XXX: is this missue?
2041
2042     } elsif ($c =~ m/^to ([^\s]*)$/) {
2043
2044         # Connect: to lists.sourceforge.net:443
2045
2046         $thread_data{$thread}{'forwarder'} = 'direct connection';
2047
2048     } elsif ($c =~ m/^Created new connection to/) {
2049
2050         # Created new connection to www.privoxy.org:80 on socket 11.
2051
2052         $thread_data{$thread}{'new_connection'} = 1;
2053
2054     } elsif ($c =~ m/^Reusing server socket \d./ or
2055              $c =~ m/^Found reusable socket/) {
2056
2057         # Reusing server socket 4. Opened for 10.0.0.1.
2058         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
2059
2060         $thread_data{$thread}{'new_connection'} = 0;
2061         $stats{'reused-connections'}++;
2062
2063     } elsif ($c =~ m/^Closing client socket \d+. .* Requests received: (\d+)\.$/) {
2064
2065         # Closing client socket 12. Keep-alive: 1. Socket alive: 1. Data available: 0. \
2066         #  Configuration file change detected: 0. Requests received: 14.
2067
2068         $stats{'client-requests-on-connection'}{$1}++;
2069         $stats{'closed-client-connections'}++;
2070     }
2071 }
2072
2073 sub gather_loglevel_header_stats ($$) {
2074
2075     my ($c, $thread) = @_;
2076     our %stats;
2077
2078     if ($c =~ m/^A HTTP\/1\.1 response without/ or
2079         $c =~ m/^Keeping the server header 'Connection: keep-alive' around./)
2080     {
2081         # A HTTP/1.1 response without Connection header implies keep-alive.
2082         # Keeping the server header 'Connection: keep-alive' around.
2083         $stats{'server-keep-alive'}++;
2084
2085     } elsif ($c =~ m/^scan: ((\w+) (.+) (HTTP\/\d\.\d))/) {
2086
2087         # scan: HTTP/1.1 200 OK
2088         $stats{'method'}{$2}++;
2089         $stats{'resource'}{$3}++;
2090         $stats{'http-version'}{$4}++;
2091
2092     } elsif ($c =~ m/^scan: Host: ([^\s]+)/) {
2093
2094         # scan: Host: p.p
2095         $stats{'hosts'}{$1}++;
2096     }
2097 }
2098
2099 sub init_stats () {
2100     our %stats = (
2101         requests => 0,
2102         crunches => 0,
2103         'server-keep-alive' => 0,
2104         'reused-connections' => 0,
2105         'empty-responses' => 0,
2106         'empty-responses-on-new-connections' => 0,
2107         'empty-responses-on-reused-connections' => 0,
2108         'fast-redirections' => 0,
2109         'blocked' => 0,
2110         'reused-connections' => 0,
2111         'server-keep-alive' => 0,
2112         'closed-client-connections' => 0,
2113         );
2114         $stats{'client-requests-on-connection'}{1} = 0;
2115 }
2116
2117 sub get_percentage ($$) {
2118     my $big = shift;
2119     my $small = shift;
2120
2121     # If small is 0 the percentage is always 0%.
2122     # Make sure it works even if big is 0 as well.
2123     return "0.00%" if ($small eq 0);
2124
2125     # Prevent division by zero.
2126     # XXX: Is this still supposed to be reachable?
2127     return "NaN" if ($big eq 0);
2128
2129     return sprintf("%.2f%%", $small / $big * 100);
2130 }
2131
2132 sub print_stats () {
2133
2134     our %stats;
2135     our %cli_options;
2136     my $new_connections = $stats{requests} - $stats{crunches} - $stats{'reused-connections'};
2137     my $outgoing_requests = $stats{requests} - $stats{crunches};
2138     my $client_requests_checksum = 0;
2139
2140     if ($stats{requests} eq 0) {
2141         print "No requests yet.\n";
2142         return;
2143     }
2144
2145     print "Client requests total: " . $stats{requests} . "\n";
2146     print "Crunches: " . $stats{crunches} . " (" .
2147         get_percentage($stats{requests}, $stats{crunches}) . ")\n";
2148     print "Blocks: " . $stats{'blocked'} . " (" .
2149         get_percentage($stats{requests}, $stats{'blocked'}) . ")\n";
2150     print "Fast redirections: " . $stats{'fast-redirections'} . " (" .
2151         get_percentage($stats{requests}, $stats{'fast-redirections'}) . ")\n";
2152     print "Outgoing requests: " . $outgoing_requests . " (" .
2153         get_percentage($stats{requests}, $outgoing_requests) . ")\n";
2154     print "Server keep-alive offers: " . $stats{'server-keep-alive'} . " (" .
2155         get_percentage($stats{requests}, $stats{'server-keep-alive'}) . ")\n";
2156     print "New outgoing connections: " . $new_connections . " (" .
2157         get_percentage($stats{requests}, $new_connections) . ")\n";
2158     print "Reused connections: " . $stats{'reused-connections'} . " (" .
2159         get_percentage($stats{requests}, $stats{'reused-connections'}) .
2160         "; server offers accepted: " .
2161         get_percentage($stats{'server-keep-alive'}, $stats{'reused-connections'}) . ")\n";
2162     print "Empty responses: " . $stats{'empty-responses'} . " (" .
2163         get_percentage($stats{requests}, $stats{'empty-responses'}) . ")\n";
2164     print "Empty responses on new connections: "
2165          . $stats{'empty-responses-on-new-connections'} . " (" .
2166         get_percentage($stats{requests}, $stats{'empty-responses-on-new-connections'})
2167         . ")\n";
2168     print "Empty responses on reused connections: " .
2169         $stats{'empty-responses-on-reused-connections'} . " (" .
2170         get_percentage($stats{requests}, $stats{'empty-responses-on-reused-connections'}) .
2171         ")\n";
2172     print "Client connections: " .  $stats{'closed-client-connections'} . "\n";
2173
2174     my $lines_printed = 0;
2175     print "Client requests per connection distribution:\n";
2176     foreach my $client_requests (sort {
2177         $stats{'client-requests-on-connection'}{$b} <=> $stats{'client-requests-on-connection'}{$a}}
2178                                   keys %{$stats{'client-requests-on-connection'}
2179                                   })
2180     {
2181         my $count = $stats{'client-requests-on-connection'}{$client_requests};
2182         $client_requests_checksum += $count * $client_requests;
2183         if ($cli_options{'show-complete-request-distribution'} or ($lines_printed < 10)) {
2184             printf "%8d: %d\n", $count, $client_requests;
2185             $lines_printed++;
2186         }
2187     }
2188     unless ($cli_options{'show-complete-request-distribution'}) {
2189         printf "Enable --show-complete-request-distribution to get less common numbers as well.\n";
2190     }
2191     # Due to log rotation we may not have a complete picture for all the requests
2192     printf "Improperly accounted requests: ~%d\n", abs($stats{requests} - $client_requests_checksum);
2193
2194     if (exists $stats{method}) {
2195         print "Method distribution:\n";
2196         foreach my $method (sort {$stats{'method'}{$b} <=> $stats{'method'}{$a}} keys %{$stats{'method'}}) {
2197             printf "%8d : %-8s\n", $stats{'method'}{$method}, $method;
2198         }
2199     } else {
2200         print "Method distribution unknown. No response headers parsed yet. Is 'debug 8' enabled?\n";
2201     }
2202     print "Client HTTP versions:\n";
2203     foreach my $http_version (sort {$stats{'http-version'}{$b} <=> $stats{'http-version'}{$a}} keys %{$stats{'http-version'}}) {
2204         printf "%d : %s\n",  $stats{'http-version'}{$http_version}, $http_version;
2205     }
2206
2207     if ($cli_options{'url-statistics-threshold'} == 0) {
2208         print "URL statistics are disabled. Increase --url-statistics-threshold to enable them.\n";
2209     } else {
2210         print "Requested URLs:\n";
2211         foreach my $resource (sort {$stats{'resource'}{$b} <=> $stats{'resource'}{$a}} keys %{$stats{'resource'}}) {
2212             if ($stats{'resource'}{$resource} < $cli_options{'url-statistics-threshold'}) {
2213                 print "Skipped statistics for URLs below the treshold.\n";
2214                 last;
2215             }
2216             printf "%d : %s\n", $stats{'resource'}{$resource}, $resource;
2217         }
2218     }
2219
2220     if ($cli_options{'host-statistics-threshold'} == 0) {
2221         print "Host statistics are disabled. Increase --host-statistics-threshold to enable them.\n";
2222     } else {
2223         print "Requested Hosts:\n";
2224         foreach my $host (sort {$stats{'hosts'}{$b} <=> $stats{'hosts'}{$a}} keys %{$stats{'hosts'}}) {
2225             if ($stats{'hosts'}{$host} < $cli_options{'host-statistics-threshold'}) {
2226                 print "Skipped statistics for Hosts below the treshold.\n";
2227                 last;
2228             }
2229             printf "%d : %s\n", $stats{'hosts'}{$host}, $host;
2230         }
2231     }
2232 }
2233
2234
2235 ################################################################################
2236 # Functions that actually print stuff
2237 ################################################################################
2238
2239 sub print_clf_message () {
2240
2241     our ($ip, $timestamp, $request_line, $status_code, $size);
2242     my $output = '';
2243
2244     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2245
2246     # Rebuild highlighted
2247     $output .= $h{'Number'} . $ip . $h{'Standard'};
2248     $output .= " - - ";
2249     $output .= "[" . $h{'Timestamp'} . $timestamp . $h{'Standard'} . "]";
2250     $output .= " ";
2251     $output .= "\"" . highlight_request_line("$request_line") . "\"";
2252     $output .= " ";
2253     $output .= $h{'Status'} . $status_code . $h{'Standard'};
2254     $output .= " ";
2255     $output .= $h{'Number'} . $size . $h{'Standard'};
2256     $output .= $line_end;
2257
2258     print $output;
2259 }
2260
2261 sub print_non_clf_message ($) {
2262
2263     my $content = shift;
2264     my $msec_string = $no_msecs_mode ? '' : '.' . $req{$t}{'msecs'};
2265     my $line_start = $html_output_mode ? '' : $h{"Standard"};
2266
2267     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2268
2269     print $line_start
2270         . $time_colours[$time_colour_index % 2]
2271         . $req{$t}{'time-stamp'}
2272         . $msec_string
2273         . $h{Standard} . " "
2274         . $thread_colours{$t}
2275         . $t
2276         . $h{Standard}
2277         . " "
2278         . $h{$req{$t}{'log-level'}}
2279         . $req{$t}{'log-level'}
2280         . $h{Standard}
2281         . ": "
2282         . $content
2283         . $line_end;
2284 }
2285
2286 sub shorten_thread_id ($) {
2287
2288     my $thread_id = shift;
2289
2290     our %short_thread_ids;
2291     our $max_threadid;
2292
2293     unless (defined $short_thread_ids{$thread_id}) {
2294         $short_thread_ids{$thread_id} = sprintf "%.3d", $max_threadid++;
2295     }
2296
2297     return $short_thread_ids{$thread_id}
2298 }
2299
2300 sub parse_loop () {
2301
2302     my ($day, $time_stamp, $thread, $log_level, $content, $c, $msecs);
2303     my $last_msecs  = 0;
2304     my $last_thread = 0;
2305     my $last_timestamp = 0;
2306     my $filters_that_did_nothing;
2307     my $key;
2308     my $time_colour;
2309     $time_colour = paint_it('white');
2310
2311     my %log_level_handlers = (
2312         'Re-Filter'         => \&handle_loglevel_re_filter,
2313         'Header'            => \&handle_loglevel_header,
2314         'Connect'           => \&handle_loglevel_connect,
2315         'Redirect'          => \&handle_loglevel_redirect,
2316         'Request'           => \&handle_loglevel_request,
2317         'Crunch'            => \&handle_loglevel_crunch,
2318         'Gif-Deanimate'     => \&handle_loglevel_gif_deanimate,
2319         'Info'              => \&handle_loglevel_info,
2320         'CGI'               => \&handle_loglevel_cgi,
2321         'Force'             => \&handle_loglevel_force,
2322         'Error'             => \&handle_loglevel_error,
2323         'Fatal error'       => \&handle_loglevel_ignore,
2324         'Writing'           => \&handle_loglevel_ignore,
2325         'Received'          => \&handle_loglevel_ignore,
2326         'Actions'           => \&handle_loglevel_ignore,
2327         'Unknown log level' => \&handle_loglevel_ignore,
2328     );
2329
2330     while (<>) {
2331
2332         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/) {
2333             $thread = $t = ($shorten_thread_ids) ? shorten_thread_id($4) : $4;
2334             $req{$t}{'day'} = $day = $1;
2335             $req{$t}{'time-stamp'} = $time_stamp = $2;
2336             $req{$t}{'msecs'} = $msecs = $3 ? $3 : 0; # Only the cool kids have micro second resolution;
2337             $req{$t}{'log-level'} = $log_level = $5;
2338             $req{$t}{'content'} = $content = $c = $6;
2339             $req{$t}{'log-message'} = $_;
2340             $no_special_header_highlighting = 0;
2341
2342             if (defined($log_level_handlers{$log_level})) {
2343
2344                 $content = $log_level_handlers{$log_level}($content);
2345
2346             } else {
2347
2348                 die "No handler found for log level \"$log_level\"\n";
2349             }
2350
2351             # Highlight Truncations
2352             if (length($_) > 4000) {
2353                 $content =~ s@(too long, truncated)]$@$h{'Truncation'}$1$h{'Standard'}]@g;
2354             }
2355
2356             next unless $content;
2357
2358             # Register threads to keep the colour constant
2359             if (!defined($thread_colours{$thread})) {
2360                 $thread_colours{$thread} = $all_colours[$thread_colour_index % @all_colours];
2361                 $thread_colour_index++;
2362             }
2363
2364             # Switch timestamp colour if timestamps differ
2365             if (($msecs ne $last_msecs) || ($time_stamp ne $last_timestamp)) {
2366                debug_message("Tick tack!") if DEBUG_TICKS;
2367                $time_colour = $time_colours[$time_colour_index % 2];
2368                $time_colour_index++;
2369                $last_msecs = $msecs;
2370                $last_timestamp = $time_stamp;
2371             }
2372
2373             $last_thread = $thread;
2374
2375             print_non_clf_message($content);
2376
2377         } elsif (m/^((?:\d+\.\d+\.\d+\.\d+|[:\d]+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2378
2379             # LOG_LEVEL_CLF lines look like this
2380             # 61.152.239.32 - - [04/Mar/2007:18:28:23 +0100] "GET \
2381             #  http://ad.yieldmanager.com/imp?z=1&Z=120x600&s=109339&u=http%3A%2F%2Fwww.365loan.co.uk%2F&r=1\
2382             #  HTTP/1.1" 403 1730
2383             our ($ip, $timestamp, $request_line, $status_code, $size) = ($1, $2, $3, $4, $5);
2384
2385             print_clf_message();
2386
2387         } else {
2388
2389             # Some Privoxy log messages span more than one line,
2390             # usually to dump lots of content that doesn't need any syntax highlighting.
2391             # XXX: add mechanism to forward these lines to the right handler anyway.
2392             chomp();
2393             unless (DEBUG_SUPPRESS_LOG_MESSAGES or (SUPPRESS_EMPTY_LINES and m/^\s+$/)) {
2394                 print and print get_line_end(); # unless (SUPPRESS_EMPTY_LINES and m/^\s+$/);
2395             }
2396         }
2397     }
2398 }
2399
2400 sub stats_loop () {
2401
2402     my ($day, $time_stamp, $msecs, $thread, $log_level, $content);
2403     my $strict_checks = cli_option_is_set('strict-checks');
2404     my %log_level_handlers = (
2405          'Connect:'           => \&gather_loglevel_connect_stats,
2406          'Crunch:'            => \&gather_loglevel_crunch_stats,
2407          'Error:'             => \&gather_loglevel_error_stats,
2408          'Header:'            => \&gather_loglevel_header_stats,
2409          'Request:'           => \&gather_loglevel_request_stats,
2410     );
2411     my %ignored_log_levels = (
2412          'Actions:'           => \&handle_loglevel_ignore,
2413          'CGI:'               => \&handle_loglevel_ignore,
2414          'Fatal error:'       => \&handle_loglevel_ignore,
2415          'Force:'             => \&handle_loglevel_ignore,
2416          'Gif-Deanimate:'     => \&handle_loglevel_ignore,
2417          'Info:'              => \&handle_loglevel_ignore,
2418          'Re-Filter:'         => \&handle_loglevel_ignore,
2419          'Received:'          => \&handle_loglevel_ignore,
2420          'Redirect:'          => \&handle_loglevel_ignore,
2421          'Unknown log level:' => \&handle_loglevel_ignore,
2422          'Writing:'           => \&handle_loglevel_ignore,
2423     );
2424
2425     while (<>) {
2426         (undef, $time_stamp, $thread, $log_level, $content) = split(/ /, $_, 5);
2427
2428         # Skip LOG_LEVEL_CLF
2429         next if (not defined($log_level) or $time_stamp eq "-");
2430
2431         if (defined($log_level_handlers{$log_level})) {
2432
2433             $content = $log_level_handlers{$log_level}($content, $thread);
2434
2435         } elsif ($strict_checks and not defined($ignored_log_levels{$log_level})) {
2436
2437             die "No handler found for: $_";
2438         }
2439     }
2440
2441     print_stats();
2442
2443 }
2444
2445 sub unbreak_lines_only_loop() {
2446     my $log_messages_reached = 0;
2447     while (<>) {
2448         chomp;
2449
2450             # Log level other than LOG_LEVEL_CLF?
2451         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/ or
2452             # LOG_LEVEL_CLF?
2453             m/^((?:\d+\.\d+\.\d+\.\d+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2454             $log_messages_reached = 1;
2455             print "\n";
2456
2457         } else {
2458             # Wrapped message
2459             $_ = "\n". $_  if /^(?:\d+\.\d+\.\d+\.\d+)/;
2460             $_ = " " . $_;
2461         }
2462         s@<BR>$@@;
2463         print;
2464         print "\n" unless $log_messages_reached;
2465     }
2466     print "\n";
2467 }
2468
2469 sub VersionMessage {
2470     my $version_message;
2471
2472     $version_message .= 'Privoxy-Log-Parser ' . PRIVOXY_LOG_PARSER_VERSION  . "\n";
2473     $version_message .= 'https://www.fabiankeil.de/sourcecode/privoxy-log-parser/' . "\n";
2474
2475     print $version_message;
2476 }
2477
2478 sub get_cli_options () {
2479
2480     our %cli_options = (
2481         'html-output'              => CLI_OPTION_DEFAULT_TO_HTML_OUTPUT,
2482         'title'                    => CLI_OPTION_TITLE,
2483         'no-syntax-highlighting'   => CLI_OPTION_NO_SYNTAX_HIGHLIGHTING,
2484         'no-embedded-css'          => CLI_OPTION_NO_EMBEDDED_CSS,
2485         'no-msecs'                 => CLI_OPTION_NO_MSECS,
2486         'shorten-thread-ids'       => CLI_OPTION_SHORTEN_THREAD_IDS,
2487         'show-ineffective-filters' => CLI_OPTION_SHOW_INEFFECTIVE_FILTERS,
2488         'statistics'               => CLI_OPTION_STATISTICS,
2489         'strict-checks'            => CLI_OPTION_STRICT_CHECKS,
2490         'url-statistics-threshold' => CLI_OPTION_URL_STATISTICS_THRESHOLD,
2491         'unbreak-lines-only'       => CLI_OPTION_UNBREAK_LINES_ONLY,
2492         'host-statistics-threshold'=> CLI_OPTION_HOST_STATISTICS_THRESHOLD,
2493         'show-complete-request-distribution' => CLI_OPTION_SHOW_COMPLETE_REQUEST_DISTRIBUTION,
2494     );
2495
2496     GetOptions (
2497         'html-output'              => \$cli_options{'html-output'},
2498         'title'                    => \$cli_options{'title'},
2499         'no-syntax-highlighting'   => \$cli_options{'no-syntax-highlighting'},
2500         'no-embedded-css'          => \$cli_options{'no-embedded-css'},
2501         'no-msecs'                 => \$cli_options{'no-msecs'},
2502         'shorten-thread-ids'       => \$cli_options{'shorten-thread-ids'},
2503         'show-ineffective-filters' => \$cli_options{'show-ineffective-filters'},
2504         'statistics'               => \$cli_options{'statistics'},
2505         'strict-checks'            => \$cli_options{'strict-checks'},
2506         'unbreak-lines-only'       => \$cli_options{'unbreak-lines-only'},
2507         'url-statistics-threshold=i'=> \$cli_options{'url-statistics-threshold'},
2508         'host-statistics-threshold=i'=> \$cli_options{'host-statistics-threshold'},
2509         'show-complete-request-distribution' => \$cli_options{'show-complete-request-distribution'},
2510         'version'                  => sub { VersionMessage && exit(0) },
2511         'help'                     => \&help,
2512    ) or exit(1);
2513
2514    $html_output_mode = cli_option_is_set('html-output');
2515    $no_msecs_mode = cli_option_is_set('no-msecs');
2516    $shorten_thread_ids = cli_option_is_set('shorten-thread-ids');
2517    $line_end = get_line_end();
2518 }
2519
2520 sub help () {
2521
2522     our %cli_options;
2523
2524     VersionMessage();
2525
2526     print << "    EOF"
2527
2528 Options and their default values if they have any:
2529     [--host-statistics-threshold $cli_options{'host-statistics-threshold'}]
2530     [--html-output]
2531     [--no-embedded-css]
2532     [--no-msecs]
2533     [--no-syntax-highlighting]
2534     [--shorten-thread-ids]
2535     [--show-ineffective-filters]
2536     [--show-complete-request-distribution]
2537     [--statistics]
2538     [--unbreak-lines-only]
2539     [--url-statistics-threshold $cli_options{'url-statistics-threshold'}]
2540     [--title $cli_options{'title'}]
2541     [--version]
2542 see "perldoc $0" for more information
2543     EOF
2544     ;
2545     exit(0);
2546 }
2547
2548 ################################################################################
2549 # main
2550 ################################################################################
2551 sub main () {
2552
2553     get_cli_options();
2554     set_background(DEFAULT_BACKGROUND);
2555     prepare_our_stuff();
2556
2557     print_intro();
2558
2559     # XXX: should explicitly reject incompatible argument combinations
2560     if (cli_option_is_set('unbreak-lines-only')) {
2561         unbreak_lines_only_loop();
2562     } elsif (cli_option_is_set('statistics')) {
2563         stats_loop();
2564     } else {
2565         parse_loop();
2566     }
2567
2568     print_outro();
2569 }
2570
2571 main();
2572
2573 =head1 NAME
2574
2575 B<privoxy-log-parser> - A parser and syntax-highlighter for Privoxy log messages
2576
2577 =head1 SYNOPSIS
2578
2579 B<privoxy-log-parser> [B<--html-output>]
2580 [B<--no-msecs>] [B<--no-syntax-higlighting>] [B<--statistics>]
2581 [B<--shorten-thread-ids>] [B<--show-ineffective-filters>]
2582 [B<--url-statistics-threshold>] [B<--version>]
2583
2584 =head1 DESCRIPTION
2585
2586 B<privoxy-log-parser> reads Privoxy log messages and
2587
2588 - syntax-highlights recognized lines,
2589
2590 - reformats some of them for easier comprehension,
2591
2592 - filters out less useful messages, and
2593
2594 - (in some cases) calculates additional information,
2595   like the compression ratio or how a filter affected
2596   the content size.
2597
2598 With B<privoxy-log-parser> you should be able to increase Privoxy's log level
2599 without getting confused by the resulting amount of output. For example for
2600 "debug 64" B<privoxy-log-parser> will (by default) only show messages that
2601 affect the content. If a filter doesn't cause any hits, B<privoxy-log-parser>
2602 will hide the "filter foo caused 0 hits" message.
2603
2604 =head1 OPTIONS
2605
2606 [B<--host-statistics-threshold>] Only show the request count for a host
2607 if it's above or equal to the given threshold. If the threshold is 0, host
2608 statistics are disabled.
2609
2610 [B<--html-output>] Use HTML and CSS for the syntax highlighting. If this option is
2611 omitted, ANSI escape sequences are used unless B<--no-syntax-highlighting> is active.
2612 This option is only intended to make embedding log excerpts in web pages easier.
2613 It does not escape any input!
2614
2615 [B<--no-msecs>] Don't expect milisecond resolution
2616
2617 [B<--no-syntax-highlighting>] Disable syntax-highlighting. Useful when
2618 the filtered output is piped into less in which case the ANSI control
2619 codes don't work, or if the terminal itself doesn't support the control
2620 codes.
2621
2622 [B<--shorten-thread-ids>] Shorten the thread ids to a three-digit decimal number.
2623 Note that the mapping from thread ids to shortened ids is created at run-time
2624 and thus varies with the input.
2625
2626 [B<--show-ineffective-filters>] Don't suppress log lines for filters
2627 that didn't modify the content.
2628
2629 [B<--show-complete-request-distribution>] Show the complete client request
2630 distribution in the B<--statistics> output. Without this option only the
2631 ten most common numbers are shown.
2632
2633 [B<--statistics>] Gather various statistics instead of syntax highlighting
2634 log messages. This is an experimental feature, if the results look wrong
2635 they very well might be. Also note that the results are pretty much guaranteed
2636 to be incorrect if Privoxy and Privoxy-Log-Parser aren't in sync.
2637
2638 [B<--strict-checks>] When generating statistics, look more careful at the
2639 input data and abort if it is unexpected, even if it doesn't affect the
2640 results. Significantly slows the parsing down and is not expected to catch
2641 any problems that matter.
2642 When highlighting, print warnings in case of unknown messages which can't be
2643 properly highlighted.
2644
2645 [B<--unbreak-lines-only>] Tries to fix lines that got messed up by a broken or
2646 interestingly configured mail client and thus are no longer recognized properly.
2647 Only fixes some breakage, but may be good enough or at least better than nothing.
2648 Doesn't do anything else, so you probably want to pipe the output into
2649 B<privoxy-log-parser> again.
2650
2651 [B<--url-statistics-threshold>] Only show the request count for a resource
2652 if it's above or equal to the given threshold. If the threshold is 0, URL
2653 statistics are disabled.
2654
2655 [B<--version>] Print version and exit.
2656
2657 =head1 EXAMPLES
2658
2659 To monitor a log file:
2660
2661 tail -F /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log | B<privoxy-log-parser>
2662
2663 Replace '-F' with '-f' if your tail implementation lacks '-F' support
2664 or if the log won't get rotated anyway. The log file location depends
2665 on your system (Doh!).
2666
2667 To monitor Privoxy without having it write to a log file:
2668
2669 privoxy --no-daemon /usr/jails/privoxy-jail/usr/local/etc/privoxy/config 2>&1 | B<privoxy-log-parser>
2670
2671 Again, the config file location depends on your system. Output redirection
2672 depends on your shell, the above works with bourne shells.
2673
2674 To read a processed Privoxy log file from top to bottom, letting the content
2675 scroll by slightly faster than you can read:
2676
2677 B<privoxy-log-parser> < /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log
2678
2679 This is probably only useful to fill screens in the background of haxor movies.
2680
2681 =head1 CAVEATS
2682
2683 Syntax highlighting with ANSI escape sequences will look strange
2684 if your background color isn't black.
2685
2686 Some messages aren't recognized yet and will not be fully highlighted.
2687
2688 B<privoxy-log-parser> is developed with Privoxy 3.0.7 or later in mind,
2689 using earlier Privoxy versions will probably result in an increased amount
2690 of unrecognized log lines.
2691
2692 Privoxy's log files tend to be rather large. If you use HTML
2693 highlighting some browsers can't handle them, get confused and
2694 will eventually crash because of segmentation faults or unexpected
2695 exceptions. This is a problem in the browser and not B<privoxy-log-parser>'s
2696 fault.
2697
2698 =head1 BUGS
2699
2700 Many settings can't be controlled through command line options yet.
2701
2702 =head1 SEE ALSO
2703
2704 privoxy(1)
2705
2706 =head1 AUTHOR
2707
2708 Fabian Keil <fk@fabiankeil.de>
2709
2710 =cut