X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/bfe645c1570343d3adca657ab67998e122ca8792..568092148bf6ade68174fa1ccf34b8c37d9064e9:/src/src/exigrep.src diff --git a/src/src/exigrep.src b/src/src/exigrep.src index bb994d769..835766fb4 100644 --- a/src/src/exigrep.src +++ b/src/src/exigrep.src @@ -1,8 +1,14 @@ -#! PERL_COMMAND -w +#! PERL_COMMAND +use warnings; use strict; +BEGIN { pop @INC if $INC[-1] eq '.' }; -# Copyright (c) 2007-2015 University of Cambridge. +use Pod::Usage; +use Getopt::Long qw(:config no_ignore_case); +use File::Basename; + +# Copyright (c) 2007-2017 University of Cambridge. # See the file NOTICE for conditions of use and distribution. # Except when they appear in comments, the following placeholders in this @@ -31,7 +37,6 @@ use strict; # Typical run time acceleration: 4 times -use Getopt::Std qw(getopts); use POSIX qw(mktime); @@ -41,7 +46,7 @@ use POSIX qw(mktime); 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))?/o; + $_[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; @@ -58,10 +63,17 @@ 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, $insensitive, $invert); +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; + # If using "related" option, have to track extra message IDs -my $related; my $related_re=''; my @Mids = (); @@ -72,7 +84,7 @@ sub do_line { if (!/^\d{4}-/o) { $_ =~ s/^.*? exim\b.*?: //o; } return unless - my($date,$id) = /^(\d{4}-\d\d-\d\d \d\d:\d\d:\d\d (?:[+-]\d{4} )?)(?:\[\d+\] )?(\w{6}\-\w{6}\-\w{2})?/o; + 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; # 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 @@ -113,7 +125,7 @@ if (defined $id) 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{4} )?)(?:\[\d+\] )?\w{6}\-\w{6}\-\w{2} rejected/o)) + /^(\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) @@ -147,7 +159,8 @@ my $compressors = { gz => { cmd => 'zcat', args => '' }, bz2 => { cmd => 'bzcat', args => '' }, xz => { cmd => 'xzcat', args => '' }, - lzma => { cmd => 'lzma', args => '-dc' } + lzma => { cmd => 'lzma', args => '-dc' }, + zst => { cmd => 'zstdcat', args => '' }, }; my $csearch = 0; @@ -174,7 +187,7 @@ sub detect_compressor_capable { if ($filename =~ /\.(?:$ext)$/) { - # Just die if compressor not found; if this occurrs in the middle of + # 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 ''); @@ -203,18 +216,44 @@ sub get_related_ids { # which is an additional condition. The -M flag will also display "related" # loglines (msgid from matched lines is searched in following lines). -getopts('Ilvt:M',\my %args); -$queue_time = $args{'t'}? $args{'t'} : -1; -$insensitive = $args{'I'}? 0 : 1; -$invert = $args{'v'}? 1 : 0; -$related = $args{'M'}? 1 : 0; - -die "usage: exigrep [-I] [-l] [-M] [-t ] [-v] []...\n" - if ($#ARGV < 0); +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. @@ -254,4 +293,83 @@ for (keys %id_list) print "+++ $_ has not completed +++\n$saved{$_}\n"; } -# End of exigrep +__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 + +This manual page was stitched together from spec.txt by Andreas Metzler L +and updated by Heiko Schlittermann L. + +=cut