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