Small tweaks for release.

[mandoc.git] / cgi.c

diff --git a/cgi.c b/cgi.c
index 300754897c84b02e7e76c97a5a91cd0e23d96849..2f5870ff8efd34949e8130af7f3eeb41d513e184 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,6 +1,6 @@
-/*     $Id: cgi.c,v 1.30 2011/12/12 02:00:49 schwarze Exp $ */
+/*     $Id: cgi.c,v 1.42 2012/03/24 01:46:25 kristaps Exp $ */

 /*
 /*

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

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -41,6 +41,7 @@
 #include "man.h"
 #include "main.h"
 #include "manpath.h"
 #include "man.h"
 #include "main.h"
 #include "manpath.h"

+#include "mandocdb.h"

 
 #ifdef __linux__
 # include <db_185.h>
 
 #ifdef __linux__
 # include <db_185.h>


@@ -68,7 +69,6 @@ struct        query {
        const char      *sec; /* manual section */
        const char      *expr; /* unparsed expression string */
        int              manroot; /* manroot index (or -1)*/
        const char      *sec; /* manual section */
        const char      *expr; /* unparsed expression string */
        int              manroot; /* manroot index (or -1)*/

-       int              whatis; /* whether whatis mode */

        int              legacy; /* whether legacy mode */
 };
 
        int              legacy; /* whether legacy mode */
 };
 


@@ -80,13 +80,17 @@ struct      req {
 };
 
 static int              atou(const char *, unsigned *);
 };
 
 static int              atou(const char *, unsigned *);

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

 static int              cmp(const void *, const void *);
 static int              cmp(const void *, const void *);

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

 static void             html_print(const char *);
 static void             html_print(const char *);

+static void             html_printquery(const struct req *);

 static void             html_putchar(char);
 static int              http_decode(char *);
 static void             http_parse(struct req *, char *);
 static void             html_putchar(char);
 static int              http_decode(char *);
 static void             http_parse(struct req *, char *);

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

 static int              pathstop(DIR *);
 static void             pathgen(DIR *, char *, struct req *);
 static void             pg_index(const struct req *, char *);
 static int              pathstop(DIR *);
 static void             pathgen(DIR *, char *, struct req *);
 static void             pg_index(const struct req *, char *);


@@ -130,7 +134,7 @@ atou(const char *buf, unsigned *v)
                return(0);
        if ((errno == ERANGE && (lval == LONG_MAX || 
                                        lval == LONG_MIN)) ||
                return(0);
        if ((errno == ERANGE && (lval == LONG_MAX || 
                                        lval == LONG_MIN)) ||

-                       (lval > UINT_MAX || lval < 0))
+                       (lval > INT_MAX || lval < 0))

                return(0);
 
        *v = (unsigned int)lval;
                return(0);
 
        *v = (unsigned int)lval;


@@ -163,6 +167,40 @@ html_putchar(char c)
                break;
        }
 }
                break;
        }
 }

+static void
+http_printquery(const struct req *req)
+{
+
+       printf("&expr=");
+       http_print(req->q.expr ? req->q.expr : "");
+       printf("&sec=");
+       http_print(req->q.sec ? req->q.sec : "");
+       printf("&arch=");
+       http_print(req->q.arch ? req->q.arch : "");
+}
+
+
+static void
+html_printquery(const struct req *req)
+{
+
+       printf("&amp;expr=");
+       html_print(req->q.expr ? req->q.expr : "");
+       printf("&amp;sec=");
+       html_print(req->q.sec ? req->q.sec : "");
+       printf("&amp;arch=");
+       html_print(req->q.arch ? req->q.arch : "");
+}
+
+static void
+http_print(const char *p)
+{
+
+       if (NULL == p)
+               return;
+       while ('\0' != *p)
+               http_putchar(*p++);
+}

 
 /*
  * Call through to html_putchar().
 
 /*
  * Call through to html_putchar().


@@ -187,51 +225,31 @@ static void
 http_parse(struct req *req, char *p)
 {
        char            *key, *val, *manroot;
 http_parse(struct req *req, char *p)
 {
        char            *key, *val, *manroot;

-       size_t           sz;

        int              i, legacy;
 
        memset(&req->q, 0, sizeof(struct query));
 
        int              i, legacy;
 
        memset(&req->q, 0, sizeof(struct query));
 

-       req->q.whatis = 1;

        legacy = -1;
        manroot = NULL;
 
        legacy = -1;
        manroot = NULL;
 

-       while (p && '\0' != *p) {
-               while (' ' == *p)
-                       p++;
-
+       while ('\0' != *p) {

                key = p;
                val = NULL;
 
                key = p;
                val = NULL;
 

-               if (NULL != (p = strchr(p, '='))) {
+               p += (int)strcspn(p, ";&");
+               if ('\0' != *p)

                        *p++ = '\0';
                        *p++ = '\0';

-                       val = p;
-
-                       sz = strcspn(p, ";&");
-                       /* LINTED */
-                       p += sz;
-
-                       if ('\0' != *p)
-                               *p++ = '\0';
-               } else {
-                       p = key;
-                       sz = strcspn(p, ";&");
-                       /* LINTED */
-                       p += sz;
-
-                       if ('\0' != *p)
-                               p++;
-                       continue;
-               }
+               if (NULL != (val = strchr(key, '=')))
+                       *val++ = '\0';

 
 

-               if ('\0' == *key || '\0' == *val)
+               if ('\0' == *key || NULL == val || '\0' == *val)

                        continue;
 
                /* Just abort handling. */
 
                if ( ! http_decode(key))
                        break;
                        continue;
 
                /* Just abort handling. */
 
                if ( ! http_decode(key))
                        break;

-               if ( ! http_decode(val))
+               if (NULL != val && ! http_decode(val))

                        break;
 
                if (0 == strcmp(key, "expr"))
                        break;
 
                if (0 == strcmp(key, "expr"))


@@ -248,19 +266,11 @@ http_parse(struct req *req, char *p)
                        manroot = val;
                else if (0 == strcmp(key, "apropos"))
                        legacy = 0 == strcmp(val, "0");
                        manroot = val;
                else if (0 == strcmp(key, "apropos"))
                        legacy = 0 == strcmp(val, "0");

-               else if (0 == strcmp(key, "op"))
-                       req->q.whatis = 0 == strcasecmp(val, "whatis");

        }
 
        /* Test for old man.cgi compatibility mode. */
 
        }
 
        /* Test for old man.cgi compatibility mode. */
 

