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 static int
  99 mode_changed (const char *file, mode_t old_mode)
 100 {
 101   struct stat new_stats;
 102
 103   if (stat (file, &new_stats))
 104     {
 105       if (force_silent == 0)
 106         error (0, errno, _("getting new attributes of %s"), quote (file));
 107       return 0;
 108     }
 109
 110   return old_mode != new_stats.st_mode;
 111 }
 112
 113 /* Tell the user how/if the MODE of FILE has been changed.
 114    CHANGED describes what (if anything) has happened. */
 115
 116 static void
 117 describe_change (const char *file, mode_t mode,
 118                  enum Change_status changed)
 119 {
 120   char perms[11];               /* "-rwxrwxrwx" ls-style modes. */
 121   const char *fmt;
 122
 123   mode_string (mode, perms);
 124   perms[10] = '\0';             /* `mode_string' does not null terminate. */
 125   switch (changed)
 126     {
 127     case CH_SUCCEEDED:
 128       fmt = _("mode of %s changed to %04lo (%s)\n");
 129       break;
 130     case CH_FAILED:
 131       fmt = _("failed to change mode of %s to %04lo (%s)\n");
 132       break;
 133     case CH_NO_CHANGE_REQUESTED:
 134       fmt = _("mode of %s retained as %04lo (%s)\n");
 135       break;
 136     default:
 137       abort ();
 138     }
 139   printf (fmt, quote (file),
 140           (unsigned long) (mode & CHMOD_MODE_BITS), &perms[1]);
 141 }
 142
 143 /* Change the mode of FILE according to the list of operations CHANGES.
 144    If DEREF_SYMLINK is nonzero and FILE is a symbolic link, change the
 145    mode of the referenced file.  If DEREF_SYMLINK is zero, ignore symbolic
 146    links.  Return 0 if successful, 1 if errors occurred. */
 147
 148 static int
 149 change_file_mode (const char *file, const struct mode_change *changes,
 150                   const int deref_symlink)
 151 {
 152   struct stat file_stats;
 153   mode_t newmode;
 154   int errors = 0;
 155   int fail;
 156   int saved_errno;
 157
 158   if (deref_symlink ? stat (file, &file_stats) : lstat (file, &file_stats))
 159     {
 160       if (force_silent == 0)
 161         error (0, errno, _("getting attributes of %s"), quote (file));
 162       return 1;
 163     }
 164
 165 #ifdef S_ISLNK
 166   if (S_ISLNK (file_stats.st_mode))
 167     return 0;
 168 #endif
 169
 170   newmode = mode_adjust (file_stats.st_mode, changes);
 171
 172   fail = chmod (file, newmode);
 173   saved_errno = errno;
 174
 175   if (verbosity == V_high
 176       || (verbosity == V_changes_only
 177           && !fail && mode_changed (file, file_stats.st_mode)))
 178     describe_change (file, newmode, (fail ? CH_FAILED : CH_SUCCEEDED));
 179
 180   if (fail)
 181     {
 182       if (force_silent == 0)
 183         error (0, saved_errno, _("changing permissions of %s"),
 184                quote (file));
 185       errors = 1;
 186     }
 187
 188   if (recurse && S_ISDIR (file_stats.st_mode))
 189     errors |= change_dir_mode (file, changes, &file_stats);
 190   return errors;
 191 }
 192
 193 /* Recursively change the modes of the files in directory DIR
 194    according to the list of operations CHANGES.
 195    STATP points to the results of lstat on DIR.
 196    Return 0 if successful, 1 if errors occurred. */
 197
 198 static int
 199 change_dir_mode (const char *dir, const struct mode_change *changes,
 200                  const struct stat *statp)
 201 {
 202   char *name_space, *namep;
 203   char *path;                   /* Full path of each entry to process. */
 204   unsigned dirlength;           /* Length of DIR and '\0'. */
 205   unsigned filelength;          /* Length of each pathname to process. */
 206   unsigned pathlength;          /* Bytes allocated for `path'. */
 207   int errors = 0;
 208
 209   name_space = savedir (dir, statp->st_size);
 210   if (name_space == NULL)
 211     {
 212       if (force_silent == 0)
 213         error (0, errno, "%s", quote (dir));
 214       return 1;
 215     }
 216
 217   dirlength = strlen (dir) + 1; /* + 1 is for the trailing '/'. */
 218   pathlength = dirlength + 1;
 219   /* Give `path' a dummy value; it will be reallocated before first use. */
 220   path = xmalloc (pathlength);
 221   strcpy (path, dir);
 222   path[dirlength - 1] = '/';
 223
 224   for (namep = name_space; *namep; namep += filelength - dirlength)
 225     {
 226       filelength = dirlength + strlen (namep) + 1;
 227       if (filelength > pathlength)
 228         {
 229           pathlength = filelength * 2;
 230           path = xrealloc (path, pathlength);
 231         }
 232       strcpy (path + dirlength, namep);
 233       errors |= change_file_mode (path, changes, 0);
 234     }
 235   free (path);
 236   free (name_space);
 237   return errors;
 238 }
 239
 240 void
 241 usage (int status)
 242 {
 243   if (status != 0)
 244     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 245              program_name);
 246   else
 247     {
 248       printf (_("\
 249 Usage: %s [OPTION]... MODE[,MODE]... FILE...\n\
 250   or:  %s [OPTION]... OCTAL-MODE FILE...\n\
 251   or:  %s [OPTION]... --reference=RFILE FILE...\n\
 252 "),
 253               program_name, program_name, program_name);
 254       printf (_("\
 255 Change the mode of each FILE to MODE.\n\
 256 \n\
 257   -c, --changes           like verbose but report only when a change is made\n\
 258   -f, --silent, --quiet   suppress most error messages\n\
 259   -v, --verbose           output a diagnostic for every file processed\n\
 260       --reference=RFILE   use RFILE's mode instead of MODE values\n\
 261   -R, --recursive         change files and directories recursively\n\
 262       --help              display this help and exit\n\
 263       --version           output version information and exit\n\
 264 \n\
 265 Each MODE is one or more of the letters ugoa, one of the symbols +-= and\n\
 266 one or more of the letters rwxXstugo.\n\
 267 "));
 268       puts (_("\nReport bugs to <bug-fileutils@gnu.org>."));
 269     }
 270   exit (status);
 271 }
 272
 273 /* Parse the ASCII mode given on the command line into a linked list
 274    of `struct mode_change' and apply that to each file argument. */
 275
 276 int
 277 main (int argc, char **argv)
 278 {
 279   struct mode_change *changes;
 280   int errors = 0;
 281   int modeind = 0;              /* Index of the mode argument in `argv'. */
 282   int thisind;
 283   int c;
 284
 285   program_name = argv[0];
 286   setlocale (LC_ALL, "");
 287   bindtextdomain (PACKAGE, LOCALEDIR);
 288   textdomain (PACKAGE);
 289
 290   atexit (close_stdout);
 291
 292   recurse = force_silent = 0;
 293
 294   while (1)
 295     {
 296       thisind = optind ? optind : 1;
 297
 298       c = getopt_long (argc, argv, "RcfvrwxXstugoa,+-=", long_options, NULL);
 299       if (c == -1)
 300         break;
 301
 302       switch (c)
 303         {
 304         case 0:
 305           break;
 306         case 'r':
 307         case 'w':
 308         case 'x':
 309         case 'X':
 310         case 's':
 311         case 't':
 312         case 'u':
 313         case 'g':
 314         case 'o':
 315         case 'a':
 316         case ',':
 317         case '+':
 318         case '-':
 319         case '=':
 320           if (modeind != 0 && modeind != thisind)
 321             {
 322               static char char_string[2] = {0, 0};
 323               char_string[0] = c;
 324               error (1, 0, _("invalid character %s in mode string %s"),
 325                      quote_n (0, char_string), quote_n (1, argv[thisind]));
 326             }
 327           modeind = thisind;
 328           break;
 329         case REFERENCE_FILE_OPTION:
 330           reference_file = optarg;
 331           break;
 332         case 'R':
 333           recurse = 1;
 334           break;
 335         case 'c':
 336           verbosity = V_changes_only;
 337           break;
 338         case 'f':
 339           force_silent = 1;
 340           break;
 341         case 'v':
 342           verbosity = V_high;
 343           break;
 344         case_GETOPT_HELP_CHAR;
 345         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 346         default:
 347           usage (1);
 348         }
 349     }
 350
 351   if (modeind == 0 && reference_file == NULL)
 352     modeind = optind++;
 353
 354   if (optind >= argc)
 355     {
 356       error (0, 0, _("too few arguments"));
 357       usage (1);
 358     }
 359
 360   changes = (reference_file ? mode_create_from_ref (reference_file)
 361              : mode_compile (argv[modeind], MODE_MASK_ALL));
 362
 363   if (changes == MODE_INVALID)
 364     error (1, 0, _("invalid mode string: %s"), quote (argv[modeind]));
 365   else if (changes == MODE_MEMORY_EXHAUSTED)
 366     xalloc_die ();
 367   else if (changes == MODE_BAD_REFERENCE)
 368     error (1, errno, _("getting attributes of %s"), quote (reference_file));
 369
 370   for (; optind < argc; ++optind)
 371     {
 372       strip_trailing_slashes (argv[optind]);
 373       errors |= change_file_mode (argv[optind], changes, 1);
 374     }
 375
 376   exit (errors);
 377 }