src/chmod.c

   1 /* chmod -- change permission modes of files
   2    Copyright (C) 89, 90, 91, 1995-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; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 /* Written by David MacKenzie <djm@gnu.ai.mit.edu> */
  19
  20 #include <config.h>
  21 #include <stdio.h>
  22 #include <getopt.h>
  23 #include <sys/types.h>
  24
  25 #include "system.h"
  26 #include "error.h"
  27 #include "filemode.h"
  28 #include "modechange.h"
  29 #include "quote.h"
  30 #include "savedir.h"
  31
  32 /* The official name of this program (e.g., no `g' prefix).  */
  33 #define PROGRAM_NAME "chmod"
  34
  35 #define AUTHORS "David MacKenzie"
  36
  37 enum Change_status
  38 {
  39   CH_SUCCEEDED,
  40   CH_FAILED,
  41   CH_NO_CHANGE_REQUESTED
  42 };
  43
  44 enum Verbosity
  45 {
  46   /* Print a message for each file that is processed.  */
  47   V_high,
  48
  49   /* Print a message for each file whose attributes we change.  */
  50   V_changes_only,
  51
  52   /* Do not be verbose.  This is the default. */
  53   V_off
  54 };
  55
  56 void strip_trailing_slashes ();
  57
  58 static int change_dir_mode PARAMS ((const char *dir,
  59                                     const struct mode_change *changes,
  60                                     const struct stat *statp));
  61
  62 /* The name the program was run with. */
  63 char *program_name;
  64
  65 /* If nonzero, change the modes of directories recursively. */
  66 static int recurse;
  67
  68 /* If nonzero, force silence (no error messages). */
  69 static int force_silent;
  70
  71 /* Level of verbosity.  */
  72 static enum Verbosity verbosity = V_off;
  73
  74 /* The argument to the --reference option.  Use the owner and group IDs
  75    of this file.  This file must exist.  */
  76 static char *reference_file;
  77
  78 /* For long options that have no equivalent short option, use a
  79    non-character as a pseudo short option, starting with CHAR_MAX + 1.  */
  80 enum
  81 {
  82   REFERENCE_FILE_OPTION = CHAR_MAX + 1
  83 };
  84
  85 static struct option const long_options[] =
  86 {
  87   {"recursive", no_argument, 0, 'R'},
  88   {"changes", no_argument, 0, 'c'},
  89   {"silent", no_argument, 0, 'f'},
  90   {"quiet", no_argument, 0, 'f'},
  91   {"reference", required_argument, 0, REFERENCE_FILE_OPTION},
  92   {"verbose", no_argument, 0, 'v'},
  93   {GETOPT_HELP_OPTION_DECL},
  94   {GETOPT_VERSION_OPTION_DECL},
  95   {0, 0, 0, 0}
  96 };
  97
  98 /* Tell the user how/if the MODE of FILE has been changed.
  99    CHANGED describes what (if anything) has happened. */
 100
 101 static void
 102 describe_change (const char *file, mode_t mode,
 103                  enum Change_status changed)
 104 {
 105   char perms[11];               /* "-rwxrwxrwx" ls-style modes. */
 106   const char *fmt;
 107
 108   mode_string (mode, perms);
 109   perms[10] = '\0';             /* `mode_string' does not null terminate. */
 110   switch (changed)
 111     {
 112     case CH_SUCCEEDED:
 113       fmt = _("mode of %s changed to %04lo (%s)\n");
 114       break;
 115     case CH_FAILED:
 116       fmt = _("failed to change mode of %s to %04lo (%s)\n");
 117       break;
 118     case CH_NO_CHANGE_REQUESTED:
 119       fmt = _("mode of %s retained as %04lo (%s)\n");
 120       break;
 121     default:
 122       abort ();
 123     }
 124   printf (fmt, quote (file),
 125           (unsigned long) (mode & CHMOD_MODE_BITS), &perms[1]);
 126 }
 127
 128 /* Change the mode of FILE according to the list of operations CHANGES.
 129    If DEREF_SYMLINK is nonzero and FILE is a symbolic link, change the
 130    mode of the referenced file.  If DEREF_SYMLINK is zero, ignore symbolic
 131    links.  Return 0 if successful, 1 if errors occurred. */
 132
 133 static int
 134 change_file_mode (const char *file, const struct mode_change *changes,
 135                   const int deref_symlink)
 136 {
 137   struct stat file_stats;
 138   mode_t newmode;
 139   int errors = 0;
 140   int fail;
 141   int saved_errno;
 142
 143   if (lstat (file, &file_stats))
 144     {
 145       if (force_silent == 0)
 146         error (0, errno, _("getting attributes of %s"), quote (file));
 147       return 1;
 148     }
 149 #ifdef S_ISLNK
 150   if (S_ISLNK (file_stats.st_mode))
 151     {
 152       if (! deref_symlink)
 153         return 0;
 154       else
 155         if (stat (file, &file_stats))
 156           {
 157             if (force_silent == 0)
 158               error (0, errno, _("getting attributes of %s"), quote (file));
 159             return 1;
 160           }
 161     }
 162 #endif
 163
 164   newmode = mode_adjust (file_stats.st_mode, changes);
 165
 166   fail = chmod (file, newmode);
 167   saved_errno = errno;
 168
 169   if (verbosity == V_high || (verbosity == V_changes_only && !fail))
 170     describe_change (file, newmode, (fail ? CH_FAILED : CH_SUCCEEDED));
 171
 172   if (fail)
 173     {
 174       if (force_silent == 0)
 175         error (0, saved_errno, _("changing permissions of %s"),
 176                quote (file));
 177       errors = 1;
 178     }
 179
 180   if (recurse && S_ISDIR (file_stats.st_mode))
 181     errors |= change_dir_mode (file, changes, &file_stats);
 182   return errors;
 183 }
 184
 185 /* Recursively change the modes of the files in directory DIR
 186    according to the list of operations CHANGES.
 187    STATP points to the results of lstat on DIR.
 188    Return 0 if successful, 1 if errors occurred. */
 189
 190 static int
 191 change_dir_mode (const char *dir, const struct mode_change *changes,
 192                  const struct stat *statp)
 193 {
 194   char *name_space, *namep;
 195   char *path;                   /* Full path of each entry to process. */
 196   unsigned dirlength;           /* Length of DIR and '\0'. */
 197   unsigned filelength;          /* Length of each pathname to process. */
 198   unsigned pathlength;          /* Bytes allocated for `path'. */
 199   int errors = 0;
 200
 201   name_space = savedir (dir, statp->st_size);
 202   if (name_space == NULL)
 203     {
 204       if (force_silent == 0)
 205         error (0, errno, "%s", quote (dir));
 206       return 1;
 207     }
 208
 209   dirlength = strlen (dir) + 1; /* + 1 is for the trailing '/'. */
 210   pathlength = dirlength + 1;
 211   /* Give `path' a dummy value; it will be reallocated before first use. */
 212   path = xmalloc (pathlength);
 213   strcpy (path, dir);
 214   path[dirlength - 1] = '/';
 215
 216   for (namep = name_space; *namep; namep += filelength - dirlength)
 217     {
 218       filelength = dirlength + strlen (namep) + 1;
 219       if (filelength > pathlength)
 220         {
 221           pathlength = filelength * 2;
 222           path = xrealloc (path, pathlength);
 223         }
 224       strcpy (path + dirlength, namep);
 225       errors |= change_file_mode (path, changes, 0);
 226     }
 227   free (path);
 228   free (name_space);
 229   return errors;
 230 }
 231
 232 void
 233 usage (int status)
 234 {
 235   if (status != 0)
 236     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 237              program_name);
 238   else
 239     {
 240       printf (_("\
 241 Usage: %s [OPTION]... MODE[,MODE]... FILE...\n\
 242   or:  %s [OPTION]... OCTAL-MODE FILE...\n\
 243   or:  %s [OPTION]... --reference=RFILE FILE...\n\
 244 "),
 245               program_name, program_name, program_name);
 246       printf (_("\
 247 Change the mode of each FILE to MODE.\n\
 248 \n\
 249   -c, --changes           like verbose but report only when a change is made\n\
 250   -f, --silent, --quiet   suppress most error messages\n\
 251   -v, --verbose           output a diagnostic for every file processed\n\
 252       --reference=RFILE   use RFILE's mode instead of MODE values\n\
 253   -R, --recursive         change files and directories recursively\n\
 254       --help              display this help and exit\n\
 255       --version           output version information and exit\n\
 256 \n\
 257 Each MODE is one or more of the letters ugoa, one of the symbols +-= and\n\
 258 one or more of the letters rwxXstugo.\n\
 259 "));
 260       puts (_("\nReport bugs to <bug-fileutils@gnu.org>."));
 261     }
 262   exit (status);
 263 }
 264
 265 /* Parse the ASCII mode given on the command line into a linked list
 266    of `struct mode_change' and apply that to each file argument. */
 267
 268 int
 269 main (int argc, char **argv)
 270 {
 271   struct mode_change *changes;
 272   int errors = 0;
 273   int modeind = 0;              /* Index of the mode argument in `argv'. */
 274   int thisind;
 275   int c;
 276
 277   program_name = argv[0];
 278   setlocale (LC_ALL, "");
 279   bindtextdomain (PACKAGE, LOCALEDIR);
 280   textdomain (PACKAGE);
 281
 282   atexit (close_stdout);
 283
 284   recurse = force_silent = 0;
 285
 286   while (1)
 287     {
 288       thisind = optind ? optind : 1;
 289
 290       c = getopt_long (argc, argv, "RcfvrwxXstugoa,+-=", long_options, NULL);
 291       if (c == -1)
 292         break;
 293
 294       switch (c)
 295         {
 296         case 0:
 297           break;
 298         case 'r':
 299         case 'w':
 300         case 'x':
 301         case 'X':
 302         case 's':
 303         case 't':
 304         case 'u':
 305         case 'g':
 306         case 'o':
 307         case 'a':
 308         case ',':
 309         case '+':
 310         case '-':
 311         case '=':
 312           if (modeind != 0 && modeind != thisind)
 313             error (1, 0, _("invalid mode"));
 314           modeind = thisind;
 315           break;
 316         case REFERENCE_FILE_OPTION:
 317           reference_file = optarg;
 318           break;
 319         case 'R':
 320           recurse = 1;
 321           break;
 322         case 'c':
 323           verbosity = V_changes_only;
 324           break;
 325         case 'f':
 326           force_silent = 1;
 327           break;
 328         case 'v':
 329           verbosity = V_high;
 330           break;
 331         case_GETOPT_HELP_CHAR;
 332         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 333         default:
 334           usage (1);
 335         }
 336     }
 337
 338   if (modeind == 0 && reference_file == NULL)
 339     modeind = optind++;
 340
 341   if (optind >= argc)
 342     {
 343       error (0, 0, _("too few arguments"));
 344       usage (1);
 345     }
 346
 347   changes = (reference_file ? mode_create_from_ref (reference_file)
 348              : mode_compile (argv[modeind], MODE_MASK_ALL));
 349
 350   if (changes == MODE_INVALID)
 351     error (1, 0, _("invalid mode"));
 352   else if (changes == MODE_MEMORY_EXHAUSTED)
 353     xalloc_die ();
 354   else if (changes == MODE_BAD_REFERENCE)
 355     error (1, errno, _("getting attributes of %s"), quote (reference_file));
 356
 357   for (; optind < argc; ++optind)
 358     {
 359       strip_trailing_slashes (argv[optind]);
 360       errors |= change_file_mode (argv[optind], changes, 1);
 361     }
 362
 363   exit (errors);
 364 }