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

Diff for /mandoc/cgi.c between version 1.168 and 1.181

version 1.168, 2019/10/01 17:54:14 version 1.181, 2023/04/28 19:11:03
Line 1 
Line 1 
 /*      $Id$ */  /* $Id$ */
 /*  /*
    * Copyright (c) 2014-2019, 2021, 2022 Ingo Schwarze <schwarze@usta.de>
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2014-2019 Ingo Schwarze <schwarze@usta.de>   * Copyright (c) 2022 Anna Vyalkova <cyber@sysrq.in>
  *   *
  * 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 14 
Line 15 
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
    *
    * Implementation of the man.cgi(8) program.
  */   */
 #include "config.h"  #include "config.h"
   
Line 70  enum focus {
Line 73  enum focus {
 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 *);
 static  void             http_encode(const char *p);  static  void             http_encode(const char *);
 static  void             parse_manpath_conf(struct req *);  static  void             parse_manpath_conf(struct req *);
 static  void             parse_path_info(struct req *req, const char *path);  static  void             parse_path_info(struct req *, const char *);
 static  void             parse_query_string(struct req *, const char *);  static  void             parse_query_string(struct req *, const char *);
 static  void             pg_error_badrequest(const char *);  static  void             pg_error_badrequest(const char *);
 static  void             pg_error_internal(void);  static  void             pg_error_internal(void);
Line 84  static void   pg_search(const struct req *);
Line 87  static void   pg_search(const struct req *);
 static  void             pg_searchres(const struct req *,  static  void             pg_searchres(const struct req *,
                                 struct manpage *, size_t);                                  struct manpage *, size_t);
 static  void             pg_show(struct req *, const char *);  static  void             pg_show(struct req *, const char *);
 static  void             resp_begin_html(int, const char *, const char *);  static  int              resp_begin_html(int, const char *, const char *);
 static  void             resp_begin_http(int, const char *);  static  void             resp_begin_http(int, const char *);
 static  void             resp_catman(const struct req *, const char *);  static  void             resp_catman(const struct req *, const char *);
 static  void             resp_copy(const char *);  static  int              resp_copy(const char *, 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 *, enum focus);  static  void             resp_searchform(const struct req *, enum focus);
Line 120  static const char *const sec_names[] = {
Line 123  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",       "armv7",      "arm64",      "amd64",       "alpha",       "armv7",       "arm64",
     "hppa",        "i386",        "landisk",      "hppa",        "i386",        "landisk",     "loongson",
     "loongson",    "luna88k",     "macppc",      "mips64",      "luna88k",     "macppc",      "mips64",      "octeon",
     "octeon",      "sgi",         "socppc",      "sparc64",      "powerpc64",   "riscv64",     "sparc64",
   
     "amiga",       "arc",         "armish",      "arm32",      "amiga",       "arc",         "armish",      "arm32",
     "atari",       "aviion",      "beagle",      "cats",      "atari",       "aviion",      "beagle",      "cats",
     "hppa64",      "hp300",      "hppa64",      "hp300",
     "ia64",        "mac68k",      "mvme68k",     "mvme88k",      "ia64",        "mac68k",      "mvme68k",     "mvme88k",
     "mvmeppc",     "palm",        "pc532",       "pegasos",      "mvmeppc",     "palm",        "pc532",       "pegasos",
     "pmax",        "powerpc",     "solbourne",   "sparc",      "pmax",        "powerpc",     "sgi",         "socppc",
       "solbourne",   "sparc",
     "sun3",        "vax",         "wgrisc",      "x68k",      "sun3",        "vax",         "wgrisc",      "x68k",
     "zaurus"      "zaurus"
 };  };
