xxd: allow "-" as file name meaning stdin
[oweals/busybox.git] / libbb / recursive_action.c
index 0d6567ddab6a9e1865cbd0babf55d8778046669f..8f2b8b9320f05e1b1cfda1287aef5bbeaf1171de 100644 (file)
@@ -4,14 +4,13 @@
  *
  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
 #include "libbb.h"
 
 #undef DEBUG_RECURS_ACTION
 
-
 /*
  * Walk down all the directories under the specified
  * location, and do something (something specified
  * is so stinking huge.
  */
 
-static int true_action(const char *fileName, struct stat *statbuf, void* userData)
+static int FAST_FUNC true_action(const char *fileName UNUSED_PARAM,
+               struct stat *statbuf UNUSED_PARAM,
+               void* userData UNUSED_PARAM,
+               int depth UNUSED_PARAM)
 {
        return TRUE;
 }
 
-int recursive_action(const char *fileName,
-               int recurse, int followLinks, int depthFirst,
-               int (*fileAction) (const char *fileName, struct stat * statbuf, void* userData),
-               int (*dirAction) (const char *fileName, struct stat * statbuf, void* userData),
-               void* userData)
+/* fileName is (l)stat'ed (depending on ACTION_FOLLOWLINKS[_L0]).
+ *
+ * If it is a file: fileAction in run on it, its return value is returned.
+ *
+ * In case we are in a recursive invocation (see below):
+ * normally, fileAction should return 1 (TRUE) to indicate that
+ * everything is okay and processing should continue.
+ * fileAction return value of 0 (FALSE) on any file in directory will make
+ * recursive_action() also return 0, but it doesn't stop directory traversal
+ * (fileAction/dirAction will be called on each file).
+ *
+ * [TODO: maybe introduce -1 to mean "stop traversal NOW and return"]
+ *
+ * If it is a directory:
+ *
+ * If !ACTION_RECURSE, dirAction is called and its
+ * return value is returned from recursive_action(). No recursion.
+ *
+ * If ACTION_RECURSE, directory is opened, and recursive_action() is called
+ * on each file/subdirectory.
+ * If any one of these calls returns 0, current recursive_action() returns 0.
+ *
+ * If !ACTION_DEPTHFIRST, dirAction is called before recurse.
+ * Return value of 0 (FALSE) is an error: prevents recursion,
+ * the warning is printed (unless ACTION_QUIET) and recursive_action() returns 0.
+ * Return value of 2 (SKIP) prevents recursion, instead recursive_action()
+ * returns 1 (TRUE, no error).
+ *
+ * If ACTION_DEPTHFIRST, dirAction is called after recurse.
+ * If it returns 0, the warning is printed and recursive_action() returns 0.
+ *
+ * ACTION_FOLLOWLINKS mainly controls handling of links to dirs.
+ * 0: lstat(statbuf). Calls fileAction on link name even if points to dir.
+ * 1: stat(statbuf). Calls dirAction and optionally recurse on link to dir.
+ */
+
+int FAST_FUNC recursive_action(const char *fileName,
+               unsigned flags,
+               int FAST_FUNC (*fileAction)(const char *fileName, struct stat *statbuf, void* userData, int depth),
+               int FAST_FUNC (*dirAction)(const char *fileName, struct stat *statbuf, void* userData, int depth),
+               void* userData,
+               unsigned depth)
 {
        struct stat statbuf;
+       unsigned follow;
        int status;
        DIR *dir;
        struct dirent *next;
@@ -42,66 +82,87 @@ int recursive_action(const char *fileName,
        if (!fileAction) fileAction = true_action;
        if (!dirAction) dirAction = true_action;
 
-       status = (followLinks ? stat : lstat)(fileName, &statbuf);
-
+       follow = ACTION_FOLLOWLINKS;
+       if (depth == 0)
+               follow = ACTION_FOLLOWLINKS | ACTION_FOLLOWLINKS_L0;
+       follow &= flags;
+       status = (follow ? stat : lstat)(fileName, &statbuf);
        if (status < 0) {
 #ifdef DEBUG_RECURS_ACTION
-               bb_error_msg("status=%d followLinks=%d TRUE=%d",
-                               status, followLinks, TRUE);
+               bb_error_msg("status=%d flags=%x", status, flags);
 #endif
-               bb_perror_msg("%s", fileName);
-               return FALSE;
+               if ((flags & ACTION_DANGLING_OK)
+                && errno == ENOENT
+                && lstat(fileName, &statbuf) == 0
+               ) {
+                       /* Dangling link */
+                       return fileAction(fileName, &statbuf, userData, depth);
+               }
+               goto done_nak_warn;
        }
 
-       if (!followLinks && (S_ISLNK(statbuf.st_mode))) {
-               return fileAction(fileName, &statbuf, userData);
+       /* If S_ISLNK(m), then we know that !S_ISDIR(m).
+        * Then we can skip checking first part: if it is true, then
+        * (!dir) is also true! */
+       if ( /* (!(flags & ACTION_FOLLOWLINKS) && S_ISLNK(statbuf.st_mode)) || */
+        !S_ISDIR(statbuf.st_mode)
+       ) {
+               return fileAction(fileName, &statbuf, userData, depth);
        }
 
-       if (!recurse) {
-               if (S_ISDIR(statbuf.st_mode)) {
-                       return dirAction(fileName, &statbuf, userData);
-               }
-       }
+       /* It's a directory (or a link to one, and followLinks is set) */
 
-       if (!S_ISDIR(statbuf.st_mode))
-               return fileAction(fileName, &statbuf, userData);
+       if (!(flags & ACTION_RECURSE)) {
+               return dirAction(fileName, &statbuf, userData, depth);
+       }
 
-       if (!depthFirst) {
-               status = dirAction(fileName, &statbuf, userData);
-               if (!status) {
-                       bb_perror_msg("%s", fileName);
-                       return FALSE;
-               }
+       if (!(flags & ACTION_DEPTHFIRST)) {
+               status = dirAction(fileName, &statbuf, userData, depth);
+               if (status == FALSE)
+                       goto done_nak_warn;
                if (status == SKIP)
                        return TRUE;
        }
 
        dir = opendir(fileName);
        if (!dir) {
-               return FALSE;
+               /* findutils-4.1.20 reports this */
+               /* (i.e. it doesn't silently return with exit code 1) */
+               /* To trigger: "find -exec rm -rf {} \;" */
+               goto done_nak_warn;
        }
        status = TRUE;
        while ((next = readdir(dir)) != NULL) {
                char *nextFile;
+               int s;
 
                nextFile = concat_subpath_file(fileName, next->d_name);
                if (nextFile == NULL)
                        continue;
-               if (!recursive_action(nextFile, TRUE, followLinks, depthFirst,
-                                       fileAction, dirAction, userData)) {
+
+               /* process every file (NB: ACTION_RECURSE is set in flags) */
+               s = recursive_action(nextFile, flags, fileAction, dirAction,
+                                               userData, depth + 1);
+               if (s == FALSE)
                        status = FALSE;
-               }
                free(nextFile);
+//#define RECURSE_RESULT_ABORT -1
+//             if (s == RECURSE_RESULT_ABORT) {
+//                     closedir(dir);
+//                     return s;
+//             }
        }
        closedir(dir);
-       if (depthFirst) {
-               if (!dirAction(fileName, &statbuf, userData)) {
-                       bb_perror_msg("%s", fileName);
-                       return FALSE;
-               }
+
+       if (flags & ACTION_DEPTHFIRST) {
+               if (!dirAction(fileName, &statbuf, userData, depth))
+                       goto done_nak_warn;
        }
 
-       if (!status)
-               return FALSE;
-       return TRUE;
+       return status;
+
+ done_nak_warn:
+       if (!(flags & ACTION_QUIET))
+               bb_simple_perror_msg(fileName);
+       return FALSE;
 }