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 #include <sys/sysctl.h>
50 #include "pathnames.h"
52 #define NO_BIN_FOUND 1
53 #define NO_MAN_FOUND 2
54 #define NO_SRC_FOUND 4
56 typedef const char *ccharp;
58 static int opt_a, opt_b, opt_m, opt_q, opt_s, opt_u, opt_x;
59 static ccharp *bindirs, *mandirs, *sourcedirs;
62 static const char *sourcepath = PATH_SOURCES;
64 static char *colonify(ccharp *);
65 static int contains(ccharp *, const char *);
66 static void decolonify(char *, ccharp **, int *);
67 static void defaults(void);
68 static void scanopts(int, char **);
69 static void usage(void);
72 * Throughout this program, a number of strings are dynamically
73 * allocated but never freed. Their memory is written to when
74 * splitting the strings into string lists which will later be
75 * processed. Since it's important that those string lists remain
76 * valid even after the functions allocating the memory returned,
77 * those functions cannot free them. They could be freed only at end
78 * of main(), which is pretty pointless anyway.
80 * The overall amount of memory to be allocated for processing the
81 * strings is not expected to exceed a few kilobytes. For that
82 * reason, allocation can usually always be assumed to succeed (within
83 * a virtual memory environment), thus we simply bail out using
84 * abort(3) in case of an allocation failure.
91 "usage: whereis [-abmqsux] [-BMS dir ... -f] program ...\n");
96 * Scan options passed to program.
98 * Note that the -B/-M/-S options expect a list of directory
99 * names that must be terminated with -f.
102 scanopts(int argc, char **argv)
107 while ((c = getopt(argc, argv, "BMSabfmqsux")) != -1)
118 dirlist = &sourcedirs;
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);
170 query = argv + optind;
174 * Find out whether string `s' is contained in list `cpp'.
177 contains(ccharp *cpp, const char *s)
184 while ((cp = *cpp) != NULL) {
185 if (strcmp(cp, s) == 0)
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.
200 decolonify(char *s, ccharp **cppp, int *ip)
204 while ((cp = strchr(s, ':')), *s != '\0') {
207 if (strlen(s) && !contains(*cppp, s)) {
208 *cppp = realloc(*cppp, (*ip + 2) * sizeof(char *));
212 (*cppp)[*ip + 1] = NULL;
223 * Join string list `cpp' into a colon-separated string.
226 colonify(ccharp *cpp)
235 for (s = 0, i = 0; cpp[i] != NULL; i++)
236 s += strlen(cpp[i]) + 1;
237 if ((cp = malloc(s + 1)) == NULL)
239 for (i = 0, *cp = '\0'; cpp[i] != NULL; i++) {
243 cp[s - 1] = '\0'; /* eliminate last colon */
249 * Provide defaults for all options and directory lists.
255 char *b, buf[BUFSIZ], *cp;
261 const int oid[2] = {CTL_USER, USER_CS_PATH};
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 (sysctl(oid, 2, NULL, &s, NULL, 0) == -1)
271 err(EX_OSERR, "sysctl(\"user.cs_path\")");
272 if ((b = malloc(s + 1)) == NULL)
274 if (sysctl(oid, 2, b, &s, NULL, 0) == -1)
275 err(EX_OSERR, "sysctl(\"user.cs_path\")");
277 decolonify(b, &bindirs, &nele);
278 bindirs = realloc(bindirs, (nele + 2) * sizeof(char *));
281 bindirs[nele++] = PATH_LIBEXEC;
282 bindirs[nele] = NULL;
283 if ((cp = getenv("PATH")) != NULL) {
284 /* don't destroy the original environment... */
288 decolonify(b, &bindirs, &nele);
292 /* -m defaults to $(manpath) */
294 if ((p = popen(MANPATHCMD, "r")) == NULL)
295 err(EX_OSERR, "cannot execute manpath command");
296 if (fgets(buf, BUFSIZ - 1, p) == NULL ||
298 err(EX_OSERR, "error processing manpath results");
299 if ((b = strchr(buf, '\n')) != NULL)
305 decolonify(b, &mandirs, &nele);
308 /* -s defaults to precompiled list, plus subdirs of /usr/ports */
310 b = strdup(sourcepath);
314 decolonify(b, &sourcedirs, &nele);
316 if (stat(PATH_PORTS, &sb) == -1) {
318 /* no /usr/ports, we are done */
320 err(EX_OSERR, "stat(" PATH_PORTS ")");
322 if ((sb.st_mode & S_IFMT) != S_IFDIR)
323 /* /usr/ports is not a directory, ignore */
325 if (access(PATH_PORTS, R_OK | X_OK) != 0)
327 if ((dir = opendir(PATH_PORTS)) == NULL)
328 err(EX_OSERR, "opendir" PATH_PORTS ")");
329 while ((dirp = readdir(dir)) != NULL) {
331 * Not everything below PATH_PORTS is of
332 * interest. First, all dot files and
333 * directories (e. g. .snap) can be ignored.
334 * Also, all subdirectories starting with a
335 * capital letter are not going to be
336 * examined, as they are used for internal
337 * purposes (Mk, Tools, ...). This also
338 * matches a possible CVS subdirectory.
339 * Finally, the distfiles subdirectory is also
340 * special, and should not be considered to
341 * avoid false matches.
343 if (dirp->d_name[0] == '.' ||
345 * isupper() not used on purpose: the
346 * check is supposed to default to the C
347 * locale instead of the current user's
350 (dirp->d_name[0] >= 'A' && dirp->d_name[0] <= 'Z') ||
351 strcmp(dirp->d_name, "distfiles") == 0)
353 if ((b = malloc(sizeof PATH_PORTS + 1 + dirp->d_namlen))
356 strcpy(b, PATH_PORTS);
358 strcat(b, dirp->d_name);
359 if (stat(b, &sb) == -1 ||
360 (sb.st_mode & S_IFMT) != S_IFDIR ||
361 access(b, R_OK | X_OK) != 0) {
365 sourcedirs = realloc(sourcedirs,
366 (nele + 2) * sizeof(char *));
367 if (sourcedirs == NULL)
369 sourcedirs[nele++] = b;
370 sourcedirs[nele] = NULL;
377 main(int argc, char **argv)
379 int unusual, i, printed;
380 char *bin, buf[BUFSIZ], *cp, *cp2, *man, *name, *src;
382 size_t nlen, olen, s;
385 regmatch_t matches[2];
389 setlocale(LC_ALL, "");
391 scanopts(argc, argv);
398 if (sourcedirs == NULL)
400 if (opt_m + opt_b + opt_s == 0)
401 errx(EX_DATAERR, "no directories to search");
404 setenv("MANPATH", colonify(mandirs), 1);
405 if ((i = regcomp(&re, MANWHEREISMATCH, REG_EXTENDED)) != 0) {
406 regerror(i, &re, buf, BUFSIZ - 1);
407 errx(EX_UNAVAILABLE, "regcomp(%s) failed: %s",
408 MANWHEREISMATCH, buf);
412 for (; (name = *query) != NULL; query++) {
413 /* strip leading path name component */
414 if ((cp = strrchr(name, '/')) != NULL)
416 /* strip SCCS or RCS suffix/prefix */
417 if (strlen(name) > 2 && strncmp(name, "s.", 2) == 0)
419 if ((s = strlen(name)) > 2 && strcmp(name + s - 2, ",v") == 0)
421 /* compression suffix */
424 (strcmp(name + s - 2, ".z") == 0 ||
425 strcmp(name + s - 2, ".Z") == 0))
428 strcmp(name + s - 3, ".gz") == 0)
431 strcmp(name + s - 4, ".bz2") == 0)
435 bin = man = src = NULL;
440 * Binaries have to match exactly, and must be regular
443 unusual = unusual | NO_BIN_FOUND;
444 for (dp = bindirs; *dp != NULL; dp++) {
445 cp = malloc(strlen(*dp) + 1 + s + 1);
451 if (stat(cp, &sb) == 0 &&
452 (sb.st_mode & S_IFMT) == S_IFREG &&
453 (sb.st_mode & (S_IXUSR | S_IXGRP | S_IXOTH))
455 unusual = unusual & ~NO_BIN_FOUND;
479 * Ask the man command to perform the search for us.
481 unusual = unusual | NO_MAN_FOUND;
483 cp = malloc(sizeof MANWHEREISALLCMD - 2 + s);
485 cp = malloc(sizeof MANWHEREISCMD - 2 + s);
491 sprintf(cp, MANWHEREISALLCMD, name);
493 sprintf(cp, MANWHEREISCMD, name);
495 if ((p = popen(cp, "r")) != NULL) {
497 while (fgets(buf, BUFSIZ - 1, p) != NULL) {
498 unusual = unusual & ~NO_MAN_FOUND;
500 if ((cp2 = strchr(buf, '\n')) != NULL)
502 if (regexec(&re, buf, 2,
504 (rlen = matches[1].rm_eo -
505 matches[1].rm_so) > 0) {
507 * man -w found formatted
508 * page, need to pick up
511 cp2 = malloc(rlen + 1);
515 buf + matches[1].rm_so,
520 * man -w found plain source
553 * Sources match if a subdir with the exact
556 unusual = unusual | NO_SRC_FOUND;
557 for (dp = sourcedirs; *dp != NULL; dp++) {
558 cp = malloc(strlen(*dp) + 1 + s + 1);
564 if (stat(cp, &sb) == 0 &&
565 (sb.st_mode & S_IFMT) == S_IFDIR) {
566 unusual = unusual & ~NO_SRC_FOUND;
587 * If still not found, ask locate to search it
588 * for us. This will find sources for things
589 * like lpr that are well hidden in the
590 * /usr/src tree, but takes a lot longer.
591 * Thus, option -x (`expensive') prevents this
594 * Do only match locate output that starts
595 * with one of our source directories, and at
596 * least one further level of subdirectories.
598 if (opt_x || (src && !opt_a))
601 cp = malloc(sizeof LOCATECMD - 2 + s);
604 sprintf(cp, LOCATECMD, name);
605 if ((p = popen(cp, "r")) == NULL)
607 while ((src == NULL || opt_a) &&
608 (fgets(buf, BUFSIZ - 1, p)) != NULL) {
609 if ((cp2 = strchr(buf, '\n')) != NULL)
611 for (dp = sourcedirs;
612 (src == NULL || opt_a) && *dp != NULL;
614 cp2 = malloc(strlen(*dp) + 9);
619 strcat(cp2, "/[^/]+/");
620 if ((i = regcomp(&re2, cp2,
621 REG_EXTENDED|REG_NOSUB))
623 regerror(i, &re, buf,
626 "regcomp(%s) failed: %s",
630 if (regexec(&re2, buf, 0,
631 (regmatch_t *)NULL, 0)
657 if (opt_u && !unusual)