src/install.c

   1 /* install - copy files and set attributes
   2    Copyright (C) 89, 90, 91, 1995-2003 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 #include <pwd.h>
  25 #include <grp.h>
  26
  27 #include "system.h"
  28 #include "backupfile.h"
  29 #include "error.h"
  30 #include "cp-hash.h"
  31 #include "copy.h"
  32 #include "dirname.h"
  33 #include "makepath.h"
  34 #include "modechange.h"
  35 #include "path-concat.h"
  36 #include "quote.h"
  37 #include "xstrtol.h"
  38
  39 /* The official name of this program (e.g., no `g' prefix).  */
  40 #define PROGRAM_NAME "install"
  41
  42 #define AUTHORS "David MacKenzie"
  43
  44 #if HAVE_SYS_WAIT_H
  45 # include <sys/wait.h>
  46 #endif
  47
  48 struct passwd *getpwnam ();
  49 struct group *getgrnam ();
  50
  51 #ifndef _POSIX_VERSION
  52 uid_t getuid ();
  53 gid_t getgid ();
  54 #endif
  55
  56 #if ! HAVE_ENDGRENT
  57 # define endgrent() ((void) 0)
  58 #endif
  59
  60 #if ! HAVE_ENDPWENT
  61 # define endpwent() ((void) 0)
  62 #endif
  63
  64 /* Initial number of entries in each hash table entry's table of inodes.  */
  65 #define INITIAL_HASH_MODULE 100
  66
  67 /* Initial number of entries in the inode hash table.  */
  68 #define INITIAL_ENTRY_TAB_SIZE 70
  69
  70 /* Number of bytes of a file to copy at a time. */
  71 #define READ_SIZE (32 * 1024)
  72
  73 int isdir ();
  74
  75 int stat ();
  76
  77 static int change_timestamps (const char *from, const char *to);
  78 static int change_attributes (const char *path);
  79 static int copy_file (const char *from, const char *to,
  80                       const struct cp_options *x);
  81 static int install_file_to_path (const char *from, const char *to,
  82                                  const struct cp_options *x);
  83 static int install_file_in_dir (const char *from, const char *to_dir,
  84                                 const struct cp_options *x);
  85 static int install_file_in_file (const char *from, const char *to,
  86                                  const struct cp_options *x);
  87 static void get_ids (void);
  88 static void strip (const char *path);
  89 void usage (int status);
  90
  91 /* The name this program was run with, for error messages. */
  92 char *program_name;
  93
  94 /* The user name that will own the files, or NULL to make the owner
  95    the current user ID. */
  96 static char *owner_name;
  97
  98 /* The user ID corresponding to `owner_name'. */
  99 static uid_t owner_id;
 100
 101 /* The group name that will own the files, or NULL to make the group
 102    the current group ID. */
 103 static char *group_name;
 104
 105 /* The group ID corresponding to `group_name'. */
 106 static gid_t group_id;
 107
 108 /* The permissions to which the files will be set.  The umask has
 109    no effect. */
 110 static mode_t mode = S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
 111
 112 /* If nonzero, strip executable files after copying them. */
 113 static int strip_files;
 114
 115 /* If nonzero, install a directory instead of a regular file. */
 116 static int dir_arg;
 117
 118 static struct option const long_options[] =
 119 {
 120   {"backup", optional_argument, NULL, 'b'},
 121   {"directory", no_argument, NULL, 'd'},
 122   {"group", required_argument, NULL, 'g'},
 123   {"mode", required_argument, NULL, 'm'},
 124   {"owner", required_argument, NULL, 'o'},
 125   {"preserve-timestamps", no_argument, NULL, 'p'},
 126   {"strip", no_argument, NULL, 's'},
 127   {"suffix", required_argument, NULL, 'S'},
 128   {"version-control", required_argument, NULL, 'V'}, /* Deprecated. FIXME. */
 129   {"verbose", no_argument, NULL, 'v'},
 130   {GETOPT_HELP_OPTION_DECL},
 131   {GETOPT_VERSION_OPTION_DECL},
 132   {NULL, 0, NULL, 0}
 133 };
 134
 135 static void
 136 cp_option_init (struct cp_options *x)
 137 {
 138   x->copy_as_regular = 1;
 139   x->dereference = DEREF_ALWAYS;
 140   x->unlink_dest_before_opening = 1;
 141   x->unlink_dest_after_failed_open = 0;
 142   x->hard_link = 0;
 143   x->interactive = I_UNSPECIFIED;
 144   x->move_mode = 0;
 145   x->myeuid = geteuid ();
 146   x->one_file_system = 0;
 147   x->preserve_ownership = 0;
 148   x->preserve_links = 0;
 149   x->preserve_mode = 0;
 150   x->preserve_timestamps = 0;
 151   x->require_preserve = 0;
 152   x->recursive = 0;
 153   x->sparse_mode = SPARSE_AUTO;
 154   x->symbolic_link = 0;
 155   x->backup_type = none;
 156
 157   /* Create destination files initially writable so we can run strip on them.
 158      Although GNU strip works fine on read-only files, some others
 159      would fail.  */
 160   x->set_mode = 1;
 161   x->mode = S_IRUSR | S_IWUSR;
 162   x->stdin_tty = 0;
 163
 164   x->umask_kill = 0;
 165   x->update = 0;
 166   x->verbose = 0;
 167   x->xstat = stat;
 168   x->dest_info = NULL;
 169   x->src_info = NULL;
 170 }
 171
 172 int
 173 main (int argc, char **argv)
 174 {
 175   int optc;
 176   int errors = 0;
 177   const char *specified_mode = NULL;
 178   int make_backups = 0;
 179   char *backup_suffix_string;
 180   char *version_control_string = NULL;
 181   int mkdir_and_install = 0;
 182   struct cp_options x;
 183   int n_files;
 184   char **file;
 185
 186   initialize_main (&argc, &argv);
 187   program_name = argv[0];
 188   setlocale (LC_ALL, "");
 189   bindtextdomain (PACKAGE, LOCALEDIR);
 190   textdomain (PACKAGE);
 191
 192   atexit (close_stdout);
 193
 194   cp_option_init (&x);
 195
 196   owner_name = NULL;
 197   group_name = NULL;
 198   strip_files = 0;
 199   dir_arg = 0;
 200   umask (0);
 201
 202   /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
 203      we'll actually use backup_suffix_string.  */
 204   backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
 205
 206   while ((optc = getopt_long (argc, argv, "bcsDdg:m:o:pvV:S:", long_options,
 207                               NULL)) != -1)
 208     {
 209       switch (optc)
 210         {
 211         case 0:
 212           break;
 213
 214         case 'V':  /* FIXME: this is deprecated.  Remove it in 2001.  */
 215           error (0, 0,
 216                  _("warning: --version-control (-V) is obsolete;  support for\
 217  it\nwill be removed in some future release.  Use --backup=%s instead."
 218                    ), optarg);
 219           /* Fall through.  */
 220
 221         case 'b':
 222           make_backups = 1;
 223           if (optarg)
 224             version_control_string = optarg;
 225           break;
 226         case 'c':
 227           break;
 228         case 's':
 229           strip_files = 1;
 230           break;
 231         case 'd':
 232           dir_arg = 1;
 233           break;
 234         case 'D':
 235           mkdir_and_install = 1;
 236           break;
 237         case 'v':
 238           x.verbose = 1;
 239           break;
 240         case 'g':
 241           group_name = optarg;
 242           break;
 243         case 'm':
 244           specified_mode = optarg;
 245           break;
 246         case 'o':
 247           owner_name = optarg;
 248           break;
 249         case 'p':
 250           x.preserve_timestamps = 1;
 251           break;
 252         case 'S':
 253           make_backups = 1;
 254           backup_suffix_string = optarg;
 255           break;
 256         case_GETOPT_HELP_CHAR;
 257         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 258         default:
 259           usage (EXIT_FAILURE);
 260         }
 261     }
 262
 263   /* Check for invalid combinations of arguments. */
 264   if (dir_arg && strip_files)
 265     error (EXIT_FAILURE, 0,
 266            _("the strip option may not be used when installing a directory"));
 267
 268   if (backup_suffix_string)
 269     simple_backup_suffix = xstrdup (backup_suffix_string);
 270
 271   x.backup_type = (make_backups
 272                    ? xget_version (_("backup type"),
 273                                    version_control_string)
 274                    : none);
 275
 276   n_files = argc - optind;
 277   file = argv + optind;
 278
 279   if (argc <= optind || (n_files == 1 && !dir_arg))
 280     {
 281       error (0, 0, _("too few arguments"));
 282       usage (EXIT_FAILURE);
 283     }
 284
 285   if (specified_mode)
 286     {
 287       struct mode_change *change = mode_compile (specified_mode, 0);
 288       if (change == MODE_INVALID)
 289         error (EXIT_FAILURE, 0, _("invalid mode %s"), quote (specified_mode));
 290       else if (change == MODE_MEMORY_EXHAUSTED)
 291         xalloc_die ();
 292       mode = mode_adjust (0, change);
 293     }
 294
 295   get_ids ();
 296
 297   if (dir_arg)
 298     {
 299       int i;
 300       for (i = 0; i < n_files; i++)
 301         {
 302           errors |=
 303             make_path (file[i], mode, mode, owner_id, group_id, 0,
 304                        (x.verbose ? _("creating directory %s") : NULL));
 305         }
 306     }
 307   else
 308     {
 309       /* FIXME: it's a little gross that this initialization is
 310          required by copy.c::copy. */
 311       hash_init ();
 312
 313       if (n_files == 2)
 314         {
 315           if (mkdir_and_install)
 316             errors = install_file_to_path (file[0], file[1], &x);
 317           else if (!isdir (file[1]))
 318             errors = install_file_in_file (file[0], file[1], &x);
 319           else
 320             errors = install_file_in_dir (file[0], file[1], &x);
 321         }
 322       else
 323         {
 324           int i;
 325           const char *dest = file[n_files - 1];
 326           if (!isdir (dest))
 327             {
 328               error (0, 0,
 329                      _("installing multiple files, but last argument, %s \
 330 is not a directory"),
 331                      quote (dest));
 332               usage (EXIT_FAILURE);
 333             }
 334
 335           dest_info_init (&x);
 336           for (i = 0; i < n_files - 1; i++)
 337             {
 338               errors |= install_file_in_dir (file[i], dest, &x);
 339             }
 340         }
 341     }
 342
 343   exit (errors);
 344 }
 345
 346 /* Copy file FROM onto file TO, creating any missing parent directories of TO.
 347    Return 0 if successful, 1 if an error occurs */
 348
 349 static int
 350 install_file_to_path (const char *from, const char *to,
 351                       const struct cp_options *x)
 352 {
 353   char *dest_dir;
 354   int fail = 0;
 355
 356   dest_dir = dir_name (to);
 357
 358   /* check to make sure this is a path (not install a b ) */
 359   if (!STREQ (dest_dir, ".")
 360       && !isdir (dest_dir))
 361     {
 362       /* Someone will probably ask for a new option or three to specify
 363          owner, group, and permissions for parent directories.  Remember
 364          that this option is intended mainly to help installers when the
 365          distribution doesn't provide proper install rules.  */
 366 #define DIR_MODE (S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
 367       fail = make_path (dest_dir, DIR_MODE, DIR_MODE, owner_id, group_id, 0,
 368                         (x->verbose ? _("creating directory %s") : NULL));
 369     }
 370
 371   if (fail == 0)
 372     fail = install_file_in_file (from, to, x);
 373
 374   free (dest_dir);
 375
 376   return fail;
 377 }
 378
 379 /* Copy file FROM onto file TO and give TO the appropriate
 380    attributes.
 381    Return 0 if successful, 1 if an error occurs. */
 382
 383 static int
 384 install_file_in_file (const char *from, const char *to,
 385                       const struct cp_options *x)
 386 {
 387   if (copy_file (from, to, x))
 388     return 1;
 389   if (strip_files)
 390     strip (to);
 391   if (change_attributes (to))
 392     return 1;
 393   if (x->preserve_timestamps)
 394     return change_timestamps (from, to);
 395   return 0;
 396 }
 397
 398 /* Copy file FROM into directory TO_DIR, keeping its same name,
 399    and give the copy the appropriate attributes.
 400    Return 0 if successful, 1 if not. */
 401
 402 static int
 403 install_file_in_dir (const char *from, const char *to_dir,
 404                      const struct cp_options *x)
 405 {
 406   const char *from_base;
 407   char *to;
 408   int ret;
 409
 410   from_base = base_name (from);
 411   to = path_concat (to_dir, from_base, NULL);
 412   ret = install_file_in_file (from, to, x);
 413   free (to);
 414   return ret;
 415 }
 416
 417 /* Copy file FROM onto file TO, creating TO if necessary.
 418    Return 0 if the copy is successful, 1 if not.  */
 419
 420 static int
 421 copy_file (const char *from, const char *to, const struct cp_options *x)
 422 {
 423   int fail;
 424   int nonexistent_dst = 0;
 425   int copy_into_self;
 426
 427   /* Allow installing from non-regular files like /dev/null.
 428      Charles Karney reported that some Sun version of install allows that
 429      and that sendmail's installation process relies on the behavior.  */
 430   if (isdir (from))
 431     {
 432       error (0, 0, _("%s is a directory"), quote (from));
 433       return 1;
 434     }
 435
 436   fail = copy (from, to, nonexistent_dst, x, &copy_into_self, NULL);
 437
 438   return fail;
 439 }
 440
 441 /* Set the attributes of file or directory PATH.
 442    Return 0 if successful, 1 if not. */
 443
 444 static int
 445 change_attributes (const char *path)
 446 {
 447   int err = 0;
 448
 449   /* chown must precede chmod because on some systems,
 450      chown clears the set[ug]id bits for non-superusers,
 451      resulting in incorrect permissions.
 452      On System V, users can give away files with chown and then not
 453      be able to chmod them.  So don't give files away.
 454
 455      We don't normally ignore errors from chown because the idea of
 456      the install command is that the file is supposed to end up with
 457      precisely the attributes that the user specified (or defaulted).
 458      If the file doesn't end up with the group they asked for, they'll
 459      want to know.  But AFS returns EPERM when you try to change a
 460      file's group; thus the kludge.  */
 461
 462   if (chown (path, owner_id, group_id)
 463 #ifdef AFS
 464       && errno != EPERM
 465 #endif
 466       )
 467     {
 468       error (0, errno, _("cannot change ownership of %s"), quote (path));
 469       err = 1;
 470     }
 471
 472   if (!err && chmod (path, mode))
 473     {
 474       error (0, errno, _("cannot change permissions of %s"), quote (path));
 475       err = 1;
 476     }
 477
 478   return err;
 479 }
 480
 481 /* Set the timestamps of file TO to match those of file FROM.
 482    Return 0 if successful, 1 if not. */
 483
 484 static int
 485 change_timestamps (const char *from, const char *to)
 486 {
 487   struct stat stb;
 488   struct utimbuf utb;
 489
 490   if (stat (from, &stb))
 491     {
 492       error (0, errno, _("cannot obtain time stamps for %s"), quote (from));
 493       return 1;
 494     }
 495
 496   /* There's currently no interface to set file timestamps with
 497      better than 1-second resolution, so discard any fractional
 498      part of the source timestamp.  */
 499
 500   utb.actime = stb.st_atime;
 501   utb.modtime = stb.st_mtime;
 502   if (utime (to, &utb))
 503     {
 504       error (0, errno, _("cannot set time stamps for %s"), quote (to));
 505       return 1;
 506     }
 507   return 0;
 508 }
 509
 510 /* Strip the symbol table from the file PATH.
 511    We could dig the magic number out of the file first to
 512    determine whether to strip it, but the header files and
 513    magic numbers vary so much from system to system that making
 514    it portable would be very difficult.  Not worth the effort. */
 515
 516 static void
 517 strip (const char *path)
 518 {
 519   int status;
 520   pid_t pid = fork ();
 521
 522   switch (pid)
 523     {
 524     case -1:
 525       error (EXIT_FAILURE, errno, _("fork system call failed"));
 526       break;
 527     case 0:                     /* Child. */
 528       execlp ("strip", "strip", path, NULL);
 529       error (EXIT_FAILURE, errno, _("cannot run strip"));
 530       break;
 531     default:                    /* Parent. */
 532       /* Parent process. */
 533       while (pid != wait (&status))     /* Wait for kid to finish. */
 534         /* Do nothing. */ ;
 535       if (status)
 536         error (EXIT_FAILURE, 0, _("strip failed"));
 537       break;
 538     }
 539 }
 540
 541 /* Initialize the user and group ownership of the files to install. */
 542
 543 static void
 544 get_ids (void)
 545 {
 546   struct passwd *pw;
 547   struct group *gr;
 548
 549   if (owner_name)
 550     {
 551       pw = getpwnam (owner_name);
 552       if (pw == NULL)
 553         {
 554           unsigned long int tmp;
 555           if (xstrtoul (owner_name, NULL, 0, &tmp, NULL) != LONGINT_OK
 556               || UID_T_MAX < tmp)
 557             error (EXIT_FAILURE, 0, _("invalid user %s"), quote (owner_name));
 558           owner_id = tmp;
 559         }
 560       else
 561         owner_id = pw->pw_uid;
 562       endpwent ();
 563     }
 564   else
 565     owner_id = (uid_t) -1;
 566
 567   if (group_name)
 568     {
 569       gr = getgrnam (group_name);
 570       if (gr == NULL)
 571         {
 572           unsigned long int tmp;
 573           if (xstrtoul (group_name, NULL, 0, &tmp, NULL) != LONGINT_OK
 574               || GID_T_MAX < tmp)
 575             error (EXIT_FAILURE, 0, _("invalid group %s"), quote (group_name));
 576           group_id = tmp;
 577         }
 578       else
 579         group_id = gr->gr_gid;
 580       endgrent ();
 581     }
 582   else
 583     group_id = (gid_t) -1;
 584 }
 585
 586 void
 587 usage (int status)
 588 {
 589   if (status != 0)
 590     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 591              program_name);
 592   else
 593     {
 594       printf (_("\
 595 Usage: %s [OPTION]... SOURCE DEST           (1st format)\n\
 596   or:  %s [OPTION]... SOURCE... DIRECTORY   (2nd format)\n\
 597   or:  %s -d [OPTION]... DIRECTORY...       (3rd format)\n\
 598 "),
 599               program_name, program_name, program_name);
 600       fputs (_("\
 601 In the first two formats, copy SOURCE to DEST or multiple SOURCE(s) to\n\
 602 the existing DIRECTORY, while setting permission modes and owner/group.\n\
 603 In the third format, create all components of the given DIRECTORY(ies).\n\
 604 \n\
 605 "), stdout);
 606       fputs (_("\
 607 Mandatory arguments to long options are mandatory for short options too.\n\
 608 "), stdout);
 609       fputs (_("\
 610       --backup[=CONTROL] make a backup of each existing destination file\n\
 611   -b                  like --backup but does not accept an argument\n\
 612   -c                  (ignored)\n\
 613   -d, --directory     treat all arguments as directory names; create all\n\
 614                         components of the specified directories\n\
 615 "), stdout);
 616       fputs (_("\
 617   -D                  create all leading components of DEST except the last,\n\
 618                         then copy SOURCE to DEST;  useful in the 1st format\n\
 619   -g, --group=GROUP   set group ownership, instead of process' current group\n\
 620   -m, --mode=MODE     set permission mode (as in chmod), instead of rwxr-xr-x\n\
 621   -o, --owner=OWNER   set ownership (super-user only)\n\
 622 "), stdout);
 623       fputs (_("\
 624   -p, --preserve-timestamps   apply access/modification times of SOURCE files\n\
 625                         to corresponding destination files\n\
 626   -s, --strip         strip symbol tables, only for 1st and 2nd formats\n\
 627   -S, --suffix=SUFFIX override the usual backup suffix\n\
 628   -v, --verbose       print the name of each directory as it is created\n\
 629 "), stdout);
 630       fputs (HELP_OPTION_DESCRIPTION, stdout);
 631       fputs (VERSION_OPTION_DESCRIPTION, stdout);
 632       fputs (_("\
 633 \n\
 634 The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
 635 The version control method may be selected via the --backup option or through\n\
 636 the VERSION_CONTROL environment variable.  Here are the values:\n\
 637 \n\
 638 "), stdout);
 639       fputs (_("\
 640   none, off       never make backups (even if --backup is given)\n\
 641   numbered, t     make numbered backups\n\
 642   existing, nil   numbered if numbered backups exist, simple otherwise\n\
 643   simple, never   always make simple backups\n\
 644 "), stdout);
 645       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 646     }
 647   exit (status);
 648 }