[apple/shell_cmds.git] / find / find.c

/*-
 * Copyright (c) 1991, 1993, 1994
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Cimarron D. Taylor of the University of California, Berkeley.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef lint
#if 0
static char sccsid[] = "@(#)find.c	8.5 (Berkeley) 8/5/94";
#else
#endif
#endif /* not lint */

#include <sys/cdefs.h>
__FBSDID("$FreeBSD: src/usr.bin/find/find.c,v 1.18 2006/05/14 20:23:00 krion Exp $");

#include <sys/types.h>
#include <sys/stat.h>

#include <err.h>
#include <errno.h>
#include <fts.h>
#include <regex.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#ifdef __APPLE__
#include <get_compat.h>
#include <unistd.h>
#else
#define COMPAT_MODE(func, mode) 1
#endif

#include "find.h"

static int find_compare(const FTSENT * const *s1, const FTSENT * const *s2);

/*
 * find_compare --
 *	tell fts_open() how to order the traversal of the hierarchy. 
 *	This variant gives lexicographical order, i.e., alphabetical
 *	order within each directory.
 */
static int
find_compare(const FTSENT * const *s1, const FTSENT * const *s2)
{

	return (strcoll((*s1)->fts_name, (*s2)->fts_name));
}

/*
 * find_formplan --
 *	process the command line and create a "plan" corresponding to the
 *	command arguments.
 */
PLAN *
find_formplan(char *argv[])
{
	PLAN *plan, *tail, *new;

	/*
	 * for each argument in the command line, determine what kind of node
	 * it is, create the appropriate node type and add the new plan node
	 * to the end of the existing plan.  The resulting plan is a linked
	 * list of plan nodes.  For example, the string:
	 *
	 *	% find . -name foo -newer bar -print
	 *
	 * results in the plan:
	 *
	 *	[-name foo]--> [-newer bar]--> [-print]
	 *
	 * in this diagram, `[-name foo]' represents the plan node generated
	 * by c_name() with an argument of foo and `-->' represents the
	 * plan->next pointer.
	 */
	for (plan = tail = NULL; *argv;) {
		if (!(new = find_create(&argv)))
			continue;
		if (plan == NULL)
			tail = plan = new;
		else {
			tail->next = new;
			tail = new;
		}
	}

	/*
	 * if the user didn't specify one of -print, -ok or -exec, then -print
	 * is assumed so we bracket the current expression with parens, if
	 * necessary, and add a -print node on the end.
	 */
	if (!isoutput) {
		OPTION *p;
		char **argv1 = 0;

		if (plan == NULL) {
			p = lookup_option("-print");
			new = (p->create)(p, &argv1);
			tail = plan = new;
		} else {
			p = lookup_option("(");
			new = (p->create)(p, &argv1);
			new->next = plan;
			plan = new;
			p = lookup_option(")");
			new = (p->create)(p, &argv1);
			tail->next = new;
			tail = new;
			p = lookup_option("-print");
			new = (p->create)(p, &argv1);
			tail->next = new;
			tail = new;
		}
	}

	/*
	 * the command line has been completely processed into a search plan
	 * except for the (, ), !, and -o operators.  Rearrange the plan so
	 * that the portions of the plan which are affected by the operators
	 * are moved into operator nodes themselves.  For example:
	 *
	 *	[!]--> [-name foo]--> [-print]
	 *
	 * becomes
	 *
	 *	[! [-name foo] ]--> [-print]
	 *
	 * and
	 *
	 *	[(]--> [-depth]--> [-name foo]--> [)]--> [-print]
	 *
	 * becomes
	 *
	 *	[expr [-depth]-->[-name foo] ]--> [-print]
	 *
	 * operators are handled in order of precedence.
	 */

	plan = paren_squish(plan);		/* ()'s */
	plan = not_squish(plan);		/* !'s */
	plan = or_squish(plan);			/* -o's */
	return (plan);
}

/* addPath - helper function used to build a list of paths that were
 * specified on the command line that we are allowed to search.
 */