-       if (legacy == 0) {
-               req->q.whatis = 0;
-               req->q.legacy = 1;
-       } else if (legacy > 0) {
-               req->q.legacy = 1;
-               req->q.whatis = 1;
-       }
+       req->q.legacy = legacy > 0;

 
        /* 
         * Section "0" means no section when in legacy mode.
 
        /* 
         * Section "0" means no section when in legacy mode.


@@ -284,6 +294,20 @@ http_parse(struct req *req, char *p)
        }
 }
 
        }
 }
 

+static void
+http_putchar(char c)
+{
+
+       if (isalnum((unsigned char)c)) {
+               putchar((unsigned char)c);
+               return;
+       } else if (' ' == c) {
+               putchar('+');
+               return;
+       }
+       printf("%%%.2x", c);
+}
+

 /*
  * HTTP-decode a string.  The standard explanation is that this turns
  * "%4e+foo" into "n foo" in the regular way.  This is done in-place
 /*
  * HTTP-decode a string.  The standard explanation is that this turns
  * "%4e+foo" into "n foo" in the regular way.  This is done in-place


@@ -346,12 +370,14 @@ resp_begin_html(int code, const char *msg)
               "<HEAD>\n"
               "<META HTTP-EQUIV=\"Content-Type\""
               " CONTENT=\"text/html; charset=utf-8\">\n"
               "<HEAD>\n"
               "<META HTTP-EQUIV=\"Content-Type\""
               " CONTENT=\"text/html; charset=utf-8\">\n"

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

               " TYPE=\"text/css\" media=\"all\">\n"
               "<TITLE>System Manpage Reference</TITLE>\n"
               "</HEAD>\n"
               "<BODY>\n"
               " TYPE=\"text/css\" media=\"all\">\n"
               "<TITLE>System Manpage Reference</TITLE>\n"
               "</HEAD>\n"
               "<BODY>\n"

-              "<!-- Begin page content. //-->\n", css);
+              "<!-- Begin page content. //-->\n", css, css);

 }
 
 static void
 }
 
 static void


@@ -368,13 +394,12 @@ resp_searchform(const struct req *req)
        int              i;
 
        puts("<!-- Begin search form. //-->");
        int              i;
 
        puts("<!-- Begin search form. //-->");

-       printf("<FORM ACTION=\"%s/search.html\" METHOD=\"get\">\n"
+       printf("<DIV ID=\"mancgi\">\n"
+              "<FORM ACTION=\"%s/search.html\" METHOD=\"get\">\n"

               "<FIELDSET>\n"
               "<LEGEND>Search Parameters</LEGEND>\n"
               "<FIELDSET>\n"
               "<LEGEND>Search Parameters</LEGEND>\n"

-              "<INPUT TYPE=\"submit\" NAME=\"op\""
-              " VALUE=\"Whatis\"> or \n"
-              "<INPUT TYPE=\"submit\" NAME=\"op\""
-              " VALUE=\"apropos\"> for manuals satisfying \n"
+              "<INPUT TYPE=\"submit\" "
+              " VALUE=\"Search\"> for manuals satisfying \n"

               "<INPUT TYPE=\"text\" NAME=\"expr\" VALUE=\"",
               progname);
        html_print(req->q.expr ? req->q.expr : "");
               "<INPUT TYPE=\"text\" NAME=\"expr\" VALUE=\"",
               progname);
        html_print(req->q.expr ? req->q.expr : "");


@@ -404,7 +429,8 @@ resp_searchform(const struct req *req)
        puts(".\n"
             "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
             "</FIELDSET>\n"
        puts(".\n"
             "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
             "</FIELDSET>\n"

-            "</FORM>");
+            "</FORM>\n"
+            "</DIV>");

        puts("<!-- End search form. //-->");
 }
 
        puts("<!-- End search form. //-->");
 }
 


@@ -469,58 +495,64 @@ resp_baddb(void)
 static void
 resp_search(struct res *r, size_t sz, void *arg)
 {
 static void
 resp_search(struct res *r, size_t sz, void *arg)
 {

-       int               i;
+       size_t           i, matched;

        const struct req *req;
 
        req = (const struct req *)arg;
        const struct req *req;
 
        req = (const struct req *)arg;

-       assert(req->q.manroot >= 0);

 
 

-       if (1 == sz) {
+       if (sz > 0)
+               assert(req->q.manroot >= 0);
+
+       for (matched = i = 0; i < sz; i++)
+               if (r[i].matched)
+                       matched++;
+       
+       if (1 == matched) {
+               for (i = 0; i < sz; i++)
+                       if (r[i].matched)
+                               break;

                /*
                 * If we have just one result, then jump there now
                 * without any delay.
                 */
                puts("Status: 303 See Other");
                /*
                 * If we have just one result, then jump there now
                 * without any delay.
                 */
                puts("Status: 303 See Other");

-               printf("Location: http://%s%s/show/%d/%u/%u.html\n",
+               printf("Location: http://%s%s/show/%d/%u/%u.html?",

                                host, progname, req->q.manroot,
                                host, progname, req->q.manroot,

-                               r[0].volume, r[0].rec);
-               puts("Content-Type: text/html; charset=utf-8\n");
+                               r[i].volume, r[i].rec);
+               http_printquery(req);
+               puts("\n"
+                    "Content-Type: text/html; charset=utf-8\n");

                return;
        }
 
                return;
        }
 

