[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.94

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