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 =
 412             xmalloc (sizeof (struct dir_attr));
 413           new->slash_offset = slash - dirpath;
 414           new->next = *attr_list;
 415           *attr_list = new;
 416
 417           *slash = '\0';
 418           if ((*xstat) (dirpath, &stats))
 419             {
 420               /* This element of the path does not exist.  We must set
 421                  *new_dst and new->is_new_dir inside this loop because,
 422                  for example, in the command `cp --parents ../a/../b/c e_dir',
 423                  make_path_private creates only e_dir/../a if ./b already
 424                  exists. */
 425               *new_dst = 1;
 426               new->is_new_dir = 1;
 427               if (mkdir (dirpath, mode))
 428                 {
 429                   error (0, errno, _("cannot make directory %s"),
 430                          quote (dirpath));
 431                   return 1;
 432                 }
 433               else
 434                 {
 435                   if (verbose_fmt_string != NULL)
 436                     printf (verbose_fmt_string, src, dirpath);
 437                 }
 438             }
 439           else if (!S_ISDIR (stats.st_mode))
 440             {
 441               error (0, 0, _("%s exists but is not a directory"),
 442                      quote (dirpath));
 443               return 1;
 444             }
 445           else
 446             {
 447               new->is_new_dir = 0;
 448               *new_dst = 0;
 449             }
 450           *slash++ = '/';
 451
 452           /* Avoid unnecessary calls to `stat' when given
 453              pathnames containing multiple adjacent slashes.  */
 454           while (*slash == '/')
 455             slash++;
 456         }
 457     }
 458
 459   /* We get here if the parent of `dirpath' already exists. */
 460
 461   else if (!S_ISDIR (stats.st_mode))
 462     {
 463       error (0, 0, _("%s exists but is not a directory"), quote (dst_dirname));
 464       return 1;
 465     }
 466   else
 467     {
 468       *new_dst = 0;
 469     }
 470   return 0;
 471 }
 472
 473 /* Scan the arguments, and copy each by calling copy.
 474    Return 0 if successful, 1 if any errors occur. */
 475
 476 static int
 477 do_copy (int n_files, char **file, const char *target_directory,
 478          struct cp_options *x)
 479 {
 480   const char *dest;
 481   struct stat sb;
 482   int new_dst = 0;
 483   int ret = 0;
 484   int dest_is_dir = 0;
 485
 486   if (n_files <= 0)
 487     {
 488       error (0, 0, _("missing file argument"));
 489       usage (EXIT_FAILURE);
 490     }
 491   if (n_files == 1 && !target_directory)
 492     {
 493       error (0, 0, _("missing destination file"));
 494       usage (EXIT_FAILURE);
 495     }
 496
 497   if (target_directory)
 498     dest = target_directory;
 499   else
 500     {
 501       dest = file[n_files - 1];
 502       --n_files;
 503     }
 504
 505   /* Initialize these hash tables only if we'll need them.
 506      The problems they're used to detect can arise only if
 507      there are two or more files to copy.  */
 508   if (n_files >= 2)
 509     {
 510       dest_info_init (x);
 511       src_info_init (x);
 512     }
 513
 514   if (lstat (dest, &sb))
 515     {
 516       if (errno != ENOENT)
 517         {
 518           error (0, errno, _("accessing %s"), quote (dest));
 519           return 1;
 520         }
 521
 522       new_dst = 1;
 523     }
 524   else
 525     {
 526       struct stat sbx;
 527
 528       /* If `dest' is not a symlink to a nonexistent file, use
 529          the results of stat instead of lstat, so we can copy files
 530          into symlinks to directories. */
 531       if (stat (dest, &sbx) == 0)
 532         sb = sbx;
 533
 534       dest_is_dir = S_ISDIR (sb.st_mode);
 535     }
 536
 537   if (!dest_is_dir)
 538     {
 539       if (target_directory || 1 < n_files)
 540         {
 541           char const *msg;
 542           if (new_dst)
 543             msg = N_("%s: specified destination directory does not exist");
 544           else if (target_directory)
 545             msg = N_("%s: specified target is not a directory");
 546           else /* n_files > 1 */
 547             msg =
 548           N_("copying multiple files, but last argument %s is not a directory");
 549
 550           error (0, 0, _(msg), quote (dest));
 551           usage (EXIT_FAILURE);
 552         }
 553     }
 554
 555   if (dest_is_dir)
 556     {
 557       /* cp file1...filen edir
 558          Copy the files `file1' through `filen'
 559          to the existing directory `edir'. */
 560       int i;
 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                                                   x->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 make_backups = 0;
 828   char *backup_suffix_string;
 829   char *version_control_string = NULL;
 830   struct cp_options x;
 831   int copy_contents = 0;
 832   char *target_directory = NULL;
 833
 834   initialize_main (&argc, &argv);
 835   program_name = argv[0];
 836   setlocale (LC_ALL, "");
 837   bindtextdomain (PACKAGE, LOCALEDIR);
 838   textdomain (PACKAGE);
 839
 840   atexit (close_stdout);
 841
 842   cp_option_init (&x);
 843
 844   /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
 845      we'll actually use backup_suffix_string.  */
 846   backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
 847
 848   while ((c = getopt_long (argc, argv, "abdfHilLprsuvxPRS:V:", long_opts, NULL))
 849          != -1)
 850     {
 851       switch (c)
 852         {
 853         case 0:
 854           break;
 855
 856         case SPARSE_OPTION:
 857           x.sparse_mode = XARGMATCH ("--sparse", optarg,
 858                                      sparse_type_string, sparse_type);
 859           break;
 860
 861         case 'a':               /* Like -dpPR. */
 862           x.dereference = DEREF_NEVER;
 863           x.preserve_links = 1;
 864           x.preserve_ownership = 1;
 865           x.preserve_mode = 1;
 866           x.preserve_timestamps = 1;
 867           x.require_preserve = 1;
 868           x.recursive = 1;
 869           break;
 870
 871         case 'V':  /* FIXME: this is deprecated.  Remove it in 2001.  */
 872           error (0, 0,
 873                  _("warning: --version-control (-V) is obsolete;  support for\
 874  it\nwill be removed in some future release.  Use --backup=%s instead."
 875                    ), optarg);
 876           /* Fall through.  */
 877
 878         case 'b':
 879           make_backups = 1;
 880           if (optarg)
 881             version_control_string = optarg;
 882           break;
 883
 884         case COPY_CONTENTS_OPTION:
 885           copy_contents = 1;
 886           break;
 887
 888         case 'd':
 889           x.preserve_links = 1;
 890           x.dereference = DEREF_NEVER;
 891           break;
 892
 893         case 'f':
 894           x.unlink_dest_after_failed_open = 1;
 895           break;
 896
 897         case 'H':
 898           x.dereference = DEREF_COMMAND_LINE_ARGUMENTS;
 899           break;
 900
 901         case 'i':
 902           x.interactive = I_ASK_USER;
 903           break;
 904
 905         case 'l':
 906           x.hard_link = 1;
 907           break;
 908
 909         case 'L':
 910           x.dereference = DEREF_ALWAYS;
 911           break;
 912
 913         case 'P':
 914           x.dereference = DEREF_NEVER;
 915           break;
 916
 917         case NO_PRESERVE_ATTRIBUTES_OPTION:
 918           decode_preserve_arg (optarg, &x, 0);
 919           break;
 920
 921         case PRESERVE_ATTRIBUTES_OPTION:
 922           if (optarg == NULL)
 923             {
 924               /* Fall through to the case for `p' below.  */
 925             }
 926           else
 927             {
 928               decode_preserve_arg (optarg, &x, 1);
 929               x.require_preserve = 1;
 930               break;
 931             }
 932
 933         case 'p':
 934           x.preserve_ownership = 1;
 935           x.preserve_mode = 1;
 936           x.preserve_timestamps = 1;
 937           x.require_preserve = 1;
 938           break;
 939
 940         case PARENTS_OPTION:
 941           flag_path = 1;
 942           break;
 943
 944         case 'r':
 945         case 'R':
 946           x.recursive = 1;
 947           break;
 948
 949         case REPLY_OPTION:
 950           x.interactive = XARGMATCH ("--reply", optarg,
 951                                      reply_args, reply_vals);
 952           break;
 953
 954         case UNLINK_DEST_BEFORE_OPENING:
 955           x.unlink_dest_before_opening = 1;
 956           break;
 957
 958         case STRIP_TRAILING_SLASHES_OPTION:
 959           remove_trailing_slashes = 1;
 960           break;
 961
 962         case 's':
 963 #ifdef S_ISLNK
 964           x.symbolic_link = 1;
 965 #else
 966           error (EXIT_FAILURE, 0,
 967                  _("symbolic links are not supported on this system"));
 968 #endif
 969           break;
 970
 971         case TARGET_DIRECTORY_OPTION:
 972           target_directory = optarg;
 973           break;
 974
 975         case 'u':
 976           x.update = 1;
 977           break;
 978
 979         case 'v':
 980           x.verbose = 1;
 981           break;
 982
 983         case 'x':
 984           x.one_file_system = 1;
 985           break;
 986
 987         case 'S':
 988           make_backups = 1;
 989           backup_suffix_string = optarg;
 990           break;
 991
 992         case_GETOPT_HELP_CHAR;
 993
 994         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 995
 996         default:
 997           usage (EXIT_FAILURE);
 998         }
 999     }
1000
1001   if (x.hard_link && x.symbolic_link)
1002     {
1003       error (0, 0, _("cannot make both hard and symbolic links"));
1004       usage (EXIT_FAILURE);
1005     }
1006
1007   if (backup_suffix_string)
1008     simple_backup_suffix = xstrdup (backup_suffix_string);
1009
1010   x.backup_type = (make_backups
1011                    ? xget_version (_("backup type"),
1012                                    version_control_string)
1013                    : none);
1014
1015   if (x.preserve_mode == 1)
1016     x.umask_kill = ~ (mode_t) 0;
1017
1018   if (x.dereference == DEREF_UNDEFINED)
1019     {
1020       if (x.recursive)
1021         /* This is compatible with FreeBSD.  */
1022         x.dereference = DEREF_NEVER;
1023       else
1024         x.dereference = DEREF_ALWAYS;
1025     }
1026
1027   /* The key difference between -d (--no-dereference) and not is the version
1028      of `stat' to call.  */
1029
1030   if (x.dereference == DEREF_NEVER)
1031     x.xstat = lstat;
1032   else
1033     {
1034       /* For DEREF_COMMAND_LINE_ARGUMENTS, x.xstat must be stat for
1035          each command line argument, but must later be `lstat' for
1036          any symlinks that are found via recursive traversal.  */
1037       x.xstat = stat;
1038     }
1039
1040   if (x.recursive)
1041     x.copy_as_regular = copy_contents;
1042
1043   /* If --force (-f) was specified and we're in link-creation mode,
1044      first remove any existing destination file.  */
1045   if (x.unlink_dest_after_failed_open && (x.hard_link || x.symbolic_link))
1046     x.unlink_dest_before_opening = 1;
1047
1048   /* Allocate space for remembering copied and created files.  */
1049
1050   hash_init ();
1051
1052   exit_status |= do_copy (argc - optind, argv + optind, target_directory, &x);
1053
1054   forget_all ();
1055
1056   exit (exit_status);
1057 }