src/chmod.c

   1 /* chmod -- change permission modes of files
   2    Copyright (C) 89, 90, 91, 1995-2004 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 "dev-ino.h"
  27 #include "dirname.h"
  28 #include "error.h"
  29 #include "filemode.h"
  30 #include "modechange.h"
  31 #include "quote.h"
  32 #include "root-dev-ino.h"
  33 #include "xfts.h"
  34
  35 /* The official name of this program (e.g., no `g' prefix).  */
  36 #define PROGRAM_NAME "chmod"
  37
  38 #define AUTHORS "David MacKenzie", "Jim Meyering"
  39
  40 enum Change_status
  41 {
  42   CH_SUCCEEDED,
  43   CH_FAILED,
  44   CH_NO_CHANGE_REQUESTED
  45 };
  46
  47 enum Verbosity
  48 {
  49   /* Print a message for each file that is processed.  */
  50   V_high,
  51
  52   /* Print a message for each file whose attributes we change.  */
  53   V_changes_only,
  54
  55   /* Do not be verbose.  This is the default. */
  56   V_off
  57 };
  58
  59 /* The name the program was run with. */
  60 char *program_name;
  61
  62 /* If nonzero, change the modes of directories recursively. */
  63 static int recurse;
  64
  65 /* If nonzero, force silence (no error messages). */
  66 static int force_silent;
  67
  68 /* Level of verbosity.  */
  69 static enum Verbosity verbosity = V_off;
  70
  71 /* The argument to the --reference option.  Use the owner and group IDs
  72    of this file.  This file must exist.  */
  73 static char *reference_file;
  74
  75 /* Pointer to the device and inode numbers of `/', when --recursive.
  76    Otherwise NULL.  */
  77 static struct dev_ino *root_dev_ino;
  78
  79 /* For long options that have no equivalent short option, use a
  80    non-character as a pseudo short option, starting with CHAR_MAX + 1.  */
  81 enum
  82 {
  83   NO_PRESERVE_ROOT = CHAR_MAX + 1,
  84   PRESERVE_ROOT,
  85   REFERENCE_FILE_OPTION
  86 };
  87
  88 static struct option const long_options[] =
  89 {
  90   {"changes", no_argument, 0, 'c'},
  91   {"recursive", no_argument, 0, 'R'},
  92   {"no-preserve-root", no_argument, 0, NO_PRESERVE_ROOT},
  93   {"preserve-root", no_argument, 0, PRESERVE_ROOT},
  94   {"quiet", no_argument, 0, 'f'},
  95   {"reference", required_argument, 0, REFERENCE_FILE_OPTION},
  96   {"silent", no_argument, 0, 'f'},
  97   {"verbose", no_argument, 0, 'v'},
  98   {GETOPT_HELP_OPTION_DECL},
  99   {GETOPT_VERSION_OPTION_DECL},
 100   {0, 0, 0, 0}
 101 };
 102
 103 static int
 104 mode_changed (const char *file, mode_t old_mode)
 105 {
 106   struct stat new_stats;
 107
 108   if (stat (file, &new_stats))
 109     {
 110       if (force_silent == 0)
 111         error (0, errno, _("getting new attributes of %s"), quote (file));
 112       return 0;
 113     }
 114
 115   return old_mode != new_stats.st_mode;
 116 }
 117
 118 /* Tell the user how/if the MODE of FILE has been changed.
 119    CHANGED describes what (if anything) has happened. */
 120
 121 static void
 122 describe_change (const char *file, mode_t mode,
 123                  enum Change_status changed)
 124 {
 125   char perms[11];               /* "-rwxrwxrwx" ls-style modes. */
 126   const char *fmt;
 127
 128   mode_string (mode, perms);
 129   perms[10] = '\0';             /* `mode_string' does not null terminate. */
 130   switch (changed)
 131     {
 132     case CH_SUCCEEDED:
 133       fmt = _("mode of %s changed to %04lo (%s)\n");
 134       break;
 135     case CH_FAILED:
 136       fmt = _("failed to change mode of %s to %04lo (%s)\n");
 137       break;
 138     case CH_NO_CHANGE_REQUESTED:
 139       fmt = _("mode of %s retained as %04lo (%s)\n");
 140       break;
 141     default:
 142       abort ();
 143     }
 144   printf (fmt, quote (file),
 145           (unsigned long) (mode & CHMOD_MODE_BITS), &perms[1]);
 146 }
 147
 148 /* Change the mode of FILE according to the list of operations CHANGES.
 149    Return 0 if successful, 1 if errors occurred.  This function is called
 150    once for every file system object that fts encounters.  */
 151
 152 static int
 153 process_file (FTS *fts, FTSENT *ent, const struct mode_change *changes)
 154 {
 155   const char *file_full_name = ent->fts_path;
 156   const char *file = ent->fts_accpath;
 157   const struct stat *sb = ent->fts_statp;
 158   mode_t newmode;
 159   int errors = 0;
 160   int fail;
 161   int saved_errno;
 162
 163   switch (ent->fts_info)
 164     {
 165     case FTS_NS:
 166       error (0, ent->fts_errno, _("cannot access %s"), quote (file_full_name));
 167       return 1;
 168
 169     case FTS_ERR:
 170       error (0, ent->fts_errno, _("%s"), quote (file_full_name));
 171       return 1;
 172
 173     case FTS_DNR:
 174       error (0, ent->fts_errno, _("cannot read directory %s"),
 175              quote (file_full_name));
 176       return 1;
 177
 178     default:
 179       break;
 180     }
 181
 182   /* If this is the second (post-order) encounter with a directory,
 183      then return right away.  */
 184   if (ent->fts_info == FTS_DP)
 185     return 0;
 186
 187   if (ROOT_DEV_INO_CHECK (root_dev_ino, sb))
 188     {
 189       ROOT_DEV_INO_WARN (file_full_name);
 190       return 1;
 191     }
 192
 193   if (S_ISLNK (sb->st_mode))
 194     return 0;
 195
 196   newmode = mode_adjust (sb->st_mode, changes);
 197
 198   fail = chmod (file, newmode);
 199   saved_errno = errno;
 200
 201   if (verbosity == V_high
 202       || (verbosity == V_changes_only
 203           && !fail && mode_changed (file, sb->st_mode)))
 204     describe_change (file_full_name, newmode,
 205                      (fail ? CH_FAILED : CH_SUCCEEDED));
 206
 207   if (fail)
 208     {
 209       if (force_silent == 0)
 210         error (0, saved_errno, _("changing permissions of %s"),
 211                quote (file_full_name));
 212       errors = 1;
 213     }
 214
 215   if ( ! recurse)
 216     fts_set (fts, ent, FTS_SKIP);
 217
 218   return errors;
 219 }
 220
 221 /* Recursively change the modes of the specified FILES (the last entry
 222    of which is NULL) according to the list of operations CHANGES.
 223    BIT_FLAGS controls how fts works.
 224    If the fts_open call fails, exit nonzero.
 225    Otherwise, return nonzero upon error.  */
 226
 227 static int
 228 process_files (char **files, int bit_flags, const struct mode_change *changes)
 229 {
 230   int fail = 0;
 231
 232   FTS *fts = xfts_open (files, bit_flags, NULL);
 233
 234   while (1)
 235     {
 236       FTSENT *ent;
 237
 238       ent = fts_read (fts);
 239       if (ent == NULL)
 240         {
 241           if (errno != 0)
 242             {
 243               /* FIXME: try to give a better message  */
 244               error (0, errno, _("fts_read failed"));
 245               fail = 1;
 246             }
 247           break;
 248         }
 249
 250       fail |= process_file (fts, ent, changes);
 251     }
 252
 253   /* Ignore failure, since the only way it can do so is in failing to
 254      return to the original directory, and since we're about to exit,
 255      that doesn't matter.  */
 256   fts_close (fts);
 257
 258   return fail;
 259 }
 260
 261 void
 262 usage (int status)
 263 {
 264   if (status != EXIT_SUCCESS)
 265     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 266              program_name);
 267   else
 268     {
 269       printf (_("\
 270 Usage: %s [OPTION]... MODE[,MODE]... FILE...\n\
 271   or:  %s [OPTION]... OCTAL-MODE FILE...\n\
 272   or:  %s [OPTION]... --reference=RFILE FILE...\n\
 273 "),
 274               program_name, program_name, program_name);
 275       fputs (_("\
 276 Change the mode of each FILE to MODE.\n\
 277 \n\
 278   -c, --changes           like verbose but report only when a change is made\n\
 279 "), stdout);
 280       fputs (_("\
 281       --no-preserve-root  do not treat `/' specially (the default)\n\
 282       --preserve-root     fail to operate recursively on `/'\n\
 283 "), stdout);
 284       fputs (_("\
 285   -f, --silent, --quiet   suppress most error messages\n\
 286   -v, --verbose           output a diagnostic for every file processed\n\
 287       --reference=RFILE   use RFILE's mode instead of MODE values\n\
 288   -R, --recursive         change files and directories recursively\n\
 289 "), stdout);
 290       fputs (HELP_OPTION_DESCRIPTION, stdout);
 291       fputs (VERSION_OPTION_DESCRIPTION, stdout);
 292       fputs (_("\
 293 \n\
 294 Each MODE is one or more of the letters ugoa, one of the symbols +-= and\n\
 295 one or more of the letters rwxXstugo.\n\
 296 "), stdout);
 297       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 298     }
 299   exit (status);
 300 }
 301
 302 /* Parse the ASCII mode given on the command line into a linked list
 303    of `struct mode_change' and apply that to each file argument. */
 304
 305 int
 306 main (int argc, char **argv)
 307 {
 308   struct mode_change *changes;
 309   int fail = 0;
 310   int modeind = 0;              /* Index of the mode argument in `argv'. */
 311   int thisind;
 312   bool preserve_root = false;
 313   int c;
 314
 315   initialize_main (&argc, &argv);
 316   program_name = argv[0];
 317   setlocale (LC_ALL, "");
 318   bindtextdomain (PACKAGE, LOCALEDIR);
 319   textdomain (PACKAGE);
 320
 321   atexit (close_stdout);
 322
 323   recurse = force_silent = 0;
 324
 325   while (1)
 326     {
 327       thisind = optind ? optind : 1;
 328
 329       c = getopt_long (argc, argv, "RcfvrwxXstugoa,+-=", long_options, NULL);
 330       if (c == -1)
 331         break;
 332
 333       switch (c)
 334         {
 335         case 0:
 336           break;
 337         case 'r':
 338         case 'w':
 339         case 'x':
 340         case 'X':
 341         case 's':
 342         case 't':
 343         case 'u':
 344         case 'g':
 345         case 'o':
 346         case 'a':
 347         case ',':
 348         case '+':
 349         case '-':
 350         case '=':
 351           if (modeind != 0 && modeind != thisind)
 352             {
 353               static char char_string[2] = {0, 0};
 354               char_string[0] = c;
 355               error (EXIT_FAILURE, 0,
 356                      _("invalid character %s in mode string %s"),
 357                      quote_n (0, char_string), quote_n (1, argv[thisind]));
 358             }
 359           modeind = thisind;
 360           break;
 361         case NO_PRESERVE_ROOT:
 362           preserve_root = false;
 363           break;
 364         case PRESERVE_ROOT:
 365           preserve_root = true;
 366           break;
 367         case REFERENCE_FILE_OPTION:
 368           reference_file = optarg;
 369           break;
 370         case 'R':
 371           recurse = 1;
 372           break;
 373         case 'c':
 374           verbosity = V_changes_only;
 375           break;
 376         case 'f':
 377           force_silent = 1;
 378           break;
 379         case 'v':
 380           verbosity = V_high;
 381           break;
 382         case_GETOPT_HELP_CHAR;
 383         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 384         default:
 385           usage (EXIT_FAILURE);
 386         }
 387     }
 388
 389   if (modeind == 0 && reference_file == NULL)
 390     modeind = optind++;
 391
 392   if (optind >= argc)
 393     {
 394       error (0, 0, _("too few arguments"));
 395       usage (EXIT_FAILURE);
 396     }
 397
 398   changes = (reference_file ? mode_create_from_ref (reference_file)
 399              : mode_compile (argv[modeind], MODE_MASK_ALL));
 400
 401   if (changes == MODE_INVALID)
 402     error (EXIT_FAILURE, 0,
 403            _("invalid mode string: %s"), quote (argv[modeind]));
 404   else if (changes == MODE_MEMORY_EXHAUSTED)
 405     xalloc_die ();
 406   else if (changes == MODE_BAD_REFERENCE)
 407     error (EXIT_FAILURE, errno, _("failed to get attributes of %s"),
 408            quote (reference_file));
 409
 410   if (recurse && preserve_root)
 411     {
 412       static struct dev_ino dev_ino_buf;
 413       root_dev_ino = get_root_dev_ino (&dev_ino_buf);
 414       if (root_dev_ino == NULL)
 415         error (EXIT_FAILURE, errno, _("failed to get attributes of %s"),
 416                quote ("/"));
 417     }
 418   else
 419     {
 420       root_dev_ino = NULL;
 421     }
 422
 423   fail = process_files (argv + optind, FTS_COMFOLLOW, changes);
 424
 425   exit (fail ? EXIT_FAILURE : EXIT_SUCCESS);
 426 }