]> git.cameronkatri.com Git - mandoc.git/blobdiff - main.c
adjust test framework to not require a tty
[mandoc.git] / main.c
diff --git a/main.c b/main.c
index 9da85435ca9ddbb6d859d0000ceeb35e6b39cf18..b571905bc7baf916968964375e8e9c75a85cdd47 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,7 +1,7 @@
-/*     $Id: main.c,v 1.339 2019/07/28 18:36:06 schwarze Exp $ */
+/* $Id: main.c,v 1.352 2020/07/21 15:10:01 schwarze Exp $ */
 /*
+ * Copyright (c) 2010-2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010-2012, 2014-2019 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
@@ -15,6 +15,8 @@
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ * Main program for mandoc(1), man(1), apropos(1), whatis(1), and help(1).
  */
 #include "config.h"
 
@@ -32,6 +34,7 @@
 #include <errno.h>
 #include <fcntl.h>
 #include <glob.h>
+#include <limits.h>
 #if HAVE_SANDBOX_INIT
 #include <sandbox.h>
 #endif
@@ -52,6 +55,7 @@
 #include "man.h"
 #include "mandoc_parse.h"
 #include "tag.h"
+#include "term_tag.h"
 #include "main.h"
 #include "manconf.h"
 #include "mansearch.h"
@@ -95,16 +99,17 @@ static      int               fs_lookup(const struct manpaths *,
                                const char *, const char *,
                                struct manpage **, size_t *);
 static int               fs_search(const struct mansearch *,
-                               const struct manpaths *, int, char**,
+                               const struct manpaths *, const char *,
                                struct manpage **, size_t *);
+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 *);
 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 *);
 
@@ -160,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();
        }
@@ -325,7 +330,8 @@ main(int argc, char *argv[])
 
        /* Postprocess options. */
 