-       qsort(r, sz, sizeof(struct res), cmp);
-

        resp_begin_html(200, NULL);
        resp_searchform(req);
 
        resp_begin_html(200, NULL);
        resp_searchform(req);
 

-       if (0 == sz) {
-               printf("<P>\n"
-                      "No %s results found.\n",
-                      req->q.whatis ? "whatis" : "apropos");
-               if (req->q.whatis) {
-                       printf("(Try <A HREF=\"%s/search.html?"
-                              "op=apropos&amp;expr=", progname);
-                       html_print(req->q.expr ? req->q.expr : "");
-                       printf("&amp;sec=");
-                       html_print(req->q.sec ? req->q.sec : "");
-                       printf("&amp;arch=");
-                       html_print(req->q.arch ? req->q.arch : "");
-                       puts("\">apropos</A>?)");
-               }
-               puts("</P>");
+       puts("<DIV CLASS=\"results\">");
+
+       if (0 == matched) {
+               puts("<P>\n"
+                    "No results found.\n"
+                    "</P>\n"
+                    "</DIV>");

                resp_end_html();
                return;
        }
 
                resp_end_html();
                return;
        }
 

-       puts("<P></P>\n"
-            "<TABLE>");
+       qsort(r, sz, sizeof(struct res), cmp);
+
+       puts("<TABLE>");

 
 

-       for (i = 0; i < (int)sz; i++) {
+       for (i = 0; i < sz; i++) {
+               if ( ! r[i].matched)
+                       continue;

                printf("<TR>\n"
                       "<TD CLASS=\"title\">\n"
                printf("<TR>\n"
                       "<TD CLASS=\"title\">\n"

-                      "<A HREF=\"%s/show/%d/%u/%u.html\">", 
+                      "<A HREF=\"%s/show/%d/%u/%u.html?", 

                                progname, req->q.manroot,
                                r[i].volume, r[i].rec);
                                progname, req->q.manroot,
                                r[i].volume, r[i].rec);

+               html_printquery(req);
+               printf("\">");

                html_print(r[i].title);
                putchar('(');
                html_print(r[i].cat);
                html_print(r[i].title);
                putchar('(');
                html_print(r[i].cat);


@@ -536,7 +568,8 @@ resp_search(struct res *r, size_t sz, void *arg)
                     "</TR>");
        }
 
                     "</TR>");
        }
 

-       puts("</TABLE>");
+       puts("</TABLE>\n"
+            "</DIV>");

        resp_end_html();
 }
 
        resp_end_html();
 }
 


@@ -549,7 +582,7 @@ pg_index(const struct req *req, char *path)
 }
 
 static void
 }
 
 static void

-catman(const char *file)
+catman(const struct req *req, const char *file)

 {
        FILE            *f;
        size_t           len;
 {
        FILE            *f;
        size_t           len;


@@ -562,21 +595,10 @@ catman(const char *file)
                return;
        }
 
                return;
        }
 

-       resp_begin_http(200, NULL);
-       printf("<!DOCTYPE HTML PUBLIC "
-              " \"-//W3C//DTD HTML 4.01//EN\""
-              " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
-              "<HTML>\n"
-              "<HEAD>\n"
-              "<META HTTP-EQUIV=\"Content-Type\""
-              " CONTENT=\"text/html; charset=utf-8\">\n"
-              "<LINK REL=\"stylesheet\" HREF=\"%s/catman.css\""
-              " TYPE=\"text/css\" media=\"all\">\n"
-              "<TITLE>System Manpage Reference</TITLE>\n"
-              "</HEAD>\n"
-              "<BODY>\n"
-              "<!-- Begin page content. //-->\n"
-              "<PRE>\n", css);
+       resp_begin_html(200, NULL);
+       resp_searchform(req);
+       puts("<DIV CLASS=\"catman\">\n"
+            "<PRE>");

 
        while (NULL != (p = fgetln(f, &len))) {
                bold = italic = 0;
 
        while (NULL != (p = fgetln(f, &len))) {
                bold = italic = 0;


@@ -688,6 +710,7 @@ catman(const char *file)
        }
 
        puts("</PRE>\n"
        }
 
        puts("</PRE>\n"

+            "</DIV>\n"

             "</BODY>\n"
             "</HTML>");
 
             "</BODY>\n"
             "</HTML>");
 


