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,
  28   int symfollow)
  29 {
  30   struct dirtree *dt = NULL;
  31   struct stat st;
  32   char buf[4096];
  33   int len = 0, linklen = 0;
  34
  35   if (name) {
  36     // open code this because haven't got node to call dirtree_parentfd() on yet
  37     int fd = parent ? parent->data : AT_FDCWD;
  38
  39     if (fstatat(fd, name, &st, symfollow ? 0 : AT_SYMLINK_NOFOLLOW)) goto error;
  40     if (S_ISLNK(st.st_mode)) {
  41       if (0>(linklen = readlinkat(fd, name, buf, 4095))) goto error;
  42       buf[linklen++]=0;
  43     }
  44     len = strlen(name);
  45   }
  46   dt = xzalloc((len = sizeof(struct dirtree)+len+1)+linklen);
  47   dt->parent = parent;
  48   if (name) {
  49     memcpy(&(dt->st), &st, sizeof(struct stat));
  50     strcpy(dt->name, name);
  51
  52     if (linklen) {
  53       dt->symlink = memcpy(len+(char *)dt, buf, linklen);
  54       dt->data = --linklen;
  55     }
  56   }
  57
  58   return dt;
  59
  60 error:
  61   if (notdotdot(name)) {
  62     char *path = parent ? dirtree_path(parent, 0) : "";
  63
  64     perror_msg("%s%s%s", path, parent ? "/" : "", name);
  65     if (parent) free(path);
  66   }
  67   if (parent) parent->symlink = (char *)1;
  68   free(dt);
  69   return 0;
  70 }
  71
  72 // Return path to this node, assembled recursively.
  73
  74 char *dirtree_path(struct dirtree *node, int *plen)
  75 {
  76   char *path;
  77   int len;
  78
  79   if (!node || !node->name) {
  80     path = xmalloc(*plen);
  81     *plen = 0;
  82     return path;
  83   }
  84
  85   len = (plen ? *plen : 0)+strlen(node->name)+1;
  86   path = dirtree_path(node->parent, &len);
  87   if (len && path[len-1] != '/') path[len++]='/';
  88   len = (stpcpy(path+len, node->name) - path);
  89   if (plen) *plen = len;
  90
  91   return path;
  92 }
  93
  94 int dirtree_parentfd(struct dirtree *node)
  95 {
  96   return node->parent ? node->parent->data : AT_FDCWD;
  97 }
  98
  99 // Handle callback for a node in the tree. Returns saved node(s) or NULL.
 100 //
 101 // By default, allocates a tree of struct dirtree, not following symlinks
 102 // If callback==NULL, or callback always returns 0, allocate tree of struct
 103 // dirtree and return root of tree.  Otherwise call callback(node) on each
 104 // hit, free structures after use, and return NULL.
 105 //
 106
 107 struct dirtree *dirtree_handle_callback(struct dirtree *new,
 108           int (*callback)(struct dirtree *node))
 109 {
 110   int flags, dir = S_ISDIR(new->st.st_mode);
 111
 112   if (!callback) callback = dirtree_notdotdot;
 113
 114   flags = callback(new);
 115
 116   if (dir) {
 117     if (flags & (DIRTREE_RECURSE|DIRTREE_COMEAGAIN)) {
 118       new->data = openat(dirtree_parentfd(new), new->name, O_CLOEXEC);
 119       dirtree_recurse(new, callback, flags & DIRTREE_SYMFOLLOW);
 120       if (flags & DIRTREE_COMEAGAIN) flags = callback(new);
 121     }
 122   }
 123
 124   // If this had children, it was callback's job to free them already.
 125   if (!(flags & DIRTREE_SAVE)) {
 126     free(new);
 127     new = NULL;
 128   }
 129
 130   return (flags & DIRTREE_ABORT)==DIRTREE_ABORT ? DIRTREE_ABORTVAL : new;
 131 }
 132
 133 // Recursively read/process children of directory node (with dirfd in data),
 134 // filtering through callback().
 135
 136 void dirtree_recurse(struct dirtree *node,
 137           int (*callback)(struct dirtree *node), int symfollow)
 138 {
 139   struct dirtree *new, **ddt = &(node->child);
 140   struct dirent *entry;
 141   DIR *dir;
 142
 143   if (node->data == -1 || !(dir = fdopendir(node->data))) {
 144     char *path = dirtree_path(node, 0);
 145     perror_msg("No %s", path);
 146     free(path);
 147     close(node->data);
 148
 149     return;
 150   }
 151
 152   // according to the fddir() man page, the filehandle in the DIR * can still
 153   // be externally used by things that don't lseek() it.
 154
 155   // The extra parentheses are to shut the stupid compiler up.
 156   while ((entry = readdir(dir))) {
 157     if (!(new = dirtree_add_node(node, entry->d_name, symfollow)))
 158       continue;
 159     new = dirtree_handle_callback(new, callback);
 160     if (new == DIRTREE_ABORTVAL) break;
 161     if (new) {
 162       *ddt = new;
 163       ddt = &((*ddt)->next);
 164     }
 165   }
 166
 167   // This closes filehandle as well, so note it
 168   closedir(dir);
 169   node->data = -1;
 170 }
 171
 172 // Create dirtree from path, using callback to filter nodes.
 173 // If callback == NULL allocate a tree of struct dirtree nodes and return
 174 // pointer to root node.
 175 // symfollow is just for the top of tree, callback return code controls children
 176
 177 struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node))
 178 {
 179   struct dirtree *root = dirtree_add_node(0, path, 0);
 180
 181   return root ? dirtree_handle_callback(root, callback) : DIRTREE_ABORTVAL;
 182 }