]> git.cameronkatri.com Git - mandoc.git/blobdiff - main.c
during prioritization for man(1), correctly extract the section name
[mandoc.git] / main.c
diff --git a/main.c b/main.c
index 862eb9bf47439f7b0d8fbabc2c91c9eafbde0ab1..c5a7cff918ab681846f5fb0dde9293f7f08fde25 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,7 +1,7 @@
-/*     $Id: main.c,v 1.344 2020/02/24 21:16:31 schwarze Exp $ */
+/* $Id: main.c,v 1.358 2021/09/04 22:38:46 schwarze Exp $ */
 /*
+ * Copyright (c) 2010-2012, 2014-2021 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010-2012, 2014-2020 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"
 
@@ -53,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"
@@ -90,10 +93,12 @@ struct      outstate {
 
 int                      mandocdb(int, char *[]);
 
-static void              check_xr(void);
-static int               fs_lookup(const struct manpaths *,
-                               size_t ipath, const char *,
-                               const char *, const char *,
+static void              check_xr(struct manpaths *);
+static void              fs_append(char **, size_t, int,
+                               size_t, const char *, enum form,
+                               struct manpage **, size_t *);
+static int               fs_lookup(const struct manpaths *, size_t,
+                               const char *, const char *, const char *,
                                struct manpage **, size_t *);
 static int               fs_search(const struct mansearch *,
                                const struct manpaths *, const char *,
@@ -101,12 +106,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 *);
 
@@ -127,7 +132,7 @@ main(int argc, char *argv[])
        struct mparse   *mp;            /* Opaque parser object. */
        const char      *conf_file;     /* -C: alternate config file. */
        const char      *os_s;          /* -I: Operating system for display. */
-       const char      *progname, *sec;
+       const char      *progname, *sec, *ep;
        char            *defpaths;      /* -M: override manpaths. */
        char            *auxpaths;      /* -m: additional manpaths. */
        char            *oarg;          /* -O: output option string. */
@@ -162,7 +167,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();
        }
@@ -370,7 +375,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 &&
@@ -384,12 +391,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
 
@@ -443,7 +454,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. */
@@ -524,11 +536,16 @@ main(int argc, char *argv[])
                                        sec++; /* Prefer without suffix. */
                                if (*sec != '/')
                                        prio += 10; /* Wrong dir name. */
-                               if (search.sec != NULL &&
-                                   (strlen(sec) <= ssz  + 3 ||
-                                    strcmp(sec + strlen(sec) - ssz,
-                                     search.sec) != 0))
-                                       prio += 20; /* Wrong file ext. */
+                               if (search.sec != NULL) {
+                                       ep = strchr(sec, '\0');
+                                       if (ep - sec > 3 &&
+                                           strncmp(ep - 3, ".gz", 3) == 0)
+                                               ep -= 3;
+                                       if ((size_t)(ep - sec) < ssz + 3 ||
+                                           strncmp(ep - ssz, search.sec,
+                                            ssz) != 0)      /* Wrong file */
+                                               prio += 20;  /* extension. */
+                               }
                                if (prio >= best_prio)
                                        continue;
                                best_prio = prio;
@@ -598,7 +615,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)
@@ -608,7 +624,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:
@@ -637,10 +656,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();
 
@@ -687,6 +707,30 @@ glob_esc(char **dst, const char *src, const char *suffix)
                *(*dst)++ = *suffix++;
 }
 
