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