Line 340  resp_begin_http(int code, const char *msg)
Line 345  resp_begin_http(int code, const char *msg)
   
         printf("Content-Type: text/html; charset=utf-8\r\n"          printf("Content-Type: text/html; charset=utf-8\r\n"
              "Cache-Control: no-cache\r\n"               "Cache-Control: no-cache\r\n"
                "Content-Security-Policy: default-src 'none'; "
                "style-src 'self' 'unsafe-inline'\r\n"
              "Pragma: no-cache\r\n"               "Pragma: no-cache\r\n"
              "\r\n");               "\r\n");
   
         fflush(stdout);          fflush(stdout);
 }  }
   
 static void  static int
 resp_copy(const char *filename)  resp_copy(const char *element, const char *filename)
 {  {
         char     buf[4096];          char     buf[4096];
         ssize_t  sz;          ssize_t  sz;
         int      fd;          int      fd;
   
         if ((fd = open(filename, O_RDONLY)) != -1) {          if ((fd = open(filename, O_RDONLY)) == -1)
                 fflush(stdout);                  return 0;
                 while ((sz = read(fd, buf, sizeof(buf))) > 0)  
                         write(STDOUT_FILENO, buf, sz);          if (element != NULL)
                 close(fd);                  printf("<%s>\n", element);
         }          fflush(stdout);
           while ((sz = read(fd, buf, sizeof(buf))) > 0)
                   write(STDOUT_FILENO, buf, sz);
           close(fd);
           return 1;
 }  }
   
 static void  static int
 resp_begin_html(int code, const char *msg, const char *file)  resp_begin_html(int code, const char *msg, const char *file)
 {  {
         char    *cp;          const char      *name, *sec, *cp;
           int              namesz, secsz;
   
         resp_begin_http(code, msg);          resp_begin_http(code, msg);
   
Line 379  resp_begin_html(int code, const char *msg, const char 
Line 391  resp_begin_html(int code, const char *msg, const char 
                "  <title>",                 "  <title>",
                CSS_DIR);                 CSS_DIR);
         if (file != NULL) {          if (file != NULL) {
                 if ((cp = strrchr(file, '/')) != NULL)                  cp = strrchr(file, '/');
                         file = cp + 1;                  name = cp == NULL ? file : cp + 1;
                 if ((cp = strrchr(file, '.')) != NULL) {                  cp = strrchr(name, '.');
                         printf("%.*s(%s) - ", (int)(cp - file), file, cp + 1);                  namesz = cp == NULL ? strlen(name) : cp - name;
                 } else                  sec = NULL;
                         printf("%s - ", file);                  if (cp != NULL && cp[1] != '0') {
                           sec = cp + 1;
                           secsz = strlen(sec);
                   } else if (name - file > 1) {
                           for (cp = name - 2; cp >= file; cp--) {
                                   if (*cp < '1' || *cp > '9')
                                           continue;
                                   sec = cp;
                                   secsz = name - cp - 1;
                                   break;
                           }
                   }
                   printf("%.*s", namesz, name);
                   if (sec != NULL)
                           printf("(%.*s)", secsz, sec);
                   fputs(" - ", stdout);
         }          }
         printf("%s</title>\n"          printf("%s</title>\n"
                "</head>\n"                 "</head>\n"
                "<body>\n",                 "<body>\n",
                CUSTOMIZE_TITLE);                 CUSTOMIZE_TITLE);
   
         resp_copy(MAN_DIR "/header.html");          return resp_copy("header", MAN_DIR "/header.html");
 }  }
   
 static void  static void
 resp_end_html(void)  resp_end_html(void)
 {  {
           if (resp_copy("footer", MAN_DIR "/footer.html"))
                   puts("</footer>");
   
         resp_copy(MAN_DIR "/footer.html");  
   
         puts("</body>\n"          puts("</body>\n"
              "</html>");               "</html>");
 }  }
