===================================================================
RCS file: /cvs/mandoc/cgi.c,v
retrieving revision 1.10
retrieving revision 1.32
diff -u -p -r1.10 -r1.32
--- mandoc/cgi.c 2011/12/07 00:23:04 1.10
+++ mandoc/cgi.c 2011/12/15 12:05:19 1.32
@@ -1,4 +1,4 @@
-/* $Id: cgi.c,v 1.10 2011/12/07 00:23:04 kristaps Exp $ */
+/* $Id: cgi.c,v 1.32 2011/12/15 12:05:19 kristaps Exp $ */
/*
* Copyright (c) 2011 Kristaps Dzonsons
*
@@ -24,6 +24,7 @@
#include
#include
#include
+#include
#include
#include
#include
@@ -54,31 +55,43 @@ enum page {
PAGE__MAX
};
-struct kval {
- char *key;
- char *val;
+struct paths {
+ char *name;
+ char *path;
};
+/*
+ * A query as passed to the search function.
+ */
+struct query {
+ const char *arch; /* architecture */
+ const char *sec; /* manual section */
+ const char *expr; /* unparsed expression string */
+ int manroot; /* manroot index (or -1)*/
+ int whatis; /* whether whatis mode */
+ int legacy; /* whether legacy mode */
+};
+
struct req {
- struct kval *fields;
- size_t fieldsz;
+ struct query q;
+ struct paths *p;
+ size_t psz;
enum page page;
};
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 int cmp(const void *, const void *);
+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 int http_decode(char *);
+static void http_parse(struct req *, char *);
+static int pathstop(DIR *);
+static void pathgen(DIR *, char *, 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);
@@ -90,9 +103,10 @@ static void resp_index(const struct req *);
static void resp_search(struct res *, size_t, void *);
static void resp_searchform(const struct req *);
-static const char *progname;
-static const char *cache;
-static const char *host;
+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 * const pages[PAGE__MAX] = {
"index", /* PAGE_INDEX */
@@ -123,6 +137,10 @@ atou(const char *buf, unsigned *v)
return(1);
}
+/*
+ * Print a character, escaping HTML along the way.
+ * This will pass non-ASCII straight to output: be warned!
+ */
static void
html_putchar(char c)
{
@@ -147,8 +165,8 @@ html_putchar(char c)
}
/*
- * 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,31 +178,24 @@ 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;
+ char *key, *val, *manroot;
+ size_t sz;
+ int i, legacy;
- cur = 0;
+ memset(&req->q, 0, sizeof(struct query));
+ req->q.whatis = 1;
+ legacy = -1;
+ manroot = NULL;
+
while (p && '\0' != *p) {
while (' ' == *p)
p++;
@@ -218,21 +229,59 @@ kval_parse(struct kval **kv, size_t *kvsz, char *p)
/* Just abort handling. */
- if ( ! kval_decode(key))
- return;
- if ( ! kval_decode(val))
- return;
+ if ( ! http_decode(key))
+ break;
+ if ( ! http_decode(val))
+ break;
- if (*kvsz + 1 >= cur) {
- cur++;
- *kv = mandoc_realloc
- (*kv, cur * sizeof(struct kval));
- }
+ 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"))
+ manroot = val;
+ else if (0 == strcmp(key, "apropos"))
+ legacy = 0 == strcmp(val, "0");
+ else if (0 == strcmp(key, "op"))
+ req->q.whatis = 0 == strcasecmp(val, "whatis");
+ }
- (*kv)[(int)*kvsz].key = mandoc_strdup(key);
- (*kv)[(int)*kvsz].val = mandoc_strdup(val);
- (*kvsz)++;
+ /* Test for old man.cgi compatibility mode. */
+
+ if (legacy == 0) {
+ req->q.whatis = 0;
+ req->q.legacy = 1;
+ } else if (legacy > 0) {
+ req->q.legacy = 1;
+ req->q.whatis = 1;
}
+
+ /*
+ * 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;
+
+ /* Default to first manroot. */
+
+ if (NULL != manroot) {
+ for (i = 0; i < (int)req->psz; i++)
+ if (0 == strcmp(req->p[i].name, manroot))
+ break;
+ req->q.manroot = i < (int)req->psz ? i : -1;
+ }
}
/*
@@ -241,7 +290,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;
@@ -276,9 +325,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);
@@ -290,61 +339,77 @@ 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"
+ "System Manpage Reference \n"
+ "\n"
+ "\n"
+ "\n", css, css);
}
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 = "";
-
- 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, "sec"))
- sec = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "arch"))
- arch = req->fields[i].val;
-
puts("");
- printf("\n");
+ printf("\n"
+ "\n"
+ "
");
+ puts("");
}
static void
@@ -361,12 +426,12 @@ resp_error400(void)
{
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"
- "
");
+ printf("Malformed Query \n"
+ "\n"
+ "The query your entered was malformed.\n"
+ "Try again from the\n"
+ "main page .\n"
+ "
", progname);
resp_end_html();
}
@@ -377,14 +442,14 @@ resp_error404(const char *page)
resp_begin_html(404, "Not Found");
puts("Page Not Found \n"
"\n"
- " The page you're looking for, ");
- printf(" ");
+ "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"
- "
");
+ printf(",\n"
+ "could not be found.\n"
+ "Try searching from the\n"
+ "main page .\n"
+ "
", progname);
resp_end_html();
}
@@ -408,31 +473,58 @@ resp_baddb(void)
static void
resp_search(struct res *r, size_t sz, void *arg)
{
- int i;
+ int i;
+ const struct req *req;
+ req = (const struct req *)arg;
+ assert(req->q.manroot >= 0);
+
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,
+ printf("Location: http://%s%s/show/%d/%u/%u.html\n",
+ host, progname, req->q.manroot,
r[0].volume, r[0].rec);
puts("Content-Type: text/html; charset=utf-8\n");
return;
}
+ qsort(r, sz, sizeof(struct res), cmp);
+
resp_begin_html(200, NULL);
- resp_searchform((const struct req *)arg);
+ resp_searchform(req);
- if (0 == sz)
- puts("No results found.
");
+ if (0 == sz) {
+ printf("\n"
+ "No %s results found.\n",
+ req->q.whatis ? "whatis" : "apropos");
+ if (req->q.whatis) {
+ printf("(Try q.expr ? req->q.expr : "");
+ printf("&sec=");
+ html_print(req->q.sec ? req->q.sec : "");
+ printf("&arch=");
+ html_print(req->q.arch ? req->q.arch : "");
+ puts("\">apropos ?)");
+ }
+ puts("
");
+ resp_end_html();
+ return;
+ }
+ puts("
\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;
@@ -471,8 +567,10 @@ catman(const char *file)
}
resp_begin_html(200, NULL);
+ resp_searchform(req);
+ puts("\n"
+ "
");
- puts("");
while (NULL != (p = fgetln(f, &len))) {
bold = italic = 0;
for (i = 0; i < (int)len - 1; i++) {
@@ -583,6 +681,7 @@ catman(const char *file)
}
puts(" \n"
+ " \n"
"