]> git.cameronkatri.com Git - mandoc.git/blobdiff - cgi.c
First, remove the catman(8) jobstart() stuff. It only copies files.
[mandoc.git] / cgi.c
diff --git a/cgi.c b/cgi.c
index 1d88c434207ee572ecb92d144ebc80f255abacc1..bdf303dcc352a5862e53e55776be2b21ce1cc206 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,4 +1,4 @@
-/*     $Id: cgi.c,v 1.9 2011/12/04 22:52:50 kristaps Exp $ */
+/*     $Id: cgi.c,v 1.16 2011/12/07 16:18:52 kristaps Exp $ */
 /*
  * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *
@@ -67,8 +67,10 @@ struct       req {
 
 static int              atou(const char *, unsigned *);
 static void             catman(const char *);
+static int              cmp(const void *, const void *);
 static void             format(const char *);
 static void             html_print(const char *);
+static void             html_putchar(char);
 static int              kval_decode(char *);
 static void             kval_parse(struct kval **, size_t *, char *);
 static void             kval_free(struct kval *, size_t);
@@ -80,9 +82,8 @@ static        void             pg_show(const struct manpaths *,
                                const struct req *, char *);
 static void             resp_bad(void);
 static void             resp_baddb(void);
-static void             resp_badexpr(const struct req *);
-static void             resp_badmanual(void);
-static void             resp_badpage(void);
+static void             resp_error400(void);
+static void             resp_error404(const char *);
 static void             resp_begin_html(int, const char *);
 static void             resp_begin_http(int, const char *);
 static void             resp_end_html(void);
@@ -123,6 +124,29 @@ atou(const char *buf, unsigned *v)
        return(1);
 }
 
+static void
+html_putchar(char c)
+{
+
+       switch (c) {
+       case ('"'):
+               printf("&quote;");
+               break;
+       case ('&'):
+               printf("&amp;");
+               break;
+       case ('>'):
+               printf("&gt;");
+               break;
+       case ('<'):
+               printf("&lt;");
+               break;
+       default:
+               putchar((unsigned char)c);
+               break;
+       }
+}
+
 /*
  * Print a word, escaping HTML along the way.
  * This will pass non-ASCII straight to output: be warned!
@@ -130,29 +154,11 @@ atou(const char *buf, unsigned *v)
 static void
 html_print(const char *p)
 {
-       char             c;
        
        if (NULL == p)
                return;
-
        while ('\0' != *p)
-               switch ((c = *p++)) {
-               case ('"'):
-                       printf("&quote;");
-                       break;
-               case ('&'):
-                       printf("&amp;");
-                       break;
-               case ('>'):
-                       printf("&gt;");
-                       break;
-               case ('<'):
-                       printf("&lt;");
-                       break;
-               default:
-                       putchar((unsigned char)c);
-                       break;
-               }
+               html_putchar(*p++);
 }
 
 static void
@@ -290,6 +296,10 @@ resp_begin_html(int code, const char *msg)
             " \"http://www.w3.org/TR/html4/strict.dtd\">"      "\n"
             "<HTML>"                                           "\n"
             " <HEAD>"                                          "\n"
+            "  <META HTTP-EQUIV=\"Content-Type\" "             "\n"
+            "        CONTENT=\"text/html; charset=utf-8\">"    "\n"
+            "  <LINK REL=\"stylesheet\" HREF=\"/man.cgi.css\"" "\n"
+            "        TYPE=\"text/css\" media=\"all\">"         "\n"
             "  <TITLE>System Manpage Reference</TITLE>"        "\n"
             " </HEAD>"                                         "\n"
             " <BODY>"                                          "\n"
@@ -314,30 +324,43 @@ resp_searchform(const struct req *req)
        for (i = 0; i < (int)req->fieldsz; i++)
                if (0 == strcmp(req->fields[i].key, "expr"))
                        expr = req->fields[i].val;
+               else if (0 == strcmp(req->fields[i].key, "query"))
+                       expr = req->fields[i].val;
                else if (0 == strcmp(req->fields[i].key, "sec"))
                        sec = req->fields[i].val;
+               else if (0 == strcmp(req->fields[i].key, "sektion"))
+                       sec = req->fields[i].val;
                else if (0 == strcmp(req->fields[i].key, "arch"))
                        arch = req->fields[i].val;
 
+       if (NULL != sec && 0 == strcmp(sec, "0"))
+               sec = NULL;
+
        puts("<!-- Begin search form. //-->");
        printf("<FORM ACTION=\"");
        html_print(progname);
        printf("/search.html\" METHOD=\"get\">\n");
-       puts(" <FIELDSET>"                                      "\n"
-            "  <INPUT TYPE=\"submit\" VALUE=\"Search:\">");
-       printf("  Terms: <INPUT TYPE=\"text\" "
-                       "SIZE=\"60\" NAME=\"expr\" VALUE=\"");
+       printf("<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=\"text\" NAME=\"expr\" VALUE=\"");
        html_print(expr);
-       puts("\">");
-       printf("  Section: <INPUT TYPE=\"text\" "
-                       "SIZE=\"4\" NAME=\"sec\" VALUE=\"");
+       printf("\">, section "
+              "<INPUT TYPE=\"text\" "
+               "SIZE=\"4\" NAME=\"sec\" VALUE=\"");
        html_print(sec);
-       puts("\">");
-       printf("  Arch: <INPUT TYPE=\"text\" "
-                       "SIZE=\"8\" NAME=\"arch\" VALUE=\"");
+       printf("\">, arch "
+              "<INPUT TYPE=\"text\" "
+               "SIZE=\"8\" NAME=\"arch\" VALUE=\"");
        html_print(arch);
-       puts("\">");
-       puts(" </FIELDSET>\n</FORM>\n<!-- End search form. //-->");
+       puts("\">.\n"
+            "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
+            "</FIELDSET>\n"
+            "</FORM>\n"
+            "<!-- End search form. //-->");
 }
 
 static void
@@ -350,30 +373,34 @@ resp_index(const struct req *req)
 }
 
 static void
-resp_badpage(void)
+resp_error400(void)
 {
 
-       resp_begin_html(404, "Not Found");
-       puts("<P>Page not found.</P>");
+       resp_begin_html(400, "Query Malformed");
+       printf("<H1>Malformed Query</H1>\n"
+              "<P>\n"
+              "  The query your entered was malformed.\n"
+              "  Try again from the\n"
+              "  <A HREF=\"%s/index.html\">main page</A>\n"
+              "</P>", progname);
        resp_end_html();
 }
 
 static void
-resp_badmanual(void)
+resp_error404(const char *page)
 {
 
        resp_begin_html(404, "Not Found");
-       puts("<P>Requested manual not found.</P>");
-       resp_end_html();
-}
-
-static void
-resp_badexpr(const struct req *req)
-{
-
-       resp_begin_html(200, NULL);
-       resp_searchform(req);
-       puts("<P>Your search didn't work.</P>");
+       puts("<H1>Page Not Found</H1>\n"
+            "<P>\n"
+            "  The page you're looking for, ");
+       printf("  <B>");
+       html_print(page);
+       printf("</B>,\n"
+              "  could not be found.\n"
+              "  Try searching from the\n"
+              "  <A HREF=\"%s/index.html\">main page</A>\n"
+              "</P>", progname);
        resp_end_html();
 }
 
@@ -412,14 +439,22 @@ resp_search(struct res *r, size_t sz, void *arg)
                return;
        }
 
+       qsort(r, sz, sizeof(struct res), cmp);
+
        resp_begin_html(200, NULL);
        resp_searchform((const struct req *)arg);
 
-       if (0 == sz)
+       if (0 == sz) {
                puts("<P>No results found.</P>");
+               resp_end_html();
+               return;
+       }
+
+       puts("<P></P>\n"
+            "<TABLE>");
 
        for (i = 0; i < (int)sz; i++) {
-               printf("<P><A HREF=\"");
+               printf("<TR><TD CLASS=\"title\"><A HREF=\"");
                html_print(progname);
                printf("/show/%u/%u.html\">", r[i].volume, r[i].rec);
                html_print(r[i].title);
@@ -429,11 +464,13 @@ resp_search(struct res *r, size_t sz, void *arg)
                        putchar('/');
                        html_print(r[i].arch);
                }
-               printf(")</A> ");
+               printf(")</A></TD><TD CLASS=\"desc\">");
                html_print(r[i].desc);
-               puts("</P>");
+               puts("</TD></TR>");
        }
 
+       puts("</TABLE>");
+
        resp_end_html();
 }
 
@@ -448,24 +485,147 @@ pg_index(const struct manpaths *ps, const struct req *req, char *path)
 static void
 catman(const char *file)
 {
-       int              fd;
-       char             buf[BUFSIZ];
-       ssize_t          ssz;
+       FILE            *f;
+       size_t           len;
+       int              i;
+       char            *p;
+       int              italic, bold;
 
-       if (-1 == (fd = open(file, O_RDONLY, 0))) {
+       if (NULL == (f = fopen(file, "r"))) {
                resp_baddb();
                return;
        }
 
        resp_begin_http(200, NULL);
+       puts("<!DOCTYPE HTML PUBLIC "                           "\n"
+            " \"-//W3C//DTD HTML 4.01//EN\""                   "\n"
+            " \"http://www.w3.org/TR/html4/strict.dtd\">"      "\n"
+            "<HTML>"                                           "\n"
+            " <HEAD>"                                          "\n"
+            "  <META HTTP-EQUIV=\"Content-Type\" "             "\n"
+            "        CONTENT=\"text/html; charset=utf-8\">"    "\n"
+            "  <LINK REL=\"stylesheet\" HREF=\"/catman.css\""  "\n"
+            "        TYPE=\"text/css\" media=\"all\">"         "\n"
+            "  <TITLE>System Manpage Reference</TITLE>"        "\n"
+            " </HEAD>"                                         "\n"
+            " <BODY>"                                          "\n"
+            "<!-- Begin page content. //-->");
 
-       while ((ssz = read(fd, buf, BUFSIZ)) > 0)
-               write(STDOUT_FILENO, buf, (size_t)ssz);
+       puts("<PRE>");
+       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).
+                        */
+
+                       if ('\b' == p[i] || '\n' == p[i])
+                               continue;
+
+                       /*
+                        * Print a regular character.
+                        * Close out any bold/italic scopes.
+                        * If we're in back-space mode, make sure we'll
+                        * have something to enter when we backspace.
+                        */
+
+                       if ('\b' != p[i + 1]) {
+                               if (italic)
+                                       printf("</I>");
+                               if (bold)
+                                       printf("</B>");
+                               italic = bold = 0;
+                               html_putchar(p[i]);
+                               continue;
+                       } else if (i + 2 >= (int)len)
+                               continue;
+
+                       /* Italic mode. */
+
+                       if ('_' == p[i]) {
+                               if (bold)
+                                       printf("</B>");
+                               if ( ! italic)
+                                       printf("<I>");
+                               bold = 0;
+                               italic = 1;
+                               i += 2;
+                               html_putchar(p[i]);
+                               continue;
+                       }
 
