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