1 /* vi: set sw=4 ts=4: */
3 * Mini find implementation for busybox
5 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
7 * Reworked by David Douthitt <n9ubh@callsign.net> and
8 * Matt Kraai <kraai@alumni.carnegiemellon.edu>.
10 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
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' '{} {}' ';'
25 * (strace: execve("/bin/echo", ["echo", "file.txt file.txt"], [ 30 vars ]))
26 * # find file.txt -exec 'echo' '{} {}' ';' -print -exec pwd ';'
30 * # find -name '*.c' -o -name '*.h'
31 * [shows files, *.c and *.h intermixed]
32 * # find file.txt -name '*f*' -o -name '*t*'
34 * # find file.txt -name '*z*' -o -name '*t*'
36 * # find file.txt -name '*f*' -o -name '*z*'
39 * # find t z -name '*t*' -print -o -name '*z*'
41 * # find t z t z -name '*t*' -o -name '*z*' -print
44 * # find t z t z '(' -name '*t*' -o -name '*z*' ')' -o -print
51 USE_FEATURE_FIND_XDEV(static dev_t *xdev_dev;)
52 USE_FEATURE_FIND_XDEV(static int xdev_count;)
54 typedef int (*action_fp)(const char *fileName, struct stat *statbuf, void *);
58 #if ENABLE_FEATURE_FIND_NOT
62 #define ACTS(name, arg...) typedef struct { action a; arg; } action_##name;
63 #define ACTF(name) static int func_##name(const char *fileName, struct stat *statbuf, action_##name* ap)
65 ACTS(name, const char *pattern;)
66 USE_FEATURE_FIND_PRINT0(ACTS(print0))
67 USE_FEATURE_FIND_TYPE( ACTS(type, int type_mask;))
68 USE_FEATURE_FIND_PERM( ACTS(perm, char perm_char; mode_t perm_mask;))
69 USE_FEATURE_FIND_MTIME( ACTS(mtime, char mtime_char; unsigned mtime_days;))
70 USE_FEATURE_FIND_MMIN( ACTS(mmin, char mmin_char; unsigned mmin_mins;))
71 USE_FEATURE_FIND_NEWER( ACTS(newer, time_t newer_mtime;))
72 USE_FEATURE_FIND_INUM( ACTS(inum, ino_t inode_num;))
73 USE_FEATURE_FIND_EXEC( ACTS(exec, char **exec_argv; unsigned *subst_count; int exec_argc;))
74 USE_FEATURE_FIND_USER( ACTS(user, uid_t uid;))
75 USE_FEATURE_FIND_GROUP( ACTS(group, gid_t gid;))
76 USE_FEATURE_FIND_PAREN( ACTS(paren, action ***subexpr;))
77 USE_FEATURE_FIND_SIZE( ACTS(size, off_t size;))
78 USE_FEATURE_FIND_PRUNE( ACTS(prune))
80 static action ***actions;
81 static bool need_print = 1;
82 static int recurse_flags = ACTION_RECURSE;
84 #if ENABLE_FEATURE_FIND_EXEC
85 static unsigned count_subst(const char *str)
88 while ((str = strstr(str, "{}"))) {
96 static char* subst(const char *src, unsigned count, const char* filename)
98 char *buf, *dst, *end;
99 size_t flen = strlen(filename);
100 /* we replace each '{}' with filename: growth by strlen-2 */
101 buf = dst = xmalloc(strlen(src) + count*(flen-2) + 1);
102 while ((end = strstr(src, "{}"))) {
103 memcpy(dst, src, end - src);
106 memcpy(dst, filename, flen);
114 /* Return values of ACTFs ('action functions') are a bit mask:
115 * bit 1=1: prune (use SKIP constant for setting it)
116 * bit 0=1: matched successfully (TRUE)
119 static int exec_actions(action ***appp, const char *fileName, struct stat *statbuf)
126 /* "action group" is a set of actions ANDed together.
127 * groups are ORed together.
128 * We simply evaluate each group until we find one in which all actions
131 /* -prune is special: if it is encountered, then we won't
132 * descend into current directory. It doesn't matter whether
133 * action group (in which -prune sits) will succeed or not:
134 * find * -prune -name 'f*' -o -name 'm*' -- prunes every dir
135 * find * -name 'f*' -o -prune -name 'm*' -- prunes all dirs
136 * not starting with 'f' */
138 /* We invert TRUE bit (bit 0). Now 1 there means 'failure'.
139 * and bitwise OR in "rc |= TRUE ^ ap->f()" will:
140 * (1) make SKIP (-prune) bit stick; and (2) detect 'failure'.
141 * On return, bit is restored. */
144 while ((app = appp[++cur_group])) {
145 rc &= ~TRUE; /* 'success' so far, clear TRUE bit */
148 ap = app[++cur_action];
149 if (!ap) /* all actions in group were successful */
150 return rc ^ TRUE; /* restore TRUE bit */
151 rc |= TRUE ^ ap->f(fileName, statbuf, ap);
152 #if ENABLE_FEATURE_FIND_NOT
153 if (ap->invert) rc ^= TRUE;
155 if (rc & TRUE) /* current group failed, try next */
159 return rc ^ TRUE; /* restore TRUE bit */
165 const char *tmp = strrchr(fileName, '/');
170 if (!*tmp) { /* "foo/bar/". Oh no... go back to 'b' */
172 while (tmp != fileName && *--tmp != '/')
178 return fnmatch(ap->pattern, tmp, FNM_PERIOD) == 0;
180 #if ENABLE_FEATURE_FIND_TYPE
183 return ((statbuf->st_mode & S_IFMT) == ap->type_mask);
186 #if ENABLE_FEATURE_FIND_PERM
189 /* -perm +mode: at least one of perm_mask bits are set */
190 if (ap->perm_char == '+')
191 return (statbuf->st_mode & ap->perm_mask) != 0;
192 /* -perm -mode: all of perm_mask are set */
193 if (ap->perm_char == '-')
194 return (statbuf->st_mode & ap->perm_mask) == ap->perm_mask;
195 /* -perm mode: file mode must match perm_mask */
196 return (statbuf->st_mode & 07777) == ap->perm_mask;
199 #if ENABLE_FEATURE_FIND_MTIME
202 time_t file_age = time(NULL) - statbuf->st_mtime;
203 time_t mtime_secs = ap->mtime_days * 24*60*60;
204 if (ap->mtime_char == '+')
205 return file_age >= mtime_secs + 24*60*60;
206 if (ap->mtime_char == '-')
207 return file_age < mtime_secs;
208 /* just numeric mtime */
209 return file_age >= mtime_secs && file_age < (mtime_secs + 24*60*60);
212 #if ENABLE_FEATURE_FIND_MMIN
215 time_t file_age = time(NULL) - statbuf->st_mtime;
216 time_t mmin_secs = ap->mmin_mins * 60;
217 if (ap->mmin_char == '+')
218 return file_age >= mmin_secs + 60;
219 if (ap->mmin_char == '-')
220 return file_age < mmin_secs;
221 /* just numeric mmin */
222 return file_age >= mmin_secs && file_age < (mmin_secs + 60);
225 #if ENABLE_FEATURE_FIND_NEWER
228 return (ap->newer_mtime < statbuf->st_mtime);
231 #if ENABLE_FEATURE_FIND_INUM
234 return (statbuf->st_ino == ap->inode_num);
237 #if ENABLE_FEATURE_FIND_EXEC
241 char *argv[ap->exec_argc + 1];
242 for (i = 0; i < ap->exec_argc; i++)
243 argv[i] = subst(ap->exec_argv[i], ap->subst_count[i], fileName);
244 argv[i] = NULL; /* terminate the list */
246 rc = spawn_and_wait(argv);
248 bb_perror_msg("%s", argv[0]);
253 return rc == 0; /* return 1 if exitcode 0 */
257 #if ENABLE_FEATURE_FIND_USER
260 return (statbuf->st_uid == ap->uid);
264 #if ENABLE_FEATURE_FIND_GROUP
267 return (statbuf->st_gid == ap->gid);
271 #if ENABLE_FEATURE_FIND_PRINT0
274 printf("%s%c", fileName, '\0');
285 #if ENABLE_FEATURE_FIND_PAREN
288 return exec_actions(ap->subexpr, fileName, statbuf);
292 #if ENABLE_FEATURE_FIND_PRUNE
294 * -prune: if -depth is not given, return true and do not descend
295 * current dir; if -depth is given, return false with no effect.
297 * find dir -name 'asm-*' -prune -o -name '*.[chS]' -print
305 #if ENABLE_FEATURE_FIND_SIZE
308 return statbuf->st_size == ap->size;
313 static int fileAction(const char *fileName, struct stat *statbuf, void* junk, int depth)
316 #if ENABLE_FEATURE_FIND_XDEV
317 if (S_ISDIR(statbuf->st_mode) && xdev_count) {
318 for (i = 0; i < xdev_count; i++) {
319 if (xdev_dev[i] != statbuf->st_dev)
324 i = exec_actions(actions, fileName, statbuf);
325 /* Had no explicit -print[0] or -exec? then print */
326 if ((i & TRUE) && need_print)
328 /* Cannot return 0: our caller, recursive_action(),
329 * will perror() and skip dirs (if called on dir) */
330 return (i & SKIP) ? SKIP : TRUE;
334 #if ENABLE_FEATURE_FIND_TYPE
335 static int find_type(const char *type)
341 else if (*type == 'c')
343 else if (*type == 'd')
345 else if (*type == 'p')
347 else if (*type == 'f')
349 else if (*type == 'l')
351 else if (*type == 's')
354 if (mask == 0 || *(type + 1) != '\0')
355 bb_error_msg_and_die(bb_msg_invalid_arg, type, "-type");
361 #if ENABLE_FEATURE_FIND_PERM || ENABLE_FEATURE_FIND_MTIME \
362 || ENABLE_FEATURE_FIND_MMIN
363 static const char* plus_minus_num(const char* str)
365 if (*str == '-' || *str == '+')
371 static action*** parse_params(char **argv)
376 USE_FEATURE_FIND_NOT( PARM_char_not ,)
378 USE_FEATURE_FIND_PRINT0(PARM_print0 ,)
380 USE_FEATURE_FIND_TYPE( PARM_type ,)
381 USE_FEATURE_FIND_PERM( PARM_perm ,)
382 USE_FEATURE_FIND_MTIME( PARM_mtime ,)
383 USE_FEATURE_FIND_MMIN( PARM_mmin ,)
384 USE_FEATURE_FIND_NEWER( PARM_newer ,)
385 USE_FEATURE_FIND_INUM( PARM_inum ,)
386 USE_FEATURE_FIND_EXEC( PARM_exec ,)
387 USE_FEATURE_FIND_USER( PARM_user ,)
388 USE_FEATURE_FIND_GROUP( PARM_group ,)
389 USE_FEATURE_FIND_DEPTH( PARM_depth ,)
390 USE_FEATURE_FIND_PAREN( PARM_char_brace,)
391 USE_FEATURE_FIND_SIZE( PARM_size ,)
392 USE_FEATURE_FIND_PRUNE( PARM_prune ,)
396 USE_FEATURE_FIND_NOT( PARM_not ,)
400 static const char *const params[] = {
403 USE_FEATURE_FIND_NOT( "!" ,)
405 USE_FEATURE_FIND_PRINT0("-print0",)
407 USE_FEATURE_FIND_TYPE( "-type" ,)
408 USE_FEATURE_FIND_PERM( "-perm" ,)
409 USE_FEATURE_FIND_MTIME( "-mtime" ,)
410 USE_FEATURE_FIND_MMIN( "-mmin" ,)
411 USE_FEATURE_FIND_NEWER( "-newer" ,)
412 USE_FEATURE_FIND_INUM( "-inum" ,)
413 USE_FEATURE_FIND_EXEC( "-exec" ,)
414 USE_FEATURE_FIND_USER( "-user" ,)
415 USE_FEATURE_FIND_GROUP( "-group" ,)
416 USE_FEATURE_FIND_DEPTH( "-depth" ,)
417 USE_FEATURE_FIND_PAREN( "(" ,)
418 USE_FEATURE_FIND_SIZE( "-size" ,)
419 USE_FEATURE_FIND_PRUNE( "-prune" ,)
423 USE_FEATURE_FIND_NOT( "-not" ,)
429 unsigned cur_group = 0;
430 unsigned cur_action = 0;
431 USE_FEATURE_FIND_NOT( bool invert_flag = 0; )
433 /* 'static' doesn't work here! (gcc 4.1.2) */
434 action* alloc_action(int sizeof_struct, action_fp f)
437 appp[cur_group] = xrealloc(appp[cur_group], (cur_action+2) * sizeof(*appp));
438 appp[cur_group][cur_action++] = ap = xmalloc(sizeof_struct);
439 appp[cur_group][cur_action] = NULL;
441 USE_FEATURE_FIND_NOT( ap->invert = invert_flag; )
442 USE_FEATURE_FIND_NOT( invert_flag = 0; )
446 #define ALLOC_ACTION(name) (action_##name*)alloc_action(sizeof(action_##name), (action_fp) func_##name)
448 appp = xzalloc(2 * sizeof(appp[0])); /* appp[0],[1] == NULL */
450 /* Actions have side effects and return a true or false value
451 * We implement: -print, -print0, -exec
453 * The rest are tests.
455 * Tests and actions are grouped by operators
456 * ( expr ) Force precedence
457 * ! expr True if expr is false
458 * -not expr Same as ! expr
459 * expr1 [-a[nd]] expr2 And; expr2 is not evaluated if expr1 is false
460 * expr1 -o[r] expr2 Or; expr2 is not evaluated if expr1 is true
461 * expr1 , expr2 List; both expr1 and expr2 are always evaluated
462 * We implement: (), -a, -o
465 const char *arg = argv[0];
466 const char *arg1 = argv[1];
467 int parm = index_in_str_array(params, arg);
468 /* --- Operators --- */
469 if (parm == PARM_a USE_DESKTOP(|| parm == PARM_and)) {
470 /* no further special handling required */
472 else if (parm == PARM_o USE_DESKTOP(|| parm == PARM_or)) {
473 /* start new OR group */
475 appp = xrealloc(appp, (cur_group+2) * sizeof(*appp));
476 /*appp[cur_group] = NULL; - already NULL */
477 appp[cur_group+1] = NULL;
480 #if ENABLE_FEATURE_FIND_NOT
481 else if (parm == PARM_char_not USE_DESKTOP(|| parm == PARM_not)) {
482 /* also handles "find ! ! -name 'foo*'" */
487 /* --- Tests and actions --- */
488 else if (parm == PARM_print) {
490 /* GNU find ignores '!' here: "find ! -print" */
491 USE_FEATURE_FIND_NOT( invert_flag = 0; )
492 (void) ALLOC_ACTION(print);
494 #if ENABLE_FEATURE_FIND_PRINT0
495 else if (parm == PARM_print0) {
497 USE_FEATURE_FIND_NOT( invert_flag = 0; )
498 (void) ALLOC_ACTION(print0);
501 else if (parm == PARM_name) {
504 bb_error_msg_and_die(bb_msg_requires_arg, arg);
505 ap = ALLOC_ACTION(name);
508 #if ENABLE_FEATURE_FIND_TYPE
509 else if (parm == PARM_type) {
512 bb_error_msg_and_die(bb_msg_requires_arg, arg);
513 ap = ALLOC_ACTION(type);
514 ap->type_mask = find_type(arg1);
517 #if ENABLE_FEATURE_FIND_PERM
518 /* -perm mode File's permission bits are exactly mode (octal or symbolic).
519 * Symbolic modes use mode 0 as a point of departure.
520 * -perm -mode All of the permission bits mode are set for the file.
521 * -perm +mode Any of the permission bits mode are set for the file.
523 else if (parm == PARM_perm) {
526 bb_error_msg_and_die(bb_msg_requires_arg, arg);
527 ap = ALLOC_ACTION(perm);
528 ap->perm_char = arg1[0];
529 arg1 = plus_minus_num(arg1);
531 if (!bb_parse_mode(arg1, &ap->perm_mask))
532 bb_error_msg_and_die("invalid mode: %s", arg1);
535 #if ENABLE_FEATURE_FIND_MTIME
536 else if (parm == PARM_mtime) {
539 bb_error_msg_and_die(bb_msg_requires_arg, arg);
540 ap = ALLOC_ACTION(mtime);
541 ap->mtime_char = arg1[0];
542 ap->mtime_days = xatoul(plus_minus_num(arg1));
545 #if ENABLE_FEATURE_FIND_MMIN
546 else if (parm == PARM_mmin) {
549 bb_error_msg_and_die(bb_msg_requires_arg, arg);
550 ap = ALLOC_ACTION(mmin);
551 ap->mmin_char = arg1[0];
552 ap->mmin_mins = xatoul(plus_minus_num(arg1));
555 #if ENABLE_FEATURE_FIND_NEWER
556 else if (parm == PARM_newer) {
558 struct stat stat_newer;
560 bb_error_msg_and_die(bb_msg_requires_arg, arg);
561 xstat(arg1, &stat_newer);
562 ap = ALLOC_ACTION(newer);
563 ap->newer_mtime = stat_newer.st_mtime;
566 #if ENABLE_FEATURE_FIND_INUM
567 else if (parm == PARM_inum) {
570 bb_error_msg_and_die(bb_msg_requires_arg, arg);
571 ap = ALLOC_ACTION(inum);
572 ap->inode_num = xatoul(arg1);
575 #if ENABLE_FEATURE_FIND_EXEC
576 else if (parm == PARM_exec) {
580 USE_FEATURE_FIND_NOT( invert_flag = 0; )
581 ap = ALLOC_ACTION(exec);
582 ap->exec_argv = ++argv; /* first arg after -exec */
585 if (!*argv) /* did not see ';' until end */
586 bb_error_msg_and_die(bb_msg_requires_arg, arg);
587 if (LONE_CHAR(argv[0], ';'))
592 if (ap->exec_argc == 0)
593 bb_error_msg_and_die(bb_msg_requires_arg, arg);
594 ap->subst_count = xmalloc(ap->exec_argc * sizeof(int));
597 ap->subst_count[i] = count_subst(ap->exec_argv[i]);
600 #if ENABLE_FEATURE_FIND_USER
601 else if (parm == PARM_user) {
604 bb_error_msg_and_die(bb_msg_requires_arg, arg);
605 ap = ALLOC_ACTION(user);
606 ap->uid = bb_strtou(arg1, NULL, 10);
608 ap->uid = xuname2uid(arg1);
611 #if ENABLE_FEATURE_FIND_GROUP
612 else if (parm == PARM_group) {
615 bb_error_msg_and_die(bb_msg_requires_arg, arg);
616 ap = ALLOC_ACTION(group);
617 ap->gid = bb_strtou(arg1, NULL, 10);
619 ap->gid = xgroup2gid(arg1);
622 #if ENABLE_FEATURE_FIND_DEPTH
623 else if (parm == PARM_depth) {
624 recurse_flags |= ACTION_DEPTHFIRST;
627 #if ENABLE_FEATURE_FIND_PAREN
628 else if (parm == PARM_char_brace) {
636 bb_error_msg_and_die("unpaired '('");
637 if (LONE_CHAR(*endarg, '('))
639 else if (LONE_CHAR(*endarg, ')') && !--nested) {
644 ap = ALLOC_ACTION(paren);
645 ap->subexpr = parse_params(argv + 1);
646 *endarg = (char*) ")"; /* restore NULLed parameter */
650 #if ENABLE_FEATURE_FIND_PRUNE
651 else if (parm == PARM_prune) {
652 USE_FEATURE_FIND_NOT( invert_flag = 0; )
653 (void) ALLOC_ACTION(prune);
656 #if ENABLE_FEATURE_FIND_SIZE
657 else if (parm == PARM_size) {
660 bb_error_msg_and_die(bb_msg_requires_arg, arg);
661 ap = ALLOC_ACTION(size);
662 ap->size = XATOOFF(arg1);
674 int find_main(int argc, char **argv);
675 int find_main(int argc, char **argv)
677 static const char * const options[] = {
679 USE_FEATURE_FIND_XDEV( "-xdev", )
685 int i, firstopt, status = EXIT_SUCCESS;
687 for (firstopt = 1; firstopt < argc; firstopt++) {
688 if (argv[firstopt][0] == '-')
690 if (ENABLE_FEATURE_FIND_NOT && LONE_CHAR(argv[firstopt], '!'))
692 #if ENABLE_FEATURE_FIND_PAREN
693 if (LONE_CHAR(argv[firstopt], '('))
698 argv[0] = (char*)".";
703 /* All options always return true. They always take effect
704 * rather than being processed only when their place in the
705 * expression is reached.
706 * We implement: -follow, -xdev
708 /* Process options, and replace then with -a */
709 /* (-a will be ignored by recursive parser later) */
710 argp = &argv[firstopt];
711 while ((arg = argp[0])) {
712 i = index_in_str_array(options, arg);
713 if (i == 0) { /* -follow */
714 recurse_flags |= ACTION_FOLLOWLINKS;
715 argp[0] = (char*)"-a";
717 #if ENABLE_FEATURE_FIND_XDEV
718 else if (i == 1) { /* -xdev */
721 xdev_count = firstopt - 1;
722 xdev_dev = xmalloc(xdev_count * sizeof(dev_t));
723 for (i = 1; i < firstopt; i++) {
724 /* not xstat(): shouldn't bomb out on
725 * "find not_exist exist -xdev" */
726 if (stat(argv[i], &stbuf))
728 xdev_dev[i-1] = stbuf.st_dev;
731 argp[0] = (char*)"-a";
737 actions = parse_params(&argv[firstopt]);
739 for (i = 1; i < firstopt; i++) {
740 if (!recursive_action(argv[i],
741 recurse_flags, /* flags */
742 fileAction, /* file action */
743 fileAction, /* dir action */
744 NULL, /* user data */
746 status = EXIT_FAILURE;