=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.66 retrieving revision 1.72 diff -u -p -r1.66 -r1.72 --- mandoc/cgi.c 2014/07/12 17:21:45 1.66 +++ mandoc/cgi.c 2014/07/13 12:55:45 1.72 @@ -1,4 +1,4 @@ -/* $Id: cgi.c,v 1.66 2014/07/12 17:21:45 schwarze Exp $ */ +/* $Id: cgi.c,v 1.72 2014/07/13 12:55:45 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Kristaps Dzonsons * Copyright (c) 2014 Ingo Schwarze @@ -33,6 +33,7 @@ #include "main.h" #include "manpath.h" #include "mansearch.h" +#include "cgi.h" /* * A query as passed to the search function. @@ -63,25 +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 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_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 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_show(const struct req *, const char *); 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 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! @@ -314,11 +347,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 @@ -334,42 +367,70 @@ resp_searchform(const struct req *req) { int i; + puts(CUSTOMIZE_BEGIN); puts(""); printf("

\n" "

\n" - "Search Parameters\n" - " " - "for manuals \n", + "Manual Page Search Parameters\n", scriptname); - printf("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(" SELECTED=\"selected\""); - printf(">named\n" - "\n" - "\n" - "q.expr ? req->q.expr : ""); - printf("\">, section " - "q.sec ? req->q.sec : ""); - printf("\">, arch " - "q.arch ? req->q.arch : ""); - printf("\">"); + printf("CHECKED "); + printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n" + "Show named manual page\n"); + + /* Write section selector. */ + + printf( "\n" + ""); + + /* Write architecture selector. */ + + puts(""); + + /* Write manpath selector. */ + if (req->psz > 1) { - puts(", in "); for (i = 0; i < (int)req->psz; i++) { printf("

\n" "

"); @@ -387,28 +457,24 @@ resp_searchform(const struct req *req) } static void -resp_index(const struct req *req) +pg_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" + "man.cgi " + "manual, and the " + "apropos " + "manual explains the query syntax.\n" "

\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); @@ -419,7 +485,7 @@ resp_noresult(const struct req *req, const char *msg) } static void -resp_error_badrequest(const char *msg) +pg_error_badrequest(const char *msg) { resp_begin_html(400, "Bad Request"); @@ -433,7 +499,7 @@ resp_error_badrequest(const char *msg) } static void -resp_error_internal(void) +pg_error_internal(void) { resp_begin_html(500, "Internal Server Error"); puts("

Internal Server Error

"); @@ -441,9 +507,11 @@ resp_error_internal(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) { /* @@ -485,6 +553,30 @@ resp_search(const struct req *req, struct manpage *r, puts("\n" ""); + + /* + * In man(1) mode, show one of the pages + * even if more than one is found. + */ + + if (req->q.equal) { + puts("

"); + 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(); } @@ -498,13 +590,10 @@ catman(const struct req *req, const char *file) int italic, bold; if (NULL == (f = fopen(file, "r"))) { - resp_error_badrequest( - "You specified an invalid manual file."); + puts("

You specified an invalid manual file.

"); return; } - resp_begin_html(200, NULL); - resp_searchform(req); puts("

\n" "

");
 
@@ -618,9 +707,7 @@ catman(const struct req *req, const char *file)
 	}
 
 	puts("

\n" - "

\n" - "\n" - ""); + ""); fclose(f); } @@ -637,8 +724,7 @@ format(const struct req *req, const char *file) char opts[PATH_MAX + 128]; if (-1 == (fd = open(file, O_RDONLY, 0))) { - resp_error_badrequest( - "You specified an invalid manual file."); + puts("

You specified an invalid manual file.

"); return; } @@ -650,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); - resp_error_internal(); + pg_error_internal(); return; } @@ -662,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); - resp_error_internal(); + pg_error_internal(); mparse_free(mp); return; } - resp_begin_html(200, NULL); - resp_searchform(req); - vp = html_alloc(opts); if (NULL != mdoc) @@ -677,20 +760,29 @@ format(const struct req *req, const char *file) else html_man(vp, man); - puts("\n" - ""); - 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, '/'))) { - resp_error_badrequest( + pg_error_badrequest( "You did not specify a page to show."); return; } @@ -703,15 +795,15 @@ pg_show(const struct req *req, const char *path) */ if (-1 == chdir(path)) { - resp_error_badrequest( + pg_error_badrequest( "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 @@ -732,7 +824,7 @@ pg_search(const struct req *req) */ if (-1 == (chdir(req->q.manpath))) { - resp_error_badrequest( + pg_error_badrequest( "You specified an invalid manpath."); return; } @@ -770,11 +862,11 @@ pg_search(const struct req *req) } 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) - resp_noresult(req, "No results found."); + pg_noresult(req, "No results found."); else - resp_search(req, res, ressz); + pg_searchres(req, res, ressz); for (i = 0; i < sz; i++) free(cp[i]); @@ -801,28 +893,22 @@ main(void) /* 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_error_internal(); + MAN_DIR, strerror(errno)); + pg_error_internal(); return(EXIT_FAILURE); } @@ -847,7 +933,7 @@ main(void) 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]);