[BACK]Return to cgi.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/cgi.c, Revision 1.171

1.171   ! schwarze    1: /*     $Id: cgi.c,v 1.170 2020/01/10 12:54:43 schwarze Exp $ */
1.6       kristaps    2: /*
1.42      kristaps    3:  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.168     schwarze    4:  * Copyright (c) 2014-2019 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:  *
1.105     schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.6       kristaps   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.105     schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.6       kristaps   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: #include "config.h"
1.93      schwarze   19:
                     20: #include <sys/types.h>
1.95      schwarze   21: #include <sys/time.h>
1.6       kristaps   22:
                     23: #include <ctype.h>
1.147     schwarze   24: #if HAVE_ERR
1.128     schwarze   25: #include <err.h>
1.147     schwarze   26: #endif
1.58      schwarze   27: #include <errno.h>
1.1       kristaps   28: #include <fcntl.h>
1.6       kristaps   29: #include <limits.h>
1.92      schwarze   30: #include <stdint.h>
1.1       kristaps   31: #include <stdio.h>
                     32: #include <stdlib.h>
                     33: #include <string.h>
1.6       kristaps   34: #include <unistd.h>
1.1       kristaps   35:
1.108     schwarze   36: #include "mandoc_aux.h"
1.4       schwarze   37: #include "mandoc.h"
1.108     schwarze   38: #include "roff.h"
1.111     schwarze   39: #include "mdoc.h"
1.112     schwarze   40: #include "man.h"
1.162     schwarze   41: #include "mandoc_parse.h"
1.8       kristaps   42: #include "main.h"
1.105     schwarze   43: #include "manconf.h"
1.52      schwarze   44: #include "mansearch.h"
1.67      schwarze   45: #include "cgi.h"
1.1       kristaps   46:
1.20      kristaps   47: /*
                     48:  * A query as passed to the search function.
                     49:  */
                     50: struct query {
1.83      schwarze   51:        char            *manpath; /* desired manual directory */
                     52:        char            *arch; /* architecture */
                     53:        char            *sec; /* manual section */
1.85      schwarze   54:        char            *query; /* unparsed query expression */
1.65      schwarze   55:        int              equal; /* match whole names, not substrings */
1.20      kristaps   56: };
                     57:
1.1       kristaps   58: struct req {
1.58      schwarze   59:        struct query      q;
                     60:        char            **p; /* array of available manpaths */
                     61:        size_t            psz; /* number of available manpaths */
1.121     schwarze   62:        int               isquery; /* QUERY_STRING used, not PATH_INFO */
1.1       kristaps   63: };
                     64:
1.131     schwarze   65: enum   focus {
                     66:        FOCUS_NONE = 0,
                     67:        FOCUS_QUERY
                     68: };
                     69:
1.6       kristaps   70: static void             html_print(const char *);
1.10      kristaps   71: static void             html_putchar(char);
1.104     schwarze   72: static int              http_decode(char *);
1.159     schwarze   73: static void             http_encode(const char *p);
1.129     schwarze   74: static void             parse_manpath_conf(struct req *);
                     75: static void             parse_path_info(struct req *req, const char *path);
                     76: static void             parse_query_string(struct req *, const char *);
1.72      schwarze   77: static void             pg_error_badrequest(const char *);
                     78: static void             pg_error_internal(void);
                     79: static void             pg_index(const struct req *);
1.168     schwarze   80: static void             pg_noresult(const struct req *, int, const char *,
                     81:                                const char *);
1.149     schwarze   82: static void             pg_redirect(const struct req *, const char *);
1.66      schwarze   83: static void             pg_search(const struct req *);
1.72      schwarze   84: static void             pg_searchres(const struct req *,
                     85:                                struct manpage *, size_t);
1.79      schwarze   86: static void             pg_show(struct req *, const char *);
1.150     schwarze   87: static void             resp_begin_html(int, const char *, const char *);
1.6       kristaps   88: static void             resp_begin_http(int, const char *);
1.129     schwarze   89: static void             resp_catman(const struct req *, const char *);
1.114     schwarze   90: static void             resp_copy(const char *);
1.6       kristaps   91: static void             resp_end_html(void);
1.129     schwarze   92: static void             resp_format(const struct req *, const char *);
1.131     schwarze   93: static void             resp_searchform(const struct req *, enum focus);
1.70      schwarze   94: static void             resp_show(const struct req *, const char *);
1.85      schwarze   95: static void             set_query_attr(char **, char **);
1.159     schwarze   96: static int              validate_arch(const char *);
1.85      schwarze   97: static int              validate_filename(const char *);
                     98: static int              validate_manpath(const struct req *, const char *);
                     99: static int              validate_urifrag(const char *);
1.6       kristaps  100:
1.119     schwarze  101: static const char       *scriptname = SCRIPT_NAME;
1.1       kristaps  102:
1.70      schwarze  103: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.68      schwarze  104: static const char *const sec_numbers[] = {
                    105:     "0", "1", "2", "3", "3p", "4", "5", "6", "7", "8", "9"
                    106: };
                    107: static const char *const sec_names[] = {
                    108:     "All Sections",
                    109:     "1 - General Commands",
                    110:     "2 - System Calls",
1.96      schwarze  111:     "3 - Library Functions",
                    112:     "3p - Perl Library",
                    113:     "4 - Device Drivers",
1.68      schwarze  114:     "5 - File Formats",
                    115:     "6 - Games",
1.96      schwarze  116:     "7 - Miscellaneous Information",
                    117:     "8 - System Manager\'s Manual",
                    118:     "9 - Kernel Developer\'s Manual"
1.68      schwarze  119: };
                    120: static const int sec_MAX = sizeof(sec_names) / sizeof(char *);
                    121:
                    122: static const char *const arch_names[] = {
1.146     schwarze  123:     "amd64",       "alpha",       "armv7",     "arm64",
1.137     schwarze  124:     "hppa",        "i386",        "landisk",
1.125     schwarze  125:     "loongson",    "luna88k",     "macppc",      "mips64",
1.140     schwarze  126:     "octeon",      "sgi",         "socppc",      "sparc64",
1.137     schwarze  127:     "amiga",       "arc",         "armish",      "arm32",
                    128:     "atari",       "aviion",      "beagle",      "cats",
                    129:     "hppa64",      "hp300",
1.125     schwarze  130:     "ia64",        "mac68k",      "mvme68k",     "mvme88k",
                    131:     "mvmeppc",     "palm",        "pc532",       "pegasos",
1.139     schwarze  132:     "pmax",        "powerpc",     "solbourne",   "sparc",
1.140     schwarze  133:     "sun3",        "vax",         "wgrisc",      "x68k",
                    134:     "zaurus"
1.68      schwarze  135: };
                    136: static const int arch_MAX = sizeof(arch_names) / sizeof(char *);
                    137:
1.6       kristaps  138: /*
1.20      kristaps  139:  * Print a character, escaping HTML along the way.
                    140:  * This will pass non-ASCII straight to output: be warned!
                    141:  */
