===================================================================
RCS file: /cvs/mandoc/cgi.c,v
retrieving revision 1.10
retrieving revision 1.23
diff -u -p -r1.10 -r1.23
--- mandoc/cgi.c 2011/12/07 00:23:04 1.10
+++ mandoc/cgi.c 2011/12/10 10:59:21 1.23
@@ -1,4 +1,4 @@
-/* $Id: cgi.c,v 1.10 2011/12/07 00:23:04 kristaps Exp $ */
+/* $Id: cgi.c,v 1.23 2011/12/10 10:59:21 kristaps Exp $ */
/*
* Copyright (c) 2011 Kristaps Dzonsons
*
@@ -54,6 +54,18 @@ enum page {
PAGE__MAX
};
+/*
+ * A query as passed to the search function.
+ * See kval_query() on how this is parsed.
+ */
+struct query {
+ const char *arch; /* architecture */
+ const char *sec; /* manual section */
+ const char *expr; /* unparsed expression string */
+ int whatis; /* whether whatis mode */
+ int legacy; /* whether legacy mode */
+};
+
struct kval {
char *key;
char *val;
@@ -67,12 +79,15 @@ struct req {
static int atou(const char *, unsigned *);
static void catman(const char *);
+static int cmp(const void *, const void *);
static void format(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 kval_parse(struct kval **, size_t *, char *);
+static void kval_query(struct query *,
+ const struct kval *, size_t);
static void pg_index(const struct manpaths *,
const struct req *, char *);
static void pg_search(const struct manpaths *,
@@ -101,6 +116,63 @@ static const char * const pages[PAGE__MAX] = {
};
/*
+ * Initialise and parse a query structure from input.
+ * This accomodates for mdocml's man.cgi and also for legacy man.cgi
+ * input keys ("sektion" and "apropos").
+ * Note that legacy mode has some quirks: if apropos legacy mode is
+ * detected, we unset the section and architecture string.
+ */
+static void
+kval_query(struct query *q, const struct kval *fields, size_t sz)
+{
+ int i, legacy;
+
+ memset(q, 0, sizeof(struct query));
+ q->whatis = 1;
+ legacy = -1;
+
+ for (i = 0; i < (int)sz; i++)
+ if (0 == strcmp(fields[i].key, "expr"))
+ q->expr = fields[i].val;
+ else if (0 == strcmp(fields[i].key, "query"))
+ q->expr = fields[i].val;
+ else if (0 == strcmp(fields[i].key, "sec"))
+ q->sec = fields[i].val;
+ else if (0 == strcmp(fields[i].key, "sektion"))
+ q->sec = fields[i].val;
+ else if (0 == strcmp(fields[i].key, "arch"))
+ q->arch = fields[i].val;
+ else if (0 == strcmp(fields[i].key, "apropos"))
+ legacy = 0 == strcmp
+ (fields[i].val, "0");
+ else if (0 == strcmp(fields[i].key, "op"))
+ q->whatis = 0 == strcasecmp
+ (fields[i].val, "whatis");
+
+ /* Test for old man.cgi compatibility mode. */
+
+ if (legacy == 0) {
+ q->whatis = 0;
+ q->legacy = 1;
+ } else if (legacy > 0) {
+ q->legacy = 1;
+ q->whatis = 1;
+ }
+
+ /*
+ * Section "0" means no section when in legacy mode.
+ * For some man.cgi scripts, "default" arch is none.
+ */
+
+ if (q->legacy && NULL != q->sec)
+ if (0 == strcmp(q->sec, "0"))
+ q->sec = NULL;
+ if (q->legacy && NULL != q->arch)
+ if (0 == strcmp(q->arch, "default"))
+ q->arch = NULL;
+}
+
+/*
* This is just OpenBSD's strtol(3) suggestion.
* I use it instead of strtonum(3) for portability's sake.
*/
@@ -123,6 +195,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 +223,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)
@@ -276,9 +352,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,16 +366,18 @@ resp_begin_html(int code, const char *msg)
resp_begin_http(code, msg);
- puts("" "\n"
- "" "\n"
- " " "\n"
- " " "\n"
- " System Manpage Reference " "\n"
- " " "\n"
- " " "\n"
+ puts("\n"
+ "\n"
+ "\n"
+ " \n"
+ " \n"
+ "System Manpage Reference \n"
+ "\n"
+ "\n"
"");
}
@@ -307,44 +385,42 @@ 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;
+ struct query q;
- expr = sec = arch = "";
+ kval_query(&q, req->fields, req->fieldsz);
- 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"
+ "Search Parameters \n"
+ " or \n"
+ " for manuals satisfying \n"
+ " , section "
+ " , arch "
+ " .\n"
+ " \n"
+ " \n"
+ "");
+ puts("");
}
static void
@@ -361,12 +437,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 +453,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,7 +484,9 @@ resp_baddb(void)
static void
resp_search(struct res *r, size_t sz, void *arg)
{
- int i;
+ int i;
+ struct query q;
+ const struct req *req;
if (1 == sz) {
/*
@@ -423,14 +501,41 @@ resp_search(struct res *r, size_t sz, void *arg)
return;
}
+ qsort(r, sz, sizeof(struct res), cmp);
+
resp_begin_html(200, NULL);
- resp_searchform((const struct req *)arg);
- if (0 == sz)
- puts("No results found.
");
+ req = (const struct req *)arg;
+ resp_searchform(req);
+ kval_query(&q, req->fields, req->fieldsz);
+ if (0 == sz) {
+ printf("\n"
+ "No %s results found.",
+ q.whatis ? "whatis" : "apropos");
+ if (q.whatis) {
+ printf("(Try apropos ?)");
+ }
+ puts("
");
+ resp_end_html();
+ return;
+ }
+
+ puts("
\n"
+ "");
resp_end_html();
}
@@ -470,9 +579,22 @@ catman(const char *file)
return;
}
- resp_begin_html(200, NULL);
+ resp_begin_http(200, NULL);
+ puts("\n"
+ "\n"
+ "\n"
+ " \n"
+ " \n"
+ "System Manpage Reference \n"
+ "\n"
+ "\n"
+ "\n"
+ "");
- puts("");
while (NULL != (p = fgetln(f, &len))) {
bold = italic = 0;
for (i = 0; i < (int)len - 1; i++) {
@@ -614,9 +736,9 @@ format(const char *file)
return;
}
- snprintf(opts, sizeof(opts), "style=/style.css,"
+ snprintf(opts, sizeof(opts), "style=/man.css,"
"man=%s/search.html?sec=%%S&expr=%%N,"
- "includes=/cgi-bin/man.cgi/usr/include/%%I",
+ /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,
progname);
mparse_result(mp, &mdoc, &man);
@@ -691,7 +813,7 @@ pg_show(const struct manpaths *ps, const struct req *r
else if (NULL == memchr(fn, '\0', val.size - (fn - cp)))
resp_baddb();
else {
- strlcpy(file, ps->paths[vol], MAXPATHLEN);
+ strlcpy(file, cache, MAXPATHLEN);
strlcat(file, "/", MAXPATHLEN);
strlcat(file, fn, MAXPATHLEN);
if (0 == strcmp(cp, "cat"))
@@ -712,21 +834,17 @@ pg_search(const struct manpaths *ps, const struct req
char **cp;
struct opts opt;
struct expr *expr;
+ struct query q;
- expr = NULL;
- cp = NULL;
- ep = NULL;
- sz = 0;
-
+ kval_query(&q, req->fields, req->fieldsz);
memset(&opt, 0, sizeof(struct opts));
- for (sz = 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, "sec"))
- opt.cat = req->fields[i].val;
- else if (0 == strcmp(req->fields[i].key, "arch"))
- opt.arch = req->fields[i].val;
+ ep = q.expr;
+ opt.arch = q.arch;
+ opt.cat = q.sec;
+ rc = -1;
+ sz = 0;
+ cp = NULL;
/*
* Poor man's tokenisation.
@@ -749,14 +867,15 @@ pg_search(const struct manpaths *ps, const struct req
ep++;
}
- rc = -1;
-
/*
* Pump down into apropos backend.
* The resp_search() function is called with the results.
*/
- if (NULL != (expr = exprcomp(sz, cp, &tt)))
+ expr = q.whatis ? termcomp(sz, cp, &tt) :
+ exprcomp(sz, cp, &tt);
+
+ if (NULL != expr)
rc = apropos_search
(ps->sz, ps->paths, &opt,
expr, tt, (void *)req, resp_search);
@@ -865,3 +984,12 @@ main(void)
return(EXIT_SUCCESS);
}
+
+static int
+cmp(const void *p1, const void *p2)
+{
+
+ return(strcasecmp(((const struct res *)p1)->title,
+ ((const struct res *)p2)->title));
+}
+