]> git.cameronkatri.com Git - mandoc.git/blobdiff - main.c
do not crash when a manpath directory contains a symbolic link
[mandoc.git] / main.c
diff --git a/main.c b/main.c
index 8c3ded9b1b7a9dcf8d15432b7ed18a03a5c39c69..f0e2d873bef30a6ec17ff02665f3095c7498e50f 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,6 +1,6 @@
-/* $Id: main.c,v 1.345 2020/03/13 15:32:28 schwarze Exp $ */
+/* $Id: main.c,v 1.356 2021/08/14 13:53:08 schwarze Exp $ */
 /*
- * Copyright (c) 2010-2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2012, 2014-2021 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
  *
@@ -54,6 +54,7 @@
 #include "mdoc.h"
 #include "man.h"
 #include "mandoc_parse.h"
+#include "tag.h"
 #include "term_tag.h"
 #include "main.h"
 #include "manconf.h"
@@ -92,7 +93,7 @@ struct        outstate {
 
 int                      mandocdb(int, char *[]);
 
-static void              check_xr(void);
+static void              check_xr(struct manpaths *);
 static int               fs_lookup(const struct manpaths *,
                                size_t ipath, const char *,
                                const char *, const char *,
@@ -103,12 +104,12 @@ static    int               fs_search(const struct mansearch *,
 static void              glob_esc(char **, const char *, const char *);
 static void              outdata_alloc(struct outstate *, struct manoutput *);
 static void              parse(struct mparse *, int, const char *,
-                               struct outstate *, struct manoutput *);
+                               struct outstate *, struct manconf *);
 static void              passthrough(int, int);
 static void              process_onefile(struct mparse *, struct manpage *,
                                int, struct outstate *, struct manconf *);
-static void              run_pager(struct tag_files *);
-static pid_t             spawn_pager(struct tag_files *);
+static void              run_pager(struct outstate *, char *);
+static pid_t             spawn_pager(struct outstate *, char *);
 static void              usage(enum argmode) __attribute__((__noreturn__));
 static int               woptions(char *, enum mandoc_os *, int *);
 
@@ -164,7 +165,7 @@ main(int argc, char *argv[])
                return mandocdb(argc, argv);
 
 #if HAVE_PLEDGE
-       if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) {
+       if (pledge("stdio rpath wpath cpath tmppath tty proc exec", NULL) == -1) {
                mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
                return mandoc_msg_getrc();
        }
@@ -372,7 +373,9 @@ main(int argc, char *argv[])
 
        if (outmode == OUTMODE_FLN ||
            outmode == OUTMODE_LST ||
-           !isatty(STDOUT_FILENO))
+           (conf.output.outfilename == NULL &&
+            conf.output.tagfilename == NULL &&
+            isatty(STDOUT_FILENO) == 0))
                outst.use_pager = 0;
 
        if (outst.use_pager &&
@@ -386,12 +389,16 @@ main(int argc, char *argv[])
        }
 
 #if HAVE_PLEDGE
-       if (outst.use_pager == 0) {
-               if (pledge("stdio rpath", NULL) == -1) {
-                       mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
-                           "%s", strerror(errno));
-                       return mandoc_msg_getrc();
-               }
+       if (outst.use_pager == 0)
+               c = pledge("stdio rpath", NULL);
+       else if (conf.output.outfilename != NULL ||
+           conf.output.tagfilename != NULL)
+               c = pledge("stdio rpath wpath cpath", NULL);
+       else
+               c = pledge("stdio rpath tmppath tty proc exec", NULL);
+       if (c == -1) {
+               mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
+               return mandoc_msg_getrc();
        }
 #endif
 
@@ -445,7 +452,8 @@ main(int argc, char *argv[])
 
        /* Read the configuration file. */
 
-       if (search.argmode != ARG_FILE)
+       if (search.argmode != ARG_FILE ||
+           mandoc_msg_getmin() == MANDOCERR_STYLE)
                manconf_parse(&conf, conf_file, defpaths, auxpaths);
 
        /* man(1): Resolve each name individually. */
@@ -609,6 +617,10 @@ main(int argc, char *argv[])
                (void)fchdir(startdir);
                close(startdir);
        }