-       if (ssz < 0)
-               perror(file);
+                       /* 
+                        * Handle funny behaviour troff-isms.
+                        * These grok'd from the original man2html.c.
+                        */
+
+                       if (('+' == p[i] && 'o' == p[i + 2]) ||
+                                       ('o' == p[i] && '+' == p[i + 2]) ||
+                                       ('|' == p[i] && '=' == p[i + 2]) ||
+                                       ('=' == p[i] && '|' == p[i + 2]) ||
+                                       ('*' == p[i] && '=' == p[i + 2]) ||
+                                       ('=' == p[i] && '*' == p[i + 2]) ||
+                                       ('*' == p[i] && '|' == p[i + 2]) ||
+                                       ('|' == p[i] && '*' == p[i + 2]))  {
+                               if (italic)
+                                       printf("</I>");
+                               if (bold)
+                                       printf("</B>");
+                               italic = bold = 0;
+                               putchar('*');
+                               i += 2;
+                               continue;
+                       } else if (('|' == p[i] && '-' == p[i + 2]) ||
+                                       ('-' == p[i] && '|' == p[i + 1]) ||
+                                       ('+' == p[i] && '-' == p[i + 1]) ||
+                                       ('-' == p[i] && '+' == p[i + 1]) ||
+                                       ('+' == p[i] && '|' == p[i + 1]) ||
+                                       ('|' == p[i] && '+' == p[i + 1]))  {
+                               if (italic)
+                                       printf("</I>");
+                               if (bold)
+                                       printf("</B>");
+                               italic = bold = 0;
+                               putchar('+');
+                               i += 2;
+                               continue;
+                       }
 
