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