cp/utils.c

   1 /*-
   2  * Copyright (c) 1991, 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #ifndef lint
  31 #if 0
  32 static char sccsid[] = "@(#)utils.c     8.3 (Berkeley) 4/1/94";
  33 #endif
  34 #endif /* not lint */
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD: src/bin/cp/utils.c,v 1.46 2005/09/05 04:36:08 csjp Exp $");
  37
  38 #include <sys/types.h>
  39 #include <sys/acl.h>
  40 #include <sys/param.h>
  41 #include <sys/stat.h>
  42 #ifdef VM_AND_BUFFER_CACHE_SYNCHRONIZED
  43 #include <sys/mman.h>
  44 #endif
  45
  46 #include <err.h>
  47 #include <errno.h>
  48 #include <fcntl.h>
  49 #include <fts.h>
  50 #include <limits.h>
  51 #include <stdio.h>
  52 #include <stdlib.h>
  53 #include <sysexits.h>
  54 #include <unistd.h>
  55
  56 #ifdef __APPLE__
  57 #include <sys/time.h>
  58 #include <copyfile.h>
  59 #include <string.h>
  60 #include <sys/mount.h>
  61 #include <get_compat.h>
  62 #else
  63 #define COMPAT_MODE(a,b) (1)
  64 #endif /* __APPLE__ */
  65
  66 #include "extern.h"
  67 #define cp_pct(x,y)     (int)(100.0 * (double)(x) / (double)(y))
  68
  69 int
  70 copy_file(const FTSENT *entp, int dne)
  71 {
  72         static char buf[MAXBSIZE];
  73         struct stat *fs;
  74         int ch, checkch, from_fd, rval, to_fd;
  75         ssize_t rcount;
  76         ssize_t wcount;
  77         size_t wresid;
  78         off_t wtotal;
  79         char *bufp;
  80 #ifdef VM_AND_BUFFER_CACHE_SYNCHRONIZED
  81         char *p;
  82 #endif
  83         mode_t mode = 0;
  84         struct stat to_stat;
  85
  86         if ((from_fd = open(entp->fts_path, O_RDONLY, 0)) == -1) {
  87                 warn("%s", entp->fts_path);
  88                 return (1);
  89         }
  90
  91         fs = entp->fts_statp;
  92
  93         /*
  94          * If the file exists and we're interactive, verify with the user.
  95          * If the file DNE, set the mode to be the from file, minus setuid
  96          * bits, modified by the umask; arguably wrong, but it makes copying
  97          * executables work right and it's been that way forever.  (The
  98          * other choice is 666 or'ed with the execute bits on the from file
  99          * modified by the umask.)
 100          */
 101         if (!dne) {
 102 #define YESNO "(y/n [n]) "
 103                 if (nflag) {
 104                         if (vflag)
 105                                 printf("%s not overwritten\n", to.p_path);
 106                         (void)close(from_fd);
 107                         return (1);
 108                 } else if (iflag) {
 109                         (void)fprintf(stderr, "overwrite %s? %s",
 110                                         to.p_path, YESNO);
 111                         checkch = ch = getchar();
 112                         while (ch != '\n' && ch != EOF)
 113                                 ch = getchar();
 114                         if (checkch != 'y' && checkch != 'Y') {
 115                                 (void)close(from_fd);
 116                                 (void)fprintf(stderr, "not overwritten\n");
 117                                 return (1);
 118                         }
 119                 }
 120
 121                 if (COMPAT_MODE("bin/cp", "unix2003")) {
 122                     /* first try to overwrite existing destination file name */
 123                     to_fd = open(to.p_path, O_WRONLY | O_TRUNC, 0);
 124                     if (to_fd == -1) {
 125                         if (fflag) {
 126                             /* Only if it fails remove file and create a new one */
 127                             (void)unlink(to.p_path);
 128                             to_fd = open(to.p_path, O_WRONLY | O_TRUNC | O_CREAT,
 129                                          fs->st_mode & ~(S_ISUID | S_ISGID));
 130                         }
 131                     }
 132                 } else {
 133                         if (fflag) {
 134                             /* remove existing destination file name,
 135                              * create a new file  */
 136                             (void)unlink(to.p_path);
 137                             to_fd = open(to.p_path, O_WRONLY | O_TRUNC | O_CREAT,
 138                                          fs->st_mode & ~(S_ISUID | S_ISGID));
 139                         } else
 140                             /* overwrite existing destination file name */
 141                             to_fd = open(to.p_path, O_WRONLY | O_TRUNC, 0);
 142                 }
 143         } else
 144                 to_fd = open(to.p_path, O_WRONLY | O_TRUNC | O_CREAT,
 145                     fs->st_mode & ~(S_ISUID | S_ISGID));
 146
 147         if (to_fd == -1) {
 148                 warn("%s", to.p_path);
 149                 (void)close(from_fd);
 150                 return (1);
 151         }
 152
 153         rval = 0;
 154
 155 #ifdef __APPLE__
 156        if (S_ISREG(fs->st_mode)) {
 157                struct statfs sfs;
 158
 159                /*
 160                 * Pre-allocate blocks for the destination file if it
 161                 * resides on Xsan.
 162                 */
 163                if (fstatfs(to_fd, &sfs) == 0 &&
 164                    strcmp(sfs.f_fstypename, "acfs") == 0) {
 165                        fstore_t fst;
 166
 167                        fst.fst_flags = 0;
 168                        fst.fst_posmode = F_PEOFPOSMODE;
 169                        fst.fst_offset = 0;
 170                        fst.fst_length = fs->st_size;
 171
 172                        (void) fcntl(to_fd, F_PREALLOCATE, &fst);
 173                }
 174        }
 175 #endif /* __APPLE__ */
 176
 177        if (fstat(to_fd, &to_stat) != -1) {
 178                mode = to_stat.st_mode;
 179                if ((mode & (S_IRWXG|S_IRWXO))
 180                    && fchmod(to_fd, mode & ~(S_IRWXG|S_IRWXO))) {
 181                        if (errno != EPERM) /* we have write access but do not own the file */
 182                                warn("%s: fchmod failed", to.p_path);
 183                        mode = 0;
 184                }
 185        } else {
 186                warn("%s", to.p_path);
 187        }
 188         /*
 189          * Mmap and write if less than 8M (the limit is so we don't totally
 190          * trash memory on big files.  This is really a minor hack, but it
 191          * wins some CPU back.
 192          */
 193 #ifdef VM_AND_BUFFER_CACHE_SYNCHRONIZED
 194         if (S_ISREG(fs->st_mode) && fs->st_size > 0 &&
 195             fs->st_size <= 8 * 1048576) {
 196                 if ((p = mmap(NULL, (size_t)fs->st_size, PROT_READ,
 197                     MAP_SHARED, from_fd, (off_t)0)) == MAP_FAILED) {
 198                         warn("%s", entp->fts_path);
 199                         rval = 1;
 200                 } else {
 201                         wtotal = 0;
 202                         for (bufp = p, wresid = fs->st_size; ;
 203                             bufp += wcount, wresid -= (size_t)wcount) {
 204                                 wcount = write(to_fd, bufp, wresid);
 205                                 wtotal += wcount;
 206                                 if (info) {
 207                                         info = 0;
 208                                         (void)fprintf(stderr,
 209                                                 "%s -> %s %3d%%\n",
 210                                                 entp->fts_path, to.p_path,
 211                                                 cp_pct(wtotal, fs->st_size));
 212
 213                                 }
 214                                 if (wcount >= (ssize_t)wresid || wcount <= 0)
 215                                         break;
 216                         }
 217                         if (wcount != (ssize_t)wresid) {
 218                                 warn("%s", to.p_path);
 219                                 rval = 1;
 220                         }
 221                         /* Some systems don't unmap on close(2). */
 222                         if (munmap(p, fs->st_size) < 0) {
 223                                 warn("%s", entp->fts_path);
 224                                 rval = 1;
 225                         }
 226                 }
 227         } else
 228 #endif
 229         {
 230                 wtotal = 0;
 231                 while ((rcount = read(from_fd, buf, MAXBSIZE)) > 0) {
 232                         for (bufp = buf, wresid = rcount; ;
 233                             bufp += wcount, wresid -= wcount) {
 234                                 wcount = write(to_fd, bufp, wresid);
 235                                 wtotal += wcount;
 236                                 if (info) {
 237                                         info = 0;
 238                                         (void)fprintf(stderr,
 239                                                 "%s -> %s %3d%%\n",
 240                                                 entp->fts_path, to.p_path,
 241                                                 cp_pct(wtotal, fs->st_size));
 242
 243                                 }
 244                                 if (wcount >= (ssize_t)wresid || wcount <= 0)
 245                                         break;
 246                         }
 247                         if (wcount != (ssize_t)wresid) {
 248                                 warn("%s", to.p_path);
 249                                 rval = 1;
 250                                 break;
 251                         }
 252                 }
 253                 if (rcount < 0) {
 254                         warn("%s", entp->fts_path);
 255                         rval = 1;
 256                 }
 257         }
 258
 259         /*
 260          * Don't remove the target even after an error.  The target might
 261          * not be a regular file, or its attributes might be important,
 262          * or its contents might be irreplaceable.  It would only be safe
 263          * to remove it if we created it and its length is 0.
 264          */
 265         if (mode != 0)
 266                 if (fchmod(to_fd, mode))
 267                         warn("%s: fchmod failed", to.p_path);
 268 #ifdef __APPLE__
 269         /* do these before setfile in case copyfile changes mtime */
 270         if (!Xflag && S_ISREG(fs->st_mode)) { /* skip devices, etc */
 271                 if (fcopyfile(from_fd, to_fd, NULL, COPYFILE_XATTR) < 0)
 272                         warn("%s: could not copy extended attributes to %s", entp->fts_path, to.p_path);
 273         }
 274         if (pflag && setfile(fs, to_fd))
 275                 rval = 1;
 276         if (pflag) {
 277                 /* If this ACL denies writeattr then setfile will fail... */
 278                 if (fcopyfile(from_fd, to_fd, NULL, COPYFILE_ACL) < 0)
 279                         warn("%s: could not copy ACL to %s", entp->fts_path, to.p_path);
 280         }
 281 #else  /* !__APPLE__ */
 282         if (pflag && setfile(fs, to_fd))
 283                 rval = 1;
 284         if (pflag && preserve_fd_acls(from_fd, to_fd) != 0)
 285                 rval = 1;
 286 #endif /* __APPLE__ */
 287         (void)close(from_fd);
 288         if (close(to_fd)) {
 289                 warn("%s", to.p_path);
 290                 rval = 1;
 291         }
 292         return (rval);
 293 }
 294
 295 int
 296 copy_link(const FTSENT *p, int exists)
 297 {
 298         ssize_t len;
 299         char llink[PATH_MAX];
 300
 301         if ((len = readlink(p->fts_path, llink, sizeof(llink) - 1)) == -1) {
 302                 warn("readlink: %s", p->fts_path);
 303                 return (1);
 304         }
 305         llink[len] = '\0';
 306         if (exists && unlink(to.p_path)) {
 307                 warn("unlink: %s", to.p_path);
 308                 return (1);
 309         }
 310         if (symlink(llink, to.p_path)) {
 311                 warn("symlink: %s", llink);
 312                 return (1);
 313         }
 314 #ifdef __APPLE__
 315         if (!Xflag)
 316                 if (copyfile(p->fts_path, to.p_path, NULL, COPYFILE_XATTR | COPYFILE_NOFOLLOW_SRC) <0)
 317                         warn("%s: could not copy extended attributes to %s",
 318                              p->fts_path, to.p_path);
 319 #endif
 320         return (pflag ? setfile(p->fts_statp, -1) : 0);
 321 }
 322
 323 int
 324 copy_fifo(struct stat *from_stat, int exists)
 325 {
 326         if (exists && unlink(to.p_path)) {
 327                 warn("unlink: %s", to.p_path);
 328                 return (1);
 329         }
 330         if (mkfifo(to.p_path, from_stat->st_mode)) {
 331                 warn("mkfifo: %s", to.p_path);
 332                 return (1);
 333         }
 334         return (pflag ? setfile(from_stat, -1) : 0);
 335 }
 336
 337 int
 338 copy_special(struct stat *from_stat, int exists)
 339 {
 340         if (exists && unlink(to.p_path)) {
 341                 warn("unlink: %s", to.p_path);
 342                 return (1);
 343         }
 344         if (mknod(to.p_path, from_stat->st_mode, from_stat->st_rdev)) {
 345                 warn("mknod: %s", to.p_path);
 346                 return (1);
 347         }
 348         return (pflag ? setfile(from_stat, -1) : 0);
 349 }
 350
 351 int
 352 setfile(struct stat *fs, int fd)
 353 {
 354         static struct timeval tv[2];
 355         struct stat ts;
 356         int rval, gotstat, islink, fdval;
 357
 358         rval = 0;
 359         fdval = fd != -1;
 360         islink = !fdval && S_ISLNK(fs->st_mode);
 361         fs->st_mode &= S_ISUID | S_ISGID | S_ISVTX |
 362                        S_IRWXU | S_IRWXG | S_IRWXO;
 363
 364         TIMESPEC_TO_TIMEVAL(&tv[0], &fs->st_atimespec);
 365         TIMESPEC_TO_TIMEVAL(&tv[1], &fs->st_mtimespec);
 366 #ifdef __APPLE__
 367         if (islink ? 0 : utimes(to.p_path, tv)) {
 368 #else
 369         if (islink ? lutimes(to.p_path, tv) : utimes(to.p_path, tv)) {
 370 #endif /* __APPLE__ */
 371                 warn("%sutimes: %s", islink ? "l" : "", to.p_path);
 372                 rval = 1;
 373         }
 374         if (fdval ? fstat(fd, &ts) :
 375             (islink ? lstat(to.p_path, &ts) : stat(to.p_path, &ts)))
 376                 gotstat = 0;
 377         else {
 378                 gotstat = 1;
 379                 ts.st_mode &= S_ISUID | S_ISGID | S_ISVTX |
 380                               S_IRWXU | S_IRWXG | S_IRWXO;
 381         }
 382         /*
 383          * Changing the ownership probably won't succeed, unless we're root
 384          * or POSIX_CHOWN_RESTRICTED is not set.  Set uid/gid before setting
 385          * the mode; current BSD behavior is to remove all setuid bits on
 386          * chown.  If chown fails, lose setuid/setgid bits.
 387          */
 388         if (!gotstat || fs->st_uid != ts.st_uid || fs->st_gid != ts.st_gid)
 389                 if (fdval ? fchown(fd, fs->st_uid, fs->st_gid) :
 390                     (islink ? lchown(to.p_path, fs->st_uid, fs->st_gid) :
 391                     chown(to.p_path, fs->st_uid, fs->st_gid))) {
 392                         if (errno != EPERM) {
 393                                 warn("%schown: %s", islink ? "l" : "", to.p_path);
 394                                 rval = 1;
 395                         }
 396                         fs->st_mode &= ~(S_ISUID | S_ISGID);
 397                 }
 398
 399         if (!gotstat || fs->st_mode != ts.st_mode)
 400                 if (fdval ? fchmod(fd, fs->st_mode) :
 401                     (islink ? lchmod(to.p_path, fs->st_mode) :
 402                     chmod(to.p_path, fs->st_mode))) {
 403                         warn("%schmod: %s", islink ? "l" : "", to.p_path);
 404                         rval = 1;
 405                 }
 406
 407         if (!gotstat || fs->st_flags != ts.st_flags)
 408                 if (fdval ?
 409                     fchflags(fd, fs->st_flags) :
 410                     (islink ? lchflags(to.p_path, fs->st_flags) :
 411                     chflags(to.p_path, fs->st_flags))) {
 412                         warn("%schflags: %s", islink ? "l" : "", to.p_path);
 413                         rval = 1;
 414                 }
 415
 416         return (rval);
 417 }
 418
 419 #ifndef __APPLE__
 420 int
 421 preserve_fd_acls(int source_fd, int dest_fd)
 422 {
 423         struct acl *aclp;
 424         acl_t acl;
 425
 426         if (fpathconf(source_fd, _PC_ACL_EXTENDED) != 1 ||
 427             fpathconf(dest_fd, _PC_ACL_EXTENDED) != 1)
 428                 return (0);
 429         acl = acl_get_fd(source_fd);
 430         if (acl == NULL) {
 431                 warn("failed to get acl entries while setting %s", to.p_path);
 432                 return (1);
 433         }
 434         aclp = &acl->ats_acl;
 435         if (aclp->acl_cnt == 3)
 436                 return (0);
 437         if (acl_set_fd(dest_fd, acl) < 0) {
 438                 warn("failed to set acl entries for %s", to.p_path);
 439                 return (1);
 440         }
 441         return (0);
 442 }
 443
 444 int
 445 preserve_dir_acls(struct stat *fs, char *source_dir, char *dest_dir)
 446 {
 447         acl_t (*aclgetf)(const char *, acl_type_t);
 448         int (*aclsetf)(const char *, acl_type_t, acl_t);
 449         struct acl *aclp;
 450         acl_t acl;
 451
 452         if (pathconf(source_dir, _PC_ACL_EXTENDED) != 1 ||
 453             pathconf(dest_dir, _PC_ACL_EXTENDED) != 1)
 454                 return (0);
 455         /*
 456          * If the file is a link we will not follow it
 457          */
 458         if (S_ISLNK(fs->st_mode)) {
 459                 aclgetf = acl_get_link_np;
 460                 aclsetf = acl_set_link_np;
 461         } else {
 462                 aclgetf = acl_get_file;
 463                 aclsetf = acl_set_file;
 464         }
 465         /*
 466          * Even if there is no ACL_TYPE_DEFAULT entry here, a zero
 467          * size ACL will be returned. So it is not safe to simply
 468          * check the pointer to see if the default ACL is present.
 469          */
 470         acl = aclgetf(source_dir, ACL_TYPE_DEFAULT);
 471         if (acl == NULL) {
 472                 warn("failed to get default acl entries on %s",
 473                     source_dir);
 474                 return (1);
 475         }
 476         aclp = &acl->ats_acl;
 477         if (aclp->acl_cnt != 0 && aclsetf(dest_dir,
 478             ACL_TYPE_DEFAULT, acl) < 0) {
 479                 warn("failed to set default acl entries on %s",
 480                     dest_dir);
 481                 return (1);
 482         }
 483         acl = aclgetf(source_dir, ACL_TYPE_ACCESS);
 484         if (acl == NULL) {
 485                 warn("failed to get acl entries on %s", source_dir);
 486                 return (1);
 487         }
 488         aclp = &acl->ats_acl;
 489         if (aclsetf(dest_dir, ACL_TYPE_ACCESS, acl) < 0) {
 490                 warn("failed to set acl entries on %s", dest_dir);
 491                 return (1);
 492         }
 493         return (0);
 494 }
 495 #endif /* !__APPLE__ */
 496
 497 void
 498 usage(void)
 499 {
 500
 501         if (COMPAT_MODE("bin/cp", "unix2003")) {
 502         (void)fprintf(stderr, "%s\n%s\n",
 503 "usage: cp [-R [-H | -L | -P]] [-fi | -n] [-apvX] source_file target_file",
 504 "       cp [-R [-H | -L | -P]] [-fi | -n] [-apvX] source_file ... "
 505 "target_directory");
 506         } else {
 507         (void)fprintf(stderr, "%s\n%s\n",
 508 "usage: cp [-R [-H | -L | -P]] [-f | -i | -n] [-apvX] source_file target_file",
 509 "       cp [-R [-H | -L | -P]] [-f | -i | -n] [-apvX] source_file ... "
 510 "target_directory");
 511         }
 512         exit(EX_USAGE);
 513 }