+       if (conf.output.tag != NULL && conf.output.tag_found == 0) {
+               mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
+               conf.output.tag = NULL;
+       }
        if (outst.outdata != NULL) {
                switch (outst.outtype) {
                case OUTT_HTML:
@@ -617,7 +629,6 @@ main(int argc, char *argv[])
                case OUTT_UTF8:
                case OUTT_LOCALE:
                case OUTT_ASCII:
-                       term_tag_finish();
                        ascii_free(outst.outdata);
                        break;
                case OUTT_PDF:
@@ -638,8 +649,10 @@ out:
                manconf_free(&conf);
 
        if (outst.tag_files != NULL) {
-               fclose(stdout);
-               run_pager(outst.tag_files);
+               if (term_tag_close() != -1 &&
+                   conf.output.outfilename == NULL &&
+                   conf.output.tagfilename == NULL)
+                       run_pager(&outst, conf.output.tag);
                term_tag_unlink();
        } else if (outst.had_output && outst.outtype != OUTT_LINT)
                mandoc_msg_summary();
@@ -831,20 +844,29 @@ process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
        } else
                fd = STDIN_FILENO;
 
-       if (outst->outtype <= OUTT_UTF8) {
-               if (outst->use_pager) {
-                       outst->use_pager = 0;
-                       outst->tag_files = term_tag_init(conf->output.tag);
-               }
-               if (outst->had_output) {
-                       if (outst->outdata == NULL)
-                               outdata_alloc(outst, &conf->output);
-                       terminal_sepline(outst->outdata);
+       if (outst->use_pager) {
+               outst->use_pager = 0;
+               outst->tag_files = term_tag_init(conf->output.outfilename,
+                   outst->outtype == OUTT_HTML ? ".html" : "",
+                   conf->output.tagfilename);
+#if HAVE_PLEDGE
+               if ((conf->output.outfilename != NULL ||
+                    conf->output.tagfilename != NULL) &&
+                   pledge("stdio rpath cpath", NULL) == -1) {
+                       mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
+                           "%s", strerror(errno));
+                       exit(mandoc_msg_getrc());
                }
+#endif
+       }
+       if (outst->had_output && outst->outtype <= OUTT_UTF8) {
+               if (outst->outdata == NULL)
+                       outdata_alloc(outst, &conf->output);
+               terminal_sepline(outst->outdata);
        }
 
        if (resp->form == FORM_SRC)
-               parse(mp, fd, resp->file, outst, &conf->output);
+               parse(mp, fd, resp->file, outst, conf);
        else {
                passthrough(fd, conf->output.synopsisonly);
                outst->had_output = 1;
@@ -865,8 +887,9 @@ process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
 
 static void
 parse(struct mparse *mp, int fd, const char *file,
-    struct outstate *outst, struct manoutput *outconf)
+    struct outstate *outst, struct manconf *conf)
 {
+       static struct manpaths   basepaths;
        static int               previous;
        struct roff_meta        *meta;
 
@@ -892,9 +915,9 @@ parse(struct mparse *mp, int fd, const char *file,
                return;
 
        if (outst->outdata == NULL)
-               outdata_alloc(outst, outconf);
+               outdata_alloc(outst, &conf->output);
        else if (outst->outtype == OUTT_HTML)
-               html_reset(outst);
+               html_reset(outst->outdata);
 
        mandoc_xr_reset();
        meta = mparse_result(mp);
@@ -945,25 +968,32 @@ parse(struct mparse *mp, int fd, const char *file,
                case OUTT_PS:
                        terminal_man(outst->outdata, meta);
                        break;
+               case OUTT_MARKDOWN:
+                       mandoc_msg(MANDOCERR_MAN_TMARKDOWN, 0, 0, NULL);
+                       break;
                default:
                        break;
                }
        }
-       if (mandoc_msg_getmin() < MANDOCERR_STYLE)
-               check_xr();
+       if (conf->output.tag != NULL && conf->output.tag_found == 0 &&
+           tag_exists(conf->output.tag))
+               conf->output.tag_found = 1;
+
+       if (mandoc_msg_getmin() < MANDOCERR_STYLE) {
+               if (basepaths.sz == 0)
+                       manpath_base(&basepaths);
+               check_xr(&basepaths);
+       } else if (mandoc_msg_getmin() < MANDOCERR_WARNING)
+               check_xr(&conf->manpath);
 }
 
 static void
-check_xr(void)
+check_xr(struct manpaths *paths)
 {
-       static struct manpaths   paths;
        struct mansearch         search;
        struct mandoc_xr        *xr;
        size_t                   sz;
 
-       if (paths.sz == 0)
-               manpath_base(&paths);
-
        for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
                if (xr->line == -1)
                        continue;
@@ -972,9 +1002,9 @@ check_xr(void)
                search.outkey = NULL;
                search.argmode = ARG_NAME;
                search.firstmatch = 1;
-               if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))
+               if (mansearch(&search, paths, 1, &xr->name, NULL, &sz))
                        continue;
-               if (fs_search(&search, &paths, xr->name, NULL, &sz) != -1)
+               if (fs_search(&search, paths, xr->name, NULL, &sz) != -1)
                        continue;
                if (xr->count == 1)
                        mandoc_msg(MANDOCERR_XR_BAD, xr->line,
@@ -1139,29 +1169,29 @@ woptions(char *arg, enum mandoc_os *os_e, int *wstop)
  * then fork the pager and wait for the user to close it.
  */
 static void
-run_pager(struct tag_files *tag_files)
+run_pager(struct outstate *outst, char *tag_target)
 {
        int      signum, status;
        pid_t    man_pgid, tc_pgid;
        pid_t    pager_pid, wait_pid;
 
        man_pgid = getpgid(0);
-       tag_files->tcpgid = man_pgid == getpid() ? getpgid(getppid()) :
-           man_pgid;
+       outst->tag_files->tcpgid =
+           man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
        pager_pid = 0;
        signum = SIGSTOP;
 
        for (;;) {
                /* Stop here until moved to the foreground. */
 
-               tc_pgid = tcgetpgrp(tag_files->ofd);
+               tc_pgid = tcgetpgrp(STDOUT_FILENO);
                if (tc_pgid != man_pgid) {
                        if (tc_pgid == pager_pid) {
-                               (void)tcsetpgrp(tag_files->ofd, man_pgid);
+                               (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
                                if (signum == SIGTTIN)
                                        continue;
                        } else
-                               tag_files->tcpgid = tc_pgid;
+                               outst->tag_files->tcpgid = tc_pgid;
                        kill(0, signum);
                        continue;
                }
@@ -1169,10 +1199,10 @@ run_pager(struct tag_files *tag_files)
                /* Once in the foreground, activate the pager. */
 
                if (pager_pid) {
-                       (void)tcsetpgrp(tag_files->ofd, pager_pid);
+                       (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
                        kill(pager_pid, SIGCONT);
                } else
-                       pager_pid = spawn_pager(tag_files);
+                       pager_pid = spawn_pager(outst, tag_target);
 
                /* Wait for the pager to stop or exit. */
 
@@ -1193,7 +1223,7 @@ run_pager(struct tag_files *tag_files)
 }
 
 static pid_t
-spawn_pager(struct tag_files *tag_files)
+spawn_pager(struct outstate *outst, char *tag_target)
 {
        const struct timespec timeout = { 0, 100000000 };  /* 0.1s */
 #define MAX_PAGER_ARGS 16
@@ -1206,11 +1236,14 @@ spawn_pager(struct tag_files *tag_files)
        int              argc, use_ofn;
        pid_t            pager_pid;
 
+       assert(outst->tag_files->ofd == -1);
+       assert(outst->tag_files->tfs == NULL);
+
        pager = getenv("MANPAGER");
        if (pager == NULL || *pager == '\0')
                pager = getenv("PAGER");
        if (pager == NULL || *pager == '\0')
-               pager = "more -s";
+               pager = BINM_PAGER;
        cp = mandoc_strdup(pager);
 
        /*
@@ -1235,21 +1268,28 @@ spawn_pager(struct tag_files *tag_files)
 
        use_ofn = 1;
 #if HAVE_LESS_T
-       if (*tag_files->tfn != '\0' && (cmdlen = strlen(argv[0])) >= 4) {
+       if (*outst->tag_files->tfn != '\0' &&
+           (cmdlen = strlen(argv[0])) >= 4) {
                cp = argv[0] + cmdlen - 4;
                if (strcmp(cp, "less") == 0) {
                        argv[argc++] = mandoc_strdup("-T");
-                       argv[argc++] = tag_files->tfn;
-                       if (tag_files->tagname != NULL) {
+                       argv[argc++] = outst->tag_files->tfn;
+                       if (tag_target != NULL) {
                                argv[argc++] = mandoc_strdup("-t");
-                               argv[argc++] = tag_files->tagname;
+                               argv[argc++] = tag_target;
                                use_ofn = 0;
                        }
                }
        }
 #endif
-       if (use_ofn)
-               argv[argc++] = tag_files->ofn;
+       if (use_ofn) {
+               if (outst->outtype == OUTT_HTML && tag_target != NULL)
+                       mandoc_asprintf(&argv[argc], "file://%s#%s",
+                           outst->tag_files->ofn, tag_target);
+               else
+                       argv[argc] = outst->tag_files->ofn;
+               argc++;
+       }
        argv[argc] = NULL;
 
        switch (pager_pid = fork()) {
@@ -1260,7 +1300,7 @@ spawn_pager(struct tag_files *tag_files)
                break;
        default:
                (void)setpgid(pager_pid, 0);
-               (void)tcsetpgrp(tag_files->ofd, pager_pid);
+               (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
 #if HAVE_PLEDGE
                if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
                        mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
@@ -1268,20 +1308,14 @@ spawn_pager(struct tag_files *tag_files)
                        exit(mandoc_msg_getrc());
                }
 #endif
-               tag_files->pager_pid = pager_pid;
+               outst->tag_files->pager_pid = pager_pid;
                return pager_pid;
        }
 
-       /* The child process becomes the pager. */
-
-       if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) {
-               mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno));
-               _exit(mandoc_msg_getrc());
-       }
-       close(tag_files->ofd);
-       assert(tag_files->tfs == NULL);
-
-       /* Do not start the pager before controlling the terminal. */
+       /*
+        * The child process becomes the pager.
+        * Do not start it before controlling the terminal.
+        */
 
        while (tcgetpgrp(STDOUT_FILENO) != getpid())
                nanosleep(&timeout, NULL);