Debug: fix showing option name for list (vs. list content)
[exim.git] / src / src / exigrep.src
index 45bdc2c80cffe3bafc2f2cfa08773fc37b4e4b8a..a425ad03bdd982624b52c0989eb94d0288f314c7 100644 (file)
@@ -1,14 +1,17 @@
 #! PERL_COMMAND
 
+# Copyright (c) The Exim Maintainers 2020 - 2023
+# Copyright (c) 2007-2017 University of Cambridge.
+# See the file NOTICE for conditions of use and distribution.
+# SPDX-License-Identifier: GPL-2.0-or-later
+
 use warnings;
 use strict;
 BEGIN { pop @INC if $INC[-1] eq '.' };
 
 use Pod::Usage;
-use Getopt::Long;
-
-# Copyright (c) 2007-2015 University of Cambridge.
-# See the file NOTICE for conditions of use and distribution.
+use Getopt::Long qw(:config no_ignore_case);
+use File::Basename;
 
 # Except when they appear in comments, the following placeholders in this
 # source are replaced when it is turned into a runnable script:
@@ -43,20 +46,21 @@ 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))?/o;
+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
@@ -76,77 +80,78 @@ my $literal     = 0;
 my $related_re='';
 my @Mids = ();
 
-sub do_line {
+sub do_line
+  {
 
-# Convert syslog lines to mainlog format, as in eximstats.
+  # Convert syslog lines to mainlog format, as in eximstats.
 
-if (!/^\d{4}-/o) { $_ =~ s/^.*? exim\b.*?: //o; }
+  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;
+  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}|\w{6}-\w{11}-\w{4})?/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
-# or discard.
+  # 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.
 
-if (defined $id)
-  {
-  $saved{$id} = '' unless defined($saved{$id});
+  if (defined $id)
+    {
+    $saved{$id} = '' unless defined($saved{$id});
 
-  # Save up the data for this message in case it becomes interesting later.
+    # Save up the data for this message in case it becomes interesting later.
 
-  $saved{$id} .= $_;
+    $saved{$id} .= $_;
 
-  # Are we interested in this id ? Short circuit if we already were interested.
+    # Are we interested in this id ? Short circuit if we already were interested.
 
-  if ($invert)
-    {
-    $id_list{$id} = 1 if (!defined($id_list{$id}));
-    $id_list{$id} = 0 if (($insensitive && /$pattern/io) || /$pattern/o);
-    }
-  else
-    {
-    if (defined $id_list{$id} ||
-      ($insensitive && /$pattern/io) || /$pattern/o)
+    if ($invert)
       {
-      $id_list{$id} = 1;
-      get_related_ids($id) if $related;
+      $id_list{$id} = 1 if (!defined($id_list{$id}));
+      $id_list{$id} = 0 if (($insensitive && /$pattern/io) || /$pattern/o);
       }
-    elsif ($related && $related_re)
+    else
       {
-      grep_for_related($_, $id);
+      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);
+       }
       }
-    }
 
-  # See if this is a completion for some message. If it is interesting,
-  # print it, but in any event, throw away what was saved.
+    # 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{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)
+    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}|\w{6}-\w{11}-\w{4}) rejected/o))
       {
-      my $old_sec = &seconds($1);
-      my $sec = &seconds($date);
-      $id_list{$id} = 0 if $id_list{$id} && $sec - $old_sec <= $queue_time;
+      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};
+      delete $saved{$id};
       }
-
-    print "$saved{$id}\n" if ($id_list{$id});
-    delete $id_list{$id};
-    delete $saved{$id};
     }
-  }
 
-# Handle the case where the log line does not belong to a specific message.
-# Print it if it is interesting.
+  # 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"; }
-}
+  elsif ( ($invert && (($insensitive && !/$pattern/io) || !/$pattern/o)) ||
+        (!$invert && (($insensitive &&  /$pattern/io) ||  /$pattern/o)) )
+    { print "$_\n"; }
+  }
 
 # 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
@@ -158,7 +163,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;
 
@@ -197,17 +203,19 @@ sub detect_compressor_capable
   return $cmdline;
   }
 
-sub grep_for_related {
+sub grep_for_related
+  {
   my ($line,$id) = @_;
   $id_list{$id} = 1 if $line =~ m/$related_re/;
-}
+  }
 
-sub get_related_ids {
+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
@@ -229,6 +237,12 @@ GetOptions(
             -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;
@@ -237,13 +251,15 @@ $pattern = quotemeta $pattern if $literal;
 # Start a pager if output goes to a terminal
 if (-t 1 and $use_pager)
   {
-  foreach ($ENV{PAGER}//(), 'less', 'more')
+  # 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.
@@ -304,8 +320,8 @@ 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>, and F<.lzma>)
-a suitable de-compressor is used, if available.
+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<less>, C<more>.
@@ -345,7 +361,7 @@ 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<exigrep(8)>,
-or C<exigrep -m>.
+or C<exigrep --man>.
 
 =item B<-m>|B<--man>