xxd: allow "-" as file name meaning stdin
[oweals/busybox.git] / libbb / recursive_action.c
index 510080b8360d2350c014565c6d010716b6f2a0db..8f2b8b9320f05e1b1cfda1287aef5bbeaf1171de 100644 (file)
 /*
  * Utility routines.
  *
- * Copyright (C) tons of folks.  Tracking down who wrote what
- * isn't something I'm going to worry about...  If you wrote something
- * here, please feel free to acknowledge your work.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- *
- * Based in part on code from sash, Copyright (c) 1999 by David I. Bell 
- * Permission has been granted to redistribute this code under the GPL.
+ * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
  *
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
-#include <stdio.h>
-#include <string.h>
-#include <dirent.h>
-#include <sys/stat.h>
-#include <stdlib.h>    /* free() */
 #include "libbb.h"
 
-
-/* same conditions as recursive_action */
-#define bb_need_name_too_long
-#define BB_DECLARE_EXTERN
-#include "../messages.c"
-
 #undef DEBUG_RECURS_ACTION
 
-
 /*
- * Walk down all the directories under the specified 
+ * Walk down all the directories under the specified
  * location, and do something (something specified
  * by the fileAction and dirAction function pointers).
  *
- * Unfortunately, while nftw(3) could replace this and reduce 
- * code size a bit, nftw() wasn't supported before GNU libc 2.1, 
+ * Unfortunately, while nftw(3) could replace this and reduce
+ * code size a bit, nftw() wasn't supported before GNU libc 2.1,
  * and so isn't sufficiently portable to take over since glibc2.1
  * is so stinking huge.
  */
-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)
+
+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;
+}
+
+/* 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)
 {
-       int status;
        struct stat statbuf;
+       unsigned follow;
+       int status;
+       DIR *dir;
        struct dirent *next;
 
-       if (followLinks == TRUE)
-               status = stat(fileName, &statbuf);
-       else
-               status = lstat(fileName, &statbuf);
+       if (!fileAction) fileAction = true_action;
+       if (!dirAction) dirAction = true_action;
 
+       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
-               fprintf(stderr,
-                               "status=%d followLinks=%d TRUE=%d\n",
-                               status, followLinks, TRUE);
+               bb_error_msg("status=%d flags=%x", status, flags);
 #endif
-               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 == FALSE) && (S_ISLNK(statbuf.st_mode))) {
-               if (fileAction == NULL)
-                       return TRUE;
-               else
-                       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 == FALSE) {
-               if (S_ISDIR(statbuf.st_mode)) {
-                       if (dirAction != NULL)
-                               return (dirAction(fileName, &statbuf, userData));
-                       else
-                               return TRUE;
-               }
-       }
+       /* It's a directory (or a link to one, and followLinks is set) */
 
-       if (S_ISDIR(statbuf.st_mode)) {
-               DIR *dir;
+       if (!(flags & ACTION_RECURSE)) {
+               return dirAction(fileName, &statbuf, userData, depth);
+       }
 
-               if (dirAction != NULL && depthFirst == FALSE) {
-                       status = dirAction(fileName, &statbuf, userData);
-                       if (status == FALSE) {
-                               perror_msg("%s", fileName);
-                               return FALSE;
-                       } else if (status == SKIP)
-                               return TRUE;
-               }
-               dir = opendir(fileName);
-               if (!dir) {
-                       perror_msg("%s", fileName);
-                       return FALSE;
-               }
-               status = TRUE;
-               while ((next = readdir(dir)) != NULL) {
-                       char *nextFile;
-
-                       if ((strcmp(next->d_name, "..") == 0)
-                                       || (strcmp(next->d_name, ".") == 0)) {
-                               continue;
-                       }
-                       nextFile = concat_path_file(fileName, next->d_name);
-                       if (recursive_action(nextFile, TRUE, followLinks, depthFirst,
-                                               fileAction, dirAction, userData) == FALSE) {
-                               status = FALSE;
-                       }
-                       free(nextFile);
-               }
-               closedir(dir);
-               if (dirAction != NULL && depthFirst == TRUE) {
-                       if (dirAction(fileName, &statbuf, userData) == FALSE) {
-                               perror_msg("%s", fileName);
-                               return FALSE;
-                       }
-               }
+       if (!(flags & ACTION_DEPTHFIRST)) {
+               status = dirAction(fileName, &statbuf, userData, depth);
                if (status == FALSE)
-                       return FALSE;
-       } else {
-               if (fileAction == NULL)
+                       goto done_nak_warn;
+               if (status == SKIP)
                        return TRUE;
-               else
-                       return fileAction(fileName, &statbuf, userData);
        }
-       return TRUE;
-}
 
+       dir = opendir(fileName);
+       if (!dir) {
+               /* 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;
 
-/* END CODE */
-/*
-Local Variables:
-c-file-style: "linux"
-c-basic-offset: 4
-tab-width: 4
-End:
-*/
+               /* 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 (flags & ACTION_DEPTHFIRST) {
+               if (!dirAction(fileName, &statbuf, userData, depth))
+                       goto done_nak_warn;
+       }
+
+       return status;
+
+ done_nak_warn:
+       if (!(flags & ACTION_QUIET))
+               bb_simple_perror_msg(fileName);
+       return FALSE;
+}