libbb/recursive_action.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Utility routines.
   4  *
   5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
   6  *
   7  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
   8  */
   9
  10 #include "libbb.h"
  11
  12 #undef DEBUG_RECURS_ACTION
  13
  14 /*
  15  * Walk down all the directories under the specified
  16  * location, and do something (something specified
  17  * by the fileAction and dirAction function pointers).
  18  *
  19  * Unfortunately, while nftw(3) could replace this and reduce
  20  * code size a bit, nftw() wasn't supported before GNU libc 2.1,
  21  * and so isn't sufficiently portable to take over since glibc2.1
  22  * is so stinking huge.
  23  */
  24
  25 static int FAST_FUNC true_action(const char *fileName UNUSED_PARAM,
  26                 struct stat *statbuf UNUSED_PARAM,
  27                 void* userData UNUSED_PARAM,
  28                 int depth UNUSED_PARAM)
  29 {
  30         return TRUE;
  31 }
  32
  33 /* fileAction return value of 0 on any file in directory will make
  34  * recursive_action() return 0, but it doesn't stop directory traversal
  35  * (fileAction/dirAction will be called on each file).
  36  *
  37  * If !ACTION_RECURSE, dirAction is called on the directory and its
  38  * return value is returned from recursive_action(). No recursion.
  39  *
  40  * If ACTION_RECURSE, recursive_action() is called on each directory.
  41  * If any one of these calls returns 0, current recursive_action() returns 0.
  42  *
  43  * If ACTION_DEPTHFIRST, dirAction is called after recurse.
  44  * If it returns 0, the warning is printed and recursive_action() returns 0.
  45  *
  46  * If !ACTION_DEPTHFIRST, dirAction is called before we recurse.
  47  * Return value of 0 (FALSE) or 2 (SKIP) prevents recursion
  48  * into that directory, instead recursive_action() returns 0 (if FALSE)
  49  * or 1 (if SKIP)
  50  *
  51  * followLinks=0/1 differs mainly in handling of links to dirs.
  52  * 0: lstat(statbuf). Calls fileAction on link name even if points to dir.
  53  * 1: stat(statbuf). Calls dirAction and optionally recurse on link to dir.
  54  */
  55
  56 int FAST_FUNC recursive_action(const char *fileName,
  57                 unsigned flags,
  58                 int FAST_FUNC (*fileAction)(const char *fileName, struct stat *statbuf, void* userData, int depth),
  59                 int FAST_FUNC (*dirAction)(const char *fileName, struct stat *statbuf, void* userData, int depth),
  60                 void* userData,
  61                 unsigned depth)
  62 {
  63         struct stat statbuf;
  64         int status;
  65         DIR *dir;
  66         struct dirent *next;
  67
  68         if (!fileAction) fileAction = true_action;
  69         if (!dirAction) dirAction = true_action;
  70
  71         status = ACTION_FOLLOWLINKS; /* hijack a variable for bitmask... */
  72         if (!depth)
  73                 status = ACTION_FOLLOWLINKS | ACTION_FOLLOWLINKS_L0;
  74         status = ((flags & status) ? stat : lstat)(fileName, &statbuf);
  75         if (status < 0) {
  76 #ifdef DEBUG_RECURS_ACTION
  77                 bb_error_msg("status=%d flags=%x", status, flags);
  78 #endif
  79                 goto done_nak_warn;
  80         }
  81
  82         /* If S_ISLNK(m), then we know that !S_ISDIR(m).
  83          * Then we can skip checking first part: if it is true, then
  84          * (!dir) is also true! */
  85         if ( /* (!(flags & ACTION_FOLLOWLINKS) && S_ISLNK(statbuf.st_mode)) || */
  86          !S_ISDIR(statbuf.st_mode)
  87         ) {
  88                 return fileAction(fileName, &statbuf, userData, depth);
  89         }
  90
  91         /* It's a directory (or a link to one, and followLinks is set) */
  92
  93         if (!(flags & ACTION_RECURSE)) {
  94                 return dirAction(fileName, &statbuf, userData, depth);
  95         }
  96
  97         if (!(flags & ACTION_DEPTHFIRST)) {
  98                 status = dirAction(fileName, &statbuf, userData, depth);
  99                 if (!status)
 100                         goto done_nak_warn;
 101                 if (status == SKIP)
 102                         return TRUE;
 103         }
 104
 105         dir = opendir(fileName);
 106         if (!dir) {
 107                 /* findutils-4.1.20 reports this */
 108                 /* (i.e. it doesn't silently return with exit code 1) */
 109                 /* To trigger: "find -exec rm -rf {} \;" */
 110                 goto done_nak_warn;
 111         }
 112         status = TRUE;
 113         while ((next = readdir(dir)) != NULL) {
 114                 char *nextFile;
 115
 116                 nextFile = concat_subpath_file(fileName, next->d_name);
 117                 if (nextFile == NULL)
 118                         continue;
 119                 /* process every file (NB: ACTION_RECURSE is set in flags) */
 120                 if (!recursive_action(nextFile, flags, fileAction, dirAction,
 121                                                 userData, depth + 1))
 122                         status = FALSE;
 123 //              s = recursive_action(nextFile, flags, fileAction, dirAction,
 124 //                                              userData, depth + 1);
 125                 free(nextFile);
 126 //#define RECURSE_RESULT_ABORT 3
 127 //              if (s == RECURSE_RESULT_ABORT) {
 128 //                      closedir(dir);
 129 //                      return s;
 130 //              }
 131 //              if (s == FALSE)
 132 //                      status = FALSE;
 133         }
 134         closedir(dir);
 135
 136         if (flags & ACTION_DEPTHFIRST) {
 137                 if (!dirAction(fileName, &statbuf, userData, depth))
 138                         goto done_nak_warn;
 139         }
 140
 141         return status;
 142
 143  done_nak_warn:
 144         if (!(flags & ACTION_QUIET))
 145                 bb_simple_perror_msg(fileName);
 146         return FALSE;
 147 }