=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.54 retrieving revision 1.132 diff -u -p -r1.54 -r1.132 --- mandoc/cgi.c 2014/07/09 09:19:03 1.54 +++ mandoc/cgi.c 2016/05/28 13:40:48 1.132 @@ -1,108 +1,132 @@ -/* $Id: cgi.c,v 1.54 2014/07/09 09:19:03 schwarze Exp $ */ +/* $Id: cgi.c,v 1.132 2016/05/28 13:40:48 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Kristaps Dzonsons - * Copyright (c) 2014 Ingo Schwarze + * Copyright (c) 2014, 2015, 2016 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * 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. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif +#include +#include + #include +#include +#include #include #include +#include #include #include #include #include -#if defined(__sun) -/* for stat() */ -#include -#include -#include -#endif - -#include "mandoc.h" #include "mandoc_aux.h" +#include "mandoc.h" +#include "roff.h" +#include "mdoc.h" +#include "man.h" #include "main.h" -#include "manpath.h" +#include "manconf.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. */ struct query { - const char *manroot; /* manual root directory */ - const char *arch; /* architecture */ - const char *sec; /* manual section */ - const char *expr; /* unparsed expression string */ - int legacy; /* whether legacy mode */ + char *manpath; /* desired manual directory */ + char *arch; /* architecture */ + char *sec; /* manual section */ + char *query; /* unparsed query expression */ + int equal; /* match whole names, not substrings */ }; struct req { - struct query q; - char **p; /* array of available manroots */ - size_t psz; - enum page page; + struct query q; + char **p; /* array of available manpaths */ + size_t psz; /* number of available manpaths */ + int isquery; /* QUERY_STRING used, not PATH_INFO */ }; -static void catman(const struct req *, const char *); -static int cmp(const void *, const void *); -static void format(const struct req *, const char *); +enum focus { + FOCUS_NONE = 0, + FOCUS_QUERY +}; + static void html_print(const char *); -static void html_printquery(const struct req *); static void html_putchar(char); -static int http_decode(char *); -static void http_parse(struct req *, char *); -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 int http_decode(char *); +static void parse_manpath_conf(struct req *); +static void parse_path_info(struct req *req, const char *path); +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_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 *); static void resp_begin_http(int, const char *); +static void resp_catman(const struct req *, const char *); +static void resp_copy(const char *); static void resp_end_html(void); -static void resp_index(const struct req *); -static void resp_search(const struct req *, - struct manpage *, size_t); -static void resp_searchform(const struct req *); +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_filename(const char *); +static int validate_manpath(const struct req *, const char *); +static int validate_urifrag(const char *); -static const char *progname; /* cgi script name */ -static const char *cache; /* cache directory */ -static const char *css; /* css directory */ -static const char *host; /* hostname */ +static const char *scriptname = SCRIPT_NAME; -static const char * const pages[PAGE__MAX] = { - "index", /* PAGE_INDEX */ - "search", /* PAGE_SEARCH */ - "show", /* PAGE_SHOW */ +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 - Library Functions", + "3p - Perl Library", + "4 - Device Drivers", + "5 - File Formats", + "6 - Games", + "7 - Miscellaneous Information", + "8 - System Manager\'s Manual", + "9 - Kernel Developer\'s Manual" +}; +static const int sec_MAX = sizeof(sec_names) / sizeof(char *); +static const char *const arch_names[] = { + "amd64", "alpha", "armish", "armv7", + "hppa", "hppa64", "i386", "landisk", + "loongson", "luna88k", "macppc", "mips64", + "octeon", "sgi", "socppc", "sparc", + "sparc64", "zaurus", + "amiga", "arc", "arm32", "atari", + "aviion", "beagle", "cats", "hp300", + "ia64", "mac68k", "mvme68k", "mvme88k", + "mvmeppc", "palm", "pc532", "pegasos", + "pmax", "powerpc", "solbourne", "sun3", + "vax", "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! @@ -129,155 +153,126 @@ html_putchar(char c) break; } } -static void -http_printquery(const struct req *req) -{ - if (NULL != req->q.manroot) { - printf("&manpath="); - http_print(req->q.manroot); - } - if (NULL != req->q.sec) { - printf("&sec="); - http_print(req->q.sec); - } - if (NULL != req->q.arch) { - printf("&arch="); - http_print(req->q.arch); - } - if (NULL != req->q.expr) { - printf("&expr="); - http_print(req->q.expr ? req->q.expr : ""); - } -} - - +/* + * Call through to html_putchar(). + * Accepts NULL strings. + */ static void -html_printquery(const struct req *req) +html_print(const char *p) { - if (NULL != req->q.manroot) { - printf("&manpath="); - html_print(req->q.manroot); - } - if (NULL != req->q.sec) { - printf("&sec="); - html_print(req->q.sec); - } - if (NULL != req->q.arch) { - printf("&arch="); - html_print(req->q.arch); - } - if (NULL != req->q.expr) { - printf("&expr="); - html_print(req->q.expr ? req->q.expr : ""); - } -} - -static void -http_print(const char *p) -{ - if (NULL == p) return; while ('\0' != *p) - http_putchar(*p++); + html_putchar(*p++); } /* - * Call through to html_putchar(). - * Accepts NULL strings. + * Transfer the responsibility for the allocated string *val + * to the query structure. */ static void -html_print(const char *p) +set_query_attr(char **attr, char **val) { - - if (NULL == p) - return; - while ('\0' != *p) - html_putchar(*p++); + + free(*attr); + if (**val == '\0') { + *attr = NULL; + free(*val); + } else + *attr = *val; + *val = NULL; } /* - * Parse out key-value pairs from an HTTP request variable. - * This can be either a cookie or a POST/GET string, although man.cgi - * uses only GET for simplicity. + * Parse the QUERY_STRING for key-value pairs + * and store the values into the query structure. */ static void -http_parse(struct req *req, char *p) +parse_query_string(struct req *req, const char *qs) { - char *key, *val; - int legacy; + char *key, *val; + size_t keysz, valsz; - memset(&req->q, 0, sizeof(struct query)); - req->q.manroot = req->p[0]; + req->isquery = 1; + req->q.manpath = NULL; + req->q.arch = NULL; + req->q.sec = NULL; + req->q.query = NULL; + req->q.equal = 1; - legacy = -1; - while ('\0' != *p) { - key = p; - val = NULL; + key = val = NULL; + while (*qs != '\0') { - p += (int)strcspn(p, ";&"); - if ('\0' != *p) - *p++ = '\0'; - if (NULL != (val = strchr(key, '='))) - *val++ = '\0'; + /* Parse one key. */ - if ('\0' == *key || NULL == val || '\0' == *val) - continue; + keysz = strcspn(qs, "=;&"); + key = mandoc_strndup(qs, keysz); + qs += keysz; + if (*qs != '=') + goto next; - /* Just abort handling. */ + /* Parse one value. */ - if ( ! http_decode(key)) - break; - if (NULL != val && ! http_decode(val)) - break; + valsz = strcspn(++qs, ";&"); + val = mandoc_strndup(qs, valsz); + qs += valsz; - if (0 == strcmp(key, "expr")) - 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.manroot = val; - else if (0 == strcmp(key, "apropos")) - legacy = 0 == strcmp(val, "0"); - } + /* Decode and catch encoding errors. */ - /* Test for old man.cgi compatibility mode. */ + if ( ! (http_decode(key) && http_decode(val))) + goto next; - req->q.legacy = legacy > 0; + /* Handle key-value pairs. */ - /* - * Section "0" means no section when in legacy mode. - * For some man.cgi scripts, "default" arch is none. - */ + if ( ! strcmp(key, "query")) + set_query_attr(&req->q.query, &val); - 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; -} + else if ( ! strcmp(key, "apropos")) + req->q.equal = !strcmp(val, "0"); -static void -http_putchar(char c) -{ + else if ( ! strcmp(key, "manpath")) { +#ifdef COMPAT_OLDURI + if ( ! strncmp(val, "OpenBSD ", 8)) { + val[7] = '-'; + if ('C' == val[8]) + val[8] = 'c'; + } +#endif + set_query_attr(&req->q.manpath, &val); + } - if (isalnum((unsigned char)c)) { - putchar((unsigned char)c); - return; - } else if (' ' == c) { - putchar('+'); - return; + else if ( ! (strcmp(key, "sec") +#ifdef COMPAT_OLDURI + && strcmp(key, "sektion") +#endif + )) { + if ( ! strcmp(val, "0")) + *val = '\0'; + set_query_attr(&req->q.sec, &val); + } + + else if ( ! strcmp(key, "arch")) { + if ( ! strcmp(val, "default")) + *val = '\0'; + set_query_attr(&req->q.arch, &val); + } + + /* + * The key must be freed in any case. + * The val may have been handed over to the query + * structure, in which case it is now NULL. + */ +next: + free(key); + key = NULL; + free(val); + val = NULL; + + if (*qs != '\0') + qs++; } - printf("%%%.2x", c); } /* @@ -289,29 +284,31 @@ 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); + return 0; if ('\0' == (hex[1] = *(p + 2))) - return(0); + return 0; if (1 != sscanf(hex, "%x", &c)) - return(0); + return 0; if ('\0' == c) - return(0); + 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'; - return(1); + *q = '\0'; + return 1; } static void @@ -319,241 +316,365 @@ 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); } static void +resp_copy(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); + } +} + +static void resp_begin_html(int code, const char *msg) { resp_begin_http(code, msg); - printf("\n" - "\n" - "\n" - "\n" - "\n" - "\n" - "System Manpage Reference\n" - "\n" - "\n" - "\n", css, css); + printf("\n" + "\n" + "\n" + "\n" + "\n" + "%s\n" + "\n" + "\n" + "\n", + CSS_DIR, CUSTOMIZE_TITLE); + + resp_copy(MAN_DIR "/header.html"); } static void resp_end_html(void) { - puts("\n" - ""); + resp_copy(MAN_DIR "/footer.html"); + + puts("\n" + ""); } static void -resp_searchform(const struct req *req) +resp_searchform(const struct req *req, enum focus focus) { int i; puts(""); - printf("
\n" - "
\n" - "
\n" - "Search Parameters\n" - " for manuals satisfying \n" - "q.expr ? req->q.expr : ""); - printf("\">, section " - "q.sec ? req->q.sec : ""); - printf("\">, arch " - "q.arch ? req->q.arch : ""); - printf("\">"); + printf("
\n" + "\n" + "
\n" + "Manual Page Search Parameters\n", + scriptname); + + /* Write query input box. */ + + printf("q.query != NULL) + html_print(req->q.query); + printf( "\" size=\"40\""); + if (focus == FOCUS_QUERY) + printf(" autofocus"); + puts(">"); + + /* Write submission buttons. */ + + printf( "\n" + "\n
\n"); + + /* Write section selector. */ + + puts(""); + + /* Write architecture selector. */ + + printf( ""); + + /* Write manpath selector. */ + if (req->psz > 1) { - puts(", "); for (i = 0; i < (int)req->psz; i++) { - printf(""); + puts(""); } - puts(""); + puts(""); } - puts(".\n" - "\n" - "
\n" - "\n" - "
"); + + puts("
\n" + "\n" + "
"); puts(""); } -static void -resp_index(const struct req *req) +static int +validate_urifrag(const char *frag) { - resp_begin_html(200, NULL); - resp_searchform(req); - resp_end_html(); + while ('\0' != *frag) { + if ( ! (isalnum((unsigned char)*frag) || + '-' == *frag || '.' == *frag || + '/' == *frag || '_' == *frag)) + return 0; + frag++; + } + return 1; } -static void -resp_error400(void) +static int +validate_manpath(const struct req *req, const char* manpath) { + size_t i; - 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" - "

", progname); - resp_end_html(); + if ( ! strcmp(manpath, "mandoc")) + return 1; + + for (i = 0; i < req->psz; i++) + if ( ! strcmp(manpath, req->p[i])) + return 1; + + return 0; } +static int +validate_filename(const char *file) +{ + + if ('.' == file[0] && '/' == file[1]) + file += 2; + + return ! (strstr(file, "../") || strstr(file, "/..") || + (strncmp(file, "man", 3) && strncmp(file, "cat", 3))); +} + static void -resp_error404(const char *page) +pg_index(const struct req *req) { - 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" - "main page.\n" - "

", progname); + resp_begin_html(200, NULL); + resp_searchform(req, FOCUS_QUERY); + printf("

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

\n", + scriptname, *scriptname == '\0' ? "" : "/", + scriptname, *scriptname == '\0' ? "" : "/"); resp_end_html(); } static void -resp_bad(void) +pg_noresult(const struct req *req, const char *msg) { - resp_begin_html(500, "Internal Server Error"); - puts("

Generic badness happened.

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

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

"); resp_end_html(); } static void -resp_baddb(void) +pg_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 +pg_error_internal(void) +{ resp_begin_html(500, "Internal Server Error"); - puts("

Your database is broken.

"); + puts("

Internal Server Error

"); resp_end_html(); } 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; + char *arch, *archend; + const char *sec; + size_t i, iuse; + int archprio, archpriouse; + int prio, priouse; - if (1 == sz) { + for (i = 0; i < sz; i++) { + if (validate_filename(r[i].file)) + continue; + warnx("invalid filename %s in %s database", + r[i].file, req->q.manpath); + pg_error_internal(); + return; + } + + if (req->isquery && sz == 1) { /* * 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?", - host, progname, req->q.manroot, r[0].file); - http_printquery(req); - puts("\n" - "Content-Type: text/html; charset=utf-8\n"); + printf("Status: 303 See Other\r\n"); + printf("Location: http://%s/%s%s%s/%s", + HTTP_HOST, scriptname, + *scriptname == '\0' ? "" : "/", + req->q.manpath, r[0].file); + printf("\r\n" + "Content-Type: text/html; charset=utf-8\r\n" + "\r\n"); return; } resp_begin_html(200, NULL); - resp_searchform(req); + resp_searchform(req, + req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY); - puts("
"); + if (sz > 1) { + puts("
"); + puts(""); - if (0 == sz) { - puts("

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

\n" - ""); - resp_end_html(); - return; + for (i = 0; i < sz; i++) { + printf("\n" + "\n" + "\n" + ""); + } + + puts("
\n" + "q.manpath, r[i].file); + printf("\">"); + html_print(r[i].names); + printf("\n" + ""); + html_print(r[i].output); + puts("
\n" + "
"); } - qsort(r, sz, sizeof(struct manpage), cmp); + /* + * In man(1) mode, show one of the pages + * even if more than one is found. + */ - puts(""); - - for (i = 0; i < sz; i++) { - printf("\n" - "\n" - "\n" - ""); + if (req->q.equal || sz == 1) { + puts("
"); + iuse = 0; + priouse = 20; + archpriouse = 3; + for (i = 0; i < sz; i++) { + sec = r[i].file; + sec += strcspn(sec, "123456789"); + if (sec[0] == '\0') + continue; + prio = sec_prios[sec[0] - '1']; + if (sec[1] != '/') + prio += 10; + if (req->q.arch == NULL) { + archprio = + ((arch = strchr(sec + 1, '/')) + == NULL) ? 3 : + ((archend = strchr(arch + 1, '/')) + == NULL) ? 0 : + strncmp(arch, "amd64/", + archend - arch) ? 2 : 1; + if (archprio < archpriouse) { + archpriouse = archprio; + priouse = prio; + iuse = i; + continue; + } + if (archprio > archpriouse) + continue; + } + if (prio >= priouse) + continue; + priouse = prio; + iuse = i; + } + resp_show(req, r[iuse].file); } - puts("
\n" - "q.manroot, r[i].file); - html_printquery(req); - printf("\">"); - html_print(r[i].names); - printf("\n" - ""); - html_print(r[i].output); - puts("
\n" - "
"); resp_end_html(); } -/* ARGSUSED */ static void -pg_index(const struct req *req, char *path) +resp_catman(const struct req *req, const char *file) { - - resp_index(req); -} - -static void -catman(const struct req *req, const char *file) -{ FILE *f; - size_t len; - int i; char *p; + size_t sz; + ssize_t len; + int i; int italic, bold; - if (NULL == (f = fopen(file, "r"))) { - resp_baddb(); + if ((f = fopen(file, "r")) == NULL) { + puts("

You specified an invalid manual file.

"); return; } - resp_begin_html(200, NULL); - resp_searchform(req); - puts("
\n" - "
");
+	puts("
\n"
+	     "
");
 
-	while (NULL != (p = fgetln(f, &len))) {
+	p = NULL;
+	sz = 0;
+
+	while ((len = getline(&p, &sz, f)) != -1) {
 		bold = italic = 0;
-		for (i = 0; i < (int)len - 1; i++) {
-			/* 
+		for (i = 0; i < len - 1; i++) {
+			/*
 			 * This means that the catpage is out of state.
 			 * Ignore it and keep going (although the
 			 * catpage is bogus).
@@ -571,22 +692,22 @@ catman(const struct req *req, const char *file)
 
 			if ('\b' != p[i + 1]) {
 				if (italic)
-					printf("");
+					printf("");
 				if (bold)
-					printf("");
+					printf("");
 				italic = bold = 0;
 				html_putchar(p[i]);
 				continue;
-			} else if (i + 2 >= (int)len)
+			} else if (i + 2 >= len)
 				continue;
 
 			/* Italic mode. */
 
 			if ('_' == p[i]) {
 				if (bold)
-					printf("");
+					printf("");
 				if ( ! italic)
-					printf("");
+					printf("");
 				bold = 0;
 				italic = 1;
 				i += 2;
@@ -594,7 +715,7 @@ catman(const struct req *req, const char *file)
 				continue;
 			}
 
-			/* 
+			/*
 			 * Handle funny behaviour troff-isms.
 			 * These grok'd from the original man2html.c.
 			 */
@@ -608,9 +729,9 @@ catman(const struct req *req, const char *file)
 					('*' == p[i] && '|' == p[i + 2]) ||
 					('|' == p[i] && '*' == p[i + 2]))  {
 				if (italic)
-					printf("");
+					printf("");
 				if (bold)
-					printf("");
+					printf("");
 				italic = bold = 0;
 				putchar('*');
 				i += 2;
@@ -622,9 +743,9 @@ catman(const struct req *req, const char *file)
 					('+' == p[i] && '|' == p[i + 1]) ||
 					('|' == p[i] && '+' == p[i + 1]))  {
 				if (italic)
-					printf("");
+					printf("");
 				if (bold)
-					printf("");
+					printf("");
 				italic = bold = 0;
 				putchar('+');
 				i += 2;
@@ -632,133 +753,166 @@ catman(const struct req *req, const char *file)
 			}
 
 			/* Bold mode. */
-			
+
 			if (italic)
-				printf("");
+				printf("");
 			if ( ! bold)
-				printf("");
+				printf("");
 			bold = 1;
 			italic = 0;
 			i += 2;
 			html_putchar(p[i]);
 		}
 
-		/* 
+		/*
 		 * Clean up the last character.
-		 * We can get to a newline; don't print that. 
+		 * We can get to a newline; don't print that.
 		 */
 
 		if (italic)
-			printf("");
+			printf("");
 		if (bold)
-			printf("");
+			printf("");
 
-		if (i == (int)len - 1 && '\n' != p[i])
+		if (i == len - 1 && p[i] != '\n')
 			html_putchar(p[i]);
 
 		putchar('\n');
 	}
+	free(p);
 
-	puts("
\n"
-	     "
\n"
-	     "\n"
-	     "");
+	puts("
\n" + "
"); fclose(f); } static void -format(const struct req *req, const char *file) +resp_format(const struct req *req, const char *file) { + struct manoutput conf; struct mparse *mp; - int fd; - struct mdoc *mdoc; - struct man *man; + struct roff_man *man; void *vp; - enum mandoclevel rc; - char opts[PATH_MAX + 128]; + int fd; + int usepath; if (-1 == (fd = open(file, O_RDONLY, 0))) { - resp_baddb(); + puts("

You specified an invalid manual file.

"); return; } - mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_FATAL, NULL, NULL); - rc = mparse_readfd(mp, fd, file); + mchars_alloc(); + mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_BADARG, NULL, req->q.manpath); + mparse_readfd(mp, fd, file); close(fd); - if (rc >= MANDOCLEVEL_FATAL) { - resp_baddb(); - return; - } + memset(&conf, 0, sizeof(conf)); + conf.fragment = 1; + usepath = strcmp(req->q.manpath, req->p[0]); + mandoc_asprintf(&conf.man, "/%s%s%%N.%%S", + usepath ? req->q.manpath : "", usepath ? "/" : ""); - snprintf(opts, sizeof(opts), - "fragment,man=%s/search?sec=%%S&expr=Nm~^%%N$", - progname); - - mparse_result(mp, &mdoc, &man, NULL); - if (NULL == man && NULL == mdoc) { - resp_baddb(); + 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; } - resp_begin_html(200, NULL); - resp_searchform(req); + vp = html_alloc(&conf); - vp = html_alloc(opts); - - if (NULL != mdoc) - html_mdoc(vp, mdoc); - else + if (man->macroset == MACROSET_MDOC) { + mdoc_validate(man); + html_mdoc(vp, man); + } else { + man_validate(man); html_man(vp, man); + } - puts("\n" - ""); - html_free(vp); mparse_free(mp); + mchars_free(); + free(conf.man); } static void -pg_show(const struct req *req, char *path) +resp_show(const struct req *req, const char *file) { - char *sub; - if (NULL == path || NULL == (sub = strchr(path, '/'))) { - resp_error400(); + if ('.' == file[0] && '/' == file[1]) + file += 2; + + if ('c' == *file) + resp_catman(req, file); + else + resp_format(req, file); +} + +static void +pg_show(struct req *req, const char *fullpath) +{ + char *manpath; + const char *file; + + if ((file = strchr(fullpath, '/')) == NULL) { + pg_error_badrequest( + "You did not specify a page to show."); return; - } - *sub++ = '\0'; + } + manpath = mandoc_strndup(fullpath, file - fullpath); + file++; + if ( ! validate_manpath(req, manpath)) { + pg_error_badrequest( + "You specified an invalid manpath."); + free(manpath); + return; + } + /* - * Begin by chdir()ing into the manroot. + * Begin by chdir()ing into the manpath. * This way we can pick up the database files, which are * relative to the manpath root. */ - if (-1 == chdir(path)) { - perror(path); - resp_baddb(); + if (chdir(manpath) == -1) { + warn("chdir %s", manpath); + pg_error_internal(); + free(manpath); return; } - if ('c' == *sub) - catman(req, sub); - else - format(req, sub); + if (strcmp(manpath, "mandoc")) { + free(req->q.manpath); + req->q.manpath = manpath; + } else + free(manpath); + + if ( ! validate_filename(file)) { + pg_error_badrequest( + "You specified an invalid manual file."); + return; + } + + resp_begin_html(200, NULL); + resp_searchform(req, FOCUS_NONE); + resp_show(req, file); + resp_end_html(); } static void -pg_search(const struct req *req, char *path) +pg_search(const struct req *req) { struct mansearch search; struct manpaths paths; struct manpage *res; - char **cp; - const char *ep, *start; + char **argv; + char *query, *rp, *wp; size_t ressz; - int i, sz; + int argc; /* * Begin by chdir()ing into the root of the manpath. @@ -766,60 +920,62 @@ pg_search(const struct req *req, char *path) * relative to the manpath root. */ - if (-1 == (chdir(req->q.manroot))) { - perror(req->q.manroot); - resp_search(req, NULL, 0); + if (chdir(req->q.manpath) == -1) { + warn("chdir %s", req->q.manpath); + pg_error_internal(); return; } search.arch = req->q.arch; search.sec = req->q.sec; - search.deftype = TYPE_Nm | TYPE_Nd; - search.flags = 0; + search.outkey = "Nd"; + search.argmode = req->q.equal ? ARG_NAME : ARG_EXPR; + search.firstmatch = 1; paths.sz = 1; paths.paths = mandoc_malloc(sizeof(char *)); paths.paths[0] = mandoc_strdup("."); /* - * Poor man's tokenisation: just break apart by spaces. - * Yes, this is half-ass. But it works for now. + * Break apart at spaces with backslash-escaping. */ - ep = req->q.expr; - while (ep && isspace((unsigned char)*ep)) - ep++; - - sz = 0; - cp = NULL; - while (ep && '\0' != *ep) { - cp = mandoc_reallocarray(cp, sz + 1, sizeof(char *)); - start = ep; - while ('\0' != *ep && ! isspace((unsigned char)*ep)) - ep++; - cp[sz] = mandoc_malloc((ep - start) + 1); - memcpy(cp[sz], start, ep - start); - cp[sz++][ep - start] = '\0'; - while (isspace((unsigned char)*ep)) - ep++; + argc = 0; + argv = NULL; + rp = query = mandoc_strdup(req->q.query); + for (;;) { + while (isspace((unsigned char)*rp)) + rp++; + if (*rp == '\0') + break; + argv = mandoc_reallocarray(argv, argc + 1, sizeof(char *)); + argv[argc++] = wp = rp; + for (;;) { + if (isspace((unsigned char)*rp)) { + *wp = '\0'; + rp++; + break; + } + if (rp[0] == '\\' && rp[1] != '\0') + rp++; + if (wp != rp) + *wp = *rp; + if (*rp == '\0') + break; + wp++; + rp++; + } } - if (mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz)) - resp_search(req, res, ressz); + if (0 == mansearch(&search, &paths, argc, argv, &res, &ressz)) + pg_noresult(req, "You entered an invalid query."); + else if (0 == ressz) + pg_noresult(req, "No results found."); else - resp_baddb(); + pg_searchres(req, res, ressz); - for (i = 0; i < sz; i++) - free(cp[i]); - free(cp); - - for (i = 0; i < (int)ressz; i++) { - free(res[i].file); - free(res[i].names); - free(res[i].output); - } - free(res); - + free(query); + mansearch_free(res, ressz); free(paths.paths[0]); free(paths.paths); } @@ -827,121 +983,187 @@ pg_search(const struct req *req, char *path) int main(void) { - int i; struct req req; - char *p, *path, *subpath; + struct itimerval itimer; + const char *path; + const char *querystring; + int i; - /* Scan our run-time environment. */ + /* Poor man's ReDoS mitigation. */ - if (NULL == (cache = getenv("CACHE_DIR"))) - cache = "/cache/man.cgi"; + itimer.it_value.tv_sec = 2; + itimer.it_value.tv_usec = 0; + itimer.it_interval.tv_sec = 2; + itimer.it_interval.tv_usec = 0; + if (setitimer(ITIMER_VIRTUAL, &itimer, NULL) == -1) { + warn("setitimer"); + pg_error_internal(); + return EXIT_FAILURE; + } - if (NULL == (progname = getenv("SCRIPT_NAME"))) - progname = ""; - - if (NULL == (css = getenv("CSS_DIR"))) - css = ""; - - if (NULL == (host = getenv("HTTP_HOST"))) - host = "localhost"; - /* - * First we change directory into the cache directory 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(cache)) { - perror(cache); - resp_bad(); - return(EXIT_FAILURE); - } + if (chdir(MAN_DIR) == -1) { + warn("MAN_DIR: %s", MAN_DIR); + pg_error_internal(); + return EXIT_FAILURE; + } memset(&req, 0, sizeof(struct req)); - pathgen(&req); + req.q.equal = 1; + parse_manpath_conf(&req); - /* Next parse out the query string. */ + /* Parse the path info and the query string. */ - if (NULL != (p = getenv("QUERY_STRING"))) - http_parse(&req, p); + if ((path = getenv("PATH_INFO")) == NULL) + path = ""; + else if (*path == '/') + path++; - /* - * 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. - */ + if (*path != '\0') { + parse_path_info(&req, path); + if (access(path, F_OK) == -1) + path = ""; + } else if ((querystring = getenv("QUERY_STRING")) != NULL) + parse_query_string(&req, querystring); - subpath = path = NULL; - req.page = PAGE__MAX; + /* Validate parsed data and add defaults. */ - if (NULL == (path = getenv("PATH_INFO")) || '\0' == *path) - req.page = PAGE_INDEX; + if (req.q.manpath == NULL) + req.q.manpath = mandoc_strdup(req.p[0]); + else if ( ! validate_manpath(&req, req.q.manpath)) { + pg_error_badrequest( + "You specified an invalid manpath."); + return EXIT_FAILURE; + } - if (NULL != path && '/' == *path && '\0' == *++path) - req.page = PAGE_INDEX; + if ( ! (NULL == req.q.arch || validate_urifrag(req.q.arch))) { + pg_error_badrequest( + "You specified an invalid architecture."); + return EXIT_FAILURE; + } - /* Resolve subpath component. */ + /* Dispatch to the three different pages. */ - if (NULL != path && NULL != (subpath = strchr(path, '/'))) - *subpath++ = '\0'; + if ('\0' != *path) + pg_show(&req, path); + else if (NULL != req.q.query) + pg_search(&req); + else + pg_index(&req); - /* 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; - } - + free(req.q.manpath); + free(req.q.arch); + free(req.q.sec); + free(req.q.query); for (i = 0; i < (int)req.psz; i++) free(req.p[i]); free(req.p); - return(EXIT_SUCCESS); + return EXIT_SUCCESS; } -static int -cmp(const void *p1, const void *p2) +/* + * If PATH_INFO is not a file name, translate it to a query. + */ +static void +parse_path_info(struct req *req, const char *path) { + char *dir; - return(strcasecmp(((const struct manpage *)p1)->names, - ((const struct manpage *)p2)->names)); + req->isquery = 0; + req->q.equal = 1; + req->q.manpath = mandoc_strdup(path); + + /* 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'; + + /* 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; + } + + /* Handle the case of name[.section] only. */ + if (req->q.manpath == NULL) { + req->q.arch = NULL; + return; + } + req->q.query = mandoc_strdup(req->q.query); + + /* Optional architecture. */ + dir = strrchr(req->q.manpath, '/'); + if (dir != NULL && strncmp(dir + 1, "man", 3) != 0) { + *dir++ = '\0'; + req->q.arch = mandoc_strdup(dir); + dir = strrchr(req->q.manpath, '/'); + } else + req->q.arch = NULL; + + /* Optional directory name. */ + if (dir != NULL && strncmp(dir + 1, "man", 3) == 0) { + *dir++ = '\0'; + free(req->q.sec); + req->q.sec = mandoc_strdup(dir + 3); + } } /* * Scan for indexable paths. */ static void -pathgen(struct req *req) +parse_manpath_conf(struct req *req) { FILE *fp; char *dp; size_t dpsz; + ssize_t len; - if (NULL == (fp = fopen("manpath.conf", "r"))) - return; + if ((fp = fopen("manpath.conf", "r")) == NULL) { + warn("%s/manpath.conf", MAN_DIR); + pg_error_internal(); + exit(EXIT_FAILURE); + } - while (NULL != (dp = fgetln(fp, &dpsz))) { + dp = NULL; + dpsz = 0; + + while ((len = getline(&dp, &dpsz, fp)) != -1) { + if (dp[len - 1] == '\n') + dp[--len] = '\0'; req->p = mandoc_realloc(req->p, (req->psz + 1) * sizeof(char *)); - req->p[req->psz++] = mandoc_strndup(dp, dpsz); + if ( ! validate_urifrag(dp)) { + warnx("%s/manpath.conf contains " + "unsafe path \"%s\"", MAN_DIR, dp); + pg_error_internal(); + exit(EXIT_FAILURE); + } + if (strchr(dp, '/') != NULL) { + warnx("%s/manpath.conf contains " + "path with slash \"%s\"", MAN_DIR, dp); + pg_error_internal(); + exit(EXIT_FAILURE); + } + req->p[req->psz++] = dp; + dp = NULL; + dpsz = 0; + } + free(dp); + + if (req->p == NULL) { + warnx("%s/manpath.conf is empty", MAN_DIR); + pg_error_internal(); + exit(EXIT_FAILURE); } }