test/misc/tst-gnuglob.c

   1 /* Test the GNU extensions in glob which allow the user to provide callbacks
   2    for the filesystem access functions.
   3    Copyright (C) 2001-2002 Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5    Contributed by Ulrich Drepper <drepper@redhat.com>, 2001.
   6
   7    The GNU C Library is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU Lesser General Public
   9    License as published by the Free Software Foundation; either
  10    version 2.1 of the License, or (at your option) any later version.
  11
  12    The GNU C Library is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    Lesser General Public License for more details.
  16
  17    You should have received a copy of the GNU Lesser General Public
  18    License along with the GNU C Library; if not, see
  19    <http://www.gnu.org/licenses/>.  */
  20
  21 #include <dirent.h>
  22 #include <errno.h>
  23 #include <error.h>
  24 #include <glob.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <sys/stat.h>
  29
  30
  31 // #define DEBUG
  32 #ifdef DEBUG
  33 # define PRINTF(fmt, args...) printf (fmt, ##args)
  34 #else
  35 # define PRINTF(fmt, args...)
  36 #endif
  37
  38
  39 #ifdef GLOB_ALTDIRFUNC
  40 static struct
  41 {
  42   const char *name;
  43   int level;
  44   int type;
  45 } filesystem[] =
  46 {
  47   { ".", 1, DT_DIR },
  48   { "..", 1, DT_DIR },
  49   { "file1lev1", 1, DT_REG },
  50   { "file2lev1", 1, DT_UNKNOWN },
  51   { "dir1lev1", 1, DT_UNKNOWN },
  52     { ".", 2, DT_DIR },
  53     { "..", 2, DT_DIR },
  54     { "file1lev2", 2, DT_REG },
  55     { "dir1lev2", 2, DT_DIR },
  56       { ".", 3, DT_DIR },
  57       { "..", 3, DT_DIR },
  58     { "dir2lev2", 2, DT_DIR },
  59       { ".", 3, DT_DIR },
  60       { "..", 3, DT_DIR },
  61       { ".foo", 3, DT_REG },
  62       { "dir1lev3", 3, DT_DIR },
  63         { ".", 4, DT_DIR },
  64         { "..", 4, DT_DIR },
  65         { "file1lev4", 4, DT_REG },
  66       { "file1lev3", 3, DT_REG },
  67       { "file2lev3", 3, DT_REG },
  68     { "file2lev2", 2, DT_REG },
  69     { "file3lev2", 2, DT_REG },
  70     { "dir3lev2", 2, DT_DIR },
  71       { ".", 3, DT_DIR },
  72       { "..", 3, DT_DIR },
  73       { "file3lev3", 3, DT_REG },
  74       { "file4lev3", 3, DT_REG },
  75   { "dir2lev1", 1, DT_DIR },
  76     { ".", 2, DT_DIR },
  77     { "..", 2, DT_DIR },
  78     { "dir1lev2", 2, DT_UNKNOWN },
  79       { ".", 3, DT_DIR },
  80       { "..", 3, DT_DIR },
  81       { ".foo", 3, DT_REG },
  82       { ".dir", 3, DT_DIR },
  83         { ".", 4, DT_DIR },
  84         { "..", 4, DT_DIR },
  85         { "hidden", 4, DT_REG }
  86 };
  87 #define nfiles (sizeof (filesystem) / sizeof (filesystem[0]))
  88
  89
  90 typedef struct
  91 {
  92   int level;
  93   int idx;
  94   struct dirent d;
  95   char room_for_dirent[NAME_MAX];
  96 } my_DIR;
  97
  98
  99 static long int
 100 find_file (const char *s)
 101 {
 102   int level = 1;
 103   long int idx = 0;
 104
 105   if (strcmp (s, ".") == 0)
 106     return 0;
 107
 108   if (s[0] == '.' && s[1] == '/')
 109     s += 2;
 110
 111   while (*s != '\0')
 112     {
 113       char *endp = strchrnul (s, '/');
 114
 115       PRINTF ("looking for %.*s, level %d\n", (int) (endp - s), s, level);
 116
 117       while (idx < nfiles && filesystem[idx].level >= level)
 118         {
 119           if (filesystem[idx].level == level
 120               && memcmp (s, filesystem[idx].name, endp - s) == 0
 121               && filesystem[idx].name[endp - s] == '\0')
 122             break;
 123           ++idx;
 124         }
 125
 126       if (idx == nfiles || filesystem[idx].level < level)
 127         {
 128           errno = ENOENT;
 129           return -1;
 130         }
 131
 132       if (*endp == '\0')
 133         return idx + 1;
 134
 135       if (filesystem[idx].type != DT_DIR
 136           && (idx + 1 >= nfiles
 137               || filesystem[idx].level >= filesystem[idx + 1].level))
 138         {
 139           errno = ENOTDIR;
 140           return -1;
 141         }
 142
 143       ++idx;
 144
 145       s = endp + 1;
 146       ++level;
 147     }
 148
 149   errno = ENOENT;
 150   return -1;
 151 }
 152
 153
 154 static void *
 155 my_opendir (const char *s)
 156 {
 157   long int idx = find_file (s);
 158   my_DIR *dir;
 159
 160
 161   if (idx == -1)
 162     {
 163       PRINTF ("my_opendir(\"%s\") == NULL\n", s);
 164       return NULL;
 165     }
 166
 167   dir = (my_DIR *) malloc (sizeof (my_DIR));
 168   if (dir == NULL)
 169     error (EXIT_FAILURE, errno, "cannot allocate directory handle");
 170
 171   dir->level = filesystem[idx].level;
 172   dir->idx = idx;
 173
 174   PRINTF ("my_opendir(\"%s\") == { level: %d, idx: %ld }\n",
 175           s, filesystem[idx].level, idx);
 176
 177   return dir;
 178 }
 179
 180
 181 static struct dirent *
 182 my_readdir (void *gdir)
 183 {
 184   my_DIR *dir = gdir;
 185
 186   if (dir->idx == -1)
 187     {
 188       PRINTF ("my_readdir ({ level: %d, idx: %ld }) = NULL\n",
 189               dir->level, (long int) dir->idx);
 190       return NULL;
 191     }
 192
 193   while (dir->idx < nfiles && filesystem[dir->idx].level > dir->level)
 194     ++dir->idx;
 195
 196   if (dir->idx == nfiles || filesystem[dir->idx].level < dir->level)
 197     {
 198       dir->idx = -1;
 199       PRINTF ("my_readdir ({ level: %d, idx: %ld }) = NULL\n",
 200               dir->level, (long int) dir->idx);
 201       return NULL;
 202     }
 203
 204   dir->d.d_ino = dir->idx;
 205
 206 #ifdef _DIRENT_HAVE_D_TYPE
 207   dir->d.d_type = filesystem[dir->idx].type;
 208 #endif
 209
 210   strcpy (dir->d.d_name, filesystem[dir->idx].name);
 211
 212 #ifdef _DIRENT_HAVE_D_TYPE
 213   PRINTF ("my_readdir ({ level: %d, idx: %ld }) = { d_ino: %ld, d_type: %d, d_name: \"%s\" }\n",
 214           dir->level, (long int) dir->idx, dir->d.d_ino, dir->d.d_type,
 215           dir->d.d_name);
 216 #else
 217   PRINTF ("my_readdir ({ level: %d, idx: %ld }) = { d_ino: %ld, d_name: \"%s\" }\n",
 218           dir->level, (long int) dir->idx, dir->d.d_ino,
 219           dir->d.d_name);
 220 #endif
 221
 222   ++dir->idx;
 223
 224   return &dir->d;
 225 }
 226
 227
 228 static void
 229 my_closedir (void *dir)
 230 {
 231   PRINTF ("my_closedir ()\n");
 232   free (dir);
 233 }
 234
 235
 236 /* We use this function for lstat as well since we don't have any.  */
 237 static int
 238 my_stat (const char *name, struct stat *st)
 239 {
 240   long int idx = find_file (name);
 241
 242   if (idx == -1)
 243     {
 244       PRINTF ("my_stat (\"%s\", ...) = -1 (%s)\n", name, strerror (errno));
 245       return -1;
 246     }
 247
 248   memset (st, '\0', sizeof (*st));
 249
 250   if (filesystem[idx].type == DT_UNKNOWN)
 251     st->st_mode = DTTOIF (idx + 1 < nfiles
 252                           && filesystem[idx].level < filesystem[idx + 1].level
 253                           ? DT_DIR : DT_REG) | 0777;
 254   else
 255     st->st_mode = DTTOIF (filesystem[idx].type) | 0777;
 256
 257   PRINTF ("my_stat (\"%s\", { st_mode: %o }) = 0\n", name, st->st_mode);
 258
 259   return 0;
 260 }
 261
 262
 263 static const char *glob_errstring[] =
 264 {
 265   [GLOB_NOSPACE] = "out of memory",
 266   [GLOB_ABORTED] = "read error",
 267   [GLOB_NOMATCH] = "no matches found"
 268 };
 269 #define nglob_errstring (sizeof (glob_errstring) / sizeof (glob_errstring[0]))
 270
 271
 272 static const char *
 273 flagstr (int flags)
 274 {
 275   const char *strs[] =
 276   {
 277     "GLOB_ERR", "GLOB_MARK", "GLOB_NOSORT", "GLOB_DOOFSS", "GLOB_NOCHECK",
 278     "GLOB_APPEND", "GLOB_NOESCAPE", "GLOB_PERIOD", "GLOB_MAGCHAR",
 279     "GLOB_ALTDIRFUNC", "GLOB_BRACE", "GLOB_NOMAGIC", "GLOB_TILDE",
 280     "GLOB_ONLYDIR", "GLOB_TILDECHECK"
 281   };
 282 #define nstrs (sizeof (strs) / sizeof (strs[0]))
 283   static char buf[100];
 284   char *cp = buf;
 285   int cnt;
 286
 287   for (cnt = 0; cnt < nstrs; ++cnt)
 288     if (flags & (1 << cnt))
 289       {
 290         flags &= ~(1 << cnt);
 291         if (cp != buf)
 292           *cp++ = '|';
 293         cp = stpcpy (cp, strs[cnt]);
 294       }
 295
 296   if (flags != 0)
 297     {
 298       if (cp != buf)
 299         *cp++ = '|';
 300       sprintf (cp, "%#x", flags);
 301     }
 302
 303   return buf;
 304 }
 305
 306
 307 static int
 308 test_result (const char *fmt, int flags, glob_t *gl, const char *str[])
 309 {
 310   size_t cnt;
 311   int result = 0;
 312
 313   printf ("results for glob (\"%s\", %s)\n", fmt, flagstr (flags));
 314   for (cnt = 0; cnt < gl->gl_pathc && str[cnt] != NULL; ++cnt)
 315     {
 316       int ok = strcmp (gl->gl_pathv[cnt], str[cnt]) == 0;
 317       const char *errstr = "";
 318
 319       if (! ok)
 320         {
 321           size_t inner;
 322
 323           for (inner = 0; str[inner] != NULL; ++inner)
 324             if (strcmp (gl->gl_pathv[cnt], str[inner]) == 0)
 325               break;
 326
 327           if (str[inner] == NULL)
 328             errstr =  ok ? "" : " *** WRONG";
 329           else
 330             errstr = ok ? "" : " * wrong position";
 331
 332           result = 1;
 333         }
 334
 335       printf ("  %s%s\n", gl->gl_pathv[cnt], errstr);
 336     }
 337   puts ("");
 338
 339   if (str[cnt] != NULL || cnt < gl->gl_pathc)
 340     {
 341       puts ("  *** incorrect number of entries");
 342       result = 1;
 343     }
 344
 345   return result;
 346 }
 347
 348
 349 int
 350 main (void)
 351 {
 352   glob_t gl;
 353   int errval;
 354   int result = 0;
 355   const char *fmt;
 356   int flags;
 357
 358   memset (&gl, '\0', sizeof (gl));
 359
 360   gl.gl_closedir = my_closedir;
 361   gl.gl_readdir = my_readdir;
 362   gl.gl_opendir = my_opendir;
 363   gl.gl_lstat = my_stat;
 364   gl.gl_stat = my_stat;
 365
 366 #define test(a, b, c...) \
 367   fmt = a;                                                                    \
 368   flags = b;                                                                  \
 369   errval = glob (fmt, flags, NULL, &gl);                                      \
 370   if (errval != 0)                                                            \
 371     {                                                                         \
 372       printf ("glob (\"%s\", %s) failed: %s\n", fmt, flagstr (flags),         \
 373               errval >= 0 && errval < nglob_errstring                         \
 374               ? glob_errstring[errval] : "???");                              \
 375       result = 1;                                                             \
 376     }                                                                         \
 377   else                                                                        \
 378     result |= test_result (fmt, flags, &gl, (const char *[]) { c, NULL })
 379
 380   test ("*/*/*", GLOB_ALTDIRFUNC,
 381         "dir1lev1/dir2lev2/dir1lev3",
 382         "dir1lev1/dir2lev2/file1lev3",
 383         "dir1lev1/dir2lev2/file2lev3",
 384         "dir1lev1/dir3lev2/file3lev3",
 385         "dir1lev1/dir3lev2/file4lev3");
 386
 387   test ("*/*/*", GLOB_ALTDIRFUNC | GLOB_PERIOD,
 388         "dir1lev1/dir1lev2/.",
 389         "dir1lev1/dir1lev2/..",
 390         "dir1lev1/dir2lev2/.",
 391         "dir1lev1/dir2lev2/..",
 392         "dir1lev1/dir2lev2/.foo",
 393         "dir1lev1/dir2lev2/dir1lev3",
 394         "dir1lev1/dir2lev2/file1lev3",
 395         "dir1lev1/dir2lev2/file2lev3",
 396         "dir1lev1/dir3lev2/.",
 397         "dir1lev1/dir3lev2/..",
 398         "dir1lev1/dir3lev2/file3lev3",
 399         "dir1lev1/dir3lev2/file4lev3",
 400         "dir2lev1/dir1lev2/.",
 401         "dir2lev1/dir1lev2/..",
 402         "dir2lev1/dir1lev2/.dir",
 403         "dir2lev1/dir1lev2/.foo");
 404
 405   test ("*/*/.*", GLOB_ALTDIRFUNC,
 406         "dir1lev1/dir1lev2/.",
 407         "dir1lev1/dir1lev2/..",
 408         "dir1lev1/dir2lev2/.",
 409         "dir1lev1/dir2lev2/..",
 410         "dir1lev1/dir2lev2/.foo",
 411         "dir1lev1/dir3lev2/.",
 412         "dir1lev1/dir3lev2/..",
 413         "dir2lev1/dir1lev2/.",
 414         "dir2lev1/dir1lev2/..",
 415         "dir2lev1/dir1lev2/.dir",
 416         "dir2lev1/dir1lev2/.foo");
 417
 418   test ("*1*/*2*/.*", GLOB_ALTDIRFUNC,
 419         "dir1lev1/dir1lev2/.",
 420         "dir1lev1/dir1lev2/..",
 421         "dir1lev1/dir2lev2/.",
 422         "dir1lev1/dir2lev2/..",
 423         "dir1lev1/dir2lev2/.foo",
 424         "dir1lev1/dir3lev2/.",
 425         "dir1lev1/dir3lev2/..",
 426         "dir2lev1/dir1lev2/.",
 427         "dir2lev1/dir1lev2/..",
 428         "dir2lev1/dir1lev2/.dir",
 429         "dir2lev1/dir1lev2/.foo");
 430
 431   test ("*1*/*1*/.*", GLOB_ALTDIRFUNC,
 432         "dir1lev1/dir1lev2/.",
 433         "dir1lev1/dir1lev2/..",
 434         "dir2lev1/dir1lev2/.",
 435         "dir2lev1/dir1lev2/..",
 436         "dir2lev1/dir1lev2/.dir",
 437         "dir2lev1/dir1lev2/.foo");
 438
 439   globfree (&gl);
 440
 441   return result;
 442 }
 443
 444 #else
 445 int main(void) { return 0; }
 446 #endif