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  move 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 /* Scan the arguments, and copy each by calling copy.
 469    Return 0 if successful, 1 if any errors occur. */
 470
 471 static int
 472 do_copy (int n_files, char **file, const char *target_directory,
 473          struct cp_options *x)
 474 {
 475   const char *dest;
 476   struct stat sb;
 477   int new_dst = 0;
 478   int ret = 0;
 479   int dest_is_dir = 0;
 480
 481   if (n_files <= 0)
 482     {
 483       error (0, 0, _("missing file argument"));
 484       usage (EXIT_FAILURE);
 485     }
 486   if (n_files == 1 && !target_directory)
 487     {
 488       error (0, 0, _("missing destination file"));
 489       usage (EXIT_FAILURE);
 490     }
 491
 492   if (target_directory)
 493     dest = target_directory;
 494   else
 495     {
 496       dest = file[n_files - 1];
 497       --n_files;
 498     }
 499
 500   /* Initialize these hash tables only if we'll need them.
 501      The problems they're used to detect can arise only if
 502      there are two or more files to copy.  */
 503   if (n_files >= 2)
 504     {
 505       dest_info_init (x);
 506       src_info_init (x);
 507     }
 508
 509   if (lstat (dest, &sb))
 510     {
 511       if (errno != ENOENT)
 512         {
 513           error (0, errno, _("accessing %s"), quote (dest));
 514           return 1;
 515         }
 516
 517       new_dst = 1;
 518     }
 519   else
 520     {
 521       struct stat sbx;
 522
 523       /* If `dest' is not a symlink to a nonexistent file, use
 524          the results of stat instead of lstat, so we can copy files
 525          into symlinks to directories. */
 526       if (stat (dest, &sbx) == 0)
 527         sb = sbx;
 528
 529       dest_is_dir = S_ISDIR (sb.st_mode);
 530     }
 531
 532   if (!dest_is_dir)
 533     {
 534       if (target_directory || 1 < n_files)
 535         {
 536           if (new_dst)
 537             error (0, 0, _("%s: destination directory does not exist"),
 538                    quotearg_colon (dest));
 539           else if (target_directory)
 540             error (0, 0, _("%s: specified target is not a directory"),
 541                    quotearg_colon (dest));
 542           else /* n_files > 1 */
 543             error (0, 0,
 544            _("copying multiple files, but last argument %s is not a directory"),
 545                    quote (dest));
 546
 547           usage (EXIT_FAILURE);
 548         }
 549     }
 550
 551   if (dest_is_dir)
 552     {
 553       /* cp file1...filen edir
 554          Copy the files `file1' through `filen'
 555          to the existing directory `edir'. */
 556       int i;
 557       int (*xstat)() = (x->dereference == DEREF_COMMAND_LINE_ARGUMENTS
 558                         || x->dereference == DEREF_ALWAYS
 559                         ? stat
 560                         : lstat);
 561
 562       for (i = 0; i < n_files; i++)
 563         {
 564           char *dst_path;
 565           int parent_exists = 1; /* True if dir_name (dst_path) exists. */
 566           struct dir_attr *attr_list;
 567           char *arg_in_concat = NULL;
 568           char *arg = file[i];
 569
 570           /* Trailing slashes are meaningful (i.e., maybe worth preserving)
 571              only in the source file names.  */
 572           if (remove_trailing_slashes)
 573             strip_trailing_slashes (arg);
 574
 575           if (flag_path)
 576             {
 577               char *arg_no_trailing_slash;
 578
 579               /* Use `arg' without trailing slashes in constructing destination
 580                  file names.  Otherwise, we can end up trying to create a
 581                  directory via `mkdir ("dst/foo/"...', which is not portable.
 582                  It fails, due to the trailing slash, on at least
 583                  NetBSD 1.[34] systems.  */
 584               ASSIGN_STRDUPA (arg_no_trailing_slash, arg);
 585               strip_trailing_slashes (arg_no_trailing_slash);
 586
 587               /* Append all of `arg' (minus any trailing slash) to `dest'.  */
 588               dst_path = path_concat (dest, arg_no_trailing_slash,
 589                                       &arg_in_concat);
 590               if (dst_path == NULL)
 591                 xalloc_die ();
 592
 593               /* For --parents, we have to make sure that the directory
 594                  dir_name (dst_path) exists.  We may have to create a few
 595                  leading directories. */
 596               parent_exists = !make_path_private (dst_path,
 597                                                   arg_in_concat - dst_path,
 598                                                   S_IRWXU,
 599                                                   (x->verbose
 600                                                    ? "%s -> %s\n" : NULL),
 601                                                   &attr_list, &new_dst,
 602                                                   xstat);
 603             }
 604           else
 605             {
 606               char *arg_base;
 607               /* Append the last component of `arg' to `dest'.  */
 608
 609               ASSIGN_BASENAME_STRDUPA (arg_base, arg);
 610               /* For `cp -R source/.. dest', don't copy into `dest/..'. */
 611               dst_path = (STREQ (arg_base, "..")
 612                           ? xstrdup (dest)
 613                           : path_concat (dest, arg_base, NULL));
 614             }
 615
 616           if (!parent_exists)
 617             {
 618               /* make_path_private failed, so don't even attempt the copy. */
 619               ret = 1;
 620             }
 621           else
 622             {
 623               int copy_into_self;
 624               ret |= copy (arg, dst_path, new_dst, x, &copy_into_self, NULL);
 625
 626               if (flag_path)
 627                 {
 628                   ret |= re_protect (dst_path, arg_in_concat - dst_path,
 629                                      attr_list, x);
 630                 }
 631             }
 632
 633           free (dst_path);
 634         }
 635       return ret;
 636     }
 637   else /* if (n_files == 1) */
 638     {
 639       char *new_dest;
 640       char *source;
 641       int unused;
 642       struct stat source_stats;
 643
 644       if (flag_path)
 645         {
 646           error (0, 0,
 647                _("when preserving paths, the destination must be a directory"));
 648           usage (EXIT_FAILURE);
 649         }
 650
 651       source = file[0];
 652
 653       /* When the force and backup options have been specified and
 654          the source and destination are the same name for an existing
 655          regular file, convert the user's command, e.g.,
 656          `cp --force --backup foo foo' to `cp --force foo fooSUFFIX'
 657          where SUFFIX is determined by any version control options used.  */
 658
 659       if (x->unlink_dest_after_failed_open
 660           && x->backup_type != none
 661           && STREQ (source, dest)
 662           && !new_dst && S_ISREG (sb.st_mode))
 663         {
 664           static struct cp_options x_tmp;
 665
 666           new_dest = find_backup_file_name (dest, x->backup_type);
 667           /* Set x->backup_type to `none' so that the normal backup
 668              mechanism is not used when performing the actual copy.
 669              backup_type must be set to `none' only *after* the above
 670              call to find_backup_file_name -- that function uses
 671              backup_type to determine the suffix it applies.  */
 672           x_tmp = *x;
 673           x_tmp.backup_type = none;
 674           x = &x_tmp;
 675
 676           if (new_dest == NULL)
 677             xalloc_die ();
 678         }
 679
 680       /* When the destination is specified with a trailing slash and the
 681          source exists but is not a directory, convert the user's command
 682          `cp source dest/' to `cp source dest/basename(source)'.  Doing
 683          this ensures that the command `cp non-directory file/' will now
 684          fail rather than performing the copy.  COPY diagnoses the case of
 685          `cp directory non-directory'.  */
 686
 687       else if (dest[strlen (dest) - 1] == '/'
 688           && lstat (source, &source_stats) == 0
 689           && !S_ISDIR (source_stats.st_mode))
 690         {
 691           char *source_base;
 692
 693           ASSIGN_BASENAME_STRDUPA (source_base, source);
 694           new_dest = alloca (strlen (dest) + strlen (source_base) + 1);
 695           stpcpy (stpcpy (new_dest, dest), source_base);
 696         }
 697       else
 698         {
 699           new_dest = (char *) dest;
 700         }
 701
 702       return copy (source, new_dest, new_dst, x, &unused, NULL);
 703     }
 704
 705   /* unreachable */
 706 }
 707
 708 static void
 709 cp_option_init (struct cp_options *x)
 710 {
 711   x->copy_as_regular = 1;
 712   x->dereference = DEREF_UNDEFINED;
 713   x->unlink_dest_before_opening = 0;
 714   x->unlink_dest_after_failed_open = 0;
 715   x->hard_link = 0;
 716   x->interactive = I_UNSPECIFIED;
 717   x->myeuid = geteuid ();
 718   x->move_mode = 0;
 719   x->one_file_system = 0;
 720
 721   x->preserve_ownership = 0;
 722   x->preserve_links = 0;
 723   x->preserve_mode = 0;
 724   x->preserve_timestamps = 0;
 725
 726   x->require_preserve = 0;
 727   x->recursive = 0;
 728   x->sparse_mode = SPARSE_AUTO;
 729   x->symbolic_link = 0;
 730   x->set_mode = 0;
 731   x->mode = 0;
 732
 733   /* Not used.  */
 734   x->stdin_tty = 0;
 735
 736   /* Find out the current file creation mask, to knock the right bits
 737      when using chmod.  The creation mask is set to be liberal, so
 738      that created directories can be written, even if it would not
 739      have been allowed with the mask this process was started with.  */
 740   x->umask_kill = ~ umask (0);
 741
 742   x->update = 0;
 743   x->verbose = 0;
 744   x->dest_info = NULL;
 745   x->src_info = NULL;
 746 }
 747
 748 /* Given a string, ARG, containing a comma-separated list of arguments
 749    to the --preserve option, set the appropriate fields of X to ON_OFF.  */
 750 static void
 751 decode_preserve_arg (char const *arg, struct cp_options *x, int on_off)
 752 {
 753   enum File_attribute
 754     {
 755       PRESERVE_MODE,
 756       PRESERVE_TIMESTAMPS,
 757       PRESERVE_OWNERSHIP,
 758       PRESERVE_LINK,
 759       PRESERVE_ALL
 760     };
 761   static enum File_attribute const preserve_vals[] =
 762     {
 763       PRESERVE_MODE, PRESERVE_TIMESTAMPS,
 764       PRESERVE_OWNERSHIP, PRESERVE_LINK, PRESERVE_ALL
 765     };
 766
 767   /* Valid arguments to the `--preserve' option. */
 768   static char const* const preserve_args[] =
 769     {
 770       "mode", "timestamps",
 771       "ownership", "links", "all", 0
 772     };
 773
 774   char *arg_writable = xstrdup (arg);
 775   char *s = arg_writable;
 776   do
 777     {
 778       /* find next comma */
 779       char *comma = strchr (s, ',');
 780       enum File_attribute val;
 781
 782       /* If we found a comma, put a NUL in its place and advance.  */
 783       if (comma)
 784         *comma++ = 0;
 785
 786       /* process S.  */
 787       val = XARGMATCH ("--preserve", s, preserve_args, preserve_vals);
 788       switch (val)
 789         {
 790         case PRESERVE_MODE:
 791           x->preserve_mode = on_off;
 792           break;
 793
 794         case PRESERVE_TIMESTAMPS:
 795           x->preserve_timestamps = on_off;
 796           break;
 797
 798         case PRESERVE_OWNERSHIP:
 799           x->preserve_ownership = on_off;
 800           break;
 801
 802         case PRESERVE_LINK:
 803           x->preserve_links = on_off;
 804           break;
 805
 806         case PRESERVE_ALL:
 807           x->preserve_mode = on_off;
 808           x->preserve_timestamps = on_off;
 809           x->preserve_ownership = on_off;
 810           x->preserve_links = on_off;
 811           break;
 812
 813         default:
 814           abort ();
 815         }
 816       s = comma;
 817     }
 818   while (s);
 819
 820   free (arg_writable);
 821 }
 822
 823 int
 824 main (int argc, char **argv)
 825 {
 826   int c;
 827   int exit_status;
 828   int make_backups = 0;
 829   char *backup_suffix_string;
 830   char *version_control_string = NULL;
 831   struct cp_options x;
 832   int copy_contents = 0;
 833   char *target_directory = NULL;
 834
 835   initialize_main (&argc, &argv);
 836   program_name = argv[0];
 837   setlocale (LC_ALL, "");
 838   bindtextdomain (PACKAGE, LOCALEDIR);
 839   textdomain (PACKAGE);
 840
 841   atexit (close_stdout);
 842
 843   cp_option_init (&x);
 844
 845   /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
 846      we'll actually use backup_suffix_string.  */
 847   backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
 848
 849   while ((c = getopt_long (argc, argv, "abdfHilLprsuvxPRS:V:", long_opts, NULL))
 850          != -1)
 851     {
 852       switch (c)
 853         {
 854         case 0:
 855           break;
 856
 857         case SPARSE_OPTION:
 858           x.sparse_mode = XARGMATCH ("--sparse", optarg,
 859                                      sparse_type_string, sparse_type);
 860           break;
 861
 862         case 'a':               /* Like -dpPR. */
 863           x.dereference = DEREF_NEVER;
 864           x.preserve_links = 1;
 865           x.preserve_ownership = 1;
 866           x.preserve_mode = 1;
 867           x.preserve_timestamps = 1;
 868           x.require_preserve = 1;
 869           x.recursive = 1;
 870           break;
 871
 872         case 'V':  /* FIXME: this is deprecated.  Remove it in 2001.  */
 873           error (0, 0,
 874                  _("warning: --version-control (-V) is obsolete;  support for\
 875  it\nwill be removed in some future release.  Use --backup=%s instead."
 876                    ), optarg);
 877           /* Fall through.  */
 878
 879         case 'b':
 880           make_backups = 1;
 881           if (optarg)
 882             version_control_string = optarg;
 883           break;
 884
 885         case COPY_CONTENTS_OPTION:
 886           copy_contents = 1;
 887           break;
 888
 889         case 'd':
 890           x.preserve_links = 1;
 891           x.dereference = DEREF_NEVER;
 892           break;
 893
 894         case 'f':
 895           x.unlink_dest_after_failed_open = 1;
 896           break;
 897
 898         case 'H':
 899           x.dereference = DEREF_COMMAND_LINE_ARGUMENTS;
 900           break;
 901
 902         case 'i':
 903           x.interactive = I_ASK_USER;
 904           break;
 905
 906         case 'l':
 907           x.hard_link = 1;
 908           break;
 909
 910         case 'L':
 911           x.dereference = DEREF_ALWAYS;
 912           break;
 913
 914         case 'P':
 915           x.dereference = DEREF_NEVER;
 916           break;
 917
 918         case NO_PRESERVE_ATTRIBUTES_OPTION:
 919           decode_preserve_arg (optarg, &x, 0);
 920           break;
 921
 922         case PRESERVE_ATTRIBUTES_OPTION:
 923           if (optarg == NULL)
 924             {
 925               /* Fall through to the case for `p' below.  */
 926             }
 927           else
 928             {
 929               decode_preserve_arg (optarg, &x, 1);
 930               x.require_preserve = 1;
 931               break;
 932             }
 933
 934         case 'p':
 935           x.preserve_ownership = 1;
 936           x.preserve_mode = 1;
 937           x.preserve_timestamps = 1;
 938           x.require_preserve = 1;
 939           break;
 940
 941         case PARENTS_OPTION:
 942           flag_path = 1;
 943           break;
 944
 945         case 'r':
 946         case 'R':
 947           x.recursive = 1;
 948           break;
 949
 950         case REPLY_OPTION:
 951           x.interactive = XARGMATCH ("--reply", optarg,
 952                                      reply_args, reply_vals);
 953           break;
 954
 955         case UNLINK_DEST_BEFORE_OPENING:
 956           x.unlink_dest_before_opening = 1;
 957           break;
 958
 959         case STRIP_TRAILING_SLASHES_OPTION:
 960           remove_trailing_slashes = 1;
 961           break;
 962
 963         case 's':
 964 #ifdef S_ISLNK
 965           x.symbolic_link = 1;
 966 #else
 967           error (EXIT_FAILURE, 0,
 968                  _("symbolic links are not supported on this system"));
 969 #endif
 970           break;
 971
 972         case TARGET_DIRECTORY_OPTION:
 973           target_directory = optarg;
 974           break;
 975
 976         case 'u':
 977           x.update = 1;
 978           break;
 979
 980         case 'v':
 981           x.verbose = 1;
 982           break;
 983
 984         case 'x':
 985           x.one_file_system = 1;
 986           break;
 987
 988         case 'S':
 989           make_backups = 1;
 990           backup_suffix_string = optarg;
 991           break;
 992
 993         case_GETOPT_HELP_CHAR;
 994
 995         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 996
 997         default:
 998           usage (EXIT_FAILURE);
 999         }
1000     }
1001
1002   if (x.hard_link && x.symbolic_link)
1003     {
1004       error (0, 0, _("cannot make both hard and symbolic links"));
1005       usage (EXIT_FAILURE);
1006     }
1007
1008   if (backup_suffix_string)
1009     simple_backup_suffix = xstrdup (backup_suffix_string);
1010
1011   x.backup_type = (make_backups
1012                    ? xget_version (_("backup type"),
1013                                    version_control_string)
1014                    : none);
1015
1016   if (x.preserve_mode == 1)
1017     x.umask_kill = ~ (mode_t) 0;
1018
1019   if (x.dereference == DEREF_UNDEFINED)
1020     {
1021       if (x.recursive)
1022         /* This is compatible with FreeBSD.  */
1023         x.dereference = DEREF_NEVER;
1024       else
1025         x.dereference = DEREF_ALWAYS;
1026     }
1027
1028   /* The key difference between -d (--no-dereference) and not is the version
1029      of `stat' to call.  */
1030
1031   if (x.recursive)
1032     x.copy_as_regular = copy_contents;
1033
1034   /* If --force (-f) was specified and we're in link-creation mode,
1035      first remove any existing destination file.  */
1036   if (x.unlink_dest_after_failed_open && (x.hard_link || x.symbolic_link))
1037     x.unlink_dest_before_opening = 1;
1038
1039   /* Allocate space for remembering copied and created files.  */
1040
1041   hash_init ();
1042
1043   exit_status = do_copy (argc - optind, argv + optind, target_directory, &x);
1044
1045   forget_all ();
1046
1047   exit (exit_status);
1048 }