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

Diff for /mandoc/cgi.c between version 1.129 and 1.148

version 1.129, 2016/04/15 21:14:51 version 1.148, 2017/02/22 16:20:01
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2014, 2015, 2016 Ingo Schwarze <schwarze@usta.de>   * Copyright (c) 2014, 2015, 2016, 2017 Ingo Schwarze <schwarze@usta.de>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 21 
Line 21 
 #include <sys/time.h>  #include <sys/time.h>
   
 #include <ctype.h>  #include <ctype.h>
   #if HAVE_ERR
 #include <err.h>  #include <err.h>
   #endif
 #include <errno.h>  #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <limits.h>  #include <limits.h>
Line 59  struct req {
Line 61  struct req {
         int               isquery; /* QUERY_STRING used, not PATH_INFO */          int               isquery; /* QUERY_STRING used, not PATH_INFO */
 };  };
   
   enum    focus {
           FOCUS_NONE = 0,
           FOCUS_QUERY
   };
   
 static  void             html_print(const char *);  static  void             html_print(const char *);
 static  void             html_putchar(char);  static  void             html_putchar(char);
 static  int              http_decode(char *);  static  int              http_decode(char *);
Line 79  static void   resp_catman(const struct req *, const ch
Line 86  static void   resp_catman(const struct req *, const ch
 static  void             resp_copy(const char *);  static  void             resp_copy(const char *);
 static  void             resp_end_html(void);  static  void             resp_end_html(void);
 static  void             resp_format(const struct req *, const char *);  static  void             resp_format(const struct req *, const char *);
 static  void             resp_searchform(const struct req *);  static  void             resp_searchform(const struct req *, enum focus);
 static  void             resp_show(const struct req *, const char *);  static  void             resp_show(const struct req *, const char *);
 static  void             set_query_attr(char **, char **);  static  void             set_query_attr(char **, char **);
 static  int              validate_filename(const char *);  static  int              validate_filename(const char *);
Line 108  static const char *const sec_names[] = {
Line 115  static const char *const sec_names[] = {
 static  const int sec_MAX = sizeof(sec_names) / sizeof(char *);  static  const int sec_MAX = sizeof(sec_names) / sizeof(char *);
   
 static  const char *const arch_names[] = {  static  const char *const arch_names[] = {
     "amd64",       "alpha",       "armish",      "armv7",      "amd64",       "alpha",       "armv7",      "arm64",
     "hppa",        "hppa64",      "i386",        "landisk",      "hppa",        "i386",        "landisk",
     "loongson",    "luna88k",     "macppc",      "mips64",      "loongson",    "luna88k",     "macppc",      "mips64",
     "octeon",      "sgi",         "socppc",      "sparc",      "octeon",      "sgi",         "socppc",      "sparc64",
     "sparc64",     "zaurus",      "amiga",       "arc",         "armish",      "arm32",
     "amiga",       "arc",         "arm32",       "atari",      "atari",       "aviion",      "beagle",      "cats",
     "aviion",      "beagle",      "cats",        "hp300",      "hppa64",      "hp300",
     "ia64",        "mac68k",      "mvme68k",     "mvme88k",      "ia64",        "mac68k",      "mvme68k",     "mvme88k",
     "mvmeppc",     "palm",        "pc532",       "pegasos",      "mvmeppc",     "palm",        "pc532",       "pegasos",
     "pmax",        "powerpc",     "solbourne",   "sun3",      "pmax",        "powerpc",     "solbourne",   "sparc",
     "vax",         "wgrisc",      "x68k"      "sun3",        "vax",         "wgrisc",      "x68k",
       "zaurus"
 };  };
 static  const int arch_MAX = sizeof(arch_names) / sizeof(char *);  static  const int arch_MAX = sizeof(arch_names) / sizeof(char *);
   
Line 132  html_putchar(char c)
Line 140  html_putchar(char c)
   
         switch (c) {          switch (c) {
         case ('"'):          case ('"'):
                 printf("&quote;");                  printf("&quot;");
                 break;                  break;
         case ('&'):          case ('&'):
                 printf("&amp;");                  printf("&amp;");
Line 332  resp_copy(const char *filename)
Line 340  resp_copy(const char *filename)
                 fflush(stdout);                  fflush(stdout);
                 while ((sz = read(fd, buf, sizeof(buf))) > 0)                  while ((sz = read(fd, buf, sizeof(buf))) > 0)
                         write(STDOUT_FILENO, buf, sz);                          write(STDOUT_FILENO, buf, sz);
                   close(fd);
         }          }
 }  }
   
Line 344  resp_begin_html(int code, const char *msg)
Line 353  resp_begin_html(int code, const char *msg)
         printf("<!DOCTYPE html>\n"          printf("<!DOCTYPE html>\n"
                "<html>\n"                 "<html>\n"
                "<head>\n"                 "<head>\n"
                "<meta charset=\"UTF-8\"/>\n"                 "  <meta charset=\"UTF-8\"/>\n"
                "<link rel=\"stylesheet\" href=\"%s/mandoc.css\""                 "  <link rel=\"stylesheet\" href=\"%s/mandoc.css\""
                " type=\"text/css\" media=\"all\">\n"                 " type=\"text/css\" media=\"all\">\n"
                "<title>%s</title>\n"                 "  <title>%s</title>\n"
                "</head>\n"                 "</head>\n"
                "<body>\n"                 "<body>\n",
                "<!-- Begin page content. //-->\n",  
                CSS_DIR, CUSTOMIZE_TITLE);                 CSS_DIR, CUSTOMIZE_TITLE);
   
         resp_copy(MAN_DIR "/header.html");          resp_copy(MAN_DIR "/header.html");
Line 367  resp_end_html(void)
Line 375  resp_end_html(void)
 }  }
   
 static void  static void
 resp_searchform(const struct req *req)  resp_searchform(const struct req *req, enum focus focus)
 {  {
         int              i;          int              i;
   
         puts("<!-- Begin search form. //-->");          printf("<form action=\"/%s\" method=\"get\">\n"
         printf("<div id=\"mancgi\">\n"                 "  <fieldset>\n"
                "<form action=\"/%s\" method=\"get\">\n"                 "    <legend>Manual Page Search Parameters</legend>\n",
                "<fieldset>\n"  
                "<legend>Manual Page Search Parameters</legend>\n",  
                scriptname);                 scriptname);
   
         /* Write query input box. */          /* Write query input box. */
   
         printf( "<table><tr><td>\n"          printf("    <input type=\"text\" name=\"query\" value=\"");
                 "<input type=\"text\" name=\"query\" value=\"");          if (req->q.query != NULL)
         if (NULL != req->q.query)  
                 html_print(req->q.query);                  html_print(req->q.query);
         puts("\" size=\"40\">");          printf( "\" size=\"40\"");
           if (focus == FOCUS_QUERY)
                   printf(" autofocus");
           puts(">");
   
         /* Write submission and reset buttons. */          /* Write submission buttons. */
   
         printf( "<input type=\"submit\" value=\"Submit\">\n"          printf( "    <button type=\"submit\" name=\"apropos\" value=\"0\">"
                 "<input type=\"reset\" value=\"Reset\">\n");                  "man</button>\n"
                   "    <button type=\"submit\" name=\"apropos\" value=\"1\">"
                   "apropos</button>\n"
                   "    <br/>\n");
   
         /* Write show radio button */  
   
         printf( "</td><td>\n"  
                 "<input type=\"radio\" ");  
         if (req->q.equal)  
                 printf("checked=\"checked\" ");  
         printf( "name=\"apropos\" id=\"show\" value=\"0\">\n"  
                 "<label for=\"show\">Show named manual page</label>\n");  
   
         /* Write section selector. */          /* Write section selector. */
   
         puts(   "</td></tr><tr><td>\n"          puts("    <select name=\"sec\">");
                 "<select name=\"sec\">");  
         for (i = 0; i < sec_MAX; i++) {          for (i = 0; i < sec_MAX; i++) {
                 printf("<option value=\"%s\"", sec_numbers[i]);                  printf("      <option value=\"%s\"", sec_numbers[i]);
                 if (NULL != req->q.sec &&                  if (NULL != req->q.sec &&
                     0 == strcmp(sec_numbers[i], req->q.sec))                      0 == strcmp(sec_numbers[i], req->q.sec))
                         printf(" selected=\"selected\"");                          printf(" selected=\"selected\"");
                 printf(">%s</option>\n", sec_names[i]);                  printf(">%s</option>\n", sec_names[i]);
         }          }
         puts("</select>");          puts("    </select>");
   
         /* Write architecture selector. */          /* Write architecture selector. */
   
         printf( "<select name=\"arch\">\n"          printf( "    <select name=\"arch\">\n"
                 "<option value=\"default\"");                  "      <option value=\"default\"");
         if (NULL == req->q.arch)          if (NULL == req->q.arch)
                 printf(" selected=\"selected\"");                  printf(" selected=\"selected\"");
         puts(">All Architectures</option>");          puts(">All Architectures</option>");
         for (i = 0; i < arch_MAX; i++) {          for (i = 0; i < arch_MAX; i++) {
                 printf("<option value=\"%s\"", arch_names[i]);                  printf("      <option value=\"%s\"", arch_names[i]);
                 if (NULL != req->q.arch &&                  if (NULL != req->q.arch &&
                     0 == strcmp(arch_names[i], req->q.arch))                      0 == strcmp(arch_names[i], req->q.arch))
                         printf(" selected=\"selected\"");                          printf(" selected=\"selected\"");
                 printf(">%s</option>\n", arch_names[i]);                  printf(">%s</option>\n", arch_names[i]);
         }          }
         puts("</select>");          puts("    </select>");
   
         /* Write manpath selector. */          /* Write manpath selector. */
   
         if (req->psz > 1) {          if (req->psz > 1) {
                 puts("<select name=\"manpath\">");                  puts("    <select name=\"manpath\">");
                 for (i = 0; i < (int)req->psz; i++) {                  for (i = 0; i < (int)req->psz; i++) {
                         printf("<option ");                          printf("      <option ");
                         if (strcmp(req->q.manpath, req->p[i]) == 0)                          if (strcmp(req->q.manpath, req->p[i]) == 0)
                                 printf("selected=\"selected\" ");                                  printf("selected=\"selected\" ");
                         printf("value=\"");                          printf("value=\"");
Line 443  resp_searchform(const struct req *req)
Line 444  resp_searchform(const struct req *req)
                         html_print(req->p[i]);                          html_print(req->p[i]);
                         puts("</option>");                          puts("</option>");
                 }                  }
                 puts("</select>");                  puts("    </select>");
         }          }
   
         /* Write search radio button */          puts("  </fieldset>\n"
                "</form>");
         printf( "</td><td>\n"  
                 "<input type=\"radio\" ");  
         if (0 == req->q.equal)  
                 printf("checked=\"checked\" ");  
         printf( "name=\"apropos\" id=\"search\" value=\"1\">\n"  
                 "<label for=\"search\">Search with apropos query</label>\n");  
   
         puts("</td></tr></table>\n"  
              "</fieldset>\n"  
              "</form>\n"  
              "</div>");  
         puts("<!-- End search form. //-->");  
 }  }
   
 static int  static int