-       close(fd);
+                       /* Bold mode. */
+                       
+                       if (italic)
+                               printf("</I>");
+                       if ( ! bold)
+                               printf("<B>");
+                       bold = 1;
+                       italic = 0;
+                       i += 2;
+                       html_putchar(p[i]);
+               }
+
+               /* 
+                * Clean up the last character.
+                * We can get to a newline; don't print that. 
+                */
+
+               if (italic)
+                       printf("</I>");
+               if (bold)
+                       printf("</B>");
+
+               if (i == (int)len - 1 && '\n' != p[i])
+                       html_putchar(p[i]);
+
+               putchar('\n');
+       }
+
+       puts("</PRE>\n"
+            "</BODY>\n"
+            "</HTML>");
+
+       fclose(f);
 }
 
 static void
@@ -477,6 +637,7 @@ format(const char *file)
        struct man      *man;
        void            *vp;
        enum mandoclevel rc;
+       char             opts[MAXPATHLEN + 128];
 
        if (-1 == (fd = open(file, O_RDONLY, 0))) {
                resp_baddb();
@@ -492,8 +653,13 @@ format(const char *file)
                return;
        }
 
+       snprintf(opts, sizeof(opts), "style=/man.css,"
+                       "man=%s/search.html?sec=%%S&expr=%%N,"
+                       /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,
+                       progname);
+
        mparse_result(mp, &mdoc, &man);
