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 * $DragonFly: src/usr.bin/whereis/whereis.c,v 1.1 2004/03/25 16:39:40 drhodus Exp $ 26 */ 27 28 /* 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. 33 */ 34 35 #include <sys/types.h> 36 37 38 #include <sys/stat.h> 39 #include <sys/sysctl.h> 40 41 #include <dirent.h> 42 #include <err.h> 43 #include <errno.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, opt_f; 105 ccharp **dirlist; 106 107 opt_f = 0; 108 while ((c = getopt(argc, argv, "BMSabfmqsux")) != -1) 109 switch (c) { 110 case 'B': 111 dirlist = &bindirs; 112 goto dolist; 113 114 case 'M': 115 dirlist = &mandirs; 116 goto dolist; 117 118 case 'S': 119 dirlist = &sourcedirs; 120 dolist: 121 i = 0; 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); 130 optind++; 131 } 132 break; 133 134 case 'a': 135 opt_a = 1; 136 break; 137 138 case 'b': 139 opt_b = 1; 140 break; 141 142 case 'f': 143 goto breakout; 144 145 case 'm': 146 opt_m = 1; 147 break; 148 149 case 'q': 150 opt_q = 1; 151 break; 152 153 case 's': 154 opt_s = 1; 155 break; 156 157 case 'u': 158 opt_u = 1; 159 break; 160 161 case 'x': 162 opt_x = 1; 163 break; 164 165 default: 166 usage(); 167 } 168 breakout: 169 if (optind == argc) 170 usage(); 171 query = argv + optind; 172 } 173 174 /* 175 * Find out whether string `s' is contained in list `cpp'. 176 */ 177 int 178 contains(ccharp *cpp, const char *s) 179 { 180 ccharp cp; 181 182 if (cpp == NULL) 183 return (0); 184 185 while ((cp = *cpp) != NULL) { 186 if (strcmp(cp, s) == 0) 187 return (1); 188 cpp++; 189 } 190 return (0); 191 } 192 193 /* 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. 199 */ 200 void 201 decolonify(char *s, ccharp **cppp, int *ip) 202 { 203 char *cp; 204 205 while ((cp = strchr(s, ':')), *s != '\0') { 206 if (cp) 207 *cp = '\0'; 208 if (strlen(s) && !contains(*cppp, s)) { 209 *cppp = realloc(*cppp, (*ip + 2) * sizeof(char *)); 210 if (cppp == NULL) 211 abort(); 212 (*cppp)[*ip] = s; 213 (*cppp)[*ip + 1] = NULL; 214 (*ip)++; 215 } 216 if (cp) 217 s = cp + 1; 218 else 219 break; 220 } 221 } 222 223 /* 224 * Join string list `cpp' into a colon-separated string. 225 */ 226 char * 227 colonify(ccharp *cpp) 228 { 229 size_t s; 230 char *cp; 231 int i; 232 233 if (cpp == NULL) 234 return (0); 235 236 for (s = 0, i = 0; cpp[i] != NULL; i++) 237 s += strlen(cpp[i]) + 1; 238 if ((cp = malloc(s + 1)) == NULL) 239 abort(); 240 for (i = 0, *cp = '\0'; cpp[i] != NULL; i++) { 241 strcat(cp, cpp[i]); 242 strcat(cp, ":"); 243 } 244 cp[s - 1] = '\0'; /* eliminate last colon */ 245 246 return (cp); 247 } 248 249 /* 250 * Provide defaults for all options and directory lists. 251 */ 252 void 253 defaults(void) 254 { 255 size_t s; 256 char *b, buf[BUFSIZ], *cp; 257 int nele; 258 FILE *p; 259 DIR *dir; 260 struct stat sb; 261 struct dirent *dirp; 262 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; 266 267 /* -b defaults to default path + /usr/libexec + 268 * /usr/games + user's path */ 269 if (!bindirs) { 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) 274 abort(); 275 if (sysctlbyname("user.cs_path", b, &s, (void *)NULL, 0) == -1) 276 err(EX_OSERR, "sysctlbyname(\"user.cs_path\")"); 277 nele = 0; 278 decolonify(b, &bindirs, &nele); 279 bindirs = realloc(bindirs, (nele + 3) * sizeof(char *)); 280 if (bindirs == NULL) 281 abort(); 282 bindirs[nele++] = PATH_LIBEXEC; 283 bindirs[nele++] = PATH_GAMES; 284 bindirs[nele] = NULL; 285 if ((cp = getenv("PATH")) != NULL) { 286 /* don't destroy the original environment... */ 287 if ((b = malloc(strlen(cp) + 1)) == NULL) 288 abort(); 289 strcpy(b, cp); 290 decolonify(b, &bindirs, &nele); 291 } 292 } 293 294 /* -m defaults to $(manpath) */ 295 if (!mandirs) { 296 if ((p = popen(MANPATHCMD, "r")) == NULL) 297 err(EX_OSERR, "cannot execute manpath command"); 298 if (fgets(buf, BUFSIZ - 1, p) == NULL || 299 pclose(p)) 300 err(EX_OSERR, "error processing manpath results"); 301 if ((b = strchr(buf, '\n')) != NULL) 302 *b = '\0'; 303 if ((b = malloc(strlen(buf) + 1)) == NULL) 304 abort(); 305 strcpy(b, buf); 306 nele = 0; 307 decolonify(b, &mandirs, &nele); 308 } 309 310 /* -s defaults to precompiled list, plus subdirs of /usr/ports */ 311 if (!sourcedirs) { 312 if ((b = malloc(strlen(sourcepath) + 1)) == NULL) 313 abort(); 314 strcpy(b, sourcepath); 315 nele = 0; 316 decolonify(b, &sourcedirs, &nele); 317 318 if (stat(PATH_PORTS, &sb) == -1) { 319 if (errno == ENOENT) 320 /* no /usr/ports, we are done */ 321 return; 322 err(EX_OSERR, "stat(" PATH_PORTS ")"); 323 } 324 if ((sb.st_mode & S_IFMT) != S_IFDIR) 325 /* /usr/ports is not a directory, ignore */ 326 return; 327 if (access(PATH_PORTS, R_OK | X_OK) != 0) 328 return; 329 if ((dir = opendir(PATH_PORTS)) == NULL) 330 err(EX_OSERR, "opendir" PATH_PORTS ")"); 331 while ((dirp = readdir(dir)) != NULL) { 332 if (dirp->d_name[0] == '.' || 333 strcmp(dirp->d_name, "CVS") == 0) 334 /* ignore dot entries and CVS subdir */ 335 continue; 336 if ((b = malloc(sizeof PATH_PORTS + 1 + dirp->d_namlen)) 337 == NULL) 338 abort(); 339 strcpy(b, PATH_PORTS); 340 strcat(b, "/"); 341 strcat(b, dirp->d_name); 342 if (stat(b, &sb) == -1 || 343 (sb.st_mode & S_IFMT) != S_IFDIR || 344 access(b, R_OK | X_OK) != 0) { 345 free(b); 346 continue; 347 } 348 sourcedirs = realloc(sourcedirs, 349 (nele + 2) * sizeof(char *)); 350 if (sourcedirs == NULL) 351 abort(); 352 sourcedirs[nele++] = b; 353 sourcedirs[nele] = NULL; 354 } 355 closedir(dir); 356 } 357 } 358 359 int 360 main(int argc, char **argv) 361 { 362 int unusual, i, printed; 363 char *bin, buf[BUFSIZ], *cp, *cp2, *man, *name, *src; 364 ccharp *dp; 365 size_t nlen, olen, s; 366 struct stat sb; 367 regex_t re, re2; 368 regmatch_t matches[2]; 369 regoff_t rlen; 370 FILE *p; 371 372 scanopts(argc, argv); 373 defaults(); 374 375 if (mandirs == NULL) 376 opt_m = 0; 377 if (bindirs == NULL) 378 opt_b = 0; 379 if (sourcedirs == NULL) 380 opt_s = 0; 381 if (opt_m + opt_b + opt_s == 0) 382 errx(EX_DATAERR, "no directories to search"); 383 384 if (opt_m) { 385 setenv("MANPATH", colonify(mandirs), 1); 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 == 0) 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 == 0) 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 == 0) 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, 614 (regmatch_t *)NULL, 0) 615 == 0) { 616 unusual = unusual & 617 ~NO_SRC_FOUND; 618 if (src == NULL) { 619 src = strdup(buf); 620 } else { 621 olen = strlen(src); 622 nlen = strlen(buf); 623 src = realloc(src, 624 olen + 625 nlen + 2); 626 if (src == 0) 627 abort(); 628 strcat(src, " "); 629 strcat(src, buf); 630 } 631 } 632 regfree(&re2); 633 } 634 } 635 pclose(p); 636 free(cp); 637 } 638 done_sources: 639 640 if (opt_u && !unusual) 641 continue; 642 643 printed = 0; 644 if (!opt_q) { 645 printf("%s:", name); 646 printed++; 647 } 648 if (bin) { 649 if (printed++) 650 putchar(' '); 651 fputs(bin, stdout); 652 } 653 if (man) { 654 if (printed++) 655 putchar(' '); 656 fputs(man, stdout); 657 } 658 if (src) { 659 if (printed++) 660 putchar(' '); 661 fputs(src, stdout); 662 } 663 if (printed) 664 putchar('\n'); 665 } 666 667 if (opt_m) 668 regfree(&re); 669 670 return (0); 671 } 672