2 * Copyright © 2002, Jörg Wunsch
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
27 * 4.3BSD UI-compatible whereis(1) utility. Rewritten from scratch
28 * since the original 4.3BSD version suffers legal problems that
29 * prevent it from being redistributed, and since the 4.4BSD version
30 * was pretty inferior in functionality.
33 #include <sys/types.h>
35 __FBSDID("$FreeBSD$");
38 #include <sys/sysctl.h>
51 #include "pathnames.h"
53 #define NO_BIN_FOUND 1
54 #define NO_MAN_FOUND 2
55 #define NO_SRC_FOUND 4
57 typedef const char *ccharp;
59 static int opt_a, opt_b, opt_m, opt_q, opt_s, opt_u, opt_x;
60 static ccharp *bindirs, *mandirs, *sourcedirs;
63 static const char *sourcepath = PATH_SOURCES;
65 static char *colonify(ccharp *);
66 static int contains(ccharp *, const char *);
67 static void decolonify(char *, ccharp **, int *);
68 static void defaults(void);
69 static void scanopts(int, char **);
70 static void usage(void);
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.
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.
92 "usage: whereis [-abmqsux] [-BMS dir ... -f] program ...\n");
97 * Scan options passed to program.
99 * Note that the -B/-M/-S options expect a list of directory
100 * names that must be terminated with -f.
103 scanopts(int argc, char **argv)
108 while ((c = getopt(argc, argv, "BMSabfmqsux")) != -1)
119 dirlist = &sourcedirs;
122 *dirlist = realloc(*dirlist, (i + 1) * sizeof(char *));
123 (*dirlist)[i] = NULL;
124 while (optind < argc &&
125 strcmp(argv[optind], "-f") != 0 &&
126 strcmp(argv[optind], "-B") != 0 &&
127 strcmp(argv[optind], "-M") != 0 &&
128 strcmp(argv[optind], "-S") != 0) {
129 decolonify(argv[optind], dirlist, &i);
171 query = argv + optind;
175 * Find out whether string `s' is contained in list `cpp'.
178 contains(ccharp *cpp, const char *s)
185 while ((cp = *cpp) != NULL) {
186 if (strcmp(cp, s) == 0)
194 * Split string `s' at colons, and pass it to the string list pointed
195 * to by `cppp' (which has `*ip' elements). Note that the original
196 * string is modified by replacing the colon with a NUL byte. The
197 * partial string is only added if it has a length greater than 0, and
198 * if it's not already contained in the string list.
201 decolonify(char *s, ccharp **cppp, int *ip)
205 while ((cp = strchr(s, ':')), *s != '\0') {
208 if (strlen(s) && !contains(*cppp, s)) {
209 *cppp = realloc(*cppp, (*ip + 2) * sizeof(char *));
213 (*cppp)[*ip + 1] = NULL;
224 * Join string list `cpp' into a colon-separated string.
227 colonify(ccharp *cpp)
236 for (s = 0, i = 0; cpp[i] != NULL; i++)
237 s += strlen(cpp[i]) + 1;
238 if ((cp = malloc(s + 1)) == NULL)
240 for (i = 0, *cp = '\0'; cpp[i] != NULL; i++) {
244 cp[s - 1] = '\0'; /* eliminate last colon */
250 * Provide defaults for all options and directory lists.
256 char *b, buf[BUFSIZ], *cp;
263 /* default to -bms if none has been specified */
264 if (!opt_b && !opt_m && !opt_s)
265 opt_b = opt_m = opt_s = 1;
267 /* -b defaults to default path + /usr/libexec +
270 if (sysctlbyname("user.cs_path", (void *)NULL, &s,
271 (void *)NULL, 0) == -1)
272 err(EX_OSERR, "sysctlbyname(\"user.cs_path\")");
273 if ((b = malloc(s + 1)) == NULL)
275 if (sysctlbyname("user.cs_path", b, &s, (void *)NULL, 0) == -1)
276 err(EX_OSERR, "sysctlbyname(\"user.cs_path\")");
278 decolonify(b, &bindirs, &nele);
279 bindirs = realloc(bindirs, (nele + 2) * sizeof(char *));
282 bindirs[nele++] = PATH_LIBEXEC;
283 bindirs[nele] = NULL;
284 if ((cp = getenv("PATH")) != NULL) {
285 /* don't destroy the original environment... */
286 if ((b = malloc(strlen(cp) + 1)) == NULL)
289 decolonify(b, &bindirs, &nele);
293 /* -m defaults to $(manpath) */
295 if ((p = popen(MANPATHCMD, "r")) == NULL)
296 err(EX_OSERR, "cannot execute manpath command");
297 if (fgets(buf, BUFSIZ - 1, p) == NULL ||
299 err(EX_OSERR, "error processing manpath results");
300 if ((b = strchr(buf, '\n')) != NULL)
302 if ((b = malloc(strlen(buf) + 1)) == NULL)
306 decolonify(b, &mandirs, &nele);
309 /* -s defaults to precompiled list, plus subdirs of /usr/ports */
311 if ((b = malloc(strlen(sourcepath) + 1)) == NULL)
313 strcpy(b, sourcepath);
315 decolonify(b, &sourcedirs, &nele);
317 if (stat(PATH_PORTS, &sb) == -1) {
319 /* no /usr/ports, we are done */
321 err(EX_OSERR, "stat(" PATH_PORTS ")");
323 if ((sb.st_mode & S_IFMT) != S_IFDIR)
324 /* /usr/ports is not a directory, ignore */
326 if (access(PATH_PORTS, R_OK | X_OK) != 0)
328 if ((dir = opendir(PATH_PORTS)) == NULL)
329 err(EX_OSERR, "opendir" PATH_PORTS ")");
330 while ((dirp = readdir(dir)) != NULL) {
332 * Not everything below PATH_PORTS is of
333 * interest. First, all dot files and
334 * directories (e. g. .snap) can be ignored.
335 * Also, all subdirectories starting with a
336 * capital letter are not going to be
337 * examined, as they are used for internal
338 * purposes (Mk, Tools, ...). This also
339 * matches a possible CVS subdirectory.
340 * Finally, the distfiles subdirectory is also
341 * special, and should not be considered to
342 * avoid false matches.
344 if (dirp->d_name[0] == '.' ||
346 * isupper() not used on purpose: the
347 * check is supposed to default to the C
348 * locale instead of the current user's
351 (dirp->d_name[0] >= 'A' && dirp->d_name[0] <= 'Z') ||
352 strcmp(dirp->d_name, "distfiles") == 0)
354 if ((b = malloc(sizeof PATH_PORTS + 1 + dirp->d_namlen))
357 strcpy(b, PATH_PORTS);
359 strcat(b, dirp->d_name);
360 if (stat(b, &sb) == -1 ||
361 (sb.st_mode & S_IFMT) != S_IFDIR ||
362 access(b, R_OK | X_OK) != 0) {
366 sourcedirs = realloc(sourcedirs,
367 (nele + 2) * sizeof(char *));
368 if (sourcedirs == NULL)
370 sourcedirs[nele++] = b;
371 sourcedirs[nele] = NULL;
378 main(int argc, char **argv)
380 int unusual, i, printed;
381 char *bin, buf[BUFSIZ], *cp, *cp2, *man, *name, *src;
383 size_t nlen, olen, s;
386 regmatch_t matches[2];
390 setlocale(LC_ALL, "");
392 scanopts(argc, argv);
399 if (sourcedirs == NULL)
401 if (opt_m + opt_b + opt_s == 0)
402 errx(EX_DATAERR, "no directories to search");
405 setenv("MANPATH", colonify(mandirs), 1);
406 if ((i = regcomp(&re, MANWHEREISMATCH, REG_EXTENDED)) != 0) {
407 regerror(i, &re, buf, BUFSIZ - 1);
408 errx(EX_UNAVAILABLE, "regcomp(%s) failed: %s",
409 MANWHEREISMATCH, buf);
413 for (; (name = *query) != NULL; query++) {
414 /* strip leading path name component */
415 if ((cp = strrchr(name, '/')) != NULL)
417 /* strip SCCS or RCS suffix/prefix */
418 if (strlen(name) > 2 && strncmp(name, "s.", 2) == 0)
420 if ((s = strlen(name)) > 2 && strcmp(name + s - 2, ",v") == 0)
422 /* compression suffix */
425 (strcmp(name + s - 2, ".z") == 0 ||
426 strcmp(name + s - 2, ".Z") == 0))
429 strcmp(name + s - 3, ".gz") == 0)
432 strcmp(name + s - 4, ".bz2") == 0)
436 bin = man = src = NULL;
441 * Binaries have to match exactly, and must be regular
444 unusual = unusual | NO_BIN_FOUND;
445 for (dp = bindirs; *dp != NULL; dp++) {
446 cp = malloc(strlen(*dp) + 1 + s + 1);
452 if (stat(cp, &sb) == 0 &&
453 (sb.st_mode & S_IFMT) == S_IFREG &&
454 (sb.st_mode & (S_IXUSR | S_IXGRP | S_IXOTH))
456 unusual = unusual & ~NO_BIN_FOUND;
480 * Ask the man command to perform the search for us.
482 unusual = unusual | NO_MAN_FOUND;
484 cp = malloc(sizeof MANWHEREISALLCMD - 2 + s);
486 cp = malloc(sizeof MANWHEREISCMD - 2 + s);
492 sprintf(cp, MANWHEREISALLCMD, name);
494 sprintf(cp, MANWHEREISCMD, name);
496 if ((p = popen(cp, "r")) != NULL) {
498 while (fgets(buf, BUFSIZ - 1, p) != NULL) {
499 unusual = unusual & ~NO_MAN_FOUND;
501 if ((cp2 = strchr(buf, '\n')) != NULL)
503 if (regexec(&re, buf, 2,
505 (rlen = matches[1].rm_eo -
506 matches[1].rm_so) > 0) {
508 * man -w found formatted
509 * page, need to pick up
512 cp2 = malloc(rlen + 1);
516 buf + matches[1].rm_so,
521 * man -w found plain source
556 * Sources match if a subdir with the exact
559 unusual = unusual | NO_SRC_FOUND;
560 for (dp = sourcedirs; *dp != NULL; dp++) {
561 cp = malloc(strlen(*dp) + 1 + s + 1);
567 if (stat(cp, &sb) == 0 &&
568 (sb.st_mode & S_IFMT) == S_IFDIR) {
569 unusual = unusual & ~NO_SRC_FOUND;
590 * If still not found, ask locate to search it
591 * for us. This will find sources for things
592 * like lpr that are well hidden in the
593 * /usr/src tree, but takes a lot longer.
594 * Thus, option -x (`expensive') prevents this
597 * Do only match locate output that starts
598 * with one of our source directories, and at
599 * least one further level of subdirectories.
601 if (opt_x || (src && !opt_a))
604 cp = malloc(sizeof LOCATECMD - 2 + s);
607 sprintf(cp, LOCATECMD, name);
608 if ((p = popen(cp, "r")) == NULL)
610 while ((src == NULL || opt_a) &&
611 (fgets(buf, BUFSIZ - 1, p)) != NULL) {
612 if ((cp2 = strchr(buf, '\n')) != NULL)
614 for (dp = sourcedirs;
615 (src == NULL || opt_a) && *dp != NULL;
617 cp2 = malloc(strlen(*dp) + 9);
622 strcat(cp2, "/[^/]+/");
623 if ((i = regcomp(&re2, cp2,
624 REG_EXTENDED|REG_NOSUB))
626 regerror(i, &re, buf,
629 "regcomp(%s) failed: %s",
633 if (regexec(&re2, buf, 0,
634 (regmatch_t *)NULL, 0)
660 if (opt_u && !unusual)