+static void
+fs_append(char **file, size_t filesz, int copy, size_t ipath,
+    const char *sec, enum form form, struct manpage **res, size_t *ressz)
+{
+       struct manpage  *page;
+
+       *res = mandoc_reallocarray(*res, *ressz + filesz, sizeof(**res));
+       page = *res + *ressz;
+       *ressz += filesz;
+       for (;;) {
+               page->file = copy ? mandoc_strdup(*file) : *file;
+               page->names = NULL;
+               page->output = NULL;
+               page->bits = NAME_FILE & NAME_MASK;
+               page->ipath = ipath;
+               page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
+               page->form = form;
+               if (--filesz == 0)
+                       break;
+               file++;
+               page++;
+       }
+}
+
 static int
 fs_lookup(const struct manpaths *paths, size_t ipath,
        const char *sec, const char *arch, const char *name,
@@ -694,16 +738,19 @@ fs_lookup(const struct manpaths *paths, size_t ipath,
 {
        struct stat      sb;
        glob_t           globinfo;
-       struct manpage  *page;
-       char            *file, *cp;
+       char            *file, *cp, secnum[2];
        int              globres;
        enum form        form;
 
        const char *const slman = "/man";
        const char *const slash = "/";
        const char *const sglob = ".[01-9]*";
+       const char *const dot   = ".";
+       const char *const aster = "*";
 
+       memset(&globinfo, 0, sizeof(globinfo));
        form = FORM_SRC;
+
        mandoc_asprintf(&file, "%s/man%s/%s.%s",
            paths->paths[ipath], sec, name, sec);
        if (stat(file, &sb) != -1)
@@ -738,14 +785,34 @@ fs_lookup(const struct manpaths *paths, size_t ipath,
                mandoc_msg(MANDOCERR_GLOB, 0, 0,
                    "%s: %s", file, strerror(errno));
        free(file);
+       file = NULL;
        if (globres == 0)
-               file = mandoc_strdup(*globinfo.gl_pathv);
+               goto found;
        globfree(&globinfo);
-       if (globres == 0) {
-               if (stat(file, &sb) != -1)
-                       goto found;
+
+       if (sec[1] != '\0' && *ressz == 0) {
+               secnum[0] = sec[0];
+               secnum[1] = '\0';
+               cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
+                   strlen(slman) + strlen(secnum) * 2 + strlen(slash) +
+                   strlen(name) * 2 + strlen(dot) +
+                   strlen(sec) * 2 + strlen(aster) + 1);
+               glob_esc(&cp, paths->paths[ipath], slman);
+               glob_esc(&cp, secnum, slash);
+               glob_esc(&cp, name, dot);
+               glob_esc(&cp, sec, aster);
+               *cp = '\0';
+               globres = glob(file, 0, NULL, &globinfo);
+               if (globres != 0 && globres != GLOB_NOMATCH)
+                       mandoc_msg(MANDOCERR_GLOB, 0, 0,
+                           "%s: %s", file, strerror(errno));
                free(file);
+               file = NULL;
+               if (globres == 0)
+                       goto found;
+               globfree(&globinfo);
        }
+
        if (res != NULL || ipath + 1 != paths->sz)
                return -1;
 
@@ -757,19 +824,14 @@ fs_lookup(const struct manpaths *paths, size_t ipath,
 found:
        warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
            name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
-       if (res == NULL) {
+       if (res == NULL)
                free(file);
-               return 0;
-       }
-       *res = mandoc_reallocarray(*res, ++*ressz, sizeof(**res));
-       page = *res + (*ressz - 1);
-       page->file = file;
-       page->names = NULL;
-       page->output = NULL;
-       page->bits = NAME_FILE & NAME_MASK;
-       page->ipath = ipath;
-       page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
-       page->form = form;
+       else if (file == NULL)
+               fs_append(globinfo.gl_pathv, globinfo.gl_pathc, 1,
+                   ipath, sec, form, res, ressz);
+       else
+               fs_append(&file, 1, 0, ipath, sec, form, res, ressz);
+       globfree(&globinfo);
        return 0;
 }
 
@@ -833,9 +895,19 @@ 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,
+                   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);
@@ -843,7 +915,7 @@ process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
        }
 
        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;
@@ -853,7 +925,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",
@@ -864,8 +936,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;
 
@@ -891,9 +964,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);
@@ -944,25 +1017,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;
@@ -971,9 +1051,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,
@@ -1138,29 +1218,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;
                }
@@ -1168,10 +1248,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. */
 
@@ -1192,7 +1272,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
@@ -1205,11 +1285,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);
 
        /*
@@ -1234,21 +1317,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()) {
@@ -1259,7 +1349,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,
@@ -1267,20 +1357,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);