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

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