1*4d131170SRobert Mustacchi /* $Id: manpath.c,v 1.43 2020/08/27 14:59:47 schwarze Exp $ */
2260e9a87SYuri Pankov /*
3*4d131170SRobert Mustacchi * Copyright (c) 2011,2014,2015,2017-2019 Ingo Schwarze <schwarze@openbsd.org>
4260e9a87SYuri Pankov * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
5260e9a87SYuri Pankov *
6260e9a87SYuri Pankov * Permission to use, copy, modify, and distribute this software for any
7260e9a87SYuri Pankov * purpose with or without fee is hereby granted, provided that the above
8260e9a87SYuri Pankov * copyright notice and this permission notice appear in all copies.
9260e9a87SYuri Pankov *
10371584c2SYuri Pankov * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11260e9a87SYuri Pankov * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12371584c2SYuri Pankov * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13260e9a87SYuri Pankov * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14260e9a87SYuri Pankov * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15260e9a87SYuri Pankov * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16260e9a87SYuri Pankov * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17260e9a87SYuri Pankov */
18260e9a87SYuri Pankov #include "config.h"
19260e9a87SYuri Pankov
20260e9a87SYuri Pankov #include <sys/types.h>
21260e9a87SYuri Pankov #include <sys/stat.h>
22260e9a87SYuri Pankov
23260e9a87SYuri Pankov #include <ctype.h>
24*4d131170SRobert Mustacchi #include <errno.h>
25260e9a87SYuri Pankov #include <limits.h>
26260e9a87SYuri Pankov #include <stdio.h>
27260e9a87SYuri Pankov #include <stdlib.h>
28260e9a87SYuri Pankov #include <string.h>
29260e9a87SYuri Pankov
30260e9a87SYuri Pankov #include "mandoc_aux.h"
31*4d131170SRobert Mustacchi #include "mandoc.h"
32371584c2SYuri Pankov #include "manconf.h"
33260e9a87SYuri Pankov
34371584c2SYuri Pankov static void manconf_file(struct manconf *, const char *);
35*4d131170SRobert Mustacchi static void manpath_add(struct manpaths *, const char *, char);
36*4d131170SRobert Mustacchi static void manpath_parseline(struct manpaths *, char *, char);
37260e9a87SYuri Pankov
38371584c2SYuri Pankov
39260e9a87SYuri Pankov void
manconf_parse(struct manconf * conf,const char * file,char * defp,char * auxp)40371584c2SYuri Pankov manconf_parse(struct manconf *conf, const char *file,
41260e9a87SYuri Pankov char *defp, char *auxp)
42260e9a87SYuri Pankov {
43260e9a87SYuri Pankov char *insert;
44260e9a87SYuri Pankov
45260e9a87SYuri Pankov /* Always prepend -m. */
46*4d131170SRobert Mustacchi manpath_parseline(&conf->manpath, auxp, 'm');
47260e9a87SYuri Pankov
48260e9a87SYuri Pankov /* If -M is given, it overrides everything else. */
49260e9a87SYuri Pankov if (NULL != defp) {
50*4d131170SRobert Mustacchi manpath_parseline(&conf->manpath, defp, 'M');
51260e9a87SYuri Pankov return;
52260e9a87SYuri Pankov }
53260e9a87SYuri Pankov
54260e9a87SYuri Pankov /* MANPATH and man.conf(5) cooperate. */
55260e9a87SYuri Pankov defp = getenv("MANPATH");
56260e9a87SYuri Pankov if (NULL == file)
57260e9a87SYuri Pankov file = MAN_CONF_FILE;
58260e9a87SYuri Pankov
59260e9a87SYuri Pankov /* No MANPATH; use man.conf(5) only. */
60260e9a87SYuri Pankov if (NULL == defp || '\0' == defp[0]) {
61371584c2SYuri Pankov manconf_file(conf, file);
62260e9a87SYuri Pankov return;
63260e9a87SYuri Pankov }
64260e9a87SYuri Pankov
65260e9a87SYuri Pankov /* Prepend man.conf(5) to MANPATH. */
66260e9a87SYuri Pankov if (':' == defp[0]) {
67371584c2SYuri Pankov manconf_file(conf, file);
68*4d131170SRobert Mustacchi manpath_parseline(&conf->manpath, defp, '\0');
69260e9a87SYuri Pankov return;
70260e9a87SYuri Pankov }
71260e9a87SYuri Pankov
72260e9a87SYuri Pankov /* Append man.conf(5) to MANPATH. */
73260e9a87SYuri Pankov if (':' == defp[strlen(defp) - 1]) {
74*4d131170SRobert Mustacchi manpath_parseline(&conf->manpath, defp, '\0');
75371584c2SYuri Pankov manconf_file(conf, file);
76260e9a87SYuri Pankov return;
77260e9a87SYuri Pankov }
78260e9a87SYuri Pankov
79260e9a87SYuri Pankov /* Insert man.conf(5) into MANPATH. */
80260e9a87SYuri Pankov insert = strstr(defp, "::");
81260e9a87SYuri Pankov if (NULL != insert) {
82260e9a87SYuri Pankov *insert++ = '\0';
83*4d131170SRobert Mustacchi manpath_parseline(&conf->manpath, defp, '\0');
84371584c2SYuri Pankov manconf_file(conf, file);
85*4d131170SRobert Mustacchi manpath_parseline(&conf->manpath, insert + 1, '\0');
86260e9a87SYuri Pankov return;
87260e9a87SYuri Pankov }
88260e9a87SYuri Pankov
89260e9a87SYuri Pankov /* MANPATH overrides man.conf(5) completely. */
90*4d131170SRobert Mustacchi manpath_parseline(&conf->manpath, defp, '\0');
91260e9a87SYuri Pankov }
92260e9a87SYuri Pankov
93c66b8046SYuri Pankov void
manpath_base(struct manpaths * dirs)94c66b8046SYuri Pankov manpath_base(struct manpaths *dirs)
95c66b8046SYuri Pankov {
96c66b8046SYuri Pankov char path_base[] = MANPATH_BASE;
97*4d131170SRobert Mustacchi manpath_parseline(dirs, path_base, '\0');
98c66b8046SYuri Pankov }
99c66b8046SYuri Pankov
100260e9a87SYuri Pankov /*
101260e9a87SYuri Pankov * Parse a FULL pathname from a colon-separated list of arrays.
102260e9a87SYuri Pankov */
103260e9a87SYuri Pankov static void
manpath_parseline(struct manpaths * dirs,char * path,char option)104*4d131170SRobert Mustacchi manpath_parseline(struct manpaths *dirs, char *path, char option)
105260e9a87SYuri Pankov {
106260e9a87SYuri Pankov char *dir;
107260e9a87SYuri Pankov
108260e9a87SYuri Pankov if (NULL == path)
109260e9a87SYuri Pankov return;
110260e9a87SYuri Pankov
111260e9a87SYuri Pankov for (dir = strtok(path, ":"); dir; dir = strtok(NULL, ":"))
112*4d131170SRobert Mustacchi manpath_add(dirs, dir, option);
113260e9a87SYuri Pankov }
114260e9a87SYuri Pankov
115260e9a87SYuri Pankov /*
116260e9a87SYuri Pankov * Add a directory to the array, ignoring bad directories.
117260e9a87SYuri Pankov * Grow the array one-by-one for simplicity's sake.
118260e9a87SYuri Pankov */
119260e9a87SYuri Pankov static void
manpath_add(struct manpaths * dirs,const char * dir,char option)120*4d131170SRobert Mustacchi manpath_add(struct manpaths *dirs, const char *dir, char option)
121260e9a87SYuri Pankov {
122260e9a87SYuri Pankov char buf[PATH_MAX];
123260e9a87SYuri Pankov struct stat sb;
124260e9a87SYuri Pankov char *cp;
125260e9a87SYuri Pankov size_t i;
126260e9a87SYuri Pankov
127*4d131170SRobert Mustacchi if ((cp = realpath(dir, buf)) == NULL)
128*4d131170SRobert Mustacchi goto fail;
129260e9a87SYuri Pankov
130260e9a87SYuri Pankov for (i = 0; i < dirs->sz; i++)
131*4d131170SRobert Mustacchi if (strcmp(dirs->paths[i], dir) == 0)
132260e9a87SYuri Pankov return;
133260e9a87SYuri Pankov
134*4d131170SRobert Mustacchi if (stat(cp, &sb) == -1)
135*4d131170SRobert Mustacchi goto fail;
136260e9a87SYuri Pankov
137260e9a87SYuri Pankov dirs->paths = mandoc_reallocarray(dirs->paths,
138*4d131170SRobert Mustacchi dirs->sz + 1, sizeof(*dirs->paths));
139260e9a87SYuri Pankov dirs->paths[dirs->sz++] = mandoc_strdup(cp);
140*4d131170SRobert Mustacchi return;
141*4d131170SRobert Mustacchi
142*4d131170SRobert Mustacchi fail:
143*4d131170SRobert Mustacchi if (option != '\0')
144*4d131170SRobert Mustacchi mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
145*4d131170SRobert Mustacchi "-%c %s: %s", option, dir, strerror(errno));
146260e9a87SYuri Pankov }
147260e9a87SYuri Pankov
148260e9a87SYuri Pankov void
manconf_free(struct manconf * conf)149371584c2SYuri Pankov manconf_free(struct manconf *conf)
150260e9a87SYuri Pankov {
151260e9a87SYuri Pankov size_t i;
152260e9a87SYuri Pankov
153371584c2SYuri Pankov for (i = 0; i < conf->manpath.sz; i++)
154371584c2SYuri Pankov free(conf->manpath.paths[i]);
155260e9a87SYuri Pankov
156371584c2SYuri Pankov free(conf->manpath.paths);
157371584c2SYuri Pankov free(conf->output.includes);
158371584c2SYuri Pankov free(conf->output.man);
159371584c2SYuri Pankov free(conf->output.paper);
160371584c2SYuri Pankov free(conf->output.style);
161260e9a87SYuri Pankov }
162260e9a87SYuri Pankov
163371584c2SYuri Pankov static void
manconf_file(struct manconf * conf,const char * file)164371584c2SYuri Pankov manconf_file(struct manconf *conf, const char *file)
165260e9a87SYuri Pankov {
166*4d131170SRobert Mustacchi const char *const toks[] = { "manpath", "output" };
167371584c2SYuri Pankov char manpath_default[] = MANPATH_DEFAULT;
168371584c2SYuri Pankov
169260e9a87SYuri Pankov FILE *stream;
170371584c2SYuri Pankov char *line, *cp, *ep;
171371584c2SYuri Pankov size_t linesz, tok, toklen;
172371584c2SYuri Pankov ssize_t linelen;
173371584c2SYuri Pankov
174371584c2SYuri Pankov if ((stream = fopen(file, "r")) == NULL)
175371584c2SYuri Pankov goto out;
176371584c2SYuri Pankov
177371584c2SYuri Pankov line = NULL;
178371584c2SYuri Pankov linesz = 0;
179371584c2SYuri Pankov
180371584c2SYuri Pankov while ((linelen = getline(&line, &linesz, stream)) != -1) {
181371584c2SYuri Pankov cp = line;
182371584c2SYuri Pankov ep = cp + linelen - 1;
183371584c2SYuri Pankov while (ep > cp && isspace((unsigned char)*ep))
184371584c2SYuri Pankov *ep-- = '\0';
185371584c2SYuri Pankov while (isspace((unsigned char)*cp))
186371584c2SYuri Pankov cp++;
187371584c2SYuri Pankov if (cp == ep || *cp == '#')
188371584c2SYuri Pankov continue;
189260e9a87SYuri Pankov
190371584c2SYuri Pankov for (tok = 0; tok < sizeof(toks)/sizeof(toks[0]); tok++) {
191371584c2SYuri Pankov toklen = strlen(toks[tok]);
192371584c2SYuri Pankov if (cp + toklen < ep &&
193371584c2SYuri Pankov isspace((unsigned char)cp[toklen]) &&
194371584c2SYuri Pankov strncmp(cp, toks[tok], toklen) == 0) {
195371584c2SYuri Pankov cp += toklen;
196371584c2SYuri Pankov while (isspace((unsigned char)*cp))
197371584c2SYuri Pankov cp++;
198371584c2SYuri Pankov break;
199371584c2SYuri Pankov }
200371584c2SYuri Pankov }
201260e9a87SYuri Pankov
202371584c2SYuri Pankov switch (tok) {
203371584c2SYuri Pankov case 0: /* manpath */
204*4d131170SRobert Mustacchi manpath_add(&conf->manpath, cp, '\0');
205371584c2SYuri Pankov *manpath_default = '\0';
206371584c2SYuri Pankov break;
207371584c2SYuri Pankov case 1: /* output */
208a40ea1a7SYuri Pankov manconf_output(&conf->output, cp, 1);
209371584c2SYuri Pankov break;
210371584c2SYuri Pankov default:
211371584c2SYuri Pankov break;
212371584c2SYuri Pankov }
213371584c2SYuri Pankov }
214371584c2SYuri Pankov free(line);
215371584c2SYuri Pankov fclose(stream);
216371584c2SYuri Pankov
217371584c2SYuri Pankov out:
218371584c2SYuri Pankov if (*manpath_default != '\0')
219*4d131170SRobert Mustacchi manpath_parseline(&conf->manpath, manpath_default, '\0');
220371584c2SYuri Pankov }
221260e9a87SYuri Pankov
222a40ea1a7SYuri Pankov int
manconf_output(struct manoutput * conf,const char * cp,int fromfile)223a40ea1a7SYuri Pankov manconf_output(struct manoutput *conf, const char *cp, int fromfile)
224371584c2SYuri Pankov {
225371584c2SYuri Pankov const char *const toks[] = {
226*4d131170SRobert Mustacchi /* Tokens requiring an argument. */
227cec8643bSMichal Nowak "includes", "man", "paper", "style", "indent", "width",
228*4d131170SRobert Mustacchi "outfilename", "tagfilename",
229*4d131170SRobert Mustacchi /* Token taking an optional argument. */
230*4d131170SRobert Mustacchi "tag",
231*4d131170SRobert Mustacchi /* Tokens not taking arguments. */
232*4d131170SRobert Mustacchi "fragment", "mdoc", "noval", "toc"
233371584c2SYuri Pankov };
234*4d131170SRobert Mustacchi const size_t ntoks = sizeof(toks) / sizeof(toks[0]);
235371584c2SYuri Pankov
236a40ea1a7SYuri Pankov const char *errstr;
237a40ea1a7SYuri Pankov char *oldval;
238a40ea1a7SYuri Pankov size_t len, tok;
239371584c2SYuri Pankov
240*4d131170SRobert Mustacchi for (tok = 0; tok < ntoks; tok++) {
241371584c2SYuri Pankov len = strlen(toks[tok]);
242*4d131170SRobert Mustacchi if (strncmp(cp, toks[tok], len) == 0 &&
243371584c2SYuri Pankov strchr(" = ", cp[len]) != NULL) {
244371584c2SYuri Pankov cp += len;
245371584c2SYuri Pankov if (*cp == '=')
246371584c2SYuri Pankov cp++;
247371584c2SYuri Pankov while (isspace((unsigned char)*cp))
248371584c2SYuri Pankov cp++;
249260e9a87SYuri Pankov break;
250371584c2SYuri Pankov }
251260e9a87SYuri Pankov }
252260e9a87SYuri Pankov
253*4d131170SRobert Mustacchi if (tok < 8 && *cp == '\0') {
254*4d131170SRobert Mustacchi mandoc_msg(MANDOCERR_BADVAL_MISS, 0, 0, "-O %s=?", toks[tok]);
255a40ea1a7SYuri Pankov return -1;
256a40ea1a7SYuri Pankov }
257*4d131170SRobert Mustacchi if (tok > 8 && tok < ntoks && *cp != '\0') {
258*4d131170SRobert Mustacchi mandoc_msg(MANDOCERR_BADVAL, 0, 0, "-O %s=%s", toks[tok], cp);
259a40ea1a7SYuri Pankov return -1;
260a40ea1a7SYuri Pankov }
261371584c2SYuri Pankov
262371584c2SYuri Pankov switch (tok) {
263371584c2SYuri Pankov case 0:
264a40ea1a7SYuri Pankov if (conf->includes != NULL) {
265a40ea1a7SYuri Pankov oldval = mandoc_strdup(conf->includes);
266a40ea1a7SYuri Pankov break;
267a40ea1a7SYuri Pankov }
268a40ea1a7SYuri Pankov conf->includes = mandoc_strdup(cp);
269a40ea1a7SYuri Pankov return 0;
270371584c2SYuri Pankov case 1:
271a40ea1a7SYuri Pankov if (conf->man != NULL) {
272a40ea1a7SYuri Pankov oldval = mandoc_strdup(conf->man);
273a40ea1a7SYuri Pankov break;
274a40ea1a7SYuri Pankov }
275a40ea1a7SYuri Pankov conf->man = mandoc_strdup(cp);
276a40ea1a7SYuri Pankov return 0;
277371584c2SYuri Pankov case 2:
278a40ea1a7SYuri Pankov if (conf->paper != NULL) {
279a40ea1a7SYuri Pankov oldval = mandoc_strdup(conf->paper);
280a40ea1a7SYuri Pankov break;
281a40ea1a7SYuri Pankov }
282a40ea1a7SYuri Pankov conf->paper = mandoc_strdup(cp);
283a40ea1a7SYuri Pankov return 0;
284371584c2SYuri Pankov case 3:
285a40ea1a7SYuri Pankov if (conf->style != NULL) {
286a40ea1a7SYuri Pankov oldval = mandoc_strdup(conf->style);
287a40ea1a7SYuri Pankov break;
288a40ea1a7SYuri Pankov }
289a40ea1a7SYuri Pankov conf->style = mandoc_strdup(cp);
290a40ea1a7SYuri Pankov return 0;
291371584c2SYuri Pankov case 4:
292a40ea1a7SYuri Pankov if (conf->indent) {
293a40ea1a7SYuri Pankov mandoc_asprintf(&oldval, "%zu", conf->indent);
294a40ea1a7SYuri Pankov break;
295a40ea1a7SYuri Pankov }
296a40ea1a7SYuri Pankov conf->indent = strtonum(cp, 0, 1000, &errstr);
297a40ea1a7SYuri Pankov if (errstr == NULL)
298a40ea1a7SYuri Pankov return 0;
299*4d131170SRobert Mustacchi mandoc_msg(MANDOCERR_BADVAL_BAD, 0, 0,
300*4d131170SRobert Mustacchi "-O indent=%s is %s", cp, errstr);
301a40ea1a7SYuri Pankov return -1;
302371584c2SYuri Pankov case 5:
303a40ea1a7SYuri Pankov if (conf->width) {
304a40ea1a7SYuri Pankov mandoc_asprintf(&oldval, "%zu", conf->width);
305a40ea1a7SYuri Pankov break;
306a40ea1a7SYuri Pankov }
307c66b8046SYuri Pankov conf->width = strtonum(cp, 1, 1000, &errstr);
308a40ea1a7SYuri Pankov if (errstr == NULL)
309a40ea1a7SYuri Pankov return 0;
310*4d131170SRobert Mustacchi mandoc_msg(MANDOCERR_BADVAL_BAD, 0, 0,
311*4d131170SRobert Mustacchi "-O width=%s is %s", cp, errstr);
312a40ea1a7SYuri Pankov return -1;
313371584c2SYuri Pankov case 6:
314*4d131170SRobert Mustacchi if (conf->outfilename != NULL) {
315*4d131170SRobert Mustacchi oldval = mandoc_strdup(conf->outfilename);
316*4d131170SRobert Mustacchi break;
317*4d131170SRobert Mustacchi }
318*4d131170SRobert Mustacchi conf->outfilename = mandoc_strdup(cp);
319*4d131170SRobert Mustacchi return 0;
320*4d131170SRobert Mustacchi case 7:
321*4d131170SRobert Mustacchi if (conf->tagfilename != NULL) {
322*4d131170SRobert Mustacchi oldval = mandoc_strdup(conf->tagfilename);
323*4d131170SRobert Mustacchi break;
324*4d131170SRobert Mustacchi }
325*4d131170SRobert Mustacchi conf->tagfilename = mandoc_strdup(cp);
326*4d131170SRobert Mustacchi return 0;
327*4d131170SRobert Mustacchi /*
328*4d131170SRobert Mustacchi * If the index of the following token changes,
329*4d131170SRobert Mustacchi * do not forget to adjust the range check above the switch.
330*4d131170SRobert Mustacchi */
331*4d131170SRobert Mustacchi case 8:
332cec8643bSMichal Nowak if (conf->tag != NULL) {
333cec8643bSMichal Nowak oldval = mandoc_strdup(conf->tag);
334cec8643bSMichal Nowak break;
335cec8643bSMichal Nowak }
336cec8643bSMichal Nowak conf->tag = mandoc_strdup(cp);
337a40ea1a7SYuri Pankov return 0;
338*4d131170SRobert Mustacchi case 9:
339cec8643bSMichal Nowak conf->fragment = 1;
340a40ea1a7SYuri Pankov return 0;
341*4d131170SRobert Mustacchi case 10:
342cec8643bSMichal Nowak conf->mdoc = 1;
343cec8643bSMichal Nowak return 0;
344*4d131170SRobert Mustacchi case 11:
345a40ea1a7SYuri Pankov conf->noval = 1;
346a40ea1a7SYuri Pankov return 0;
347*4d131170SRobert Mustacchi case 12:
348cec8643bSMichal Nowak conf->toc = 1;
349cec8643bSMichal Nowak return 0;
350371584c2SYuri Pankov default:
351*4d131170SRobert Mustacchi mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-O %s", cp);
352*4d131170SRobert Mustacchi return -1;
353*4d131170SRobert Mustacchi }
354*4d131170SRobert Mustacchi if (fromfile) {
355*4d131170SRobert Mustacchi free(oldval);
356*4d131170SRobert Mustacchi return 0;
357*4d131170SRobert Mustacchi } else {
358*4d131170SRobert Mustacchi mandoc_msg(MANDOCERR_BADVAL_DUPE, 0, 0,
359*4d131170SRobert Mustacchi "-O %s=%s: already set to %s", toks[tok], cp, oldval);
360*4d131170SRobert Mustacchi free(oldval);
361a40ea1a7SYuri Pankov return -1;
362371584c2SYuri Pankov }
363260e9a87SYuri Pankov }
364