2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 #if !defined(HAVE_GLOB) || !defined(GLOB_HAS_ALTDIRFUNC) || \
41 !defined(GLOB_HAS_GL_MATCHC)
43 #if defined(LIBC_SCCS) && !defined(lint)
45 static char sccsid[] = "@(#)glob.c 8.3 (Berkeley) 10/13/93";
47 static char rcsid[] = "$OpenBSD: glob.c,v 1.8 1998/08/14 21:39:30 deraadt Exp $";
49 #endif /* LIBC_SCCS and not lint */
52 * glob(3) -- a superset of the one defined in POSIX 1003.2.
54 * The [!...] convention to negate a range is supported (SysV, Posix, ksh).
56 * Optional extra services, controlled by flags not defined by POSIX:
59 * Escaping convention: \ inhibits any special meaning the following
60 * character might have (except \ at end of string is retained).
62 * Set in gl_flags if pattern contained a globbing character.
64 * Same as GLOB_NOCHECK, but it will only append pattern if it did
65 * not contain any magic characters. [Used in csh style globbing]
67 * Use alternately specified directory access functions.
69 * expand ~user/foo to the /home/dir/of/user/foo
71 * expand {1,2}{a,b} to 1a 1b 2a 2b
73 * Number of matches in the current invocation of glob.
89 #define UNDERSCORE '_'
97 #define M_QUOTE 0x8000
98 #define M_PROTECT 0x4000
100 #define M_ASCII 0x00ff
102 typedef u_short Char;
107 #define M_PROTECT 0x40
116 #define CHAR(c) ((Char)((c)&M_ASCII))
117 #define META(c) ((Char)((c)|M_QUOTE))
118 #define M_ALL META('*')
119 #define M_END META(']')
120 #define M_NOT META('!')
121 #define M_ONE META('?')
122 #define M_RNG META('-')
123 #define M_SET META('[')
124 #define ismeta(c) (((c)&M_QUOTE) != 0)
127 static int compare __P((const void *, const void *));
128 static void g_Ctoc __P((const Char *, char *));
129 static int g_lstat __P((Char *, struct stat *, glob_t *));
130 static DIR *g_opendir __P((Char *, glob_t *));
131 static Char *g_strchr __P((Char *, int));
133 static Char *g_strcat __P((Char *, const Char *));
135 static int g_stat __P((Char *, struct stat *, glob_t *));
136 static int glob0 __P((const Char *, glob_t *));
137 static int glob1 __P((Char *, glob_t *));
138 static int glob2 __P((Char *, Char *, Char *, glob_t *));
139 static int glob3 __P((Char *, Char *, Char *, Char *, glob_t *));
140 static int globextend __P((const Char *, glob_t *));
141 static const Char * globtilde __P((const Char *, Char *, size_t, glob_t *));
142 static int globexp1 __P((const Char *, glob_t *));
143 static int globexp2 __P((const Char *, const Char *, glob_t *, int *));
144 static int match __P((Char *, Char *, Char *));
146 static void qprintf __P((const char *, Char *));
150 glob(pattern, flags, errfunc, pglob)
152 int flags, (*errfunc) __P((const char *, int));
155 const u_char *patnext;
157 Char *bufnext, *bufend, patbuf[MAXPATHLEN+1];
159 patnext = (u_char *) pattern;
160 if (!(flags & GLOB_APPEND)) {
162 pglob->gl_pathv = NULL;
163 if (!(flags & GLOB_DOOFFS))
166 pglob->gl_flags = flags & ~GLOB_MAGCHAR;
167 pglob->gl_errfunc = errfunc;
168 pglob->gl_matchc = 0;
171 bufend = bufnext + MAXPATHLEN;
172 if (flags & GLOB_NOESCAPE)
173 while (bufnext < bufend && (c = *patnext++) != EOS)
176 /* Protect the quoted characters. */
177 while (bufnext < bufend && (c = *patnext++) != EOS)
179 if ((c = *patnext++) == EOS) {
183 *bufnext++ = c | M_PROTECT;
190 if (flags & GLOB_BRACE)
191 return globexp1(patbuf, pglob);
193 return glob0(patbuf, pglob);
197 * Expand recursively a glob {} pattern. When there is no more expansion
198 * invoke the standard globbing routine to glob the rest of the magic
201 static int globexp1(pattern, pglob)
205 const Char* ptr = pattern;
208 /* Protect a single {}, for find(1), like csh */
209 if (pattern[0] == LBRACE && pattern[1] == RBRACE && pattern[2] == EOS)
210 return glob0(pattern, pglob);
212 while ((ptr = (const Char *) g_strchr((Char *) ptr, LBRACE)) != NULL)
213 if (!globexp2(ptr, pattern, pglob, &rv))
216 return glob0(pattern, pglob);
221 * Recursive brace globbing helper. Tries to expand a single brace.
222 * If it succeeds then it invokes globexp1 with the new pattern.
223 * If it fails then it tries to glob the rest of the pattern and returns.
225 static int globexp2(ptr, pattern, pglob, rv)
226 const Char *ptr, *pattern;
232 const Char *pe, *pm, *pl;
233 Char patbuf[MAXPATHLEN + 1];
235 /* copy part up to the brace */
236 for (lm = patbuf, pm = pattern; pm != ptr; *lm++ = *pm++)
240 /* Find the balanced brace */
241 for (i = 0, pe = ++ptr; *pe; pe++)
242 if (*pe == LBRACKET) {
243 /* Ignore everything between [] */
244 for (pm = pe++; *pe != RBRACKET && *pe != EOS; pe++)
248 * We could not find a matching RBRACKET.
249 * Ignore and just look for RBRACE
254 else if (*pe == LBRACE)
256 else if (*pe == RBRACE) {
262 /* Non matching braces; just glob the pattern */
263 if (i != 0 || *pe == EOS) {
264 *rv = glob0(patbuf, pglob);
268 for (i = 0, pl = pm = ptr; pm <= pe; pm++)
271 /* Ignore everything between [] */
272 for (pl = pm++; *pm != RBRACKET && *pm != EOS; pm++)
276 * We could not find a matching RBRACKET.
277 * Ignore and just look for RBRACE
294 if (i && *pm == COMMA)
297 /* Append the current string */
298 for (lm = ls; (pl < pm); *lm++ = *pl++)
301 * Append the rest of the pattern after the
304 for (pl = pe + 1; (*lm++ = *pl++) != EOS;)
307 /* Expand the current pattern */
309 qprintf("globexp2:", patbuf);
311 *rv = globexp1(patbuf, pglob);
313 /* move after the comma, to the next string */
328 * expand tilde from the passwd file.
331 globtilde(pattern, patbuf, patbuf_len, pglob)
342 if (*pattern != TILDE || !(pglob->gl_flags & GLOB_TILDE))
345 /* Copy up to the end of the string or / */
346 eb = &patbuf[patbuf_len - 1];
347 for (p = pattern + 1, h = (char *) patbuf;
348 h < (char *)eb && *p && *p != SLASH; *h++ = *p++)
353 if (((char *) patbuf)[0] == EOS) {
355 * handle a plain ~ or ~/ by expanding $HOME
356 * first and then trying the password file
359 if (issetugid() != 0 || (h = getenv("HOME")) == NULL) {
361 if ((getuid() != geteuid()) || (h = getenv("HOME")) == NULL) {
362 if ((pwd = getpwuid(getuid())) == NULL)
372 if ((pwd = getpwnam((char*) patbuf)) == NULL)
378 /* Copy the home directory */
379 for (b = patbuf; b < eb && *h; *b++ = *h++)
382 /* Append the rest of the pattern */
383 while (b < eb && (*b++ = *p++) != EOS)
392 * The main glob() routine: compiles the pattern (optionally processing
393 * quotes), calls glob1() to do the real pattern matching, and finally
394 * sorts the list (unless unsorted operation is requested). Returns 0
395 * if things went well, nonzero if errors occurred. It is not an error
396 * to find no matches.
399 glob0(pattern, pglob)
403 const Char *qpatnext;
404 int c, err, oldpathc;
405 Char *bufnext, patbuf[MAXPATHLEN+1];
407 qpatnext = globtilde(pattern, patbuf, sizeof(patbuf) / sizeof(Char),
409 oldpathc = pglob->gl_pathc;
412 /* We don't need to check for buffer overflow any more. */
413 while ((c = *qpatnext++) != EOS) {
419 if (*qpatnext == EOS ||
420 g_strchr((Char *) qpatnext+1, RBRACKET) == NULL) {
421 *bufnext++ = LBRACKET;
431 *bufnext++ = CHAR(c);
432 if (*qpatnext == RANGE &&
433 (c = qpatnext[1]) != RBRACKET) {
435 *bufnext++ = CHAR(c);
438 } while ((c = *qpatnext++) != RBRACKET);
439 pglob->gl_flags |= GLOB_MAGCHAR;
443 pglob->gl_flags |= GLOB_MAGCHAR;
447 pglob->gl_flags |= GLOB_MAGCHAR;
448 /* collapse adjacent stars to one,
449 * to avoid exponential behavior
451 if (bufnext == patbuf || bufnext[-1] != M_ALL)
455 *bufnext++ = CHAR(c);
461 qprintf("glob0:", patbuf);
464 if ((err = glob1(patbuf, pglob)) != 0)
468 * If there was no match we are going to append the pattern
469 * if GLOB_NOCHECK was specified or if GLOB_NOMAGIC was specified
470 * and the pattern did not contain any magic characters
471 * GLOB_NOMAGIC is there just for compatibility with csh.
473 if (pglob->gl_pathc == oldpathc) {
474 if ((pglob->gl_flags & GLOB_NOCHECK) ||
475 ((pglob->gl_flags & GLOB_NOMAGIC) &&
476 !(pglob->gl_flags & GLOB_MAGCHAR)))
477 return(globextend(pattern, pglob));
479 return(GLOB_NOMATCH);
481 if (!(pglob->gl_flags & GLOB_NOSORT))
482 qsort(pglob->gl_pathv + pglob->gl_offs + oldpathc,
483 pglob->gl_pathc - oldpathc, sizeof(char *), compare);
491 return(strcmp(*(char **)p, *(char **)q));
495 glob1(pattern, pglob)
499 Char pathbuf[MAXPATHLEN+1];
501 /* A null pathname is invalid -- POSIX 1003.1 sect. 2.4. */
504 return(glob2(pathbuf, pathbuf, pattern, pglob));
508 * The functions glob2 and glob3 are mutually recursive; there is one level
509 * of recursion for each segment in the pattern that contains one or more
513 glob2(pathbuf, pathend, pattern, pglob)
514 Char *pathbuf, *pathend, *pattern;
522 * Loop over pattern segments until end of pattern or until
523 * segment with meta character found.
525 for (anymeta = 0;;) {
526 if (*pattern == EOS) { /* End of pattern? */
528 if (g_lstat(pathbuf, &sb, pglob))
531 if (((pglob->gl_flags & GLOB_MARK) &&
532 pathend[-1] != SEP) && (S_ISDIR(sb.st_mode)
533 || (S_ISLNK(sb.st_mode) &&
534 (g_stat(pathbuf, &sb, pglob) == 0) &&
535 S_ISDIR(sb.st_mode)))) {
540 return(globextend(pathbuf, pglob));
543 /* Find end of next segment, copy tentatively to pathend. */
546 while (*p != EOS && *p != SEP) {
552 if (!anymeta) { /* No expansion, do next segment. */
555 while (*pattern == SEP)
556 *pathend++ = *pattern++;
557 } else /* Need expansion, recurse. */
558 return(glob3(pathbuf, pathend, pattern, p, pglob));
564 glob3(pathbuf, pathend, pattern, restpattern, pglob)
565 Char *pathbuf, *pathend, *pattern, *restpattern;
568 register struct dirent *dp;
571 char buf[MAXPATHLEN];
574 * The readdirfunc declaration can't be prototyped, because it is
575 * assigned, below, to two functions which are prototyped in glob.h
576 * and dirent.h as taking pointers to differently typed opaque
579 struct dirent *(*readdirfunc)();
584 if ((dirp = g_opendir(pathbuf, pglob)) == NULL) {
585 /* TODO: don't call for ENOENT or ENOTDIR? */
586 if (pglob->gl_errfunc) {
587 g_Ctoc(pathbuf, buf);
588 if (pglob->gl_errfunc(buf, errno) ||
589 pglob->gl_flags & GLOB_ERR)
590 return (GLOB_ABORTED);
597 /* Search directory for matching names. */
598 if (pglob->gl_flags & GLOB_ALTDIRFUNC)
599 readdirfunc = pglob->gl_readdir;
601 readdirfunc = readdir;
602 while ((dp = (*readdirfunc)(dirp))) {
606 /* Initial DOT must be matched literally. */
607 if (dp->d_name[0] == DOT && *pattern != DOT)
609 for (sc = (u_char *) dp->d_name, dc = pathend;
610 (*dc++ = *sc++) != EOS;)
612 if (!match(pathend, pattern, restpattern)) {
616 err = glob2(pathbuf, --dc, restpattern, pglob);
621 if (pglob->gl_flags & GLOB_ALTDIRFUNC)
622 (*pglob->gl_closedir)(dirp);
630 * Extend the gl_pathv member of a glob_t structure to accomodate a new item,
631 * add the new item, and update gl_pathc.
633 * This assumes the BSD realloc, which only copies the block when its size
634 * crosses a power-of-two boundary; for v7 realloc, this would cause quadratic
637 * Return 0 if new item added, error code if memory couldn't be allocated.
639 * Invariant of the glob_t structure:
640 * Either gl_pathc is zero and gl_pathv is NULL; or gl_pathc > 0 and
641 * gl_pathv points to (gl_offs + gl_pathc + 1) items.
644 globextend(path, pglob)
648 register char **pathv;
654 newsize = sizeof(*pathv) * (2 + pglob->gl_pathc + pglob->gl_offs);
655 pathv = pglob->gl_pathv ?
656 realloc((char *)pglob->gl_pathv, newsize) :
660 free(pglob->gl_pathv);
661 return(GLOB_NOSPACE);
664 if (pglob->gl_pathv == NULL && pglob->gl_offs > 0) {
665 /* first time around -- clear initial gl_offs items */
666 pathv += pglob->gl_offs;
667 for (i = pglob->gl_offs; --i >= 0; )
670 pglob->gl_pathv = pathv;
672 for (p = path; *p++;)
674 if ((copy = malloc(p - path)) != NULL) {
676 pathv[pglob->gl_offs + pglob->gl_pathc++] = copy;
678 pathv[pglob->gl_offs + pglob->gl_pathc] = NULL;
679 return(copy == NULL ? GLOB_NOSPACE : 0);
684 * pattern matching function for filenames. Each occurrence of the *
685 * pattern causes a recursion level.
688 match(name, pat, patend)
689 register Char *name, *pat, *patend;
691 int ok, negate_range;
694 while (pat < patend) {
696 switch (c & M_MASK) {
701 if (match(name, pat, patend))
703 while (*name++ != EOS);
711 if ((k = *name++) == EOS)
713 if ((negate_range = ((*pat & M_MASK) == M_NOT)) != EOS)
715 while (((c = *pat++) & M_MASK) != M_END)
716 if ((*pat & M_MASK) == M_RNG) {
717 if (c <= k && k <= pat[1])
722 if (ok == negate_range)
731 return(*name == EOS);
734 /* Free allocated data belonging to a glob_t structure. */
742 if (pglob->gl_pathv != NULL) {
743 pp = pglob->gl_pathv + pglob->gl_offs;
744 for (i = pglob->gl_pathc; i--; ++pp)
747 free(pglob->gl_pathv);
752 g_opendir(str, pglob)
756 char buf[MAXPATHLEN];
763 if (pglob->gl_flags & GLOB_ALTDIRFUNC)
764 return((*pglob->gl_opendir)(buf));
766 return(opendir(buf));
770 g_lstat(fn, sb, pglob)
775 char buf[MAXPATHLEN];
778 if (pglob->gl_flags & GLOB_ALTDIRFUNC)
779 return((*pglob->gl_lstat)(buf, sb));
780 return(lstat(buf, sb));
784 g_stat(fn, sb, pglob)
789 char buf[MAXPATHLEN];
792 if (pglob->gl_flags & GLOB_ALTDIRFUNC)
793 return((*pglob->gl_stat)(buf, sb));
794 return(stat(buf, sb));
820 while((*dst++ = *src++) != EOS)
829 register const Char *str;
834 for (dc = buf; (*dc++ = *str++) != EOS;)
846 (void)printf("%s:\n", str);
848 (void)printf("%c", CHAR(*p));
851 (void)printf("%c", *p & M_PROTECT ? '"' : ' ');
854 (void)printf("%c", ismeta(*p) ? '_' : ' ');
859 #endif /* !defined(HAVE_GLOB) || !defined(GLOB_HAS_ALTDIRFUNC) ||
860 !defined(GLOB_HAS_GL_MATCHC) */