xref: /freebsd/usr.bin/find/find.c (revision f0a75d274af375d15b97b830966b99a02b7db911)
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 
37 #ifndef lint
38 #if 0
39 static char sccsid[] = "@(#)find.c	8.5 (Berkeley) 8/5/94";
40 #else
41 #endif
42 #endif /* not lint */
43 
44 #include <sys/cdefs.h>
45 __FBSDID("$FreeBSD$");
46 
47 #include <sys/types.h>
48 #include <sys/stat.h>
49 
50 #include <err.h>
51 #include <errno.h>
52 #include <fts.h>
53 #include <regex.h>
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57 
58 #include "find.h"
59 
60 static int find_compare(const FTSENT * const *s1, const FTSENT * const *s2);
61 
62 /*
63  * find_compare --
64  *	tell fts_open() how to order the traversal of the hierarchy.
65  *	This variant gives lexicographical order, i.e., alphabetical
66  *	order within each directory.
67  */
68 static int
69 find_compare(const FTSENT * const *s1, const FTSENT * const *s2)
70 {
71 
72 	return (strcoll((*s1)->fts_name, (*s2)->fts_name));
73 }
74 
75 /*
76  * find_formplan --
77  *	process the command line and create a "plan" corresponding to the
78  *	command arguments.
79  */
80 PLAN *
81 find_formplan(char *argv[])
82 {
83 	PLAN *plan, *tail, *new;
84 
85 	/*
86 	 * for each argument in the command line, determine what kind of node
87 	 * it is, create the appropriate node type and add the new plan node
88 	 * to the end of the existing plan.  The resulting plan is a linked
89 	 * list of plan nodes.  For example, the string:
90 	 *
91 	 *	% find . -name foo -newer bar -print
92 	 *
93 	 * results in the plan:
94 	 *
95 	 *	[-name foo]--> [-newer bar]--> [-print]
96 	 *
97 	 * in this diagram, `[-name foo]' represents the plan node generated
98 	 * by c_name() with an argument of foo and `-->' represents the
99 	 * plan->next pointer.
100 	 */
101 	for (plan = tail = NULL; *argv;) {
102 		if (!(new = find_create(&argv)))
103 			continue;
104 		if (plan == NULL)
105 			tail = plan = new;
106 		else {
107 			tail->next = new;
108 			tail = new;
109 		}
110 	}
111 
112 	/*
113 	 * if the user didn't specify one of -print, -ok or -exec, then -print
114 	 * is assumed so we bracket the current expression with parens, if
115 	 * necessary, and add a -print node on the end.
116 	 */
117 	if (!isoutput) {
118 		OPTION *p;
119 		char **argv1 = 0;
120 
121 		if (plan == NULL) {
122 			p = lookup_option("-print");
123 			new = (p->create)(p, &argv1);
124 			tail = plan = new;
125 		} else {
126 			p = lookup_option("(");
127 			new = (p->create)(p, &argv1);
128 			new->next = plan;
129 			plan = new;
130 			p = lookup_option(")");
131 			new = (p->create)(p, &argv1);
132 			tail->next = new;
133 			tail = new;
134 			p = lookup_option("-print");
135 			new = (p->create)(p, &argv1);
136 			tail->next = new;
137 			tail = new;
138 		}
139 	}
140 
141 	/*
142 	 * the command line has been completely processed into a search plan
143 	 * except for the (, ), !, and -o operators.  Rearrange the plan so
144 	 * that the portions of the plan which are affected by the operators
145 	 * are moved into operator nodes themselves.  For example:
146 	 *
147 	 *	[!]--> [-name foo]--> [-print]
148 	 *
149 	 * becomes
150 	 *
151 	 *	[! [-name foo] ]--> [-print]
152 	 *
153 	 * and
154 	 *
155 	 *	[(]--> [-depth]--> [-name foo]--> [)]--> [-print]
156 	 *
157 	 * becomes
158 	 *
159 	 *	[expr [-depth]-->[-name foo] ]--> [-print]
160 	 *
161 	 * operators are handled in order of precedence.
162 	 */
163 
164 	plan = paren_squish(plan);		/* ()'s */
165 	plan = not_squish(plan);		/* !'s */
166 	plan = or_squish(plan);			/* -o's */
167 	return (plan);
168 }
169 
170 FTS *tree;			/* pointer to top of FTS hierarchy */
171 
172 /*
173  * find_execute --
174  *	take a search plan and an array of search paths and executes the plan
175  *	over all FTSENT's returned for the given search paths.
176  */
177 int
178 find_execute(PLAN *plan, char *paths[])
179 {
180 	FTSENT *entry;
181 	PLAN *p;
182 	int rval;
183 
184 	tree = fts_open(paths, ftsoptions, (issort ? find_compare : NULL));
185 	if (tree == NULL)
186 		err(1, "ftsopen");
187 
188 	for (rval = 0; (entry = fts_read(tree)) != NULL;) {
189 		if (maxdepth != -1 && entry->fts_level >= maxdepth) {
190 			if (fts_set(tree, entry, FTS_SKIP))
191 				err(1, "%s", entry->fts_path);
192 		}
193 
194 		switch (entry->fts_info) {
195 		case FTS_D:
196 			if (isdepth)
197 				continue;
198 			break;
199 		case FTS_DP:
200 			if (!isdepth)
201 				continue;
202 			break;
203 		case FTS_DNR:
204 		case FTS_ERR:
205 		case FTS_NS:
206 			(void)fflush(stdout);
207 			warnx("%s: %s",
208 			    entry->fts_path, strerror(entry->fts_errno));
209 			rval = 1;
210 			continue;
211 #ifdef FTS_W
212 		case FTS_W:
213 			continue;
214 #endif /* FTS_W */
215 		}
216 #define	BADCH	" \t\n\\'\""
217 		if (isxargs && strpbrk(entry->fts_path, BADCH)) {
218 			(void)fflush(stdout);
219 			warnx("%s: illegal path", entry->fts_path);
220 			rval = 1;
221 			continue;
222 		}
223 
224 		if (mindepth != -1 && entry->fts_level < mindepth)
225 			continue;
226 
227 		/*
228 		 * Call all the functions in the execution plan until one is
229 		 * false or all have been executed.  This is where we do all
230 		 * the work specified by the user on the command line.
231 		 */
232 		for (p = plan; p && (p->execute)(p, entry); p = p->next);
233 	}
234 	finish_execplus();
235 	if (errno)
236 		err(1, "fts_read");
237 	return (rval);
238 }
239