Make the calltree a bit easier to understand by giving the

[mandoc.git] / cgi.c

diff --git a/cgi.c b/cgi.c
index 5c53279a556dfec40b84544e1380aea2ccfa37d6..00f033ef4386c513823704cdf0528d2e708c0b70 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,4 +1,4 @@
-/*     $Id: cgi.c,v 1.67 2014/07/12 18:32:47 schwarze Exp $ */
+/*     $Id: cgi.c,v 1.72 2014/07/13 12:55:45 schwarze Exp $ */

 /*
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>
 /*
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>


@@ -64,23 +64,57 @@ static      void             http_print(const char *);
 static void             http_putchar(char);
 static void             http_printquery(const struct req *);
 static void             pathgen(struct req *);
 static void             http_putchar(char);
 static void             http_printquery(const struct req *);
 static void             pathgen(struct req *);

+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_search(const struct req *);
 static void             pg_search(const struct req *);

+static void             pg_searchres(const struct req *,
+                               struct manpage *, size_t);

 static void             pg_show(const struct req *, const char *);
 static void             resp_begin_html(int, const char *);
 static void             resp_begin_http(int, const char *);
 static void             resp_end_html(void);
 static void             pg_show(const struct req *, const char *);
 static void             resp_begin_html(int, const char *);
 static void             resp_begin_http(int, const char *);
 static void             resp_end_html(void);

-static void             resp_error_badrequest(const char *);
-static void             resp_error_internal(void);
-static void             resp_index(const struct req *);
-static void             resp_noresult(const struct req *,
-                               const char *);
-static void             resp_search(const struct req *,
-                               struct manpage *, size_t);

 static void             resp_searchform(const struct req *);
 static void             resp_searchform(const struct req *);

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

 
 static const char       *scriptname; /* CGI script name */
 static const char       *httphost; /* hostname used in the URIs */
 
 
 static const char       *scriptname; /* CGI script name */
 static const char       *httphost; /* hostname used in the URIs */
 

+static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
+static const char *const sec_numbers[] = {
+    "0", "1", "2", "3", "3p", "4", "5", "6", "7", "8", "9"
+};
+static const char *const sec_names[] = {
+    "All Sections",
+    "1 - General Commands",
+    "2 - System Calls",
+    "3 - Subroutines",
+    "3p - Perl Subroutines",
+    "4 - Special Files",
+    "5 - File Formats",
+    "6 - Games",
+    "7 - Macros and Conventions",
+    "8 - Maintenance Commands",
+    "9 - Kernel Interface"
+};
+static const int sec_MAX = sizeof(sec_names) / sizeof(char *);
+
+static const char *const arch_names[] = {
+    "amd64",       "alpha",       "armish",      "armv7",
+    "aviion",      "hppa",        "hppa64",      "i386",
+    "ia64",        "landisk",     "loongson",    "luna88k",
+    "macppc",      "mips64",      "octeon",      "sgi",
+    "socppc",      "solbourne",   "sparc",       "sparc64",
+    "vax",         "zaurus",
+    "amiga",       "arc",         "arm32",       "atari",
+    "beagle",      "cats",        "hp300",       "mac68k",
+    "mvme68k",     "mvme88k",     "mvmeppc",     "palm",
+    "pc532",       "pegasos",     "pmax",        "powerpc",
+    "sun3",        "wgrisc",      "x68k"
+};
+static const int arch_MAX = sizeof(arch_names) / sizeof(char *);
+

 /*
  * Print a character, escaping HTML along the way.
  * This will pass non-ASCII straight to output: be warned!
 /*
  * Print a character, escaping HTML along the way.
  * This will pass non-ASCII straight to output: be warned!


@@ -338,38 +372,65 @@ resp_searchform(const struct req *req)
        printf("<DIV ID=\"mancgi\">\n"
               "<FORM ACTION=\"%s\" METHOD=\"get\">\n"
               "<FIELDSET>\n"
        printf("<DIV ID=\"mancgi\">\n"
               "<FORM ACTION=\"%s\" METHOD=\"get\">\n"
               "<FIELDSET>\n"

-              "<LEGEND>Search Parameters</LEGEND>\n"
-              "<INPUT TYPE=\"submit\" VALUE=\"Search\"> "
-              "for manuals \n",
+              "<LEGEND>Manual Page Search Parameters</LEGEND>\n",

               scriptname);
               scriptname);

-       printf("<SELECT NAME=\"apropos\">\n"
-              "<OPTION VALUE=\"0\"");
+
+       /* Write query input box. */
+
+       printf( "<TABLE><TR><TD>\n"
+               "<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\"");
+       if (NULL != req->q.expr)
+               html_print(req->q.expr);
+       puts("\" SIZE=\"40\">");
+
+       /* Write submission and reset buttons. */
+
+       printf( "<INPUT TYPE=\"submit\" VALUE=\"Submit\">\n"
+               "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n");
+
+       /* Write show radio button */
+
+       printf( "</TD><TD>\n"
+               "<INPUT TYPE=\"radio\" ");

        if (req->q.equal)
        if (req->q.equal)

