version 1.80, 2014/07/22 18:14:13 |
version 1.88, 2014/07/25 18:20:39 |
|
|
* A query as passed to the search function. |
* A query as passed to the search function. |
*/ |
*/ |
struct query { |
struct query { |
const char *manpath; /* desired manual directory */ |
char *manpath; /* desired manual directory */ |
const char *arch; /* architecture */ |
char *arch; /* architecture */ |
const char *sec; /* manual section */ |
char *sec; /* manual section */ |
const char *expr; /* unparsed expression string */ |
char *query; /* unparsed query expression */ |
int equal; /* match whole names, not substrings */ |
int equal; /* match whole names, not substrings */ |
}; |
}; |
|
|
|
|
}; |
}; |
|
|
static void catman(const struct req *, 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 format(const struct req *, const char *); |
static void html_print(const char *); |
static void html_print(const char *); |
static void html_printquery(const struct req *); |
static void html_printquery(const struct req *); |
static void html_putchar(char); |
static void html_putchar(char); |
static int http_decode(char *); |
static int http_decode(char *); |
static void http_parse(struct req *, char *); |
static void http_parse(struct req *, const char *); |
static void http_print(const char *); |
static void http_print(const char *); |
static void http_putchar(char); |
static void http_putchar(char); |
static void http_printquery(const struct req *); |
static void http_printquery(const struct req *); |
Line 77 static void resp_begin_http(int, const char *); |
|
Line 76 static void resp_begin_http(int, const char *); |
|
static void resp_end_html(void); |
static void resp_end_html(void); |
static void resp_searchform(const struct req *); |
static void resp_searchform(const struct req *); |
static void resp_show(const struct req *, const char *); |
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 *scriptname; /* CGI script name */ |
static const char *scriptname; /* CGI script name */ |
|
|
|
|
http_printquery(const struct req *req) |
http_printquery(const struct req *req) |
{ |
{ |
|
|
if (NULL != req->q.manpath) { |
if (NULL != req->q.query) { |
printf("&manpath="); |
printf("query="); |
http_print(req->q.manpath); |
http_print(req->q.query); |
} |
} |
|
if (0 == req->q.equal) |
|
printf("&apropos=1"); |
if (NULL != req->q.sec) { |
if (NULL != req->q.sec) { |
printf("&sec="); |
printf("&sec="); |
http_print(req->q.sec); |
http_print(req->q.sec); |
Line 157 http_printquery(const struct req *req) |
|
Line 162 http_printquery(const struct req *req) |
|
printf("&arch="); |
printf("&arch="); |
http_print(req->q.arch); |
http_print(req->q.arch); |
} |
} |
if (NULL != req->q.expr) { |
if (NULL != req->q.manpath && |
printf("&query="); |
strcmp(req->q.manpath, req->p[0])) { |
http_print(req->q.expr); |
printf("&manpath="); |
|
http_print(req->q.manpath); |
} |
} |
if (0 == req->q.equal) |
|
printf("&apropos=1"); |
|
} |
} |
|
|
static void |
static void |
html_printquery(const struct req *req) |
html_printquery(const struct req *req) |
{ |
{ |
|
|
if (NULL != req->q.manpath) { |
if (NULL != req->q.query) { |
printf("&manpath="); |
printf("query="); |
html_print(req->q.manpath); |
html_print(req->q.query); |
} |
} |
|
if (0 == req->q.equal) |
|
printf("&apropos=1"); |
if (NULL != req->q.sec) { |
if (NULL != req->q.sec) { |
printf("&sec="); |
printf("&sec="); |
html_print(req->q.sec); |
html_print(req->q.sec); |
Line 181 html_printquery(const struct req *req) |
|
Line 187 html_printquery(const struct req *req) |
|
printf("&arch="); |
printf("&arch="); |
html_print(req->q.arch); |
html_print(req->q.arch); |
} |
} |
if (NULL != req->q.expr) { |
if (NULL != req->q.manpath && |
printf("&query="); |
strcmp(req->q.manpath, req->p[0])) { |
html_print(req->q.expr); |
printf("&manpath="); |
|
html_print(req->q.manpath); |
} |
} |
if (0 == req->q.equal) |
|
printf("&apropos=1"); |
|
} |
} |
|
|
static void |
static void |
Line 214 html_print(const char *p) |
|
Line 219 html_print(const char *p) |
|
} |
} |
|
|
/* |
/* |
* Parse out key-value pairs from an HTTP request variable. |
* Transfer the responsibility for the allocated string *val |
* This can be either a cookie or a POST/GET string, although man.cgi |
* to the query structure. |
* uses only GET for simplicity. |
|
*/ |
*/ |
static void |
static void |
http_parse(struct req *req, char *p) |
set_query_attr(char **attr, char **val) |
{ |
{ |
char *key, *val; |
|
|
|
memset(&req->q, 0, sizeof(struct query)); |
free(*attr); |
req->q.manpath = req->p[0]; |
if (**val == '\0') { |
req->q.equal = 1; |
*attr = NULL; |
|
free(*val); |
|
} else |
|
*attr = *val; |
|
*val = NULL; |
|
} |
|
|
while ('\0' != *p) { |
/* |
key = p; |
* Parse the QUERY_STRING for key-value pairs |
val = NULL; |
* and store the values into the query structure. |
|
*/ |
|
static void |
|
http_parse(struct req *req, const char *qs) |
|
{ |
|
char *key, *val; |
|
size_t keysz, valsz; |
|
|
p += (int)strcspn(p, ";&"); |
req->q.manpath = NULL; |
if ('\0' != *p) |
req->q.arch = NULL; |
*p++ = '\0'; |
req->q.sec = NULL; |
if (NULL != (val = strchr(key, '='))) |
req->q.query = NULL; |
*val++ = '\0'; |
req->q.equal = 1; |
|
|
if ('\0' == *key || NULL == val || '\0' == *val) |
key = val = NULL; |
continue; |
while (*qs != '\0') { |
|
|
/* Just abort handling. */ |
/* Parse one key. */ |
|
|
if ( ! http_decode(key)) |
keysz = strcspn(qs, "=;&"); |
break; |
key = mandoc_strndup(qs, keysz); |
if (NULL != val && ! http_decode(val)) |
qs += keysz; |
break; |
if (*qs != '=') |
|
goto next; |
|
|
if (0 == strcmp(key, "query")) |
/* Parse one value. */ |
req->q.expr = val; |
|
else if (0 == strcmp(key, "manpath")) { |
valsz = strcspn(++qs, ";&"); |
|
val = mandoc_strndup(qs, valsz); |
|
qs += valsz; |
|
|
|
/* Decode and catch encoding errors. */ |
|
|
|
if ( ! (http_decode(key) && http_decode(val))) |
|
goto next; |
|
|
|
/* Handle key-value pairs. */ |
|
|
|
if ( ! strcmp(key, "query")) |
|
set_query_attr(&req->q.query, &val); |
|
|
|
else if ( ! strcmp(key, "apropos")) |
|
req->q.equal = !strcmp(val, "0"); |
|
|
|
else if ( ! strcmp(key, "manpath")) { |
#ifdef COMPAT_OLDURI |
#ifdef COMPAT_OLDURI |
if (0 == strncmp(val, "OpenBSD ", 8)) { |
if ( ! strncmp(val, "OpenBSD ", 8)) { |
val[7] = '-'; |
val[7] = '-'; |
if ('C' == val[8]) |
if ('C' == val[8]) |
val[8] = 'c'; |
val[8] = 'c'; |
} |
} |
#endif |
#endif |
req->q.manpath = val; |
set_query_attr(&req->q.manpath, &val); |
} else if (0 == strcmp(key, "apropos")) |
} |
req->q.equal = !strcmp(val, "0"); |
|
else if (0 == strcmp(key, "sec")) { |
else if ( ! (strcmp(key, "sec") |
if (strcmp(val, "0")) |
|
req->q.sec = val; |
|
#ifdef COMPAT_OLDURI |
#ifdef COMPAT_OLDURI |
} else if (0 == strcmp(key, "sektion")) { |
&& strcmp(key, "sektion") |
if (strcmp(val, "0")) |
|
req->q.sec = val; |
|
#endif |
#endif |
} else if (0 == strcmp(key, "arch")) { |
)) { |
if (strcmp(val, "default")) |
if ( ! strcmp(val, "0")) |
req->q.arch = val; |
*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 |
static void |
Line 389 resp_searchform(const struct req *req) |
|
Line 443 resp_searchform(const struct req *req) |
|
|
|
printf( "<TABLE><TR><TD>\n" |
printf( "<TABLE><TR><TD>\n" |
"<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\""); |
"<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\""); |
if (NULL != req->q.expr) |
if (NULL != req->q.query) |
html_print(req->q.expr); |
html_print(req->q.query); |
puts("\" SIZE=\"40\">"); |
puts("\" SIZE=\"40\">"); |
|
|
/* Write submission and reset buttons. */ |
/* Write submission and reset buttons. */ |
Line 403 resp_searchform(const struct req *req) |
|
Line 457 resp_searchform(const struct req *req) |
|
printf( "</TD><TD>\n" |
printf( "</TD><TD>\n" |
"<INPUT TYPE=\"radio\" "); |
"<INPUT TYPE=\"radio\" "); |
if (req->q.equal) |
if (req->q.equal) |
printf("CHECKED "); |
printf("CHECKED=\"checked\" "); |
printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n" |
printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n" |
"<LABEL FOR=\"show\">Show named manual page</LABEL>\n"); |
"<LABEL FOR=\"show\">Show named manual page</LABEL>\n"); |
|
|
/* Write section selector. */ |
/* Write section selector. */ |
|
|
printf( "</TD></TR><TR><TD>\n" |
puts( "</TD></TR><TR><TD>\n" |
"<SELECT NAME=\"sec\">"); |
"<SELECT NAME=\"sec\">"); |
for (i = 0; i < sec_MAX; i++) { |
for (i = 0; i < sec_MAX; i++) { |
printf("<OPTION VALUE=\"%s\"", sec_numbers[i]); |
printf("<OPTION VALUE=\"%s\"", sec_numbers[i]); |
if (NULL != req->q.sec && |
if (NULL != req->q.sec && |
0 == strcmp(sec_numbers[i], req->q.sec)) |
0 == strcmp(sec_numbers[i], req->q.sec)) |
printf(" SELECTED"); |
printf(" SELECTED=\"selected\""); |
printf(">%s</OPTION>\n", sec_names[i]); |
printf(">%s</OPTION>\n", sec_names[i]); |
} |
} |
puts("</SELECT>"); |
puts("</SELECT>"); |
|
|
/* Write architecture selector. */ |
/* Write architecture selector. */ |
|
|
puts("<SELECT NAME=\"arch\">"); |
printf( "<SELECT NAME=\"arch\">\n" |
|
"<OPTION VALUE=\"default\""); |
|
if (NULL == req->q.arch) |
|
printf(" SELECTED=\"selected\""); |
|
puts(">All Architectures</OPTION>"); |
for (i = 0; i < arch_MAX; i++) { |
for (i = 0; i < arch_MAX; i++) { |
printf("<OPTION VALUE=\"%s\"", arch_names[i]); |
printf("<OPTION VALUE=\"%s\"", arch_names[i]); |
if (NULL != req->q.arch && |
if (NULL != req->q.arch && |
0 == strcmp(arch_names[i], req->q.arch)) |
0 == strcmp(arch_names[i], req->q.arch)) |
printf(" SELECTED"); |
printf(" SELECTED=\"selected\""); |
printf(">%s</OPTION>\n", arch_names[i]); |
printf(">%s</OPTION>\n", arch_names[i]); |
} |
} |
puts("</SELECT>"); |
puts("</SELECT>"); |
Line 440 resp_searchform(const struct req *req) |
|
Line 498 resp_searchform(const struct req *req) |
|
printf("<OPTION "); |
printf("<OPTION "); |
if (NULL == req->q.manpath ? 0 == i : |
if (NULL == req->q.manpath ? 0 == i : |
0 == strcmp(req->q.manpath, req->p[i])) |
0 == strcmp(req->q.manpath, req->p[i])) |
printf("SELECTED "); |
printf("SELECTED=\"selected\" "); |
printf("VALUE=\""); |
printf("VALUE=\""); |
html_print(req->p[i]); |
html_print(req->p[i]); |
printf("\">"); |
printf("\">"); |
Line 455 resp_searchform(const struct req *req) |
|
Line 513 resp_searchform(const struct req *req) |
|
printf( "</TD><TD>\n" |
printf( "</TD><TD>\n" |
"<INPUT TYPE=\"radio\" "); |
"<INPUT TYPE=\"radio\" "); |
if (0 == req->q.equal) |
if (0 == req->q.equal) |
printf("CHECKED "); |
printf("CHECKED=\"checked\" "); |
printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n" |
printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n" |
"<LABEL FOR=\"search\">Search with apropos query</LABEL>\n"); |
"<LABEL FOR=\"search\">Search with apropos query</LABEL>\n"); |
|
|
Line 513 pg_index(const struct req *req) |
|
Line 571 pg_index(const struct req *req) |
|
resp_begin_html(200, NULL); |
resp_begin_html(200, NULL); |
resp_searchform(req); |
resp_searchform(req); |
printf("<P>\n" |
printf("<P>\n" |
"This web interface is documented in the " |
"This web interface is documented in the\n" |
"<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A> " |
"<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A>\n" |
"manual, and the " |
"manual, and the\n" |
"<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A> " |
"<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A>\n" |
"manual explains the query syntax.\n" |
"manual explains the query syntax.\n" |
"</P>\n", |
"</P>\n", |
scriptname, scriptname); |
scriptname, scriptname); |
Line 559 pg_error_internal(void) |
|
Line 617 pg_error_internal(void) |
|
static void |
static void |
pg_searchres(const struct req *req, struct manpage *r, size_t sz) |
pg_searchres(const struct req *req, struct manpage *r, size_t sz) |
{ |
{ |
|
char *arch, *archend; |
size_t i, iuse, isec; |
size_t i, iuse, isec; |
|
int archprio, archpriouse; |
int prio, priouse; |
int prio, priouse; |
char sec; |
char sec; |
|
|
Line 587 pg_searchres(const struct req *req, struct manpage *r, |
|
Line 647 pg_searchres(const struct req *req, struct manpage *r, |
|
return; |
return; |
} |
} |
|
|
qsort(r, sz, sizeof(struct manpage), cmp); |
|
|
|
resp_begin_html(200, NULL); |
resp_begin_html(200, NULL); |
resp_searchform(req); |
resp_searchform(req); |
puts("<DIV CLASS=\"results\">"); |
puts("<DIV CLASS=\"results\">"); |
Line 622 pg_searchres(const struct req *req, struct manpage *r, |
|
Line 680 pg_searchres(const struct req *req, struct manpage *r, |
|
puts("<HR>"); |
puts("<HR>"); |
iuse = 0; |
iuse = 0; |
priouse = 10; |
priouse = 10; |
|
archpriouse = 3; |
for (i = 0; i < sz; i++) { |
for (i = 0; i < sz; i++) { |
isec = strcspn(r[i].file, "123456789"); |
isec = strcspn(r[i].file, "123456789"); |
sec = r[i].file[isec]; |
sec = r[i].file[isec]; |
if ('\0' == sec) |
if ('\0' == sec) |
continue; |
continue; |
prio = sec_prios[sec - '1']; |
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) |
if (prio >= priouse) |
continue; |
continue; |
priouse = prio; |
priouse = prio; |
Line 800 format(const struct req *req, const char *file) |
|
Line 876 format(const struct req *req, const char *file) |
|
} |
} |
|
|
snprintf(opts, sizeof(opts), "fragment,man=%s?" |
snprintf(opts, sizeof(opts), "fragment,man=%s?" |
"manpath=%s&query=%%N&sec=%%S&arch=%s", |
"manpath=%s&query=%%N&sec=%%S%s%s", |
scriptname, req->q.manpath, |
scriptname, req->q.manpath, |
|
req->q.arch ? "&arch=" : "", |
req->q.arch ? req->q.arch : ""); |
req->q.arch ? req->q.arch : ""); |
|
|
mparse_result(mp, &mdoc, &man, NULL); |
mparse_result(mp, &mdoc, &man, NULL); |
Line 838 resp_show(const struct req *req, const char *file) |
|
Line 915 resp_show(const struct req *req, const char *file) |
|
} |
} |
|
|
static void |
static void |
pg_show(struct req *req, const char *path) |
pg_show(struct req *req, const char *fullpath) |
{ |
{ |
char *sub; |
char *manpath; |
|
const char *file; |
|
|
if (NULL == path || NULL == (sub = strchr(path, '/'))) { |
if ((file = strchr(fullpath, '/')) == NULL) { |
pg_error_badrequest( |
pg_error_badrequest( |
"You did not specify a page to show."); |
"You did not specify a page to show."); |
return; |
return; |
} |
} |
*sub++ = '\0'; |
manpath = mandoc_strndup(fullpath, file - fullpath); |
|
file++; |
|
|
if ( ! validate_manpath(req, path)) { |
if ( ! validate_manpath(req, manpath)) { |
pg_error_badrequest( |
pg_error_badrequest( |
"You specified an invalid manpath."); |
"You specified an invalid manpath."); |
|
free(manpath); |
return; |
return; |
} |
} |
|
|
Line 861 pg_show(struct req *req, const char *path) |
|
Line 941 pg_show(struct req *req, const char *path) |
|
* relative to the manpath root. |
* relative to the manpath root. |
*/ |
*/ |
|
|
if (-1 == chdir(path)) { |
if (chdir(manpath) == -1) { |
fprintf(stderr, "chdir %s: %s\n", |
fprintf(stderr, "chdir %s: %s\n", |
path, strerror(errno)); |
manpath, strerror(errno)); |
pg_error_internal(); |
pg_error_internal(); |
|
free(manpath); |
return; |
return; |
} |
} |
|
|
if ( ! validate_filename(sub)) { |
if (strcmp(manpath, "mandoc")) { |
|
free(req->q.manpath); |
|
req->q.manpath = manpath; |
|
} else |
|
free(manpath); |
|
|
|
if ( ! validate_filename(file)) { |
pg_error_badrequest( |
pg_error_badrequest( |
"You specified an invalid manual file."); |
"You specified an invalid manual file."); |
return; |
return; |
} |
} |
|
|
if (strcmp(path, "mandoc")) |
|
req->q.manpath = path; |
|
|
|
resp_begin_html(200, NULL); |
resp_begin_html(200, NULL); |
resp_searchform(req); |
resp_searchform(req); |
resp_show(req, sub); |
resp_show(req, file); |
resp_end_html(); |
resp_end_html(); |
} |
} |
|
|
Line 921 pg_search(const struct req *req) |
|
Line 1005 pg_search(const struct req *req) |
|
* Yes, this is half-ass. But it works for now. |
* Yes, this is half-ass. But it works for now. |
*/ |
*/ |
|
|
ep = req->q.expr; |
ep = req->q.query; |
while (ep && isspace((unsigned char)*ep)) |
while (ep && isspace((unsigned char)*ep)) |
ep++; |
ep++; |
|
|
|
|
{ |
{ |
struct req req; |
struct req req; |
const char *path; |
const char *path; |
char *querystring; |
const char *querystring; |
int i; |
int i; |
|
|
/* Scan our run-time environment. */ |
/* Scan our run-time environment. */ |
|
|
|
|
if ('\0' != *path) |
if ('\0' != *path) |
pg_show(&req, path); |
pg_show(&req, path); |
else if (NULL != req.q.expr) |
else if (NULL != req.q.query) |
pg_search(&req); |
pg_search(&req); |
else |
else |
pg_index(&req); |
pg_index(&req); |
|
|
|
free(req.q.manpath); |
|
free(req.q.arch); |
|
free(req.q.sec); |
|
free(req.q.query); |
for (i = 0; i < (int)req.psz; i++) |
for (i = 0; i < (int)req.psz; i++) |
free(req.p[i]); |
free(req.p[i]); |
free(req.p); |
free(req.p); |
return(EXIT_SUCCESS); |
return(EXIT_SUCCESS); |
} |
|
|
|
static int |
|
cmp(const void *p1, const void *p2) |
|
{ |
|
|
|
return(strcasecmp(((const struct manpage *)p1)->names, |
|
((const struct manpage *)p2)->names)); |
|
} |
} |
|
|
/* |
/* |