xref: /dragonfly/usr.bin/whereis/whereis.c (revision 5868d2b9) 
1 /*
2  * Copyright � 2002, J�rg Wunsch
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
17  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
22  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23  * POSSIBILITY OF SUCH DAMAGE.
24  * $FreeBSD: src/usr.bin/whereis/whereis.c,v 1.12 2002/08/22 01:50:51 johan Exp $
25  */
26 
27 /*
28  * 4.3BSD UI-compatible whereis(1) utility.  Rewritten from scratch
29  * since the original 4.3BSD version suffers legal problems that
30  * prevent it from being redistributed, and since the 4.4BSD version
31  * was pretty inferior in functionality.
32  */
33 
34 #include <sys/types.h>
35 
36 
37 #include <sys/stat.h>
38 #include <sys/sysctl.h>
39 
40 #include <dirent.h>
41 #include <err.h>
42 #include <errno.h>
43 #include <locale.h>
44 #include <regex.h>
45 #include <stdio.h>
46 #include <stdlib.h>
47 #include <string.h>
48 #include <sysexits.h>
49 #include <unistd.h>
50 
51 #include "pathnames.h"
52 
53 #define	NO_BIN_FOUND	1
54 #define	NO_MAN_FOUND	2
55 #define	NO_SRC_FOUND	4
56 
57 typedef const char *ccharp;
58 
59 int opt_a, opt_b, opt_m, opt_q, opt_s, opt_u, opt_x;
60 ccharp *bindirs, *mandirs, *sourcedirs;
61 char **query;
62 
63 const char *sourcepath = PATH_SOURCES;
64 
65 char	*colonify(ccharp *);
66 int	 contains(ccharp *, const char *);
67 void	 decolonify(char *, ccharp **, int *);
68 void	 defaults(void);
69 void	 scanopts(int, char **);
70 void	 usage(void);
71 
72 /*
73  * Throughout this program, a number of strings are dynamically
74  * allocated but never freed.  Their memory is written to when
75  * splitting the strings into string lists which will later be
76  * processed.  Since it's important that those string lists remain
77  * valid even after the functions allocating the memory returned,
78  * those functions cannot free them.  They could be freed only at end
79  * of main(), which is pretty pointless anyway.
80  *
81  * The overall amount of memory to be allocated for processing the
82  * strings is not expected to exceed a few kilobytes.  For that
83  * reason, allocation can usually always be assumed to succeed (within
84  * a virtual memory environment), thus we simply bail out using
85  * abort(3) in case of an allocation failure.
86  */
87 
88 void
89 usage(void)
90 {
91 	errx(EX_USAGE,
92 	     "usage: whereis [-abmqsux] [-BMS dir... -f] name ...");
93 }
94 
95 /*
96  * Scan options passed to program.
97  *
98  * Note that the -B/-M/-S options expect a list of directory
99  * names that must be terminated with -f.
100  */
101 void
102 scanopts(int argc, char **argv)
103 {
104 	int c, i;
105 	ccharp **dirlist;
106 
107 	while ((c = getopt(argc, argv, "BMSabfmqsux")) != -1)
108 		switch (c) {
109 		case 'B':
110 			dirlist = &bindirs;
111 			goto dolist;
112 
113 		case 'M':
114 			dirlist = &mandirs;
115 			goto dolist;
116 
117 		case 'S':
118 			dirlist = &sourcedirs;
119 		  dolist:
120 			i = 0;
121 			*dirlist = realloc(*dirlist, (i + 1) * sizeof(char *));
122 			(*dirlist)[i] = NULL;
123 			while (optind < argc &&
124 			       strcmp(argv[optind], "-f") != 0 &&
125 			       strcmp(argv[optind], "-B") != 0 &&
126 			       strcmp(argv[optind], "-M") != 0 &&
127 			       strcmp(argv[optind], "-S") != 0) {
128 				decolonify(argv[optind], dirlist, &i);
129 				optind++;
130 			}
131 			break;
132 
133 		case 'a':
134 			opt_a = 1;
135 			break;
136 
137 		case 'b':
138 			opt_b = 1;
139 			break;
140 
141 		case 'f':
142 			goto breakout;
143 
144 		case 'm':
145 			opt_m = 1;
146 			break;
147 
148 		case 'q':
149 			opt_q = 1;
150 			break;
151 
152 		case 's':
153 			opt_s = 1;
154 			break;
155 
156 		case 'u':
157 			opt_u = 1;
158 			break;
159 
160 		case 'x':
161 			opt_x = 1;
162 			break;
163 
164 		default:
165 			usage();
166 		}
167 breakout:
168 	if (optind == argc)
169 		usage();
170 	query = argv + optind;
171 }
172 
173 /*
174  * Find out whether string `s' is contained in list `cpp'.
175  */
176 int
177 contains(ccharp *cpp, const char *s)
178 {
179 	ccharp cp;
180 
181 	if (cpp == NULL)
182 		return (0);
183 
184 	while ((cp = *cpp) != NULL) {
185 		if (strcmp(cp, s) == 0)
186 			return (1);
187 		cpp++;
188 	}
189 	return (0);
190 }
191 
192 /*
193  * Split string `s' at colons, and pass it to the string list pointed
194  * to by `cppp' (which has `*ip' elements).  Note that the original
195  * string is modified by replacing the colon with a NUL byte.  The
196  * partial string is only added if it has a length greater than 0, and
197  * if it's not already contained in the string list.
198  */
199 void
200 decolonify(char *s, ccharp **cppp, int *ip)
201 {
202 	char *cp;
203 
204 	while ((cp = strchr(s, ':')), *s != '\0') {
205 		if (cp)
206 			*cp = '\0';
207 		if (strlen(s) && !contains(*cppp, s)) {
208 			*cppp = realloc(*cppp, (*ip + 2) * sizeof(char *));
209 			if (cppp == NULL)
210 				abort();
211 			(*cppp)[*ip] = s;
212 			(*cppp)[*ip + 1] = NULL;
213 			(*ip)++;
214 		}
215 		if (cp)
216 			s = cp + 1;
217 		else
218 			break;
219 	}
220 }
221 
222 /*
223  * Join string list `cpp' into a colon-separated string.
224  */
225 char *
226 colonify(ccharp *cpp)
227 {
228 	size_t s;
229 	char *cp;
230 	int i;
231 
232 	if (cpp == NULL)
233 		return (0);
234 
235 	for (s = 0, i = 0; cpp[i] != NULL; i++)
236 		s += strlen(cpp[i]) + 1;
237 	if ((cp = malloc(s + 1)) == NULL)
238 		abort();
239 	for (i = 0, *cp = '\0'; cpp[i] != NULL; i++) {
240 		strcat(cp, cpp[i]);
241 		strcat(cp, ":");
242 	}
243 	cp[s - 1] = '\0';		/* eliminate last colon */
244 
245 	return (cp);
246 }
247 
248 /*
249  * Provide defaults for all options and directory lists.
250  */
251 void
252 defaults(void)
253 {
254 	size_t s;
255 	char *b, buf[BUFSIZ], *cp;
256 	int nele;
257 	FILE *p;
258 	DIR *dir;
259 	struct stat sb;
260 	struct dirent *dirp;
261 
262 	/* default to -bms if none has been specified */
263 	if (!opt_b && !opt_m && !opt_s)
264 		opt_b = opt_m = opt_s = 1;
265 
266 	/* -b defaults to default path + /usr/libexec +
267 	 * /usr/games + user's path */
268 	if (!bindirs) {
269 		if (sysctlbyname("user.cs_path", NULL, &s, NULL, 0) == -1)
270 			err(EX_OSERR, "sysctlbyname(\"user.cs_path\")");
271 		if ((b = malloc(s + 1)) == NULL)
272 			abort();
273 		if (sysctlbyname("user.cs_path", b, &s, NULL, 0) == -1)
274 			err(EX_OSERR, "sysctlbyname(\"user.cs_path\")");
275 		nele = 0;
276 		decolonify(b, &bindirs, &nele);
277 		bindirs = realloc(bindirs, (nele + 3) * sizeof(char *));
278 		if (bindirs == NULL)
279 			abort();
280 		bindirs[nele++] = PATH_LIBEXEC;
281 		bindirs[nele++] = PATH_GAMES;
282 		bindirs[nele] = NULL;
283 		if ((cp = getenv("PATH")) != NULL) {
284 			/* don't destroy the original environment... */
285 			if ((b = malloc(strlen(cp) + 1)) == NULL)
286 				abort();
287 			strcpy(b, cp);
288 			decolonify(b, &bindirs, &nele);
289 		}
290 	}
291 
292 	/* -m defaults to $(manpath) */
293 	if (!mandirs) {
294 		if ((p = popen(MANPATHCMD, "r")) == NULL)
295 			err(EX_OSERR, "cannot execute manpath command");
296 		if (fgets(buf, BUFSIZ - 1, p) == NULL ||
297 		    pclose(p))
298 			err(EX_OSERR, "error processing manpath results");
299 		if ((b = strchr(buf, '\n')) != NULL)
300 			*b = '\0';
301 		if ((b = malloc(strlen(buf) + 1)) == NULL)
302 			abort();
303 		strcpy(b, buf);
304 		nele = 0;
305 		decolonify(b, &mandirs, &nele);
306 	}
307 
308 	/* -s defaults to precompiled list, plus subdirs of /usr/pkgsrc */
309 	if (!sourcedirs) {
310 		if ((b = malloc(strlen(sourcepath) + 1)) == NULL)
311 			abort();
312 		strcpy(b, sourcepath);
313 		nele = 0;
314 		decolonify(b, &sourcedirs, &nele);
315 
316 		if (stat(PATH_PKGSRC, &sb) == -1) {
317 			if (errno == ENOENT)
318 				/* no /usr/pkgsrc, we are done */
319 				return;
320 			err(EX_OSERR, "stat(" PATH_PKGSRC ")");
321 		}
322 		if ((sb.st_mode & S_IFMT) != S_IFDIR)
323 			/* /usr/pkgsrc is not a directory, ignore */
324 			return;
325 		if (access(PATH_PKGSRC, R_OK | X_OK) != 0)
326 			return;
327 		if ((dir = opendir(PATH_PKGSRC)) == NULL)
328 			err(EX_OSERR, "opendir" PATH_PKGSRC ")");
329 		while ((dirp = readdir(dir)) != NULL) {
330 			if (dirp->d_name[0] == '.' ||
331 			    strcmp(dirp->d_name, "CVS") == 0)
332 				/* ignore dot entries and CVS subdir */
333 				continue;
334 			if ((b = malloc(sizeof PATH_PKGSRC + 1 + dirp->d_namlen))
335 			    == NULL)
336 				abort();
337 			strcpy(b, PATH_PKGSRC);
338 			strcat(b, "/");
339 			strcat(b, dirp->d_name);
340 			if (stat(b, &sb) == -1 ||
341 			    (sb.st_mode & S_IFMT) != S_IFDIR ||
342 			    access(b, R_OK | X_OK) != 0) {
343 				free(b);
344 				continue;
345 			}
346 			sourcedirs = realloc(sourcedirs,
347 					     (nele + 2) * sizeof(char *));
348 			if (sourcedirs == NULL)
349 				abort();
350 			sourcedirs[nele++] = b;
351 			sourcedirs[nele] = NULL;
352 		}
353 		closedir(dir);
354 	}
355 }
356 
357 int
358 main(int argc, char **argv)
359 {
360 	int unusual, i, printed;
361 	char *bin, buf[BUFSIZ], *cp, *cp2, *man, *name, *src;
362 	ccharp *dp;
363 	size_t nlen, olen, s;
364 	struct stat sb;
365 	regex_t re, re2;
366 	regmatch_t matches[2];
367 	regoff_t rlen;
368 	FILE *p;
369 
370 	setlocale(LC_ALL, "");
371 	scanopts(argc, argv);
372 	defaults();
373 
374 	if (mandirs == NULL)
375 		opt_m = 0;
376 	if (bindirs == NULL)
377 		opt_b = 0;
378 	if (sourcedirs == NULL)
379 		opt_s = 0;
380 	if (opt_m + opt_b + opt_s == 0)
381 		errx(EX_DATAERR, "no directories to search");
382 
383 	if (opt_m) {
384 		if (setenv("MANPATH", colonify(mandirs), 1) == -1)
385 			err(1, "setenv: cannot set MANPATH=%s", colonify(mandirs));
386 		if ((i = regcomp(&re, MANWHEREISMATCH, REG_EXTENDED)) != 0) {
387 			regerror(i, &re, buf, BUFSIZ - 1);
388 			errx(EX_UNAVAILABLE, "regcomp(%s) failed: %s",
389 			     MANWHEREISMATCH, buf);
390 		}
391 	}
392 
393 	for (; (name = *query) != NULL; query++) {
394 		/* strip leading path name component */
395 		if ((cp = strrchr(name, '/')) != NULL)
396 			name = cp + 1;
397 		/* strip SCCS or RCS suffix/prefix */
398 		if (strlen(name) > 2 && strncmp(name, "s.", 2) == 0)
399 			name += 2;
400 		if ((s = strlen(name)) > 2 && strcmp(name + s - 2, ",v") == 0)
401 			name[s - 2] = '\0';
402 		/* compression suffix */
403 		s = strlen(name);
404 		if (s > 2 &&
405 		    (strcmp(name + s - 2, ".z") == 0 ||
406 		     strcmp(name + s - 2, ".Z") == 0))
407 			name[s - 2] = '\0';
408 		else if (s > 3 &&
409 			 strcmp(name + s - 3, ".gz") == 0)
410 			name[s - 3] = '\0';
411 		else if (s > 4 &&
412 			 strcmp(name + s - 4, ".bz2") == 0)
413 			name[s - 4] = '\0';
414 
415 		unusual = 0;
416 		bin = man = src = NULL;
417 		s = strlen(name);
418 
419 		if (opt_b) {
420 			/*
421 			 * Binaries have to match exactly, and must be regular
422 			 * executable files.
423 			 */
424 			unusual = unusual | NO_BIN_FOUND;
425 			for (dp = bindirs; *dp != NULL; dp++) {
426 				cp = malloc(strlen(*dp) + 1 + s + 1);
427 				if (cp == NULL)
428 					abort();
429 				strcpy(cp, *dp);
430 				strcat(cp, "/");
431 				strcat(cp, name);
432 				if (stat(cp, &sb) == 0 &&
433 				    (sb.st_mode & S_IFMT) == S_IFREG &&
434 				    (sb.st_mode & (S_IXUSR | S_IXGRP | S_IXOTH))
435 				    != 0) {
436 					unusual = unusual & ~NO_BIN_FOUND;
437 					if (bin == NULL) {
438 						bin = strdup(cp);
439 					} else {
440 						olen = strlen(bin);
441 						nlen = strlen(cp);
442 						bin = realloc(bin,
443 							      olen + nlen + 2);
444 						if (bin == NULL)
445 							abort();
446 						strcat(bin, " ");
447 						strcat(bin, cp);
448 					}
449 					if (!opt_a) {
450 						free(cp);
451 						break;
452 					}
453 				}
454 				free(cp);
455 			}
456 		}
457 
458 		if (opt_m) {
459 			/*
460 			 * Ask the man command to perform the search for us.
461 			 */
462 			unusual = unusual | NO_MAN_FOUND;
463 			if (opt_a)
464 				cp = malloc(sizeof MANWHEREISALLCMD - 2 + s);
465 			else
466 				cp = malloc(sizeof MANWHEREISCMD - 2 + s);
467 
468 			if (cp == NULL)
469 				abort();
470 
471 			if (opt_a)
472 				sprintf(cp, MANWHEREISALLCMD, name);
473 			else
474 				sprintf(cp, MANWHEREISCMD, name);
475 
476 			if ((p = popen(cp, "r")) != NULL) {
477 
478 				while (fgets(buf, BUFSIZ - 1, p) != NULL) {
479 					unusual = unusual & ~NO_MAN_FOUND;
480 
481 					if ((cp2 = strchr(buf, '\n')) != NULL)
482 						*cp2 = '\0';
483 					if (regexec(&re, buf, 2,
484 						    matches, 0) == 0 &&
485 					    (rlen = matches[1].rm_eo -
486 					     matches[1].rm_so) > 0) {
487 						/*
488 						 * man -w found formated
489 						 * page, need to pick up
490 						 * source page name.
491 						 */
492 						cp2 = malloc(rlen + 1);
493 						if (cp2 == NULL)
494 							abort();
495 						memcpy(cp2,
496 						       buf + matches[1].rm_so,
497 						       rlen);
498 						cp2[rlen] = '\0';
499 					} else {
500 						/*
501 						 * man -w found plain source
502 						 * page, use it.
503 						 */
504 						s = strlen(buf);
505 						cp2 = malloc(s + 1);
506 						if (cp2 == NULL)
507 							abort();
508 						strcpy(cp2, buf);
509 					}
510 
511 					if (man == NULL) {
512 						man = strdup(cp2);
513 					} else {
514 						olen = strlen(man);
515 						nlen = strlen(cp2);
516 						man = realloc(man,
517 							      olen + nlen + 2);
518 						if (man == NULL)
519 							abort();
520 						strcat(man, " ");
521 						strcat(man, cp2);
522 					}
523 
524 					free(cp2);
525 
526 					if (!opt_a)
527 						break;
528 				}
529 				pclose(p);
530 				free(cp);
531 			}
532 		}
533 
534 		if (opt_s) {
535 			/*
536 			 * Sources match if a subdir with the exact
537 			 * name is found.
538 			 */
539 			unusual = unusual | NO_SRC_FOUND;
540 			for (dp = sourcedirs; *dp != NULL; dp++) {
541 				cp = malloc(strlen(*dp) + 1 + s + 1);
542 				if (cp == NULL)
543 					abort();
544 				strcpy(cp, *dp);
545 				strcat(cp, "/");
546 				strcat(cp, name);
547 				if (stat(cp, &sb) == 0 &&
548 				    (sb.st_mode & S_IFMT) == S_IFDIR) {
549 					unusual = unusual & ~NO_SRC_FOUND;
550 					if (src == NULL) {
551 						src = strdup(cp);
552 					} else {
553 						olen = strlen(src);
554 						nlen = strlen(cp);
555 						src = realloc(src,
556 							      olen + nlen + 2);
557 						if (src == NULL)
558 							abort();
559 						strcat(src, " ");
560 						strcat(src, cp);
561 					}
562 					if (!opt_a) {
563 						free(cp);
564 						break;
565 					}
566 				}
567 				free(cp);
568 			}
569 			/*
570 			 * If still not found, ask locate to search it
571 			 * for us.  This will find sources for things
572 			 * like lpr that are well hidden in the
573 			 * /usr/src tree, but takes a lot longer.
574 			 * Thus, option -x (`expensive') prevents this
575 			 * search.
576 			 *
577 			 * Do only match locate output that starts
578 			 * with one of our source directories, and at
579 			 * least one further level of subdirectories.
580 			 */
581 			if (opt_x || (src && !opt_a))
582 				goto done_sources;
583 
584 			cp = malloc(sizeof LOCATECMD - 2 + s);
585 			if (cp == NULL)
586 				abort();
587 			sprintf(cp, LOCATECMD, name);
588 			if ((p = popen(cp, "r")) == NULL)
589 				goto done_sources;
590 			while ((src == NULL || opt_a) &&
591 			       (fgets(buf, BUFSIZ - 1, p)) != NULL) {
592 				if ((cp2 = strchr(buf, '\n')) != NULL)
593 					*cp2 = '\0';
594 				for (dp = sourcedirs;
595 				     (src == NULL || opt_a) && *dp != NULL;
596 				     dp++) {
597 					cp2 = malloc(strlen(*dp) + 9);
598 					if (cp2 == NULL)
599 						abort();
600 					strcpy(cp2, "^");
601 					strcat(cp2, *dp);
602 					strcat(cp2, "/[^/]+/");
603 					if ((i = regcomp(&re2, cp2,
604 							 REG_EXTENDED|REG_NOSUB))
605 					    != 0) {
606 						regerror(i, &re, buf,
607 							 BUFSIZ - 1);
608 						errx(EX_UNAVAILABLE,
609 						     "regcomp(%s) failed: %s",
610 						     cp2, buf);
611 					}
612 					free(cp2);
613 					if (regexec(&re2, buf, 0, NULL, 0)
614 					    == 0) {
615 						unusual = unusual &
616 						          ~NO_SRC_FOUND;
617 						if (src == NULL) {
618 							src = strdup(buf);
619 						} else {
620 							olen = strlen(src);
621 							nlen = strlen(buf);
622 							src = realloc(src,
623 								      olen +
624 								      nlen + 2);
625 							if (src == NULL)
626 								abort();
627 							strcat(src, " ");
628 							strcat(src, buf);
629 						}
630 					}
631 					regfree(&re2);
632 				}
633 			}
634 			pclose(p);
635 			free(cp);
636 		}
637 done_sources:
638 
639 		if (opt_u && !unusual)
640 			continue;
641 
642 		printed = 0;
643 		if (!opt_q) {
644 			printf("%s:", name);
645 			printed++;
646 		}
647 		if (bin) {
648 			if (printed++)
649 				putchar(' ');
650 			fputs(bin, stdout);
651 		}
652 		if (man) {
653 			if (printed++)
654 				putchar(' ');
655 			fputs(man, stdout);
656 		}
657 		if (src) {
658 			if (printed++)
659 				putchar(' ');
660 			fputs(src, stdout);
661 		}
662 		if (printed)
663 			putchar('\n');
664 	}
665 
666 	if (opt_m)
667 		regfree(&re);
668 
669 	return (0);
670 }
671