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.138 2012/09/04 08:40:25 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_GIF_NOT_CHANGED => 1,
  74     SUPPRESS_NEED_TO_DE_CHUNK_FIRST => 1,
  75
  76     DEBUG_HEADER_REGISTERING => 0,
  77     DEBUG_HEADER_HIGHLIGHTING => 0,
  78     DEBUG_TICKS => 0,
  79     DEBUG_PAINT_IT => 0,
  80     DEBUG_SUPPRESS_LOG_MESSAGES => 0,
  81
  82     PUNISH_MISSING_LOG_KNOWLEDGE_WITH_DEATH => 0,
  83     PUNISH_MISSING_HIGHLIGHT_KNOWLEDGE_WITH_DEATH => 1,
  84
  85     LOG_UNPARSED_LINES_TO_EXTRA_FILE => 0,
  86     ERROR_LOG_FILE => '/var/log/privoxy-log-parser',
  87
  88     # You better leave these alone unless you know what you're doing.
  89     COLOUR_RESET      => "\033[0;0m",
  90     ESCAPE => "\033[",
  91 };
  92
  93 # For performance reasons, these are global.
  94
  95 my $t;
  96 my %req; # request data from previous lines
  97 my %h;
  98 my %thread_colours;
  99 my @all_colours;
 100 my @time_colours;
 101 my $thread_colour_index = 0;
 102 my $header_colour_index = 0;
 103 my $time_colour_index = 0;
 104 my %header_colours;
 105 my $no_special_header_highlighting;
 106 my %reason_colours;
 107 my %h_colours;
 108 my $header_highlight_regex = '';
 109
 110 my $html_output_mode;
 111 my $no_msecs_mode; # XXX: should probably be removed
 112 my $shorten_thread_ids;
 113 my $line_end;
 114
 115 sub prepare_our_stuff () {
 116
 117     # Syntax Higlight hash
 118     @all_colours = (
 119         'red', 'green', 'brown', 'blue', 'purple', 'cyan',
 120         'light_gray', 'light_red', 'light_green', 'yellow',
 121         'light_blue', 'pink', 'light_cyan', 'white'
 122     );
 123
 124     %h = (
 125         # LOG_LEVEL
 126         Info            => 'blue',
 127         Header          => 'green',
 128         Filter          => 'purple', # XXX: Used?
 129         'Re-Filter'     => 'purple',
 130         Connect         => 'brown',
 131         Request         => 'light_cyan',
 132         CGI             => 'light_green',
 133         Redirect        => 'cyan',
 134         Error           => 'light_red',
 135         Crunch          => 'cyan',
 136         'Fatal error'   => 'light_red',
 137         'Gif-Deanimate' => 'blue',
 138         Force           => 'red',
 139         Writing         => 'light_green',
 140         Received        => 'yellow',
 141         Actions         => '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           or $c =~ m/^Enlisting (?:sorted|left-over) header/
 918             )
 919     {
 920         # XXX: Some of these may need highlighting
 921
 922         # Modified: User-Agent: Mozilla/5.0 (X11; U; SunOS i86pc; pl-PL; rv:1.8.1.1) Gecko/20070214 Firefox/2.0.0.1
 923         # Accept-Language header crunched and replaced with: Accept-Language: pl-pl
 924         # cookie 'Set-Cookie: eZSessionCookie=07bfec287c197440d299f81580593c3d; \
 925         #  expires=Thursday, 12-Apr-07 15:16:18 GMT; path=/' send by \
 926         #  http://wirres.net/article/articleview/4265/1/6/ appears to be using time format 1 (XXX: gone with the wind)
 927         # Cookie rewritten to a temporary one: Set-Cookie: NSC_gffe-iuuq-mc-wtfswfs=8efb33a53660;path=/
 928         # Text mode is already enabled
 929         # Denied request with NULL byte(s) turned into line break(s)
 930         # Replaced: 'Connection: Yo, home to Bel Air' with 'Connection: close'
 931         # addh-unique: Host: people.freebsd.org
 932         # Suppressed offer to compress content
 933         # Crunched incoming cookie -- yum!
 934         # Accepted the client's request to fetch without filtering.
 935         # Crunched outgoing cookie: Cookie: PREF=ID=6cf0abd347b30262:TM=1173357617:LM=1173357617:S=jZypyyJ7LPiwFi1_
 936         # addh-unique: Host: subkeys.pgp.net:11371
 937         # Referer forged to: Referer: http://10.0.0.1/
 938         # Downgraded answer to HTTP/1.0
 939         # Parameter: +hide-referrer{pille-palle} is a bad idea, but I don't care.
 940         # Referer overwritten with: Referer: pille-palle
 941         # Referer replaced with: Referer: pille-palle
 942         # crunched x-forwarded-for!
 943         # crunched From!
 944         #  modified # XXX: pretty stupid log message
 945         # Content filtering is enabled. Crunching: 'Range: 1234-5678' to prevent range-mismatch problems
 946         # force-text-mode overruled the client's request to fetch without filtering!
 947         # Server time in the future.
 948         # content-disposition header crunched and replaced with: content-disposition: filename=baz
 949         # Content-Disposition header crunched and replaced with: content-disposition: filename=baz
 950         # Reducing white space in 'X-LWS-Test: "This  is  quoted" this is not "this  is  " but " this again   is  not'
 951         # Ignoring single quote in 'X-LWS-Test: "This  is  quoted" this is not "this  is  " but "  this again   is  not'
 952         # Converting tab to space in 'X-LWS-Test:   "This  is  quoted" this   is  not "this  is  "  but  "\
 953         #  this again   is  not'
 954         # A HTTP/1.1 response without Connection header implies keep-alive.
 955         # Disabled filter mode on behalf of the client.
 956         # Keeping the server header 'Connection: keep-alive' around.
 957         # Keeping the client header 'Connection: close' around. The connection will not be kept alive.
 958         # Keeping the client header 'Connection: keep-alive' around. The connection will be kept alive if possible.
 959         # Content modified with no Content-Length header set. Creating a fake one for adjustment later on.
 960         # Appended client IP address to X-Forwarded-For: 10.0.0.2, 10.0.0.1
 961         # Removing 'Connection: close' to imply keep-alive.
 962         # keep-alive support is disabled. Crunching: Keep-Alive: 300.
 963         # Continue hack in da house.
 964         # Merged multiple header lines to: 'X-FORWARDED-PROTO: http X-HOST: 127.0.0.1'
 965         # Added header: Content-Encoding: deflate
 966         # Enlisting sorted header User-Agent: Mozilla/5.0 (X11; SunOS i86pc; rv:10.0.3) Gecko/20100101 Firefox/10.0.3
 967         # Enlisting left-over header Connection: close
 968
 969     } elsif ($c =~ m/^scanning headers for:/) {
 970
 971         return '' unless SHOW_SCAN_INTRO;
 972
 973     } elsif ($c =~ m/^[Cc]runch(ing|ed)|crumble crunched:/) {
 974         # crunched User-Agent!
 975         # Crunching: Content-Encoding: gzip
 976
 977         $c =~ s@(Crunching|crunched)@$h{$1}$1$h{'Standard'}@;
 978
 979     } elsif ($c =~ m/^Offending request data with NULL bytes turned into \'°\' characters:/) {
 980
 981         # Offending request data with NULL bytes turned into '°' characters: °°n°°(°°°
 982
 983         $c = h('warning') . $c . h('Standard');
 984
 985     } elsif ($c =~ m/^(Transforming \")(.*?)(\" to \")(.*?)(\")/) {
 986
 987         # Transforming "Proxy-Authenticate: Basic realm="Correos Proxy Server"" to\
 988         #  "Proxy-Authenticate: Basic realm="Correos Proxy Server""
 989
 990        $c =~ s@(?<=^Transforming \")(.*)(?=\" to)@$h{'Header'}$1$h{'Standard'}@;
 991        $c =~ s@(?<=to \")(.*)(?=\")@$h{'Header'}$1$h{'Standard'}@;
 992
 993     } elsif ($c =~ m/^Removing empty header/) {
 994
 995         # Removing empty header
 996         # Ignore for now
 997
 998     } elsif ($c =~ m/^Content-Type: .* not replaced/) {
 999
1000         # Content-Type: application/octet-stream not replaced. It doesn't look like text.\
1001         #  Enable force-text-mode if you know what you're doing.
1002         # XXX: Could highlight more here.
1003         $c =~ s@(?<=^Content-Type: )(.*)(?= not replaced)@$h{'content-type'}$1$h{'Standard'}@;
1004
1005     } elsif ($c =~ m/^(Server|Client) keep-alive timeout is/) {
1006
1007        # Server keep-alive timeout is 5. Sticking with 10.
1008        # Client keep-alive timeout is 20. Sticking with 10.
1009
1010        $c =~ s@(?<=timeout is )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1011        $c =~ s@(?<=Sticking with )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1012
1013     } elsif ($c =~ m/^Reducing keep-alive timeout/) {
1014
1015        # Reducing keep-alive timeout from 60 to 10.
1016
1017        $c =~ s@(?<= from )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1018        $c =~ s@(?<= to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1019
1020     } elsif ($c =~ m/^Killed all-caps Host header line: HOST:/) {
1021
1022        # Killed all-caps Host header line: HOST: bestproxydb.com
1023        $c = highlight_matched_host($c, '(?<=HOST: )[^\s]+');
1024        $c = highlight_matched_pattern($c, 'HOST', 'HOST');
1025
1026     } else {
1027
1028         found_unknown_content($c);
1029     }
1030
1031     # Highlight headers
1032     unless ($c =~ m/^Transforming/) {
1033         $c = highlight_known_headers($c) unless $no_special_header_highlighting;
1034     }
1035
1036     return $c;
1037 }
1038
1039 sub handle_loglevel_re_filter ($) {
1040
1041     my $content = shift;
1042     my $c = $content;
1043     my $key;
1044
1045     if ($c =~ m/^(?:re_)?filtering ([^\s]+) \(size (\d+)\) with (?:filter )?\'?([^\s]+?)\'? produced (\d+) hits \(new size (\d+)\)/) {
1046
1047         # XXX: only the second version gets highlighted properly.
1048         # re_filtering www.lfk.de/favicon.ico (size 209) with filter untrackable-hulk produced 0 hits (new size 209).
1049         # filtering aci.blogg.de/ (size 37988) with 'blogg.de' produced 3 hits (new size 38057)
1050         $req{$t}{'content_source'} = $1;
1051         $req{$t}{'content_size'}   = $2;
1052         $req{$t}{'content_filter'} = $3;
1053         $req{$t}{'content_hits'}   = $4;
1054         $req{$t}{'new_content_size'} = $5;
1055         $req{$t}{'content_size_change'} = $req{$t}{'new_content_size'} - $req{$t}{'content_size'};
1056         #return '' if ($req{$t}{'content_hits'} == 0 && !cli_option_is_set('show-ineffective-filters'));
1057         if ($req{$t}{'content_hits'} == 0 and
1058             not (cli_option_is_set('show-ineffective-filters')
1059                  or ($req{$t}{'content_filter'} =~ m/^privoxy-filter-test$/))) {
1060                 return '';
1061         }
1062
1063         $c =~ s@(?<=\(size )(\d+)\)(?= with)@$h{'Number'}$1$h{'Standard'}@;
1064         $c =~ s@(?<=\(new size )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1065         $c =~ s@(?<=produced )(\d+)(?= hits)@$h{'Number'}$1$h{'Standard'}@;
1066
1067         $c =~ s@([^\s]+?)(\'? produced)@$h{'filter'}$1$h{'Standard'}$2@;
1068         $c = highlight_matched_host($c, '(?<=filtering )[^\s]+');
1069
1070         $c =~ s@\.$@ @;
1071         $c .= "(" . $h{'Number'};
1072         $c .= "+" if ($req{$t}{'content_size_change'} >= 0);
1073         $c .= $req{$t}{'content_size_change'} . $h{'Standard'} . ")";
1074         $content = $c;
1075
1076   } elsif ($c =~ /\.{3}$/
1077         and $c =~ m/^(?:re_)?filtering \'?(.*?)\'? \(size (\d*)\) with (?:filter )?\'?([^\s]*?)\'? ?\.{3}$/) {
1078
1079         # Used by Privoxy 3.0.5 and 3.0.6:
1080         # XXX: Fill in ...
1081         # Used by Privoxy 3.0.7:
1082         # filtering 'Connection: close' (size 17) with 'generic-content-ads' ...
1083
1084         $req{$t}{'filtered_header'} = $1;
1085         $req{$t}{'old_header_size'} = $2;
1086         $req{$t}{'header_filter_name'} = $3;
1087
1088         unless (cli_option_is_set('show-ineffective-filters') or
1089                 $req{$t}{'header_filter_name'} =~ m/^privoxy-filter-test$/) {
1090             return '';
1091         }
1092         $content =~ s@(?<=\(size )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1093         $content =~ s@($req{$t}{'header_filter_name'})@$h{'filter'}$1$h{'Standard'}@;
1094
1095     } elsif ($c =~ m/^ ?\.\.\. ?produced (\d*) hits \(new size (\d*)\)\./) {
1096
1097         # ...produced 0 hits (new size 23).
1098         #... produced 1 hits (new size 54).
1099
1100         $req{$t}{'header_filter_hits'} = $1;
1101         $req{$t}{'new_header_size'} = $2;
1102
1103         unless (cli_option_is_set('show-ineffective-filters') or
1104                 (defined($req{$t}{'header_filter_name'}) and
1105                  $req{$t}{'header_filter_name'} =~ m/^privoxy-filter-test$/)) {
1106
1107             if ($req{$t}{'header_filter_hits'} == 0 and
1108                 not (defined($req{$t}{'header_filter_name'}) and
1109                  $req{$t}{'header_filter_name'} =~ m/^privoxy-filter-test$/)) {
1110                 return '';
1111             }
1112             # Reformat including information from the intro
1113             $c = "'" . h('filter') . $req{$t}{'header_filter_name'} . h('Standard') . "'";
1114             $c .= " hit ";
1115             # XXX: Hide behind constant, it may be interesting if LOG_LEVEL_HEADER isn't enabled as well.
1116             # $c .= $req{$t}{'filtered_header'} . " ";
1117             $c .= h('Number') . $req{$t}{'header_filter_hits'}. h('Standard');
1118             $c .= ($req{$t}{'header_filter_hits'} == 1) ? " time, " : " times, ";
1119
1120             if ($req{$t}{'old_header_size'} !=  $req{$t}{'new_header_size'}) {
1121
1122                 $c .= "changing size from ";
1123                 $c .=  h('Number') . $req{$t}{'old_header_size'} . h('Standard');
1124                 $c .= " to ";
1125                 $c .= h('Number') . $req{$t}{'new_header_size'} . h('Standard');
1126                 $c .= ".";
1127
1128             } else {
1129
1130                 $c .= "keeping the size at " . $req{$t}{'old_header_size'};
1131
1132             }
1133
1134             # Highlight from last line (XXX: What?)
1135             # $c =~ s@(?<=produced )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1136             # $c =~ s@($req{$t}{'header_filter_name'})@$h{'filter'}$1$h{'Standard'}@;
1137
1138         } else {
1139
1140            # XXX: Untested
1141            $c =~ s@(?<=produced )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1142            $c =~ s@(?<=new size )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1143
1144         }
1145         $content = $c;
1146
1147     } elsif ($c =~ m/^(Tagger|Filter) ([^\s]*) has empty joblist. Nothing to do./) {
1148
1149         # Filter privoxy-filter-test has empty joblist. Nothing to do.
1150         # Tagger variable-test has empty joblist. Nothing to do.
1151
1152         $content =~ s@(?<=$1 )([^\s]*)@$h{'filter'}$1$h{'Standard'}@;
1153
1154     } elsif ($c =~ m/^De-chunking successful. Shrunk from (\d+) to (\d+)/) {
1155
1156         $req{$t}{'chunked-size'} = $1;
1157         $req{$t}{'dechunked-size'} = $2;
1158         $req{$t}{'dechunk-change'} = $req{$t}{'dechunked-size'} - $req{$t}{'chunked-size'};
1159
1160         $content .= " (" . h('Number') . $req{$t}{'dechunk-change'} . h('Standard') . ")";
1161
1162         $content =~ s@(?<=from )($req{$t}{'chunked-size'})@$h{'Number'}$1$h{'Standard'}@;
1163         $content =~ s@(?<=to )($req{$t}{'dechunked-size'})@$h{'Number'}$1$h{'Standard'}@;
1164
1165     } elsif ($c =~ m/^Decompression successful. Old size: (\d+), new size: (\d+)./) {
1166
1167         # Decompression successful. Old size: 670, new size: 1166.
1168
1169         $req{$t}{'size-compressed'} = $1;
1170         $req{$t}{'size-decompressed'} = $2;
1171         $req{$t}{'decompression-gain'} = $req{$t}{'size-decompressed'} - $req{$t}{'size-compressed'};
1172
1173         $content =~ s@(?<=Old size: )($req{$t}{'size-compressed'})@$h{'Number'}$1$h{'Standard'}@;
1174         $content =~ s@(?<=new size: )($req{$t}{'size-decompressed'})@$h{'Number'}$1$h{'Standard'}@;
1175
1176         # XXX: Create sub get_percentage()
1177         if ($req{$t}{'size-decompressed'}) {
1178             $req{$t}{'decompression-gain-percent'} =
1179                 $req{$t}{'decompression-gain'} / $req{$t}{'size-decompressed'} * 100;
1180
1181             $content .= " (saved: ";
1182             #$content .= h('Number') . $req{$t}{'decompression-gain'} . h('Standard');
1183             #$content .= "/";
1184             $content .= h('Number') . sprintf("%.2f%%", $req{$t}{'decompression-gain-percent'}) . h('Standard');
1185             $content .= ")";
1186         }
1187
1188     } elsif ($c =~ m/^(Need to de-chunk first)/) {
1189
1190         # Need to de-chunk first
1191         return '' if SUPPRESS_NEED_TO_DE_CHUNK_FIRST;
1192
1193     } elsif ($c =~ m/^(Adding (?:dynamic )?re_filter job)/) {
1194
1195         return ''  if (SUPPRESS_SUCCEEDED_FILTER_ADDITIONS && m/succeeded/);
1196
1197         # Adding re_filter job ...
1198         # Adding dynamic re_filter job s@^(?:\w*)\s+.*\s+HTTP/\d\.\d\s*@IP-ADDRESS: $origin@D\
1199         #  to filter client-ip-address succeeded.
1200
1201     } elsif ($c =~ m/^Compressed content from /) {
1202
1203         # Compressed content from 29258 to 8630 bytes. Compression level: 3
1204         $content =~ s@(?<=from )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1205         $content =~ s@(?<=to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1206         $content =~ s@(?<=level: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1207
1208     } elsif ($c =~ m/^Reading in filter/) {
1209
1210         return '' unless SHOW_FILTER_READIN_IN;
1211
1212     } else {
1213
1214         found_unknown_content($content);
1215
1216     }
1217
1218     return $content;
1219 }
1220
1221 sub handle_loglevel_redirect ($) {
1222
1223     my $c = shift;
1224
1225     if ($c =~ m/^Decoding "([^""]*)"/) {
1226
1227          $req{$t}{'original-destination'} = $1;
1228          $c = highlight_matched_path($c, '(?<=Decoding ")[^"]*');
1229          $c =~ s@\"@@g;
1230
1231     } elsif ($c =~ m/^Checking/) {
1232
1233          # Checking /_ylt=A0geu.Z76BRGR9k/**http://search.yahoo.com/search?p=view+odb+presentation+on+freebsd\
1234          #  &ei=UTF-8&xargs=0&pstart=1&fr=moz2&b=11 for redirects.
1235
1236          # TODO: Change colour if really url-decoded
1237          $req{$t}{'decoded-original-destination'} = $1;
1238          $c = highlight_matched_path($c, '(?<=Checking ")[^"]*');
1239          $c =~ s@\"@@g;
1240
1241     } elsif ($c =~ m/^pcrs command "([^""]*)" changed /) {
1242
1243         # pcrs command "s@&from=rss@@" changed \
1244         #  "http://it.slashdot.org/article.pl?sid=07/03/02/1657247&from=rss"\
1245         #  to "http://it.slashdot.org/article.pl?sid=07/03/02/1657247" (1 hit).
1246         $c =~ s@(?<=pcrs command )"([^""]*)"@$h{'filter'}$1$h{'Standard'}@;
1247         $c = highlight_matched_url($c, '(?<=changed ")[^""]*');
1248         $c =~ s@(?<=changed )"([^""]*)"@$1@; # Remove quotes
1249         $c = highlight_matched_url($c, '(?<=to ")[^""]*');
1250         $c =~ s@(?<=to )"([^""]*)"@$1@; # Remove quotes
1251         $c =~ s@(\d+)(?= hits?)@$h{'hits'}$1$h{'Standard'}@;
1252
1253     } elsif ($c =~ m/^pcrs command "([^""]*)" didn\'t change/) {
1254
1255         # pcrs command "s@^http://([^.]+?)/?$@http://www.bing.com/search?q=$1@" didn't \
1256         #  change "http://www.example.org/".
1257         $c =~ s@(?<=pcrs command )"([^""]*)"@$h{'filter'}$1$h{'Standard'}@;
1258         $c = highlight_matched_url($c, '(?<=change ")[^""]*');
1259
1260     } elsif ($c =~ m/(^New URL is: )(.*)/) {
1261
1262         # New URL is: http://it.slashdot.org/article.pl?sid=07/03/04/1511210
1263         # XXX: Use URL highlighter
1264         # XXX: Save?
1265         $c = $1 . h('rewritten-URL') . $2 . h('Standard');
1266
1267     } elsif ($c =~ m/No pcrs command recognized, assuming that/) {
1268         # No pcrs command recognized, assuming that "http://config.privoxy.org/user-manual/favicon.png"\
1269         #  is already properly formatted.
1270         # XXX: assume the same?
1271         $c = highlight_matched_url($c, '(?<=assuming that \")[^"]*');
1272
1273     } elsif ($c =~ m/^Percent-encoding redirect/) {
1274
1275         # Percent-encoding redirect URL: http://www.example.org/\x02
1276         $c = highlight_matched_url($c, '(?<=redirect URL: ).*');
1277
1278     } else {
1279
1280         found_unknown_content($c);
1281
1282     }
1283
1284     return $c;
1285 }
1286
1287 sub handle_loglevel_gif_deanimate ($) {
1288
1289     my $content = shift;
1290
1291     if ($content =~ m/Success! GIF shrunk from (\d+) bytes to (\d+)\./) {
1292
1293         my $bytes_from = $1;
1294         my $bytes_to = $2;
1295         # Gif-Deanimate: Success! GIF shrunk from 205 bytes to 133.
1296         $content =~ s@$bytes_from@$h{'Number'}$bytes_from$h{'Standard'}@;
1297         # XXX: Do we need g in case of ($1 == $2)?
1298         $content =~ s@$bytes_to@$h{'Number'}$bytes_to$h{'Standard'}@;
1299
1300     } elsif ($content =~ m/GIF (not) changed/) {
1301
1302         # Gif-Deanimate: GIF not changed.
1303         return '' if SUPPRESS_GIF_NOT_CHANGED;
1304         $content =~ s@($1)@$h{'not'}$1$h{'Standard'}@;
1305
1306     } elsif ($content =~ m/^failed! \(gif parsing\)/) {
1307
1308         # failed! (gif parsing)
1309         # XXX: Replace this error message with something less stupid
1310         $content =~ s@(failed!)@$h{'error'}$1$h{'Standard'}@;
1311
1312     } elsif ($content =~ m/^Need to de-chunk first/) {
1313
1314         # Need to de-chunk first
1315         return '' if SUPPRESS_NEED_TO_DE_CHUNK_FIRST;
1316
1317     } elsif ($content =~ m/^(?:No GIF header found|failed while parsing)/) {
1318
1319         # No GIF header found (XXX: Did I ever commit this?)
1320         # failed while parsing 195 134747048 (XXX: never committed)
1321
1322         # Ignore these for now
1323
1324     } else {
1325
1326         found_unknown_content($content);
1327
1328     }
1329
1330     return $content;
1331 }
1332
1333 sub handle_loglevel_request ($) {
1334
1335     my $content = shift;
1336
1337     if ($content =~ m/crunch! /) {
1338
1339         # config.privoxy.org/send-stylesheet crunch! (CGI Call)
1340
1341         # Highlight crunch reasons
1342         foreach my $reason (keys %reason_colours) {
1343             $content =~ s@\(($reason)\)@$reason_colours{$reason}($1)$h{'Standard'}@g;
1344         }
1345         # Highlight request URL domain and ditch 'crunch!'
1346         $content = highlight_matched_pattern($content, 'request_', '[^ ]*(?= crunch!)');
1347         $content =~ s@ crunch!@@;
1348
1349     } elsif ($content =~ m/\[too long, truncated\]$/) {
1350
1351         # config.privoxy.org/edit-actions-submit?f=3&v=1176116716&s=7&Submit=Submit[...]&filter... [too long, truncated]
1352         $content = highlight_matched_pattern($content, 'request_', '^.*(?=\.\.\. \[too long, truncated\]$)');
1353
1354     } elsif ($content =~ m/(.*)/) { # XXX: Pretty stupid
1355
1356         # trac.vidalia-project.net/wiki/Volunteer?format=txt
1357         $content = h('request_') . $content . h('Standard');
1358
1359     } else {  # XXX: Nop
1360
1361         found_unknown_content($content);
1362
1363     }
1364
1365     return $content;
1366 }
1367
1368 sub handle_loglevel_crunch ($) {
1369
1370     my $content = shift;
1371
1372     # Highlight crunch reason
1373     foreach my $reason (keys %reason_colours) {
1374         $content =~ s@($reason)@$reason_colours{$reason}$1$h{'Standard'}@g;
1375     }
1376
1377     if ($content =~ m/\[too long, truncated\]$/) {
1378
1379         # Blocked: config.privoxy.org/edit-actions-submit?f=3&v=1176116716&s=7&Submit=Submit\
1380         #  [...]&filter... [too long, truncated]
1381         $content = highlight_matched_pattern($content, 'request_', '^.*(?=\.\.\. \[too long, truncated\]$)');
1382
1383     } else {
1384
1385         # Blocked: http://ads.example.org/
1386         $content = highlight_matched_pattern($content, 'request_', '(?<=: ).*');
1387     }
1388
1389     return $content;
1390 }
1391
1392 sub handle_loglevel_connect ($) {
1393
1394     my $c = shift;
1395
1396     if ($c =~ m/^via [^\s]+ to: [^\s]+/) {
1397
1398         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
1399
1400         $c = highlight_matched_host($c, '(?<=via )[^\s]+');
1401         $c = highlight_matched_host($c, '(?<=to: )[^\s]+');
1402
1403     } elsif ($c =~ m/^connect to: .* failed: .*/) {
1404
1405         # connect to: www.example.org.noconnect failed: Operation not permitted
1406
1407         $c = highlight_matched_host($c, '(?<=connect to: )[^\s]+');
1408
1409         $c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1410
1411     } elsif ($c =~ m/^to ([^\s]*)( successful)?$/) {
1412
1413         # Connect: to www.nzherald.co.nz successful
1414         # Connect: to archiv.radiotux.de
1415
1416         return '' if SUPPRESS_SUCCESSFUL_CONNECTIONS;
1417         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1418
1419     } elsif ($c =~ m/^to ([^\s]*)$/) {
1420
1421         # Connect: to lists.sourceforge.net:443
1422
1423         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1424
1425     } elsif ($c =~ m/^[Aa]ccepted connection from .*/ or
1426              $c =~ m/^OK/) {
1427
1428         # Privoxy 3.0.20:
1429         # Accepted connection from 10.0.0.1 on socket 5
1430         # Privoxy between 3.0.20 and 3.0.6:
1431         # accepted connection from 10.0.0.1( on socket 5)?
1432         # Privoxy 3.0.6 and earlier just say:
1433         # OK
1434         $c = highlight_matched_host($c, '(?<=connection from )[^ ]*');
1435         $c = highlight_matched_pattern($c, 'Number', '(?<=socket )\d+');
1436
1437     } elsif ($c =~ m/^Closing client socket/) {
1438
1439         # Closing client socket 5. Keep-alive: 0, Socket alive: 1. Data available: 0.
1440         $c = highlight_matched_pattern($c, 'Number', '(?<=socket )\d+');
1441         $c = highlight_matched_pattern($c, 'Number', '(?<=Keep-alive: )\d+');
1442         $c = highlight_matched_pattern($c, 'Number', '(?<=Socket alive: )\d+');
1443         $c = highlight_matched_pattern($c, 'Number', '(?<=available: )\d+');
1444
1445     } elsif ($c =~ m/^write header to: .* failed:/) {
1446
1447         # write header to: 10.0.0.1 failed: Broken pipe
1448
1449         $c = highlight_matched_host($c, '(?<=write header to: )[^\s]*');
1450         $c =~ s@(?<=failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1451
1452     } elsif ($c =~ m/^write header to client failed:/) {
1453
1454         # write header to client failed: Broken pipe
1455         # XXX: Stil in use?
1456         $c =~ s@(?<=failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1457
1458     } elsif ($c =~ m/^socks4_connect:/) {
1459
1460         # socks4_connect: SOCKS request rejected or failed.
1461         $c =~ s@(?<=socks4_connect: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1462
1463     } elsif ($c =~ m/^Listening for new connections/ or
1464              $c =~ m/^accept connection/) {
1465         # XXX: Highlight?
1466         # Privoxy versions above 3.0.6 say:
1467         # Listening for new connections ...
1468         # earlier versions say:
1469         # accept connection ...
1470         return '';
1471
1472     } elsif ($c =~ m/^accept failed:/) {
1473
1474         $c =~ s@(?<=accept failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1475
1476     } elsif ($c =~ m/^Overriding forwarding settings/) {
1477
1478         # Overriding forwarding settings based on 'forward 10.0.0.1:8123'
1479         $c =~ s@(?<=based on \')(.*)(?=\')@$h{'configuration-line'}$1$h{'Standard'}@;
1480
1481     } elsif ($c =~ m/^Denying suspicious CONNECT request from/) {
1482
1483         # Denying suspicious CONNECT request from 10.0.0.1
1484         $c = highlight_matched_host($c, '(?<=from )[^\s]+'); # XXX: not an URL
1485
1486     } elsif ($c =~ m/^socks5_connect:/) {
1487
1488         $c =~ s@(?<=socks5_connect: )(.*)@$h{'error'}$1$h{'Standard'}@;
1489
1490     } elsif ($c =~ m/^Created new connection to/) {
1491
1492         # Created new connection to www.privoxy.org:80 on socket 11.
1493         $c = highlight_matched_host($c, '(?<=connection to )[^\s]+');
1494         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1495
1496     } elsif ($c =~ m/^Found reusable socket/) {
1497
1498         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
1499         # 3.0.15 and later:
1500         # Found reusable socket 8 for www.privoxy.org:80 in slot 2.\
1501         #  Timestamp made 0 seconds ago. Timeout: 1. Latency: 0.
1502         $c =~ s@(?<=Found reusable socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1503         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1504         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1505         $c =~ s@(?<=made )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1506         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1507         $c =~ s@(?<=Latency: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1508
1509     } elsif ($c =~ m/^Marking open socket/) {
1510
1511         # Marking open socket 9 for www.privoxy.org:80 in slot 0 as unused.
1512         $c =~ s@(?<=Marking open 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/^No reusable/) {
1517
1518         # No reusable socket for addons.mozilla.org:443 found. Opening a new one.
1519         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1520
1521     } elsif ($c =~ m/^(Remembering|Forgetting) socket/) {
1522
1523         # Remembering socket 13 for www.privoxy.org:80 in slot 0.
1524         # Forgetting socket 38 for www.privoxy.org:80 in slot 5.
1525
1526         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1527         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1528         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1529
1530     } elsif ($c =~ m/^Socket/) {
1531
1532         # Socket 16 already forgotten or never remembered.
1533         $c =~ s@(?<=Socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1534
1535     } elsif ($c =~ m/^The connection to/) {
1536
1537         # The connection to www.privoxy.org:80 in slot 6 timed out. Closing socket 19. Timeout is: 61.
1538         # 3.0.15 and later:
1539         # The connection to 1.bp.blogspot.com:80 in slot 0 timed out. Closing socket 5.\
1540         #  Timeout is: 1. Assumed latency: 4.
1541         # The connection to 10.0.0.1:80 in slot 0 is no longer usable. Closing socket 4.
1542         $c = highlight_matched_host($c, '(?<=connection to )[^\s]+');
1543         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1544         $c =~ s@(?<=Closing socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1545         $c =~ s@(?<=Timeout is: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1546         $c =~ s@(?<=Assumed latency: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1547
1548     } elsif ($c =~ m/^Stopped waiting for the request line/ or
1549              $c =~ m/^No request line on socket \d received in time/ or
1550              $c =~ m/^The client side of the connection on socket \d/) {
1551
1552         # Stopped waiting for the request line. Timeout: 121.
1553         # Privoxy 3.0.19 and later:
1554         # No request line on socket 5 received in time. Timeout: 1.
1555         # The client side of the connection on socket 5 got closed \
1556         #  without sending a complete request line.
1557         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1558         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1559
1560     } elsif ($c =~ m/^Waiting for \d/) {
1561
1562         # Waiting for 1 connections to timeout.
1563         $c =~ s@(?<=^Waiting for )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1564
1565     } elsif ($c =~ m/^Initialized/) {
1566
1567         # Initialized 20 socket slots.
1568         $c =~ s@(?<=Initialized )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1569
1570     } elsif ($c =~ m/^Done reading from server/) {
1571
1572         # Done reading from server. Expected content length: 24892. \
1573         #  Actual content length: 24892. Most recently received: 4412.
1574         # 3.0.15 and later:
1575         # Done reading from server. Expected content length: 24892. \
1576         #  Actual content length: 24892. Bytes most recently read: 4412.
1577         # Done reading from server. Content length: 6018 as expected. \
1578         #  Bytes most recently read: 294.
1579         $c =~ s@(?<=ontent length: )(\d+)@$h{'Number'}$1$h{'Standard'}@g;
1580         $c =~ s@(?<=received: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1581         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1582
1583     } elsif ($c =~ m/^Continuing buffering (?:server )?headers/) {
1584
1585         # Continuing buffering headers. byte_count: 19. header_offset: 517. len: 536.
1586         $c =~ s@(?<=byte_count: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1587         $c =~ s@(?<=header_offset: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1588         $c =~ s@(?<=len: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1589         # 3.0.15 up to 3.0.19:
1590         # Continuing buffering headers. Bytes most recently read: 498.
1591         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1592         # 3.0.20 and later:
1593         # Continuing buffering server headers from socket 5. Bytes most recently read: 498.
1594         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1595
1596     } elsif ($c =~ m/^Received \d+ bytes while/) {
1597
1598         # Received 206 bytes while expecting 12103.
1599         $c =~ s@(?<=Received )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1600         $c =~ s@(?<=expecting )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1601
1602     } elsif ($c =~ m/^(Rejecting c|C)onnection from/) {
1603
1604         # Connection from 81.163.28.218 dropped due to ACL
1605         # Rejecting connection from 178.63.152.227. Maximum number of connections reached.
1606         $c =~ s@(?<=onnection from )((?:\d+\.?){3}\d+)@$h{'Number'}$1$h{'Standard'}@;
1607
1608     } elsif ($c =~ m/^(?:Reusing|Closing) server socket \d./ or
1609              $c =~ m/^No additional client request/) {
1610
1611         # Reusing server socket 4. Opened for 10.0.0.1.
1612         # Closing server socket 2. Opened for 10.0.0.1.
1613         # No additional client request received in time. \
1614         #  Closing server socket 4, initially opened for 10.0.0.1.
1615         # No additional client request received in time on socket 29.
1616
1617         $c =~ s@(?<= socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1618         $c = highlight_matched_host($c, '(?<=for )[^\s]+(?=\.$)');
1619
1620     } elsif ($c =~ m/^Connected to /) {
1621
1622         # Connected to tor-jail[10.0.0.2]:9050.
1623
1624         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1625         $c = highlight_matched_host($c, '(?<=Connected to )[^\[\s]+');
1626         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1627
1628     } elsif ($c =~ m/^Could not connect to /) {
1629
1630         # Could not connect to [10.0.0.1]:80.
1631
1632         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1633         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1634
1635     } elsif ($c =~ m/^Waiting for the next client request/ or
1636              $c =~ m/^The connection on server socket/ or
1637              $c =~ m/^Client request arrived in time /) {
1638
1639         # Waiting for the next client request on socket 3. Keeping the server \
1640         #  socket 12 to a.fsdn.com open.
1641         # The connection on server socket 6 to upload.wikimedia.org isn't reusable. Closing.
1642         # Used by Privoxy 3.0.18 and later:
1643         # Client request arrived in time on socket 21.
1644         # Used by earlier version:
1645         # Client request arrived in time or the client closed the connection on socket 12.
1646
1647         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1648         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1649         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1650
1651     } elsif ($c =~ m/^Marking the server socket/) {
1652
1653         # Marking the server socket 7 tainted.
1654
1655         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1656
1657     } elsif ($c =~ m/^Reduced expected bytes to /) {
1658
1659         # Reduced expected bytes to 0 to account for the 1542 ones we already got.
1660         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1661         $c =~ s@(?<=for the )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1662
1663     } elsif ($c =~ m/^The client closed socket /) {
1664
1665         # The client closed socket 2 while the server socket 4 is still open.
1666         $c =~ s@(?<=closed socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1667         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1668
1669     } elsif ($c =~ m/^Expected client content length set /) {
1670
1671         # Expected client content length set to 667325411 after reading 4999 bytes.
1672         $c =~ s@(?<=set to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1673         $c =~ s@(?<=reading )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1674
1675     } elsif ($c =~ m/^Reducing expected bytes to /) {
1676
1677         # Reducing expected bytes to 0. Marking the server socket tainted after throwing 4 bytes away.
1678         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1679         $c =~ s@(?<=after throwing )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1680
1681     } elsif ($c =~ m/^Waiting for up to /) {
1682
1683         # Waiting for up to 4999 bytes from the client.
1684         $c =~ s@(?<=up to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1685
1686     } elsif ($c =~ m/^Stopping to watch the client socket/) {
1687
1688         # Stopping to watch the client socket. There's already another request waiting.
1689         # Privoxy 3.0.20 and later:
1690         # Stopping to watch the client socket 5. There's already another request waiting.
1691         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1692
1693     } elsif ($c =~ m/^Looks like we / or
1694              $c =~ m/^Unsetting keep-alive flag/ or
1695              $c =~ m/^No connections to wait/ or
1696              $c =~ m/^Complete client request received/ or
1697              $c =~ m/^Possible pipeline attempt detected./ or
1698              $c =~ m/^POST request detected. The connection will not be kept alive./ or
1699              $c =~ m/^The server still wants to talk, but the client hung up on us./ or
1700              $c =~ m/^The server didn't specify how long the connection will stay open/ or
1701              $c =~ m/^There might be a request body. The connection will not be kept alive/ or
1702              $c =~ m/^Done reading from the client\.$/) {
1703
1704         # Looks like we reached the end of the last chunk. We better stop reading.
1705         # Looks like we read the end of the last chunk together with the server \
1706         #  headers. We better stop reading.
1707         # Looks like we got the last chunk together with the server headers. \
1708         #  We better stop reading.
1709         # Unsetting keep-alive flag.
1710         # No connections to wait for left.
1711         # Client request arrived in time or the client closed the connection.
1712         # Complete client request received
1713         # Possible pipeline attempt detected. The connection will not be \
1714         #  kept alive and we will only serve the first request.
1715         # POST request detected. The connection will not be kept alive.
1716         # The server still wants to talk, but the client hung up on us.
1717         # The server didn't specify how long the connection will stay open. Assume it's only a second.
1718         # There might be a request body. The connection will not be kept alive.
1719         # Done reading from the client\.
1720
1721     } else {
1722
1723         found_unknown_content($c);
1724
1725     }
1726
1727     return $c;
1728 }
1729
1730
1731 sub handle_loglevel_info ($) {
1732
1733     my $c = shift;
1734
1735     if ($c =~ m/^Rewrite detected:/) {
1736
1737         # Rewrite detected: GET http://10.0.0.2:88/blah.txt HTTP/1.1
1738         $c = highlight_matched_request_line($c, '(?<=^Rewrite detected: ).*');
1739
1740     } elsif ($c =~ m/^Decompress(ing deflated|ion didn)/ or
1741              $c =~ m/^Compressed content detected/ or
1742              $c =~ m/^SDCH-compressed content detected/ or
1743              $c =~ m/^Tagger/
1744             ) {
1745         # Decompressing deflated iob: 117
1746         # Decompression didn't result in any content.
1747         # Compressed content detected, content filtering disabled. Consider recompiling Privoxy\
1748         #  with zlib support or enable the prevent-compression action.
1749         # SDCH-compressed content detected, content filtering disabled.\
1750         #  Consider suppressing SDCH offers made by the client.
1751         # Tagger 'complete-url' created empty tag. Ignored.
1752
1753         # Ignored for now
1754
1755     } elsif ($c =~ m/^(Re)?loading configuration file /) {
1756
1757         # loading configuration file '/usr/local/etc/privoxy/config':
1758         # Reloading configuration file '/usr/local/etc/privoxy/config'
1759         $c =~ s@(?<=loading configuration file \')([^\']*)@$h{'file'}$1$h{'Standard'}@;
1760
1761     } elsif ($c =~ m/^Loading (actions|filter) file: /) {
1762
1763         # Loading actions file: /usr/local/etc/privoxy/default.action
1764         # Loading filter file: /usr/local/etc/privoxy/default.filter
1765         $c =~ s@(?<= file: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1766
1767     } elsif ($c =~ m/^exiting by signal/) {
1768
1769         # exiting by signal 15 .. bye
1770         $c =~ s@(?<=exiting by signal )(\d+)@$h{'signal'}$1$h{'Standard'}@;
1771
1772     } elsif ($c =~ m/^Privoxy version/) {
1773
1774         # Privoxy version 3.0.7
1775         $c =~ s@(?<=^Privoxy version )(\d+\.\d+\.\d+)$@$h{'version'}$1$h{'Standard'}@;
1776
1777     } elsif ($c =~ m/^Program name: /) {
1778
1779         # Program name: /usr/local/sbin/privoxy
1780         $c =~ s@(?<=Program name: )(.*)@$h{'program-name'}$1$h{'Standard'}@;
1781
1782     } elsif ($c =~ m/^Listening on port /) {
1783
1784         # Listening on port 8118 on IP address 10.0.0.1
1785         $c =~ s@(?<=Listening on port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1786         $c =~ s@(?<=on IP address )(.*)@$h{'ip-address'}$1$h{'Standard'}@;
1787
1788     } elsif ($c =~ m/^\(Re-\)Open(?:ing)? logfile/) {
1789
1790         # (Re-)Open logfile /var/log/privoxy/privoxy.log
1791         $c =~ s@(?<=Open logfile )(.*)@$h{'file'}$1$h{'Standard'}@;
1792
1793     } elsif ($c =~ m/^(Request from|Malformed server response detected)/) {
1794
1795         # Request from 10.0.0.1 denied. limit-connect{,} doesn't allow CONNECT requests to port 443.
1796         # Request from 10.0.0.1 marked for blocking. limit-connect{,} doesn't allow CONNECT requests to port 443.
1797         # 3.0.18 and later:
1798         # Request from 10.0.0.1 marked for blocking. limit-connect{0} doesn't allow CONNECT requests to www.example.org:443
1799         # Malformed server response detected. Downgrading to HTTP/1.0 impossible.
1800
1801         $c =~ s@(?<=Request from )([^\s]*)@$h{'ip-address'}$1$h{'Standard'}@;
1802         $c =~ s@(denied|blocking)@$h{'warning'}$1$h{'Standard'}@;
1803         $c =~ s@(CONNECT)@$h{'method'}$1$h{'Standard'}@;
1804         $c =~ s@(?<=to port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1805         $c =~ s@(?<=to )([^\s]+)@$h{'request_'}$1$h{'Standard'}@;
1806
1807     } elsif ($c =~ m/^Status code/) {
1808
1809         # Status code 304 implies no body.
1810         $c =~ s@(?<=Status code )(\d+)@$h{'status-code'}$1$h{'Standard'}@;
1811
1812     } elsif ($c =~ m/^Method/) {
1813
1814         # Method HEAD implies no body.
1815         $c =~ s@(?<=Method )([^\s]+)@$h{'method'}$1$h{'Standard'}@;
1816
1817     } elsif ($c =~ m/^Buffer limit reached while extending /) {
1818
1819         # Buffer limit reached while extending the buffer (iob). Needed: 4197470. Limit: 4194304
1820         $c =~ s@(?<=Needed: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1821         $c =~ s@(?<=Limit: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1822
1823     } elsif ($c =~ m/^File modification detected: /) {
1824
1825         # File modification detected: /usr/local/etc/privoxy/user-agent.action
1826         $c =~ s@(?<= detected: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1827
1828     } elsif ($c =~ m/^No logfile configured/ or
1829              $c =~ m/^Malformerd HTTP headers detected and MS IIS5 hack enabled/ or
1830              $c =~ m/^Invalid \"chunked\" transfer/ or
1831              $c =~ m/^Support for/ or
1832              $c =~ m/^Flushing header and buffers/ or
1833              $c =~ m/^Can not resolve/
1834              ) {
1835
1836         # No logfile configured. Please enable it before reporting any problems.
1837         # Malformerd HTTP headers detected and MS IIS5 hack enabled. Expect an invalid \
1838         #  response or even no response at all.
1839         # No logfile configured. Logging disabled.
1840         # Invalid "chunked" transfer encoding detected and ignored.
1841         # Support for 'Connection: keep-alive' is experimental, incomplete and\
1842         #  known not to work properly in some situations.
1843         # Flushing header and buffers. Stepping back from filtering.
1844         # Can not resolve doesnotexist: hostname nor servname provided, or not known
1845
1846     } else {
1847
1848         found_unknown_content($c);
1849
1850     }
1851
1852     return $c;
1853 }
1854
1855 sub handle_loglevel_cgi ($) {
1856
1857     my $c = shift;
1858
1859     if ($c =~ m/^Granting access to/) {
1860
1861         #Granting access to http://config.privoxy.org/send-stylesheet, referrer http://p.p/ is trustworthy.
1862
1863     } elsif ($c =~ m/^Substituting: s(.)/) {
1864
1865         # Substituting: s/@else-not-FEATURE_ZLIB@.*@endif-FEATURE_ZLIB@//sigTU
1866         # XXX: prone to span several lines
1867
1868         my $delimiter = $1;
1869         #$c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1870         $c =~ s@(?!<=\\)($delimiter)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g; # XXX: Too aggressive
1871         #$c =~ s@(?!<=\\)($1)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g;
1872     }
1873
1874     return $c;
1875 }
1876
1877 sub handle_loglevel_force ($) {
1878
1879     my $c = shift;
1880
1881     if ($c =~ m/^Ignored force prefix in request:/) {
1882
1883         # Ignored force prefix in request: "GET http://10.0.0.1/PRIVOXY-FORCE/block HTTP/1.1"
1884         $c =~ s@^(Ignored)@$h{'ignored'}$1$h{'Standard'}@;
1885         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1886
1887     } elsif ($c =~ m/^Enforcing request:/) {
1888
1889         # Enforcing request: "GET http://10.0.0.1/block HTTP/1.1".
1890         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1891
1892     } else {
1893
1894         found_unknown_content($c);
1895
1896     }
1897
1898     return $c;
1899 }
1900
1901 sub handle_loglevel_error ($) {
1902
1903     my $c = shift;
1904
1905     if ($c =~ m/^(?:Empty|No) server or forwarder response received on socket \d+\./) {
1906
1907         # Empty server or forwarder response received on socket 4.
1908         # Empty server or forwarder response received on socket 3. \
1909         #  Closing client socket 15 without sending data.
1910         # Used by Privoxy 3.0.18 and later:
1911         # No server or forwarder response received on socket 8. \
1912         #  Closing client socket 10 without sending data.
1913
1914         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1915         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1916
1917     } elsif ($c =~ m/^Didn't receive data in time:/) {
1918
1919         # Didn't receive data in time: a.fsdn.com:443
1920         $c =~ s@(?<=in time: )(.*)@$h{'destination'}$1$h{'Standard'}@;
1921     }
1922
1923     # XXX: There are probably more messages that deserve highlighting.
1924
1925     return $c;
1926 }
1927
1928
1929 sub handle_loglevel_ignore ($) {
1930     return shift;
1931 }
1932
1933 sub gather_loglevel_request_stats ($$) {
1934     my $c = shift;
1935     my $thread = shift;
1936     our %stats;
1937
1938     $stats{requests}++;
1939 }
1940
1941 sub gather_loglevel_crunch_stats ($$) {
1942     my $c = shift;
1943     my $thread = shift;
1944     our %stats;
1945
1946     $stats{requests}++;
1947     $stats{crunches}++;
1948
1949     if ($c =~ m/^Redirected:/) {
1950         # Redirected: http://www.example.org/http://p.p/
1951         $stats{'fast-redirections'}++;
1952
1953     } elsif ($c =~ m/^Blocked:/) {
1954         # Blocked: blogger.googleusercontent.com:443
1955         $stats{'blocked'}++;
1956     }
1957 }
1958
1959
1960 sub gather_loglevel_error_stats ($$) {
1961
1962     my $c = shift;
1963     my $thread = shift;
1964     our %stats;
1965     our %thread_data;
1966
1967     if ($c =~ m/^Empty server or forwarder response received on socket \d+./) {
1968
1969         # Empty server or forwarder response received on socket 4.
1970         $stats{'empty-responses'}++;
1971         if ($thread_data{$thread}{'new_connection'}) {
1972             $stats{'empty-responses-on-new-connections'}++;
1973         } else {
1974             $stats{'empty-responses-on-reused-connections'}++;
1975         }
1976     }
1977 }
1978
1979 sub gather_loglevel_connect_stats ($$) {
1980
1981     my ($c, $thread) = @_;
1982     our %thread_data;
1983     our %stats;
1984
1985     if ($c =~ m/^via ([^\s]+) to: [^\s]+/) {
1986
1987         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
1988         $thread_data{$thread}{'forwarder'} = $1; # XXX: is this missue?
1989
1990     } elsif ($c =~ m/^to ([^\s]*)$/) {
1991
1992         # Connect: to lists.sourceforge.net:443
1993
1994         $thread_data{$thread}{'forwarder'} = 'direct connection';
1995
1996     } elsif ($c =~ m/^Created new connection to/) {
1997
1998         # Created new connection to www.privoxy.org:80 on socket 11.
1999
2000         $thread_data{$thread}{'new_connection'} = 1;
2001
2002     } elsif ($c =~ m/^Reusing server socket \d./ or
2003              $c =~ m/^Found reusable socket/) {
2004
2005         # Reusing server socket 4. Opened for 10.0.0.1.
2006         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
2007
2008         $thread_data{$thread}{'new_connection'} = 0;
2009         $stats{'reused-connections'}++;
2010     }
2011 }
2012
2013 sub gather_loglevel_header_stats ($$) {
2014
2015     my ($c, $thread) = @_;
2016     our %stats;
2017
2018     if ($c =~ m/^A HTTP\/1\.1 response without/ or
2019         $c =~ m/^Keeping the server header 'Connection: keep-alive' around./)
2020     {
2021         # A HTTP/1.1 response without Connection header implies keep-alive.
2022         # Keeping the server header 'Connection: keep-alive' around.
2023         $stats{'server-keep-alive'}++;
2024
2025     } elsif ($c =~ m/^scan: ((\w+) (.+) (HTTP\/\d\.\d))/) {
2026
2027         # scan: HTTP/1.1 200 OK
2028         $stats{'method'}{$2}++;
2029         $stats{'resource'}{$3}++;
2030         $stats{'http-version'}{$4}++;
2031
2032     } elsif ($c =~ m/^scan: Host: ([^\s]+)/) {
2033
2034         # scan: Host: p.p
2035         $stats{'hosts'}{$1}++;
2036     }
2037 }
2038
2039 sub init_stats () {
2040     our %stats = (
2041         requests => 0,
2042         crunches => 0,
2043         'server-keep-alive' => 0,
2044         'reused-connections' => 0,
2045         'empty-responses' => 0,
2046         'empty-responses-on-new-connections' => 0,
2047         'empty-responses-on-reused-connections' => 0,
2048         'fast-redirections' => 0,
2049         'blocked' => 0,
2050         'reused-connections' => 0,
2051         'server-keep-alive' => 0,
2052         );
2053 }
2054
2055 sub get_percentage ($$) {
2056     my $big = shift;
2057     my $small = shift;
2058
2059     # If small is 0 the percentage is always 0%.
2060     # Make sure it works even if big is 0 as well.
2061     return "0.00%" if ($small eq 0);
2062
2063     # Prevent division by zero.
2064     # XXX: Is this still supposed to be reachable?
2065     return "NaN" if ($big eq 0);
2066
2067     return sprintf("%.2f%%", $small / $big * 100);
2068 }
2069
2070 sub print_stats () {
2071
2072     our %stats;
2073     our %cli_options;
2074     my $new_connections = $stats{requests} - $stats{crunches} - $stats{'reused-connections'};
2075     my $outgoing_requests = $stats{requests} - $stats{crunches};
2076
2077     if ($stats{requests} eq 0) {
2078         print "No requests yet.\n";
2079         return;
2080     }
2081
2082     print "Client requests total: " . $stats{requests} . "\n";
2083     print "Crunches: " . $stats{crunches} . " (" .
2084         get_percentage($stats{requests}, $stats{crunches}) . ")\n";
2085     print "Blocks: " . $stats{'blocked'} . " (" .
2086         get_percentage($stats{requests}, $stats{'blocked'}) . ")\n";
2087     print "Fast redirections: " . $stats{'fast-redirections'} . " (" .
2088         get_percentage($stats{requests}, $stats{'fast-redirections'}) . ")\n";
2089     print "Outgoing requests: " . $outgoing_requests . " (" .
2090         get_percentage($stats{requests}, $outgoing_requests) . ")\n";
2091     print "Server keep-alive offers: " . $stats{'server-keep-alive'} . " (" .
2092         get_percentage($stats{requests}, $stats{'server-keep-alive'}) . ")\n";
2093     print "New outgoing connections: " . $new_connections . " (" .
2094         get_percentage($stats{requests}, $new_connections) . ")\n";
2095     print "Reused connections: " . $stats{'reused-connections'} . " (" .
2096         get_percentage($stats{requests}, $stats{'reused-connections'}) .
2097         "; server offers accepted: " .
2098         get_percentage($stats{'server-keep-alive'}, $stats{'reused-connections'}) . ")\n";
2099     print "Empty responses: " . $stats{'empty-responses'} . " (" .
2100         get_percentage($stats{requests}, $stats{'empty-responses'}) . ")\n";
2101     print "Empty responses on new connections: "
2102          . $stats{'empty-responses-on-new-connections'} . " (" .
2103         get_percentage($stats{requests}, $stats{'empty-responses-on-new-connections'})
2104         . ")\n";
2105     print "Empty responses on reused connections: " .
2106         $stats{'empty-responses-on-reused-connections'} . " (" .
2107         get_percentage($stats{requests}, $stats{'empty-responses-on-reused-connections'}) .
2108         ")\n";
2109
2110     if ($stats{method} eq 0) {
2111         print "No response lines parsed yet yet.\n";
2112         return;
2113     }
2114     print "Method distribution:\n";
2115     foreach my $method (sort {$stats{'method'}{$b} <=> $stats{'method'}{$a}} keys %{$stats{'method'}}) {
2116         printf "%8d : %-8s\n", $stats{'method'}{$method}, $method;
2117     }
2118     print "Client HTTP versions:\n";
2119     foreach my $http_version (sort {$stats{'http-version'}{$b} <=> $stats{'http-version'}{$a}} keys %{$stats{'http-version'}}) {
2120         printf "%d : %s\n",  $stats{'http-version'}{$http_version}, $http_version;
2121     }
2122
2123     if ($cli_options{'url-statistics-threshold'} == 0) {
2124         print "URL statistics are disabled. Increase --url-statistics-threshold to enable them.\n";
2125     } else {
2126         print "Requested URLs:\n";
2127         foreach my $resource (sort {$stats{'resource'}{$b} <=> $stats{'resource'}{$a}} keys %{$stats{'resource'}}) {
2128             if ($stats{'resource'}{$resource} < $cli_options{'url-statistics-threshold'}) {
2129                 print "Skipped statistics for URLs below the treshold.\n";
2130                 last;
2131             }
2132             printf "%d : %s\n", $stats{'resource'}{$resource}, $resource;
2133         }
2134     }
2135
2136     if ($cli_options{'host-statistics-threshold'} == 0) {
2137         print "Host statistics are disabled. Increase --host-statistics-threshold to enable them.\n";
2138     } else {
2139         print "Requested Hosts:\n";
2140         foreach my $host (sort {$stats{'hosts'}{$b} <=> $stats{'hosts'}{$a}} keys %{$stats{'hosts'}}) {
2141             if ($stats{'hosts'}{$host} < $cli_options{'host-statistics-threshold'}) {
2142                 print "Skipped statistics for Hosts below the treshold.\n";
2143                 last;
2144             }
2145             printf "%d : %s\n", $stats{'hosts'}{$host}, $host;
2146         }
2147     }
2148 }
2149
2150
2151 ################################################################################
2152 # Functions that actually print stuff
2153 ################################################################################
2154
2155 sub print_clf_message () {
2156
2157     our ($ip, $timestamp, $request_line, $status_code, $size);
2158     my $output = '';
2159
2160     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2161
2162     # Rebuild highlighted
2163     $output .= $h{'Number'} . $ip . $h{'Standard'};
2164     $output .= " - - ";
2165     $output .= "[" . $h{'Timestamp'} . $timestamp . $h{'Standard'} . "]";
2166     $output .= " ";
2167     $output .= "\"" . highlight_request_line("$request_line") . "\"";
2168     $output .= " ";
2169     $output .= $h{'Status'} . $status_code . $h{'Standard'};
2170     $output .= " ";
2171     $output .= $h{'Number'} . $size . $h{'Standard'};
2172     $output .= $line_end;
2173
2174     print $output;
2175 }
2176
2177 sub print_non_clf_message ($) {
2178
2179     my $content = shift;
2180     my $msec_string = $no_msecs_mode ? '' : '.' . $req{$t}{'msecs'};
2181     my $line_start = $html_output_mode ? '' : $h{"Standard"};
2182
2183     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2184
2185     print $line_start
2186         . $time_colours[$time_colour_index % 2]
2187         . $req{$t}{'time-stamp'}
2188         . $msec_string
2189         . $h{Standard} . " "
2190         . $thread_colours{$t}
2191         . $t
2192         . $h{Standard}
2193         . " "
2194         . $h{$req{$t}{'log-level'}}
2195         . $req{$t}{'log-level'}
2196         . $h{Standard}
2197         . ": "
2198         . $content
2199         . $line_end;
2200 }
2201
2202 sub shorten_thread_id ($) {
2203
2204     my $thread_id = shift;
2205
2206     our %short_thread_ids;
2207     our $max_threadid;
2208
2209     unless (defined $short_thread_ids{$thread_id}) {
2210         $short_thread_ids{$thread_id} = sprintf "%.3d", $max_threadid++;
2211     }
2212
2213     return $short_thread_ids{$thread_id}
2214 }
2215
2216 sub parse_loop () {
2217
2218     my ($day, $time_stamp, $thread, $log_level, $content, $c, $msecs);
2219     my $last_msecs  = 0;
2220     my $last_thread = 0;
2221     my $last_timestamp = 0;
2222     my $filters_that_did_nothing;
2223     my $key;
2224     my $time_colour;
2225     $time_colour = paint_it('white');
2226
2227     my %log_level_handlers = (
2228         'Re-Filter'         => \&handle_loglevel_re_filter,
2229         'Header'            => \&handle_loglevel_header,
2230         'Connect'           => \&handle_loglevel_connect,
2231         'Redirect'          => \&handle_loglevel_redirect,
2232         'Request'           => \&handle_loglevel_request,
2233         'Crunch'            => \&handle_loglevel_crunch,
2234         'Gif-Deanimate'     => \&handle_loglevel_gif_deanimate,
2235         'Info'              => \&handle_loglevel_info,
2236         'CGI'               => \&handle_loglevel_cgi,
2237         'Force'             => \&handle_loglevel_force,
2238         'Error'             => \&handle_loglevel_error,
2239         'Fatal error'       => \&handle_loglevel_ignore,
2240         'Writing'           => \&handle_loglevel_ignore,
2241         'Received'          => \&handle_loglevel_ignore,
2242         'Actions'           => \&handle_loglevel_ignore,
2243         'Unknown log level' => \&handle_loglevel_ignore,
2244     );
2245
2246     while (<>) {
2247
2248         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/) {
2249             $thread = $t = ($shorten_thread_ids) ? shorten_thread_id($4) : $4;
2250             $req{$t}{'day'} = $day = $1;
2251             $req{$t}{'time-stamp'} = $time_stamp = $2;
2252             $req{$t}{'msecs'} = $msecs = $3 ? $3 : 0; # Only the cool kids have micro second resolution;
2253             $req{$t}{'log-level'} = $log_level = $5;
2254             $req{$t}{'content'} = $content = $c = $6;
2255             $req{$t}{'log-message'} = $_;
2256             $no_special_header_highlighting = 0;
2257
2258             if (defined($log_level_handlers{$log_level})) {
2259
2260                 $content = $log_level_handlers{$log_level}($content);
2261
2262             } else {
2263
2264                 die "No handler found for log level \"$log_level\"\n";
2265             }
2266
2267             # Highlight Truncations
2268             if (length($_) > 4000) {
2269                 $content =~ s@(too long, truncated)]$@$h{'Truncation'}$1$h{'Standard'}]@g;
2270             }
2271
2272             next unless $content;
2273
2274             # Register threads to keep the colour constant
2275             if (!defined($thread_colours{$thread})) {
2276                 $thread_colours{$thread} = $all_colours[$thread_colour_index % @all_colours];
2277                 $thread_colour_index++;
2278             }
2279
2280             # Switch timestamp colour if timestamps differ
2281             if (($msecs ne $last_msecs) || ($time_stamp ne $last_timestamp)) {
2282                debug_message("Tick tack!") if DEBUG_TICKS;
2283                $time_colour = $time_colours[$time_colour_index % 2];
2284                $time_colour_index++;
2285                $last_msecs = $msecs;
2286                $last_timestamp = $time_stamp;
2287             }
2288
2289             $last_thread = $thread;
2290
2291             print_non_clf_message($content);
2292
2293         } elsif (m/^((?:\d+\.\d+\.\d+\.\d+|[:\d]+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2294
2295             # LOG_LEVEL_CLF lines look like this
2296             # 61.152.239.32 - - [04/Mar/2007:18:28:23 +0100] "GET \
2297             #  http://ad.yieldmanager.com/imp?z=1&Z=120x600&s=109339&u=http%3A%2F%2Fwww.365loan.co.uk%2F&r=1\
2298             #  HTTP/1.1" 403 1730
2299             our ($ip, $timestamp, $request_line, $status_code, $size) = ($1, $2, $3, $4, $5);
2300
2301             print_clf_message();
2302
2303         } else {
2304
2305             # Some Privoxy log messages span more than one line,
2306             # usually to dump lots of content that doesn't need any syntax highlighting.
2307             # XXX: add mechanism to forward these lines to the right handler anyway.
2308             chomp();
2309             unless (DEBUG_SUPPRESS_LOG_MESSAGES or (SUPPRESS_EMPTY_LINES and m/^\s+$/)) {
2310                 print and print get_line_end(); # unless (SUPPRESS_EMPTY_LINES and m/^\s+$/);
2311             }
2312         }
2313     }
2314 }
2315
2316 sub stats_loop () {
2317
2318     my ($day, $time_stamp, $msecs, $thread, $log_level, $content);
2319     my %log_level_handlers = (
2320          'Re-Filter'         => \&handle_loglevel_ignore,
2321          'Header'            => \&gather_loglevel_header_stats,
2322          'Connect'           => \&gather_loglevel_connect_stats,
2323          'Redirect'          => \&handle_loglevel_ignore,
2324          'Request'           => \&gather_loglevel_request_stats,
2325          'Crunch'            => \&gather_loglevel_crunch_stats,
2326          'Gif-Deanimate'     => \&handle_loglevel_ignore,
2327          'Info'              => \&handle_loglevel_ignore,
2328          'CGI'               => \&handle_loglevel_ignore,
2329          'Force'             => \&handle_loglevel_ignore,
2330          'Error'             => \&gather_loglevel_error_stats,
2331          'Fatal error'       => \&handle_loglevel_ignore,
2332          'Writing'           => \&handle_loglevel_ignore,
2333          'Received'          => \&handle_loglevel_ignore,
2334          'Actions'           => \&handle_loglevel_ignore,
2335          'Unknown log level' => \&handle_loglevel_ignore
2336     );
2337
2338     while (<>) {
2339         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/) {
2340             $day = $1;
2341             $time_stamp = $2;
2342             $msecs = $3 ? $3 : 0;
2343             $thread = $4;
2344             $log_level = $5;
2345             $content = $6;
2346
2347             if (defined($log_level_handlers{$log_level})) {
2348
2349                 $content = $log_level_handlers{$log_level}($content, $thread);
2350
2351             } else {
2352
2353                 die "No handler found for log level \"$log_level\"\n";
2354
2355             }
2356         }
2357     }
2358
2359     print_stats();
2360
2361 }
2362
2363 sub unbreak_lines_only_loop() {
2364     my $log_messages_reached = 0;
2365     while (<>) {
2366         chomp;
2367
2368             # Log level other than LOG_LEVEL_CLF?
2369         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/ or
2370             # LOG_LEVEL_CLF?
2371             m/^((?:\d+\.\d+\.\d+\.\d+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2372             $log_messages_reached = 1;
2373             print "\n";
2374
2375         } else {
2376             # Wrapped message
2377             $_ = "\n". $_  if /^(?:\d+\.\d+\.\d+\.\d+)/;
2378             $_ = " " . $_;
2379         }
2380         s@<BR>$@@;
2381         print;
2382         print "\n" unless $log_messages_reached;
2383     }
2384     print "\n";
2385 }
2386
2387 sub VersionMessage {
2388     my $version_message;
2389
2390     $version_message .= 'Privoxy-Log-Parser ' . PRIVOXY_LOG_PARSER_VERSION  . "\n";
2391     $version_message .= 'Copyright (C) 2007-2010 Fabian Keil <fk@fabiankeil.de>' . "\n";
2392     $version_message .= 'http://www.fabiankeil.de/sourcecode/privoxy-log-parser/' . "\n";
2393
2394     print $version_message;
2395 }
2396
2397 sub get_cli_options () {
2398
2399     our %cli_options = (
2400         'html-output'              => CLI_OPTION_DEFAULT_TO_HTML_OUTPUT,
2401         'title'                    => CLI_OPTION_TITLE,
2402         'no-syntax-highlighting'   => CLI_OPTION_NO_SYNTAX_HIGHLIGHTING,
2403         'no-embedded-css'          => CLI_OPTION_NO_EMBEDDED_CSS,
2404         'no-msecs'                 => CLI_OPTION_NO_MSECS,
2405         'shorten-thread-ids'       => CLI_OPTION_SHORTEN_THREAD_IDS,
2406         'show-ineffective-filters' => CLI_OPTION_SHOW_INEFFECTIVE_FILTERS,
2407         'accept-unknown-messages'  => CLI_OPTION_ACCEPT_UNKNOWN_MESSAGES,
2408         'statistics'               => CLI_OPTION_STATISTICS,
2409         'url-statistics-threshold' => CLI_OPTION_URL_STATISTICS_THRESHOLD,
2410         'unbreak-lines-only'       => CLI_OPTION_UNBREAK_LINES_ONLY,
2411         'host-statistics-threshold'=> CLI_OPTION_HOST_STATISTICS_THRESHOLD,
2412     );
2413
2414     GetOptions (
2415         'html-output'              => \$cli_options{'html-output'},
2416         'title'                    => \$cli_options{'title'},
2417         'no-syntax-highlighting'   => \$cli_options{'no-syntax-highlighting'},
2418         'no-embedded-css'          => \$cli_options{'no-embedded-css'},
2419         'no-msecs'                 => \$cli_options{'no-msecs'},
2420         'shorten-thread-ids'       => \$cli_options{'shorten-thread-ids'},
2421         'show-ineffective-filters' => \$cli_options{'show-ineffective-filters'},
2422         'accept-unknown-messages'  => \$cli_options{'accept-unknown-messages'},
2423         'statistics'               => \$cli_options{'statistics'},
2424         'unbreak-lines-only'       => \$cli_options{'unbreak-lines-only'},
2425         'url-statistics-threshold=i'=> \$cli_options{'url-statistics-threshold'},
2426         'host-statistics-threshold=i'=> \$cli_options{'host-statistics-threshold'},
2427         'version'                  => sub { VersionMessage && exit(0) },
2428         'help'                     => \&help,
2429    ) or exit(1);
2430
2431    $html_output_mode = cli_option_is_set('html-output');
2432    $no_msecs_mode = cli_option_is_set('no-msecs');
2433    $shorten_thread_ids = cli_option_is_set('shorten-thread-ids');
2434    $line_end = get_line_end();
2435 }
2436
2437 sub help () {
2438
2439     our %cli_options;
2440
2441     VersionMessage();
2442
2443     print << "    EOF"
2444
2445 Options and their default values if they have any:
2446     [--accept-unknown-messages]
2447     [--host-statistics-threshold $cli_options{'host-statistics-threshold'}]
2448     [--html-output]
2449     [--no-embedded-css]
2450     [--no-msecs]
2451     [--no-syntax-highlighting]
2452     [--shorten-thread-ids]
2453     [--show-ineffective-filters]
2454     [--statistics]
2455     [--unbreak-lines-only]
2456     [--url-statistics-threshold $cli_options{'url-statistics-threshold'}]
2457     [--title $cli_options{'title'}]
2458     [--version]
2459 see "perldoc $0" for more information
2460     EOF
2461     ;
2462     exit(0);
2463 }
2464
2465 ################################################################################
2466 # main
2467 ################################################################################
2468 sub main () {
2469
2470     get_cli_options();
2471     set_background(DEFAULT_BACKGROUND);
2472     prepare_our_stuff();
2473
2474     print_intro();
2475
2476     # XXX: should explicitly reject incompatible argument combinations
2477     if (cli_option_is_set('unbreak-lines-only')) {
2478         unbreak_lines_only_loop();
2479     } elsif (cli_option_is_set('statistics')) {
2480         stats_loop();
2481     } else {
2482         parse_loop();
2483     }
2484
2485     print_outro();
2486 }
2487
2488 main();
2489
2490 =head1 NAME
2491
2492 B<privoxy-log-parser> - A parser and syntax-highlighter for Privoxy log messages
2493
2494 =head1 SYNOPSIS
2495
2496 B<privoxy-log-parser> [B<--accept-unknown-messages>] [B<--html-output>]
2497 [B<--no-msecs>] [B<--no-syntax-higlighting>] [B<--statistics>]
2498 [B<--shorten-thread-ids>] [B<--show-ineffective-filters>]
2499 [B<--url-statistics-threshold>] [B<--version>]
2500
2501 =head1 DESCRIPTION
2502
2503 B<privoxy-log-parser> reads Privoxy log messages and
2504
2505 - syntax-highlights recognized lines,
2506
2507 - reformats some of them for easier comprehension,
2508
2509 - filters out less useful messages, and
2510
2511 - (in some cases) calculates additional information,
2512   like the compression ratio or how a filter affected
2513   the content size.
2514
2515 With B<privoxy-log-parser> you should be able to increase Privoxy's log level
2516 without getting confused by the resulting amount of output. For example for
2517 "debug 64" B<privoxy-log-parser> will (by default) only show messages that
2518 affect the content. If a filter doesn't cause any hits, B<privoxy-log-parser>
2519 will hide the "filter foo caused 0 hits" message.
2520
2521 =head1 OPTIONS
2522
2523 [B<--accept-unknown-messages>] Don't print warnings in case of unknown messages,
2524 just don't highlight them.
2525
2526 [B<--host-statistics-threshold>] Only show the request count for a host
2527 if it's above or equal to the given threshold. If the threshold is 0, host
2528 statistics are disabled.
2529
2530 [B<--html-output>] Use HTML and CSS for the syntax highlighting. If this option is
2531 omitted, ANSI escape sequences are used unless B<--no-syntax-highlighting> is active.
2532 This option is only intended to make embedding log excerpts in web pages easier.
2533 It does not escape any input!
2534
2535 [B<--no-msecs>] Don't expect milisecond resolution
2536
2537 [B<--no-syntax-highlighting>] Disable syntax-highlighting. Useful when
2538 the filtered output is piped into less in which case the ANSI control
2539 codes don't work, or if the terminal itself doesn't support the control
2540 codes.
2541
2542 [B<--shorten-thread-ids>] Shorten the thread ids to a three-digit decimal number.
2543 Note that the mapping from thread ids to shortened ids is created at run-time
2544 and thus varies with the input.
2545
2546 [B<--show-ineffective-filters>] Don't suppress log lines for filters
2547 that didn't modify the content.
2548
2549 [B<--statistics>] Gather various statistics instead of syntax highlighting
2550 log messages. This is an experimental feature, if the results look wrong
2551 they very well might be. Also note that the results are pretty much guaranteed
2552 to be incorrect if Privoxy and Privoxy-Log-Parser aren't in sync.
2553
2554 [B<--unbreak-lines-only>] Tries to fix lines that got messed up by a broken or
2555 interestingly configured mail client and thus are no longer recognized properly.
2556 Only fixes some breakage, but may be good enough or at least better than nothing.
2557 Doesn't do anything else, so you probably want to pipe the output into
2558 B<privoxy-log-parser> again.
2559
2560 [B<--url-statistics-threshold>] Only show the request count for a resource
2561 if it's above or equal to the given threshold. If the threshold is 0, URL
2562 statistics are disabled.
2563
2564 [B<--version>] Print version and exit.
2565
2566 =head1 EXAMPLES
2567
2568 To monitor a log file:
2569
2570 tail -F /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log | B<privoxy-log-parser>
2571
2572 Replace '-F' with '-f' if your tail implementation lacks '-F' support
2573 or if the log won't get rotated anyway. The log file location depends
2574 on your system (Doh!).
2575
2576 To monitor Privoxy without having it write to a log file:
2577
2578 privoxy --no-daemon /usr/jails/privoxy-jail/usr/local/etc/privoxy/config 2>&1 | B<privoxy-log-parser>
2579
2580 Again, the config file location depends on your system. Output redirection
2581 depends on your shell, the above works with bourne shells.
2582
2583 To read a processed Privoxy log file from top to bottom, letting the content
2584 scroll by slightly faster than you can read:
2585
2586 B<privoxy-log-parser> < /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log
2587
2588 This is probably only useful to fill screens in the background of haxor movies.
2589
2590 =head1 CAVEATS
2591
2592 Syntax highlighting with ANSI escape sequences will look strange
2593 if your background color isn't black.
2594
2595 Some messages aren't recognized yet and will not be fully highlighted.
2596
2597 B<privoxy-log-parser> is developed with Privoxy 3.0.7 or later in mind,
2598 using earlier Privoxy versions will probably result in an increased amount
2599 of unrecognized log lines.
2600
2601 Privoxy's log files tend to be rather large. If you use HTML
2602 highlighting some browsers can't handle them, get confused and
2603 will eventually crash because of segmentation faults or unexpected
2604 exceptions. This is a problem in the browser and not B<privoxy-log-parser>'s
2605 fault.
2606
2607 =head1 BUGS
2608
2609 Many settings can't be controlled through command line options yet.
2610
2611 =head1 SEE ALSO
2612
2613 privoxy(1)
2614
2615 =head1 AUTHOR
2616
2617 Fabian Keil <fk@fabiankeil.de>
2618
2619 =cut