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