src/src/exicyclog.src

   1 #! /bin/sh
   2 # $Cambridge: exim/src/src/exicyclog.src,v 1.2 2004/12/21 16:26:31 ph10 Exp $
   3
   4 # Copyright (c) 2004 University of Cambridge.
   5 # See the file NOTICE for conditions of use and distribution.
   6
   7 # Except when they appear in comments, the following placeholders in this
   8 # source are replaced when it is turned into a runnable script:
   9 #
  10 # CONFIGURE_FILE_USE_NODE
  11 # CONFIGURE_FILE_USE_EUID
  12 # CONFIGURE_FILE
  13 # BIN_DIRECTORY
  14 # EXICYCLOG_MAX
  15 # COMPRESS_COMMAND
  16 # COMPRESS_SUFFIX
  17 # CHOWN_COMMAND
  18 # CHGRP_COMMAND
  19 # MV_COMMAND
  20 # RM_COMMAND
  21
  22 # PROCESSED_FLAG
  23
  24 # This is a shell script for cycling exim main and reject log files. Each time
  25 # it is run, the files get "shuffled down" by one, the current one (e.g.
  26 # mainlog) becoming mainlog.01, the previous mainlog.01 becoming mainlog.02,
  27 # and so on, up to the limit configured here. When the number to keep is
  28 # greater than 99 (not common, but some people do it), three digits are used
  29 # (e.g. mainlog.001). The same shuffling happens to the reject logs. All
  30 # renamed files with numbers greater than 1 are compressed.
  31
  32 # This script should be called regularly (e.g. daily) by a root crontab
  33 # entry of the form
  34
  35 # 1 0 * * *   /opt/exim/bin/exicyclog
  36
  37 # The following lines are generated from Exim's configuration file when
  38 # this source is built into a script, but you can subsequently edit them
  39 # without rebuilding things, as long are you are careful not to overwrite
  40 # the script in the next Exim rebuild/install. "Keep" is the number of old log
  41 # files that are required to be kept. "Compress" and "suffix" define your
  42 # chosen compression method. The others are provided because the location
  43 # of certain commands varies from OS to OS. Sigh.
  44
  45 keep=EXICYCLOG_MAX
  46 compress=COMPRESS_COMMAND
  47 suffix=COMPRESS_SUFFIX
  48
  49 chown=CHOWN_COMMAND
  50 chgrp=CHGRP_COMMAND
  51 mv=MV_COMMAND
  52 rm=RM_COMMAND
  53
  54 # End of editable lines
  55 #########################################################################
  56
  57 # Some operating systems have different versions in which the commands live
  58 # in different places. We have a fudge that will search the usual suspects if
  59 # requested.
  60
  61 for cmd in chown chgrp mv rm ; do
  62   eval "oldcmd=\$$cmd"
  63   if [ "$oldcmd" != "look_for_it" ] ; then continue ; fi
  64   newcmd=$cmd
  65   for dir in /bin /usr/bin /usr/sbin /usr/etc ; do
  66     if [ -f $dir/$cmd ] ; then
  67       newcmd=$dir/$cmd
  68       break
  69     fi
  70   done
  71   eval $cmd=$newcmd
  72 done
  73
  74 # See if this installation is using the esoteric "USE_EUID" feature of Exim,
  75 # in which it uses the effective user id as a suffix for the configuration file
  76 # name. In order for this to work, exicyclog must be run under the appropriate
  77 # euid.
  78
  79 if [ "CONFIGURE_FILE_USE_EUID" = "yes" ]; then
  80   euid=.`id -u`
  81 fi
  82
  83 # See if this installation is using the esoteric "USE_NODE" feature of Exim,
  84 # in which it uses the host's name as a suffix for the configuration file name.
  85
  86 if [ "CONFIGURE_FILE_USE_NODE" = "yes" ]; then
  87   hostsuffix=.`uname -n`
  88 fi
  89
  90 # Now find the configuration file name. This has got complicated because the
  91 # CONFIGURE_FILE value may now be a list of files. The one that is used is the
  92 # first one that exists. Mimic the code in readconf.c by testing first for the
  93 # suffixed file in each case.
  94
  95 set `awk -F: '{ for (i = 1; i <= NF; i++) print $i }' <<End
  96 CONFIGURE_FILE
  97 End
  98 `
  99 while [ "$config" = "" -a $# -gt 0 ] ; do
 100   if [ -f "$1$euid$hostsuffix" ] ; then
 101     config="$1$euid$hostsuffix"
 102   elif [ -f "$1$euid" ] ; then
 103     config="$1$euid"
 104   elif [ -f "$1$hostsuffix" ] ; then
 105     config="$1$hostsuffix"
 106   elif [ -f "$1" ] ; then
 107     config="$1"
 108   fi
 109   shift
 110 done
 111
 112 # Determine if the log file path is set, and where the spool directory is.
 113 # Search for an exim_path setting in the configure file; otherwise use the bin
 114 # directory. Call that version of Exim to find the spool directory and log file
 115 # path. BEWARE: a tab character is needed in the command below. It has had a
 116 # nasty tendency to get lost in the past. Use a variable to hold a space and a
 117 # tab to keep the tab in one place.
 118
 119 st='     '
 120 exim_path=`grep "^[$st]*exim_path" $config | sed "s/.*=[$st]*//"`
 121 if test "$exim_path" = ""; then exim_path=BIN_DIRECTORY/exim; fi
 122
 123 spool_directory=`$exim_path -C $config -bP spool_directory | sed 's/.*=[  ]*//'`
 124 log_file_path=`$exim_path -C $config -bP log_file_path | sed 's/.*=[  ]*//'`
 125
 126 # If log_file_path contains only "syslog" then no Exim log files are in use.
 127 # We can't cycle anything. Complain and give up.
 128
 129 if [ "$log_file_path" = "syslog" ] ; then
 130   echo "*** Exim is logging to syslog - no log files to cycle ***"
 131   exit 1
 132 fi
 133
 134 # Otherwise, remove ":syslog" or "syslog:" (some spaces allowed) and inspect
 135 # what remains. The simplistic regex originally used failed when a filename
 136 # contained "syslog", so we have to use three less general ones, because sed
 137 # doesn't have much power in its regexs.
 138
 139 log_file_path=`echo "$log_file_path" | \
 140   sed 's/^ *:\{0,1\} *syslog *:\{0,1\} *//;s/: *syslog *:/:/;s/: *syslog *$//'`
 141
 142 # If log_file_path is empty, then the logs we are interested in are called
 143 # "mainlog" and "rejectlog" in the directory called "log" in the spool
 144 # directory. Otherwise we fish out the directory from the given path, and
 145 # also the names of the logs.
 146
 147 if [ "$log_file_path" = "" ]; then
 148   logdir=$spool_directory/log
 149   mainlog=mainlog
 150   rejectlog=rejectlog
 151 else
 152   logdir=`echo $log_file_path | sed 's?/[^/]*$??'`
 153   logbase=`echo $log_file_path | sed 's?^.*/??'`
 154   mainlog=`echo $logbase | sed 's/%s/main/'`
 155   rejectlog=`echo $logbase | sed 's/%s/reject/'`
 156 fi
 157
 158 # Get into the log directory to do the business.
 159
 160 cd $logdir
 161
 162 # If there is no main log file, do nothing.
 163
 164 if [ ! -f $mainlog ]; then exit; fi
 165
 166 # Find out the owner and group of the main log file so that we can re-instate
 167 # this on moved and compressed files, since some operating systems may change
 168 # things. This is a tedious bit of code, but it should work both in operating
 169 # systems where the -l option of ls gives the user and group, and those in which
 170 # you need -lg. The condition is that, if the fifth field of the output from
 171 # ls consists entirely of digits, then the third and fourth fields are the user
 172 # and group.
 173
 174 a=`ls -lg $mainlog`
 175 b=`ls -l  $mainlog`
 176
 177 # These statements work fine in the Bourne or Korn shells, but not in Bash.
 178 # So for the benefit of systems whose /bin/sh is really Bash, they have been
 179 # changed to a messier form.
 180
 181 # user=`echo "$a\n$b\n" | awk 'BEGIN { OFS=""} { if ($5 ~ /^[0-9]+$/) print $3; }'`
 182 # group=`echo "$a\n$b\n" | awk 'BEGIN { OFS=""} { if ($5 ~ /^[0-9]+$/) print $4; }'`
 183
 184 user=`echo "$a
 185 $b
 186 " | awk 'BEGIN { OFS=""} { if ($5 ~ /^[0-9]+$/) { print $3; exit; } }'`
 187
 188 group=`echo "$a
 189 $b
 190 " | awk 'BEGIN { OFS=""} { if ($5 ~ /^[0-9]+$/) { print $4; exit; } }'`
 191
 192 # Now do the job. First remove the files that have "fallen off the bottom".
 193 # Look for both the compressed and uncompressed forms.
 194
 195 if [ $keep -lt 10 ]; then keept=0$keep; else keept=$keep; fi;
 196
 197 if [ -f $mainlog.$keept ]; then $rm $mainlog.$keept; fi;
 198 if [ -f $mainlog.$keept.$suffix ]; then $rm $mainlog.$keept.$suffix; fi;
 199
 200 if [ -f $rejectlog.$keept ]; then $rm $rejectlog.$keept; fi;
 201 if [ -f $rejectlog.$keept.$suffix ]; then $rm $rejectlog.$keept.$suffix; fi;
 202
 203 # Now rename all the previous old files by increasing their numbers by 1.
 204 # When the number is less than 10, insert a leading zero.
 205
 206 count=$keep
 207 if [ $count -lt 10 ]; then countt=0$count; else countt=$count; fi
 208
 209 while [ $count -gt 1 ]; do
 210   old=`expr $count - 1`
 211   if [ $keep -gt 99 ]; then
 212     if   [ $old -lt 10 ]; then oldt=00$old
 213     elif [ $old -lt 100 ]; then oldt=0$old
 214     else oldt=$old
 215     fi
 216   else
 217     if [ $old -lt 10 ]; then oldt=0$old; else oldt=$old; fi;
 218   fi
 219   if [ -f $mainlog.$oldt ]; then
 220     $mv $mainlog.$oldt $mainlog.$countt
 221   elif [ -f $mainlog.$oldt.$suffix ]; then
 222     $mv $mainlog.$oldt.$suffix $mainlog.$countt.$suffix
 223   fi
 224   if [ -f $rejectlog.$oldt ]; then
 225     $mv $rejectlog.$oldt $rejectlog.$countt
 226   elif [ -f $rejectlog.$oldt.$suffix ]; then
 227     $mv $rejectlog.$oldt.$suffix $rejectlog.$countt.$suffix
 228   fi
 229   count=$old
 230   countt=$oldt
 231 done
 232
 233 # Now rename the current files as 01 or 001 if keeping more than 99
 234
 235 if [ $keep -gt 99 ]; then first=001; else first=01; fi
 236
 237 if [ -f $mainlog ]; then
 238   $mv $mainlog $mainlog.$first
 239   $chown $user:$group $mainlog.$first
 240 fi
 241
 242 if [ -f $rejectlog ]; then
 243   $mv $rejectlog $rejectlog.$first
 244   $chown $user:$group $rejectlog.$first
 245 fi
 246
 247 # Now scan the (0)02 and later files, compressing where necessary, and
 248 # ensuring that their owners and groups are correct.
 249
 250 count=2;
 251
 252 while [ $count -le $keep ]; do
 253   if [ $keep -gt 99 ]; then
 254     if   [ $count -lt 10 ]; then countt=00$count
 255     elif [ $count -lt 100 ]; then countt=0$count
 256     else countt=$count
 257     fi
 258   else
 259     if [ $count -lt 10 ]; then countt=0$count; else countt=$count; fi
 260   fi
 261   if [ -f $mainlog.$countt ]; then $compress $mainlog.$countt; fi
 262   if [ -f $mainlog.$countt.$suffix ]; then
 263     $chown $user:$group $mainlog.$countt.$suffix
 264   fi
 265   if [ -f $rejectlog.$countt ]; then $compress $rejectlog.$countt; fi
 266   if [ -f $rejectlog.$countt.$suffix ]; then
 267     $chown $user:$group $rejectlog.$countt.$suffix
 268   fi
 269   count=`expr $count + 1`
 270 done
 271
 272 # End of exicyclog