1 /* cp.c -- file copying (main routines)
2 Copyright (C) 89, 90, 91, 1995-2001 Free Software Foundation.
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)
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.
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.
18 Written by Torbjorn Granlund, David MacKenzie, and Jim Meyering. */
26 #include <sys/types.h>
32 #include "backupfile.h"
37 #include "path-concat.h"
40 #define ASSIGN_BASENAME_STRDUPA(Dest, File_name) \
44 ASSIGN_STRDUPA (tmp_abns_, (File_name)); \
45 strip_trailing_slashes (tmp_abns_); \
46 Dest = base_name (tmp_abns_); \
50 /* The official name of this program (e.g., no `g' prefix). */
51 #define PROGRAM_NAME "cp"
53 #define AUTHORS N_ ("Torbjorn Granlund, David MacKenzie, and Jim Meyering")
55 #ifndef _POSIX_VERSION
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. */
66 struct dir_attr *next;
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. */
73 PARENTS_OPTION = CHAR_MAX + 1,
76 STRIP_TRAILING_SLASHES_OPTION,
77 TARGET_DIRECTORY_OPTION,
78 UNLINK_DEST_BEFORE_OPENING
81 /* Initial number of entries in each hash table entry's table of inodes. */
82 #define INITIAL_HASH_MODULE 100
84 /* Initial number of entries in the inode hash table. */
85 #define INITIAL_ENTRY_TAB_SIZE 70
87 /* The invocation name of this program. */
90 /* If nonzero, the command "cp x/e_file e_dir" uses "e_dir/x/e_file"
91 as its destination instead of the usual "e_dir/e_file." */
92 static int flag_path = 0;
94 /* Remove any trailing slashes from each SOURCE argument. */
95 static int remove_trailing_slashes;
97 static char const *const sparse_type_string[] =
99 "never", "auto", "always", 0
102 static enum Sparse_type const sparse_type[] =
104 SPARSE_NEVER, SPARSE_AUTO, SPARSE_ALWAYS
107 /* Valid arguments to the `--reply' option. */
108 static char const* const reply_args[] =
110 "yes", "no", "query", 0
113 /* The values that correspond to the above strings. */
114 static int const reply_vals[] =
116 I_ALWAYS_YES, I_ALWAYS_NO, I_ASK_USER
119 /* The error code to return to the system. */
120 static int exit_status = 0;
122 static struct option const long_opts[] =
124 {"archive", no_argument, NULL, 'a'},
125 {"backup", optional_argument, NULL, 'b'},
126 {"dereference", no_argument, NULL, 'L'},
127 {"force", no_argument, NULL, 'f'},
128 {"sparse", required_argument, NULL, SPARSE_OPTION},
129 {"interactive", no_argument, NULL, 'i'},
130 {"link", no_argument, NULL, 'l'},
131 {"no-dereference", no_argument, NULL, 'd'},
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", no_argument, NULL, 'p'},
136 {"recursive", no_argument, NULL, 'R'},
137 {"remove-destination", no_argument, NULL, UNLINK_DEST_BEFORE_OPENING},
138 {"reply", required_argument, NULL, REPLY_OPTION},
139 {"strip-trailing-slashes", no_argument, NULL, STRIP_TRAILING_SLASHES_OPTION},
140 {"suffix", required_argument, NULL, 'S'},
141 {"symbolic-link", no_argument, NULL, 's'},
142 {"target-directory", required_argument, NULL, TARGET_DIRECTORY_OPTION},
143 {"update", no_argument, NULL, 'u'},
144 {"verbose", no_argument, NULL, 'v'},
145 {"version-control", required_argument, NULL, 'V'}, /* Deprecated. FIXME. */
146 {GETOPT_HELP_OPTION_DECL},
147 {GETOPT_VERSION_OPTION_DECL},
155 fprintf (stderr, _("Try `%s --help' for more information.\n"),
160 Usage: %s [OPTION]... SOURCE DEST\n\
161 or: %s [OPTION]... SOURCE... DIRECTORY\n\
162 or: %s [OPTION]... --target-directory=DIRECTORY SOURCE...\n\
164 program_name, program_name, program_name);
166 Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n\
168 -a, --archive same as -dpR\n\
169 --backup[=CONTROL] make a backup of each existing destination file\n\
170 -b like --backup but does not accept an argument\n\
171 -d, --no-dereference never follow symbolic links\n\
172 -f, --force if an existing destination file cannot be\n\
173 opened, remove it and try again\n\
174 -i, --interactive prompt before overwrite\n\
175 -H follow command-line symbolic links\n\
178 -l, --link link files instead of copying\n\
179 -L, --dereference always follow symbolic links\n\
180 -p, --preserve preserve file attributes if possible\n\
181 --parents append source path to DIRECTORY\n\
182 -P same as `--parents' for now; soon to change to\n\
183 `--no-dereference' to conform to POSIX\n\
184 -r copy recursively, non-directories as files\n\
185 WARNING: use -R instead when you might copy\n\
186 special files like FIFOs or /dev/zero\n\
187 --remove-destination remove each existing destination file before\n\
188 attempting to open it (contrast with --force)\n\
191 --sparse=WHEN control creation of sparse files\n\
192 -R, --recursive copy directories recursively\n\
193 --reply={yes,no,query} specify how to handle the prompt about an\n\
194 existing destination file\n\
195 --strip-trailing-slashes remove any trailing slashes from each SOURCE\n\
197 -s, --symbolic-link make symbolic links instead of copying\n\
198 -S, --suffix=SUFFIX override the usual backup suffix\n\
199 --target-directory=DIRECTORY move all SOURCE arguments into DIRECTORY\n\
200 -u, --update copy only when the SOURCE file is newer\n\
201 than the destination file or when the\n\
202 destination file is missing\n\
205 -v, --verbose explain what is being done\n\
206 -x, --one-file-system stay on this file system\n\
207 --help display this help and exit\n\
208 --version output version information and exit\n\
210 By default, sparse SOURCE files are detected by a crude heuristic and the\n\
211 corresponding DEST file is made sparse as well. That is the behavior\n\
212 selected by --sparse=auto. Specify --sparse=always to create a sparse DEST\n\
213 file whenever the SOURCE file contains a long enough sequence of zero bytes.\n\
214 Use --sparse=never to inhibit creation of sparse files.\n\
218 The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
219 The version control method may be selected via the --backup option or through\n\
220 the VERSION_CONTROL environment variable. Here are the values:\n\
222 none, off never make backups (even if --backup is given)\n\
223 numbered, t make numbered backups\n\
224 existing, nil numbered if numbered backups exist, simple otherwise\n\
225 simple, never always make simple backups\n\
229 As a special case, cp makes a backup of SOURCE when the force and backup\n\
230 options are given and SOURCE and DEST are the same name for an existing,\n\
233 puts (_("\nReport bugs to <bug-fileutils@gnu.org>."));
238 /* Ensure that the parent directories of CONST_DST_PATH have the
239 correct protections, for the --parents option. This is done
240 after all copying has been completed, to allow permissions
241 that don't include user write/execute.
243 SRC_OFFSET is the index in CONST_DST_PATH of the beginning of the
244 source directory name.
246 ATTR_LIST is a null-terminated linked list of structures that
247 indicates the end of the filename of each intermediate directory
248 in CONST_DST_PATH that may need to have its attributes changed.
249 The command `cp --parents --preserve a/b/c d/e_dir' changes the
250 attributes of the directories d/e_dir/a and d/e_dir/a/b to match
251 the corresponding source directories regardless of whether they
252 existed before the `cp' command was given.
254 Return 0 if the parent of CONST_DST_PATH and any intermediate
255 directories specified by ATTR_LIST have the proper permissions
256 when done, otherwise 1. */
259 re_protect (const char *const_dst_path, int src_offset,
260 struct dir_attr *attr_list, const struct cp_options *x)
263 char *dst_path; /* A copy of CONST_DST_PATH we can change. */
264 char *src_path; /* The source name in `dst_path'. */
265 uid_t myeuid = geteuid ();
267 dst_path = (char *) alloca (strlen (const_dst_path) + 1);
268 strcpy (dst_path, const_dst_path);
269 src_path = dst_path + src_offset;
271 for (p = attr_list; p; p = p->next)
275 dst_path[p->slash_offset] = '\0';
277 if ((*(x->xstat)) (src_path, &src_sb))
279 error (0, errno, _("getting attributes of %s"),
284 /* Adjust the times (and if possible, ownership) for the copy.
285 chown turns off set[ug]id bits for non-root,
286 so do the chmod last. */
288 if (x->preserve_timestamps)
292 /* There's currently no interface to set file timestamps with
293 better than 1-second resolution, so discard any fractional
294 part of the source timestamp. */
296 utb.actime = src_sb.st_atime;
297 utb.modtime = src_sb.st_mtime;
299 if (utime (dst_path, &utb))
301 error (0, errno, _("preserving times for %s"), quote (dst_path));
306 if (x->preserve_owner_and_group)
308 /* If non-root uses -p, it's ok if we can't preserve ownership.
309 But root probably wants to know, e.g. if NFS disallows it,
310 or if the target system doesn't support file ownership. */
311 if (chown (dst_path, src_sb.st_uid, src_sb.st_gid)
312 && ((errno != EPERM && errno != EINVAL) || myeuid == 0))
314 error (0, errno, _("preserving ownership for %s"),
320 if (x->preserve_chmod_bits || p->is_new_dir)
322 if (chmod (dst_path, src_sb.st_mode & x->umask_kill))
324 error (0, errno, _("preserving permissions for %s"),
330 dst_path[p->slash_offset] = '/';
335 /* Ensure that the parent directory of CONST_DIRPATH exists, for
336 the --parents option.
338 SRC_OFFSET is the index in CONST_DIRPATH (which is a destination
339 path) of the beginning of the source directory name.
340 Create any leading directories that don't already exist,
341 giving them permissions MODE.
342 If VERBOSE_FMT_STRING is nonzero, use it as a printf format
343 string for printing a message after successfully making a directory.
344 The format should take two string arguments: the names of the
345 source and destination directories.
346 Creates a linked list of attributes of intermediate directories,
347 *ATTR_LIST, for re_protect to use after calling copy.
348 Sets *NEW_DST to 1 if this function creates parent of CONST_DIRPATH.
350 Return 0 if parent of CONST_DIRPATH exists as a directory with the proper
351 permissions when done, otherwise 1. */
353 /* FIXME: find a way to synch this function with the one in lib/makepath.c. */
356 make_path_private (const char *const_dirpath, int src_offset, int mode,
357 const char *verbose_fmt_string, struct dir_attr **attr_list,
358 int *new_dst, int (*xstat)())
361 char *dirpath; /* A copy of CONST_DIRPATH we can change. */
362 char *src; /* Source name in `dirpath'. */
363 char *dst_dirname; /* Leading path of `dirpath'. */
364 size_t dirlen; /* Length of leading path of `dirpath'. */
366 dirpath = (char *) alloca (strlen (const_dirpath) + 1);
367 strcpy (dirpath, const_dirpath);
369 src = dirpath + src_offset;
371 dirlen = dir_len (dirpath);
372 dst_dirname = (char *) alloca (dirlen + 1);
373 memcpy (dst_dirname, dirpath, dirlen);
374 dst_dirname[dirlen] = '\0';
378 if ((*xstat) (dst_dirname, &stats))
380 /* Parent of CONST_DIRNAME does not exist.
381 Make all missing intermediate directories. */
385 while (*slash == '/')
387 while ((slash = strchr (slash, '/')))
389 /* Add this directory to the list of directories whose modes need
391 struct dir_attr *new =
392 (struct dir_attr *) xmalloc (sizeof (struct dir_attr));
393 new->slash_offset = slash - dirpath;
394 new->next = *attr_list;
398 if ((*xstat) (dirpath, &stats))
400 /* This element of the path does not exist. We must set
401 *new_dst and new->is_new_dir inside this loop because,
402 for example, in the command `cp --parents ../a/../b/c e_dir',
403 make_path_private creates only e_dir/../a if ./b already
407 if (mkdir (dirpath, mode))
409 error (0, errno, _("cannot make directory %s"),
415 if (verbose_fmt_string != NULL)
416 printf (verbose_fmt_string, src, dirpath);
419 else if (!S_ISDIR (stats.st_mode))
421 error (0, 0, _("%s exists but is not a directory"),
432 /* Avoid unnecessary calls to `stat' when given
433 pathnames containing multiple adjacent slashes. */
434 while (*slash == '/')
439 /* We get here if the parent of `dirpath' already exists. */
441 else if (!S_ISDIR (stats.st_mode))
443 error (0, 0, _("%s exists but is not a directory"), quote (dst_dirname));
453 /* Scan the arguments, and copy each by calling copy.
454 Return 0 if successful, 1 if any errors occur. */
457 do_copy (int n_files, char **file, const char *target_directory,
458 const struct cp_options *x)
468 error (0, 0, _("missing file arguments"));
471 if (n_files == 1 && !target_directory)
473 error (0, 0, _("missing destination file"));
477 if (target_directory)
478 dest = target_directory;
481 dest = file[n_files - 1];
485 /* Initialize the hash table only if we'll need it.
486 The problem it is used to detect can arise only if there are
487 two or more files to copy. */
491 if (lstat (dest, &sb))
495 error (0, errno, _("accessing %s"), quote (dest));
505 /* If `dest' is not a symlink to a nonexistent file, use
506 the results of stat instead of lstat, so we can copy files
507 into symlinks to directories. */
508 if (stat (dest, &sbx) == 0)
511 dest_is_dir = S_ISDIR (sb.st_mode);
516 if (target_directory)
518 error (0, 0, _("specified target, %s is not a directory"),
526 _("copying multiple files, but last argument %s is not a directory"),
534 /* cp file1...filen edir
535 Copy the files `file1' through `filen'
536 to the existing directory `edir'. */
539 for (i = 0; i < n_files; i++)
542 int parent_exists = 1; /* True if dir_name (dst_path) exists. */
543 struct dir_attr *attr_list;
544 char *arg_in_concat = NULL;
547 /* Trailing slashes are meaningful (i.e., maybe worth preserving)
548 only in the source file names. */
549 if (remove_trailing_slashes)
550 strip_trailing_slashes (arg);
554 char *arg_no_trailing_slash;
556 /* Use `arg' without trailing slashes in constructing destination
557 file names. Otherwise, we can end up trying to create a
558 directory via `mkdir ("dst/foo/"...', which is not portable.
559 It fails, due to the trailing slash, on at least
560 NetBSD 1.[34] systems. */
561 ASSIGN_STRDUPA (arg_no_trailing_slash, arg);
562 strip_trailing_slashes (arg_no_trailing_slash);
564 /* Append all of `arg' (minus any trailing slash) to `dest'. */
565 dst_path = path_concat (dest, arg_no_trailing_slash,
567 if (dst_path == NULL)
570 /* For --parents, we have to make sure that the directory
571 dir_name (dst_path) exists. We may have to create a few
572 leading directories. */
573 parent_exists = !make_path_private (dst_path,
574 arg_in_concat - dst_path,
577 ? "%s -> %s\n" : NULL),
578 &attr_list, &new_dst,
584 /* Append the last component of `arg' to `dest'. */
586 ASSIGN_BASENAME_STRDUPA (arg_base, arg);
587 /* For `cp -R source/.. dest', don't copy into `dest/..'. */
588 dst_path = (STREQ (arg_base, "..")
590 : path_concat (dest, arg_base, NULL));
595 /* make_path_private failed, so don't even attempt the copy. */
601 ret |= copy (arg, dst_path, new_dst, x, ©_into_self, NULL);
606 ret |= re_protect (dst_path, arg_in_concat - dst_path,
615 else /* if (n_files == 1) */
620 struct stat source_stats;
625 _("when preserving paths, the destination must be a directory"));
631 /* When the force and backup options have been specified and
632 the source and destination are the same name for an existing
633 regular file, convert the user's command, e.g.,
634 `cp --force --backup foo foo' to `cp --force foo fooSUFFIX'
635 where SUFFIX is determined by any version control options used. */
637 if (x->unlink_dest_after_failed_open
638 && x->backup_type != none
639 && STREQ (source, dest)
640 && !new_dst && S_ISREG (sb.st_mode))
642 static struct cp_options x_tmp;
644 new_dest = find_backup_file_name (dest, x->backup_type);
645 /* Set x->backup_type to `none' so that the normal backup
646 mechanism is not used when performing the actual copy.
647 backup_type must be set to `none' only *after* the above
648 call to find_backup_file_name -- that function uses
649 backup_type to determine the suffix it applies. */
651 x_tmp.backup_type = none;
654 if (new_dest == NULL)
658 /* When the destination is specified with a trailing slash and the
659 source exists but is not a directory, convert the user's command
660 `cp source dest/' to `cp source dest/basename(source)'. Doing
661 this ensures that the command `cp non-directory file/' will now
662 fail rather than performing the copy. COPY diagnoses the case of
663 `cp directory non-directory'. */
665 else if (dest[strlen (dest) - 1] == '/'
666 && lstat (source, &source_stats) == 0
667 && !S_ISDIR (source_stats.st_mode))
671 ASSIGN_BASENAME_STRDUPA (source_base, source);
672 new_dest = (char *) alloca (strlen (dest)
673 + strlen (source_base) + 1);
674 stpcpy (stpcpy (new_dest, dest), source_base);
678 new_dest = (char *) dest;
681 return copy (source, new_dest, new_dst, x, &unused, NULL);
688 cp_option_init (struct cp_options *x)
690 x->copy_as_regular = 1;
691 x->dereference = DEREF_UNDEFINED;
692 x->unlink_dest_before_opening = 0;
693 x->unlink_dest_after_failed_open = 0;
694 x->failed_unlink_is_fatal = 1;
696 x->interactive = I_UNSPECIFIED;
697 x->myeuid = geteuid ();
699 x->one_file_system = 0;
701 x->preserve_owner_and_group = 0;
702 x->preserve_chmod_bits = 0;
703 x->preserve_timestamps = 0;
705 x->require_preserve = 0;
707 x->sparse_mode = SPARSE_AUTO;
708 x->symbolic_link = 0;
715 /* Find out the current file creation mask, to knock the right bits
716 when using chmod. The creation mask is set to be liberal, so
717 that created directories can be written, even if it would not
718 have been allowed with the mask this process was started with. */
719 x->umask_kill = ~ umask (0);
726 main (int argc, char **argv)
729 int make_backups = 0;
730 char *backup_suffix_string;
731 char *version_control_string = NULL;
733 char *target_directory = NULL;
734 int used_P_option = 0;
736 program_name = argv[0];
737 setlocale (LC_ALL, "");
738 bindtextdomain (PACKAGE, LOCALEDIR);
739 textdomain (PACKAGE);
741 atexit (close_stdout);
745 /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
746 we'll actually use backup_suffix_string. */
747 backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
749 while ((c = getopt_long (argc, argv, "abdfHilLprsuvxPRS:V:", long_opts, NULL))
758 x.sparse_mode = XARGMATCH ("--sparse", optarg,
759 sparse_type_string, sparse_type);
762 case 'a': /* Like -dpR. */
763 x.dereference = DEREF_NEVER;
764 x.preserve_owner_and_group = 1;
765 x.preserve_chmod_bits = 1;
766 x.preserve_timestamps = 1;
767 x.require_preserve = 1;
769 x.copy_as_regular = 0;
772 case 'V': /* FIXME: this is deprecated. Remove it in 2001. */
774 _("warning: --version-control (-V) is obsolete; support for\
775 it\nwill be removed in some future release. Use --backup=%s instead."
782 version_control_string = optarg;
786 x.dereference = DEREF_NEVER;
790 x.unlink_dest_after_failed_open = 1;
794 x.dereference = DEREF_COMMAND_LINE_ARGUMENTS;
798 x.interactive = I_ASK_USER;
806 x.dereference = DEREF_ALWAYS;
810 x.preserve_owner_and_group = 1;
811 x.preserve_chmod_bits = 1;
812 x.preserve_timestamps = 1;
813 x.require_preserve = 1;
825 x.copy_as_regular = 1;
830 x.copy_as_regular = 0;
834 x.interactive = XARGMATCH ("--reply", optarg,
835 reply_args, reply_vals);
838 case UNLINK_DEST_BEFORE_OPENING:
839 x.unlink_dest_before_opening = 1;
842 case STRIP_TRAILING_SLASHES_OPTION:
843 remove_trailing_slashes = 1;
850 error (1, 0, _("symbolic links are not supported on this system"));
854 case TARGET_DIRECTORY_OPTION:
855 target_directory = optarg;
867 x.one_file_system = 1;
872 backup_suffix_string = optarg;
875 case_GETOPT_HELP_CHAR;
877 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
884 if (x.hard_link && x.symbolic_link)
886 error (0, 0, _("cannot make both hard and symbolic links"));
894 Warning: the meaning of `-P' will change in the future to conform to POSIX.\n\
895 Use `--parents' for the old meaning, and `--no-dereference' for the new one."));
898 if (backup_suffix_string)
899 simple_backup_suffix = xstrdup (backup_suffix_string);
901 x.backup_type = (make_backups
902 ? xget_version (_("backup type"),
903 version_control_string)
906 if (x.preserve_chmod_bits == 1)
907 x.umask_kill = ~ (mode_t) 0;
909 if (x.dereference == DEREF_UNDEFINED)
912 /* This is compatible with FreeBSD. */
913 x.dereference = DEREF_NEVER;
915 x.dereference = DEREF_ALWAYS;
918 /* The key difference between -d (--no-dereference) and not is the version
919 of `stat' to call. */
921 if (x.dereference == DEREF_NEVER)
925 /* For DEREF_COMMAND_LINE_ARGUMENTS, x.xstat must be stat for
926 each command line argument, but must later be `lstat' for
927 any symlinks that are found via recursive traversal. */
931 /* If --force (-f) was specified and we're in link-creation mode,
932 first remove any existing destination file. */
933 if (x.unlink_dest_after_failed_open && (x.hard_link || x.symbolic_link))
934 x.unlink_dest_before_opening = 1;
936 /* Allocate space for remembering copied and created files. */
938 hash_init (INITIAL_HASH_MODULE, INITIAL_ENTRY_TAB_SIZE);
940 exit_status |= do_copy (argc - optind, argv + optind, target_directory, &x);