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.122 2011/11/12 12:55:46 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./) {
1535
1536         # Stopped waiting for the request line. Timeout: 121.
1537         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1538
1539     } elsif ($c =~ m/^Waiting for \d/) {
1540
1541         # Waiting for 1 connections to timeout.
1542         $c =~ s@(?<=^Waiting for )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1543
1544     } elsif ($c =~ m/^Initialized/) {
1545
1546         # Initialized 20 socket slots.
1547         $c =~ s@(?<=Initialized )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1548
1549     } elsif ($c =~ m/^Done reading from server/) {
1550
1551         # Done reading from server. Expected content length: 24892. \
1552         #  Actual content length: 24892. Most recently received: 4412.
1553         # 3.0.15 and later:
1554         # Done reading from server. Expected content length: 24892. \
1555         #  Actual content length: 24892. Bytes most recently read: 4412.
1556         # Done reading from server. Content length: 6018 as expected. \
1557         #  Bytes most recently read: 294.
1558         $c =~ s@(?<=ontent length: )(\d+)@$h{'Number'}$1$h{'Standard'}@g;
1559         $c =~ s@(?<=received: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1560         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1561
1562     } elsif ($c =~ m/^Continuing buffering headers/) {
1563
1564         # Continuing buffering headers. byte_count: 19. header_offset: 517. len: 536.
1565         $c =~ s@(?<=byte_count: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1566         $c =~ s@(?<=header_offset: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1567         $c =~ s@(?<=len: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1568         # 3.0.15 and later:
1569         # Continuing buffering headers. Bytes most recently read: %d.
1570         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1571
1572     } elsif ($c =~ m/^Received \d+ bytes while/) {
1573
1574         # Received 206 bytes while expecting 12103.
1575         $c =~ s@(?<=Received )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1576         $c =~ s@(?<=expecting )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1577
1578     } elsif ($c =~ m/^(Rejecting c|C)onnection from/) {
1579
1580         # Connection from 81.163.28.218 dropped due to ACL
1581         # Rejecting connection from 178.63.152.227. Maximum number of connections reached.
1582         $c =~ s@(?<=onnection from )((?:\d+\.?){3}\d+)@$h{'Number'}$1$h{'Standard'}@;
1583
1584     } elsif ($c =~ m/^(?:Reusing|Closing) server socket \d./ or
1585              $c =~ m/^No additional client request/) {
1586
1587         # Reusing server socket 4. Opened for 10.0.0.1.
1588         # Closing server socket 2. Opened for 10.0.0.1.
1589         # No additional client request received in time. \
1590         #  Closing server socket 4, initially opened for 10.0.0.1.
1591         # No additional client request received in time on socket 29.
1592
1593         $c =~ s@(?<= socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1594         $c = highlight_matched_host($c, '(?<=for )[^\s]+(?=\.$)');
1595
1596     } elsif ($c =~ m/^Connected to /) {
1597
1598         # Connected to tor-jail[10.0.0.2]:9050.
1599
1600         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1601         $c = highlight_matched_host($c, '(?<=Connected to )[^\[\s]+');
1602         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1603
1604     } elsif ($c =~ m/^Could not connect to /) {
1605
1606         # Could not connect to [10.0.0.1]:80.
1607
1608         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1609         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1610
1611     } elsif ($c =~ m/^Waiting for the next client request/ or
1612              $c =~ m/^The connection on server socket/ or
1613              $c =~ m/^Client request arrived in time /) {
1614
1615         # Waiting for the next client request on socket 3. Keeping the server \
1616         #  socket 12 to a.fsdn.com open.
1617         # The connection on server socket 6 to upload.wikimedia.org isn't reusable. Closing.
1618         # Used by Privoxy 3.0.18 and later:
1619         # Client request arrived in time on socket 21.
1620         # Used by earlier version:
1621         # Client request arrived in time or the client closed the connection on socket 12.
1622
1623         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1624         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1625         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1626
1627     } elsif ($c =~ m/^Marking the server socket/) {
1628
1629         # Marking the server socket 7 tainted.
1630
1631         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1632
1633     } elsif ($c =~ m/^Reduced expected bytes to /) {
1634
1635         # Reduced expected bytes to 0 to account for the 1542 ones we already got.
1636         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1637         $c =~ s@(?<=for the )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1638
1639     } elsif ($c =~ m/^The client closed socket /) {
1640
1641         # The client closed socket 2 while the server socket 4 is still open.
1642         $c =~ s@(?<=closed socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1643         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1644
1645     } elsif ($c =~ m/^Expected client content length set /) {
1646
1647         # Expected client content length set to 667325411 after reading 4999 bytes.
1648         $c =~ s@(?<=set to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1649         $c =~ s@(?<=reading )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1650
1651     } elsif ($c =~ m/^Reducing expected bytes to /) {
1652
1653         # Reducing expected bytes to 0. Marking the server socket tainted after throwing 4 bytes away.
1654         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1655         $c =~ s@(?<=after throwing )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1656
1657     } elsif ($c =~ m/^Waiting for up to /) {
1658
1659         # Waiting for up to 4999 bytes from the client.
1660         $c =~ s@(?<=up to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1661
1662     } elsif ($c =~ m/^Looks like we / or
1663              $c =~ m/^Unsetting keep-alive flag/ or
1664              $c =~ m/^No connections to wait/ or
1665              $c =~ m/^Complete client request received/ or
1666              $c =~ m/^Possible pipeline attempt detected./ or
1667              $c =~ m/^POST request detected. The connection will not be kept alive./ or
1668              $c =~ m/^The server still wants to talk, but the client hung up on us./ or
1669              $c =~ m/^The server didn't specify how long the connection will stay open/ or
1670              $c =~ m/^There might be a request body. The connection will not be kept alive/ or
1671              $c =~ m/^Stopping to watch the client socket. There's already another request waiting./ or
1672              $c =~ m/^Done reading from the client\.$/) {
1673
1674         # Looks like we reached the end of the last chunk. We better stop reading.
1675         # Looks like we read the end of the last chunk together with the server \
1676         #  headers. We better stop reading.
1677         # Looks like we got the last chunk together with the server headers. \
1678         #  We better stop reading.
1679         # Unsetting keep-alive flag.
1680         # No connections to wait for left.
1681         # Client request arrived in time or the client closed the connection.
1682         # Complete client request received
1683         # Possible pipeline attempt detected. The connection will not be \
1684         #  kept alive and we will only serve the first request.
1685         # POST request detected. The connection will not be kept alive.
1686         # The server still wants to talk, but the client hung up on us.
1687         # The server didn't specify how long the connection will stay open. Assume it's only a second.
1688         # There might be a request body. The connection will not be kept alive.
1689         # Stopping to watch the client socket. There's already another request waiting.
1690         # Done reading from the client\.
1691
1692     } else {
1693
1694         found_unknown_content($c);
1695
1696     }
1697
1698     return $c;
1699 }
1700
1701
1702 sub handle_loglevel_info ($) {
1703
1704     my $c = shift;
1705
1706     if ($c =~ m/^Rewrite detected:/) {
1707
1708         # Rewrite detected: GET http://10.0.0.2:88/blah.txt HTTP/1.1
1709         $c = highlight_matched_request_line($c, '(?<=^Rewrite detected: ).*');
1710
1711     } elsif ($c =~ m/^Decompress(ing deflated|ion didn)/ or
1712              $c =~ m/^Compressed content detected/ or
1713              $c =~ m/^SDCH-compressed content detected/ or
1714              $c =~ m/^Tagger/
1715             ) {
1716         # Decompressing deflated iob: 117
1717         # Decompression didn't result in any content.
1718         # Compressed content detected, content filtering disabled. Consider recompiling Privoxy\
1719         #  with zlib support or enable the prevent-compression action.
1720         # SDCH-compressed content detected, content filtering disabled.\
1721         #  Consider suppressing SDCH offers made by the client.
1722         # Tagger 'complete-url' created empty tag. Ignored.
1723
1724         # Ignored for now
1725
1726     } elsif ($c =~ m/^(Re)?loading configuration file /) {
1727
1728         # loading configuration file '/usr/local/etc/privoxy/config':
1729         # Reloading configuration file '/usr/local/etc/privoxy/config'
1730         $c =~ s@(?<=loading configuration file \')([^\']*)@$h{'file'}$1$h{'Standard'}@;
1731
1732     } elsif ($c =~ m/^Loading (actions|filter) file: /) {
1733
1734         # Loading actions file: /usr/local/etc/privoxy/default.action
1735         # Loading filter file: /usr/local/etc/privoxy/default.filter
1736         $c =~ s@(?<= file: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1737
1738     } elsif ($c =~ m/^exiting by signal/) {
1739
1740         # exiting by signal 15 .. bye
1741         $c =~ s@(?<=exiting by signal )(\d+)@$h{'signal'}$1$h{'Standard'}@;
1742
1743     } elsif ($c =~ m/^Privoxy version/) {
1744
1745         # Privoxy version 3.0.7
1746         $c =~ s@(?<=^Privoxy version )(\d+\.\d+\.\d+)$@$h{'version'}$1$h{'Standard'}@;
1747
1748     } elsif ($c =~ m/^Program name: /) {
1749
1750         # Program name: /usr/local/sbin/privoxy
1751         $c =~ s@(?<=Program name: )(.*)@$h{'program-name'}$1$h{'Standard'}@;
1752
1753     } elsif ($c =~ m/^Listening on port /) {
1754
1755         # Listening on port 8118 on IP address 10.0.0.1
1756         $c =~ s@(?<=Listening on port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1757         $c =~ s@(?<=on IP address )(.*)@$h{'ip-address'}$1$h{'Standard'}@;
1758
1759     } elsif ($c =~ m/^\(Re-\)Open(?:ing)? logfile/) {
1760
1761         # (Re-)Open logfile /var/log/privoxy/privoxy.log
1762         $c =~ s@(?<=Open logfile )(.*)@$h{'file'}$1$h{'Standard'}@;
1763
1764     } elsif ($c =~ m/^(Request from|Malformed server response detected)/) {
1765
1766         # Request from 10.0.0.1 denied. limit-connect{,} doesn't allow CONNECT requests to port 443.
1767         # Request from 10.0.0.1 marked for blocking. limit-connect{,} doesn't allow CONNECT requests to port 443.
1768         # 3.0.18 and later:
1769         # Request from 10.0.0.1 marked for blocking. limit-connect{0} doesn't allow CONNECT requests to www.example.org:443
1770         # Malformed server response detected. Downgrading to HTTP/1.0 impossible.
1771
1772         $c =~ s@(?<=Request from )([^\s]*)@$h{'ip-address'}$1$h{'Standard'}@;
1773         $c =~ s@(denied|blocking)@$h{'warning'}$1$h{'Standard'}@;
1774         $c =~ s@(CONNECT)@$h{'method'}$1$h{'Standard'}@;
1775         $c =~ s@(?<=to port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1776         $c =~ s@(?<=to )([^\s]+)@$h{'request_'}$1$h{'Standard'}@;
1777
1778     } elsif ($c =~ m/^Status code/) {
1779
1780         # Status code 304 implies no body.
1781         $c =~ s@(?<=Status code )(\d+)@$h{'status-code'}$1$h{'Standard'}@;
1782
1783     } elsif ($c =~ m/^Method/) {
1784
1785         # Method HEAD implies no body.
1786         $c =~ s@(?<=Method )([^\s]+)@$h{'method'}$1$h{'Standard'}@;
1787
1788     } elsif ($c =~ m/^Buffer limit reached while extending /) {
1789
1790         # Buffer limit reached while extending the buffer (iob). Needed: 4197470. Limit: 4194304
1791         $c =~ s@(?<=Needed: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1792         $c =~ s@(?<=Limit: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1793
1794     } elsif ($c =~ m/^File modification detected: /) {
1795
1796         # File modification detected: /usr/local/etc/privoxy/user-agent.action
1797         $c =~ s@(?<= detected: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1798
1799     } elsif ($c =~ m/^No logfile configured/ or
1800              $c =~ m/^Malformerd HTTP headers detected and MS IIS5 hack enabled/ or
1801              $c =~ m/^Invalid \"chunked\" transfer/ or
1802              $c =~ m/^Support for/ or
1803              $c =~ m/^Flushing header and buffers/ or
1804              $c =~ m/^Can not resolve/
1805              ) {
1806
1807         # No logfile configured. Please enable it before reporting any problems.
1808         # Malformerd HTTP headers detected and MS IIS5 hack enabled. Expect an invalid \
1809         #  response or even no response at all.
1810         # No logfile configured. Logging disabled.
1811         # Invalid "chunked" transfer encoding detected and ignored.
1812         # Support for 'Connection: keep-alive' is experimental, incomplete and\
1813         #  known not to work properly in some situations.
1814         # Flushing header and buffers. Stepping back from filtering.
1815         # Can not resolve doesnotexist: hostname nor servname provided, or not known
1816
1817     } else {
1818
1819         found_unknown_content($c);
1820
1821     }
1822
1823     return $c;
1824 }
1825
1826 sub handle_loglevel_cgi ($) {
1827
1828     my $c = shift;
1829
1830     if ($c =~ m/^Granting access to/) {
1831
1832         #Granting access to http://config.privoxy.org/send-stylesheet, referrer http://p.p/ is trustworthy.
1833
1834     } elsif ($c =~ m/^Substituting: s(.)/) {
1835
1836         # Substituting: s/@else-not-FEATURE_ZLIB@.*@endif-FEATURE_ZLIB@//sigTU
1837         # XXX: prone to span several lines
1838
1839         my $delimiter = $1;
1840         #$c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1841         $c =~ s@(?!<=\\)($delimiter)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g; # XXX: Too aggressive
1842         #$c =~ s@(?!<=\\)($1)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g;
1843     }
1844
1845     return $c;
1846 }
1847
1848 sub handle_loglevel_force ($) {
1849
1850     my $c = shift;
1851
1852     if ($c =~ m/^Ignored force prefix in request:/) {
1853
1854         # Ignored force prefix in request: "GET http://10.0.0.1/PRIVOXY-FORCE/block HTTP/1.1"
1855         $c =~ s@^(Ignored)@$h{'ignored'}$1$h{'Standard'}@;
1856         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1857
1858     } elsif ($c =~ m/^Enforcing request:/) {
1859
1860         # Enforcing request: "GET http://10.0.0.1/block HTTP/1.1".
1861         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1862
1863     } else {
1864
1865         found_unknown_content($c);
1866
1867     }
1868
1869     return $c;
1870 }
1871
1872 sub handle_loglevel_error ($) {
1873
1874     my $c = shift;
1875
1876     if ($c =~ m/^Empty server or forwarder response received on socket \d+./) {
1877
1878         # Empty server or forwarder response received on socket 4.
1879         # Empty server or forwarder response received on socket 3. \
1880         #  Closing client socket 15 without sending data.
1881         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1882         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1883
1884     } elsif ($c =~ m/^Didn't receive data in time:/) {
1885
1886         # Didn't receive data in time: a.fsdn.com:443
1887         $c =~ s@(?<=in time: )(.*)@$h{'destination'}$1$h{'Standard'}@;
1888     }
1889
1890     # XXX: There are probably more messages that deserve highlighting.
1891
1892     return $c;
1893 }
1894
1895
1896 sub handle_loglevel_ignore ($) {
1897     return shift;
1898 }
1899
1900 sub gather_loglevel_request_stats ($$) {
1901     my $c = shift;
1902     my $thread = shift;
1903     our %stats;
1904
1905     $stats{requests}++;
1906 }
1907
1908 sub gather_loglevel_crunch_stats ($$) {
1909     my $c = shift;
1910     my $thread = shift;
1911     our %stats;
1912
1913     $stats{requests}++;
1914     $stats{crunches}++;
1915
1916     if ($c =~ m/^Redirected:/) {
1917         # Redirected: http://www.example.org/http://p.p/
1918         $stats{'fast-redirections'}++;
1919
1920     } elsif ($c =~ m/^Blocked:/) {
1921         # Blocked: blogger.googleusercontent.com:443
1922         $stats{'blocked'}++;
1923     }
1924 }
1925
1926
1927 sub gather_loglevel_error_stats ($$) {
1928
1929     my $c = shift;
1930     my $thread = shift;
1931     our %stats;
1932     our %thread_data;
1933
1934     if ($c =~ m/^Empty server or forwarder response received on socket \d+./) {
1935
1936         # Empty server or forwarder response received on socket 4.
1937         $stats{'empty-responses'}++;
1938         if ($thread_data{$thread}{'new_connection'}) {
1939             $stats{'empty-responses-on-new-connections'}++;
1940         } else {
1941             $stats{'empty-responses-on-reused-connections'}++;
1942         }
1943     }
1944 }
1945
1946 sub gather_loglevel_connect_stats ($$) {
1947
1948     my ($c, $thread) = @_;
1949     our %thread_data;
1950     our %stats;
1951
1952     if ($c =~ m/^via ([^\s]+) to: [^\s]+/) {
1953
1954         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
1955         $thread_data{$thread}{'forwarder'} = $1; # XXX: is this missue?
1956
1957     } elsif ($c =~ m/^to ([^\s]*)$/) {
1958
1959         # Connect: to lists.sourceforge.net:443
1960
1961         $thread_data{$thread}{'forwarder'} = 'direct connection';
1962
1963     } elsif ($c =~ m/^Created new connection to/) {
1964
1965         # Created new connection to www.privoxy.org:80 on socket 11.
1966
1967         $thread_data{$thread}{'new_connection'} = 1;
1968
1969     } elsif ($c =~ m/^Reusing server socket \d./ or
1970              $c =~ m/^Found reusable socket/) {
1971
1972         # Reusing server socket 4. Opened for 10.0.0.1.
1973         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
1974
1975         $thread_data{$thread}{'new_connection'} = 0;
1976         $stats{'reused-connections'}++;
1977     }
1978 }
1979
1980 sub gather_loglevel_header_stats ($$) {
1981
1982     my ($c, $thread) = @_;
1983     our %stats;
1984
1985     if ($c =~ m/^A HTTP\/1\.1 response without/ or
1986         $c =~ m/^Keeping the server header 'Connection: keep-alive' around./)
1987     {
1988         # A HTTP/1.1 response without Connection header implies keep-alive.
1989         # Keeping the server header 'Connection: keep-alive' around.
1990         $stats{'server-keep-alive'}++;
1991
1992     } elsif ($c =~ m/^scan: ((\w+) (.+) (HTTP\/\d\.\d))/) {
1993
1994         # scan: HTTP/1.1 200 OK
1995         $stats{'method'}{$2}++;
1996         $stats{'ressource'}{$3}++;
1997         $stats{'http-version'}{$4}++;
1998
1999     } elsif ($c =~ m/^scan: Host: ([^\s]+)/) {
2000
2001         # scan: Host: p.p
2002         $stats{'hosts'}{$1}++;
2003     }
2004 }
2005
2006 sub init_stats () {
2007     our %stats = (
2008         requests => 0,
2009         crunches => 0,
2010         'server-keep-alive' => 0,
2011         'reused-connections' => 0,
2012         'empty-responses' => 0,
2013         'empty-responses-on-new-connections' => 0,
2014         'empty-responses-on-reused-connections' => 0,
2015         'fast-redirections' => 0,
2016         'blocked' => 0,
2017         'reused-connections' => 0,
2018         'server-keep-alive' => 0,
2019         );
2020 }
2021
2022 sub get_percentage ($$) {
2023     my $big = shift;
2024     my $small = shift;
2025     return "NaN" if ($big eq 0);
2026     return sprintf("%.2f%%", $small / $big * 100);
2027 }
2028
2029 sub print_stats () {
2030
2031     our %stats;
2032     our %cli_options;
2033     my $new_connections = $stats{requests} - $stats{crunches} - $stats{'reused-connections'};
2034     my $outgoing_requests = $stats{requests} - $stats{crunches};
2035
2036     if ($stats{requests} eq 0) {
2037         print "No requests yet.\n";
2038         return;
2039     }
2040
2041     print "Client requests total: " . $stats{requests} . "\n";
2042     print "Crunches: " . $stats{crunches} . " (" .
2043         get_percentage($stats{requests}, $stats{crunches}) . ")\n";
2044     print "Blocks: " . $stats{'blocked'} . " (" .
2045         get_percentage($stats{requests}, $stats{'blocked'}) . ")\n";
2046     print "Fast redirections: " . $stats{'fast-redirections'} . " (" .
2047         get_percentage($stats{requests}, $stats{'fast-redirections'}) . ")\n";
2048     print "Outgoing requests: " . $outgoing_requests . " (" .
2049         get_percentage($stats{requests}, $outgoing_requests) . ")\n";
2050     print "Server keep-alive offers: " . $stats{'server-keep-alive'} . " (" .
2051         get_percentage($stats{requests}, $stats{'server-keep-alive'}) . ")\n";
2052     print "New outgoing connections: " . $new_connections . " (" .
2053         get_percentage($stats{requests}, $new_connections) . ")\n";
2054     print "Reused connections: " . $stats{'reused-connections'} . " (" .
2055         get_percentage($stats{requests}, $stats{'reused-connections'}) .
2056         "; server offers accepted: " .
2057         get_percentage($stats{'server-keep-alive'}, $stats{'reused-connections'}) . ")\n";
2058     print "Empty responses: " . $stats{'empty-responses'} . " (" .
2059         get_percentage($stats{requests}, $stats{'empty-responses'}) . ")\n";
2060     print "Empty responses on new connections: "
2061          . $stats{'empty-responses-on-new-connections'} . " (" .
2062         get_percentage($stats{requests}, $stats{'empty-responses-on-new-connections'})
2063         . ")\n";
2064     print "Empty responses on reused connections: " .
2065         $stats{'empty-responses-on-reused-connections'} . " (" .
2066         get_percentage($stats{requests}, $stats{'empty-responses-on-reused-connections'}) .
2067         ")\n";
2068
2069     if ($stats{method} eq 0) {
2070         print "No response lines parsed yet yet.\n";
2071         return;
2072     }
2073     print "Method distribution:\n";
2074     foreach my $method (sort {$stats{'method'}{$b} <=> $stats{'method'}{$a}} keys %{$stats{'method'}}) {
2075         printf "%8d : %-8s\n", $stats{'method'}{$method}, $method;
2076     }
2077     print "Client HTTP versions:\n";
2078     foreach my $http_version (sort {$stats{'http-version'}{$b} <=> $stats{'http-version'}{$a}} keys %{$stats{'http-version'}}) {
2079         printf "%d : %s\n",  $stats{'http-version'}{$http_version}, $http_version;
2080     }
2081
2082     if ($cli_options{'url-statistics-threshold'} == 0) {
2083         print "URL statistics are disabled. Increase --url-statistics-threshold to enable them.\n";
2084     } else {
2085         print "Requested URLs:\n";
2086         foreach my $ressource (sort {$stats{'ressource'}{$b} <=> $stats{'ressource'}{$a}} keys %{$stats{'ressource'}}) {
2087             if ($stats{'ressource'}{$ressource} < $cli_options{'url-statistics-threshold'}) {
2088                 print "Skipped statistics for URLs below the treshold.\n";
2089                 last;
2090             }
2091             printf "%d : %s\n", $stats{'ressource'}{$ressource}, $ressource;
2092         }
2093     }
2094
2095     if ($cli_options{'host-statistics-threshold'} == 0) {
2096         print "Host statistics are disabled. Increase --host-statistics-threshold to enable them.\n";
2097     } else {
2098         print "Requested Hosts:\n";
2099         foreach my $host (sort {$stats{'hosts'}{$b} <=> $stats{'hosts'}{$a}} keys %{$stats{'hosts'}}) {
2100             if ($stats{'hosts'}{$host} < $cli_options{'host-statistics-threshold'}) {
2101                 print "Skipped statistics for Hosts below the treshold.\n";
2102                 last;
2103             }
2104             printf "%d : %s\n", $stats{'hosts'}{$host}, $host;
2105         }
2106     }
2107 }
2108
2109
2110 ################################################################################
2111 # Functions that actually print stuff
2112 ################################################################################
2113
2114 sub print_clf_message () {
2115
2116     our ($ip, $timestamp, $request_line, $status_code, $size);
2117     my $output = '';
2118
2119     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2120
2121     # Rebuild highlighted
2122     $output .= $h{'Number'} . $ip . $h{'Standard'};
2123     $output .= " - - ";
2124     $output .= "[" . $h{'Timestamp'} . $timestamp . $h{'Standard'} . "]";
2125     $output .= " ";
2126     $output .= "\"" . highlight_request_line("$request_line") . "\"";
2127     $output .= " ";
2128     $output .= $h{'Status'} . $status_code . $h{'Standard'};
2129     $output .= " ";
2130     $output .= $h{'Number'} . $size . $h{'Standard'};
2131     $output .= $line_end;
2132
2133     print $output;
2134 }
2135
2136 sub print_non_clf_message ($) {
2137
2138     my $content = shift;
2139     my $msec_string = "." . $req{$t}{'msecs'} unless $no_msecs_mode;
2140     my $line_start = $html_output_mode ? '' : $h{"Standard"};
2141
2142     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2143
2144     print $line_start
2145         . $time_colours[$time_colour_index % 2]
2146         . $req{$t}{'time-stamp'}
2147         . $msec_string
2148         . $h{Standard} . " "
2149         . $thread_colours{$t}
2150         . $t
2151         . $h{Standard}
2152         . " "
2153         . $h{$req{$t}{'log-level'}}
2154         . $req{$t}{'log-level'}
2155         . $h{Standard}
2156         . ": "
2157         . $content
2158         . $line_end;
2159 }
2160
2161 sub shorten_thread_id ($) {
2162
2163     my $thread_id = shift;
2164
2165     our %short_thread_ids;
2166     our $max_threadid;
2167
2168     unless (defined $short_thread_ids{$thread_id}) {
2169         $short_thread_ids{$thread_id} = sprintf "%.3d", $max_threadid++;
2170     }
2171
2172     return $short_thread_ids{$thread_id}
2173 }
2174
2175 sub parse_loop () {
2176
2177     my ($day, $time_stamp, $thread, $log_level, $content, $c, $msecs);
2178     my $last_msecs  = 0;
2179     my $last_thread = 0;
2180     my $last_timestamp = 0;
2181     my $filters_that_did_nothing;
2182     my $key;
2183     my $time_colour;
2184     $time_colour = paint_it('white');
2185
2186     my %log_level_handlers = (
2187         'Re-Filter'         => \&handle_loglevel_re_filter,
2188         'Header'            => \&handle_loglevel_header,
2189         'Connect'           => \&handle_loglevel_connect,
2190         'Redirect'          => \&handle_loglevel_redirect,
2191         'Request'           => \&handle_loglevel_request,
2192         'Crunch'            => \&handle_loglevel_crunch,
2193         'Gif-Deanimate'     => \&handle_loglevel_gif_deanimate,
2194         'Info'              => \&handle_loglevel_info,
2195         'CGI'               => \&handle_loglevel_cgi,
2196         'Force'             => \&handle_loglevel_force,
2197         'Error'             => \&handle_loglevel_error,
2198         'Fatal error'       => \&handle_loglevel_ignore,
2199         'Writing'           => \&handle_loglevel_ignore,
2200         'Received'          => \&handle_loglevel_ignore,
2201         'Unknown log level' => \&handle_loglevel_ignore,
2202     );
2203
2204     while (<>) {
2205
2206         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/) {
2207             $thread = $t = ($shorten_thread_ids) ? shorten_thread_id($4) : $4;
2208             $req{$t}{'day'} = $day = $1;
2209             $req{$t}{'time-stamp'} = $time_stamp = $2;
2210             $req{$t}{'msecs'} = $msecs = $3 ? $3 : 0; # Only the cool kids have micro second resolution;
2211             $req{$t}{'log-level'} = $log_level = $5;
2212             $req{$t}{'content'} = $content = $c = $6;
2213             $req{$t}{'log-message'} = $_;
2214             $no_special_header_highlighting = 0;
2215
2216             if (defined($log_level_handlers{$log_level})) {
2217
2218                 $content = $log_level_handlers{$log_level}($content);
2219
2220             } else {
2221
2222                 die "No handler found for log level \"$log_level\"\n";
2223             }
2224
2225             # Highlight Truncations
2226             if (length($_) > 4000) {
2227                 $content =~ s@(too long, truncated)]$@$h{'Truncation'}$1$h{'Standard'}]@g;
2228             }
2229
2230             next unless $content;
2231
2232             # Register threads to keep the colour constant
2233             if (!defined($thread_colours{$thread})) {
2234                 $thread_colours{$thread} = $all_colours[$thread_colour_index % @all_colours];
2235                 $thread_colour_index++;
2236             }
2237
2238             # Switch timestamp colour if timestamps differ
2239             if (($msecs ne $last_msecs) || ($time_stamp ne $last_timestamp)) {
2240                debug_message("Tick tack!") if DEBUG_TICKS;
2241                $time_colour = $time_colours[$time_colour_index % 2];
2242                $time_colour_index++;
2243                $last_msecs = $msecs;
2244                $last_timestamp = $time_stamp;
2245             }
2246
2247             $last_thread = $thread;
2248
2249             print_non_clf_message($content);
2250
2251         } elsif (m/^((?:\d+\.\d+\.\d+\.\d+|[:\d]+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2252
2253             # LOG_LEVEL_CLF lines look like this
2254             # 61.152.239.32 - - [04/Mar/2007:18:28:23 +0100] "GET \
2255             #  http://ad.yieldmanager.com/imp?z=1&Z=120x600&s=109339&u=http%3A%2F%2Fwww.365loan.co.uk%2F&r=1\
2256             #  HTTP/1.1" 403 1730
2257             our ($ip, $timestamp, $request_line, $status_code, $size) = ($1, $2, $3, $4, $5);
2258
2259             print_clf_message();
2260
2261         } else {
2262
2263             # Some Privoxy log messages span more than one line,
2264             # usually to dump lots of content that doesn't need any syntax highlighting.
2265             # XXX: add mechanism to forward these lines to the right handler anyway.
2266             chomp();
2267             unless (DEBUG_SUPPRESS_LOG_MESSAGES or (SUPPRESS_EMPTY_LINES and m/^\s+$/)) {
2268                 print and print get_line_end(); # unless (SUPPRESS_EMPTY_LINES and m/^\s+$/);
2269             }
2270         }
2271     }
2272 }
2273
2274 sub stats_loop () {
2275
2276     my ($day, $time_stamp, $msecs, $thread, $log_level, $content);
2277     my %log_level_handlers = (
2278          'Re-Filter'         => \&handle_loglevel_ignore,
2279          'Header'            => \&gather_loglevel_header_stats,
2280          'Connect'           => \&gather_loglevel_connect_stats,
2281          'Redirect'          => \&handle_loglevel_ignore,
2282          'Request'           => \&gather_loglevel_request_stats,
2283          'Crunch'            => \&gather_loglevel_crunch_stats,
2284          'Gif-Deanimate'     => \&handle_loglevel_ignore,
2285          'Info'              => \&handle_loglevel_ignore,
2286          'CGI'               => \&handle_loglevel_ignore,
2287          'Force'             => \&handle_loglevel_ignore,
2288          'Error'             => \&gather_loglevel_error_stats,
2289          'Fatal error'       => \&handle_loglevel_ignore,
2290          'Writing'           => \&handle_loglevel_ignore,
2291          'Received'          => \&handle_loglevel_ignore,
2292          'Unknown log level' => \&handle_loglevel_ignore
2293     );
2294
2295     while (<>) {
2296         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/) {
2297             $day = $1;
2298             $time_stamp = $2;
2299             $msecs = $3 ? $3 : 0;
2300             $thread = $4;
2301             $log_level = $5;
2302             $content = $6;
2303
2304             if (defined($log_level_handlers{$log_level})) {
2305
2306                 $content = $log_level_handlers{$log_level}($content, $thread);
2307
2308             } else {
2309
2310                 die "No handler found for log level \"$log_level\"\n";
2311
2312             }
2313         }
2314     }
2315
2316     print_stats();
2317
2318 }
2319
2320 sub unbreak_lines_only_loop() {
2321     my $log_messages_reached = 0;
2322     while (<>) {
2323         chomp;
2324
2325             # Log level other than LOG_LEVEL_CLF?
2326         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/ or
2327             # LOG_LEVEL_CLF?
2328             m/^((?:\d+\.\d+\.\d+\.\d+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2329             $log_messages_reached = 1;
2330             print "\n";
2331
2332         } else {
2333             # Wrapped message
2334             $_ = "\n". $_  if /^(?:\d+\.\d+\.\d+\.\d+)/;
2335             $_ = " " . $_;
2336         }
2337         s@<BR>$@@;
2338         print;
2339         print "\n" unless $log_messages_reached;
2340     }
2341     print "\n";
2342 }
2343
2344 sub VersionMessage {
2345     my $version_message;
2346
2347     $version_message .= 'Privoxy-Log-Parser ' . PRIVOXY_LOG_PARSER_VERSION  . "\n";
2348     $version_message .= 'Copyright (C) 2007-2010 Fabian Keil <fk@fabiankeil.de>' . "\n";
2349     $version_message .= 'http://www.fabiankeil.de/sourcecode/privoxy-log-parser/' . "\n";
2350
2351     print $version_message;
2352 }
2353
2354 sub get_cli_options () {
2355
2356     our %cli_options = (
2357         'html-output'              => CLI_OPTION_DEFAULT_TO_HTML_OUTPUT,
2358         'title'                    => CLI_OPTION_TITLE,
2359         'no-syntax-highlighting'   => CLI_OPTION_NO_SYNTAX_HIGHLIGHTING,
2360         'no-embedded-css'          => CLI_OPTION_NO_EMBEDDED_CSS,
2361         'no-msecs'                 => CLI_OPTION_NO_MSECS,
2362         'shorten-thread-ids'       => CLI_OPTION_SHORTEN_THREAD_IDS,
2363         'show-ineffective-filters' => CLI_OPTION_SHOW_INEFFECTIVE_FILTERS,
2364         'accept-unknown-messages'  => CLI_OPTION_ACCEPT_UNKNOWN_MESSAGES,
2365         'statistics'               => CLI_OPTION_STATISTICS,
2366         'url-statistics-threshold' => CLI_OPTION_URL_STATISTICS_THRESHOLD,
2367         'unbreak-lines-only'       => CLI_OPTION_UNBREAK_LINES_ONLY,
2368         'host-statistics-threshold'=> CLI_OPTION_HOST_STATISTICS_THRESHOLD,
2369     );
2370
2371     GetOptions (
2372         'html-output'              => \$cli_options{'html-output'},
2373         'title'                    => \$cli_options{'title'},
2374         'no-syntax-highlighting'   => \$cli_options{'no-syntax-highlighting'},
2375         'no-embedded-css'          => \$cli_options{'no-embedded-css'},
2376         'no-msecs'                 => \$cli_options{'no-msecs'},
2377         'shorten-thread-ids'       => \$cli_options{'shorten-thread-ids'},
2378         'show-ineffective-filters' => \$cli_options{'show-ineffective-filters'},
2379         'accept-unknown-messages'  => \$cli_options{'accept-unknown-messages'},
2380         'statistics'               => \$cli_options{'statistics'},
2381         'unbreak-lines-only'       => \$cli_options{'unbreak-lines-only'},
2382         'url-statistics-threshold=i'=> \$cli_options{'url-statistics-threshold'},
2383         'host-statistics-threshold=i'=> \$cli_options{'host-statistics-threshold'},
2384         'version'                  => sub { VersionMessage && exit(0) },
2385         'help'                     => \&help,
2386    ) or exit(1);
2387
2388    $html_output_mode = cli_option_is_set('html-output');
2389    $no_msecs_mode = cli_option_is_set('no-msecs');
2390    $shorten_thread_ids = cli_option_is_set('shorten-thread-ids');
2391    $line_end = get_line_end();
2392 }
2393
2394 sub help () {
2395
2396     our %cli_options;
2397
2398     VersionMessage();
2399
2400     print << "    EOF"
2401
2402 Options and their default values if they have any:
2403     [--accept-unknown-messages]
2404     [--host-statistics-threshold $cli_options{'host-statistics-threshold'}]
2405     [--html-output]
2406     [--no-embedded-css]
2407     [--no-msecs]
2408     [--no-syntax-highlighting]
2409     [--shorten-thread-ids]
2410     [--show-ineffective-filters]
2411     [--statistics]
2412     [--unbreak-lines-only]
2413     [--url-statistics-threshold $cli_options{'url-statistics-threshold'}]
2414     [--title $cli_options{'title'}]
2415     [--version]
2416 see "perldoc $0" for more information
2417     EOF
2418     ;
2419     exit(0);
2420 }
2421
2422 ################################################################################
2423 # main
2424 ################################################################################
2425 sub main () {
2426
2427     get_cli_options();
2428     set_background(DEFAULT_BACKGROUND);
2429     prepare_our_stuff();
2430
2431     print_intro();
2432
2433     # XXX: should explicitly reject incompatible argument combinations
2434     if (cli_option_is_set('unbreak-lines-only')) {
2435         unbreak_lines_only_loop();
2436     } elsif (cli_option_is_set('statistics')) {
2437         stats_loop();
2438     } else {
2439         parse_loop();
2440     }
2441
2442     print_outro();
2443 }
2444
2445 main();
2446
2447 =head1 NAME
2448
2449 B<privoxy-log-parser> - A parser and syntax-highlighter for Privoxy log messages
2450
2451 =head1 SYNOPSIS
2452
2453 B<privoxy-log-parser> [B<--accept-unknown-messages>] [B<--html-output>]
2454 [B<--no-msecs>] [B<--no-syntax-higlighting>] [B<--statistics>]
2455 [B<--shorten-thread-ids>] [B<--show-ineffective-filters>]
2456 [B<--url-statistics-threshold>] [B<--version>]
2457
2458 =head1 DESCRIPTION
2459
2460 B<privoxy-log-parser> reads Privoxy log messages and
2461
2462 - syntax-highlights recognized lines,
2463
2464 - reformats some of them for easier comprehension,
2465
2466 - filters out less useful messages, and
2467
2468 - (in some cases) calculates additional information,
2469   like the compression ratio or how a filter affected
2470   the content size.
2471
2472 With B<privoxy-log-parser> you should be able to increase Privoxy's log level
2473 without getting confused by the resulting amount of output. For example for
2474 "debug 64" B<privoxy-log-parser> will (by default) only show messages that
2475 affect the content. If a filter doesn't cause any hits, B<privoxy-log-parser>
2476 will hide the "filter foo caused 0 hits" message.
2477
2478 =head1 OPTIONS
2479
2480 [B<--accept-unknown-messages>] Don't print warnings in case of unknown messages,
2481 just don't highlight them.
2482
2483 [B<--host-statistics-threshold>] Only show the request count for a host
2484 if it's above or equal to the given threshold. If the threshold is 0, host
2485 statistics are disabled.
2486
2487 [B<--html-output>] Use HTML and CSS for the syntax highlighting. If this option is
2488 omitted, ANSI escape sequences are used unless B<--no-syntax-highlighting> is active.
2489 This option is only intended to make embedding log excerpts in web pages easier.
2490 It does not escape any input!
2491
2492 [B<--no-msecs>] Don't expect milisecond resolution
2493
2494 [B<--no-syntax-highlighting>] Disable syntax-highlighting. Useful when
2495 the filtered output is piped into less in which case the ANSI control
2496 codes don't work, or if the terminal itself doesn't support the control
2497 codes.
2498
2499 [B<--shorten-thread-ids>] Shorten the thread ids to a three-digit decimal number.
2500 Note that the mapping from thread ids to shortened ids is created at run-time
2501 and thus varies with the input.
2502
2503 [B<--show-ineffective-filters>] Don't suppress log lines for filters
2504 that didn't modify the content.
2505
2506 [B<--statistics>] Gather various statistics instead of syntax highlighting
2507 log messages. This is an experimental feature, if the results look wrong
2508 they very well might be. Also note that the results are pretty much guaranteed
2509 to be incorrect if Privoxy and Privoxy-Log-Parser aren't in sync.
2510
2511 [B<--unbreak-lines-only>] Tries to fix lines that got messed up by a broken or
2512 interestingly configured mail client and thus are no longer recognized properly.
2513 Only fixes some breakage, but may be good enough or at least better than nothing.
2514 Doesn't do anything else, so you probably want to pipe the output into
2515 B<privoxy-log-parser> again.
2516
2517 [B<--url-statistics-threshold>] Only show the request count for a ressource
2518 if it's above or equal to the given threshold. If the threshold is 0, URL
2519 statistics are disabled.
2520
2521 [B<--version>] Print version and exit.
2522
2523 =head1 EXAMPLES
2524
2525 To monitor a log file:
2526
2527 tail -F /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log | B<privoxy-log-parser>
2528
2529 Replace '-F' with '-f' if your tail implementation lacks '-F' support
2530 or if the log won't get rotated anyway. The log file location depends
2531 on your system (Doh!).
2532
2533 To monitor Privoxy without having it write to a log file:
2534
2535 privoxy --no-daemon /usr/jails/privoxy-jail/usr/local/etc/privoxy/config 2>&1 | B<privoxy-log-parser>
2536
2537 Again, the config file location depends on your system. Output redirection
2538 depends on your shell, the above works with bourne shells.
2539
2540 To read a processed Privoxy log file from top to bottom, letting the content
2541 scroll by slightly faster than you can read:
2542
2543 B<privoxy-log-parser> < /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log
2544
2545 This is probably only useful to fill screens in the background of haxor movies.
2546
2547 =head1 CAVEATS
2548
2549 Syntax highlighting with ANSI escape sequences will look strange
2550 if your background color isn't black.
2551
2552 Some messages aren't recognized yet and will not be fully highlighted.
2553
2554 B<privoxy-log-parser> is developed with Privoxy 3.0.7 or later in mind,
2555 using earlier Privoxy versions will probably result in an increased amount
2556 of unrecognized log lines.
2557
2558 Privoxy's log files tend to be rather large. If you use HTML
2559 highlighting some browsers can't handle them, get confused and
2560 will eventually crash because of segmentation faults or unexpected
2561 exceptions. This is a problem in the browser and not B<privoxy-log-parser>'s
2562 fault.
2563
2564 =head1 BUGS
2565
2566 Many settings can't be controlled through command line options yet.
2567
2568 =head1 SEE ALSO
2569
2570 privoxy(1)
2571
2572 =head1 AUTHOR
2573
2574 Fabian Keil <fk@fabiankeil.de>
2575
2576 =cut