delete some TODO entries that were already fixed

[mandoc.git] / cgi.c

diff --git a/cgi.c b/cgi.c
index 04a02d63819b233a35dad2f8c40721d9ae5f5e31..14ff5f8b6ab6417de7baaaf8d35f304c85e40f9d 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,37 +1,40 @@
-/*     $Id: cgi.c,v 1.88 2014/07/25 18:20:39 schwarze Exp $ */
+/*     $Id: cgi.c,v 1.108 2015/04/18 16:34:25 schwarze Exp $ */

 /*
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>

- * Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>
+ * Copyright (c) 2014, 2015 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
  * copyright notice and this permission notice appear in all copies.
  *
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES

  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR

  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * 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.
  */
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * 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.
  */

-#ifdef HAVE_CONFIG_H

 #include "config.h"
 #include "config.h"

-#endif
+
+#include <sys/types.h>
+#include <sys/time.h>

 
 #include <ctype.h>
 #include <errno.h>
 #include <fcntl.h>
 #include <limits.h>
 
 #include <ctype.h>
 #include <errno.h>
 #include <fcntl.h>
 #include <limits.h>

+#include <stdint.h>

 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
 

-#include "mandoc.h"

 #include "mandoc_aux.h"
 #include "mandoc_aux.h"

+#include "mandoc.h"
+#include "roff.h"

 #include "main.h"
 #include "main.h"

-#include "manpath.h"
+#include "manconf.h"

 #include "mansearch.h"
 #include "cgi.h"
 
 #include "mansearch.h"
 #include "cgi.h"
 


@@ -55,13 +58,12 @@ struct      req {
 static void             catman(const struct req *, const char *);
 static void             format(const struct req *, const char *);
 static void             html_print(const char *);
 static void             catman(const struct req *, const char *);
 static void             format(const struct req *, const char *);
 static void             html_print(const char *);

-static void             html_printquery(const struct req *);

 static void             html_putchar(char);
 static void             html_putchar(char);

-static int              http_decode(char *);
+static int              http_decode(char *);

 static void             http_parse(struct req *, const char *);
 static void             http_print(const char *);
 static void             http_parse(struct req *, const char *);
 static void             http_print(const char *);

-static void             http_putchar(char);
-static void             http_printquery(const struct req *);
+static void             http_putchar(char);
+static void             http_printquery(const struct req *, const char *);

 static void             pathgen(struct req *);
 static void             pg_error_badrequest(const char *);
 static void             pg_error_internal(void);
 static void             pathgen(struct req *);
 static void             pg_error_badrequest(const char *);
 static void             pg_error_internal(void);


@@ -91,14 +93,14 @@ static      const char *const sec_names[] = {
     "All Sections",
     "1 - General Commands",
     "2 - System Calls",
     "All Sections",
     "1 - General Commands",
     "2 - System Calls",

-    "3 - Subroutines",
-    "3p - Perl Subroutines",
-    "4 - Special Files",
+    "3 - Library Functions",
+    "3p - Perl Library",
+    "4 - Device Drivers",

     "5 - File Formats",
     "6 - Games",
     "5 - File Formats",
     "6 - Games",

-    "7 - Macros and Conventions",
-    "8 - Maintenance Commands",
-    "9 - Kernel Interface"
+    "7 - Miscellaneous Information",
+    "8 - System Manager\'s Manual",
+    "9 - Kernel Developer\'s Manual"

 };
 static const int sec_MAX = sizeof(sec_names) / sizeof(char *);
 
 };
 static const int sec_MAX = sizeof(sec_names) / sizeof(char *);
 


@@ -145,7 +147,7 @@ html_putchar(char c)
 }
 
 static void
 }
 
 static void

