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