src/cp.c

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