-http_printquery(const struct req *req)
+http_printquery(const struct req *req, const char *sep)

 {
 
        if (NULL != req->q.query) {
 {
 
        if (NULL != req->q.query) {


@@ -153,47 +155,21 @@ http_printquery(const struct req *req)
                http_print(req->q.query);
        }
        if (0 == req->q.equal)
                http_print(req->q.query);
        }
        if (0 == req->q.equal)

-               printf("&apropos=1");
+               printf("%sapropos=1", sep);

        if (NULL != req->q.sec) {
        if (NULL != req->q.sec) {

-               printf("&sec=");
+               printf("%ssec=", sep);

                http_print(req->q.sec);
        }
        if (NULL != req->q.arch) {
                http_print(req->q.sec);
        }
        if (NULL != req->q.arch) {

-               printf("&arch=");
+               printf("%sarch=", sep);

                http_print(req->q.arch);
        }
                http_print(req->q.arch);
        }

-       if (NULL != req->q.manpath &&
-           strcmp(req->q.manpath, req->p[0])) {
-               printf("&manpath=");
+       if (strcmp(req->q.manpath, req->p[0])) {
+               printf("%smanpath=", sep);

                http_print(req->q.manpath);
        }
 }
 
                http_print(req->q.manpath);
        }
 }
 

-static void
-html_printquery(const struct req *req)
-{
-
-       if (NULL != req->q.query) {
-               printf("query=");
-               html_print(req->q.query);
-       }
-       if (0 == req->q.equal)
-               printf("&amp;apropos=1");
-       if (NULL != req->q.sec) {
-               printf("&amp;sec=");
-               html_print(req->q.sec);
-       }
-       if (NULL != req->q.arch) {
-               printf("&amp;arch=");
-               html_print(req->q.arch);
-       }
-       if (NULL != req->q.manpath &&
-           strcmp(req->q.manpath, req->p[0])) {
-               printf("&amp;manpath=");
-               html_print(req->q.manpath);
-       }
-}
-

 static void
 http_print(const char *p)
 {
 static void
 http_print(const char *p)
 {


@@ -211,7 +187,7 @@ http_print(const char *p)
 static void
 html_print(const char *p)
 {
 static void
 html_print(const char *p)
 {

-       
+

        if (NULL == p)
                return;
        while ('\0' != *p)
        if (NULL == p)
                return;
        while ('\0' != *p)


@@ -322,11 +298,6 @@ next:
                if (*qs != '\0')
                        qs++;
        }
                if (*qs != '\0')
                        qs++;
        }

-
-       /* Fall back to the default manpath. */
-
-       if (req->q.manpath == NULL)
-               req->q.manpath = mandoc_strdup(req->p[0]);

 }
 
 static void
 }
 
 static void


@@ -400,13 +371,10 @@ resp_begin_html(int code, const char *msg)
 
        resp_begin_http(code, msg);
 
 
        resp_begin_http(code, msg);
 

