Annotation of mandoc/cgi.c, Revision 1.60
1.60 ! schwarze 1: /* $Id: cgi.c,v 1.59 2014/07/09 16:23:01 schwarze Exp $ */
1.6 kristaps 2: /*
1.42 kristaps 3: * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.52 schwarze 4: * Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>
1.6 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18: #ifdef HAVE_CONFIG_H
19: #include "config.h"
20: #endif
21:
22: #include <ctype.h>
1.58 schwarze 23: #include <errno.h>
1.1 kristaps 24: #include <fcntl.h>
1.6 kristaps 25: #include <limits.h>
1.1 kristaps 26: #include <stdio.h>
27: #include <stdlib.h>
28: #include <string.h>
1.6 kristaps 29: #include <unistd.h>
1.1 kristaps 30:
1.4 schwarze 31: #include "mandoc.h"
1.50 schwarze 32: #include "mandoc_aux.h"
1.8 kristaps 33: #include "main.h"
1.6 kristaps 34: #include "manpath.h"
1.52 schwarze 35: #include "mansearch.h"
1.1 kristaps 36:
37: enum page {
38: PAGE_INDEX,
39: PAGE_SEARCH,
1.6 kristaps 40: PAGE_SHOW,
1.1 kristaps 41: PAGE__MAX
42: };
43:
1.20 kristaps 44: /*
45: * A query as passed to the search function.
46: */
47: struct query {
1.58 schwarze 48: const char *manpath; /* desired manual directory */
1.20 kristaps 49: const char *arch; /* architecture */
50: const char *sec; /* manual section */
51: const char *expr; /* unparsed expression string */
52: int legacy; /* whether legacy mode */
53: };
54:
1.1 kristaps 55: struct req {
1.58 schwarze 56: struct query q;
57: char **p; /* array of available manpaths */
58: size_t psz; /* number of available manpaths */
59: enum page page;
1.1 kristaps 60: };
61:
1.32 kristaps 62: static void catman(const struct req *, const char *);
1.15 kristaps 63: static int cmp(const void *, const void *);
1.32 kristaps 64: static void format(const struct req *, const char *);
1.6 kristaps 65: static void html_print(const char *);
1.36 kristaps 66: static void html_printquery(const struct req *);
1.10 kristaps 67: static void html_putchar(char);
1.24 kristaps 68: static int http_decode(char *);
1.26 kristaps 69: static void http_parse(struct req *, char *);
1.36 kristaps 70: static void http_print(const char *);
71: static void http_putchar(char);
72: static void http_printquery(const struct req *);
1.54 schwarze 73: static void pathgen(struct req *);
1.24 kristaps 74: static void pg_index(const struct req *, char *);
75: static void pg_search(const struct req *, char *);
76: static void pg_show(const struct req *, char *);
1.6 kristaps 77: static void resp_begin_html(int, const char *);
78: static void resp_begin_http(int, const char *);
79: static void resp_end_html(void);
1.59 schwarze 80: static void resp_error_badrequest(const char *);
81: static void resp_error_internal(void);
82: static void resp_error_notfound(const char *);
1.6 kristaps 83: static void resp_index(const struct req *);
1.59 schwarze 84: static void resp_noresult(const struct req *,
85: const char *);
1.52 schwarze 86: static void resp_search(const struct req *,
87: struct manpage *, size_t);
1.6 kristaps 88: static void resp_searchform(const struct req *);
89:
1.58 schwarze 90: static const char *scriptname; /* CGI script name */
91: static const char *mandir; /* contains all manpath directories */
92: static const char *cssdir; /* css directory */
93: static const char *httphost; /* hostname used in the URIs */
1.1 kristaps 94:
95: static const char * const pages[PAGE__MAX] = {
96: "index", /* PAGE_INDEX */
97: "search", /* PAGE_SEARCH */
1.6 kristaps 98: "show", /* PAGE_SHOW */
1.1 kristaps 99: };
100:
1.6 kristaps 101: /*
1.20 kristaps 102: * Print a character, escaping HTML along the way.
103: * This will pass non-ASCII straight to output: be warned!
104: */
1.10 kristaps 105: static void
106: html_putchar(char c)
107: {
108:
109: switch (c) {
110: case ('"'):
111: printf(""e;");
112: break;
113: case ('&'):
114: printf("&");
115: break;
116: case ('>'):
117: printf(">");
118: break;
119: case ('<'):
120: printf("<");
121: break;
122: default:
123: putchar((unsigned char)c);
124: break;
125: }
126: }
1.57 schwarze 127:
1.36 kristaps 128: static void
129: http_printquery(const struct req *req)
130: {
131:
1.58 schwarze 132: if (NULL != req->q.manpath) {
1.53 schwarze 133: printf("&manpath=");
1.58 schwarze 134: http_print(req->q.manpath);
1.53 schwarze 135: }
136: if (NULL != req->q.sec) {
137: printf("&sec=");
138: http_print(req->q.sec);
139: }
140: if (NULL != req->q.arch) {
141: printf("&arch=");
142: http_print(req->q.arch);
143: }
144: if (NULL != req->q.expr) {
145: printf("&expr=");
146: http_print(req->q.expr ? req->q.expr : "");
147: }
1.36 kristaps 148: }
149:
150: static void
151: html_printquery(const struct req *req)
152: {
153:
1.58 schwarze 154: if (NULL != req->q.manpath) {
1.53 schwarze 155: printf("&manpath=");
1.58 schwarze 156: html_print(req->q.manpath);
1.53 schwarze 157: }
158: if (NULL != req->q.sec) {
159: printf("&sec=");
160: html_print(req->q.sec);
161: }
162: if (NULL != req->q.arch) {
163: printf("&arch=");
164: html_print(req->q.arch);
165: }
166: if (NULL != req->q.expr) {
167: printf("&expr=");
168: html_print(req->q.expr ? req->q.expr : "");
169: }
1.36 kristaps 170: }
171:
172: static void
173: http_print(const char *p)
174: {
175:
176: if (NULL == p)
177: return;
178: while ('\0' != *p)
179: http_putchar(*p++);
180: }
1.10 kristaps 181:
1.6 kristaps 182: /*
1.20 kristaps 183: * Call through to html_putchar().
184: * Accepts NULL strings.
1.6 kristaps 185: */
1.1 kristaps 186: static void
1.6 kristaps 187: html_print(const char *p)
1.1 kristaps 188: {
1.6 kristaps 189:
190: if (NULL == p)
191: return;
1.1 kristaps 192: while ('\0' != *p)
1.10 kristaps 193: html_putchar(*p++);
1.1 kristaps 194: }
195:
196: /*
197: * Parse out key-value pairs from an HTTP request variable.
1.6 kristaps 198: * This can be either a cookie or a POST/GET string, although man.cgi
199: * uses only GET for simplicity.
1.1 kristaps 200: */
201: static void
1.26 kristaps 202: http_parse(struct req *req, char *p)
1.1 kristaps 203: {
1.52 schwarze 204: char *key, *val;
205: int legacy;
1.1 kristaps 206:
1.26 kristaps 207: memset(&req->q, 0, sizeof(struct query));
1.58 schwarze 208: req->q.manpath = req->p[0];
1.24 kristaps 209:
210: legacy = -1;
1.36 kristaps 211: while ('\0' != *p) {
1.1 kristaps 212: key = p;
213: val = NULL;
214:
1.36 kristaps 215: p += (int)strcspn(p, ";&");
216: if ('\0' != *p)
1.1 kristaps 217: *p++ = '\0';
1.36 kristaps 218: if (NULL != (val = strchr(key, '=')))
219: *val++ = '\0';
1.1 kristaps 220:
1.36 kristaps 221: if ('\0' == *key || NULL == val || '\0' == *val)
1.1 kristaps 222: continue;
223:
224: /* Just abort handling. */
225:
1.24 kristaps 226: if ( ! http_decode(key))
227: break;
1.36 kristaps 228: if (NULL != val && ! http_decode(val))
1.24 kristaps 229: break;
230:
231: if (0 == strcmp(key, "expr"))
1.26 kristaps 232: req->q.expr = val;
1.24 kristaps 233: else if (0 == strcmp(key, "query"))
1.26 kristaps 234: req->q.expr = val;
1.24 kristaps 235: else if (0 == strcmp(key, "sec"))
1.26 kristaps 236: req->q.sec = val;
1.24 kristaps 237: else if (0 == strcmp(key, "sektion"))
1.26 kristaps 238: req->q.sec = val;
1.24 kristaps 239: else if (0 == strcmp(key, "arch"))
1.26 kristaps 240: req->q.arch = val;
241: else if (0 == strcmp(key, "manpath"))
1.58 schwarze 242: req->q.manpath = val;
1.24 kristaps 243: else if (0 == strcmp(key, "apropos"))
244: legacy = 0 == strcmp(val, "0");
245: }
1.1 kristaps 246:
1.24 kristaps 247: /* Test for old man.cgi compatibility mode. */
1.1 kristaps 248:
1.40 kristaps 249: req->q.legacy = legacy > 0;
1.24 kristaps 250:
251: /*
252: * Section "0" means no section when in legacy mode.
253: * For some man.cgi scripts, "default" arch is none.
254: */
255:
1.26 kristaps 256: if (req->q.legacy && NULL != req->q.sec)
257: if (0 == strcmp(req->q.sec, "0"))
258: req->q.sec = NULL;
259: if (req->q.legacy && NULL != req->q.arch)
260: if (0 == strcmp(req->q.arch, "default"))
261: req->q.arch = NULL;
1.1 kristaps 262: }
263:
1.36 kristaps 264: static void
265: http_putchar(char c)
266: {
267:
268: if (isalnum((unsigned char)c)) {
269: putchar((unsigned char)c);
270: return;
271: } else if (' ' == c) {
272: putchar('+');
273: return;
274: }
275: printf("%%%.2x", c);
276: }
277:
1.1 kristaps 278: /*
1.6 kristaps 279: * HTTP-decode a string. The standard explanation is that this turns
280: * "%4e+foo" into "n foo" in the regular way. This is done in-place
281: * over the allocated string.
1.1 kristaps 282: */
283: static int
1.24 kristaps 284: http_decode(char *p)
1.1 kristaps 285: {
286: char hex[3];
287: int c;
288:
289: hex[2] = '\0';
290:
291: for ( ; '\0' != *p; p++) {
292: if ('%' == *p) {
293: if ('\0' == (hex[0] = *(p + 1)))
294: return(0);
295: if ('\0' == (hex[1] = *(p + 2)))
296: return(0);
297: if (1 != sscanf(hex, "%x", &c))
298: return(0);
299: if ('\0' == c)
300: return(0);
301:
302: *p = (char)c;
303: memmove(p + 1, p + 3, strlen(p + 3) + 1);
304: } else
305: *p = '+' == *p ? ' ' : *p;
306: }
307:
308: *p = '\0';
309: return(1);
310: }
311:
1.6 kristaps 312: static void
313: resp_begin_http(int code, const char *msg)
314: {
315:
316: if (200 != code)
317: printf("Status: %d %s\n", code, msg);
318:
1.20 kristaps 319: puts("Content-Type: text/html; charset=utf-8\n"
320: "Cache-Control: no-cache\n"
321: "Pragma: no-cache\n"
1.6 kristaps 322: "");
323:
324: fflush(stdout);
325: }
326:
327: static void
328: resp_begin_html(int code, const char *msg)
329: {
330:
331: resp_begin_http(code, msg);
332:
1.29 kristaps 333: printf("<!DOCTYPE HTML PUBLIC "
334: " \"-//W3C//DTD HTML 4.01//EN\""
335: " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
336: "<HTML>\n"
337: "<HEAD>\n"
338: "<META HTTP-EQUIV=\"Content-Type\""
339: " CONTENT=\"text/html; charset=utf-8\">\n"
1.32 kristaps 340: "<LINK REL=\"stylesheet\" HREF=\"%s/man-cgi.css\""
341: " TYPE=\"text/css\" media=\"all\">\n"
342: "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""
1.29 kristaps 343: " TYPE=\"text/css\" media=\"all\">\n"
344: "<TITLE>System Manpage Reference</TITLE>\n"
345: "</HEAD>\n"
346: "<BODY>\n"
1.58 schwarze 347: "<!-- Begin page content. //-->\n",
348: cssdir, cssdir);
1.6 kristaps 349: }
350:
351: static void
352: resp_end_html(void)
353: {
354:
1.20 kristaps 355: puts("</BODY>\n"
356: "</HTML>");
1.6 kristaps 357: }
358:
359: static void
360: resp_searchform(const struct req *req)
361: {
1.27 kristaps 362: int i;
1.13 kristaps 363:
1.6 kristaps 364: puts("<!-- Begin search form. //-->");
1.32 kristaps 365: printf("<DIV ID=\"mancgi\">\n"
1.52 schwarze 366: "<FORM ACTION=\"%s/search\" METHOD=\"get\">\n"
1.29 kristaps 367: "<FIELDSET>\n"
1.16 kristaps 368: "<LEGEND>Search Parameters</LEGEND>\n"
1.40 kristaps 369: "<INPUT TYPE=\"submit\" "
370: " VALUE=\"Search\"> for manuals satisfying \n"
1.29 kristaps 371: "<INPUT TYPE=\"text\" NAME=\"expr\" VALUE=\"",
1.58 schwarze 372: scriptname);
1.24 kristaps 373: html_print(req->q.expr ? req->q.expr : "");
1.14 kristaps 374: printf("\">, section "
1.20 kristaps 375: "<INPUT TYPE=\"text\""
376: " SIZE=\"4\" NAME=\"sec\" VALUE=\"");
1.24 kristaps 377: html_print(req->q.sec ? req->q.sec : "");
1.14 kristaps 378: printf("\">, arch "
1.20 kristaps 379: "<INPUT TYPE=\"text\""
380: " SIZE=\"8\" NAME=\"arch\" VALUE=\"");
1.24 kristaps 381: html_print(req->q.arch ? req->q.arch : "");
1.27 kristaps 382: printf("\">");
383: if (req->psz > 1) {
1.60 ! schwarze 384: puts(", in <SELECT NAME=\"manpath\">");
1.27 kristaps 385: for (i = 0; i < (int)req->psz; i++) {
1.52 schwarze 386: printf("<OPTION ");
1.58 schwarze 387: if (NULL == req->q.manpath ? 0 == i :
388: 0 == strcmp(req->q.manpath, req->p[i]))
1.52 schwarze 389: printf("SELECTED=\"selected\" ");
390: printf("VALUE=\"");
391: html_print(req->p[i]);
1.27 kristaps 392: printf("\">");
1.52 schwarze 393: html_print(req->p[i]);
1.27 kristaps 394: puts("</OPTION>");
395: }
396: puts("</SELECT>");
397: }
1.60 ! schwarze 398: puts("—\n"
1.12 kristaps 399: "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
400: "</FIELDSET>\n"
1.32 kristaps 401: "</FORM>\n"
402: "</DIV>");
1.20 kristaps 403: puts("<!-- End search form. //-->");
1.6 kristaps 404: }
405:
406: static void
407: resp_index(const struct req *req)
408: {
409:
410: resp_begin_html(200, NULL);
1.60 ! schwarze 411: puts("<H1>\n"
! 412: "Online manuals with "
! 413: "<A HREF=\"http://mdocml.bsd.lv/\">mandoc</A>\n"
! 414: "</H1>");
1.6 kristaps 415: resp_searchform(req);
1.60 ! schwarze 416: puts("<P>\n"
! 417: "The <A HREF=\"search?expr=Nm~^apropos$&sec=1\">"
! 418: "apropos</A> manual explains the query syntax.\n"
! 419: "</P>");
1.6 kristaps 420: resp_end_html();
421: }
422:
423: static void
1.59 schwarze 424: resp_noresult(const struct req *req, const char *msg)
425: {
426: resp_begin_html(200, NULL);
427: resp_searchform(req);
428: puts("<P>");
429: puts(msg);
430: puts("</P>");
431: resp_end_html();
432: }
433:
434: static void
435: resp_error_badrequest(const char *msg)
1.9 kristaps 436: {
437:
1.59 schwarze 438: resp_begin_html(400, "Bad Request");
439: puts("<H1>Bad Request</H1>\n"
440: "<P>\n");
441: puts(msg);
442: printf("Try again from the\n"
443: "<A HREF=\"%s\">main page</A>.\n"
1.58 schwarze 444: "</P>", scriptname);
1.9 kristaps 445: resp_end_html();
446: }
447:
448: static void
1.59 schwarze 449: resp_error_notfound(const char *page)
1.6 kristaps 450: {
451:
452: resp_begin_html(404, "Not Found");
1.10 kristaps 453: puts("<H1>Page Not Found</H1>\n"
454: "<P>\n"
1.20 kristaps 455: "The page you're looking for, ");
456: printf("<B>");
1.10 kristaps 457: html_print(page);
1.12 kristaps 458: printf("</B>,\n"
1.20 kristaps 459: "could not be found.\n"
460: "Try searching from the\n"
1.58 schwarze 461: "<A HREF=\"%s\">main page</A>.\n"
462: "</P>", scriptname);
1.6 kristaps 463: resp_end_html();
464: }
1.1 kristaps 465:
466: static void
1.59 schwarze 467: resp_error_internal(void)
1.7 kristaps 468: {
469: resp_begin_html(500, "Internal Server Error");
1.58 schwarze 470: puts("<P>Internal Server Error</P>");
1.7 kristaps 471: resp_end_html();
472: }
473:
474: static void
1.52 schwarze 475: resp_search(const struct req *req, struct manpage *r, size_t sz)
1.1 kristaps 476: {
1.52 schwarze 477: size_t i;
1.19 kristaps 478:
1.52 schwarze 479: if (1 == sz) {
1.6 kristaps 480: /*
481: * If we have just one result, then jump there now
482: * without any delay.
483: */
484: puts("Status: 303 See Other");
1.52 schwarze 485: printf("Location: http://%s%s/show/%s/%s?",
1.58 schwarze 486: httphost, scriptname, req->q.manpath, r[0].file);
1.36 kristaps 487: http_printquery(req);
488: puts("\n"
489: "Content-Type: text/html; charset=utf-8\n");
1.6 kristaps 490: return;
491: }
492:
1.59 schwarze 493: qsort(r, sz, sizeof(struct manpage), cmp);
494:
1.12 kristaps 495: resp_begin_html(200, NULL);
1.19 kristaps 496: resp_searchform(req);
1.33 kristaps 497: puts("<DIV CLASS=\"results\">");
498: puts("<TABLE>");
1.1 kristaps 499:
1.41 kristaps 500: for (i = 0; i < sz; i++) {
1.20 kristaps 501: printf("<TR>\n"
502: "<TD CLASS=\"title\">\n"
1.52 schwarze 503: "<A HREF=\"%s/show/%s/%s?",
1.58 schwarze 504: scriptname, req->q.manpath, r[i].file);
1.36 kristaps 505: html_printquery(req);
506: printf("\">");
1.52 schwarze 507: html_print(r[i].names);
508: printf("</A>\n"
1.20 kristaps 509: "</TD>\n"
510: "<TD CLASS=\"desc\">");
1.52 schwarze 511: html_print(r[i].output);
1.20 kristaps 512: puts("</TD>\n"
513: "</TR>");
1.1 kristaps 514: }
1.16 kristaps 515:
1.33 kristaps 516: puts("</TABLE>\n"
517: "</DIV>");
1.6 kristaps 518: resp_end_html();
519: }
520:
521: /* ARGSUSED */
522: static void
1.24 kristaps 523: pg_index(const struct req *req, char *path)
1.6 kristaps 524: {
525:
526: resp_index(req);
1.1 kristaps 527: }
528:
529: static void
1.32 kristaps 530: catman(const struct req *req, const char *file)
1.9 kristaps 531: {
1.10 kristaps 532: FILE *f;
533: size_t len;
534: int i;
535: char *p;
536: int italic, bold;
1.9 kristaps 537:
1.10 kristaps 538: if (NULL == (f = fopen(file, "r"))) {
1.59 schwarze 539: resp_error_badrequest(
540: "You specified an invalid manual file.");
1.9 kristaps 541: return;
542: }
543:
1.32 kristaps 544: resp_begin_html(200, NULL);
545: resp_searchform(req);
546: puts("<DIV CLASS=\"catman\">\n"
547: "<PRE>");
1.10 kristaps 548:
549: while (NULL != (p = fgetln(f, &len))) {
550: bold = italic = 0;
551: for (i = 0; i < (int)len - 1; i++) {
552: /*
553: * This means that the catpage is out of state.
554: * Ignore it and keep going (although the
555: * catpage is bogus).
556: */
557:
558: if ('\b' == p[i] || '\n' == p[i])
559: continue;
560:
561: /*
562: * Print a regular character.
563: * Close out any bold/italic scopes.
564: * If we're in back-space mode, make sure we'll
565: * have something to enter when we backspace.
566: */
567:
568: if ('\b' != p[i + 1]) {
569: if (italic)
570: printf("</I>");
571: if (bold)
572: printf("</B>");
573: italic = bold = 0;
574: html_putchar(p[i]);
575: continue;
576: } else if (i + 2 >= (int)len)
577: continue;
578:
579: /* Italic mode. */
580:
581: if ('_' == p[i]) {
582: if (bold)
583: printf("</B>");
584: if ( ! italic)
585: printf("<I>");
586: bold = 0;
587: italic = 1;
588: i += 2;
589: html_putchar(p[i]);
590: continue;
591: }
592:
593: /*
594: * Handle funny behaviour troff-isms.
595: * These grok'd from the original man2html.c.
596: */
597:
598: if (('+' == p[i] && 'o' == p[i + 2]) ||
599: ('o' == p[i] && '+' == p[i + 2]) ||
600: ('|' == p[i] && '=' == p[i + 2]) ||
601: ('=' == p[i] && '|' == p[i + 2]) ||
602: ('*' == p[i] && '=' == p[i + 2]) ||
603: ('=' == p[i] && '*' == p[i + 2]) ||
604: ('*' == p[i] && '|' == p[i + 2]) ||
605: ('|' == p[i] && '*' == p[i + 2])) {
606: if (italic)
607: printf("</I>");
608: if (bold)
609: printf("</B>");
610: italic = bold = 0;
611: putchar('*');
612: i += 2;
613: continue;
614: } else if (('|' == p[i] && '-' == p[i + 2]) ||
615: ('-' == p[i] && '|' == p[i + 1]) ||
616: ('+' == p[i] && '-' == p[i + 1]) ||
617: ('-' == p[i] && '+' == p[i + 1]) ||
618: ('+' == p[i] && '|' == p[i + 1]) ||
619: ('|' == p[i] && '+' == p[i + 1])) {
620: if (italic)
621: printf("</I>");
622: if (bold)
623: printf("</B>");
624: italic = bold = 0;
625: putchar('+');
626: i += 2;
627: continue;
628: }
629:
630: /* Bold mode. */
631:
632: if (italic)
633: printf("</I>");
634: if ( ! bold)
635: printf("<B>");
636: bold = 1;
637: italic = 0;
638: i += 2;
639: html_putchar(p[i]);
640: }
641:
642: /*
643: * Clean up the last character.
644: * We can get to a newline; don't print that.
645: */
1.9 kristaps 646:
1.10 kristaps 647: if (italic)
648: printf("</I>");
649: if (bold)
650: printf("</B>");
1.9 kristaps 651:
1.10 kristaps 652: if (i == (int)len - 1 && '\n' != p[i])
653: html_putchar(p[i]);
1.9 kristaps 654:
1.10 kristaps 655: putchar('\n');
656: }
657:
658: puts("</PRE>\n"
1.32 kristaps 659: "</DIV>\n"
1.10 kristaps 660: "</BODY>\n"
661: "</HTML>");
662:
663: fclose(f);
1.9 kristaps 664: }
665:
666: static void
1.32 kristaps 667: format(const struct req *req, const char *file)
1.7 kristaps 668: {
1.8 kristaps 669: struct mparse *mp;
670: int fd;
671: struct mdoc *mdoc;
672: struct man *man;
673: void *vp;
674: enum mandoclevel rc;
1.45 schwarze 675: char opts[PATH_MAX + 128];
1.7 kristaps 676:
1.8 kristaps 677: if (-1 == (fd = open(file, O_RDONLY, 0))) {
1.59 schwarze 678: resp_error_badrequest(
679: "You specified an invalid manual file.");
1.7 kristaps 680: return;
681: }
682:
1.56 schwarze 683: mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_FATAL, NULL,
1.58 schwarze 684: req->q.manpath);
1.8 kristaps 685: rc = mparse_readfd(mp, fd, file);
686: close(fd);
1.7 kristaps 687:
1.8 kristaps 688: if (rc >= MANDOCLEVEL_FATAL) {
1.59 schwarze 689: fprintf(stderr, "fatal mandoc error: %s/%s\n",
690: req->q.manpath, file);
691: resp_error_internal();
1.7 kristaps 692: return;
693: }
694:
1.52 schwarze 695: snprintf(opts, sizeof(opts),
696: "fragment,man=%s/search?sec=%%S&expr=Nm~^%%N$",
1.58 schwarze 697: scriptname);
1.10 kristaps 698:
1.49 schwarze 699: mparse_result(mp, &mdoc, &man, NULL);
1.32 kristaps 700: if (NULL == man && NULL == mdoc) {
1.59 schwarze 701: fprintf(stderr, "fatal mandoc error: %s/%s\n",
702: req->q.manpath, file);
703: resp_error_internal();
1.32 kristaps 704: mparse_free(mp);
705: return;
706: }
707:
708: resp_begin_html(200, NULL);
709: resp_searchform(req);
710:
1.10 kristaps 711: vp = html_alloc(opts);
1.7 kristaps 712:
1.32 kristaps 713: if (NULL != mdoc)
1.8 kristaps 714: html_mdoc(vp, mdoc);
1.32 kristaps 715: else
1.8 kristaps 716: html_man(vp, man);
1.32 kristaps 717:
718: puts("</BODY>\n"
719: "</HTML>");
1.7 kristaps 720:
1.8 kristaps 721: html_free(vp);
722: mparse_free(mp);
1.7 kristaps 723: }
724:
725: static void
1.24 kristaps 726: pg_show(const struct req *req, char *path)
1.1 kristaps 727: {
1.6 kristaps 728: char *sub;
1.25 kristaps 729:
730: if (NULL == path || NULL == (sub = strchr(path, '/'))) {
1.59 schwarze 731: resp_error_badrequest(
732: "You did not specify a page to show.");
1.25 kristaps 733: return;
734: }
735: *sub++ = '\0';
1.6 kristaps 736:
1.24 kristaps 737: /*
1.58 schwarze 738: * Begin by chdir()ing into the manpath.
1.24 kristaps 739: * This way we can pick up the database files, which are
740: * relative to the manpath root.
741: */
742:
1.52 schwarze 743: if (-1 == chdir(path)) {
1.59 schwarze 744: resp_error_badrequest(
745: "You specified an invalid manpath.");
1.24 kristaps 746: return;
747: }
748:
1.52 schwarze 749: if ('c' == *sub)
750: catman(req, sub);
751: else
752: format(req, sub);
1.6 kristaps 753: }
754:
755: static void
1.24 kristaps 756: pg_search(const struct req *req, char *path)
1.6 kristaps 757: {
1.52 schwarze 758: struct mansearch search;
759: struct manpaths paths;
760: struct manpage *res;
761: char **cp;
762: const char *ep, *start;
763: size_t ressz;
764: int i, sz;
1.6 kristaps 765:
766: /*
1.24 kristaps 767: * Begin by chdir()ing into the root of the manpath.
768: * This way we can pick up the database files, which are
769: * relative to the manpath root.
770: */
771:
1.58 schwarze 772: if (-1 == (chdir(req->q.manpath))) {
1.59 schwarze 773: resp_error_badrequest(
774: "You specified an invalid manpath.");
1.24 kristaps 775: return;
776: }
777:
1.52 schwarze 778: search.arch = req->q.arch;
779: search.sec = req->q.sec;
780: search.deftype = TYPE_Nm | TYPE_Nd;
781: search.flags = 0;
782:
783: paths.sz = 1;
784: paths.paths = mandoc_malloc(sizeof(char *));
785: paths.paths[0] = mandoc_strdup(".");
1.24 kristaps 786:
787: /*
788: * Poor man's tokenisation: just break apart by spaces.
1.6 kristaps 789: * Yes, this is half-ass. But it works for now.
790: */
791:
1.52 schwarze 792: ep = req->q.expr;
1.6 kristaps 793: while (ep && isspace((unsigned char)*ep))
794: ep++;
795:
1.52 schwarze 796: sz = 0;
797: cp = NULL;
1.6 kristaps 798: while (ep && '\0' != *ep) {
1.51 schwarze 799: cp = mandoc_reallocarray(cp, sz + 1, sizeof(char *));
1.6 kristaps 800: start = ep;
801: while ('\0' != *ep && ! isspace((unsigned char)*ep))
802: ep++;
803: cp[sz] = mandoc_malloc((ep - start) + 1);
804: memcpy(cp[sz], start, ep - start);
805: cp[sz++][ep - start] = '\0';
806: while (isspace((unsigned char)*ep))
807: ep++;
808: }
809:
1.59 schwarze 810: if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz))
811: resp_noresult(req, "You entered an invalid query.");
812: else if (0 == ressz)
813: resp_noresult(req, "No results found.");
814: else
1.52 schwarze 815: resp_search(req, res, ressz);
1.6 kristaps 816:
817: for (i = 0; i < sz; i++)
818: free(cp[i]);
1.52 schwarze 819: free(cp);
820:
821: for (i = 0; i < (int)ressz; i++) {
822: free(res[i].file);
823: free(res[i].names);
824: free(res[i].output);
825: }
826: free(res);
1.6 kristaps 827:
1.52 schwarze 828: free(paths.paths[0]);
829: free(paths.paths);
1.1 kristaps 830: }
831:
832: int
833: main(void)
834: {
835: int i;
836: struct req req;
1.58 schwarze 837: char *querystring, *path, *subpath;
1.6 kristaps 838:
1.24 kristaps 839: /* Scan our run-time environment. */
1.6 kristaps 840:
1.58 schwarze 841: if (NULL == (mandir = getenv("MAN_DIR")))
842: mandir = "/man";
1.29 kristaps 843:
1.58 schwarze 844: if (NULL == (scriptname = getenv("SCRIPT_NAME")))
845: scriptname = "";
1.6 kristaps 846:
1.58 schwarze 847: if (NULL == (cssdir = getenv("CSS_DIR")))
848: cssdir = "";
1.7 kristaps 849:
1.58 schwarze 850: if (NULL == (httphost = getenv("HTTP_HOST")))
851: httphost = "localhost";
1.24 kristaps 852:
853: /*
1.58 schwarze 854: * First we change directory into the mandir so that
1.24 kristaps 855: * subsequent scanning for manpath directories is rooted
856: * relative to the same position.
857: */
858:
1.58 schwarze 859: if (-1 == chdir(mandir)) {
860: fprintf(stderr, "MAN_DIR: %s: %s\n",
861: mandir, strerror(errno));
1.59 schwarze 862: resp_error_internal();
1.24 kristaps 863: return(EXIT_FAILURE);
864: }
865:
866: memset(&req, 0, sizeof(struct req));
1.54 schwarze 867: pathgen(&req);
1.1 kristaps 868:
1.24 kristaps 869: /* Next parse out the query string. */
1.1 kristaps 870:
1.58 schwarze 871: if (NULL != (querystring = getenv("QUERY_STRING")))
872: http_parse(&req, querystring);
1.1 kristaps 873:
1.24 kristaps 874: /*
875: * Now juggle paths to extract information.
876: * We want to extract our filetype (the file suffix), the
877: * initial path component, then the trailing component(s).
878: * Start with leading subpath component.
879: */
1.1 kristaps 880:
1.6 kristaps 881: subpath = path = NULL;
1.1 kristaps 882: req.page = PAGE__MAX;
883:
884: if (NULL == (path = getenv("PATH_INFO")) || '\0' == *path)
885: req.page = PAGE_INDEX;
1.6 kristaps 886:
1.1 kristaps 887: if (NULL != path && '/' == *path && '\0' == *++path)
888: req.page = PAGE_INDEX;
889:
1.6 kristaps 890: /* Resolve subpath component. */
1.1 kristaps 891:
892: if (NULL != path && NULL != (subpath = strchr(path, '/')))
1.6 kristaps 893: *subpath++ = '\0';
1.1 kristaps 894:
1.6 kristaps 895: /* Map path into one we recognise. */
1.1 kristaps 896:
897: if (NULL != path && '\0' != *path)
898: for (i = 0; i < (int)PAGE__MAX; i++)
899: if (0 == strcmp(pages[i], path)) {
900: req.page = (enum page)i;
901: break;
902: }
903:
1.6 kristaps 904: /* Route pages. */
905:
1.1 kristaps 906: switch (req.page) {
907: case (PAGE_INDEX):
1.24 kristaps 908: pg_index(&req, subpath);
1.1 kristaps 909: break;
910: case (PAGE_SEARCH):
1.24 kristaps 911: pg_search(&req, subpath);
1.6 kristaps 912: break;
913: case (PAGE_SHOW):
1.24 kristaps 914: pg_show(&req, subpath);
1.1 kristaps 915: break;
916: default:
1.59 schwarze 917: resp_error_notfound(path);
1.1 kristaps 918: break;
919: }
920:
1.52 schwarze 921: for (i = 0; i < (int)req.psz; i++)
922: free(req.p[i]);
1.24 kristaps 923: free(req.p);
1.1 kristaps 924: return(EXIT_SUCCESS);
925: }
1.15 kristaps 926:
927: static int
928: cmp(const void *p1, const void *p2)
929: {
930:
1.52 schwarze 931: return(strcasecmp(((const struct manpage *)p1)->names,
932: ((const struct manpage *)p2)->names));
1.24 kristaps 933: }
934:
935: /*
936: * Scan for indexable paths.
937: */
938: static void
1.54 schwarze 939: pathgen(struct req *req)
1.24 kristaps 940: {
1.54 schwarze 941: FILE *fp;
942: char *dp;
943: size_t dpsz;
944:
945: if (NULL == (fp = fopen("manpath.conf", "r")))
946: return;
1.24 kristaps 947:
1.54 schwarze 948: while (NULL != (dp = fgetln(fp, &dpsz))) {
1.55 schwarze 949: if ('\n' == dp[dpsz - 1])
950: dpsz--;
1.54 schwarze 951: req->p = mandoc_realloc(req->p,
952: (req->psz + 1) * sizeof(char *));
953: req->p[req->psz++] = mandoc_strndup(dp, dpsz);
1.24 kristaps 954: }
955: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to cgi.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc