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