1.10      kristaps  142: static void
                    143: html_putchar(char c)
                    144: {
                    145:
                    146:        switch (c) {
1.155     schwarze  147:        case '"':
1.141     schwarze  148:                printf("&quot;");
1.10      kristaps  149:                break;
1.155     schwarze  150:        case '&':
1.10      kristaps  151:                printf("&amp;");
                    152:                break;
1.155     schwarze  153:        case '>':
1.10      kristaps  154:                printf("&gt;");
                    155:                break;
1.155     schwarze  156:        case '<':
1.10      kristaps  157:                printf("&lt;");
                    158:                break;
                    159:        default:
                    160:                putchar((unsigned char)c);
                    161:                break;
                    162:        }
                    163: }
1.57      schwarze  164:
1.6       kristaps  165: /*
1.20      kristaps  166:  * Call through to html_putchar().
                    167:  * Accepts NULL strings.
1.6       kristaps  168:  */
1.1       kristaps  169: static void
1.6       kristaps  170: html_print(const char *p)
1.1       kristaps  171: {
1.104     schwarze  172:
1.6       kristaps  173:        if (NULL == p)
                    174:                return;
1.1       kristaps  175:        while ('\0' != *p)
1.10      kristaps  176:                html_putchar(*p++);
1.1       kristaps  177: }
                    178:
                    179: /*
1.83      schwarze  180:  * Transfer the responsibility for the allocated string *val
                    181:  * to the query structure.
1.1       kristaps  182:  */
                    183: static void
1.83      schwarze  184: set_query_attr(char **attr, char **val)
1.1       kristaps  185: {
                    186:
1.83      schwarze  187:        free(*attr);
                    188:        if (**val == '\0') {
                    189:                *attr = NULL;
                    190:                free(*val);
                    191:        } else
                    192:                *attr = *val;
                    193:        *val = NULL;
                    194: }
                    195:
                    196: /*
                    197:  * Parse the QUERY_STRING for key-value pairs
                    198:  * and store the values into the query structure.
                    199:  */
                    200: static void
1.129     schwarze  201: parse_query_string(struct req *req, const char *qs)
1.83      schwarze  202: {
                    203:        char            *key, *val;
                    204:        size_t           keysz, valsz;
                    205:
1.121     schwarze  206:        req->isquery    = 1;
1.83      schwarze  207:        req->q.manpath  = NULL;
                    208:        req->q.arch     = NULL;
                    209:        req->q.sec      = NULL;
1.85      schwarze  210:        req->q.query    = NULL;
1.83      schwarze  211:        req->q.equal    = 1;
                    212:
                    213:        key = val = NULL;
                    214:        while (*qs != '\0') {
1.24      kristaps  215:
1.83      schwarze  216:                /* Parse one key. */
                    217:
                    218:                keysz = strcspn(qs, "=;&");
                    219:                key = mandoc_strndup(qs, keysz);
                    220:                qs += keysz;
                    221:                if (*qs != '=')
                    222:                        goto next;
                    223:
                    224:                /* Parse one value. */
                    225:
                    226:                valsz = strcspn(++qs, ";&");
                    227:                val = mandoc_strndup(qs, valsz);
                    228:                qs += valsz;
                    229:
                    230:                /* Decode and catch encoding errors. */
1.1       kristaps  231:
1.83      schwarze  232:                if ( ! (http_decode(key) && http_decode(val)))
                    233:                        goto next;
1.1       kristaps  234:
1.83      schwarze  235:                /* Handle key-value pairs. */
1.1       kristaps  236:
1.83      schwarze  237:                if ( ! strcmp(key, "query"))
1.85      schwarze  238:                        set_query_attr(&req->q.query, &val);
1.1       kristaps  239:
1.83      schwarze  240:                else if ( ! strcmp(key, "apropos"))
                    241:                        req->q.equal = !strcmp(val, "0");
                    242:
                    243:                else if ( ! strcmp(key, "manpath")) {
1.73      schwarze  244: #ifdef COMPAT_OLDURI
1.83      schwarze  245:                        if ( ! strncmp(val, "OpenBSD ", 8)) {
1.73      schwarze  246:                                val[7] = '-';
                    247:                                if ('C' == val[8])
                    248:                                        val[8] = 'c';
                    249:                        }
                    250: #endif
1.83      schwarze  251:                        set_query_attr(&req->q.manpath, &val);
                    252:                }
                    253:
                    254:                else if ( ! (strcmp(key, "sec")
1.73      schwarze  255: #ifdef COMPAT_OLDURI
1.83      schwarze  256:                    && strcmp(key, "sektion")
1.73      schwarze  257: #endif
1.83      schwarze  258:                    )) {
                    259:                        if ( ! strcmp(val, "0"))
                    260:                                *val = '\0';
                    261:                        set_query_attr(&req->q.sec, &val);
1.65      schwarze  262:                }
1.83      schwarze  263:
                    264:                else if ( ! strcmp(key, "arch")) {
                    265:                        if ( ! strcmp(val, "default"))
                    266:                                *val = '\0';
                    267:                        set_query_attr(&req->q.arch, &val);
                    268:                }
                    269:
                    270:                /*
                    271:                 * The key must be freed in any case.
                    272:                 * The val may have been handed over to the query
                    273:                 * structure, in which case it is now NULL.
                    274:                 */
                    275: next:
                    276:                free(key);
                    277:                key = NULL;
                    278:                free(val);
                    279:                val = NULL;
                    280:
                    281:                if (*qs != '\0')
                    282:                        qs++;
1.24      kristaps  283:        }
1.1       kristaps  284: }
                    285:
                    286: /*
1.6       kristaps  287:  * HTTP-decode a string.  The standard explanation is that this turns
                    288:  * "%4e+foo" into "n foo" in the regular way.  This is done in-place
                    289:  * over the allocated string.
1.1       kristaps  290:  */
                    291: static int
1.24      kristaps  292: http_decode(char *p)
1.1       kristaps  293: {
                    294:        char             hex[3];
1.63      schwarze  295:        char            *q;
1.1       kristaps  296:        int              c;
                    297:
                    298:        hex[2] = '\0';
                    299:
1.63      schwarze  300:        q = p;
                    301:        for ( ; '\0' != *p; p++, q++) {
1.1       kristaps  302:                if ('%' == *p) {
                    303:                        if ('\0' == (hex[0] = *(p + 1)))
1.109     schwarze  304:                                return 0;
1.1       kristaps  305:                        if ('\0' == (hex[1] = *(p + 2)))
1.109     schwarze  306:                                return 0;
1.1       kristaps  307:                        if (1 != sscanf(hex, "%x", &c))
1.109     schwarze  308:                                return 0;
1.1       kristaps  309:                        if ('\0' == c)
1.109     schwarze  310:                                return 0;
1.1       kristaps  311:
1.63      schwarze  312:                        *q = (char)c;
                    313:                        p += 2;
1.1       kristaps  314:                } else
1.63      schwarze  315:                        *q = '+' == *p ? ' ' : *p;
1.1       kristaps  316:        }
                    317:
1.63      schwarze  318:        *q = '\0';
1.109     schwarze  319:        return 1;
1.1       kristaps  320: }
                    321:
1.6       kristaps  322: static void
1.159     schwarze  323: http_encode(const char *p)
                    324: {
                    325:        for (; *p != '\0'; p++) {
                    326:                if (isalnum((unsigned char)*p) == 0 &&
                    327:                    strchr("-._~", *p) == NULL)
1.166     schwarze  328:                        printf("%%%2.2X", (unsigned char)*p);
1.159     schwarze  329:                else
                    330:                        putchar(*p);
                    331:        }
                    332: }
                    333:
                    334: static void
