src/cp.c

   1 /* cp.c  -- file copying (main routines)
   2    Copyright (C) 89, 90, 91, 1995-2004 Free Software Foundation.
   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 Torbjorn Granlund, David MacKenzie, and Jim Meyering. */
  19
  20 #include <config.h>
  21 #include <stdio.h>
  22 #include <sys/types.h>
  23 #include <assert.h>
  24 #include <getopt.h>
  25
  26 #include "system.h"
  27 #include "argmatch.h"
  28 #include "backupfile.h"
  29 #include "copy.h"
  30 #include "cp-hash.h"
  31 #include "error.h"
  32 #include "dirname.h"
  33 #include "path-concat.h"
  34 #include "quote.h"
  35 #include "quotearg.h"
  36 #include "utimens.h"
  37
  38 #define ASSIGN_BASENAME_STRDUPA(Dest, File_name)        \
  39   do                                                    \
  40     {                                                   \
  41       char *tmp_abns_;                                  \
  42       ASSIGN_STRDUPA (tmp_abns_, (File_name));          \
  43       strip_trailing_slashes (tmp_abns_);               \
  44       Dest = base_name (tmp_abns_);                     \
  45     }                                                   \
  46   while (0)
  47
  48 /* The official name of this program (e.g., no `g' prefix).  */
  49 #define PROGRAM_NAME "cp"
  50
  51 #define AUTHORS "Torbjorn Granlund", "David MacKenzie", "Jim Meyering"
  52
  53 #ifndef _POSIX_VERSION
  54 uid_t geteuid ();
  55 #endif
  56
  57 /* Used by do_copy, make_path_private, and re_protect
  58    to keep a list of leading directories whose protections
  59    need to be fixed after copying. */
  60 struct dir_attr
  61 {
  62   int is_new_dir;
  63   int slash_offset;
  64   struct dir_attr *next;
  65 };
  66
  67 /* For long options that have no equivalent short option, use a
  68    non-character as a pseudo short option, starting with CHAR_MAX + 1.  */
  69 enum
  70 {
  71   COPY_CONTENTS_OPTION = CHAR_MAX + 1,
  72   NO_PRESERVE_ATTRIBUTES_OPTION,
  73   PARENTS_OPTION,
  74   PRESERVE_ATTRIBUTES_OPTION,
  75   REPLY_OPTION,
  76   SPARSE_OPTION,
  77   STRIP_TRAILING_SLASHES_OPTION,
  78   TARGET_DIRECTORY_OPTION,
  79   UNLINK_DEST_BEFORE_OPENING
  80 };
  81
  82 /* Initial number of entries in each hash table entry's table of inodes.  */
  83 #define INITIAL_HASH_MODULE 100
  84
  85 /* Initial number of entries in the inode hash table.  */
  86 #define INITIAL_ENTRY_TAB_SIZE 70
  87
  88 /* The invocation name of this program.  */
  89 char *program_name;
  90
  91 /* If nonzero, the command "cp x/e_file e_dir" uses "e_dir/x/e_file"
  92    as its destination instead of the usual "e_dir/e_file." */
  93 static int flag_path = 0;
  94
  95 /* Remove any trailing slashes from each SOURCE argument.  */
  96 static int remove_trailing_slashes;
  97
  98 static char const *const sparse_type_string[] =
  99 {
 100   "never", "auto", "always", 0
 101 };
 102
 103 static enum Sparse_type const sparse_type[] =
 104 {
 105   SPARSE_NEVER, SPARSE_AUTO, SPARSE_ALWAYS
 106 };
 107
 108 /* Valid arguments to the `--reply' option. */
 109 static char const* const reply_args[] =
 110 {
 111   "yes", "no", "query", 0
 112 };
 113
 114 /* The values that correspond to the above strings. */
 115 static int const reply_vals[] =
 116 {
 117   I_ALWAYS_YES, I_ALWAYS_NO, I_ASK_USER
 118 };
 119
 120 static struct option const long_opts[] =
 121 {
 122   {"archive", no_argument, NULL, 'a'},
 123   {"backup", optional_argument, NULL, 'b'},
 124   {"copy-contents", no_argument, NULL, COPY_CONTENTS_OPTION},
 125   {"dereference", no_argument, NULL, 'L'},
 126   {"force", no_argument, NULL, 'f'},
 127   {"interactive", no_argument, NULL, 'i'},
 128   {"link", no_argument, NULL, 'l'},
 129   {"no-dereference", no_argument, NULL, 'P'},
 130   {"no-preserve", required_argument, NULL, NO_PRESERVE_ATTRIBUTES_OPTION},
 131   {"one-file-system", no_argument, NULL, 'x'},
 132   {"parents", no_argument, NULL, PARENTS_OPTION},
 133   {"path", no_argument, NULL, PARENTS_OPTION},   /* Deprecated.  */
 134   {"preserve", optional_argument, NULL, PRESERVE_ATTRIBUTES_OPTION},
 135   {"recursive", no_argument, NULL, 'R'},
 136   {"remove-destination", no_argument, NULL, UNLINK_DEST_BEFORE_OPENING},
 137   {"reply", required_argument, NULL, REPLY_OPTION},
 138   {"sparse", required_argument, NULL, SPARSE_OPTION},
 139   {"strip-trailing-slashes", no_argument, NULL, STRIP_TRAILING_SLASHES_OPTION},
 140   {"suffix", required_argument, NULL, 'S'},
 141   {"symbolic-link", no_argument, NULL, 's'},
 142   {"target-directory", required_argument, NULL, TARGET_DIRECTORY_OPTION},
 143   {"update", no_argument, NULL, 'u'},
 144   {"verbose", no_argument, NULL, 'v'},
 145   {"version-control", required_argument, NULL, 'V'}, /* Deprecated. FIXME. */
 146   {GETOPT_HELP_OPTION_DECL},
 147   {GETOPT_VERSION_OPTION_DECL},
 148   {NULL, 0, NULL, 0}
 149 };
 150
 151 void
 152 usage (int status)
 153 {
 154   if (status != EXIT_SUCCESS)
 155     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 156              program_name);
 157   else
 158     {
 159       printf (_("\
 160 Usage: %s [OPTION]... SOURCE DEST\n\
 161   or:  %s [OPTION]... SOURCE... DIRECTORY\n\
 162   or:  %s [OPTION]... --target-directory=DIRECTORY SOURCE...\n\
 163 "),
 164               program_name, program_name, program_name);
 165       fputs (_("\
 166 Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n\
 167 \n\
 168 "), stdout);
 169       fputs (_("\
 170 Mandatory arguments to long options are mandatory for short options too.\n\
 171 "), stdout);
 172       fputs (_("\
 173   -a, --archive                same as -dpR\n\
 174       --backup[=CONTROL]       make a backup of each existing destination file\n\
 175   -b                           like --backup but does not accept an argument\n\
 176       --copy-contents          copy contents of special files when recursive\n\
 177   -d                           same as --no-dereference --preserve=link\n\
 178 "), stdout);
 179       fputs (_("\
 180       --no-dereference         never follow symbolic links\n\
 181   -f, --force                  if an existing destination file cannot be\n\
 182                                  opened, remove it and try again\n\
 183   -i, --interactive            prompt before overwrite\n\
 184   -H                           follow command-line symbolic links\n\
 185 "), stdout);
 186       fputs (_("\
 187   -l, --link                   link files instead of copying\n\
 188   -L, --dereference            always follow symbolic links\n\
 189   -p                           same as --preserve=mode,ownership,timestamps\n\
 190       --preserve[=ATTR_LIST]   preserve the specified attributes (default:\n\
 191                                  mode,ownership,timestamps), if possible\n\
 192                                  additional attributes: links, all\n\
 193 "), stdout);
 194       fputs (_("\
 195       --no-preserve=ATTR_LIST  don't preserve the specified attributes\n\
 196       --parents                append source path to DIRECTORY\n\
 197   -P                           same as `--no-dereference'\n\
 198 "), stdout);
 199       fputs (_("\
 200   -R, -r, --recursive          copy directories recursively\n\
 201       --remove-destination     remove each existing destination file before\n\
 202                                  attempting to open it (contrast with --force)\n\
 203 "), stdout);
 204       fputs (_("\
 205       --reply={yes,no,query}   specify how to handle the prompt about an\n\
 206                                  existing destination file\n\
 207       --sparse=WHEN            control creation of sparse files\n\
 208       --strip-trailing-slashes remove any trailing slashes from each SOURCE\n\
 209                                  argument\n\
 210 "), stdout);
 211       fputs (_("\
 212   -s, --symbolic-link          make symbolic links instead of copying\n\
 213   -S, --suffix=SUFFIX          override the usual backup suffix\n\
 214       --target-directory=DIRECTORY  copy all SOURCE arguments into DIRECTORY\n\
 215 "), stdout);
 216       fputs (_("\
 217   -u, --update                 copy only when the SOURCE file is newer\n\
 218                                  than the destination file or when the\n\
 219                                  destination file is missing\n\
 220   -v, --verbose                explain what is being done\n\
 221   -x, --one-file-system        stay on this file system\n\
 222 "), stdout);
 223       fputs (HELP_OPTION_DESCRIPTION, stdout);
 224       fputs (VERSION_OPTION_DESCRIPTION, stdout);
 225       fputs (_("\
 226 \n\
 227 By default, sparse SOURCE files are detected by a crude heuristic and the\n\
 228 corresponding DEST file is made sparse as well.  That is the behavior\n\
 229 selected by --sparse=auto.  Specify --sparse=always to create a sparse DEST\n\
 230 file whenever the SOURCE file contains a long enough sequence of zero bytes.\n\
 231 Use --sparse=never to inhibit creation of sparse files.\n\
 232 \n\
 233 "), stdout);
 234       fputs (_("\
 235 The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
 236 The version control method may be selected via the --backup option or through\n\
 237 the VERSION_CONTROL environment variable.  Here are the values:\n\
 238 \n\
 239 "), stdout);
 240       fputs (_("\
 241   none, off       never make backups (even if --backup is given)\n\
 242   numbered, t     make numbered backups\n\
 243   existing, nil   numbered if numbered backups exist, simple otherwise\n\
 244   simple, never   always make simple backups\n\
 245 "), stdout);
 246       fputs (_("\
 247 \n\
 248 As a special case, cp makes a backup of SOURCE when the force and backup\n\
 249 options are given and SOURCE and DEST are the same name for an existing,\n\
 250 regular file.\n\
 251 "), stdout);
 252       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 253     }
 254   exit (status);
 255 }
 256
 257 /* Ensure that the parent directories of CONST_DST_PATH have the
 258    correct protections, for the --parents option.  This is done
 259    after all copying has been completed, to allow permissions
 260    that don't include user write/execute.
 261
 262    SRC_OFFSET is the index in CONST_DST_PATH of the beginning of the
 263    source directory name.
 264
 265    ATTR_LIST is a null-terminated linked list of structures that
 266    indicates the end of the filename of each intermediate directory
 267    in CONST_DST_PATH that may need to have its attributes changed.
 268    The command `cp --parents --preserve a/b/c d/e_dir' changes the
 269    attributes of the directories d/e_dir/a and d/e_dir/a/b to match
 270    the corresponding source directories regardless of whether they
 271    existed before the `cp' command was given.
 272
 273    Return 0 if the parent of CONST_DST_PATH and any intermediate
 274    directories specified by ATTR_LIST have the proper permissions
 275    when done, otherwise 1. */
 276
 277 static int
 278 re_protect (const char *const_dst_path, int src_offset,
 279             struct dir_attr *attr_list, const struct cp_options *x)
 280 {
 281   struct dir_attr *p;
 282   char *dst_path;               /* A copy of CONST_DST_PATH we can change. */
 283   char *src_path;               /* The source name in `dst_path'. */
 284   uid_t myeuid = geteuid ();
 285
 286   ASSIGN_STRDUPA (dst_path, const_dst_path);
 287   src_path = dst_path + src_offset;
 288
 289   for (p = attr_list; p; p = p->next)
 290     {
 291       struct stat src_sb;
 292
 293       dst_path[p->slash_offset] = '\0';
 294
 295       if (XSTAT (x, src_path, &src_sb))
 296         {
 297           error (0, errno, _("failed to get attributes of %s"),
 298                  quote (src_path));
 299           return 1;
 300         }
 301
 302       /* Adjust the times (and if possible, ownership) for the copy.
 303          chown turns off set[ug]id bits for non-root,
 304          so do the chmod last.  */
 305
 306       if (x->preserve_timestamps)
 307         {
 308           struct timespec timespec[2];
 309
 310           timespec[0].tv_sec = src_sb.st_atime;
 311           timespec[0].tv_nsec = TIMESPEC_NS (src_sb.st_atim);
 312           timespec[1].tv_sec = src_sb.st_mtime;
 313           timespec[1].tv_nsec = TIMESPEC_NS (src_sb.st_mtim);
 314
 315           if (utimens (dst_path, timespec))
 316             {
 317               error (0, errno, _("failed to preserve times for %s"),
 318                      quote (dst_path));
 319               return 1;
 320             }
 321         }
 322
 323       if (x->preserve_ownership)
 324         {
 325           /* If non-root uses -p, it's ok if we can't preserve ownership.
 326              But root probably wants to know, e.g. if NFS disallows it,
 327              or if the target system doesn't support file ownership.  */
 328           if (chown (dst_path, src_sb.st_uid, src_sb.st_gid)
 329               && ((errno != EPERM && errno != EINVAL) || myeuid == 0))
 330             {
 331               error (0, errno, _("failed to preserve ownership for %s"),
 332                      quote (dst_path));
 333               return 1;
 334             }
 335         }
 336
 337       if (x->preserve_mode || p->is_new_dir)
 338         {
 339           if (chmod (dst_path, src_sb.st_mode & x->umask_kill))
 340             {
 341               error (0, errno, _("failed to preserve permissions for %s"),
 342                      quote (dst_path));
 343               return 1;
 344             }
 345         }
 346
 347       dst_path[p->slash_offset] = '/';
 348     }
 349   return 0;
 350 }
 351
 352 /* Ensure that the parent directory of CONST_DIRPATH exists, for
 353    the --parents option.
 354
 355    SRC_OFFSET is the index in CONST_DIRPATH (which is a destination
 356    path) of the beginning of the source directory name.
 357    Create any leading directories that don't already exist,
 358    giving them permissions MODE.
 359    If VERBOSE_FMT_STRING is nonzero, use it as a printf format
 360    string for printing a message after successfully making a directory.
 361    The format should take two string arguments: the names of the
 362    source and destination directories.
 363    Creates a linked list of attributes of intermediate directories,
 364    *ATTR_LIST, for re_protect to use after calling copy.
 365    Sets *NEW_DST to 1 if this function creates parent of CONST_DIRPATH.
 366
 367    Return 0 if parent of CONST_DIRPATH exists as a directory with the proper
 368    permissions when done, otherwise 1. */
 369
 370 /* FIXME: find a way to synch this function with the one in lib/makepath.c. */
 371
 372 static int
 373 make_path_private (const char *const_dirpath, int src_offset, int mode,
 374                    const char *verbose_fmt_string, struct dir_attr **attr_list,
 375                    int *new_dst, int (*xstat)())
 376 {
 377   struct stat stats;
 378   char *dirpath;                /* A copy of CONST_DIRPATH we can change. */
 379   char *src;                    /* Source name in `dirpath'. */
 380   char *dst_dirname;            /* Leading path of `dirpath'. */
 381   size_t dirlen;                /* Length of leading path of `dirpath'. */
 382
 383   ASSIGN_STRDUPA (dirpath, const_dirpath);
 384
 385   src = dirpath + src_offset;
 386
 387   dirlen = dir_len (dirpath);
 388   dst_dirname = alloca (dirlen + 1);
 389   memcpy (dst_dirname, dirpath, dirlen);
 390   dst_dirname[dirlen] = '\0';
 391
 392   *attr_list = NULL;
 393
 394   if ((*xstat) (dst_dirname, &stats))
 395     {
 396       /* Parent of CONST_DIRNAME does not exist.
 397          Make all missing intermediate directories. */
 398       char *slash;
 399
 400       slash = src;
 401       while (*slash == '/')
 402         slash++;
 403       while ((slash = strchr (slash, '/')))
 404         {
 405           /* Add this directory to the list of directories whose modes need
 406              fixing later. */
 407           struct dir_attr *new = xmalloc (sizeof *new);
 408           new->slash_offset = slash - dirpath;
 409           new->next = *attr_list;
 410           *attr_list = new;
 411
 412           *slash = '\0';
 413           if ((*xstat) (dirpath, &stats))
 414             {
 415               /* This element of the path does not exist.  We must set
 416                  *new_dst and new->is_new_dir inside this loop because,
 417                  for example, in the command `cp --parents ../a/../b/c e_dir',
 418                  make_path_private creates only e_dir/../a if ./b already
 419                  exists. */
 420               *new_dst = 1;
 421               new->is_new_dir = 1;
 422               if (mkdir (dirpath, mode))
 423                 {
 424                   error (0, errno, _("cannot make directory %s"),
 425                          quote (dirpath));
 426                   return 1;
 427                 }
 428               else
 429                 {
 430                   if (verbose_fmt_string != NULL)
 431                     printf (verbose_fmt_string, src, dirpath);
 432                 }
 433             }
 434           else if (!S_ISDIR (stats.st_mode))
 435             {
 436               error (0, 0, _("%s exists but is not a directory"),
 437                      quote (dirpath));
 438               return 1;
 439             }
 440           else
 441             {
 442               new->is_new_dir = 0;
 443               *new_dst = 0;
 444             }
 445           *slash++ = '/';
 446
 447           /* Avoid unnecessary calls to `stat' when given
 448              pathnames containing multiple adjacent slashes.  */
 449           while (*slash == '/')
 450             slash++;
 451         }
 452     }
 453
 454   /* We get here if the parent of `dirpath' already exists. */
 455
 456   else if (!S_ISDIR (stats.st_mode))
 457     {
 458       error (0, 0, _("%s exists but is not a directory"), quote (dst_dirname));
 459       return 1;
 460     }
 461   else
 462     {
 463       *new_dst = 0;
 464     }
 465   return 0;
 466 }
 467
 468 /* FILE is the last operand of this command.  Return -1 if FILE is a
 469    directory, 0 if not, ENOENT if FILE does not exist.
 470    But report an error there is a problem accessing FILE,
 471    or if FILE does not exist but would have to refer to an existing
 472    directory if it referred to anything at all.
 473
 474    Store the file's status into *ST, and store the resulting
 475    error number into *ERRP.  */
 476
 477 static int
 478 target_directory_operand (char const *file, struct stat *st, int *errp)
 479 {
 480   char const *b = base_name (file);
 481   size_t blen = strlen (b);
 482   bool looks_like_a_dir = (blen == 0 || ISSLASH (b[blen - 1]));
 483   int err = (stat (file, st) == 0 ? 0 : errno);
 484   bool is_a_dir = !err && S_ISDIR (st->st_mode);
 485   if (err && err != ENOENT)
 486     error (EXIT_FAILURE, err, _("accessing %s"), quote (file));
 487   if (is_a_dir < looks_like_a_dir)
 488     error (EXIT_FAILURE, err, _("target %s is not a directory"), quote (file));
 489   *errp = err;
 490   return is_a_dir;
 491 }
 492
 493 /* Scan the arguments, and copy each by calling copy.
 494    Return 0 if successful, 1 if any errors occur. */
 495
 496 static int
 497 do_copy (int n_files, char **file, const char *target_directory,
 498          struct cp_options *x)
 499 {
 500   struct stat sb;
 501   int new_dst = 0;
 502   int ret = 0;
 503
 504   if (n_files <= !target_directory)
 505     {
 506       if (n_files <= 0)
 507         error (0, 0, _("missing file operand"));
 508       else
 509         error (0, 0, _("missing destination file operand after %s"),
 510                quote (file[0]));
 511       usage (EXIT_FAILURE);
 512     }
 513
 514   if (!target_directory)
 515     {
 516       if (2 <= n_files
 517           && target_directory_operand (file[n_files - 1], &sb, &new_dst))
 518         target_directory = file[--n_files];
 519       else if (2 < n_files)
 520         error (EXIT_FAILURE, 0, _("target %s is not a directory"),
 521                quote (file[n_files - 1]));
 522     }
 523
 524   if (target_directory)
 525     {
 526       /* cp file1...filen edir
 527          Copy the files `file1' through `filen'
 528          to the existing directory `edir'. */
 529       int i;
 530       int (*xstat)() = (x->dereference == DEREF_COMMAND_LINE_ARGUMENTS
 531                         || x->dereference == DEREF_ALWAYS
 532                         ? stat
 533                         : lstat);
 534
 535       /* Initialize these hash tables only if we'll need them.
 536          The problems they're used to detect can arise only if
 537          there are two or more files to copy.  */
 538       if (2 <= n_files)
 539         {
 540           dest_info_init (x);
 541           src_info_init (x);
 542         }
 543
 544       for (i = 0; i < n_files; i++)
 545         {
 546           char *dst_path;
 547           int parent_exists = 1; /* True if dir_name (dst_path) exists. */
 548           struct dir_attr *attr_list;
 549           char *arg_in_concat = NULL;
 550           char *arg = file[i];
 551
 552           /* Trailing slashes are meaningful (i.e., maybe worth preserving)
 553              only in the source file names.  */
 554           if (remove_trailing_slashes)
 555             strip_trailing_slashes (arg);
 556
 557           if (flag_path)
 558             {
 559               char *arg_no_trailing_slash;
 560
 561               /* Use `arg' without trailing slashes in constructing destination
 562                  file names.  Otherwise, we can end up trying to create a
 563                  directory via `mkdir ("dst/foo/"...', which is not portable.
 564                  It fails, due to the trailing slash, on at least
 565                  NetBSD 1.[34] systems.  */
 566               ASSIGN_STRDUPA (arg_no_trailing_slash, arg);
 567               strip_trailing_slashes (arg_no_trailing_slash);
 568
 569               /* Append all of `arg' (minus any trailing slash) to `dest'.  */
 570               dst_path = path_concat (target_directory, arg_no_trailing_slash,
 571                                       &arg_in_concat);
 572               if (dst_path == NULL)
 573                 xalloc_die ();
 574
 575               /* For --parents, we have to make sure that the directory
 576                  dir_name (dst_path) exists.  We may have to create a few
 577                  leading directories. */
 578               parent_exists = !make_path_private (dst_path,
 579                                                   arg_in_concat - dst_path,
 580                                                   S_IRWXU,
 581                                                   (x->verbose
 582                                                    ? "%s -> %s\n" : NULL),
 583                                                   &attr_list, &new_dst,
 584                                                   xstat);
 585             }
 586           else
 587             {
 588               char *arg_base;
 589               /* Append the last component of `arg' to `target_directory'.  */
 590
 591               ASSIGN_BASENAME_STRDUPA (arg_base, arg);
 592               /* For `cp -R source/.. dest', don't copy into `dest/..'. */
 593               dst_path = (STREQ (arg_base, "..")
 594                           ? xstrdup (target_directory)
 595                           : path_concat (target_directory, arg_base, NULL));
 596             }
 597
 598           if (!parent_exists)
 599             {
 600               /* make_path_private failed, so don't even attempt the copy. */
 601               ret = 1;
 602             }
 603           else
 604             {
 605               int copy_into_self;
 606               ret |= copy (arg, dst_path, new_dst, x, &copy_into_self, NULL);
 607
 608               if (flag_path)
 609                 {
 610                   ret |= re_protect (dst_path, arg_in_concat - dst_path,
 611                                      attr_list, x);
 612                 }
 613             }
 614
 615           free (dst_path);
 616         }
 617       return ret;
 618     }
 619   else /* !target_directory */
 620     {
 621       char const *new_dest;
 622       char const *source = file[0];
 623       char const *dest = file[1];
 624       int unused;
 625
 626       if (flag_path)
 627         {
 628           error (0, 0,
 629                _("when preserving paths, the destination must be a directory"));
 630           usage (EXIT_FAILURE);
 631         }
 632
 633       /* When the force and backup options have been specified and
 634          the source and destination are the same name for an existing
 635          regular file, convert the user's command, e.g.,
 636          `cp --force --backup foo foo' to `cp --force foo fooSUFFIX'
 637          where SUFFIX is determined by any version control options used.  */
 638
 639       if (x->unlink_dest_after_failed_open
 640           && x->backup_type != none
 641           && STREQ (source, dest)
 642           && !new_dst && S_ISREG (sb.st_mode))
 643         {
 644           static struct cp_options x_tmp;
 645
 646           new_dest = find_backup_file_name (dest, x->backup_type);
 647           /* Set x->backup_type to `none' so that the normal backup
 648              mechanism is not used when performing the actual copy.
 649              backup_type must be set to `none' only *after* the above
 650              call to find_backup_file_name -- that function uses
 651              backup_type to determine the suffix it applies.  */
 652           x_tmp = *x;
 653           x_tmp.backup_type = none;
 654           x = &x_tmp;
 655
 656           if (new_dest == NULL)
 657             xalloc_die ();
 658         }
 659       else
 660         {
 661           new_dest = dest;
 662         }
 663
 664       return copy (source, new_dest, 0, x, &unused, NULL);
 665     }
 666
 667   /* unreachable */
 668 }
 669
 670 static void
 671 cp_option_init (struct cp_options *x)
 672 {
 673   x->copy_as_regular = 1;
 674   x->dereference = DEREF_UNDEFINED;
 675   x->unlink_dest_before_opening = 0;
 676   x->unlink_dest_after_failed_open = 0;
 677   x->hard_link = 0;
 678   x->interactive = I_UNSPECIFIED;
 679   x->myeuid = geteuid ();
 680   x->move_mode = 0;
 681   x->one_file_system = 0;
 682
 683   x->preserve_ownership = 0;
 684   x->preserve_links = 0;
 685   x->preserve_mode = 0;
 686   x->preserve_timestamps = 0;
 687
 688   x->require_preserve = 0;
 689   x->recursive = 0;
 690   x->sparse_mode = SPARSE_AUTO;
 691   x->symbolic_link = 0;
 692   x->set_mode = 0;
 693   x->mode = 0;
 694
 695   /* Not used.  */
 696   x->stdin_tty = 0;
 697
 698   /* Find out the current file creation mask, to knock the right bits
 699      when using chmod.  The creation mask is set to be liberal, so
 700      that created directories can be written, even if it would not
 701      have been allowed with the mask this process was started with.  */
 702   x->umask_kill = ~ umask (0);
 703
 704   x->update = 0;
 705   x->verbose = 0;
 706   x->dest_info = NULL;
 707   x->src_info = NULL;
 708 }
 709
 710 /* Given a string, ARG, containing a comma-separated list of arguments
 711    to the --preserve option, set the appropriate fields of X to ON_OFF.  */
 712 static void
 713 decode_preserve_arg (char const *arg, struct cp_options *x, int on_off)
 714 {
 715   enum File_attribute
 716     {
 717       PRESERVE_MODE,
 718       PRESERVE_TIMESTAMPS,
 719       PRESERVE_OWNERSHIP,
 720       PRESERVE_LINK,
 721       PRESERVE_ALL
 722     };
 723   static enum File_attribute const preserve_vals[] =
 724     {
 725       PRESERVE_MODE, PRESERVE_TIMESTAMPS,
 726       PRESERVE_OWNERSHIP, PRESERVE_LINK, PRESERVE_ALL
 727     };
 728
 729   /* Valid arguments to the `--preserve' option. */
 730   static char const* const preserve_args[] =
 731     {
 732       "mode", "timestamps",
 733       "ownership", "links", "all", 0
 734     };
 735
 736   char *arg_writable = xstrdup (arg);
 737   char *s = arg_writable;
 738   do
 739     {
 740       /* find next comma */
 741       char *comma = strchr (s, ',');
 742       enum File_attribute val;
 743
 744       /* If we found a comma, put a NUL in its place and advance.  */
 745       if (comma)
 746         *comma++ = 0;
 747
 748       /* process S.  */
 749       val = XARGMATCH ("--preserve", s, preserve_args, preserve_vals);
 750       switch (val)
 751         {
 752         case PRESERVE_MODE:
 753           x->preserve_mode = on_off;
 754           break;
 755
 756         case PRESERVE_TIMESTAMPS:
 757           x->preserve_timestamps = on_off;
 758           break;
 759
 760         case PRESERVE_OWNERSHIP:
 761           x->preserve_ownership = on_off;
 762           break;
 763
 764         case PRESERVE_LINK:
 765           x->preserve_links = on_off;
 766           break;
 767
 768         case PRESERVE_ALL:
 769           x->preserve_mode = on_off;
 770           x->preserve_timestamps = on_off;
 771           x->preserve_ownership = on_off;
 772           x->preserve_links = on_off;
 773           break;
 774
 775         default:
 776           abort ();
 777         }
 778       s = comma;
 779     }
 780   while (s);
 781
 782   free (arg_writable);
 783 }
 784
 785 int
 786 main (int argc, char **argv)
 787 {
 788   int c;
 789   int exit_status;
 790   int make_backups = 0;
 791   char *backup_suffix_string;
 792   char *version_control_string = NULL;
 793   struct cp_options x;
 794   int copy_contents = 0;
 795   char *target_directory = NULL;
 796
 797   initialize_main (&argc, &argv);
 798   program_name = argv[0];
 799   setlocale (LC_ALL, "");
 800   bindtextdomain (PACKAGE, LOCALEDIR);
 801   textdomain (PACKAGE);
 802
 803   atexit (close_stdout);
 804
 805   cp_option_init (&x);
 806
 807   /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
 808      we'll actually use backup_suffix_string.  */
 809   backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
 810
 811   while ((c = getopt_long (argc, argv, "abdfHilLprsuvxPRS:V:", long_opts, NULL))
 812          != -1)
 813     {
 814       switch (c)
 815         {
 816         case 0:
 817           break;
 818
 819         case SPARSE_OPTION:
 820           x.sparse_mode = XARGMATCH ("--sparse", optarg,
 821                                      sparse_type_string, sparse_type);
 822           break;
 823
 824         case 'a':               /* Like -dpPR. */
 825           x.dereference = DEREF_NEVER;
 826           x.preserve_links = 1;
 827           x.preserve_ownership = 1;
 828           x.preserve_mode = 1;
 829           x.preserve_timestamps = 1;
 830           x.require_preserve = 1;
 831           x.recursive = 1;
 832           break;
 833
 834         case 'V':  /* FIXME: this is deprecated.  Remove it in 2001.  */
 835           error (0, 0,
 836                  _("warning: --version-control (-V) is obsolete;  support for\
 837  it\nwill be removed in some future release.  Use --backup=%s instead."
 838                    ), optarg);
 839           /* Fall through.  */
 840
 841         case 'b':
 842           make_backups = 1;
 843           if (optarg)
 844             version_control_string = optarg;
 845           break;
 846
 847         case COPY_CONTENTS_OPTION:
 848           copy_contents = 1;
 849           break;
 850
 851         case 'd':
 852           x.preserve_links = 1;
 853           x.dereference = DEREF_NEVER;
 854           break;
 855
 856         case 'f':
 857           x.unlink_dest_after_failed_open = 1;
 858           break;
 859
 860         case 'H':
 861           x.dereference = DEREF_COMMAND_LINE_ARGUMENTS;
 862           break;
 863
 864         case 'i':
 865           x.interactive = I_ASK_USER;
 866           break;
 867
 868         case 'l':
 869           x.hard_link = 1;
 870           break;
 871
 872         case 'L':
 873           x.dereference = DEREF_ALWAYS;
 874           break;
 875
 876         case 'P':
 877           x.dereference = DEREF_NEVER;
 878           break;
 879
 880         case NO_PRESERVE_ATTRIBUTES_OPTION:
 881           decode_preserve_arg (optarg, &x, 0);
 882           break;
 883
 884         case PRESERVE_ATTRIBUTES_OPTION:
 885           if (optarg == NULL)
 886             {
 887               /* Fall through to the case for `p' below.  */
 888             }
 889           else
 890             {
 891               decode_preserve_arg (optarg, &x, 1);
 892               x.require_preserve = 1;
 893               break;
 894             }
 895
 896         case 'p':
 897           x.preserve_ownership = 1;
 898           x.preserve_mode = 1;
 899           x.preserve_timestamps = 1;
 900           x.require_preserve = 1;
 901           break;
 902
 903         case PARENTS_OPTION:
 904           flag_path = 1;
 905           break;
 906
 907         case 'r':
 908         case 'R':
 909           x.recursive = 1;
 910           break;
 911
 912         case REPLY_OPTION:
 913           x.interactive = XARGMATCH ("--reply", optarg,
 914                                      reply_args, reply_vals);
 915           break;
 916
 917         case UNLINK_DEST_BEFORE_OPENING:
 918           x.unlink_dest_before_opening = 1;
 919           break;
 920
 921         case STRIP_TRAILING_SLASHES_OPTION:
 922           remove_trailing_slashes = 1;
 923           break;
 924
 925         case 's':
 926 #ifdef S_ISLNK
 927           x.symbolic_link = 1;
 928 #else
 929           error (EXIT_FAILURE, 0,
 930                  _("symbolic links are not supported on this system"));
 931 #endif
 932           break;
 933
 934         case TARGET_DIRECTORY_OPTION:
 935           if (target_directory)
 936             error (EXIT_FAILURE, 0,
 937                    _("multiple target directories specified"));
 938           else
 939             {
 940               struct stat st;
 941               if (stat (optarg, &st) != 0)
 942                 error (EXIT_FAILURE, errno, _("accessing %s"), quote (optarg));
 943               if (! S_ISDIR (st.st_mode))
 944                 error (EXIT_FAILURE, 0, _("target %s is not a directory"),
 945                        quote (optarg));
 946             }
 947           target_directory = optarg;
 948           break;
 949
 950         case 'u':
 951           x.update = 1;
 952           break;
 953
 954         case 'v':
 955           x.verbose = 1;
 956           break;
 957
 958         case 'x':
 959           x.one_file_system = 1;
 960           break;
 961
 962         case 'S':
 963           make_backups = 1;
 964           backup_suffix_string = optarg;
 965           break;
 966
 967         case_GETOPT_HELP_CHAR;
 968
 969         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 970
 971         default:
 972           usage (EXIT_FAILURE);
 973         }
 974     }
 975
 976   if (x.hard_link && x.symbolic_link)
 977     {
 978       error (0, 0, _("cannot make both hard and symbolic links"));
 979       usage (EXIT_FAILURE);
 980     }
 981
 982   if (backup_suffix_string)
 983     simple_backup_suffix = xstrdup (backup_suffix_string);
 984
 985   x.backup_type = (make_backups
 986                    ? xget_version (_("backup type"),
 987                                    version_control_string)
 988                    : none);
 989
 990   if (x.preserve_mode == 1)
 991     x.umask_kill = ~ (mode_t) 0;
 992
 993   if (x.dereference == DEREF_UNDEFINED)
 994     {
 995       if (x.recursive)
 996         /* This is compatible with FreeBSD.  */
 997         x.dereference = DEREF_NEVER;
 998       else
 999         x.dereference = DEREF_ALWAYS;
1000     }
1001
1002   /* The key difference between -d (--no-dereference) and not is the version
1003      of `stat' to call.  */
1004
1005   if (x.recursive)
1006     x.copy_as_regular = copy_contents;
1007
1008   /* If --force (-f) was specified and we're in link-creation mode,
1009      first remove any existing destination file.  */
1010   if (x.unlink_dest_after_failed_open && (x.hard_link || x.symbolic_link))
1011     x.unlink_dest_before_opening = 1;
1012
1013   /* Allocate space for remembering copied and created files.  */
1014
1015   hash_init ();
1016
1017   exit_status = do_copy (argc - optind, argv + optind, target_directory, &x);
1018
1019   forget_all ();
1020
1021   exit (exit_status);
1022 }