Line 481  validate_manpath(const struct req *req, const char* ma
Line 470  validate_manpath(const struct req *req, const char* ma
 {  {
         size_t   i;          size_t   i;
   
         if ( ! strcmp(manpath, "mandoc"))  
                 return 1;  
   
         for (i = 0; i < req->psz; i++)          for (i = 0; i < req->psz; i++)
                 if ( ! strcmp(manpath, req->p[i]))                  if ( ! strcmp(manpath, req->p[i]))
                         return 1;                          return 1;
Line 507  pg_index(const struct req *req)
Line 493  pg_index(const struct req *req)
 {  {
   
         resp_begin_html(200, NULL);          resp_begin_html(200, NULL);
         resp_searchform(req);          resp_searchform(req, FOCUS_QUERY);
         printf("<p>\n"          printf("<p>\n"
                "This web interface is documented in the\n"                 "This web interface is documented in the\n"
                "<a href=\"/%s%smandoc/man8/man.cgi.8\">man.cgi</a>\n"                 "<a class=\"Xr\" href=\"/%s%sman.cgi.8\">man.cgi(8)</a>\n"
                "manual, and the\n"                 "manual, and the\n"
                "<a href=\"/%s%smandoc/man1/apropos.1\">apropos</a>\n"                 "<a class=\"Xr\" href=\"/%s%sapropos.1\">apropos(1)</a>\n"
                "manual explains the query syntax.\n"                 "manual explains the query syntax.\n"
                "</p>\n",                 "</p>\n",
                scriptname, *scriptname == '\0' ? "" : "/",                 scriptname, *scriptname == '\0' ? "" : "/",
Line 524  static void
Line 510  static void
 pg_noresult(const struct req *req, const char *msg)  pg_noresult(const struct req *req, const char *msg)
 {  {
         resp_begin_html(200, NULL);          resp_begin_html(200, NULL);
         resp_searchform(req);          resp_searchform(req, FOCUS_QUERY);
         puts("<p>");          puts("<p>");
         puts(msg);          puts(msg);
         puts("</p>");          puts("</p>");
Line 588  pg_searchres(const struct req *req, struct manpage *r,
Line 574  pg_searchres(const struct req *req, struct manpage *r,
         }          }
   
         resp_begin_html(200, NULL);          resp_begin_html(200, NULL);
         resp_searchform(req);          resp_searchform(req,
               req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);
   
         if (sz > 1) {          if (sz > 1) {
                 puts("<div class=\"results\">");                  puts("<table class=\"results\">");
                 puts("<table>");  
   
                 for (i = 0; i < sz; i++) {                  for (i = 0; i < sz; i++) {
                         printf("<tr>\n"                          printf("  <tr>\n"
                                "<td class=\"title\">\n"                                 "    <td>"
                                "<a href=\"/%s%s%s/%s",                                 "<a class=\"Xr\" href=\"/%s%s%s/%s\">",
                             scriptname, *scriptname == '\0' ? "" : "/",                              scriptname, *scriptname == '\0' ? "" : "/",
                             req->q.manpath, r[i].file);                              req->q.manpath, r[i].file);
                         printf("\">");  
                         html_print(r[i].names);                          html_print(r[i].names);
                         printf("</a>\n"                          printf("</a></td>\n"
                                "</td>\n"                                 "    <td><span class=\"Nd\">");
                                "<td class=\"desc\">");  
                         html_print(r[i].output);                          html_print(r[i].output);
                         puts("</td>\n"                          puts("</span></td>\n"
                              "</tr>");                               "  </tr>");
                 }                  }
                   puts("</table>");
                 puts("</table>\n"  
                      "</div>");  
         }          }
   
         /*          /*
Line 813  resp_format(const struct req *req, const char *file)
Line 794  resp_format(const struct req *req, const char *file)
         }          }
   
         mchars_alloc();          mchars_alloc();
         mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_BADARG, NULL, req->q.manpath);          mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1,
               MANDOCLEVEL_BADARG, NULL, req->q.manpath);
         mparse_readfd(mp, fd, file);          mparse_readfd(mp, fd, file);
         close(fd);          close(fd);
   
         memset(&conf, 0, sizeof(conf));          memset(&conf, 0, sizeof(conf));
         conf.fragment = 1;          conf.fragment = 1;
           conf.style = mandoc_strdup(CSS_DIR "/mandoc.css");
         usepath = strcmp(req->q.manpath, req->p[0]);          usepath = strcmp(req->q.manpath, req->p[0]);
         mandoc_asprintf(&conf.man, "/%s%s%%N.%%S",          mandoc_asprintf(&conf.man, "/%s%s%%N.%%S",
             usepath ? req->q.manpath : "", usepath ? "/" : "");              usepath ? req->q.manpath : "", usepath ? "/" : "");
Line 846  resp_format(const struct req *req, const char *file)
Line 829  resp_format(const struct req *req, const char *file)
         mparse_free(mp);          mparse_free(mp);
         mchars_free();          mchars_free();
         free(conf.man);          free(conf.man);
           free(conf.style);
 }  }
   
 static void  static void
Line 894  pg_show(struct req *req, const char *fullpath)
Line 878  pg_show(struct req *req, const char *fullpath)
                 free(manpath);                  free(manpath);
                 return;                  return;
         }          }
           free(manpath);
   
         if (strcmp(manpath, "mandoc")) {  
                 free(req->q.manpath);  
                 req->q.manpath = manpath;  
         } else  
                 free(manpath);  
   
         if ( ! validate_filename(file)) {          if ( ! validate_filename(file)) {
                 pg_error_badrequest(                  pg_error_badrequest(
                     "You specified an invalid manual file.");                      "You specified an invalid manual file.");
Line 908  pg_show(struct req *req, const char *fullpath)
Line 887  pg_show(struct req *req, const char *fullpath)
         }          }
   
         resp_begin_html(200, NULL);          resp_begin_html(200, NULL);
         resp_searchform(req);          resp_searchform(req, FOCUS_NONE);
         resp_show(req, file);          resp_show(req, file);
         resp_end_html();          resp_end_html();
 }  }
Line 999  main(void)
Line 978  main(void)
         const char      *querystring;          const char      *querystring;
         int              i;          int              i;
   
   #if HAVE_PLEDGE
           /*
            * The "rpath" pledge could be revoked after mparse_readfd()
            * if the file desciptor to "/footer.html" would be opened
            * up front, but it's probably not worth the complication
            * of the code it would cause: it would require scattering
            * pledge() calls in multiple low-level resp_*() functions.
            */
   
           if (pledge("stdio rpath", NULL) == -1) {
                   warn("pledge");
                   pg_error_internal();
                   return EXIT_FAILURE;
           }
   #endif
   
         /* Poor man's ReDoS mitigation. */          /* Poor man's ReDoS mitigation. */
   
         itimer.it_value.tv_sec = 2;          itimer.it_value.tv_sec = 2;
Line 1036  main(void)
Line 1031  main(void)
   
         if (*path != '\0') {          if (*path != '\0') {
                 parse_path_info(&req, path);                  parse_path_info(&req, path);
                 if (access(path, F_OK) == -1)                  if (req.q.manpath == NULL || access(path, F_OK) == -1)
                         path = "";                          path = "";
         } else if ((querystring = getenv("QUERY_STRING")) != NULL)          } else if ((querystring = getenv("QUERY_STRING")) != NULL)
                 parse_query_string(&req, querystring);                  parse_query_string(&req, querystring);
Line 1082  main(void)
Line 1077  main(void)
 static void  static void
 parse_path_info(struct req *req, const char *path)  parse_path_info(struct req *req, const char *path)
 {  {
         char    *dir;          char    *dir[4];
           int      i;
   
         req->isquery = 0;          req->isquery = 0;
         req->q.equal = 1;          req->q.equal = 1;
         req->q.manpath = mandoc_strdup(path);          req->q.manpath = mandoc_strdup(path);
           req->q.arch = NULL;
   
         /* Mandatory manual page name. */          /* Mandatory manual page name. */
         if ((req->q.query = strrchr(req->q.manpath, '/')) == NULL) {          if ((req->q.query = strrchr(req->q.manpath, '/')) == NULL) {
Line 1105  parse_path_info(struct req *req, const char *path)
Line 1102  parse_path_info(struct req *req, const char *path)
         }          }
   
         /* Handle the case of name[.section] only. */          /* Handle the case of name[.section] only. */
         if (req->q.manpath == NULL) {          if (req->q.manpath == NULL)
                 req->q.arch = NULL;  
                 return;                  return;
         }  
         req->q.query = mandoc_strdup(req->q.query);          req->q.query = mandoc_strdup(req->q.query);
   
         /* Optional architecture. */          /* Split directory components. */
         dir = strrchr(req->q.manpath, '/');          dir[i = 0] = req->q.manpath;
         if (dir != NULL && strncmp(dir + 1, "man", 3) != 0) {          while ((dir[i + 1] = strchr(dir[i], '/')) != NULL) {
                 *dir++ = '\0';                  if (++i == 3) {
                 req->q.arch = mandoc_strdup(dir);                          pg_error_badrequest(
                 dir = strrchr(req->q.manpath, '/');                              "You specified too many directory components.");
         } else                          exit(EXIT_FAILURE);
                 req->q.arch = NULL;                  }
                   *dir[i]++ = '\0';
           }
   
         /* Optional directory name. */          /* Optional manpath. */
         if (dir != NULL && strncmp(dir + 1, "man", 3) == 0) {          if ((i = validate_manpath(req, req->q.manpath)) == 0)
                 *dir++ = '\0';                  req->q.manpath = NULL;
           else if (dir[1] == NULL)
                   return;
   
           /* Optional section. */
           if (strncmp(dir[i], "man", 3) == 0) {
                 free(req->q.sec);                  free(req->q.sec);
                 req->q.sec = mandoc_strdup(dir + 3);                  req->q.sec = mandoc_strdup(dir[i++] + 3);
         }          }
           if (dir[i] == NULL) {
                   if (req->q.manpath == NULL)
                           free(dir[0]);
                   return;
           }
           if (dir[i + 1] != NULL) {
                   pg_error_badrequest(
                       "You specified an invalid directory component.");
                   exit(EXIT_FAILURE);
           }
   
           /* Optional architecture. */
           if (i) {
                   req->q.arch = mandoc_strdup(dir[i]);
                   if (req->q.manpath == NULL)
                           free(dir[0]);
           } else
                   req->q.arch = dir[0];
 }  }
   
 /*  /*
Legend:
Removed from v.1.129  
changed lines
  Added in v.1.148
CVSweb