static char **addPath(char **array, char *newPath)
{
	static int pathCounter = 0;
	
	if (newPath == NULL) {	/* initialize array */
		if ((array = malloc(sizeof(char *))) == NULL)
			err(2, "out of memory");
		array[0] = NULL;
	}
	else {
		array = realloc(array, (++pathCounter + 1) * sizeof(char *));
		if (array == NULL)
			err(2, "out of memory");
		else {
			array[pathCounter - 1] = newPath;
			array[pathCounter] = NULL;	/* ensure array is null terminated */
		}
	}
	return (array);
}

FTS *tree;			/* pointer to top of FTS hierarchy */

/*
 * find_execute --
 *	take a search plan and an array of search paths and executes the plan
 *	over all FTSENT's returned for the given search paths.
 */
int
find_execute(PLAN *plan, char *paths[])
{
	FTSENT *entry;
	PLAN *p;
	int rval;
	char **myPaths;
	int nonSearchableDirFound = 0;
	int pathIndex;
	struct stat statInfo;

	/* special-case directories specified on command line - explicitly examine
	 * mode bits, to ensure failure if the directory cannot be searched
	 * (whether or not it's empty). UNIX conformance... <sigh>
	 */
		
	int strict_symlinks = (ftsoptions & (FTS_COMFOLLOW|FTS_LOGICAL))
	  && COMPAT_MODE("bin/find", "unix2003");

	myPaths = addPath(NULL, NULL);
	for (pathIndex = 0; paths[pathIndex] != NULL; ++pathIndex) {
		int stat_ret = stat(paths[pathIndex], &statInfo);
		int stat_errno = errno;
		if (strict_symlinks && stat_ret < 0) {
		    if (stat_errno == ELOOP) {
			errx(1, "Symlink loop resolving %s", paths[pathIndex]);
		    }
		}

		/* retrieve mode bits, and examine "searchable" bit of 
		  directories, exempt root from POSIX conformance */
		if (COMPAT_MODE("bin/find", "unix2003") && getuid() 
		  && stat_ret == 0 
		  && ((statInfo.st_mode & S_IFMT) == S_IFDIR)) {
			if ((statInfo.st_mode & (S_IXUSR + S_IXGRP + S_IXOTH)) != 0) {
				myPaths = addPath(myPaths, paths[pathIndex]);
			} else {
				if (stat_errno != ENAMETOOLONG) {	/* if name is too long, just let existing logic handle it */
					warnx("%s: Permission denied", paths[pathIndex]);
					nonSearchableDirFound = 1;
				}
			}
		} else {
			/* not a directory, so add path to array */
			myPaths = addPath(myPaths, paths[pathIndex]);
		}
	}
	if (myPaths[0] == NULL) {	/* were any directories searchable? */
		free(myPaths);
		return(nonSearchableDirFound);	/* no... */
	}

	tree = fts_open(myPaths, ftsoptions, (issort ? find_compare : NULL));
	if (tree == NULL)
		err(1, "ftsopen");

	for (rval = nonSearchableDirFound; (entry = fts_read(tree)) != NULL;) {
		if (maxdepth != -1 && entry->fts_level >= maxdepth) {
			if (fts_set(tree, entry, FTS_SKIP))
				err(1, "%s", entry->fts_path);
		}

		switch (entry->fts_info) {
		case FTS_D:
			if (isdepth)
				continue;
			break;
		case FTS_DP:
			if (!isdepth)
				continue;
			break;
		case FTS_DNR:
		case FTS_ERR:
		case FTS_NS:
			(void)fflush(stdout);
			warnx("%s: %s",
			    entry->fts_path, strerror(entry->fts_errno));
			rval = 1;
			continue;
#ifdef FTS_W
		case FTS_W:
			continue;
#endif /* FTS_W */
		}
#define	BADCH	" \t\n\\'\""
		if (isxargs && strpbrk(entry->fts_path, BADCH)) {
			(void)fflush(stdout);
			warnx("%s: illegal path", entry->fts_path);
			rval = 1;
			continue;
		}

		if (mindepth != -1 && entry->fts_level < mindepth)
			continue;

		/*
		 * Call all the functions in the execution plan until one is
		 * false or all have been executed.  This is where we do all
		 * the work specified by the user on the command line.
		 */
		for (p = plan; p && (p->execute)(p, entry); p = p->next);
	}
	free (myPaths);
	finish_execplus();
	if (errno)
		err(1, "fts_read");
	fts_close(tree);
	return (rval);
}
Commit	Line	Data
44bd5ea7 A	1	/*-
	2	* Copyright (c) 1991, 1993, 1994
	3	* The Regents of the University of California. All rights reserved.
	4	*
	5	* This code is derived from software contributed to Berkeley by
	6	* Cimarron D. Taylor of the University of California, Berkeley.
	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	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.
	23	*
	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
	34	* SUCH DAMAGE.
	35	*/
	36
