X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/2671d8b5f928661e34f3b3a25984aa41fadeef1c..fa1118391546bb5404249b79fd20ebc72f5e4bab:/cgi.c?ds=sidebyside
diff --git a/cgi.c b/cgi.c
index 755318b9..284e4883 100644
--- a/cgi.c
+++ b/cgi.c
@@ -1,6 +1,7 @@
-/* $Id: cgi.c,v 1.19 2011/12/08 22:47:09 kristaps Exp $ */
+/* $Id: cgi.c,v 1.61 2014/07/10 00:52:50 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
@@ -18,34 +19,20 @@
#include "config.h"
#endif
-#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"
-
-#ifdef __linux__
-# include
-#else
-# include
-#endif
+#include "mansearch.h"
enum page {
PAGE_INDEX,
@@ -54,46 +41,56 @@ enum page {
PAGE__MAX
};
-struct kval {
- char *key;
- char *val;
+/*
+ * A query as passed to the search function.
+ */
+struct query {
+ const char *manpath; /* desired manual directory */
+ const char *arch; /* architecture */
+ const char *sec; /* manual section */
+ const char *expr; /* unparsed expression string */
+ int legacy; /* whether legacy mode */
};
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 */
+ enum page page;
};
-static int atou(const char *, unsigned *);
-static void catman(const char *);
+static void catman(const struct req *, const char *);
static int cmp(const void *, const void *);
-static void format(const char *);
+static void format(const struct req *, const char *);
static void html_print(const char *);
+static void html_printquery(const struct req *);
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 *, 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_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_search(struct res *, size_t, void *);
+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 *progname;
-static const char *cache;
-static const char *host;
+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 */
@@ -102,28 +99,9 @@ static const char * const pages[PAGE__MAX] = {
};
/*
- * 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)
{
@@ -147,9 +125,63 @@ html_putchar(char c)
}
}
+static void
+http_printquery(const struct req *req)
+{
+
+ if (NULL != req->q.manpath) {
+ printf("&manpath=");
+ http_print(req->q.manpath);
+ }
+ 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 : "");
+ }
+}
+
+static void
+html_printquery(const struct req *req)
+{
+
+ if (NULL != req->q.manpath) {
+ printf("&manpath=");
+ html_print(req->q.manpath);
+ }
+ 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++);
+}
+
/*
- * 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)
@@ -161,79 +193,86 @@ html_print(const char *p)
html_putchar(*p++);
}
-static void
-kval_free(struct kval *p, size_t sz)
-{
- int i;
-
- for (i = 0; i < (int)sz; i++) {
- free(p[i].key);
- free(p[i].val);
- }
- free(p);
-}
-
/*
* 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.
*/
static void
-kval_parse(struct kval **kv, size_t *kvsz, char *p)
+http_parse(struct req *req, char *p)
{
char *key, *val;
- size_t sz, cur;
+ int legacy;
- cur = 0;
-
- while (p && '\0' != *p) {
- while (' ' == *p)
- p++;
+ memset(&req->q, 0, sizeof(struct query));
+ req->q.manpath = req->p[0];
+ legacy = -1;
+ while ('\0' != *p) {
key = p;
val = NULL;
- if (NULL != (p = strchr(p, '='))) {
+ p += (int)strcspn(p, ";&");
+ if ('\0' != *p)
*p++ = '\0';
- val = p;
-
- sz = strcspn(p, ";&");
- /* LINTED */
- p += sz;
-
- if ('\0' != *p)
- *p++ = '\0';
- } else {
- p = key;
- sz = strcspn(p, ";&");
- /* LINTED */
- p += sz;
-
- if ('\0' != *p)
- p++;
- continue;
- }
+ if (NULL != (val = strchr(key, '=')))
+ *val++ = '\0';
- if ('\0' == *key || '\0' == *val)
+ if ('\0' == *key || NULL == val || '\0' == *val)
continue;
/* Just abort handling. */
- if ( ! kval_decode(key))
- return;
- if ( ! kval_decode(val))
- return;
+ if ( ! http_decode(key))
+ break;
+ if (NULL != val && ! http_decode(val))
+ break;
+
+ 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.manpath = val;
+ else if (0 == strcmp(key, "apropos"))
+ legacy = 0 == strcmp(val, "0");
+ }
- if (*kvsz + 1 >= cur) {
- cur++;
- *kv = mandoc_realloc
- (*kv, cur * sizeof(struct kval));
- }
+ /* Test for old man.cgi compatibility mode. */
- (*kv)[(int)*kvsz].key = mandoc_strdup(key);
- (*kv)[(int)*kvsz].val = mandoc_strdup(val);
- (*kvsz)++;
+ 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
+http_putchar(char c)
+{
+
+ if (isalnum((unsigned char)c)) {
+ putchar((unsigned char)c);
+ return;
+ } else if (' ' == c) {
+ putchar('+');
+ return;
}
+ printf("%%%.2x", c);
}
/*
@@ -242,7 +281,7 @@ kval_parse(struct kval **kv, size_t *kvsz, char *p)
* over the allocated string.
*/
static int
-kval_decode(char *p)
+http_decode(char *p)
{
char hex[3];
int c;
@@ -277,9 +316,9 @@ resp_begin_http(int code, const char *msg)
if (200 != code)
printf("Status: %d %s\n", code, msg);
- puts("Content-Type: text/html; charset=utf-8" "\n"
- "Cache-Control: no-cache" "\n"
- "Pragma: no-cache" "\n"
+ puts("Content-Type: text/html; charset=utf-8\n"
+ "Cache-Control: no-cache\n"
+ "Pragma: no-cache\n"
"");
fflush(stdout);
@@ -291,145 +330,154 @@ resp_begin_html(int code, const char *msg)
resp_begin_http(code, msg);
- puts("" "\n"
- "" "\n"
- " " "\n"
- " " "\n"
- " " "\n"
- " System Manpage Reference" "\n"
- " " "\n"
- " " "\n"
- "");
+ printf("\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "System Manpage Reference\n"
+ "\n"
+ "\n"
+ "\n",
+ cssdir, cssdir);
}
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;
-
- expr = sec = arch = "";
-
- for (i = 0; i < (int)req->fieldsz; i++)
- if (0 == strcmp(req->fields[i].key, "expr"))
- expr = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "query"))
- expr = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "sec"))
- sec = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "sektion"))
- sec = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "arch"))
- arch = req->fields[i].val;
-
- if (NULL != sec && 0 == strcmp(sec, "0"))
- sec = NULL;
+ int i;
puts("");
- printf("
", scriptname);
resp_end_html();
}
static void
-resp_baddb(void)
+resp_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)
+resp_search(const struct req *req, struct manpage *r, size_t sz)
{
- int i, whatis;
- const char *ep, *sec, *arch;
- const struct req *req;
-
- whatis = 1;
- ep = sec = arch = NULL;
+ size_t i;
if (1 == sz) {
/*
@@ -437,91 +485,52 @@ resp_search(struct res *r, size_t sz, void *arg)
* 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("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");
return;
}
- req = (const struct req *)arg;
-
- for (i = 0; i < (int)req->fieldsz; i++)
- if (0 == strcmp(req->fields[i].key, "expr"))
- ep = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "query"))
- ep = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "sec"))
- sec = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "sektion"))
- sec = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "arch"))
- arch = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "apropos"))
- whatis = 0 == strcmp
- (req->fields[i].val, "0");
- else if (0 == strcmp(req->fields[i].key, "op"))
- whatis = 0 == strcasecmp
- (req->fields[i].val, "whatis");
-
- qsort(r, sz, sizeof(struct res), cmp);
+ qsort(r, sz, sizeof(struct manpage), cmp);
resp_begin_html(200, NULL);
resp_searchform(req);
-
- if (0 == sz) {
- puts("\n"
- "No results found.");
- if (whatis) {
- printf("(Try apropos?)");
- }
- puts("
");
- resp_end_html();
- return;
- }
-
- puts("\n"
- "\n"
+ "");
resp_end_html();
}
/* ARGSUSED */
static void
-pg_index(const struct manpaths *ps, const struct req *req, char *path)
+pg_index(const struct req *req, char *path)
{
resp_index(req);
}
static void
-catman(const char *file)
+catman(const struct req *req, const char *file)
{
FILE *f;
size_t len;
@@ -530,26 +539,16 @@ catman(const char *file)
int italic, bold;
if (NULL == (f = fopen(file, "r"))) {
- resp_baddb();
+ resp_error_badrequest(
+ "You specified an invalid manual file.");
return;
}
- resp_begin_http(200, NULL);
- puts("" "\n"
- "" "\n"
- " " "\n"
- " " "\n"
- " " "\n"
- " System Manpage Reference" "\n"
- " " "\n"
- " " "\n"
- "");
-
- puts("");
+ resp_begin_html(200, NULL);
+ resp_searchform(req);
+ puts("\n"
+ "
");
+
while (NULL != (p = fgetln(f, &len))) {
bold = italic = 0;
for (i = 0; i < (int)len - 1; i++) {
@@ -660,6 +659,7 @@ catman(const char *file)
}
puts("
\n"
+ "
\n"
"\n"
"");
@@ -667,7 +667,7 @@ catman(const char *file)
}
static void
-format(const char *file)
+format(const struct req *req, const char *file)
{
struct mparse *mp;
int fd;
@@ -675,161 +675,131 @@ format(const char *file)
struct man *man;
void *vp;
enum mandoclevel rc;
- char opts[MAXPATHLEN + 128];
+ 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;
}
- mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL);
+ mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_FATAL, NULL,
+ req->q.manpath);
rc = mparse_readfd(mp, fd, 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), "style=/man.css,"
- "man=%s/search.html?sec=%%S&expr=%%N,"
- /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,
- progname);
+ snprintf(opts, sizeof(opts),
+ "fragment,man=%s/search?sec=%%S&expr=Nm~^%%N$",
+ scriptname);
+
+ mparse_result(mp, &mdoc, &man, NULL);
+ if (NULL == man && NULL == mdoc) {
+ fprintf(stderr, "fatal mandoc error: %s/%s\n",
+ req->q.manpath, file);
+ resp_error_internal();
+ mparse_free(mp);
+ return;
+ }
+
+ resp_begin_html(200, NULL);
+ resp_searchform(req);
- mparse_result(mp, &mdoc, &man);
vp = html_alloc(opts);
- if (NULL != mdoc) {
- resp_begin_http(200, NULL);
+ if (NULL != mdoc)
html_mdoc(vp, mdoc);
- } else if (NULL != man) {
- resp_begin_http(200, NULL);
+ else
html_man(vp, man);
- } else
- resp_baddb();
+
+ puts("