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