src/cp.c

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