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