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.117 2011/05/03 10:33:53 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/^Compressed content from /) {
1197
1198         # Compressed content from 29258 to 8630 bytes.
1199         $content =~ s@(?<=from )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1200         $content =~ s@(?<=to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1201
1202     } elsif ($c =~ m/^Reading in filter/) {
1203
1204         return '' unless SHOW_FILTER_READIN_IN;
1205
1206     } else {
1207
1208         found_unknown_content($content);
1209
1210     }
1211
1212     return $content;
1213 }
1214
1215 sub handle_loglevel_redirect ($) {
1216
1217     my $c = shift;
1218
1219     if ($c =~ m/^Decoding "([^""]*)"/) {
1220
1221          $req{$t}{'original-destination'} = $1;
1222          $c = highlight_matched_path($c, '(?<=Decoding ")[^"]*');
1223          $c =~ s@\"@@g;
1224
1225     } elsif ($c =~ m/^Checking/) {
1226
1227          # Checking /_ylt=A0geu.Z76BRGR9k/**http://search.yahoo.com/search?p=view+odb+presentation+on+freebsd\
1228          #  &ei=UTF-8&xargs=0&pstart=1&fr=moz2&b=11 for redirects.
1229
1230          # TODO: Change colour if really url-decoded
1231          $req{$t}{'decoded-original-destination'} = $1;
1232          $c = highlight_matched_path($c, '(?<=Checking ")[^"]*');
1233          $c =~ s@\"@@g;
1234
1235     } elsif ($c =~ m/^pcrs command "([^""]*)" changed /) {
1236
1237         # pcrs command "s@&from=rss@@" changed \
1238         #  "http://it.slashdot.org/article.pl?sid=07/03/02/1657247&from=rss"\
1239         #  to "http://it.slashdot.org/article.pl?sid=07/03/02/1657247" (1 hit).
1240         $c =~ s@(?<=pcrs command )"([^""]*)"@$h{'filter'}$1$h{'Standard'}@;
1241         $c = highlight_matched_url($c, '(?<=changed ")[^""]*');
1242         $c =~ s@(?<=changed )"([^""]*)"@$1@; # Remove quotes
1243         $c = highlight_matched_url($c, '(?<=to ")[^""]*');
1244         $c =~ s@(?<=to )"([^""]*)"@$1@; # Remove quotes
1245         $c =~ s@(\d+)(?= hits?)@$h{'hits'}$1$h{'Standard'}@;
1246
1247     } elsif ($c =~ m/^pcrs command "([^""]*)" didn\'t change/) {
1248
1249         # pcrs command "s@^http://([^.]+?)/?$@http://www.bing.com/search?q=$1@" didn't \
1250         #  change "http://www.example.org/".
1251         $c =~ s@(?<=pcrs command )"([^""]*)"@$h{'filter'}$1$h{'Standard'}@;
1252         $c = highlight_matched_url($c, '(?<=change ")[^""]*');
1253
1254     } elsif ($c =~ m/(^New URL is: )(.*)/) {
1255
1256         # New URL is: http://it.slashdot.org/article.pl?sid=07/03/04/1511210
1257         # XXX: Use URL highlighter
1258         # XXX: Save?
1259         $c = $1 . h('rewritten-URL') . $2 . h('Standard');
1260
1261     } elsif ($c =~ m/No pcrs command recognized, assuming that/) {
1262         # No pcrs command recognized, assuming that "http://config.privoxy.org/user-manual/favicon.png"\
1263         #  is already properly formatted.
1264         # XXX: assume the same?
1265         $c = highlight_matched_url($c, '(?<=assuming that \")[^"]*');
1266
1267     } else {
1268
1269         found_unknown_content($c);
1270
1271     }
1272
1273     return $c;
1274 }
1275
1276 sub handle_loglevel_gif_deanimate ($) {
1277
1278     my $content = shift;
1279
1280     if ($content =~ m/Success! GIF shrunk from (\d+) bytes to (\d+)\./) {
1281
1282         my $bytes_from = $1;
1283         my $bytes_to = $2;
1284         # Gif-Deanimate: Success! GIF shrunk from 205 bytes to 133.
1285         $content =~ s@$bytes_from@$h{'Number'}$bytes_from$h{'Standard'}@;
1286         # XXX: Do we need g in case of ($1 == $2)?
1287         $content =~ s@$bytes_to@$h{'Number'}$bytes_to$h{'Standard'}@;
1288
1289     } elsif ($content =~ m/GIF (not) changed/) {
1290
1291         # Gif-Deanimate: GIF not changed.
1292         return '' if SUPPRESS_GIF_NOT_CHANGED;
1293         $content =~ s@($1)@$h{'not'}$1$h{'Standard'}@;
1294
1295     } elsif ($content =~ m/^failed! \(gif parsing\)/) {
1296
1297         # failed! (gif parsing)
1298         # XXX: Replace this error message with something less stupid
1299         $content =~ s@(failed!)@$h{'error'}$1$h{'Standard'}@;
1300
1301     } elsif ($content =~ m/^Need to de-chunk first/) {
1302
1303         # Need to de-chunk first
1304         return '' if SUPPRESS_NEED_TO_DE_CHUNK_FIRST;
1305
1306     } elsif ($content =~ m/^(?:No GIF header found|failed while parsing)/) {
1307
1308         # No GIF header found (XXX: Did I ever commit this?)
1309         # failed while parsing 195 134747048 (XXX: never committed)
1310
1311         # Ignore these for now
1312
1313     } else {
1314
1315         found_unknown_content($content);
1316
1317     }
1318
1319     return $content;
1320 }
1321
1322 sub handle_loglevel_request ($) {
1323
1324     my $content = shift;
1325
1326     if ($content =~ m/crunch! /) {
1327
1328         # config.privoxy.org/send-stylesheet crunch! (CGI Call)
1329
1330         # Highlight crunch reasons
1331         foreach my $reason (keys %reason_colours) {
1332             $content =~ s@\(($reason)\)@$reason_colours{$reason}($1)$h{'Standard'}@g;
1333         }
1334         # Highlight request URL domain and ditch 'crunch!'
1335         $content = highlight_matched_pattern($content, 'request_', '[^ ]*(?= crunch!)');
1336         $content =~ s@ crunch!@@;
1337
1338     } elsif ($content =~ m/\[too long, truncated\]$/) {
1339
1340         # config.privoxy.org/edit-actions-submit?f=3&v=1176116716&s=7&Submit=Submit[...]&filter... [too long, truncated]
1341         $content = highlight_matched_pattern($content, 'request_', '^.*(?=\.\.\. \[too long, truncated\]$)');
1342
1343     } elsif ($content =~ m/(.*)/) { # XXX: Pretty stupid
1344
1345         # trac.vidalia-project.net/wiki/Volunteer?format=txt
1346         $content = h('request_') . $content . h('Standard');
1347
1348     } else {  # XXX: Nop
1349
1350         found_unknown_content($content);
1351
1352     }
1353
1354     return $content;
1355 }
1356
1357 sub handle_loglevel_crunch ($) {
1358
1359     my $content = shift;
1360
1361     # Highlight crunch reason
1362     foreach my $reason (keys %reason_colours) {
1363         $content =~ s@($reason)@$reason_colours{$reason}$1$h{'Standard'}@g;
1364     }
1365
1366     if ($content =~ m/\[too long, truncated\]$/) {
1367
1368         # Blocked: config.privoxy.org/edit-actions-submit?f=3&v=1176116716&s=7&Submit=Submit\
1369         #  [...]&filter... [too long, truncated]
1370         $content = highlight_matched_pattern($content, 'request_', '^.*(?=\.\.\. \[too long, truncated\]$)');
1371
1372     } else {
1373
1374         # Blocked: http://ads.example.org/
1375         $content = highlight_matched_pattern($content, 'request_', '(?<=: ).*');
1376     }
1377
1378     return $content;
1379 }
1380
1381 sub handle_loglevel_connect ($) {
1382
1383     my $c = shift;
1384
1385     if ($c =~ m/^via [^\s]+ to: [^\s]+/) {
1386
1387         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
1388
1389         $c = highlight_matched_host($c, '(?<=via )[^\s]+');
1390         $c = highlight_matched_host($c, '(?<=to: )[^\s]+');
1391
1392     } elsif ($c =~ m/^connect to: .* failed: .*/) {
1393
1394         # connect to: www.example.org.noconnect failed: Operation not permitted
1395
1396         $c = highlight_matched_host($c, '(?<=connect to: )[^\s]+');
1397
1398         $c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1399
1400     } elsif ($c =~ m/^to ([^\s]*)( successful)?$/) {
1401
1402         # Connect: to www.nzherald.co.nz successful
1403         # Connect: to archiv.radiotux.de
1404
1405         return '' if SUPPRESS_SUCCESSFUL_CONNECTIONS;
1406         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1407
1408     } elsif ($c =~ m/^to ([^\s]*)$/) {
1409
1410         # Connect: to lists.sourceforge.net:443
1411
1412         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1413
1414     } elsif ($c =~ m/^accepted connection from .*/ or
1415              $c =~ m/^OK/) {
1416
1417         # accepted connection from 10.0.0.1
1418         # Privoxy 3.0.6 and earlier just say:
1419         # OK
1420         return '' if SUPPRESS_ACCEPTED_CONNECTIONS;
1421         $c = highlight_matched_host($c, '(?<=connection from ).*');
1422
1423     } elsif ($c =~ m/^write header to: .* failed:/) {
1424
1425         # write header to: 10.0.0.1 failed: Broken pipe
1426
1427         $c = highlight_matched_host($c, '(?<=write header to: )[^\s]*');
1428         $c =~ s@(?<=failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1429
1430     } elsif ($c =~ m/^write header to client failed:/) {
1431
1432         # write header to client failed: Broken pipe
1433         # XXX: Stil in use?
1434         $c =~ s@(?<=failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1435
1436     } elsif ($c =~ m/^socks4_connect:/) {
1437
1438         # socks4_connect: SOCKS request rejected or failed.
1439         $c =~ s@(?<=socks4_connect: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1440
1441     } elsif ($c =~ m/^Listening for new connections/ or
1442              $c =~ m/^accept connection/) {
1443         # XXX: Highlight?
1444         # Privoxy versions above 3.0.6 say:
1445         # Listening for new connections ...
1446         # earlier versions say:
1447         # accept connection ...
1448         return '';
1449
1450     } elsif ($c =~ m/^accept failed:/) {
1451
1452         $c =~ s@(?<=accept failed: )(.*)@$h{'Error'}$1$h{'Standard'}@;
1453
1454     } elsif ($c =~ m/^Overriding forwarding settings/) {
1455
1456         # Overriding forwarding settings based on 'forward 10.0.0.1:8123'
1457         $c =~ s@(?<=based on \')(.*)(?=\')@$h{'configuration-line'}$1$h{'Standard'}@;
1458
1459     } elsif ($c =~ m/^Denying suspicious CONNECT request from/) {
1460
1461         # Denying suspicious CONNECT request from 10.0.0.1
1462         $c = highlight_matched_host($c, '(?<=from )[^\s]+'); # XXX: not an URL
1463
1464     } elsif ($c =~ m/^socks5_connect:/) {
1465
1466         $c =~ s@(?<=socks5_connect: )(.*)@$h{'error'}$1$h{'Standard'}@;
1467
1468     } elsif ($c =~ m/^Created new connection to/) {
1469
1470         # Created new connection to www.privoxy.org:80 on socket 11.
1471         $c = highlight_matched_host($c, '(?<=connection to )[^\s]+');
1472         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1473
1474     } elsif ($c =~ m/^Found reusable socket/) {
1475
1476         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
1477         # 3.0.15 and later:
1478         # Found reusable socket 8 for www.privoxy.org:80 in slot 2.\
1479         #  Timestamp made 0 seconds ago. Timeout: 1. Latency: 0.
1480         $c =~ s@(?<=Found reusable socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1481         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1482         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1483         $c =~ s@(?<=made )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1484         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1485         $c =~ s@(?<=Latency: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1486
1487     } elsif ($c =~ m/^Marking open socket/) {
1488
1489         # Marking open socket 9 for www.privoxy.org:80 in slot 0 as unused.
1490         $c =~ s@(?<=Marking open socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1491         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1492         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1493
1494     } elsif ($c =~ m/^No reusable/) {
1495
1496         # No reusable socket for addons.mozilla.org:443 found. Opening a new one.
1497         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1498
1499     } elsif ($c =~ m/^(Remembering|Forgetting) socket/) {
1500
1501         # Remembering socket 13 for www.privoxy.org:80 in slot 0.
1502         # Forgetting socket 38 for www.privoxy.org:80 in slot 5.
1503
1504         $c =~ s@(?<=socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1505         $c = highlight_matched_host($c, '(?<=for )[^\s]+');
1506         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1507
1508     } elsif ($c =~ m/^Socket/) {
1509
1510         # Socket 16 already forgotten or never remembered.
1511         $c =~ s@(?<=Socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1512
1513     } elsif ($c =~ m/^The connection to/) {
1514
1515         # The connection to www.privoxy.org:80 in slot 6 timed out. Closing socket 19. Timeout is: 61.
1516         # 3.0.15 and later:
1517         # The connection to 1.bp.blogspot.com:80 in slot 0 timed out. Closing socket 5.\
1518         #  Timeout is: 1. Assumed latency: 4.
1519         # The connection to 10.0.0.1:80 in slot 0 is no longer usable. Closing socket 4.
1520         $c = highlight_matched_host($c, '(?<=connection to )[^\s]+');
1521         $c =~ s@(?<=in slot )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1522         $c =~ s@(?<=Closing socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1523         $c =~ s@(?<=Timeout is: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1524         $c =~ s@(?<=Assumed latency: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1525
1526     } elsif ($c =~ m/^Stopped waiting for the request line./) {
1527
1528         # Stopped waiting for the request line. Timeout: 121.
1529         $c =~ s@(?<=Timeout: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1530
1531     } elsif ($c =~ m/^Waiting for \d/) {
1532
1533         # Waiting for 1 connections to timeout.
1534         $c =~ s@(?<=^Waiting for )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1535
1536     } elsif ($c =~ m/^Initialized/) {
1537
1538         # Initialized 20 socket slots.
1539         $c =~ s@(?<=Initialized )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1540
1541     } elsif ($c =~ m/^Done reading from server/) {
1542
1543         # Done reading from server. Expected content length: 24892. \
1544         #  Actual content length: 24892. Most recently received: 4412.
1545         # 3.0.15 and later:
1546         # Done reading from server. Expected content length: 24892. \
1547         #  Actual content length: 24892. Bytes most recently read: 4412.
1548         # Done reading from server. Content length: 6018 as expected. \
1549         #  Bytes most recently read: 294.
1550         $c =~ s@(?<=ontent length: )(\d+)@$h{'Number'}$1$h{'Standard'}@g;
1551         $c =~ s@(?<=received: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1552         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1553
1554     } elsif ($c =~ m/^Continuing buffering headers/) {
1555
1556         # Continuing buffering headers. byte_count: 19. header_offset: 517. len: 536.
1557         $c =~ s@(?<=byte_count: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1558         $c =~ s@(?<=header_offset: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1559         $c =~ s@(?<=len: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1560         # 3.0.15 and later:
1561         # Continuing buffering headers. Bytes most recently read: %d.
1562         $c =~ s@(?<=read: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1563
1564     } elsif ($c =~ m/^Received \d+ bytes while/) {
1565
1566         # Received 206 bytes while expecting 12103.
1567         $c =~ s@(?<=Received )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1568         $c =~ s@(?<=expecting )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1569
1570     } elsif ($c =~ m/^(Rejecting c|C)onnection from/) {
1571
1572         # Connection from 81.163.28.218 dropped due to ACL
1573         # Rejecting connection from 178.63.152.227. Maximum number of connections reached.
1574         $c =~ s@(?<=onnection from )((?:\d+\.?){3}\d+)@$h{'Number'}$1$h{'Standard'}@;
1575
1576     } elsif ($c =~ m/^(?:Reusing|Closing) server socket \d./ or
1577              $c =~ m/^No additional client request/) {
1578
1579         # Reusing server socket 4. Opened for 10.0.0.1.
1580         # Closing server socket 2. Opened for 10.0.0.1.
1581         # No additional client request received in time. \
1582         #  Closing server socket 4, initially opened for 10.0.0.1.
1583         # No additional client request received in time on socket 29.
1584
1585         $c =~ s@(?<= socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1586         $c = highlight_matched_host($c, '(?<=for )[^\s]+(?=\.$)');
1587
1588     } elsif ($c =~ m/^Connected to /) {
1589
1590         # Connected to tor-jail[10.0.0.2]:9050.
1591
1592         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1593         $c = highlight_matched_host($c, '(?<=Connected to )[^\[\s]+');
1594         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1595
1596     } elsif ($c =~ m/^Could not connect to /) {
1597
1598         # Could not connect to [10.0.0.1]:80.
1599
1600         $c = highlight_matched_host($c, '(?<=\[)[^\]]+');
1601         $c =~ s@(?<=\]:)(\d+)@$h{'Number'}$1$h{'Standard'}@;
1602
1603     } elsif ($c =~ m/^Waiting for the next client request/ or
1604              $c =~ m/^The connection on server socket/ or
1605              $c =~ m/^Client request arrived in time /) {
1606
1607         # Waiting for the next client request on socket 3. Keeping the server \
1608         #  socket 12 to a.fsdn.com open.
1609         # The connection on server socket 6 to upload.wikimedia.org isn't reusable. Closing.
1610         # Used by Privoxy 3.0.18 and later:
1611         # Client request arrived in time on socket 21.
1612         # Used by earlier version:
1613         # Client request arrived in time or the client closed the connection on socket 12.
1614
1615         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1616         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1617         $c = highlight_matched_host($c, '(?<=to )[^\s]+');
1618
1619     } elsif ($c =~ m/^Marking the server socket/) {
1620
1621         # Marking the server socket 7 tainted.
1622
1623         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1624
1625     } elsif ($c =~ m/^Reduced expected bytes to /) {
1626
1627         # Reduced expected bytes to 0 to account for the 1542 ones we already got.
1628         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1629         $c =~ s@(?<=for the )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1630
1631     } elsif ($c =~ m/^The client closed socket /) {
1632
1633         # The client closed socket 2 while the server socket 4 is still open.
1634         $c =~ s@(?<=closed socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1635         $c =~ s@(?<=server socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1636
1637     } elsif ($c =~ m/^Expected client content length set /) {
1638
1639         # Expected client content length set to 667325411 after reading 4999 bytes.
1640         $c =~ s@(?<=set to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1641         $c =~ s@(?<=reading )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1642
1643     } elsif ($c =~ m/^Reducing expected bytes to /) {
1644
1645         # Reducing expected bytes to 0. Marking the server socket tainted after throwing 4 bytes away.
1646         $c =~ s@(?<=bytes to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1647         $c =~ s@(?<=after throwing )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1648
1649     } elsif ($c =~ m/^Waiting for up to /) {
1650
1651         # Waiting for up to 4999 bytes from the client.
1652         $c =~ s@(?<=up to )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1653
1654     } elsif ($c =~ m/^Looks like we / or
1655              $c =~ m/^Unsetting keep-alive flag/ or
1656              $c =~ m/^No connections to wait/ or
1657              $c =~ m/^Complete client request received/ or
1658              $c =~ m/^Possible pipeline attempt detected./ or
1659              $c =~ m/^POST request detected. The connection will not be kept alive./ or
1660              $c =~ m/^The server still wants to talk, but the client hung up on us./ or
1661              $c =~ m/^The server didn't specify how long the connection will stay open/ or
1662              $c =~ m/^There might be a request body. The connection will not be kept alive/ or
1663              $c =~ m/^Stopping to watch the client socket. There's already another request waiting./ or
1664              $c =~ m/^Done reading from the client\.$/) {
1665
1666         # Looks like we reached the end of the last chunk. We better stop reading.
1667         # Looks like we read the end of the last chunk together with the server \
1668         #  headers. We better stop reading.
1669         # Looks like we got the last chunk together with the server headers. \
1670         #  We better stop reading.
1671         # Unsetting keep-alive flag.
1672         # No connections to wait for left.
1673         # Client request arrived in time or the client closed the connection.
1674         # Complete client request received
1675         # Possible pipeline attempt detected. The connection will not be \
1676         #  kept alive and we will only serve the first request.
1677         # POST request detected. The connection will not be kept alive.
1678         # The server still wants to talk, but the client hung up on us.
1679         # The server didn't specify how long the connection will stay open. Assume it's only a second.
1680         # There might be a request body. The connection will not be kept alive.
1681         # Stopping to watch the client socket. There's already another request waiting.
1682         # Done reading from the client\.
1683
1684     } else {
1685
1686         found_unknown_content($c);
1687
1688     }
1689
1690     return $c;
1691 }
1692
1693
1694 sub handle_loglevel_info ($) {
1695
1696     my $c = shift;
1697
1698     if ($c =~ m/^Rewrite detected:/) {
1699
1700         # Rewrite detected: GET http://10.0.0.2:88/blah.txt HTTP/1.1
1701         $c = highlight_matched_request_line($c, '(?<=^Rewrite detected: ).*');
1702
1703     } elsif ($c =~ m/^Decompress(ing deflated|ion didn)/ or
1704              $c =~ m/^Compressed content detected/ or
1705              $c =~ m/^SDCH-compressed content detected/ or
1706              $c =~ m/^Tagger/
1707             ) {
1708         # Decompressing deflated iob: 117
1709         # Decompression didn't result in any content.
1710         # Compressed content detected, content filtering disabled. Consider recompiling Privoxy\
1711         #  with zlib support or enable the prevent-compression action.
1712         # SDCH-compressed content detected, content filtering disabled.\
1713         #  Consider suppressing SDCH offers made by the client.
1714         # Tagger 'complete-url' created empty tag. Ignored.
1715
1716         # Ignored for now
1717
1718     } elsif ($c =~ m/^(Re)?loading configuration file /) {
1719
1720         # loading configuration file '/usr/local/etc/privoxy/config':
1721         # Reloading configuration file '/usr/local/etc/privoxy/config'
1722         $c =~ s@(?<=loading configuration file \')([^\']*)@$h{'file'}$1$h{'Standard'}@;
1723
1724     } elsif ($c =~ m/^Loading (actions|filter) file: /) {
1725
1726         # Loading actions file: /usr/local/etc/privoxy/default.action
1727         # Loading filter file: /usr/local/etc/privoxy/default.filter
1728         $c =~ s@(?<= file: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1729
1730     } elsif ($c =~ m/^exiting by signal/) {
1731
1732         # exiting by signal 15 .. bye
1733         $c =~ s@(?<=exiting by signal )(\d+)@$h{'signal'}$1$h{'Standard'}@;
1734
1735     } elsif ($c =~ m/^Privoxy version/) {
1736
1737         # Privoxy version 3.0.7
1738         $c =~ s@(?<=^Privoxy version )(\d+\.\d+\.\d+)$@$h{'version'}$1$h{'Standard'}@;
1739
1740     } elsif ($c =~ m/^Program name: /) {
1741
1742         # Program name: /usr/local/sbin/privoxy
1743         $c =~ s@(?<=Program name: )(.*)@$h{'program-name'}$1$h{'Standard'}@;
1744
1745     } elsif ($c =~ m/^Listening on port /) {
1746
1747         # Listening on port 8118 on IP address 10.0.0.1
1748         $c =~ s@(?<=Listening on port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1749         $c =~ s@(?<=on IP address )(.*)@$h{'ip-address'}$1$h{'Standard'}@;
1750
1751     } elsif ($c =~ m/^\(Re-\)Open(?:ing)? logfile/) {
1752
1753         # (Re-)Open logfile /var/log/privoxy/privoxy.log
1754         $c =~ s@(?<=Open logfile )(.*)@$h{'file'}$1$h{'Standard'}@;
1755
1756     } elsif ($c =~ m/^(Request from|Malformed server response detected)/) {
1757
1758         # Request from 10.0.0.1 denied. limit-connect{,} doesn't allow CONNECT requests to port 443.
1759         # Request from 10.0.0.1 marked for blocking. limit-connect{,} doesn't allow CONNECT requests to port 443.
1760         # 3.0.18 and later:
1761         # Request from 10.0.0.1 marked for blocking. limit-connect{0} doesn't allow CONNECT requests to www.example.org:443
1762         # Malformed server response detected. Downgrading to HTTP/1.0 impossible.
1763
1764         $c =~ s@(?<=Request from )([^\s]*)@$h{'ip-address'}$1$h{'Standard'}@;
1765         $c =~ s@(denied|blocking)@$h{'warning'}$1$h{'Standard'}@;
1766         $c =~ s@(CONNECT)@$h{'method'}$1$h{'Standard'}@;
1767         $c =~ s@(?<=to port )(\d+)@$h{'port'}$1$h{'Standard'}@;
1768         $c =~ s@(?<=to )([^\s]+)@$h{'request_'}$1$h{'Standard'}@;
1769
1770     } elsif ($c =~ m/^Status code/) {
1771
1772         # Status code 304 implies no body.
1773         $c =~ s@(?<=Status code )(\d+)@$h{'status-code'}$1$h{'Standard'}@;
1774
1775     } elsif ($c =~ m/^Method/) {
1776
1777         # Method HEAD implies no body.
1778         $c =~ s@(?<=Method )([^\s]+)@$h{'method'}$1$h{'Standard'}@;
1779
1780     } elsif ($c =~ m/^Buffer limit reached while extending /) {
1781
1782         # Buffer limit reached while extending the buffer (iob). Needed: 4197470. Limit: 4194304
1783         $c =~ s@(?<=Needed: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1784         $c =~ s@(?<=Limit: )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1785
1786     } elsif ($c =~ m/^File modification detected: /) {
1787
1788         # File modification detected: /usr/local/etc/privoxy/user-agent.action
1789         $c =~ s@(?<= detected: )(.*)$@$h{'file'}$1$h{'Standard'}@;
1790
1791     } elsif ($c =~ m/^No logfile configured/ or
1792              $c =~ m/^Malformerd HTTP headers detected and MS IIS5 hack enabled/ or
1793              $c =~ m/^Invalid \"chunked\" transfer/ or
1794              $c =~ m/^Support for/ or
1795              $c =~ m/^Flushing header and buffers/ or
1796              $c =~ m/^Can not resolve/
1797              ) {
1798
1799         # No logfile configured. Please enable it before reporting any problems.
1800         # Malformerd HTTP headers detected and MS IIS5 hack enabled. Expect an invalid \
1801         #  response or even no response at all.
1802         # No logfile configured. Logging disabled.
1803         # Invalid "chunked" transfer encoding detected and ignored.
1804         # Support for 'Connection: keep-alive' is experimental, incomplete and\
1805         #  known not to work properly in some situations.
1806         # Flushing header and buffers. Stepping back from filtering.
1807         # Can not resolve doesnotexist: hostname nor servname provided, or not known
1808
1809     } else {
1810
1811         found_unknown_content($c);
1812
1813     }
1814
1815     return $c;
1816 }
1817
1818 sub handle_loglevel_cgi ($) {
1819
1820     my $c = shift;
1821
1822     if ($c =~ m/^Granting access to/) {
1823
1824         #Granting access to http://config.privoxy.org/send-stylesheet, referrer http://p.p/ is trustworthy.
1825
1826     } elsif ($c =~ m/^Substituting: s(.)/) {
1827
1828         # Substituting: s/@else-not-FEATURE_ZLIB@.*@endif-FEATURE_ZLIB@//sigTU
1829         # XXX: prone to span several lines
1830
1831         my $delimiter = $1;
1832         #$c =~ s@(?<=failed: )(.*)@$h{'error'}$1$h{'Standard'}@;
1833         $c =~ s@(?!<=\\)($delimiter)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g; # XXX: Too aggressive
1834         #$c =~ s@(?!<=\\)($1)@$h{'pcrs-delimiter'}$1$h{'Standard'}@g;
1835     }
1836
1837     return $c;
1838 }
1839
1840 sub handle_loglevel_force ($) {
1841
1842     my $c = shift;
1843
1844     if ($c =~ m/^Ignored force prefix in request:/) {
1845
1846         # Ignored force prefix in request: "GET http://10.0.0.1/PRIVOXY-FORCE/block HTTP/1.1"
1847         $c =~ s@^(Ignored)@$h{'ignored'}$1$h{'Standard'}@;
1848         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1849
1850     } elsif ($c =~ m/^Enforcing request:/) {
1851
1852         # Enforcing request: "GET http://10.0.0.1/block HTTP/1.1".
1853         $c = highlight_matched_request_line($c, '(?<=request: ")[^"]*');
1854
1855     } else {
1856
1857         found_unknown_content($c);
1858
1859     }
1860
1861     return $c;
1862 }
1863
1864 sub handle_loglevel_error ($) {
1865
1866     my $c = shift;
1867
1868     if ($c =~ m/^Empty server or forwarder response received on socket \d+./) {
1869
1870         # Empty server or forwarder response received on socket 4.
1871         # Empty server or forwarder response received on socket 3. \
1872         #  Closing client socket 15 without sending data.
1873         $c =~ s@(?<=on socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1874         $c =~ s@(?<=client socket )(\d+)@$h{'Number'}$1$h{'Standard'}@;
1875     }
1876     # XXX: There are probably more messages that deserve highlighting.
1877
1878     return $c;
1879 }
1880
1881
1882 sub handle_loglevel_ignore ($) {
1883     return shift;
1884 }
1885
1886 sub gather_loglevel_request_stats ($$) {
1887     my $c = shift;
1888     my $thread = shift;
1889     our %stats;
1890
1891     $stats{requests}++;
1892 }
1893
1894 sub gather_loglevel_crunch_stats ($$) {
1895     my $c = shift;
1896     my $thread = shift;
1897     our %stats;
1898
1899     $stats{requests}++;
1900     $stats{crunches}++;
1901
1902     if ($c =~ m/^Redirected:/) {
1903         # Redirected: http://www.example.org/http://p.p/
1904         $stats{'fast-redirections'}++;
1905
1906     } elsif ($c =~ m/^Blocked:/) {
1907         # Blocked: blogger.googleusercontent.com:443
1908         $stats{'blocked'}++;
1909     }
1910 }
1911
1912
1913 sub gather_loglevel_error_stats ($$) {
1914
1915     my $c = shift;
1916     my $thread = shift;
1917     our %stats;
1918     our %thread_data;
1919
1920     if ($c =~ m/^Empty server or forwarder response received on socket \d+./) {
1921
1922         # Empty server or forwarder response received on socket 4.
1923         $stats{'empty-responses'}++;
1924         if ($thread_data{$thread}{'new_connection'}) {
1925             $stats{'empty-responses-on-new-connections'}++;
1926         } else {
1927             $stats{'empty-responses-on-reused-connections'}++;
1928         }
1929     }
1930 }
1931
1932 sub gather_loglevel_connect_stats ($$) {
1933
1934     my ($c, $thread) = @_;
1935     our %thread_data;
1936     our %stats;
1937
1938     if ($c =~ m/^via ([^\s]+) to: [^\s]+/) {
1939
1940         # Connect: via 10.0.0.1:8123 to: www.example.org.noconnect
1941         $thread_data{$thread}{'forwarder'} = $1; # XXX: is this missue?
1942
1943     } elsif ($c =~ m/^to ([^\s]*)$/) {
1944
1945         # Connect: to lists.sourceforge.net:443
1946
1947         $thread_data{$thread}{'forwarder'} = 'direct connection';
1948
1949     } elsif ($c =~ m/^Created new connection to/) {
1950
1951         # Created new connection to www.privoxy.org:80 on socket 11.
1952
1953         $thread_data{$thread}{'new_connection'} = 1;
1954
1955     } elsif ($c =~ m/^Reusing server socket \d./ or
1956              $c =~ m/^Found reusable socket/) {
1957
1958         # Reusing server socket 4. Opened for 10.0.0.1.
1959         # Found reusable socket 9 for www.privoxy.org:80 in slot 0.
1960
1961         $thread_data{$thread}{'new_connection'} = 0;
1962         $stats{'reused-connections'}++;
1963     }
1964 }
1965
1966 sub gather_loglevel_header_stats ($$) {
1967
1968     my ($c, $thread) = @_;
1969     our %stats;
1970
1971     if ($c =~ m/^A HTTP\/1\.1 response without/ or
1972         $c =~ m/^Keeping the server header 'Connection: keep-alive' around./)
1973     {
1974         # A HTTP/1.1 response without Connection header implies keep-alive.
1975         # Keeping the server header 'Connection: keep-alive' around.
1976         $stats{'server-keep-alive'}++;
1977
1978     } elsif ($c =~ m/^scan: ((\w+) (.+) (HTTP\/\d\.\d))/) {
1979
1980         # scan: HTTP/1.1 200 OK
1981         $stats{'method'}{$2}++;
1982         $stats{'ressource'}{$3}++;
1983         $stats{'http-version'}{$4}++;
1984
1985     } elsif ($c =~ m/^scan: Host: ([^\s]+)/) {
1986
1987         # scan: Host: p.p
1988         $stats{'hosts'}{$1}++;
1989     }
1990 }
1991
1992 sub init_stats () {
1993     our %stats = (
1994         requests => 0,
1995         crunches => 0,
1996         'server-keep-alive' => 0,
1997         'reused-connections' => 0,
1998         'empty-responses' => 0,
1999         'empty-responses-on-new-connections' => 0,
2000         'empty-responses-on-reused-connections' => 0,
2001         'fast-redirections' => 0,
2002         'blocked' => 0,
2003         'reused-connections' => 0,
2004         'server-keep-alive' => 0,
2005         );
2006 }
2007
2008 sub get_percentage ($$) {
2009     my $big = shift;
2010     my $small = shift;
2011     return "NaN" if ($big eq 0);
2012     return sprintf("%.2f%%", $small / $big * 100);
2013 }
2014
2015 sub print_stats () {
2016
2017     our %stats;
2018     our %cli_options;
2019     my $new_connections = $stats{requests} - $stats{crunches} - $stats{'reused-connections'};
2020     my $outgoing_requests = $stats{requests} - $stats{crunches};
2021
2022     if ($stats{requests} eq 0) {
2023         print "No requests yet.\n";
2024         return;
2025     }
2026
2027     print "Client requests total: " . $stats{requests} . "\n";
2028     print "Crunches: " . $stats{crunches} . " (" .
2029         get_percentage($stats{requests}, $stats{crunches}) . ")\n";
2030     print "Blocks: " . $stats{'blocked'} . " (" .
2031         get_percentage($stats{requests}, $stats{'blocked'}) . ")\n";
2032     print "Fast redirections: " . $stats{'fast-redirections'} . " (" .
2033         get_percentage($stats{requests}, $stats{'fast-redirections'}) . ")\n";
2034     print "Outgoing requests: " . $outgoing_requests . " (" .
2035         get_percentage($stats{requests}, $outgoing_requests) . ")\n";
2036     print "Server keep-alive offers: " . $stats{'server-keep-alive'} . " (" .
2037         get_percentage($stats{requests}, $stats{'server-keep-alive'}) . ")\n";
2038     print "New outgoing connections: " . $new_connections . " (" .
2039         get_percentage($stats{requests}, $new_connections) . ")\n";
2040     print "Reused connections: " . $stats{'reused-connections'} . " (" .
2041         get_percentage($stats{requests}, $stats{'reused-connections'}) .
2042         "; server offers accepted: " .
2043         get_percentage($stats{'server-keep-alive'}, $stats{'reused-connections'}) . ")\n";
2044     print "Empty responses: " . $stats{'empty-responses'} . " (" .
2045         get_percentage($stats{requests}, $stats{'empty-responses'}) . ")\n";
2046     print "Empty responses on new connections: "
2047          . $stats{'empty-responses-on-new-connections'} . " (" .
2048         get_percentage($stats{requests}, $stats{'empty-responses-on-new-connections'})
2049         . ")\n";
2050     print "Empty responses on reused connections: " .
2051         $stats{'empty-responses-on-reused-connections'} . " (" .
2052         get_percentage($stats{requests}, $stats{'empty-responses-on-reused-connections'}) .
2053         ")\n";
2054
2055     if ($stats{method} eq 0) {
2056         print "No response lines parsed yet yet.\n";
2057         return;
2058     }
2059     print "Method distribution:\n";
2060     foreach my $method (sort {$stats{'method'}{$b} <=> $stats{'method'}{$a}} keys %{$stats{'method'}}) {
2061         printf "%8d : %-8s\n", $stats{'method'}{$method}, $method;
2062     }
2063     print "Client HTTP versions:\n";
2064     foreach my $http_version (sort {$stats{'http-version'}{$b} <=> $stats{'http-version'}{$a}} keys %{$stats{'http-version'}}) {
2065         printf "%d : %s\n",  $stats{'http-version'}{$http_version}, $http_version;
2066     }
2067
2068     if ($cli_options{'url-statistics-threshold'} == 0) {
2069         print "URL statistics are disabled. Increase --url-statistics-threshold to enable them.\n";
2070     } else {
2071         print "Requested URLs:\n";
2072         foreach my $ressource (sort {$stats{'ressource'}{$b} <=> $stats{'ressource'}{$a}} keys %{$stats{'ressource'}}) {
2073             if ($stats{'ressource'}{$ressource} < $cli_options{'url-statistics-threshold'}) {
2074                 print "Skipped statistics for URLs below the treshold.\n";
2075                 last;
2076             }
2077             printf "%d : %s\n", $stats{'ressource'}{$ressource}, $ressource;
2078         }
2079     }
2080
2081     if ($cli_options{'host-statistics-threshold'} == 0) {
2082         print "Host statistics are disabled. Increase --host-statistics-threshold to enable them.\n";
2083     } else {
2084         print "Requested Hosts:\n";
2085         foreach my $host (sort {$stats{'hosts'}{$b} <=> $stats{'hosts'}{$a}} keys %{$stats{'hosts'}}) {
2086             if ($stats{'hosts'}{$host} < $cli_options{'host-statistics-threshold'}) {
2087                 print "Skipped statistics for Hosts below the treshold.\n";
2088                 last;
2089             }
2090             printf "%d : %s\n", $stats{'hosts'}{$host}, $host;
2091         }
2092     }
2093 }
2094
2095
2096 ################################################################################
2097 # Functions that actually print stuff
2098 ################################################################################
2099
2100 sub print_clf_message () {
2101
2102     our ($ip, $timestamp, $request_line, $status_code, $size);
2103     my $output = '';
2104
2105     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2106
2107     # Rebuild highlighted
2108     $output .= $h{'Number'} . $ip . $h{'Standard'};
2109     $output .= " - - ";
2110     $output .= "[" . $h{'Timestamp'} . $timestamp . $h{'Standard'} . "]";
2111     $output .= " ";
2112     $output .= "\"" . highlight_request_line("$request_line") . "\"";
2113     $output .= " ";
2114     $output .= $h{'Status'} . $status_code . $h{'Standard'};
2115     $output .= " ";
2116     $output .= $h{'Number'} . $size . $h{'Standard'};
2117     $output .= $line_end;
2118
2119     print $output;
2120 }
2121
2122 sub print_non_clf_message ($) {
2123
2124     my $content = shift;
2125     my $msec_string = "." . $req{$t}{'msecs'} unless $no_msecs_mode;
2126     my $line_start = $html_output_mode ? '' : $h{"Standard"};
2127
2128     return if DEBUG_SUPPRESS_LOG_MESSAGES;
2129
2130     print $line_start
2131         . $time_colours[$time_colour_index % 2]
2132         . $req{$t}{'time-stamp'}
2133         . $msec_string
2134         . $h{Standard} . " "
2135         . $thread_colours{$t}
2136         . $t
2137         . $h{Standard}
2138         . " "
2139         . $h{$req{$t}{'log-level'}}
2140         . $req{$t}{'log-level'}
2141         . $h{Standard}
2142         . ": "
2143         . $content
2144         . $line_end;
2145 }
2146
2147 sub shorten_thread_id ($) {
2148
2149     my $thread_id = shift;
2150
2151     our %short_thread_ids;
2152     our $max_threadid;
2153
2154     unless (defined $short_thread_ids{$thread_id}) {
2155         $short_thread_ids{$thread_id} = sprintf "%.3d", $max_threadid++;
2156     }
2157
2158     return $short_thread_ids{$thread_id}
2159 }
2160
2161 sub parse_loop () {
2162
2163     my ($day, $time_stamp, $thread, $log_level, $content, $c, $msecs);
2164     my $last_msecs  = 0;
2165     my $last_thread = 0;
2166     my $last_timestamp = 0;
2167     my $filters_that_did_nothing;
2168     my $key;
2169     my $time_colour;
2170     $time_colour = paint_it('white');
2171
2172     my %log_level_handlers = (
2173         'Re-Filter'         => \&handle_loglevel_re_filter,
2174         'Header'            => \&handle_loglevel_header,
2175         'Connect'           => \&handle_loglevel_connect,
2176         'Redirect'          => \&handle_loglevel_redirect,
2177         'Request'           => \&handle_loglevel_request,
2178         'Crunch'            => \&handle_loglevel_crunch,
2179         'Gif-Deanimate'     => \&handle_loglevel_gif_deanimate,
2180         'Info'              => \&handle_loglevel_info,
2181         'CGI'               => \&handle_loglevel_cgi,
2182         'Force'             => \&handle_loglevel_force,
2183         'Error'             => \&handle_loglevel_error,
2184         'Fatal error'       => \&handle_loglevel_ignore,
2185         'Writing'           => \&handle_loglevel_ignore,
2186         'Received'          => \&handle_loglevel_ignore,
2187         'Unknown log level' => \&handle_loglevel_ignore,
2188     );
2189
2190     while (<>) {
2191
2192         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/) {
2193             $thread = $t = ($shorten_thread_ids) ? shorten_thread_id($4) : $4;
2194             $req{$t}{'day'} = $day = $1;
2195             $req{$t}{'time-stamp'} = $time_stamp = $2;
2196             $req{$t}{'msecs'} = $msecs = $3 ? $3 : 0; # Only the cool kids have micro second resolution;
2197             $req{$t}{'log-level'} = $log_level = $5;
2198             $req{$t}{'content'} = $content = $c = $6;
2199             $req{$t}{'log-message'} = $_;
2200             $no_special_header_highlighting = 0;
2201
2202             if (defined($log_level_handlers{$log_level})) {
2203
2204                 $content = $log_level_handlers{$log_level}($content);
2205
2206             } else {
2207
2208                 die "No handler found for log level \"$log_level\"\n";
2209             }
2210
2211             # Highlight Truncations
2212             if (length($_) > 4000) {
2213                 $content =~ s@(too long, truncated)]$@$h{'Truncation'}$1$h{'Standard'}]@g;
2214             }
2215
2216             next unless $content;
2217
2218             # Register threads to keep the colour constant
2219             if (!defined($thread_colours{$thread})) {
2220                 $thread_colours{$thread} = $all_colours[$thread_colour_index % @all_colours];
2221                 $thread_colour_index++;
2222             }
2223
2224             # Switch timestamp colour if timestamps differ
2225             if (($msecs ne $last_msecs) || ($time_stamp ne $last_timestamp)) {
2226                debug_message("Tick tack!") if DEBUG_TICKS;
2227                $time_colour = $time_colours[$time_colour_index % 2];
2228                $time_colour_index++;
2229                $last_msecs = $msecs;
2230                $last_timestamp = $time_stamp;
2231             }
2232
2233             $last_thread = $thread;
2234
2235             print_non_clf_message($content);
2236
2237         } elsif (m/^((?:\d+\.\d+\.\d+\.\d+|[:\d]+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2238
2239             # LOG_LEVEL_CLF lines look like this
2240             # 61.152.239.32 - - [04/Mar/2007:18:28:23 +0100] "GET \
2241             #  http://ad.yieldmanager.com/imp?z=1&Z=120x600&s=109339&u=http%3A%2F%2Fwww.365loan.co.uk%2F&r=1\
2242             #  HTTP/1.1" 403 1730
2243             our ($ip, $timestamp, $request_line, $status_code, $size) = ($1, $2, $3, $4, $5);
2244
2245             print_clf_message();
2246
2247         } else {
2248
2249             # Some Privoxy log messages span more than one line,
2250             # usually to dump lots of content that doesn't need any syntax highlighting.
2251             # XXX: add mechanism to forward these lines to the right handler anyway.
2252             chomp();
2253             unless (DEBUG_SUPPRESS_LOG_MESSAGES or (SUPPRESS_EMPTY_LINES and m/^\s+$/)) {
2254                 print and print get_line_end(); # unless (SUPPRESS_EMPTY_LINES and m/^\s+$/);
2255             }
2256         }
2257     }
2258 }
2259
2260 sub stats_loop () {
2261
2262     my ($day, $time_stamp, $msecs, $thread, $log_level, $content);
2263     my %log_level_handlers = (
2264          'Re-Filter'         => \&handle_loglevel_ignore,
2265          'Header'            => \&gather_loglevel_header_stats,
2266          'Connect'           => \&gather_loglevel_connect_stats,
2267          'Redirect'          => \&handle_loglevel_ignore,
2268          'Request'           => \&gather_loglevel_request_stats,
2269          'Crunch'            => \&gather_loglevel_crunch_stats,
2270          'Gif-Deanimate'     => \&handle_loglevel_ignore,
2271          'Info'              => \&handle_loglevel_ignore,
2272          'CGI'               => \&handle_loglevel_ignore,
2273          'Force'             => \&handle_loglevel_ignore,
2274          'Error'             => \&gather_loglevel_error_stats,
2275          'Fatal error'       => \&handle_loglevel_ignore,
2276          'Writing'           => \&handle_loglevel_ignore,
2277          'Received'          => \&handle_loglevel_ignore,
2278          'Unknown log level' => \&handle_loglevel_ignore
2279     );
2280
2281     while (<>) {
2282         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/) {
2283             $day = $1;
2284             $time_stamp = $2;
2285             $msecs = $3 ? $3 : 0;
2286             $thread = $4;
2287             $log_level = $5;
2288             $content = $6;
2289
2290             if (defined($log_level_handlers{$log_level})) {
2291
2292                 $content = $log_level_handlers{$log_level}($content, $thread);
2293
2294             } else {
2295
2296                 die "No handler found for log level \"$log_level\"\n";
2297
2298             }
2299         }
2300     }
2301
2302     print_stats();
2303
2304 }
2305
2306 sub unbreak_lines_only_loop() {
2307     my $log_messages_reached = 0;
2308     while (<>) {
2309         chomp;
2310
2311             # Log level other than LOG_LEVEL_CLF?
2312         if (m/^(\d{4}-\d{2}-\d{2}|\w{3} \d{2}) (\d\d:\d\d:\d\d)\.?(\d+)? (?:Privoxy\()?([^\)\s]*)[\)]? ([\w -]*): (.*?)\r?$/ or
2313             # LOG_LEVEL_CLF?
2314             m/^((?:\d+\.\d+\.\d+\.\d+)) - - \[(.*)\] "(.*)" (\d+) (\d+)/) {
2315             $log_messages_reached = 1;
2316             print "\n";
2317
2318         } else {
2319             # Wrapped message
2320             $_ = "\n". $_  if /^(?:\d+\.\d+\.\d+\.\d+)/;
2321             $_ = " " . $_;
2322         }
2323         s@<BR>$@@;
2324         print;
2325         print "\n" unless $log_messages_reached;
2326     }
2327     print "\n";
2328 }
2329
2330 sub VersionMessage {
2331     my $version_message;
2332
2333     $version_message .= 'Privoxy-Log-Parser ' . PRIVOXY_LOG_PARSER_VERSION  . "\n";
2334     $version_message .= 'Copyright (C) 2007-2010 Fabian Keil <fk@fabiankeil.de>' . "\n";
2335     $version_message .= 'http://www.fabiankeil.de/sourcecode/privoxy-log-parser/' . "\n";
2336
2337     print $version_message;
2338 }
2339
2340 sub get_cli_options () {
2341
2342     our %cli_options = (
2343         'html-output'              => CLI_OPTION_DEFAULT_TO_HTML_OUTPUT,
2344         'title'                    => CLI_OPTION_TITLE,
2345         'no-syntax-highlighting'   => CLI_OPTION_NO_SYNTAX_HIGHLIGHTING,
2346         'no-embedded-css'          => CLI_OPTION_NO_EMBEDDED_CSS,
2347         'no-msecs'                 => CLI_OPTION_NO_MSECS,
2348         'shorten-thread-ids'       => CLI_OPTION_SHORTEN_THREAD_IDS,
2349         'show-ineffective-filters' => CLI_OPTION_SHOW_INEFFECTIVE_FILTERS,
2350         'accept-unknown-messages'  => CLI_OPTION_ACCEPT_UNKNOWN_MESSAGES,
2351         'statistics'               => CLI_OPTION_STATISTICS,
2352         'url-statistics-threshold' => CLI_OPTION_URL_STATISTICS_THRESHOLD,
2353         'unbreak-lines-only'       => CLI_OPTION_UNBREAK_LINES_ONLY,
2354         'host-statistics-threshold'=> CLI_OPTION_HOST_STATISTICS_THRESHOLD,
2355     );
2356
2357     GetOptions (
2358         'html-output'              => \$cli_options{'html-output'},
2359         'title'                    => \$cli_options{'title'},
2360         'no-syntax-highlighting'   => \$cli_options{'no-syntax-highlighting'},
2361         'no-embedded-css'          => \$cli_options{'no-embedded-css'},
2362         'no-msecs'                 => \$cli_options{'no-msecs'},
2363         'shorten-thread-ids'       => \$cli_options{'shorten-thread-ids'},
2364         'show-ineffective-filters' => \$cli_options{'show-ineffective-filters'},
2365         'accept-unknown-messages'  => \$cli_options{'accept-unknown-messages'},
2366         'statistics'               => \$cli_options{'statistics'},
2367         'unbreak-lines-only'       => \$cli_options{'unbreak-lines-only'},
2368         'url-statistics-threshold=s'=> \$cli_options{'url-statistics-threshold'},
2369         'host-statistics-threshold=s'=> \$cli_options{'host-statistics-threshold'},
2370         'version'                  => sub { VersionMessage && exit(0) },
2371         'help'                     => \&help,
2372    ) or exit(1);
2373
2374    $html_output_mode = cli_option_is_set('html-output');
2375    $no_msecs_mode = cli_option_is_set('no-msecs');
2376    $shorten_thread_ids = cli_option_is_set('shorten-thread-ids');
2377    $line_end = get_line_end();
2378 }
2379
2380 sub help () {
2381
2382     our %cli_options;
2383
2384     VersionMessage();
2385
2386     print << "    EOF"
2387
2388 Options and their default values if they have any:
2389     [--accept-unknown-messages]
2390     [--host-statistics-threshold $cli_options{'host-statistics-threshold'}]
2391     [--html-output]
2392     [--no-embedded-css]
2393     [--no-msecs]
2394     [--no-syntax-highlighting]
2395     [--shorten-thread-ids]
2396     [--show-ineffective-filters]
2397     [--statistics]
2398     [--unbreak-lines-only]
2399     [--url-statistics-threshold $cli_options{'url-statistics-threshold'}]
2400     [--title $cli_options{'title'}]
2401     [--version]
2402 see "perldoc $0" for more information
2403     EOF
2404     ;
2405     exit(0);
2406 }
2407
2408 ################################################################################
2409 # main
2410 ################################################################################
2411 sub main () {
2412
2413     get_cli_options();
2414     set_background(DEFAULT_BACKGROUND);
2415     prepare_our_stuff();
2416
2417     print_intro();
2418
2419     # XXX: should explicitly reject incompatible argument combinations
2420     if (cli_option_is_set('unbreak-lines-only')) {
2421         unbreak_lines_only_loop();
2422     } elsif (cli_option_is_set('statistics')) {
2423         stats_loop();
2424     } else {
2425         parse_loop();
2426     }
2427
2428     print_outro();
2429 }
2430
2431 main();
2432
2433 =head1 NAME
2434
2435 B<privoxy-log-parser> - A parser and syntax-highlighter for Privoxy log messages
2436
2437 =head1 SYNOPSIS
2438
2439 B<privoxy-log-parser> [B<--accept-unknown-messages>] [B<--html-output>]
2440 [B<--no-msecs>] [B<--no-syntax-higlighting>] [B<--statistics>]
2441 [B<--shorten-thread-ids>] [B<--show-ineffective-filters>]
2442 [B<--url-statistics-threshold>] [B<--version>]
2443
2444 =head1 DESCRIPTION
2445
2446 B<privoxy-log-parser> reads Privoxy log messages and
2447
2448 - syntax-highlights recognized lines,
2449
2450 - reformats some of them for easier comprehension,
2451
2452 - filters out less useful messages, and
2453
2454 - (in some cases) calculates additional information,
2455   like the compression ratio or how a filter affected
2456   the content size.
2457
2458 With B<privoxy-log-parser> you should be able to increase Privoxy's log level
2459 without getting confused by the resulting amount of output. For example for
2460 "debug 64" B<privoxy-log-parser> will (by default) only show messages that
2461 affect the content. If a filter doesn't cause any hits, B<privoxy-log-parser>
2462 will hide the "filter foo caused 0 hits" message.
2463
2464 =head1 OPTIONS
2465
2466 [B<--accept-unknown-messages>] Don't print warnings in case of unknown messages,
2467 just don't highlight them.
2468
2469 [B<--host-statistics-threshold>] Only show the request count for a host
2470 if it's above or equal to the given threshold. If the threshold is 0, host
2471 statistics are disabled.
2472
2473 [B<--html-output>] Use HTML and CSS for the syntax highlighting. If this option is
2474 omitted, ANSI escape sequences are used unless B<--no-syntax-highlighting> is active.
2475 This option is only intended to make embedding log excerpts in web pages easier.
2476 It does not escape any input!
2477
2478 [B<--no-msecs>] Don't expect milisecond resolution
2479
2480 [B<--no-syntax-highlighting>] Disable syntax-highlighting. Useful when
2481 the filtered output is piped into less in which case the ANSI control
2482 codes don't work, or if the terminal itself doesn't support the control
2483 codes.
2484
2485 [B<--shorten-thread-ids>] Shorten the thread ids to a three-digit decimal number.
2486 Note that the mapping from thread ids to shortened ids is created at run-time
2487 and thus varies with the input.
2488
2489 [B<--show-ineffective-filters>] Don't suppress log lines for filters
2490 that didn't modify the content.
2491
2492 [B<--statistics>] Gather various statistics instead of syntax highlighting
2493 log messages. This is an experimental feature, if the results look wrong
2494 they very well might be. Also note that the results are pretty much guaranteed
2495 to be incorrect if Privoxy and Privoxy-Log-Parser aren't in sync.
2496
2497 [B<--unbreak-lines-only>] Tries to fix lines that got messed up by a broken or
2498 interestingly configured mail client and thus are no longer recognized properly.
2499 Only fixes some breakage, but may be good enough or at least better than nothing.
2500 Doesn't do anything else, so you probably want to pipe the output into
2501 B<privoxy-log-parser> again.
2502
2503 [B<--url-statistics-threshold>] Only show the request count for a ressource
2504 if it's above or equal to the given threshold. If the threshold is 0, URL
2505 statistics are disabled.
2506
2507 [B<--version>] Print version and exit.
2508
2509 =head1 EXAMPLES
2510
2511 To monitor a log file:
2512
2513 tail -F /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log | B<privoxy-log-parser>
2514
2515 Replace '-F' with '-f' if your tail implementation lacks '-F' support
2516 or if the log won't get rotated anyway. The log file location depends
2517 on your system (Doh!).
2518
2519 To monitor Privoxy without having it write to a log file:
2520
2521 privoxy --no-daemon /usr/jails/privoxy-jail/usr/local/etc/privoxy/config 2>&1 | B<privoxy-log-parser>
2522
2523 Again, the config file location depends on your system. Output redirection
2524 depends on your shell, the above works with bourne shells.
2525
2526 To read a processed Privoxy log file from top to bottom, letting the content
2527 scroll by slightly faster than you can read:
2528
2529 B<privoxy-log-parser> < /usr/jails/privoxy-jail/var/log/privoxy/privoxy.log
2530
2531 This is probably only useful to fill screens in the background of haxor movies.
2532
2533 =head1 CAVEATS
2534
2535 Syntax highlighting with ANSI escape sequences will look strange
2536 if your background color isn't black.
2537
2538 Some messages aren't recognized yet and will not be fully highlighted.
2539
2540 B<privoxy-log-parser> is developed with Privoxy 3.0.7 or later in mind,
2541 using earlier Privoxy versions will probably result in an increased amount
2542 of unrecognized log lines.
2543
2544 Privoxy's log files tend to be rather large. If you use HTML
2545 highlighting some browsers can't handle them, get confused and
2546 will eventually crash because of segmentation faults or unexpected
2547 exceptions. This is a problem in the browser and not B<privoxy-log-parser>'s
2548 fault.
2549
2550 =head1 BUGS
2551
2552 Many settings can't be controlled through command line options yet.
2553
2554 =head1 SEE ALSO
2555
2556 privoxy(1)
2557
2558 =head1 AUTHOR
2559
2560 Fabian Keil <fk@fabiankeil.de>
2561
2562 =cut