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