1.6       kristaps  335: resp_begin_http(int code, const char *msg)
                    336: {
                    337:
                    338:        if (200 != code)
1.62      schwarze  339:                printf("Status: %d %s\r\n", code, msg);
1.6       kristaps  340:
1.62      schwarze  341:        printf("Content-Type: text/html; charset=utf-8\r\n"
                    342:             "Cache-Control: no-cache\r\n"
1.169     schwarze  343:             "Content-Security-Policy: default-src 'none'; "
                    344:             "style-src 'self' 'unsafe-inline'\r\n"
1.62      schwarze  345:             "Pragma: no-cache\r\n"
                    346:             "\r\n");
1.6       kristaps  347:
                    348:        fflush(stdout);
                    349: }
                    350:
                    351: static void
1.114     schwarze  352: resp_copy(const char *filename)
                    353: {
                    354:        char     buf[4096];
                    355:        ssize_t  sz;
                    356:        int      fd;
                    357:
                    358:        if ((fd = open(filename, O_RDONLY)) != -1) {
                    359:                fflush(stdout);
                    360:                while ((sz = read(fd, buf, sizeof(buf))) > 0)
                    361:                        write(STDOUT_FILENO, buf, sz);
1.138     schwarze  362:                close(fd);
1.114     schwarze  363:        }
                    364: }
                    365:
                    366: static void
1.150     schwarze  367: resp_begin_html(int code, const char *msg, const char *file)
1.6       kristaps  368: {
1.150     schwarze  369:        char    *cp;
1.6       kristaps  370:
                    371:        resp_begin_http(code, msg);
                    372:
1.98      kristaps  373:        printf("<!DOCTYPE html>\n"
1.126     schwarze  374:               "<html>\n"
                    375:               "<head>\n"
1.143     schwarze  376:               "  <meta charset=\"UTF-8\"/>\n"
1.157     schwarze  377:               "  <meta name=\"viewport\""
                    378:                      " content=\"width=device-width, initial-scale=1.0\">\n"
1.143     schwarze  379:               "  <link rel=\"stylesheet\" href=\"%s/mandoc.css\""
1.126     schwarze  380:               " type=\"text/css\" media=\"all\">\n"
1.150     schwarze  381:               "  <title>",
                    382:               CSS_DIR);
                    383:        if (file != NULL) {
                    384:                if ((cp = strrchr(file, '/')) != NULL)
                    385:                        file = cp + 1;
                    386:                if ((cp = strrchr(file, '.')) != NULL) {
                    387:                        printf("%.*s(%s) - ", (int)(cp - file), file, cp + 1);
                    388:                } else
                    389:                        printf("%s - ", file);
                    390:        }
                    391:        printf("%s</title>\n"
1.126     schwarze  392:               "</head>\n"
1.142     schwarze  393:               "<body>\n",
1.150     schwarze  394:               CUSTOMIZE_TITLE);
1.114     schwarze  395:
                    396:        resp_copy(MAN_DIR "/header.html");
1.6       kristaps  397: }
                    398:
                    399: static void
                    400: resp_end_html(void)
                    401: {
                    402:
1.114     schwarze  403:        resp_copy(MAN_DIR "/footer.html");
                    404:
1.126     schwarze  405:        puts("</body>\n"
                    406:             "</html>");
1.6       kristaps  407: }
                    408:
                    409: static void
1.131     schwarze  410: resp_searchform(const struct req *req, enum focus focus)
1.6       kristaps  411: {
1.27      kristaps  412:        int              i;
1.13      kristaps  413:
1.171   ! schwarze  414:        printf("<form action=\"/%s\" method=\"get\" "
        !           415:               "autocomplete=\"off\" autocapitalize=\"none\">\n"
1.143     schwarze  416:               "  <fieldset>\n"
                    417:               "    <legend>Manual Page Search Parameters</legend>\n",
1.58      schwarze  418:               scriptname);
1.68      schwarze  419:
                    420:        /* Write query input box. */
                    421:
1.158     schwarze  422:        printf("    <input type=\"search\" name=\"query\" value=\"");
1.131     schwarze  423:        if (req->q.query != NULL)
1.85      schwarze  424:                html_print(req->q.query);
1.131     schwarze  425:        printf( "\" size=\"40\"");
                    426:        if (focus == FOCUS_QUERY)
                    427:                printf(" autofocus");
                    428:        puts(">");
1.68      schwarze  429:
1.132     schwarze  430:        /* Write submission buttons. */
1.68      schwarze  431:
1.143     schwarze  432:        printf( "    <button type=\"submit\" name=\"apropos\" value=\"0\">"
1.132     schwarze  433:                "man</button>\n"
1.143     schwarze  434:                "    <button type=\"submit\" name=\"apropos\" value=\"1\">"
                    435:                "apropos</button>\n"
                    436:                "    <br/>\n");
1.68      schwarze  437:
                    438:        /* Write section selector. */
                    439:
1.143     schwarze  440:        puts("    <select name=\"sec\">");
1.68      schwarze  441:        for (i = 0; i < sec_MAX; i++) {
1.143     schwarze  442:                printf("      <option value=\"%s\"", sec_numbers[i]);
1.68      schwarze  443:                if (NULL != req->q.sec &&
                    444:                    0 == strcmp(sec_numbers[i], req->q.sec))
1.126     schwarze  445:                        printf(" selected=\"selected\"");
                    446:                printf(">%s</option>\n", sec_names[i]);
1.68      schwarze  447:        }
1.143     schwarze  448:        puts("    </select>");
1.68      schwarze  449:
                    450:        /* Write architecture selector. */
                    451:
1.143     schwarze  452:        printf( "    <select name=\"arch\">\n"
                    453:                "      <option value=\"default\"");
1.81      schwarze  454:        if (NULL == req->q.arch)
1.126     schwarze  455:                printf(" selected=\"selected\"");
                    456:        puts(">All Architectures</option>");
1.68      schwarze  457:        for (i = 0; i < arch_MAX; i++) {
1.158     schwarze  458:                printf("      <option");
1.68      schwarze  459:                if (NULL != req->q.arch &&
                    460:                    0 == strcmp(arch_names[i], req->q.arch))
1.126     schwarze  461:                        printf(" selected=\"selected\"");
                    462:                printf(">%s</option>\n", arch_names[i]);
1.68      schwarze  463:        }
1.143     schwarze  464:        puts("    </select>");
1.68      schwarze  465:
                    466:        /* Write manpath selector. */
                    467:
1.27      kristaps  468:        if (req->psz > 1) {
1.143     schwarze  469:                puts("    <select name=\"manpath\">");
1.27      kristaps  470:                for (i = 0; i < (int)req->psz; i++) {
1.158     schwarze  471:                        printf("      <option");
1.102     schwarze  472:                        if (strcmp(req->q.manpath, req->p[i]) == 0)
1.158     schwarze  473:                                printf(" selected=\"selected\"");
                    474:                        printf(">");
1.52      schwarze  475:                        html_print(req->p[i]);
1.126     schwarze  476:                        puts("</option>");
1.27      kristaps  477:                }
1.143     schwarze  478:                puts("    </select>");
1.27      kristaps  479:        }
1.68      schwarze  480:
1.143     schwarze  481:        puts("  </fieldset>\n"
1.142     schwarze  482:             "</form>");
1.6       kristaps  483: }
                    484:
