[BACK]Return to mandocdb.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/mandocdb.c, Revision 1.124

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