1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1991, 1993, 1994
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Cimarron D. Taylor of the University of California, Berkeley.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 */
34
35#if 0
36static char sccsid[] = "@(#)find.c	8.5 (Berkeley) 8/5/94";
37#endif
38
39#include <sys/cdefs.h>
40__FBSDID("$FreeBSD$");
41
42#include <sys/types.h>
43#include <sys/stat.h>
44
45#include <err.h>
46#include <errno.h>
47#include <fts.h>
48#include <regex.h>
49#include <stdio.h>
50#include <stdlib.h>
51#include <string.h>
52
53#include "find.h"
54
55static int find_compare(const FTSENT * const *s1, const FTSENT * const *s2);
56
57/*
58 * find_compare --
59 *	tell fts_open() how to order the traversal of the hierarchy.
60 *	This variant gives lexicographical order, i.e., alphabetical
61 *	order within each directory.
62 */
63static int
64find_compare(const FTSENT * const *s1, const FTSENT * const *s2)
65{
66
67	return (strcoll((*s1)->fts_name, (*s2)->fts_name));
68}
69
70/*
71 * find_formplan --
72 *	process the command line and create a "plan" corresponding to the
73 *	command arguments.
74 */
75PLAN *
76find_formplan(char *argv[])
77{
78	PLAN *plan, *tail, *new;
79
80	/*
81	 * for each argument in the command line, determine what kind of node
82	 * it is, create the appropriate node type and add the new plan node
83	 * to the end of the existing plan.  The resulting plan is a linked
84	 * list of plan nodes.  For example, the string:
85	 *
86	 *	% find . -name foo -newer bar -print
87	 *
88	 * results in the plan:
89	 *
90	 *	[-name foo]--> [-newer bar]--> [-print]
91	 *
92	 * in this diagram, `[-name foo]' represents the plan node generated
93	 * by c_name() with an argument of foo and `-->' represents the
94	 * plan->next pointer.
95	 */
96	for (plan = tail = NULL; *argv;) {
97		if (!(new = find_create(&argv)))
98			continue;
99		if (plan == NULL)
100			tail = plan = new;
101		else {
102			tail->next = new;
103			tail = new;
104		}
105	}
106
107	/*
108	 * if the user didn't specify one of -print, -ok or -exec, then -print
109	 * is assumed so we bracket the current expression with parens, if
110	 * necessary, and add a -print node on the end.
111	 */
112	if (!isoutput) {
113		OPTION *p;
114		char **argv1 = 0;
115
116		if (plan == NULL) {
117			p = lookup_option("-print");
118			new = (p->create)(p, &argv1);
119			tail = plan = new;
120		} else {
121			p = lookup_option("(");
122			new = (p->create)(p, &argv1);
123			new->next = plan;
124			plan = new;
125			p = lookup_option(")");
126			new = (p->create)(p, &argv1);
127			tail->next = new;
128			tail = new;
129			p = lookup_option("-print");
130			new = (p->create)(p, &argv1);
131			tail->next = new;
132			tail = new;
133		}
134	}
135
136	/*
137	 * the command line has been completely processed into a search plan
138	 * except for the (, ), !, and -o operators.  Rearrange the plan so
139	 * that the portions of the plan which are affected by the operators
140	 * are moved into operator nodes themselves.  For example:
141	 *
142	 *	[!]--> [-name foo]--> [-print]
143	 *
144	 * becomes
145	 *
146	 *	[! [-name foo] ]--> [-print]
147	 *
148	 * and
149	 *
150	 *	[(]--> [-depth]--> [-name foo]--> [)]--> [-print]
151	 *
152	 * becomes
153	 *
154	 *	[expr [-depth]-->[-name foo] ]--> [-print]
155	 *
156	 * operators are handled in order of precedence.
157	 */
158
159	plan = paren_squish(plan);		/* ()'s */
160	plan = not_squish(plan);		/* !'s */
161	plan = or_squish(plan);			/* -o's */
162	return (plan);
163}
164
165FTS *tree;			/* pointer to top of FTS hierarchy */
166
167/*
168 * find_execute --
169 *	take a search plan and an array of search paths and executes the plan
170 *	over all FTSENT's returned for the given search paths.
171 */
172int
173find_execute(PLAN *plan, char *paths[])
174{
175	FTSENT *entry;
176	PLAN *p;
177	int e;
178
179	tree = fts_open(paths, ftsoptions, (issort ? find_compare : NULL));
180	if (tree == NULL)
181		err(1, "ftsopen");
182
183	exitstatus = 0;
184	while (errno = 0, (entry = fts_read(tree)) != NULL) {
185		if (maxdepth != -1 && entry->fts_level >= maxdepth) {
186			if (fts_set(tree, entry, FTS_SKIP))
187				err(1, "%s", entry->fts_path);
188		}
189
190		switch (entry->fts_info) {
191		case FTS_D:
192			if (isdepth)
193				continue;
194			break;
195		case FTS_DP:
196			if (!isdepth)
197				continue;
198			break;
199		case FTS_DNR:
200		case FTS_NS:
201			if (ignore_readdir_race &&
202			    entry->fts_errno == ENOENT && entry->fts_level > 0)
203				continue;
204			/* FALLTHROUGH */
205		case FTS_ERR:
206			(void)fflush(stdout);
207			warnx("%s: %s",
208			    entry->fts_path, strerror(entry->fts_errno));
209			exitstatus = 1;
210			continue;
211#if defined(FTS_W) && defined(FTS_WHITEOUT)
212		case FTS_W:
213			if (ftsoptions & FTS_WHITEOUT)
214				break;
215			continue;
216#endif /* FTS_W */
217		}
218#define	BADCH	" \t\n\\'\""
219		if (isxargs && strpbrk(entry->fts_path, BADCH)) {
220			(void)fflush(stdout);
221			warnx("%s: illegal path", entry->fts_path);
222			exitstatus = 1;
223			continue;
224		}
225
226		if (mindepth != -1 && entry->fts_level < mindepth)
227			continue;
228
229		/*
230		 * Call all the functions in the execution plan until one is
231		 * false or all have been executed.  This is where we do all
232		 * the work specified by the user on the command line.
233		 */
234		for (p = plan; p && (p->execute)(p, entry); p = p->next);
235	}
236	e = errno;
237	finish_execplus();
238	if (e && (!ignore_readdir_race || e != ENOENT))
239		errc(1, e, "fts_read");
240	return (exitstatus);
241}
242