1.76      schwarze  485: static int
1.80      schwarze  486: validate_urifrag(const char *frag)
                    487: {
                    488:
                    489:        while ('\0' != *frag) {
                    490:                if ( ! (isalnum((unsigned char)*frag) ||
                    491:                    '-' == *frag || '.' == *frag ||
                    492:                    '/' == *frag || '_' == *frag))
1.109     schwarze  493:                        return 0;
1.80      schwarze  494:                frag++;
                    495:        }
1.109     schwarze  496:        return 1;
1.80      schwarze  497: }
                    498:
                    499: static int
1.77      schwarze  500: validate_manpath(const struct req *req, const char* manpath)
                    501: {
                    502:        size_t   i;
                    503:
                    504:        for (i = 0; i < req->psz; i++)
                    505:                if ( ! strcmp(manpath, req->p[i]))
1.109     schwarze  506:                        return 1;
1.77      schwarze  507:
1.109     schwarze  508:        return 0;
1.77      schwarze  509: }
                    510:
                    511: static int
1.159     schwarze  512: validate_arch(const char *arch)
                    513: {
                    514:        int      i;
                    515:
                    516:        for (i = 0; i < arch_MAX; i++)
                    517:                if (strcmp(arch, arch_names[i]) == 0)
                    518:                        return 1;
                    519:
                    520:        return 0;
                    521: }
                    522:
                    523: static int
1.76      schwarze  524: validate_filename(const char *file)
                    525: {
                    526:
                    527:        if ('.' == file[0] && '/' == file[1])
                    528:                file += 2;
                    529:
1.109     schwarze  530:        return ! (strstr(file, "../") || strstr(file, "/..") ||
                    531:            (strncmp(file, "man", 3) && strncmp(file, "cat", 3)));
1.76      schwarze  532: }
                    533:
1.6       kristaps  534: static void
1.72      schwarze  535: pg_index(const struct req *req)
1.6       kristaps  536: {
                    537:
1.150     schwarze  538:        resp_begin_html(200, NULL, NULL);
1.131     schwarze  539:        resp_searchform(req, FOCUS_QUERY);
1.126     schwarze  540:        printf("<p>\n"
1.86      schwarze  541:               "This web interface is documented in the\n"
1.144     schwarze  542:               "<a class=\"Xr\" href=\"/%s%sman.cgi.8\">man.cgi(8)</a>\n"
1.86      schwarze  543:               "manual, and the\n"
1.144     schwarze  544:               "<a class=\"Xr\" href=\"/%s%sapropos.1\">apropos(1)</a>\n"
1.69      schwarze  545:               "manual explains the query syntax.\n"
1.126     schwarze  546:               "</p>\n",
1.119     schwarze  547:               scriptname, *scriptname == '\0' ? "" : "/",
                    548:               scriptname, *scriptname == '\0' ? "" : "/");
1.6       kristaps  549:        resp_end_html();
                    550: }
                    551:
                    552: static void
1.168     schwarze  553: pg_noresult(const struct req *req, int code, const char *http_msg,
                    554:     const char *user_msg)
1.59      schwarze  555: {
1.168     schwarze  556:        resp_begin_html(code, http_msg, NULL);
1.131     schwarze  557:        resp_searchform(req, FOCUS_QUERY);
1.126     schwarze  558:        puts("<p>");
1.168     schwarze  559:        puts(user_msg);
1.126     schwarze  560:        puts("</p>");
1.59      schwarze  561:        resp_end_html();
                    562: }
                    563:
                    564: static void
1.72      schwarze  565: pg_error_badrequest(const char *msg)
1.9       kristaps  566: {
                    567:
1.150     schwarze  568:        resp_begin_html(400, "Bad Request", NULL);
1.126     schwarze  569:        puts("<h1>Bad Request</h1>\n"
                    570:             "<p>\n");
1.59      schwarze  571:        puts(msg);
                    572:        printf("Try again from the\n"
1.126     schwarze  573:               "<a href=\"/%s\">main page</a>.\n"
                    574:               "</p>", scriptname);
1.9       kristaps  575:        resp_end_html();
                    576: }
                    577:
                    578: static void
1.72      schwarze  579: pg_error_internal(void)
1.7       kristaps  580: {
1.150     schwarze  581:        resp_begin_html(500, "Internal Server Error", NULL);
1.126     schwarze  582:        puts("<p>Internal Server Error</p>");
1.7       kristaps  583:        resp_end_html();
                    584: }
                    585:
                    586: static void
1.149     schwarze  587: pg_redirect(const struct req *req, const char *name)
                    588: {
1.153     schwarze  589:        printf("Status: 303 See Other\r\n"
                    590:            "Location: /");
1.149     schwarze  591:        if (*scriptname != '\0')
                    592:                printf("%s/", scriptname);
                    593:        if (strcmp(req->q.manpath, req->p[0]))
                    594:                printf("%s/", req->q.manpath);
                    595:        if (req->q.arch != NULL)
                    596:                printf("%s/", req->q.arch);
1.159     schwarze  597:        http_encode(name);
                    598:        if (req->q.sec != NULL) {
                    599:                putchar('.');
                    600:                http_encode(req->q.sec);
                    601:        }
1.149     schwarze  602:        printf("\r\nContent-Type: text/html; charset=utf-8\r\n\r\n");
                    603: }
                    604:
                    605: static void
