src/cp.c

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