1*99db7d0eSSascha Wildner /* $Id: mandocdb.c,v 1.269 2021/08/19 16:55:31 schwarze Exp $ */
236342e81SSascha Wildner /*
3*99db7d0eSSascha Wildner * Copyright (c) 2011-2020 Ingo Schwarze <schwarze@openbsd.org>
4f88b6c16SFranco Fichtner * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
554ba9607SSascha Wildner * Copyright (c) 2016 Ed Maste <emaste@freebsd.org>
636342e81SSascha Wildner *
736342e81SSascha Wildner * Permission to use, copy, modify, and distribute this software for any
836342e81SSascha Wildner * purpose with or without fee is hereby granted, provided that the above
936342e81SSascha Wildner * copyright notice and this permission notice appear in all copies.
1036342e81SSascha Wildner *
1154ba9607SSascha Wildner * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1236342e81SSascha Wildner * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1354ba9607SSascha Wildner * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1436342e81SSascha Wildner * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1536342e81SSascha Wildner * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1636342e81SSascha Wildner * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1736342e81SSascha Wildner * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18*99db7d0eSSascha Wildner *
19*99db7d0eSSascha Wildner * Implementation of the makewhatis(8) program.
2036342e81SSascha Wildner */
2136342e81SSascha Wildner #include "config.h"
2236342e81SSascha Wildner
2354ba9607SSascha Wildner #include <sys/types.h>
2454ba9607SSascha Wildner #include <sys/mman.h>
25070c62a6SFranco Fichtner #include <sys/stat.h>
2636342e81SSascha Wildner
2736342e81SSascha Wildner #include <assert.h>
2836342e81SSascha Wildner #include <ctype.h>
2954ba9607SSascha Wildner #if HAVE_ERR
3054ba9607SSascha Wildner #include <err.h>
3154ba9607SSascha Wildner #endif
3236342e81SSascha Wildner #include <errno.h>
3336342e81SSascha Wildner #include <fcntl.h>
3454ba9607SSascha Wildner #if HAVE_FTS
35070c62a6SFranco Fichtner #include <fts.h>
3654ba9607SSascha Wildner #else
3754ba9607SSascha Wildner #include "compat_fts.h"
3854ba9607SSascha Wildner #endif
39f88b6c16SFranco Fichtner #include <limits.h>
4054ba9607SSascha Wildner #if HAVE_SANDBOX_INIT
4154ba9607SSascha Wildner #include <sandbox.h>
4254ba9607SSascha Wildner #endif
4354ba9607SSascha Wildner #include <stdarg.h>
44070c62a6SFranco Fichtner #include <stddef.h>
4536342e81SSascha Wildner #include <stdio.h>
4636342e81SSascha Wildner #include <stdint.h>
4736342e81SSascha Wildner #include <stdlib.h>
4836342e81SSascha Wildner #include <string.h>
4936342e81SSascha Wildner #include <unistd.h>
5036342e81SSascha Wildner
5154ba9607SSascha Wildner #include "mandoc_aux.h"
5254ba9607SSascha Wildner #include "mandoc_ohash.h"
5354ba9607SSascha Wildner #include "mandoc.h"
5454ba9607SSascha Wildner #include "roff.h"
5536342e81SSascha Wildner #include "mdoc.h"
56070c62a6SFranco Fichtner #include "man.h"
5754ba9607SSascha Wildner #include "mandoc_parse.h"
5854ba9607SSascha Wildner #include "manconf.h"
59070c62a6SFranco Fichtner #include "mansearch.h"
6054ba9607SSascha Wildner #include "dba_array.h"
6154ba9607SSascha Wildner #include "dba.h"
6236342e81SSascha Wildner
63070c62a6SFranco Fichtner extern const char *const mansearch_keynames[];
6436342e81SSascha Wildner
6536342e81SSascha Wildner enum op {
6636342e81SSascha Wildner OP_DEFAULT = 0, /* new dbs from dir list or default config */
6736342e81SSascha Wildner OP_CONFFILE, /* new databases from custom config file */
6836342e81SSascha Wildner OP_UPDATE, /* delete/add entries in existing database */
6936342e81SSascha Wildner OP_DELETE, /* delete entries from existing database */
7036342e81SSascha Wildner OP_TEST /* change no databases, report potential problems */
7136342e81SSascha Wildner };
7236342e81SSascha Wildner
73070c62a6SFranco Fichtner struct str {
74070c62a6SFranco Fichtner const struct mpage *mpage; /* if set, the owning parse */
75070c62a6SFranco Fichtner uint64_t mask; /* bitmask in sequence */
7654ba9607SSascha Wildner char key[]; /* rendered text */
77070c62a6SFranco Fichtner };
7836342e81SSascha Wildner
79070c62a6SFranco Fichtner struct inodev {
80070c62a6SFranco Fichtner ino_t st_ino;
81070c62a6SFranco Fichtner dev_t st_dev;
82070c62a6SFranco Fichtner };
83070c62a6SFranco Fichtner
84070c62a6SFranco Fichtner struct mpage {
85070c62a6SFranco Fichtner struct inodev inodev; /* used for hashing routine */
8654ba9607SSascha Wildner struct dba_array *dba;
87070c62a6SFranco Fichtner char *sec; /* section from file content */
88070c62a6SFranco Fichtner char *arch; /* architecture from file content */
89070c62a6SFranco Fichtner char *title; /* title from file content */
90070c62a6SFranco Fichtner char *desc; /* description from file content */
9154ba9607SSascha Wildner struct mpage *next; /* singly linked list */
92070c62a6SFranco Fichtner struct mlink *mlinks; /* singly linked list */
9354ba9607SSascha Wildner int name_head_done;
9454ba9607SSascha Wildner enum form form; /* format from file content */
95070c62a6SFranco Fichtner };
96070c62a6SFranco Fichtner
97070c62a6SFranco Fichtner struct mlink {
98070c62a6SFranco Fichtner char file[PATH_MAX]; /* filename rel. to manpath */
99070c62a6SFranco Fichtner char *dsec; /* section from directory */
100070c62a6SFranco Fichtner char *arch; /* architecture from directory */
101070c62a6SFranco Fichtner char *name; /* name from file name (not empty) */
102070c62a6SFranco Fichtner char *fsec; /* section from file name suffix */
103070c62a6SFranco Fichtner struct mlink *next; /* singly linked list */
104070c62a6SFranco Fichtner struct mpage *mpage; /* parent */
105070c62a6SFranco Fichtner int gzip; /* filename has a .gz suffix */
10654ba9607SSascha Wildner enum form dform; /* format from directory */
10754ba9607SSascha Wildner enum form fform; /* format from file name suffix */
108070c62a6SFranco Fichtner };
109070c62a6SFranco Fichtner
11054ba9607SSascha Wildner typedef int (*mdoc_fp)(struct mpage *, const struct roff_meta *,
11154ba9607SSascha Wildner const struct roff_node *);
11236342e81SSascha Wildner
11336342e81SSascha Wildner struct mdoc_handler {
114070c62a6SFranco Fichtner mdoc_fp fp; /* optional handler */
115070c62a6SFranco Fichtner uint64_t mask; /* set unless handler returns 0 */
11654ba9607SSascha Wildner int taboo; /* node flags that must not be set */
11736342e81SSascha Wildner };
11836342e81SSascha Wildner
11954ba9607SSascha Wildner
12054ba9607SSascha Wildner int mandocdb(int, char *[]);
12154ba9607SSascha Wildner
12254ba9607SSascha Wildner static void dbadd(struct dba *, struct mpage *);
123*99db7d0eSSascha Wildner static void dbadd_mlink(const struct mlink *);
12454ba9607SSascha Wildner static void dbprune(struct dba *);
12554ba9607SSascha Wildner static void dbwrite(struct dba *);
126070c62a6SFranco Fichtner static void filescan(const char *);
12754ba9607SSascha Wildner #if HAVE_FTS_COMPARE_CONST
12854ba9607SSascha Wildner static int fts_compare(const FTSENT *const *, const FTSENT *const *);
12954ba9607SSascha Wildner #else
13054ba9607SSascha Wildner static int fts_compare(const FTSENT **, const FTSENT **);
13154ba9607SSascha Wildner #endif
132070c62a6SFranco Fichtner static void mlink_add(struct mlink *, const struct stat *);
133070c62a6SFranco Fichtner static void mlink_check(struct mpage *, struct mlink *);
134070c62a6SFranco Fichtner static void mlink_free(struct mlink *);
135070c62a6SFranco Fichtner static void mlinks_undupe(struct mpage *);
136070c62a6SFranco Fichtner static void mpages_free(void);
13754ba9607SSascha Wildner static void mpages_merge(struct dba *, struct mparse *);
138070c62a6SFranco Fichtner static void parse_cat(struct mpage *, int);
13954ba9607SSascha Wildner static void parse_man(struct mpage *, const struct roff_meta *,
14054ba9607SSascha Wildner const struct roff_node *);
14154ba9607SSascha Wildner static void parse_mdoc(struct mpage *, const struct roff_meta *,
14254ba9607SSascha Wildner const struct roff_node *);
14354ba9607SSascha Wildner static int parse_mdoc_head(struct mpage *, const struct roff_meta *,
14454ba9607SSascha Wildner const struct roff_node *);
14554ba9607SSascha Wildner static int parse_mdoc_Fa(struct mpage *, const struct roff_meta *,
14654ba9607SSascha Wildner const struct roff_node *);
14754ba9607SSascha Wildner static int parse_mdoc_Fd(struct mpage *, const struct roff_meta *,
14854ba9607SSascha Wildner const struct roff_node *);
14954ba9607SSascha Wildner static void parse_mdoc_fname(struct mpage *, const struct roff_node *);
15054ba9607SSascha Wildner static int parse_mdoc_Fn(struct mpage *, const struct roff_meta *,
15154ba9607SSascha Wildner const struct roff_node *);
15254ba9607SSascha Wildner static int parse_mdoc_Fo(struct mpage *, const struct roff_meta *,
15354ba9607SSascha Wildner const struct roff_node *);
15454ba9607SSascha Wildner static int parse_mdoc_Nd(struct mpage *, const struct roff_meta *,
15554ba9607SSascha Wildner const struct roff_node *);
15654ba9607SSascha Wildner static int parse_mdoc_Nm(struct mpage *, const struct roff_meta *,
15754ba9607SSascha Wildner const struct roff_node *);
15854ba9607SSascha Wildner static int parse_mdoc_Sh(struct mpage *, const struct roff_meta *,
15954ba9607SSascha Wildner const struct roff_node *);
16054ba9607SSascha Wildner static int parse_mdoc_Va(struct mpage *, const struct roff_meta *,
16154ba9607SSascha Wildner const struct roff_node *);
16254ba9607SSascha Wildner static int parse_mdoc_Xr(struct mpage *, const struct roff_meta *,
16354ba9607SSascha Wildner const struct roff_node *);
164070c62a6SFranco Fichtner static void putkey(const struct mpage *, char *, uint64_t);
16554ba9607SSascha Wildner static void putkeys(const struct mpage *, char *, size_t, uint64_t);
166070c62a6SFranco Fichtner static void putmdockey(const struct mpage *,
16754ba9607SSascha Wildner const struct roff_node *, uint64_t, int);
168*99db7d0eSSascha Wildner #ifdef READ_ALLOWED_PATH
169*99db7d0eSSascha Wildner static int read_allowed(const char *);
170*99db7d0eSSascha Wildner #endif
17154ba9607SSascha Wildner static int render_string(char **, size_t *);
17254ba9607SSascha Wildner static void say(const char *, const char *, ...)
17354ba9607SSascha Wildner __attribute__((__format__ (__printf__, 2, 3)));
17454ba9607SSascha Wildner static int set_basedir(const char *, int);
175070c62a6SFranco Fichtner static int treescan(void);
176070c62a6SFranco Fichtner static size_t utf8(unsigned int, char [7]);
177070c62a6SFranco Fichtner
178070c62a6SFranco Fichtner static int nodb; /* no database changes */
179070c62a6SFranco Fichtner static int mparse_options; /* abort the parse early */
180070c62a6SFranco Fichtner static int use_all; /* use all found files */
181070c62a6SFranco Fichtner static int debug; /* print what we're doing */
182070c62a6SFranco Fichtner static int warnings; /* warn about crap */
183070c62a6SFranco Fichtner static int write_utf8; /* write UTF-8 output; else ASCII */
184070c62a6SFranco Fichtner static int exitcode; /* to be returned by main */
185070c62a6SFranco Fichtner static enum op op; /* operational mode */
186070c62a6SFranco Fichtner static char basedir[PATH_MAX]; /* current base directory */
187*99db7d0eSSascha Wildner static size_t basedir_len; /* strlen(basedir) */
18854ba9607SSascha Wildner static struct mpage *mpage_head; /* list of distinct manual pages */
189070c62a6SFranco Fichtner static struct ohash mpages; /* table of distinct manual pages */
190070c62a6SFranco Fichtner static struct ohash mlinks; /* table of directory entries */
191070c62a6SFranco Fichtner static struct ohash names; /* table of all names */
192070c62a6SFranco Fichtner static struct ohash strings; /* table of all strings */
193070c62a6SFranco Fichtner static uint64_t name_mask;
194070c62a6SFranco Fichtner
19554ba9607SSascha Wildner static const struct mdoc_handler mdoc_handlers[MDOC_MAX - MDOC_Dd] = {
19654ba9607SSascha Wildner { NULL, 0, NODE_NOPRT }, /* Dd */
19754ba9607SSascha Wildner { NULL, 0, NODE_NOPRT }, /* Dt */
19854ba9607SSascha Wildner { NULL, 0, NODE_NOPRT }, /* Os */
19954ba9607SSascha Wildner { parse_mdoc_Sh, TYPE_Sh, 0 }, /* Sh */
20054ba9607SSascha Wildner { parse_mdoc_head, TYPE_Ss, 0 }, /* Ss */
20154ba9607SSascha Wildner { NULL, 0, 0 }, /* Pp */
20254ba9607SSascha Wildner { NULL, 0, 0 }, /* D1 */
20354ba9607SSascha Wildner { NULL, 0, 0 }, /* Dl */
20454ba9607SSascha Wildner { NULL, 0, 0 }, /* Bd */
20554ba9607SSascha Wildner { NULL, 0, 0 }, /* Ed */
20654ba9607SSascha Wildner { NULL, 0, 0 }, /* Bl */
20754ba9607SSascha Wildner { NULL, 0, 0 }, /* El */
20854ba9607SSascha Wildner { NULL, 0, 0 }, /* It */
20954ba9607SSascha Wildner { NULL, 0, 0 }, /* Ad */
21054ba9607SSascha Wildner { NULL, TYPE_An, 0 }, /* An */
21154ba9607SSascha Wildner { NULL, 0, 0 }, /* Ap */
21254ba9607SSascha Wildner { NULL, TYPE_Ar, 0 }, /* Ar */
21354ba9607SSascha Wildner { NULL, TYPE_Cd, 0 }, /* Cd */
21454ba9607SSascha Wildner { NULL, TYPE_Cm, 0 }, /* Cm */
21554ba9607SSascha Wildner { NULL, TYPE_Dv, 0 }, /* Dv */
21654ba9607SSascha Wildner { NULL, TYPE_Er, 0 }, /* Er */
21754ba9607SSascha Wildner { NULL, TYPE_Ev, 0 }, /* Ev */
21854ba9607SSascha Wildner { NULL, 0, 0 }, /* Ex */
21954ba9607SSascha Wildner { parse_mdoc_Fa, 0, 0 }, /* Fa */
22054ba9607SSascha Wildner { parse_mdoc_Fd, 0, 0 }, /* Fd */
22154ba9607SSascha Wildner { NULL, TYPE_Fl, 0 }, /* Fl */
22254ba9607SSascha Wildner { parse_mdoc_Fn, 0, 0 }, /* Fn */
22354ba9607SSascha Wildner { NULL, TYPE_Ft | TYPE_Vt, 0 }, /* Ft */
22454ba9607SSascha Wildner { NULL, TYPE_Ic, 0 }, /* Ic */
22554ba9607SSascha Wildner { NULL, TYPE_In, 0 }, /* In */
22654ba9607SSascha Wildner { NULL, TYPE_Li, 0 }, /* Li */
22754ba9607SSascha Wildner { parse_mdoc_Nd, 0, 0 }, /* Nd */
22854ba9607SSascha Wildner { parse_mdoc_Nm, 0, 0 }, /* Nm */
22954ba9607SSascha Wildner { NULL, 0, 0 }, /* Op */
23054ba9607SSascha Wildner { NULL, 0, 0 }, /* Ot */
23154ba9607SSascha Wildner { NULL, TYPE_Pa, NODE_NOSRC }, /* Pa */
23254ba9607SSascha Wildner { NULL, 0, 0 }, /* Rv */
23354ba9607SSascha Wildner { NULL, TYPE_St, 0 }, /* St */
23454ba9607SSascha Wildner { parse_mdoc_Va, TYPE_Va, 0 }, /* Va */
23554ba9607SSascha Wildner { parse_mdoc_Va, TYPE_Vt, 0 }, /* Vt */
23654ba9607SSascha Wildner { parse_mdoc_Xr, 0, 0 }, /* Xr */
23754ba9607SSascha Wildner { NULL, 0, 0 }, /* %A */
23854ba9607SSascha Wildner { NULL, 0, 0 }, /* %B */
23954ba9607SSascha Wildner { NULL, 0, 0 }, /* %D */
24054ba9607SSascha Wildner { NULL, 0, 0 }, /* %I */
24154ba9607SSascha Wildner { NULL, 0, 0 }, /* %J */
24254ba9607SSascha Wildner { NULL, 0, 0 }, /* %N */
24354ba9607SSascha Wildner { NULL, 0, 0 }, /* %O */
24454ba9607SSascha Wildner { NULL, 0, 0 }, /* %P */
24554ba9607SSascha Wildner { NULL, 0, 0 }, /* %R */
24654ba9607SSascha Wildner { NULL, 0, 0 }, /* %T */
24754ba9607SSascha Wildner { NULL, 0, 0 }, /* %V */
24854ba9607SSascha Wildner { NULL, 0, 0 }, /* Ac */
24954ba9607SSascha Wildner { NULL, 0, 0 }, /* Ao */
25054ba9607SSascha Wildner { NULL, 0, 0 }, /* Aq */
25154ba9607SSascha Wildner { NULL, TYPE_At, 0 }, /* At */
25254ba9607SSascha Wildner { NULL, 0, 0 }, /* Bc */
25354ba9607SSascha Wildner { NULL, 0, 0 }, /* Bf */
25454ba9607SSascha Wildner { NULL, 0, 0 }, /* Bo */
25554ba9607SSascha Wildner { NULL, 0, 0 }, /* Bq */
25654ba9607SSascha Wildner { NULL, TYPE_Bsx, NODE_NOSRC }, /* Bsx */
25754ba9607SSascha Wildner { NULL, TYPE_Bx, NODE_NOSRC }, /* Bx */
25854ba9607SSascha Wildner { NULL, 0, 0 }, /* Db */
25954ba9607SSascha Wildner { NULL, 0, 0 }, /* Dc */
26054ba9607SSascha Wildner { NULL, 0, 0 }, /* Do */
26154ba9607SSascha Wildner { NULL, 0, 0 }, /* Dq */
26254ba9607SSascha Wildner { NULL, 0, 0 }, /* Ec */
26354ba9607SSascha Wildner { NULL, 0, 0 }, /* Ef */
26454ba9607SSascha Wildner { NULL, TYPE_Em, 0 }, /* Em */
26554ba9607SSascha Wildner { NULL, 0, 0 }, /* Eo */
26654ba9607SSascha Wildner { NULL, TYPE_Fx, NODE_NOSRC }, /* Fx */
26754ba9607SSascha Wildner { NULL, TYPE_Ms, 0 }, /* Ms */
26854ba9607SSascha Wildner { NULL, 0, 0 }, /* No */
26954ba9607SSascha Wildner { NULL, 0, 0 }, /* Ns */
27054ba9607SSascha Wildner { NULL, TYPE_Nx, NODE_NOSRC }, /* Nx */
27154ba9607SSascha Wildner { NULL, TYPE_Ox, NODE_NOSRC }, /* Ox */
27254ba9607SSascha Wildner { NULL, 0, 0 }, /* Pc */
27354ba9607SSascha Wildner { NULL, 0, 0 }, /* Pf */
27454ba9607SSascha Wildner { NULL, 0, 0 }, /* Po */
27554ba9607SSascha Wildner { NULL, 0, 0 }, /* Pq */
27654ba9607SSascha Wildner { NULL, 0, 0 }, /* Qc */
27754ba9607SSascha Wildner { NULL, 0, 0 }, /* Ql */
27854ba9607SSascha Wildner { NULL, 0, 0 }, /* Qo */
27954ba9607SSascha Wildner { NULL, 0, 0 }, /* Qq */
28054ba9607SSascha Wildner { NULL, 0, 0 }, /* Re */
28154ba9607SSascha Wildner { NULL, 0, 0 }, /* Rs */
28254ba9607SSascha Wildner { NULL, 0, 0 }, /* Sc */
28354ba9607SSascha Wildner { NULL, 0, 0 }, /* So */
28454ba9607SSascha Wildner { NULL, 0, 0 }, /* Sq */
28554ba9607SSascha Wildner { NULL, 0, 0 }, /* Sm */
28654ba9607SSascha Wildner { NULL, 0, 0 }, /* Sx */
28754ba9607SSascha Wildner { NULL, TYPE_Sy, 0 }, /* Sy */
28854ba9607SSascha Wildner { NULL, TYPE_Tn, 0 }, /* Tn */
28954ba9607SSascha Wildner { NULL, 0, NODE_NOSRC }, /* Ux */
29054ba9607SSascha Wildner { NULL, 0, 0 }, /* Xc */
29154ba9607SSascha Wildner { NULL, 0, 0 }, /* Xo */
29254ba9607SSascha Wildner { parse_mdoc_Fo, 0, 0 }, /* Fo */
29354ba9607SSascha Wildner { NULL, 0, 0 }, /* Fc */
29454ba9607SSascha Wildner { NULL, 0, 0 }, /* Oo */
29554ba9607SSascha Wildner { NULL, 0, 0 }, /* Oc */
29654ba9607SSascha Wildner { NULL, 0, 0 }, /* Bk */
29754ba9607SSascha Wildner { NULL, 0, 0 }, /* Ek */
29854ba9607SSascha Wildner { NULL, 0, 0 }, /* Bt */
29954ba9607SSascha Wildner { NULL, 0, 0 }, /* Hf */
30054ba9607SSascha Wildner { NULL, 0, 0 }, /* Fr */
30154ba9607SSascha Wildner { NULL, 0, 0 }, /* Ud */
30254ba9607SSascha Wildner { NULL, TYPE_Lb, NODE_NOSRC }, /* Lb */
30354ba9607SSascha Wildner { NULL, 0, 0 }, /* Lp */
30454ba9607SSascha Wildner { NULL, TYPE_Lk, 0 }, /* Lk */
30554ba9607SSascha Wildner { NULL, TYPE_Mt, NODE_NOSRC }, /* Mt */
30654ba9607SSascha Wildner { NULL, 0, 0 }, /* Brq */
30754ba9607SSascha Wildner { NULL, 0, 0 }, /* Bro */
30854ba9607SSascha Wildner { NULL, 0, 0 }, /* Brc */
30954ba9607SSascha Wildner { NULL, 0, 0 }, /* %C */
31054ba9607SSascha Wildner { NULL, 0, 0 }, /* Es */
31154ba9607SSascha Wildner { NULL, 0, 0 }, /* En */
31254ba9607SSascha Wildner { NULL, TYPE_Dx, NODE_NOSRC }, /* Dx */
31354ba9607SSascha Wildner { NULL, 0, 0 }, /* %Q */
31454ba9607SSascha Wildner { NULL, 0, 0 }, /* %U */
31554ba9607SSascha Wildner { NULL, 0, 0 }, /* Ta */
31636342e81SSascha Wildner };
31736342e81SSascha Wildner
31836342e81SSascha Wildner
31936342e81SSascha Wildner int
mandocdb(int argc,char * argv[])32054ba9607SSascha Wildner mandocdb(int argc, char *argv[])
32136342e81SSascha Wildner {
32254ba9607SSascha Wildner struct manconf conf;
323070c62a6SFranco Fichtner struct mparse *mp;
32454ba9607SSascha Wildner struct dba *dba;
32554ba9607SSascha Wildner const char *path_arg, *progname;
32654ba9607SSascha Wildner size_t j, sz;
32754ba9607SSascha Wildner int ch, i;
328070c62a6SFranco Fichtner
32954ba9607SSascha Wildner #if HAVE_PLEDGE
33054ba9607SSascha Wildner if (pledge("stdio rpath wpath cpath", NULL) == -1) {
33154ba9607SSascha Wildner warn("pledge");
33254ba9607SSascha Wildner return (int)MANDOCLEVEL_SYSERR;
33354ba9607SSascha Wildner }
33454ba9607SSascha Wildner #endif
335070c62a6SFranco Fichtner
33654ba9607SSascha Wildner #if HAVE_SANDBOX_INIT
33754ba9607SSascha Wildner if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1) {
33854ba9607SSascha Wildner warnx("sandbox_init");
33954ba9607SSascha Wildner return (int)MANDOCLEVEL_SYSERR;
34054ba9607SSascha Wildner }
34154ba9607SSascha Wildner #endif
342070c62a6SFranco Fichtner
34354ba9607SSascha Wildner memset(&conf, 0, sizeof(conf));
34436342e81SSascha Wildner
345070c62a6SFranco Fichtner /*
346070c62a6SFranco Fichtner * We accept a few different invocations.
347070c62a6SFranco Fichtner * The CHECKOP macro makes sure that invocation styles don't
348070c62a6SFranco Fichtner * clobber each other.
349070c62a6SFranco Fichtner */
350070c62a6SFranco Fichtner #define CHECKOP(_op, _ch) do \
351*99db7d0eSSascha Wildner if ((_op) != OP_DEFAULT) { \
35254ba9607SSascha Wildner warnx("-%c: Conflicting option", (_ch)); \
353070c62a6SFranco Fichtner goto usage; \
354070c62a6SFranco Fichtner } while (/*CONSTCOND*/0)
35536342e81SSascha Wildner
35654ba9607SSascha Wildner mparse_options = MPARSE_VALIDATE;
357070c62a6SFranco Fichtner path_arg = NULL;
35836342e81SSascha Wildner op = OP_DEFAULT;
35936342e81SSascha Wildner
360*99db7d0eSSascha Wildner while ((ch = getopt(argc, argv, "aC:Dd:npQT:tu:v")) != -1)
36136342e81SSascha Wildner switch (ch) {
362070c62a6SFranco Fichtner case 'a':
36336342e81SSascha Wildner use_all = 1;
36436342e81SSascha Wildner break;
365070c62a6SFranco Fichtner case 'C':
366070c62a6SFranco Fichtner CHECKOP(op, ch);
367070c62a6SFranco Fichtner path_arg = optarg;
36836342e81SSascha Wildner op = OP_CONFFILE;
36936342e81SSascha Wildner break;
370070c62a6SFranco Fichtner case 'D':
371070c62a6SFranco Fichtner debug++;
372070c62a6SFranco Fichtner break;
373070c62a6SFranco Fichtner case 'd':
374070c62a6SFranco Fichtner CHECKOP(op, ch);
375070c62a6SFranco Fichtner path_arg = optarg;
37636342e81SSascha Wildner op = OP_UPDATE;
37736342e81SSascha Wildner break;
378070c62a6SFranco Fichtner case 'n':
379070c62a6SFranco Fichtner nodb = 1;
380070c62a6SFranco Fichtner break;
381070c62a6SFranco Fichtner case 'p':
38236342e81SSascha Wildner warnings = 1;
38336342e81SSascha Wildner break;
384070c62a6SFranco Fichtner case 'Q':
385070c62a6SFranco Fichtner mparse_options |= MPARSE_QUICK;
386070c62a6SFranco Fichtner break;
387070c62a6SFranco Fichtner case 'T':
388*99db7d0eSSascha Wildner if (strcmp(optarg, "utf8") != 0) {
38954ba9607SSascha Wildner warnx("-T%s: Unsupported output format",
39054ba9607SSascha Wildner optarg);
39136342e81SSascha Wildner goto usage;
39236342e81SSascha Wildner }
393070c62a6SFranco Fichtner write_utf8 = 1;
394070c62a6SFranco Fichtner break;
395070c62a6SFranco Fichtner case 't':
396070c62a6SFranco Fichtner CHECKOP(op, ch);
397070c62a6SFranco Fichtner dup2(STDOUT_FILENO, STDERR_FILENO);
398070c62a6SFranco Fichtner op = OP_TEST;
399070c62a6SFranco Fichtner nodb = warnings = 1;
400070c62a6SFranco Fichtner break;
401070c62a6SFranco Fichtner case 'u':
402070c62a6SFranco Fichtner CHECKOP(op, ch);
403070c62a6SFranco Fichtner path_arg = optarg;
40436342e81SSascha Wildner op = OP_DELETE;
40536342e81SSascha Wildner break;
406070c62a6SFranco Fichtner case 'v':
407070c62a6SFranco Fichtner /* Compatibility with espie@'s makewhatis. */
40836342e81SSascha Wildner break;
40936342e81SSascha Wildner default:
41036342e81SSascha Wildner goto usage;
41136342e81SSascha Wildner }
41236342e81SSascha Wildner
41336342e81SSascha Wildner argc -= optind;
41436342e81SSascha Wildner argv += optind;
41536342e81SSascha Wildner
41654ba9607SSascha Wildner #if HAVE_PLEDGE
41754ba9607SSascha Wildner if (nodb) {
41854ba9607SSascha Wildner if (pledge("stdio rpath", NULL) == -1) {
41954ba9607SSascha Wildner warn("pledge");
42054ba9607SSascha Wildner return (int)MANDOCLEVEL_SYSERR;
42154ba9607SSascha Wildner }
42254ba9607SSascha Wildner }
42354ba9607SSascha Wildner #endif
42454ba9607SSascha Wildner
425*99db7d0eSSascha Wildner if (op == OP_CONFFILE && argc > 0) {
42654ba9607SSascha Wildner warnx("-C: Too many arguments");
42736342e81SSascha Wildner goto usage;
42836342e81SSascha Wildner }
42936342e81SSascha Wildner
430070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_OK;
43154ba9607SSascha Wildner mchars_alloc();
43254ba9607SSascha Wildner mp = mparse_alloc(mparse_options, MANDOC_OS_OTHER, NULL);
43354ba9607SSascha Wildner mandoc_ohash_init(&mpages, 6, offsetof(struct mpage, inodev));
43454ba9607SSascha Wildner mandoc_ohash_init(&mlinks, 6, offsetof(struct mlink, file));
43536342e81SSascha Wildner
436*99db7d0eSSascha Wildner if (op == OP_UPDATE || op == OP_DELETE || op == OP_TEST) {
43736342e81SSascha Wildner
43836342e81SSascha Wildner /*
439070c62a6SFranco Fichtner * Most of these deal with a specific directory.
440070c62a6SFranco Fichtner * Jump into that directory first.
44136342e81SSascha Wildner */
442*99db7d0eSSascha Wildner if (op != OP_TEST && set_basedir(path_arg, 1) == 0)
443070c62a6SFranco Fichtner goto out;
44436342e81SSascha Wildner
44554ba9607SSascha Wildner dba = nodb ? dba_new(128) : dba_read(MANDOC_DB);
44654ba9607SSascha Wildner if (dba != NULL) {
447070c62a6SFranco Fichtner /*
448070c62a6SFranco Fichtner * The existing database is usable. Process
449070c62a6SFranco Fichtner * all files specified on the command-line.
450070c62a6SFranco Fichtner */
451070c62a6SFranco Fichtner use_all = 1;
452070c62a6SFranco Fichtner for (i = 0; i < argc; i++)
453070c62a6SFranco Fichtner filescan(argv[i]);
45454ba9607SSascha Wildner if (nodb == 0)
45554ba9607SSascha Wildner dbprune(dba);
456070c62a6SFranco Fichtner } else {
45754ba9607SSascha Wildner /* Database missing or corrupt. */
45854ba9607SSascha Wildner if (op != OP_UPDATE || errno != ENOENT)
45954ba9607SSascha Wildner say(MANDOC_DB, "%s: Automatically recreating"
46054ba9607SSascha Wildner " from scratch", strerror(errno));
461070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_OK;
462070c62a6SFranco Fichtner op = OP_DEFAULT;
463*99db7d0eSSascha Wildner if (treescan() == 0)
464070c62a6SFranco Fichtner goto out;
46554ba9607SSascha Wildner dba = dba_new(128);
46636342e81SSascha Wildner }
467*99db7d0eSSascha Wildner if (op != OP_DELETE)
46854ba9607SSascha Wildner mpages_merge(dba, mp);
46954ba9607SSascha Wildner if (nodb == 0)
47054ba9607SSascha Wildner dbwrite(dba);
47154ba9607SSascha Wildner dba_free(dba);
472070c62a6SFranco Fichtner } else {
47336342e81SSascha Wildner /*
474070c62a6SFranco Fichtner * If we have arguments, use them as our manpaths.
47554ba9607SSascha Wildner * If we don't, use man.conf(5).
47636342e81SSascha Wildner */
47736342e81SSascha Wildner if (argc > 0) {
47854ba9607SSascha Wildner conf.manpath.paths = mandoc_reallocarray(NULL,
479070c62a6SFranco Fichtner argc, sizeof(char *));
48054ba9607SSascha Wildner conf.manpath.sz = (size_t)argc;
481070c62a6SFranco Fichtner for (i = 0; i < argc; i++)
48254ba9607SSascha Wildner conf.manpath.paths[i] = mandoc_strdup(argv[i]);
48336342e81SSascha Wildner } else
48454ba9607SSascha Wildner manconf_parse(&conf, path_arg, NULL, NULL);
48536342e81SSascha Wildner
48654ba9607SSascha Wildner if (conf.manpath.sz == 0) {
487070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_BADARG;
488070c62a6SFranco Fichtner say("", "Empty manpath");
489f88b6c16SFranco Fichtner }
49036342e81SSascha Wildner
49136342e81SSascha Wildner /*
492070c62a6SFranco Fichtner * First scan the tree rooted at a base directory, then
493070c62a6SFranco Fichtner * build a new database and finally move it into place.
494070c62a6SFranco Fichtner * Ignore zero-length directories and strip trailing
495070c62a6SFranco Fichtner * slashes.
49636342e81SSascha Wildner */
49754ba9607SSascha Wildner for (j = 0; j < conf.manpath.sz; j++) {
49854ba9607SSascha Wildner sz = strlen(conf.manpath.paths[j]);
49954ba9607SSascha Wildner if (sz && conf.manpath.paths[j][sz - 1] == '/')
50054ba9607SSascha Wildner conf.manpath.paths[j][--sz] = '\0';
501*99db7d0eSSascha Wildner if (sz == 0)
502070c62a6SFranco Fichtner continue;
50336342e81SSascha Wildner
504070c62a6SFranco Fichtner if (j) {
50554ba9607SSascha Wildner mandoc_ohash_init(&mpages, 6,
50654ba9607SSascha Wildner offsetof(struct mpage, inodev));
50754ba9607SSascha Wildner mandoc_ohash_init(&mlinks, 6,
50854ba9607SSascha Wildner offsetof(struct mlink, file));
50936342e81SSascha Wildner }
51036342e81SSascha Wildner
511*99db7d0eSSascha Wildner if (set_basedir(conf.manpath.paths[j], argc > 0) == 0)
51254ba9607SSascha Wildner continue;
513*99db7d0eSSascha Wildner if (treescan() == 0)
51454ba9607SSascha Wildner continue;
51554ba9607SSascha Wildner dba = dba_new(128);
51654ba9607SSascha Wildner mpages_merge(dba, mp);
51754ba9607SSascha Wildner if (nodb == 0)
51854ba9607SSascha Wildner dbwrite(dba);
51954ba9607SSascha Wildner dba_free(dba);
520f88b6c16SFranco Fichtner
52154ba9607SSascha Wildner if (j + 1 < conf.manpath.sz) {
522070c62a6SFranco Fichtner mpages_free();
523070c62a6SFranco Fichtner ohash_delete(&mpages);
524070c62a6SFranco Fichtner ohash_delete(&mlinks);
525f88b6c16SFranco Fichtner }
52636342e81SSascha Wildner }
527070c62a6SFranco Fichtner }
52836342e81SSascha Wildner out:
52954ba9607SSascha Wildner manconf_free(&conf);
530070c62a6SFranco Fichtner mparse_free(mp);
53154ba9607SSascha Wildner mchars_free();
532070c62a6SFranco Fichtner mpages_free();
533070c62a6SFranco Fichtner ohash_delete(&mpages);
534070c62a6SFranco Fichtner ohash_delete(&mlinks);
53554ba9607SSascha Wildner return exitcode;
53636342e81SSascha Wildner usage:
53754ba9607SSascha Wildner progname = getprogname();
538070c62a6SFranco Fichtner fprintf(stderr, "usage: %s [-aDnpQ] [-C file] [-Tutf8]\n"
539070c62a6SFranco Fichtner " %s [-aDnpQ] [-Tutf8] dir ...\n"
540070c62a6SFranco Fichtner " %s [-DnpQ] [-Tutf8] -d dir [file ...]\n"
541070c62a6SFranco Fichtner " %s [-Dnp] -u dir [file ...]\n"
542070c62a6SFranco Fichtner " %s [-Q] -t file ...\n",
54354ba9607SSascha Wildner progname, progname, progname, progname, progname);
54436342e81SSascha Wildner
54554ba9607SSascha Wildner return (int)MANDOCLEVEL_BADARG;
54654ba9607SSascha Wildner }
54754ba9607SSascha Wildner
54854ba9607SSascha Wildner /*
54954ba9607SSascha Wildner * To get a singly linked list in alpha order while inserting entries
55054ba9607SSascha Wildner * at the beginning, process directory entries in reverse alpha order.
55154ba9607SSascha Wildner */
55254ba9607SSascha Wildner static int
55354ba9607SSascha Wildner #if HAVE_FTS_COMPARE_CONST
fts_compare(const FTSENT * const * a,const FTSENT * const * b)55454ba9607SSascha Wildner fts_compare(const FTSENT *const *a, const FTSENT *const *b)
55554ba9607SSascha Wildner #else
55654ba9607SSascha Wildner fts_compare(const FTSENT **a, const FTSENT **b)
55754ba9607SSascha Wildner #endif
55854ba9607SSascha Wildner {
55954ba9607SSascha Wildner return -strcmp((*a)->fts_name, (*b)->fts_name);
56036342e81SSascha Wildner }
56136342e81SSascha Wildner
562070c62a6SFranco Fichtner /*
563070c62a6SFranco Fichtner * Scan a directory tree rooted at "basedir" for manpages.
564070c62a6SFranco Fichtner * We use fts(), scanning directory parts along the way for clues to our
565070c62a6SFranco Fichtner * section and architecture.
566070c62a6SFranco Fichtner *
567070c62a6SFranco Fichtner * If use_all has been specified, grok all files.
568070c62a6SFranco Fichtner * If not, sanitise paths to the following:
569070c62a6SFranco Fichtner *
570070c62a6SFranco Fichtner * [./]man*[/<arch>]/<name>.<section>
571070c62a6SFranco Fichtner * or
572070c62a6SFranco Fichtner * [./]cat<section>[/<arch>]/<name>.0
573070c62a6SFranco Fichtner *
57454ba9607SSascha Wildner * TODO: accommodate for multi-language directories.
575070c62a6SFranco Fichtner */
576070c62a6SFranco Fichtner static int
treescan(void)577070c62a6SFranco Fichtner treescan(void)
57836342e81SSascha Wildner {
579070c62a6SFranco Fichtner char buf[PATH_MAX];
580070c62a6SFranco Fichtner FTS *f;
581070c62a6SFranco Fichtner FTSENT *ff;
582070c62a6SFranco Fichtner struct mlink *mlink;
58354ba9607SSascha Wildner int gzip;
58454ba9607SSascha Wildner enum form dform;
585070c62a6SFranco Fichtner char *dsec, *arch, *fsec, *cp;
586070c62a6SFranco Fichtner const char *path;
587070c62a6SFranco Fichtner const char *argv[2];
58836342e81SSascha Wildner
589070c62a6SFranco Fichtner argv[0] = ".";
59054ba9607SSascha Wildner argv[1] = NULL;
5917888c61dSFranco Fichtner
59254ba9607SSascha Wildner f = fts_open((char * const *)argv, FTS_PHYSICAL | FTS_NOCHDIR,
59354ba9607SSascha Wildner fts_compare);
59454ba9607SSascha Wildner if (f == NULL) {
595070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_SYSERR;
596070c62a6SFranco Fichtner say("", "&fts_open");
59754ba9607SSascha Wildner return 0;
59836342e81SSascha Wildner }
59936342e81SSascha Wildner
600070c62a6SFranco Fichtner dsec = arch = NULL;
601070c62a6SFranco Fichtner dform = FORM_NONE;
602070c62a6SFranco Fichtner
60354ba9607SSascha Wildner while ((ff = fts_read(f)) != NULL) {
604070c62a6SFranco Fichtner path = ff->fts_path + 2;
605070c62a6SFranco Fichtner switch (ff->fts_info) {
60636342e81SSascha Wildner
60736342e81SSascha Wildner /*
608070c62a6SFranco Fichtner * Symbolic links require various sanity checks,
609070c62a6SFranco Fichtner * then get handled just like regular files.
61036342e81SSascha Wildner */
611070c62a6SFranco Fichtner case FTS_SL:
61254ba9607SSascha Wildner if (realpath(path, buf) == NULL) {
613070c62a6SFranco Fichtner if (warnings)
614070c62a6SFranco Fichtner say(path, "&realpath");
615070c62a6SFranco Fichtner continue;
61636342e81SSascha Wildner }
617*99db7d0eSSascha Wildner if (strncmp(buf, basedir, basedir_len) != 0
618*99db7d0eSSascha Wildner #ifdef READ_ALLOWED_PATH
619*99db7d0eSSascha Wildner && !read_allowed(buf)
62054ba9607SSascha Wildner #endif
62154ba9607SSascha Wildner ) {
622070c62a6SFranco Fichtner if (warnings) say("",
623070c62a6SFranco Fichtner "%s: outside base directory", buf);
624070c62a6SFranco Fichtner continue;
625070c62a6SFranco Fichtner }
626070c62a6SFranco Fichtner /* Use logical inode to avoid mpages dupe. */
62754ba9607SSascha Wildner if (stat(path, ff->fts_statp) == -1) {
628070c62a6SFranco Fichtner if (warnings)
629070c62a6SFranco Fichtner say(path, "&stat");
630070c62a6SFranco Fichtner continue;
631070c62a6SFranco Fichtner }
632*99db7d0eSSascha Wildner if ((ff->fts_statp->st_mode & S_IFMT) != S_IFREG)
633*99db7d0eSSascha Wildner continue;
634070c62a6SFranco Fichtner /* FALLTHROUGH */
635070c62a6SFranco Fichtner
636070c62a6SFranco Fichtner /*
637070c62a6SFranco Fichtner * If we're a regular file, add an mlink by using the
638070c62a6SFranco Fichtner * stored directory data and handling the filename.
639070c62a6SFranco Fichtner */
640070c62a6SFranco Fichtner case FTS_F:
64154ba9607SSascha Wildner if ( ! strcmp(path, MANDOC_DB))
642070c62a6SFranco Fichtner continue;
643070c62a6SFranco Fichtner if ( ! use_all && ff->fts_level < 2) {
644070c62a6SFranco Fichtner if (warnings)
645070c62a6SFranco Fichtner say(path, "Extraneous file");
646070c62a6SFranco Fichtner continue;
647070c62a6SFranco Fichtner }
648070c62a6SFranco Fichtner gzip = 0;
649070c62a6SFranco Fichtner fsec = NULL;
65054ba9607SSascha Wildner while (fsec == NULL) {
651070c62a6SFranco Fichtner fsec = strrchr(ff->fts_name, '.');
65254ba9607SSascha Wildner if (fsec == NULL || strcmp(fsec+1, "gz"))
653070c62a6SFranco Fichtner break;
654070c62a6SFranco Fichtner gzip = 1;
655070c62a6SFranco Fichtner *fsec = '\0';
656070c62a6SFranco Fichtner fsec = NULL;
657070c62a6SFranco Fichtner }
65854ba9607SSascha Wildner if (fsec == NULL) {
659070c62a6SFranco Fichtner if ( ! use_all) {
660070c62a6SFranco Fichtner if (warnings)
661070c62a6SFranco Fichtner say(path,
662070c62a6SFranco Fichtner "No filename suffix");
663070c62a6SFranco Fichtner continue;
664070c62a6SFranco Fichtner }
66554ba9607SSascha Wildner } else if ( ! strcmp(++fsec, "html")) {
666070c62a6SFranco Fichtner if (warnings)
667070c62a6SFranco Fichtner say(path, "Skip html");
668070c62a6SFranco Fichtner continue;
66954ba9607SSascha Wildner } else if ( ! strcmp(fsec, "ps")) {
670070c62a6SFranco Fichtner if (warnings)
671070c62a6SFranco Fichtner say(path, "Skip ps");
672070c62a6SFranco Fichtner continue;
67354ba9607SSascha Wildner } else if ( ! strcmp(fsec, "pdf")) {
674070c62a6SFranco Fichtner if (warnings)
675070c62a6SFranco Fichtner say(path, "Skip pdf");
676070c62a6SFranco Fichtner continue;
677070c62a6SFranco Fichtner } else if ( ! use_all &&
67854ba9607SSascha Wildner ((dform == FORM_SRC &&
67954ba9607SSascha Wildner strncmp(fsec, dsec, strlen(dsec))) ||
68054ba9607SSascha Wildner (dform == FORM_CAT && strcmp(fsec, "0")))) {
681070c62a6SFranco Fichtner if (warnings)
682070c62a6SFranco Fichtner say(path, "Wrong filename suffix");
683070c62a6SFranco Fichtner continue;
684070c62a6SFranco Fichtner } else
685070c62a6SFranco Fichtner fsec[-1] = '\0';
686070c62a6SFranco Fichtner
687070c62a6SFranco Fichtner mlink = mandoc_calloc(1, sizeof(struct mlink));
688070c62a6SFranco Fichtner if (strlcpy(mlink->file, path,
689070c62a6SFranco Fichtner sizeof(mlink->file)) >=
690070c62a6SFranco Fichtner sizeof(mlink->file)) {
691070c62a6SFranco Fichtner say(path, "Filename too long");
692070c62a6SFranco Fichtner free(mlink);
693070c62a6SFranco Fichtner continue;
694070c62a6SFranco Fichtner }
695070c62a6SFranco Fichtner mlink->dform = dform;
696070c62a6SFranco Fichtner mlink->dsec = dsec;
697070c62a6SFranco Fichtner mlink->arch = arch;
698070c62a6SFranco Fichtner mlink->name = ff->fts_name;
699070c62a6SFranco Fichtner mlink->fsec = fsec;
700070c62a6SFranco Fichtner mlink->gzip = gzip;
701070c62a6SFranco Fichtner mlink_add(mlink, ff->fts_statp);
702070c62a6SFranco Fichtner continue;
703070c62a6SFranco Fichtner
704070c62a6SFranco Fichtner case FTS_D:
705070c62a6SFranco Fichtner case FTS_DP:
706070c62a6SFranco Fichtner break;
707070c62a6SFranco Fichtner
708070c62a6SFranco Fichtner default:
709070c62a6SFranco Fichtner if (warnings)
710070c62a6SFranco Fichtner say(path, "Not a regular file");
711070c62a6SFranco Fichtner continue;
712070c62a6SFranco Fichtner }
713070c62a6SFranco Fichtner
714070c62a6SFranco Fichtner switch (ff->fts_level) {
715070c62a6SFranco Fichtner case 0:
716070c62a6SFranco Fichtner /* Ignore the root directory. */
717070c62a6SFranco Fichtner break;
718070c62a6SFranco Fichtner case 1:
719070c62a6SFranco Fichtner /*
720070c62a6SFranco Fichtner * This might contain manX/ or catX/.
721070c62a6SFranco Fichtner * Try to infer this from the name.
722070c62a6SFranco Fichtner * If we're not in use_all, enforce it.
723070c62a6SFranco Fichtner */
724070c62a6SFranco Fichtner cp = ff->fts_name;
72554ba9607SSascha Wildner if (ff->fts_info == FTS_DP) {
72654ba9607SSascha Wildner dform = FORM_NONE;
72754ba9607SSascha Wildner dsec = NULL;
728070c62a6SFranco Fichtner break;
72954ba9607SSascha Wildner }
730070c62a6SFranco Fichtner
73154ba9607SSascha Wildner if ( ! strncmp(cp, "man", 3)) {
732070c62a6SFranco Fichtner dform = FORM_SRC;
733070c62a6SFranco Fichtner dsec = cp + 3;
73454ba9607SSascha Wildner } else if ( ! strncmp(cp, "cat", 3)) {
735070c62a6SFranco Fichtner dform = FORM_CAT;
736070c62a6SFranco Fichtner dsec = cp + 3;
737070c62a6SFranco Fichtner } else {
738070c62a6SFranco Fichtner dform = FORM_NONE;
739070c62a6SFranco Fichtner dsec = NULL;
740070c62a6SFranco Fichtner }
741070c62a6SFranco Fichtner
74254ba9607SSascha Wildner if (dsec != NULL || use_all)
743070c62a6SFranco Fichtner break;
744070c62a6SFranco Fichtner
745070c62a6SFranco Fichtner if (warnings)
746070c62a6SFranco Fichtner say(path, "Unknown directory part");
747070c62a6SFranco Fichtner fts_set(f, ff, FTS_SKIP);
748070c62a6SFranco Fichtner break;
749070c62a6SFranco Fichtner case 2:
750070c62a6SFranco Fichtner /*
751070c62a6SFranco Fichtner * Possibly our architecture.
752070c62a6SFranco Fichtner * If we're descending, keep tabs on it.
753070c62a6SFranco Fichtner */
75454ba9607SSascha Wildner if (ff->fts_info != FTS_DP && dsec != NULL)
755070c62a6SFranco Fichtner arch = ff->fts_name;
756070c62a6SFranco Fichtner else
757070c62a6SFranco Fichtner arch = NULL;
758070c62a6SFranco Fichtner break;
759070c62a6SFranco Fichtner default:
76054ba9607SSascha Wildner if (ff->fts_info == FTS_DP || use_all)
761070c62a6SFranco Fichtner break;
762070c62a6SFranco Fichtner if (warnings)
763070c62a6SFranco Fichtner say(path, "Extraneous directory part");
764070c62a6SFranco Fichtner fts_set(f, ff, FTS_SKIP);
765070c62a6SFranco Fichtner break;
766070c62a6SFranco Fichtner }
767070c62a6SFranco Fichtner }
768070c62a6SFranco Fichtner
769070c62a6SFranco Fichtner fts_close(f);
77054ba9607SSascha Wildner return 1;
771070c62a6SFranco Fichtner }
772070c62a6SFranco Fichtner
773070c62a6SFranco Fichtner /*
774070c62a6SFranco Fichtner * Add a file to the mlinks table.
775070c62a6SFranco Fichtner * Do not verify that it's a "valid" looking manpage (we'll do that
776070c62a6SFranco Fichtner * later).
777070c62a6SFranco Fichtner *
778070c62a6SFranco Fichtner * Try to infer the manual section, architecture, and page name from the
779070c62a6SFranco Fichtner * path, assuming it looks like
780070c62a6SFranco Fichtner *
781070c62a6SFranco Fichtner * [./]man*[/<arch>]/<name>.<section>
782070c62a6SFranco Fichtner * or
783070c62a6SFranco Fichtner * [./]cat<section>[/<arch>]/<name>.0
784070c62a6SFranco Fichtner *
785070c62a6SFranco Fichtner * See treescan() for the fts(3) version of this.
786070c62a6SFranco Fichtner */
787070c62a6SFranco Fichtner static void
filescan(const char * infile)788*99db7d0eSSascha Wildner filescan(const char *infile)
789070c62a6SFranco Fichtner {
790070c62a6SFranco Fichtner struct stat st;
791070c62a6SFranco Fichtner struct mlink *mlink;
792*99db7d0eSSascha Wildner char *linkfile, *p, *realdir, *start, *usefile;
793*99db7d0eSSascha Wildner size_t realdir_len;
794070c62a6SFranco Fichtner
795070c62a6SFranco Fichtner assert(use_all);
796070c62a6SFranco Fichtner
797*99db7d0eSSascha Wildner if (strncmp(infile, "./", 2) == 0)
798*99db7d0eSSascha Wildner infile += 2;
799070c62a6SFranco Fichtner
800070c62a6SFranco Fichtner /*
801070c62a6SFranco Fichtner * We have to do lstat(2) before realpath(3) loses
802070c62a6SFranco Fichtner * the information whether this is a symbolic link.
803070c62a6SFranco Fichtner * We need to know that because for symbolic links,
804070c62a6SFranco Fichtner * we want to use the orginal file name, while for
805070c62a6SFranco Fichtner * regular files, we want to use the real path.
806070c62a6SFranco Fichtner */
807*99db7d0eSSascha Wildner if (lstat(infile, &st) == -1) {
808070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_BADARG;
809*99db7d0eSSascha Wildner say(infile, "&lstat");
810070c62a6SFranco Fichtner return;
811*99db7d0eSSascha Wildner } else if (S_ISREG(st.st_mode) == 0 && S_ISLNK(st.st_mode) == 0) {
812070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_BADARG;
813*99db7d0eSSascha Wildner say(infile, "Not a regular file");
814070c62a6SFranco Fichtner return;
815070c62a6SFranco Fichtner }
816070c62a6SFranco Fichtner
817070c62a6SFranco Fichtner /*
818070c62a6SFranco Fichtner * We have to resolve the file name to the real path
819070c62a6SFranco Fichtner * in any case for the base directory check.
820070c62a6SFranco Fichtner */
821*99db7d0eSSascha Wildner if ((usefile = realpath(infile, NULL)) == NULL) {
822070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_BADARG;
823*99db7d0eSSascha Wildner say(infile, "&realpath");
824070c62a6SFranco Fichtner return;
825070c62a6SFranco Fichtner }
826070c62a6SFranco Fichtner
827*99db7d0eSSascha Wildner if (op == OP_TEST)
828*99db7d0eSSascha Wildner start = usefile;
829*99db7d0eSSascha Wildner else if (strncmp(usefile, basedir, basedir_len) == 0)
830*99db7d0eSSascha Wildner start = usefile + basedir_len;
831*99db7d0eSSascha Wildner #ifdef READ_ALLOWED_PATH
832*99db7d0eSSascha Wildner else if (read_allowed(usefile))
833*99db7d0eSSascha Wildner start = usefile;
83454ba9607SSascha Wildner #endif
835070c62a6SFranco Fichtner else {
836070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_BADARG;
837*99db7d0eSSascha Wildner say("", "%s: outside base directory", infile);
838*99db7d0eSSascha Wildner free(usefile);
839070c62a6SFranco Fichtner return;
840070c62a6SFranco Fichtner }
841070c62a6SFranco Fichtner
842070c62a6SFranco Fichtner /*
843070c62a6SFranco Fichtner * Now we are sure the file is inside our tree.
844070c62a6SFranco Fichtner * If it is a symbolic link, ignore the real path
845070c62a6SFranco Fichtner * and use the original name.
846070c62a6SFranco Fichtner */
847*99db7d0eSSascha Wildner do {
848*99db7d0eSSascha Wildner if (S_ISLNK(st.st_mode) == 0)
849*99db7d0eSSascha Wildner break;
850*99db7d0eSSascha Wildner
851*99db7d0eSSascha Wildner /*
852*99db7d0eSSascha Wildner * Some implementations of realpath(3) may succeed
853*99db7d0eSSascha Wildner * even if the target of the link does not exist,
854*99db7d0eSSascha Wildner * so check again for extra safety.
855*99db7d0eSSascha Wildner */
856*99db7d0eSSascha Wildner if (stat(usefile, &st) == -1) {
857070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_BADARG;
858*99db7d0eSSascha Wildner say(infile, "&stat");
859*99db7d0eSSascha Wildner free(usefile);
860070c62a6SFranco Fichtner return;
861070c62a6SFranco Fichtner }
862*99db7d0eSSascha Wildner linkfile = mandoc_strdup(infile);
863*99db7d0eSSascha Wildner if (op == OP_TEST) {
864*99db7d0eSSascha Wildner free(usefile);
865*99db7d0eSSascha Wildner start = usefile = linkfile;
866*99db7d0eSSascha Wildner break;
867*99db7d0eSSascha Wildner }
868*99db7d0eSSascha Wildner if (strncmp(infile, basedir, basedir_len) == 0) {
869*99db7d0eSSascha Wildner free(usefile);
870*99db7d0eSSascha Wildner usefile = linkfile;
871*99db7d0eSSascha Wildner start = usefile + basedir_len;
872*99db7d0eSSascha Wildner break;
873*99db7d0eSSascha Wildner }
874*99db7d0eSSascha Wildner
875*99db7d0eSSascha Wildner /*
876*99db7d0eSSascha Wildner * This symbolic link points into the basedir
877*99db7d0eSSascha Wildner * from the outside. Let's see whether any of
878*99db7d0eSSascha Wildner * the parent directories resolve to the basedir.
879*99db7d0eSSascha Wildner */
880*99db7d0eSSascha Wildner p = strchr(linkfile, '\0');
881*99db7d0eSSascha Wildner do {
882*99db7d0eSSascha Wildner while (*--p != '/')
883*99db7d0eSSascha Wildner continue;
884*99db7d0eSSascha Wildner *p = '\0';
885*99db7d0eSSascha Wildner if ((realdir = realpath(linkfile, NULL)) == NULL) {
886*99db7d0eSSascha Wildner exitcode = (int)MANDOCLEVEL_BADARG;
887*99db7d0eSSascha Wildner say(infile, "&realpath");
888*99db7d0eSSascha Wildner free(linkfile);
889*99db7d0eSSascha Wildner free(usefile);
890070c62a6SFranco Fichtner return;
891070c62a6SFranco Fichtner }
892*99db7d0eSSascha Wildner realdir_len = strlen(realdir) + 1;
893*99db7d0eSSascha Wildner free(realdir);
894*99db7d0eSSascha Wildner *p = '/';
895*99db7d0eSSascha Wildner } while (realdir_len > basedir_len);
896*99db7d0eSSascha Wildner
897*99db7d0eSSascha Wildner /*
898*99db7d0eSSascha Wildner * If one of the directories resolves to the basedir,
899*99db7d0eSSascha Wildner * use the rest of the original name.
900*99db7d0eSSascha Wildner * Otherwise, the best we can do
901*99db7d0eSSascha Wildner * is to use the filename pointed to.
902*99db7d0eSSascha Wildner */
903*99db7d0eSSascha Wildner if (realdir_len == basedir_len) {
904*99db7d0eSSascha Wildner free(usefile);
905*99db7d0eSSascha Wildner usefile = linkfile;
906*99db7d0eSSascha Wildner start = p + 1;
907*99db7d0eSSascha Wildner } else {
908*99db7d0eSSascha Wildner free(linkfile);
909*99db7d0eSSascha Wildner start = usefile + basedir_len;
910070c62a6SFranco Fichtner }
911*99db7d0eSSascha Wildner } while (/* CONSTCOND */ 0);
912070c62a6SFranco Fichtner
913070c62a6SFranco Fichtner mlink = mandoc_calloc(1, sizeof(struct mlink));
91454ba9607SSascha Wildner mlink->dform = FORM_NONE;
915070c62a6SFranco Fichtner if (strlcpy(mlink->file, start, sizeof(mlink->file)) >=
916070c62a6SFranco Fichtner sizeof(mlink->file)) {
917070c62a6SFranco Fichtner say(start, "Filename too long");
91854ba9607SSascha Wildner free(mlink);
919*99db7d0eSSascha Wildner free(usefile);
920070c62a6SFranco Fichtner return;
921070c62a6SFranco Fichtner }
922070c62a6SFranco Fichtner
923070c62a6SFranco Fichtner /*
92454ba9607SSascha Wildner * In test mode or when the original name is absolute
92554ba9607SSascha Wildner * but outside our tree, guess the base directory.
92654ba9607SSascha Wildner */
92754ba9607SSascha Wildner
928*99db7d0eSSascha Wildner if (op == OP_TEST || (start == usefile && *start == '/')) {
929*99db7d0eSSascha Wildner if (strncmp(usefile, "man/", 4) == 0)
930*99db7d0eSSascha Wildner start = usefile + 4;
931*99db7d0eSSascha Wildner else if ((start = strstr(usefile, "/man/")) != NULL)
93254ba9607SSascha Wildner start += 5;
93354ba9607SSascha Wildner else
934*99db7d0eSSascha Wildner start = usefile;
93554ba9607SSascha Wildner }
93654ba9607SSascha Wildner
93754ba9607SSascha Wildner /*
938070c62a6SFranco Fichtner * First try to guess our directory structure.
939070c62a6SFranco Fichtner * If we find a separator, try to look for man* or cat*.
940070c62a6SFranco Fichtner * If we find one of these and what's underneath is a directory,
941070c62a6SFranco Fichtner * assume it's an architecture.
942070c62a6SFranco Fichtner */
943*99db7d0eSSascha Wildner if ((p = strchr(start, '/')) != NULL) {
944070c62a6SFranco Fichtner *p++ = '\0';
945*99db7d0eSSascha Wildner if (strncmp(start, "man", 3) == 0) {
946070c62a6SFranco Fichtner mlink->dform = FORM_SRC;
947070c62a6SFranco Fichtner mlink->dsec = start + 3;
948*99db7d0eSSascha Wildner } else if (strncmp(start, "cat", 3) == 0) {
949070c62a6SFranco Fichtner mlink->dform = FORM_CAT;
950070c62a6SFranco Fichtner mlink->dsec = start + 3;
951070c62a6SFranco Fichtner }
952070c62a6SFranco Fichtner
953070c62a6SFranco Fichtner start = p;
954*99db7d0eSSascha Wildner if (mlink->dsec != NULL && (p = strchr(start, '/')) != NULL) {
955070c62a6SFranco Fichtner *p++ = '\0';
956070c62a6SFranco Fichtner mlink->arch = start;
957070c62a6SFranco Fichtner start = p;
958070c62a6SFranco Fichtner }
959070c62a6SFranco Fichtner }
960070c62a6SFranco Fichtner
961070c62a6SFranco Fichtner /*
962070c62a6SFranco Fichtner * Now check the file suffix.
963070c62a6SFranco Fichtner * Suffix of `.0' indicates a catpage, `.1-9' is a manpage.
964070c62a6SFranco Fichtner */
965070c62a6SFranco Fichtner p = strrchr(start, '\0');
966*99db7d0eSSascha Wildner while (p-- > start && *p != '/' && *p != '.')
967*99db7d0eSSascha Wildner continue;
968070c62a6SFranco Fichtner
969*99db7d0eSSascha Wildner if (*p == '.') {
970070c62a6SFranco Fichtner *p++ = '\0';
971070c62a6SFranco Fichtner mlink->fsec = p;
972070c62a6SFranco Fichtner }
973070c62a6SFranco Fichtner
974070c62a6SFranco Fichtner /*
975070c62a6SFranco Fichtner * Now try to parse the name.
976070c62a6SFranco Fichtner * Use the filename portion of the path.
977070c62a6SFranco Fichtner */
978070c62a6SFranco Fichtner mlink->name = start;
979*99db7d0eSSascha Wildner if ((p = strrchr(start, '/')) != NULL) {
980070c62a6SFranco Fichtner mlink->name = p + 1;
981070c62a6SFranco Fichtner *p = '\0';
982070c62a6SFranco Fichtner }
983070c62a6SFranco Fichtner mlink_add(mlink, &st);
984*99db7d0eSSascha Wildner free(usefile);
985070c62a6SFranco Fichtner }
986070c62a6SFranco Fichtner
987070c62a6SFranco Fichtner static void
mlink_add(struct mlink * mlink,const struct stat * st)988070c62a6SFranco Fichtner mlink_add(struct mlink *mlink, const struct stat *st)
989070c62a6SFranco Fichtner {
990070c62a6SFranco Fichtner struct inodev inodev;
991070c62a6SFranco Fichtner struct mpage *mpage;
992070c62a6SFranco Fichtner unsigned int slot;
993070c62a6SFranco Fichtner
994070c62a6SFranco Fichtner assert(NULL != mlink->file);
995070c62a6SFranco Fichtner
996070c62a6SFranco Fichtner mlink->dsec = mandoc_strdup(mlink->dsec ? mlink->dsec : "");
997070c62a6SFranco Fichtner mlink->arch = mandoc_strdup(mlink->arch ? mlink->arch : "");
998070c62a6SFranco Fichtner mlink->name = mandoc_strdup(mlink->name ? mlink->name : "");
999070c62a6SFranco Fichtner mlink->fsec = mandoc_strdup(mlink->fsec ? mlink->fsec : "");
1000070c62a6SFranco Fichtner
1001070c62a6SFranco Fichtner if ('0' == *mlink->fsec) {
1002070c62a6SFranco Fichtner free(mlink->fsec);
1003070c62a6SFranco Fichtner mlink->fsec = mandoc_strdup(mlink->dsec);
1004070c62a6SFranco Fichtner mlink->fform = FORM_CAT;
1005070c62a6SFranco Fichtner } else if ('1' <= *mlink->fsec && '9' >= *mlink->fsec)
1006070c62a6SFranco Fichtner mlink->fform = FORM_SRC;
1007070c62a6SFranco Fichtner else
1008070c62a6SFranco Fichtner mlink->fform = FORM_NONE;
1009070c62a6SFranco Fichtner
1010070c62a6SFranco Fichtner slot = ohash_qlookup(&mlinks, mlink->file);
1011070c62a6SFranco Fichtner assert(NULL == ohash_find(&mlinks, slot));
1012070c62a6SFranco Fichtner ohash_insert(&mlinks, slot, mlink);
1013070c62a6SFranco Fichtner
101454ba9607SSascha Wildner memset(&inodev, 0, sizeof(inodev)); /* Clear padding. */
1015070c62a6SFranco Fichtner inodev.st_ino = st->st_ino;
1016070c62a6SFranco Fichtner inodev.st_dev = st->st_dev;
1017070c62a6SFranco Fichtner slot = ohash_lookup_memory(&mpages, (char *)&inodev,
1018070c62a6SFranco Fichtner sizeof(struct inodev), inodev.st_ino);
1019070c62a6SFranco Fichtner mpage = ohash_find(&mpages, slot);
1020070c62a6SFranco Fichtner if (NULL == mpage) {
1021070c62a6SFranco Fichtner mpage = mandoc_calloc(1, sizeof(struct mpage));
1022070c62a6SFranco Fichtner mpage->inodev.st_ino = inodev.st_ino;
1023070c62a6SFranco Fichtner mpage->inodev.st_dev = inodev.st_dev;
102454ba9607SSascha Wildner mpage->form = FORM_NONE;
102554ba9607SSascha Wildner mpage->next = mpage_head;
102654ba9607SSascha Wildner mpage_head = mpage;
1027070c62a6SFranco Fichtner ohash_insert(&mpages, slot, mpage);
1028070c62a6SFranco Fichtner } else
1029070c62a6SFranco Fichtner mlink->next = mpage->mlinks;
1030070c62a6SFranco Fichtner mpage->mlinks = mlink;
1031070c62a6SFranco Fichtner mlink->mpage = mpage;
1032070c62a6SFranco Fichtner }
1033070c62a6SFranco Fichtner
1034070c62a6SFranco Fichtner static void
mlink_free(struct mlink * mlink)1035070c62a6SFranco Fichtner mlink_free(struct mlink *mlink)
1036070c62a6SFranco Fichtner {
1037070c62a6SFranco Fichtner
1038070c62a6SFranco Fichtner free(mlink->dsec);
1039070c62a6SFranco Fichtner free(mlink->arch);
1040070c62a6SFranco Fichtner free(mlink->name);
1041070c62a6SFranco Fichtner free(mlink->fsec);
1042070c62a6SFranco Fichtner free(mlink);
1043070c62a6SFranco Fichtner }
1044070c62a6SFranco Fichtner
1045070c62a6SFranco Fichtner static void
mpages_free(void)1046070c62a6SFranco Fichtner mpages_free(void)
1047070c62a6SFranco Fichtner {
1048070c62a6SFranco Fichtner struct mpage *mpage;
1049070c62a6SFranco Fichtner struct mlink *mlink;
1050070c62a6SFranco Fichtner
105154ba9607SSascha Wildner while ((mpage = mpage_head) != NULL) {
105254ba9607SSascha Wildner while ((mlink = mpage->mlinks) != NULL) {
1053070c62a6SFranco Fichtner mpage->mlinks = mlink->next;
1054070c62a6SFranco Fichtner mlink_free(mlink);
1055070c62a6SFranco Fichtner }
105654ba9607SSascha Wildner mpage_head = mpage->next;
1057070c62a6SFranco Fichtner free(mpage->sec);
1058070c62a6SFranco Fichtner free(mpage->arch);
1059070c62a6SFranco Fichtner free(mpage->title);
1060070c62a6SFranco Fichtner free(mpage->desc);
1061070c62a6SFranco Fichtner free(mpage);
1062070c62a6SFranco Fichtner }
1063070c62a6SFranco Fichtner }
1064070c62a6SFranco Fichtner
1065070c62a6SFranco Fichtner /*
1066070c62a6SFranco Fichtner * For each mlink to the mpage, check whether the path looks like
1067070c62a6SFranco Fichtner * it is formatted, and if it does, check whether a source manual
1068070c62a6SFranco Fichtner * exists by the same name, ignoring the suffix.
1069070c62a6SFranco Fichtner * If both conditions hold, drop the mlink.
1070070c62a6SFranco Fichtner */
1071070c62a6SFranco Fichtner static void
mlinks_undupe(struct mpage * mpage)1072070c62a6SFranco Fichtner mlinks_undupe(struct mpage *mpage)
1073070c62a6SFranco Fichtner {
1074070c62a6SFranco Fichtner char buf[PATH_MAX];
1075070c62a6SFranco Fichtner struct mlink **prev;
1076070c62a6SFranco Fichtner struct mlink *mlink;
1077070c62a6SFranco Fichtner char *bufp;
1078070c62a6SFranco Fichtner
1079070c62a6SFranco Fichtner mpage->form = FORM_CAT;
1080070c62a6SFranco Fichtner prev = &mpage->mlinks;
1081070c62a6SFranco Fichtner while (NULL != (mlink = *prev)) {
1082070c62a6SFranco Fichtner if (FORM_CAT != mlink->dform) {
1083070c62a6SFranco Fichtner mpage->form = FORM_NONE;
1084070c62a6SFranco Fichtner goto nextlink;
1085070c62a6SFranco Fichtner }
1086070c62a6SFranco Fichtner (void)strlcpy(buf, mlink->file, sizeof(buf));
1087070c62a6SFranco Fichtner bufp = strstr(buf, "cat");
1088070c62a6SFranco Fichtner assert(NULL != bufp);
1089070c62a6SFranco Fichtner memcpy(bufp, "man", 3);
1090070c62a6SFranco Fichtner if (NULL != (bufp = strrchr(buf, '.')))
1091070c62a6SFranco Fichtner *++bufp = '\0';
1092070c62a6SFranco Fichtner (void)strlcat(buf, mlink->dsec, sizeof(buf));
1093070c62a6SFranco Fichtner if (NULL == ohash_find(&mlinks,
1094070c62a6SFranco Fichtner ohash_qlookup(&mlinks, buf)))
1095070c62a6SFranco Fichtner goto nextlink;
1096070c62a6SFranco Fichtner if (warnings)
1097070c62a6SFranco Fichtner say(mlink->file, "Man source exists: %s", buf);
1098070c62a6SFranco Fichtner if (use_all)
1099070c62a6SFranco Fichtner goto nextlink;
1100070c62a6SFranco Fichtner *prev = mlink->next;
1101070c62a6SFranco Fichtner mlink_free(mlink);
1102070c62a6SFranco Fichtner continue;
1103070c62a6SFranco Fichtner nextlink:
1104070c62a6SFranco Fichtner prev = &(*prev)->next;
1105070c62a6SFranco Fichtner }
1106070c62a6SFranco Fichtner }
1107070c62a6SFranco Fichtner
1108070c62a6SFranco Fichtner static void
mlink_check(struct mpage * mpage,struct mlink * mlink)1109070c62a6SFranco Fichtner mlink_check(struct mpage *mpage, struct mlink *mlink)
1110070c62a6SFranco Fichtner {
1111070c62a6SFranco Fichtner struct str *str;
1112070c62a6SFranco Fichtner unsigned int slot;
111336342e81SSascha Wildner
111436342e81SSascha Wildner /*
111536342e81SSascha Wildner * Check whether the manual section given in a file
111636342e81SSascha Wildner * agrees with the directory where the file is located.
111736342e81SSascha Wildner * Some manuals have suffixes like (3p) on their
111836342e81SSascha Wildner * section number either inside the file or in the
111936342e81SSascha Wildner * directory name, some are linked into more than one
1120070c62a6SFranco Fichtner * section, like encrypt(1) = makekey(8).
112136342e81SSascha Wildner */
112236342e81SSascha Wildner
1123070c62a6SFranco Fichtner if (FORM_SRC == mpage->form &&
1124070c62a6SFranco Fichtner strcasecmp(mpage->sec, mlink->dsec))
1125070c62a6SFranco Fichtner say(mlink->file, "Section \"%s\" manual in %s directory",
1126070c62a6SFranco Fichtner mpage->sec, mlink->dsec);
1127f88b6c16SFranco Fichtner
112836342e81SSascha Wildner /*
112936342e81SSascha Wildner * Manual page directories exist for each kernel
113036342e81SSascha Wildner * architecture as returned by machine(1).
113136342e81SSascha Wildner * However, many manuals only depend on the
113236342e81SSascha Wildner * application architecture as returned by arch(1).
113336342e81SSascha Wildner * For example, some (2/ARM) manuals are shared
113436342e81SSascha Wildner * across the "armish" and "zaurus" kernel
113536342e81SSascha Wildner * architectures.
113636342e81SSascha Wildner * A few manuals are even shared across completely
113736342e81SSascha Wildner * different architectures, for example fdformat(1)
113854ba9607SSascha Wildner * on amd64, i386, and sparc64.
113936342e81SSascha Wildner */
114036342e81SSascha Wildner
1141070c62a6SFranco Fichtner if (strcasecmp(mpage->arch, mlink->arch))
1142070c62a6SFranco Fichtner say(mlink->file, "Architecture \"%s\" manual in "
1143070c62a6SFranco Fichtner "\"%s\" directory", mpage->arch, mlink->arch);
114436342e81SSascha Wildner
114536342e81SSascha Wildner /*
1146070c62a6SFranco Fichtner * XXX
1147070c62a6SFranco Fichtner * parse_cat() doesn't set NAME_TITLE yet.
114836342e81SSascha Wildner */
114936342e81SSascha Wildner
1150070c62a6SFranco Fichtner if (FORM_CAT == mpage->form)
115136342e81SSascha Wildner return;
115236342e81SSascha Wildner
1153070c62a6SFranco Fichtner /*
1154070c62a6SFranco Fichtner * Check whether this mlink
1155070c62a6SFranco Fichtner * appears as a name in the NAME section.
1156070c62a6SFranco Fichtner */
115736342e81SSascha Wildner
1158070c62a6SFranco Fichtner slot = ohash_qlookup(&names, mlink->name);
1159070c62a6SFranco Fichtner str = ohash_find(&names, slot);
1160070c62a6SFranco Fichtner assert(NULL != str);
1161070c62a6SFranco Fichtner if ( ! (NAME_TITLE & str->mask))
1162070c62a6SFranco Fichtner say(mlink->file, "Name missing in NAME section");
116336342e81SSascha Wildner }
116436342e81SSascha Wildner
116536342e81SSascha Wildner /*
1166070c62a6SFranco Fichtner * Run through the files in the global vector "mpages"
1167070c62a6SFranco Fichtner * and add them to the database specified in "basedir".
1168070c62a6SFranco Fichtner *
1169070c62a6SFranco Fichtner * This handles the parsing scheme itself, using the cues of directory
1170070c62a6SFranco Fichtner * and filename to determine whether the file is parsable or not.
117136342e81SSascha Wildner */
117236342e81SSascha Wildner static void
mpages_merge(struct dba * dba,struct mparse * mp)117354ba9607SSascha Wildner mpages_merge(struct dba *dba, struct mparse *mp)
117436342e81SSascha Wildner {
1175070c62a6SFranco Fichtner struct mpage *mpage, *mpage_dest;
1176070c62a6SFranco Fichtner struct mlink *mlink, *mlink_dest;
117754ba9607SSascha Wildner struct roff_meta *meta;
1178070c62a6SFranco Fichtner char *cp;
117954ba9607SSascha Wildner int fd;
118036342e81SSascha Wildner
118154ba9607SSascha Wildner for (mpage = mpage_head; mpage != NULL; mpage = mpage->next) {
1182070c62a6SFranco Fichtner mlinks_undupe(mpage);
118354ba9607SSascha Wildner if ((mlink = mpage->mlinks) == NULL)
118436342e81SSascha Wildner continue;
118536342e81SSascha Wildner
1186070c62a6SFranco Fichtner name_mask = NAME_MASK;
118754ba9607SSascha Wildner mandoc_ohash_init(&names, 4, offsetof(struct str, key));
118854ba9607SSascha Wildner mandoc_ohash_init(&strings, 6, offsetof(struct str, key));
1189070c62a6SFranco Fichtner mparse_reset(mp);
119054ba9607SSascha Wildner meta = NULL;
1191070c62a6SFranco Fichtner
119254ba9607SSascha Wildner if ((fd = mparse_open(mp, mlink->file)) == -1) {
119354ba9607SSascha Wildner say(mlink->file, "&open");
1194070c62a6SFranco Fichtner goto nextpage;
119536342e81SSascha Wildner }
119636342e81SSascha Wildner
119736342e81SSascha Wildner /*
119854ba9607SSascha Wildner * Interpret the file as mdoc(7) or man(7) source
119954ba9607SSascha Wildner * code, unless it is known to be formatted.
120036342e81SSascha Wildner */
120154ba9607SSascha Wildner if (mlink->dform != FORM_CAT || mlink->fform != FORM_CAT) {
120254ba9607SSascha Wildner mparse_readfd(mp, fd, mlink->file);
120354ba9607SSascha Wildner close(fd);
120454ba9607SSascha Wildner fd = -1;
120554ba9607SSascha Wildner meta = mparse_result(mp);
1206070c62a6SFranco Fichtner }
1207070c62a6SFranco Fichtner
120854ba9607SSascha Wildner if (meta != NULL && meta->sodest != NULL) {
1209070c62a6SFranco Fichtner mlink_dest = ohash_find(&mlinks,
121054ba9607SSascha Wildner ohash_qlookup(&mlinks, meta->sodest));
121154ba9607SSascha Wildner if (mlink_dest == NULL) {
121254ba9607SSascha Wildner mandoc_asprintf(&cp, "%s.gz", meta->sodest);
121354ba9607SSascha Wildner mlink_dest = ohash_find(&mlinks,
121454ba9607SSascha Wildner ohash_qlookup(&mlinks, cp));
121554ba9607SSascha Wildner free(cp);
121654ba9607SSascha Wildner }
121754ba9607SSascha Wildner if (mlink_dest != NULL) {
1218070c62a6SFranco Fichtner
1219070c62a6SFranco Fichtner /* The .so target exists. */
1220070c62a6SFranco Fichtner
1221070c62a6SFranco Fichtner mpage_dest = mlink_dest->mpage;
1222070c62a6SFranco Fichtner while (1) {
1223070c62a6SFranco Fichtner mlink->mpage = mpage_dest;
1224070c62a6SFranco Fichtner
1225070c62a6SFranco Fichtner /*
1226070c62a6SFranco Fichtner * If the target was already
1227070c62a6SFranco Fichtner * processed, add the links
1228070c62a6SFranco Fichtner * to the database now.
1229070c62a6SFranco Fichtner * Otherwise, this will
1230070c62a6SFranco Fichtner * happen when we come
1231070c62a6SFranco Fichtner * to the target.
1232070c62a6SFranco Fichtner */
1233070c62a6SFranco Fichtner
123454ba9607SSascha Wildner if (mpage_dest->dba != NULL)
1235070c62a6SFranco Fichtner dbadd_mlink(mlink);
1236070c62a6SFranco Fichtner
123754ba9607SSascha Wildner if (mlink->next == NULL)
1238070c62a6SFranco Fichtner break;
1239070c62a6SFranco Fichtner mlink = mlink->next;
1240070c62a6SFranco Fichtner }
1241070c62a6SFranco Fichtner
1242070c62a6SFranco Fichtner /* Move all links to the target. */
1243070c62a6SFranco Fichtner
1244070c62a6SFranco Fichtner mlink->next = mlink_dest->next;
1245070c62a6SFranco Fichtner mlink_dest->next = mpage->mlinks;
1246070c62a6SFranco Fichtner mpage->mlinks = NULL;
1247070c62a6SFranco Fichtner goto nextpage;
1248*99db7d0eSSascha Wildner }
1249*99db7d0eSSascha Wildner meta->macroset = MACROSET_NONE;
1250*99db7d0eSSascha Wildner }
1251*99db7d0eSSascha Wildner if (meta != NULL && meta->macroset == MACROSET_MDOC) {
1252070c62a6SFranco Fichtner mpage->form = FORM_SRC;
125354ba9607SSascha Wildner mpage->sec = meta->msec;
1254070c62a6SFranco Fichtner mpage->sec = mandoc_strdup(
125554ba9607SSascha Wildner mpage->sec == NULL ? "" : mpage->sec);
125654ba9607SSascha Wildner mpage->arch = meta->arch;
1257070c62a6SFranco Fichtner mpage->arch = mandoc_strdup(
125854ba9607SSascha Wildner mpage->arch == NULL ? "" : mpage->arch);
125954ba9607SSascha Wildner mpage->title = mandoc_strdup(meta->title);
126054ba9607SSascha Wildner } else if (meta != NULL && meta->macroset == MACROSET_MAN) {
126154ba9607SSascha Wildner if (*meta->msec != '\0' || *meta->title != '\0') {
1262070c62a6SFranco Fichtner mpage->form = FORM_SRC;
126354ba9607SSascha Wildner mpage->sec = mandoc_strdup(meta->msec);
126454ba9607SSascha Wildner mpage->arch = mandoc_strdup(mlink->arch);
126554ba9607SSascha Wildner mpage->title = mandoc_strdup(meta->title);
126654ba9607SSascha Wildner } else
126754ba9607SSascha Wildner meta = NULL;
126854ba9607SSascha Wildner }
126954ba9607SSascha Wildner
127054ba9607SSascha Wildner assert(mpage->desc == NULL);
1271*99db7d0eSSascha Wildner if (meta == NULL || meta->sodest != NULL) {
127254ba9607SSascha Wildner mpage->sec = mandoc_strdup(mlink->dsec);
127354ba9607SSascha Wildner mpage->arch = mandoc_strdup(mlink->arch);
127454ba9607SSascha Wildner mpage->title = mandoc_strdup(mlink->name);
1275*99db7d0eSSascha Wildner if (meta == NULL) {
1276*99db7d0eSSascha Wildner mpage->form = FORM_CAT;
127754ba9607SSascha Wildner parse_cat(mpage, fd);
1278*99db7d0eSSascha Wildner } else
1279*99db7d0eSSascha Wildner mpage->form = FORM_SRC;
128054ba9607SSascha Wildner } else if (meta->macroset == MACROSET_MDOC)
128154ba9607SSascha Wildner parse_mdoc(mpage, meta, meta->first);
1282070c62a6SFranco Fichtner else
128354ba9607SSascha Wildner parse_man(mpage, meta, meta->first);
128454ba9607SSascha Wildner if (mpage->desc == NULL) {
128554ba9607SSascha Wildner mpage->desc = mandoc_strdup(mlink->name);
128654ba9607SSascha Wildner if (warnings)
128754ba9607SSascha Wildner say(mlink->file, "No one-line description, "
128854ba9607SSascha Wildner "using filename \"%s\"", mlink->name);
128954ba9607SSascha Wildner }
1290070c62a6SFranco Fichtner
129154ba9607SSascha Wildner for (mlink = mpage->mlinks;
129254ba9607SSascha Wildner mlink != NULL;
129354ba9607SSascha Wildner mlink = mlink->next) {
129454ba9607SSascha Wildner putkey(mpage, mlink->name, NAME_FILE);
1295070c62a6SFranco Fichtner if (warnings && !use_all)
1296070c62a6SFranco Fichtner mlink_check(mpage, mlink);
129754ba9607SSascha Wildner }
1298070c62a6SFranco Fichtner
129954ba9607SSascha Wildner dbadd(dba, mpage);
1300070c62a6SFranco Fichtner
1301070c62a6SFranco Fichtner nextpage:
1302070c62a6SFranco Fichtner ohash_delete(&strings);
1303070c62a6SFranco Fichtner ohash_delete(&names);
1304070c62a6SFranco Fichtner }
1305070c62a6SFranco Fichtner }
1306070c62a6SFranco Fichtner
1307070c62a6SFranco Fichtner static void
parse_cat(struct mpage * mpage,int fd)1308070c62a6SFranco Fichtner parse_cat(struct mpage *mpage, int fd)
130936342e81SSascha Wildner {
131036342e81SSascha Wildner FILE *stream;
131154ba9607SSascha Wildner struct mlink *mlink;
131254ba9607SSascha Wildner char *line, *p, *title, *sec;
131354ba9607SSascha Wildner size_t linesz, plen, titlesz;
131454ba9607SSascha Wildner ssize_t len;
131554ba9607SSascha Wildner int offs;
131636342e81SSascha Wildner
131754ba9607SSascha Wildner mlink = mpage->mlinks;
131854ba9607SSascha Wildner stream = fd == -1 ? fopen(mlink->file, "r") : fdopen(fd, "r");
131954ba9607SSascha Wildner if (stream == NULL) {
132054ba9607SSascha Wildner if (fd != -1)
132154ba9607SSascha Wildner close(fd);
1322f88b6c16SFranco Fichtner if (warnings)
132354ba9607SSascha Wildner say(mlink->file, "&fopen");
132436342e81SSascha Wildner return;
132536342e81SSascha Wildner }
132636342e81SSascha Wildner
132754ba9607SSascha Wildner line = NULL;
132854ba9607SSascha Wildner linesz = 0;
132954ba9607SSascha Wildner
133054ba9607SSascha Wildner /* Parse the section number from the header line. */
133154ba9607SSascha Wildner
133254ba9607SSascha Wildner while (getline(&line, &linesz, stream) != -1) {
133354ba9607SSascha Wildner if (*line == '\n')
133454ba9607SSascha Wildner continue;
133554ba9607SSascha Wildner if ((sec = strchr(line, '(')) == NULL)
133654ba9607SSascha Wildner break;
133754ba9607SSascha Wildner if ((p = strchr(++sec, ')')) == NULL)
133854ba9607SSascha Wildner break;
133954ba9607SSascha Wildner free(mpage->sec);
134054ba9607SSascha Wildner mpage->sec = mandoc_strndup(sec, p - sec);
134154ba9607SSascha Wildner if (warnings && *mlink->dsec != '\0' &&
134254ba9607SSascha Wildner strcasecmp(mpage->sec, mlink->dsec))
134354ba9607SSascha Wildner say(mlink->file,
134454ba9607SSascha Wildner "Section \"%s\" manual in %s directory",
134554ba9607SSascha Wildner mpage->sec, mlink->dsec);
134654ba9607SSascha Wildner break;
134754ba9607SSascha Wildner }
134854ba9607SSascha Wildner
134936342e81SSascha Wildner /* Skip to first blank line. */
135036342e81SSascha Wildner
135154ba9607SSascha Wildner while (line == NULL || *line != '\n')
135254ba9607SSascha Wildner if (getline(&line, &linesz, stream) == -1)
135336342e81SSascha Wildner break;
135436342e81SSascha Wildner
135536342e81SSascha Wildner /*
135636342e81SSascha Wildner * Assume the first line that is not indented
135736342e81SSascha Wildner * is the first section header. Skip to it.
135836342e81SSascha Wildner */
135936342e81SSascha Wildner
136054ba9607SSascha Wildner while (getline(&line, &linesz, stream) != -1)
136154ba9607SSascha Wildner if (*line != '\n' && *line != ' ')
136236342e81SSascha Wildner break;
136336342e81SSascha Wildner
136436342e81SSascha Wildner /*
136536342e81SSascha Wildner * Read up until the next section into a buffer.
136636342e81SSascha Wildner * Strip the leading and trailing newline from each read line,
136736342e81SSascha Wildner * appending a trailing space.
136836342e81SSascha Wildner * Ignore empty (whitespace-only) lines.
136936342e81SSascha Wildner */
137036342e81SSascha Wildner
137136342e81SSascha Wildner titlesz = 0;
137236342e81SSascha Wildner title = NULL;
137336342e81SSascha Wildner
137454ba9607SSascha Wildner while ((len = getline(&line, &linesz, stream)) != -1) {
137554ba9607SSascha Wildner if (*line != ' ')
137636342e81SSascha Wildner break;
137754ba9607SSascha Wildner offs = 0;
137854ba9607SSascha Wildner while (isspace((unsigned char)line[offs]))
137954ba9607SSascha Wildner offs++;
138054ba9607SSascha Wildner if (line[offs] == '\0')
138136342e81SSascha Wildner continue;
138254ba9607SSascha Wildner title = mandoc_realloc(title, titlesz + len - offs);
138354ba9607SSascha Wildner memcpy(title + titlesz, line + offs, len - offs);
138454ba9607SSascha Wildner titlesz += len - offs;
1385070c62a6SFranco Fichtner title[titlesz - 1] = ' ';
138636342e81SSascha Wildner }
138754ba9607SSascha Wildner free(line);
138836342e81SSascha Wildner
138936342e81SSascha Wildner /*
139036342e81SSascha Wildner * If no page content can be found, or the input line
139136342e81SSascha Wildner * is already the next section header, or there is no
139236342e81SSascha Wildner * trailing newline, reuse the page title as the page
139336342e81SSascha Wildner * description.
139436342e81SSascha Wildner */
139536342e81SSascha Wildner
139636342e81SSascha Wildner if (NULL == title || '\0' == *title) {
1397f88b6c16SFranco Fichtner if (warnings)
139854ba9607SSascha Wildner say(mlink->file, "Cannot find NAME section");
139936342e81SSascha Wildner fclose(stream);
140036342e81SSascha Wildner free(title);
140136342e81SSascha Wildner return;
140236342e81SSascha Wildner }
140336342e81SSascha Wildner
140454ba9607SSascha Wildner title[titlesz - 1] = '\0';
140536342e81SSascha Wildner
140636342e81SSascha Wildner /*
140736342e81SSascha Wildner * Skip to the first dash.
140836342e81SSascha Wildner * Use the remaining line as the description (no more than 70
140936342e81SSascha Wildner * bytes).
141036342e81SSascha Wildner */
141136342e81SSascha Wildner
141236342e81SSascha Wildner if (NULL != (p = strstr(title, "- "))) {
141336342e81SSascha Wildner for (p += 2; ' ' == *p || '\b' == *p; p++)
141436342e81SSascha Wildner /* Skip to next word. */ ;
141536342e81SSascha Wildner } else {
1416f88b6c16SFranco Fichtner if (warnings)
141754ba9607SSascha Wildner say(mlink->file, "No dash in title line, "
141854ba9607SSascha Wildner "reusing \"%s\" as one-line description", title);
141936342e81SSascha Wildner p = title;
142036342e81SSascha Wildner }
142136342e81SSascha Wildner
142236342e81SSascha Wildner plen = strlen(p);
142336342e81SSascha Wildner
142436342e81SSascha Wildner /* Strip backspace-encoding from line. */
142536342e81SSascha Wildner
142636342e81SSascha Wildner while (NULL != (line = memchr(p, '\b', plen))) {
142736342e81SSascha Wildner len = line - p;
142836342e81SSascha Wildner if (0 == len) {
142936342e81SSascha Wildner memmove(line, line + 1, plen--);
143036342e81SSascha Wildner continue;
143136342e81SSascha Wildner }
143236342e81SSascha Wildner memmove(line - 1, line + 1, plen - len);
143336342e81SSascha Wildner plen -= 2;
143436342e81SSascha Wildner }
143536342e81SSascha Wildner
143654ba9607SSascha Wildner /*
143754ba9607SSascha Wildner * Cut off excessive one-line descriptions.
143854ba9607SSascha Wildner * Bad pages are not worth better heuristics.
143954ba9607SSascha Wildner */
144054ba9607SSascha Wildner
144154ba9607SSascha Wildner mpage->desc = mandoc_strndup(p, 150);
144236342e81SSascha Wildner fclose(stream);
144336342e81SSascha Wildner free(title);
144436342e81SSascha Wildner }
144536342e81SSascha Wildner
1446070c62a6SFranco Fichtner /*
1447070c62a6SFranco Fichtner * Put a type/word pair into the word database for this particular file.
1448070c62a6SFranco Fichtner */
144936342e81SSascha Wildner static void
putkey(const struct mpage * mpage,char * value,uint64_t type)1450070c62a6SFranco Fichtner putkey(const struct mpage *mpage, char *value, uint64_t type)
145136342e81SSascha Wildner {
1452070c62a6SFranco Fichtner putkeys(mpage, value, strlen(value), type);
1453f88b6c16SFranco Fichtner }
145436342e81SSascha Wildner
145536342e81SSascha Wildner /*
1456070c62a6SFranco Fichtner * Grok all nodes at or below a certain mdoc node into putkey().
1457070c62a6SFranco Fichtner */
1458070c62a6SFranco Fichtner static void
putmdockey(const struct mpage * mpage,const struct roff_node * n,uint64_t m,int taboo)1459070c62a6SFranco Fichtner putmdockey(const struct mpage *mpage,
146054ba9607SSascha Wildner const struct roff_node *n, uint64_t m, int taboo)
1461070c62a6SFranco Fichtner {
1462070c62a6SFranco Fichtner
1463070c62a6SFranco Fichtner for ( ; NULL != n; n = n->next) {
146454ba9607SSascha Wildner if (n->flags & taboo)
146554ba9607SSascha Wildner continue;
1466070c62a6SFranco Fichtner if (NULL != n->child)
146754ba9607SSascha Wildner putmdockey(mpage, n->child, m, taboo);
146854ba9607SSascha Wildner if (n->type == ROFFT_TEXT)
1469070c62a6SFranco Fichtner putkey(mpage, n->string, m);
1470070c62a6SFranco Fichtner }
1471070c62a6SFranco Fichtner }
1472070c62a6SFranco Fichtner
1473070c62a6SFranco Fichtner static void
parse_man(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)147454ba9607SSascha Wildner parse_man(struct mpage *mpage, const struct roff_meta *meta,
147554ba9607SSascha Wildner const struct roff_node *n)
1476070c62a6SFranco Fichtner {
147754ba9607SSascha Wildner const struct roff_node *head, *body;
1478070c62a6SFranco Fichtner char *start, *title;
1479070c62a6SFranco Fichtner char byte;
1480070c62a6SFranco Fichtner size_t sz;
1481070c62a6SFranco Fichtner
148254ba9607SSascha Wildner if (n == NULL)
1483070c62a6SFranco Fichtner return;
1484070c62a6SFranco Fichtner
1485070c62a6SFranco Fichtner /*
1486070c62a6SFranco Fichtner * We're only searching for one thing: the first text child in
1487070c62a6SFranco Fichtner * the BODY of a NAME section. Since we don't keep track of
1488070c62a6SFranco Fichtner * sections in -man, run some hoops to find out whether we're in
1489070c62a6SFranco Fichtner * the correct section or not.
149036342e81SSascha Wildner */
149136342e81SSascha Wildner
149254ba9607SSascha Wildner if (n->type == ROFFT_BODY && n->tok == MAN_SH) {
1493070c62a6SFranco Fichtner body = n;
149454ba9607SSascha Wildner if ((head = body->parent->head) != NULL &&
149554ba9607SSascha Wildner (head = head->child) != NULL &&
149654ba9607SSascha Wildner head->next == NULL &&
149754ba9607SSascha Wildner head->type == ROFFT_TEXT &&
149854ba9607SSascha Wildner strcmp(head->string, "NAME") == 0 &&
149954ba9607SSascha Wildner body->child != NULL) {
1500070c62a6SFranco Fichtner
1501070c62a6SFranco Fichtner /*
1502070c62a6SFranco Fichtner * Suck the entire NAME section into memory.
1503070c62a6SFranco Fichtner * Yes, we might run away.
1504070c62a6SFranco Fichtner * But too many manuals have big, spread-out
1505070c62a6SFranco Fichtner * NAME sections over many lines.
1506070c62a6SFranco Fichtner */
1507070c62a6SFranco Fichtner
1508070c62a6SFranco Fichtner title = NULL;
150954ba9607SSascha Wildner deroff(&title, body);
1510070c62a6SFranco Fichtner if (NULL == title)
1511070c62a6SFranco Fichtner return;
1512070c62a6SFranco Fichtner
1513070c62a6SFranco Fichtner /*
1514070c62a6SFranco Fichtner * Go through a special heuristic dance here.
1515070c62a6SFranco Fichtner * Conventionally, one or more manual names are
1516070c62a6SFranco Fichtner * comma-specified prior to a whitespace, then a
1517070c62a6SFranco Fichtner * dash, then a description. Try to puzzle out
1518070c62a6SFranco Fichtner * the name parts here.
1519070c62a6SFranco Fichtner */
1520070c62a6SFranco Fichtner
1521070c62a6SFranco Fichtner start = title;
1522070c62a6SFranco Fichtner for ( ;; ) {
1523070c62a6SFranco Fichtner sz = strcspn(start, " ,");
1524070c62a6SFranco Fichtner if ('\0' == start[sz])
1525070c62a6SFranco Fichtner break;
1526070c62a6SFranco Fichtner
1527070c62a6SFranco Fichtner byte = start[sz];
1528070c62a6SFranco Fichtner start[sz] = '\0';
1529070c62a6SFranco Fichtner
1530070c62a6SFranco Fichtner /*
1531070c62a6SFranco Fichtner * Assume a stray trailing comma in the
1532070c62a6SFranco Fichtner * name list if a name begins with a dash.
1533070c62a6SFranco Fichtner */
1534070c62a6SFranco Fichtner
1535070c62a6SFranco Fichtner if ('-' == start[0] ||
1536070c62a6SFranco Fichtner ('\\' == start[0] && '-' == start[1]))
1537070c62a6SFranco Fichtner break;
1538070c62a6SFranco Fichtner
1539070c62a6SFranco Fichtner putkey(mpage, start, NAME_TITLE);
154054ba9607SSascha Wildner if ( ! (mpage->name_head_done ||
154154ba9607SSascha Wildner strcasecmp(start, meta->title))) {
154254ba9607SSascha Wildner putkey(mpage, start, NAME_HEAD);
154354ba9607SSascha Wildner mpage->name_head_done = 1;
154454ba9607SSascha Wildner }
1545070c62a6SFranco Fichtner
1546070c62a6SFranco Fichtner if (' ' == byte) {
1547070c62a6SFranco Fichtner start += sz + 1;
154836342e81SSascha Wildner break;
154936342e81SSascha Wildner }
1550070c62a6SFranco Fichtner
1551070c62a6SFranco Fichtner assert(',' == byte);
1552070c62a6SFranco Fichtner start += sz + 1;
1553070c62a6SFranco Fichtner while (' ' == *start)
1554070c62a6SFranco Fichtner start++;
155536342e81SSascha Wildner }
155636342e81SSascha Wildner
1557070c62a6SFranco Fichtner if (start == title) {
1558070c62a6SFranco Fichtner putkey(mpage, start, NAME_TITLE);
155954ba9607SSascha Wildner if ( ! (mpage->name_head_done ||
156054ba9607SSascha Wildner strcasecmp(start, meta->title))) {
156154ba9607SSascha Wildner putkey(mpage, start, NAME_HEAD);
156254ba9607SSascha Wildner mpage->name_head_done = 1;
156354ba9607SSascha Wildner }
1564070c62a6SFranco Fichtner free(title);
156536342e81SSascha Wildner return;
156636342e81SSascha Wildner }
156736342e81SSascha Wildner
1568070c62a6SFranco Fichtner while (isspace((unsigned char)*start))
1569070c62a6SFranco Fichtner start++;
157036342e81SSascha Wildner
1571070c62a6SFranco Fichtner if (0 == strncmp(start, "-", 1))
1572070c62a6SFranco Fichtner start += 1;
1573070c62a6SFranco Fichtner else if (0 == strncmp(start, "\\-\\-", 4))
1574070c62a6SFranco Fichtner start += 4;
1575070c62a6SFranco Fichtner else if (0 == strncmp(start, "\\-", 2))
1576070c62a6SFranco Fichtner start += 2;
1577070c62a6SFranco Fichtner else if (0 == strncmp(start, "\\(en", 4))
1578070c62a6SFranco Fichtner start += 4;
1579070c62a6SFranco Fichtner else if (0 == strncmp(start, "\\(em", 4))
1580070c62a6SFranco Fichtner start += 4;
158136342e81SSascha Wildner
1582070c62a6SFranco Fichtner while (' ' == *start)
1583070c62a6SFranco Fichtner start++;
158436342e81SSascha Wildner
158554ba9607SSascha Wildner /*
158654ba9607SSascha Wildner * Cut off excessive one-line descriptions.
158754ba9607SSascha Wildner * Bad pages are not worth better heuristics.
158854ba9607SSascha Wildner */
158954ba9607SSascha Wildner
159054ba9607SSascha Wildner mpage->desc = mandoc_strndup(start, 150);
1591070c62a6SFranco Fichtner free(title);
1592070c62a6SFranco Fichtner return;
159336342e81SSascha Wildner }
159436342e81SSascha Wildner }
159536342e81SSascha Wildner
1596070c62a6SFranco Fichtner for (n = n->child; n; n = n->next) {
1597070c62a6SFranco Fichtner if (NULL != mpage->desc)
159836342e81SSascha Wildner break;
159954ba9607SSascha Wildner parse_man(mpage, meta, n);
160036342e81SSascha Wildner }
160136342e81SSascha Wildner }
160236342e81SSascha Wildner
160336342e81SSascha Wildner static void
parse_mdoc(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)160454ba9607SSascha Wildner parse_mdoc(struct mpage *mpage, const struct roff_meta *meta,
160554ba9607SSascha Wildner const struct roff_node *n)
160636342e81SSascha Wildner {
160754ba9607SSascha Wildner const struct mdoc_handler *handler;
160836342e81SSascha Wildner
160954ba9607SSascha Wildner for (n = n->child; n != NULL; n = n->next) {
161054ba9607SSascha Wildner if (n->tok == TOKEN_NONE || n->tok < ROFF_MAX)
161154ba9607SSascha Wildner continue;
161254ba9607SSascha Wildner assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
161354ba9607SSascha Wildner handler = mdoc_handlers + (n->tok - MDOC_Dd);
161454ba9607SSascha Wildner if (n->flags & handler->taboo)
161554ba9607SSascha Wildner continue;
161654ba9607SSascha Wildner
1617070c62a6SFranco Fichtner switch (n->type) {
161854ba9607SSascha Wildner case ROFFT_ELEM:
161954ba9607SSascha Wildner case ROFFT_BLOCK:
162054ba9607SSascha Wildner case ROFFT_HEAD:
162154ba9607SSascha Wildner case ROFFT_BODY:
162254ba9607SSascha Wildner case ROFFT_TAIL:
162354ba9607SSascha Wildner if (handler->fp != NULL &&
162454ba9607SSascha Wildner (*handler->fp)(mpage, meta, n) == 0)
1625070c62a6SFranco Fichtner break;
162654ba9607SSascha Wildner if (handler->mask)
1627070c62a6SFranco Fichtner putmdockey(mpage, n->child,
162854ba9607SSascha Wildner handler->mask, handler->taboo);
1629070c62a6SFranco Fichtner break;
1630070c62a6SFranco Fichtner default:
1631070c62a6SFranco Fichtner continue;
163236342e81SSascha Wildner }
1633070c62a6SFranco Fichtner if (NULL != n->child)
163454ba9607SSascha Wildner parse_mdoc(mpage, meta, n);
1635070c62a6SFranco Fichtner }
1636070c62a6SFranco Fichtner }
1637070c62a6SFranco Fichtner
1638070c62a6SFranco Fichtner static int
parse_mdoc_Fa(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)163954ba9607SSascha Wildner parse_mdoc_Fa(struct mpage *mpage, const struct roff_meta *meta,
164054ba9607SSascha Wildner const struct roff_node *n)
1641070c62a6SFranco Fichtner {
164254ba9607SSascha Wildner uint64_t mask;
164354ba9607SSascha Wildner
164454ba9607SSascha Wildner mask = TYPE_Fa;
164554ba9607SSascha Wildner if (n->sec == SEC_SYNOPSIS)
164654ba9607SSascha Wildner mask |= TYPE_Vt;
164754ba9607SSascha Wildner
164854ba9607SSascha Wildner putmdockey(mpage, n->child, mask, 0);
164954ba9607SSascha Wildner return 0;
165054ba9607SSascha Wildner }
165154ba9607SSascha Wildner
165254ba9607SSascha Wildner static int
parse_mdoc_Fd(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)165354ba9607SSascha Wildner parse_mdoc_Fd(struct mpage *mpage, const struct roff_meta *meta,
165454ba9607SSascha Wildner const struct roff_node *n)
165554ba9607SSascha Wildner {
165654ba9607SSascha Wildner char *start, *end;
1657070c62a6SFranco Fichtner size_t sz;
1658070c62a6SFranco Fichtner
1659070c62a6SFranco Fichtner if (SEC_SYNOPSIS != n->sec ||
1660070c62a6SFranco Fichtner NULL == (n = n->child) ||
166154ba9607SSascha Wildner n->type != ROFFT_TEXT)
166254ba9607SSascha Wildner return 0;
1663070c62a6SFranco Fichtner
1664070c62a6SFranco Fichtner /*
1665070c62a6SFranco Fichtner * Only consider those `Fd' macro fields that begin with an
1666070c62a6SFranco Fichtner * "inclusion" token (versus, e.g., #define).
1667070c62a6SFranco Fichtner */
1668070c62a6SFranco Fichtner
1669070c62a6SFranco Fichtner if (strcmp("#include", n->string))
167054ba9607SSascha Wildner return 0;
1671070c62a6SFranco Fichtner
167254ba9607SSascha Wildner if ((n = n->next) == NULL || n->type != ROFFT_TEXT)
167354ba9607SSascha Wildner return 0;
1674070c62a6SFranco Fichtner
1675070c62a6SFranco Fichtner /*
1676070c62a6SFranco Fichtner * Strip away the enclosing angle brackets and make sure we're
1677070c62a6SFranco Fichtner * not zero-length.
1678070c62a6SFranco Fichtner */
1679070c62a6SFranco Fichtner
1680070c62a6SFranco Fichtner start = n->string;
1681070c62a6SFranco Fichtner if ('<' == *start || '"' == *start)
1682070c62a6SFranco Fichtner start++;
1683070c62a6SFranco Fichtner
1684070c62a6SFranco Fichtner if (0 == (sz = strlen(start)))
168554ba9607SSascha Wildner return 0;
1686070c62a6SFranco Fichtner
1687070c62a6SFranco Fichtner end = &start[(int)sz - 1];
1688070c62a6SFranco Fichtner if ('>' == *end || '"' == *end)
1689070c62a6SFranco Fichtner end--;
1690070c62a6SFranco Fichtner
1691070c62a6SFranco Fichtner if (end > start)
1692070c62a6SFranco Fichtner putkeys(mpage, start, end - start + 1, TYPE_In);
169354ba9607SSascha Wildner return 0;
169454ba9607SSascha Wildner }
169554ba9607SSascha Wildner
169654ba9607SSascha Wildner static void
parse_mdoc_fname(struct mpage * mpage,const struct roff_node * n)169754ba9607SSascha Wildner parse_mdoc_fname(struct mpage *mpage, const struct roff_node *n)
169854ba9607SSascha Wildner {
169954ba9607SSascha Wildner char *cp;
170054ba9607SSascha Wildner size_t sz;
170154ba9607SSascha Wildner
170254ba9607SSascha Wildner if (n->type != ROFFT_TEXT)
170354ba9607SSascha Wildner return;
170454ba9607SSascha Wildner
170554ba9607SSascha Wildner /* Skip function pointer punctuation. */
170654ba9607SSascha Wildner
170754ba9607SSascha Wildner cp = n->string;
170854ba9607SSascha Wildner while (*cp == '(' || *cp == '*')
170954ba9607SSascha Wildner cp++;
171054ba9607SSascha Wildner sz = strcspn(cp, "()");
171154ba9607SSascha Wildner
171254ba9607SSascha Wildner putkeys(mpage, cp, sz, TYPE_Fn);
171354ba9607SSascha Wildner if (n->sec == SEC_SYNOPSIS)
171454ba9607SSascha Wildner putkeys(mpage, cp, sz, NAME_SYN);
1715070c62a6SFranco Fichtner }
1716070c62a6SFranco Fichtner
1717070c62a6SFranco Fichtner static int
parse_mdoc_Fn(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)171854ba9607SSascha Wildner parse_mdoc_Fn(struct mpage *mpage, const struct roff_meta *meta,
171954ba9607SSascha Wildner const struct roff_node *n)
172054ba9607SSascha Wildner {
172154ba9607SSascha Wildner uint64_t mask;
172254ba9607SSascha Wildner
172354ba9607SSascha Wildner if (n->child == NULL)
172454ba9607SSascha Wildner return 0;
172554ba9607SSascha Wildner
172654ba9607SSascha Wildner parse_mdoc_fname(mpage, n->child);
172754ba9607SSascha Wildner
172854ba9607SSascha Wildner n = n->child->next;
172954ba9607SSascha Wildner if (n != NULL && n->type == ROFFT_TEXT) {
173054ba9607SSascha Wildner mask = TYPE_Fa;
173154ba9607SSascha Wildner if (n->sec == SEC_SYNOPSIS)
173254ba9607SSascha Wildner mask |= TYPE_Vt;
173354ba9607SSascha Wildner putmdockey(mpage, n, mask, 0);
173454ba9607SSascha Wildner }
173554ba9607SSascha Wildner
173654ba9607SSascha Wildner return 0;
173754ba9607SSascha Wildner }
173854ba9607SSascha Wildner
173954ba9607SSascha Wildner static int
parse_mdoc_Fo(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)174054ba9607SSascha Wildner parse_mdoc_Fo(struct mpage *mpage, const struct roff_meta *meta,
174154ba9607SSascha Wildner const struct roff_node *n)
174254ba9607SSascha Wildner {
174354ba9607SSascha Wildner
174454ba9607SSascha Wildner if (n->type != ROFFT_HEAD)
174554ba9607SSascha Wildner return 1;
174654ba9607SSascha Wildner
174754ba9607SSascha Wildner if (n->child != NULL)
174854ba9607SSascha Wildner parse_mdoc_fname(mpage, n->child);
174954ba9607SSascha Wildner
175054ba9607SSascha Wildner return 0;
175154ba9607SSascha Wildner }
175254ba9607SSascha Wildner
175354ba9607SSascha Wildner static int
parse_mdoc_Va(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)175454ba9607SSascha Wildner parse_mdoc_Va(struct mpage *mpage, const struct roff_meta *meta,
175554ba9607SSascha Wildner const struct roff_node *n)
1756070c62a6SFranco Fichtner {
1757070c62a6SFranco Fichtner char *cp;
1758070c62a6SFranco Fichtner
175954ba9607SSascha Wildner if (n->type != ROFFT_ELEM && n->type != ROFFT_BODY)
176054ba9607SSascha Wildner return 0;
1761070c62a6SFranco Fichtner
176254ba9607SSascha Wildner if (n->child != NULL &&
176354ba9607SSascha Wildner n->child->next == NULL &&
176454ba9607SSascha Wildner n->child->type == ROFFT_TEXT)
176554ba9607SSascha Wildner return 1;
1766070c62a6SFranco Fichtner
176754ba9607SSascha Wildner cp = NULL;
176854ba9607SSascha Wildner deroff(&cp, n);
176954ba9607SSascha Wildner if (cp != NULL) {
177054ba9607SSascha Wildner putkey(mpage, cp, TYPE_Vt | (n->tok == MDOC_Va ||
177154ba9607SSascha Wildner n->type == ROFFT_BODY ? TYPE_Va : 0));
177254ba9607SSascha Wildner free(cp);
177354ba9607SSascha Wildner }
1774070c62a6SFranco Fichtner
177554ba9607SSascha Wildner return 0;
1776070c62a6SFranco Fichtner }
1777070c62a6SFranco Fichtner
1778070c62a6SFranco Fichtner static int
parse_mdoc_Xr(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)177954ba9607SSascha Wildner parse_mdoc_Xr(struct mpage *mpage, const struct roff_meta *meta,
178054ba9607SSascha Wildner const struct roff_node *n)
1781070c62a6SFranco Fichtner {
1782070c62a6SFranco Fichtner char *cp;
1783070c62a6SFranco Fichtner
1784070c62a6SFranco Fichtner if (NULL == (n = n->child))
178554ba9607SSascha Wildner return 0;
1786070c62a6SFranco Fichtner
1787070c62a6SFranco Fichtner if (NULL == n->next) {
1788070c62a6SFranco Fichtner putkey(mpage, n->string, TYPE_Xr);
178954ba9607SSascha Wildner return 0;
1790070c62a6SFranco Fichtner }
1791070c62a6SFranco Fichtner
1792070c62a6SFranco Fichtner mandoc_asprintf(&cp, "%s(%s)", n->string, n->next->string);
1793070c62a6SFranco Fichtner putkey(mpage, cp, TYPE_Xr);
1794070c62a6SFranco Fichtner free(cp);
179554ba9607SSascha Wildner return 0;
1796070c62a6SFranco Fichtner }
1797070c62a6SFranco Fichtner
1798070c62a6SFranco Fichtner static int
parse_mdoc_Nd(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)179954ba9607SSascha Wildner parse_mdoc_Nd(struct mpage *mpage, const struct roff_meta *meta,
180054ba9607SSascha Wildner const struct roff_node *n)
1801070c62a6SFranco Fichtner {
1802070c62a6SFranco Fichtner
180354ba9607SSascha Wildner if (n->type == ROFFT_BODY)
180454ba9607SSascha Wildner deroff(&mpage->desc, n);
180554ba9607SSascha Wildner return 0;
1806070c62a6SFranco Fichtner }
1807070c62a6SFranco Fichtner
1808070c62a6SFranco Fichtner static int
parse_mdoc_Nm(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)180954ba9607SSascha Wildner parse_mdoc_Nm(struct mpage *mpage, const struct roff_meta *meta,
181054ba9607SSascha Wildner const struct roff_node *n)
1811070c62a6SFranco Fichtner {
1812070c62a6SFranco Fichtner
1813070c62a6SFranco Fichtner if (SEC_NAME == n->sec)
181454ba9607SSascha Wildner putmdockey(mpage, n->child, NAME_TITLE, 0);
181554ba9607SSascha Wildner else if (n->sec == SEC_SYNOPSIS && n->type == ROFFT_HEAD) {
181654ba9607SSascha Wildner if (n->child == NULL)
181754ba9607SSascha Wildner putkey(mpage, meta->name, NAME_SYN);
181854ba9607SSascha Wildner else
181954ba9607SSascha Wildner putmdockey(mpage, n->child, NAME_SYN, 0);
182054ba9607SSascha Wildner }
182154ba9607SSascha Wildner if ( ! (mpage->name_head_done ||
182254ba9607SSascha Wildner n->child == NULL || n->child->string == NULL ||
182354ba9607SSascha Wildner strcasecmp(n->child->string, meta->title))) {
182454ba9607SSascha Wildner putkey(mpage, n->child->string, NAME_HEAD);
182554ba9607SSascha Wildner mpage->name_head_done = 1;
182654ba9607SSascha Wildner }
182754ba9607SSascha Wildner return 0;
1828070c62a6SFranco Fichtner }
1829070c62a6SFranco Fichtner
1830070c62a6SFranco Fichtner static int
parse_mdoc_Sh(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)183154ba9607SSascha Wildner parse_mdoc_Sh(struct mpage *mpage, const struct roff_meta *meta,
183254ba9607SSascha Wildner const struct roff_node *n)
1833070c62a6SFranco Fichtner {
1834070c62a6SFranco Fichtner
183554ba9607SSascha Wildner return n->sec == SEC_CUSTOM && n->type == ROFFT_HEAD;
1836070c62a6SFranco Fichtner }
1837070c62a6SFranco Fichtner
1838070c62a6SFranco Fichtner static int
parse_mdoc_head(struct mpage * mpage,const struct roff_meta * meta,const struct roff_node * n)183954ba9607SSascha Wildner parse_mdoc_head(struct mpage *mpage, const struct roff_meta *meta,
184054ba9607SSascha Wildner const struct roff_node *n)
1841070c62a6SFranco Fichtner {
1842070c62a6SFranco Fichtner
184354ba9607SSascha Wildner return n->type == ROFFT_HEAD;
1844070c62a6SFranco Fichtner }
1845070c62a6SFranco Fichtner
1846070c62a6SFranco Fichtner /*
1847070c62a6SFranco Fichtner * Add a string to the hash table for the current manual.
1848070c62a6SFranco Fichtner * Each string has a bitmask telling which macros it belongs to.
1849070c62a6SFranco Fichtner * When we finish the manual, we'll dump the table.
1850070c62a6SFranco Fichtner */
1851070c62a6SFranco Fichtner static void
putkeys(const struct mpage * mpage,char * cp,size_t sz,uint64_t v)185254ba9607SSascha Wildner putkeys(const struct mpage *mpage, char *cp, size_t sz, uint64_t v)
1853070c62a6SFranco Fichtner {
1854070c62a6SFranco Fichtner struct ohash *htab;
1855070c62a6SFranco Fichtner struct str *s;
1856070c62a6SFranco Fichtner const char *end;
1857070c62a6SFranco Fichtner unsigned int slot;
185854ba9607SSascha Wildner int i, mustfree;
1859070c62a6SFranco Fichtner
1860070c62a6SFranco Fichtner if (0 == sz)
1861070c62a6SFranco Fichtner return;
1862070c62a6SFranco Fichtner
186354ba9607SSascha Wildner mustfree = render_string(&cp, &sz);
186454ba9607SSascha Wildner
1865070c62a6SFranco Fichtner if (TYPE_Nm & v) {
1866070c62a6SFranco Fichtner htab = &names;
1867070c62a6SFranco Fichtner v &= name_mask;
186854ba9607SSascha Wildner if (v & NAME_FIRST)
1869070c62a6SFranco Fichtner name_mask &= ~NAME_FIRST;
1870070c62a6SFranco Fichtner if (debug > 1)
1871070c62a6SFranco Fichtner say(mpage->mlinks->file,
187254ba9607SSascha Wildner "Adding name %*s, bits=0x%llx", (int)sz, cp,
187354ba9607SSascha Wildner (unsigned long long)v);
1874070c62a6SFranco Fichtner } else {
1875070c62a6SFranco Fichtner htab = &strings;
1876070c62a6SFranco Fichtner if (debug > 1)
187754ba9607SSascha Wildner for (i = 0; i < KEY_MAX; i++)
187854ba9607SSascha Wildner if ((uint64_t)1 << i & v)
1879070c62a6SFranco Fichtner say(mpage->mlinks->file,
1880070c62a6SFranco Fichtner "Adding key %s=%*s",
188154ba9607SSascha Wildner mansearch_keynames[i], (int)sz, cp);
1882070c62a6SFranco Fichtner }
1883070c62a6SFranco Fichtner
1884070c62a6SFranco Fichtner end = cp + sz;
1885070c62a6SFranco Fichtner slot = ohash_qlookupi(htab, cp, &end);
1886070c62a6SFranco Fichtner s = ohash_find(htab, slot);
1887070c62a6SFranco Fichtner
1888070c62a6SFranco Fichtner if (NULL != s && mpage == s->mpage) {
1889070c62a6SFranco Fichtner s->mask |= v;
1890070c62a6SFranco Fichtner return;
1891070c62a6SFranco Fichtner } else if (NULL == s) {
1892070c62a6SFranco Fichtner s = mandoc_calloc(1, sizeof(struct str) + sz + 1);
1893070c62a6SFranco Fichtner memcpy(s->key, cp, sz);
1894070c62a6SFranco Fichtner ohash_insert(htab, slot, s);
1895070c62a6SFranco Fichtner }
1896070c62a6SFranco Fichtner s->mpage = mpage;
1897070c62a6SFranco Fichtner s->mask = v;
189854ba9607SSascha Wildner
189954ba9607SSascha Wildner if (mustfree)
190054ba9607SSascha Wildner free(cp);
1901070c62a6SFranco Fichtner }
1902070c62a6SFranco Fichtner
1903070c62a6SFranco Fichtner /*
1904070c62a6SFranco Fichtner * Take a Unicode codepoint and produce its UTF-8 encoding.
1905070c62a6SFranco Fichtner * This isn't the best way to do this, but it works.
1906070c62a6SFranco Fichtner * The magic numbers are from the UTF-8 packaging.
1907070c62a6SFranco Fichtner * They're not as scary as they seem: read the UTF-8 spec for details.
1908070c62a6SFranco Fichtner */
1909070c62a6SFranco Fichtner static size_t
utf8(unsigned int cp,char out[7])1910070c62a6SFranco Fichtner utf8(unsigned int cp, char out[7])
1911070c62a6SFranco Fichtner {
1912070c62a6SFranco Fichtner size_t rc;
1913070c62a6SFranco Fichtner
1914070c62a6SFranco Fichtner rc = 0;
1915070c62a6SFranco Fichtner if (cp <= 0x0000007F) {
1916070c62a6SFranco Fichtner rc = 1;
1917070c62a6SFranco Fichtner out[0] = (char)cp;
1918070c62a6SFranco Fichtner } else if (cp <= 0x000007FF) {
1919070c62a6SFranco Fichtner rc = 2;
1920070c62a6SFranco Fichtner out[0] = (cp >> 6 & 31) | 192;
1921070c62a6SFranco Fichtner out[1] = (cp & 63) | 128;
1922070c62a6SFranco Fichtner } else if (cp <= 0x0000FFFF) {
1923070c62a6SFranco Fichtner rc = 3;
1924070c62a6SFranco Fichtner out[0] = (cp >> 12 & 15) | 224;
1925070c62a6SFranco Fichtner out[1] = (cp >> 6 & 63) | 128;
1926070c62a6SFranco Fichtner out[2] = (cp & 63) | 128;
1927070c62a6SFranco Fichtner } else if (cp <= 0x001FFFFF) {
1928070c62a6SFranco Fichtner rc = 4;
1929070c62a6SFranco Fichtner out[0] = (cp >> 18 & 7) | 240;
1930070c62a6SFranco Fichtner out[1] = (cp >> 12 & 63) | 128;
1931070c62a6SFranco Fichtner out[2] = (cp >> 6 & 63) | 128;
1932070c62a6SFranco Fichtner out[3] = (cp & 63) | 128;
1933070c62a6SFranco Fichtner } else if (cp <= 0x03FFFFFF) {
1934070c62a6SFranco Fichtner rc = 5;
1935070c62a6SFranco Fichtner out[0] = (cp >> 24 & 3) | 248;
1936070c62a6SFranco Fichtner out[1] = (cp >> 18 & 63) | 128;
1937070c62a6SFranco Fichtner out[2] = (cp >> 12 & 63) | 128;
1938070c62a6SFranco Fichtner out[3] = (cp >> 6 & 63) | 128;
1939070c62a6SFranco Fichtner out[4] = (cp & 63) | 128;
1940070c62a6SFranco Fichtner } else if (cp <= 0x7FFFFFFF) {
1941070c62a6SFranco Fichtner rc = 6;
1942070c62a6SFranco Fichtner out[0] = (cp >> 30 & 1) | 252;
1943070c62a6SFranco Fichtner out[1] = (cp >> 24 & 63) | 128;
1944070c62a6SFranco Fichtner out[2] = (cp >> 18 & 63) | 128;
1945070c62a6SFranco Fichtner out[3] = (cp >> 12 & 63) | 128;
1946070c62a6SFranco Fichtner out[4] = (cp >> 6 & 63) | 128;
1947070c62a6SFranco Fichtner out[5] = (cp & 63) | 128;
1948070c62a6SFranco Fichtner } else
194954ba9607SSascha Wildner return 0;
1950070c62a6SFranco Fichtner
1951070c62a6SFranco Fichtner out[rc] = '\0';
195254ba9607SSascha Wildner return rc;
1953070c62a6SFranco Fichtner }
1954070c62a6SFranco Fichtner
1955070c62a6SFranco Fichtner /*
195654ba9607SSascha Wildner * If the string contains escape sequences,
195754ba9607SSascha Wildner * replace it with an allocated rendering and return 1,
195854ba9607SSascha Wildner * such that the caller can free it after use.
195954ba9607SSascha Wildner * Otherwise, do nothing and return 0.
1960070c62a6SFranco Fichtner */
196154ba9607SSascha Wildner static int
render_string(char ** public,size_t * psz)196254ba9607SSascha Wildner render_string(char **public, size_t *psz)
1963070c62a6SFranco Fichtner {
196454ba9607SSascha Wildner const char *src, *scp, *addcp, *seq;
196554ba9607SSascha Wildner char *dst;
196654ba9607SSascha Wildner size_t ssz, dsz, addsz;
1967070c62a6SFranco Fichtner char utfbuf[7], res[6];
196854ba9607SSascha Wildner int seqlen, unicode;
1969070c62a6SFranco Fichtner
1970070c62a6SFranco Fichtner res[0] = '\\';
1971070c62a6SFranco Fichtner res[1] = '\t';
1972070c62a6SFranco Fichtner res[2] = ASCII_NBRSP;
1973070c62a6SFranco Fichtner res[3] = ASCII_HYPH;
1974070c62a6SFranco Fichtner res[4] = ASCII_BREAK;
1975070c62a6SFranco Fichtner res[5] = '\0';
1976070c62a6SFranco Fichtner
197754ba9607SSascha Wildner src = scp = *public;
197854ba9607SSascha Wildner ssz = *psz;
197954ba9607SSascha Wildner dst = NULL;
198054ba9607SSascha Wildner dsz = 0;
1981070c62a6SFranco Fichtner
198254ba9607SSascha Wildner while (scp < src + *psz) {
1983070c62a6SFranco Fichtner
198454ba9607SSascha Wildner /* Leave normal characters unchanged. */
1985070c62a6SFranco Fichtner
198654ba9607SSascha Wildner if (strchr(res, *scp) == NULL) {
198754ba9607SSascha Wildner if (dst != NULL)
198854ba9607SSascha Wildner dst[dsz++] = *scp;
198954ba9607SSascha Wildner scp++;
1990070c62a6SFranco Fichtner continue;
199154ba9607SSascha Wildner }
199254ba9607SSascha Wildner
199354ba9607SSascha Wildner /*
199454ba9607SSascha Wildner * Found something that requires replacing,
199554ba9607SSascha Wildner * make sure we have a destination buffer.
199654ba9607SSascha Wildner */
199754ba9607SSascha Wildner
199854ba9607SSascha Wildner if (dst == NULL) {
199954ba9607SSascha Wildner dst = mandoc_malloc(ssz + 1);
200054ba9607SSascha Wildner dsz = scp - src;
200154ba9607SSascha Wildner memcpy(dst, src, dsz);
200254ba9607SSascha Wildner }
200354ba9607SSascha Wildner
200454ba9607SSascha Wildner /* Handle single-char special characters. */
200554ba9607SSascha Wildner
200654ba9607SSascha Wildner switch (*scp) {
200754ba9607SSascha Wildner case '\\':
200854ba9607SSascha Wildner break;
2009070c62a6SFranco Fichtner case '\t':
2010070c62a6SFranco Fichtner case ASCII_NBRSP:
201154ba9607SSascha Wildner dst[dsz++] = ' ';
201254ba9607SSascha Wildner scp++;
201354ba9607SSascha Wildner continue;
201454ba9607SSascha Wildner case ASCII_HYPH:
201554ba9607SSascha Wildner dst[dsz++] = '-';
2016070c62a6SFranco Fichtner /* FALLTHROUGH */
2017070c62a6SFranco Fichtner case ASCII_BREAK:
201854ba9607SSascha Wildner scp++;
2019070c62a6SFranco Fichtner continue;
2020070c62a6SFranco Fichtner default:
202154ba9607SSascha Wildner abort();
2022070c62a6SFranco Fichtner }
2023070c62a6SFranco Fichtner
2024070c62a6SFranco Fichtner /*
202554ba9607SSascha Wildner * Found an escape sequence.
202654ba9607SSascha Wildner * Read past the slash, then parse it.
202754ba9607SSascha Wildner * Ignore everything except characters.
2028070c62a6SFranco Fichtner */
2029070c62a6SFranco Fichtner
203054ba9607SSascha Wildner scp++;
203154ba9607SSascha Wildner if (mandoc_escape(&scp, &seq, &seqlen) != ESCAPE_SPECIAL)
2032070c62a6SFranco Fichtner continue;
2033070c62a6SFranco Fichtner
2034070c62a6SFranco Fichtner /*
2035070c62a6SFranco Fichtner * Render the special character
2036070c62a6SFranco Fichtner * as either UTF-8 or ASCII.
2037070c62a6SFranco Fichtner */
2038070c62a6SFranco Fichtner
2039070c62a6SFranco Fichtner if (write_utf8) {
204054ba9607SSascha Wildner unicode = mchars_spec2cp(seq, seqlen);
204154ba9607SSascha Wildner if (unicode <= 0)
2042070c62a6SFranco Fichtner continue;
204354ba9607SSascha Wildner addsz = utf8(unicode, utfbuf);
204454ba9607SSascha Wildner if (addsz == 0)
2045070c62a6SFranco Fichtner continue;
204654ba9607SSascha Wildner addcp = utfbuf;
2047070c62a6SFranco Fichtner } else {
204854ba9607SSascha Wildner addcp = mchars_spec2str(seq, seqlen, &addsz);
204954ba9607SSascha Wildner if (addcp == NULL)
2050070c62a6SFranco Fichtner continue;
205154ba9607SSascha Wildner if (*addcp == ASCII_NBRSP) {
205254ba9607SSascha Wildner addcp = " ";
205354ba9607SSascha Wildner addsz = 1;
2054070c62a6SFranco Fichtner }
2055070c62a6SFranco Fichtner }
2056070c62a6SFranco Fichtner
2057070c62a6SFranco Fichtner /* Copy the rendered glyph into the stream. */
2058070c62a6SFranco Fichtner
205954ba9607SSascha Wildner ssz += addsz;
206054ba9607SSascha Wildner dst = mandoc_realloc(dst, ssz + 1);
206154ba9607SSascha Wildner memcpy(dst + dsz, addcp, addsz);
206254ba9607SSascha Wildner dsz += addsz;
206354ba9607SSascha Wildner }
206454ba9607SSascha Wildner if (dst != NULL) {
206554ba9607SSascha Wildner *public = dst;
206654ba9607SSascha Wildner *psz = dsz;
2067070c62a6SFranco Fichtner }
2068070c62a6SFranco Fichtner
206954ba9607SSascha Wildner /* Trim trailing whitespace and NUL-terminate. */
207054ba9607SSascha Wildner
207154ba9607SSascha Wildner while (*psz > 0 && (*public)[*psz - 1] == ' ')
207254ba9607SSascha Wildner --*psz;
207354ba9607SSascha Wildner if (dst != NULL) {
207454ba9607SSascha Wildner (*public)[*psz] = '\0';
207554ba9607SSascha Wildner return 1;
207654ba9607SSascha Wildner } else
207754ba9607SSascha Wildner return 0;
2078070c62a6SFranco Fichtner }
2079070c62a6SFranco Fichtner
2080070c62a6SFranco Fichtner static void
dbadd_mlink(const struct mlink * mlink)2081070c62a6SFranco Fichtner dbadd_mlink(const struct mlink *mlink)
2082070c62a6SFranco Fichtner {
208354ba9607SSascha Wildner dba_page_alias(mlink->mpage->dba, mlink->name, NAME_FILE);
208454ba9607SSascha Wildner dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->dsec);
208554ba9607SSascha Wildner dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->fsec);
208654ba9607SSascha Wildner dba_page_add(mlink->mpage->dba, DBP_ARCH, mlink->arch);
208754ba9607SSascha Wildner dba_page_add(mlink->mpage->dba, DBP_FILE, mlink->file);
2088070c62a6SFranco Fichtner }
2089070c62a6SFranco Fichtner
2090070c62a6SFranco Fichtner /*
2091070c62a6SFranco Fichtner * Flush the current page's terms (and their bits) into the database.
2092070c62a6SFranco Fichtner * Also, handle escape sequences at the last possible moment.
2093070c62a6SFranco Fichtner */
2094070c62a6SFranco Fichtner static void
dbadd(struct dba * dba,struct mpage * mpage)209554ba9607SSascha Wildner dbadd(struct dba *dba, struct mpage *mpage)
2096070c62a6SFranco Fichtner {
2097070c62a6SFranco Fichtner struct mlink *mlink;
2098070c62a6SFranco Fichtner struct str *key;
209954ba9607SSascha Wildner char *cp;
210054ba9607SSascha Wildner uint64_t mask;
2101070c62a6SFranco Fichtner size_t i;
2102070c62a6SFranco Fichtner unsigned int slot;
210354ba9607SSascha Wildner int mustfree;
2104070c62a6SFranco Fichtner
2105070c62a6SFranco Fichtner mlink = mpage->mlinks;
2106070c62a6SFranco Fichtner
2107070c62a6SFranco Fichtner if (nodb) {
2108070c62a6SFranco Fichtner for (key = ohash_first(&names, &slot); NULL != key;
210954ba9607SSascha Wildner key = ohash_next(&names, &slot))
2110070c62a6SFranco Fichtner free(key);
2111070c62a6SFranco Fichtner for (key = ohash_first(&strings, &slot); NULL != key;
211254ba9607SSascha Wildner key = ohash_next(&strings, &slot))
2113070c62a6SFranco Fichtner free(key);
2114070c62a6SFranco Fichtner if (0 == debug)
2115070c62a6SFranco Fichtner return;
2116070c62a6SFranco Fichtner while (NULL != mlink) {
2117070c62a6SFranco Fichtner fputs(mlink->name, stdout);
2118070c62a6SFranco Fichtner if (NULL == mlink->next ||
2119070c62a6SFranco Fichtner strcmp(mlink->dsec, mlink->next->dsec) ||
2120070c62a6SFranco Fichtner strcmp(mlink->fsec, mlink->next->fsec) ||
2121070c62a6SFranco Fichtner strcmp(mlink->arch, mlink->next->arch)) {
2122070c62a6SFranco Fichtner putchar('(');
2123070c62a6SFranco Fichtner if ('\0' == *mlink->dsec)
2124070c62a6SFranco Fichtner fputs(mlink->fsec, stdout);
2125070c62a6SFranco Fichtner else
2126070c62a6SFranco Fichtner fputs(mlink->dsec, stdout);
2127070c62a6SFranco Fichtner if ('\0' != *mlink->arch)
2128070c62a6SFranco Fichtner printf("/%s", mlink->arch);
2129070c62a6SFranco Fichtner putchar(')');
2130070c62a6SFranco Fichtner }
2131070c62a6SFranco Fichtner mlink = mlink->next;
2132070c62a6SFranco Fichtner if (NULL != mlink)
2133070c62a6SFranco Fichtner fputs(", ", stdout);
2134070c62a6SFranco Fichtner }
2135070c62a6SFranco Fichtner printf(" - %s\n", mpage->desc);
2136070c62a6SFranco Fichtner return;
2137070c62a6SFranco Fichtner }
2138070c62a6SFranco Fichtner
2139070c62a6SFranco Fichtner if (debug)
2140070c62a6SFranco Fichtner say(mlink->file, "Adding to database");
2141070c62a6SFranco Fichtner
214254ba9607SSascha Wildner cp = mpage->desc;
214354ba9607SSascha Wildner i = strlen(cp);
214454ba9607SSascha Wildner mustfree = render_string(&cp, &i);
214554ba9607SSascha Wildner mpage->dba = dba_page_new(dba->pages,
214654ba9607SSascha Wildner *mpage->arch == '\0' ? mlink->arch : mpage->arch,
214754ba9607SSascha Wildner cp, mlink->file, mpage->form);
214854ba9607SSascha Wildner if (mustfree)
214954ba9607SSascha Wildner free(cp);
215054ba9607SSascha Wildner dba_page_add(mpage->dba, DBP_SECT, mpage->sec);
2151070c62a6SFranco Fichtner
215254ba9607SSascha Wildner while (mlink != NULL) {
2153070c62a6SFranco Fichtner dbadd_mlink(mlink);
2154070c62a6SFranco Fichtner mlink = mlink->next;
2155070c62a6SFranco Fichtner }
2156070c62a6SFranco Fichtner
2157070c62a6SFranco Fichtner for (key = ohash_first(&names, &slot); NULL != key;
2158070c62a6SFranco Fichtner key = ohash_next(&names, &slot)) {
2159070c62a6SFranco Fichtner assert(key->mpage == mpage);
216054ba9607SSascha Wildner dba_page_alias(mpage->dba, key->key, key->mask);
2161070c62a6SFranco Fichtner free(key);
2162070c62a6SFranco Fichtner }
2163070c62a6SFranco Fichtner for (key = ohash_first(&strings, &slot); NULL != key;
2164070c62a6SFranco Fichtner key = ohash_next(&strings, &slot)) {
2165070c62a6SFranco Fichtner assert(key->mpage == mpage);
216654ba9607SSascha Wildner i = 0;
216754ba9607SSascha Wildner for (mask = TYPE_Xr; mask <= TYPE_Lb; mask *= 2) {
216854ba9607SSascha Wildner if (key->mask & mask)
216954ba9607SSascha Wildner dba_macro_add(dba->macros, i,
217054ba9607SSascha Wildner key->key, mpage->dba);
217154ba9607SSascha Wildner i++;
217254ba9607SSascha Wildner }
2173070c62a6SFranco Fichtner free(key);
2174070c62a6SFranco Fichtner }
2175070c62a6SFranco Fichtner }
2176070c62a6SFranco Fichtner
2177070c62a6SFranco Fichtner static void
dbprune(struct dba * dba)217854ba9607SSascha Wildner dbprune(struct dba *dba)
2179070c62a6SFranco Fichtner {
218054ba9607SSascha Wildner struct dba_array *page, *files;
218154ba9607SSascha Wildner char *file;
2182070c62a6SFranco Fichtner
218354ba9607SSascha Wildner dba_array_FOREACH(dba->pages, page) {
218454ba9607SSascha Wildner files = dba_array_get(page, DBP_FILE);
218554ba9607SSascha Wildner dba_array_FOREACH(files, file) {
218654ba9607SSascha Wildner if (*file < ' ')
218754ba9607SSascha Wildner file++;
218854ba9607SSascha Wildner if (ohash_find(&mlinks, ohash_qlookup(&mlinks,
218954ba9607SSascha Wildner file)) != NULL) {
2190070c62a6SFranco Fichtner if (debug)
219154ba9607SSascha Wildner say(file, "Deleting from database");
219254ba9607SSascha Wildner dba_array_del(dba->pages);
219354ba9607SSascha Wildner break;
2194070c62a6SFranco Fichtner }
2195070c62a6SFranco Fichtner }
219654ba9607SSascha Wildner }
2197070c62a6SFranco Fichtner }
2198070c62a6SFranco Fichtner
2199070c62a6SFranco Fichtner /*
220054ba9607SSascha Wildner * Write the database from memory to disk.
2201070c62a6SFranco Fichtner */
2202070c62a6SFranco Fichtner static void
dbwrite(struct dba * dba)220354ba9607SSascha Wildner dbwrite(struct dba *dba)
2204070c62a6SFranco Fichtner {
220554ba9607SSascha Wildner struct stat sb1, sb2;
220654ba9607SSascha Wildner char tfn[33], *cp1, *cp2;
220754ba9607SSascha Wildner off_t i;
220854ba9607SSascha Wildner int fd1, fd2;
2209070c62a6SFranco Fichtner
221054ba9607SSascha Wildner /*
221154ba9607SSascha Wildner * Do not write empty databases, and delete existing ones
221254ba9607SSascha Wildner * when makewhatis -u causes them to become empty.
221354ba9607SSascha Wildner */
221454ba9607SSascha Wildner
221554ba9607SSascha Wildner dba_array_start(dba->pages);
221654ba9607SSascha Wildner if (dba_array_next(dba->pages) == NULL) {
221754ba9607SSascha Wildner if (unlink(MANDOC_DB) == -1 && errno != ENOENT)
221854ba9607SSascha Wildner say(MANDOC_DB, "&unlink");
2219070c62a6SFranco Fichtner return;
2220070c62a6SFranco Fichtner }
2221070c62a6SFranco Fichtner
222254ba9607SSascha Wildner /*
222354ba9607SSascha Wildner * Build the database in a temporary file,
222454ba9607SSascha Wildner * then atomically move it into place.
222554ba9607SSascha Wildner */
2226070c62a6SFranco Fichtner
222754ba9607SSascha Wildner if (dba_write(MANDOC_DB "~", dba) != -1) {
222854ba9607SSascha Wildner if (rename(MANDOC_DB "~", MANDOC_DB) == -1) {
2229070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_SYSERR;
2230070c62a6SFranco Fichtner say(MANDOC_DB, "&rename");
223154ba9607SSascha Wildner unlink(MANDOC_DB "~");
2232070c62a6SFranco Fichtner }
2233070c62a6SFranco Fichtner return;
2234070c62a6SFranco Fichtner }
2235070c62a6SFranco Fichtner
2236070c62a6SFranco Fichtner /*
223754ba9607SSascha Wildner * We lack write permission and cannot replace the database
223854ba9607SSascha Wildner * file, but let's at least check whether the data changed.
2239070c62a6SFranco Fichtner */
2240070c62a6SFranco Fichtner
224154ba9607SSascha Wildner (void)strlcpy(tfn, "/tmp/mandocdb.XXXXXXXX", sizeof(tfn));
224254ba9607SSascha Wildner if (mkdtemp(tfn) == NULL) {
2243070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_SYSERR;
224454ba9607SSascha Wildner say("", "&%s", tfn);
224554ba9607SSascha Wildner return;
2246070c62a6SFranco Fichtner }
224754ba9607SSascha Wildner cp1 = cp2 = MAP_FAILED;
224854ba9607SSascha Wildner fd1 = fd2 = -1;
224954ba9607SSascha Wildner (void)strlcat(tfn, "/" MANDOC_DB, sizeof(tfn));
225054ba9607SSascha Wildner if (dba_write(tfn, dba) == -1) {
225154ba9607SSascha Wildner say(tfn, "&dba_write");
225254ba9607SSascha Wildner goto err;
2253070c62a6SFranco Fichtner }
225454ba9607SSascha Wildner if ((fd1 = open(MANDOC_DB, O_RDONLY, 0)) == -1) {
225554ba9607SSascha Wildner say(MANDOC_DB, "&open");
225654ba9607SSascha Wildner goto err;
2257070c62a6SFranco Fichtner }
225854ba9607SSascha Wildner if ((fd2 = open(tfn, O_RDONLY, 0)) == -1) {
225954ba9607SSascha Wildner say(tfn, "&open");
226054ba9607SSascha Wildner goto err;
2261070c62a6SFranco Fichtner }
226254ba9607SSascha Wildner if (fstat(fd1, &sb1) == -1) {
226354ba9607SSascha Wildner say(MANDOC_DB, "&fstat");
226454ba9607SSascha Wildner goto err;
226554ba9607SSascha Wildner }
226654ba9607SSascha Wildner if (fstat(fd2, &sb2) == -1) {
226754ba9607SSascha Wildner say(tfn, "&fstat");
226854ba9607SSascha Wildner goto err;
226954ba9607SSascha Wildner }
227054ba9607SSascha Wildner if (sb1.st_size != sb2.st_size)
227154ba9607SSascha Wildner goto err;
227254ba9607SSascha Wildner if ((cp1 = mmap(NULL, sb1.st_size, PROT_READ, MAP_PRIVATE,
227354ba9607SSascha Wildner fd1, 0)) == MAP_FAILED) {
227454ba9607SSascha Wildner say(MANDOC_DB, "&mmap");
227554ba9607SSascha Wildner goto err;
227654ba9607SSascha Wildner }
227754ba9607SSascha Wildner if ((cp2 = mmap(NULL, sb2.st_size, PROT_READ, MAP_PRIVATE,
227854ba9607SSascha Wildner fd2, 0)) == MAP_FAILED) {
227954ba9607SSascha Wildner say(tfn, "&mmap");
228054ba9607SSascha Wildner goto err;
228154ba9607SSascha Wildner }
228254ba9607SSascha Wildner for (i = 0; i < sb1.st_size; i++)
228354ba9607SSascha Wildner if (cp1[i] != cp2[i])
228454ba9607SSascha Wildner goto err;
228554ba9607SSascha Wildner goto out;
2286070c62a6SFranco Fichtner
228754ba9607SSascha Wildner err:
228854ba9607SSascha Wildner exitcode = (int)MANDOCLEVEL_SYSERR;
228954ba9607SSascha Wildner say(MANDOC_DB, "Data changed, but cannot replace database");
2290070c62a6SFranco Fichtner
229154ba9607SSascha Wildner out:
229254ba9607SSascha Wildner if (cp1 != MAP_FAILED)
229354ba9607SSascha Wildner munmap(cp1, sb1.st_size);
229454ba9607SSascha Wildner if (cp2 != MAP_FAILED)
229554ba9607SSascha Wildner munmap(cp2, sb2.st_size);
229654ba9607SSascha Wildner if (fd1 != -1)
229754ba9607SSascha Wildner close(fd1);
229854ba9607SSascha Wildner if (fd2 != -1)
229954ba9607SSascha Wildner close(fd2);
230054ba9607SSascha Wildner unlink(tfn);
230154ba9607SSascha Wildner *strrchr(tfn, '/') = '\0';
230254ba9607SSascha Wildner rmdir(tfn);
2303070c62a6SFranco Fichtner }
2304070c62a6SFranco Fichtner
2305070c62a6SFranco Fichtner static int
set_basedir(const char * targetdir,int report_baddir)230654ba9607SSascha Wildner set_basedir(const char *targetdir, int report_baddir)
2307070c62a6SFranco Fichtner {
2308070c62a6SFranco Fichtner static char startdir[PATH_MAX];
2309070c62a6SFranco Fichtner static int getcwd_status; /* 1 = ok, 2 = failure */
2310070c62a6SFranco Fichtner static int chdir_status; /* 1 = changed directory */
2311070c62a6SFranco Fichtner
2312070c62a6SFranco Fichtner /*
2313070c62a6SFranco Fichtner * Remember the original working directory, if possible.
2314070c62a6SFranco Fichtner * This will be needed if the second or a later directory
2315070c62a6SFranco Fichtner * on the command line is given as a relative path.
2316070c62a6SFranco Fichtner * Do not error out if the current directory is not
2317070c62a6SFranco Fichtner * searchable: Maybe it won't be needed after all.
2318070c62a6SFranco Fichtner */
2319*99db7d0eSSascha Wildner if (getcwd_status == 0) {
2320*99db7d0eSSascha Wildner if (getcwd(startdir, sizeof(startdir)) == NULL) {
2321070c62a6SFranco Fichtner getcwd_status = 2;
2322070c62a6SFranco Fichtner (void)strlcpy(startdir, strerror(errno),
2323070c62a6SFranco Fichtner sizeof(startdir));
2324070c62a6SFranco Fichtner } else
2325070c62a6SFranco Fichtner getcwd_status = 1;
2326070c62a6SFranco Fichtner }
2327070c62a6SFranco Fichtner
2328070c62a6SFranco Fichtner /*
2329070c62a6SFranco Fichtner * We are leaving the old base directory.
2330070c62a6SFranco Fichtner * Do not use it any longer, not even for messages.
2331070c62a6SFranco Fichtner */
2332070c62a6SFranco Fichtner *basedir = '\0';
2333*99db7d0eSSascha Wildner basedir_len = 0;
2334070c62a6SFranco Fichtner
2335070c62a6SFranco Fichtner /*
2336070c62a6SFranco Fichtner * If and only if the directory was changed earlier and
2337070c62a6SFranco Fichtner * the next directory to process is given as a relative path,
2338070c62a6SFranco Fichtner * first go back, or bail out if that is impossible.
2339070c62a6SFranco Fichtner */
2340*99db7d0eSSascha Wildner if (chdir_status && *targetdir != '/') {
2341*99db7d0eSSascha Wildner if (getcwd_status == 2) {
2342070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_SYSERR;
2343070c62a6SFranco Fichtner say("", "getcwd: %s", startdir);
234454ba9607SSascha Wildner return 0;
2345070c62a6SFranco Fichtner }
2346*99db7d0eSSascha Wildner if (chdir(startdir) == -1) {
2347070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_SYSERR;
2348070c62a6SFranco Fichtner say("", "&chdir %s", startdir);
234954ba9607SSascha Wildner return 0;
2350070c62a6SFranco Fichtner }
2351070c62a6SFranco Fichtner }
2352070c62a6SFranco Fichtner
2353070c62a6SFranco Fichtner /*
2354070c62a6SFranco Fichtner * Always resolve basedir to the canonicalized absolute
2355070c62a6SFranco Fichtner * pathname and append a trailing slash, such that
2356070c62a6SFranco Fichtner * we can reliably check whether files are inside.
2357070c62a6SFranco Fichtner */
2358*99db7d0eSSascha Wildner if (realpath(targetdir, basedir) == NULL) {
235954ba9607SSascha Wildner if (report_baddir || errno != ENOENT) {
2360070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_BADARG;
2361070c62a6SFranco Fichtner say("", "&%s: realpath", targetdir);
236254ba9607SSascha Wildner }
2363*99db7d0eSSascha Wildner *basedir = '\0';
236454ba9607SSascha Wildner return 0;
2365*99db7d0eSSascha Wildner } else if (chdir(basedir) == -1) {
236654ba9607SSascha Wildner if (report_baddir || errno != ENOENT) {
2367070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_BADARG;
2368070c62a6SFranco Fichtner say("", "&chdir");
236954ba9607SSascha Wildner }
2370*99db7d0eSSascha Wildner *basedir = '\0';
237154ba9607SSascha Wildner return 0;
2372070c62a6SFranco Fichtner }
2373070c62a6SFranco Fichtner chdir_status = 1;
2374*99db7d0eSSascha Wildner basedir_len = strlen(basedir);
2375*99db7d0eSSascha Wildner if (basedir[basedir_len - 1] != '/') {
2376*99db7d0eSSascha Wildner if (basedir_len >= PATH_MAX - 1) {
2377070c62a6SFranco Fichtner exitcode = (int)MANDOCLEVEL_SYSERR;
2378070c62a6SFranco Fichtner say("", "Filename too long");
2379*99db7d0eSSascha Wildner *basedir = '\0';
2380*99db7d0eSSascha Wildner basedir_len = 0;
238154ba9607SSascha Wildner return 0;
2382070c62a6SFranco Fichtner }
2383*99db7d0eSSascha Wildner basedir[basedir_len++] = '/';
2384*99db7d0eSSascha Wildner basedir[basedir_len] = '\0';
2385070c62a6SFranco Fichtner }
238654ba9607SSascha Wildner return 1;
2387070c62a6SFranco Fichtner }
2388070c62a6SFranco Fichtner
2389*99db7d0eSSascha Wildner #ifdef READ_ALLOWED_PATH
2390*99db7d0eSSascha Wildner static int
read_allowed(const char * candidate)2391*99db7d0eSSascha Wildner read_allowed(const char *candidate)
2392*99db7d0eSSascha Wildner {
2393*99db7d0eSSascha Wildner const char *cp;
2394*99db7d0eSSascha Wildner size_t len;
2395*99db7d0eSSascha Wildner
2396*99db7d0eSSascha Wildner for (cp = READ_ALLOWED_PATH;; cp += len) {
2397*99db7d0eSSascha Wildner while (*cp == ':')
2398*99db7d0eSSascha Wildner cp++;
2399*99db7d0eSSascha Wildner if (*cp == '\0')
2400*99db7d0eSSascha Wildner return 0;
2401*99db7d0eSSascha Wildner len = strcspn(cp, ":");
2402*99db7d0eSSascha Wildner if (strncmp(candidate, cp, len) == 0)
2403*99db7d0eSSascha Wildner return 1;
2404*99db7d0eSSascha Wildner }
2405*99db7d0eSSascha Wildner }
2406*99db7d0eSSascha Wildner #endif
2407*99db7d0eSSascha Wildner
2408070c62a6SFranco Fichtner static void
say(const char * file,const char * format,...)2409070c62a6SFranco Fichtner say(const char *file, const char *format, ...)
2410070c62a6SFranco Fichtner {
2411070c62a6SFranco Fichtner va_list ap;
2412070c62a6SFranco Fichtner int use_errno;
2413070c62a6SFranco Fichtner
2414*99db7d0eSSascha Wildner if (*basedir != '\0')
2415070c62a6SFranco Fichtner fprintf(stderr, "%s", basedir);
2416*99db7d0eSSascha Wildner if (*basedir != '\0' && *file != '\0')
2417070c62a6SFranco Fichtner fputc('/', stderr);
2418*99db7d0eSSascha Wildner if (*file != '\0')
2419070c62a6SFranco Fichtner fprintf(stderr, "%s", file);
2420070c62a6SFranco Fichtner
2421070c62a6SFranco Fichtner use_errno = 1;
2422*99db7d0eSSascha Wildner if (format != NULL) {
2423070c62a6SFranco Fichtner switch (*format) {
2424070c62a6SFranco Fichtner case '&':
2425070c62a6SFranco Fichtner format++;
2426070c62a6SFranco Fichtner break;
2427070c62a6SFranco Fichtner case '\0':
2428070c62a6SFranco Fichtner format = NULL;
2429070c62a6SFranco Fichtner break;
2430070c62a6SFranco Fichtner default:
2431070c62a6SFranco Fichtner use_errno = 0;
2432070c62a6SFranco Fichtner break;
2433070c62a6SFranco Fichtner }
2434070c62a6SFranco Fichtner }
2435*99db7d0eSSascha Wildner if (format != NULL) {
2436*99db7d0eSSascha Wildner if (*basedir != '\0' || *file != '\0')
2437070c62a6SFranco Fichtner fputs(": ", stderr);
2438070c62a6SFranco Fichtner va_start(ap, format);
2439070c62a6SFranco Fichtner vfprintf(stderr, format, ap);
2440070c62a6SFranco Fichtner va_end(ap);
2441070c62a6SFranco Fichtner }
2442070c62a6SFranco Fichtner if (use_errno) {
2443*99db7d0eSSascha Wildner if (*basedir != '\0' || *file != '\0' || format != NULL)
2444070c62a6SFranco Fichtner fputs(": ", stderr);
2445070c62a6SFranco Fichtner perror(NULL);
2446070c62a6SFranco Fichtner } else
2447070c62a6SFranco Fichtner fputc('\n', stderr);
244836342e81SSascha Wildner }
2449