bin/rm/rm.c

   1 /*-
   2  * Copyright (c) 1990, 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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * @(#) Copyright (c) 1990, 1993, 1994 The Regents of the University of California.  All rights reserved.
  34  * @(#)rm.c     8.5 (Berkeley) 4/18/94
  35  * $FreeBSD: src/bin/rm/rm.c,v 1.29.2.5 2002/07/12 07:25:48 tjr Exp $
  36  * $DragonFly: src/bin/rm/rm.c,v 1.11 2005/01/05 16:24:19 liamfoy Exp $
  37  */
  38
  39 #include <sys/stat.h>
  40 #include <sys/param.h>
  41 #include <sys/mount.h>
  42
  43 #include <err.h>
  44 #include <errno.h>
  45 #include <fcntl.h>
  46 #include <fts.h>
  47 #include <stdio.h>
  48 #include <stdlib.h>
  49 #include <string.h>
  50 #include <sysexits.h>
  51 #include <unistd.h>
  52
  53 int dflag, eval, fflag, iflag, Pflag, vflag, Wflag, stdin_ok;
  54 int rflag, Iflag;
  55 uid_t uid;
  56
  57 static int      check(const char *, const char *, struct stat *);
  58 static int      check2(char **);
  59 static void     checkdot(char **);
  60 static void     rm_file(char **);
  61 static int      rm_overwrite(const char *, struct stat *);
  62 static void     rm_tree(char **);
  63 static void     usage(void);
  64
  65 /*
  66  * rm --
  67  *      This rm is different from historic rm's, but is expected to match
  68  *      POSIX 1003.2 behavior.  The most visible difference is that -f
  69  *      has two specific effects now, ignore non-existent files and force
  70  *      file removal.
  71  */
  72 int
  73 main(int argc, char *argv[])
  74 {
  75         int ch;
  76         const char *p;
  77
  78         /*
  79          * Test for the special case where the utility is called as
  80          * "unlink", for which the functionality provided is greatly
  81          * simplified.
  82          */
  83         if ((p = strrchr(argv[0], '/')) == NULL)
  84                 p = argv[0];
  85         else
  86                 ++p;
  87         if (strcmp(p, "unlink") == 0) {
  88                 while (getopt(argc, argv, "") != -1)
  89                         usage();
  90                 argc -= optind;
  91                 argv += optind;
  92                 if (argc != 1)
  93                         usage();
  94                 rm_file(&argv[0]);
  95                 exit(eval);
  96         }
  97
  98         Pflag = rflag = 0;
  99         while ((ch = getopt(argc, argv, "dfiIPRrvW")) != -1)
 100                 switch(ch) {
 101                 case 'd':
 102                         dflag = 1;
 103                         break;
 104                 case 'f':
 105                         fflag = 1;
 106                         iflag = 0;
 107                         break;
 108                 case 'i':
 109                         fflag = 0;
 110                         iflag = 1;
 111                         break;
 112                 case 'I':
 113                         Iflag = 1;
 114                         break;
 115                 case 'P':
 116                         Pflag = 1;
 117                         break;
 118                 case 'R':
 119                 case 'r':                       /* Compatibility. */
 120                         rflag = 1;
 121                         break;
 122                 case 'v':
 123                         vflag = 1;
 124                         break;
 125                 case 'W':
 126                         Wflag = 1;
 127                         break;
 128                 default:
 129                         usage();
 130                 }
 131         argc -= optind;
 132         argv += optind;
 133
 134         if (argc < 1) {
 135                 if (fflag)
 136                         return 0;
 137                 usage();
 138         }
 139
 140         checkdot(argv);
 141         uid = geteuid();
 142
 143         if (*argv) {
 144                 stdin_ok = isatty(STDIN_FILENO);
 145
 146                 if (Iflag) {
 147                         if (check2(argv) == 0)
 148                                 exit (1);
 149                 }
 150                 if (rflag)
 151                         rm_tree(argv);
 152                 else
 153                         rm_file(argv);
 154         }
 155
 156         exit (eval);
 157 }
 158
 159 static void
 160 rm_tree(char **argv)
 161 {
 162         FTS *fts;
 163         FTSENT *p;
 164         int needstat;
 165         int flags;
 166         int rval;
 167
 168         /*
 169          * Remove a file hierarchy.  If forcing removal (-f), or interactive
 170          * (-i) or can't ask anyway (stdin_ok), don't stat the file.
 171          */
 172         needstat = !uid || (!fflag && !iflag && stdin_ok);
 173
 174         /*
 175          * If the -i option is specified, the user can skip on the pre-order
 176          * visit.  The fts_number field flags skipped directories.
 177          */
 178 #define SKIPPED 1
 179
 180         flags = FTS_PHYSICAL;
 181         if (!needstat)
 182                 flags |= FTS_NOSTAT;
 183         if (Wflag)
 184                 flags |= FTS_WHITEOUT;
 185         if ((fts = fts_open(argv, flags, NULL)) == NULL) {
 186                 if (fflag && errno == ENOENT)
 187                         return;
 188                 err(1, NULL);
 189         }
 190         while ((p = fts_read(fts)) != NULL) {
 191                 switch (p->fts_info) {
 192                 case FTS_DNR:
 193                         if (!fflag || p->fts_errno != ENOENT) {
 194                                 warnx("%s: %s",
 195                                     p->fts_path, strerror(p->fts_errno));
 196                                 eval = 1;
 197                         }
 198                         continue;
 199                 case FTS_ERR:
 200                         errx(1, "%s: %s", p->fts_path, strerror(p->fts_errno));
 201                 case FTS_NS:
 202                        /*
 203                         * Assume that since fts_read() couldn't stat
 204                         * the file, it can't be unlinked.
 205                         */
 206                         if (!needstat)
 207                                 break;
 208                         if (!fflag || p->fts_errno != ENOENT) {
 209                                 warnx("%s: %s",
 210                                     p->fts_path, strerror(p->fts_errno));
 211                                 eval = 1;
 212                         }
 213                         continue;
 214                 case FTS_D:
 215                         /* Pre-order: give user chance to skip. */
 216                         if (!fflag && !check(p->fts_path, p->fts_accpath,
 217                             p->fts_statp)) {
 218                                 fts_set(fts, p, FTS_SKIP);
 219                                 p->fts_number = SKIPPED;
 220                         }
 221                         else if (!uid &&
 222                                  (p->fts_statp->st_flags & (UF_APPEND|UF_IMMUTABLE)) &&
 223                                  !(p->fts_statp->st_flags & (SF_APPEND|SF_IMMUTABLE)) &&
 224                                  chflags(p->fts_accpath,
 225                                          p->fts_statp->st_flags &= ~(UF_APPEND|UF_IMMUTABLE)) < 0)
 226                                 goto err;
 227                         continue;
 228                 case FTS_DP:
 229                         /* Post-order: see if user skipped. */
 230                         if (p->fts_number == SKIPPED)
 231                                 continue;
 232                         break;
 233                 default:
 234                         if (!fflag &&
 235                             !check(p->fts_path, p->fts_accpath, p->fts_statp))
 236                                 continue;
 237                 }
 238
 239                 rval = 0;
 240                 if (!uid &&
 241                     (p->fts_statp->st_flags & (UF_APPEND|UF_IMMUTABLE)) &&
 242                     !(p->fts_statp->st_flags & (SF_APPEND|SF_IMMUTABLE)))
 243                         rval = chflags(p->fts_accpath,
 244                                        p->fts_statp->st_flags &= ~(UF_APPEND|UF_IMMUTABLE));
 245                 if (rval == 0) {
 246                         /*
 247                          * If we can't read or search the directory, may still be
 248                          * able to remove it.  Don't print out the un{read,search}able
 249                          * message unless the remove fails.
 250                          */
 251                         switch (p->fts_info) {
 252                         case FTS_DP:
 253                         case FTS_DNR:
 254                                 rval = rmdir(p->fts_accpath);
 255                                 if (rval == 0 || (fflag && errno == ENOENT)) {
 256                                         if (rval == 0 && vflag)
 257                                                 printf("%s\n",
 258                                                     p->fts_path);
 259                                         continue;
 260                                 }
 261                                 break;
 262
 263                         case FTS_W:
 264                                 rval = undelete(p->fts_accpath);
 265                                 if (rval == 0 && (fflag && errno == ENOENT)) {
 266                                         if (vflag)
 267                                                 printf("%s\n",
 268                                                     p->fts_path);
 269                                         continue;
 270                                 }
 271                                 break;
 272
 273                         case FTS_NS:
 274                         /*
 275                          * Assume that since fts_read() couldn't stat
 276                          * the file, it can't be unlinked.
 277                          */
 278                                 if (fflag)
 279                                         continue;
 280                                 /* FALLTHROUGH */
 281                         default:
 282                                 if (Pflag)
 283                                         if (!rm_overwrite(p->fts_accpath, NULL))
 284                                                 continue;
 285                                 rval = unlink(p->fts_accpath);
 286                                 if (rval == 0 || (fflag && errno == ENOENT)) {
 287                                         if (rval == 0 && vflag)
 288                                                 printf("%s\n",
 289                                                     p->fts_path);
 290                                         continue;
 291                                 }
 292                         }
 293                 }
 294 err:
 295                 warn("%s", p->fts_path);
 296                 eval = 1;
 297         }
 298         if (errno)
 299                 err(1, "fts_read");
 300 }
 301
 302 static void
 303 rm_file(char **argv)
 304 {
 305         struct stat sb;
 306         int rval;
 307         const char *f;
 308
 309         /*
 310          * Remove a file.  POSIX 1003.2 states that, by default, attempting
 311          * to remove a directory is an error, so must always stat the file.
 312          */
 313         while ((f = *argv++) != NULL) {
 314                 /* Assume if can't stat the file, can't unlink it. */
 315                 if (lstat(f, &sb)) {
 316                         if (Wflag) {
 317                                 sb.st_mode = S_IFWHT|S_IWUSR|S_IRUSR;
 318                         } else {
 319                                 if (!fflag || errno != ENOENT) {
 320                                         warn("%s", f);
 321                                         eval = 1;
 322                                 }
 323                                 continue;
 324                         }
 325                 } else if (Wflag) {
 326                         warnx("%s: %s", f, strerror(EEXIST));
 327                         eval = 1;
 328                         continue;
 329                 }
 330
 331                 if (S_ISDIR(sb.st_mode) && !dflag) {
 332                         warnx("%s: is a directory", f);
 333                         eval = 1;
 334                         continue;
 335                 }
 336                 if (!fflag && !S_ISWHT(sb.st_mode) && !check(f, f, &sb))
 337                         continue;
 338                 rval = 0;
 339                 if (!uid &&
 340                     (sb.st_flags & (UF_APPEND|UF_IMMUTABLE)) &&
 341                     !(sb.st_flags & (SF_APPEND|SF_IMMUTABLE)))
 342                         rval = chflags(f, sb.st_flags & ~(UF_APPEND|UF_IMMUTABLE));
 343                 if (rval == 0) {
 344                         if (S_ISWHT(sb.st_mode))
 345                                 rval = undelete(f);
 346                         else if (S_ISDIR(sb.st_mode))
 347                                 rval = rmdir(f);
 348                         else {
 349                                 if (Pflag)
 350                                         if (!rm_overwrite(f, &sb))
 351                                                 continue;
 352                                 rval = unlink(f);
 353                         }
 354                 }
 355                 if (rval && (!fflag || errno != ENOENT)) {
 356                         warn("%s", f);
 357                         eval = 1;
 358                 }
 359                 if (vflag && rval == 0)
 360                         printf("%s\n", f);
 361         }
 362 }
 363
 364 /*
 365  * rm_overwrite --
 366  *      Overwrite the file 3 times with varying bit patterns.
 367  *
 368  * XXX
 369  * This is a cheap way to *really* delete files.  Note that only regular
 370  * files are deleted, directories (and therefore names) will remain.
 371  * Also, this assumes a fixed-block filesystem (like FFS, or a V7 or a
 372  * System V filesystem).  In a logging filesystem, you'll have to have
 373  * kernel support.
 374  */
 375 static int
 376 rm_overwrite(const char *file, struct stat *sbp)
 377 {
 378         struct stat sb;
 379         struct statfs fsb;
 380         off_t len;
 381         int bsize, fd, wlen;
 382         char *buf = NULL;
 383
 384         fd = -1;
 385         if (sbp == NULL) {
 386                 if (lstat(file, &sb))
 387                         goto err;
 388                 sbp = &sb;
 389         }
 390         if (!S_ISREG(sbp->st_mode)) {
 391                 warnx("%s: cannot overwrite a non-regular file", file);
 392                 return (1);
 393         }
 394         if ((fd = open(file, O_WRONLY, 0)) == -1)
 395                 goto err;
 396         if (fstatfs(fd, &fsb) == -1)
 397                 goto err;
 398         bsize = MAX(fsb.f_iosize, 1024);
 399         if ((buf = malloc(bsize)) == NULL)
 400                 err(1, "%s malloc failed", file);
 401
 402 #define PASS(byte) {                                                    \
 403         memset(buf, byte, bsize);                                       \
 404         for (len = sbp->st_size; len > 0; len -= wlen) {                \
 405                 wlen = len < bsize ? len : bsize;                       \
 406                 if (write(fd, buf, wlen) != wlen)                       \
 407                         goto err;                                       \
 408         }                                                               \
 409 }
 410         PASS(0xff);
 411         if (fsync(fd) || lseek(fd, (off_t)0, SEEK_SET))
 412                 goto err;
 413         PASS(0x00);
 414         if (fsync(fd) || lseek(fd, (off_t)0, SEEK_SET))
 415                 goto err;
 416         PASS(0xff);
 417         if (!fsync(fd) && !close(fd)) {
 418                 free(buf);
 419                 return (1);
 420         }
 421
 422 err:    eval = 1;
 423         if (buf)
 424                 free(buf);
 425         if (fd != -1)
 426                 close(fd);
 427         warn("%s", file);
 428         return (0);
 429 }
 430
 431
 432 static int
 433 check(const char *path, const char *name, struct stat *sp)
 434 {
 435         int ch, first;
 436         char modep[15], *flagsp;
 437
 438         /* Check -i first. */
 439         if (iflag)
 440                 fprintf(stderr, "remove %s? ", path);
 441         else {
 442                 /*
 443                  * If it's not a symbolic link and it's unwritable and we're
 444                  * talking to a terminal, ask.  Symbolic links are excluded
 445                  * because their permissions are meaningless.  Check stdin_ok
 446                  * first because we may not have stat'ed the file.
 447                  * Also skip this check if the -P option was specified because
 448                  * we will not be able to overwrite file contents and will
 449                  * barf later.
 450                  */
 451                 if (!stdin_ok || S_ISLNK(sp->st_mode) || Pflag ||
 452                     (!access(name, W_OK) &&
 453                     !(sp->st_flags & (SF_APPEND|SF_IMMUTABLE)) &&
 454                     (!(sp->st_flags & (UF_APPEND|UF_IMMUTABLE)) || !uid)))
 455                         return (1);
 456                 strmode(sp->st_mode, modep);
 457                 if ((flagsp = fflagstostr(sp->st_flags)) == NULL)
 458                         err(1, NULL);
 459                 fprintf(stderr, "override %s%s%s/%s %s%sfor %s? ",
 460                     modep + 1, modep[9] == ' ' ? "" : " ",
 461                     user_from_uid(sp->st_uid, 0),
 462                     group_from_gid(sp->st_gid, 0),
 463                     *flagsp ? flagsp : "", *flagsp ? " " : "",
 464                     path);
 465                 free(flagsp);
 466         }
 467         fflush(stderr);
 468
 469         first = ch = getchar();
 470         while (ch != '\n' && ch != EOF)
 471                 ch = getchar();
 472         return (first == 'y' || first == 'Y');
 473 }
 474
 475 static int
 476 check2(char **argv)
 477 {
 478         struct stat st;
 479         int first;
 480         int ch;
 481         int fcount = 0;
 482         int dcount = 0;
 483         int i;
 484         const char *dname = NULL;
 485
 486         for (i = 0; argv[i]; ++i) {
 487                 if (lstat(argv[i], &st) == 0) {
 488                         if (S_ISDIR(st.st_mode)) {
 489                                 ++dcount;
 490                                 dname = argv[i];    /* only used if 1 dir */
 491                         } else {
 492                                 ++fcount;
 493                         }
 494                 }
 495         }
 496         first = 0;
 497         while (first != 'n' && first != 'N' && first != 'y' && first != 'Y') {
 498                 if (dcount && rflag) {
 499                         fprintf(stderr, "recursively remove");
 500                         if (dcount == 1)
 501                                 fprintf(stderr, " %s", dname);
 502                         else
 503                                 fprintf(stderr, " %d dirs", dcount);
 504                         if (fcount == 1)
 505                                 fprintf(stderr, " and 1 file");
 506                         else if (fcount > 1)
 507                                 fprintf(stderr, " and %d files", fcount);
 508                 } else if (dcount + fcount > 3) {
 509                         fprintf(stderr, "remove %d files", dcount + fcount);
 510                 } else {
 511                         return(1);
 512                 }
 513                 fprintf(stderr, "? ");
 514                 fflush(stderr);
 515
 516                 first = ch = getchar();
 517                 while (ch != '\n' && ch != EOF)
 518                         ch = getchar();
 519                 if (ch == EOF)
 520                         break;
 521         }
 522         return (first == 'y' || first == 'Y');
 523 }
 524
 525 #define ISDOT(a)        ((a)[0] == '.' && (!(a)[1] || ((a)[1] == '.' && !(a)[2])))
 526 static void
 527 checkdot(char **argv)
 528 {
 529         char *p, **save, **t;
 530         int complained;
 531
 532         complained = 0;
 533         for (t = argv; *t;) {
 534                 if ((p = strrchr(*t, '/')) != NULL)
 535                         ++p;
 536                 else
 537                         p = *t;
 538                 if (ISDOT(p)) {
 539                         if (!complained++)
 540                                 warnx("\".\" and \"..\" may not be removed");
 541                         eval = 1;
 542                         for (save = t; (t[0] = t[1]) != NULL; ++t)
 543                                 continue;
 544                         t = save;
 545                 } else
 546                         ++t;
 547         }
 548 }
 549
 550 static void
 551 usage(void)
 552 {
 553
 554         fprintf(stderr, "%s\n%s\n",
 555             "usage: rm [-f | -i] [-dIPRrvW] file ...",
 556             "       unlink file");
 557         exit(EX_USAGE);
 558 }