=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.58 retrieving revision 1.65 diff -u -p -r1.58 -r1.65 --- mandoc/cgi.c 2014/07/09 14:18:59 1.58 +++ mandoc/cgi.c 2014/07/12 16:14:35 1.65 @@ -1,4 +1,4 @@ -/* $Id: cgi.c,v 1.58 2014/07/09 14:18:59 schwarze Exp $ */ +/* $Id: cgi.c,v 1.65 2014/07/12 16:14:35 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Kristaps Dzonsons * Copyright (c) 2014 Ingo Schwarze @@ -49,7 +49,7 @@ 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 { @@ -74,14 +74,15 @@ 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 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_error_notfound(const char *); 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 *); @@ -141,9 +142,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 +166,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 +206,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 +231,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 +271,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 +288,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 +303,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); } @@ -365,10 +355,20 @@ resp_searchform(const struct req *req) "
\n" "
\n" "Search Parameters\n" - " for manuals satisfying \n" - " " + "for manuals \n", scriptname); + printf("\n" + "q.expr ? req->q.expr : ""); printf("\">, section " "q.arch ? req->q.arch : ""); printf("\">"); if (req->psz > 1) { - puts(", "); for (i = 0; i < (int)req->psz; i++) { printf("
\n" "
\n" @@ -407,26 +407,49 @@ resp_index(const struct req *req) { resp_begin_html(200, NULL); + puts("

\n" + "Online manuals with " + "mandoc\n" + "

"); 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(200, NULL); + resp_searchform(req); + puts("

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

"); + resp_end_html(); +} - 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" +static void +resp_error_badrequest(const char *msg) +{ + + 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_error404(const char *page) +resp_error_notfound(const char *page) { resp_begin_html(404, "Not Found"); @@ -444,7 +467,7 @@ resp_error404(const char *page) } static void -resp_bad(void) +resp_error_internal(void) { resp_begin_html(500, "Internal Server Error"); puts("

Internal Server Error

"); @@ -452,15 +475,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,31 +484,21 @@ 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("Status: 303 See Other\r\n"); printf("Location: http://%s%s/show/%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++) { @@ -536,7 +540,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 +679,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,7 +690,9 @@ 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; } @@ -694,7 +702,9 @@ format(const struct req *req, const char *file) 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; } @@ -722,7 +732,8 @@ pg_show(const struct req *req, 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 +745,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; } @@ -763,15 +774,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 +811,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]); @@ -850,7 +863,7 @@ main(void) if (-1 == chdir(mandir)) { fprintf(stderr, "MAN_DIR: %s: %s\n", mandir, strerror(errno)); - resp_bad(); + resp_error_internal(); return(EXIT_FAILURE); } @@ -905,7 +918,7 @@ main(void) pg_show(&req, subpath); break; default: - resp_error404(path); + resp_error_notfound(path); break; }