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