Annotation of mandoc/mandocdb.c, Revision 1.235
1.235 ! schwarze 1: /* $Id: mandocdb.c,v 1.234 2016/10/22 10:09:27 schwarze Exp $ */
1.1 kristaps 2: /*
1.48 schwarze 3: * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.235 ! schwarze 4: * Copyright (c) 2011-2017 Ingo Schwarze <schwarze@openbsd.org>
1.231 schwarze 5: * Copyright (c) 2016 Ed Maste <emaste@freebsd.org>
1.1 kristaps 6: *
7: * Permission to use, copy, modify, and distribute this software for any
8: * purpose with or without fee is hereby granted, provided that the above
9: * copyright notice and this permission notice appear in all copies.
10: *
1.187 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1 kristaps 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.187 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1 kristaps 14: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18: */
19: #include "config.h"
20:
1.162 schwarze 21: #include <sys/types.h>
1.50 kristaps 22: #include <sys/stat.h>
1.115 schwarze 23: #include <sys/wait.h>
1.1 kristaps 24:
25: #include <assert.h>
1.43 kristaps 26: #include <ctype.h>
1.208 schwarze 27: #if HAVE_ERR
1.198 schwarze 28: #include <err.h>
1.208 schwarze 29: #endif
1.63 schwarze 30: #include <errno.h>
1.1 kristaps 31: #include <fcntl.h>
1.158 schwarze 32: #if HAVE_FTS
1.50 kristaps 33: #include <fts.h>
1.157 schwarze 34: #else
35: #include "compat_fts.h"
36: #endif
1.58 schwarze 37: #include <limits.h>
1.218 kristaps 38: #if HAVE_SANDBOX_INIT
39: #include <sandbox.h>
40: #endif
1.221 schwarze 41: #include <stdarg.h>
1.50 kristaps 42: #include <stddef.h>
1.59 schwarze 43: #include <stdio.h>
1.1 kristaps 44: #include <stdint.h>
45: #include <stdlib.h>
46: #include <string.h>
1.17 schwarze 47: #include <unistd.h>
1.1 kristaps 48:
1.188 schwarze 49: #include "mandoc_aux.h"
1.202 schwarze 50: #include "mandoc_ohash.h"
1.188 schwarze 51: #include "mandoc.h"
52: #include "roff.h"
1.50 kristaps 53: #include "mdoc.h"
1.1 kristaps 54: #include "man.h"
1.187 schwarze 55: #include "manconf.h"
1.55 kristaps 56: #include "mansearch.h"
1.221 schwarze 57: #include "dba_array.h"
58: #include "dba.h"
1.1 kristaps 59:
1.111 schwarze 60: extern const char *const mansearch_keynames[];
61:
1.50 kristaps 62: enum op {
63: OP_DEFAULT = 0, /* new dbs from dir list or default config */
64: OP_CONFFILE, /* new databases from custom config file */
65: OP_UPDATE, /* delete/add entries in existing database */
66: OP_DELETE, /* delete entries from existing database */
67: OP_TEST /* change no databases, report potential problems */
1.38 schwarze 68: };
69:
1.50 kristaps 70: struct str {
1.78 schwarze 71: const struct mpage *mpage; /* if set, the owning parse */
1.50 kristaps 72: uint64_t mask; /* bitmask in sequence */
1.176 schwarze 73: char key[]; /* rendered text */
1.38 schwarze 74: };
75:
1.79 schwarze 76: struct inodev {
77: ino_t st_ino;
78: dev_t st_dev;
1.50 kristaps 79: };
1.5 kristaps 80:
1.78 schwarze 81: struct mpage {
1.79 schwarze 82: struct inodev inodev; /* used for hashing routine */
1.221 schwarze 83: struct dba_array *dba;
1.82 schwarze 84: char *sec; /* section from file content */
85: char *arch; /* architecture from file content */
86: char *title; /* title from file content */
87: char *desc; /* description from file content */
1.231 schwarze 88: struct mpage *next; /* singly linked list */
1.82 schwarze 89: struct mlink *mlinks; /* singly linked list */
1.174 schwarze 90: int name_head_done;
1.221 schwarze 91: enum form form; /* format from file content */
1.82 schwarze 92: };
93:
94: struct mlink {
1.58 schwarze 95: char file[PATH_MAX]; /* filename rel. to manpath */
1.82 schwarze 96: char *dsec; /* section from directory */
97: char *arch; /* architecture from directory */
98: char *name; /* name from file name (not empty) */
99: char *fsec; /* section from file name suffix */
1.85 schwarze 100: struct mlink *next; /* singly linked list */
1.118 schwarze 101: struct mpage *mpage; /* parent */
1.124 schwarze 102: int gzip; /* filename has a .gz suffix */
1.221 schwarze 103: enum form dform; /* format from directory */
104: enum form fform; /* format from file name suffix */
1.1 kristaps 105: };
106:
1.190 schwarze 107: typedef int (*mdoc_fp)(struct mpage *, const struct roff_meta *,
1.189 schwarze 108: const struct roff_node *);
1.1 kristaps 109:
1.50 kristaps 110: struct mdoc_handler {
111: mdoc_fp fp; /* optional handler */
112: uint64_t mask; /* set unless handler returns 0 */
1.235 ! schwarze 113: int taboo; /* node flags that must not be set */
1.1 kristaps 114: };
1.219 schwarze 115:
116:
117: int mandocdb(int, char *[]);
1.1 kristaps 118:
1.221 schwarze 119: static void dbadd(struct dba *, struct mpage *);
1.118 schwarze 120: static void dbadd_mlink(const struct mlink *mlink);
1.221 schwarze 121: static void dbprune(struct dba *);
122: static void dbwrite(struct dba *);
1.59 schwarze 123: static void filescan(const char *);
1.232 schwarze 124: #if HAVE_FTS_COMPARE_CONST
125: static int fts_compare(const FTSENT *const *, const FTSENT *const *);
126: #else
1.231 schwarze 127: static int fts_compare(const FTSENT **, const FTSENT **);
1.232 schwarze 128: #endif
1.84 schwarze 129: static void mlink_add(struct mlink *, const struct stat *);
1.131 schwarze 130: static void mlink_check(struct mpage *, struct mlink *);
1.82 schwarze 131: static void mlink_free(struct mlink *);
1.89 schwarze 132: static void mlinks_undupe(struct mpage *);
1.78 schwarze 133: static void mpages_free(void);
1.221 schwarze 134: static void mpages_merge(struct dba *, struct mparse *);
1.124 schwarze 135: static void parse_cat(struct mpage *, int);
1.190 schwarze 136: static void parse_man(struct mpage *, const struct roff_meta *,
1.189 schwarze 137: const struct roff_node *);
1.190 schwarze 138: static void parse_mdoc(struct mpage *, const struct roff_meta *,
1.189 schwarze 139: const struct roff_node *);
1.190 schwarze 140: static int parse_mdoc_head(struct mpage *, const struct roff_meta *,
1.189 schwarze 141: const struct roff_node *);
1.190 schwarze 142: static int parse_mdoc_Fd(struct mpage *, const struct roff_meta *,
1.189 schwarze 143: const struct roff_node *);
144: static void parse_mdoc_fname(struct mpage *, const struct roff_node *);
1.190 schwarze 145: static int parse_mdoc_Fn(struct mpage *, const struct roff_meta *,
1.189 schwarze 146: const struct roff_node *);
1.190 schwarze 147: static int parse_mdoc_Fo(struct mpage *, const struct roff_meta *,
1.189 schwarze 148: const struct roff_node *);
1.190 schwarze 149: static int parse_mdoc_Nd(struct mpage *, const struct roff_meta *,
1.189 schwarze 150: const struct roff_node *);
1.190 schwarze 151: static int parse_mdoc_Nm(struct mpage *, const struct roff_meta *,
1.189 schwarze 152: const struct roff_node *);
1.190 schwarze 153: static int parse_mdoc_Sh(struct mpage *, const struct roff_meta *,
1.189 schwarze 154: const struct roff_node *);
1.211 schwarze 155: static int parse_mdoc_Va(struct mpage *, const struct roff_meta *,
156: const struct roff_node *);
1.190 schwarze 157: static int parse_mdoc_Xr(struct mpage *, const struct roff_meta *,
1.189 schwarze 158: const struct roff_node *);
1.112 schwarze 159: static void putkey(const struct mpage *, char *, uint64_t);
1.176 schwarze 160: static void putkeys(const struct mpage *, char *, size_t, uint64_t);
1.78 schwarze 161: static void putmdockey(const struct mpage *,
1.235 ! schwarze 162: const struct roff_node *, uint64_t, int);
1.176 schwarze 163: static int render_string(char **, size_t *);
1.220 schwarze 164: static void say(const char *, const char *, ...)
165: __attribute__((__format__ (printf, 2, 3)));
1.165 schwarze 166: static int set_basedir(const char *, int);
1.59 schwarze 167: static int treescan(void);
1.50 kristaps 168: static size_t utf8(unsigned int, char [7]);
169:
1.102 schwarze 170: static int nodb; /* no database changes */
1.116 schwarze 171: static int mparse_options; /* abort the parse early */
1.141 schwarze 172: static int use_all; /* use all found files */
173: static int debug; /* print what we're doing */
174: static int warnings; /* warn about crap */
1.95 schwarze 175: static int write_utf8; /* write UTF-8 output; else ASCII */
1.59 schwarze 176: static int exitcode; /* to be returned by main */
1.141 schwarze 177: static enum op op; /* operational mode */
1.59 schwarze 178: static char basedir[PATH_MAX]; /* current base directory */
1.231 schwarze 179: static struct mpage *mpage_head; /* list of distinct manual pages */
1.78 schwarze 180: static struct ohash mpages; /* table of distinct manual pages */
1.83 schwarze 181: static struct ohash mlinks; /* table of directory entries */
1.133 schwarze 182: static struct ohash names; /* table of all names */
1.50 kristaps 183: static struct ohash strings; /* table of all strings */
1.133 schwarze 184: static uint64_t name_mask;
1.25 schwarze 185:
186: static const struct mdoc_handler mdocs[MDOC_MAX] = {
1.235 ! schwarze 187: { NULL, 0, 0 }, /* Ap */
! 188: { NULL, 0, NODE_NOPRT }, /* Dd */
! 189: { NULL, 0, NODE_NOPRT }, /* Dt */
! 190: { NULL, 0, NODE_NOPRT }, /* Os */
! 191: { parse_mdoc_Sh, TYPE_Sh, 0 }, /* Sh */
! 192: { parse_mdoc_head, TYPE_Ss, 0 }, /* Ss */
! 193: { NULL, 0, 0 }, /* Pp */
! 194: { NULL, 0, 0 }, /* D1 */
! 195: { NULL, 0, 0 }, /* Dl */
! 196: { NULL, 0, 0 }, /* Bd */
! 197: { NULL, 0, 0 }, /* Ed */
! 198: { NULL, 0, 0 }, /* Bl */
! 199: { NULL, 0, 0 }, /* El */
! 200: { NULL, 0, 0 }, /* It */
! 201: { NULL, 0, 0 }, /* Ad */
! 202: { NULL, TYPE_An, 0 }, /* An */
! 203: { NULL, TYPE_Ar, 0 }, /* Ar */
! 204: { NULL, TYPE_Cd, 0 }, /* Cd */
! 205: { NULL, TYPE_Cm, 0 }, /* Cm */
! 206: { NULL, TYPE_Dv, 0 }, /* Dv */
! 207: { NULL, TYPE_Er, 0 }, /* Er */
! 208: { NULL, TYPE_Ev, 0 }, /* Ev */
! 209: { NULL, 0, 0 }, /* Ex */
! 210: { NULL, TYPE_Fa, 0 }, /* Fa */
! 211: { parse_mdoc_Fd, 0, 0 }, /* Fd */
! 212: { NULL, TYPE_Fl, 0 }, /* Fl */
! 213: { parse_mdoc_Fn, 0, 0 }, /* Fn */
! 214: { NULL, TYPE_Ft, 0 }, /* Ft */
! 215: { NULL, TYPE_Ic, 0 }, /* Ic */
! 216: { NULL, TYPE_In, 0 }, /* In */
! 217: { NULL, TYPE_Li, 0 }, /* Li */
! 218: { parse_mdoc_Nd, 0, 0 }, /* Nd */
! 219: { parse_mdoc_Nm, 0, 0 }, /* Nm */
! 220: { NULL, 0, 0 }, /* Op */
! 221: { NULL, 0, 0 }, /* Ot */
! 222: { NULL, TYPE_Pa, NODE_NOSRC }, /* Pa */
! 223: { NULL, 0, 0 }, /* Rv */
! 224: { NULL, TYPE_St, 0 }, /* St */
! 225: { parse_mdoc_Va, TYPE_Va, 0 }, /* Va */
! 226: { parse_mdoc_Va, TYPE_Vt, 0 }, /* Vt */
! 227: { parse_mdoc_Xr, 0, 0 }, /* Xr */
! 228: { NULL, 0, 0 }, /* %A */
! 229: { NULL, 0, 0 }, /* %B */
! 230: { NULL, 0, 0 }, /* %D */
! 231: { NULL, 0, 0 }, /* %I */
! 232: { NULL, 0, 0 }, /* %J */
! 233: { NULL, 0, 0 }, /* %N */
! 234: { NULL, 0, 0 }, /* %O */
! 235: { NULL, 0, 0 }, /* %P */
! 236: { NULL, 0, 0 }, /* %R */
! 237: { NULL, 0, 0 }, /* %T */
! 238: { NULL, 0, 0 }, /* %V */
! 239: { NULL, 0, 0 }, /* Ac */
! 240: { NULL, 0, 0 }, /* Ao */
! 241: { NULL, 0, 0 }, /* Aq */
! 242: { NULL, TYPE_At, 0 }, /* At */
! 243: { NULL, 0, 0 }, /* Bc */
! 244: { NULL, 0, 0 }, /* Bf */
! 245: { NULL, 0, 0 }, /* Bo */
! 246: { NULL, 0, 0 }, /* Bq */
! 247: { NULL, TYPE_Bsx, NODE_NOSRC }, /* Bsx */
! 248: { NULL, TYPE_Bx, 0 }, /* Bx */
! 249: { NULL, 0, 0 }, /* Db */
! 250: { NULL, 0, 0 }, /* Dc */
! 251: { NULL, 0, 0 }, /* Do */
! 252: { NULL, 0, 0 }, /* Dq */
! 253: { NULL, 0, 0 }, /* Ec */
! 254: { NULL, 0, 0 }, /* Ef */
! 255: { NULL, TYPE_Em, 0 }, /* Em */
! 256: { NULL, 0, 0 }, /* Eo */
! 257: { NULL, TYPE_Fx, NODE_NOSRC }, /* Fx */
! 258: { NULL, TYPE_Ms, 0 }, /* Ms */
! 259: { NULL, 0, 0 }, /* No */
! 260: { NULL, 0, 0 }, /* Ns */
! 261: { NULL, TYPE_Nx, NODE_NOSRC }, /* Nx */
! 262: { NULL, TYPE_Ox, NODE_NOSRC }, /* Ox */
! 263: { NULL, 0, 0 }, /* Pc */
! 264: { NULL, 0, 0 }, /* Pf */
! 265: { NULL, 0, 0 }, /* Po */
! 266: { NULL, 0, 0 }, /* Pq */
! 267: { NULL, 0, 0 }, /* Qc */
! 268: { NULL, 0, 0 }, /* Ql */
! 269: { NULL, 0, 0 }, /* Qo */
! 270: { NULL, 0, 0 }, /* Qq */
! 271: { NULL, 0, 0 }, /* Re */
! 272: { NULL, 0, 0 }, /* Rs */
! 273: { NULL, 0, 0 }, /* Sc */
! 274: { NULL, 0, 0 }, /* So */
! 275: { NULL, 0, 0 }, /* Sq */
! 276: { NULL, 0, 0 }, /* Sm */
! 277: { NULL, 0, 0 }, /* Sx */
! 278: { NULL, TYPE_Sy, 0 }, /* Sy */
! 279: { NULL, TYPE_Tn, 0 }, /* Tn */
! 280: { NULL, 0, NODE_NOSRC }, /* Ux */
! 281: { NULL, 0, 0 }, /* Xc */
! 282: { NULL, 0, 0 }, /* Xo */
! 283: { parse_mdoc_Fo, 0, 0 }, /* Fo */
! 284: { NULL, 0, 0 }, /* Fc */
! 285: { NULL, 0, 0 }, /* Oo */
! 286: { NULL, 0, 0 }, /* Oc */
! 287: { NULL, 0, 0 }, /* Bk */
! 288: { NULL, 0, 0 }, /* Ek */
! 289: { NULL, 0, 0 }, /* Bt */
! 290: { NULL, 0, 0 }, /* Hf */
! 291: { NULL, 0, 0 }, /* Fr */
! 292: { NULL, 0, 0 }, /* Ud */
! 293: { NULL, TYPE_Lb, 0 }, /* Lb */
! 294: { NULL, 0, 0 }, /* Lp */
! 295: { NULL, TYPE_Lk, 0 }, /* Lk */
! 296: { NULL, TYPE_Mt, NODE_NOSRC }, /* Mt */
! 297: { NULL, 0, 0 }, /* Brq */
! 298: { NULL, 0, 0 }, /* Bro */
! 299: { NULL, 0, 0 }, /* Brc */
! 300: { NULL, 0, 0 }, /* %C */
! 301: { NULL, 0, 0 }, /* Es */
! 302: { NULL, 0, 0 }, /* En */
! 303: { NULL, TYPE_Dx, NODE_NOSRC }, /* Dx */
! 304: { NULL, 0, 0 }, /* %Q */
! 305: { NULL, 0, 0 }, /* br */
! 306: { NULL, 0, 0 }, /* sp */
! 307: { NULL, 0, 0 }, /* %U */
! 308: { NULL, 0, 0 }, /* Ta */
! 309: { NULL, 0, 0 }, /* ll */
1.1 kristaps 310: };
311:
1.141 schwarze 312:
1.1 kristaps 313: int
1.179 schwarze 314: mandocdb(int argc, char *argv[])
1.1 kristaps 315: {
1.187 schwarze 316: struct manconf conf;
317: struct mparse *mp;
1.221 schwarze 318: struct dba *dba;
1.206 schwarze 319: const char *path_arg, *progname;
1.187 schwarze 320: size_t j, sz;
1.59 schwarze 321: int ch, i;
1.50 kristaps 322:
1.207 schwarze 323: #if HAVE_PLEDGE
324: if (pledge("stdio rpath wpath cpath fattr flock proc exec", NULL) == -1) {
1.214 schwarze 325: warn("pledge");
1.218 kristaps 326: return (int)MANDOCLEVEL_SYSERR;
327: }
328: #endif
329:
330: #if HAVE_SANDBOX_INIT
331: if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1) {
332: warnx("sandbox_init");
1.207 schwarze 333: return (int)MANDOCLEVEL_SYSERR;
334: }
335: #endif
336:
1.187 schwarze 337: memset(&conf, 0, sizeof(conf));
1.50 kristaps 338:
339: /*
1.141 schwarze 340: * We accept a few different invocations.
1.50 kristaps 341: * The CHECKOP macro makes sure that invocation styles don't
342: * clobber each other.
343: */
344: #define CHECKOP(_op, _ch) do \
345: if (OP_DEFAULT != (_op)) { \
1.198 schwarze 346: warnx("-%c: Conflicting option", (_ch)); \
1.50 kristaps 347: goto usage; \
348: } while (/*CONSTCOND*/0)
1.10 kristaps 349:
1.59 schwarze 350: path_arg = NULL;
1.38 schwarze 351: op = OP_DEFAULT;
1.1 kristaps 352:
1.126 schwarze 353: while (-1 != (ch = getopt(argc, argv, "aC:Dd:npQT:tu:v")))
1.1 kristaps 354: switch (ch) {
1.141 schwarze 355: case 'a':
1.12 schwarze 356: use_all = 1;
357: break;
1.141 schwarze 358: case 'C':
1.50 kristaps 359: CHECKOP(op, ch);
1.59 schwarze 360: path_arg = optarg;
1.38 schwarze 361: op = OP_CONFFILE;
1.34 schwarze 362: break;
1.141 schwarze 363: case 'D':
1.125 schwarze 364: debug++;
365: break;
1.141 schwarze 366: case 'd':
1.50 kristaps 367: CHECKOP(op, ch);
1.59 schwarze 368: path_arg = optarg;
1.5 kristaps 369: op = OP_UPDATE;
370: break;
1.141 schwarze 371: case 'n':
1.50 kristaps 372: nodb = 1;
373: break;
1.141 schwarze 374: case 'p':
1.126 schwarze 375: warnings = 1;
376: break;
1.141 schwarze 377: case 'Q':
1.116 schwarze 378: mparse_options |= MPARSE_QUICK;
1.102 schwarze 379: break;
1.141 schwarze 380: case 'T':
1.95 schwarze 381: if (strcmp(optarg, "utf8")) {
1.198 schwarze 382: warnx("-T%s: Unsupported output format",
383: optarg);
1.95 schwarze 384: goto usage;
385: }
386: write_utf8 = 1;
387: break;
1.141 schwarze 388: case 't':
1.50 kristaps 389: CHECKOP(op, ch);
1.38 schwarze 390: dup2(STDOUT_FILENO, STDERR_FILENO);
391: op = OP_TEST;
1.50 kristaps 392: nodb = warnings = 1;
1.38 schwarze 393: break;
1.141 schwarze 394: case 'u':
1.50 kristaps 395: CHECKOP(op, ch);
1.59 schwarze 396: path_arg = optarg;
1.5 kristaps 397: op = OP_DELETE;
398: break;
1.141 schwarze 399: case 'v':
1.126 schwarze 400: /* Compatibility with espie@'s makewhatis. */
1.38 schwarze 401: break;
1.1 kristaps 402: default:
1.38 schwarze 403: goto usage;
1.1 kristaps 404: }
405:
406: argc -= optind;
407: argv += optind;
408:
1.207 schwarze 409: #if HAVE_PLEDGE
1.210 schwarze 410: if (nodb) {
411: if (pledge("stdio rpath", NULL) == -1) {
1.214 schwarze 412: warn("pledge");
1.210 schwarze 413: return (int)MANDOCLEVEL_SYSERR;
414: }
1.207 schwarze 415: }
416: #endif
417:
1.38 schwarze 418: if (OP_CONFFILE == op && argc > 0) {
1.198 schwarze 419: warnx("-C: Too many arguments");
1.38 schwarze 420: goto usage;
421: }
422:
1.59 schwarze 423: exitcode = (int)MANDOCLEVEL_OK;
1.203 schwarze 424: mchars_alloc();
425: mp = mparse_alloc(mparse_options, MANDOCLEVEL_BADARG, NULL, NULL);
1.202 schwarze 426: mandoc_ohash_init(&mpages, 6, offsetof(struct mpage, inodev));
427: mandoc_ohash_init(&mlinks, 6, offsetof(struct mlink, file));
1.50 kristaps 428:
429: if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) {
1.59 schwarze 430:
1.50 kristaps 431: /*
1.150 schwarze 432: * Most of these deal with a specific directory.
1.140 schwarze 433: * Jump into that directory first.
1.50 kristaps 434: */
1.165 schwarze 435: if (OP_TEST != op && 0 == set_basedir(path_arg, 1))
1.50 kristaps 436: goto out;
1.140 schwarze 437:
1.225 schwarze 438: dba = nodb ? dba_new(128) : dba_read(MANDOC_DB);
439: if (dba != NULL) {
1.140 schwarze 440: /*
441: * The existing database is usable. Process
442: * all files specified on the command-line.
443: */
1.207 schwarze 444: #if HAVE_PLEDGE
1.210 schwarze 445: if (!nodb) {
446: if (pledge("stdio rpath wpath cpath fattr flock", NULL) == -1) {
1.214 schwarze 447: warn("pledge");
1.210 schwarze 448: exitcode = (int)MANDOCLEVEL_SYSERR;
449: goto out;
450: }
1.207 schwarze 451: }
452: #endif
1.140 schwarze 453: use_all = 1;
1.138 schwarze 454: for (i = 0; i < argc; i++)
455: filescan(argv[i]);
1.225 schwarze 456: if (nodb == 0)
1.221 schwarze 457: dbprune(dba);
1.138 schwarze 458: } else {
1.228 schwarze 459: /* Database missing or corrupt. */
1.230 schwarze 460: if (op != OP_UPDATE || errno != ENOENT)
461: say(MANDOC_DB, "%s: Automatically recreating"
462: " from scratch", strerror(errno));
1.140 schwarze 463: exitcode = (int)MANDOCLEVEL_OK;
1.138 schwarze 464: op = OP_DEFAULT;
465: if (0 == treescan())
466: goto out;
1.221 schwarze 467: dba = dba_new(128);
1.138 schwarze 468: }
1.50 kristaps 469: if (OP_DELETE != op)
1.221 schwarze 470: mpages_merge(dba, mp);
471: if (nodb == 0)
472: dbwrite(dba);
473: dba_free(dba);
1.50 kristaps 474: } else {
475: /*
476: * If we have arguments, use them as our manpaths.
1.222 schwarze 477: * If we don't, use man.conf(5).
1.50 kristaps 478: */
479: if (argc > 0) {
1.187 schwarze 480: conf.manpath.paths = mandoc_reallocarray(NULL,
1.144 schwarze 481: argc, sizeof(char *));
1.187 schwarze 482: conf.manpath.sz = (size_t)argc;
1.50 kristaps 483: for (i = 0; i < argc; i++)
1.187 schwarze 484: conf.manpath.paths[i] = mandoc_strdup(argv[i]);
1.50 kristaps 485: } else
1.187 schwarze 486: manconf_parse(&conf, path_arg, NULL, NULL);
1.127 schwarze 487:
1.187 schwarze 488: if (conf.manpath.sz == 0) {
1.127 schwarze 489: exitcode = (int)MANDOCLEVEL_BADARG;
490: say("", "Empty manpath");
491: }
1.50 kristaps 492:
493: /*
1.69 schwarze 494: * First scan the tree rooted at a base directory, then
495: * build a new database and finally move it into place.
1.50 kristaps 496: * Ignore zero-length directories and strip trailing
497: * slashes.
498: */
1.187 schwarze 499: for (j = 0; j < conf.manpath.sz; j++) {
500: sz = strlen(conf.manpath.paths[j]);
501: if (sz && conf.manpath.paths[j][sz - 1] == '/')
502: conf.manpath.paths[j][--sz] = '\0';
1.50 kristaps 503: if (0 == sz)
504: continue;
1.66 schwarze 505:
506: if (j) {
1.202 schwarze 507: mandoc_ohash_init(&mpages, 6,
508: offsetof(struct mpage, inodev));
509: mandoc_ohash_init(&mlinks, 6,
510: offsetof(struct mlink, file));
1.66 schwarze 511: }
512:
1.187 schwarze 513: if ( ! set_basedir(conf.manpath.paths[j], argc > 0))
1.165 schwarze 514: continue;
1.59 schwarze 515: if (0 == treescan())
1.165 schwarze 516: continue;
1.221 schwarze 517: dba = dba_new(128);
518: mpages_merge(dba, mp);
519: if (nodb == 0)
520: dbwrite(dba);
521: dba_free(dba);
1.66 schwarze 522:
1.187 schwarze 523: if (j + 1 < conf.manpath.sz) {
1.80 schwarze 524: mpages_free();
1.78 schwarze 525: ohash_delete(&mpages);
1.83 schwarze 526: ohash_delete(&mlinks);
1.66 schwarze 527: }
1.50 kristaps 528: }
529: }
530: out:
1.187 schwarze 531: manconf_free(&conf);
1.168 schwarze 532: mparse_free(mp);
1.203 schwarze 533: mchars_free();
1.80 schwarze 534: mpages_free();
1.78 schwarze 535: ohash_delete(&mpages);
1.83 schwarze 536: ohash_delete(&mlinks);
1.197 schwarze 537: return exitcode;
1.50 kristaps 538: usage:
1.206 schwarze 539: progname = getprogname();
1.126 schwarze 540: fprintf(stderr, "usage: %s [-aDnpQ] [-C file] [-Tutf8]\n"
541: " %s [-aDnpQ] [-Tutf8] dir ...\n"
542: " %s [-DnpQ] [-Tutf8] -d dir [file ...]\n"
543: " %s [-Dnp] -u dir [file ...]\n"
1.102 schwarze 544: " %s [-Q] -t file ...\n",
1.206 schwarze 545: progname, progname, progname, progname, progname);
1.50 kristaps 546:
1.197 schwarze 547: return (int)MANDOCLEVEL_BADARG;
1.50 kristaps 548: }
549:
550: /*
1.231 schwarze 551: * To get a singly linked list in alpha order while inserting entries
552: * at the beginning, process directory entries in reverse alpha order.
553: */
554: static int
1.232 schwarze 555: #if HAVE_FTS_COMPARE_CONST
556: fts_compare(const FTSENT *const *a, const FTSENT *const *b)
557: #else
1.231 schwarze 558: fts_compare(const FTSENT **a, const FTSENT **b)
1.232 schwarze 559: #endif
1.231 schwarze 560: {
561: return -strcmp((*a)->fts_name, (*b)->fts_name);
562: }
563:
564: /*
1.59 schwarze 565: * Scan a directory tree rooted at "basedir" for manpages.
1.50 kristaps 566: * We use fts(), scanning directory parts along the way for clues to our
567: * section and architecture.
568: *
569: * If use_all has been specified, grok all files.
570: * If not, sanitise paths to the following:
571: *
1.141 schwarze 572: * [./]man*[/<arch>]/<name>.<section>
1.50 kristaps 573: * or
574: * [./]cat<section>[/<arch>]/<name>.0
575: *
1.216 schwarze 576: * TODO: accommodate for multi-language directories.
1.50 kristaps 577: */
578: static int
1.59 schwarze 579: treescan(void)
1.50 kristaps 580: {
1.139 schwarze 581: char buf[PATH_MAX];
1.50 kristaps 582: FTS *f;
583: FTSENT *ff;
1.84 schwarze 584: struct mlink *mlink;
1.221 schwarze 585: int gzip;
586: enum form dform;
1.94 schwarze 587: char *dsec, *arch, *fsec, *cp;
588: const char *path;
1.50 kristaps 589: const char *argv[2];
590:
591: argv[0] = ".";
592: argv[1] = (char *)NULL;
593:
1.231 schwarze 594: f = fts_open((char * const *)argv, FTS_PHYSICAL | FTS_NOCHDIR,
595: fts_compare);
1.200 schwarze 596: if (f == NULL) {
1.59 schwarze 597: exitcode = (int)MANDOCLEVEL_SYSERR;
1.123 schwarze 598: say("", "&fts_open");
1.197 schwarze 599: return 0;
1.50 kristaps 600: }
601:
602: dsec = arch = NULL;
603: dform = FORM_NONE;
604:
1.200 schwarze 605: while ((ff = fts_read(f)) != NULL) {
1.50 kristaps 606: path = ff->fts_path + 2;
1.139 schwarze 607: switch (ff->fts_info) {
608:
609: /*
610: * Symbolic links require various sanity checks,
611: * then get handled just like regular files.
612: */
1.141 schwarze 613: case FTS_SL:
1.200 schwarze 614: if (realpath(path, buf) == NULL) {
1.139 schwarze 615: if (warnings)
616: say(path, "&realpath");
617: continue;
618: }
1.184 schwarze 619: if (strstr(buf, basedir) != buf
620: #ifdef HOMEBREWDIR
621: && strstr(buf, HOMEBREWDIR) != buf
622: #endif
623: ) {
1.139 schwarze 624: if (warnings) say("",
625: "%s: outside base directory", buf);
626: continue;
627: }
628: /* Use logical inode to avoid mpages dupe. */
1.200 schwarze 629: if (stat(path, ff->fts_statp) == -1) {
1.139 schwarze 630: if (warnings)
631: say(path, "&stat");
632: continue;
633: }
634: /* FALLTHROUGH */
635:
1.50 kristaps 636: /*
1.83 schwarze 637: * If we're a regular file, add an mlink by using the
1.50 kristaps 638: * stored directory data and handling the filename.
639: */
1.141 schwarze 640: case FTS_F:
1.200 schwarze 641: if ( ! strcmp(path, MANDOC_DB))
1.60 schwarze 642: continue;
1.50 kristaps 643: if ( ! use_all && ff->fts_level < 2) {
1.56 schwarze 644: if (warnings)
1.59 schwarze 645: say(path, "Extraneous file");
1.50 kristaps 646: continue;
1.124 schwarze 647: }
648: gzip = 0;
649: fsec = NULL;
1.200 schwarze 650: while (fsec == NULL) {
1.124 schwarze 651: fsec = strrchr(ff->fts_name, '.');
1.200 schwarze 652: if (fsec == NULL || strcmp(fsec+1, "gz"))
1.124 schwarze 653: break;
654: gzip = 1;
655: *fsec = '\0';
656: fsec = NULL;
657: }
1.200 schwarze 658: if (fsec == NULL) {
1.60 schwarze 659: if ( ! use_all) {
1.56 schwarze 660: if (warnings)
1.60 schwarze 661: say(path,
662: "No filename suffix");
1.50 kristaps 663: continue;
664: }
1.200 schwarze 665: } else if ( ! strcmp(++fsec, "html")) {
1.60 schwarze 666: if (warnings)
667: say(path, "Skip html");
668: continue;
1.200 schwarze 669: } else if ( ! strcmp(fsec, "ps")) {
1.60 schwarze 670: if (warnings)
671: say(path, "Skip ps");
672: continue;
1.200 schwarze 673: } else if ( ! strcmp(fsec, "pdf")) {
1.60 schwarze 674: if (warnings)
675: say(path, "Skip pdf");
676: continue;
677: } else if ( ! use_all &&
1.200 schwarze 678: ((dform == FORM_SRC &&
1.185 schwarze 679: strncmp(fsec, dsec, strlen(dsec))) ||
1.200 schwarze 680: (dform == FORM_CAT && strcmp(fsec, "0")))) {
1.60 schwarze 681: if (warnings)
682: say(path, "Wrong filename suffix");
683: continue;
1.66 schwarze 684: } else
1.84 schwarze 685: fsec[-1] = '\0';
1.94 schwarze 686:
1.84 schwarze 687: mlink = mandoc_calloc(1, sizeof(struct mlink));
1.143 schwarze 688: if (strlcpy(mlink->file, path,
689: sizeof(mlink->file)) >=
690: sizeof(mlink->file)) {
691: say(path, "Filename too long");
692: free(mlink);
693: continue;
694: }
1.84 schwarze 695: mlink->dform = dform;
1.94 schwarze 696: mlink->dsec = dsec;
697: mlink->arch = arch;
698: mlink->name = ff->fts_name;
699: mlink->fsec = fsec;
1.124 schwarze 700: mlink->gzip = gzip;
1.84 schwarze 701: mlink_add(mlink, ff->fts_statp);
1.50 kristaps 702: continue;
1.139 schwarze 703:
1.141 schwarze 704: case FTS_D:
705: case FTS_DP:
1.139 schwarze 706: break;
707:
708: default:
1.60 schwarze 709: if (warnings)
710: say(path, "Not a regular file");
1.50 kristaps 711: continue;
1.60 schwarze 712: }
1.1 kristaps 713:
1.50 kristaps 714: switch (ff->fts_level) {
1.141 schwarze 715: case 0:
1.50 kristaps 716: /* Ignore the root directory. */
717: break;
1.141 schwarze 718: case 1:
1.50 kristaps 719: /*
720: * This might contain manX/ or catX/.
721: * Try to infer this from the name.
722: * If we're not in use_all, enforce it.
723: */
724: cp = ff->fts_name;
1.200 schwarze 725: if (ff->fts_info == FTS_DP) {
726: dform = FORM_NONE;
727: dsec = NULL;
1.50 kristaps 728: break;
1.200 schwarze 729: }
1.1 kristaps 730:
1.200 schwarze 731: if ( ! strncmp(cp, "man", 3)) {
1.50 kristaps 732: dform = FORM_SRC;
1.66 schwarze 733: dsec = cp + 3;
1.200 schwarze 734: } else if ( ! strncmp(cp, "cat", 3)) {
1.50 kristaps 735: dform = FORM_CAT;
1.66 schwarze 736: dsec = cp + 3;
1.94 schwarze 737: } else {
738: dform = FORM_NONE;
739: dsec = NULL;
1.50 kristaps 740: }
1.1 kristaps 741:
1.200 schwarze 742: if (dsec != NULL || use_all)
1.50 kristaps 743: break;
1.1 kristaps 744:
1.56 schwarze 745: if (warnings)
1.59 schwarze 746: say(path, "Unknown directory part");
1.50 kristaps 747: fts_set(f, ff, FTS_SKIP);
748: break;
1.141 schwarze 749: case 2:
1.50 kristaps 750: /*
751: * Possibly our architecture.
752: * If we're descending, keep tabs on it.
753: */
1.200 schwarze 754: if (ff->fts_info != FTS_DP && dsec != NULL)
1.66 schwarze 755: arch = ff->fts_name;
1.94 schwarze 756: else
757: arch = NULL;
1.50 kristaps 758: break;
759: default:
1.200 schwarze 760: if (ff->fts_info == FTS_DP || use_all)
1.50 kristaps 761: break;
1.56 schwarze 762: if (warnings)
1.59 schwarze 763: say(path, "Extraneous directory part");
1.50 kristaps 764: fts_set(f, ff, FTS_SKIP);
765: break;
1.5 kristaps 766: }
1.50 kristaps 767: }
768:
769: fts_close(f);
1.197 schwarze 770: return 1;
1.50 kristaps 771: }
1.5 kristaps 772:
1.50 kristaps 773: /*
1.89 schwarze 774: * Add a file to the mlinks table.
1.50 kristaps 775: * Do not verify that it's a "valid" looking manpage (we'll do that
776: * later).
777: *
778: * Try to infer the manual section, architecture, and page name from the
779: * path, assuming it looks like
780: *
1.141 schwarze 781: * [./]man*[/<arch>]/<name>.<section>
1.50 kristaps 782: * or
783: * [./]cat<section>[/<arch>]/<name>.0
784: *
785: * See treescan() for the fts(3) version of this.
786: */
787: static void
1.59 schwarze 788: filescan(const char *file)
1.50 kristaps 789: {
1.59 schwarze 790: char buf[PATH_MAX];
1.84 schwarze 791: struct stat st;
792: struct mlink *mlink;
1.59 schwarze 793: char *p, *start;
1.5 kristaps 794:
1.50 kristaps 795: assert(use_all);
1.5 kristaps 796:
1.50 kristaps 797: if (0 == strncmp(file, "./", 2))
798: file += 2;
1.5 kristaps 799:
1.139 schwarze 800: /*
801: * We have to do lstat(2) before realpath(3) loses
802: * the information whether this is a symbolic link.
803: * We need to know that because for symbolic links,
804: * we want to use the orginal file name, while for
805: * regular files, we want to use the real path.
806: */
807: if (-1 == lstat(file, &st)) {
808: exitcode = (int)MANDOCLEVEL_BADARG;
809: say(file, "&lstat");
810: return;
811: } else if (0 == ((S_IFREG | S_IFLNK) & st.st_mode)) {
812: exitcode = (int)MANDOCLEVEL_BADARG;
813: say(file, "Not a regular file");
814: return;
815: }
816:
817: /*
818: * We have to resolve the file name to the real path
819: * in any case for the base directory check.
820: */
1.59 schwarze 821: if (NULL == realpath(file, buf)) {
822: exitcode = (int)MANDOCLEVEL_BADARG;
1.123 schwarze 823: say(file, "&realpath");
1.59 schwarze 824: return;
1.106 schwarze 825: }
826:
1.150 schwarze 827: if (OP_TEST == op)
1.106 schwarze 828: start = buf;
1.150 schwarze 829: else if (strstr(buf, basedir) == buf)
830: start = buf + strlen(basedir);
1.184 schwarze 831: #ifdef HOMEBREWDIR
832: else if (strstr(buf, HOMEBREWDIR) == buf)
833: start = buf;
834: #endif
1.106 schwarze 835: else {
1.59 schwarze 836: exitcode = (int)MANDOCLEVEL_BADARG;
837: say("", "%s: outside base directory", buf);
838: return;
1.106 schwarze 839: }
840:
1.139 schwarze 841: /*
842: * Now we are sure the file is inside our tree.
843: * If it is a symbolic link, ignore the real path
844: * and use the original name.
845: * This implies passing stuff like "cat1/../man1/foo.1"
846: * on the command line won't work. So don't do that.
847: * Note the stat(2) can still fail if the link target
848: * doesn't exist.
849: */
850: if (S_IFLNK & st.st_mode) {
851: if (-1 == stat(buf, &st)) {
852: exitcode = (int)MANDOCLEVEL_BADARG;
853: say(file, "&stat");
854: return;
855: }
1.143 schwarze 856: if (strlcpy(buf, file, sizeof(buf)) >= sizeof(buf)) {
857: say(file, "Filename too long");
858: return;
859: }
1.150 schwarze 860: start = buf;
861: if (OP_TEST != op && strstr(buf, basedir) == buf)
862: start += strlen(basedir);
1.50 kristaps 863: }
1.106 schwarze 864:
1.84 schwarze 865: mlink = mandoc_calloc(1, sizeof(struct mlink));
1.161 schwarze 866: mlink->dform = FORM_NONE;
1.143 schwarze 867: if (strlcpy(mlink->file, start, sizeof(mlink->file)) >=
868: sizeof(mlink->file)) {
869: say(start, "Filename too long");
1.180 schwarze 870: free(mlink);
1.143 schwarze 871: return;
872: }
1.17 schwarze 873:
1.50 kristaps 874: /*
875: * First try to guess our directory structure.
876: * If we find a separator, try to look for man* or cat*.
877: * If we find one of these and what's underneath is a directory,
878: * assume it's an architecture.
879: */
880: if (NULL != (p = strchr(start, '/'))) {
881: *p++ = '\0';
882: if (0 == strncmp(start, "man", 3)) {
1.84 schwarze 883: mlink->dform = FORM_SRC;
1.94 schwarze 884: mlink->dsec = start + 3;
1.50 kristaps 885: } else if (0 == strncmp(start, "cat", 3)) {
1.84 schwarze 886: mlink->dform = FORM_CAT;
1.94 schwarze 887: mlink->dsec = start + 3;
1.17 schwarze 888: }
1.5 kristaps 889:
1.50 kristaps 890: start = p;
1.84 schwarze 891: if (NULL != mlink->dsec && NULL != (p = strchr(start, '/'))) {
1.50 kristaps 892: *p++ = '\0';
1.94 schwarze 893: mlink->arch = start;
1.50 kristaps 894: start = p;
1.84 schwarze 895: }
1.50 kristaps 896: }
897:
898: /*
899: * Now check the file suffix.
900: * Suffix of `.0' indicates a catpage, `.1-9' is a manpage.
901: */
902: p = strrchr(start, '\0');
903: while (p-- > start && '/' != *p && '.' != *p)
904: /* Loop. */ ;
905:
906: if ('.' == *p) {
907: *p++ = '\0';
1.94 schwarze 908: mlink->fsec = p;
1.5 kristaps 909: }
910:
1.10 kristaps 911: /*
1.50 kristaps 912: * Now try to parse the name.
913: * Use the filename portion of the path.
1.10 kristaps 914: */
1.84 schwarze 915: mlink->name = start;
1.50 kristaps 916: if (NULL != (p = strrchr(start, '/'))) {
1.84 schwarze 917: mlink->name = p + 1;
1.50 kristaps 918: *p = '\0';
1.84 schwarze 919: }
920: mlink_add(mlink, &st);
1.50 kristaps 921: }
1.5 kristaps 922:
1.50 kristaps 923: static void
1.84 schwarze 924: mlink_add(struct mlink *mlink, const struct stat *st)
1.50 kristaps 925: {
1.83 schwarze 926: struct inodev inodev;
1.78 schwarze 927: struct mpage *mpage;
1.83 schwarze 928: unsigned int slot;
1.50 kristaps 929:
1.84 schwarze 930: assert(NULL != mlink->file);
1.50 kristaps 931:
1.94 schwarze 932: mlink->dsec = mandoc_strdup(mlink->dsec ? mlink->dsec : "");
933: mlink->arch = mandoc_strdup(mlink->arch ? mlink->arch : "");
934: mlink->name = mandoc_strdup(mlink->name ? mlink->name : "");
935: mlink->fsec = mandoc_strdup(mlink->fsec ? mlink->fsec : "");
1.84 schwarze 936:
937: if ('0' == *mlink->fsec) {
938: free(mlink->fsec);
939: mlink->fsec = mandoc_strdup(mlink->dsec);
940: mlink->fform = FORM_CAT;
941: } else if ('1' <= *mlink->fsec && '9' >= *mlink->fsec)
942: mlink->fform = FORM_SRC;
1.74 schwarze 943: else
1.84 schwarze 944: mlink->fform = FORM_NONE;
1.82 schwarze 945:
1.83 schwarze 946: slot = ohash_qlookup(&mlinks, mlink->file);
947: assert(NULL == ohash_find(&mlinks, slot));
948: ohash_insert(&mlinks, slot, mlink);
949:
1.186 schwarze 950: memset(&inodev, 0, sizeof(inodev)); /* Clear padding. */
1.83 schwarze 951: inodev.st_ino = st->st_ino;
952: inodev.st_dev = st->st_dev;
953: slot = ohash_lookup_memory(&mpages, (char *)&inodev,
954: sizeof(struct inodev), inodev.st_ino);
955: mpage = ohash_find(&mpages, slot);
956: if (NULL == mpage) {
957: mpage = mandoc_calloc(1, sizeof(struct mpage));
958: mpage->inodev.st_ino = inodev.st_ino;
959: mpage->inodev.st_dev = inodev.st_dev;
1.221 schwarze 960: mpage->form = FORM_NONE;
1.231 schwarze 961: mpage->next = mpage_head;
962: mpage_head = mpage;
1.83 schwarze 963: ohash_insert(&mpages, slot, mpage);
964: } else
1.85 schwarze 965: mlink->next = mpage->mlinks;
1.82 schwarze 966: mpage->mlinks = mlink;
1.118 schwarze 967: mlink->mpage = mpage;
1.82 schwarze 968: }
969:
970: static void
971: mlink_free(struct mlink *mlink)
972: {
973:
974: free(mlink->dsec);
975: free(mlink->arch);
976: free(mlink->name);
977: free(mlink->fsec);
978: free(mlink);
1.50 kristaps 979: }
1.3 kristaps 980:
1.50 kristaps 981: static void
1.78 schwarze 982: mpages_free(void)
1.50 kristaps 983: {
1.78 schwarze 984: struct mpage *mpage;
1.82 schwarze 985: struct mlink *mlink;
1.3 kristaps 986:
1.231 schwarze 987: while ((mpage = mpage_head) != NULL) {
988: while ((mlink = mpage->mlinks) != NULL) {
1.85 schwarze 989: mpage->mlinks = mlink->next;
1.82 schwarze 990: mlink_free(mlink);
991: }
1.231 schwarze 992: mpage_head = mpage->next;
1.78 schwarze 993: free(mpage->sec);
994: free(mpage->arch);
1.82 schwarze 995: free(mpage->title);
996: free(mpage->desc);
1.78 schwarze 997: free(mpage);
1.50 kristaps 998: }
999: }
1.38 schwarze 1000:
1.50 kristaps 1001: /*
1.89 schwarze 1002: * For each mlink to the mpage, check whether the path looks like
1003: * it is formatted, and if it does, check whether a source manual
1004: * exists by the same name, ignoring the suffix.
1005: * If both conditions hold, drop the mlink.
1006: */
1007: static void
1008: mlinks_undupe(struct mpage *mpage)
1009: {
1010: char buf[PATH_MAX];
1011: struct mlink **prev;
1012: struct mlink *mlink;
1013: char *bufp;
1014:
1015: mpage->form = FORM_CAT;
1.90 schwarze 1016: prev = &mpage->mlinks;
1017: while (NULL != (mlink = *prev)) {
1.89 schwarze 1018: if (FORM_CAT != mlink->dform) {
1019: mpage->form = FORM_NONE;
1.90 schwarze 1020: goto nextlink;
1.89 schwarze 1021: }
1.143 schwarze 1022: (void)strlcpy(buf, mlink->file, sizeof(buf));
1.89 schwarze 1023: bufp = strstr(buf, "cat");
1024: assert(NULL != bufp);
1025: memcpy(bufp, "man", 3);
1026: if (NULL != (bufp = strrchr(buf, '.')))
1027: *++bufp = '\0';
1.143 schwarze 1028: (void)strlcat(buf, mlink->dsec, sizeof(buf));
1.89 schwarze 1029: if (NULL == ohash_find(&mlinks,
1.141 schwarze 1030: ohash_qlookup(&mlinks, buf)))
1.90 schwarze 1031: goto nextlink;
1.89 schwarze 1032: if (warnings)
1033: say(mlink->file, "Man source exists: %s", buf);
1034: if (use_all)
1.90 schwarze 1035: goto nextlink;
1.89 schwarze 1036: *prev = mlink->next;
1037: mlink_free(mlink);
1.90 schwarze 1038: continue;
1039: nextlink:
1040: prev = &(*prev)->next;
1.89 schwarze 1041: }
1042: }
1043:
1.131 schwarze 1044: static void
1.93 schwarze 1045: mlink_check(struct mpage *mpage, struct mlink *mlink)
1046: {
1.131 schwarze 1047: struct str *str;
1048: unsigned int slot;
1.93 schwarze 1049:
1050: /*
1051: * Check whether the manual section given in a file
1052: * agrees with the directory where the file is located.
1053: * Some manuals have suffixes like (3p) on their
1054: * section number either inside the file or in the
1055: * directory name, some are linked into more than one
1056: * section, like encrypt(1) = makekey(8).
1057: */
1058:
1059: if (FORM_SRC == mpage->form &&
1.131 schwarze 1060: strcasecmp(mpage->sec, mlink->dsec))
1.93 schwarze 1061: say(mlink->file, "Section \"%s\" manual in %s directory",
1062: mpage->sec, mlink->dsec);
1063:
1064: /*
1065: * Manual page directories exist for each kernel
1066: * architecture as returned by machine(1).
1067: * However, many manuals only depend on the
1068: * application architecture as returned by arch(1).
1069: * For example, some (2/ARM) manuals are shared
1070: * across the "armish" and "zaurus" kernel
1071: * architectures.
1072: * A few manuals are even shared across completely
1073: * different architectures, for example fdformat(1)
1.229 schwarze 1074: * on amd64, i386, and sparc64.
1.93 schwarze 1075: */
1076:
1.131 schwarze 1077: if (strcasecmp(mpage->arch, mlink->arch))
1.93 schwarze 1078: say(mlink->file, "Architecture \"%s\" manual in "
1079: "\"%s\" directory", mpage->arch, mlink->arch);
1080:
1.131 schwarze 1081: /*
1082: * XXX
1.133 schwarze 1083: * parse_cat() doesn't set NAME_TITLE yet.
1.131 schwarze 1084: */
1085:
1086: if (FORM_CAT == mpage->form)
1087: return;
1088:
1089: /*
1090: * Check whether this mlink
1091: * appears as a name in the NAME section.
1092: */
1.93 schwarze 1093:
1.133 schwarze 1094: slot = ohash_qlookup(&names, mlink->name);
1095: str = ohash_find(&names, slot);
1.131 schwarze 1096: assert(NULL != str);
1.133 schwarze 1097: if ( ! (NAME_TITLE & str->mask))
1.131 schwarze 1098: say(mlink->file, "Name missing in NAME section");
1.93 schwarze 1099: }
1100:
1.89 schwarze 1101: /*
1.80 schwarze 1102: * Run through the files in the global vector "mpages"
1103: * and add them to the database specified in "basedir".
1.50 kristaps 1104: *
1105: * This handles the parsing scheme itself, using the cues of directory
1106: * and filename to determine whether the file is parsable or not.
1107: */
1.59 schwarze 1108: static void
1.221 schwarze 1109: mpages_merge(struct dba *dba, struct mparse *mp)
1.50 kristaps 1110: {
1.231 schwarze 1111: struct mpage *mpage, *mpage_dest;
1.118 schwarze 1112: struct mlink *mlink, *mlink_dest;
1.191 schwarze 1113: struct roff_man *man;
1.118 schwarze 1114: char *sodest;
1.112 schwarze 1115: char *cp;
1.162 schwarze 1116: int fd;
1.69 schwarze 1117:
1.231 schwarze 1118: for (mpage = mpage_head; mpage != NULL; mpage = mpage->next) {
1.89 schwarze 1119: mlinks_undupe(mpage);
1.231 schwarze 1120: if ((mlink = mpage->mlinks) == NULL)
1121: continue;
1.50 kristaps 1122:
1.133 schwarze 1123: name_mask = NAME_MASK;
1.202 schwarze 1124: mandoc_ohash_init(&names, 4, offsetof(struct str, key));
1125: mandoc_ohash_init(&strings, 6, offsetof(struct str, key));
1.50 kristaps 1126: mparse_reset(mp);
1127: man = NULL;
1.124 schwarze 1128: sodest = NULL;
1129:
1.213 schwarze 1130: if ((fd = mparse_open(mp, mlink->file)) == -1) {
1.182 schwarze 1131: say(mlink->file, "&open");
1.162 schwarze 1132: goto nextpage;
1.124 schwarze 1133: }
1.14 schwarze 1134:
1135: /*
1.183 schwarze 1136: * Interpret the file as mdoc(7) or man(7) source
1137: * code, unless it is known to be formatted.
1.14 schwarze 1138: */
1.182 schwarze 1139: if (mlink->dform != FORM_CAT || mlink->fform != FORM_CAT) {
1.183 schwarze 1140: mparse_readfd(mp, fd, mlink->file);
1.212 schwarze 1141: close(fd);
1.192 schwarze 1142: mparse_result(mp, &man, &sodest);
1.76 schwarze 1143: }
1.14 schwarze 1144:
1.171 schwarze 1145: if (sodest != NULL) {
1.118 schwarze 1146: mlink_dest = ohash_find(&mlinks,
1147: ohash_qlookup(&mlinks, sodest));
1.171 schwarze 1148: if (mlink_dest == NULL) {
1149: mandoc_asprintf(&cp, "%s.gz", sodest);
1150: mlink_dest = ohash_find(&mlinks,
1151: ohash_qlookup(&mlinks, cp));
1152: free(cp);
1153: }
1154: if (mlink_dest != NULL) {
1.118 schwarze 1155:
1156: /* The .so target exists. */
1157:
1158: mpage_dest = mlink_dest->mpage;
1159: while (1) {
1160: mlink->mpage = mpage_dest;
1161:
1162: /*
1163: * If the target was already
1164: * processed, add the links
1165: * to the database now.
1166: * Otherwise, this will
1167: * happen when we come
1168: * to the target.
1169: */
1170:
1.221 schwarze 1171: if (mpage_dest->dba != NULL)
1172: dbadd_mlink(mlink);
1.118 schwarze 1173:
1.171 schwarze 1174: if (mlink->next == NULL)
1.118 schwarze 1175: break;
1176: mlink = mlink->next;
1177: }
1178:
1179: /* Move all links to the target. */
1180:
1181: mlink->next = mlink_dest->next;
1182: mlink_dest->next = mpage->mlinks;
1183: mpage->mlinks = NULL;
1184: }
1.124 schwarze 1185: goto nextpage;
1.192 schwarze 1186: } else if (man != NULL && man->macroset == MACROSET_MDOC) {
1.204 schwarze 1187: mdoc_validate(man);
1.82 schwarze 1188: mpage->form = FORM_SRC;
1.193 schwarze 1189: mpage->sec = man->meta.msec;
1.155 schwarze 1190: mpage->sec = mandoc_strdup(
1.171 schwarze 1191: mpage->sec == NULL ? "" : mpage->sec);
1.193 schwarze 1192: mpage->arch = man->meta.arch;
1.84 schwarze 1193: mpage->arch = mandoc_strdup(
1.171 schwarze 1194: mpage->arch == NULL ? "" : mpage->arch);
1.193 schwarze 1195: mpage->title = mandoc_strdup(man->meta.title);
1.192 schwarze 1196: } else if (man != NULL && man->macroset == MACROSET_MAN) {
1.205 schwarze 1197: man_validate(man);
1.82 schwarze 1198: mpage->form = FORM_SRC;
1.193 schwarze 1199: mpage->sec = mandoc_strdup(man->meta.msec);
1.182 schwarze 1200: mpage->arch = mandoc_strdup(mlink->arch);
1.193 schwarze 1201: mpage->title = mandoc_strdup(man->meta.title);
1.76 schwarze 1202: } else {
1.82 schwarze 1203: mpage->form = FORM_CAT;
1.182 schwarze 1204: mpage->sec = mandoc_strdup(mlink->dsec);
1205: mpage->arch = mandoc_strdup(mlink->arch);
1206: mpage->title = mandoc_strdup(mlink->name);
1.76 schwarze 1207: }
1.12 schwarze 1208:
1.174 schwarze 1209: assert(mpage->desc == NULL);
1.192 schwarze 1210: if (man != NULL && man->macroset == MACROSET_MDOC)
1.193 schwarze 1211: parse_mdoc(mpage, &man->meta, man->first);
1.174 schwarze 1212: else if (man != NULL)
1.193 schwarze 1213: parse_man(mpage, &man->meta, man->first);
1.50 kristaps 1214: else
1.162 schwarze 1215: parse_cat(mpage, fd);
1.174 schwarze 1216: if (mpage->desc == NULL)
1.135 schwarze 1217: mpage->desc = mandoc_strdup(mpage->mlinks->name);
1.131 schwarze 1218:
1219: if (warnings && !use_all)
1220: for (mlink = mpage->mlinks; mlink;
1221: mlink = mlink->next)
1222: mlink_check(mpage, mlink);
1.44 kristaps 1223:
1.221 schwarze 1224: dbadd(dba, mpage);
1.182 schwarze 1225: mlink = mpage->mlinks;
1.124 schwarze 1226:
1227: nextpage:
1.66 schwarze 1228: ohash_delete(&strings);
1.133 schwarze 1229: ohash_delete(&names);
1.50 kristaps 1230: }
1231: }
1.12 schwarze 1232:
1.50 kristaps 1233: static void
1.124 schwarze 1234: parse_cat(struct mpage *mpage, int fd)
1.50 kristaps 1235: {
1236: FILE *stream;
1237: char *line, *p, *title;
1.209 schwarze 1238: size_t linesz, plen, titlesz;
1239: ssize_t len;
1240: int offs;
1.12 schwarze 1241:
1.124 schwarze 1242: stream = (-1 == fd) ?
1243: fopen(mpage->mlinks->file, "r") :
1244: fdopen(fd, "r");
1245: if (NULL == stream) {
1.159 schwarze 1246: if (-1 != fd)
1247: close(fd);
1.56 schwarze 1248: if (warnings)
1.123 schwarze 1249: say(mpage->mlinks->file, "&fopen");
1.50 kristaps 1250: return;
1251: }
1.1 kristaps 1252:
1.209 schwarze 1253: line = NULL;
1254: linesz = 0;
1255:
1.50 kristaps 1256: /* Skip to first blank line. */
1.1 kristaps 1257:
1.209 schwarze 1258: while (getline(&line, &linesz, stream) != -1)
1259: if (*line == '\n')
1.50 kristaps 1260: break;
1.1 kristaps 1261:
1.50 kristaps 1262: /*
1263: * Assume the first line that is not indented
1264: * is the first section header. Skip to it.
1265: */
1.1 kristaps 1266:
1.209 schwarze 1267: while (getline(&line, &linesz, stream) != -1)
1268: if (*line != '\n' && *line != ' ')
1.50 kristaps 1269: break;
1.141 schwarze 1270:
1.50 kristaps 1271: /*
1272: * Read up until the next section into a buffer.
1273: * Strip the leading and trailing newline from each read line,
1274: * appending a trailing space.
1275: * Ignore empty (whitespace-only) lines.
1276: */
1.1 kristaps 1277:
1.50 kristaps 1278: titlesz = 0;
1279: title = NULL;
1.38 schwarze 1280:
1.209 schwarze 1281: while ((len = getline(&line, &linesz, stream)) != -1) {
1282: if (*line != ' ')
1.50 kristaps 1283: break;
1.209 schwarze 1284: offs = 0;
1285: while (isspace((unsigned char)line[offs]))
1286: offs++;
1287: if (line[offs] == '\0')
1.38 schwarze 1288: continue;
1.209 schwarze 1289: title = mandoc_realloc(title, titlesz + len - offs);
1290: memcpy(title + titlesz, line + offs, len - offs);
1291: titlesz += len - offs;
1.50 kristaps 1292: title[titlesz - 1] = ' ';
1293: }
1.209 schwarze 1294: free(line);
1.38 schwarze 1295:
1.50 kristaps 1296: /*
1297: * If no page content can be found, or the input line
1298: * is already the next section header, or there is no
1299: * trailing newline, reuse the page title as the page
1300: * description.
1301: */
1.44 kristaps 1302:
1.50 kristaps 1303: if (NULL == title || '\0' == *title) {
1.56 schwarze 1304: if (warnings)
1.82 schwarze 1305: say(mpage->mlinks->file,
1306: "Cannot find NAME section");
1.50 kristaps 1307: fclose(stream);
1308: free(title);
1309: return;
1310: }
1.1 kristaps 1311:
1.209 schwarze 1312: title[titlesz - 1] = '\0';
1.33 schwarze 1313:
1.50 kristaps 1314: /*
1315: * Skip to the first dash.
1316: * Use the remaining line as the description (no more than 70
1317: * bytes).
1318: */
1.33 schwarze 1319:
1.50 kristaps 1320: if (NULL != (p = strstr(title, "- "))) {
1321: for (p += 2; ' ' == *p || '\b' == *p; p++)
1322: /* Skip to next word. */ ;
1323: } else {
1.56 schwarze 1324: if (warnings)
1.82 schwarze 1325: say(mpage->mlinks->file,
1326: "No dash in title line");
1.50 kristaps 1327: p = title;
1328: }
1.38 schwarze 1329:
1.50 kristaps 1330: plen = strlen(p);
1.1 kristaps 1331:
1.50 kristaps 1332: /* Strip backspace-encoding from line. */
1.1 kristaps 1333:
1.50 kristaps 1334: while (NULL != (line = memchr(p, '\b', plen))) {
1335: len = line - p;
1336: if (0 == len) {
1337: memmove(line, line + 1, plen--);
1338: continue;
1.141 schwarze 1339: }
1.50 kristaps 1340: memmove(line - 1, line + 1, plen - len);
1341: plen -= 2;
1342: }
1.1 kristaps 1343:
1.78 schwarze 1344: mpage->desc = mandoc_strdup(p);
1.50 kristaps 1345: fclose(stream);
1346: free(title);
1347: }
1.1 kristaps 1348:
1.50 kristaps 1349: /*
1350: * Put a type/word pair into the word database for this particular file.
1351: */
1352: static void
1.112 schwarze 1353: putkey(const struct mpage *mpage, char *value, uint64_t type)
1.50 kristaps 1354: {
1.78 schwarze 1355: putkeys(mpage, value, strlen(value), type);
1.3 kristaps 1356: }
1357:
1358: /*
1.50 kristaps 1359: * Grok all nodes at or below a certain mdoc node into putkey().
1.3 kristaps 1360: */
1361: static void
1.78 schwarze 1362: putmdockey(const struct mpage *mpage,
1.235 ! schwarze 1363: const struct roff_node *n, uint64_t m, int taboo)
1.3 kristaps 1364: {
1.18 kristaps 1365:
1.50 kristaps 1366: for ( ; NULL != n; n = n->next) {
1.235 ! schwarze 1367: if (n->flags & taboo)
! 1368: continue;
1.50 kristaps 1369: if (NULL != n->child)
1.235 ! schwarze 1370: putmdockey(mpage, n->child, m, taboo);
1.188 schwarze 1371: if (n->type == ROFFT_TEXT)
1.78 schwarze 1372: putkey(mpage, n->string, m);
1.50 kristaps 1373: }
1374: }
1.18 kristaps 1375:
1.61 schwarze 1376: static void
1.190 schwarze 1377: parse_man(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1378: const struct roff_node *n)
1.50 kristaps 1379: {
1.189 schwarze 1380: const struct roff_node *head, *body;
1.121 schwarze 1381: char *start, *title;
1.50 kristaps 1382: char byte;
1.121 schwarze 1383: size_t sz;
1.18 kristaps 1384:
1.215 schwarze 1385: if (n == NULL)
1.61 schwarze 1386: return;
1.18 kristaps 1387:
1.50 kristaps 1388: /*
1389: * We're only searching for one thing: the first text child in
1390: * the BODY of a NAME section. Since we don't keep track of
1391: * sections in -man, run some hoops to find out whether we're in
1392: * the correct section or not.
1393: */
1.18 kristaps 1394:
1.188 schwarze 1395: if (n->type == ROFFT_BODY && n->tok == MAN_SH) {
1.50 kristaps 1396: body = n;
1.215 schwarze 1397: if ((head = body->parent->head) != NULL &&
1398: (head = head->child) != NULL &&
1399: head->next == NULL &&
1.188 schwarze 1400: head->type == ROFFT_TEXT &&
1.215 schwarze 1401: strcmp(head->string, "NAME") == 0 &&
1402: body->child != NULL) {
1.3 kristaps 1403:
1.50 kristaps 1404: /*
1405: * Suck the entire NAME section into memory.
1406: * Yes, we might run away.
1407: * But too many manuals have big, spread-out
1408: * NAME sections over many lines.
1409: */
1.3 kristaps 1410:
1.121 schwarze 1411: title = NULL;
1.194 schwarze 1412: deroff(&title, body);
1.50 kristaps 1413: if (NULL == title)
1.61 schwarze 1414: return;
1.18 kristaps 1415:
1.141 schwarze 1416: /*
1.50 kristaps 1417: * Go through a special heuristic dance here.
1418: * Conventionally, one or more manual names are
1419: * comma-specified prior to a whitespace, then a
1420: * dash, then a description. Try to puzzle out
1421: * the name parts here.
1422: */
1.18 kristaps 1423:
1.121 schwarze 1424: start = title;
1.50 kristaps 1425: for ( ;; ) {
1426: sz = strcspn(start, " ,");
1427: if ('\0' == start[sz])
1428: break;
1.1 kristaps 1429:
1.50 kristaps 1430: byte = start[sz];
1431: start[sz] = '\0';
1.110 schwarze 1432:
1433: /*
1434: * Assume a stray trailing comma in the
1435: * name list if a name begins with a dash.
1436: */
1437:
1438: if ('-' == start[0] ||
1439: ('\\' == start[0] && '-' == start[1]))
1440: break;
1.1 kristaps 1441:
1.133 schwarze 1442: putkey(mpage, start, NAME_TITLE);
1.174 schwarze 1443: if ( ! (mpage->name_head_done ||
1444: strcasecmp(start, meta->title))) {
1445: putkey(mpage, start, NAME_HEAD);
1446: mpage->name_head_done = 1;
1447: }
1.1 kristaps 1448:
1.50 kristaps 1449: if (' ' == byte) {
1450: start += sz + 1;
1451: break;
1452: }
1.1 kristaps 1453:
1.50 kristaps 1454: assert(',' == byte);
1455: start += sz + 1;
1456: while (' ' == *start)
1457: start++;
1458: }
1.1 kristaps 1459:
1.121 schwarze 1460: if (start == title) {
1.133 schwarze 1461: putkey(mpage, start, NAME_TITLE);
1.174 schwarze 1462: if ( ! (mpage->name_head_done ||
1463: strcasecmp(start, meta->title))) {
1464: putkey(mpage, start, NAME_HEAD);
1465: mpage->name_head_done = 1;
1466: }
1.50 kristaps 1467: free(title);
1.61 schwarze 1468: return;
1.50 kristaps 1469: }
1.1 kristaps 1470:
1.50 kristaps 1471: while (isspace((unsigned char)*start))
1472: start++;
1.1 kristaps 1473:
1.50 kristaps 1474: if (0 == strncmp(start, "-", 1))
1475: start += 1;
1476: else if (0 == strncmp(start, "\\-\\-", 4))
1477: start += 4;
1478: else if (0 == strncmp(start, "\\-", 2))
1479: start += 2;
1480: else if (0 == strncmp(start, "\\(en", 4))
1481: start += 4;
1482: else if (0 == strncmp(start, "\\(em", 4))
1483: start += 4;
1.1 kristaps 1484:
1.50 kristaps 1485: while (' ' == *start)
1486: start++;
1.1 kristaps 1487:
1.78 schwarze 1488: mpage->desc = mandoc_strdup(start);
1.50 kristaps 1489: free(title);
1.61 schwarze 1490: return;
1.50 kristaps 1491: }
1492: }
1.1 kristaps 1493:
1.77 schwarze 1494: for (n = n->child; n; n = n->next) {
1.78 schwarze 1495: if (NULL != mpage->desc)
1.77 schwarze 1496: break;
1.174 schwarze 1497: parse_man(mpage, meta, n);
1.77 schwarze 1498: }
1.1 kristaps 1499: }
1500:
1501: static void
1.190 schwarze 1502: parse_mdoc(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1503: const struct roff_node *n)
1.1 kristaps 1504: {
1505:
1.50 kristaps 1506: assert(NULL != n);
1507: for (n = n->child; NULL != n; n = n->next) {
1.235 ! schwarze 1508: if (n->flags & mdocs[n->tok].taboo)
! 1509: continue;
1.50 kristaps 1510: switch (n->type) {
1.188 schwarze 1511: case ROFFT_ELEM:
1512: case ROFFT_BLOCK:
1513: case ROFFT_HEAD:
1514: case ROFFT_BODY:
1515: case ROFFT_TAIL:
1.50 kristaps 1516: if (NULL != mdocs[n->tok].fp)
1.172 schwarze 1517: if (0 == (*mdocs[n->tok].fp)(mpage, meta, n))
1.50 kristaps 1518: break;
1.68 schwarze 1519: if (mdocs[n->tok].mask)
1.78 schwarze 1520: putmdockey(mpage, n->child,
1.235 ! schwarze 1521: mdocs[n->tok].mask, mdocs[n->tok].taboo);
1.50 kristaps 1522: break;
1523: default:
1.188 schwarze 1524: assert(n->type != ROFFT_ROOT);
1.50 kristaps 1525: continue;
1526: }
1527: if (NULL != n->child)
1.172 schwarze 1528: parse_mdoc(mpage, meta, n);
1.1 kristaps 1529: }
1530: }
1531:
1.25 schwarze 1532: static int
1.190 schwarze 1533: parse_mdoc_Fd(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1534: const struct roff_node *n)
1.1 kristaps 1535: {
1.176 schwarze 1536: char *start, *end;
1.1 kristaps 1537: size_t sz;
1.25 schwarze 1538:
1.50 kristaps 1539: if (SEC_SYNOPSIS != n->sec ||
1.141 schwarze 1540: NULL == (n = n->child) ||
1.188 schwarze 1541: n->type != ROFFT_TEXT)
1.197 schwarze 1542: return 0;
1.1 kristaps 1543:
1544: /*
1545: * Only consider those `Fd' macro fields that begin with an
1546: * "inclusion" token (versus, e.g., #define).
1547: */
1.50 kristaps 1548:
1.1 kristaps 1549: if (strcmp("#include", n->string))
1.197 schwarze 1550: return 0;
1.1 kristaps 1551:
1.188 schwarze 1552: if ((n = n->next) == NULL || n->type != ROFFT_TEXT)
1.197 schwarze 1553: return 0;
1.1 kristaps 1554:
1555: /*
1556: * Strip away the enclosing angle brackets and make sure we're
1557: * not zero-length.
1558: */
1559:
1560: start = n->string;
1561: if ('<' == *start || '"' == *start)
1562: start++;
1563:
1564: if (0 == (sz = strlen(start)))
1.197 schwarze 1565: return 0;
1.1 kristaps 1566:
1567: end = &start[(int)sz - 1];
1568: if ('>' == *end || '"' == *end)
1569: end--;
1570:
1.50 kristaps 1571: if (end > start)
1.78 schwarze 1572: putkeys(mpage, start, end - start + 1, TYPE_In);
1.197 schwarze 1573: return 0;
1.1 kristaps 1574: }
1575:
1.178 schwarze 1576: static void
1.189 schwarze 1577: parse_mdoc_fname(struct mpage *mpage, const struct roff_node *n)
1.1 kristaps 1578: {
1.112 schwarze 1579: char *cp;
1.178 schwarze 1580: size_t sz;
1.1 kristaps 1581:
1.188 schwarze 1582: if (n->type != ROFFT_TEXT)
1.178 schwarze 1583: return;
1.25 schwarze 1584:
1.178 schwarze 1585: /* Skip function pointer punctuation. */
1.1 kristaps 1586:
1.178 schwarze 1587: cp = n->string;
1588: while (*cp == '(' || *cp == '*')
1.1 kristaps 1589: cp++;
1.178 schwarze 1590: sz = strcspn(cp, "()");
1.1 kristaps 1591:
1.178 schwarze 1592: putkeys(mpage, cp, sz, TYPE_Fn);
1.173 schwarze 1593: if (n->sec == SEC_SYNOPSIS)
1.178 schwarze 1594: putkeys(mpage, cp, sz, NAME_SYN);
1595: }
1.25 schwarze 1596:
1.178 schwarze 1597: static int
1.190 schwarze 1598: parse_mdoc_Fn(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1599: const struct roff_node *n)
1.178 schwarze 1600: {
1601:
1602: if (n->child == NULL)
1.197 schwarze 1603: return 0;
1.178 schwarze 1604:
1605: parse_mdoc_fname(mpage, n->child);
1.25 schwarze 1606:
1.178 schwarze 1607: for (n = n->child->next; n != NULL; n = n->next)
1.188 schwarze 1608: if (n->type == ROFFT_TEXT)
1.78 schwarze 1609: putkey(mpage, n->string, TYPE_Fa);
1.25 schwarze 1610:
1.197 schwarze 1611: return 0;
1.173 schwarze 1612: }
1613:
1614: static int
1.190 schwarze 1615: parse_mdoc_Fo(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1616: const struct roff_node *n)
1.173 schwarze 1617: {
1.177 schwarze 1618:
1.188 schwarze 1619: if (n->type != ROFFT_HEAD)
1.197 schwarze 1620: return 1;
1.173 schwarze 1621:
1.178 schwarze 1622: if (n->child != NULL)
1623: parse_mdoc_fname(mpage, n->child);
1624:
1.197 schwarze 1625: return 0;
1.1 kristaps 1626: }
1627:
1.25 schwarze 1628: static int
1.211 schwarze 1629: parse_mdoc_Va(struct mpage *mpage, const struct roff_meta *meta,
1630: const struct roff_node *n)
1631: {
1632: char *cp;
1633:
1634: if (n->type != ROFFT_ELEM && n->type != ROFFT_BODY)
1635: return 0;
1636:
1.215 schwarze 1637: if (n->child != NULL &&
1638: n->child->next == NULL &&
1639: n->child->type == ROFFT_TEXT)
1.211 schwarze 1640: return 1;
1641:
1642: cp = NULL;
1643: deroff(&cp, n);
1644: if (cp != NULL) {
1645: putkey(mpage, cp, TYPE_Vt | (n->tok == MDOC_Va ||
1646: n->type == ROFFT_BODY ? TYPE_Va : 0));
1647: free(cp);
1648: }
1649:
1650: return 0;
1651: }
1652:
1653: static int
1.190 schwarze 1654: parse_mdoc_Xr(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1655: const struct roff_node *n)
1.1 kristaps 1656: {
1.67 schwarze 1657: char *cp;
1.1 kristaps 1658:
1659: if (NULL == (n = n->child))
1.197 schwarze 1660: return 0;
1.1 kristaps 1661:
1.67 schwarze 1662: if (NULL == n->next) {
1.78 schwarze 1663: putkey(mpage, n->string, TYPE_Xr);
1.197 schwarze 1664: return 0;
1.67 schwarze 1665: }
1666:
1.120 schwarze 1667: mandoc_asprintf(&cp, "%s(%s)", n->string, n->next->string);
1.78 schwarze 1668: putkey(mpage, cp, TYPE_Xr);
1.67 schwarze 1669: free(cp);
1.197 schwarze 1670: return 0;
1.1 kristaps 1671: }
1672:
1.25 schwarze 1673: static int
1.190 schwarze 1674: parse_mdoc_Nd(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1675: const struct roff_node *n)
1.1 kristaps 1676: {
1677:
1.188 schwarze 1678: if (n->type == ROFFT_BODY)
1.194 schwarze 1679: deroff(&mpage->desc, n);
1.197 schwarze 1680: return 0;
1.1 kristaps 1681: }
1682:
1.25 schwarze 1683: static int
1.190 schwarze 1684: parse_mdoc_Nm(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1685: const struct roff_node *n)
1.1 kristaps 1686: {
1687:
1.129 schwarze 1688: if (SEC_NAME == n->sec)
1.235 ! schwarze 1689: putmdockey(mpage, n->child, NAME_TITLE, 0);
1.188 schwarze 1690: else if (n->sec == SEC_SYNOPSIS && n->type == ROFFT_HEAD) {
1.172 schwarze 1691: if (n->child == NULL)
1692: putkey(mpage, meta->name, NAME_SYN);
1693: else
1.235 ! schwarze 1694: putmdockey(mpage, n->child, NAME_SYN, 0);
1.174 schwarze 1695: }
1696: if ( ! (mpage->name_head_done ||
1697: n->child == NULL || n->child->string == NULL ||
1698: strcasecmp(n->child->string, meta->title))) {
1.226 schwarze 1699: putkey(mpage, n->child->string, NAME_HEAD);
1.174 schwarze 1700: mpage->name_head_done = 1;
1.172 schwarze 1701: }
1.197 schwarze 1702: return 0;
1.1 kristaps 1703: }
1704:
1.25 schwarze 1705: static int
1.190 schwarze 1706: parse_mdoc_Sh(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1707: const struct roff_node *n)
1.1 kristaps 1708: {
1709:
1.197 schwarze 1710: return n->sec == SEC_CUSTOM && n->type == ROFFT_HEAD;
1.1 kristaps 1711: }
1712:
1.50 kristaps 1713: static int
1.190 schwarze 1714: parse_mdoc_head(struct mpage *mpage, const struct roff_meta *meta,
1.189 schwarze 1715: const struct roff_node *n)
1.1 kristaps 1716: {
1717:
1.197 schwarze 1718: return n->type == ROFFT_HEAD;
1.1 kristaps 1719: }
1720:
1.50 kristaps 1721: /*
1.66 schwarze 1722: * Add a string to the hash table for the current manual.
1723: * Each string has a bitmask telling which macros it belongs to.
1724: * When we finish the manual, we'll dump the table.
1.50 kristaps 1725: */
1726: static void
1.176 schwarze 1727: putkeys(const struct mpage *mpage, char *cp, size_t sz, uint64_t v)
1.50 kristaps 1728: {
1.133 schwarze 1729: struct ohash *htab;
1.50 kristaps 1730: struct str *s;
1.111 schwarze 1731: const char *end;
1.65 schwarze 1732: unsigned int slot;
1.176 schwarze 1733: int i, mustfree;
1.25 schwarze 1734:
1.50 kristaps 1735: if (0 == sz)
1736: return;
1.111 schwarze 1737:
1.176 schwarze 1738: mustfree = render_string(&cp, &sz);
1739:
1.133 schwarze 1740: if (TYPE_Nm & v) {
1741: htab = &names;
1742: v &= name_mask;
1.169 schwarze 1743: if (v & NAME_FIRST)
1744: name_mask &= ~NAME_FIRST;
1.133 schwarze 1745: if (debug > 1)
1746: say(mpage->mlinks->file,
1.234 schwarze 1747: "Adding name %*s, bits=0x%llx", (int)sz, cp,
1748: (unsigned long long)v);
1.133 schwarze 1749: } else {
1750: htab = &strings;
1751: if (debug > 1)
1.221 schwarze 1752: for (i = 0; i < KEY_MAX; i++)
1.163 schwarze 1753: if ((uint64_t)1 << i & v)
1.133 schwarze 1754: say(mpage->mlinks->file,
1755: "Adding key %s=%*s",
1.220 schwarze 1756: mansearch_keynames[i], (int)sz, cp);
1.111 schwarze 1757: }
1.25 schwarze 1758:
1.65 schwarze 1759: end = cp + sz;
1.133 schwarze 1760: slot = ohash_qlookupi(htab, cp, &end);
1761: s = ohash_find(htab, slot);
1.25 schwarze 1762:
1.78 schwarze 1763: if (NULL != s && mpage == s->mpage) {
1.50 kristaps 1764: s->mask |= v;
1765: return;
1766: } else if (NULL == s) {
1.144 schwarze 1767: s = mandoc_calloc(1, sizeof(struct str) + sz + 1);
1.50 kristaps 1768: memcpy(s->key, cp, sz);
1.133 schwarze 1769: ohash_insert(htab, slot, s);
1.1 kristaps 1770: }
1.78 schwarze 1771: s->mpage = mpage;
1.50 kristaps 1772: s->mask = v;
1.176 schwarze 1773:
1774: if (mustfree)
1775: free(cp);
1.1 kristaps 1776: }
1777:
1.50 kristaps 1778: /*
1779: * Take a Unicode codepoint and produce its UTF-8 encoding.
1780: * This isn't the best way to do this, but it works.
1781: * The magic numbers are from the UTF-8 packaging.
1782: * They're not as scary as they seem: read the UTF-8 spec for details.
1783: */
1784: static size_t
1785: utf8(unsigned int cp, char out[7])
1.1 kristaps 1786: {
1.50 kristaps 1787: size_t rc;
1.1 kristaps 1788:
1.50 kristaps 1789: rc = 0;
1790: if (cp <= 0x0000007F) {
1791: rc = 1;
1792: out[0] = (char)cp;
1793: } else if (cp <= 0x000007FF) {
1794: rc = 2;
1795: out[0] = (cp >> 6 & 31) | 192;
1796: out[1] = (cp & 63) | 128;
1797: } else if (cp <= 0x0000FFFF) {
1798: rc = 3;
1799: out[0] = (cp >> 12 & 15) | 224;
1800: out[1] = (cp >> 6 & 63) | 128;
1801: out[2] = (cp & 63) | 128;
1802: } else if (cp <= 0x001FFFFF) {
1803: rc = 4;
1804: out[0] = (cp >> 18 & 7) | 240;
1805: out[1] = (cp >> 12 & 63) | 128;
1806: out[2] = (cp >> 6 & 63) | 128;
1807: out[3] = (cp & 63) | 128;
1808: } else if (cp <= 0x03FFFFFF) {
1809: rc = 5;
1810: out[0] = (cp >> 24 & 3) | 248;
1811: out[1] = (cp >> 18 & 63) | 128;
1812: out[2] = (cp >> 12 & 63) | 128;
1813: out[3] = (cp >> 6 & 63) | 128;
1814: out[4] = (cp & 63) | 128;
1815: } else if (cp <= 0x7FFFFFFF) {
1816: rc = 6;
1817: out[0] = (cp >> 30 & 1) | 252;
1818: out[1] = (cp >> 24 & 63) | 128;
1819: out[2] = (cp >> 18 & 63) | 128;
1820: out[3] = (cp >> 12 & 63) | 128;
1821: out[4] = (cp >> 6 & 63) | 128;
1822: out[5] = (cp & 63) | 128;
1823: } else
1.197 schwarze 1824: return 0;
1.1 kristaps 1825:
1.50 kristaps 1826: out[rc] = '\0';
1.197 schwarze 1827: return rc;
1.50 kristaps 1828: }
1.1 kristaps 1829:
1.50 kristaps 1830: /*
1.176 schwarze 1831: * If the string contains escape sequences,
1832: * replace it with an allocated rendering and return 1,
1833: * such that the caller can free it after use.
1834: * Otherwise, do nothing and return 0.
1.50 kristaps 1835: */
1.176 schwarze 1836: static int
1837: render_string(char **public, size_t *psz)
1.50 kristaps 1838: {
1.176 schwarze 1839: const char *src, *scp, *addcp, *seq;
1840: char *dst;
1841: size_t ssz, dsz, addsz;
1.114 schwarze 1842: char utfbuf[7], res[6];
1.176 schwarze 1843: int seqlen, unicode;
1.50 kristaps 1844:
1845: res[0] = '\\';
1846: res[1] = '\t';
1847: res[2] = ASCII_NBRSP;
1848: res[3] = ASCII_HYPH;
1.114 schwarze 1849: res[4] = ASCII_BREAK;
1850: res[5] = '\0';
1.1 kristaps 1851:
1.176 schwarze 1852: src = scp = *public;
1853: ssz = *psz;
1854: dst = NULL;
1855: dsz = 0;
1856:
1857: while (scp < src + *psz) {
1858:
1859: /* Leave normal characters unchanged. */
1860:
1861: if (strchr(res, *scp) == NULL) {
1862: if (dst != NULL)
1863: dst[dsz++] = *scp;
1864: scp++;
1865: continue;
1866: }
1.46 kristaps 1867:
1.50 kristaps 1868: /*
1.176 schwarze 1869: * Found something that requires replacing,
1870: * make sure we have a destination buffer.
1.50 kristaps 1871: */
1.176 schwarze 1872:
1873: if (dst == NULL) {
1874: dst = mandoc_malloc(ssz + 1);
1875: dsz = scp - src;
1876: memcpy(dst, src, dsz);
1.50 kristaps 1877: }
1.46 kristaps 1878:
1.176 schwarze 1879: /* Handle single-char special characters. */
1880:
1881: switch (*scp) {
1882: case '\\':
1883: break;
1.141 schwarze 1884: case '\t':
1885: case ASCII_NBRSP:
1.176 schwarze 1886: dst[dsz++] = ' ';
1887: scp++;
1888: continue;
1889: case ASCII_HYPH:
1890: dst[dsz++] = '-';
1.114 schwarze 1891: /* FALLTHROUGH */
1.141 schwarze 1892: case ASCII_BREAK:
1.176 schwarze 1893: scp++;
1.50 kristaps 1894: continue;
1.114 schwarze 1895: default:
1.176 schwarze 1896: abort();
1.114 schwarze 1897: }
1.46 kristaps 1898:
1.50 kristaps 1899: /*
1.176 schwarze 1900: * Found an escape sequence.
1901: * Read past the slash, then parse it.
1902: * Ignore everything except characters.
1.50 kristaps 1903: */
1.95 schwarze 1904:
1.176 schwarze 1905: scp++;
1906: if (mandoc_escape(&scp, &seq, &seqlen) != ESCAPE_SPECIAL)
1.50 kristaps 1907: continue;
1.1 kristaps 1908:
1.50 kristaps 1909: /*
1.95 schwarze 1910: * Render the special character
1911: * as either UTF-8 or ASCII.
1.50 kristaps 1912: */
1.95 schwarze 1913:
1914: if (write_utf8) {
1.203 schwarze 1915: unicode = mchars_spec2cp(seq, seqlen);
1.176 schwarze 1916: if (unicode <= 0)
1.95 schwarze 1917: continue;
1.176 schwarze 1918: addsz = utf8(unicode, utfbuf);
1919: if (addsz == 0)
1.95 schwarze 1920: continue;
1.176 schwarze 1921: addcp = utfbuf;
1.95 schwarze 1922: } else {
1.203 schwarze 1923: addcp = mchars_spec2str(seq, seqlen, &addsz);
1.176 schwarze 1924: if (addcp == NULL)
1.95 schwarze 1925: continue;
1.176 schwarze 1926: if (*addcp == ASCII_NBRSP) {
1927: addcp = " ";
1928: addsz = 1;
1.95 schwarze 1929: }
1930: }
1.1 kristaps 1931:
1.50 kristaps 1932: /* Copy the rendered glyph into the stream. */
1.1 kristaps 1933:
1.176 schwarze 1934: ssz += addsz;
1935: dst = mandoc_realloc(dst, ssz + 1);
1936: memcpy(dst + dsz, addcp, addsz);
1937: dsz += addsz;
1938: }
1939: if (dst != NULL) {
1940: *public = dst;
1941: *psz = dsz;
1942: }
1943:
1944: /* Trim trailing whitespace and NUL-terminate. */
1945:
1946: while (*psz > 0 && (*public)[*psz - 1] == ' ')
1947: --*psz;
1948: if (dst != NULL) {
1949: (*public)[*psz] = '\0';
1.197 schwarze 1950: return 1;
1.176 schwarze 1951: } else
1.197 schwarze 1952: return 0;
1.1 kristaps 1953: }
1954:
1.118 schwarze 1955: static void
1956: dbadd_mlink(const struct mlink *mlink)
1957: {
1.221 schwarze 1958: dba_page_alias(mlink->mpage->dba, mlink->name, NAME_FILE);
1959: dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->dsec);
1.223 schwarze 1960: dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->fsec);
1.221 schwarze 1961: dba_page_add(mlink->mpage->dba, DBP_ARCH, mlink->arch);
1962: dba_page_add(mlink->mpage->dba, DBP_FILE, mlink->file);
1.118 schwarze 1963: }
1964:
1.14 schwarze 1965: /*
1.50 kristaps 1966: * Flush the current page's terms (and their bits) into the database.
1.96 schwarze 1967: * Also, handle escape sequences at the last possible moment.
1.14 schwarze 1968: */
1969: static void
1.221 schwarze 1970: dbadd(struct dba *dba, struct mpage *mpage)
1.14 schwarze 1971: {
1.87 schwarze 1972: struct mlink *mlink;
1.50 kristaps 1973: struct str *key;
1.176 schwarze 1974: char *cp;
1.221 schwarze 1975: uint64_t mask;
1.52 kristaps 1976: size_t i;
1.66 schwarze 1977: unsigned int slot;
1.176 schwarze 1978: int mustfree;
1.14 schwarze 1979:
1.128 schwarze 1980: mlink = mpage->mlinks;
1.43 kristaps 1981:
1.128 schwarze 1982: if (nodb) {
1.147 schwarze 1983: for (key = ohash_first(&names, &slot); NULL != key;
1.176 schwarze 1984: key = ohash_next(&names, &slot))
1.147 schwarze 1985: free(key);
1986: for (key = ohash_first(&strings, &slot); NULL != key;
1.176 schwarze 1987: key = ohash_next(&strings, &slot))
1.147 schwarze 1988: free(key);
1.145 schwarze 1989: if (0 == debug)
1990: return;
1.128 schwarze 1991: while (NULL != mlink) {
1992: fputs(mlink->name, stdout);
1993: if (NULL == mlink->next ||
1994: strcmp(mlink->dsec, mlink->next->dsec) ||
1995: strcmp(mlink->fsec, mlink->next->fsec) ||
1996: strcmp(mlink->arch, mlink->next->arch)) {
1997: putchar('(');
1998: if ('\0' == *mlink->dsec)
1999: fputs(mlink->fsec, stdout);
2000: else
2001: fputs(mlink->dsec, stdout);
2002: if ('\0' != *mlink->arch)
2003: printf("/%s", mlink->arch);
2004: putchar(')');
2005: }
2006: mlink = mlink->next;
2007: if (NULL != mlink)
2008: fputs(", ", stdout);
2009: }
1.132 schwarze 2010: printf(" - %s\n", mpage->desc);
1.14 schwarze 2011: return;
1.128 schwarze 2012: }
2013:
2014: if (debug)
2015: say(mlink->file, "Adding to database");
1.28 kristaps 2016:
1.176 schwarze 2017: cp = mpage->desc;
2018: i = strlen(cp);
2019: mustfree = render_string(&cp, &i);
1.227 schwarze 2020: mpage->dba = dba_page_new(dba->pages,
1.223 schwarze 2021: *mpage->arch == '\0' ? mlink->arch : mpage->arch,
2022: cp, mlink->file, mpage->form);
1.176 schwarze 2023: if (mustfree)
2024: free(cp);
1.227 schwarze 2025: dba_page_add(mpage->dba, DBP_SECT, mpage->sec);
1.81 schwarze 2026:
1.223 schwarze 2027: while (mlink != NULL) {
1.118 schwarze 2028: dbadd_mlink(mlink);
1.223 schwarze 2029: mlink = mlink->next;
2030: }
1.50 kristaps 2031:
1.133 schwarze 2032: for (key = ohash_first(&names, &slot); NULL != key;
2033: key = ohash_next(&names, &slot)) {
2034: assert(key->mpage == mpage);
1.221 schwarze 2035: dba_page_alias(mpage->dba, key->key, key->mask);
1.133 schwarze 2036: free(key);
2037: }
1.66 schwarze 2038: for (key = ohash_first(&strings, &slot); NULL != key;
2039: key = ohash_next(&strings, &slot)) {
1.78 schwarze 2040: assert(key->mpage == mpage);
1.221 schwarze 2041: i = 0;
2042: for (mask = TYPE_Xr; mask <= TYPE_Lb; mask *= 2) {
2043: if (key->mask & mask)
2044: dba_macro_add(dba->macros, i,
2045: key->key, mpage->dba);
2046: i++;
2047: }
1.66 schwarze 2048: free(key);
1.38 schwarze 2049: }
1.14 schwarze 2050: }
2051:
1.5 kristaps 2052: static void
1.221 schwarze 2053: dbprune(struct dba *dba)
1.5 kristaps 2054: {
1.221 schwarze 2055: struct dba_array *page, *files;
2056: char *file;
1.5 kristaps 2057:
1.221 schwarze 2058: dba_array_FOREACH(dba->pages, page) {
2059: files = dba_array_get(page, DBP_FILE);
2060: dba_array_FOREACH(files, file) {
2061: if (*file < ' ')
2062: file++;
2063: if (ohash_find(&mlinks, ohash_qlookup(&mlinks,
2064: file)) != NULL) {
2065: if (debug)
2066: say(file, "Deleting from database");
2067: dba_array_del(dba->pages);
2068: break;
2069: }
1.106 schwarze 2070: }
1.5 kristaps 2071: }
2072: }
2073:
1.4 kristaps 2074: /*
1.221 schwarze 2075: * Write the database from memory to disk.
1.4 kristaps 2076: */
1.35 kristaps 2077: static void
1.221 schwarze 2078: dbwrite(struct dba *dba)
1.4 kristaps 2079: {
1.221 schwarze 2080: char tfn[32];
1.115 schwarze 2081: int status;
2082: pid_t child;
1.4 kristaps 2083:
1.221 schwarze 2084: if (dba_write(MANDOC_DB "~", dba) != -1) {
2085: if (rename(MANDOC_DB "~", MANDOC_DB) == -1) {
2086: exitcode = (int)MANDOCLEVEL_SYSERR;
2087: say(MANDOC_DB, "&rename");
2088: unlink(MANDOC_DB "~");
2089: }
1.38 schwarze 2090: return;
1.4 kristaps 2091: }
2092:
1.221 schwarze 2093: (void)strlcpy(tfn, "/tmp/mandocdb.XXXXXXXX", sizeof(tfn));
2094: if (mkdtemp(tfn) == NULL) {
2095: exitcode = (int)MANDOCLEVEL_SYSERR;
2096: say("", "&%s", tfn);
1.50 kristaps 2097: return;
1.221 schwarze 2098: }
1.12 schwarze 2099:
1.221 schwarze 2100: (void)strlcat(tfn, "/" MANDOC_DB, sizeof(tfn));
2101: if (dba_write(tfn, dba) == -1) {
2102: exitcode = (int)MANDOCLEVEL_SYSERR;
2103: say(tfn, "&dba_write");
2104: goto out;
1.115 schwarze 2105: }
2106:
2107: switch (child = fork()) {
1.141 schwarze 2108: case -1:
1.115 schwarze 2109: exitcode = (int)MANDOCLEVEL_SYSERR;
1.123 schwarze 2110: say("", "&fork cmp");
1.115 schwarze 2111: return;
1.141 schwarze 2112: case 0:
1.221 schwarze 2113: execlp("cmp", "cmp", "-s", tfn, MANDOC_DB, (char *)NULL);
1.123 schwarze 2114: say("", "&exec cmp");
1.115 schwarze 2115: exit(0);
2116: default:
2117: break;
2118: }
1.221 schwarze 2119: if (waitpid(child, &status, 0) == -1) {
1.115 schwarze 2120: exitcode = (int)MANDOCLEVEL_SYSERR;
1.123 schwarze 2121: say("", "&wait cmp");
1.115 schwarze 2122: } else if (WIFSIGNALED(status)) {
2123: exitcode = (int)MANDOCLEVEL_SYSERR;
1.123 schwarze 2124: say("", "cmp died from signal %d", WTERMSIG(status));
1.115 schwarze 2125: } else if (WEXITSTATUS(status)) {
1.59 schwarze 2126: exitcode = (int)MANDOCLEVEL_SYSERR;
1.115 schwarze 2127: say(MANDOC_DB,
2128: "Data changed, but cannot replace database");
2129: }
2130:
1.221 schwarze 2131: out:
2132: *strrchr(tfn, '/') = '\0';
1.115 schwarze 2133: switch (child = fork()) {
1.141 schwarze 2134: case -1:
1.115 schwarze 2135: exitcode = (int)MANDOCLEVEL_SYSERR;
1.123 schwarze 2136: say("", "&fork rm");
1.115 schwarze 2137: return;
1.141 schwarze 2138: case 0:
1.221 schwarze 2139: execlp("rm", "rm", "-rf", tfn, (char *)NULL);
1.123 schwarze 2140: say("", "&exec rm");
1.115 schwarze 2141: exit((int)MANDOCLEVEL_SYSERR);
2142: default:
2143: break;
2144: }
1.221 schwarze 2145: if (waitpid(child, &status, 0) == -1) {
1.115 schwarze 2146: exitcode = (int)MANDOCLEVEL_SYSERR;
1.123 schwarze 2147: say("", "&wait rm");
1.115 schwarze 2148: } else if (WIFSIGNALED(status) || WEXITSTATUS(status)) {
2149: exitcode = (int)MANDOCLEVEL_SYSERR;
1.221 schwarze 2150: say("", "%s: Cannot remove temporary directory", tfn);
1.146 schwarze 2151: }
1.4 kristaps 2152: }
2153:
1.50 kristaps 2154: static int
1.165 schwarze 2155: set_basedir(const char *targetdir, int report_baddir)
1.4 kristaps 2156: {
1.59 schwarze 2157: static char startdir[PATH_MAX];
1.151 schwarze 2158: static int getcwd_status; /* 1 = ok, 2 = failure */
2159: static int chdir_status; /* 1 = changed directory */
1.150 schwarze 2160: char *cp;
1.4 kristaps 2161:
1.59 schwarze 2162: /*
1.151 schwarze 2163: * Remember the original working directory, if possible.
2164: * This will be needed if the second or a later directory
2165: * on the command line is given as a relative path.
2166: * Do not error out if the current directory is not
2167: * searchable: Maybe it won't be needed after all.
2168: */
2169: if (0 == getcwd_status) {
2170: if (NULL == getcwd(startdir, sizeof(startdir))) {
2171: getcwd_status = 2;
2172: (void)strlcpy(startdir, strerror(errno),
2173: sizeof(startdir));
2174: } else
2175: getcwd_status = 1;
2176: }
2177:
2178: /*
2179: * We are leaving the old base directory.
2180: * Do not use it any longer, not even for messages.
2181: */
2182: *basedir = '\0';
2183:
2184: /*
2185: * If and only if the directory was changed earlier and
2186: * the next directory to process is given as a relative path,
2187: * first go back, or bail out if that is impossible.
1.59 schwarze 2188: */
1.151 schwarze 2189: if (chdir_status && '/' != *targetdir) {
2190: if (2 == getcwd_status) {
1.59 schwarze 2191: exitcode = (int)MANDOCLEVEL_SYSERR;
1.151 schwarze 2192: say("", "getcwd: %s", startdir);
1.197 schwarze 2193: return 0;
1.59 schwarze 2194: }
1.151 schwarze 2195: if (-1 == chdir(startdir)) {
1.59 schwarze 2196: exitcode = (int)MANDOCLEVEL_SYSERR;
1.123 schwarze 2197: say("", "&chdir %s", startdir);
1.197 schwarze 2198: return 0;
1.59 schwarze 2199: }
2200: }
1.151 schwarze 2201:
2202: /*
2203: * Always resolve basedir to the canonicalized absolute
2204: * pathname and append a trailing slash, such that
2205: * we can reliably check whether files are inside.
2206: */
1.59 schwarze 2207: if (NULL == realpath(targetdir, basedir)) {
1.165 schwarze 2208: if (report_baddir || errno != ENOENT) {
2209: exitcode = (int)MANDOCLEVEL_BADARG;
2210: say("", "&%s: realpath", targetdir);
2211: }
1.197 schwarze 2212: return 0;
1.59 schwarze 2213: } else if (-1 == chdir(basedir)) {
1.165 schwarze 2214: if (report_baddir || errno != ENOENT) {
2215: exitcode = (int)MANDOCLEVEL_BADARG;
2216: say("", "&chdir");
2217: }
1.197 schwarze 2218: return 0;
1.150 schwarze 2219: }
1.151 schwarze 2220: chdir_status = 1;
1.150 schwarze 2221: cp = strchr(basedir, '\0');
2222: if ('/' != cp[-1]) {
2223: if (cp - basedir >= PATH_MAX - 1) {
2224: exitcode = (int)MANDOCLEVEL_SYSERR;
2225: say("", "Filename too long");
1.197 schwarze 2226: return 0;
1.150 schwarze 2227: }
2228: *cp++ = '/';
2229: *cp = '\0';
1.4 kristaps 2230: }
1.197 schwarze 2231: return 1;
1.56 schwarze 2232: }
2233:
2234: static void
1.59 schwarze 2235: say(const char *file, const char *format, ...)
1.56 schwarze 2236: {
2237: va_list ap;
1.123 schwarze 2238: int use_errno;
1.56 schwarze 2239:
1.59 schwarze 2240: if ('\0' != *basedir)
2241: fprintf(stderr, "%s", basedir);
2242: if ('\0' != *basedir && '\0' != *file)
1.151 schwarze 2243: fputc('/', stderr);
1.56 schwarze 2244: if ('\0' != *file)
1.59 schwarze 2245: fprintf(stderr, "%s", file);
2246:
1.123 schwarze 2247: use_errno = 1;
2248: if (NULL != format) {
2249: switch (*format) {
1.141 schwarze 2250: case '&':
1.123 schwarze 2251: format++;
2252: break;
1.141 schwarze 2253: case '\0':
1.123 schwarze 2254: format = NULL;
2255: break;
2256: default:
2257: use_errno = 0;
2258: break;
2259: }
2260: }
2261: if (NULL != format) {
2262: if ('\0' != *basedir || '\0' != *file)
2263: fputs(": ", stderr);
2264: va_start(ap, format);
2265: vfprintf(stderr, format, ap);
2266: va_end(ap);
2267: }
2268: if (use_errno) {
2269: if ('\0' != *basedir || '\0' != *file || NULL != format)
2270: fputs(": ", stderr);
1.59 schwarze 2271: perror(NULL);
1.123 schwarze 2272: } else
2273: fputc('\n', stderr);
1.1 kristaps 2274: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mandocdb.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc