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