toys/posix/cp.c

   1 /* Copyright 2008 Rob Landley <rob@landley.net>
   2  *
   3  * See http://opengroup.org/onlinepubs/9699919799/utilities/cp.html
   4  *
   5  * Posix says "cp -Rf dir file" shouldn't delete file, but our -f does.
   6
   7 // This is subtle: MV options must be in same order (right to left) as CP
   8 // for FLAG_X macros to work out right.
   9
  10 USE_CP(NEWTOY(cp, "<2RHLPp"USE_CP_MORE("rdaslvnF")"fi[-HLPd]"USE_CP_MORE("[-ni]"), TOYFLAG_BIN))
  11 USE_CP_MV(OLDTOY(mv, cp, "<2"USE_CP_MORE("vnF")"fi"USE_CP_MORE("[-ni]"), TOYFLAG_BIN))
  12 USE_INSTALL(NEWTOY(install, "<1cdDpsvm:o:g:", TOYFLAG_USR|TOYFLAG_BIN))
  13 *
  14
  15 config CP
  16   bool "cp"
  17   default y
  18   help
  19     usage: cp [-fipRHLP] SOURCE... DEST
  20
  21     Copy files from SOURCE to DEST.  If more than one SOURCE, DEST must
  22     be a directory.
  23
  24     -f  delete destination files we can't write to
  25     -F  delete any existing destination file first (breaks hardlinks)
  26     -i  interactive, prompt before overwriting existing DEST
  27     -p  preserve timestamps, ownership, and permissions
  28     -R  recurse into subdirectories (DEST must be a directory)
  29     -H  Follow symlinks listed on command line
  30     -L  Follow all symlinks
  31     -P  Do not follow symlinks [default]
  32
  33 config CP_MORE
  34   bool "cp -adlnrsv options"
  35   default y
  36   depends on CP
  37   help
  38     usage: cp [-adlnrsv]
  39
  40     -a  same as -dpr
  41     -d  don't dereference symlinks
  42     -l  hard link instead of copy
  43     -n  no clobber (don't overwrite DEST)
  44     -r  synonym for -R
  45     -s  symlink instead of copy
  46     -v  verbose
  47
  48 config CP_MV
  49   bool "mv"
  50   default y
  51   depends on CP
  52   help
  53     usage: mv [-fi] SOURCE... DEST"
  54
  55     -f  force copy by deleting destination file
  56     -i  interactive, prompt before overwriting existing DEST
  57
  58 config CP_MV_MORE
  59   bool
  60   default y
  61   depends on CP_MV && CP_MORE
  62   help
  63     usage: mv [-vn]
  64
  65     -v  verbose
  66     -n  no clobber (don't overwrite DEST)
  67
  68 config INSTALL
  69   bool "install"
  70   default y
  71   depends on CP && CP_MORE
  72   help
  73     usage: install [-dDpsv] [-o USER] [-g GROUP] [-m MODE] [SOURCE...] DEST
  74
  75     Copy files and set attributes.
  76
  77     -d  Act like mkdir -p
  78     -D  Create leading directories for DEST
  79     -g  Make copy belong to GROUP
  80     -m  Set permissions to MODE
  81     -o  Make copy belong to USER
  82     -p  Preserve timestamps
  83     -s  Call "strip -p"
  84     -v  Verbose
  85 */
  86
  87 #define FOR_cp
  88 #include "toys.h"
  89
  90 GLOBALS(
  91   // install's options
  92   char *group;
  93   char *user;
  94   char *mode;
  95
  96   char *destname;
  97   struct stat top;
  98   int (*callback)(struct dirtree *try);
  99   uid_t uid;
 100   gid_t gid;
 101 )
 102
 103 // Callback from dirtree_read() for each file/directory under a source dir.
 104
 105 int cp_node(struct dirtree *try)
 106 {
 107   int fdout = -1, cfd = try->parent ? try->parent->extra : AT_FDCWD,
 108       tfd = dirtree_parentfd(try);
 109   unsigned flags = toys.optflags;
 110   char *catch = try->parent ? try->name : TT.destname, *err = "%s";
 111   struct stat cst;
 112
 113   if (!dirtree_notdotdot(try)) return 0;
 114
 115   // If returning from COMEAGAIN, jump straight to -p logic at end.
 116   if (S_ISDIR(try->st.st_mode) && try->again) {
 117     fdout = try->extra;
 118     err = 0;
 119   } else {
 120
 121     // -d is only the same as -r for symlinks, not for directories
 122     if (S_ISLNK(try->st.st_mode) & (flags & FLAG_d)) flags |= FLAG_r;
 123
 124     // Detect recursive copies via repeated top node (cp -R .. .) or
 125     // identical source/target (fun with hardlinks).
 126     if ((TT.top.st_dev == try->st.st_dev && TT.top.st_ino == try->st.st_ino
 127          && (catch = TT.destname))
 128         || (!fstatat(cfd, catch, &cst, 0) && cst.st_dev == try->st.st_dev
 129          && cst.st_ino == try->st.st_ino))
 130     {
 131       error_msg("'%s' is '%s'", catch, err = dirtree_path(try, 0));
 132       free(err);
 133
 134       return 0;
 135     }
 136
 137     // Handle -inv
 138
 139     if (!faccessat(cfd, catch, F_OK, 0) && !S_ISDIR(cst.st_mode)) {
 140       char *s;
 141
 142       if (S_ISDIR(try->st.st_dev)) {
 143         error_msg("dir at '%s'", s = dirtree_path(try, 0));
 144         free(s);
 145         return 0;
 146       } else if ((flags & FLAG_F) && unlinkat(cfd, catch, 0)) {
 147         error_msg("unlink '%s'", catch);
 148         return 0;
 149       } else if (flags & FLAG_n) return 0;
 150       else if (flags & FLAG_i) {
 151         fprintf(stderr, "cp: overwrite '%s'", s = dirtree_path(try, 0));
 152         free(s);
 153         if (!yesno("", 1)) return 0;
 154       }
 155     }
 156
 157     if (flags & FLAG_v) {
 158       char *s = dirtree_path(try, 0);
 159       printf("%s '%s'\n", toys.which->name, s);
 160       free(s);
 161     }
 162
 163     // Loop for -f retry after unlink
 164     do {
 165
 166       // directory, hardlink, symlink, mknod (char, block, fifo, socket), file
 167
 168       // Copy directory
 169
 170       if (S_ISDIR(try->st.st_mode)) {
 171         struct stat st2;
 172
 173         if (!(flags & (FLAG_a|FLAG_r|FLAG_R))) {
 174           err = "Skipped dir '%s'";
 175           catch = try->name;
 176           break;
 177         }
 178
 179         // Always make directory writeable to us, so we can create files in it.
 180         //
 181         // Yes, there's a race window between mkdir() and open() so it's
 182         // possible that -p can be made to chown a directory other than the one
 183         // we created. The closest we can do to closing this is make sure
 184         // that what we open _is_ a directory rather than something else.
 185
 186         if (!mkdirat(cfd, catch, try->st.st_mode | 0200) || errno == EEXIST)
 187           if (-1 != (try->extra = openat(cfd, catch, O_NOFOLLOW)))
 188             if (!fstat(try->extra, &st2) && S_ISDIR(st2.st_mode))
 189               return DIRTREE_COMEAGAIN
 190                      | (DIRTREE_SYMFOLLOW*!!(toys.optflags&FLAG_L));
 191
 192       // Hardlink
 193
 194       } else if (flags & FLAG_l) {
 195         if (!linkat(tfd, try->name, cfd, catch, 0)) err = 0;
 196
 197       // Copy tree as symlinks. For non-absolute paths this involves
 198       // appending the right number of .. entries as you go down the tree.
 199
 200       } else if (flags & FLAG_s) {
 201         char *s;
 202         struct dirtree *or;
 203         int dotdots = 0;
 204
 205         s = dirtree_path(try, 0);
 206         for (or = try; or->parent; or = or->parent) dotdots++;
 207
 208         if (*or->name == '/') dotdots = 0;
 209         if (dotdots) {
 210           char *s2 = xmprintf("% *c%s", 3*dotdots, ' ', s);
 211           free(s);
 212           s = s2;
 213           while(dotdots--) {
 214             memcpy(s2, "../", 3);
 215             s2 += 3;
 216           }
 217         }
 218         if (!symlinkat(s, cfd, catch)) {
 219           err = 0;
 220           fdout = AT_FDCWD;
 221         }
 222         free(s);
 223
 224       // Do something _other_ than copy contents of a file?
 225       } else if (!S_ISREG(try->st.st_mode)
 226                  && (try->parent || (flags & (FLAG_a|FLAG_r))))
 227       {
 228         int i;
 229
 230         // make symlink, or make block/char/fifo/socket
 231         if (S_ISLNK(try->st.st_mode)
 232             ? (0 < (i = readlinkat(tfd, try->name, toybuf, sizeof(toybuf))) &&
 233                sizeof(toybuf) > i && !symlinkat(toybuf, cfd, catch))
 234             : !mknodat(cfd, catch, try->st.st_mode, try->st.st_rdev))
 235         {
 236           err = 0;
 237           fdout = AT_FDCWD;
 238         }
 239
 240       // Copy contents of file.
 241       } else {
 242         int fdin;
 243
 244         fdin = openat(tfd, try->name, O_RDONLY);
 245         if (fdin < 0) {
 246           catch = try->name;
 247           break;
 248         } else {
 249           fdout = openat(cfd, catch, O_RDWR|O_CREAT|O_TRUNC, try->st.st_mode);
 250           if (fdout >= 0) {
 251             xsendfile(fdin, fdout);
 252             err = 0;
 253           }
 254           close(fdin);
 255         }
 256       }
 257     } while (err && (flags & (FLAG_f|FLAG_n)) && !unlinkat(cfd, catch, 0));
 258   }
 259
 260   if (fdout != -1) {
 261     if (flags & (FLAG_a|FLAG_p)) {
 262       struct timespec times[2];
 263
 264       // Inability to set these isn't fatal, some require root access.
 265
 266       times[0] = try->st.st_atim;
 267       times[1] = try->st.st_mtim;
 268
 269       // If we can't get a filehandle to the actual object, use racy functions
 270       if (fdout == AT_FDCWD) {
 271         fchownat(cfd, catch, try->st.st_uid, try->st.st_gid,
 272                  AT_SYMLINK_NOFOLLOW);
 273         utimensat(cfd, catch, times, AT_SYMLINK_NOFOLLOW);
 274         // permission bits already correct for mknod, don't apply to symlink
 275       } else {
 276         fchown(fdout, try->st.st_uid, try->st.st_gid);
 277         futimens(fdout, times);
 278         fchmod(fdout, try->st.st_mode);
 279       }
 280     }
 281
 282     if (fdout != AT_FDCWD) xclose(fdout);
 283
 284     if (CFG_CP_MV && toys.which->name[0] == 'm')
 285       if (unlinkat(tfd, try->name, S_ISDIR(try->st.st_mode) ? AT_REMOVEDIR :0))
 286         err = "%s";
 287   }
 288
 289   if (err) perror_msg(err, catch);
 290   return 0;
 291 }
 292
 293 void cp_main(void)
 294 {
 295   char *destname = toys.optargs[--toys.optc];
 296   int i, destdir = !stat(destname, &TT.top) && S_ISDIR(TT.top.st_mode);
 297
 298   if (toys.optc>1 && !destdir) error_exit("'%s' not directory", destname);
 299   if (toys.which->name[0] == 'm') toys.optflags |= FLAG_d|FLAG_p|FLAG_R;
 300   if (toys.optflags & (FLAG_a|FLAG_p)) umask(0);
 301
 302   if (!TT.callback) TT.callback = cp_node;
 303
 304   // Loop through sources
 305
 306   for (i=0; i<toys.optc; i++) {
 307     struct dirtree *new;
 308     char *src = toys.optargs[i];
 309     int rc = 1;
 310
 311     if (destdir) TT.destname = xmprintf("%s/%s", destname, basename(src));
 312     else TT.destname = destname;
 313
 314     errno = EXDEV;
 315     if (CFG_CP_MV && toys.which->name[0] == 'm') rc = rename(src, TT.destname);
 316
 317     // Skip nonexistent sources
 318     if (rc) {
 319       int symfollow = toys.optflags & (FLAG_H|FLAG_L);
 320
 321       if (errno != EXDEV || !(new = dirtree_add_node(0, src, symfollow)))
 322           perror_msg("bad '%s'", src);
 323       else dirtree_handle_callback(new, TT.callback);
 324     }
 325     if (destdir) free(TT.destname);
 326   }
 327 }
 328
 329 #define CLEANUP_cp
 330 #define FOR_install
 331 #include <generated/flags.h>
 332
 333 static int install_node(struct dirtree *try)
 334 {
 335   if (TT.mode) try->st.st_mode = string_to_mode(TT.mode, try->st.st_mode);
 336   if (TT.group) try->st.st_gid = TT.gid;
 337   if (TT.user) try->st.st_uid = TT.uid;
 338
 339   // Always returns 0 because no -r
 340   cp_node(try);
 341
 342   // No -r so always one level deep, so destname as set by cp_node() is correct
 343   if (toys.optflags & FLAG_s)
 344     if (xpclose(xpopen((char *[]){"strip", "-p", TT.destname, 0}, 0), 0))
 345       toys.exitval = 1;
 346
 347   return 0;
 348 }
 349
 350 void install_main(void)
 351 {
 352   char **ss;
 353   int flags = toys.optflags;
 354
 355   if (flags & FLAG_d) {
 356     for (ss = toys.optargs; *ss; ss++) {
 357       if (mkpathat(AT_FDCWD, *ss, 0777, 3)) perror_msg("%s", *ss);
 358       if (flags & FLAG_v) printf("%s\n", *ss);
 359     }
 360
 361     return;
 362   }
 363
 364   if (toys.optflags & FLAG_D) {
 365     if (mkpathat(AT_FDCWD, TT.destname, 0, 2))
 366       perror_exit("-D '%s'", TT.destname);
 367     if (toys.optc == 1) return;
 368   }
 369   if (toys.optc < 2) error_exit("needs 2 args");
 370
 371   // Translate flags from install to cp
 372   toys.optflags = 4;  // Force cp's FLAG_F
 373   if (flags & FLAG_v) toys.optflags |= 8; // cp's FLAG_v
 374   if (flags & (FLAG_p|FLAG_o|FLAG_g)) toys.optflags |= 512; // cp's FLAG_p
 375
 376   if (TT.user) TT.uid = xgetpwnam(TT.user)->pw_uid;
 377   if (TT.group) TT.gid = xgetgrnam(TT.group)->gr_gid;
 378
 379   TT.callback = install_node;
 380   cp_main();
 381 }