1.72      schwarze  606: pg_searchres(const struct req *req, struct manpage *r, size_t sz)
1.1       kristaps  607: {
1.81      schwarze  608:        char            *arch, *archend;
1.120     schwarze  609:        const char      *sec;
                    610:        size_t           i, iuse;
1.81      schwarze  611:        int              archprio, archpriouse;
1.70      schwarze  612:        int              prio, priouse;
1.19      kristaps  613:
1.76      schwarze  614:        for (i = 0; i < sz; i++) {
                    615:                if (validate_filename(r[i].file))
                    616:                        continue;
1.128     schwarze  617:                warnx("invalid filename %s in %s database",
1.76      schwarze  618:                    r[i].file, req->q.manpath);
                    619:                pg_error_internal();
                    620:                return;
                    621:        }
                    622:
1.121     schwarze  623:        if (req->isquery && sz == 1) {
1.6       kristaps  624:                /*
                    625:                 * If we have just one result, then jump there now
                    626:                 * without any delay.
                    627:                 */
1.153     schwarze  628:                printf("Status: 303 See Other\r\n"
                    629:                    "Location: /");
                    630:                if (*scriptname != '\0')
                    631:                        printf("%s/", scriptname);
                    632:                if (strcmp(req->q.manpath, req->p[0]))
                    633:                        printf("%s/", req->q.manpath);
                    634:                printf("%s\r\n"
                    635:                    "Content-Type: text/html; charset=utf-8\r\n\r\n",
                    636:                    r[0].file);
1.6       kristaps  637:                return;
                    638:        }
                    639:
1.70      schwarze  640:        /*
                    641:         * In man(1) mode, show one of the pages
                    642:         * even if more than one is found.
                    643:         */
                    644:
1.150     schwarze  645:        iuse = 0;
1.123     schwarze  646:        if (req->q.equal || sz == 1) {
1.120     schwarze  647:                priouse = 20;
1.81      schwarze  648:                archpriouse = 3;
1.70      schwarze  649:                for (i = 0; i < sz; i++) {
1.120     schwarze  650:                        sec = r[i].file;
                    651:                        sec += strcspn(sec, "123456789");
                    652:                        if (sec[0] == '\0')
1.70      schwarze  653:                                continue;
1.120     schwarze  654:                        prio = sec_prios[sec[0] - '1'];
                    655:                        if (sec[1] != '/')
                    656:                                prio += 10;
                    657:                        if (req->q.arch == NULL) {
1.81      schwarze  658:                                archprio =
1.120     schwarze  659:                                    ((arch = strchr(sec + 1, '/'))
                    660:                                        == NULL) ? 3 :
                    661:                                    ((archend = strchr(arch + 1, '/'))
                    662:                                        == NULL) ? 0 :
1.81      schwarze  663:                                    strncmp(arch, "amd64/",
                    664:                                        archend - arch) ? 2 : 1;
                    665:                                if (archprio < archpriouse) {
                    666:                                        archpriouse = archprio;
                    667:                                        priouse = prio;
                    668:                                        iuse = i;
                    669:                                        continue;
                    670:                                }
                    671:                                if (archprio > archpriouse)
                    672:                                        continue;
                    673:                        }
1.70      schwarze  674:                        if (prio >= priouse)
                    675:                                continue;
                    676:                        priouse = prio;
                    677:                        iuse = i;
                    678:                }
1.150     schwarze  679:                resp_begin_html(200, NULL, r[iuse].file);
                    680:        } else
                    681:                resp_begin_html(200, NULL, NULL);
                    682:
                    683:        resp_searchform(req,
                    684:            req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);
                    685:
                    686:        if (sz > 1) {
                    687:                puts("<table class=\"results\">");
                    688:                for (i = 0; i < sz; i++) {
                    689:                        printf("  <tr>\n"
                    690:                               "    <td>"
1.151     schwarze  691:                               "<a class=\"Xr\" href=\"/");
                    692:                        if (*scriptname != '\0')
                    693:                                printf("%s/", scriptname);
                    694:                        if (strcmp(req->q.manpath, req->p[0]))
                    695:                                printf("%s/", req->q.manpath);
                    696:                        printf("%s\">", r[i].file);
1.150     schwarze  697:                        html_print(r[i].names);
                    698:                        printf("</a></td>\n"
                    699:                               "    <td><span class=\"Nd\">");
                    700:                        html_print(r[i].output);
                    701:                        puts("</span></td>\n"
                    702:                             "  </tr>");
                    703:                }
                    704:                puts("</table>");
                    705:        }
                    706:
                    707:        if (req->q.equal || sz == 1) {
                    708:                puts("<hr>");
1.70      schwarze  709:                resp_show(req, r[iuse].file);
                    710:        }
                    711:
1.6       kristaps  712:        resp_end_html();
                    713: }
                    714:
1.1       kristaps  715: static void
1.129     schwarze  716: resp_catman(const struct req *req, const char *file)
1.9       kristaps  717: {
1.10      kristaps  718:        FILE            *f;
1.115     schwarze  719:        char            *p;
                    720:        size_t           sz;
                    721:        ssize_t          len;
1.10      kristaps  722:        int              i;
                    723:        int              italic, bold;
1.9       kristaps  724:
1.115     schwarze  725:        if ((f = fopen(file, "r")) == NULL) {
1.126     schwarze  726:                puts("<p>You specified an invalid manual file.</p>");
1.9       kristaps  727:                return;
                    728:        }
                    729:
1.126     schwarze  730:        puts("<div class=\"catman\">\n"
                    731:             "<pre>");
1.10      kristaps  732:
1.115     schwarze  733:        p = NULL;
                    734:        sz = 0;
                    735:
                    736:        while ((len = getline(&p, &sz, f)) != -1) {
1.10      kristaps  737:                bold = italic = 0;
1.115     schwarze  738:                for (i = 0; i < len - 1; i++) {
1.104     schwarze  739:                        /*
1.10      kristaps  740:                         * This means that the catpage is out of state.
                    741:                         * Ignore it and keep going (although the
                    742:                         * catpage is bogus).
                    743:                         */
                    744:
                    745:                        if ('\b' == p[i] || '\n' == p[i])
                    746:                                continue;
                    747:
                    748:                        /*
                    749:                         * Print a regular character.
                    750:                         * Close out any bold/italic scopes.
                    751:                         * If we're in back-space mode, make sure we'll
                    752:                         * have something to enter when we backspace.
                    753:                         */
                    754:
                    755:                        if ('\b' != p[i + 1]) {
                    756:                                if (italic)
1.126     schwarze  757:                                        printf("</i>");
1.10      kristaps  758:                                if (bold)
1.126     schwarze  759:                                        printf("</b>");
1.10      kristaps  760:                                italic = bold = 0;
                    761:                                html_putchar(p[i]);
                    762:                                continue;
1.115     schwarze  763:                        } else if (i + 2 >= len)
1.10      kristaps  764:                                continue;
                    765:
                    766:                        /* Italic mode. */
                    767:
                    768:                        if ('_' == p[i]) {
                    769:                                if (bold)
1.126     schwarze  770:                                        printf("</b>");
1.10      kristaps  771:                                if ( ! italic)
1.126     schwarze  772:                                        printf("<i>");
1.10      kristaps  773:                                bold = 0;
                    774:                                italic = 1;
                    775:                                i += 2;
                    776:                                html_putchar(p[i]);
                    777:                                continue;
                    778:                        }
                    779:
1.104     schwarze  780:                        /*
1.10      kristaps  781:                         * Handle funny behaviour troff-isms.
                    782:                         * These grok'd from the original man2html.c.
                    783:                         */
                    784:
                    785:                        if (('+' == p[i] && 'o' == p[i + 2]) ||
                    786:                                        ('o' == p[i] && '+' == p[i + 2]) ||
                    787:                                        ('|' == p[i] && '=' == p[i + 2]) ||
                    788:                                        ('=' == p[i] && '|' == p[i + 2]) ||
                    789:                                        ('*' == p[i] && '=' == p[i + 2]) ||
                    790:                                        ('=' == p[i] && '*' == p[i + 2]) ||
                    791:                                        ('*' == p[i] && '|' == p[i + 2]) ||
                    792:                                        ('|' == p[i] && '*' == p[i + 2]))  {
                    793:                                if (italic)
1.126     schwarze  794:                                        printf("</i>");
1.10      kristaps  795:                                if (bold)
1.126     schwarze  796:                                        printf("</b>");
1.10      kristaps  797:                                italic = bold = 0;
                    798:                                putchar('*');
                    799:                                i += 2;
                    800:                                continue;
                    801:                        } else if (('|' == p[i] && '-' == p[i + 2]) ||
                    802:                                        ('-' == p[i] && '|' == p[i + 1]) ||
                    803:                                        ('+' == p[i] && '-' == p[i + 1]) ||
                    804:                                        ('-' == p[i] && '+' == p[i + 1]) ||
                    805:                                        ('+' == p[i] && '|' == p[i + 1]) ||
                    806:                                        ('|' == p[i] && '+' == p[i + 1]))  {
                    807:                                if (italic)
1.126     schwarze  808:                                        printf("</i>");
1.10      kristaps  809:                                if (bold)
1.126     schwarze  810:                                        printf("</b>");
1.10      kristaps  811:                                italic = bold = 0;
                    812:                                putchar('+');
                    813:                                i += 2;
                    814:                                continue;
                    815:                        }
                    816:
                    817:                        /* Bold mode. */
1.104     schwarze  818:
1.10      kristaps  819:                        if (italic)
1.126     schwarze  820:                                printf("</i>");
1.10      kristaps  821:                        if ( ! bold)
1.126     schwarze  822:                                printf("<b>");
1.10      kristaps  823:                        bold = 1;
                    824:                        italic = 0;
                    825:                        i += 2;
                    826:                        html_putchar(p[i]);
                    827:                }
                    828:
1.104     schwarze  829:                /*
1.10      kristaps  830:                 * Clean up the last character.
1.104     schwarze  831:                 * We can get to a newline; don't print that.
1.10      kristaps  832:                 */
1.9       kristaps  833:
1.10      kristaps  834:                if (italic)
1.126     schwarze  835:                        printf("</i>");
1.10      kristaps  836:                if (bold)
1.126     schwarze  837:                        printf("</b>");
1.9       kristaps  838:
1.115     schwarze  839:                if (i == len - 1 && p[i] != '\n')
1.10      kristaps  840:                        html_putchar(p[i]);
1.9       kristaps  841:
1.10      kristaps  842:                putchar('\n');
                    843:        }
1.115     schwarze  844:        free(p);
1.10      kristaps  845:
1.126     schwarze  846:        puts("</pre>\n"
                    847:             "</div>");
1.10      kristaps  848:
                    849:        fclose(f);
1.9       kristaps  850: }
                    851:
                    852: static void
