===================================================================
RCS file: /cvs/mandoc/cgi.c,v
retrieving revision 1.10
retrieving revision 1.94
diff -u -p -r1.10 -r1.94
--- mandoc/cgi.c 2011/12/07 00:23:04 1.10
+++ mandoc/cgi.c 2014/08/17 03:24:47 1.94
@@ -1,6 +1,7 @@
-/* $Id: cgi.c,v 1.10 2011/12/07 00:23:04 kristaps Exp $ */
+/* $Id: cgi.c,v 1.94 2014/08/17 03:24:47 schwarze Exp $ */
/*
- * Copyright (c) 2011 Kristaps Dzonsons
+ * Copyright (c) 2011, 2012 Kristaps Dzonsons
+ * Copyright (c) 2014 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
@@ -14,115 +15,112 @@
* 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
+#include
#include
#include
#include
-#include "apropos_db.h"
#include "mandoc.h"
-#include "mdoc.h"
-#include "man.h"
+#include "mandoc_aux.h"
#include "main.h"
#include "manpath.h"
+#include "mansearch.h"
+#include "cgi.h"
-#ifdef __linux__
-# include
-#else
-# include
-#endif
-
-enum page {
- PAGE_INDEX,
- PAGE_SEARCH,
- PAGE_SHOW,
- PAGE__MAX
+/*
+ * A query as passed to the search function.
+ */
+struct query {
+ 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 kval {
- char *key;
- char *val;
-};
-
struct req {
- struct kval *fields;
- size_t fieldsz;
- enum page page;
+ struct query q;
+ char **p; /* array of available manpaths */
+ size_t psz; /* number of available manpaths */
};
-static int atou(const char *, unsigned *);
-static void catman(const char *);
-static void format(const char *);
+static void catman(const struct req *, const char *);
+static void format(const struct req *, const char *);
static void html_print(const char *);
static void html_putchar(char);
-static int kval_decode(char *);
-static void kval_parse(struct kval **, size_t *, char *);
-static void kval_free(struct kval *, size_t);
-static void pg_index(const struct manpaths *,
- const struct req *, char *);
-static void pg_search(const struct manpaths *,
- const struct req *, char *);
-static void pg_show(const struct manpaths *,
- 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 http_parse(struct req *, const char *);
+static void http_print(const char *);
+static void http_putchar(char);
+static void http_printquery(const struct req *, const char *);
+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(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_index(const struct req *);
-static void resp_search(struct res *, size_t, void *);
static void resp_searchform(const struct req *);
+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;
-static const char *cache;
-static const char *host;
+static const char *scriptname; /* CGI 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 - 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 *);
+
/*
- * This is just OpenBSD's strtol(3) suggestion.
- * I use it instead of strtonum(3) for portability's sake.
+ * Print a character, escaping HTML along the way.
+ * This will pass non-ASCII straight to output: be warned!
*/
-static int
-atou(const char *buf, unsigned *v)
-{
- char *ep;
- long lval;
-
- errno = 0;
- lval = strtol(buf, &ep, 10);
- if (buf[0] == '\0' || *ep != '\0')
- return(0);
- if ((errno == ERANGE && (lval == LONG_MAX ||
- lval == LONG_MIN)) ||
- (lval > UINT_MAX || lval < 0))
- return(0);
-
- *v = (unsigned int)lval;
- return(1);
-}
-
static void
html_putchar(char c)
{
@@ -146,9 +144,44 @@ html_putchar(char c)
}
}
+static void
+http_printquery(const struct req *req, const char *sep)
+{
+
+ if (NULL != req->q.query) {
+ printf("query=");
+ http_print(req->q.query);
+ }
+ if (0 == req->q.equal)
+ printf("%sapropos=1", sep);
+ if (NULL != req->q.sec) {
+ printf("%ssec=", sep);
+ http_print(req->q.sec);
+ }
+ if (NULL != req->q.arch) {
+ printf("%sarch=", sep);
+ http_print(req->q.arch);
+ }
+ if (NULL != req->q.manpath &&
+ strcmp(req->q.manpath, req->p[0])) {
+ printf("%smanpath=", sep);
+ http_print(req->q.manpath);
+ }
+}
+
+static void
+http_print(const char *p)
+{
+
+ if (NULL == p)
+ return;
+ while ('\0' != *p)
+ http_putchar(*p++);
+}
+
/*
- * Print a word, escaping HTML along the way.
- * This will pass non-ASCII straight to output: be warned!
+ * Call through to html_putchar().
+ * Accepts NULL strings.
*/
static void
html_print(const char *p)
@@ -160,95 +193,147 @@ html_print(const char *p)
html_putchar(*p++);
}
+/*
+ * Transfer the responsibility for the allocated string *val
+ * to the query structure.
+ */
static void
-kval_free(struct kval *p, size_t sz)
+set_query_attr(char **attr, char **val)
{
- int i;
- for (i = 0; i < (int)sz; i++) {
- free(p[i].key);
- free(p[i].val);
- }
- free(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
-kval_parse(struct kval **kv, size_t *kvsz, char *p)
+http_parse(struct req *req, const char *qs)
{
- char *key, *val;
- size_t sz, cur;
+ char *key, *val;
+ size_t keysz, valsz;
- cur = 0;
+ req->q.manpath = NULL;
+ req->q.arch = NULL;
+ req->q.sec = NULL;
+ req->q.query = NULL;
+ req->q.equal = 1;
- while (p && '\0' != *p) {
- while (' ' == *p)
- p++;
+ key = val = NULL;
+ while (*qs != '\0') {
- key = p;
- val = NULL;
+ /* Parse one key. */
- if (NULL != (p = strchr(p, '='))) {
- *p++ = '\0';
- val = p;
+ keysz = strcspn(qs, "=;&");
+ key = mandoc_strndup(qs, keysz);
+ qs += keysz;
+ if (*qs != '=')
+ goto next;
- sz = strcspn(p, ";&");
- /* LINTED */
- p += sz;
+ /* Parse one value. */
- if ('\0' != *p)
- *p++ = '\0';
- } else {
- p = key;
- sz = strcspn(p, ";&");
- /* LINTED */
- p += sz;
+ valsz = strcspn(++qs, ";&");
+ val = mandoc_strndup(qs, valsz);
+ qs += valsz;
- if ('\0' != *p)
- p++;
- continue;
- }
+ /* Decode and catch encoding errors. */
- if ('\0' == *key || '\0' == *val)
- continue;
+ if ( ! (http_decode(key) && http_decode(val)))
+ goto next;
- /* Just abort handling. */
+ /* Handle key-value pairs. */
- if ( ! kval_decode(key))
- return;
- if ( ! kval_decode(val))
- return;
+ if ( ! strcmp(key, "query"))
+ set_query_attr(&req->q.query, &val);
- if (*kvsz + 1 >= cur) {
- cur++;
- *kv = mandoc_realloc
- (*kv, cur * sizeof(struct kval));
+ else if ( ! strcmp(key, "apropos"))
+ req->q.equal = !strcmp(val, "0");
+
+ 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);
}
- (*kv)[(int)*kvsz].key = mandoc_strdup(key);
- (*kv)[(int)*kvsz].val = mandoc_strdup(val);
- (*kvsz)++;
+ 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++;
}
+
+ /* Fall back to the default manpath. */
+
+ if (req->q.manpath == NULL)
+ req->q.manpath = mandoc_strdup(req->p[0]);
}
+static void
+http_putchar(char c)
+{
+
+ if (isalnum((unsigned char)c)) {
+ putchar((unsigned char)c);
+ return;
+ } else if (' ' == c) {
+ putchar('+');
+ return;
+ }
+ printf("%%%.2x", c);
+}
+
/*
* HTTP-decode a string. The standard explanation is that this turns
* "%4e+foo" into "n foo" in the regular way. This is done in-place
* over the allocated string.
*/
static int
-kval_decode(char *p)
+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);
@@ -259,13 +344,13 @@ kval_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);
}
@@ -274,12 +359,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);
}
@@ -290,175 +375,324 @@ resp_begin_html(int code, const char *msg)
resp_begin_http(code, msg);
- puts("" "\n"
- "" "\n"
- " " "\n"
- " " "\n"
- " System Manpage Reference " "\n"
- " " "\n"
- " " "\n"
- "");
+ printf("\n"
+ "\n"
+ "\n"
+ " \n"
+ " \n"
+ " \n"
+ "%s \n"
+ "\n"
+ "\n"
+ "\n",
+ CSS_DIR, CSS_DIR, CUSTOMIZE_TITLE);
}
static void
resp_end_html(void)
{
- puts(" \n");
+ puts("\n"
+ "");
}
static void
resp_searchform(const struct req *req)
{
- int i;
- const char *expr, *sec, *arch;
+ int i;
- expr = sec = arch = "";
+ puts(CUSTOMIZE_BEGIN);
+ puts("");
+ printf("");
+ 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");
- puts("Malformed Query \n"
- "\n"
- " The query your entered was malformed.\n"
- " Try again from the\n"
- " main page \n"
- "
");
- 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);
- puts(" ,\n"
- " could not be found.\n"
- " Try searching from the\n"
- " main page \n"
- "
");
+ resp_begin_html(200, NULL);
+ resp_searchform(req);
+ 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);
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);
+ 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(struct res *r, size_t sz, void *arg)
+pg_searchres(const struct req *req, struct manpage *r, size_t sz)
{
- int i;
+ char *arch, *archend;
+ size_t i, iuse, isec;
+ int archprio, archpriouse;
+ int prio, priouse;
+ char sec;
+ for (i = 0; i < sz; i++) {
+ if (validate_filename(r[i].file))
+ continue;
+ fprintf(stderr, "invalid filename %s in %s database\n",
+ r[i].file, req->q.manpath);
+ pg_error_internal();
+ return;
+ }
+
if (1 == sz) {
/*
* If we have just one result, then jump there now
* without any delay.
*/
- puts("Status: 303 See Other");
- printf("Location: http://%s%s/show/%u/%u.html\n",
- host, progname,
- r[0].volume, r[0].rec);
- puts("Content-Type: text/html; charset=utf-8\n");
+ printf("Status: 303 See Other\r\n");
+ printf("Location: http://%s%s/%s/%s?",
+ HTTP_HOST, scriptname, req->q.manpath, r[0].file);
+ http_printquery(req, "&");
+ printf("\r\n"
+ "Content-Type: text/html; charset=utf-8\r\n"
+ "\r\n");
return;
}
resp_begin_html(200, NULL);
- resp_searchform((const struct req *)arg);
+ resp_searchform(req);
+ puts("");
+
+ /*
+ * 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;
+ archpriouse = 3;
+ 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 (NULL == req->q.arch) {
+ archprio =
+ (NULL == (arch = strchr(
+ r[i].file + isec, '/'))) ? 3 :
+ (NULL == (archend = strchr(
+ arch + 1, '/'))) ? 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;
}
- printf(") ");
- html_print(r[i].desc);
- puts("
");
+ resp_show(req, r[iuse].file);
}
resp_end_html();
}
-/* ARGSUSED */
static void
-pg_index(const struct manpaths *ps, const struct req *req, char *path)
+catman(const struct req *req, const char *file)
{
-
- resp_index(req);
-}
-
-static void
-catman(const char *file)
-{
FILE *f;
size_t len;
int i;
@@ -466,13 +700,13 @@ catman(const char *file)
int italic, bold;
if (NULL == (f = fopen(file, "r"))) {
- resp_baddb();
+ puts("You specified an invalid manual file.
");
return;
}
- resp_begin_html(200, NULL);
+ puts("\n"
+ "
");
- puts("");
while (NULL != (p = fgetln(f, &len))) {
bold = italic = 0;
for (i = 0; i < (int)len - 1; i++) {
@@ -583,162 +817,182 @@ catman(const char *file)
}
puts(" \n"
- "