]> git.cameronkatri.com Git - mandoc.git/blobdiff - cgi.c
git.ckatri.com / mandoc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
For accessibility, label the last two widgets in the search form.
[mandoc.git] / cgi.c
diff --git a/cgi.c b/cgi.c
index be6a90544b4ad28ce43852466e63f6ce8003202b..68460c55fda8ac9d35853a5757e36490dcc4e65e 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,6 +1,6 @@
-/* $Id: cgi.c,v 1.177 2022/07/04 16:20:42 schwarze Exp $ */
+/* $Id: cgi.c,v 1.180 2022/07/06 17:21:04 schwarze Exp $ */
 /*
 /*
- * Copyright (c) 2014-2019, 2021 Ingo Schwarze <schwarze@usta.de>
+ * Copyright (c) 2014-2019, 2021, 2022 Ingo Schwarze <schwarze@usta.de>
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2022 Anna Vyalkova <cyber@sysrq.in>
  *
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2022 Anna Vyalkova <cyber@sysrq.in>
  *
@@ -87,10 +87,10 @@ static      void             pg_search(const struct req *);
 static void             pg_searchres(const struct req *,
                                struct manpage *, size_t);
 static void             pg_show(struct req *, const char *);
 static void             pg_searchres(const struct req *,
                                struct manpage *, size_t);
 static void             pg_show(struct req *, const char *);
-static void             resp_begin_html(int, const char *, const char *);
+static int              resp_begin_html(int, const char *, const char *);
 static void             resp_begin_http(int, const char *);
 static void             resp_catman(const struct req *, const char *);
 static void             resp_begin_http(int, const char *);
 static void             resp_catman(const struct req *, const char *);
-static void             resp_copy(const char *);
+static int              resp_copy(const char *, const char *);
 static void             resp_end_html(void);
 static void             resp_format(const struct req *, const char *);
 static void             resp_searchform(const struct req *, enum focus);
 static void             resp_end_html(void);
 static void             resp_format(const struct req *, const char *);
 static void             resp_searchform(const struct req *, enum focus);
@@ -353,22 +353,26 @@ resp_begin_http(int code, const char *msg)
        fflush(stdout);
 }
 
        fflush(stdout);
 }
 
-static void
-resp_copy(const char *filename)
+static int
+resp_copy(const char *element, const char *filename)
 {
        char     buf[4096];
        ssize_t  sz;
        int      fd;
 
 {
        char     buf[4096];
        ssize_t  sz;
        int      fd;
 
-       if ((fd = open(filename, O_RDONLY)) != -1) {
-               fflush(stdout);
-               while ((sz = read(fd, buf, sizeof(buf))) > 0)
-                       write(STDOUT_FILENO, buf, sz);
-               close(fd);
-       }
+       if ((fd = open(filename, O_RDONLY)) == -1)
+               return 0;
+
+       if (element != NULL)
+               printf("<%s>\n", element);
+       fflush(stdout);
+       while ((sz = read(fd, buf, sizeof(buf))) > 0)
+               write(STDOUT_FILENO, buf, sz);
+       close(fd);
+       return 1;
 }
 
 }
 
-static void
+static int
 resp_begin_html(int code, const char *msg, const char *file)
 {
        const char      *name, *sec, *cp;
 resp_begin_html(int code, const char *msg, const char *file)
 {
        const char      *name, *sec, *cp;
@@ -414,14 +418,14 @@ resp_begin_html(int code, const char *msg, const char *file)
               "<body>\n",
               CUSTOMIZE_TITLE);
 
               "<body>\n",
               CUSTOMIZE_TITLE);
 
-       resp_copy(MAN_DIR "/header.html");
+       return resp_copy("header", MAN_DIR "/header.html");
 }
 
 static void
 resp_end_html(void)
 {
 }
 
 static void
 resp_end_html(void)
 {
-
-       resp_copy(MAN_DIR "/footer.html");
+       if (resp_copy("footer", MAN_DIR "/footer.html"))
+               puts("</footer>");
 
        puts("</body>\n"
             "</html>");
 
        puts("</body>\n"
             "</html>");
@@ -432,8 +436,7 @@ resp_searchform(const struct req *req, enum focus focus)
 {
        int              i;
 
 {
        int              i;
 
-       printf("<header>\n"
-              "<form role=\"search\" action=\"/%s\" method=\"get\" "
+       printf("<form role=\"search\" action=\"/%s\" method=\"get\" "
               "autocomplete=\"off\" autocapitalize=\"none\">\n"
               "  <fieldset>\n"
               "    <legend>Manual Page Search Parameters</legend>\n",
               "autocomplete=\"off\" autocapitalize=\"none\">\n"
               "  <fieldset>\n"
               "    <legend>Manual Page Search Parameters</legend>\n",
@@ -441,13 +444,14 @@ resp_searchform(const struct req *req, enum focus focus)
 
        /* Write query input box. */
 
 
        /* Write query input box. */
 