1.129     schwarze  853: resp_format(const struct req *req, const char *file)
1.7       kristaps  854: {
1.106     schwarze  855:        struct manoutput conf;
1.8       kristaps  856:        struct mparse   *mp;
1.164     schwarze  857:        struct roff_meta *meta;
1.8       kristaps  858:        void            *vp;
1.90      schwarze  859:        int              fd;
                    860:        int              usepath;
1.7       kristaps  861:
1.8       kristaps  862:        if (-1 == (fd = open(file, O_RDONLY, 0))) {
1.126     schwarze  863:                puts("<p>You specified an invalid manual file.</p>");
1.7       kristaps  864:                return;
                    865:        }
                    866:
1.110     schwarze  867:        mchars_alloc();
1.164     schwarze  868:        mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1 |
                    869:            MPARSE_VALIDATE, MANDOC_OS_OTHER, req->q.manpath);
1.103     schwarze  870:        mparse_readfd(mp, fd, file);
1.8       kristaps  871:        close(fd);
1.164     schwarze  872:        meta = mparse_result(mp);
1.7       kristaps  873:
1.106     schwarze  874:        memset(&conf, 0, sizeof(conf));
                    875:        conf.fragment = 1;
1.145     schwarze  876:        conf.style = mandoc_strdup(CSS_DIR "/mandoc.css");
1.90      schwarze  877:        usepath = strcmp(req->q.manpath, req->p[0]);
1.152     schwarze  878:        mandoc_asprintf(&conf.man, "/%s%s%s%s%%N.%%S",
                    879:            scriptname, *scriptname == '\0' ? "" : "/",
1.122     schwarze  880:            usepath ? req->q.manpath : "", usepath ? "/" : "");
1.10      kristaps  881:
1.110     schwarze  882:        vp = html_alloc(&conf);
1.164     schwarze  883:        if (meta->macroset == MACROSET_MDOC)
                    884:                html_mdoc(vp, meta);
                    885:        else
                    886:                html_man(vp, meta);
1.32      kristaps  887:
1.8       kristaps  888:        html_free(vp);
                    889:        mparse_free(mp);
1.110     schwarze  890:        mchars_free();
1.106     schwarze  891:        free(conf.man);
1.145     schwarze  892:        free(conf.style);
1.7       kristaps  893: }
                    894:
                    895: static void
1.70      schwarze  896: resp_show(const struct req *req, const char *file)
                    897: {
1.76      schwarze  898:
                    899:        if ('.' == file[0] && '/' == file[1])
1.71      schwarze  900:                file += 2;
1.70      schwarze  901:
                    902:        if ('c' == *file)
1.129     schwarze  903:                resp_catman(req, file);
1.70      schwarze  904:        else
1.129     schwarze  905:                resp_format(req, file);
1.70      schwarze  906: }
                    907:
                    908: static void
1.84      schwarze  909: pg_show(struct req *req, const char *fullpath)
1.1       kristaps  910: {
1.84      schwarze  911:        char            *manpath;
                    912:        const char      *file;
1.25      kristaps  913:
1.84      schwarze  914:        if ((file = strchr(fullpath, '/')) == NULL) {
1.72      schwarze  915:                pg_error_badrequest(
1.59      schwarze  916:                    "You did not specify a page to show.");
1.25      kristaps  917:                return;
1.104     schwarze  918:        }
1.84      schwarze  919:        manpath = mandoc_strndup(fullpath, file - fullpath);
                    920:        file++;
1.6       kristaps  921:
1.84      schwarze  922:        if ( ! validate_manpath(req, manpath)) {
1.77      schwarze  923:                pg_error_badrequest(
                    924:                    "You specified an invalid manpath.");
1.84      schwarze  925:                free(manpath);
1.77      schwarze  926:                return;
                    927:        }
                    928:
1.24      kristaps  929:        /*
1.58      schwarze  930:         * Begin by chdir()ing into the manpath.
1.24      kristaps  931:         * This way we can pick up the database files, which are
                    932:         * relative to the manpath root.
                    933:         */
                    934:
1.84      schwarze  935:        if (chdir(manpath) == -1) {
1.128     schwarze  936:                warn("chdir %s", manpath);
1.77      schwarze  937:                pg_error_internal();
1.84      schwarze  938:                free(manpath);
1.76      schwarze  939:                return;
                    940:        }
1.134     schwarze  941:        free(manpath);
1.84      schwarze  942:
                    943:        if ( ! validate_filename(file)) {
1.76      schwarze  944:                pg_error_badrequest(
                    945:                    "You specified an invalid manual file.");
1.24      kristaps  946:                return;
                    947:        }
1.79      schwarze  948:
1.150     schwarze  949:        resp_begin_html(200, NULL, file);
1.131     schwarze  950:        resp_searchform(req, FOCUS_NONE);
1.84      schwarze  951:        resp_show(req, file);
1.70      schwarze  952:        resp_end_html();
1.6       kristaps  953: }
                    954:
                    955: static void
