5 BEGIN { pop @INC if $INC[-1] eq '.' };
8 use Getopt::Long qw(:config no_ignore_case);
11 # Copyright (c) 2007-2017 University of Cambridge.
12 # See the file NOTICE for conditions of use and distribution.
14 # Except when they appear in comments, the following placeholders in this
15 # source are replaced when it is turned into a runnable script:
23 # This is a perl script which extracts from an Exim log all entries
24 # for all messages that have an entry that matches a given pattern.
25 # If *any* entry for a particular message matches the pattern, *all*
26 # entries for that message are displayed.
28 # We buffer up information on a per-message basis. It is done this way rather
29 # than reading the input twice so that the input can be a pipe.
31 # There must be one argument, which is the pattern. Subsequent arguments
32 # are the files to scan; if none, the standard input is read. If any file
33 # appears to be compressed, it is passed through zcat. We can't just do this
34 # for all files, because zcat chokes on non-compressed files.
36 # Performance optimized in 02/02/2007 by Jori Hamalainen
37 # Typical run time acceleration: 4 times
43 # This subroutine converts a time/date string from an Exim log line into
44 # the number of seconds since the epoch. It handles optional timezone
48 my($year,$month,$day,$hour,$min,$sec,$tzs,$tzh,$tzm) =
49 $_[0] =~ /^(\d{4})-(\d\d)-(\d\d)\s(\d\d):(\d\d):(\d\d)(?:.\d+)?(?>\s([+-])(\d\d)(\d\d))?/o;
51 my $seconds = mktime $sec, $min, $hour, $day, $month - 1, $year - 1900;
55 $seconds -= $tzh * 3600 + $tzm * 60 if $tzs eq "+";
56 $seconds += $tzh * 3600 + $tzm * 60 if $tzs eq "-";
63 # This subroutine processes a single line (in $_) from a log file. Program
64 # defensively against short lines finding their way into the log.
66 my (%saved, %id_list, $pattern);
76 # If using "related" option, have to track extra message IDs
82 # Convert syslog lines to mainlog format, as in eximstats.
84 if (!/^\d{4}-/o) { $_ =~ s/^.*? exim\b.*?: //o; }
87 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;
89 # Handle the case when the log line belongs to a specific message. We save
90 # lines for specific messages until the message is complete. Then either print
95 $saved{$id} = '' unless defined($saved{$id});
97 # Save up the data for this message in case it becomes interesting later.
101 # Are we interested in this id ? Short circuit if we already were interested.
105 $id_list{$id} = 1 if (!defined($id_list{$id}));
106 $id_list{$id} = 0 if (($insensitive && /$pattern/io) || /$pattern/o);
110 if (defined $id_list{$id} ||
111 ($insensitive && /$pattern/io) || /$pattern/o)
114 get_related_ids($id) if $related;
116 elsif ($related && $related_re)
118 grep_for_related($_, $id);
122 # See if this is a completion for some message. If it is interesting,
123 # print it, but in any event, throw away what was saved.
125 if (index($_, 'Completed') != -1 ||
126 index($_, 'SMTP data timeout') != -1 ||
127 (index($_, 'rejected') != -1 &&
128 /^(\d{4}-\d\d-\d\d \d\d:\d\d:\d\d(?:\.\d+)? (?:[+-]\d{4} )?)(?:\[\d+\] )?\w{6}\-\w{6}\-\w{2} rejected/o))
130 if ($queue_time != -1 &&
131 $saved{$id} =~ /^(\d{4}-\d\d-\d\d \d\d:\d\d:\d\d ([+-]\d{4} )?)/o)
133 my $old_sec = &seconds($1);
134 my $sec = &seconds($date);
135 $id_list{$id} = 0 if $id_list{$id} && $sec - $old_sec <= $queue_time;
138 print "$saved{$id}\n" if ($id_list{$id});
139 delete $id_list{$id};
144 # Handle the case where the log line does not belong to a specific message.
145 # Print it if it is interesting.
147 elsif ( ($invert && (($insensitive && !/$pattern/io) || !/$pattern/o)) ||
148 (!$invert && (($insensitive && /$pattern/io) || /$pattern/o)) )
152 # Rotated log files are frequently compressed and there are a variety of
153 # formats it could be compressed with. Rather than use just one that is
154 # detected and hardcoded at Exim compile time, detect and use what the
155 # logfile is compressed with on the fly.
157 # List of known compression extensions and their associated commands:
159 gz => { cmd => 'zcat', args => '' },
160 bz2 => { cmd => 'bzcat', args => '' },
161 xz => { cmd => 'xzcat', args => '' },
162 lzma => { cmd => 'lzma', args => '-dc' },
163 zst => { cmd => 'zstdcat', args => '' },
167 sub detect_compressor_bin
170 my $c = $compressors->{$ext}->{cmd};
171 $compressors->{$ext}->{bin} = `which $c 2>/dev/null`;
172 chomp($compressors->{$ext}->{bin});
175 sub detect_compressor_capable
177 my $filename = shift();
178 map { &detect_compressor_bin($_) } keys %$compressors
182 unless (grep {$filename =~ /\.(?:$_)$/} keys %$compressors);
183 # Loop through them, figure out which one it detected,
184 # and build the commandline.
186 foreach my $ext (keys %$compressors)
188 if ($filename =~ /\.(?:$ext)$/)
190 # Just die if compressor not found; if this occurs in the middle of
191 # two valid files with a lot of matches, error could easily be missed.
192 die("Didn't find $ext decompressor for $filename\n")
193 if ($compressors->{$ext}->{bin} eq '');
194 $cmdline = $compressors->{$ext}->{bin} ." ".
195 $compressors->{$ext}->{args};
202 sub grep_for_related {
204 $id_list{$id} = 1 if $line =~ m/$related_re/;
207 sub get_related_ids {
209 push @Mids, $id unless grep /\b$id\b/, @Mids;
210 my $re = join '|', @Mids;
211 $related_re = qr/$re/;
214 # The main program. Extract the pattern and make sure any relevant characters
215 # are quoted if the -l flag is given. The -t flag gives a time-on-queue value
216 # which is an additional condition. The -M flag will also display "related"
217 # loglines (msgid from matched lines is searched in following lines).
220 'I|sensitive' => sub { $insensitive = 0 },
221 'l|literal' => \$literal,
222 'M|related' => \$related,
223 't|queue-time=i' => \$queue_time,
224 'pager!' => \$use_pager,
225 'v|invert' => \$invert,
226 'h|help' => sub { pod2usage(-exit => 0, -verbose => 1) },
231 -noperldoc => system('perldoc -V 2>/dev/null >&2')
235 print basename($0) . ": $0\n",
236 "build: EXIM_RELEASE_VERSIONEXIM_VARIANT_VERSION\n",
237 "perl(runtime): $]\n";
240 ) and @ARGV or pod2usage;
242 $pattern = shift @ARGV;
243 $pattern = quotemeta $pattern if $literal;
245 # Start a pager if output goes to a terminal
246 if (-t 1 and $use_pager)
248 # for perl >= v5.10.x: foreach ($ENV{PAGER}//(), 'less', 'more')
249 foreach (defined $ENV{PAGER} ? $ENV{PAGER} : (), 'less', 'more')
251 local $ENV{LESS} .= ' --no-init --quit-if-one-screen';
252 open(my $pager, '|-', $_) or next;
258 # If file arguments are given, open each one and process according as it is
259 # is compressed or not.
266 if (-x 'ZCAT_COMMAND' && $filename =~ /\.(?:COMPRESS_SUFFIX)$/o)
268 open(LOG, "ZCAT_COMMAND $filename |") ||
269 die "Unable to zcat $filename: $!\n";
271 elsif (my $cmdline = &detect_compressor_capable($filename))
273 open(LOG, "$cmdline $filename |") ||
274 die "Unable to decompress $filename: $!\n";
278 open(LOG, "<$filename") || die "Unable to open $filename: $!\n";
280 do_line() while (<LOG>);
285 # If no files are named, process STDIN only
287 else { do_line() while (<STDIN>); }
289 # At the end of processing all the input, print any uncompleted messages.
293 print "+++ $_ has not completed +++\n$saved{$_}\n";
300 exigrep - search Exim's main log
304 B<exigrep> [options] pattern [log] ...
308 The B<exigrep> utility is a Perl script that searches one or more main log
309 files for entries that match a given pattern. When it finds a match,
310 it extracts all the log entries for the relevant message, not just
311 those that match the pattern. Thus, B<exigrep> can extract complete log
312 entries for a given message, or all mail for a given user, or for a
313 given host, for example.
315 If no file names are given on the command line, the standard input is read.
317 For known file extensions indicating compression (F<.gz>, F<.bz2>, F<.xz>,
318 F<.lzma>, and F<.zst>) a suitable de-compressor is used, if available.
320 The output is sent through a pager if a terminal is connected to STDOUT. As
321 pager are considered: C<$ENV{PAGER}>, C<less>, C<more>.
327 =item B<-l>|B<--literal>
329 This means 'literal', that is, treat all characters in the
330 pattern as standing for themselves. Otherwise the pattern must be a
331 Perl regular expression. The pattern match is case-insensitive.
333 =item B<-t>|B<--queue-time> I<seconds>
335 Limit the output to messages that spent at least I<seconds> in the
338 =item B<-I>|B<--sensitive>
340 Do a case sensitive search.
342 =item B<-v>|B<--invert>
344 Invert the meaning of the search pattern. That is, print message log
345 entries that are not related to that pattern.
347 =item B<-M>|B<--related>
349 Search for related messages too.
353 Do not use a pager, even if STDOUT is connected to a terminal.
355 =item B<-h>|B<--help>
357 Print a short reference help. For more detailed help try L<exigrep(8)>,
362 Print this manual page of B<exigrep>.
368 L<exim(8)>, L<perlre(1)>, L<Exim|http://exim.org/>
372 This manual page was stitched together from spec.txt by Andreas Metzler L<ametzler at downhill.at.eu.org>
373 and updated by Heiko Schlittermann L<hs@schlittermann.de>.