cp: improve status message when omitting directories
[coreutils.git] / src / cp.c
blob1b528c6a21818cf83055baba53e99a11166b0413
1 /* cp.c -- file copying (main routines)
2 Copyright (C) 1989-2016 Free Software Foundation, Inc.
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 3 of the License, or
7 (at your option) any later version.
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, see <http://www.gnu.org/licenses/>.
17 Written by Torbjorn Granlund, David MacKenzie, and Jim Meyering. */
19 #include <config.h>
20 #include <stdio.h>
21 #include <sys/types.h>
22 #include <getopt.h>
23 #include <selinux/selinux.h>
25 #include "system.h"
26 #include "argmatch.h"
27 #include "backupfile.h"
28 #include "copy.h"
29 #include "cp-hash.h"
30 #include "die.h"
31 #include "error.h"
32 #include "filenamecat.h"
33 #include "ignore-value.h"
34 #include "quote.h"
35 #include "stat-time.h"
36 #include "utimens.h"
37 #include "acl.h"
39 #if ! HAVE_LCHOWN
40 # define lchown(name, uid, gid) chown (name, uid, gid)
41 #endif
43 #define ASSIGN_BASENAME_STRDUPA(Dest, File_name) \
44 do \
45 { \
46 char *tmp_abns_; \
47 ASSIGN_STRDUPA (tmp_abns_, (File_name)); \
48 Dest = last_component (tmp_abns_); \
49 strip_trailing_slashes (Dest); \
50 } \
51 while (0)
53 /* The official name of this program (e.g., no 'g' prefix). */
54 #define PROGRAM_NAME "cp"
56 #define AUTHORS \
57 proper_name ("Torbjorn Granlund"), \
58 proper_name ("David MacKenzie"), \
59 proper_name ("Jim Meyering")
61 /* Used by do_copy, make_dir_parents_private, and re_protect
62 to keep a list of leading directories whose protections
63 need to be fixed after copying. */
64 struct dir_attr
66 struct stat st;
67 bool restore_mode;
68 size_t slash_offset;
69 struct dir_attr *next;
72 /* For long options that have no equivalent short option, use a
73 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
74 enum
76 ATTRIBUTES_ONLY_OPTION = CHAR_MAX + 1,
77 COPY_CONTENTS_OPTION,
78 NO_PRESERVE_ATTRIBUTES_OPTION,
79 PARENTS_OPTION,
80 PRESERVE_ATTRIBUTES_OPTION,
81 REFLINK_OPTION,
82 SPARSE_OPTION,
83 STRIP_TRAILING_SLASHES_OPTION,
84 UNLINK_DEST_BEFORE_OPENING
87 /* True if the kernel is SELinux enabled. */
88 static bool selinux_enabled;
90 /* If true, 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 bool parents_option = false;
94 /* Remove any trailing slashes from each SOURCE argument. */
95 static bool remove_trailing_slashes;
97 static char const *const sparse_type_string[] =
99 "never", "auto", "always", NULL
101 static enum Sparse_type const sparse_type[] =
103 SPARSE_NEVER, SPARSE_AUTO, SPARSE_ALWAYS
105 ARGMATCH_VERIFY (sparse_type_string, sparse_type);
107 static char const *const reflink_type_string[] =
109 "auto", "always", NULL
111 static enum Reflink_type const reflink_type[] =
113 REFLINK_AUTO, REFLINK_ALWAYS
115 ARGMATCH_VERIFY (reflink_type_string, reflink_type);
117 static struct option const long_opts[] =
119 {"archive", no_argument, NULL, 'a'},
120 {"attributes-only", no_argument, NULL, ATTRIBUTES_ONLY_OPTION},
121 {"backup", optional_argument, NULL, 'b'},
122 {"copy-contents", no_argument, NULL, COPY_CONTENTS_OPTION},
123 {"dereference", no_argument, NULL, 'L'},
124 {"force", no_argument, NULL, 'f'},
125 {"interactive", no_argument, NULL, 'i'},
126 {"link", no_argument, NULL, 'l'},
127 {"no-clobber", no_argument, NULL, 'n'},
128 {"no-dereference", no_argument, NULL, 'P'},
129 {"no-preserve", required_argument, NULL, NO_PRESERVE_ATTRIBUTES_OPTION},
130 {"no-target-directory", no_argument, NULL, 'T'},
131 {"one-file-system", no_argument, NULL, 'x'},
132 {"parents", no_argument, NULL, PARENTS_OPTION},
133 {"path", no_argument, NULL, PARENTS_OPTION}, /* Deprecated. */
134 {"preserve", optional_argument, NULL, PRESERVE_ATTRIBUTES_OPTION},
135 {"recursive", no_argument, NULL, 'R'},
136 {"remove-destination", no_argument, NULL, UNLINK_DEST_BEFORE_OPENING},
137 {"sparse", required_argument, NULL, SPARSE_OPTION},
138 {"reflink", optional_argument, NULL, REFLINK_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, 't'},
143 {"update", no_argument, NULL, 'u'},
144 {"verbose", no_argument, NULL, 'v'},
145 {GETOPT_SELINUX_CONTEXT_OPTION_DECL},
146 {GETOPT_HELP_OPTION_DECL},
147 {GETOPT_VERSION_OPTION_DECL},
148 {NULL, 0, NULL, 0}
151 void
152 usage (int status)
154 if (status != EXIT_SUCCESS)
155 emit_try_help ();
156 else
158 printf (_("\
159 Usage: %s [OPTION]... [-T] SOURCE DEST\n\
160 or: %s [OPTION]... SOURCE... DIRECTORY\n\
161 or: %s [OPTION]... -t DIRECTORY SOURCE...\n\
163 program_name, program_name, program_name);
164 fputs (_("\
165 Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n\
166 "), stdout);
168 emit_mandatory_arg_note ();
170 fputs (_("\
171 -a, --archive same as -dR --preserve=all\n\
172 --attributes-only don't copy the file data, just the attributes\n\
173 --backup[=CONTROL] make a backup of each existing destination file\
175 -b like --backup but does not accept an argument\n\
176 --copy-contents copy contents of special files when recursive\n\
177 -d same as --no-dereference --preserve=links\n\
178 "), stdout);
179 fputs (_("\
180 -f, --force if an existing destination file cannot be\n\
181 opened, remove it and try again (this option\n\
182 is ignored when the -n option is also used)\n\
183 -i, --interactive prompt before overwrite (overrides a previous -n\
185 option)\n\
186 -H follow command-line symbolic links in SOURCE\n\
187 "), stdout);
188 fputs (_("\
189 -l, --link hard link files instead of copying\n\
190 -L, --dereference always follow symbolic links in SOURCE\n\
191 "), stdout);
192 fputs (_("\
193 -n, --no-clobber do not overwrite an existing file (overrides\n\
194 a previous -i option)\n\
195 -P, --no-dereference never follow symbolic links in SOURCE\n\
196 "), stdout);
197 fputs (_("\
198 -p same as --preserve=mode,ownership,timestamps\n\
199 --preserve[=ATTR_LIST] preserve the specified attributes (default:\n\
200 mode,ownership,timestamps), if possible\n\
201 additional attributes: context, links, xattr,\
203 all\n\
204 "), stdout);
205 fputs (_("\
206 --no-preserve=ATTR_LIST don't preserve the specified attributes\n\
207 --parents use full source file name under DIRECTORY\n\
208 "), stdout);
209 fputs (_("\
210 -R, -r, --recursive copy directories recursively\n\
211 --reflink[=WHEN] control clone/CoW copies. See below\n\
212 --remove-destination remove each existing destination file before\n\
213 attempting to open it (contrast with --force)\
214 \n"), stdout);
215 fputs (_("\
216 --sparse=WHEN control creation of sparse files. See below\n\
217 --strip-trailing-slashes remove any trailing slashes from each SOURCE\n\
218 argument\n\
219 "), stdout);
220 fputs (_("\
221 -s, --symbolic-link make symbolic links instead of copying\n\
222 -S, --suffix=SUFFIX override the usual backup suffix\n\
223 -t, --target-directory=DIRECTORY copy all SOURCE arguments into DIRECTORY\n\
224 -T, --no-target-directory treat DEST as a normal file\n\
225 "), stdout);
226 fputs (_("\
227 -u, --update copy only when the SOURCE file is newer\n\
228 than the destination file or when the\n\
229 destination file is missing\n\
230 -v, --verbose explain what is being done\n\
231 -x, --one-file-system stay on this file system\n\
232 "), stdout);
233 fputs (_("\
234 -Z set SELinux security context of destination\n\
235 file to default type\n\
236 --context[=CTX] like -Z, or if CTX is specified then set the\n\
237 SELinux or SMACK security context to CTX\n\
238 "), stdout);
239 fputs (HELP_OPTION_DESCRIPTION, stdout);
240 fputs (VERSION_OPTION_DESCRIPTION, stdout);
241 fputs (_("\
243 By default, sparse SOURCE files are detected by a crude heuristic and the\n\
244 corresponding DEST file is made sparse as well. That is the behavior\n\
245 selected by --sparse=auto. Specify --sparse=always to create a sparse DEST\n\
246 file whenever the SOURCE file contains a long enough sequence of zero bytes.\n\
247 Use --sparse=never to inhibit creation of sparse files.\n\
249 When --reflink[=always] is specified, perform a lightweight copy, where the\n\
250 data blocks are copied only when modified. If this is not possible the copy\n\
251 fails, or if --reflink=auto is specified, fall back to a standard copy.\n\
252 "), stdout);
253 emit_backup_suffix_note ();
254 fputs (_("\
256 As a special case, cp makes a backup of SOURCE when the force and backup\n\
257 options are given and SOURCE and DEST are the same name for an existing,\n\
258 regular file.\n\
259 "), stdout);
260 emit_ancillary_info (PROGRAM_NAME);
262 exit (status);
265 /* Ensure that the parent directories of CONST_DST_NAME have the
266 correct protections, for the --parents option. This is done
267 after all copying has been completed, to allow permissions
268 that don't include user write/execute.
270 SRC_OFFSET is the index in CONST_DST_NAME of the beginning of the
271 source directory name.
273 ATTR_LIST is a null-terminated linked list of structures that
274 indicates the end of the filename of each intermediate directory
275 in CONST_DST_NAME that may need to have its attributes changed.
276 The command 'cp --parents --preserve a/b/c d/e_dir' changes the
277 attributes of the directories d/e_dir/a and d/e_dir/a/b to match
278 the corresponding source directories regardless of whether they
279 existed before the 'cp' command was given.
281 Return true if the parent of CONST_DST_NAME and any intermediate
282 directories specified by ATTR_LIST have the proper permissions
283 when done. */
285 static bool
286 re_protect (char const *const_dst_name, size_t src_offset,
287 struct dir_attr *attr_list, const struct cp_options *x)
289 struct dir_attr *p;
290 char *dst_name; /* A copy of CONST_DST_NAME we can change. */
291 char *src_name; /* The source name in 'dst_name'. */
293 ASSIGN_STRDUPA (dst_name, const_dst_name);
294 src_name = dst_name + src_offset;
296 for (p = attr_list; p; p = p->next)
298 dst_name[p->slash_offset] = '\0';
300 /* Adjust the times (and if possible, ownership) for the copy.
301 chown turns off set[ug]id bits for non-root,
302 so do the chmod last. */
304 if (x->preserve_timestamps)
306 struct timespec timespec[2];
308 timespec[0] = get_stat_atime (&p->st);
309 timespec[1] = get_stat_mtime (&p->st);
311 if (utimens (dst_name, timespec))
313 error (0, errno, _("failed to preserve times for %s"),
314 quoteaf (dst_name));
315 return false;
319 if (x->preserve_ownership)
321 if (lchown (dst_name, p->st.st_uid, p->st.st_gid) != 0)
323 if (! chown_failure_ok (x))
325 error (0, errno, _("failed to preserve ownership for %s"),
326 quoteaf (dst_name));
327 return false;
329 /* Failing to preserve ownership is OK. Still, try to preserve
330 the group, but ignore the possible error. */
331 ignore_value (lchown (dst_name, -1, p->st.st_gid));
335 if (x->preserve_mode)
337 if (copy_acl (src_name, -1, dst_name, -1, p->st.st_mode) != 0)
338 return false;
340 else if (p->restore_mode)
342 if (lchmod (dst_name, p->st.st_mode) != 0)
344 error (0, errno, _("failed to preserve permissions for %s"),
345 quoteaf (dst_name));
346 return false;
350 dst_name[p->slash_offset] = '/';
352 return true;
355 /* Ensure that the parent directory of CONST_DIR exists, for
356 the --parents option.
358 SRC_OFFSET is the index in CONST_DIR (which is a destination
359 directory) of the beginning of the source directory name.
360 Create any leading directories that don't already exist.
361 If VERBOSE_FMT_STRING is nonzero, use it as a printf format
362 string for printing a message after successfully making a directory.
363 The format should take two string arguments: the names of the
364 source and destination directories.
365 Creates a linked list of attributes of intermediate directories,
366 *ATTR_LIST, for re_protect to use after calling copy.
367 Sets *NEW_DST if this function creates parent of CONST_DIR.
369 Return true if parent of CONST_DIR exists as a directory with the proper
370 permissions when done. */
372 /* FIXME: Synch this function with the one in ../lib/mkdir-p.c. */
374 static bool
375 make_dir_parents_private (char const *const_dir, size_t src_offset,
376 char const *verbose_fmt_string,
377 struct dir_attr **attr_list, bool *new_dst,
378 const struct cp_options *x)
380 struct stat stats;
381 char *dir; /* A copy of CONST_DIR we can change. */
382 char *src; /* Source name in DIR. */
383 char *dst_dir; /* Leading directory of DIR. */
384 size_t dirlen; /* Length of DIR. */
386 ASSIGN_STRDUPA (dir, const_dir);
388 src = dir + src_offset;
390 dirlen = dir_len (dir);
391 dst_dir = alloca (dirlen + 1);
392 memcpy (dst_dir, dir, dirlen);
393 dst_dir[dirlen] = '\0';
395 *attr_list = NULL;
397 if (stat (dst_dir, &stats) != 0)
399 /* A parent of CONST_DIR does not exist.
400 Make all missing intermediate directories. */
401 char *slash;
403 slash = src;
404 while (*slash == '/')
405 slash++;
406 while ((slash = strchr (slash, '/')))
408 struct dir_attr *new IF_LINT ( = NULL);
409 bool missing_dir;
411 *slash = '\0';
412 missing_dir = (stat (dir, &stats) != 0);
414 if (missing_dir || x->preserve_ownership || x->preserve_mode
415 || x->preserve_timestamps)
417 /* Add this directory to the list of directories whose
418 modes might need fixing later. */
419 struct stat src_st;
420 int src_errno = (stat (src, &src_st) != 0
421 ? errno
422 : S_ISDIR (src_st.st_mode)
424 : ENOTDIR);
425 if (src_errno)
427 error (0, src_errno, _("failed to get attributes of %s"),
428 quoteaf (src));
429 return false;
432 new = xmalloc (sizeof *new);
433 new->st = src_st;
434 new->slash_offset = slash - dir;
435 new->restore_mode = false;
436 new->next = *attr_list;
437 *attr_list = new;
440 if (missing_dir)
442 mode_t src_mode;
443 mode_t omitted_permissions;
444 mode_t mkdir_mode;
446 /* This component does not exist. We must set
447 *new_dst and new->st.st_mode inside this loop because,
448 for example, in the command 'cp --parents ../a/../b/c e_dir',
449 make_dir_parents_private creates only e_dir/../a if
450 ./b already exists. */
451 *new_dst = true;
452 src_mode = new->st.st_mode;
454 /* If the ownership or special mode bits might change,
455 omit some permissions at first, so unauthorized users
456 cannot nip in before the file is ready. */
457 omitted_permissions = (src_mode
458 & (x->preserve_ownership
459 ? S_IRWXG | S_IRWXO
460 : x->preserve_mode
461 ? S_IWGRP | S_IWOTH
462 : 0));
464 /* POSIX says mkdir's behavior is implementation-defined when
465 (src_mode & ~S_IRWXUGO) != 0. However, common practice is
466 to ask mkdir to copy all the CHMOD_MODE_BITS, letting mkdir
467 decide what to do with S_ISUID | S_ISGID | S_ISVTX. */
468 mkdir_mode = x->explicit_no_preserve_mode ? S_IRWXUGO : src_mode;
469 mkdir_mode &= CHMOD_MODE_BITS & ~omitted_permissions;
470 if (mkdir (dir, mkdir_mode) != 0)
472 error (0, errno, _("cannot make directory %s"),
473 quoteaf (dir));
474 return false;
476 else
478 if (verbose_fmt_string != NULL)
479 printf (verbose_fmt_string, src, dir);
482 /* We need search and write permissions to the new directory
483 for writing the directory's contents. Check if these
484 permissions are there. */
486 if (lstat (dir, &stats))
488 error (0, errno, _("failed to get attributes of %s"),
489 quoteaf (dir));
490 return false;
494 if (! x->preserve_mode)
496 if (omitted_permissions & ~stats.st_mode)
497 omitted_permissions &= ~ cached_umask ();
498 if (omitted_permissions & ~stats.st_mode
499 || (stats.st_mode & S_IRWXU) != S_IRWXU)
501 new->st.st_mode = stats.st_mode | omitted_permissions;
502 new->restore_mode = true;
506 if ((stats.st_mode & S_IRWXU) != S_IRWXU)
508 /* Make the new directory searchable and writable.
509 The original permissions will be restored later. */
511 if (lchmod (dir, stats.st_mode | S_IRWXU) != 0)
513 error (0, errno, _("setting permissions for %s"),
514 quoteaf (dir));
515 return false;
519 else if (!S_ISDIR (stats.st_mode))
521 error (0, 0, _("%s exists but is not a directory"),
522 quoteaf (dir));
523 return false;
525 else
526 *new_dst = false;
527 *slash++ = '/';
529 /* Avoid unnecessary calls to 'stat' when given
530 file names containing multiple adjacent slashes. */
531 while (*slash == '/')
532 slash++;
536 /* We get here if the parent of DIR already exists. */
538 else if (!S_ISDIR (stats.st_mode))
540 error (0, 0, _("%s exists but is not a directory"), quoteaf (dst_dir));
541 return false;
543 else
545 *new_dst = false;
547 return true;
550 /* FILE is the last operand of this command.
551 Return true if FILE is a directory.
552 But report an error and exit if there is a problem accessing FILE,
553 or if FILE does not exist but would have to refer to an existing
554 directory if it referred to anything at all.
556 If the file exists, store the file's status into *ST.
557 Otherwise, set *NEW_DST. */
559 static bool
560 target_directory_operand (char const *file, struct stat *st, bool *new_dst)
562 int err = (stat (file, st) == 0 ? 0 : errno);
563 bool is_a_dir = !err && S_ISDIR (st->st_mode);
564 if (err)
566 if (err != ENOENT)
567 die (EXIT_FAILURE, err, _("failed to access %s"), quoteaf (file));
568 *new_dst = true;
570 return is_a_dir;
573 /* Scan the arguments, and copy each by calling copy.
574 Return true if successful. */
576 static bool
577 do_copy (int n_files, char **file, const char *target_directory,
578 bool no_target_directory, struct cp_options *x)
580 struct stat sb;
581 bool new_dst = false;
582 bool ok = true;
584 if (n_files <= !target_directory)
586 if (n_files <= 0)
587 error (0, 0, _("missing file operand"));
588 else
589 error (0, 0, _("missing destination file operand after %s"),
590 quoteaf (file[0]));
591 usage (EXIT_FAILURE);
594 if (no_target_directory)
596 if (target_directory)
597 die (EXIT_FAILURE, 0,
598 _("cannot combine --target-directory (-t) "
599 "and --no-target-directory (-T)"));
600 if (2 < n_files)
602 error (0, 0, _("extra operand %s"), quoteaf (file[2]));
603 usage (EXIT_FAILURE);
605 /* Update NEW_DST and SB, which may be checked below. */
606 ignore_value (target_directory_operand (file[n_files -1], &sb, &new_dst));
608 else if (!target_directory)
610 if (2 <= n_files
611 && target_directory_operand (file[n_files - 1], &sb, &new_dst))
612 target_directory = file[--n_files];
613 else if (2 < n_files)
614 die (EXIT_FAILURE, 0, _("target %s is not a directory"),
615 quoteaf (file[n_files - 1]));
618 if (target_directory)
620 /* cp file1...filen edir
621 Copy the files 'file1' through 'filen'
622 to the existing directory 'edir'. */
623 int i;
625 /* Initialize these hash tables only if we'll need them.
626 The problems they're used to detect can arise only if
627 there are two or more files to copy. */
628 if (2 <= n_files)
630 dest_info_init (x);
631 src_info_init (x);
634 for (i = 0; i < n_files; i++)
636 char *dst_name;
637 bool parent_exists = true; /* True if dir_name (dst_name) exists. */
638 struct dir_attr *attr_list;
639 char *arg_in_concat = NULL;
640 char *arg = file[i];
642 /* Trailing slashes are meaningful (i.e., maybe worth preserving)
643 only in the source file names. */
644 if (remove_trailing_slashes)
645 strip_trailing_slashes (arg);
647 if (parents_option)
649 char *arg_no_trailing_slash;
651 /* Use 'arg' without trailing slashes in constructing destination
652 file names. Otherwise, we can end up trying to create a
653 directory via 'mkdir ("dst/foo/"...', which is not portable.
654 It fails, due to the trailing slash, on at least
655 NetBSD 1.[34] systems. */
656 ASSIGN_STRDUPA (arg_no_trailing_slash, arg);
657 strip_trailing_slashes (arg_no_trailing_slash);
659 /* Append all of 'arg' (minus any trailing slash) to 'dest'. */
660 dst_name = file_name_concat (target_directory,
661 arg_no_trailing_slash,
662 &arg_in_concat);
664 /* For --parents, we have to make sure that the directory
665 dir_name (dst_name) exists. We may have to create a few
666 leading directories. */
667 parent_exists =
668 (make_dir_parents_private
669 (dst_name, arg_in_concat - dst_name,
670 (x->verbose ? "%s -> %s\n" : NULL),
671 &attr_list, &new_dst, x));
673 else
675 char *arg_base;
676 /* Append the last component of 'arg' to 'target_directory'. */
678 ASSIGN_BASENAME_STRDUPA (arg_base, arg);
679 /* For 'cp -R source/.. dest', don't copy into 'dest/..'. */
680 dst_name = (STREQ (arg_base, "..")
681 ? xstrdup (target_directory)
682 : file_name_concat (target_directory, arg_base,
683 NULL));
686 if (!parent_exists)
688 /* make_dir_parents_private failed, so don't even
689 attempt the copy. */
690 ok = false;
692 else
694 bool copy_into_self;
695 ok &= copy (arg, dst_name, new_dst, x, &copy_into_self, NULL);
697 if (parents_option)
698 ok &= re_protect (dst_name, arg_in_concat - dst_name,
699 attr_list, x);
702 if (parents_option)
704 while (attr_list)
706 struct dir_attr *p = attr_list;
707 attr_list = attr_list->next;
708 free (p);
712 free (dst_name);
715 else /* !target_directory */
717 char const *new_dest;
718 char const *source = file[0];
719 char const *dest = file[1];
720 bool unused;
722 if (parents_option)
724 error (0, 0,
725 _("with --parents, the destination must be a directory"));
726 usage (EXIT_FAILURE);
729 /* When the force and backup options have been specified and
730 the source and destination are the same name for an existing
731 regular file, convert the user's command, e.g.,
732 'cp --force --backup foo foo' to 'cp --force foo fooSUFFIX'
733 where SUFFIX is determined by any version control options used. */
735 if (x->unlink_dest_after_failed_open
736 && x->backup_type != no_backups
737 && STREQ (source, dest)
738 && !new_dst && S_ISREG (sb.st_mode))
740 static struct cp_options x_tmp;
742 new_dest = find_backup_file_name (dest, x->backup_type);
743 /* Set x->backup_type to 'no_backups' so that the normal backup
744 mechanism is not used when performing the actual copy.
745 backup_type must be set to 'no_backups' only *after* the above
746 call to find_backup_file_name -- that function uses
747 backup_type to determine the suffix it applies. */
748 x_tmp = *x;
749 x_tmp.backup_type = no_backups;
750 x = &x_tmp;
752 else
754 new_dest = dest;
757 ok = copy (source, new_dest, 0, x, &unused, NULL);
760 return ok;
763 static void
764 cp_option_init (struct cp_options *x)
766 cp_options_default (x);
767 x->copy_as_regular = true;
768 x->dereference = DEREF_UNDEFINED;
769 x->unlink_dest_before_opening = false;
770 x->unlink_dest_after_failed_open = false;
771 x->hard_link = false;
772 x->interactive = I_UNSPECIFIED;
773 x->move_mode = false;
774 x->install_mode = false;
775 x->one_file_system = false;
776 x->reflink_mode = REFLINK_NEVER;
778 x->preserve_ownership = false;
779 x->preserve_links = false;
780 x->preserve_mode = false;
781 x->preserve_timestamps = false;
782 x->explicit_no_preserve_mode = false;
783 x->preserve_security_context = false; /* -a or --preserve=context. */
784 x->require_preserve_context = false; /* --preserve=context. */
785 x->set_security_context = false; /* -Z, set sys default context. */
786 x->preserve_xattr = false;
787 x->reduce_diagnostics = false;
788 x->require_preserve_xattr = false;
790 x->data_copy_required = true;
791 x->require_preserve = false;
792 x->recursive = false;
793 x->sparse_mode = SPARSE_AUTO;
794 x->symbolic_link = false;
795 x->set_mode = false;
796 x->mode = 0;
798 /* Not used. */
799 x->stdin_tty = false;
801 x->update = false;
802 x->verbose = false;
804 /* By default, refuse to open a dangling destination symlink, because
805 in general one cannot do that safely, give the current semantics of
806 open's O_EXCL flag, (which POSIX doesn't even allow cp to use, btw).
807 But POSIX requires it. */
808 x->open_dangling_dest_symlink = getenv ("POSIXLY_CORRECT") != NULL;
810 x->dest_info = NULL;
811 x->src_info = NULL;
814 /* Given a string, ARG, containing a comma-separated list of arguments
815 to the --preserve option, set the appropriate fields of X to ON_OFF. */
816 static void
817 decode_preserve_arg (char const *arg, struct cp_options *x, bool on_off)
819 enum File_attribute
821 PRESERVE_MODE,
822 PRESERVE_TIMESTAMPS,
823 PRESERVE_OWNERSHIP,
824 PRESERVE_LINK,
825 PRESERVE_CONTEXT,
826 PRESERVE_XATTR,
827 PRESERVE_ALL
829 static enum File_attribute const preserve_vals[] =
831 PRESERVE_MODE, PRESERVE_TIMESTAMPS,
832 PRESERVE_OWNERSHIP, PRESERVE_LINK, PRESERVE_CONTEXT, PRESERVE_XATTR,
833 PRESERVE_ALL
835 /* Valid arguments to the '--preserve' option. */
836 static char const* const preserve_args[] =
838 "mode", "timestamps",
839 "ownership", "links", "context", "xattr", "all", NULL
841 ARGMATCH_VERIFY (preserve_args, preserve_vals);
843 char *arg_writable = xstrdup (arg);
844 char *s = arg_writable;
847 /* find next comma */
848 char *comma = strchr (s, ',');
849 enum File_attribute val;
851 /* If we found a comma, put a NUL in its place and advance. */
852 if (comma)
853 *comma++ = 0;
855 /* process S. */
856 val = XARGMATCH (on_off ? "--preserve" : "--no-preserve",
857 s, preserve_args, preserve_vals);
858 switch (val)
860 case PRESERVE_MODE:
861 x->preserve_mode = on_off;
862 x->explicit_no_preserve_mode = !on_off;
863 break;
865 case PRESERVE_TIMESTAMPS:
866 x->preserve_timestamps = on_off;
867 break;
869 case PRESERVE_OWNERSHIP:
870 x->preserve_ownership = on_off;
871 break;
873 case PRESERVE_LINK:
874 x->preserve_links = on_off;
875 break;
877 case PRESERVE_CONTEXT:
878 x->require_preserve_context = on_off;
879 x->preserve_security_context = on_off;
880 break;
882 case PRESERVE_XATTR:
883 x->preserve_xattr = on_off;
884 x->require_preserve_xattr = on_off;
885 break;
887 case PRESERVE_ALL:
888 x->preserve_mode = on_off;
889 x->preserve_timestamps = on_off;
890 x->preserve_ownership = on_off;
891 x->preserve_links = on_off;
892 x->explicit_no_preserve_mode = !on_off;
893 if (selinux_enabled)
894 x->preserve_security_context = on_off;
895 x->preserve_xattr = on_off;
896 break;
898 default:
899 abort ();
901 s = comma;
903 while (s);
905 free (arg_writable);
909 main (int argc, char **argv)
911 int c;
912 bool ok;
913 bool make_backups = false;
914 char *version_control_string = NULL;
915 struct cp_options x;
916 bool copy_contents = false;
917 char *target_directory = NULL;
918 bool no_target_directory = false;
919 char const *scontext = NULL;
921 initialize_main (&argc, &argv);
922 set_program_name (argv[0]);
923 setlocale (LC_ALL, "");
924 bindtextdomain (PACKAGE, LOCALEDIR);
925 textdomain (PACKAGE);
927 atexit (close_stdin);
929 selinux_enabled = (0 < is_selinux_enabled ());
930 cp_option_init (&x);
932 while ((c = getopt_long (argc, argv, "abdfHilLnprst:uvxPRS:TZ",
933 long_opts, NULL))
934 != -1)
936 switch (c)
938 case SPARSE_OPTION:
939 x.sparse_mode = XARGMATCH ("--sparse", optarg,
940 sparse_type_string, sparse_type);
941 break;
943 case REFLINK_OPTION:
944 if (optarg == NULL)
945 x.reflink_mode = REFLINK_ALWAYS;
946 else
947 x.reflink_mode = XARGMATCH ("--reflink", optarg,
948 reflink_type_string, reflink_type);
949 break;
951 case 'a':
952 /* Like -dR --preserve=all with reduced failure diagnostics. */
953 x.dereference = DEREF_NEVER;
954 x.preserve_links = true;
955 x.preserve_ownership = true;
956 x.preserve_mode = true;
957 x.preserve_timestamps = true;
958 x.require_preserve = true;
959 if (selinux_enabled)
960 x.preserve_security_context = true;
961 x.preserve_xattr = true;
962 x.reduce_diagnostics = true;
963 x.recursive = true;
964 break;
966 case 'b':
967 make_backups = true;
968 if (optarg)
969 version_control_string = optarg;
970 break;
972 case ATTRIBUTES_ONLY_OPTION:
973 x.data_copy_required = false;
974 break;
976 case COPY_CONTENTS_OPTION:
977 copy_contents = true;
978 break;
980 case 'd':
981 x.preserve_links = true;
982 x.dereference = DEREF_NEVER;
983 break;
985 case 'f':
986 x.unlink_dest_after_failed_open = true;
987 break;
989 case 'H':
990 x.dereference = DEREF_COMMAND_LINE_ARGUMENTS;
991 break;
993 case 'i':
994 x.interactive = I_ASK_USER;
995 break;
997 case 'l':
998 x.hard_link = true;
999 break;
1001 case 'L':
1002 x.dereference = DEREF_ALWAYS;
1003 break;
1005 case 'n':
1006 x.interactive = I_ALWAYS_NO;
1007 break;
1009 case 'P':
1010 x.dereference = DEREF_NEVER;
1011 break;
1013 case NO_PRESERVE_ATTRIBUTES_OPTION:
1014 decode_preserve_arg (optarg, &x, false);
1015 break;
1017 case PRESERVE_ATTRIBUTES_OPTION:
1018 if (optarg == NULL)
1020 /* Fall through to the case for 'p' below. */
1022 else
1024 decode_preserve_arg (optarg, &x, true);
1025 x.require_preserve = true;
1026 break;
1028 /* fall through */
1030 case 'p':
1031 x.preserve_ownership = true;
1032 x.preserve_mode = true;
1033 x.preserve_timestamps = true;
1034 x.require_preserve = true;
1035 break;
1037 case PARENTS_OPTION:
1038 parents_option = true;
1039 break;
1041 case 'r':
1042 case 'R':
1043 x.recursive = true;
1044 break;
1046 case UNLINK_DEST_BEFORE_OPENING:
1047 x.unlink_dest_before_opening = true;
1048 break;
1050 case STRIP_TRAILING_SLASHES_OPTION:
1051 remove_trailing_slashes = true;
1052 break;
1054 case 's':
1055 x.symbolic_link = true;
1056 break;
1058 case 't':
1059 if (target_directory)
1060 die (EXIT_FAILURE, 0,
1061 _("multiple target directories specified"));
1062 else
1064 struct stat st;
1065 if (stat (optarg, &st) != 0)
1066 die (EXIT_FAILURE, errno, _("failed to access %s"),
1067 quoteaf (optarg));
1068 if (! S_ISDIR (st.st_mode))
1069 die (EXIT_FAILURE, 0, _("target %s is not a directory"),
1070 quoteaf (optarg));
1072 target_directory = optarg;
1073 break;
1075 case 'T':
1076 no_target_directory = true;
1077 break;
1079 case 'u':
1080 x.update = true;
1081 break;
1083 case 'v':
1084 x.verbose = true;
1085 break;
1087 case 'x':
1088 x.one_file_system = true;
1089 break;
1091 case 'Z':
1092 /* politely decline if we're not on a selinux-enabled kernel. */
1093 if (selinux_enabled)
1095 if (optarg)
1096 scontext = optarg;
1097 else
1098 x.set_security_context = true;
1100 else if (optarg)
1102 error (0, 0,
1103 _("warning: ignoring --context; "
1104 "it requires an SELinux-enabled kernel"));
1106 break;
1108 case 'S':
1109 make_backups = true;
1110 simple_backup_suffix = optarg;
1111 break;
1113 case_GETOPT_HELP_CHAR;
1115 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1117 default:
1118 usage (EXIT_FAILURE);
1122 if (x.hard_link && x.symbolic_link)
1124 error (0, 0, _("cannot make both hard and symbolic links"));
1125 usage (EXIT_FAILURE);
1128 if (make_backups && x.interactive == I_ALWAYS_NO)
1130 error (0, 0,
1131 _("options --backup and --no-clobber are mutually exclusive"));
1132 usage (EXIT_FAILURE);
1135 if (x.reflink_mode == REFLINK_ALWAYS && x.sparse_mode != SPARSE_AUTO)
1137 error (0, 0, _("--reflink can be used only with --sparse=auto"));
1138 usage (EXIT_FAILURE);
1141 x.backup_type = (make_backups
1142 ? xget_version (_("backup type"),
1143 version_control_string)
1144 : no_backups);
1146 if (x.dereference == DEREF_UNDEFINED)
1148 if (x.recursive && ! x.hard_link)
1149 /* This is compatible with FreeBSD. */
1150 x.dereference = DEREF_NEVER;
1151 else
1152 x.dereference = DEREF_ALWAYS;
1155 if (x.recursive)
1156 x.copy_as_regular = copy_contents;
1158 /* If --force (-f) was specified and we're in link-creation mode,
1159 first remove any existing destination file. */
1160 if (x.unlink_dest_after_failed_open && (x.hard_link || x.symbolic_link))
1161 x.unlink_dest_before_opening = true;
1163 /* Ensure -Z overrides -a. */
1164 if ((x.set_security_context || scontext)
1165 && ! x.require_preserve_context)
1166 x.preserve_security_context = false;
1168 if (x.preserve_security_context && (x.set_security_context || scontext))
1169 die (EXIT_FAILURE, 0,
1170 _("cannot set target context and preserve it"));
1172 if (x.require_preserve_context && ! selinux_enabled)
1173 die (EXIT_FAILURE, 0,
1174 _("cannot preserve security context "
1175 "without an SELinux-enabled kernel"));
1177 /* FIXME: This handles new files. But what about existing files?
1178 I.e., if updating a tree, new files would have the specified context,
1179 but shouldn't existing files be updated for consistency like this?
1180 if (scontext)
1181 restorecon (dst_path, 0, true);
1183 if (scontext && setfscreatecon (se_const (scontext)) < 0)
1184 die (EXIT_FAILURE, errno,
1185 _("failed to set default file creation context to %s"),
1186 quote (scontext));
1188 #if !USE_XATTR
1189 if (x.require_preserve_xattr)
1190 die (EXIT_FAILURE, 0, _("cannot preserve extended attributes, cp is "
1191 "built without xattr support"));
1192 #endif
1194 /* Allocate space for remembering copied and created files. */
1196 hash_init ();
1198 ok = do_copy (argc - optind, argv + optind,
1199 target_directory, no_target_directory, &x);
1201 #ifdef lint
1202 forget_all ();
1203 #endif
1205 return ok ? EXIT_SUCCESS : EXIT_FAILURE;