44bd5ea7 A	37	#ifndef lint
44bd5ea7 A	38	#if 0
c0fcf4e1	39	static char sccsid[] = "@(#)find.c 8.5 (Berkeley) 8/5/94";
44bd5ea7	40	#else
44bd5ea7 A	41	#endif
	42	#endif /* not lint */
	43
e1a085ba A	44	#include <sys/cdefs.h>
	45	__FBSDID("$FreeBSD: src/usr.bin/find/find.c,v 1.18 2006/05/14 20:23:00 krion Exp $");
	46
44bd5ea7 A	47	#include <sys/types.h>
	48	#include <sys/stat.h>
	49
	50	#include <err.h>
	51	#include <errno.h>
	52	#include <fts.h>
c0fcf4e1	53	#include <regex.h>
44bd5ea7	54	#include <stdio.h>
44bd5ea7	55	#include <stdlib.h>
e1a085ba	56	#include <string.h>
44bd5ea7	57
1a5bac72	58	#ifdef __APPLE__
e1a085ba A	59	#include <get_compat.h>
e1a085ba A	60	#include <unistd.h>
1a5bac72 A	61	#else
	62	#define COMPAT_MODE(func, mode) 1
	63	#endif
	64
44bd5ea7 A	65	#include "find.h"
44bd5ea7 A	66
e1a085ba	67	static int find_compare(const FTSENT * const s1, const FTSENT const *s2);
c0fcf4e1 A	68
	69	/*
	70	* find_compare --
	71	* tell fts_open() how to order the traversal of the hierarchy.
	72	* This variant gives lexicographical order, i.e., alphabetical
	73	* order within each directory.
	74	*/
	75	static int
e1a085ba	76	find_compare(const FTSENT * const s1, const FTSENT const *s2)
c0fcf4e1 A	77	{
	78
	79	return (strcoll((s1)->fts_name, (s2)->fts_name));
	80	}
	81
44bd5ea7 A	82	/*
	83	* find_formplan --
	84	* process the command line and create a "plan" corresponding to the
	85	* command arguments.
	86	*/
	87	PLAN *
