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