2 * Copyright (c) 2010, Frank Lahm <franklahm@googlemail.com>
3 * Copyright (c) 1988, 1993, 1994
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from software contributed to Berkeley by
7 * David Hitz of Auspex Systems Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Cp copies source files to target files.
37 * The global PATH_T structure "to" always contains the path to the
38 * current target file. Since fts(3) does not change directories,
39 * this path can be either absolute or dot-relative.
41 * The basic algorithm is to initialize "to" and use fts(3) to traverse
42 * the file hierarchy rooted in the argument list. A trivial case is the
43 * case of 'cp file1 file2'. The more interesting case is the case of
44 * 'cp file1 file2 ... fileN dir' where the hierarchy is traversed and the
45 * path (relative to the root of the traversal) is appended to dir (stored
46 * in "to") to form the final target path.
51 #endif /* HAVE_CONFIG_H */
53 #include <sys/types.h>
63 #include <atalk/ftw.h>
64 #include <atalk/adouble.h>
65 #include <atalk/vfs.h>
66 #include <atalk/util.h>
67 #include <atalk/unix.h>
68 #include <atalk/volume.h>
69 #include <atalk/volinfo.h>
70 #include <atalk/bstrlib.h>
71 #include <atalk/bstradd.h>
72 #include <atalk/queue.h>
76 #define STRIP_TRAILING_SLASH(p) { \
77 while ((p).p_end > (p).p_path + 1 && (p).p_end[-1] == '/') \
81 static char emptystring[] = "";
83 PATH_T to = { to.p_path, emptystring, "" };
84 enum op { FILE_TO_FILE, FILE_TO_DIR, DIR_TO_DNE };
86 int fflag, iflag, lflag, nflag, pflag, vflag;
89 cnid_t ppdid, pdid, did; /* current dir CNID and parent did*/
91 static afpvol_t svolume, dvolume;
94 volatile sig_atomic_t sigint;
95 static int badcp, rval;
96 static int ftw_options = FTW_MOUNT | FTW_PHYS | FTW_ACTIONRETVAL;
98 static char *netatalk_dirs[] = {
105 /* Forward declarations */
106 static int copy(const char *fpath, const struct stat *sb, int tflag, struct FTW *ftwbuf);
107 static void siginfo(int _U_);
108 static int ftw_copy_file(const struct FTW *, const char *, const struct stat *, int);
109 static int ftw_copy_link(const struct FTW *, const char *, const struct stat *, int);
110 static int setfile(const struct stat *, int);
111 static int preserve_dir_acls(const struct stat *, char *, char *);
112 static int preserve_fd_acls(int, int);
115 Check for netatalk special folders e.g. ".AppleDB" or ".AppleDesktop"
116 Returns pointer to name or NULL.
118 static const char *check_netatalk_dirs(const char *name)
122 for (c=0; netatalk_dirs[c]; c++) {
123 if ((strcmp(name, netatalk_dirs[c])) == 0)
124 return netatalk_dirs[c];
129 static void upfunc(void)
135 static void usage_cp(void)
138 "Usage: ad cp [-R [-P]] [-pvf] <source_file> <target_file>\n"
139 "Usage: ad cp [-R [-P]] [-pvfx] <source_file [source_file ...]> <target_directory>\n"
144 int ad_cp(int argc, char *argv[])
146 struct stat to_stat, tmp_stat;
147 int r, ch, have_trailing_slash;
154 ppdid = pdid = htonl(1);
157 while ((ch = getopt(argc, argv, "Rafilnpvx")) != -1)
188 ftw_options |= FTW_MOUNT;
200 (void)signal(SIGINT, siginfo);
204 /* Save the target base in "to". */
205 target = argv[--argc];
206 if ((strlcpy(to.p_path, target, PATH_MAX)) >= PATH_MAX)
207 ERROR("%s: name too long", target);
209 to.p_end = to.p_path + strlen(to.p_path);
210 if (to.p_path == to.p_end) {
214 have_trailing_slash = (to.p_end[-1] == '/');
215 if (have_trailing_slash)
216 STRIP_TRAILING_SLASH(to);
217 to.target_end = to.p_end;
219 /* Set end of argument list */
223 * Cp has two distinct cases:
225 * cp [-R] source target
226 * cp [-R] source1 ... sourceN directory
228 * In both cases, source can be either a file or a directory.
230 * In (1), the target becomes a copy of the source. That is, if the
231 * source is a file, the target will be a file, and likewise for
234 * In (2), the real target is not directory, but "directory/source".
236 r = stat(to.p_path, &to_stat);
237 if (r == -1 && errno != ENOENT)
238 ERROR("%s", to.p_path);
239 if (r == -1 || !S_ISDIR(to_stat.st_mode)) {
241 * Case (1). Target is not a directory.
244 ERROR("%s is not a directory", to.p_path);
247 * Need to detect the case:
249 * Where dir is a directory and foo does not exist, where
250 * we want pathname concatenations turned on but not for
251 * the initial mkdir().
254 lstat(*argv, &tmp_stat);
256 if (S_ISDIR(tmp_stat.st_mode) && Rflag)
263 if (have_trailing_slash && type == FILE_TO_FILE) {
265 ERROR("directory %s does not exist", to.p_path);
267 ERROR("%s is not a directory", to.p_path);
271 * Case (2). Target is a directory.
276 * Keep an inverted copy of the umask, for use in correcting
277 * permissions on created directories when not using -p.
283 /* Inhereting perms in ad_mkdir etc requires this */
287 /* Load .volinfo file for destination*/
288 openvol(to.p_path, &dvolume);
290 for (int i = 0; argv[i] != NULL; i++) {
291 /* Load .volinfo file for source */
292 openvol(argv[i], &svolume);
294 if (nftw(argv[i], copy, upfunc, 20, ftw_options) == -1) {
295 ERROR("%s: %s", argv[i], strerror(errno));
304 static int copy(const char *path,
305 const struct stat *statp,
317 const char *dir = strrchr(path, '/');
322 if (check_netatalk_dirs(dir) != NULL) {
323 SLOG("Skipping Netatalk dir %s", path);
324 return FTW_SKIP_SUBTREE;
328 * If we are in case (2) above, we need to append the
329 * source name to the target name.
331 if (type != FILE_TO_FILE) {
333 * Need to remember the roots of traversals to create
334 * correct pathnames. If there's a directory being
335 * copied to a non-existent directory, e.g.
336 * cp -R a/dir noexist
337 * the resulting path name should be noexist/foo, not
338 * noexist/dir/foo (where foo is a file in dir), which
339 * is the case where the target exists.
341 * Also, check for "..". This is for correct path
342 * concatenation for paths ending in "..", e.g.
344 * Paths ending in ".." are changed to ".". This is
345 * tricky, but seems the easiest way to fix the problem.
348 * Since the first level MUST be FTS_ROOTLEVEL, base
349 * is always initialized.
351 if (ftw->level == 0) {
352 if (type != DIR_TO_DNE) {
355 if (strcmp(&path[base], "..") == 0)
362 nlen = strlen(path) - base;
363 target_mid = to.target_end;
364 if (*p != '/' && target_mid[-1] != '/')
367 if (target_mid - to.p_path + nlen >= PATH_MAX) {
368 SLOG("%s%s: name too long (not copied)", to.p_path, p);
372 (void)strncat(target_mid, p, nlen);
373 to.p_end = target_mid + nlen;
375 STRIP_TRAILING_SLASH(to);
378 /* Not an error but need to remember it happened */
379 if (stat(to.p_path, &to_stat) == -1)
382 if (to_stat.st_dev == statp->st_dev &&
383 to_stat.st_ino == statp->st_ino) {
384 SLOG("%s and %s are identical (not copied).",
387 if (S_ISDIR(statp->st_mode))
388 /* without using glibc extension FTW_ACTIONRETVAL cant handle this */
391 if (!S_ISDIR(statp->st_mode) &&
392 S_ISDIR(to_stat.st_mode)) {
393 SLOG("cannot overwrite directory %s with "
402 switch (statp->st_mode & S_IFMT) {
404 if (ftw_copy_link(ftw, path, statp, !dne))
409 SLOG("%s is a directory", path);
414 * If the directory doesn't exist, create the new
415 * one with the from file mode plus owner RWX bits,
416 * modified by the umask. Trade-off between being
417 * able to write the directory (if from directory is
418 * 555) and not causing a permissions race. If the
419 * umask blocks owner writes, we fail..
422 if (mkdir(to.p_path, statp->st_mode | S_IRWXU) < 0)
423 ERROR("mkdir: %s: %s", to.p_path, strerror(errno));
424 } else if (!S_ISDIR(to_stat.st_mode)) {
426 ERROR("%s", to.p_path);
429 /* Create ad dir and copy ".Parent" */
430 if (dvolume.volinfo.v_path && dvolume.volinfo.v_adouble == AD_VERSION2) {
431 /* Create ".AppleDouble" dir */
432 mode_t omask = umask(0);
433 bstring addir = bfromcstr(to.p_path);
434 bcatcstr(addir, "/.AppleDouble");
435 mkdir(cfrombstr(addir), 02777);
437 if (svolume.volinfo.v_path && svolume.volinfo.v_adouble == AD_VERSION2) {
438 /* copy ".Parent" file */
439 bcatcstr(addir, "/.Parent");
440 bstring sdir = bfromcstr(path);
441 bcatcstr(sdir, "/.AppleDouble/.Parent");
442 if (copy_file(-1, cfrombstr(sdir), cfrombstr(addir), 0666) != 0) {
443 SLOG("Error copying %s -> %s", cfrombstr(sdir), cfrombstr(addir));
451 /* Get CNID of Parent and add new childir to CNID database */
454 did = cnid_for_path(&dvolume.volinfo, &dvolume.volume, to.p_path);
455 SLOG("got CNID: %u for path: %s", ntohl(did), to.p_path);
459 if (stat(to.p_path, &st) != 0) {
463 ad_init(&ad, dvolume.volinfo.v_adouble, dvolume.volinfo.v_ad_options);
464 if (ad_open_metadata(to.p_path, ADFLAGS_DIR, O_RDWR | O_CREAT, &ad) != 0) {
465 ERROR("Error opening adouble for: %s", to.p_path);
467 ad_setid( &ad, st.st_dev, st.st_ino, did, pdid, dvolume.db_stamp);
468 ad_setname(&ad, utompath(&dvolume.volinfo, path + ftw->base));
470 ad_close_metadata(&ad);
476 if (setfile(statp, -1))
479 if (preserve_dir_acls(statp, curr->fts_accpath, to.p_path) != 0)
487 SLOG("%s is a device file (not copied).", path);
490 SLOG("%s is a socket (not copied).", path);
493 SLOG("%s is a FIFO (not copied).", path);
496 if (ftw_copy_file(ftw, path, statp, dne))
499 if (dvolume.volinfo.v_path && dvolume.volinfo.v_adouble == AD_VERSION2) {
501 SLOG("ad for file: %s", to.p_path);
502 mode_t omask = umask(0);
503 if (svolume.volinfo.v_path && svolume.volinfo.v_adouble == AD_VERSION2) {
505 if (dvolume.volume.vfs->vfs_copyfile(&dvolume.volume, -1, path, to.p_path))
509 /* Get CNID of Parent and add new childir to CNID database */
510 cnid_t cnid = cnid_for_path(&dvolume.volinfo, &dvolume.volume, to.p_path);
511 SLOG("got CNID: %u for path: %s", ntohl(cnid), to.p_path);
515 if (stat(to.p_path, &st) != 0) {
519 ad_init(&ad, dvolume.volinfo.v_adouble, dvolume.volinfo.v_ad_options);
520 if (ad_open_metadata(to.p_path, 0, O_RDWR | O_CREAT, &ad) != 0) {
521 ERROR("Error opening adouble for: %s", to.p_path);
523 ad_setid( &ad, st.st_dev, st.st_ino, cnid, did, dvolume.db_stamp);
524 ad_setname(&ad, utompath(&dvolume.volinfo, path + ftw->base));
526 ad_close_metadata(&ad);
532 (void)printf("%s -> %s\n", path, to.p_path);
537 static void siginfo(int sig _U_)
542 /* Memory strategy threshold, in pages: if physmem is larger then this, use a large buffer */
543 #define PHYSPAGES_THRESHOLD (32*1024)
545 /* Maximum buffer size in bytes - do not allow it to grow larger than this */
546 #define BUFSIZE_MAX (2*1024*1024)
548 /* Small (default) buffer size in bytes. It's inefficient for this to be smaller than MAXPHYS */
549 #define MAXPHYS (64 * 1024)
550 #define BUFSIZE_SMALL (MAXPHYS)
552 static int ftw_copy_file(const struct FTW *entp,
554 const struct stat *sp,
557 static char *buf = NULL;
558 static size_t bufsize;
562 int ch, checkch, from_fd = 0, rcount, rval, to_fd = 0;
566 if ((from_fd = open(spath, O_RDONLY, 0)) == -1) {
567 SLOG("%s: %s", spath, strerror(errno));
572 * If the file exists and we're interactive, verify with the user.
573 * If the file DNE, set the mode to be the from file, minus setuid
574 * bits, modified by the umask; arguably wrong, but it makes copying
575 * executables work right and it's been that way forever. (The
576 * other choice is 666 or'ed with the execute bits on the from file
577 * modified by the umask.)
580 #define YESNO "(y/n [n]) "
583 printf("%s not overwritten\n", to.p_path);
584 (void)close(from_fd);
587 (void)fprintf(stderr, "overwrite %s? %s",
589 checkch = ch = getchar();
590 while (ch != '\n' && ch != EOF)
592 if (checkch != 'y' && checkch != 'Y') {
593 (void)close(from_fd);
594 (void)fprintf(stderr, "not overwritten\n");
600 /* remove existing destination file name,
601 * create a new file */
602 (void)unlink(to.p_path);
603 (void)dvolume.volume.vfs->vfs_deletefile(&dvolume.volume, -1, to.p_path);
605 to_fd = open(to.p_path, O_WRONLY | O_TRUNC | O_CREAT,
606 sp->st_mode & ~(S_ISUID | S_ISGID));
609 /* overwrite existing destination file name */
610 to_fd = open(to.p_path, O_WRONLY | O_TRUNC, 0);
614 to_fd = open(to.p_path, O_WRONLY | O_TRUNC | O_CREAT,
615 sp->st_mode & ~(S_ISUID | S_ISGID));
619 SLOG("%s: %s", to.p_path, strerror(errno));
620 (void)close(from_fd);
628 * Mmap and write if less than 8M (the limit is so we don't totally
629 * trash memory on big files. This is really a minor hack, but it
630 * wins some CPU back.
631 * Some filesystems, such as smbnetfs, don't support mmap,
632 * so this is a best-effort attempt.
635 if (S_ISREG(sp->st_mode) && sp->st_size > 0 &&
636 sp->st_size <= 8 * 1024 * 1024 &&
637 (p = mmap(NULL, (size_t)sp->st_size, PROT_READ,
638 MAP_SHARED, from_fd, (off_t)0)) != MAP_FAILED) {
640 for (bufp = p, wresid = sp->st_size; ;
641 bufp += wcount, wresid -= (size_t)wcount) {
642 wcount = write(to_fd, bufp, wresid);
646 if (wcount >= (ssize_t)wresid)
649 if (wcount != (ssize_t)wresid) {
650 SLOG("%s: %s", to.p_path, strerror(errno));
653 /* Some systems don't unmap on close(2). */
654 if (munmap(p, sp->st_size) < 0) {
655 SLOG("%s: %s", spath, strerror(errno));
661 * Note that buf and bufsize are static. If
662 * malloc() fails, it will fail at the start
663 * and not copy only some files.
665 if (sysconf(_SC_PHYS_PAGES) >
667 bufsize = MIN(BUFSIZE_MAX, MAXPHYS * 8);
669 bufsize = BUFSIZE_SMALL;
670 buf = malloc(bufsize);
672 ERROR("Not enough memory");
676 while ((rcount = read(from_fd, buf, bufsize)) > 0) {
677 for (bufp = buf, wresid = rcount; ;
678 bufp += wcount, wresid -= wcount) {
679 wcount = write(to_fd, bufp, wresid);
683 if (wcount >= (ssize_t)wresid)
686 if (wcount != (ssize_t)wresid) {
687 SLOG("%s: %s", to.p_path, strerror(errno));
693 SLOG("%s: %s", spath, strerror(errno));
698 if (link(spath, to.p_path)) {
699 SLOG("%s", to.p_path);
705 * Don't remove the target even after an error. The target might
706 * not be a regular file, or its attributes might be important,
707 * or its contents might be irreplaceable. It would only be safe
708 * to remove it if we created it and its length is 0.
712 if (pflag && setfile(sp, to_fd))
714 if (pflag && preserve_fd_acls(from_fd, to_fd) != 0)
717 SLOG("%s: %s", to.p_path, strerror(errno));
722 (void)close(from_fd);
727 static int ftw_copy_link(const struct FTW *p,
729 const struct stat *sstp,
733 char llink[PATH_MAX];
735 if ((len = readlink(spath, llink, sizeof(llink) - 1)) == -1) {
736 SLOG("readlink: %s: %s", spath, strerror(errno));
740 if (exists && unlink(to.p_path)) {
741 SLOG("unlink: %s: %s", to.p_path, strerror(errno));
744 if (symlink(llink, to.p_path)) {
745 SLOG("symlink: %s: %s", llink, strerror(errno));
748 return (pflag ? setfile(sstp, -1) : 0);
751 static int setfile(const struct stat *fs, int fd)
753 static struct timeval tv[2];
755 int rval, gotstat, islink, fdval;
760 islink = !fdval && S_ISLNK(fs->st_mode);
761 mode = fs->st_mode & (S_ISUID | S_ISGID | S_ISVTX | S_IRWXU | S_IRWXG | S_IRWXO);
763 TIMESPEC_TO_TIMEVAL(&tv[0], &fs->st_atim);
764 TIMESPEC_TO_TIMEVAL(&tv[1], &fs->st_mtim);
765 if (islink ? lutimes(to.p_path, tv) : utimes(to.p_path, tv)) {
766 SLOG("%sutimes: %s", islink ? "l" : "", to.p_path);
769 if (fdval ? fstat(fd, &ts) :
770 (islink ? lstat(to.p_path, &ts) : stat(to.p_path, &ts)))
774 ts.st_mode &= S_ISUID | S_ISGID | S_ISVTX |
775 S_IRWXU | S_IRWXG | S_IRWXO;
778 * Changing the ownership probably won't succeed, unless we're root
779 * or POSIX_CHOWN_RESTRICTED is not set. Set uid/gid before setting
780 * the mode; current BSD behavior is to remove all setuid bits on
781 * chown. If chown fails, lose setuid/setgid bits.
783 if (!gotstat || fs->st_uid != ts.st_uid || fs->st_gid != ts.st_gid)
784 if (fdval ? fchown(fd, fs->st_uid, fs->st_gid) :
785 (islink ? lchown(to.p_path, fs->st_uid, fs->st_gid) :
786 chown(to.p_path, fs->st_uid, fs->st_gid))) {
787 if (errno != EPERM) {
788 SLOG("chown: %s: %s", to.p_path, strerror(errno));
791 mode &= ~(S_ISUID | S_ISGID);
794 if (!gotstat || mode != ts.st_mode)
795 if (fdval ? fchmod(fd, mode) : chmod(to.p_path, mode)) {
796 SLOG("chmod: %s: %s", to.p_path, strerror(errno));
801 if (!gotstat || fs->st_flags != ts.st_flags)
803 fchflags(fd, fs->st_flags) :
804 (islink ? lchflags(to.p_path, fs->st_flags) :
805 chflags(to.p_path, fs->st_flags))) {
806 SLOG("chflags: %s: %s", to.p_path, strerror(errno));
814 static int preserve_fd_acls(int source_fd, int dest_fd)
819 int acl_supported = 0, ret, trivial;
821 ret = fpathconf(source_fd, _PC_ACL_NFS4);
824 acl_type = ACL_TYPE_NFS4;
825 } else if (ret < 0 && errno != EINVAL) {
826 warn("fpathconf(..., _PC_ACL_NFS4) failed for %s", to.p_path);
829 if (acl_supported == 0) {
830 ret = fpathconf(source_fd, _PC_ACL_EXTENDED);
833 acl_type = ACL_TYPE_ACCESS;
834 } else if (ret < 0 && errno != EINVAL) {
835 warn("fpathconf(..., _PC_ACL_EXTENDED) failed for %s",
840 if (acl_supported == 0)
843 acl = acl_get_fd_np(source_fd, acl_type);
845 warn("failed to get acl entries while setting %s", to.p_path);
848 if (acl_is_trivial_np(acl, &trivial)) {
849 warn("acl_is_trivial() failed for %s", to.p_path);
857 if (acl_set_fd_np(dest_fd, acl, acl_type) < 0) {
858 warn("failed to set acl entries for %s", to.p_path);
867 static int preserve_dir_acls(const struct stat *fs, char *source_dir, char *dest_dir)
870 acl_t (*aclgetf)(const char *, acl_type_t);
871 int (*aclsetf)(const char *, acl_type_t, acl_t);
875 int acl_supported = 0, ret, trivial;
877 ret = pathconf(source_dir, _PC_ACL_NFS4);
880 acl_type = ACL_TYPE_NFS4;
881 } else if (ret < 0 && errno != EINVAL) {
882 warn("fpathconf(..., _PC_ACL_NFS4) failed for %s", source_dir);
885 if (acl_supported == 0) {
886 ret = pathconf(source_dir, _PC_ACL_EXTENDED);
889 acl_type = ACL_TYPE_ACCESS;
890 } else if (ret < 0 && errno != EINVAL) {
891 warn("fpathconf(..., _PC_ACL_EXTENDED) failed for %s",
896 if (acl_supported == 0)
900 * If the file is a link we will not follow it
902 if (S_ISLNK(fs->st_mode)) {
903 aclgetf = acl_get_link_np;
904 aclsetf = acl_set_link_np;
906 aclgetf = acl_get_file;
907 aclsetf = acl_set_file;
909 if (acl_type == ACL_TYPE_ACCESS) {
911 * Even if there is no ACL_TYPE_DEFAULT entry here, a zero
912 * size ACL will be returned. So it is not safe to simply
913 * check the pointer to see if the default ACL is present.
915 acl = aclgetf(source_dir, ACL_TYPE_DEFAULT);
917 warn("failed to get default acl entries on %s",
921 aclp = &acl->ats_acl;
922 if (aclp->acl_cnt != 0 && aclsetf(dest_dir,
923 ACL_TYPE_DEFAULT, acl) < 0) {
924 warn("failed to set default acl entries on %s",
931 acl = aclgetf(source_dir, acl_type);
933 warn("failed to get acl entries on %s", source_dir);
936 if (acl_is_trivial_np(acl, &trivial)) {
937 warn("acl_is_trivial() failed on %s", source_dir);
945 if (aclsetf(dest_dir, acl_type, acl) < 0) {
946 warn("failed to set acl entries on %s", dest_dir);