@@ -695,7 +718,7 @@ catman(const char *file)
 }
 
 static void
 }
 
 static void

-format(const char *file)
+format(const struct req *req, const char *file)

 {
        struct mparse   *mp;
        int              fd;
 {
        struct mparse   *mp;
        int              fd;


@@ -719,22 +742,30 @@ format(const char *file)
                return;
        }
 
                return;
        }
 

-       snprintf(opts, sizeof(opts), "style=%s/man.css,"
+       snprintf(opts, sizeof(opts), "fragment,"

                        "man=%s/search.html?sec=%%S&expr=%%N,"
                        /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,
                        "man=%s/search.html?sec=%%S&expr=%%N,"
                        /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,

-                       css, progname);
+                       progname);

 
        mparse_result(mp, &mdoc, &man);
 
        mparse_result(mp, &mdoc, &man);

+       if (NULL == man && NULL == mdoc) {
+               resp_baddb();
+               mparse_free(mp);
+               return;
+       }
+
+       resp_begin_html(200, NULL);
+       resp_searchform(req);
+

        vp = html_alloc(opts);
 
        vp = html_alloc(opts);
 

-       if (NULL != mdoc) {
-               resp_begin_http(200, NULL);
+       if (NULL != mdoc)

                html_mdoc(vp, mdoc);
                html_mdoc(vp, mdoc);

-       } else if (NULL != man) {
-               resp_begin_http(200, NULL);
+       else

                html_man(vp, man);
                html_man(vp, man);

-       } else
-               resp_baddb();
+
+       puts("</BODY>\n"
+            "</HTML>");

 
        html_free(vp);
        mparse_free(mp);
 
        html_free(vp);
        mparse_free(mp);


@@ -744,10 +775,11 @@ static void
 pg_show(const struct req *req, char *path)
 {
        struct manpaths  ps;
 pg_show(const struct req *req, char *path)
 {
        struct manpaths  ps;

+       size_t           sz;

        char            *sub;
        char             file[MAXPATHLEN];
        char            *sub;
        char             file[MAXPATHLEN];

-       const char      *fn, *cp;
-       int              rc;
+       const char      *cp;
+       int              rc, catm;

        unsigned int     vol, rec, mr;
        DB              *idx;
        DBT              key, val;
        unsigned int     vol, rec, mr;
        DB              *idx;
        DBT              key, val;


@@ -799,8 +831,10 @@ pg_show(const struct req *req, char *path)
                goto out;
        }
 
                goto out;
        }
 

-       strlcpy(file, ps.paths[vol], MAXPATHLEN);
-       strlcat(file, "/mandoc.index", MAXPATHLEN);
+       sz = strlcpy(file, ps.paths[vol], MAXPATHLEN);
+       assert(sz < MAXPATHLEN);
+       strlcat(file, "/", MAXPATHLEN);
+       strlcat(file, MANDOC_IDX, MAXPATHLEN);

 
        /* Open the index recno(3) database. */
 
 
        /* Open the index recno(3) database. */
 


