1 /* cp.c -- file copying (main routines)
2 Copyright (C) 89, 90, 91, 1995-2000 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"
39 /* The official name of this program (e.g., no `g' prefix). */
40 #define PROGRAM_NAME "cp"
42 #define AUTHORS "Torbjorn Granlund, David MacKenzie, and Jim Meyering"
44 #ifndef _POSIX_VERSION
48 /* Used by do_copy, make_path_private, and re_protect
49 to keep a list of leading directories whose protections
50 need to be fixed after copying. */
55 struct dir_attr *next;
58 /* For long options that have no equivalent short option, use a
59 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
62 TARGET_DIRECTORY_OPTION = CHAR_MAX + 1,
64 STRIP_TRAILING_SLASHES_OPTION
70 void strip_trailing_slashes ();
72 /* Initial number of entries in each hash table entry's table of inodes. */
73 #define INITIAL_HASH_MODULE 100
75 /* Initial number of entries in the inode hash table. */
76 #define INITIAL_ENTRY_TAB_SIZE 70
78 /* The invocation name of this program. */
81 /* If nonzero, the command "cp x/e_file e_dir" uses "e_dir/x/e_file"
82 as its destination instead of the usual "e_dir/e_file." */
83 static int flag_path = 0;
85 /* Remove any trailing slashes from each SOURCE argument. */
86 static int remove_trailing_slashes;
88 static char const *const sparse_type_string[] =
90 "never", "auto", "always", 0
93 static enum Sparse_type const sparse_type[] =
95 SPARSE_NEVER, SPARSE_AUTO, SPARSE_ALWAYS
98 /* The error code to return to the system. */
99 static int exit_status = 0;
101 static struct option const long_opts[] =
103 {"archive", no_argument, NULL, 'a'},
104 {"backup", optional_argument, NULL, 'b'},
105 {"force", no_argument, NULL, 'f'},
106 {"sparse", required_argument, NULL, SPARSE_OPTION},
107 {"interactive", no_argument, NULL, 'i'},
108 {"link", no_argument, NULL, 'l'},
109 {"no-dereference", no_argument, NULL, 'd'},
110 {"one-file-system", no_argument, NULL, 'x'},
111 {"parents", no_argument, NULL, 'P'},
112 {"path", no_argument, NULL, 'P'},
113 {"preserve", no_argument, NULL, 'p'},
114 {"recursive", no_argument, NULL, 'R'},
115 {"strip-trailing-slash", no_argument, NULL, STRIP_TRAILING_SLASHES_OPTION},
116 {"suffix", required_argument, NULL, 'S'},
117 {"symbolic-link", no_argument, NULL, 's'},
118 {"target-directory", required_argument, NULL, TARGET_DIRECTORY_OPTION},
119 {"update", no_argument, NULL, 'u'},
120 {"verbose", no_argument, NULL, 'v'},
121 {"version-control", required_argument, NULL, 'V'}, /* Deprecated. FIXME. */
122 {GETOPT_HELP_OPTION_DECL},
123 {GETOPT_VERSION_OPTION_DECL},
131 fprintf (stderr, _("Try `%s --help' for more information.\n"),
136 Usage: %s [OPTION]... SOURCE DEST\n\
137 or: %s [OPTION]... SOURCE... DIRECTORY\n\
138 or: %s [OPTION]... --target-directory=DIRECTORY SOURCE...\n\
140 program_name, program_name, program_name);
142 Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n\
144 -a, --archive same as -dpR\n\
145 --backup[=CONTROL] make a backup of each existing destination file\n\
146 -b like --backup but does not accept an argument\n\
147 -d, --no-dereference preserve links\n\
148 -f, --force remove existing destinations, never prompt\n\
149 -i, --interactive prompt before overwrite\n\
150 -l, --link link files instead of copying\n\
151 -p, --preserve preserve file attributes if possible\n\
152 -P, --parents append source path to DIRECTORY\n\
153 -r copy recursively, non-directories as files\n\
154 WARNING: use -R instead when you might copy\n\
155 special files like FIFOs or /dev/zero\n\
156 --sparse=WHEN control creation of sparse files\n\
157 -R, --recursive copy directories recursively\n\
158 --strip-trailing-slashes remove any trailing slashes from each SOURCE\n\
160 -s, --symbolic-link make symbolic links instead of copying\n\
161 -S, --suffix=SUFFIX override the usual backup suffix\n\
162 --target-directory=DIRECTORY move all SOURCE arguments into DIRECTORY\n\
163 -u, --update copy only when the SOURCE file is newer\n\
164 than the destination file or when the\n\
165 destination file is missing\n\
166 -v, --verbose explain what is being done\n\
167 -x, --one-file-system stay on this file system\n\
168 --help display this help and exit\n\
169 --version output version information and exit\n\
171 By default, sparse SOURCE files are detected by a crude heuristic and the\n\
172 corresponding DEST file is made sparse as well. That is the behavior\n\
173 selected by --sparse=auto. Specify --sparse=always to create a sparse DEST\n\
174 file whenever the SOURCE file contains a long enough sequence of zero bytes.\n\
175 Use --sparse=never to inhibit creation of sparse files.\n\
179 The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
180 The version control method may be selected via the --backup option or through\n\
181 the VERSION_CONTROL environment variable. Here are the values:\n\
183 none, off never make backups (even if --backup is given)\n\
184 numbered, t make numbered backups\n\
185 existing, nil numbered if numbered backups exist, simple otherwise\n\
186 simple, never always make simple backups\n\
190 As a special case, cp makes a backup of SOURCE when the force and backup\n\
191 options are given and SOURCE and DEST are the same name for an existing,\n\
194 puts (_("\nReport bugs to <bug-fileutils@gnu.org>."));
200 /* Ensure that the parent directories of CONST_DST_PATH have the
201 correct protections, for the --parents option. This is done
202 after all copying has been completed, to allow permissions
203 that don't include user write/execute.
205 SRC_OFFSET is the index in CONST_DST_PATH of the beginning of the
206 source directory name.
208 ATTR_LIST is a null-terminated linked list of structures that
209 indicates the end of the filename of each intermediate directory
210 in CONST_DST_PATH that may need to have its attributes changed.
211 The command `cp --parents --preserve a/b/c d/e_dir' changes the
212 attributes of the directories d/e_dir/a and d/e_dir/a/b to match
213 the corresponding source directories regardless of whether they
214 existed before the `cp' command was given.
216 Return 0 if the parent of CONST_DST_PATH and any intermediate
217 directories specified by ATTR_LIST have the proper permissions
218 when done, otherwise 1. */
221 re_protect (const char *const_dst_path, int src_offset,
222 struct dir_attr *attr_list, const struct cp_options *x)
225 char *dst_path; /* A copy of CONST_DST_PATH we can change. */
226 char *src_path; /* The source name in `dst_path'. */
227 uid_t myeuid = geteuid ();
229 dst_path = (char *) alloca (strlen (const_dst_path) + 1);
230 strcpy (dst_path, const_dst_path);
231 src_path = dst_path + src_offset;
233 for (p = attr_list; p; p = p->next)
237 dst_path[p->slash_offset] = '\0';
239 if ((*(x->xstat)) (src_path, &src_sb))
241 error (0, errno, "%s", src_path);
245 /* Adjust the times (and if possible, ownership) for the copy.
246 chown turns off set[ug]id bits for non-root,
247 so do the chmod last. */
249 if (x->preserve_timestamps)
253 /* There's currently no interface to set file timestamps with
254 better than 1-second resolution, so discard any fractional
255 part of the source timestamp. */
257 utb.actime = src_sb.st_atime;
258 utb.modtime = src_sb.st_mtime;
260 if (utime (dst_path, &utb))
262 error (0, errno, _("preserving times for %s"), dst_path);
267 if (x->preserve_owner_and_group)
269 /* If non-root uses -p, it's ok if we can't preserve ownership.
270 But root probably wants to know, e.g. if NFS disallows it,
271 or if the target system doesn't support file ownership. */
272 if (chown (dst_path, src_sb.st_uid, src_sb.st_gid)
273 && ((errno != EPERM && errno != EINVAL) || myeuid == 0))
275 error (0, errno, _("preserving ownership for %s"), dst_path);
280 if (x->preserve_chmod_bits || p->is_new_dir)
282 if (chmod (dst_path, src_sb.st_mode & x->umask_kill))
284 error (0, errno, _("preserving permissions for %s"), dst_path);
289 dst_path[p->slash_offset] = '/';
294 /* Ensure that the parent directory of CONST_DIRPATH exists, for
295 the --parents option.
297 SRC_OFFSET is the index in CONST_DIRPATH (which is a destination
298 path) of the beginning of the source directory name.
299 Create any leading directories that don't already exist,
300 giving them permissions MODE.
301 If VERBOSE_FMT_STRING is nonzero, use it as a printf format
302 string for printing a message after successfully making a directory.
303 The format should take two string arguments: the names of the
304 source and destination directories.
305 Creates a linked list of attributes of intermediate directories,
306 *ATTR_LIST, for re_protect to use after calling copy.
307 Sets *NEW_DST to 1 if this function creates parent of CONST_DIRPATH.
309 Return 0 if parent of CONST_DIRPATH exists as a directory with the proper
310 permissions when done, otherwise 1. */
313 make_path_private (const char *const_dirpath, int src_offset, int mode,
314 const char *verbose_fmt_string, struct dir_attr **attr_list,
315 int *new_dst, int (*xstat)())
318 char *dirpath; /* A copy of CONST_DIRPATH we can change. */
319 char *src; /* Source name in `dirpath'. */
320 char *tmp_dst_dirname; /* Leading path of `dirpath', malloc. */
321 char *dst_dirname; /* Leading path of `dirpath', alloca. */
323 dirpath = (char *) alloca (strlen (const_dirpath) + 1);
324 strcpy (dirpath, const_dirpath);
326 src = dirpath + src_offset;
328 tmp_dst_dirname = dir_name (dirpath);
329 dst_dirname = (char *) alloca (strlen (tmp_dst_dirname) + 1);
330 strcpy (dst_dirname, tmp_dst_dirname);
331 free (tmp_dst_dirname);
335 if ((*xstat) (dst_dirname, &stats))
337 /* Parent of CONST_DIRNAME does not exist.
338 Make all missing intermediate directories. */
342 while (*slash == '/')
344 while ((slash = strchr (slash, '/')))
346 /* Add this directory to the list of directories whose modes need
348 struct dir_attr *new =
349 (struct dir_attr *) xmalloc (sizeof (struct dir_attr));
350 new->slash_offset = slash - dirpath;
351 new->next = *attr_list;
355 if ((*xstat) (dirpath, &stats))
357 /* This element of the path does not exist. We must set
358 *new_dst and new->is_new_dir inside this loop because,
359 for example, in the command `cp --parents ../a/../b/c e_dir',
360 make_path_private creates only e_dir/../a if ./b already
364 if (mkdir (dirpath, mode))
366 error (0, errno, _("cannot make directory `%s'"), dirpath);
371 if (verbose_fmt_string != NULL)
372 printf (verbose_fmt_string, src, dirpath);
375 else if (!S_ISDIR (stats.st_mode))
377 error (0, 0, _("`%s' exists but is not a directory"), dirpath);
387 /* Avoid unnecessary calls to `stat' when given
388 pathnames containing multiple adjacent slashes. */
389 while (*slash == '/')
394 /* We get here if the parent of `dirpath' already exists. */
396 else if (!S_ISDIR (stats.st_mode))
398 error (0, 0, _("`%s' exists but is not a directory"), dst_dirname);
408 /* Scan the arguments, and copy each by calling copy.
409 Return 0 if successful, 1 if any errors occur. */
412 do_copy (int n_files, char **file, const char *target_directory,
413 const struct cp_options *x)
423 error (0, 0, _("missing file arguments"));
426 if (n_files == 1 && !target_directory)
428 error (0, 0, _("missing destination file"));
432 if (target_directory)
433 dest = target_directory;
436 dest = file[n_files - 1];
440 if (lstat (dest, &sb))
444 error (0, errno, "%s", dest);
454 /* If `dest' is not a symlink to a nonexistent file, use
455 the results of stat instead of lstat, so we can copy files
456 into symlinks to directories. */
457 if (stat (dest, &sbx) == 0)
460 dest_is_dir = S_ISDIR (sb.st_mode);
465 if (target_directory)
467 error (0, 0, _("specified target, `%s' is not a directory"), dest);
474 _("copying multiple files, but last argument (%s) is not a directory"),
482 /* cp file1...filen edir
483 Copy the files `file1' through `filen'
484 to the existing directory `edir'. */
487 for (i = 0; i < n_files; i++)
491 int parent_exists = 1; /* True if dir_name (dst_path) exists. */
492 struct dir_attr *attr_list;
493 char *arg_in_concat = NULL;
496 if (remove_trailing_slashes)
497 strip_trailing_slashes (arg);
501 /* Append all of `arg' to `dest'. */
502 dst_path = path_concat (dest, arg, &arg_in_concat);
503 if (dst_path == NULL)
504 error (1, 0, _("virtual memory exhausted"));
506 /* For --parents, we have to make sure that the directory
507 dir_name (dst_path) exists. We may have to create a few
508 leading directories. */
509 parent_exists = !make_path_private (dst_path,
510 arg_in_concat - dst_path,
513 ? "%s -> %s\n" : NULL),
514 &attr_list, &new_dst,
519 /* Append the last component of `arg' to `dest'. */
521 ap = base_name (arg);
522 /* For `cp -R source/.. dest', don't copy into `dest/..'. */
523 dst_path = (STREQ (ap, "..")
525 : path_concat (dest, ap, NULL));
530 /* make_path_private failed, so don't even attempt the copy. */
536 ret |= copy (arg, dst_path, new_dst, x, ©_into_self, NULL);
541 ret |= re_protect (dst_path, arg_in_concat - dst_path,
550 else /* if (n_files == 1) */
555 struct stat source_stats;
560 _("when preserving paths, the destination must be a directory"));
566 /* When the force and backup options have been specified and
567 the source and destination are the same name for an existing
568 regular file, convert the user's command, e.g.,
569 `cp --force --backup foo foo' to `cp --force foo fooSUFFIX'
570 where SUFFIX is determined by any version control options used. */
573 && x->backup_type != none
574 && STREQ (source, dest)
575 && !new_dst && S_ISREG (sb.st_mode))
577 static struct cp_options x_tmp;
579 new_dest = find_backup_file_name (dest, x->backup_type);
580 /* Set x->backup_type to `none' so that the normal backup
581 mechanism is not used when performing the actual copy.
582 backup_type must be set to `none' only *after* the above
583 call to find_backup_file_name -- that function uses
584 backup_type to determine the suffix it applies. */
586 x_tmp.backup_type = none;
589 if (new_dest == NULL)
590 error (1, 0, _("virtual memory exhausted"));
593 /* When the destination is specified with a trailing slash and the
594 source exists but is not a directory, convert the user's command
595 `cp source dest/' to `cp source dest/basename(source)'. Doing
596 this ensures that the command `cp non-directory file/' will now
597 fail rather than performing the copy. COPY diagnoses the case of
598 `cp directory non-directory'. */
600 else if (dest[strlen (dest) - 1] == '/'
601 && lstat (source, &source_stats) == 0
602 && !S_ISDIR (source_stats.st_mode))
607 tmp_source = (char *) alloca (strlen (source) + 1);
608 strcpy (tmp_source, source);
609 if (remove_trailing_slashes)
610 strip_trailing_slashes (tmp_source);
611 source_base = base_name (tmp_source);
613 new_dest = (char *) alloca (strlen (dest)
614 + strlen (source_base) + 1);
615 stpcpy (stpcpy (new_dest, dest), source_base);
619 new_dest = (char *) dest;
622 return copy (source, new_dest, new_dst, x, &unused, NULL);
629 cp_option_init (struct cp_options *x)
631 x->copy_as_regular = 1;
634 x->failed_unlink_is_fatal = 1;
637 x->myeuid = geteuid ();
639 x->one_file_system = 0;
641 x->preserve_owner_and_group = 0;
642 x->preserve_chmod_bits = 0;
643 x->preserve_timestamps = 0;
645 x->require_preserve = 0;
647 x->sparse_mode = SPARSE_AUTO;
648 x->symbolic_link = 0;
652 /* Find out the current file creation mask, to knock the right bits
653 when using chmod. The creation mask is set to be liberal, so
654 that created directories can be written, even if it would not
655 have been allowed with the mask this process was started with. */
656 x->umask_kill = ~ umask (0);
663 main (int argc, char **argv)
666 int make_backups = 0;
667 char *backup_suffix_string;
668 char *version_control_string = NULL;
670 char *target_directory = NULL;
672 program_name = argv[0];
673 setlocale (LC_ALL, "");
674 bindtextdomain (PACKAGE, LOCALEDIR);
675 textdomain (PACKAGE);
679 /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
680 we'll actually use backup_suffix_string. */
681 backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
683 while ((c = getopt_long (argc, argv, "abdfilprsuvxPRS:V:", long_opts, NULL))
692 x.sparse_mode = XARGMATCH ("--sparse", optarg,
693 sparse_type_string, sparse_type);
696 case 'a': /* Like -dpR. */
698 x.preserve_owner_and_group = 1;
699 x.preserve_chmod_bits = 1;
700 x.preserve_timestamps = 1;
701 x.require_preserve = 1;
703 x.copy_as_regular = 0;
706 case 'V': /* FIXME: this is deprecated. Remove it in 2001. */
708 _("warning: --version-control (-V) is obsolete; support for\
709 it\nwill be removed in some future release. Use --backup=%s instead."
716 version_control_string = optarg;
738 x.preserve_owner_and_group = 1;
739 x.preserve_chmod_bits = 1;
740 x.preserve_timestamps = 1;
741 x.require_preserve = 1;
750 x.copy_as_regular = 1;
755 x.copy_as_regular = 0;
758 case STRIP_TRAILING_SLASHES_OPTION:
759 remove_trailing_slashes = 1;
766 error (1, 0, _("symbolic links are not supported on this system"));
770 case TARGET_DIRECTORY_OPTION:
771 target_directory = optarg;
783 x.one_file_system = 1;
788 backup_suffix_string = optarg;
791 case_GETOPT_HELP_CHAR;
793 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
800 if (x.hard_link && x.symbolic_link)
802 error (0, 0, _("cannot make both hard and symbolic links"));
806 if (backup_suffix_string)
807 simple_backup_suffix = xstrdup (backup_suffix_string);
809 x.backup_type = (make_backups
810 ? xget_version (_("backup type"),
811 version_control_string)
814 if (x.preserve_chmod_bits == 1)
815 x.umask_kill = ~ (mode_t) 0;
817 /* The key difference between -d (--no-dereference) and not is the version
818 of `stat' to call. */
825 /* Allocate space for remembering copied and created files. */
827 hash_init (INITIAL_HASH_MODULE, INITIAL_ENTRY_TAB_SIZE);
829 exit_status |= do_copy (argc - optind, argv + optind, target_directory, &x);