2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright © 2002, Jörg Wunsch
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
19 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
23 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
29 * 4.3BSD UI-compatible whereis(1) utility. Rewritten from scratch
30 * since the original 4.3BSD version suffers legal problems that
31 * prevent it from being redistributed, and since the 4.4BSD version
32 * was pretty inferior in functionality.
35 #include <sys/types.h>
37 __FBSDID("$FreeBSD$");
40 #include <sys/sysctl.h>
53 #include "pathnames.h"
55 #define NO_BIN_FOUND 1
56 #define NO_MAN_FOUND 2
57 #define NO_SRC_FOUND 4
59 typedef const char *ccharp;
61 static int opt_a, opt_b, opt_m, opt_q, opt_s, opt_u, opt_x;
62 static ccharp *bindirs, *mandirs, *sourcedirs;
65 static const char *sourcepath = PATH_SOURCES;
67 static char *colonify(ccharp *);
68 static int contains(ccharp *, const char *);
69 static void decolonify(char *, ccharp **, int *);
70 static void defaults(void);
71 static void scanopts(int, char **);
72 static void usage(void);
75 * Throughout this program, a number of strings are dynamically
76 * allocated but never freed. Their memory is written to when
77 * splitting the strings into string lists which will later be
78 * processed. Since it's important that those string lists remain
79 * valid even after the functions allocating the memory returned,
80 * those functions cannot free them. They could be freed only at end
81 * of main(), which is pretty pointless anyway.
83 * The overall amount of memory to be allocated for processing the
84 * strings is not expected to exceed a few kilobytes. For that
85 * reason, allocation can usually always be assumed to succeed (within
86 * a virtual memory environment), thus we simply bail out using
87 * abort(3) in case of an allocation failure.
94 "usage: whereis [-abmqsux] [-BMS dir ... -f] program ...\n");
99 * Scan options passed to program.
101 * Note that the -B/-M/-S options expect a list of directory
102 * names that must be terminated with -f.
105 scanopts(int argc, char **argv)
110 while ((c = getopt(argc, argv, "BMSabfmqsux")) != -1)
121 dirlist = &sourcedirs;
124 *dirlist = realloc(*dirlist, (i + 1) * sizeof(char *));
125 (*dirlist)[i] = NULL;
126 while (optind < argc &&
127 strcmp(argv[optind], "-f") != 0 &&
128 strcmp(argv[optind], "-B") != 0 &&
129 strcmp(argv[optind], "-M") != 0 &&
130 strcmp(argv[optind], "-S") != 0) {
131 decolonify(argv[optind], dirlist, &i);
173 query = argv + optind;
177 * Find out whether string `s' is contained in list `cpp'.
180 contains(ccharp *cpp, const char *s)
187 while ((cp = *cpp) != NULL) {
188 if (strcmp(cp, s) == 0)
196 * Split string `s' at colons, and pass it to the string list pointed
197 * to by `cppp' (which has `*ip' elements). Note that the original
198 * string is modified by replacing the colon with a NUL byte. The
199 * partial string is only added if it has a length greater than 0, and
200 * if it's not already contained in the string list.
203 decolonify(char *s, ccharp **cppp, int *ip)
207 while ((cp = strchr(s, ':')), *s != '\0') {
210 if (strlen(s) && !contains(*cppp, s)) {
211 *cppp = realloc(*cppp, (*ip + 2) * sizeof(char *));
215 (*cppp)[*ip + 1] = NULL;
226 * Join string list `cpp' into a colon-separated string.
229 colonify(ccharp *cpp)
238 for (s = 0, i = 0; cpp[i] != NULL; i++)
239 s += strlen(cpp[i]) + 1;
240 if ((cp = malloc(s + 1)) == NULL)
242 for (i = 0, *cp = '\0'; cpp[i] != NULL; i++) {
246 cp[s - 1] = '\0'; /* eliminate last colon */
252 * Provide defaults for all options and directory lists.
258 char *b, buf[BUFSIZ], *cp;
264 const int oid[2] = {CTL_USER, USER_CS_PATH};
266 /* default to -bms if none has been specified */
267 if (!opt_b && !opt_m && !opt_s)
268 opt_b = opt_m = opt_s = 1;
270 /* -b defaults to default path + /usr/libexec +
273 if (sysctl(oid, 2, NULL, &s, NULL, 0) == -1)
274 err(EX_OSERR, "sysctl(\"user.cs_path\")");
275 if ((b = malloc(s + 1)) == NULL)
277 if (sysctl(oid, 2, b, &s, NULL, 0) == -1)
278 err(EX_OSERR, "sysctl(\"user.cs_path\")");
280 decolonify(b, &bindirs, &nele);
281 bindirs = realloc(bindirs, (nele + 2) * sizeof(char *));
284 bindirs[nele++] = PATH_LIBEXEC;
285 bindirs[nele] = NULL;
286 if ((cp = getenv("PATH")) != NULL) {
287 /* don't destroy the original environment... */
291 decolonify(b, &bindirs, &nele);
295 /* -m defaults to $(manpath) */
297 if ((p = popen(MANPATHCMD, "r")) == NULL)
298 err(EX_OSERR, "cannot execute manpath command");
299 if (fgets(buf, BUFSIZ - 1, p) == NULL ||
301 err(EX_OSERR, "error processing manpath results");
302 if ((b = strchr(buf, '\n')) != NULL)
308 decolonify(b, &mandirs, &nele);
311 /* -s defaults to precompiled list, plus subdirs of /usr/ports */
313 b = strdup(sourcepath);
317 decolonify(b, &sourcedirs, &nele);
319 if (stat(PATH_PORTS, &sb) == -1) {
321 /* no /usr/ports, we are done */
323 err(EX_OSERR, "stat(" PATH_PORTS ")");
325 if ((sb.st_mode & S_IFMT) != S_IFDIR)
326 /* /usr/ports is not a directory, ignore */
328 if (access(PATH_PORTS, R_OK | X_OK) != 0)
330 if ((dir = opendir(PATH_PORTS)) == NULL)
331 err(EX_OSERR, "opendir" PATH_PORTS ")");
332 while ((dirp = readdir(dir)) != NULL) {
334 * Not everything below PATH_PORTS is of
335 * interest. First, all dot files and
336 * directories (e. g. .snap) can be ignored.
337 * Also, all subdirectories starting with a
338 * capital letter are not going to be
339 * examined, as they are used for internal
340 * purposes (Mk, Tools, ...). This also
341 * matches a possible CVS subdirectory.
342 * Finally, the distfiles subdirectory is also
343 * special, and should not be considered to
344 * avoid false matches.
346 if (dirp->d_name[0] == '.' ||
348 * isupper() not used on purpose: the
349 * check is supposed to default to the C
350 * locale instead of the current user's
353 (dirp->d_name[0] >= 'A' && dirp->d_name[0] <= 'Z') ||
354 strcmp(dirp->d_name, "distfiles") == 0)
356 if ((b = malloc(sizeof PATH_PORTS + 1 + dirp->d_namlen))
359 strcpy(b, PATH_PORTS);
361 strcat(b, dirp->d_name);
362 if (stat(b, &sb) == -1 ||
363 (sb.st_mode & S_IFMT) != S_IFDIR ||
364 access(b, R_OK | X_OK) != 0) {
368 sourcedirs = realloc(sourcedirs,
369 (nele + 2) * sizeof(char *));
370 if (sourcedirs == NULL)
372 sourcedirs[nele++] = b;
373 sourcedirs[nele] = NULL;
380 main(int argc, char **argv)
382 int unusual, i, printed;
383 char *bin, buf[BUFSIZ], *cp, *cp2, *man, *name, *src;
385 size_t nlen, olen, s;
388 regmatch_t matches[2];
392 setlocale(LC_ALL, "");
394 scanopts(argc, argv);
401 if (sourcedirs == NULL)
403 if (opt_m + opt_b + opt_s == 0)
404 errx(EX_DATAERR, "no directories to search");
407 setenv("MANPATH", colonify(mandirs), 1);
408 if ((i = regcomp(&re, MANWHEREISMATCH, REG_EXTENDED)) != 0) {
409 regerror(i, &re, buf, BUFSIZ - 1);
410 errx(EX_UNAVAILABLE, "regcomp(%s) failed: %s",
411 MANWHEREISMATCH, buf);
415 for (; (name = *query) != NULL; query++) {
416 /* strip leading path name component */
417 if ((cp = strrchr(name, '/')) != NULL)
419 /* strip SCCS or RCS suffix/prefix */
420 if (strlen(name) > 2 && strncmp(name, "s.", 2) == 0)
422 if ((s = strlen(name)) > 2 && strcmp(name + s - 2, ",v") == 0)
424 /* compression suffix */
427 (strcmp(name + s - 2, ".z") == 0 ||
428 strcmp(name + s - 2, ".Z") == 0))
431 strcmp(name + s - 3, ".gz") == 0)
434 strcmp(name + s - 4, ".bz2") == 0)
438 bin = man = src = NULL;
443 * Binaries have to match exactly, and must be regular
446 unusual = unusual | NO_BIN_FOUND;
447 for (dp = bindirs; *dp != NULL; dp++) {
448 cp = malloc(strlen(*dp) + 1 + s + 1);
454 if (stat(cp, &sb) == 0 &&
455 (sb.st_mode & S_IFMT) == S_IFREG &&
456 (sb.st_mode & (S_IXUSR | S_IXGRP | S_IXOTH))
458 unusual = unusual & ~NO_BIN_FOUND;
482 * Ask the man command to perform the search for us.
484 unusual = unusual | NO_MAN_FOUND;
486 cp = malloc(sizeof MANWHEREISALLCMD - 2 + s);
488 cp = malloc(sizeof MANWHEREISCMD - 2 + s);
494 sprintf(cp, MANWHEREISALLCMD, name);
496 sprintf(cp, MANWHEREISCMD, name);
498 if ((p = popen(cp, "r")) != NULL) {
500 while (fgets(buf, BUFSIZ - 1, p) != NULL) {
501 unusual = unusual & ~NO_MAN_FOUND;
503 if ((cp2 = strchr(buf, '\n')) != NULL)
505 if (regexec(&re, buf, 2,
507 (rlen = matches[1].rm_eo -
508 matches[1].rm_so) > 0) {
510 * man -w found formatted
511 * page, need to pick up
514 cp2 = malloc(rlen + 1);
518 buf + matches[1].rm_so,
523 * 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)