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