1.66      schwarze  956: pg_search(const struct req *req)
1.6       kristaps  957: {
1.52      schwarze  958:        struct mansearch          search;
                    959:        struct manpaths           paths;
                    960:        struct manpage           *res;
1.97      schwarze  961:        char                    **argv;
                    962:        char                     *query, *rp, *wp;
1.52      schwarze  963:        size_t                    ressz;
1.97      schwarze  964:        int                       argc;
1.6       kristaps  965:
                    966:        /*
1.24      kristaps  967:         * Begin by chdir()ing into the root of the manpath.
                    968:         * This way we can pick up the database files, which are
                    969:         * relative to the manpath root.
                    970:         */
                    971:
1.128     schwarze  972:        if (chdir(req->q.manpath) == -1) {
                    973:                warn("chdir %s", req->q.manpath);
1.77      schwarze  974:                pg_error_internal();
1.24      kristaps  975:                return;
                    976:        }
                    977:
1.52      schwarze  978:        search.arch = req->q.arch;
                    979:        search.sec = req->q.sec;
1.94      schwarze  980:        search.outkey = "Nd";
                    981:        search.argmode = req->q.equal ? ARG_NAME : ARG_EXPR;
1.101     schwarze  982:        search.firstmatch = 1;
1.52      schwarze  983:
                    984:        paths.sz = 1;
                    985:        paths.paths = mandoc_malloc(sizeof(char *));
                    986:        paths.paths[0] = mandoc_strdup(".");
1.24      kristaps  987:
                    988:        /*
1.97      schwarze  989:         * Break apart at spaces with backslash-escaping.
1.6       kristaps  990:         */
                    991:
1.97      schwarze  992:        argc = 0;
                    993:        argv = NULL;
                    994:        rp = query = mandoc_strdup(req->q.query);
                    995:        for (;;) {
                    996:                while (isspace((unsigned char)*rp))
                    997:                        rp++;
                    998:                if (*rp == '\0')
                    999:                        break;
                   1000:                argv = mandoc_reallocarray(argv, argc + 1, sizeof(char *));
                   1001:                argv[argc++] = wp = rp;
                   1002:                for (;;) {
                   1003:                        if (isspace((unsigned char)*rp)) {
                   1004:                                *wp = '\0';
                   1005:                                rp++;
                   1006:                                break;
                   1007:                        }
                   1008:                        if (rp[0] == '\\' && rp[1] != '\0')
                   1009:                                rp++;
                   1010:                        if (wp != rp)
                   1011:                                *wp = *rp;
                   1012:                        if (*rp == '\0')
                   1013:                                break;
                   1014:                        wp++;
                   1015:                        rp++;
                   1016:                }
1.6       kristaps 1017:        }
                   1018:
1.149     schwarze 1019:        res = NULL;
                   1020:        ressz = 0;
                   1021:        if (req->isquery && req->q.equal && argc == 1)
                   1022:                pg_redirect(req, argv[0]);
                   1023:        else if (mansearch(&search, &paths, argc, argv, &res, &ressz) == 0)
1.168     schwarze 1024:                pg_noresult(req, 400, "Bad Request",
                   1025:                    "You entered an invalid query.");
1.149     schwarze 1026:        else if (ressz == 0)
1.168     schwarze 1027:                pg_noresult(req, 404, "Not Found", "No results found.");
1.59      schwarze 1028:        else
1.72      schwarze 1029:                pg_searchres(req, res, ressz);
1.6       kristaps 1030:
1.97      schwarze 1031:        free(query);
                   1032:        mansearch_free(res, ressz);
1.52      schwarze 1033:        free(paths.paths[0]);
                   1034:        free(paths.paths);
1.1       kristaps 1035: }
                   1036:
                   1037: int
                   1038: main(void)
                   1039: {
1.66      schwarze 1040:        struct req       req;
1.95      schwarze 1041:        struct itimerval itimer;
1.66      schwarze 1042:        const char      *path;
1.83      schwarze 1043:        const char      *querystring;
1.1       kristaps 1044:        int              i;
1.148     schwarze 1045:
                   1046: #if HAVE_PLEDGE
                   1047:        /*
                   1048:         * The "rpath" pledge could be revoked after mparse_readfd()
                   1049:         * if the file desciptor to "/footer.html" would be opened
                   1050:         * up front, but it's probably not worth the complication
                   1051:         * of the code it would cause: it would require scattering
                   1052:         * pledge() calls in multiple low-level resp_*() functions.
                   1053:         */
                   1054:
                   1055:        if (pledge("stdio rpath", NULL) == -1) {
                   1056:                warn("pledge");
                   1057:                pg_error_internal();
                   1058:                return EXIT_FAILURE;
                   1059:        }
                   1060: #endif
1.95      schwarze 1061:
                   1062:        /* Poor man's ReDoS mitigation. */
                   1063:
1.99      schwarze 1064:        itimer.it_value.tv_sec = 2;
1.95      schwarze 1065:        itimer.it_value.tv_usec = 0;
1.99      schwarze 1066:        itimer.it_interval.tv_sec = 2;
1.95      schwarze 1067:        itimer.it_interval.tv_usec = 0;
                   1068:        if (setitimer(ITIMER_VIRTUAL, &itimer, NULL) == -1) {
1.128     schwarze 1069:                warn("setitimer");
1.80      schwarze 1070:                pg_error_internal();
1.109     schwarze 1071:                return EXIT_FAILURE;
1.80      schwarze 1072:        }
                   1073:
1.24      kristaps 1074:        /*
1.67      schwarze 1075:         * First we change directory into the MAN_DIR so that
1.24      kristaps 1076:         * subsequent scanning for manpath directories is rooted
                   1077:         * relative to the same position.
                   1078:         */
                   1079:
1.128     schwarze 1080:        if (chdir(MAN_DIR) == -1) {
                   1081:                warn("MAN_DIR: %s", MAN_DIR);
1.72      schwarze 1082:                pg_error_internal();
1.109     schwarze 1083:                return EXIT_FAILURE;
1.104     schwarze 1084:        }
1.24      kristaps 1085:
                   1086:        memset(&req, 0, sizeof(struct req));
1.118     schwarze 1087:        req.q.equal = 1;
1.129     schwarze 1088:        parse_manpath_conf(&req);
1.1       kristaps 1089:
1.117     schwarze 1090:        /* Parse the path info and the query string. */
1.1       kristaps 1091:
1.117     schwarze 1092:        if ((path = getenv("PATH_INFO")) == NULL)
                   1093:                path = "";
                   1094:        else if (*path == '/')
                   1095:                path++;
                   1096:
1.124     schwarze 1097:        if (*path != '\0') {
1.129     schwarze 1098:                parse_path_info(&req, path);
1.154     schwarze 1099:                if (req.q.manpath == NULL || req.q.sec == NULL ||
                   1100:                    *req.q.query == '\0' || access(path, F_OK) == -1)
1.124     schwarze 1101:                        path = "";
1.117     schwarze 1102:        } else if ((querystring = getenv("QUERY_STRING")) != NULL)
1.129     schwarze 1103:                parse_query_string(&req, querystring);
1.77      schwarze 1104:
1.117     schwarze 1105:        /* Validate parsed data and add defaults. */
                   1106:
1.102     schwarze 1107:        if (req.q.manpath == NULL)
                   1108:                req.q.manpath = mandoc_strdup(req.p[0]);
                   1109:        else if ( ! validate_manpath(&req, req.q.manpath)) {
1.77      schwarze 1110:                pg_error_badrequest(
                   1111:                    "You specified an invalid manpath.");
1.109     schwarze 1112:                return EXIT_FAILURE;
1.77      schwarze 1113:        }
1.1       kristaps 1114:
1.159     schwarze 1115:        if (req.q.arch != NULL && validate_arch(req.q.arch) == 0) {
1.80      schwarze 1116:                pg_error_badrequest(
                   1117:                    "You specified an invalid architecture.");
1.109     schwarze 1118:                return EXIT_FAILURE;
1.80      schwarze 1119:        }
                   1120:
1.66      schwarze 1121:        /* Dispatch to the three different pages. */
1.1       kristaps 1122:
1.66      schwarze 1123:        if ('\0' != *path)
                   1124:                pg_show(&req, path);
1.85      schwarze 1125:        else if (NULL != req.q.query)
1.66      schwarze 1126:                pg_search(&req);
                   1127:        else
1.72      schwarze 1128:                pg_index(&req);
1.1       kristaps 1129:
1.83      schwarze 1130:        free(req.q.manpath);
                   1131:        free(req.q.arch);
                   1132:        free(req.q.sec);
1.85      schwarze 1133:        free(req.q.query);
1.52      schwarze 1134:        for (i = 0; i < (int)req.psz; i++)
                   1135:                free(req.p[i]);
1.24      kristaps 1136:        free(req.p);
1.109     schwarze 1137:        return EXIT_SUCCESS;
1.117     schwarze 1138: }
                   1139:
                   1140: /*
1.161     schwarze 1141:  * Translate PATH_INFO to a query.
1.117     schwarze 1142:  */
                   1143: static void