-               printf(" SELECTED=\"selected\"");
-       printf(">named</OPTION>\n"
-              "<OPTION VALUE=\"1\"");
-       if (0 == req->q.equal)
-               printf(" SELECTED=\"selected\"");
-       printf(">matching</OPTION>\n"
-              "</SELECT>\n"
-              "<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\"");
-       html_print(req->q.expr ? req->q.expr : "");
-       printf("\">, section "
-              "<INPUT TYPE=\"text\""
-              " SIZE=\"4\" NAME=\"sec\" VALUE=\"");
-       html_print(req->q.sec ? req->q.sec : "");
-       printf("\">, arch "
-              "<INPUT TYPE=\"text\""
-              " SIZE=\"8\" NAME=\"arch\" VALUE=\"");
-       html_print(req->q.arch ? req->q.arch : "");
-       printf("\">");
+               printf("CHECKED ");
+       printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n"
+               "<LABEL FOR=\"show\">Show named manual page</LABEL>\n");
+
+       /* Write section selector. */
+
+       printf( "</TD></TR><TR><TD>\n"
+               "<SELECT NAME=\"sec\">");
+       for (i = 0; i < sec_MAX; i++) {
+               printf("<OPTION VALUE=\"%s\"", sec_numbers[i]);
+               if (NULL != req->q.sec &&
+                   0 == strcmp(sec_numbers[i], req->q.sec))
+                       printf(" SELECTED");
+               printf(">%s</OPTION>\n", sec_names[i]);
+       }
+       puts("</SELECT>");
+
+       /* Write architecture selector. */
+
+       puts("<SELECT NAME=\"arch\">");
+       for (i = 0; i < arch_MAX; i++) {
+               printf("<OPTION VALUE=\"%s\"", arch_names[i]);
+               if (NULL != req->q.arch &&
+                   0 == strcmp(arch_names[i], req->q.arch))
+                       printf(" SELECTED");
+               printf(">%s</OPTION>\n", arch_names[i]);
+       }
+       puts("</SELECT>");
+
+       /* Write manpath selector. */
+

        if (req->psz > 1) {
        if (req->psz > 1) {

-               puts(", in <SELECT NAME=\"manpath\">");
+               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]))
                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]))

-                               printf("SELECTED=\"selected\" ");
+                               printf("SELECTED ");

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


@@ -378,8 +439,17 @@ resp_searchform(const struct req *req)
                }
                puts("</SELECT>");
        }
                }
                puts("</SELECT>");
        }

-       puts("&mdash;\n"
-            "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
+
+       /* Write search radio button */
+
+       printf( "</TD><TD>\n"
+               "<INPUT TYPE=\"radio\" ");
+       if (0 == req->q.equal)
+               printf("CHECKED ");
+       printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n"
+               "<LABEL FOR=\"search\">Search with apropos query</LABEL>\n");
+
+       puts("</TD></TR></TABLE>\n"

             "</FIELDSET>\n"
             "</FORM>\n"
             "</DIV>");
             "</FIELDSET>\n"
             "</FORM>\n"
             "</DIV>");


@@ -387,24 +457,24 @@ resp_searchform(const struct req *req)
 }
 
 static void
 }
 
 static void

-resp_index(const struct req *req)
+pg_index(const struct req *req)

 {
 
        resp_begin_html(200, NULL);
        resp_searchform(req);
        printf("<P>\n"
               "This web interface is documented in the "
 {
 
        resp_begin_html(200, NULL);
        resp_searchform(req);
        printf("<P>\n"
               "This web interface is documented in the "

-              "<A HREF=\"%s?query=man.cgi&amp;sec=8\">"
-              "man.cgi</A> manual, and the "
-              "<A HREF=\"%s?query=apropos&amp;sec=1\">"
-              "apropos</A> manual explains the query syntax.\n"
+              "<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A> "
+              "manual, and the "
+              "<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A> "
+              "manual explains the query syntax.\n"

               "</P>\n",
               scriptname, scriptname);
        resp_end_html();
 }
 
 static void
               "</P>\n",
               scriptname, scriptname);
        resp_end_html();
 }
 
 static void

