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