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