-resp_noresult(const struct req *req, const char *msg)
+pg_noresult(const struct req *req, const char *msg)

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


@@ -415,7 +485,7 @@ resp_noresult(const struct req *req, const char *msg)
 }
 
 static void
 }
 
 static void

-resp_error_badrequest(const char *msg)
+pg_error_badrequest(const char *msg)

 {
 
        resp_begin_html(400, "Bad Request");
 {
 
        resp_begin_html(400, "Bad Request");


@@ -429,7 +499,7 @@ resp_error_badrequest(const char *msg)
 }
 
 static void
 }
 
 static void

-resp_error_internal(void)
+pg_error_internal(void)

 {
        resp_begin_html(500, "Internal Server Error");
        puts("<P>Internal Server Error</P>");
 {
        resp_begin_html(500, "Internal Server Error");
        puts("<P>Internal Server Error</P>");


@@ -437,9 +507,11 @@ resp_error_internal(void)
 }
 
 static void
 }
 
 static void

-resp_search(const struct req *req, struct manpage *r, size_t sz)
+pg_searchres(const struct req *req, struct manpage *r, size_t sz)

 {
 {

-       size_t           i;
+       size_t           i, iuse, isec;
+       int              prio, priouse;
+       char             sec;

 
        if (1 == sz) {
                /*
 
        if (1 == sz) {
                /*


@@ -481,6 +553,30 @@ resp_search(const struct req *req, struct manpage *r, size_t sz)
 
        puts("</TABLE>\n"
             "</DIV>");
 
        puts("</TABLE>\n"
             "</DIV>");

+
+       /*
+        * In man(1) mode, show one of the pages
+        * even if more than one is found.
+        */
+
+       if (req->q.equal) {
+               puts("<HR>");
+               iuse = 0;
+               priouse = 10;
+               for (i = 0; i < sz; i++) {
+                       isec = strcspn(r[i].file, "123456789");
+                       sec = r[i].file[isec];
+                       if ('\0' == sec)
+                               continue;
+                       prio = sec_prios[sec - '1'];
+                       if (prio >= priouse)
+                               continue;
+                       priouse = prio;
+                       iuse = i;
+               }
+               resp_show(req, r[iuse].file);
+       }
+

        resp_end_html();
 }
 
        resp_end_html();
 }
 


@@ -494,13 +590,10 @@ catman(const struct req *req, const char *file)
        int              italic, bold;
 
        if (NULL == (f = fopen(file, "r"))) {
        int              italic, bold;
 
        if (NULL == (f = fopen(file, "r"))) {

-               resp_error_badrequest(
-                   "You specified an invalid manual file.");
+               puts("<P>You specified an invalid manual file.</P>");

                return;
        }
 
                return;
        }
 

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

        puts("<DIV CLASS=\"catman\">\n"
             "<PRE>");
 
        puts("<DIV CLASS=\"catman\">\n"
             "<PRE>");
 


@@ -614,9 +707,7 @@ catman(const struct req *req, const char *file)
        }
 
        puts("</PRE>\n"
        }
 
        puts("</PRE>\n"

-            "</DIV>\n"
-            "</BODY>\n"
-            "</HTML>");
+            "</DIV>");

 
        fclose(f);
 }
 
        fclose(f);
 }


@@ -633,8 +724,7 @@ format(const struct req *req, const char *file)
        char             opts[PATH_MAX + 128];
 
        if (-1 == (fd = open(file, O_RDONLY, 0))) {
        char             opts[PATH_MAX + 128];
 
        if (-1 == (fd = open(file, O_RDONLY, 0))) {

-               resp_error_badrequest(
-                   "You specified an invalid manual file.");
+               puts("<P>You specified an invalid manual file.</P>");

                return;
        }
 
                return;
        }
 


@@ -646,7 +736,7 @@ format(const struct req *req, const char *file)
        if (rc >= MANDOCLEVEL_FATAL) {
                fprintf(stderr, "fatal mandoc error: %s/%s\n",
                    req->q.manpath, file);
        if (rc >= MANDOCLEVEL_FATAL) {
                fprintf(stderr, "fatal mandoc error: %s/%s\n",
                    req->q.manpath, file);

-               resp_error_internal();
+               pg_error_internal();

                return;
        }
 
                return;
        }
 


