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