-       printf("    <input type=\"search\" name=\"query\" value=\"");
+       printf("    <label>Search query:\n"
+              "      <input type=\"search\" name=\"query\" value=\"");
        if (req->q.query != NULL)
                html_print(req->q.query);
        if (req->q.query != NULL)
                html_print(req->q.query);
-       printf( "\" size=\"40\"");
+       printf("\" size=\"40\"");
        if (focus == FOCUS_QUERY)
                printf(" autofocus");
        if (focus == FOCUS_QUERY)
                printf(" autofocus");
-       puts(">");
+       puts(">\n    </label>");
 
        /* Write submission buttons. */
 
 
        /* Write submission buttons. */
 
@@ -459,7 +463,7 @@ resp_searchform(const struct req *req, enum focus focus)
 
        /* Write section selector. */
 
 
        /* Write section selector. */
 
-       puts("    <select name=\"sec\" aria-label=\"manual section\">");
+       puts("    <select name=\"sec\" aria-label=\"Manual section\">");
        for (i = 0; i < sec_MAX; i++) {
                printf("      <option value=\"%s\"", sec_numbers[i]);
                if (NULL != req->q.sec &&
        for (i = 0; i < sec_MAX; i++) {
                printf("      <option value=\"%s\"", sec_numbers[i]);
                if (NULL != req->q.sec &&
@@ -488,7 +492,8 @@ resp_searchform(const struct req *req, enum focus focus)
        /* Write manpath selector. */
 
        if (req->psz > 1) {
        /* Write manpath selector. */
 
        if (req->psz > 1) {
-               puts("    <select name=\"manpath\">");
+               puts("    <select name=\"manpath\""
+                    " aria-label=\"Manual path\">");
                for (i = 0; i < (int)req->psz; i++) {
                        printf("      <option");
                        if (strcmp(req->q.manpath, req->p[i]) == 0)
                for (i = 0; i < (int)req->psz; i++) {
                        printf("      <option");
                        if (strcmp(req->q.manpath, req->p[i]) == 0)
@@ -501,8 +506,7 @@ resp_searchform(const struct req *req, enum focus focus)
        }
 
        puts("  </fieldset>\n"
        }
 
        puts("  </fieldset>\n"
-            "</form>\n"
-            "</header>");
+            "</form>");
 }
 
 static int
 }
 
 static int
@@ -557,11 +561,12 @@ validate_filename(const char *file)
 static void
 pg_index(const struct req *req)
 {
 static void
 pg_index(const struct req *req)
 {
-
-       resp_begin_html(200, NULL, NULL);
+       if (resp_begin_html(200, NULL, NULL) == 0)
+               puts("<header>");
        resp_searchform(req, FOCUS_QUERY);
        resp_searchform(req, FOCUS_QUERY);
-       printf("<main>\n"
-              "<p role=\"doc-notice\" aria-label=\"usage\">\n"
+       printf("</header>\n"
+              "<main>\n"
+              "<p role=\"doc-notice\" aria-label=\"Usage\">\n"
               "This web interface is documented in the\n"
               "<a class=\"Xr\" href=\"/%s%sman.cgi.8\""
               " aria-label=\"man dot CGI, section 8\">man.cgi(8)</a>\n"
               "This web interface is documented in the\n"
               "<a class=\"Xr\" href=\"/%s%sman.cgi.8\""
               " aria-label=\"man dot CGI, section 8\">man.cgi(8)</a>\n"
@@ -580,10 +585,12 @@ static void
 pg_noresult(const struct req *req, int code, const char *http_msg,
     const char *user_msg)
 {
 pg_noresult(const struct req *req, int code, const char *http_msg,
     const char *user_msg)
 {
-       resp_begin_html(code, http_msg, NULL);
+       if (resp_begin_html(code, http_msg, NULL) == 0)
+               puts("<header>");
        resp_searchform(req, FOCUS_QUERY);
        resp_searchform(req, FOCUS_QUERY);
+       puts("</header>");
        puts("<main>");
        puts("<main>");
-       puts("<p role=\"doc-notice\" aria-label=\"no result\">");
+       puts("<p role=\"doc-notice\" aria-label=\"No result\">");
        puts(user_msg);
        puts("</p>");
        puts("</main>");
        puts(user_msg);
        puts("</p>");
        puts("</main>");
@@ -593,8 +600,8 @@ pg_noresult(const struct req *req, int code, const char *http_msg,
 static void
 pg_error_badrequest(const char *msg)
 {
 static void
 pg_error_badrequest(const char *msg)
 {
-
-       resp_begin_html(400, "Bad Request", NULL);
+       if (resp_begin_html(400, "Bad Request", NULL))
+               puts("</header>");
        puts("<main>\n"
             "<h1>Bad Request</h1>\n"
             "<p role=\"doc-notice\" aria-label=\"Bad Request\">");
        puts("<main>\n"
             "<h1>Bad Request</h1>\n"
             "<p role=\"doc-notice\" aria-label=\"Bad Request\">");
@@ -602,14 +609,15 @@ pg_error_badrequest(const char *msg)
        printf("Try again from the\n"
               "<a href=\"/%s\">main page</a>.\n"
               "</p>\n"
        printf("Try again from the\n"
               "<a href=\"/%s\">main page</a>.\n"
               "</p>\n"
-              "</main>", scriptname);
+              "</main>\n", scriptname);
        resp_end_html();
 }
 
 static void
 pg_error_internal(void)
 {
        resp_end_html();
 }
 
 static void
 pg_error_internal(void)
 {
-       resp_begin_html(500, "Internal Server Error", NULL);
+       if (resp_begin_html(500, "Internal Server Error", NULL))
+               puts("</header>");
        puts("<main><p role=\"doc-notice\">Internal Server Error</p></main>");
        resp_end_html();
 }
        puts("<main><p role=\"doc-notice\">Internal Server Error</p></main>");
        resp_end_html();
 }
@@ -641,6 +649,7 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz)
        size_t           i, iuse;
        int              archprio, archpriouse;
        int              prio, priouse;
        size_t           i, iuse;
        int              archprio, archpriouse;
        int              prio, priouse;
+       int              have_header;
 
        for (i = 0; i < sz; i++) {
                if (validate_filename(r[i].file))
 
        for (i = 0; i < sz; i++) {
                if (validate_filename(r[i].file))
@@ -707,12 +716,15 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz)
                        priouse = prio;
                        iuse = i;
                }
                        priouse = prio;
                        iuse = i;
                }
-               resp_begin_html(200, NULL, r[iuse].file);
+               have_header = resp_begin_html(200, NULL, r[iuse].file);
        } else
        } else
-               resp_begin_html(200, NULL, NULL);
+               have_header = resp_begin_html(200, NULL, NULL);
 
 
+       if (have_header == 0)
+               puts("<header>");
        resp_searchform(req,
            req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);
        resp_searchform(req,
            req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);
+       puts("</header>");
 
        if (sz > 1) {
                puts("<nav>");
 
        if (sz > 1) {
                puts("<nav>");
@@ -983,8 +995,10 @@ pg_show(struct req *req, const char *fullpath)
                return;
        }
 
                return;
        }
 
-       resp_begin_html(200, NULL, file);
+       if (resp_begin_html(200, NULL, file) == 0)
+               puts("<header>");
        resp_searchform(req, FOCUS_NONE);
        resp_searchform(req, FOCUS_NONE);
+       puts("</header>");
        resp_show(req, file);
        resp_end_html();
 }
        resp_show(req, file);
        resp_end_html();
 }
A git conversion mirror of mandoc.bsd.lv