@@ -658,14 +748,11 @@ format(const struct req *req, const char *file)
        if (NULL == man && NULL == mdoc) {
                fprintf(stderr, "fatal mandoc error: %s/%s\n",
                    req->q.manpath, file);
        if (NULL == man && NULL == mdoc) {
                fprintf(stderr, "fatal mandoc error: %s/%s\n",
                    req->q.manpath, file);

-               resp_error_internal();
+               pg_error_internal();

                mparse_free(mp);
                return;
        }
 
                mparse_free(mp);
                return;
        }
 

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

        vp = html_alloc(opts);
 
        if (NULL != mdoc)
        vp = html_alloc(opts);
 
        if (NULL != mdoc)


@@ -673,20 +760,29 @@ format(const struct req *req, const char *file)
        else
                html_man(vp, man);
 
        else
                html_man(vp, man);
 

-       puts("</BODY>\n"
-            "</HTML>");
-

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

+static void
+resp_show(const struct req *req, const char *file)
+{
+       if ('.' == file[0] || '/' == file[1])
+               file += 2;
+
+       if ('c' == *file)
+               catman(req, file);
+       else
+               format(req, file);
+}
+

 static void
 pg_show(const struct req *req, const char *path)
 {
        char            *sub;
 
        if (NULL == path || NULL == (sub = strchr(path, '/'))) {
 static void
 pg_show(const struct req *req, const char *path)
 {
        char            *sub;
 
        if (NULL == path || NULL == (sub = strchr(path, '/'))) {

-               resp_error_badrequest(
+               pg_error_badrequest(

                    "You did not specify a page to show.");
                return;
        } 
                    "You did not specify a page to show.");
                return;
        } 


@@ -699,15 +795,15 @@ pg_show(const struct req *req, const char *path)
         */
 
        if (-1 == chdir(path)) {
         */
 
        if (-1 == chdir(path)) {

-               resp_error_badrequest(
+               pg_error_badrequest(

                    "You specified an invalid manpath.");
                return;
        }
 
                    "You specified an invalid manpath.");
                return;
        }
 

-       if ('c' == *sub)
-               catman(req, sub);
-       else
-               format(req, sub);
+       resp_begin_html(200, NULL);
+       resp_searchform(req);
+       resp_show(req, sub);
+       resp_end_html();

 }
 
 static void
 }
 
 static void


@@ -728,7 +824,7 @@ pg_search(const struct req *req)
         */
 
        if (-1 == (chdir(req->q.manpath))) {
         */
 
        if (-1 == (chdir(req->q.manpath))) {

-               resp_error_badrequest(
+               pg_error_badrequest(

                    "You specified an invalid manpath.");
                return;
        }
                    "You specified an invalid manpath.");
                return;
        }


@@ -766,11 +862,11 @@ pg_search(const struct req *req)
        }
 
        if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz))
        }
 
        if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz))

-               resp_noresult(req, "You entered an invalid query.");
+               pg_noresult(req, "You entered an invalid query.");

        else if (0 == ressz)
        else if (0 == ressz)

-               resp_noresult(req, "No results found.");
+               pg_noresult(req, "No results found.");

        else
        else

-               resp_search(req, res, ressz);
+               pg_searchres(req, res, ressz);

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


@@ -812,7 +908,7 @@ main(void)
        if (-1 == chdir(MAN_DIR)) {
                fprintf(stderr, "MAN_DIR: %s: %s\n",
                    MAN_DIR, strerror(errno));
        if (-1 == chdir(MAN_DIR)) {
                fprintf(stderr, "MAN_DIR: %s: %s\n",
                    MAN_DIR, strerror(errno));

-               resp_error_internal();
+               pg_error_internal();

                return(EXIT_FAILURE);
        } 
 
                return(EXIT_FAILURE);
        } 
 


@@ -837,7 +933,7 @@ main(void)
        else if (NULL != req.q.expr)
                pg_search(&req);
        else
        else if (NULL != req.q.expr)
                pg_search(&req);
        else

-               resp_index(&req);
+               pg_index(&req);

 
        for (i = 0; i < (int)req.psz; i++)
                free(req.p[i]);
 
        for (i = 0; i < (int)req.psz; i++)
                free(req.p[i]);