X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/395ff96dec2b7ef473ffb5dd39b79b62d1661eee..a85c067ba6c6940512cf57ec213277a370d87e70:/src/src/exigrep.src diff --git a/src/src/exigrep.src b/src/src/exigrep.src index c6ccbfdc5..2c414fd31 100644 --- a/src/src/exigrep.src +++ b/src/src/exigrep.src @@ -1,9 +1,15 @@ -#! PERL_COMMAND -w -# $Cambridge: exim/src/src/exigrep.src,v 1.3 2005/08/01 13:28:30 ph10 Exp $ +#! PERL_COMMAND +use warnings; use strict; +BEGIN { pop @INC if $INC[-1] eq '.' }; -# Copyright (c) 2004 University of Cambridge. +use Pod::Usage; +use Getopt::Long qw(:config no_ignore_case); +use File::Basename; + +# Copyright (c) 2007-2017 University of Cambridge. +# Copyright (c) The Exim Maintainers 2020 - 2021 # See the file NOTICE for conditions of use and distribution. # Except when they appear in comments, the following placeholders in this @@ -28,7 +34,10 @@ use strict; # appears to be compressed, it is passed through zcat. We can't just do this # for all files, because zcat chokes on non-compressed files. -use Getopt::Std qw(getopts); +# Performance optimized in 02/02/2007 by Jori Hamalainen +# Typical run time acceleration: 4 times + + use POSIX qw(mktime); @@ -36,95 +45,220 @@ use POSIX qw(mktime); # the number of seconds since the epoch. It handles optional timezone # information. -sub seconds { -my($year,$month,$day,$hour,$min,$sec,$tzs,$tzh,$tzm) = - $_[0] =~ /^(\d{4})-(\d\d)-(\d\d)\s(\d\d):(\d\d):(\d\d)(?>\s([+-])(\d\d)(\d\d))?/; +sub seconds + { + my($year,$month,$day,$hour,$min,$sec,$tzs,$tzh,$tzm) = + $_[0] =~ /^(\d{4})-(\d\d)-(\d\d)\s(\d\d):(\d\d):(\d\d)(?:.\d+)?(?>\s([+-])(\d\d)(\d\d))?/o; -my $seconds = mktime $sec, $min, $hour, $day, $month - 1, $year - 1900; + my $seconds = mktime $sec, $min, $hour, $day, $month - 1, $year - 1900; -if (defined $tzs) - { - $seconds -= $tzh * 3600 + $tzm * 60 if $tzs eq "+"; - $seconds += $tzh * 3600 + $tzm * 60 if $tzs eq "-"; - } + if (defined $tzs) + { + $seconds -= $tzh * 3600 + $tzm * 60 if $tzs eq "+"; + $seconds += $tzh * 3600 + $tzm * 60 if $tzs eq "-"; + } -return $seconds; -} + return $seconds; + } # This subroutine processes a single line (in $_) from a log file. Program # defensively against short lines finding their way into the log. -my (%saved, %id_list, $pattern, $queue_time); +my (%saved, %id_list, $pattern); + +my $queue_time = -1; +my $insensitive = 1; +my $invert = 0; +my $related = 0; +my $use_pager = 1; +my $literal = 0; -sub do_line { -# Convert syslog lines to mainlog format, as in eximstats. +# If using "related" option, have to track extra message IDs +my $related_re=''; +my @Mids = (); -if (! /^\\d{4}/) { $_ =~ s/^.*? exim\b.*?: //; } +sub do_line + { -return unless - my($date,$entry) = /^(\d{4}-\d\d-\d\d \d\d:\d\d:\d\d (?:[+-]\d{4} )?)(.*)/; + # Convert syslog lines to mainlog format, as in eximstats. -# Handle the case when the log line belongs to a specific message. We save -# lines for specific messages until the message is complete. Then either print -# discard. + if (!/^\d{4}-/o) { $_ =~ s/^.*? exim\b.*?: //o; } -if (my($id) = $entry =~ /^(\w{6}\-\w{6}\-\w{2})/) - { - $saved{$id} = '' unless defined($saved{$id}); + return unless + my($date,$id) = /^(\d{4}-\d\d-\d\d \d\d:\d\d:\d\d(?:\.\d+)? (?:[+-]\d{4} )?)(?:\[\d+\] )?(\w{6}\-\w{6}\-\w{2})?/o; - # Save up the data for this message in case it becomes interesting later. + # Handle the case when the log line belongs to a specific message. We save + # lines for specific messages until the message is complete. Then either print + # or discard. - $saved{$id} .= $_; + if (defined $id) + { + $saved{$id} = '' unless defined($saved{$id}); - # Are we interested in this id ? + # Save up the data for this message in case it becomes interesting later. - $id_list{$id} = 1 if /$pattern/io; + $saved{$id} .= $_; - # See if this is a completion for some message. If it is interesting, - # print it, but in any event, throw away what was saved. + # Are we interested in this id ? Short circuit if we already were interested. - if ($entry =~ - /(?:Completed|rejected (?:by local_scan|by non-SMTP ACL|after DATA))/) - { - if ($saved{$id} =~ /^(\d{4}-\d\d-\d\d \d\d:\d\d:\d\d ([+-]\d{4} )?)(\w{6}\-\w{6}\-\w{2})/) + if ($invert) + { + $id_list{$id} = 1 if (!defined($id_list{$id})); + $id_list{$id} = 0 if (($insensitive && /$pattern/io) || /$pattern/o); + } + else { - my $old_sec = &seconds($1); - my $sec = &seconds($date); - delete $id_list{$id} if $id_list{$id} && $sec - $old_sec <= $queue_time; + if (defined $id_list{$id} || + ($insensitive && /$pattern/io) || /$pattern/o) + { + $id_list{$id} = 1; + get_related_ids($id) if $related; + } + elsif ($related && $related_re) + { + grep_for_related($_, $id); + } } - if ($id_list{$id}) + # See if this is a completion for some message. If it is interesting, + # print it, but in any event, throw away what was saved. + + if (index($_, 'Completed') != -1 || + index($_, 'SMTP data timeout') != -1 || + (index($_, 'rejected') != -1 && + /^(\d{4}-\d\d-\d\d \d\d:\d\d:\d\d(?:\.\d+)? (?:[+-]\d{4} )?)(?:\[\d+\] )?\w{6}\-\w{6}\-\w{2} rejected/o)) { + if ($queue_time != -1 && + $saved{$id} =~ /^(\d{4}-\d\d-\d\d \d\d:\d\d:\d\d ([+-]\d{4} )?)/o) + { + my $old_sec = &seconds($1); + my $sec = &seconds($date); + $id_list{$id} = 0 if $id_list{$id} && $sec - $old_sec <= $queue_time; + } + + print "$saved{$id}\n" if ($id_list{$id}); delete $id_list{$id}; - print "$saved{$id}\n"; + delete $saved{$id}; } - - delete $saved{$id}; } + + # Handle the case where the log line does not belong to a specific message. + # Print it if it is interesting. + + elsif ( ($invert && (($insensitive && !/$pattern/io) || !/$pattern/o)) || + (!$invert && (($insensitive && /$pattern/io) || /$pattern/o)) ) + { print "$_\n"; } } -# Handle the case where the log line does not belong to a specific message. -# Print it if it is interesting. +# Rotated log files are frequently compressed and there are a variety of +# formats it could be compressed with. Rather than use just one that is +# detected and hardcoded at Exim compile time, detect and use what the +# logfile is compressed with on the fly. +# +# List of known compression extensions and their associated commands: +my $compressors = { + gz => { cmd => 'zcat', args => '' }, + bz2 => { cmd => 'bzcat', args => '' }, + xz => { cmd => 'xzcat', args => '' }, + lzma => { cmd => 'lzma', args => '-dc' }, + zst => { cmd => 'zstdcat', args => '' }, +}; +my $csearch = 0; + +sub detect_compressor_bin + { + my $ext = shift(); + my $c = $compressors->{$ext}->{cmd}; + $compressors->{$ext}->{bin} = `which $c 2>/dev/null`; + chomp($compressors->{$ext}->{bin}); + } -elsif ($entry =~ /$pattern/io) { print "$_\n"; } -} +sub detect_compressor_capable + { + my $filename = shift(); + map { &detect_compressor_bin($_) } keys %$compressors + if (!$csearch); + $csearch = 1; + return undef + unless (grep {$filename =~ /\.(?:$_)$/} keys %$compressors); + # Loop through them, figure out which one it detected, + # and build the commandline. + my $cmdline = undef; + foreach my $ext (keys %$compressors) + { + if ($filename =~ /\.(?:$ext)$/) + { + # Just die if compressor not found; if this occurs in the middle of + # two valid files with a lot of matches, error could easily be missed. + die("Didn't find $ext decompressor for $filename\n") + if ($compressors->{$ext}->{bin} eq ''); + $cmdline = $compressors->{$ext}->{bin} ." ". + $compressors->{$ext}->{args}; + last; + } + } + return $cmdline; + } +sub grep_for_related + { + my ($line,$id) = @_; + $id_list{$id} = 1 if $line =~ m/$related_re/; + } + +sub get_related_ids + { + my ($id) = @_; + push @Mids, $id unless grep /\b$id\b/, @Mids; + my $re = join '|', @Mids; + $related_re = qr/$re/; + } # The main program. Extract the pattern and make sure any relevant characters # are quoted if the -l flag is given. The -t flag gives a time-on-queue value -# which is an additional condition. - -getopts('lt:',\my %args); -$queue_time = $args{'t'}? $args{'t'} : -1; - -die "usage: exigrep [-l] [-t ] []...\n" - if ($#ARGV < 0); +# which is an additional condition. The -M flag will also display "related" +# loglines (msgid from matched lines is searched in following lines). + +GetOptions( + 'I|sensitive' => sub { $insensitive = 0 }, + 'l|literal' => \$literal, + 'M|related' => \$related, + 't|queue-time=i' => \$queue_time, + 'pager!' => \$use_pager, + 'v|invert' => \$invert, + 'h|help' => sub { pod2usage(-exit => 0, -verbose => 1) }, + 'm|man' => sub { + pod2usage( + -exit => 0, + -verbose => 2, + -noperldoc => system('perldoc -V 2>/dev/null >&2') + ); + }, + 'version' => sub { + print basename($0) . ": $0\n", + "build: EXIM_RELEASE_VERSIONEXIM_VARIANT_VERSION\n", + "perl(runtime): $]\n"; + exit 0; + }, +) and @ARGV or pod2usage; $pattern = shift @ARGV; -$pattern = quotemeta $pattern if $args{l}; +$pattern = quotemeta $pattern if $literal; +# Start a pager if output goes to a terminal +if (-t 1 and $use_pager) + { + # for perl >= v5.10.x: foreach ($ENV{PAGER}//(), 'less', 'more') + foreach (defined $ENV{PAGER} ? $ENV{PAGER} : (), 'less', 'more') + { + local $ENV{LESS} .= ' --no-init --quit-if-one-screen'; + open(my $pager, '|-', $_) or next; + select $pager; + last; + } + } # If file arguments are given, open each one and process according as it is # is compressed or not. @@ -134,11 +268,16 @@ if (@ARGV) foreach (@ARGV) { my $filename = $_; - if ($filename =~ /\.(?:COMPRESS_SUFFIX)$/) + if (-x 'ZCAT_COMMAND' && $filename =~ /\.(?:COMPRESS_SUFFIX)$/o) { open(LOG, "ZCAT_COMMAND $filename |") || die "Unable to zcat $filename: $!\n"; } + elsif (my $cmdline = &detect_compressor_capable($filename)) + { + open(LOG, "$cmdline $filename |") || + die "Unable to decompress $filename: $!\n"; + } else { open(LOG, "<$filename") || die "Unable to open $filename: $!\n"; @@ -152,8 +291,90 @@ if (@ARGV) else { do_line() while (); } -# At the end of processing all the input, print any uncompleted data +# At the end of processing all the input, print any uncompleted messages. + +for (keys %id_list) + { + print "+++ $_ has not completed +++\n$saved{$_}\n"; + } + +__END__ + +=head1 NAME + +exigrep - search Exim's main log + +=head1 SYNOPSIS + +B [options] pattern [log] ... + +=head1 DESCRIPTION + +The B utility is a Perl script that searches one or more main log +files for entries that match a given pattern. When it finds a match, +it extracts all the log entries for the relevant message, not just +those that match the pattern. Thus, B can extract complete log +entries for a given message, or all mail for a given user, or for a +given host, for example. + +If no file names are given on the command line, the standard input is read. + +For known file extensions indicating compression (F<.gz>, F<.bz2>, F<.xz>, +F<.lzma>, and F<.zst>) a suitable de-compressor is used, if available. + +The output is sent through a pager if a terminal is connected to STDOUT. As +pager are considered: C<$ENV{PAGER}>, C, C. + +=head1 OPTIONS + +=over + +=item B<-l>|B<--literal> + +This means 'literal', that is, treat all characters in the +pattern as standing for themselves. Otherwise the pattern must be a +Perl regular expression. The pattern match is case-insensitive. + +=item B<-t>|B<--queue-time> I + +Limit the output to messages that spent at least I in the +queue. + +=item B<-I>|B<--sensitive> + +Do a case sensitive search. + +=item B<-v>|B<--invert> + +Invert the meaning of the search pattern. That is, print message log +entries that are not related to that pattern. + +=item B<-M>|B<--related> + +Search for related messages too. + +=item B<--no-pager> + +Do not use a pager, even if STDOUT is connected to a terminal. + +=item B<-h>|B<--help> + +Print a short reference help. For more detailed help try L, +or C. + +=item B<-m>|B<--man> + +Print this manual page of B. + +=back + +=head1 SEE ALSO + +L, L, L + +=head1 AUTHOR -for (keys %id_list) { print "+++ $_ not completed +++\n$saved{$_}\n;" } +This manual page was stitched together from spec.txt by Andreas Metzler L +and updated by Heiko Schlittermann L. -# End of exigrep +=cut