findutils/find.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini find implementation for busybox
   4  *
   5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
   6  *
   7  * Reworked by David Douthitt <n9ubh@callsign.net> and
   8  *  Matt Kraai <kraai@alumni.carnegiemellon.edu>.
   9  *
  10  * Licensed under the GPL version 2, see the file LICENSE in this tarball.
  11  */
  12
  13 /* findutils-4.1.20:
  14  *
  15  * # find file.txt -exec 'echo {}' '{}  {}' ';'
  16  * find: echo file.txt: No such file or directory
  17  * # find file.txt -exec 'echo' '{}  {}' '; '
  18  * find: missing argument to `-exec'
  19  * # find file.txt -exec 'echo {}' '{}  {}' ';' junk
  20  * find: paths must precede expression
  21  * # find file.txt -exec 'echo {}' '{}  {}' ';' junk ';'
  22  * find: paths must precede expression
  23  * # find file.txt -exec 'echo' '{}  {}' ';'
  24  * file.txt  file.txt
  25  * (strace: execve("/bin/echo", ["echo", "file.txt  file.txt"], [ 30 vars ]))
  26  * # find file.txt -exec 'echo' '{}  {}' ';' -print -exec pwd ';'
  27  * file.txt  file.txt
  28  * file.txt
  29  * /tmp
  30  * # find -name '*.c' -o -name '*.h'
  31  * [shows files, *.c and *.h intermixed]
  32  * # find file.txt -name '*f*' -o -name '*t*'
  33  * file.txt
  34  * # find file.txt -name '*z*' -o -name '*t*'
  35  * file.txt
  36  * # find file.txt -name '*f*' -o -name '*z*'
  37  * file.txt
  38  *
  39  * # find t z -name '*t*' -print -o -name '*z*'
  40  * t
  41  * # find t z t z -name '*t*' -o -name '*z*' -print
  42  * z
  43  * z
  44  * # find t z t z '(' -name '*t*' -o -name '*z*' ')' -o -print
  45  * (no output)
  46  */
  47
  48 #include "busybox.h"
  49 #include <fnmatch.h>
  50
  51 USE_FEATURE_FIND_XDEV(static dev_t *xdev_dev;)
  52 USE_FEATURE_FIND_XDEV(static int xdev_count;)
  53
  54 typedef int (*action_fp)(const char *fileName, struct stat *statbuf, void *);
  55
  56 typedef struct {
  57         action_fp f;
  58 } action;
  59 #define SACT(name, arg...) typedef struct { action a; arg; } action_##name;
  60 #define SFUNC(name)        static int func_##name(const char *fileName, struct stat *statbuf, action_##name* ap)
  61                         SACT(print)
  62                         SACT(name,  char *pattern;)
  63 USE_FEATURE_FIND_PRINT0(SACT(print0))
  64 USE_FEATURE_FIND_TYPE(  SACT(type,  int type_mask;))
  65 USE_FEATURE_FIND_PERM(  SACT(perm,  char perm_char; int perm_mask;))
  66 USE_FEATURE_FIND_MTIME( SACT(mtime, char mtime_char; int mtime_days;))
  67 USE_FEATURE_FIND_MMIN(  SACT(mmin,  char mmin_char; int mmin_mins;))
  68 USE_FEATURE_FIND_NEWER( SACT(newer, time_t newer_mtime;))
  69 USE_FEATURE_FIND_INUM(  SACT(inum,  ino_t inode_num;))
  70 USE_FEATURE_FIND_EXEC(  SACT(exec,  char **exec_argv; int *subst_count; int exec_argc;))
  71 USE_DESKTOP(            SACT(paren, action ***subexpr;))
  72 USE_DESKTOP(            SACT(prune))
  73
  74 static action ***actions;
  75 static int need_print = 1;
  76
  77 static inline int one_char(const char* str, char c)
  78 {
  79         return (str[0] == c && str[1] == '\0');
  80 }
  81
  82
  83 static int count_subst(const char *str)
  84 {
  85         int count = 0;
  86         while ((str = strstr(str, "{}"))) {
  87                 count++;
  88                 str++;
  89         }
  90         return count;
  91 }
  92
  93
  94 static char* subst(const char *src, int count, const char* filename)
  95 {
  96         char *buf, *dst, *end;
  97         int flen = strlen(filename);
  98         /* we replace each '{}' with filename: growth by strlen-2 */
  99         buf = dst = xmalloc(strlen(src) + count*(flen-2) + 1);
 100         while ((end = strstr(src, "{}"))) {
 101                 memcpy(dst, src, end - src);
 102                 dst += end - src;
 103                 src = end + 2;
 104                 memcpy(dst, filename, flen);
 105                 dst += flen;
 106         }
 107         strcpy(dst, src);
 108         return buf;
 109 }
 110
 111
 112 static int exec_actions(action ***appp, const char *fileName, struct stat *statbuf)
 113 {
 114         int cur_group;
 115         int cur_action;
 116         int rc = TRUE;
 117         action **app, *ap;
 118
 119         cur_group = -1;
 120         while ((app = appp[++cur_group])) {
 121                 cur_action = -1;
 122                 do {
 123                         ap = app[++cur_action];
 124                 } while (ap && (rc = ap->f(fileName, statbuf, ap)));
 125                 if (!ap) {
 126                         /* all actions in group were successful */
 127                         break;
 128                 }
 129         }
 130         return rc;
 131 }
 132
 133
 134 SFUNC(name)
 135 {
 136         const char *tmp = strrchr(fileName, '/');
 137         if (tmp == NULL)
 138                 tmp = fileName;
 139         else
 140                 tmp++;
 141         return fnmatch(ap->pattern, tmp, FNM_PERIOD) == 0;
 142 }
 143 #if ENABLE_FEATURE_FIND_TYPE
 144 SFUNC(type)
 145 {
 146         return !((statbuf->st_mode & S_IFMT) == ap->type_mask);
 147 }
 148 #endif
 149 #if ENABLE_FEATURE_FIND_PERM
 150 SFUNC(perm)
 151 {
 152         return !((isdigit(ap->perm_char) && (statbuf->st_mode & 07777) == ap->perm_mask)
 153                 || (ap->perm_char == '-' && (statbuf->st_mode & ap->perm_mask) == ap->perm_mask)
 154                 || (ap->perm_char == '+' && (statbuf->st_mode & ap->perm_mask) != 0));
 155 }
 156 #endif
 157 #if ENABLE_FEATURE_FIND_MTIME
 158 SFUNC(mtime)
 159 {
 160         time_t file_age = time(NULL) - statbuf->st_mtime;
 161         time_t mtime_secs = ap->mtime_days * 24 * 60 * 60;
 162         return !((isdigit(ap->mtime_char) && file_age >= mtime_secs
 163                                           && file_age < mtime_secs + 24 * 60 * 60)
 164                 || (ap->mtime_char == '+' && file_age >= mtime_secs + 24 * 60 * 60)
 165                 || (ap->mtime_char == '-' && file_age < mtime_secs));
 166 }
 167 #endif
 168 #if ENABLE_FEATURE_FIND_MMIN
 169 SFUNC(mmin)
 170 {
 171         time_t file_age = time(NULL) - statbuf->st_mtime;
 172         time_t mmin_secs = ap->mmin_mins * 60;
 173         return !((isdigit(ap->mmin_char) && file_age >= mmin_secs
 174                                          && file_age < mmin_secs + 60)
 175                 || (ap->mmin_char == '+' && file_age >= mmin_secs + 60)
 176                 || (ap->mmin_char == '-' && file_age < mmin_secs));
 177 }
 178 #endif
 179 #if ENABLE_FEATURE_FIND_NEWER
 180 SFUNC(newer)
 181 {
 182         return (ap->newer_mtime >= statbuf->st_mtime);
 183 }
 184 #endif
 185 #if ENABLE_FEATURE_FIND_INUM
 186 SFUNC(inum)
 187 {
 188         return (statbuf->st_ino != ap->inode_num);
 189 }
 190 #endif
 191 #if ENABLE_FEATURE_FIND_EXEC
 192 SFUNC(exec)
 193 {
 194         int i, rc;
 195         char *argv[ap->exec_argc+1];
 196         for (i = 0; i < ap->exec_argc; i++)
 197                 argv[i] = subst(ap->exec_argv[i], ap->subst_count[i], fileName);
 198         argv[i] = NULL; /* terminate the list */
 199         errno = 0;
 200         rc = wait4pid(spawn(argv));
 201         if (errno)
 202                 bb_perror_msg("%s", argv[0]);
 203         for (i = 0; i < ap->exec_argc; i++)
 204                 free(argv[i]);
 205         return rc == 0; /* return 1 if success */
 206 }
 207 #endif
 208
 209 #if ENABLE_FEATURE_FIND_PRINT0
 210 SFUNC(print0)
 211 {
 212         printf("%s%c", fileName, '\0');
 213         return TRUE;
 214 }
 215 #endif
 216
 217 SFUNC(print)
 218 {
 219         puts(fileName);
 220         return TRUE;
 221 }
 222
 223 #if ENABLE_DESKTOP
 224 SFUNC(paren)
 225 {
 226         return exec_actions(ap->subexpr, fileName, statbuf);
 227 }
 228 /*
 229  * -prune: if -depth is not given, return true and do not descend
 230  * current dir; if -depth is given, return false with no effect.
 231  * Example:
 232  * find dir -name 'asm-*' -prune -o -name '*.[chS]' -print
 233  */
 234 SFUNC(prune)
 235 {
 236         return SKIP;
 237 }
 238 #endif
 239
 240
 241 static int fileAction(const char *fileName, struct stat *statbuf, void* junk, int depth)
 242 {
 243         int rc;
 244 #ifdef CONFIG_FEATURE_FIND_XDEV
 245         if (S_ISDIR(statbuf->st_mode) && xdev_count) {
 246                 int i;
 247                 for (i = 0; i < xdev_count; i++) {
 248                         if (xdev_dev[i] != statbuf->st_dev)
 249                                 return SKIP;
 250                 }
 251         }
 252 #endif
 253         rc = exec_actions(actions, fileName, statbuf);
 254         /* Had no explicit -print[0] or -exec? then print */
 255         if (rc && need_print)
 256                 puts(fileName);
 257         /* Cannot return 0: our caller, recursive_action(),
 258          * will perror() and skip dirs (if called on dir) */
 259         return rc == 0 ? TRUE : rc;
 260 }
 261
 262
 263 #if ENABLE_FEATURE_FIND_TYPE
 264 static int find_type(char *type)
 265 {
 266         int mask = 0;
 267
 268         switch (type[0]) {
 269         case 'b':
 270                 mask = S_IFBLK;
 271                 break;
 272         case 'c':
 273                 mask = S_IFCHR;
 274                 break;
 275         case 'd':
 276                 mask = S_IFDIR;
 277                 break;
 278         case 'p':
 279                 mask = S_IFIFO;
 280                 break;
 281         case 'f':
 282                 mask = S_IFREG;
 283                 break;
 284         case 'l':
 285                 mask = S_IFLNK;
 286                 break;
 287         case 's':
 288                 mask = S_IFSOCK;
 289                 break;
 290         }
 291
 292         if (mask == 0 || type[1] != '\0')
 293                 bb_error_msg_and_die(bb_msg_invalid_arg, type, "-type");
 294
 295         return mask;
 296 }
 297 #endif
 298
 299 action*** parse_params(char **argv)
 300 {
 301         action*** appp;
 302         int cur_group = 0;
 303         int cur_action = 0;
 304
 305         action* alloc_action(int sizeof_struct, action_fp f)
 306         {
 307                 action *ap;
 308                 appp[cur_group] = xrealloc(appp[cur_group], (cur_action+2) * sizeof(*appp));
 309                 appp[cur_group][cur_action++] = ap = xmalloc(sizeof_struct);
 310                 appp[cur_group][cur_action] = NULL;
 311                 ap->f = f;
 312                 return ap;
 313         }
 314 #define ALLOC_ACTION(name) (action_##name*)alloc_action(sizeof(action_##name), (action_fp) func_##name)
 315
 316         appp = xzalloc(2 * sizeof(*appp)); /* appp[0],[1] == NULL */
 317
 318 // Actions have side effects and return a true or false value
 319 // We implement: -print, -print0, -exec
 320
 321 // The rest are tests.
 322
 323 // Tests and actions are grouped by operators
 324 // ( expr )              Force precedence
 325 // ! expr                True if expr is false
 326 // -not expr             Same as ! expr
 327 // expr1 [-a[nd]] expr2  And; expr2 is not evaluated if expr1 is false
 328 // expr1 -o[r] expr2     Or; expr2 is not evaluated if expr1 is true
 329 // expr1 , expr2         List; both expr1 and expr2 are always evaluated
 330 // We implement: (), -a, -o
 331
 332         while (*argv) {
 333                 char *arg = argv[0];
 334                 char *arg1 = argv[1];
 335         /* --- Operators --- */
 336                 if (strcmp(arg, "-a") == 0
 337                     USE_DESKTOP(|| strcmp(arg, "-and") == 0)
 338                 ) {
 339                         /* no special handling required */
 340                 }
 341                 else if (strcmp(arg, "-o") == 0
 342                          USE_DESKTOP(|| strcmp(arg, "-or") == 0)
 343                 ) {
 344                         /* start new OR group */
 345                         cur_group++;
 346                         appp = xrealloc(appp, (cur_group+2) * sizeof(*appp));
 347                         appp[cur_group] = NULL;
 348                         appp[cur_group+1] = NULL;
 349                         cur_action = 0;
 350                 }
 351
 352         /* --- Tests and actions --- */
 353                 else if (strcmp(arg, "-print") == 0) {
 354                         need_print = 0;
 355                         (void) ALLOC_ACTION(print);
 356                 }
 357 #if ENABLE_FEATURE_FIND_PRINT0
 358                 else if (strcmp(arg, "-print0") == 0) {
 359                         need_print = 0;
 360                         (void) ALLOC_ACTION(print0);
 361                 }
 362 #endif
 363                 else if (strcmp(arg, "-name") == 0) {
 364                         action_name *ap;
 365                         if (!*++argv)
 366                                 bb_error_msg_and_die(bb_msg_requires_arg, arg);
 367                         ap = ALLOC_ACTION(name);
 368                         ap->pattern = arg1;
 369                 }
 370 #if ENABLE_FEATURE_FIND_TYPE
 371                 else if (strcmp(arg, "-type") == 0) {
 372                         action_type *ap;
 373                         if (!*++argv)
 374                                 bb_error_msg_and_die(bb_msg_requires_arg, arg);
 375                         ap = ALLOC_ACTION(type);
 376                         ap->type_mask = find_type(arg1);
 377                 }
 378 #endif
 379 #if ENABLE_FEATURE_FIND_PERM
 380 /* TODO:
 381  * -perm mode   File's permission bits are exactly mode (octal or symbolic).
 382  *              Symbolic modes use mode 0 as a point of departure.
 383  * -perm -mode  All of the permission bits mode are set for the file.
 384  * -perm +mode  Any of the permission bits mode are set for the file.
 385  */
 386                 else if (strcmp(arg, "-perm") == 0) {
 387                         action_perm *ap;
 388                         if (!*++argv)
 389                                 bb_error_msg_and_die(bb_msg_requires_arg, arg);
 390                         ap = ALLOC_ACTION(perm);
 391                         ap->perm_mask = xstrtol_range(arg1, 8, 0, 07777);
 392                         ap->perm_char = arg1[0];
 393                         if (ap->perm_char == '-')
 394                                 ap->perm_mask = -ap->perm_mask;
 395                 }
 396 #endif
 397 #if ENABLE_FEATURE_FIND_MTIME
 398                 else if (strcmp(arg, "-mtime") == 0) {
 399                         action_mtime *ap;
 400                         if (!*++argv)
 401                                 bb_error_msg_and_die(bb_msg_requires_arg, arg);
 402                         ap = ALLOC_ACTION(mtime);
 403                         ap->mtime_days = xatol(arg1);
 404                         ap->mtime_char = arg1[0];
 405                         if (ap->mtime_char == '-')
 406                                 ap->mtime_days = -ap->mtime_days;
 407                 }
 408 #endif
 409 #if ENABLE_FEATURE_FIND_MMIN
 410                 else if (strcmp(arg, "-mmin") == 0) {
 411                         action_mmin *ap;
 412                         if (!*++argv)
 413                                 bb_error_msg_and_die(bb_msg_requires_arg, arg);
 414                         ap = ALLOC_ACTION(mmin);
 415                         ap->mmin_mins = xatol(arg1);
 416                         ap->mmin_char = arg1[0];
 417                         if (ap->mmin_char == '-')
 418                                 ap->mmin_mins = -ap->mmin_mins;
 419                 }
 420 #endif
 421 #if ENABLE_FEATURE_FIND_NEWER
 422                 else if (strcmp(arg, "-newer") == 0) {
 423                         action_newer *ap;
 424                         struct stat stat_newer;
 425                         if (!*++argv)
 426                                 bb_error_msg_and_die(bb_msg_requires_arg, arg);
 427                         xstat(arg1, &stat_newer);
 428                         ap = ALLOC_ACTION(newer);
 429                         ap->newer_mtime = stat_newer.st_mtime;
 430                 }
 431 #endif
 432 #if ENABLE_FEATURE_FIND_INUM
 433                 else if (strcmp(arg, "-inum") == 0) {
 434                         action_inum *ap;
 435                         if (!*++argv)
 436                                 bb_error_msg_and_die(bb_msg_requires_arg, arg);
 437                         ap = ALLOC_ACTION(inum);
 438                         ap->inode_num = xatoul(arg1);
 439                 }
 440 #endif
 441 #if ENABLE_FEATURE_FIND_EXEC
 442                 else if (strcmp(arg, "-exec") == 0) {
 443                         int i;
 444                         action_exec *ap;
 445                         need_print = 0;
 446                         ap = ALLOC_ACTION(exec);
 447                         ap->exec_argv = ++argv; /* first arg after -exec */
 448                         ap->exec_argc = 0;
 449                         while (1) {
 450                                 if (!*argv) /* did not see ';' till end */
 451                                         bb_error_msg_and_die(bb_msg_requires_arg, arg);
 452                                 if (one_char(argv[0], ';'))
 453                                         break;
 454                                 argv++;
 455                                 ap->exec_argc++;
 456                         }
 457                         if (ap->exec_argc == 0)
 458                                 bb_error_msg_and_die(bb_msg_requires_arg, arg);
 459                         ap->subst_count = xmalloc(ap->exec_argc * sizeof(int));
 460                         i = ap->exec_argc;
 461                         while (i--)
 462                                 ap->subst_count[i] = count_subst(ap->exec_argv[i]);
 463                 }
 464 #endif
 465 #if ENABLE_DESKTOP
 466                 else if (one_char(arg, '(')) {
 467                         action_paren *ap;
 468                         char **endarg;
 469                         int nested = 1;
 470
 471                         endarg = argv;
 472                         while (1) {
 473                                 if (!*++endarg)
 474                                         bb_error_msg_and_die("unpaired '('");
 475                                 if (one_char(*endarg, '('))
 476                                         nested++;
 477                                 else if (one_char(*endarg, ')') && !--nested) {
 478                                         *endarg = NULL;
 479                                         break;
 480                                 }
 481                         }
 482                         ap = ALLOC_ACTION(paren);
 483                         ap->subexpr = parse_params(argv + 1);
 484                         *endarg = ")"; /* restore NULLed parameter */
 485                         argv = endarg;
 486                 }
 487                 else if (strcmp(arg, "-prune") == 0) {
 488                         (void) ALLOC_ACTION(prune);
 489                 }
 490 #endif
 491                 else
 492                         bb_show_usage();
 493                 argv++;
 494         }
 495
 496         return appp;
 497 #undef ALLOC_ACTION
 498 }
 499
 500
 501 int find_main(int argc, char **argv)
 502 {
 503         int dereference = FALSE;
 504         char **argp;
 505         int i, firstopt, status = EXIT_SUCCESS;
 506
 507         for (firstopt = 1; firstopt < argc; firstopt++) {
 508                 if (argv[firstopt][0] == '-')
 509                         break;
 510 #if ENABLE_DESKTOP
 511                 if (one_char(argv[firstopt], '('))
 512                         break;
 513 #endif
 514         }
 515         if (firstopt == 1) {
 516                 argv[0] = ".";
 517                 argv--;
 518                 firstopt++;
 519         }
 520
 521 // All options always return true. They always take effect,
 522 // rather than being processed only when their place in the
 523 // expression is reached
 524 // We implement: -follow, -xdev
 525
 526         /* Process options, and replace then with -a */
 527         /* (that will be ignored by recursive parser later) */
 528         argp = &argv[firstopt];
 529         while (*argp) {
 530                 char *arg = argp[0];
 531                 if (strcmp(arg, "-follow") == 0) {
 532                         dereference = TRUE;
 533                         argp[0] = "-a";
 534                 }
 535 #if ENABLE_FEATURE_FIND_XDEV
 536                 else if (strcmp(arg, "-xdev") == 0) {
 537                         struct stat stbuf;
 538                         if (!xdev_count) {
 539                                 xdev_count = firstopt - 1;
 540                                 xdev_dev = xmalloc(xdev_count * sizeof(dev_t));
 541                                 for (i = 1; i < firstopt; i++) {
 542                                         /* not xstat(): shouldn't bomb out on
 543                                          * "find not_exist exist -xdev" */
 544                                         if (stat(argv[i], &stbuf)) stbuf.st_dev = -1L;
 545                                         xdev_dev[i-1] = stbuf.st_dev;
 546                                 }
 547                         }
 548                         argp[0] = "-a";
 549                 }
 550                 argp++;
 551         }
 552 #endif
 553
 554         actions = parse_params(&argv[firstopt]);
 555
 556         for (i = 1; i < firstopt; i++) {
 557                 if (!recursive_action(argv[i],
 558                                 TRUE,           // recurse
 559                                 dereference,    // follow links
 560                                 FALSE,          // depth first
 561                                 fileAction,     // file action
 562                                 fileAction,     // dir action
 563                                 NULL,           // user data
 564                                 0))             // depth
 565                         status = EXIT_FAILURE;
 566         }
 567         return status;
 568 }