misc-utils/whereis.c

   1 /*-
   2  * Copyright (c) 1980 The Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * 1999-02-22 Arkadiusz Miśkiewicz <misiek@pld.ORG.PL>
  34  * - added Native Language Support
  35  * 2011-08-12 Davidlohr Bueso <dave@gnu.org>
  36  * - added $PATH lookup
  37  *
  38  * Copyright (C) 2013 Karel Zak <kzak@redhat.com>
  39  *               2013 Sami Kerola <kerolasa@iki.fi>
  40  */
  41
  42 #include <sys/param.h>
  43 #include <sys/types.h>
  44 #include <sys/stat.h>
  45 #include <dirent.h>
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <string.h>
  49 #include <ctype.h>
  50 #include <assert.h>
  51
  52 #include "xalloc.h"
  53 #include "nls.h"
  54 #include "c.h"
  55 #include "closestream.h"
  56 #include "canonicalize.h"
  57
  58 #include "debug.h"
  59
  60 static UL_DEBUG_DEFINE_MASK(whereis);
  61 UL_DEBUG_DEFINE_MASKNAMES(whereis) = UL_DEBUG_EMPTY_MASKNAMES;
  62
  63 #define WHEREIS_DEBUG_INIT      (1 << 1)
  64 #define WHEREIS_DEBUG_PATH      (1 << 2)
  65 #define WHEREIS_DEBUG_ENV       (1 << 3)
  66 #define WHEREIS_DEBUG_ARGV      (1 << 4)
  67 #define WHEREIS_DEBUG_SEARCH    (1 << 5)
  68 #define WHEREIS_DEBUG_STATIC    (1 << 6)
  69 #define WHEREIS_DEBUG_LIST      (1 << 7)
  70 #define WHEREIS_DEBUG_ALL       0xFFFF
  71
  72 #define DBG(m, x)       __UL_DBG(whereis, WHEREIS_DEBUG_, m, x)
  73 #define ON_DBG(m, x)    __UL_DBG_CALL(whereis, WHEREIS_DEBUG_, m, x)
  74
  75 #define UL_DEBUG_CURRENT_MASK   UL_DEBUG_MASK(whereis)
  76 #include "debugobj.h"
  77
  78 static char uflag = 0;
  79
  80 /* supported types */
  81 enum {
  82         BIN_DIR = (1 << 1),
  83         MAN_DIR = (1 << 2),
  84         SRC_DIR = (1 << 3),
  85
  86         ALL_DIRS = BIN_DIR | MAN_DIR | SRC_DIR
  87 };
  88
  89 /* directories */
  90 struct wh_dirlist {
  91         int     type;
  92         dev_t   st_dev;
  93         ino_t   st_ino;
  94         char    *path;
  95
  96         struct wh_dirlist *next;
  97 };
  98
  99 static const char *bindirs[] = {
 100         "/usr/bin",
 101         "/usr/sbin",
 102 #if defined(MULTIARCHTRIPLET)
 103         "/lib/" MULTIARCHTRIPLET,
 104         "/usr/lib/" MULTIARCHTRIPLET,
 105         "/usr/local/lib/" MULTIARCHTRIPLET,
 106 #endif
 107         "/usr/lib",
 108         "/usr/lib64",
 109         "/bin",
 110         "/sbin",
 111         "/etc",
 112         "/usr/etc",
 113         "/lib",
 114         "/lib64",
 115         "/usr/games",
 116         "/usr/games/bin",
 117         "/usr/games/lib",
 118         "/usr/emacs/etc",
 119         "/usr/lib/emacs/*/etc",
 120         "/usr/TeX/bin",
 121         "/usr/tex/bin",
 122         "/usr/interviews/bin/LINUX",
 123
 124         "/usr/X11R6/bin",
 125         "/usr/X386/bin",
 126         "/usr/bin/X11",
 127         "/usr/X11/bin",
 128         "/usr/X11R5/bin",
 129
 130         "/usr/local/bin",
 131         "/usr/local/sbin",
 132         "/usr/local/etc",
 133         "/usr/local/lib",
 134         "/usr/local/games",
 135         "/usr/local/games/bin",
 136         "/usr/local/emacs/etc",
 137         "/usr/local/TeX/bin",
 138         "/usr/local/tex/bin",
 139         "/usr/local/bin/X11",
 140
 141         "/usr/contrib",
 142         "/usr/hosts",
 143         "/usr/include",
 144
 145         "/usr/g++-include",
 146
 147         "/usr/ucb",
 148         "/usr/old",
 149         "/usr/new",
 150         "/usr/local",
 151         "/usr/libexec",
 152         "/usr/share",
 153
 154         "/opt/*/bin",
 155         NULL
 156 };
 157
 158 static const char *mandirs[] = {
 159         "/usr/man/*",
 160         "/usr/share/man/*",
 161         "/usr/X386/man/*",
 162         "/usr/X11/man/*",
 163         "/usr/TeX/man/*",
 164         "/usr/interviews/man/mann",
 165         "/usr/share/info",
 166         NULL
 167 };
 168
 169 static const char *srcdirs[] = {
 170         "/usr/src/*",
 171         "/usr/src/lib/libc/*",
 172         "/usr/src/lib/libc/net/*",
 173         "/usr/src/ucb/pascal",
 174         "/usr/src/ucb/pascal/utilities",
 175         "/usr/src/undoc",
 176         NULL
 177 };
 178
 179 static void whereis_init_debug(void)
 180 {
 181         __UL_INIT_DEBUG_FROM_ENV(whereis, WHEREIS_DEBUG_, 0, WHEREIS_DEBUG);
 182 }
 183
 184 static const char *whereis_type_to_name(int type)
 185 {
 186         switch (type) {
 187         case BIN_DIR: return "bin";
 188         case MAN_DIR: return "man";
 189         case SRC_DIR: return "src";
 190         default:      return "???";
 191         }
 192 }
 193
 194 static void __attribute__((__noreturn__)) usage(void)
 195 {
 196         FILE *out = stdout;
 197
 198         fputs(USAGE_HEADER, out);
 199         fprintf(out, _(" %s [options] [-BMS <dir>... -f] <name>\n"), program_invocation_short_name);
 200
 201         fputs(USAGE_SEPARATOR, out);
 202         fputs(_("Locate the binary, source, and manual-page files for a command.\n"), out);
 203
 204         fputs(USAGE_OPTIONS, out);
 205         fputs(_(" -b         search only for binaries\n"), out);
 206         fputs(_(" -B <dirs>  define binaries lookup path\n"), out);
 207         fputs(_(" -m         search only for manuals and infos\n"), out);
 208         fputs(_(" -M <dirs>  define man and info lookup path\n"), out);
 209         fputs(_(" -s         search only for sources\n"), out);
 210         fputs(_(" -S <dirs>  define sources lookup path\n"), out);
 211         fputs(_(" -f         terminate <dirs> argument list\n"), out);
 212         fputs(_(" -u         search for unusual entries\n"), out);
 213         fputs(_(" -l         output effective lookup paths\n"), out);
 214
 215         fputs(USAGE_SEPARATOR, out);
 216         printf(USAGE_HELP_OPTIONS(16));
 217         printf(USAGE_MAN_TAIL("whereis(1)"));
 218         exit(EXIT_SUCCESS);
 219 }
 220
 221 static void dirlist_add_dir(struct wh_dirlist **ls0, int type, const char *dir)
 222 {
 223         struct stat st;
 224         struct wh_dirlist *prev = NULL, *ls = *ls0;
 225
 226         if (access(dir, R_OK) != 0)
 227                 return;
 228         if (stat(dir, &st) != 0 || !S_ISDIR(st.st_mode))
 229                 return;
 230
 231         while (ls) {
 232                 if (ls->st_ino == st.st_ino &&
 233                     ls->st_dev == st.st_dev &&
 234                     ls->type == type) {
 235                         DBG(LIST, ul_debugobj(*ls0, "  ignore (already in list): %s", dir));
 236                         return;
 237                 }
 238                 prev = ls;
 239                 ls = ls->next;
 240         }
 241
 242
 243         ls = xcalloc(1, sizeof(*ls));
 244         ls->st_ino = st.st_ino;
 245         ls->st_dev = st.st_dev;
 246         ls->type = type;
 247         ls->path = canonicalize_path(dir);
 248
 249         if (!*ls0)
 250                 *ls0 = ls;              /* first in the list */
 251         else {
 252                 assert(prev);
 253                 prev->next = ls;        /* add to the end of the list */
 254         }
 255
 256         DBG(LIST, ul_debugobj(*ls0, "  add dir: %s", ls->path));
 257         return;
 258 }
 259
 260 /* special case for '*' in the paths */
 261 static void dirlist_add_subdir(struct wh_dirlist **ls, int type, const char *dir)
 262 {
 263         char buf[PATH_MAX], *d;
 264         DIR *dirp;
 265         struct dirent *dp;
 266
 267         strncpy(buf, dir, PATH_MAX);
 268         buf[PATH_MAX - 1] = '\0';
 269
 270         d = strchr(buf, '*');
 271         if (!d)
 272                 return;
 273         *d = 0;
 274
 275         dirp = opendir(buf);
 276         if (!dirp)
 277                 return;
 278
 279         DBG(LIST, ul_debugobj(*ls, " scanning subdir: %s", dir));
 280
 281         while ((dp = readdir(dirp)) != NULL) {
 282                 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
 283                         continue;
 284                 snprintf(d, PATH_MAX - (d - buf), "%s", dp->d_name);
 285                 /* a dir definition can have a star in middle of path */
 286                 strcat(buf, strchr(dir, '*') + 1);
 287                 dirlist_add_dir(ls, type, buf);
 288         }
 289         closedir(dirp);
 290         return;
 291 }
 292
 293 static void construct_dirlist_from_env(const char *env,
 294                                        struct wh_dirlist **ls,
 295                                        int type)
 296 {
 297         char *key = NULL, *tok = NULL, *pathcp, *path = getenv(env);
 298
 299         if (!path)
 300                 return;
 301         pathcp = xstrdup(path);
 302
 303         DBG(ENV, ul_debugobj(*ls, "construct %s dirlist from: %s",
 304                                 whereis_type_to_name(type), path));
 305
 306         for (tok = strtok_r(pathcp, ":", &key); tok;
 307              tok = strtok_r(NULL, ":", &key))
 308                 dirlist_add_dir(ls, type, tok);
 309
 310         free(pathcp);
 311         return;
 312 }
 313
 314 static void construct_dirlist_from_argv(struct wh_dirlist **ls,
 315                                         int *idx,
 316                                         int argc,
 317                                         char *argv[],
 318                                         int type)
 319 {
 320         int i;
 321
 322         DBG(ARGV, ul_debugobj(*ls, "construct %s dirlist from argv[%d..]",
 323                                 whereis_type_to_name(type), *idx));
 324
 325         for (i = *idx; i < argc; i++) {
 326                 if (*argv[i] == '-')                    /* end of the list */
 327                         break;
 328
 329                 DBG(ARGV, ul_debugobj(*ls, "  using argv[%d]: %s", *idx, argv[*idx]));
 330                 dirlist_add_dir(ls, type, argv[i]);
 331                 *idx = i;
 332         }
 333
 334         return;
 335 }
 336
 337 static void construct_dirlist(struct wh_dirlist **ls,
 338                               int type,
 339                               const char **paths)
 340 {
 341         size_t i;
 342
 343         DBG(STATIC, ul_debugobj(*ls, "construct %s dirlist from static array",
 344                                 whereis_type_to_name(type)));
 345
 346         for (i = 0; paths[i]; i++) {
 347                 if (!strchr(paths[i], '*'))
 348                         dirlist_add_dir(ls, type, paths[i]);
 349                 else
 350                         dirlist_add_subdir(ls, type, paths[i]);
 351         }
 352         return;
 353 }
 354
 355 static void free_dirlist(struct wh_dirlist **ls0, int type)
 356 {
 357         struct wh_dirlist *prev = NULL, *next, *ls = *ls0;
 358
 359         *ls0 = NULL;
 360
 361         DBG(LIST, ul_debugobj(*ls0, "free dirlist"));
 362
 363         while (ls) {
 364                 if (ls->type & type) {
 365                         next = ls->next;
 366                         DBG(LIST, ul_debugobj(*ls0, " free: %s", ls->path));
 367                         free(ls->path);
 368                         free(ls);
 369                         ls = next;
 370                         if (prev)
 371                                 prev->next = ls;
 372                 } else {
 373                         if (!prev)
 374                                 *ls0 = ls;      /* first unremoved */
 375                         prev = ls;
 376                         ls = ls->next;
 377                 }
 378         }
 379
 380         return;
 381 }
 382
 383
 384 static int filename_equal(const char *cp, const char *dp)
 385 {
 386         int i = strlen(dp);
 387
 388         DBG(SEARCH, ul_debug("compare '%s' and '%s'", cp, dp));
 389
 390         if (dp[0] == 's' && dp[1] == '.' && filename_equal(cp, dp + 2))
 391                 return 1;
 392         if (!strcmp(dp + i - 2, ".Z"))
 393                 i -= 2;
 394         else if (!strcmp(dp + i - 3, ".gz"))
 395                 i -= 3;
 396         else if (!strcmp(dp + i - 3, ".xz"))
 397                 i -= 3;
 398         else if (!strcmp(dp + i - 4, ".bz2"))
 399                 i -= 4;
 400         while (*cp && *dp && *cp == *dp)
 401                 cp++, dp++, i--;
 402         if (*cp == 0 && *dp == 0)
 403                 return 1;
 404         while (isdigit(*dp))
 405                 dp++;
 406         if (*cp == 0 && *dp++ == '.') {
 407                 --i;
 408                 while (i > 0 && *dp)
 409                         if (--i, *dp++ == '.')
 410                                 return (*dp++ == 'C' && *dp++ == 0);
 411                 return 1;
 412         }
 413         return 0;
 414 }
 415
 416 static void findin(const char *dir, const char *pattern, int *count, char **wait)
 417 {
 418         DIR *dirp;
 419         struct dirent *dp;
 420
 421         dirp = opendir(dir);
 422         if (dirp == NULL)
 423                 return;
 424
 425         DBG(SEARCH, ul_debug("find '%s' in '%s'", pattern, dir));
 426
 427         while ((dp = readdir(dirp)) != NULL) {
 428                 if (!filename_equal(pattern, dp->d_name))
 429                         continue;
 430
 431                 if (uflag && *count == 0)
 432                         xasprintf(wait, "%s/%s", dir, dp->d_name);
 433
 434                 else if (uflag && *count == 1 && *wait) {
 435                         printf("%s: %s %s/%s", pattern, *wait, dir,  dp->d_name);
 436                         free(*wait);
 437                         *wait = NULL;
 438                 } else
 439                         printf(" %s/%s", dir, dp->d_name);
 440                 ++(*count);
 441         }
 442         closedir(dirp);
 443         return;
 444 }
 445
 446 static void lookup(const char *pattern, struct wh_dirlist *ls, int want)
 447 {
 448         char patbuf[PATH_MAX];
 449         int count = 0;
 450         char *wait = NULL, *p;
 451
 452         /* canonicalize pattern -- remove path suffix etc. */
 453         p = strrchr(pattern, '/');
 454         p = p ? p + 1 : (char *) pattern;
 455         strncpy(patbuf, p, PATH_MAX);
 456         patbuf[PATH_MAX - 1] = '\0';
 457
 458         DBG(SEARCH, ul_debug("lookup dirs for '%s' (%s), want: %s %s %s",
 459                                 patbuf, pattern,
 460                                 want & BIN_DIR ? "bin" : "",
 461                                 want & MAN_DIR ? "man" : "",
 462                                 want & SRC_DIR ? "src" : ""));
 463         p = strrchr(patbuf, '.');
 464         if (p)
 465                 *p = '\0';
 466
 467         if (!uflag)
 468                 /* if -u not specified then we always print the pattern */
 469                 printf("%s:", patbuf);
 470
 471         for (; ls; ls = ls->next) {
 472                 if ((ls->type & want) && ls->path)
 473                         findin(ls->path, patbuf, &count, &wait);
 474         }
 475
 476         free(wait);
 477
 478         if (!uflag || count > 1)
 479                 putchar('\n');
 480         return;
 481 }
 482
 483 static void list_dirlist(struct wh_dirlist *ls)
 484 {
 485         while (ls) {
 486                 if (ls->path) {
 487                         switch (ls->type) {
 488                         case BIN_DIR:
 489                                 printf("bin: ");
 490                                 break;
 491                         case MAN_DIR:
 492                                 printf("man: ");
 493                                 break;
 494                         case SRC_DIR:
 495                                 printf("src: ");
 496                                 break;
 497                         default:
 498                                 abort();
 499                         }
 500                         printf("%s\n", ls->path);
 501                 }
 502                 ls = ls->next;
 503         }
 504 }
 505
 506 int main(int argc, char **argv)
 507 {
 508         struct wh_dirlist *ls = NULL;
 509         int want = ALL_DIRS;
 510         int i, want_resetable = 0, opt_f_missing = 0;
 511
 512         setlocale(LC_ALL, "");
 513         bindtextdomain(PACKAGE, LOCALEDIR);
 514         textdomain(PACKAGE);
 515         atexit(close_stdout);
 516
 517         if (argc <= 1) {
 518                 warnx(_("not enough arguments"));
 519                 errtryhelp(EXIT_FAILURE);
 520         } else {
 521                 /* first arg may be one of our standard longopts */
 522                 if (!strcmp(argv[1], "--help"))
 523                         usage();
 524                 if (!strcmp(argv[1], "--version")) {
 525                         printf(UTIL_LINUX_VERSION);
 526                         exit(EXIT_SUCCESS);
 527                 }
 528         }
 529
 530         whereis_init_debug();
 531
 532         construct_dirlist(&ls, BIN_DIR, bindirs);
 533         construct_dirlist_from_env("PATH", &ls, BIN_DIR);
 534
 535         construct_dirlist(&ls, MAN_DIR, mandirs);
 536         construct_dirlist_from_env("MANPATH", &ls, MAN_DIR);
 537
 538         construct_dirlist(&ls, SRC_DIR, srcdirs);
 539
 540         for (i = 1; i < argc; i++) {
 541                 const char *arg = argv[i];
 542                 int arg_i = i;
 543
 544                 DBG(ARGV, ul_debug("argv[%d]: %s", i, arg));
 545
 546                 if (*arg != '-') {
 547                         lookup(arg, ls, want);
 548                         /*
 549                          * The lookup mask ("want") is cumulative and it's
 550                          * resetable only when it has been already used.
 551                          *
 552                          *  whereis -b -m foo     :'foo' mask=BIN|MAN
 553                          *  whereis -b foo bar    :'foo' and 'bar' mask=BIN|MAN
 554                          *  whereis -b foo -m bar :'foo' mask=BIN; 'bar' mask=MAN
 555                          */
 556                         want_resetable = 1;
 557                         continue;
 558                 }
 559
 560                 for (++arg; arg && *arg; arg++) {
 561                         DBG(ARGV, ul_debug("  arg: %s", arg));
 562
 563                         switch (*arg) {
 564                         case 'f':
 565                                 opt_f_missing = 0;
 566                                 break;
 567                         case 'u':
 568                                 uflag = 1;
 569                                 opt_f_missing = 0;
 570                                 break;
 571                         case 'B':
 572                                 if (*(arg + 1)) {
 573                                         warnx(_("bad usage"));
 574                                         errtryhelp(EXIT_FAILURE);
 575                                 }
 576                                 i++;
 577                                 free_dirlist(&ls, BIN_DIR);
 578                                 construct_dirlist_from_argv(
 579                                         &ls, &i, argc, argv, BIN_DIR);
 580                                 opt_f_missing = 1;
 581                                 break;
 582                         case 'M':
 583                                 if (*(arg + 1)) {
 584                                         warnx(_("bad usage"));
 585                                         errtryhelp(EXIT_FAILURE);
 586                                 }
 587                                 i++;
 588                                 free_dirlist(&ls, MAN_DIR);
 589                                 construct_dirlist_from_argv(
 590                                         &ls, &i, argc, argv, MAN_DIR);
 591                                 opt_f_missing = 1;
 592                                 break;
 593                         case 'S':
 594                                 if (*(arg + 1)) {
 595                                         warnx(_("bad usage"));
 596                                         errtryhelp(EXIT_FAILURE);
 597                                 }
 598                                 i++;
 599                                 free_dirlist(&ls, SRC_DIR);
 600                                 construct_dirlist_from_argv(
 601                                         &ls, &i, argc, argv, SRC_DIR);
 602                                 opt_f_missing = 1;
 603                                 break;
 604                         case 'b':
 605                                 if (want_resetable) {
 606                                         want = ALL_DIRS;
 607                                         want_resetable = 0;
 608                                 }
 609                                 want = want == ALL_DIRS ? BIN_DIR : want | BIN_DIR;
 610                                 opt_f_missing = 0;
 611                                 break;
 612                         case 'm':
 613                                 if (want_resetable) {
 614                                         want = ALL_DIRS;
 615                                         want_resetable = 0;
 616                                 }
 617                                 want = want == ALL_DIRS ? MAN_DIR : want | MAN_DIR;
 618                                 opt_f_missing = 0;
 619                                 break;
 620                         case 's':
 621                                 if (want_resetable) {
 622                                         want = ALL_DIRS;
 623                                         want_resetable = 0;
 624                                 }
 625                                 want = want == ALL_DIRS ? SRC_DIR : want | SRC_DIR;
 626                                 opt_f_missing = 0;
 627                                 break;
 628                         case 'l':
 629                                 list_dirlist(ls);
 630                                 break;
 631                         case 'V':
 632                                 printf(UTIL_LINUX_VERSION);
 633                                 return EXIT_SUCCESS;
 634                         case 'h':
 635                                 usage();
 636                         default:
 637                                 warnx(_("bad usage"));
 638                                 errtryhelp(EXIT_FAILURE);
 639                         }
 640
 641                         if (arg_i < i)          /* moved to the next argv[] item */
 642                                 break;
 643                 }
 644         }
 645
 646         free_dirlist(&ls, ALL_DIRS);
 647         if (opt_f_missing)
 648                 errx(EXIT_FAILURE, _("option -f is missing"));
 649         return EXIT_SUCCESS;
 650 }