-       if (outmode == OUTMODE_DEF) {
+       switch (outmode) {
+       case OUTMODE_DEF:
                switch (search.argmode) {
                case ARG_FILE:
                        outmode = OUTMODE_ALL;
@@ -338,6 +344,16 @@ main(int argc, char *argv[])
                        outmode = OUTMODE_LST;
                        break;
                }
+               break;
+       case OUTMODE_FLN:
+               if (search.argmode == ARG_FILE)
+                       outmode = OUTMODE_ALL;
+               break;
+       case OUTMODE_ALL:
+               break;
+       case OUTMODE_LST:
+       case OUTMODE_ONE:
+               abort();
        }
 
        if (oarg != NULL) {
@@ -357,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 &&
@@ -371,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
 
@@ -436,19 +458,42 @@ main(int argc, char *argv[])
        /* man(1): Resolve each name individually. */
 
        if (search.argmode == ARG_NAME) {
-               if (argc < 1)
-                       usage(ARG_NAME);
+               if (argc < 1) {
+                       if (outmode != OUTMODE_FLN)
+                               usage(ARG_NAME);
+                       if (conf.manpath.sz == 0) {
+                               warnx("The manpath is empty.");
+                               mandoc_msg_setrc(MANDOCLEVEL_BADARG);
+                       } else {
+                               for (i = 0; i + 1 < conf.manpath.sz; i++)
+                                       printf("%s:", conf.manpath.paths[i]);
+                               printf("%s\n", conf.manpath.paths[i]);
+                       }
+                       manconf_free(&conf);
+                       return (int)mandoc_msg_getrc();
+               }
                for (res = NULL, ressz = 0; argc > 0; argc--, argv++) {
                        (void)mansearch(&search, &conf.manpath,
                            1, argv, &resn, &resnsz);
                        if (resnsz == 0)
                                (void)fs_search(&search, &conf.manpath,
-                                   1, argv, &resn, &resnsz);
+                                   *argv, &resn, &resnsz);
+                       if (resnsz == 0 && strchr(*argv, '/') == NULL) {
+                               if (search.arch != NULL &&
+                                   arch_valid(search.arch, OSENUM) == 0)
+                                       warnx("Unknown architecture \"%s\".",
+                                           search.arch);
+                               else if (search.sec != NULL)
+                                       warnx("No entry for %s in "
+                                           "section %s of the manual.",
+                                           *argv, search.sec);
+                               else
+                                       warnx("No entry for %s in "
+                                           "the manual.", *argv);
+                               mandoc_msg_setrc(MANDOCLEVEL_BADARG);
+                               continue;
+                       }
                        if (resnsz == 0) {
-                               if (strchr(*argv, '/') == NULL) {
-                                       mandoc_msg_setrc(MANDOCLEVEL_BADARG);
-                                       continue;
-                               }
                                if (access(*argv, R_OK) == -1) {
                                        mandoc_msg_setinfilename(*argv);
                                        mandoc_msg(MANDOCERR_BADARG_BAD,
@@ -562,7 +607,6 @@ main(int argc, char *argv[])
         * readable: Maybe it won't be needed after all.
         */
        startdir = open(".", O_RDONLY | O_DIRECTORY);
-
        for (i = 0; i < ressz; i++) {
                process_onefile(mp, res + i, startdir, &outst, &conf);
                if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
@@ -572,7 +616,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:
@@ -601,10 +648,11 @@ out:
                manconf_free(&conf);
 
        if (outst.tag_files != NULL) {
-               fclose(stdout);
-               tag_write();
-               run_pager(outst.tag_files);
-               tag_unlink();
+               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();
 
@@ -639,6 +687,18 @@ usage(enum argmode argmode)
        exit((int)MANDOCLEVEL_BADARG);
 }
 
+static void
+glob_esc(char **dst, const char *src, const char *suffix)
+{
+       while (*src != '\0') {
+               if (strchr("*?[", *src) != NULL)
+                       *(*dst)++ = '\\';
+               *(*dst)++ = *src++;
+       }
+       while (*suffix != '\0')
+               *(*dst)++ = *suffix++;
+}
+
 static int
 fs_lookup(const struct manpaths *paths, size_t ipath,
        const char *sec, const char *arch, const char *name,
@@ -647,10 +707,14 @@ fs_lookup(const struct manpaths *paths, size_t ipath,
        struct stat      sb;
        glob_t           globinfo;
        struct manpage  *page;
-       char            *file;
+       char            *file, *cp;
        int              globres;
        enum form        form;
 
+       const char *const slman = "/man";
+       const char *const slash = "/";
+       const char *const sglob = ".[01-9]*";
+
        form = FORM_SRC;
        mandoc_asprintf(&file, "%s/man%s/%s.%s",
            paths->paths[ipath], sec, name, sec);
@@ -674,8 +738,13 @@ fs_lookup(const struct manpaths *paths, size_t ipath,
                free(file);
        }
 
-       mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
-           paths->paths[ipath], sec, name);
+       cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
+           strlen(slman) + strlen(sec) * 2 + strlen(slash) +
+           strlen(name) * 2 + strlen(sglob) + 1);
+       glob_esc(&cp, paths->paths[ipath], slman);
+       glob_esc(&cp, sec, slash);
+       glob_esc(&cp, name, sglob);
+       *cp = '\0';
        globres = glob(file, 0, NULL, &globinfo);
        if (globres != 0 && globres != GLOB_NOMATCH)
                mandoc_msg(MANDOCERR_GLOB, 0, 0,
@@ -718,48 +787,30 @@ found:
 
 static int
 fs_search(const struct mansearch *cfg, const struct manpaths *paths,
-       int argc, char **argv, struct manpage **res, size_t *ressz)
+       const char *name, struct manpage **res, size_t *ressz)
 {
        const char *const sections[] =
            {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
        const size_t nsec = sizeof(sections)/sizeof(sections[0]);
 
-       size_t           ipath, isec, lastsz;
+       size_t           ipath, isec;
 
        assert(cfg->argmode == ARG_NAME);
-
        if (res != NULL)
                *res = NULL;
-       *ressz = lastsz = 0;
-       while (argc) {
-               for (ipath = 0; ipath < paths->sz; ipath++) {
-                       if (cfg->sec != NULL) {
-                               if (fs_lookup(paths, ipath, cfg->sec,
-                                   cfg->arch, *argv, res, ressz) != -1 &&
-                                   cfg->firstmatch)
-                                       return 0;
-                       } else for (isec = 0; isec < nsec; isec++)
+       *ressz = 0;
+       for (ipath = 0; ipath < paths->sz; ipath++) {
+               if (cfg->sec != NULL) {
+                       if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,
+                           name, res, ressz) != -1 && cfg->firstmatch)
+                               return 0;
+               } else {
+                       for (isec = 0; isec < nsec; isec++)
                                if (fs_lookup(paths, ipath, sections[isec],
-                                   cfg->arch, *argv, res, ressz) != -1 &&
+                                   cfg->arch, name, res, ressz) != -1 &&
                                    cfg->firstmatch)
                                        return 0;
                }
-               if (res != NULL && *ressz == lastsz &&
-                   strchr(*argv, '/') == NULL) {
-                       if (cfg->arch != NULL &&
-                           arch_valid(cfg->arch, OSENUM) == 0)
-                               warnx("Unknown architecture \"%s\".",
-                                   cfg->arch);
-                       else if (cfg->sec == NULL)
-                               warnx("No entry for %s in the manual.",
-                                   *argv);
-                       else
-                               warnx("No entry for %s in section %s "
-                                   "of the manual.", *argv, cfg->sec);
-               }
-               lastsz = *ressz;
-               argv++;
-               argc--;
        }
        return -1;
 }
@@ -794,9 +845,16 @@ process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
 
        if (outst->use_pager) {
                outst->use_pager = 0;
-               outst->tag_files = tag_init(conf->output.tag);
+               outst->tag_files = term_tag_init(conf->output.outfilename,
+                   conf->output.tagfilename);
+               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());
+               }
        }
-
        if (outst->had_output && outst->outtype <= OUTT_UTF8) {
                if (outst->outdata == NULL)
                        outdata_alloc(outst, &conf->output);
@@ -814,7 +872,7 @@ process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
                if (outst->tag_files != NULL) {
                        mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
                            outst->tag_files->ofn, strerror(errno));
-                       tag_unlink();
+                       term_tag_unlink();
                        outst->tag_files = NULL;
                } else
                        mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
@@ -854,7 +912,7 @@ parse(struct mparse *mp, int fd, const char *file,
        if (outst->outdata == NULL)
                outdata_alloc(outst, outconf);
        else if (outst->outtype == OUTT_HTML)
-               html_reset(outst);
+               html_reset(outst->outdata);
 
        mandoc_xr_reset();
        meta = mparse_result(mp);
@@ -909,6 +967,9 @@ parse(struct mparse *mp, int fd, const char *file,
                        break;
                }
        }
+       if (outconf->tag != NULL && outconf->tag_found == 0 &&
+           tag_exists(outconf->tag))
+               outconf->tag_found = 1;
        if (mandoc_msg_getmin() < MANDOCERR_STYLE)
                check_xr();
 }
@@ -934,7 +995,7 @@ check_xr(void)
                search.firstmatch = 1;
                if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))
                        continue;
-               if (fs_search(&search, &paths, 1, &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,
@@ -1099,29 +1160,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;
                }
@@ -1129,10 +1190,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. */
 
@@ -1153,7 +1214,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
@@ -1166,11 +1227,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);
 
        /*
@@ -1195,21 +1259,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()) {
@@ -1220,7 +1291,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,
@@ -1228,20 +1299,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->tfd == -1);
-
-       /* 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);