1.129     schwarze 1144: parse_path_info(struct req *req, const char *path)
1.117     schwarze 1145: {
1.161     schwarze 1146:        const char      *name, *sec, *end;
1.117     schwarze 1147:
1.121     schwarze 1148:        req->isquery = 0;
1.117     schwarze 1149:        req->q.equal = 1;
1.161     schwarze 1150:        req->q.manpath = NULL;
1.135     schwarze 1151:        req->q.arch = NULL;
1.117     schwarze 1152:
                   1153:        /* Mandatory manual page name. */
1.161     schwarze 1154:        if ((name = strrchr(path, '/')) == NULL)
                   1155:                name = path;
                   1156:        else
                   1157:                name++;
1.117     schwarze 1158:
                   1159:        /* Optional trailing section. */
1.161     schwarze 1160:        sec = strrchr(name, '.');
                   1161:        if (sec != NULL && isdigit((unsigned char)*++sec)) {
                   1162:                req->q.query = mandoc_strndup(name, sec - name - 1);
                   1163:                req->q.sec = mandoc_strdup(sec);
                   1164:        } else {
                   1165:                req->q.query = mandoc_strdup(name);
                   1166:                req->q.sec = NULL;
1.117     schwarze 1167:        }
                   1168:
                   1169:        /* Handle the case of name[.section] only. */
1.161     schwarze 1170:        if (name == path)
1.117     schwarze 1171:                return;
                   1172:
1.135     schwarze 1173:        /* Optional manpath. */
1.161     schwarze 1174:        end = strchr(path, '/');
                   1175:        req->q.manpath = mandoc_strndup(path, end - path);
                   1176:        if (validate_manpath(req, req->q.manpath)) {
                   1177:                path = end + 1;
                   1178:                if (name == path)
                   1179:                        return;
                   1180:        } else {
                   1181:                free(req->q.manpath);
1.135     schwarze 1182:                req->q.manpath = NULL;
1.161     schwarze 1183:        }
1.117     schwarze 1184:
1.135     schwarze 1185:        /* Optional section. */
1.165     schwarze 1186:        if (strncmp(path, "man", 3) == 0 || strncmp(path, "cat", 3) == 0) {
1.161     schwarze 1187:                path += 3;
                   1188:                end = strchr(path, '/');
1.127     schwarze 1189:                free(req->q.sec);
1.161     schwarze 1190:                req->q.sec = mandoc_strndup(path, end - path);
                   1191:                path = end + 1;
                   1192:                if (name == path)
                   1193:                        return;
1.117     schwarze 1194:        }
1.161     schwarze 1195:
                   1196:        /* Optional architecture. */
                   1197:        end = strchr(path, '/');
                   1198:        if (end + 1 != name) {
                   1199:                pg_error_badrequest(
                   1200:                    "You specified too many directory components.");
                   1201:                exit(EXIT_FAILURE);
1.135     schwarze 1202:        }
1.161     schwarze 1203:        req->q.arch = mandoc_strndup(path, end - path);
                   1204:        if (validate_arch(req->q.arch) == 0) {
1.135     schwarze 1205:                pg_error_badrequest(
                   1206:                    "You specified an invalid directory component.");
                   1207:                exit(EXIT_FAILURE);
                   1208:        }
1.24      kristaps 1209: }
                   1210:
                   1211: /*
                   1212:  * Scan for indexable paths.
                   1213:  */
                   1214: static void
1.129     schwarze 1215: parse_manpath_conf(struct req *req)
1.24      kristaps 1216: {
1.54      schwarze 1217:        FILE    *fp;
                   1218:        char    *dp;
                   1219:        size_t   dpsz;
1.115     schwarze 1220:        ssize_t  len;
1.54      schwarze 1221:
1.128     schwarze 1222:        if ((fp = fopen("manpath.conf", "r")) == NULL) {
                   1223:                warn("%s/manpath.conf", MAN_DIR);
1.74      schwarze 1224:                pg_error_internal();
                   1225:                exit(EXIT_FAILURE);
                   1226:        }
1.24      kristaps 1227:
1.115     schwarze 1228:        dp = NULL;
                   1229:        dpsz = 0;
                   1230:
                   1231:        while ((len = getline(&dp, &dpsz, fp)) != -1) {
                   1232:                if (dp[len - 1] == '\n')
                   1233:                        dp[--len] = '\0';
1.54      schwarze 1234:                req->p = mandoc_realloc(req->p,
                   1235:                    (req->psz + 1) * sizeof(char *));
1.80      schwarze 1236:                if ( ! validate_urifrag(dp)) {
1.128     schwarze 1237:                        warnx("%s/manpath.conf contains "
                   1238:                            "unsafe path \"%s\"", MAN_DIR, dp);
1.80      schwarze 1239:                        pg_error_internal();
                   1240:                        exit(EXIT_FAILURE);
                   1241:                }
1.128     schwarze 1242:                if (strchr(dp, '/') != NULL) {
                   1243:                        warnx("%s/manpath.conf contains "
                   1244:                            "path with slash \"%s\"", MAN_DIR, dp);
1.80      schwarze 1245:                        pg_error_internal();
                   1246:                        exit(EXIT_FAILURE);
                   1247:                }
                   1248:                req->p[req->psz++] = dp;
1.115     schwarze 1249:                dp = NULL;
                   1250:                dpsz = 0;
1.74      schwarze 1251:        }
1.115     schwarze 1252:        free(dp);
1.74      schwarze 1253:
1.128     schwarze 1254:        if (req->p == NULL) {
                   1255:                warnx("%s/manpath.conf is empty", MAN_DIR);
1.74      schwarze 1256:                pg_error_internal();
                   1257:                exit(EXIT_FAILURE);
1.24      kristaps 1258:        }
                   1259: }

CVSweb