=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.19 retrieving revision 1.20 diff -u -p -r1.19 -r1.20 --- mandoc/cgi.c 2011/12/08 22:47:09 1.19 +++ mandoc/cgi.c 2011/12/09 11:29:19 1.20 @@ -1,4 +1,4 @@ -/* $Id: cgi.c,v 1.19 2011/12/08 22:47:09 kristaps Exp $ */ +/* $Id: cgi.c,v 1.20 2011/12/09 11:29:19 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; @@ -72,8 +84,10 @@ 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 *, @@ -102,6 +116,55 @@ 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)); + 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. */ + + if (q->legacy && NULL != q->sec && 0 == strcmp(q->sec, "0")) + q->sec = NULL; +} + +/* * This is just OpenBSD's strtol(3) suggestion. * I use it instead of strtonum(3) for portability's sake. */ @@ -124,6 +187,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) { @@ -148,8 +215,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) @@ -277,9 +344,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,18 +358,18 @@ 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" + puts("\n" + "\n" + "\n" + "\n" + "\n" + "System Manpage Reference\n" + "\n" + "\n" ""); } @@ -310,57 +377,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, "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; - puts(""); printf("\n" - ""); + ""); + puts(""); } static void @@ -379,9 +431,9 @@ resp_error400(void) 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" + "The query your entered was malformed.\n" + "Try again from the\n" + "main page\n" "

", progname); resp_end_html(); } @@ -393,13 +445,13 @@ 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); printf(",\n" - " could not be found.\n" - " Try searching from the\n" - " main page\n" + "could not be found.\n" + "Try searching from the\n" + "main page\n" "

", progname); resp_end_html(); } @@ -424,13 +476,10 @@ resp_baddb(void) static void resp_search(struct res *r, size_t sz, void *arg) { - int i, whatis; - const char *ep, *sec, *arch; + int i; + struct query q; const struct req *req; - whatis = 1; - ep = sec = arch = NULL; - if (1 == sz) { /* * If we have just one result, then jump there now @@ -444,43 +493,26 @@ resp_search(struct res *r, size_t sz, void *arg) 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); resp_begin_html(200, NULL); + + req = (const struct req *)arg; resp_searchform(req); + kval_query(&q, req->fields, req->fieldsz); if (0 == sz) { puts("
\n" "No results found."); - if (whatis) { + if (q.whatis) { printf("(Try apropos?)"); } puts("
"); @@ -492,7 +524,9 @@ resp_search(struct res *r, size_t sz, void *arg) ""); for (i = 0; i < (int)sz; i++) { - printf("\n" + ""); + puts("\n" + ""); } puts("
\n" + " \n" + "", r[i].volume, r[i].rec); html_print(r[i].title); @@ -502,13 +536,15 @@ resp_search(struct res *r, size_t sz, void *arg) putchar('/'); html_print(r[i].arch); } - printf(") "); + printf(")\n" + " "); html_print(r[i].desc); - puts("
"); - resp_end_html(); } @@ -535,21 +571,21 @@ catman(const char *file) } resp_begin_http(200, NULL); - puts("" "\n" - "" "\n" - " " "\n" - " " "\n" - " " "\n" - " System Manpage Reference" "\n" - " " "\n" - " " "\n" - ""); + 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++) { @@ -784,41 +820,23 @@ static void pg_search(const struct manpaths *ps, const struct req *req, char *path) { size_t tt; - int i, sz, rc, whatis; + int i, sz, rc; const char *ep, *start; char **cp; struct opts opt; struct expr *expr; + struct query q; - expr = NULL; - cp = NULL; - ep = NULL; - sz = 0; - whatis = 1; - + 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, "query")) - 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, "sektion")) - opt.cat = req->fields[i].val; - else if (0 == strcmp(req->fields[i].key, "arch")) - opt.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"); + ep = q.expr; + opt.arch = q.arch; + opt.cat = q.sec; + rc = -1; + sz = 0; + cp = NULL; - if (NULL != opt.cat && 0 == strcmp(opt.cat, "0")) - opt.cat = NULL; - /* * Poor man's tokenisation. * Just break apart by spaces. @@ -840,15 +858,13 @@ 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. */ - expr = whatis ? termcomp(sz, cp, &tt) : - exprcomp(sz, cp, &tt); + expr = q.whatis ? termcomp(sz, cp, &tt) : + exprcomp(sz, cp, &tt); if (NULL != expr) rc = apropos_search