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