-       printf("<!DOCTYPE HTML PUBLIC "
-              " \"-//W3C//DTD HTML 4.01//EN\""
-              " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
+       printf("<!DOCTYPE html>\n"

               "<HTML>\n"
               "<HEAD>\n"
               "<HTML>\n"
               "<HEAD>\n"

-              "<META HTTP-EQUIV=\"Content-Type\""
-              " CONTENT=\"text/html; charset=utf-8\">\n"
+              "<META CHARSET=\"UTF-8\" />\n"

               "<LINK REL=\"stylesheet\" HREF=\"%s/man-cgi.css\""
               " TYPE=\"text/css\" media=\"all\">\n"
               "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""
               "<LINK REL=\"stylesheet\" HREF=\"%s/man-cgi.css\""
               " TYPE=\"text/css\" media=\"all\">\n"
               "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""


@@ -496,8 +464,7 @@ resp_searchform(const struct req *req)
                puts("<SELECT NAME=\"manpath\">");
                for (i = 0; i < (int)req->psz; i++) {
                        printf("<OPTION ");
                puts("<SELECT NAME=\"manpath\">");
                for (i = 0; i < (int)req->psz; i++) {
                        printf("<OPTION ");

-                       if (NULL == req->q.manpath ? 0 == i :
-                           0 == strcmp(req->q.manpath, req->p[i]))
+                       if (strcmp(req->q.manpath, req->p[i]) == 0)

                                printf("SELECTED=\"selected\" ");
                        printf("VALUE=\"");
                        html_print(req->p[i]);
                                printf("SELECTED=\"selected\" ");
                        printf("VALUE=\"");
                        html_print(req->p[i]);


@@ -640,7 +607,7 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz)
                printf("Status: 303 See Other\r\n");
                printf("Location: http://%s%s/%s/%s?",
                    HTTP_HOST, scriptname, req->q.manpath, r[0].file);
                printf("Status: 303 See Other\r\n");
                printf("Location: http://%s%s/%s/%s?",
                    HTTP_HOST, scriptname, req->q.manpath, r[0].file);

-               http_printquery(req);
+               http_printquery(req, "&");

                printf("\r\n"
                     "Content-Type: text/html; charset=utf-8\r\n"
                     "\r\n");
                printf("\r\n"
                     "Content-Type: text/html; charset=utf-8\r\n"
                     "\r\n");


@@ -655,9 +622,9 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz)
        for (i = 0; i < sz; i++) {
                printf("<TR>\n"
                       "<TD CLASS=\"title\">\n"
        for (i = 0; i < sz; i++) {
                printf("<TR>\n"
                       "<TD CLASS=\"title\">\n"

-                      "<A HREF=\"%s/%s/%s?", 
+                      "<A HREF=\"%s/%s/%s?",

                    scriptname, req->q.manpath, r[i].file);
                    scriptname, req->q.manpath, r[i].file);

-               html_printquery(req);
+               http_printquery(req, "&amp;");

                printf("\">");
                html_print(r[i].names);
                printf("</A>\n"
                printf("\">");
                html_print(r[i].names);
                printf("</A>\n"


@@ -735,7 +702,7 @@ catman(const struct req *req, const char *file)
        while (NULL != (p = fgetln(f, &len))) {
                bold = italic = 0;
                for (i = 0; i < (int)len - 1; i++) {
        while (NULL != (p = fgetln(f, &len))) {
                bold = italic = 0;
                for (i = 0; i < (int)len - 1; i++) {

-                       /* 
+                       /*

                         * This means that the catpage is out of state.
                         * Ignore it and keep going (although the
                         * catpage is bogus).
                         * This means that the catpage is out of state.
                         * Ignore it and keep going (although the
                         * catpage is bogus).


@@ -776,7 +743,7 @@ catman(const struct req *req, const char *file)
                                continue;
                        }
 
                                continue;
                        }
 

-                       /* 
+                       /*

                         * Handle funny behaviour troff-isms.
                         * These grok'd from the original man2html.c.
                         */
                         * Handle funny behaviour troff-isms.
                         * These grok'd from the original man2html.c.
                         */


@@ -814,7 +781,7 @@ catman(const struct req *req, const char *file)
                        }
 
                        /* Bold mode. */
                        }
 
                        /* Bold mode. */

-                       
+

                        if (italic)
                                printf("</I>");
                        if ( ! bold)
                        if (italic)
                                printf("</I>");
                        if ( ! bold)


@@ -825,9 +792,9 @@ catman(const struct req *req, const char *file)
                        html_putchar(p[i]);
                }
 
                        html_putchar(p[i]);
                }
 

-               /* 
+               /*

                 * Clean up the last character.
                 * Clean up the last character.

-                * We can get to a newline; don't print that. 
+                * We can get to a newline; don't print that.

                 */
 
                if (italic)
                 */
 
                if (italic)


@@ -850,55 +817,56 @@ catman(const struct req *req, const char *file)
 static void
 format(const struct req *req, const char *file)
 {
 static void
 format(const struct req *req, const char *file)
 {

+       struct manoutput conf;

        struct mparse   *mp;
        struct mparse   *mp;

-       int              fd;
-       struct mdoc     *mdoc;
-       struct man      *man;
+       struct mchars   *mchars;
+       struct roff_man *man;

        void            *vp;
        void            *vp;

-       enum mandoclevel rc;
-       char             opts[PATH_MAX + 128];
+       int              fd;
+       int              usepath;

 
        if (-1 == (fd = open(file, O_RDONLY, 0))) {
                puts("<P>You specified an invalid manual file.</P>");
                return;
        }
 
 
        if (-1 == (fd = open(file, O_RDONLY, 0))) {
                puts("<P>You specified an invalid manual file.</P>");
                return;
        }
 

-       mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_FATAL, NULL,
-           req->q.manpath);
-       rc = mparse_readfd(mp, fd, file);
+       mchars = mchars_alloc();
+       mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_BADARG, NULL,
+           mchars, req->q.manpath);
+       mparse_readfd(mp, fd, file);

        close(fd);
 
        close(fd);
 

-       if (rc >= MANDOCLEVEL_FATAL) {
-               fprintf(stderr, "fatal mandoc error: %s/%s\n",
-                   req->q.manpath, file);
-               pg_error_internal();
-               return;
-       }
-
-       snprintf(opts, sizeof(opts), "fragment,man=%s?"
-           "manpath=%s&query=%%N&sec=%%S%s%s",
-           scriptname, req->q.manpath,
-           req->q.arch ? "&arch=" : "",
-           req->q.arch ? req->q.arch : "");
-
-       mparse_result(mp, &mdoc, &man, NULL);
-       if (NULL == man && NULL == mdoc) {
+       memset(&conf, 0, sizeof(conf));
+       conf.fragment = 1;
+       usepath = strcmp(req->q.manpath, req->p[0]);
+       mandoc_asprintf(&conf.man, "%s?query=%%N&sec=%%S%s%s%s%s",
+           scriptname,
+           req->q.arch ? "&arch="       : "",
+           req->q.arch ? req->q.arch    : "",
+           usepath     ? "&manpath="    : "",
+           usepath     ? req->q.manpath : "");
+
+       mparse_result(mp, &man, NULL);
+       if (man == NULL) {

                fprintf(stderr, "fatal mandoc error: %s/%s\n",
                    req->q.manpath, file);
                pg_error_internal();
                mparse_free(mp);
                fprintf(stderr, "fatal mandoc error: %s/%s\n",
                    req->q.manpath, file);
                pg_error_internal();
                mparse_free(mp);

+               mchars_free(mchars);

                return;
        }
 
                return;
        }
 

-       vp = html_alloc(opts);
+       vp = html_alloc(mchars, &conf);

 
 

-       if (NULL != mdoc)
-               html_mdoc(vp, mdoc);
+       if (man->macroset == MACROSET_MDOC)
+               html_mdoc(vp, man);

        else
                html_man(vp, man);
 
        html_free(vp);
        mparse_free(mp);
        else
                html_man(vp, man);
 
        html_free(vp);
        mparse_free(mp);

+       mchars_free(mchars);
+       free(conf.man);

 }
 
 static void
 }
 
 static void


@@ -924,7 +892,7 @@ pg_show(struct req *req, const char *fullpath)
                pg_error_badrequest(
                    "You did not specify a page to show.");
                return;
                pg_error_badrequest(
                    "You did not specify a page to show.");
                return;

-       } 
+       }

        manpath = mandoc_strndup(fullpath, file - fullpath);
        file++;
 
        manpath = mandoc_strndup(fullpath, file - fullpath);
        file++;
 


@@ -973,10 +941,10 @@ pg_search(const struct req *req)
        struct mansearch          search;
        struct manpaths           paths;
        struct manpage           *res;
        struct mansearch          search;
        struct manpaths           paths;
        struct manpage           *res;

-       char                    **cp;
-       const char               *ep, *start;
+       char                    **argv;
+       char                     *query, *rp, *wp;

        size_t                    ressz;
        size_t                    ressz;

-       int                       i, sz;
+       int                       argc;

 
        /*
         * Begin by chdir()ing into the root of the manpath.
 
        /*
         * Begin by chdir()ing into the root of the manpath.


@@ -993,54 +961,54 @@ pg_search(const struct req *req)
 
        search.arch = req->q.arch;
        search.sec = req->q.sec;
 
        search.arch = req->q.arch;
        search.sec = req->q.sec;

-       search.deftype = req->q.equal ? TYPE_Nm : (TYPE_Nm | TYPE_Nd);
-       search.flags = req->q.equal ? MANSEARCH_MAN : 0;
+       search.outkey = "Nd";
+       search.argmode = req->q.equal ? ARG_NAME : ARG_EXPR;
+       search.firstmatch = 1;

 
        paths.sz = 1;
        paths.paths = mandoc_malloc(sizeof(char *));
        paths.paths[0] = mandoc_strdup(".");
 
        /*
 
        paths.sz = 1;
        paths.paths = mandoc_malloc(sizeof(char *));
        paths.paths[0] = mandoc_strdup(".");
 
        /*

-        * Poor man's tokenisation: just break apart by spaces.
-        * Yes, this is half-ass.  But it works for now.
+        * Break apart at spaces with backslash-escaping.

         */
 
         */
 

-       ep = req->q.query;
-       while (ep && isspace((unsigned char)*ep))
-               ep++;
-
-       sz = 0;
-       cp = NULL;
-       while (ep && '\0' != *ep) {
-               cp = mandoc_reallocarray(cp, sz + 1, sizeof(char *));
-               start = ep;
-               while ('\0' != *ep && ! isspace((unsigned char)*ep))
-                       ep++;
-               cp[sz] = mandoc_malloc((ep - start) + 1);
-               memcpy(cp[sz], start, ep - start);
-               cp[sz++][ep - start] = '\0';
-               while (isspace((unsigned char)*ep))
-                       ep++;
+       argc = 0;
+       argv = NULL;
+       rp = query = mandoc_strdup(req->q.query);
+       for (;;) {
+               while (isspace((unsigned char)*rp))
+                       rp++;
+               if (*rp == '\0')
+                       break;
+               argv = mandoc_reallocarray(argv, argc + 1, sizeof(char *));
+               argv[argc++] = wp = rp;
+               for (;;) {
+                       if (isspace((unsigned char)*rp)) {
+                               *wp = '\0';
+                               rp++;
+                               break;
+                       }
+                       if (rp[0] == '\\' && rp[1] != '\0')
+                               rp++;
+                       if (wp != rp)
+                               *wp = *rp;
+                       if (*rp == '\0')
+                               break;
+                       wp++;
+                       rp++;
+               }

        }
 
        }
 

-       if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz))
+       if (0 == mansearch(&search, &paths, argc, argv, &res, &ressz))

                pg_noresult(req, "You entered an invalid query.");
        else if (0 == ressz)
                pg_noresult(req, "No results found.");
        else
                pg_searchres(req, res, ressz);
 
                pg_noresult(req, "You entered an invalid query.");
        else if (0 == ressz)
                pg_noresult(req, "No results found.");
        else
                pg_searchres(req, res, ressz);
 

