lib/backupfile.c

   1 /* backupfile.c -- make Emacs style backup file names
   2    Copyright (C) 1990-1997, 1998 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; see the file COPYING.
  16    If not, write to the Free Software Foundation,
  17    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  18
  19 /* Written by David MacKenzie <djm@gnu.ai.mit.edu>.
  20    Some algorithms adapted from GNU Emacs. */
  21
  22 #if HAVE_CONFIG_H
  23 # include <config.h>
  24 #endif
  25
  26 #include <argmatch.h>
  27 #include <backupfile.h>
  28
  29 #include <stdio.h>
  30 #include <sys/types.h>
  31 #if HAVE_STRING_H
  32 # include <string.h>
  33 #else
  34 # include <strings.h>
  35 #endif
  36
  37 #if HAVE_DIRENT_H
  38 # include <dirent.h>
  39 # define NLENGTH(direct) strlen ((direct)->d_name)
  40 #else
  41 # define dirent direct
  42 # define NLENGTH(direct) ((size_t) (direct)->d_namlen)
  43 # if HAVE_SYS_NDIR_H
  44 #  include <sys/ndir.h>
  45 # endif
  46 # if HAVE_SYS_DIR_H
  47 #  include <sys/dir.h>
  48 # endif
  49 # if HAVE_NDIR_H
  50 #  include <ndir.h>
  51 # endif
  52 #endif
  53
  54 #if CLOSEDIR_VOID
  55 /* Fake a return value. */
  56 # define CLOSEDIR(d) (closedir (d), 0)
  57 #else
  58 # define CLOSEDIR(d) closedir (d)
  59 #endif
  60
  61 #if STDC_HEADERS
  62 # include <stdlib.h>
  63 #else
  64 char *malloc ();
  65 #endif
  66
  67 #if HAVE_DIRENT_H || HAVE_NDIR_H || HAVE_SYS_DIR_H || HAVE_SYS_NDIR_H
  68 # define HAVE_DIR 1
  69 #else
  70 # define HAVE_DIR 0
  71 #endif
  72
  73 #if HAVE_LIMITS_H
  74 # include <limits.h>
  75 #endif
  76 #ifndef CHAR_BIT
  77 # define CHAR_BIT 8
  78 #endif
  79 /* Upper bound on the string length of an integer converted to string.
  80    302 / 1000 is ceil (log10 (2.0)).  Subtract 1 for the sign bit;
  81    add 1 for integer division truncation; add 1 more for a minus sign.  */
  82 #define INT_STRLEN_BOUND(t) ((sizeof (t) * CHAR_BIT - 1) * 302 / 1000 + 2)
  83
  84 /* ISDIGIT differs from isdigit, as follows:
  85    - Its arg may be any int or unsigned int; it need not be an unsigned char.
  86    - It's guaranteed to evaluate its argument exactly once.
  87    - It's typically faster.
  88    Posix 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
  89    only '0' through '9' are digits.  Prefer ISDIGIT to isdigit unless
  90    it's important to use the locale's definition of `digit' even when the
  91    host does not conform to Posix.  */
  92 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
  93
  94 #if D_INO_IN_DIRENT
  95 # define REAL_DIR_ENTRY(dp) ((dp)->d_ino != 0)
  96 #else
  97 # define REAL_DIR_ENTRY(dp) 1
  98 #endif
  99
 100 /* The following test is to work around the gross typo in
 101    systems like Sony NEWS-OS Release 4.0C, whereby EXIT_FAILURE
 102    is defined to 0, not 1.  */
 103 #if !EXIT_FAILURE
 104 # undef EXIT_FAILURE
 105 # define EXIT_FAILURE 1
 106 #endif
 107
 108 #ifndef BACKUPFILE_EXIT_FAILURE
 109 # define BACKUPFILE_EXIT_FAILURE EXIT_FAILURE
 110 #endif
 111
 112 /* The extension added to file names to produce a simple (as opposed
 113    to numbered) backup file name. */
 114 const char *simple_backup_suffix = "~";
 115
 116 static int max_backup_version PARAMS ((const char *, const char *));
 117 static int version_number PARAMS ((const char *, const char *, size_t));
 118
 119 /* Return the name of the new backup file for file FILE,
 120    allocated with malloc.  Return 0 if out of memory.
 121    FILE must not end with a '/' unless it is the root directory.
 122    Do not call this function if backup_type == none. */
 123
 124 char *
 125 find_backup_file_name (const char *file, enum backup_type backup_type)
 126 {
 127   size_t backup_suffix_size_max;
 128   size_t file_len = strlen (file);
 129   size_t numbered_suffix_size_max = INT_STRLEN_BOUND (int) + 4;
 130   char *s;
 131   const char *suffix = simple_backup_suffix;
 132
 133   /* Allow room for simple or `.~N~' backups.  */
 134   backup_suffix_size_max = strlen (simple_backup_suffix) + 1;
 135   if (HAVE_DIR && backup_suffix_size_max < numbered_suffix_size_max)
 136     backup_suffix_size_max = numbered_suffix_size_max;
 137
 138   s = malloc (file_len + backup_suffix_size_max + numbered_suffix_size_max);
 139   if (s)
 140     {
 141       strcpy (s, file);
 142
 143 #if HAVE_DIR
 144       if (backup_type != simple)
 145         {
 146           int highest_backup;
 147           size_t dir_len = base_name (s) - s;
 148
 149           strcpy (s + dir_len, ".");
 150           highest_backup = max_backup_version (file + dir_len, s);
 151           if (! (backup_type == numbered_existing && highest_backup == 0))
 152             {
 153               char *numbered_suffix = s + (file_len + backup_suffix_size_max);
 154               sprintf (numbered_suffix, ".~%d~", highest_backup + 1);
 155               suffix = numbered_suffix;
 156             }
 157           strcpy (s, file);
 158         }
 159 #endif /* HAVE_DIR */
 160
 161       addext (s, suffix, '~');
 162     }
 163   return s;
 164 }
 165
 166 #if HAVE_DIR
 167
 168 /* Return the number of the highest-numbered backup file for file
 169    FILE in directory DIR.  If there are no numbered backups
 170    of FILE in DIR, or an error occurs reading DIR, return 0.
 171    */
 172
 173 static int
 174 max_backup_version (const char *file, const char *dir)
 175 {
 176   DIR *dirp;
 177   struct dirent *dp;
 178   int highest_version;
 179   int this_version;
 180   size_t file_name_length;
 181
 182   dirp = opendir (dir);
 183   if (!dirp)
 184     return 0;
 185
 186   highest_version = 0;
 187   file_name_length = strlen (file);
 188
 189   while ((dp = readdir (dirp)) != 0)
 190     {
 191       if (!REAL_DIR_ENTRY (dp) || NLENGTH (dp) < file_name_length + 4)
 192         continue;
 193
 194       this_version = version_number (file, dp->d_name, file_name_length);
 195       if (this_version > highest_version)
 196         highest_version = this_version;
 197     }
 198   if (CLOSEDIR (dirp))
 199     return 0;
 200   return highest_version;
 201 }
 202
 203 /* If BACKUP is a numbered backup of BASE, return its version number;
 204    otherwise return 0.  BASE_LENGTH is the length of BASE.
 205    */
 206
 207 static int
 208 version_number (const char *base, const char *backup, size_t base_length)
 209 {
 210   int version;
 211   const char *p;
 212
 213   version = 0;
 214   if (strncmp (base, backup, base_length) == 0
 215       && backup[base_length] == '.'
 216       && backup[base_length + 1] == '~')
 217     {
 218       for (p = &backup[base_length + 2]; ISDIGIT (*p); ++p)
 219         version = version * 10 + *p - '0';
 220       if (p[0] != '~' || p[1])
 221         version = 0;
 222     }
 223   return version;
 224 }
 225 #endif /* HAVE_DIR */
 226
 227 static const char *const backup_args[] =
 228 {
 229   "never", "simple", "nil", "existing", "t", "numbered", 0
 230 };
 231
 232 static const enum backup_type backup_types[] =
 233 {
 234   simple, simple, numbered_existing, numbered_existing, numbered, numbered
 235 };
 236
 237 /* Return the type of backup indicated by VERSION.
 238    Unique abbreviations are accepted. */
 239
 240 enum backup_type
 241 get_version (const char *version)
 242 {
 243   int i;
 244
 245   if (version == 0 || *version == 0)
 246     return numbered_existing;
 247   i = argmatch (version, backup_args);
 248   if (i < 0)
 249     {
 250       invalid_arg ("version control type", version, i);
 251       exit (BACKUPFILE_EXIT_FAILURE);
 252     }
 253   return backup_types[i];
 254 }