Line 409  resp_searchform(const struct req *req, enum focus focu
Line 436  resp_searchform(const struct req *req, enum focus focu
 {  {
         int              i;          int              i;
   
         printf("<form action=\"/%s\" method=\"get\">\n"          printf("<form role=\"search\" action=\"/%s\" method=\"get\" "
                  "autocomplete=\"off\" autocapitalize=\"none\">\n"
                "  <fieldset>\n"                 "  <fieldset>\n"
                "    <legend>Manual Page Search Parameters</legend>\n",                 "    <legend>Manual Page Search Parameters</legend>\n",
                scriptname);                 scriptname);
   
         /* Write query input box. */          /* Write query input box. */
   
         printf("    <input type=\"search\" name=\"query\" value=\"");          printf("    <label>Search query:\n"
                  "      <input type=\"search\" name=\"query\" value=\"");
         if (req->q.query != NULL)          if (req->q.query != NULL)
                 html_print(req->q.query);                  html_print(req->q.query);
         printf( "\" size=\"40\"");          printf("\" size=\"40\"");
         if (focus == FOCUS_QUERY)          if (focus == FOCUS_QUERY)
                 printf(" autofocus");                  printf(" autofocus");
         puts(">");          puts(">\n    </label>");
   
         /* Write submission buttons. */          /* Write submission buttons. */
   
Line 434  resp_searchform(const struct req *req, enum focus focu
Line 463  resp_searchform(const struct req *req, enum focus focu
   
         /* Write section selector. */          /* Write section selector. */
   
         puts("    <select name=\"sec\">");          puts("    <select name=\"sec\" aria-label=\"Manual section\">");
         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 &&
Line 446  resp_searchform(const struct req *req, enum focus focu
Line 475  resp_searchform(const struct req *req, enum focus focu
   
         /* Write architecture selector. */          /* Write architecture selector. */
   
         printf( "    <select name=\"arch\">\n"          printf( "    <select name=\"arch\" aria-label=\"CPU architecture\">\n"
                 "      <option value=\"default\"");                  "      <option value=\"default\"");
         if (NULL == req->q.arch)          if (NULL == req->q.arch)
                 printf(" selected=\"selected\"");                  printf(" selected=\"selected\"");
Line 463  resp_searchform(const struct req *req, enum focus focu
Line 492  resp_searchform(const struct req *req, enum focus focu
         /* Write manpath selector. */          /* Write manpath selector. */
   
         if (req->psz > 1) {          if (req->psz > 1) {
                 puts("    <select name=\"manpath\">");                  puts("    <select name=\"manpath\""
                        " aria-label=\"Manual path\">");
                 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)
Line 531  validate_filename(const char *file)
Line 561  validate_filename(const char *file)
 static void  static void
 pg_index(const struct req *req)  pg_index(const struct req *req)
 {  {
           if (resp_begin_html(200, NULL, NULL) == 0)
         resp_begin_html(200, NULL, NULL);                  puts("<header>");
         resp_searchform(req, FOCUS_QUERY);          resp_searchform(req, FOCUS_QUERY);
         printf("<p>\n"          printf("</header>\n"
                  "<main>\n"
                  "<p role=\"doc-notice\" aria-label=\"Usage\">\n"
                "This web interface is documented in the\n"                 "This web interface is documented in the\n"
                "<a class=\"Xr\" href=\"/%s%sman.cgi.8\">man.cgi(8)</a>\n"                 "<a class=\"Xr\" href=\"/%s%sman.cgi.8\""
                  " aria-label=\"man dot CGI, section 8\">man.cgi(8)</a>\n"
                "manual, and the\n"                 "manual, and the\n"
                "<a class=\"Xr\" href=\"/%s%sapropos.1\">apropos(1)</a>\n"                 "<a class=\"Xr\" href=\"/%s%sapropos.1\""
                  " aria-label=\"apropos, section 1\">apropos(1)</a>\n"
                "manual explains the query syntax.\n"                 "manual explains the query syntax.\n"
                "</p>\n",                 "</p>\n"
                  "</main>\n",
                scriptname, *scriptname == '\0' ? "" : "/",                 scriptname, *scriptname == '\0' ? "" : "/",
                scriptname, *scriptname == '\0' ? "" : "/");                 scriptname, *scriptname == '\0' ? "" : "/");
         resp_end_html();          resp_end_html();
Line 550  static void
Line 585  static void
 pg_noresult(const struct req *req, int code, const char *http_msg,  pg_noresult(const struct req *req, int code, const char *http_msg,
     const char *user_msg)      const char *user_msg)
 {  {
         resp_begin_html(code, http_msg, NULL);          if (resp_begin_html(code, http_msg, NULL) == 0)
                   puts("<header>");
         resp_searchform(req, FOCUS_QUERY);          resp_searchform(req, FOCUS_QUERY);
         puts("<p>");          puts("</header>");
           puts("<main>");
           puts("<p role=\"doc-notice\" aria-label=\"No result\">");
         puts(user_msg);          puts(user_msg);
         puts("</p>");          puts("</p>");
           puts("</main>");
         resp_end_html();          resp_end_html();
 }  }
   
 static void  static void
 pg_error_badrequest(const char *msg)  pg_error_badrequest(const char *msg)
 {  {
           if (resp_begin_html(400, "Bad Request", NULL))
         resp_begin_html(400, "Bad Request", NULL);                  puts("</header>");
         puts("<h1>Bad Request</h1>\n"          puts("<main>\n"
              "<p>\n");               "<h1>Bad Request</h1>\n"
                "<p role=\"doc-notice\" aria-label=\"Bad Request\">");
         puts(msg);          puts(msg);
         printf("Try again from the\n"          printf("Try again from the\n"
                "<a href=\"/%s\">main page</a>.\n"                 "<a href=\"/%s\">main page</a>.\n"
                "</p>", scriptname);                 "</p>\n"
                  "</main>\n", scriptname);
         resp_end_html();          resp_end_html();
 }  }
   
 static void  static void
 pg_error_internal(void)  pg_error_internal(void)
 {  {
         resp_begin_html(500, "Internal Server Error", NULL);          if (resp_begin_html(500, "Internal Server Error", NULL))
         puts("<p>Internal Server Error</p>");                  puts("</header>");
           puts("<main><p role=\"doc-notice\">Internal Server Error</p></main>");
         resp_end_html();          resp_end_html();
 }  }
   
Line 607  pg_searchres(const struct req *req, struct manpage *r,
Line 649  pg_searchres(const struct req *req, struct manpage *r,
         size_t           i, iuse;          size_t           i, iuse;
         int              archprio, archpriouse;          int              archprio, archpriouse;
         int              prio, priouse;          int              prio, priouse;
           int              have_header;
   
         for (i = 0; i < sz; i++) {          for (i = 0; i < sz; i++) {
                 if (validate_filename(r[i].file))                  if (validate_filename(r[i].file))
Line 673  pg_searchres(const struct req *req, struct manpage *r,
Line 716  pg_searchres(const struct req *req, struct manpage *r,
                         priouse = prio;                          priouse = prio;
                         iuse = i;                          iuse = i;
                 }                  }
                 resp_begin_html(200, NULL, r[iuse].file);                  have_header = resp_begin_html(200, NULL, r[iuse].file);
         } else          } else
                 resp_begin_html(200, NULL, NULL);                  have_header = resp_begin_html(200, NULL, NULL);
   
           if (have_header == 0)
                   puts("<header>");
         resp_searchform(req,          resp_searchform(req,
             req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);              req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);
           puts("</header>");
   
         if (sz > 1) {          if (sz > 1) {
                   puts("<nav>");
                 puts("<table class=\"results\">");                  puts("<table class=\"results\">");
                 for (i = 0; i < sz; i++) {                  for (i = 0; i < sz; i++) {
                         printf("  <tr>\n"                          printf("  <tr>\n"
Line 699  pg_searchres(const struct req *req, struct manpage *r,
Line 746  pg_searchres(const struct req *req, struct manpage *r,
                              "  </tr>");                               "  </tr>");
                 }                  }
                 puts("</table>");                  puts("</table>");
                   puts("</nav>");
         }          }
   
         if (req->q.equal || sz == 1) {          if (req->q.equal || sz == 1) {
Line 720  resp_catman(const struct req *req, const char *file)
Line 768  resp_catman(const struct req *req, const char *file)
         int              italic, bold;          int              italic, bold;
   
         if ((f = fopen(file, "r")) == NULL) {          if ((f = fopen(file, "r")) == NULL) {
                 puts("<p>You specified an invalid manual file.</p>");                  puts("<p role=\"doc-notice\">\n"
                        "  You specified an invalid manual file.\n"
                        "</p>");
                 return;                  return;
         }          }
   
Line 856  resp_format(const struct req *req, const char *file)
Line 906  resp_format(const struct req *req, const char *file)
         int              fd;          int              fd;
         int              usepath;          int              usepath;
   
         if (-1 == (fd = open(file, O_RDONLY, 0))) {          if (-1 == (fd = open(file, O_RDONLY))) {
                 puts("<p>You specified an invalid manual file.</p>");                  puts("<p role=\"doc-notice\">\n"
                        "  You specified an invalid manual file.\n"
                        "</p>");
                 return;                  return;
         }          }
   
Line 943  pg_show(struct req *req, const char *fullpath)
Line 995  pg_show(struct req *req, const char *fullpath)
                 return;                  return;
         }          }
   
         resp_begin_html(200, NULL, file);          if (resp_begin_html(200, NULL, file) == 0)
                   puts("<header>");
         resp_searchform(req, FOCUS_NONE);          resp_searchform(req, FOCUS_NONE);
           puts("</header>");
         resp_show(req, file);          resp_show(req, file);
         resp_end_html();          resp_end_html();
 }  }
Line 1043  main(void)
Line 1097  main(void)
 #if HAVE_PLEDGE  #if HAVE_PLEDGE
         /*          /*
          * The "rpath" pledge could be revoked after mparse_readfd()           * The "rpath" pledge could be revoked after mparse_readfd()
          * if the file desciptor to "/footer.html" would be opened           * if the file descriptor to "/footer.html" would be opened
          * up front, but it's probably not worth the complication           * up front, but it's probably not worth the complication
          * of the code it would cause: it would require scattering           * of the code it would cause: it would require scattering
          * pledge() calls in multiple low-level resp_*() functions.           * pledge() calls in multiple low-level resp_*() functions.

Legend:
Removed from v.1.168  
changed lines
  Added in v.1.181

CVSweb