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