• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* Copyright 2008 Rob Landley <rob@landley.net>
2  *
3  * See http://opengroup.org/onlinepubs/9699919799/utilities/cp.html
4  * And http://opengroup.org/onlinepubs/9699919799/utilities/mv.html
5  * And http://refspecs.linuxfoundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic.html#INSTALL
6  *
7  * Posix says "cp -Rf dir file" shouldn't delete file, but our -f does.
8  *
9  * Deviations from posix: -adlnrsvF, --preserve... about half the
10  * functionality in this cp isn't in posix. Posix is stuck in the 1970's.
11  *
12  * TODO: --preserve=links
13  * TODO: what's this _CP_mode system.posix_acl_ business? We chmod()?
14 
15 // options shared between mv/cp must be in same order (right to left)
16 // for FLAG macros to work out right in shared infrastructure.
17 
18 USE_CP(NEWTOY(cp, "<1(preserve):;D(parents)RHLPprudaslvnF(remove-destination)fit:T[-HLPd][-niu][+Rr]", TOYFLAG_BIN))
19 USE_MV(NEWTOY(mv, "<1v(verbose)nF(remove-destination)fit:T[-ni]", TOYFLAG_BIN))
20 USE_INSTALL(NEWTOY(install, "<1cdDp(preserve-timestamps)svt:m:o:g:", TOYFLAG_USR|TOYFLAG_BIN))
21 
22 config CP
23   bool "cp"
24   default y
25   help
26     usage: cp [-adfHiLlnPpRrsTv] [--preserve=motcxa] [-t TARGET] SOURCE... [DEST]
27 
28     Copy files from SOURCE to DEST.  If more than one SOURCE, DEST must
29     be a directory.
30 
31     -a	Same as -dpr
32     -D	Create leading dirs under DEST (--parents)
33     -d	Don't dereference symlinks
34     -F	Delete any existing destination file first (--remove-destination)
35     -f	Delete destination files we can't write to
36     -H	Follow symlinks listed on command line
37     -i	Interactive, prompt before overwriting existing DEST
38     -L	Follow all symlinks
39     -l	Hard link instead of copy
40     -n	No clobber (don't overwrite DEST)
41     -u	Update (keep newest mtime)
42     -P	Do not follow symlinks
43     -p	Preserve timestamps, ownership, and mode
44     -R	Recurse into subdirectories (DEST must be a directory)
45     -r	Synonym for -R
46     -s	Symlink instead of copy
47     -t	Copy to TARGET dir (no DEST)
48     -T	DEST always treated as file, max 2 arguments
49     -v	Verbose
50 
51     Arguments to --preserve are the first letter(s) of:
52 
53             mode - permissions (ignore umask for rwx, copy suid and sticky bit)
54        ownership - user and group
55       timestamps - file creation, modification, and access times.
56          context - security context
57            xattr - extended attributes
58              all - all of the above
59 
60 config MV
61   bool "mv"
62   default y
63   help
64     usage: mv [-finTv] [-t TARGET] SOURCE... [DEST]
65 
66     -f	Force copy by deleting destination file
67     -i	Interactive, prompt before overwriting existing DEST
68     -n	No clobber (don't overwrite DEST)
69     -t	Move to TARGET dir (no DEST)
70     -T	DEST always treated as file, max 2 arguments
71     -v	Verbose
72 
73 config INSTALL
74   bool "install"
75   default y
76   help
77     usage: install [-dDpsv] [-o USER] [-g GROUP] [-m MODE] [-t TARGET] [SOURCE...] [DEST]
78 
79     Copy files and set attributes.
80 
81     -d	Act like mkdir -p
82     -D	Create leading directories for DEST
83     -g	Make copy belong to GROUP
84     -m	Set permissions to MODE
85     -o	Make copy belong to USER
86     -p	Preserve timestamps
87     -s	Call "strip -p"
88     -t	Copy files to TARGET dir (no DEST)
89     -v	Verbose
90 */
91 
92 #define FORCE_FLAGS
93 #define FOR_cp
94 #include "toys.h"
95 
96 GLOBALS(
97   union {
98     // install's options
99     struct {
100       char *g, *o, *m, *t;
101     } i;
102     // cp's options
103     struct {
104       char *t, *preserve;
105     } c;
106   };
107 
108   char *destname;
109   struct stat top;
110   int (*callback)(struct dirtree *try);
111   uid_t uid;
112   gid_t gid;
113   int pflags;
114 )
115 
116 struct cp_preserve {
117   char *name;
118 } static const cp_preserve[] = TAGGED_ARRAY(CP,
119   {"mode"}, {"ownership"}, {"timestamps"}, {"context"}, {"xattr"},
120 );
121 
122 // Callback from dirtree_read() for each file/directory under a source dir.
123 
cp_node(struct dirtree * try)124 static int cp_node(struct dirtree *try)
125 {
126   int fdout = -1, cfd = try->parent ? try->parent->extra : AT_FDCWD,
127       save = DIRTREE_SAVE*(CFG_MV && toys.which->name[0] == 'm'), rc = 0,
128       tfd = dirtree_parentfd(try);
129   unsigned flags = toys.optflags;
130   char *s = 0, *catch = try->parent ? try->name : TT.destname, *err = "%s";
131   struct stat cst;
132 
133   if (!dirtree_notdotdot(try)) return 0;
134 
135   // If returning from COMEAGAIN, jump straight to -p logic at end.
136   if (S_ISDIR(try->st.st_mode) && try->again) {
137     fdout = try->extra;
138     err = 0;
139 
140     // If mv child had a problem, free data and don't try to delete parent dir.
141     if (try->child) {
142       save = 0;
143       llist_traverse(try->child, free);
144     }
145   } else {
146     // -d is only the same as -r for symlinks, not for directories
147     if (S_ISLNK(try->st.st_mode) && (flags & FLAG_d)) flags |= FLAG_r;
148 
149     // Detect recursive copies via repeated top node (cp -R .. .) or
150     // identical source/target (fun with hardlinks).
151     if ((same_file(&TT.top, &try->st) && (catch = TT.destname))
152         || (!fstatat(cfd, catch, &cst, 0) && same_file(&cst, &try->st)))
153     {
154       error_msg("'%s' is '%s'", catch, err = dirtree_path(try, 0));
155       free(err);
156 
157       return save;
158     }
159 
160     // Handle -inuvF
161     if (!faccessat(cfd, catch, F_OK, 0) && !S_ISDIR(cst.st_mode)) {
162       if (S_ISDIR(try->st.st_mode))
163         error_msg("dir at '%s'", s = dirtree_path(try, 0));
164       else if ((flags & FLAG_F) && unlinkat(cfd, catch, 0))
165         error_msg("unlink '%s'", catch);
166       else if (flags & FLAG_i) {
167         fprintf(stderr, "%s: overwrite '%s'", toys.which->name,
168           s = dirtree_path(try, 0));
169         if (yesno(0)) rc++;
170       } else if (!((flags&FLAG_u) && nanodiff(&try->st.st_mtim, &cst.st_mtim)>0)
171                  && !(flags & FLAG_n)) rc++;
172       free(s);
173       if (!rc) return save;
174     }
175 
176     if (flags & FLAG_v) {
177       printf("%s '%s'\n", toys.which->name, s = dirtree_path(try, 0));
178       free(s);
179     }
180 
181     // Loop for -f retry after unlink
182     do {
183 
184       // directory, hardlink, symlink, mknod (char, block, fifo, socket), file
185 
186       // Copy directory
187 
188       if (S_ISDIR(try->st.st_mode)) {
189         struct stat st2;
190 
191         if (!(flags & (FLAG_a|FLAG_r))) {
192           err = "Skipped dir '%s'";
193           catch = try->name;
194           break;
195         }
196 
197         // Always make directory writeable to us, so we can create files in it.
198         //
199         // Yes, there's a race window between mkdir() and open() so it's
200         // possible that -p can be made to chown a directory other than the one
201         // we created. The closest we can do to closing this is make sure
202         // that what we open _is_ a directory rather than something else.
203 
204         if (!mkdirat(cfd, catch, try->st.st_mode | 0200) || errno == EEXIST)
205           if (-1 != (try->extra = openat(cfd, catch, O_NOFOLLOW)))
206             if (!fstat(try->extra, &st2) && S_ISDIR(st2.st_mode))
207               return DIRTREE_COMEAGAIN | DIRTREE_SYMFOLLOW*FLAG(L);
208 
209       // Hardlink
210 
211       } else if (flags & FLAG_l) {
212         if (!linkat(tfd, try->name, cfd, catch, 0)) err = 0;
213 
214       // Copy tree as symlinks. For non-absolute paths this involves
215       // appending the right number of .. entries as you go down the tree.
216 
217       } else if (flags & FLAG_s) {
218         char *s;
219         struct dirtree *or;
220         int dotdots = 0;
221 
222         s = dirtree_path(try, 0);
223         for (or = try; or->parent; or = or->parent) dotdots++;
224 
225         if (*or->name == '/') dotdots = 0;
226         if (dotdots) {
227           char *s2 = xmprintf("%*c%s", 3*dotdots, ' ', s);
228           free(s);
229           s = s2;
230           while(dotdots--) {
231             memcpy(s2, "../", 3);
232             s2 += 3;
233           }
234         }
235         if (!symlinkat(s, cfd, catch)) {
236           err = 0;
237           fdout = AT_FDCWD;
238         }
239         free(s);
240 
241       // Do something _other_ than copy contents of a file?
242       } else if (!S_ISREG(try->st.st_mode)
243                  && (try->parent || (flags & (FLAG_a|FLAG_P|FLAG_r))))
244       {
245         // make symlink, or make block/char/fifo/socket
246         if (S_ISLNK(try->st.st_mode)
247             ? readlinkat0(tfd, try->name, toybuf, sizeof(toybuf)) &&
248               (!unlinkat(cfd, catch, 0) || ENOENT == errno) &&
249               !symlinkat(toybuf, cfd, catch)
250             : !mknodat(cfd, catch, try->st.st_mode, try->st.st_rdev))
251         {
252           err = 0;
253           fdout = AT_FDCWD;
254         }
255 
256       // Copy contents of file.
257       } else {
258         int fdin, ii;
259 
260         fdin = openat(tfd, try->name, O_RDONLY);
261         if (fdin < 0) {
262           catch = try->name;
263           break;
264         }
265         // When copying contents use symlink target's attributes
266         if (S_ISLNK(try->st.st_mode)) fstat(fdin, &try->st);
267         fdout = openat(cfd, catch, O_RDWR|O_CREAT|O_TRUNC, try->st.st_mode);
268         if (fdout >= 0) {
269           xsendfile(fdin, fdout);
270           err = 0;
271         }
272 
273         // We only copy xattrs for files because there's no flistxattrat()
274         if (TT.pflags&(_CP_xattr|_CP_context)) {
275           ssize_t listlen = xattr_flist(fdin, 0, 0), len;
276           char *name, *value, *list;
277 
278           if (listlen>0) {
279             list = xmalloc(listlen);
280             xattr_flist(fdin, list, listlen);
281             list[listlen-1] = 0; // I do not trust this API.
282             for (name = list; name-list < listlen; name += strlen(name)+1) {
283               // context copies security, xattr copies everything else
284               ii = strncmp(name, "security.", 9) ? _CP_xattr : _CP_context;
285               if (!(TT.pflags&ii)) continue;
286               if ((len = xattr_fget(fdin, name, 0, 0))>0) {
287                 value = xmalloc(len);
288                 if (len == xattr_fget(fdin, name, value, len))
289                   if (xattr_fset(fdout, name, value, len, 0))
290                     perror_msg("%s setxattr(%s=%s)", catch, name, value);
291                 free(value);
292               }
293             }
294             free(list);
295           }
296         }
297 
298         close(fdin);
299       }
300     } while (err && (flags & (FLAG_f|FLAG_n)) && !unlinkat(cfd, catch, 0));
301   }
302 
303   // Did we make a thing?
304   if (fdout != -1) {
305     // Inability to set --preserve isn't fatal, some require root access.
306 
307     // ownership
308     if (TT.pflags & _CP_ownership) {
309 
310       // permission bits already correct for mknod and don't apply to symlink
311       // If we can't get a filehandle to the actual object, use racy functions
312       if (fdout == AT_FDCWD)
313         rc = fchownat(cfd, catch, try->st.st_uid, try->st.st_gid,
314                       AT_SYMLINK_NOFOLLOW);
315       else rc = fchown(fdout, try->st.st_uid, try->st.st_gid);
316       if (rc && !geteuid()) {
317         char *pp;
318 
319         perror_msg("chown '%s'", pp = dirtree_path(try, 0));
320         free(pp);
321       }
322     }
323 
324     // timestamp
325     if (TT.pflags & _CP_timestamps) {
326       struct timespec times[] = {try->st.st_atim, try->st.st_mtim};
327 
328       if (fdout == AT_FDCWD) utimensat(cfd, catch, times, AT_SYMLINK_NOFOLLOW);
329       else futimens(fdout, times);
330     }
331 
332     // mode comes last because other syscalls can strip suid bit
333     if (fdout != AT_FDCWD) {
334       if (TT.pflags & _CP_mode) fchmod(fdout, try->st.st_mode);
335       xclose(fdout);
336     }
337 
338     if (save)
339       if (unlinkat(tfd, try->name, S_ISDIR(try->st.st_mode) ? AT_REMOVEDIR :0))
340         err = "%s";
341   }
342 
343   if (err) {
344     if (catch == try->name) {
345       s = dirtree_path(try, 0);
346       while (try->parent) try = try->parent;
347       catch = xmprintf("%s%s", TT.destname, s+strlen(try->name));
348       free(s);
349       s = catch;
350     } else s = 0;
351     perror_msg(err, catch);
352     free(s);
353   }
354   return 0;
355 }
356 
cp_main(void)357 void cp_main(void)
358 {
359   char *tt = *toys.which->name == 'i' ? TT.i.t : TT.c.t,
360     *destname = tt ? : toys.optargs[--toys.optc];
361   int i, destdir = !stat(destname, &TT.top);
362 
363   if (!toys.optc) error_exit("Needs 2 arguments");
364   if (!destdir && errno==ENOENT && FLAG(D)) {
365     if (tt && mkpathat(AT_FDCWD, tt, 0777, MKPATHAT_MAKE|MKPATHAT_MKLAST))
366       perror_exit("-t '%s'", tt);
367     destdir = 1;
368   } else {
369     destdir = destdir && S_ISDIR(TT.top.st_mode);
370     if (!destdir && (toys.optc>1 || FLAG(D) || tt))
371       error_exit("'%s' not directory", destname);
372   }
373 
374   if (FLAG(T)) {
375     if (toys.optc>1) help_exit("Max 2 arguments");
376     if (destdir) error_exit("'%s' is a directory", destname);
377   }
378 
379   if (FLAG(a)||FLAG(p)) TT.pflags = _CP_mode|_CP_ownership|_CP_timestamps;
380 
381   // Not using comma_args() (yet?) because interpeting as letters.
382   if (FLAG(preserve)) {
383     char *pre = xstrdup(TT.c.preserve ? TT.c.preserve : "mot"), *s;
384 
385     if (comma_remove(pre, "all")) TT.pflags = ~0;
386     for (i=0; i<ARRAY_LEN(cp_preserve); i++)
387       while (comma_remove(pre, cp_preserve[i].name)) TT.pflags |= 1<<i;
388     if (*pre) {
389 
390       // Try to interpret as letters, commas won't set anything this doesn't.
391       for (s = pre; *s; s++) {
392         for (i=0; i<ARRAY_LEN(cp_preserve); i++)
393           if (*s == *cp_preserve[i].name) break;
394         if (i == ARRAY_LEN(cp_preserve)) {
395           if (*s == 'a') TT.pflags = ~0;
396           else break;
397         } else TT.pflags |= 1<<i;
398       }
399 
400       if (*s) error_exit("bad --preserve=%s", pre);
401     }
402     free(pre);
403   }
404   if (TT.pflags & _CP_mode) umask(0);
405   if (!TT.callback) TT.callback = cp_node;
406 
407   // Loop through sources
408   for (i=0; i<toys.optc; i++) {
409     char *src = toys.optargs[i], *trail;
410     int send = 1;
411 
412     if (!(trail = strrchr(src, '/')) || trail[1]) trail = 0;
413     else while (trail>src && *trail=='/') *trail-- = 0;
414 
415     if (destdir) {
416       char *s = FLAG(D) ? src : getbasename(src);
417 
418       TT.destname = xmprintf("%s/%s", destname, s);
419       if (FLAG(D)) {
420         if (!(s = fileunderdir(TT.destname, destname))) {
421           error_msg("%s not under %s", TT.destname, destname);
422           continue;
423         }
424         // TODO: .. follows abspath, not links...
425         free(s);
426         mkpath(TT.destname);
427       }
428     } else TT.destname = destname;
429 
430     // "mv across devices" triggers cp fallback path, so set that as default
431     errno = EXDEV;
432     if (CFG_MV && toys.which->name[0] == 'm') {
433       if (!FLAG(f) || FLAG(n)) {
434         struct stat st;
435         int exists = !stat(TT.destname, &st);
436 
437         // Prompt if -i or file isn't writable.  Technically "is writable" is
438         // more complicated (022 is not writeable by the owner, just everybody
439         // _else_) but I don't care.
440         if (exists && (FLAG(i) || (!(st.st_mode & 0222) && isatty(0)))) {
441           fprintf(stderr, "%s: overwrite '%s'", toys.which->name, TT.destname);
442           if (!yesno(0)) send = 0;
443           else unlink(TT.destname);
444         }
445         // if -n and dest exists, don't try to rename() or copy
446         if (exists && FLAG(n)) send = 0;
447       }
448       if (send) send = rename(src, TT.destname);
449       if (trail) trail[1] = '/';
450     }
451 
452     // Copy if we didn't mv or hit an error, skipping nonexistent sources
453     if (send) {
454       if (errno!=EXDEV || dirtree_flagread(src, DIRTREE_SHUTUP+
455         DIRTREE_SYMFOLLOW*(FLAG(H)|FLAG(L)), TT.callback))
456           perror_msg("bad '%s'", src);
457     }
458     if (destdir) free(TT.destname);
459   }
460 }
461 
mv_main(void)462 void mv_main(void)
463 {
464   toys.optflags |= FLAG_d|FLAG_p|FLAG_r;
465 
466   cp_main();
467 }
468 
469 // Export cp flags into install's flag context.
470 
cp_flag_F(void)471 static inline int cp_flag_F(void) { return FLAG_F; }
cp_flag_p(void)472 static inline int cp_flag_p(void) { return FLAG_p; }
cp_flag_v(void)473 static inline int cp_flag_v(void) { return FLAG_v; }
474 
475 // Switch to install's flag context
476 #define FOR_install
477 #include <generated/flags.h>
478 
install_node(struct dirtree * try)479 static int install_node(struct dirtree *try)
480 {
481   try->st.st_mode = TT.i.m ? string_to_mode(TT.i.m, try->st.st_mode) : 0755;
482   if (TT.i.g) try->st.st_gid = TT.gid;
483   if (TT.i.o) try->st.st_uid = TT.uid;
484 
485   // Always returns 0 because no -r
486   cp_node(try);
487 
488   // No -r so always one level deep, so destname as set by cp_node() is correct
489   if (FLAG(s) && xrun((char *[]){"strip", "-p", TT.destname, 0}))
490     toys.exitval = 1;
491 
492   return 0;
493 }
494 
install_main(void)495 void install_main(void)
496 {
497   char **ss;
498 
499   TT.uid = TT.i.o ? xgetuid(TT.i.o) : -1;
500   TT.gid = TT.i.g ? xgetgid(TT.i.g) : -1;
501 
502   if (FLAG(d)) {
503     for (ss = toys.optargs; *ss; ss++) {
504       if (FLAG(v)) printf("%s\n", *ss);
505       if (mkpathat(AT_FDCWD, *ss, 0777, MKPATHAT_MKLAST | MKPATHAT_MAKE))
506         perror_msg_raw(*ss);
507       if (FLAG(g)||FLAG(o))
508         if (lchown(*ss, TT.uid, TT.gid)) perror_msg("chown '%s'", *ss);
509     }
510 
511     return;
512   }
513 
514   if (FLAG(D)) {
515     char *destname = TT.i.t ? : (TT.destname = toys.optargs[toys.optc-1]);
516     if (mkpathat(AT_FDCWD, destname, 0777, MKPATHAT_MAKE|MKPATHAT_MKLAST*FLAG(t)))
517       perror_exit("-D '%s'", destname);
518     if (toys.optc == !FLAG(t)) return;
519   }
520 
521   // Translate flags from install to cp
522   toys.optflags = cp_flag_F() + cp_flag_v()*FLAG(v)
523     + cp_flag_p()*(FLAG(p)|FLAG(o)|FLAG(g));
524 
525   TT.callback = install_node;
526   cp_main();
527 }
528