c7312e85816f603014a8d5df829efa8490132596
[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 # TODO:
12 #       - LOG_LEVEL_CGI, LOG_LEVEL_ERROR, LOG_LEVEL_WRITE content highlighting
13 #       - create fancy statistics
14 #       - grep through Privoxy sources to find unsupported log messages
15 #       - hunt down substitutions that match content from variables which
16 #         can contain stuff like ()?'[]
17 #       - replace $h{'foo'} with h('foo') where possible
18 #       - hunt down XXX comments instead of just creating them
19 #       - add example log lines for every regex and mark them up for
20 #         regression testing
21 #       - Handle incomplete input without Perl warning about undefined variables.
22 #       - Use generic highlighting function that takes a regex and the
23 #         hash key as input.
24 #       - Add --compress and --decompress options.
25 #
26 # Copyright (c) 2007-2020 Fabian Keil <fk@fabiankeil.de>
27 #
28 # Permission to use, copy, modify, and distribute this software for any
29 # purpose with or without fee is hereby granted, provided that the above
30 # copyright notice and this permission notice appear in all copies.
31 #
32 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
33 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
34 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
35 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
36 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
37 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
38 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
39 ################################################################################
40
41 use strict;
42 use warnings;
43 use Getopt::Long;
44
45 use constant {
46     PRIVOXY_LOG_PARSER_VERSION => '0.9.1',
47     # Feel free to mess with these ...
48     DEFAULT_BACKGROUND => 'black',  # Choose registered colour (like 'black')
49     DEFAULT_TEXT_COLOUR => 'white', # Choose registered colour (like 'black')
50     HEADER_DEFAULT_COLOUR => 'yellow',
51     REGISTER_HEADERS_WITH_THE_SAME_COLOUR => 1,
52
53     CLI_OPTION_DEFAULT_TO_HTML_OUTPUT => 0,
54     CLI_OPTION_TITLE => 'Privoxy-Log-Parser in da house',
55     CLI_OPTION_KEEP_DATE => 0,
56     CLI_OPTION_NO_EMBEDDED_CSS => 0,
57     CLI_OPTION_NO_MSECS => 0,
58     CLI_OPTION_NO_SYNTAX_HIGHLIGHTING => 0,
59     CLI_OPTION_SHORTEN_THREAD_IDS => 0,
60     CLI_OPTION_SHOW_INEFFECTIVE_FILTERS => 0,
61     CLI_OPTION_STATISTICS => 0,
62     CLI_OPTION_STRICT_CHECKS => 0,
63     CLI_OPTION_UNBREAK_LINES_ONLY => 0,
64     CLI_OPTION_URL_STATISTICS_THRESHOLD => 0,
65     CLI_OPTION_HOST_STATISTICS_THRESHOLD => 0,
66     CLI_OPTION_SHOW_COMPLETE_REQUEST_DISTRIBUTION => 0,
67
68     SUPPRESS_SUCCEEDED_FILTER_ADDITIONS => 1,
69     SHOW_SCAN_INTRO => 0,
70     SHOW_FILTER_READIN_IN => 0,
71     SUPPRESS_EMPTY_LINES => 1,
72     SUPPRESS_SUCCESSFUL_CONNECTIONS => 1,
73     SUPPRESS_GIF_NOT_CHANGED => 1,
74     SUPPRESS_NEED_TO_DE_CHUNK_FIRST => 1,
75
76     DEBUG_HEADER_REGISTERING => 0,
77     DEBUG_HEADER_HIGHLIGHTING => 0,
78     DEBUG_TICKS => 0,
79     DEBUG_PAINT_IT => 0,
80     DEBUG_SUPPRESS_LOG_MESSAGES => 0,
81
82     PUNISH_MISSING_LOG_KNOWLEDGE_WITH_DEATH => 0,
83     PUNISH_MISSING_HIGHLIGHT_KNOWLEDGE_WITH_DEATH => 1,
84
85     LOG_UNPARSED_LINES_TO_EXTRA_FILE => 0,
86     ERROR_LOG_FILE => '/var/log/privoxy-log-parser',
87
88     # You better leave these alone unless you know what you're doing.
89     COLOUR_RESET      => "\033[0;0m",
90     ESCAPE => "\033[",
91 };
92
93 # For performance reasons, these are global.
94
95 my $t;
96 my %req; # request data from previous lines
97 my %h;
98 my %thread_colours;
99 my @all_colours;
100 my @time_colours;
101 my $thread_colour_index = 0;
102 my $header_colour_index = 0;
103 my $time_colour_index = 0;
104 my %header_colours;
105 my $no_special_header_highlighting;
106 my %reason_colours;
107 my %h_colours;
108 my $header_highlight_regex = '';
109
110 my $html_output_mode;
111 my $keep_date_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+)@$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     } elsif ($c =~ m/^Decompression didn't result/) {
1216
1217         # Decompression didn't result in any content.
1218
1219         # Nothing to highlight.
1220
1221     } else {
1222
1223         found_unknown_content($content);
1224
1225     }
1226
1227     return $content;
1228 }
1229
1230 sub handle_loglevel_redirect($) {
1231
1232     my $c = shift;
1233
1234     if ($c =~ m/^Decoding "([^""]*)"/) {
1235
1236          $req{$t}{'original-destination'} = $1;
1237          $c = highlight_matched_path($c, '(?<=Decoding ")[^"]*');
1238          $c =~ s@\"@@g;
1239
1240     } elsif ($c =~ m/^Checking/) {
1241
1242          # Checking /_ylt=A0geu.Z76BRGR9k/**http://search.yahoo.com/search?p=view+odb+presentation+on+freebsd\
1243          #  &ei=UTF-8&xargs=0&pstart=1&fr=moz2&b=11 for redirects.
1244
1245          # TODO: Change colour if really url-decoded
1246          $req{$t}{'decoded-original-destination'} = $1;
1247          $c = highlight_matched_path($c, '(?<=Checking ")[^"]*');
1248          $c =~ s@\"@@g;
1249
1250     } elsif ($c =~ m/^pcrs command "([^""]*)" changed /) {
1251
1252         # pcrs command "s@&from=rss@@" changed \
1253         #  "http://it.slashdot.org/article.pl?sid=07/03/02/1657247&from=rss"\
1254         #  to "http://it.slashdot.org/article.pl?sid=07/03/02/1657247" (1 hit).
1255         $c =~ s@(?<=pcrs command )"([^""]*)"@$h{'filter'}$1$h{'Standard'}@;
1256         $c = highlight_matched_url($c, '(?<=changed ")[^""]*');
1257         $c =~ s@(?<=changed )"([^""]*)"@$1@; # Remove quotes
1258         $c = highlight_matched_url($c, '(?<=to ")[^""]*');
1259         $c =~ s@(?<=to )"([^""]*)"@$1@; # Remove quotes
1260         $c =~ s@(\d+)(?= hits?)@$h{'hits'}$1$h{'Standard'}@;
1261
1262     } elsif ($c =~ m/^pcrs command "([^""]*)" didn\'t change/) {
1263
1264         # pcrs command "s@^http://([^.]+?)/?$@http://www.bing.com/search?q=$1@" didn't \
1265         #  change "http://www.example.org/".
1266         $c =~ s@(?<=pcrs command )"([^""]*)"@$h{'filter'}$1$h{'Standard'}@;
1267         $c = highlight_matched_url($c, '(?<=change ")[^""]*');
1268
1269     } elsif ($c =~ m/(^New URL is: )(.*)/) {
1270
1271         # New URL is: http://it.slashdot.org/article.pl?sid=07/03/04/1511210
1272         # XXX: Use URL highlighter
1273         # XXX: Save?
1274         $c = $1 . h('rewritten-URL') . $2 . h('Standard');
1275
1276     } elsif ($c =~ m/No pcrs command recognized, assuming that/) {
1277         # No pcrs command recognized, assuming that "http://config.privoxy.org/user-manual/favicon.png"\
1278         #  is already properly formatted.
1279         # XXX: assume the same?
1280         $c = highlight_matched_url($c, '(?<=assuming that \")[^"]*');
1281
1282     } elsif ($c =~ m/^Percent-encoding redirect/) {
1283
1284         # Percent-encoding redirect URL: http://www.example.org/\x02
1285         $c = highlight_matched_url($c, '(?<=redirect URL: ).*');
1286
1287     } else {
1288
1289         found_unknown_content($c);
1290
1291     }
1292
1293     return $c;
1294 }
1295
1296 sub handle_loglevel_gif_deanimate($) {
1297
1298     my $content = shift;
1299
1300     if ($content =~ m/Success! GIF shrunk from (\d+) bytes to (\d+)\./) {
1301
1302         my $bytes_from = $1;
1303         my $bytes_to = $2;
1304         # Gif-Deanimate: Success! GIF shrunk from 205 bytes to 133.
1305         $content =~ s@$bytes_from@$h{'Number'}$bytes_from$h{'Standard'}@;
1306         # XXX: Do we need g in case of ($1 == $2)?
1307         $content =~ s@$bytes_to@$h{'Number'}$bytes_to$h{'Standard'}@;
1308
1309     } elsif ($content =~ m/GIF (not) changed/) {
1310
1311         # Gif-Deanimate: GIF not changed.
1312         return '' if SUPPRESS_GIF_NOT_CHANGED;
1313         $content =~ s@($1)@$h{'not'}$1$h{'Standard'}@;
1314
1315     } elsif ($content =~ m/^failed! \(gif parsing\)/) {
1316
1317         # failed! (gif parsing)
1318         # XXX: Replace this error message with something less stupid
1319         $content =~ s@(failed!)@$h{'error'}$1$h{'Standard'}@;
1320
1321     } elsif ($content =~ m/^Need to de-chunk first/) {
1322
1323         # Need to de-chunk first
1324         return '' if SUPPRESS_NEED_TO_DE_CHUNK_FIRST;
1325
1326     } elsif ($content =~ m/^(?:No GIF header found|failed while parsing)/) {
1327
1328         # No GIF header found (XXX: Did I ever commit this?)
1329         # failed while parsing 195 134747048 (XXX: never committed)
1330
1331         # Ignore these for now
1332
1333     } else {
1334
1335         found_unknown_content($content);
1336
1337     }
1338
1339     return $content;
1340 }
1341
1342 sub handle_loglevel_request($) {
1343
1344     my $content = shift;
1345
1346     if ($content =~ m/crunch! /) {
1347
1348         # config.privoxy.org/send-stylesheet crunch! (CGI Call)
1349
1350         # Highlight crunch reasons
1351         foreach my $reason (keys %reason_colours) {
1352             $content =~ s@\(($reason)\)@$reason_colours{$reason}($1)$h{'Standard'}@g;
1353         }
1354         # Highlight request URL domain and ditch 'crunch!'
1355         $content = highlight_matched_pattern($content, 'request_', '[^ ]*(?= crunch!)');
1356         $content =~ s@ crunch!@@;
1357
1358     } elsif ($content =~ m/\[too long, truncated\]$/) {
1359
1360         # config.privoxy.org/edit-actions-submit?f=3&v=1176116716&s=7&Submit=Submit[...]&filter... [too long, truncated]
1361         $content = highlight_matched_pattern($content, 'request_', '^.*(?=\.\.\. \[too long, truncated\]$)');
1362
1363     } elsif ($content =~ m/(.*)/) { # XXX: Pretty stupid
1364
1365         # trac.vidalia-project.net/wiki/Volunteer?format=txt
1366         $content = h('request_') . $content . h('Standard');
1367
1368     } else {  # XXX: Nop
1369
1370         found_unknown_content($content);
1371
1372     }
1373
1374     return $content;
1375 }
1376
1377 sub handle_loglevel_crunch($) {
1378
1379     my $content = shift;
1380
1381     # Highlight crunch reason
1382     foreach my $reason (keys %reason_colours) {
1383         $content =~ s@($reason)@$reason_colours{$reason}$1$h{'Standard'}@g;
1384     }
1385
1386     if ($content =~ m/\[too long, truncated\]$/) {
1387
1388         # Blocked: config.privoxy.org/edit-actions-submit?f=3&v=1176116716&s=7&Submit=Submit\
1389         #  [...]&filter... [too long, truncated]
1390         $content = highlight_matched_pattern($content, 'request_', '^.*(?=\.\.\. \[too long, truncated\]$)');
1391
1392     } else {
1393
1394         # Blocked: http://ads.example.org/
1395         $content = highlight_matched_pattern($content, 'request_', '(?<=: ).*');
1396     }
1397
1398     return $content;
1399 }
1400
1401 sub handle_loglevel_connect($) {
1402
1403     my $c = shift;
1404
1405     if ($c =~ m/^via [^\s]+ to: [^\s]+/) {
1406
1407         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
1408
1409         $c = highlight_matched_host($c, '(?<=via )[^\s]+');
1410         $c = highlight_matched_host($c, '(?<=to: )[^\s]+');
1411
1412     } elsif ($c =~ m/^connect to: .* failed: .*/) {
1413
1414         # connect to: www.example.org.noconnect failed: Operation not permitted
1415
1416         $c = highlight_matched_host($c, '(?<=connect to: )[^\s]+');
1417
1418         $c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1419
1420     } elsif ($c =~ m/^to ([^\s]*)( successful)?$/) {
1421
1422         # Connect: to www.nzherald.co.nz successful
1423         # Connect: to archiv.radiotux.de
1424
1425         return '' if SUPPRESS_SUCCESSFUL_CONNECTIONS;
1426         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1427
1428     } elsif ($c =~ m/^to ([^\s]*)$/) {
1429
1430         # Connect: to lists.sourceforge.net:443
1431
1432         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1433
1434     } elsif ($c =~ m/^[Aa]ccepted connection from .*/ or
1435              $c =~ m/^OK/) {
1436
1437         # Privoxy 3.0.20:
1438         # Accepted connection from 10.0.0.1 on socket 5
1439         # Privoxy between 3.0.20 and 3.0.6:
1440         # accepted connection from 10.0.0.1( on socket 5)?
1441         # Privoxy 3.0.6 and earlier just say:
1442         # OK
1443         $c = highlight_matched_host($c, '(?<=connection from )[^ ]*');
1444         $c = highlight_matched_pattern($c, 'Number', '(?<=socket )\d+');
1445
1446     } elsif ($c =~ m/^Closing client socket/) {
1447
1448         # Closing client socket 5. Keep-alive: 0, Socket alive: 1. Data available: 0.
1449         # Privoxy 3.0.20 and later
1450         # Closing client socket 8. Keep-alive: 1. Socket alive: 0. Data available: 0. \
1451         #  Configuration file change detected: 0. Requests received: 11.
1452
1453         $c = highlight_matched_pattern($c, 'Number', '(?<=socket )\d+');
1454         $c = highlight_matched_pattern($c, 'Number', '(?<=Keep-alive: )\d+');
1455         $c = highlight_matched_pattern($c, 'Number', '(?<=Socket alive: )\d+');
1456         $c = highlight_matched_pattern($c, 'Number', '(?<=available: )\d+');
1457         $c = highlight_matched_pattern($c, 'Number', '(?<=detected: )\d+');
1458         $c = highlight_matched_pattern($c, 'Number', '(?<=received: )\d+');
1459
1460     } elsif ($c =~ m/^write header to: .* failed:/) {
1461
1462         # write header to: 10.0.0.1 failed: Broken pipe
1463
1464         $c = highlight_matched_host($c, '(?<=write header to: )[^\s]*');
1465         $c =~ s@(?<=failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1466
1467     } elsif ($c =~ m/^write header to client failed:/) {
1468
1469         # write header to client failed: Broken pipe
1470         # XXX: Stil in use?
1471         $c =~ s@(?<=failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1472
1473     } elsif ($c =~ m/^socks4_connect:/) {
1474
1475         # socks4_connect: SOCKS request rejected or failed.
1476         $c =~ s@(?<=socks4_connect: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1477
1478     } elsif ($c =~ m/^Listening for new connections/ or
1479              $c =~ m/^accept connection/) {
1480         # XXX: Highlight?
1481         # Privoxy versions above 3.0.6 say:
1482         # Listening for new connections ...
1483         # earlier versions say:
1484         # accept connection ...
1485         return '';
1486
1487     } elsif ($c =~ m/^accept failed:/) {
1488
1489         $c =~ s@(?<=accept failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1490
1491     } elsif ($c =~ m/^Overriding forwarding settings/) {
1492
1493         # Overriding forwarding settings based on 'forward 10.0.0.1:8123'
1494         $c =~ s@(?<=based on \')(.*)(?=\')@$h{'configuration-line'}$1$h{'Standard'}@;
1495
1496     } elsif ($c =~ m/^Denying suspicious CONNECT request from/) {
1497
1498         # Denying suspicious CONNECT request from 10.0.0.1
1499         $c = highlight_matched_host($c, '(?<=from )[^\s]+'); # XXX: not an URL
1500
1501     } elsif ($c =~ m/^socks5_connect:/) {
1502
1503         $c =~ s@(?<=socks5_connect: )(.*)@$h{'error'}$1$h{'Standard'}@;
1504
1505     } elsif ($c =~ m/^Created new connection to/) {
1506
1507         # Created new connection to www.privoxy.org:80 on socket 11.
1508         $c = highlight_matched_host($c, '(?<=connection to )[^\s]+');
1509         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1510
1511     } elsif ($c =~ m/^Found reusable socket/) {
1512
1513         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
1514         # 3.0.15 and later:
1515         # Found reusable socket 8 for www.privoxy.org:80 in slot 2.\
1516         #  Timestamp made 0 seconds ago. Timeout: 1. Latency: 0.
1517         $c =~ s@(?<=Found reusable socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1518         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1519         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1520         $c =~ s@(?<=made )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1521         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1522         $c =~ s@(?<=Latency: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1523
1524     } elsif ($c =~ m/^Marking open socket/) {
1525
1526         # Marking open socket 9 for www.privoxy.org:80 in slot 0 as unused.
1527         $c =~ s@(?<=Marking open socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1528         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1529         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1530
1531     } elsif ($c =~ m/^No reusable/) {
1532
1533         # No reusable socket for addons.mozilla.org:443 found. Opening a new one.
1534         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1535
1536     } elsif ($c =~ m/^(Remembering|Forgetting) socket/) {
1537
1538         # Remembering socket 13 for www.privoxy.org:80 in slot 0.
1539         # Forgetting socket 38 for www.privoxy.org:80 in slot 5.
1540
1541         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1542         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1543         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1544
1545     } elsif ($c =~ m/^Socket/) {
1546
1547         # Socket 16 already forgotten or never remembered.
1548         $c =~ s@(?<=Socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1549
1550     } elsif ($c =~ m/^The connection to/) {
1551
1552         # The connection to www.privoxy.org:80 in slot 6 timed out. Closing socket 19. Timeout is: 61.
1553         # 3.0.15 and later:
1554         # The connection to 1.bp.blogspot.com:80 in slot 0 timed out. Closing socket 5.\
1555         #  Timeout is: 1. Assumed latency: 4.
1556         # The connection to 10.0.0.1:80 in slot 0 is no longer usable. Closing socket 4.
1557         $c = highlight_matched_host($c, '(?<=connection to )[^\s]+');
1558         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1559         $c =~ s@(?<=Closing socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1560         $c =~ s@(?<=Timeout is: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1561         $c =~ s@(?<=Assumed latency: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1562
1563     } elsif ($c =~ m/^Stopped waiting for the request line/ or
1564              $c =~ m/^No request line on socket \d received in time/ or
1565              $c =~ m/^The client side of the connection on socket \d/) {
1566
1567         # Stopped waiting for the request line. Timeout: 121.
1568         # Privoxy 3.0.19 and later:
1569         # No request line on socket 5 received in time. Timeout: 1.
1570         # The client side of the connection on socket 5 got closed \
1571         #  without sending a complete request line.
1572         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1573         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1574
1575     } elsif ($c =~ m/^Waiting for \d/) {
1576
1577         # Waiting for 1 connections to timeout.
1578         $c =~ s@(?<=^Waiting for )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1579
1580     } elsif ($c =~ m/^Initialized/) {
1581
1582         # Initialized 20 socket slots.
1583         $c =~ s@(?<=Initialized )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1584
1585     } elsif ($c =~ m/^Done reading from server/) {
1586
1587         # Done reading from server. Expected content length: 24892. \
1588         #  Actual content length: 24892. Most recently received: 4412.
1589         # 3.0.15 and later:
1590         # Done reading from server. Expected content length: 24892. \
1591         #  Actual content length: 24892. Bytes most recently read: 4412.
1592         # Done reading from server. Content length: 6018 as expected. \
1593         #  Bytes most recently read: 294.
1594         $c =~ s@(?<=ontent length: )(\d+)@$h{'Number'}$1$h{'Standard'}@g;
1595         $c =~ s@(?<=received: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1596         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1597
1598     } elsif ($c =~ m/^Continuing buffering (?:server )?headers/) {
1599
1600         # Continuing buffering headers. byte_count: 19. header_offset: 517. len: 536.
1601         $c =~ s@(?<=byte_count: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1602         $c =~ s@(?<=header_offset: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1603         $c =~ s@(?<=len: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1604         # 3.0.15 up to 3.0.19:
1605         # Continuing buffering headers. Bytes most recently read: 498.
1606         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1607         # 3.0.20 and later:
1608         # Continuing buffering server headers from socket 5. Bytes most recently read: 498.
1609         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1610
1611     } elsif ($c =~ m/^Received \d+ bytes while/) {
1612
1613         # Received 206 bytes while expecting 12103.
1614         $c =~ s@(?<=Received )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1615         $c =~ s@(?<=expecting )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1616
1617     } elsif ($c =~ m/^(Rejecting c|C)onnection from/) {
1618
1619         # Connection from 81.163.28.218 dropped due to ACL
1620         # Rejecting connection from 178.63.152.227. Maximum number of connections reached.
1621         # Connection from 192.168.2.1 on 127.0.1.1:8118 (socket 3) dropped due to ACL
1622         $c = highlight_matched_host($c, '(?<=onnection from )[\d.:]+');
1623         $c = highlight_matched_host($c, '(?<=on )[\d.:]+');
1624         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1625
1626     } elsif ($c =~ m/^(?:Reusing|Closing) server socket / or
1627              $c =~ m/^No additional client request/) {
1628
1629         # Reusing server socket 4. Opened for 10.0.0.1.
1630         # Closing server socket 2. Opened for 10.0.0.1.
1631         # No additional client request received in time. \
1632         #  Closing server socket 4, initially opened for 10.0.0.1.
1633         # No additional client request received in time on socket 29.
1634         # Privoxy 3.0.20 and later
1635         # Reusing server socket 7 connected to www.privoxy.org. Total requests: 2.
1636         # Closing server socket 6 connected to d.asset.soup.io. Keep-alive: 0.\
1637         #  Tainted: 1. Socket alive: 1. Timeout: 60. Configuration file change detected: 0.
1638         # Reusing server socket 35 connected to nl.wikipedia.org. Requests already sent: 5.
1639
1640         $c =~ s@(?<= socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1641         $c = highlight_matched_host($c, '(?<=for )[^\s]+(?=\.)');
1642         $c = highlight_matched_host($c, '(?<=connected to )[^\s]+(?=\.)');
1643         for my $number_pattern ('requests', 'Keep-alive', 'Tainted', ' alive', 'Timeout', 'detected') {
1644             $c = highlight_matched_pattern($c, 'Number', '(?<='. $number_pattern . ': )\d+');
1645         }
1646         $c =~ s@(?<=already sent: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1647
1648     } elsif ($c =~ m/^Connected to /) {
1649
1650         # Connected to tor-jail[10.0.0.2]:9050.
1651
1652         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1653         $c = highlight_matched_host($c, '(?<=Connected to )[^\[\s]+');
1654         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1655
1656     } elsif ($c =~ m/^Could not connect to /) {
1657
1658         # Could not connect to [10.0.0.1]:80.
1659
1660         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1661         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1662
1663     } elsif ($c =~ m/^Waiting for the next client request/ or
1664              $c =~ m/^The connection on server socket/ or
1665              $c =~ m/^Client request (?:\d+ )?(?:arrived in time|has been pipelined) /) {
1666
1667         # Waiting for the next client request on socket 3. Keeping the server \
1668         #  socket 12 to a.fsdn.com open.
1669         # The connection on server socket 6 to upload.wikimedia.org isn't reusable. Closing.
1670         # Privoxy 3.0.20 and later:
1671         # Client request 4 arrived in time on socket 7.
1672         # Used by Privoxy 3.0.18 and 3.0.19:
1673         # Client request arrived in time on socket 21.
1674         # Used by earlier version:
1675         # Client request arrived in time or the client closed the connection on socket 12.
1676         # Client request 8 has been pipelined on socket 7 and the socket is still alive.
1677
1678         $c =~ s@(?<=request )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1679         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1680         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1681         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1682
1683     } elsif ($c =~ m/^Marking the server socket/) {
1684
1685         # Marking the server socket 7 tainted.
1686
1687         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1688
1689     } elsif ($c =~ m/^Reduced expected bytes to /) {
1690
1691         # Reduced expected bytes to 0 to account for the 1542 ones we already got.
1692         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1693         $c =~ s@(?<=for the )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1694
1695     } elsif ($c =~ m/^The client closed socket /) {
1696
1697         # The client closed socket 2 while the server socket 4 is still open.
1698         $c =~ s@(?<=closed socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1699         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1700
1701     } elsif ($c =~ m/^Expected client content length set /) {
1702
1703         # Expected client content length set to 667325411 after reading 4999 bytes.
1704         $c =~ s@(?<=set to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1705         $c =~ s@(?<=reading )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1706
1707     } elsif ($c =~ m/^Reducing expected bytes to /) {
1708
1709         # Reducing expected bytes to 0. Marking the server socket tainted after throwing 4 bytes away.
1710         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1711         $c =~ s@(?<=after throwing )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1712
1713     } elsif ($c =~ m/^Waiting for up to /) {
1714
1715         # Waiting for up to 4999 bytes from the client.
1716         $c =~ s@(?<=up to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1717
1718     } elsif ($c =~ m/^Optimistically sending /) {
1719
1720         # Optimistically sending 318 bytes of client headers intended for www.privoxy.org
1721         $c =~ s@(?<=sending )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1722         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1723
1724     } elsif ($c =~ m/^Stopping to watch the client socket/) {
1725
1726         # Stopping to watch the client socket. There's already another request waiting.
1727         # Privoxy 3.0.20 and later:
1728         # Stopping to watch the client socket 5. There's already another request waiting.
1729         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1730
1731     } elsif ($c =~ m/^Drained \d+ bytes before closing/) {
1732
1733         # Drained 180 bytes before closing socket 6
1734         $c =~ s@(?<=Drained )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1735         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1736
1737     } elsif ($c =~ m/^Tainting client socket/ or
1738              $c =~ m/^Failed to shutdown socket/) {
1739
1740         # Tainting client socket 7 due to unread data.
1741         # Failed to shutdown socket 11: Connection reset by peer
1742
1743         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1744
1745     } elsif ($c =~ m/^Shifting \d+ pipelined bytes/) {
1746
1747         # Shifting 360 pipelined bytes by 360 bytes
1748         $c =~ s@(?<=Shifting )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1749         $c =~ s@(?<=by )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1750
1751     } elsif ($c =~ m/^Flushed (\d+) bytes of request body while expecting (\d+)/) {
1752
1753         # Flushed 30 bytes of request body while expecting 30
1754         $c =~ s@(?<=Flushed )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1755         $c =~ s@(?<=expecting )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1756
1757     } elsif ($c =~ m/^Performing the TLS\/SSL handshake with client. Hash of host:/) {
1758
1759         # Performing the TLS/SSL handshake with client. Hash of host: bab5296b25e256c7b06b92b17b56bcae
1760         $c = highlight_matched_host($c, '(?<=Hash of host: ).+');
1761
1762     } elsif ($c =~ m/^Forwarding \d+ bytes of encrypted POST data/) {
1763
1764         # Forwarding 1954 bytes of encrypted POST data
1765         $c =~ s@(?<=Forwarding )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1766
1767     } elsif ($c =~ m/^Forwarded the last \d+ bytes/) {
1768
1769         # Forwarded the last 1954 bytes
1770         $c =~ s@(?<=the last )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1771
1772     } elsif ($c =~ m/^Waiting for the next client connection. Currently active threads:/) {
1773
1774         # Waiting for the next client connection. Currently active threads: 30
1775         $c =~ s@(?<=threads: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1776
1777     } elsif ($c =~ m/^Data arrived in time on client socket/) {
1778
1779         # Data arrived in time on client socket 6. Requests so far: 3
1780         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1781         $c =~ s@(?<=Requests so far: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1782
1783     } elsif ($c =~ m/^Dropping the client connection on socket/) {
1784
1785         # Dropping the client connection on socket 71. The server connection has not been established yet.
1786         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1787
1788     } elsif ($c =~ m/^The client socket \d+ has become unusable while the server/) {
1789
1790         # The client socket 16 has become unusable while the server socket 24 is still open.
1791         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1792         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1793
1794     } elsif ($c =~ m/^Looks like we / or
1795              $c =~ m/^Unsetting keep-alive flag/ or
1796              $c =~ m/^No connections to wait/ or
1797              $c =~ m/^Complete client request received/ or
1798              $c =~ m/^Possible pipeline attempt detected./ or
1799              $c =~ m/^POST request detected. The connection will not be kept alive./ or
1800              $c =~ m/^The server still wants to talk, but the client hung up on us./ or
1801              $c =~ m/^The server didn't specify how long the connection will stay open/ or
1802              $c =~ m/^There might be a request body. The connection will not be kept alive/ or
1803              $c =~ m/^There better be a request body./ or
1804              $c =~ m/^Done reading from the client\.$/) {
1805
1806         # Looks like we reached the end of the last chunk. We better stop reading.
1807         # Looks like we read the end of the last chunk together with the server \
1808         #  headers. We better stop reading.
1809         # Looks like we got the last chunk together with the server headers. \
1810         #  We better stop reading.
1811         # Unsetting keep-alive flag.
1812         # No connections to wait for left.
1813         # Client request arrived in time or the client closed the connection.
1814         # Complete client request received
1815         # Possible pipeline attempt detected. The connection will not be \
1816         #  kept alive and we will only serve the first request.
1817         # POST request detected. The connection will not be kept alive.
1818         # The server still wants to talk, but the client hung up on us.
1819         # The server didn't specify how long the connection will stay open. Assume it's only a second.
1820         # There might be a request body. The connection will not be kept alive.
1821         # Privoxy 3.0.20 and later
1822         # There better be a request body.
1823         # Done reading from the client.
1824
1825     } else {
1826
1827         found_unknown_content($c);
1828
1829     }
1830
1831     return $c;
1832 }
1833
1834
1835 sub handle_loglevel_info($) {
1836
1837     my $c = shift;
1838
1839     if ($c =~ m/^Rewrite detected:/) {
1840
1841         # Rewrite detected: GET http://10.0.0.2:88/blah.txt HTTP/1.1
1842         $c = highlight_matched_request_line($c, '(?<=^Rewrite detected: ).*');
1843
1844     } elsif ($c =~ m/^Decompress(ing deflated|ion didn)/ or
1845              $c =~ m/^Compressed content detected/ or
1846              $c =~ m/^SDCH-compressed content detected/ or
1847              $c =~ m/^Tagger/
1848             ) {
1849         # Decompressing deflated iob: 117
1850         # Decompression didn't result in any content.
1851         # Compressed content detected, content filtering disabled. Consider recompiling Privoxy\
1852         #  with zlib support or enable the prevent-compression action.
1853         # SDCH-compressed content detected, content filtering disabled.\
1854         #  Consider suppressing SDCH offers made by the client.
1855         # Tagger 'complete-url' created empty tag. Ignored.
1856
1857         # Ignored for now
1858
1859     } elsif ($c =~ m/^(Re)?loading configuration file /) {
1860
1861         # loading configuration file '/usr/local/etc/privoxy/config':
1862         # Reloading configuration file '/usr/local/etc/privoxy/config'
1863         $c =~ s@(?<=loading configuration file \')([^\']*)@$h{'file'}$1$h{'Standard'}@;
1864
1865     } elsif ($c =~ m/^Loading (actions|filter|trust) file: /) {
1866
1867         # Loading actions file: /usr/local/etc/privoxy/default.action
1868         # Loading filter file: /usr/local/etc/privoxy/default.filter
1869         # Loading trust file: /usr/local/etc/privoxy/trust
1870
1871         $c =~ s@(?<= file: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1872
1873     } elsif ($c =~ m/^exiting by signal/) {
1874
1875         # exiting by signal 15 .. bye
1876         $c =~ s@(?<=exiting by signal )(\d+)@$h{'signal'}$1$h{'Standard'}@;
1877
1878     } elsif ($c =~ m/^Privoxy version/) {
1879
1880         # Privoxy version 3.0.7
1881         $c =~ s@(?<=^Privoxy version )(\d+\.\d+\.\d+)$@$h{'version'}$1$h{'Standard'}@;
1882
1883     } elsif ($c =~ m/^Program name: /) {
1884
1885         # Program name: /usr/local/sbin/privoxy
1886         $c =~ s@(?<=Program name: )(.*)@$h{'program-name'}$1$h{'Standard'}@;
1887
1888     } elsif ($c =~ m/^Listening on port /) {
1889
1890         # Listening on port 8118 on IP address 10.0.0.1
1891         $c =~ s@(?<=Listening on port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1892         $c =~ s@(?<=on IP address )(.*)@$h{'ip-address'}$1$h{'Standard'}@;
1893
1894     } elsif ($c =~ m/^\(Re-\)Open(?:ing)? logfile/) {
1895
1896         # (Re-)Open logfile /var/log/privoxy/privoxy.log
1897         $c =~ s@(?<=Open logfile )(.*)@$h{'file'}$1$h{'Standard'}@;
1898
1899     } elsif ($c =~ m/^(Request from|Malformed server response detected)/) {
1900
1901         # Request from 10.0.0.1 denied. limit-connect{,} doesn't allow CONNECT requests to port 443.
1902         # Request from 10.0.0.1 marked for blocking. limit-connect{,} doesn't allow CONNECT requests to port 443.
1903         # 3.0.18 and later:
1904         # Request from 10.0.0.1 marked for blocking. limit-connect{0} doesn't allow CONNECT requests to www.example.org:443
1905         # Malformed server response detected. Downgrading to HTTP/1.0 impossible.
1906
1907         $c =~ s@(?<=Request from )([^\s]*)@$h{'ip-address'}$1$h{'Standard'}@;
1908         $c =~ s@(denied|blocking)@$h{'warning'}$1$h{'Standard'}@;
1909         $c =~ s@(CONNECT)@$h{'method'}$1$h{'Standard'}@;
1910         $c =~ s@(?<=to port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1911         $c =~ s@(?<=to )([^\s]+)@$h{'request_'}$1$h{'Standard'}@;
1912
1913     } elsif ($c =~ m/^Status code/) {
1914
1915         # Status code 304 implies no body.
1916         $c =~ s@(?<=Status code )(\d+)@$h{'status-code'}$1$h{'Standard'}@;
1917
1918     } elsif ($c =~ m/^Method/) {
1919
1920         # Method HEAD implies no body.
1921         $c =~ s@(?<=Method )([^\s]+)@$h{'method'}$1$h{'Standard'}@;
1922
1923     } elsif ($c =~ m/^Buffer limit reached while extending /) {
1924
1925         # Buffer limit reached while extending the buffer (iob). Needed: 4197470. Limit: 4194304
1926         $c =~ s@(?<=Needed: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1927         $c =~ s@(?<=Limit: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1928
1929     } elsif ($c =~ m/^File modification detected: /) {
1930
1931         # File modification detected: /usr/local/etc/privoxy/user-agent.action
1932         $c =~ s@(?<= detected: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1933
1934     } elsif ($c =~ m/^No logfile configured/ or
1935              $c =~ m/^Malformerd HTTP headers detected and MS IIS5 hack enabled/ or
1936              $c =~ m/^Invalid \"chunked\" transfer/ or
1937              $c =~ m/^Support for/ or
1938              $c =~ m/^Flushing header and buffers/ or
1939              $c =~ m/^Can not resolve/
1940              ) {
1941
1942         # No logfile configured. Please enable it before reporting any problems.
1943         # Malformerd HTTP headers detected and MS IIS5 hack enabled. Expect an invalid \
1944         #  response or even no response at all.
1945         # No logfile configured. Logging disabled.
1946         # Invalid "chunked" transfer encoding detected and ignored.
1947         # Support for 'Connection: keep-alive' is experimental, incomplete and\
1948         #  known not to work properly in some situations.
1949         # Flushing header and buffers. Stepping back from filtering.
1950         # Can not resolve doesnotexist: hostname nor servname provided, or not known
1951
1952     } else {
1953
1954         found_unknown_content($c);
1955
1956     }
1957
1958     return $c;
1959 }
1960
1961 sub handle_loglevel_cgi($) {
1962
1963     my $c = shift;
1964
1965     if ($c =~ m/^Granting access to/) {
1966
1967         #Granting access to http://config.privoxy.org/send-stylesheet, referrer http://p.p/ is trustworthy.
1968
1969     } elsif ($c =~ m/^Substituting: s(.)/) {
1970
1971         # Substituting: s/@else-not-FEATURE_ZLIB@.*@endif-FEATURE_ZLIB@//sigTU
1972         # XXX: prone to span several lines
1973
1974         my $delimiter = $1;
1975         #$c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1976         $c =~ s@(?!<=\\)($delimiter)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g; # XXX: Too aggressive
1977         #$c =~ s@(?!<=\\)($1)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g;
1978     }
1979
1980     return $c;
1981 }
1982
1983 sub handle_loglevel_force($) {
1984
1985     my $c = shift;
1986
1987     if ($c =~ m/^Ignored force prefix in request:/) {
1988
1989         # Ignored force prefix in request: "GET http://10.0.0.1/PRIVOXY-FORCE/block HTTP/1.1"
1990         $c =~ s@^(Ignored)@$h{'ignored'}$1$h{'Standard'}@;
1991         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1992
1993     } elsif ($c =~ m/^Enforcing request:/) {
1994
1995         # Enforcing request: "GET http://10.0.0.1/block HTTP/1.1".
1996         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1997
1998     } else {
1999
2000         found_unknown_content($c);
2001
2002     }
2003
2004     return $c;
2005 }
2006
2007 sub handle_loglevel_error($) {
2008
2009     my $c = shift;
2010
2011     if ($c =~ m/^(?:Empty|No) server or forwarder response received on socket \d+\./) {
2012
2013         # Empty server or forwarder response received on socket 4.
2014         # Empty server or forwarder response received on socket 3. \
2015         #  Closing client socket 15 without sending data.
2016         # Used by Privoxy 3.0.18 and later:
2017         # No server or forwarder response received on socket 8. \
2018         #  Closing client socket 10 without sending data.
2019
2020         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
2021         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
2022
2023     } elsif ($c =~ m/^Didn't receive data in time:/) {
2024
2025         # Didn't receive data in time: a.fsdn.com:443
2026         $c =~ s@(?<=in time: )(.*)@$h{'destination'}$1$h{'Standard'}@;
2027     }
2028
2029     # XXX: There are probably more messages that deserve highlighting.
2030
2031     return $c;
2032 }
2033
2034
2035 sub handle_loglevel_ignore($) {
2036     return shift;
2037 }
2038
2039 sub gather_loglevel_clf_stats($) {
2040
2041     my $content = shift;
2042     my ($method, $resource, $http_version, $status_code, $size);
2043     our %stats;
2044     our %cli_options;
2045
2046     # +0200] "GET https://www.youtube.com/watch?v=JmcA9LIIXWw HTTP/1.1" 200 68004
2047     # +0200] "VERSION-CONTROL http://p.p/ HTTP/1.1" 200 2787
2048     $content =~ m/^[+-]\d{4}\] "([^ ]+) (.+) (HTTP\/\d\.\d)" (\d+) (\d+)/;
2049     $method       = $1;
2050     $resource     = $2;
2051     $http_version = $3;
2052     $status_code  = $4;
2053     $size         = $5;
2054
2055     $stats{requests_clf}++;
2056
2057     unless (defined $method) {
2058         # +0200] "Invalid request" 400 0
2059         return if ($content =~ m/^[+-]\d{4}\] "Invalid request"/);
2060         print("Failed to parse: $content\n");
2061         return;
2062     }
2063     $stats{'method'}{$method}++;
2064     if ($cli_options{'url-statistics-threshold'} != 0) {
2065         $stats{'resource'}{$resource}++;
2066     }
2067     $stats{'http-version'}{$http_version}++;
2068
2069     if ($cli_options{'host-statistics-threshold'} != 0) {
2070         $resource =~ m@(?:https?://)?([^/]+)/?@;
2071         $stats{'hosts'}{$1}++;
2072     }
2073     $stats{'content-size-total'} += $size;
2074     $stats{'status-code'}{$status_code}++;
2075 }
2076
2077 sub gather_loglevel_request_stats($$) {
2078     my $c = shift;
2079     my $thread = shift;
2080     our %stats;
2081
2082     $stats{requests}++;
2083 }
2084
2085 sub gather_loglevel_crunch_stats($$) {
2086     my $c = shift;
2087     my $thread = shift;
2088     our %stats;
2089
2090     $stats{crunches}++;
2091
2092     if ($c =~ m/^Redirected:/) {
2093         # Redirected: http://www.example.org/http://p.p/
2094         $stats{'fast-redirections'}++;
2095
2096     } elsif ($c =~ m/^Blocked:/) {
2097         # Blocked: blogger.googleusercontent.com:443
2098         $stats{'blocked'}++;
2099
2100     } elsif ($c =~ m/^Connection timeout:/) {
2101         # Connection timeout: http://c.tile.openstreetmap.org/18/136116/87842.png
2102         $stats{'connection-timeout'}++;
2103
2104     } elsif ($c =~ m/^Connection failure:/) {
2105         # Connection failure: http://127.0.0.1:8080/
2106         $stats{'connection-failure'}++;
2107     }
2108 }
2109
2110
2111 sub gather_loglevel_error_stats($$) {
2112
2113     my $c = shift;
2114     my $thread = shift;
2115     our %stats;
2116     our %thread_data;
2117
2118     if ($c =~ m/^Empty server or forwarder response received on socket \d+./) {
2119
2120         # Empty server or forwarder response received on socket 4.
2121         $stats{'empty-responses'}++;
2122         if ($thread_data{$thread}{'new_connection'}) {
2123             $stats{'empty-responses-on-new-connections'}++;
2124         } else {
2125             $stats{'empty-responses-on-reused-connections'}++;
2126         }
2127     }
2128 }
2129
2130 sub gather_loglevel_connect_stats($$) {
2131
2132     my ($c, $thread) = @_;
2133     our %thread_data;
2134     our %stats;
2135
2136     if ($c =~ m/^via ([^\s]+) to: [^\s]+/) {
2137
2138         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
2139         $thread_data{$thread}{'forwarder'} = $1; # XXX: is this missue?
2140
2141     } elsif ($c =~ m/^to ([^\s]*)$/) {
2142
2143         # Connect: to lists.sourceforge.net:443
2144
2145         $thread_data{$thread}{'forwarder'} = 'direct connection';
2146
2147     } elsif ($c =~ m/^Created new connection to/) {
2148
2149         # Created new connection to www.privoxy.org:80 on socket 11.
2150
2151         $thread_data{$thread}{'new_connection'} = 1;
2152
2153     } elsif ($c =~ m/^Reusing server socket \d./ or
2154              $c =~ m/^Found reusable socket/) {
2155
2156         # Reusing server socket 4. Opened for 10.0.0.1.
2157         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
2158
2159         $thread_data{$thread}{'new_connection'} = 0;
2160         $stats{'reused-connections'}++;
2161
2162     } elsif ($c =~ m/^Closing client socket \d+. .* Requests received: (\d+)\.$/) {
2163
2164         # Closing client socket 12. Keep-alive: 1. Socket alive: 1. Data available: 0. \
2165         #  Configuration file change detected: 0. Requests received: 14.
2166
2167         $stats{'client-requests-on-connection'}{$1}++;
2168         $stats{'closed-client-connections'}++;
2169     }
2170 }
2171
2172 sub gather_loglevel_header_stats($$) {
2173
2174     my ($c, $thread) = @_;
2175     our %stats;
2176     our %cli_options;
2177
2178     if ($c =~ m/^A HTTP\/1\.1 response without/ or
2179         $c =~ m/^Keeping the server header 'Connection: keep-alive' around./)
2180     {
2181         # A HTTP/1.1 response without Connection header implies keep-alive.
2182         # Keeping the server header 'Connection: keep-alive' around.
2183         $stats{'server-keep-alive'}++;
2184     }
2185 }
2186
2187 sub init_stats() {
2188     our %stats = (
2189         requests => 0,
2190         requests_clf => 0,
2191         crunches => 0,
2192         'server-keep-alive' => 0,
2193         'reused-connections' => 0,
2194         'empty-responses' => 0,
2195         'empty-responses-on-new-connections' => 0,
2196         'empty-responses-on-reused-connections' => 0,
2197         'fast-redirections' => 0,
2198         'blocked' => 0,
2199         'connection-failure' => 0,
2200         'connection-timeout' => 0,
2201         'reused-connections' => 0,
2202         'server-keep-alive' => 0,
2203         'closed-client-connections' => 0,
2204         'content-size-total' => 0,
2205         );
2206         $stats{'client-requests-on-connection'}{1} = 0;
2207 }
2208
2209 sub get_percentage($$) {
2210     my $big = shift;
2211     my $small = shift;
2212
2213     # If small is 0 the percentage is always 0%.
2214     # Make sure it works even if big is 0 as well.
2215     return "0.00%" if ($small eq 0);
2216
2217     # Prevent division by zero.
2218     # XXX: Is this still supposed to be reachable?
2219     return "NaN" if ($big eq 0);
2220
2221     return sprintf("%.2f%%", $small / $big * 100);
2222 }
2223
2224 sub print_stats() {
2225
2226     our %stats;
2227     our %cli_options;
2228     my $new_connections = $stats{requests} - $stats{crunches} - $stats{'reused-connections'};
2229     my $client_requests_checksum = 0;
2230     my $requests_total;
2231
2232     if ($stats{requests_clf} && $stats{requests}
2233         && $stats{requests_clf} != $stats{requests}) {
2234         print "Inconsistent request counts: " . $stats{requests} . "/" . $stats{requests_clf} . "\n";
2235     }
2236
2237     # To get the total number of requests we can use either the number
2238     # of Common-Log-Format lines or the number of "Request:" messages.
2239     # We prefer the number of CLF lines if available because using
2240     # it works when analysing old log files from Privoxy versions before 3.0.29.
2241     # In Privoxy 3.0.28 and earlier "Request:" messages excluded
2242     # crunched messages.
2243     $requests_total = $stats{requests_clf} ? $stats{requests_clf} : $stats{requests};
2244
2245     if ($requests_total eq 0) {
2246         print "No requests yet.\n";
2247         return;
2248     }
2249
2250     print "Client requests total: " . $requests_total . "\n";
2251     if ($stats{crunches}) {
2252         my $outgoing_requests = $requests_total - $stats{crunches};
2253         print "Crunches: " . $stats{crunches} . " (" .
2254             get_percentage($requests_total, $stats{crunches}) . ")\n";
2255         print "Blocks: " . $stats{'blocked'} . " (" .
2256             get_percentage($requests_total, $stats{'blocked'}) . ")\n";
2257         print "Fast redirections: " . $stats{'fast-redirections'} . " (" .
2258             get_percentage($requests_total, $stats{'fast-redirections'}) . ")\n";
2259         print "Connection timeouts: " . $stats{'connection-timeout'} . " (" .
2260             get_percentage($requests_total, $stats{'connection-timeout'}) . ")\n";
2261         print "Connection failures: " . $stats{'connection-failure'} . " (" .
2262             get_percentage($requests_total, $stats{'connection-failure'}) . ")\n";
2263         print "Outgoing requests: " . $outgoing_requests . " (" .
2264             get_percentage($requests_total, $outgoing_requests) . ")\n";
2265     } else {
2266         print "No crunches detected. Is 'debug 1024' enabled?\n";
2267     }
2268
2269     print "Server keep-alive offers: " . $stats{'server-keep-alive'} . " (" .
2270         get_percentage($requests_total, $stats{'server-keep-alive'}) . ")\n";
2271     print "New outgoing connections: " . $new_connections . " (" .
2272         get_percentage($requests_total, $new_connections) . ")\n";
2273     print "Reused connections: " . $stats{'reused-connections'} . " (" .
2274         get_percentage($requests_total, $stats{'reused-connections'}) .
2275         "; server offers accepted: " .
2276         get_percentage($stats{'server-keep-alive'}, $stats{'reused-connections'}) . ")\n";
2277     print "Empty responses: " . $stats{'empty-responses'} . " (" .
2278         get_percentage($requests_total, $stats{'empty-responses'}) . ")\n";
2279     print "Empty responses on new connections: "
2280          . $stats{'empty-responses-on-new-connections'} . " (" .
2281         get_percentage($requests_total, $stats{'empty-responses-on-new-connections'})
2282         . ")\n";
2283     print "Empty responses on reused connections: " .
2284         $stats{'empty-responses-on-reused-connections'} . " (" .
2285         get_percentage($requests_total, $stats{'empty-responses-on-reused-connections'}) .
2286         ")\n";
2287     print "Client connections: " .  $stats{'closed-client-connections'} . "\n";
2288     if ($stats{'content-size-total'}) {
2289         print "Bytes of content transfered to the client: " .  $stats{'content-size-total'} . "\n";
2290     }
2291     my $lines_printed = 0;
2292     print "Client requests per connection distribution:\n";
2293     foreach my $client_requests (sort {
2294         $stats{'client-requests-on-connection'}{$b} <=> $stats{'client-requests-on-connection'}{$a}}
2295                                   keys %{$stats{'client-requests-on-connection'}
2296                                   })
2297     {
2298         my $count = $stats{'client-requests-on-connection'}{$client_requests};
2299         $client_requests_checksum += $count * $client_requests;
2300         if ($cli_options{'show-complete-request-distribution'} or ($lines_printed < 10)) {
2301             printf "%8d: %d\n", $count, $client_requests;
2302             $lines_printed++;
2303         }
2304     }
2305     unless ($cli_options{'show-complete-request-distribution'}) {
2306         printf "Enable --show-complete-request-distribution to get less common numbers as well.\n";
2307     }
2308     # Due to log rotation we may not have a complete picture for all the requests
2309     printf "Improperly accounted requests: ~%d\n", abs($requests_total - $client_requests_checksum);
2310
2311     if (exists $stats{method}) {
2312         print "Method distribution:\n";
2313         foreach my $method (sort {$stats{'method'}{$b} <=> $stats{'method'}{$a}} keys %{$stats{'method'}}) {
2314             printf "%8d : %-8s\n", $stats{'method'}{$method}, $method;
2315         }
2316     } else {
2317         print "Method distribution unknown. No CLF message parsed yet. Is 'debug 512' enabled?\n";
2318     }
2319     if (exists $stats{'http-version'}) {
2320         print "Client HTTP versions:\n";
2321         foreach my $http_version (sort {$stats{'http-version'}{$b} <=> $stats{'http-version'}{$a}} keys %{$stats{'http-version'}}) {
2322             printf "%8d : %-8s\n",  $stats{'http-version'}{$http_version}, $http_version;
2323         }
2324     } else {
2325         print "HTTP version distribution unknown. No CLF message parsed yet. Is 'debug 512' enabled?\n";
2326     }
2327     if (exists $stats{'status-code'}) {
2328         print "HTTP status codes:\n";
2329         foreach my $status_code (sort {$stats{'status-code'}{$b} <=> $stats{'status-code'}{$a}} keys %{$stats{'status-code'}}) {
2330             printf "%8d : %-8d\n",  $stats{'status-code'}{$status_code}, $status_code;
2331         }
2332     } else {
2333         print "Status code distribution unknown. No CLF message parsed yet. Is 'debug 512' enabled?\n";
2334     }
2335
2336     if ($cli_options{'url-statistics-threshold'} == 0) {
2337         print "URL statistics are disabled. Increase --url-statistics-threshold to enable them.\n";
2338     } else {
2339         print "Requested URLs:\n";
2340         foreach my $resource (sort {$stats{'resource'}{$b} <=> $stats{'resource'}{$a}} keys %{$stats{'resource'}}) {
2341             if ($stats{'resource'}{$resource} < $cli_options{'url-statistics-threshold'}) {
2342                 print "Skipped statistics for URLs below the treshold.\n";
2343                 last;
2344             }
2345             printf "%d : %s\n", $stats{'resource'}{$resource}, $resource;
2346         }
2347     }
2348
2349     if ($cli_options{'host-statistics-threshold'} == 0) {
2350         print "Host statistics are disabled. Increase --host-statistics-threshold to enable them.\n";
2351     } else {
2352         print "Requested Hosts:\n";
2353         foreach my $host (sort {$stats{'hosts'}{$b} <=> $stats{'hosts'}{$a}} keys %{$stats{'hosts'}}) {
2354             if ($stats{'hosts'}{$host} < $cli_options{'host-statistics-threshold'}) {
2355                 print "Skipped statistics for Hosts below the treshold.\n";
2356                 last;
2357             }
2358             printf "%d : %s\n", $stats{'hosts'}{$host}, $host;
2359         }
2360     }
2361 }
2362
2363
2364 ################################################################################
2365 # Functions that actually print stuff
2366 ################################################################################
2367
2368 sub print_clf_message() {
2369
2370     our ($ip, $timestamp, $request_line, $status_code, $size);
2371     my $output = '';
2372
2373     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2374
2375     # Rebuild highlighted
2376     $output .= $h{'Number'} . $ip . $h{'Standard'};
2377     $output .= " - - ";
2378     $output .= "[" . $h{'Timestamp'} . $timestamp . $h{'Standard'} . "]";
2379     $output .= " ";
2380     $output .= "\"" . highlight_request_line("$request_line") . "\"";
2381     $output .= " ";
2382     $output .= $h{'Status'} . $status_code . $h{'Standard'};
2383     $output .= " ";
2384     $output .= $h{'Number'} . $size . $h{'Standard'};
2385     $output .= $line_end;
2386
2387     print $output;
2388 }
2389
2390 sub print_non_clf_message($) {
2391
2392     my $content = shift;
2393     my $date_string = $keep_date_mode ? $req{$t}{'day'} . ' ' : '';
2394     my $msec_string = $no_msecs_mode ? '' : '.' . $req{$t}{'msecs'};
2395     my $line_start = $html_output_mode ? '' : $h{"Standard"};
2396
2397     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2398
2399     print $line_start
2400         . $date_string
2401         . $time_colours[$time_colour_index % 2]
2402         . $req{$t}{'time-stamp'}
2403         . $msec_string
2404         . $h{Standard} . " "
2405         . $thread_colours{$t}
2406         . $t
2407         . $h{Standard}
2408         . " "
2409         . $h{$req{$t}{'log-level'}}
2410         . $req{$t}{'log-level'}
2411         . $h{Standard}
2412         . ": "
2413         . $content
2414         . $line_end;
2415 }
2416
2417 sub shorten_thread_id($) {
2418
2419     my $thread_id = shift;
2420
2421     our %short_thread_ids;
2422     our $max_threadid;
2423
2424     unless (defined $short_thread_ids{$thread_id}) {
2425         $short_thread_ids{$thread_id} = sprintf "%.3d", $max_threadid++;
2426     }
2427
2428     return $short_thread_ids{$thread_id}
2429 }
2430
2431 sub parse_loop() {
2432
2433     my ($day, $time_stamp, $thread, $log_level, $content, $c, $msecs);
2434     my $last_msecs  = 0;
2435     my $last_thread = 0;
2436     my $last_timestamp = 0;
2437     my $filters_that_did_nothing;
2438     my $key;
2439     my $time_colour;
2440     $time_colour = paint_it('white');
2441
2442     my %log_level_handlers = (
2443         'Re-Filter'         => \&handle_loglevel_re_filter,
2444         'Header'            => \&handle_loglevel_header,
2445         'Connect'           => \&handle_loglevel_connect,
2446         'Redirect'          => \&handle_loglevel_redirect,
2447         'Request'           => \&handle_loglevel_request,
2448         'Crunch'            => \&handle_loglevel_crunch,
2449         'Gif-Deanimate'     => \&handle_loglevel_gif_deanimate,
2450         'Info'              => \&handle_loglevel_info,
2451         'CGI'               => \&handle_loglevel_cgi,
2452         'Force'             => \&handle_loglevel_force,
2453         'Error'             => \&handle_loglevel_error,
2454         'Fatal error'       => \&handle_loglevel_ignore,
2455         'Writing'           => \&handle_loglevel_ignore,
2456         'Received'          => \&handle_loglevel_ignore,
2457         'Actions'           => \&handle_loglevel_ignore,
2458         'Unknown log level' => \&handle_loglevel_ignore,
2459     );
2460
2461     while (<>) {
2462
2463         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/) {
2464             $thread = $t = ($shorten_thread_ids) ? shorten_thread_id($4) : $4;
2465             $req{$t}{'day'} = $day = $1;
2466             $req{$t}{'time-stamp'} = $time_stamp = $2;
2467             $req{$t}{'msecs'} = $msecs = $3 ? $3 : 0; # Only the cool kids have micro second resolution;
2468             $req{$t}{'log-level'} = $log_level = $5;
2469             $req{$t}{'content'} = $content = $c = $6;
2470             $req{$t}{'log-message'} = $_;
2471             $no_special_header_highlighting = 0;
2472
2473             if (defined($log_level_handlers{$log_level})) {
2474
2475                 $content = $log_level_handlers{$log_level}($content);
2476
2477             } else {
2478
2479                 die "No handler found for log level \"$log_level\"\n";
2480             }
2481
2482             # Highlight Truncations
2483             if (length($_) > 4000) {
2484                 $content =~ s@(too long, truncated)]$@$h{'Truncation'}$1$h{'Standard'}]@g;
2485             }
2486
2487             next unless $content;
2488
2489             # Register threads to keep the colour constant
2490             if (!defined($thread_colours{$thread})) {
2491                 $thread_colours{$thread} = $all_colours[$thread_colour_index % @all_colours];
2492                 $thread_colour_index++;
2493             }
2494
2495             # Switch timestamp colour if timestamps differ
2496             if (($msecs ne $last_msecs) || ($time_stamp ne $last_timestamp)) {
2497                debug_message("Tick tack!") if DEBUG_TICKS;
2498                $time_colour = $time_colours[$time_colour_index % 2];
2499                $time_colour_index++;
2500                $last_msecs = $msecs;
2501                $last_timestamp = $time_stamp;
2502             }
2503
2504             $last_thread = $thread;
2505
2506             print_non_clf_message($content);
2507
2508         } elsif (m/^((?:\d+\.\d+\.\d+\.\d+|[:\d]+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2509
2510             # LOG_LEVEL_CLF lines look like this
2511             # 61.152.239.32 - - [04/Mar/2007:18:28:23 +0100] "GET \
2512             #  http://ad.yieldmanager.com/imp?z=1&Z=120x600&s=109339&u=http%3A%2F%2Fwww.365loan.co.uk%2F&r=1\
2513             #  HTTP/1.1" 403 1730
2514             our ($ip, $timestamp, $request_line, $status_code, $size) = ($1, $2, $3, $4, $5);
2515
2516             print_clf_message();
2517
2518         } else {
2519
2520             # Some Privoxy log messages span more than one line,
2521             # usually to dump lots of content that doesn't need any syntax highlighting.
2522             # XXX: add mechanism to forward these lines to the right handler anyway.
2523             chomp();
2524             unless (DEBUG_SUPPRESS_LOG_MESSAGES or (SUPPRESS_EMPTY_LINES and m/^\s+$/)) {
2525                 print and print get_line_end(); # unless (SUPPRESS_EMPTY_LINES and m/^\s+$/);
2526             }
2527         }
2528     }
2529 }
2530
2531 sub stats_loop() {
2532
2533     my ($day, $time_stamp, $msecs, $thread, $log_level, $content);
2534     my $strict_checks = cli_option_is_set('strict-checks');
2535     my %log_level_handlers = (
2536          'Connect:'           => \&gather_loglevel_connect_stats,
2537          'Crunch:'            => \&gather_loglevel_crunch_stats,
2538          'Error:'             => \&gather_loglevel_error_stats,
2539          'Header:'            => \&gather_loglevel_header_stats,
2540          'Request:'           => \&gather_loglevel_request_stats,
2541     );
2542     my %ignored_log_levels = (
2543          'Actions:'           => \&handle_loglevel_ignore,
2544          'CGI:'               => \&handle_loglevel_ignore,
2545          'Fatal error:'       => \&handle_loglevel_ignore,
2546          'Force:'             => \&handle_loglevel_ignore,
2547          'Gif-Deanimate:'     => \&handle_loglevel_ignore,
2548          'Info:'              => \&handle_loglevel_ignore,
2549          'Re-Filter:'         => \&handle_loglevel_ignore,
2550          'Received:'          => \&handle_loglevel_ignore,
2551          'Redirect:'          => \&handle_loglevel_ignore,
2552          'Unknown log level:' => \&handle_loglevel_ignore,
2553          'Writing:'           => \&handle_loglevel_ignore,
2554     );
2555
2556     while (<>) {
2557         (undef, $time_stamp, $thread, $log_level, $content) = split(/ /, $_, 5);
2558
2559
2560         next if (not defined($log_level));
2561
2562         if ($time_stamp eq "-") {
2563
2564             gather_loglevel_clf_stats($content);
2565
2566         } elsif (defined($log_level_handlers{$log_level})) {
2567
2568             $content = $log_level_handlers{$log_level}($content, $thread);
2569
2570         } elsif ($strict_checks and not defined($ignored_log_levels{$log_level})) {
2571
2572             die "No handler found for: $_";
2573         }
2574     }
2575
2576     print_stats();
2577
2578 }
2579
2580 sub unbreak_lines_only_loop() {
2581     my $log_messages_reached = 0;
2582     while (<>) {
2583         chomp;
2584
2585             # Log level other than LOG_LEVEL_CLF?
2586         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/ or
2587             # LOG_LEVEL_CLF?
2588             m/^((?:\d+\.\d+\.\d+\.\d+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2589             $log_messages_reached = 1;
2590             print "\n";
2591
2592         } else {
2593             # Wrapped message
2594             $_ = "\n". $_  if /^(?:\d+\.\d+\.\d+\.\d+)/;
2595             $_ = " " . $_;
2596         }
2597         s@<BR>$@@;
2598         print;
2599         print "\n" unless $log_messages_reached;
2600     }
2601     print "\n";
2602 }
2603
2604 sub VersionMessage {
2605     my $version_message;
2606
2607     $version_message .= 'Privoxy-Log-Parser ' . PRIVOXY_LOG_PARSER_VERSION  . "\n";
2608     $version_message .= 'https://www.fabiankeil.de/sourcecode/privoxy-log-parser/' . "\n";
2609
2610     print $version_message;
2611 }
2612
2613 sub get_cli_options() {
2614
2615     our %cli_options = (
2616         'html-output'              => CLI_OPTION_DEFAULT_TO_HTML_OUTPUT,
2617         'title'                    => CLI_OPTION_TITLE,
2618         'keep-date'                => CLI_OPTION_KEEP_DATE,
2619         'no-syntax-highlighting'   => CLI_OPTION_NO_SYNTAX_HIGHLIGHTING,
2620         'no-embedded-css'          => CLI_OPTION_NO_EMBEDDED_CSS,
2621         'no-msecs'                 => CLI_OPTION_NO_MSECS,
2622         'shorten-thread-ids'       => CLI_OPTION_SHORTEN_THREAD_IDS,
2623         'show-ineffective-filters' => CLI_OPTION_SHOW_INEFFECTIVE_FILTERS,
2624         'statistics'               => CLI_OPTION_STATISTICS,
2625         'strict-checks'            => CLI_OPTION_STRICT_CHECKS,
2626         'url-statistics-threshold' => CLI_OPTION_URL_STATISTICS_THRESHOLD,
2627         'unbreak-lines-only'       => CLI_OPTION_UNBREAK_LINES_ONLY,
2628         'host-statistics-threshold'=> CLI_OPTION_HOST_STATISTICS_THRESHOLD,
2629         'show-complete-request-distribution' => CLI_OPTION_SHOW_COMPLETE_REQUEST_DISTRIBUTION,
2630     );
2631
2632     GetOptions (
2633         'html-output'              => \$cli_options{'html-output'},
2634         'title'                    => \$cli_options{'title'},
2635         'keep-date'                => \$cli_options{'keep-date'},
2636         'no-syntax-highlighting'   => \$cli_options{'no-syntax-highlighting'},
2637         'no-embedded-css'          => \$cli_options{'no-embedded-css'},
2638         'no-msecs'                 => \$cli_options{'no-msecs'},
2639         'shorten-thread-ids'       => \$cli_options{'shorten-thread-ids'},
2640         'show-ineffective-filters' => \$cli_options{'show-ineffective-filters'},
2641         'statistics'               => \$cli_options{'statistics'},
2642         'strict-checks'            => \$cli_options{'strict-checks'},
2643         'unbreak-lines-only'       => \$cli_options{'unbreak-lines-only'},
2644         'url-statistics-threshold=i'=> \$cli_options{'url-statistics-threshold'},
2645         'host-statistics-threshold=i'=> \$cli_options{'host-statistics-threshold'},
2646         'show-complete-request-distribution' => \$cli_options{'show-complete-request-distribution'},
2647         'version'                  => sub { VersionMessage && exit(0) },
2648         'help'                     => \&help,
2649    ) or exit(1);
2650
2651    $html_output_mode = cli_option_is_set('html-output');
2652    $no_msecs_mode = cli_option_is_set('no-msecs');
2653    $keep_date_mode = cli_option_is_set('keep-date');
2654    $shorten_thread_ids = cli_option_is_set('shorten-thread-ids');
2655    $line_end = get_line_end();
2656 }
2657
2658 sub help() {
2659
2660     our %cli_options;
2661
2662     VersionMessage();
2663
2664     print << "    EOF"
2665
2666 Options and their default values if they have any:
2667     [--host-statistics-threshold $cli_options{'host-statistics-threshold'}]
2668     [--html-output]
2669     [--no-embedded-css]
2670     [--no-msecs]
2671     [--no-syntax-highlighting]
2672     [--shorten-thread-ids]
2673     [--show-ineffective-filters]
2674     [--show-complete-request-distribution]
2675     [--statistics]
2676     [--unbreak-lines-only]
2677     [--url-statistics-threshold $cli_options{'url-statistics-threshold'}]
2678     [--title $cli_options{'title'}]
2679     [--version]
2680 see "perldoc $0" for more information
2681     EOF
2682     ;
2683     exit(0);
2684 }
2685
2686 ################################################################################
2687 # main
2688 ################################################################################
2689 sub main() {
2690
2691     get_cli_options();
2692     set_background(DEFAULT_BACKGROUND);
2693     prepare_our_stuff();
2694
2695     print_intro();
2696
2697     # XXX: should explicitly reject incompatible argument combinations
2698     if (cli_option_is_set('unbreak-lines-only')) {
2699         unbreak_lines_only_loop();
2700     } elsif (cli_option_is_set('statistics')) {
2701         stats_loop();
2702     } else {
2703         parse_loop();
2704     }
2705
2706     print_outro();
2707 }
2708
2709 main();
2710
2711 =head1 NAME
2712
2713 B<privoxy-log-parser> - A parser and syntax-highlighter for Privoxy log messages
2714
2715 =head1 SYNOPSIS
2716
2717 B<privoxy-log-parser> [B<--html-output>]
2718 [B<--no-msecs>] [B<--no-syntax-higlighting>] [B<--statistics>]
2719 [B<--shorten-thread-ids>] [B<--show-ineffective-filters>]
2720 [B<--url-statistics-threshold>] [B<--version>]
2721
2722 =head1 DESCRIPTION
2723
2724 B<privoxy-log-parser> reads Privoxy log messages and
2725
2726 - syntax-highlights recognized lines,
2727
2728 - reformats some of them for easier comprehension,
2729
2730 - filters out less useful messages, and
2731
2732 - (in some cases) calculates additional information,
2733   like the compression ratio or how a filter affected
2734   the content size.
2735
2736 With B<privoxy-log-parser> you should be able to increase Privoxy's log level
2737 without getting confused by the resulting amount of output. For example for
2738 "debug 64" B<privoxy-log-parser> will (by default) only show messages that
2739 affect the content. If a filter doesn't cause any hits, B<privoxy-log-parser>
2740 will hide the "filter foo caused 0 hits" message.
2741
2742 =head1 OPTIONS
2743
2744 [B<--host-statistics-threshold>] Only show the request count for a host
2745 if it's above or equal to the given threshold. If the threshold is 0, host
2746 statistics are disabled.
2747
2748 [B<--html-output>] Use HTML and CSS for the syntax highlighting. If this option is
2749 omitted, ANSI escape sequences are used unless B<--no-syntax-highlighting> is active.
2750 This option is only intended to make embedding log excerpts in web pages easier.
2751 It does not escape any input!
2752
2753 [B<--keep-date>] Don't remove the date when printing highlighted log messages.
2754 Useful when parsing multiple log files at once.
2755
2756 [B<--no-msecs>] Don't expect milisecond resolution
2757
2758 [B<--no-syntax-highlighting>] Disable syntax-highlighting. Useful when
2759 the filtered output is piped into less in which case the ANSI control
2760 codes don't work, or if the terminal itself doesn't support the control
2761 codes.
2762
2763 [B<--shorten-thread-ids>] Shorten the thread ids to a three-digit decimal number.
2764 Note that the mapping from thread ids to shortened ids is created at run-time
2765 and thus varies with the input.
2766
2767 [B<--show-ineffective-filters>] Don't suppress log lines for filters
2768 that didn't modify the content.
2769
2770 [B<--show-complete-request-distribution>] Show the complete client request
2771 distribution in the B<--statistics> output. Without this option only the
2772 ten most common numbers are shown.
2773
2774 [B<--statistics>] Gather various statistics instead of syntax highlighting
2775 log messages. This is an experimental feature, if the results look wrong
2776 they very well might be. Also note that the results are pretty much guaranteed
2777 to be incorrect if Privoxy and Privoxy-Log-Parser aren't in sync.
2778
2779 [B<--strict-checks>] When generating statistics, look more careful at the
2780 input data and abort if it is unexpected, even if it doesn't affect the
2781 results. Significantly slows the parsing down and is not expected to catch
2782 any problems that matter.
2783 When highlighting, print warnings in case of unknown messages which can't be
2784 properly highlighted.
2785
2786 [B<--unbreak-lines-only>] Tries to fix lines that got messed up by a broken or
2787 interestingly configured mail client and thus are no longer recognized properly.
2788 Only fixes some breakage, but may be good enough or at least better than nothing.
2789 Doesn't do anything else, so you probably want to pipe the output into
2790 B<privoxy-log-parser> again.
2791
2792 [B<--url-statistics-threshold>] Only show the request count for a resource
2793 if it's above or equal to the given threshold. If the threshold is 0, URL
2794 statistics are disabled.
2795
2796 [B<--version>] Print version and exit.
2797
2798 =head1 EXAMPLES
2799
2800 To monitor a log file:
2801
2802 tail -F /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log | B<privoxy-log-parser>
2803
2804 Replace '-F' with '-f' if your tail implementation lacks '-F' support
2805 or if the log won't get rotated anyway. The log file location depends
2806 on your system (Doh!).
2807
2808 To monitor Privoxy without having it write to a log file:
2809
2810 privoxy --no-daemon /usr/jails/privoxy-jail/usr/local/etc/privoxy/config 2>&1 | B<privoxy-log-parser>
2811
2812 Again, the config file location depends on your system. Output redirection
2813 depends on your shell, the above works with bourne shells.
2814
2815 To read a processed Privoxy log file from top to bottom, letting the content
2816 scroll by slightly faster than you can read:
2817
2818 B<privoxy-log-parser> < /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log
2819
2820 This is probably only useful to fill screens in the background of haxor movies.
2821
2822 =head1 CAVEATS
2823
2824 Syntax highlighting with ANSI escape sequences will look strange
2825 if your background color isn't black.
2826
2827 Some messages aren't recognized yet and will not be fully highlighted.
2828
2829 B<privoxy-log-parser> is developed with Privoxy 3.0.7 or later in mind,
2830 using earlier Privoxy versions will probably result in an increased amount
2831 of unrecognized log lines.
2832
2833 Privoxy's log files tend to be rather large. If you use HTML
2834 highlighting some browsers can't handle them, get confused and
2835 will eventually crash because of segmentation faults or unexpected
2836 exceptions. This is a problem in the browser and not B<privoxy-log-parser>'s
2837 fault.
2838
2839 =head1 BUGS
2840
2841 Many settings can't be controlled through command line options yet.
2842
2843 =head1 SEE ALSO
2844
2845 privoxy(1)
2846
2847 =head1 AUTHOR
2848
2849 Fabian Keil <fk@fabiankeil.de>
2850
2851 =cut