-       vp = html_alloc(NULL);
+       vp = html_alloc(opts);
 
        if (NULL != mdoc) {
                resp_begin_http(200, NULL);
@@ -520,19 +686,19 @@ pg_show(const struct manpaths *ps, const struct req *req, char *path)
        DBT              key, val;
 
        if (NULL == path) {
-               resp_badmanual();
+               resp_error400();
                return;
        } else if (NULL == (sub = strrchr(path, '/'))) {
-               resp_badmanual();
+               resp_error400();
                return;
        } else
                *sub++ = '\0';
 
        if ( ! (atou(path, &vol) && atou(sub, &rec))) {
-               resp_badmanual();
+               resp_error400();
                return;
        } else if (vol >= (unsigned int)ps->sz) {
-               resp_badmanual();
+               resp_error400();
                return;
        }
 
@@ -551,7 +717,7 @@ pg_show(const struct manpaths *ps, const struct req *req, char *path)
        key.size = 4;
 
        if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) {
-               rc < 0 ? resp_baddb() : resp_badmanual();
+               rc < 0 ? resp_baddb() : resp_error400();
                goto out;
        } 
 
@@ -580,7 +746,7 @@ static void
 pg_search(const struct manpaths *ps, const struct req *req, char *path)
 {
        size_t            tt;
-       int               i, sz, rc;
+       int               i, sz, rc, whatis;
        const char       *ep, *start;
        char            **cp;
        struct opts       opt;
@@ -590,16 +756,30 @@ pg_search(const struct manpaths *ps, const struct req *req, char *path)
        cp = NULL;
        ep = NULL;
        sz = 0;
+       whatis = 1;
 
        memset(&opt, 0, sizeof(struct opts));
 
        for (sz = i = 0; i < (int)req->fieldsz; i++)
                if (0 == strcmp(req->fields[i].key, "expr"))
                        ep = req->fields[i].val;
+               else if (0 == strcmp(req->fields[i].key, "query"))
+                       ep = req->fields[i].val;
                else if (0 == strcmp(req->fields[i].key, "sec"))
                        opt.cat = req->fields[i].val;
+               else if (0 == strcmp(req->fields[i].key, "sektion"))
+                       opt.cat = req->fields[i].val;
                else if (0 == strcmp(req->fields[i].key, "arch"))
                        opt.arch = req->fields[i].val;
+               else if (0 == strcmp(req->fields[i].key, "apropos"))
+                       whatis = 0 == strcmp
+                               (req->fields[i].val, "0");
+               else if (0 == strcmp(req->fields[i].key, "op"))
+                       whatis = 0 == strcasecmp
+                               (req->fields[i].val, "whatis");
+
+       if (NULL != opt.cat && 0 == strcmp(opt.cat, "0"))
+               opt.cat = NULL;
 
        /*
         * Poor man's tokenisation.
@@ -629,7 +809,10 @@ pg_search(const struct manpaths *ps, const struct req *req, char *path)
         * The resp_search() function is called with the results.
         */
 
-       if (NULL != (expr = exprcomp(sz, cp, &tt)))
+       expr = whatis ? 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);
@@ -639,7 +822,7 @@ pg_search(const struct manpaths *ps, const struct req *req, char *path)
        if (0 == rc)
                resp_baddb();
        else if (-1 == rc)
-               resp_badexpr(req);
+               resp_search(NULL, 0, (void *)req);
 
        for (i = 0; i < sz; i++)
                free(cp[i]);
@@ -729,7 +912,7 @@ main(void)
                pg_show(&paths, &req, subpath);
                break;
        default:
-               resp_badpage();
+               resp_error404(path);
                break;
        }
 
@@ -738,3 +921,12 @@ main(void)
 
        return(EXIT_SUCCESS);
 }
+
+static int
+cmp(const void *p1, const void *p2)
+{
+
+       return(strcasecmp(((const struct res *)p1)->title,
+                               ((const struct res *)p2)->title));
+}
+