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