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