home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 February / PCWorld_2000-02_cd.bin / live / usr / bin / savelog < prev    next >
Text File  |  1998-08-16  |  6KB  |  241 lines
  1. #! /bin/sh
  2. # savelog - save a log file
  3. #    Copyright (C) 1987, 1988 Ronald S. Karr and Landon Curt Noll
  4. #    Copyright (C) 1992  Ronald S. Karr
  5. # Slight modifications by Ian A. Murdock <imurdock@gnu.ai.mit.edu>:
  6. #    * uses `gzip' rather than `compress'
  7. #    * doesn't use $savedir; keeps saved log files in the same directory
  8. #    * reports successful rotation of log files
  9. #    * for the sake of consistency, files are rotated even if they are
  10. #      empty
  11. # More modifications by Guy Maor <maor@debian.org>:
  12. #       * cleanup.
  13. #       * -p (preserve) option
  14. # 
  15. # usage: savelog [-m mode] [-u user] [-g group] [-t] [-p] [-c cycle] [-l]
  16. #                file...
  17. #    -m mode      - chmod log files to mode
  18. #    -u user      - chown log files to user
  19. #    -g group  - chgrp log files to group
  20. #    -c cycle  - save cycle versions of the logfile    (default: 7)
  21. #    -t      - touch file
  22. #    -l      - don't compress any log files    (default: compress)
  23. #       -p        - preserve mode/user/group of original file
  24. #    file       - log file names
  25. #
  26. # The savelog command saves and optionally compresses old copies of files.
  27. # Older version of 'file' are named:
  28. #
  29. #        'file'.<number><compress_suffix>
  30. #
  31. # where <number> is the version number, 0 being the newest.  By default,
  32. # version numbers > 0 are compressed (unless -l prevents it). The
  33. # version number 0 is never compressed on the off chance that a process
  34. # still has 'file' opened for I/O.
  35. #
  36. # If the 'file' does not exist and -t was given, it will be created.
  37. #
  38. # For files that do exist and have lengths greater than zero, the following 
  39. # actions are performed.
  40. #
  41. #    1) Version numered files are cycled.  That is version 6 is moved to
  42. #       version 7, version is moved to becomes version 6, ... and finally
  43. #       version 0 is moved to version 1.  Both compressed names and
  44. #       uncompressed names are cycled, regardless of -t.  Missing version 
  45. #       files are ignored.
  46. #
  47. #    2) The new file.1 is compressed and is changed subject to 
  48. #       the -m, -u and -g flags.  This step is skipped if the -t flag 
  49. #       was given.
  50. #
  51. #    3) The main file is moved to file.0.
  52. #
  53. #    4) If the -m, -u, -g, -t, or -p flags are given, then the file is
  54. #          touched into existence subject to the given flags.  The -p flag
  55. #          will preserve the original owner, group, and permissions.
  56. #
  57. #    5) The new file.0 is changed subject to the -m, -u and -g flags.
  58. #
  59. # Note: If no -m, -u, -g, -t, or -p is given, then the primary log file is 
  60. #    not created.
  61. #
  62. # Note: Since the version numbers start with 0, version number <cycle>
  63. #       is never formed.  The <cycle> count must be at least 2.
  64. #
  65. # Bugs: If a process is still writing to the file.0 and savelog
  66. #    moved it to file.1 and compresses it, data could be lost.
  67. #    Smail does not have this problem in general because it
  68. #    restats files often.
  69.  
  70. # common location
  71. export PATH=$PATH:/sbin:/bin:/usr/sbin:/usr/bin
  72. COMPRESS="gzip -9f"
  73. DOT_Z=".gz"
  74.  
  75. # parse args
  76. exitcode=0    # no problems to far
  77. prog=`basename $0`
  78. mode=
  79. user=
  80. group=
  81. touch=
  82. preserve=
  83. count=7
  84.  
  85. usage()
  86. {
  87.     echo "Usage: $prog [-m mode][-u user][-g group][-t][-c cycle][-l][-p] file ..."
  88. }
  89.  
  90.  
  91. fixfile()
  92. {
  93.     if [ -n "$user" ]; then
  94.     chown "$user" "$1"
  95.     fi
  96.     if [ -n "$group" ]; then 
  97.     chgrp "$group" "$1"
  98.     fi
  99.     if [ -n "$mode" ]; then 
  100.     chmod "$mode" "$1"
  101.     fi
  102. }
  103.  
  104.  
  105. while getopts m:u:g:c:ltph opt ; do
  106.     case "$opt" in
  107.     m) mode="$OPTARG" ;;
  108.     u) user="$OPTARG" ;;
  109.     g) group="$OPTARG" ;;
  110.     c) count="$OPTARG" ;;
  111.     t) touch=1 ;;
  112.     l) COMPRESS="" ;;
  113.     p) preserve=1 ;;
  114.     h) usage; exit 0 ;;
  115.     *) usage; exit 1 ;;
  116.     esac
  117. done
  118.  
  119. shift $(($OPTIND - 1))
  120.  
  121. if [ "$count" -lt 2 ]; then
  122.     echo "$prog: count must be at least 2" 1>&2
  123.     exit 2
  124. fi
  125.  
  126. # cycle thru filenames
  127. while [ $# -gt 0 ]; do
  128.  
  129.     # get the filename
  130.     filename="$1"
  131.     shift
  132.  
  133.     # catch bogus files
  134.     if [ -e "$filename" -a ! -f "$filename" ]; then
  135.         echo "$prog: $filename is not a regular file" 1>&2
  136.         exitcode=3
  137.         continue
  138.     fi
  139.  
  140.     # if not a file or empty, do nothing major
  141.     # (in the Debian version, we rotate even if empty)
  142.     #if [ ! -s $filename ]; then
  143.         # if -t was given and it does not exist, create it
  144.         if [ -n "$touch" -a ! -f "$filename" ]; then 
  145.             touch "$filename"
  146.             if [ "$?" -ne 0 ]; then
  147.                 echo "$prog: could not touch $filename" 1>&2
  148.                 exitcode=4
  149.                 continue
  150.             fi
  151.             fixfile "$filename"
  152.         fi
  153.     #    continue
  154.     #fi
  155.  
  156.      # be sure that the savedir exists and is writable
  157.     # (in the Debian version, $savedir is . and not ./OLD)
  158.      savedir=`dirname "$filename"`
  159.      if [ -z "$savedir" ]; then
  160.          savedir=.
  161.      fi
  162.      if [ ! -d "$savedir" ]; then
  163.          mkdir "$savedir"
  164.          if [ "$?" -ne 0 ]; then
  165.              echo "$prog: could not mkdir $savedir" 1>&2
  166.              exitcode=5
  167.              continue
  168.          fi
  169.          chmod 0755 "$savedir"
  170.      fi
  171.      if [ ! -w "$savedir" ]; then
  172.          echo "$prog: directory $savedir is not writable" 1>&2
  173.          exitcode=7
  174.          continue
  175.      fi
  176.  
  177.     # determine our uncompressed file names
  178.     newname=`basename "$filename"`
  179.     newname="$savedir/$newname"
  180.  
  181.     # cycle the old compressed log files
  182.     cycle=$(( $count - 1))
  183.     rm -f "$newname.$cycle" "$newname.$cycle$DOT_Z"
  184.     while [ $cycle -gt 1 ]; do
  185.         # --cycle
  186.         oldcycle=$cycle
  187.         cycle=$(( $cycle - 1 ))
  188.         # cycle log
  189.         if [ -f "$newname.$cycle$DOT_Z" ]; then
  190.             mv -f "$newname.$cycle$DOT_Z" \
  191.                 "$newname.$oldcycle$DOT_Z"
  192.         fi
  193.         if [ -f "$newname.$cycle" ]; then
  194.             # file was not compressed. move it anyway
  195.             mv -f "$newname.$cycle" "$newname.$oldcycle"
  196.         fi
  197.     done
  198.  
  199.     # compress the old uncompressed log if needed
  200.     if [ -f "$newname.0" ]; then
  201.         if [ -z "$COMPRESS" ]; then
  202.             newfile="$newname.1"
  203.             mv "$newname.0" "$newfile"
  204.         else
  205.             newfile="$newname.1$DOT_Z"
  206. #            $COMPRESS < $newname.0 > $newfile
  207. #            rm -f $newname.0
  208.             $COMPRESS "$newname.0"
  209.             mv "$newname.0$DOT_Z" "$newfile"
  210.         fi
  211.         fixfile "$newfile"
  212.     fi
  213.  
  214.     # create new file if needed
  215.     if [ -n "$preserve" ]; then
  216.         cp -p "$filename" "$filename.new"
  217.         echo -n > "$filename.new"
  218.         filenew=1
  219.     elif [ -n "$touch$user$group$mode" ]; then
  220.         touch "$filename.new"
  221.         fixfile "$filename.new"
  222.         filenew=1
  223.     fi
  224.  
  225.     # link the file into the file.0 holding place
  226.     if [ -f "$filename" ]; then
  227.         if [ -n "$filenew" ]; then
  228.             ln -f "$filename" "$newname.0"
  229.             mv "$filename.new" "$filename"
  230.         else
  231.             mv "$filename" "$newname.0"
  232.         fi
  233.     fi
  234.     [ ! -f "$newname.0" ] && touch "$newname.0"
  235.     fixfile "$newname.0"
  236.  
  237.     # report successful rotation
  238.     echo "Rotated \`$filename' at `date`."
  239. done
  240. exit $exitcode
  241.