lib/dirtree.c

   1 /* dirtree.c - Functions for dealing with directory trees.
   2  *
   3  * Copyright 2007 Rob Landley <rob@landley.net>
   4  */
   5
   6 #include "toys.h"
   7
   8 static int notdotdot(char *name)
   9 {
  10   if (name[0]=='.' && (!name[1] || (name[1]=='.' && !name[2]))) return 0;
  11
  12   return 1;
  13 }
  14
  15 // Default callback, filters out "." and "..".
  16
  17 int dirtree_notdotdot(struct dirtree *catch)
  18 {
  19   // Should we skip "." and ".."?
  20   return notdotdot(catch->name) ? DIRTREE_SAVE|DIRTREE_RECURSE : 0;
  21 }
  22
  23 // Create a dirtree node from a path, with stat and symlink info.
  24 // (This doesn't open directory filehandles yet so as not to exhaust the
  25 // filehandle space on large trees, dirtree_handle_callback() does that.)
  26
  27 struct dirtree *dirtree_add_node(struct dirtree *parent, char *name, int flags)
  28 {
  29   struct dirtree *dt = NULL;
  30   struct stat st;
  31   int len = 0, linklen = 0;
  32
  33   if (name) {
  34     // open code this because haven't got node to call dirtree_parentfd() on yet
  35     int fd = parent ? parent->data : AT_FDCWD;
  36
  37     if (fstatat(fd, name, &st, AT_SYMLINK_NOFOLLOW*!(flags&DIRTREE_SYMFOLLOW)))
  38       goto error;
  39     if (S_ISLNK(st.st_mode)) {
  40       if (0>(linklen = readlinkat(fd, name, libbuf, 4095))) goto error;
  41       libbuf[linklen++]=0;
  42     }
  43     len = strlen(name);
  44   }
  45   dt = xzalloc((len = sizeof(struct dirtree)+len+1)+linklen);
  46   dt->parent = parent;
  47   if (name) {
  48     memcpy(&(dt->st), &st, sizeof(struct stat));
  49     strcpy(dt->name, name);
  50
  51     if (linklen) {
  52       dt->symlink = memcpy(len+(char *)dt, libbuf, linklen);
  53       dt->data = --linklen;
  54     }
  55   }
  56
  57   return dt;
  58
  59 error:
  60   if (!(flags&DIRTREE_SHUTUP) && notdotdot(name)) {
  61     char *path = parent ? dirtree_path(parent, 0) : "";
  62
  63     perror_msg("%s%s%s", path, parent ? "/" : "", name);
  64     if (parent) free(path);
  65   }
  66   if (parent) parent->symlink = (char *)1;
  67   free(dt);
  68   return 0;
  69 }
  70
  71 // Return path to this node, assembled recursively.
  72
  73 // Initial call can pass in NULL to plen, or point to an int initialized to 0
  74 // to return the length of the path, or a value greater than 0 to allocate
  75 // extra space if you want to append your own text to the string.
  76
  77 char *dirtree_path(struct dirtree *node, int *plen)
  78 {
  79   char *path;
  80   int len;
  81
  82   if (!node) {
  83     path = xmalloc(*plen);
  84     *plen = 0;
  85     return path;
  86   }
  87
  88   len = (plen ? *plen : 0)+strlen(node->name)+1;
  89   path = dirtree_path(node->parent, &len);
  90   if (len && path[len-1] != '/') path[len++]='/';
  91   len = (stpcpy(path+len, node->name) - path);
  92   if (plen) *plen = len;
  93
  94   return path;
  95 }
  96
  97 int dirtree_parentfd(struct dirtree *node)
  98 {
  99   return node->parent ? node->parent->data : AT_FDCWD;
 100 }
 101
 102 // Handle callback for a node in the tree. Returns saved node(s) or NULL.
 103 //
 104 // By default, allocates a tree of struct dirtree, not following symlinks
 105 // If callback==NULL, or callback always returns 0, allocate tree of struct
 106 // dirtree and return root of tree.  Otherwise call callback(node) on each
 107 // hit, free structures after use, and return NULL.
 108 //
 109
 110 struct dirtree *dirtree_handle_callback(struct dirtree *new,
 111           int (*callback)(struct dirtree *node))
 112 {
 113   int flags;
 114
 115   if (!new) return 0;
 116   if (!callback) callback = dirtree_notdotdot;
 117   flags = callback(new);
 118
 119   if (S_ISDIR(new->st.st_mode)) {
 120     if (flags & (DIRTREE_RECURSE|DIRTREE_COMEAGAIN)) {
 121       new->data = openat(dirtree_parentfd(new), new->name, O_CLOEXEC);
 122       flags = dirtree_recurse(new, callback, flags);
 123     }
 124   }
 125
 126   // If this had children, it was callback's job to free them already.
 127   if (!(flags & DIRTREE_SAVE)) {
 128     free(new);
 129     new = NULL;
 130   }
 131
 132   return (flags & DIRTREE_ABORT)==DIRTREE_ABORT ? DIRTREE_ABORTVAL : new;
 133 }
 134
 135 // Recursively read/process children of directory node (with dirfd in data),
 136 // filtering through callback().
 137
 138 int dirtree_recurse(struct dirtree *node,
 139           int (*callback)(struct dirtree *node), int flags)
 140 {
 141   struct dirtree *new, **ddt = &(node->child);
 142   struct dirent *entry;
 143   DIR *dir;
 144
 145   if (node->data == -1 || !(dir = fdopendir(node->data))) {
 146     if (!(flags & DIRTREE_SHUTUP)) {
 147       char *path = dirtree_path(node, 0);
 148       perror_msg("No %s", path);
 149       free(path);
 150     }
 151     close(node->data);
 152
 153     return flags;
 154   }
 155
 156   // according to the fddir() man page, the filehandle in the DIR * can still
 157   // be externally used by things that don't lseek() it.
 158
 159   // The extra parentheses are to shut the stupid compiler up.
 160   while ((entry = readdir(dir))) {
 161     if (!(new = dirtree_add_node(node, entry->d_name, flags))) continue;
 162     new = dirtree_handle_callback(new, callback);
 163     if (new == DIRTREE_ABORTVAL) break;
 164     if (new) {
 165       *ddt = new;
 166       ddt = &((*ddt)->next);
 167     }
 168   }
 169
 170   if (flags & DIRTREE_COMEAGAIN) {
 171     node->again++;
 172     flags = callback(node);
 173   }
 174
 175   // This closes filehandle as well, so note it
 176   closedir(dir);
 177   node->data = -1;
 178
 179   return flags;
 180 }
 181
 182 // Create dirtree root
 183 struct dirtree *dirtree_start(char *name, int symfollow)
 184 {
 185   return dirtree_add_node(0, name, DIRTREE_SYMFOLLOW*!!symfollow);
 186 }
 187
 188 // Create dirtree from path, using callback to filter nodes.
 189 // If callback == NULL allocate a tree of struct dirtree nodes and return
 190 // pointer to root node.
 191
 192 struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node))
 193 {
 194   struct dirtree *root = dirtree_start(path, 0);
 195
 196   return root ? dirtree_handle_callback(root, callback) : DIRTREE_ABORTVAL;
 197 }