e1a085ba	88	find_formplan(char *argv[])
44bd5ea7 A	89	{
	90	PLAN plan, tail, *new;
	91
	92	/*
	93	* for each argument in the command line, determine what kind of node
	94	* it is, create the appropriate node type and add the new plan node
	95	* to the end of the existing plan. The resulting plan is a linked
	96	* list of plan nodes. For example, the string:
	97	*
	98	* % find . -name foo -newer bar -print
	99	*
	100	* results in the plan:
	101	*
	102	* [-name foo]--> [-newer bar]--> [-print]
	103	*
	104	* in this diagram, `[-name foo]' represents the plan node generated
	105	* by c_name() with an argument of foo and `-->' represents the
	106	* plan->next pointer.
	107	*/
	108	for (plan = tail = NULL; *argv;) {
	109	if (!(new = find_create(&argv)))
	110	continue;
	111	if (plan == NULL)
	112	tail = plan = new;
	113	else {
	114	tail->next = new;
	115	tail = new;
	116	}
	117	}
c0fcf4e1	118
44bd5ea7 A	119	/*
	120	* if the user didn't specify one of -print, -ok or -exec, then -print
	121	* is assumed so we bracket the current expression with parens, if
	122	* necessary, and add a -print node on the end.
	123	*/
	124	if (!isoutput) {
c0fcf4e1	125	OPTION *p;
e1a085ba	126	char **argv1 = 0;
c0fcf4e1	127
44bd5ea7	128	if (plan == NULL) {
e1a085ba A	129	p = lookup_option("-print");
e1a085ba A	130	new = (p->create)(p, &argv1);
44bd5ea7 A	131	tail = plan = new;
44bd5ea7 A	132	} else {
e1a085ba A	133	p = lookup_option("(");
e1a085ba A	134	new = (p->create)(p, &argv1);
44bd5ea7 A	135	new->next = plan;
44bd5ea7 A	136	plan = new;
e1a085ba A	137	p = lookup_option(")");
e1a085ba A	138	new = (p->create)(p, &argv1);
44bd5ea7 A	139	tail->next = new;
44bd5ea7 A	140	tail = new;
e1a085ba A	141	p = lookup_option("-print");
e1a085ba A	142	new = (p->create)(p, &argv1);
44bd5ea7 A	143	tail->next = new;
	144	tail = new;
	145	}
	146	}
c0fcf4e1	147
44bd5ea7 A	148	/*
	149	* the command line has been completely processed into a search plan
	150	* except for the (, ), !, and -o operators. Rearrange the plan so
	151	* that the portions of the plan which are affected by the operators
	152	* are moved into operator nodes themselves. For example:
	153	*
	154	* [!]--> [-name foo]--> [-print]
	155	*
	156	* becomes
	157	*
	158	* [! [-name foo] ]--> [-print]
	159	*
	160	* and
	161	*
	162	* [(]--> [-depth]--> [-name foo]--> [)]--> [-print]
	163	*
	164	* becomes
	165	*
	166	* [expr [-depth]-->[-name foo] ]--> [-print]
	167	*
	168	* operators are handled in order of precedence.
	169	*/
	170
	171	plan = paren_squish(plan); /* ()'s */
	172	plan = not_squish(plan); /* !'s */
	173	plan = or_squish(plan); /* -o's */
	174	return (plan);
	175	}
c0fcf4e1	176
1c4c78a5 A	177	/* addPath - helper function used to build a list of paths that were
	178	* specified on the command line that we are allowed to search.
	179	*/
	180	static char addPath(char array, char *newPath)
	181	{
	182	static int pathCounter = 0;
	183
	184	if (newPath == NULL) { /* initialize array */
	185	if ((array = malloc(sizeof(char *))) == NULL)
	186	err(2, "out of memory");
	187	array[0] = NULL;
	188	}
	189	else {
	190	array = realloc(array, (++pathCounter + 1) * sizeof(char *));
	191	if (array == NULL)
	192	err(2, "out of memory");
	193	else {
	194	array[pathCounter - 1] = newPath;
	195	array[pathCounter] = NULL; /* ensure array is null terminated */
	196	}
	197	}
	198	return (array);
	199	}
	200
44bd5ea7 A	201	FTS tree; / pointer to top of FTS hierarchy */
	202
	203	/*
	204	* find_execute --
	205	* take a search plan and an array of search paths and executes the plan
	206	* over all FTSENT's returned for the given search paths.
	207	*/
	208	int
