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