-       for (i = 0; i < sz; i++)
-               free(cp[i]);
-       free(cp);
-
-       for (i = 0; i < (int)ressz; i++) {
-               free(res[i].file);
-               free(res[i].names);
-               free(res[i].output);
-       }
-       free(res);
-
+       free(query);
+       mansearch_free(res, ressz);

        free(paths.paths[0]);
        free(paths.paths);
 }
        free(paths.paths[0]);
        free(paths.paths);
 }


@@ -1049,10 +1017,23 @@ int
 main(void)
 {
        struct req       req;
 main(void)
 {
        struct req       req;

+       struct itimerval itimer;

        const char      *path;
        const char      *querystring;
        int              i;
 
        const char      *path;
        const char      *querystring;
        int              i;
 

+       /* Poor man's ReDoS mitigation. */
+
+       itimer.it_value.tv_sec = 2;
+       itimer.it_value.tv_usec = 0;
+       itimer.it_interval.tv_sec = 2;
+       itimer.it_interval.tv_usec = 0;
+       if (setitimer(ITIMER_VIRTUAL, &itimer, NULL) == -1) {
+               fprintf(stderr, "setitimer: %s\n", strerror(errno));
+               pg_error_internal();
+               return(EXIT_FAILURE);
+       }
+

        /* Scan our run-time environment. */
 
        if (NULL == (scriptname = getenv("SCRIPT_NAME")))
        /* Scan our run-time environment. */
 
        if (NULL == (scriptname = getenv("SCRIPT_NAME")))


@@ -1076,7 +1057,7 @@ main(void)
                    MAN_DIR, strerror(errno));
                pg_error_internal();
                return(EXIT_FAILURE);
                    MAN_DIR, strerror(errno));
                pg_error_internal();
                return(EXIT_FAILURE);

-       } 
+       }

 
        memset(&req, 0, sizeof(struct req));
        pathgen(&req);
 
        memset(&req, 0, sizeof(struct req));
        pathgen(&req);


@@ -1086,7 +1067,9 @@ main(void)
        if (NULL != (querystring = getenv("QUERY_STRING")))
                http_parse(&req, querystring);
 
        if (NULL != (querystring = getenv("QUERY_STRING")))
                http_parse(&req, querystring);
 

-       if ( ! validate_manpath(&req, req.q.manpath)) {
+       if (req.q.manpath == NULL)
+               req.q.manpath = mandoc_strdup(req.p[0]);
+       else if ( ! validate_manpath(&req, req.q.manpath)) {

                pg_error_badrequest(
                    "You specified an invalid manpath.");
                return(EXIT_FAILURE);
                pg_error_badrequest(
                    "You specified an invalid manpath.");
                return(EXIT_FAILURE);