]> git.cameronkatri.com Git - mandoc.git/blobdiff - cgi.c
better error message if mandocd is not found
[mandoc.git] / cgi.c
diff --git a/cgi.c b/cgi.c
index afb38f1d8c5c4d71f554713f012fb5ad4fe6d29f..91310ce404b4d2440f60c0508a07c7aa8cc93644 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,7 +1,7 @@
-/*     $Id: cgi.c,v 1.160 2018/10/02 19:41:23 schwarze Exp $ */
+/* $Id: cgi.c,v 1.175 2021/08/19 15:23:36 schwarze Exp $ */
 /*
+ * Copyright (c) 2014-2019, 2021 Ingo Schwarze <schwarze@usta.de>
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2014, 2015, 2016, 2017, 2018 Ingo Schwarze <schwarze@usta.de>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -14,6 +14,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.
+ *
+ * Implementation of the man.cgi(8) program.
  */
 #include "config.h"
 
@@ -38,6 +40,7 @@
 #include "roff.h"
 #include "mdoc.h"
 #include "man.h"
+#include "mandoc_parse.h"
 #include "main.h"
 #include "manconf.h"
 #include "mansearch.h"
@@ -69,14 +72,15 @@ enum        focus {
 static void             html_print(const char *);
 static void             html_putchar(char);
 static int              http_decode(char *);
-static void             http_encode(const char *p);
+static void             http_encode(const char *);
 static void             parse_manpath_conf(struct req *);
-static void             parse_path_info(struct req *req, const char *path);
+static void             parse_path_info(struct req *, const char *);
 static void             parse_query_string(struct req *, const char *);
 static void             pg_error_badrequest(const char *);
 static void             pg_error_internal(void);
 static void             pg_index(const struct req *);
-static void             pg_noresult(const struct req *, const char *);
+static void             pg_noresult(const struct req *, int, const char *,
+                               const char *);
 static void             pg_redirect(const struct req *, const char *);
 static void             pg_search(const struct req *);
 static void             pg_searchres(const struct req *,
@@ -118,16 +122,18 @@ static    const char *const sec_names[] = {
 static const int sec_MAX = sizeof(sec_names) / sizeof(char *);
 
 static const char *const arch_names[] = {
-    "amd64",       "alpha",       "armv7",     "arm64",
-    "hppa",        "i386",        "landisk",
-    "loongson",    "luna88k",     "macppc",      "mips64",
-    "octeon",      "sgi",         "socppc",      "sparc64",
+    "amd64",       "alpha",       "armv7",       "arm64",
+    "hppa",        "i386",        "landisk",     "loongson",
+    "luna88k",     "macppc",      "mips64",      "octeon",
+    "powerpc64",   "riscv64",     "sparc64",
+
     "amiga",       "arc",         "armish",      "arm32",
     "atari",       "aviion",      "beagle",      "cats",
     "hppa64",      "hp300",
     "ia64",        "mac68k",      "mvme68k",     "mvme88k",
     "mvmeppc",     "palm",        "pc532",       "pegasos",
-    "pmax",        "powerpc",     "solbourne",   "sparc",
+    "pmax",        "powerpc",     "sgi",         "socppc",
+    "solbourne",   "sparc",
     "sun3",        "vax",         "wgrisc",      "x68k",
     "zaurus"
 };
@@ -323,7 +329,7 @@ http_encode(const char *p)
        for (; *p != '\0'; p++) {
                if (isalnum((unsigned char)*p) == 0 &&
                    strchr("-._~", *p) == NULL)
-                       printf("%%%02.2X", (unsigned char)*p);
+                       printf("%%%2.2X", (unsigned char)*p);
                else
                        putchar(*p);
        }
@@ -338,6 +344,8 @@ resp_begin_http(int code, const char *msg)
 
        printf("Content-Type: text/html; charset=utf-8\r\n"
             "Cache-Control: no-cache\r\n"
+            "Content-Security-Policy: default-src 'none'; "
+            "style-src 'self' 'unsafe-inline'\r\n"
             "Pragma: no-cache\r\n"
             "\r\n");
 
@@ -362,7 +370,8 @@ resp_copy(const char *filename)
 static void
 resp_begin_html(int code, const char *msg, const char *file)
 {
-       char    *cp;
+       const char      *name, *sec, *cp;
+       int              namesz, secsz;
 
        resp_begin_http(code, msg);
 
@@ -377,12 +386,27 @@ resp_begin_html(int code, const char *msg, const char *file)
               "  <title>",
               CSS_DIR);
        if (file != NULL) {
-               if ((cp = strrchr(file, '/')) != NULL)
-                       file = cp + 1;
-               if ((cp = strrchr(file, '.')) != NULL) {
-                       printf("%.*s(%s) - ", (int)(cp - file), file, cp + 1);
-               } else
-                       printf("%s - ", file);
+               cp = strrchr(file, '/');
+               name = cp == NULL ? file : cp + 1;
+               cp = strrchr(name, '.');
+               namesz = cp == NULL ? strlen(name) : cp - name;
+               sec = NULL;
+               if (cp != NULL && cp[1] != '0') {
+                       sec = cp + 1;
+                       secsz = strlen(sec);
+               } else if (name - file > 1) {
+                       for (cp = name - 2; cp >= file; cp--) {
+                               if (*cp < '1' || *cp > '9')
+                                       continue;
+                               sec = cp;
+                               secsz = name - cp - 1;
+                               break;
+                       }
+               }
+               printf("%.*s", namesz, name);
+               if (sec != NULL)
+                       printf("(%.*s)", secsz, sec);
+               fputs(" - ", stdout);
        }
        printf("%s</title>\n"
               "</head>\n"
@@ -407,7 +431,8 @@ resp_searchform(const struct req *req, enum focus focus)
 {
        int              i;
 
-       printf("<form action=\"/%s\" method=\"get\">\n"
+       printf("<form action=\"/%s\" method=\"get\" "
+              "autocomplete=\"off\" autocapitalize=\"none\">\n"
               "  <fieldset>\n"
               "    <legend>Manual Page Search Parameters</legend>\n",
               scriptname);
@@ -545,12 +570,13 @@ pg_index(const struct req *req)
 }
 
 static void
-pg_noresult(const struct req *req, const char *msg)
+pg_noresult(const struct req *req, int code, const char *http_msg,
+    const char *user_msg)
 {
-       resp_begin_html(200, NULL, NULL);
+       resp_begin_html(code, http_msg, NULL);
        resp_searchform(req, FOCUS_QUERY);
        puts("<p>");
-       puts(msg);
+       puts(user_msg);
        puts("</p>");
        resp_end_html();
 }
@@ -848,7 +874,7 @@ resp_format(const struct req *req, const char *file)
 {
        struct manoutput conf;
        struct mparse   *mp;
-       struct roff_man *man;
+       struct roff_meta *meta;
        void            *vp;
        int              fd;
        int              usepath;
@@ -859,38 +885,25 @@ resp_format(const struct req *req, const char *file)
        }
 
        mchars_alloc();
-       mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1,
-           MANDOCERR_MAX, NULL, MANDOC_OS_OTHER, req->q.manpath);
+       mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1 |
+           MPARSE_VALIDATE, MANDOC_OS_OTHER, req->q.manpath);
        mparse_readfd(mp, fd, file);
        close(fd);
+       meta = mparse_result(mp);
 
        memset(&conf, 0, sizeof(conf));
        conf.fragment = 1;
        conf.style = mandoc_strdup(CSS_DIR "/mandoc.css");
-       conf.toc = 1;
        usepath = strcmp(req->q.manpath, req->p[0]);
        mandoc_asprintf(&conf.man, "/%s%s%s%s%%N.%%S",
            scriptname, *scriptname == '\0' ? "" : "/",
            usepath ? req->q.manpath : "", usepath ? "/" : "");
 
-       mparse_result(mp, &man, NULL);
-       if (man == NULL) {
-               warnx("fatal mandoc error: %s/%s", req->q.manpath, file);
-               pg_error_internal();
-               mparse_free(mp);
-               mchars_free();
-               return;
-       }
-
        vp = html_alloc(&conf);
-
-       if (man->macroset == MACROSET_MDOC) {
-               mdoc_validate(man);
-               html_mdoc(vp, man);
-       } else {
-               man_validate(man);
-               html_man(vp, man);
-       }
+       if (meta->macroset == MACROSET_MDOC)
+               html_mdoc(vp, meta);
+       else
+               html_man(vp, meta);
 
        html_free(vp);
        mparse_free(mp);
@@ -1028,9 +1041,10 @@ pg_search(const struct req *req)
        if (req->isquery && req->q.equal && argc == 1)
                pg_redirect(req, argv[0]);
        else if (mansearch(&search, &paths, argc, argv, &res, &ressz) == 0)
-               pg_noresult(req, "You entered an invalid query.");
+               pg_noresult(req, 400, "Bad Request",
+                   "You entered an invalid query.");
        else if (ressz == 0)
-               pg_noresult(req, "No results found.");
+               pg_noresult(req, 404, "Not Found", "No results found.");
        else
                pg_searchres(req, res, ressz);
 
@@ -1144,80 +1158,74 @@ main(void)
 }
 
 /*
- * If PATH_INFO is not a file name, translate it to a query.
+ * Translate PATH_INFO to a query.
  */
 static void
 parse_path_info(struct req *req, const char *path)
 {
-       char    *dir[4];
-       int      i;
+       const char      *name, *sec, *end;
 
        req->isquery = 0;
        req->q.equal = 1;
-       req->q.manpath = mandoc_strdup(path);
+       req->q.manpath = NULL;
        req->q.arch = NULL;
 
        /* Mandatory manual page name. */
-       if ((req->q.query = strrchr(req->q.manpath, '/')) == NULL) {
-               req->q.query = req->q.manpath;
-               req->q.manpath = NULL;
-       } else
-               *req->q.query++ = '\0';
+       if ((name = strrchr(path, '/')) == NULL)
+               name = path;
+       else
+               name++;
 
        /* Optional trailing section. */
-       if ((req->q.sec = strrchr(req->q.query, '.')) != NULL) {
-               if(isdigit((unsigned char)req->q.sec[1])) {
-                       *req->q.sec++ = '\0';
-                       req->q.sec = mandoc_strdup(req->q.sec);
-               } else
-                       req->q.sec = NULL;
+       sec = strrchr(name, '.');
+       if (sec != NULL && isdigit((unsigned char)*++sec)) {
+               req->q.query = mandoc_strndup(name, sec - name - 1);
+               req->q.sec = mandoc_strdup(sec);
+       } else {
+               req->q.query = mandoc_strdup(name);
+               req->q.sec = NULL;
        }
 
        /* Handle the case of name[.section] only. */
-       if (req->q.manpath == NULL)
+       if (name == path)
                return;
-       req->q.query = mandoc_strdup(req->q.query);
-
-       /* Split directory components. */
-       dir[i = 0] = req->q.manpath;
-       while ((dir[i + 1] = strchr(dir[i], '/')) != NULL) {
-               if (++i == 3) {
-                       pg_error_badrequest(
-                           "You specified too many directory components.");
-                       exit(EXIT_FAILURE);
-               }
-               *dir[i]++ = '\0';
-       }
 
        /* Optional manpath. */
-       if ((i = validate_manpath(req, req->q.manpath)) == 0)
+       end = strchr(path, '/');
+       req->q.manpath = mandoc_strndup(path, end - path);
+       if (validate_manpath(req, req->q.manpath)) {
+               path = end + 1;
+               if (name == path)
+                       return;
+       } else {
+               free(req->q.manpath);
                req->q.manpath = NULL;
-       else if (dir[1] == NULL)
-               return;
+       }
 
        /* Optional section. */
-       if (strncmp(dir[i], "man", 3) == 0) {
+       if (strncmp(path, "man", 3) == 0 || strncmp(path, "cat", 3) == 0) {
+               path += 3;
+               end = strchr(path, '/');
                free(req->q.sec);
-               req->q.sec = mandoc_strdup(dir[i++] + 3);
+               req->q.sec = mandoc_strndup(path, end - path);
+               path = end + 1;
+               if (name == path)
+                       return;
        }
-       if (dir[i] == NULL) {
-               if (req->q.manpath == NULL)
-                       free(dir[0]);
-               return;
+
+       /* Optional architecture. */
+       end = strchr(path, '/');
+       if (end + 1 != name) {
+               pg_error_badrequest(
+                   "You specified too many directory components.");
+               exit(EXIT_FAILURE);
        }
-       if (dir[i + 1] != NULL) {
+       req->q.arch = mandoc_strndup(path, end - path);
+       if (validate_arch(req->q.arch) == 0) {
                pg_error_badrequest(
                    "You specified an invalid directory component.");
                exit(EXIT_FAILURE);
        }
-
-       /* Optional architecture. */
-       if (i) {
-               req->q.arch = mandoc_strdup(dir[i]);
-               if (req->q.manpath == NULL)
-                       free(dir[0]);
-       } else
-               req->q.arch = dir[0];
 }
 
 /*