=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.155 retrieving revision 1.181 diff -u -p -r1.155 -r1.181 --- mandoc/cgi.c 2017/06/20 17:24:35 1.155 +++ mandoc/cgi.c 2023/04/28 19:11:03 1.181 @@ -1,7 +1,8 @@ -/* $Id: cgi.c,v 1.155 2017/06/20 17:24:35 schwarze Exp $ */ +/* $Id: cgi.c,v 1.181 2023/04/28 19:11:03 schwarze Exp $ */ /* + * Copyright (c) 2014-2019, 2021, 2022 Ingo Schwarze * Copyright (c) 2011, 2012 Kristaps Dzonsons - * Copyright (c) 2014, 2015, 2016, 2017 Ingo Schwarze + * Copyright (c) 2022 Anna Vyalkova * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,6 +15,8 @@ * 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. + * + * Implementation of the man.cgi(8) program. */ #include "config.h" @@ -38,6 +41,7 @@ #include "roff.h" #include "mdoc.h" #include "man.h" +#include "mandoc_parse.h" #include "main.h" #include "manconf.h" #include "mansearch.h" @@ -69,27 +73,30 @@ enum focus { static void html_print(const char *); static void html_putchar(char); static int http_decode(char *); +static void http_encode(const char *); static void parse_manpath_conf(struct req *); -static void parse_path_info(struct req *req, const char *path); +static void parse_path_info(struct req *, const char *); static void parse_query_string(struct req *, const char *); 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_noresult(const struct req *, int, const char *, + const char *); static void pg_redirect(const struct req *, const char *); 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 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_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_show(const struct req *, const char *); static void set_query_attr(char **, char **); +static int validate_arch(const char *); static int validate_filename(const char *); static int validate_manpath(const struct req *, const char *); static int validate_urifrag(const char *); @@ -116,16 +123,18 @@ static const char *const sec_names[] = { static const int sec_MAX = sizeof(sec_names) / sizeof(char *); static const char *const arch_names[] = { - "amd64", "alpha", "armv7", "arm64", - "hppa", "i386", "landisk", - "loongson", "luna88k", "macppc", "mips64", - "octeon", "sgi", "socppc", "sparc64", + "amd64", "alpha", "armv7", "arm64", + "hppa", "i386", "landisk", "loongson", + "luna88k", "macppc", "mips64", "octeon", + "powerpc64", "riscv64", "sparc64", + "amiga", "arc", "armish", "arm32", "atari", "aviion", "beagle", "cats", "hppa64", "hp300", "ia64", "mac68k", "mvme68k", "mvme88k", "mvmeppc", "palm", "pc532", "pegasos", - "pmax", "powerpc", "solbourne", "sparc", + "pmax", "powerpc", "sgi", "socppc", + "solbourne", "sparc", "sun3", "vax", "wgrisc", "x68k", "zaurus" }; @@ -316,6 +325,18 @@ http_decode(char *p) } static void +http_encode(const char *p) +{ + for (; *p != '\0'; p++) { + if (isalnum((unsigned char)*p) == 0 && + strchr("-._~", *p) == NULL) + printf("%%%2.2X", (unsigned char)*p); + else + putchar(*p); + } +} + +static void resp_begin_http(int code, const char *msg) { @@ -324,31 +345,38 @@ resp_begin_http(int code, const char *msg) printf("Content-Type: text/html; charset=utf-8\r\n" "Cache-Control: no-cache\r\n" + "Content-Security-Policy: default-src 'none'; " + "style-src 'self' 'unsafe-inline'\r\n" "Pragma: no-cache\r\n" "\r\n"); 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; - 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) { - char *cp; + const char *name, *sec, *cp; + int namesz, secsz; resp_begin_http(code, msg); @@ -356,32 +384,49 @@ resp_begin_html(int code, const char *msg, const char "\n" "\n" " \n" + " \n" " \n" " ", CSS_DIR); if (file != NULL) { - if ((cp = strrchr(file, '/')) != NULL) - file = cp + 1; - if ((cp = strrchr(file, '.')) != NULL) { - printf("%.*s(%s) - ", (int)(cp - file), file, cp + 1); - } else - printf("%s - ", file); + cp = strrchr(file, '/'); + name = cp == NULL ? file : cp + 1; + cp = strrchr(name, '.'); + namesz = cp == NULL ? strlen(name) : cp - name; + sec = NULL; + if (cp != NULL && cp[1] != '0') { + sec = cp + 1; + secsz = strlen(sec); + } else if (name - file > 1) { + for (cp = name - 2; cp >= file; cp--) { + if (*cp < '1' || *cp > '9') + continue; + sec = cp; + secsz = name - cp - 1; + break; + } + } + printf("%.*s", namesz, name); + if (sec != NULL) + printf("(%.*s)", secsz, sec); + fputs(" - ", stdout); } printf("%s\n" "\n" "\n", CUSTOMIZE_TITLE); - resp_copy(MAN_DIR "/header.html"); + return resp_copy("header", MAN_DIR "/header.html"); } static void resp_end_html(void) { + if (resp_copy("footer", MAN_DIR "/footer.html")) + puts(""); - resp_copy(MAN_DIR "/footer.html"); - puts("\n" ""); } @@ -391,20 +436,22 @@ resp_searchform(const struct req *req, enum focus focu { int i; - printf("
\n" + printf("\n" "
\n" " Manual Page Search Parameters\n", scriptname); /* Write query input box. */ - printf(" Search query:\n" + " q.query != NULL) html_print(req->q.query); - printf( "\" size=\"40\""); + printf("\" size=\"40\""); if (focus == FOCUS_QUERY) printf(" autofocus"); - puts(">"); + puts(">\n "); /* Write submission buttons. */ @@ -416,7 +463,7 @@ resp_searchform(const struct req *req, enum focus focu /* Write section selector. */ - puts(" "); for (i = 0; i < sec_MAX; i++) { printf(" "); for (i = 0; i < arch_MAX; i++) { - printf(" "); } puts(" "); @@ -490,6 +536,18 @@ validate_manpath(const struct req *req, const char* ma } static int +validate_arch(const char *arch) +{ + int i; + + for (i = 0; i < arch_MAX; i++) + if (strcmp(arch, arch_names[i]) == 0) + return 1; + + return 0; +} + +static int validate_filename(const char *file) { @@ -503,51 +561,64 @@ validate_filename(const char *file) static void pg_index(const struct req *req) { - - resp_begin_html(200, NULL, NULL); + if (resp_begin_html(200, NULL, NULL) == 0) + puts("
"); resp_searchform(req, FOCUS_QUERY); - printf("

\n" + printf("

\n" + "
\n" + "

\n" "This web interface is documented in the\n" - "man.cgi(8)\n" + "man.cgi(8)\n" "manual, and the\n" - "apropos(1)\n" + "apropos(1)\n" "manual explains the query syntax.\n" - "

\n", + "

\n" + "
\n", scriptname, *scriptname == '\0' ? "" : "/", scriptname, *scriptname == '\0' ? "" : "/"); resp_end_html(); } static void -pg_noresult(const struct req *req, const char *msg) +pg_noresult(const struct req *req, int code, const char *http_msg, + const char *user_msg) { - resp_begin_html(200, NULL, NULL); + if (resp_begin_html(code, http_msg, NULL) == 0) + puts("
"); resp_searchform(req, FOCUS_QUERY); - puts("

"); - puts(msg); + puts("

"); + puts("
"); + puts("

"); + puts(user_msg); puts("

"); + puts("
"); resp_end_html(); } static void pg_error_badrequest(const char *msg) { - - resp_begin_html(400, "Bad Request", NULL); - puts("

Bad Request

\n" - "

\n"); + if (resp_begin_html(400, "Bad Request", NULL)) + puts(""); + puts("

\n" + "

Bad Request

\n" + "

"); puts(msg); printf("Try again from the\n" "main page.\n" - "

", scriptname); + "

\n" + "
\n", scriptname); resp_end_html(); } static void pg_error_internal(void) { - resp_begin_html(500, "Internal Server Error", NULL); - puts("

Internal Server Error

"); + if (resp_begin_html(500, "Internal Server Error", NULL)) + puts(""); + puts("

Internal Server Error

"); resp_end_html(); } @@ -562,9 +633,11 @@ pg_redirect(const struct req *req, const char *name) printf("%s/", req->q.manpath); if (req->q.arch != NULL) printf("%s/", req->q.arch); - printf("%s", name); - if (req->q.sec != NULL) - printf(".%s", req->q.sec); + http_encode(name); + if (req->q.sec != NULL) { + putchar('.'); + http_encode(req->q.sec); + } printf("\r\nContent-Type: text/html; charset=utf-8\r\n\r\n"); } @@ -576,6 +649,7 @@ pg_searchres(const struct req *req, struct manpage *r, 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)) @@ -642,14 +716,18 @@ pg_searchres(const struct req *req, struct manpage *r, priouse = prio; iuse = i; } - resp_begin_html(200, NULL, r[iuse].file); + have_header = resp_begin_html(200, NULL, r[iuse].file); } else - resp_begin_html(200, NULL, NULL); + have_header = resp_begin_html(200, NULL, NULL); + if (have_header == 0) + puts("
"); resp_searchform(req, req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY); + puts("
"); if (sz > 1) { + puts(""); } if (req->q.equal || sz == 1) { @@ -689,7 +768,9 @@ resp_catman(const struct req *req, const char *file) int italic, bold; if ((f = fopen(file, "r")) == NULL) { - puts("

You specified an invalid manual file.

"); + puts("

\n" + " You specified an invalid manual file.\n" + "

"); return; } @@ -820,21 +901,24 @@ resp_format(const struct req *req, const char *file) { struct manoutput conf; struct mparse *mp; - struct roff_man *man; + struct roff_meta *meta; void *vp; int fd; int usepath; - if (-1 == (fd = open(file, O_RDONLY, 0))) { - puts("

You specified an invalid manual file.

"); + if (-1 == (fd = open(file, O_RDONLY))) { + puts("

\n" + " You specified an invalid manual file.\n" + "

"); return; } mchars_alloc(); - mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1, - MANDOCLEVEL_BADARG, NULL, req->q.manpath); + mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1 | + MPARSE_VALIDATE, MANDOC_OS_OTHER, req->q.manpath); mparse_readfd(mp, fd, file); close(fd); + meta = mparse_result(mp); memset(&conf, 0, sizeof(conf)); conf.fragment = 1; @@ -844,25 +928,12 @@ resp_format(const struct req *req, const char *file) scriptname, *scriptname == '\0' ? "" : "/", usepath ? req->q.manpath : "", usepath ? "/" : ""); - mparse_result(mp, &man, NULL); - if (man == NULL) { - warnx("fatal mandoc error: %s/%s", req->q.manpath, file); - pg_error_internal(); - mparse_free(mp); - mchars_free(); - return; - } - vp = html_alloc(&conf); + if (meta->macroset == MACROSET_MDOC) + html_mdoc(vp, meta); + else + html_man(vp, meta); - if (man->macroset == MACROSET_MDOC) { - mdoc_validate(man); - html_mdoc(vp, man); - } else { - man_validate(man); - html_man(vp, man); - } - html_free(vp); mparse_free(mp); mchars_free(); @@ -924,8 +995,10 @@ pg_show(struct req *req, const char *fullpath) return; } - resp_begin_html(200, NULL, file); + if (resp_begin_html(200, NULL, file) == 0) + puts("
"); resp_searchform(req, FOCUS_NONE); + puts("
"); resp_show(req, file); resp_end_html(); } @@ -999,9 +1072,10 @@ pg_search(const struct req *req) if (req->isquery && req->q.equal && argc == 1) pg_redirect(req, argv[0]); else if (mansearch(&search, &paths, argc, argv, &res, &ressz) == 0) - pg_noresult(req, "You entered an invalid query."); + pg_noresult(req, 400, "Bad Request", + "You entered an invalid query."); else if (ressz == 0) - pg_noresult(req, "No results found."); + pg_noresult(req, 404, "Not Found", "No results found."); else pg_searchres(req, res, ressz); @@ -1023,7 +1097,7 @@ main(void) #if HAVE_PLEDGE /* * The "rpath" pledge could be revoked after mparse_readfd() - * if the file desciptor to "/footer.html" would be opened + * if the file descriptor to "/footer.html" would be opened * up front, but it's probably not worth the complication * of the code it would cause: it would require scattering * pledge() calls in multiple low-level resp_*() functions. @@ -1089,7 +1163,7 @@ main(void) return EXIT_FAILURE; } - if ( ! (NULL == req.q.arch || validate_urifrag(req.q.arch))) { + if (req.q.arch != NULL && validate_arch(req.q.arch) == 0) { pg_error_badrequest( "You specified an invalid architecture."); return EXIT_FAILURE; @@ -1115,80 +1189,74 @@ main(void) } /* - * If PATH_INFO is not a file name, translate it to a query. + * Translate PATH_INFO to a query. */ static void parse_path_info(struct req *req, const char *path) { - char *dir[4]; - int i; + const char *name, *sec, *end; req->isquery = 0; req->q.equal = 1; - req->q.manpath = mandoc_strdup(path); + req->q.manpath = NULL; req->q.arch = NULL; /* Mandatory manual page name. */ - if ((req->q.query = strrchr(req->q.manpath, '/')) == NULL) { - req->q.query = req->q.manpath; - req->q.manpath = NULL; - } else - *req->q.query++ = '\0'; + if ((name = strrchr(path, '/')) == NULL) + name = path; + else + name++; /* Optional trailing section. */ - if ((req->q.sec = strrchr(req->q.query, '.')) != NULL) { - if(isdigit((unsigned char)req->q.sec[1])) { - *req->q.sec++ = '\0'; - req->q.sec = mandoc_strdup(req->q.sec); - } else - req->q.sec = NULL; + sec = strrchr(name, '.'); + if (sec != NULL && isdigit((unsigned char)*++sec)) { + req->q.query = mandoc_strndup(name, sec - name - 1); + req->q.sec = mandoc_strdup(sec); + } else { + req->q.query = mandoc_strdup(name); + req->q.sec = NULL; } /* Handle the case of name[.section] only. */ - if (req->q.manpath == NULL) + if (name == path) return; - req->q.query = mandoc_strdup(req->q.query); - /* Split directory components. */ - dir[i = 0] = req->q.manpath; - while ((dir[i + 1] = strchr(dir[i], '/')) != NULL) { - if (++i == 3) { - pg_error_badrequest( - "You specified too many directory components."); - exit(EXIT_FAILURE); - } - *dir[i]++ = '\0'; - } - /* Optional manpath. */ - if ((i = validate_manpath(req, req->q.manpath)) == 0) + end = strchr(path, '/'); + req->q.manpath = mandoc_strndup(path, end - path); + if (validate_manpath(req, req->q.manpath)) { + path = end + 1; + if (name == path) + return; + } else { + free(req->q.manpath); req->q.manpath = NULL; - else if (dir[1] == NULL) - return; + } /* Optional section. */ - if (strncmp(dir[i], "man", 3) == 0) { + if (strncmp(path, "man", 3) == 0 || strncmp(path, "cat", 3) == 0) { + path += 3; + end = strchr(path, '/'); free(req->q.sec); - req->q.sec = mandoc_strdup(dir[i++] + 3); + req->q.sec = mandoc_strndup(path, end - path); + path = end + 1; + if (name == path) + return; } - if (dir[i] == NULL) { - if (req->q.manpath == NULL) - free(dir[0]); - return; + + /* Optional architecture. */ + end = strchr(path, '/'); + if (end + 1 != name) { + pg_error_badrequest( + "You specified too many directory components."); + exit(EXIT_FAILURE); } - if (dir[i + 1] != NULL) { + req->q.arch = mandoc_strndup(path, end - path); + if (validate_arch(req->q.arch) == 0) { pg_error_badrequest( "You specified an invalid directory component."); exit(EXIT_FAILURE); } - - /* Optional architecture. */ - if (i) { - req->q.arch = mandoc_strdup(dir[i]); - if (req->q.manpath == NULL) - free(dir[0]); - } else - req->q.arch = dir[0]; } /*