@@ -817,21 +851,24 @@ pg_show(const struct req *req, char *path)
        if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) {
                rc < 0 ? resp_baddb() : resp_error400();
                goto out;
        if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) {
                rc < 0 ? resp_baddb() : resp_error400();
                goto out;

-       } 
+       } else if (0 == val.size) {
+               resp_baddb();
+               goto out;
+       }

 
        cp = (char *)val.data;
 
        cp = (char *)val.data;

+       catm = 'c' == *cp++;

 
 

-       if (NULL == (fn = memchr(cp, '\0', val.size)))
-               resp_baddb();
-       else if (++fn - cp >= (int)val.size)
-               resp_baddb();
-       else if (NULL == memchr(fn, '\0', val.size - (fn - cp)))
+       if (NULL == memchr(cp, '\0', val.size - 1)) 

                resp_baddb();
        else {
                resp_baddb();
        else {

-               if (0 == strcmp(cp, "cat"))
-                       catman(fn + 1);
+               file[(int)sz] = '\0';
+               strlcat(file, "/", MAXPATHLEN);
+               strlcat(file, cp, MAXPATHLEN);
+               if (catm) 
+                       catman(req, file);

                else
                else

-                       format(fn + 1);
+                       format(req, file);

        }
 out:
        if (idx)
        }
 out:
        if (idx)


@@ -842,10 +879,11 @@ out:
 static void
 pg_search(const struct req *req, char *path)
 {
 static void
 pg_search(const struct req *req, char *path)
 {

-       size_t            tt;
+       size_t            tt, ressz;

        struct manpaths   ps;
        int               i, sz, rc;
        const char       *ep, *start;
        struct manpaths   ps;
        int               i, sz, rc;
        const char       *ep, *start;

+       struct res      *res;

        char            **cp;
        struct opts       opt;
        struct expr      *expr;
        char            **cp;
        struct opts       opt;
        struct expr      *expr;


@@ -863,6 +901,8 @@ pg_search(const struct req *req, char *path)
        rc       = -1;
        sz       = 0;
        cp       = NULL;
        rc       = -1;
        sz       = 0;
        cp       = NULL;

+       ressz    = 0;
+       res      = NULL;

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


@@ -905,25 +945,26 @@ pg_search(const struct req *req, char *path)
         * The resp_search() function is called with the results.
         */
 
         * The resp_search() function is called with the results.
         */
 

-       expr = req->q.whatis ? 
+       expr = req->q.legacy ? 

                termcomp(sz, cp, &tt) : exprcomp(sz, cp, &tt);
 
        if (NULL != expr)
                rc = apropos_search
                termcomp(sz, cp, &tt) : exprcomp(sz, cp, &tt);
 
        if (NULL != expr)
                rc = apropos_search

-                       (ps.sz, ps.paths, &opt,
-                        expr, tt, (void *)req, resp_search);
+                       (ps.sz, ps.paths, &opt, expr, tt, 
+                        (void *)req, &ressz, &res, resp_search);

 
        /* ...unless errors occured. */
 
        if (0 == rc)
                resp_baddb();
        else if (-1 == rc)
 
        /* ...unless errors occured. */
 
        if (0 == rc)
                resp_baddb();
        else if (-1 == rc)

-               resp_search(NULL, 0, (void *)req);
+               resp_search(NULL, 0, NULL);

 
        for (i = 0; i < sz; i++)
                free(cp[i]);
 
        free(cp);
 
        for (i = 0; i < sz; i++)
                free(cp[i]);
 
        free(cp);

+       resfree(res, ressz);

        exprfree(expr);
        manpath_free(&ps);
 }
        exprfree(expr);
        manpath_free(&ps);
 }


@@ -946,7 +987,7 @@ main(void)
                progname = "";
 
        if (NULL == (css = getenv("CSS_DIR")))
                progname = "";
 
        if (NULL == (css = getenv("CSS_DIR")))

-               css = "/";
+               css = "";

 
        if (NULL == (host = getenv("HTTP_HOST")))
                host = "localhost";
 
        if (NULL == (host = getenv("HTTP_HOST")))
                host = "localhost";