=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.58 retrieving revision 1.69 diff -u -p -r1.58 -r1.69 --- mandoc/cgi.c 2014/07/09 14:18:59 1.58 +++ mandoc/cgi.c 2014/07/13 09:39:32 1.69 @@ -1,4 +1,4 @@ -/* $Id: cgi.c,v 1.58 2014/07/09 14:18:59 schwarze Exp $ */ +/* $Id: cgi.c,v 1.69 2014/07/13 09:39:32 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Kristaps Dzonsons * Copyright (c) 2014 Ingo Schwarze @@ -33,14 +33,8 @@ #include "main.h" #include "manpath.h" #include "mansearch.h" +#include "cgi.h" -enum page { - PAGE_INDEX, - PAGE_SEARCH, - PAGE_SHOW, - PAGE__MAX -}; - /* * A query as passed to the search function. */ @@ -49,14 +43,13 @@ struct query { const char *arch; /* architecture */ const char *sec; /* manual section */ const char *expr; /* unparsed expression string */ - int legacy; /* whether legacy mode */ + int equal; /* match whole names, not substrings */ }; struct req { struct query q; char **p; /* array of available manpaths */ size_t psz; /* number of available manpaths */ - enum page page; }; static void catman(const struct req *, const char *); @@ -71,32 +64,56 @@ 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 pg_index(const struct req *, char *); -static void pg_search(const struct req *, char *); -static void pg_show(const struct req *, char *); -static void resp_bad(void); -static void resp_baddb(void); -static void resp_error400(void); -static void resp_error404(const char *); +static void pg_search(const struct req *); +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 const char *scriptname; /* CGI script name */ -static const char *mandir; /* contains all manpath directories */ -static const char *cssdir; /* css directory */ static const char *httphost; /* hostname used in the URIs */ -static const char * const pages[PAGE__MAX] = { - "index", /* PAGE_INDEX */ - "search", /* PAGE_SEARCH */ - "show", /* PAGE_SHOW */ +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! @@ -141,9 +158,11 @@ http_printquery(const struct req *req) http_print(req->q.arch); } if (NULL != req->q.expr) { - printf("&expr="); - http_print(req->q.expr ? req->q.expr : ""); + printf("&query="); + http_print(req->q.expr); } + if (0 == req->q.equal) + printf("&apropos=1"); } static void @@ -163,9 +182,11 @@ html_printquery(const struct req *req) html_print(req->q.arch); } if (NULL != req->q.expr) { - printf("&expr="); - html_print(req->q.expr ? req->q.expr : ""); + printf("&query="); + html_print(req->q.expr); } + if (0 == req->q.equal) + printf("&apropos=1"); } static void @@ -201,12 +222,11 @@ static void http_parse(struct req *req, char *p) { char *key, *val; - int legacy; memset(&req->q, 0, sizeof(struct query)); req->q.manpath = req->p[0]; + req->q.equal = 1; - legacy = -1; while ('\0' != *p) { key = p; val = NULL; @@ -227,37 +247,21 @@ http_parse(struct req *req, char *p) if (NULL != val && ! http_decode(val)) break; - if (0 == strcmp(key, "expr")) + if (0 == strcmp(key, "query")) req->q.expr = val; - else if (0 == strcmp(key, "query")) - req->q.expr = val; - else if (0 == strcmp(key, "sec")) - req->q.sec = val; - else if (0 == strcmp(key, "sektion")) - req->q.sec = val; - else if (0 == strcmp(key, "arch")) - req->q.arch = val; else if (0 == strcmp(key, "manpath")) req->q.manpath = val; else if (0 == strcmp(key, "apropos")) - legacy = 0 == strcmp(val, "0"); + req->q.equal = !strcmp(val, "0"); + else if (0 == strcmp(key, "sec") || + 0 == strcmp(key, "sektion")) { + if (strcmp(val, "0")) + req->q.sec = val; + } else if (0 == strcmp(key, "arch")) { + if (strcmp(val, "default")) + req->q.arch = val; + } } - - /* Test for old man.cgi compatibility mode. */ - - req->q.legacy = legacy > 0; - - /* - * Section "0" means no section when in legacy mode. - * For some man.cgi scripts, "default" arch is none. - */ - - if (req->q.legacy && NULL != req->q.sec) - if (0 == strcmp(req->q.sec, "0")) - req->q.sec = NULL; - if (req->q.legacy && NULL != req->q.arch) - if (0 == strcmp(req->q.arch, "default")) - req->q.arch = NULL; } static void @@ -283,11 +287,13 @@ static int http_decode(char *p) { char hex[3]; + char *q; int c; hex[2] = '\0'; - for ( ; '\0' != *p; p++) { + q = p; + for ( ; '\0' != *p; p++, q++) { if ('%' == *p) { if ('\0' == (hex[0] = *(p + 1))) return(0); @@ -298,13 +304,13 @@ http_decode(char *p) if ('\0' == c) return(0); - *p = (char)c; - memmove(p + 1, p + 3, strlen(p + 3) + 1); + *q = (char)c; + p += 2; } else - *p = '+' == *p ? ' ' : *p; + *q = '+' == *p ? ' ' : *p; } - *p = '\0'; + *q = '\0'; return(1); } @@ -313,12 +319,12 @@ resp_begin_http(int code, const char *msg) { if (200 != code) - printf("Status: %d %s\n", code, msg); + printf("Status: %d %s\r\n", code, msg); - puts("Content-Type: text/html; charset=utf-8\n" - "Cache-Control: no-cache\n" - "Pragma: no-cache\n" - ""); + printf("Content-Type: text/html; charset=utf-8\r\n" + "Cache-Control: no-cache\r\n" + "Pragma: no-cache\r\n" + "\r\n"); fflush(stdout); } @@ -340,11 +346,11 @@ resp_begin_html(int code, const char *msg) " TYPE=\"text/css\" media=\"all\">\n" "\n" - "System Manpage Reference\n" + "%s\n" "\n" "\n" "\n", - cssdir, cssdir); + CSS_DIR, CSS_DIR, CUSTOMIZE_TITLE); } static void @@ -360,32 +366,70 @@ resp_searchform(const struct req *req) { int i; + puts(CUSTOMIZE_BEGIN); puts(""); printf("
\n" - "
\n" + "\n" "
\n" - "Search Parameters\n" - " for manuals satisfying \n" - "Manual Page Search Parameters\n", scriptname); - html_print(req->q.expr ? req->q.expr : ""); - printf("\">, section " - "q.sec ? req->q.sec : ""); - printf("\">, arch " - "q.arch ? req->q.arch : ""); - printf("\">"); + + /* Write query input box. */ + + printf( "
\n" + "q.expr) + html_print(req->q.expr); + puts("\" SIZE=\"40\">"); + + /* Write submission and reset buttons. */ + + printf( "\n" + "\n"); + + /* Write show radio button */ + + printf( "\n" + "q.equal) + printf("CHECKED "); + printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n" + "\n"); + + /* Write section selector. */ + + printf( "
\n" + ""); + + /* Write architecture selector. */ + + puts(""); + + /* Write manpath selector. */ + if (req->psz > 1) { - puts(", "); for (i = 0; i < (int)req->psz; i++) { printf("\n" + "q.equal) + printf("CHECKED "); + printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n" + "\n"); + + puts("
\n" "
\n" "
\n" "
"); @@ -408,43 +461,44 @@ resp_index(const struct req *req) resp_begin_html(200, NULL); resp_searchform(req); + printf("

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

\n", + scriptname, scriptname); resp_end_html(); } static void -resp_error400(void) +resp_noresult(const struct req *req, const char *msg) { - - resp_begin_html(400, "Query Malformed"); - printf("

Malformed Query

\n" - "

\n" - "The query your entered was malformed.\n" - "Try again from the\n" - "main page.\n" - "

", scriptname); + resp_begin_html(200, NULL); + resp_searchform(req); + puts("

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

"); resp_end_html(); } static void -resp_error404(const char *page) +resp_error_badrequest(const char *msg) { - resp_begin_html(404, "Not Found"); - puts("

Page Not Found

\n" - "

\n" - "The page you're looking for, "); - printf(""); - html_print(page); - printf(",\n" - "could not be found.\n" - "Try searching from the\n" + resp_begin_html(400, "Bad Request"); + puts("

Bad Request

\n" + "

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

", scriptname); resp_end_html(); } static void -resp_bad(void) +resp_error_internal(void) { resp_begin_html(500, "Internal Server Error"); puts("

Internal Server Error

"); @@ -452,15 +506,6 @@ resp_bad(void) } static void -resp_baddb(void) -{ - - resp_begin_html(500, "Internal Server Error"); - puts("

Your database is broken.

"); - resp_end_html(); -} - -static void resp_search(const struct req *req, struct manpage *r, size_t sz) { size_t i; @@ -470,37 +515,27 @@ resp_search(const struct req *req, struct manpage *r, * If we have just one result, then jump there now * without any delay. */ - puts("Status: 303 See Other"); - printf("Location: http://%s%s/show/%s/%s?", + printf("Status: 303 See Other\r\n"); + printf("Location: http://%s%s/%s/%s?", httphost, scriptname, req->q.manpath, r[0].file); http_printquery(req); - puts("\n" - "Content-Type: text/html; charset=utf-8\n"); + printf("\r\n" + "Content-Type: text/html; charset=utf-8\r\n" + "\r\n"); return; } + qsort(r, sz, sizeof(struct manpage), cmp); + resp_begin_html(200, NULL); resp_searchform(req); - puts("
"); - - if (0 == sz) { - puts("

\n" - "No results found.\n" - "

\n" - "
"); - resp_end_html(); - return; - } - - qsort(r, sz, sizeof(struct manpage), cmp); - puts(""); for (i = 0; i < sz; i++) { printf("\n" "
\n" - "q.manpath, r[i].file); html_printquery(req); printf("\">"); @@ -518,15 +553,7 @@ resp_search(const struct req *req, struct manpage *r, resp_end_html(); } -/* ARGSUSED */ static void -pg_index(const struct req *req, char *path) -{ - - resp_index(req); -} - -static void catman(const struct req *req, const char *file) { FILE *f; @@ -536,7 +563,8 @@ catman(const struct req *req, const char *file) int italic, bold; if (NULL == (f = fopen(file, "r"))) { - resp_baddb(); + resp_error_badrequest( + "You specified an invalid manual file."); return; } @@ -674,7 +702,8 @@ format(const struct req *req, const char *file) char opts[PATH_MAX + 128]; if (-1 == (fd = open(file, O_RDONLY, 0))) { - resp_baddb(); + resp_error_badrequest( + "You specified an invalid manual file."); return; } @@ -684,17 +713,21 @@ format(const struct req *req, const char *file) close(fd); if (rc >= MANDOCLEVEL_FATAL) { - resp_baddb(); + fprintf(stderr, "fatal mandoc error: %s/%s\n", + req->q.manpath, file); + resp_error_internal(); return; } snprintf(opts, sizeof(opts), - "fragment,man=%s/search?sec=%%S&expr=Nm~^%%N$", + "fragment,man=%s?query=%%N&sec=%%S", scriptname); mparse_result(mp, &mdoc, &man, NULL); if (NULL == man && NULL == mdoc) { - resp_baddb(); + fprintf(stderr, "fatal mandoc error: %s/%s\n", + req->q.manpath, file); + resp_error_internal(); mparse_free(mp); return; } @@ -717,12 +750,13 @@ format(const struct req *req, const char *file) } static void -pg_show(const struct req *req, char *path) +pg_show(const struct req *req, const char *path) { char *sub; if (NULL == path || NULL == (sub = strchr(path, '/'))) { - resp_error400(); + resp_error_badrequest( + "You did not specify a page to show."); return; } *sub++ = '\0'; @@ -734,8 +768,8 @@ pg_show(const struct req *req, char *path) */ if (-1 == chdir(path)) { - perror(path); - resp_baddb(); + resp_error_badrequest( + "You specified an invalid manpath."); return; } @@ -746,7 +780,7 @@ pg_show(const struct req *req, char *path) } static void -pg_search(const struct req *req, char *path) +pg_search(const struct req *req) { struct mansearch search; struct manpaths paths; @@ -763,15 +797,15 @@ pg_search(const struct req *req, char *path) */ if (-1 == (chdir(req->q.manpath))) { - perror(req->q.manpath); - resp_search(req, NULL, 0); + resp_error_badrequest( + "You specified an invalid manpath."); return; } search.arch = req->q.arch; search.sec = req->q.sec; - search.deftype = TYPE_Nm | TYPE_Nd; - search.flags = 0; + search.deftype = req->q.equal ? TYPE_Nm : (TYPE_Nm | TYPE_Nd); + search.flags = req->q.equal ? MANSEARCH_MAN : 0; paths.sz = 1; paths.paths = mandoc_malloc(sizeof(char *)); @@ -800,10 +834,12 @@ pg_search(const struct req *req, char *path) ep++; } - if (mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz)) - resp_search(req, res, ressz); + if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz)) + resp_noresult(req, "You entered an invalid query."); + else if (0 == ressz) + resp_noresult(req, "No results found."); else - resp_baddb(); + resp_search(req, res, ressz); for (i = 0; i < sz; i++) free(cp[i]); @@ -823,34 +859,29 @@ pg_search(const struct req *req, char *path) int main(void) { - int i; struct req req; - char *querystring, *path, *subpath; + const char *path; + char *querystring; + int i; /* Scan our run-time environment. */ - if (NULL == (mandir = getenv("MAN_DIR"))) - mandir = "/man"; - if (NULL == (scriptname = getenv("SCRIPT_NAME"))) scriptname = ""; - if (NULL == (cssdir = getenv("CSS_DIR"))) - cssdir = ""; - if (NULL == (httphost = getenv("HTTP_HOST"))) httphost = "localhost"; /* - * First we change directory into the mandir so that + * First we change directory into the MAN_DIR so that * subsequent scanning for manpath directories is rooted * relative to the same position. */ - if (-1 == chdir(mandir)) { + if (-1 == chdir(MAN_DIR)) { fprintf(stderr, "MAN_DIR: %s: %s\n", - mandir, strerror(errno)); - resp_bad(); + MAN_DIR, strerror(errno)); + resp_error_internal(); return(EXIT_FAILURE); } @@ -862,52 +893,20 @@ main(void) if (NULL != (querystring = getenv("QUERY_STRING"))) http_parse(&req, querystring); - /* - * Now juggle paths to extract information. - * We want to extract our filetype (the file suffix), the - * initial path component, then the trailing component(s). - * Start with leading subpath component. - */ + /* Dispatch to the three different pages. */ - subpath = path = NULL; - req.page = PAGE__MAX; + path = getenv("PATH_INFO"); + if (NULL == path) + path = ""; + else if ('/' == *path) + path++; - if (NULL == (path = getenv("PATH_INFO")) || '\0' == *path) - req.page = PAGE_INDEX; - - if (NULL != path && '/' == *path && '\0' == *++path) - req.page = PAGE_INDEX; - - /* Resolve subpath component. */ - - if (NULL != path && NULL != (subpath = strchr(path, '/'))) - *subpath++ = '\0'; - - /* Map path into one we recognise. */ - - if (NULL != path && '\0' != *path) - for (i = 0; i < (int)PAGE__MAX; i++) - if (0 == strcmp(pages[i], path)) { - req.page = (enum page)i; - break; - } - - /* Route pages. */ - - switch (req.page) { - case (PAGE_INDEX): - pg_index(&req, subpath); - break; - case (PAGE_SEARCH): - pg_search(&req, subpath); - break; - case (PAGE_SHOW): - pg_show(&req, subpath); - break; - default: - resp_error404(path); - break; - } + if ('\0' != *path) + pg_show(&req, path); + else if (NULL != req.q.expr) + pg_search(&req); + else + resp_index(&req); for (i = 0; i < (int)req.psz; i++) free(req.p[i]);