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