lib/backupfile.c

   1 /* backupfile.c -- make Emacs style backup file names
   2    Copyright (C) 1990-1997, 1998, 1999, 2000 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 #ifndef HAVE_DECL_GETENV
  68 'this configure-time declaration test was not run'
  69 #endif
  70 #if !HAVE_DECL_GETENV
  71 char *getenv ();
  72 #endif
  73
  74 char *base_name PARAMS ((char const *));
  75
  76 #if HAVE_DIRENT_H || HAVE_NDIR_H || HAVE_SYS_DIR_H || HAVE_SYS_NDIR_H
  77 # define HAVE_DIR 1
  78 #else
  79 # define HAVE_DIR 0
  80 #endif
  81
  82 #if HAVE_LIMITS_H
  83 # include <limits.h>
  84 #endif
  85 #ifndef CHAR_BIT
  86 # define CHAR_BIT 8
  87 #endif
  88 /* Upper bound on the string length of an integer converted to string.
  89    302 / 1000 is ceil (log10 (2.0)).  Subtract 1 for the sign bit;
  90    add 1 for integer division truncation; add 1 more for a minus sign.  */
  91 #define INT_STRLEN_BOUND(t) ((sizeof (t) * CHAR_BIT - 1) * 302 / 1000 + 2)
  92
  93 /* ISDIGIT differs from isdigit, as follows:
  94    - Its arg may be any int or unsigned int; it need not be an unsigned char.
  95    - It's guaranteed to evaluate its argument exactly once.
  96    - It's typically faster.
  97    Posix 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
  98    only '0' through '9' are digits.  Prefer ISDIGIT to isdigit unless
  99    it's important to use the locale's definition of `digit' even when the
 100    host does not conform to Posix.  */
 101 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
 102
 103 #if D_INO_IN_DIRENT
 104 # define REAL_DIR_ENTRY(dp) ((dp)->d_ino != 0)
 105 #else
 106 # define REAL_DIR_ENTRY(dp) 1
 107 #endif
 108
 109 /* The extension added to file names to produce a simple (as opposed
 110    to numbered) backup file name. */
 111 const char *simple_backup_suffix = "~";
 112
 113 static int max_backup_version PARAMS ((const char *, const char *));
 114 static int version_number PARAMS ((const char *, const char *, size_t));
 115
 116 /* Return the name of the new backup file for file FILE,
 117    allocated with malloc.  Return 0 if out of memory.
 118    FILE must not end with a '/' unless it is the root directory.
 119    Do not call this function if backup_type == none. */
 120
 121 char *
 122 find_backup_file_name (const char *file, enum backup_type backup_type)
 123 {
 124   size_t backup_suffix_size_max;
 125   size_t file_len = strlen (file);
 126   size_t numbered_suffix_size_max = INT_STRLEN_BOUND (int) + 4;
 127   char *s;
 128   const char *suffix = simple_backup_suffix;
 129
 130   /* Allow room for simple or `.~N~' backups.  */
 131   backup_suffix_size_max = strlen (simple_backup_suffix) + 1;
 132   if (HAVE_DIR && backup_suffix_size_max < numbered_suffix_size_max)
 133     backup_suffix_size_max = numbered_suffix_size_max;
 134
 135   s = malloc (file_len + backup_suffix_size_max + numbered_suffix_size_max);
 136   if (s)
 137     {
 138       strcpy (s, file);
 139
 140 #if HAVE_DIR
 141       if (backup_type != simple)
 142         {
 143           int highest_backup;
 144           size_t dir_len = base_name (s) - s;
 145
 146           strcpy (s + dir_len, ".");
 147           highest_backup = max_backup_version (file + dir_len, s);
 148           if (! (backup_type == numbered_existing && highest_backup == 0))
 149             {
 150               char *numbered_suffix = s + (file_len + backup_suffix_size_max);
 151               sprintf (numbered_suffix, ".~%d~", highest_backup + 1);
 152               suffix = numbered_suffix;
 153             }
 154           strcpy (s, file);
 155         }
 156 #endif /* HAVE_DIR */
 157
 158       addext (s, suffix, '~');
 159     }
 160   return s;
 161 }
 162
 163 #if HAVE_DIR
 164
 165 /* Return the number of the highest-numbered backup file for file
 166    FILE in directory DIR.  If there are no numbered backups
 167    of FILE in DIR, or an error occurs reading DIR, return 0.
 168    */
 169
 170 static int
 171 max_backup_version (const char *file, const char *dir)
 172 {
 173   DIR *dirp;
 174   struct dirent *dp;
 175   int highest_version;
 176   int this_version;
 177   size_t file_name_length;
 178
 179   dirp = opendir (dir);
 180   if (!dirp)
 181     return 0;
 182
 183   highest_version = 0;
 184   file_name_length = strlen (file);
 185
 186   while ((dp = readdir (dirp)) != 0)
 187     {
 188       if (!REAL_DIR_ENTRY (dp) || NLENGTH (dp) < file_name_length + 4)
 189         continue;
 190
 191       this_version = version_number (file, dp->d_name, file_name_length);
 192       if (this_version > highest_version)
 193         highest_version = this_version;
 194     }
 195   if (CLOSEDIR (dirp))
 196     return 0;
 197   return highest_version;
 198 }
 199
 200 /* If BACKUP is a numbered backup of BASE, return its version number;
 201    otherwise return 0.  BASE_LENGTH is the length of BASE.
 202    */
 203
 204 static int
 205 version_number (const char *base, const char *backup, size_t base_length)
 206 {
 207   int version;
 208   const char *p;
 209
 210   version = 0;
 211   if (strncmp (base, backup, base_length) == 0
 212       && backup[base_length] == '.'
 213       && backup[base_length + 1] == '~')
 214     {
 215       for (p = &backup[base_length + 2]; ISDIGIT (*p); ++p)
 216         version = version * 10 + *p - '0';
 217       if (p[0] != '~' || p[1])
 218         version = 0;
 219     }
 220   return version;
 221 }
 222 #endif /* HAVE_DIR */
 223
 224 static const char * const backup_args[] =
 225 {
 226   /* In a series of synonyms, present the most meaning full first, so
 227      that argmatch_valid be more readable. */
 228   "none", "off",
 229   "simple", "never",
 230   "existing", "nil",
 231   "numbered", "t",
 232   0
 233 };
 234
 235 static const enum backup_type backup_types[] =
 236 {
 237   none, none,
 238   simple, simple,
 239   numbered_existing, numbered_existing,
 240   numbered, numbered
 241 };
 242
 243 /* Return the type of backup specified by VERSION.
 244    If VERSION is NULL or the empty string, return numbered_existing.
 245    If VERSION is invalid or ambiguous, fail with a diagnostic appropriate
 246    for the specified CONTEXT.  Unambiguous abbreviations are accepted.  */
 247
 248 enum backup_type
 249 get_version (const char *context, const char *version)
 250 {
 251   if (version == 0 || *version == 0)
 252     return numbered_existing;
 253   else
 254     return XARGMATCH (context, version, backup_args, backup_types);
 255 }
 256
 257
 258 /* Return the type of backup specified by VERSION.
 259    If VERSION is NULL, use the value of the envvar VERSION_CONTROL.
 260    If the specified string is invalid or ambiguous, fail with a diagnostic
 261    appropriate for the specified CONTEXT.
 262    Unambiguous abbreviations are accepted.  */
 263
 264 enum backup_type
 265 xget_version (const char *context, const char *version)
 266 {
 267   if (version && *version)
 268     return get_version (context, version);
 269   else
 270     return get_version ("$VERSION_CONTROL", getenv ("VERSION_CONTROL"));
 271 }