e1a085ba	209	find_execute(PLAN plan, char paths[])
44bd5ea7	210	{
e1a085ba	211	FTSENT *entry;
44bd5ea7 A	212	PLAN *p;
44bd5ea7 A	213	int rval;
e1a085ba A	214	char **myPaths;
	215	int nonSearchableDirFound = 0;
	216	int pathIndex;
1c4c78a5	217	struct stat statInfo;
c0fcf4e1	218
1c4c78a5 A	219	/* special-case directories specified on command line - explicitly examine
	220	* mode bits, to ensure failure if the directory cannot be searched
	221	* (whether or not it's empty). UNIX conformance... <sigh>
	222	*/
	223
1a5bac72 A	224	int strict_symlinks = (ftsoptions & (FTS_COMFOLLOW\|FTS_LOGICAL))
	225	&& COMPAT_MODE("bin/find", "unix2003");
	226
1c4c78a5 A	227	myPaths = addPath(NULL, NULL);
1c4c78a5 A	228	for (pathIndex = 0; paths[pathIndex] != NULL; ++pathIndex) {
1a5bac72 A	229	int stat_ret = stat(paths[pathIndex], &statInfo);
	230	int stat_errno = errno;
	231	if (strict_symlinks && stat_ret < 0) {
	232	if (stat_errno == ELOOP) {
	233	errx(1, "Symlink loop resolving %s", paths[pathIndex]);
	234	}
	235	}
	236
	237	/* retrieve mode bits, and examine "searchable" bit of
	238	directories, exempt root from POSIX conformance */
	239	if (COMPAT_MODE("bin/find", "unix2003") && getuid()
	240	&& stat_ret == 0
	241	&& ((statInfo.st_mode & S_IFMT) == S_IFDIR)) {
1c4c78a5 A	242	if ((statInfo.st_mode & (S_IXUSR + S_IXGRP + S_IXOTH)) != 0) {
	243	myPaths = addPath(myPaths, paths[pathIndex]);
	244	} else {
1a5bac72	245	if (stat_errno != ENAMETOOLONG) { /* if name is too long, just let existing logic handle it */
1c4c78a5 A	246	warnx("%s: Permission denied", paths[pathIndex]);
	247	nonSearchableDirFound = 1;
	248	}
	249	}
	250	} else {
	251	/* not a directory, so add path to array */
	252	myPaths = addPath(myPaths, paths[pathIndex]);
	253	}
	254	}
	255	if (myPaths[0] == NULL) { /* were any directories searchable? */
	256	free(myPaths);
	257	return(nonSearchableDirFound); /* no... */
	258	}
	259
	260	tree = fts_open(myPaths, ftsoptions, (issort ? find_compare : NULL));
c0fcf4e1	261	if (tree == NULL)
44bd5ea7 A	262	err(1, "ftsopen");
44bd5ea7 A	263
1c4c78a5	264	for (rval = nonSearchableDirFound; (entry = fts_read(tree)) != NULL;) {
e1a085ba A	265	if (maxdepth != -1 && entry->fts_level >= maxdepth) {
	266	if (fts_set(tree, entry, FTS_SKIP))
	267	err(1, "%s", entry->fts_path);
	268	}
	269
44bd5ea7 A	270	switch (entry->fts_info) {
	271	case FTS_D:
	272	if (isdepth)
	273	continue;
	274	break;
	275	case FTS_DP:
	276	if (!isdepth)
	277	continue;
	278	break;
	279	case FTS_DNR:
	280	case FTS_ERR:
	281	case FTS_NS:
	282	(void)fflush(stdout);
	283	warnx("%s: %s",
	284	entry->fts_path, strerror(entry->fts_errno));
	285	rval = 1;
	286	continue;
	287	#ifdef FTS_W
	288	case FTS_W:
	289	continue;
	290	#endif /* FTS_W */
	291	}
	292	#define BADCH " \t\n\\'\""
	293	if (isxargs && strpbrk(entry->fts_path, BADCH)) {
	294	(void)fflush(stdout);
	295	warnx("%s: illegal path", entry->fts_path);
	296	rval = 1;
	297	continue;
	298	}
c0fcf4e1 A	299
	300	if (mindepth != -1 && entry->fts_level < mindepth)
	301	continue;
	302
44bd5ea7 A	303	/*
	304	* Call all the functions in the execution plan until one is
	305	* false or all have been executed. This is where we do all
	306	* the work specified by the user on the command line.
	307	*/
c0fcf4e1	308	for (p = plan; p && (p->execute)(p, entry); p = p->next);
44bd5ea7	309	}
e1a085ba A	310	free (myPaths);
e1a085ba A	311	finish_execplus();
44bd5ea7 A	312	if (errno)
44bd5ea7 A	313	err(1, "fts_read");
e1a085ba	314	fts_close(tree);
44bd5ea7 A	315	return (rval);
44bd5ea7 A	316	}