Automated function-comment nitpicking.
[privoxy.git] / cgi.c
diff --git a/cgi.c b/cgi.c
index e700c73..641af64 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,4 +1,4 @@
-const char cgi_rcs[] = "$Id: cgi.c,v 1.38 2001/11/13 00:31:21 jongfoster Exp $";
+const char cgi_rcs[] = "$Id: cgi.c,v 1.44 2002/03/05 22:43:45 david__schmidt Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/cgi.c,v $
@@ -38,6 +38,31 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.38 2001/11/13 00:31:21 jongfoster Exp $";
  *
  * Revisions   :
  *    $Log: cgi.c,v $
+ *    Revision 1.44  2002/03/05 22:43:45  david__schmidt
+ *    - Better error reporting on OS/2
+ *    - Fix double-slash comment (oops)
+ *
+ *    Revision 1.43  2002/03/05 21:33:45  david__schmidt
+ *    - Re-enable OS/2 building after new parms were added
+ *    - Fix false out of memory report when resolving CGI templates when no IP
+ *      address is available of failed attempt (a la no such domain)
+ *
+ *    Revision 1.42  2002/01/21 00:33:20  jongfoster
+ *    Replacing strsav() with the safer string_append() or string_join().
+ *    Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
+ *    Adding missing html_encode() to error message generators.
+ *    Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
+ *
+ *    Revision 1.41  2002/01/17 20:56:22  jongfoster
+ *    Replacing hard references to the URL of the config interface
+ *    with #defines from project.h
+ *
+ *    Revision 1.40  2002/01/09 14:26:46  oes
+ *    Added support for thread-safe gmtime_r call.
+ *
+ *    Revision 1.39  2001/11/16 00:48:13  jongfoster
+ *    Fixing a compiler warning
+ *
  *    Revision 1.38  2001/11/13 00:31:21  jongfoster
  *    - Adding new CGIs for use by non-JavaScript browsers:
  *        edit-actions-url-form
@@ -309,6 +334,29 @@ static const struct cgi_dispatcher cgi_dispatchers[] = {
    { "edit-actions",
          cgi_edit_actions, 
          "Edit the actions list" },
+
+   
+   { "eaa", /* Shortcut for edit-actions-add-url-form */
+         cgi_edit_actions_add_url_form, 
+         NULL },
+   { "eau", /* Shortcut for edit-actions-url-form */
+         cgi_edit_actions_url_form, 
+         NULL },
+   { "ear", /* Shortcut for edit-actions-remove-url-form */
+         cgi_edit_actions_remove_url_form, 
+         NULL },
+   { "eas", /* Shortcut for edit-actions-for-url */
+         cgi_edit_actions_for_url, 
+         NULL },
+   { "easa", /* Shortcut for edit-actions-section-add */
+         cgi_edit_actions_section_add, 
+         NULL },
+   { "easr", /* Shortcut for edit-actions-section-remove */
+         cgi_edit_actions_section_remove, 
+         NULL },
+   { "eass", /* Shortcut for edit-actions-section-swap */
+         cgi_edit_actions_section_swap, 
+         NULL },
    { "edit-actions-for-url",
          cgi_edit_actions_for_url, 
          NULL /* Edit the actions for (a) specified URL(s) */ },
@@ -336,12 +384,15 @@ static const struct cgi_dispatcher cgi_dispatchers[] = {
    { "edit-actions-remove-url-form",
          cgi_edit_actions_remove_url_form, 
          NULL /* Form to remove a URL pattern from the actionsfile */ },
-   { "edit-actions-section-remove",
-         cgi_edit_actions_section_remove, 
-         NULL /* Remove a section from the actionsfile */ },
    { "edit-actions-section-add",
          cgi_edit_actions_section_add, 
          NULL /* Remove a section from the actionsfile */ },
+   { "edit-actions-section-remove",
+         cgi_edit_actions_section_remove, 
+         NULL /* Remove a section from the actionsfile */ },
+   { "edit-actions-section-swap",
+         cgi_edit_actions_section_swap, 
+         NULL /* Swap two sections in the actionsfile */ },
 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
    { "robots.txt", 
          cgi_robots_txt,  
@@ -349,6 +400,9 @@ static const struct cgi_dispatcher cgi_dispatchers[] = {
    { "send-banner",
          cgi_send_banner, 
          NULL /* Send the transparent or \"Junkbuster\" gif */ },
+   { "t",
+         cgi_transparent_gif, 
+         NULL /* Send a transparent gif (short name) */ },
    { NULL, /* NULL Indicates end of list and default page */
          cgi_error_404,
          NULL /* Unknown CGI page */ }
@@ -395,8 +449,10 @@ static struct map *parse_cgi_parameters(char *argstring);
  * 
  * Function    :  dispatch_cgi
  *
- * Description :  Checks if a request URL has either the magical hostname
- *                i.j.b or matches HOME_PAGE_URL/config/. If so, it passes
+ * Description :  Checks if a request URL has either the magical
+ *                hostname CGI_SITE_1_HOST (usully http://i.j.b/) or
+ *                matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
+ *                http://ijbswa.sourceforge.net/config). If so, it passes
  *                the (rest of the) path onto dispatch_known_cgi, which
  *                calls the relevant CGI handler function.
  *
@@ -415,27 +471,34 @@ struct http_response *dispatch_cgi(struct client_state *csp)
     * Should we intercept ?
     */
 
-   /* Either the host matches CGI_PREFIX_HOST ..*/
-   if (   (0 == strcmpic(host, CGI_PREFIX_HOST))
+   /* Note: "example.com" and "example.com." are equivalent hostnames. */
+
+   /* Either the host matches CGI_SITE_1_HOST ..*/
+   if (   ( (0 == strcmpic(host, CGI_SITE_1_HOST))
+         || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
        && (path[0] == '/') )
    {
       /* ..then the path will all be for us.  Remove leading '/' */
       path++;
    }
-   /* Or it's the host part HOME_PAGE_URL, and the path /config/ */
-   else if (   (0 == strcmpic(host, HOME_PAGE_URL + 7 ))
-            && (0 == strncmpic(path,"/config", 7)) )
+   /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
+   else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
+            || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
+          && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
    {
-      /* take everything following "/config" */
-      path += 7;
+      /* take everything following CGI_SITE_2_PATH */
+      path += strlen(CGI_SITE_2_PATH);
       if (*path == '/')
       {
-         /* skip the forward slash after "/config" */
+         /* skip the forward slash after CGI_SITE_2_PATH */
          path++;
       }
       else if (*path != '\0')
       {
-         /* wierdness: URL is /configXXX, where XXX is some string */
+         /*
+          * wierdness: URL is /configXXX, where XXX is some string
+          * Do *NOT* intercept.
+          */
          return NULL;
       }
    }
@@ -630,13 +693,20 @@ struct http_response *error_response(struct client_state *csp,
       return cgi_error_memory();
    }
 
-   err = map(exports, "host-html", 1, html_encode(csp->http->host), 0);
-   if (!err) err = map(exports, "hostport", 1, csp->http->hostport, 1);
-   if (!err) err = map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0);
-   if (!err) err = map(exports, "path", 1, csp->http->path, 1);
-   if (!err) err = map(exports, "path-html", 1, html_encode(csp->http->path), 0);
-   if (!err) err = map(exports, "error", 1, safe_strerror(sys_err), 0);
-   if (!err) err = map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1);
+   err = map(exports, "host", 1, html_encode(csp->http->host), 0);
+   if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
+   if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
+   if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
+   if (!err)
+   {
+     err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
+     if (err)
+     {
+       /* Some failures, like "404 no such domain", don't have an IP address. */
+       err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
+     }
+   }
+
 
    if (err)
    {
@@ -701,7 +771,7 @@ void cgi_init_error_messages(void)
       "<head><title>500 Internal JunkBuster Proxy Error</title></head>\r\n"
       "<body>\r\n"
       "<h1>500 Internal JunkBuster Proxy Error</h1>\r\n"
-      "<p>JunkBuster <b>ran out of memory</b> whilst processing your request.</p>\r\n"
+      "<p>JunkBuster <b>ran out of memory</b> while processing your request.</p>\r\n"
       "<p>Please contact your proxy administrator, or try again later</p>\r\n"
       "</body>\r\n"
       "</html>\r\n";
@@ -721,9 +791,9 @@ void cgi_init_error_messages(void)
  *                Returns a statically-allocated error response.
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  template_name = Name of template that could not
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  template_name = Name of template that could not
  *                                be loaded.
  *
  * Returns     :  JB_ERR_OK on success
@@ -749,9 +819,9 @@ struct http_response *cgi_error_memory(void)
  *                parameters.
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  template_name = Name of template that could not
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  template_name = Name of template that could not
  *                                be loaded.
  *
  * Returns     :  JB_ERR_OK on success
@@ -769,7 +839,7 @@ jb_err cgi_error_no_template(struct client_state *csp,
       "<head><title>500 Internal JunkBuster Proxy Error</title></head>\r\n"
       "<body>\r\n"
       "<h1>500 Internal JunkBuster Proxy Error</h1>\r\n"
-      "<p>JunkBuster encountered an error whilst processing your request:</p>\r\n"
+      "<p>JunkBuster encountered an error while processing your request:</p>\r\n"
       "<p><b>Could not load template file <code>";
    static const char body_suffix[] =
       "</code></b></p>\r\n"
@@ -825,8 +895,8 @@ jb_err cgi_error_no_template(struct client_state *csp,
  *                (query string) for a CGI were wrong.
  *               
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
  *
  * CGI Parameters : none
  *
@@ -886,7 +956,14 @@ void get_http_time(int time_offset, char *buf)
    current_time += time_offset;
 
    /* get and save the gmt */
-   t = gmtime(&current_time);
+   {
+#ifdef HAVE_GMTIME_R
+      struct tm dummy;
+      t = gmtime_r(&current_time, &dummy);
+#else
+      t = gmtime(&current_time);
+#endif
+   }
 
    /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
    snprintf(buf, 30,
@@ -1072,10 +1149,10 @@ void free_http_response(struct http_response *rsp)
  *                lines. 
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  template_ptr = Destination for pointer to loaded
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  template_ptr = Destination for pointer to loaded
  *                               template text.
- *           3 :  template = name of the HTML template to be used
+ *           :  template = name of the HTML template to be used
  *
  * Returns     :  JB_ERR_OK on success
  *                JB_ERR_MEMORY on out-of-memory error.  
@@ -1171,11 +1248,11 @@ jb_err template_load(struct client_state *csp, char ** template_ptr,
  *                interpretation.
  *
  * Parameters  :
- *           1 :  template_ptr = IN: Template to be filled out.
+ *           :  template_ptr = IN: Template to be filled out.
  *                                   Will be free()d.
  *                               OUT: Filled out template.
  *                                    Caller must free().
- *           2 :  exports = map with fill in symbol -> name pairs
+ *           :  exports = map with fill in symbol -> name pairs
  *
  * Returns     :  JB_ERR_OK on success
  *                JB_ERR_MEMORY on out-of-memory error
@@ -1278,9 +1355,9 @@ jb_err template_fill(char **template_ptr, const struct map *exports)
  *                this function also frees the passed "exports" map.
  *
  * Parameters  :
- *           1 :  csp = Client state
- *           2 :  templatename = name of the HTML template to be used
- *           3 :  exports = map with fill in symbol -> name pairs.
+ *           :  csp = Client state
+ *           :  templatename = name of the HTML template to be used
+ *           :  exports = map with fill in symbol -> name pairs.
  *                          Will be freed by this function.
  *
  * Returns     :  JB_ERR_OK on success
@@ -1346,13 +1423,13 @@ struct map *default_exports(const struct client_state *csp, const char *caller)
       return NULL;
    }
 
-   err = map(exports, "version", 1, VERSION, 1);
-   if (!err) err = map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1);
-   if (!err) err = map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1);
-   if (!err) err = map(exports, "homepage", 1, HOME_PAGE_URL, 1);
-   if (!err) err = map(exports, "default-cgi", 1, HOME_PAGE_URL "/config", 1);
-   if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
-   if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
+   err = map(exports, "version", 1, html_encode(VERSION), 0);
+   if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
+   if (!err) err = map(exports, "my-hostname",   1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
+   if (!err) err = map(exports, "homepage",      1, html_encode(HOME_PAGE_URL), 0);
+   if (!err) err = map(exports, "default-cgi",   1, html_encode(CGI_PREFIX), 0);
+   if (!err) err = map(exports, "menu",          1, make_menu(caller), 0);
+   if (!err) err = map(exports, "code-status",   1, CODE_STATUS, 1);
    if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB);
 
    snprintf(buf, 20, "%d", csp->config->hport);
@@ -1365,7 +1442,7 @@ struct map *default_exports(const struct client_state *csp, const char *caller)
 
    if (csp->config->admin_address != NULL)
    {
-      if (!err) err = map(exports, "admin-address", 1, csp->config->admin_address, 1);
+      if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
       local_help_exists = 1;
    }
    else
@@ -1375,7 +1452,7 @@ struct map *default_exports(const struct client_state *csp, const char *caller)
 
    if (csp->config->proxy_info_url != NULL)
    {
-      if (!err) err = map(exports, "proxy-info-url", 1, csp->config->proxy_info_url, 1);
+      if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
       local_help_exists = 1;
    }
    else
@@ -1429,6 +1506,44 @@ jb_err map_block_killer(struct map *exports, const char *name)
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  map_block_keep
+ *
+ * Description :  Convenience function.  Removes the markers used
+ *                by map-block-killer, to save a few bytes.
+ *                i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
+ *
+ * Parameters  :  
+ *          1  :  exports = map to extend
+ *          2  :  name = name of conditional block
+ *
+ * Returns     :  JB_ERR_OK on success
+ *                JB_ERR_MEMORY on out-of-memory error.  
+ *
+ *********************************************************************/
+jb_err map_block_keep(struct map *exports, const char *name)
+{
+   jb_err err;
+   char buf[500]; /* Will do, since the names are hardwired */
+
+   assert(exports);
+   assert(name);
+   assert(strlen(name) < 490);
+
+   snprintf(buf, 500, "if-%s-start", name);
+   err = map(exports, buf, 1, "", 1);
+
+   if (err)
+   {
+      return err;
+   }
+
+   snprintf(buf, 500, "if-%s-end", name);
+   return map(exports, buf, 1, "", 1);
+}
+
+
 /*********************************************************************
  *
  * Function    :  map_conditional
@@ -1488,14 +1603,13 @@ jb_err map_conditional(struct map *exports, const char *name, int choose_first)
  *
  * Parameters  :  self = name of CGI to leave out, can be NULL
  *
- * Returns     :  menu string
+ * Returns     :  menu string, or NULL on out-of-memory error.
  *
  *********************************************************************/
 char *make_menu(const char *self)
 {
    const struct cgi_dispatcher *d;
-   char buf[BUFFER_SIZE];
-   char *result = NULL;
+   char *result = strdup("");
 
    if (self == NULL)
    {
@@ -1507,13 +1621,15 @@ char *make_menu(const char *self)
    {
       if (d->description && strcmp(d->name, self))
       {
-         snprintf(buf, BUFFER_SIZE, "<li><a href=\"%s/config/%s\">%s</a></li>\n",
-              HOME_PAGE_URL, d->name, d->description);
-         result = strsav(result, buf);
+         string_append(&result, "<li><a href=\"" CGI_PREFIX);
+         string_append(&result, d->name);
+         string_append(&result, "\">");
+         string_append(&result, d->description);
+         string_append(&result, "</a></li>\n");
       }
    }
-   return(result);
 
+   return result;
 }
 
 
@@ -1531,24 +1647,24 @@ char *make_menu(const char *self)
  *********************************************************************/
 char *dump_map(const struct map *the_map)
 {
-   struct map_entry *cur_entry = the_map->first;
-   char *ret = NULL;
+   struct map_entry *cur_entry;
+   char *ret = strdup("");
 
-   ret = strsav(ret, "<table>\n");
+   string_append(&ret, "<table>\n");
 
-   while (cur_entry)
+   for (cur_entry = the_map->first;
+        (cur_entry != NULL) && (ret != NULL);
+        cur_entry = cur_entry->next)
    {
-      ret = strsav(ret, "<tr><td><b>");
-      ret = strsav(ret, cur_entry->name);
-      ret = strsav(ret, "</b></td><td>");
-      ret = strsav(ret, cur_entry->value);
-      ret = strsav(ret, "</td></tr>\n");
-      cur_entry = cur_entry->next;
+      string_append(&ret, "<tr><td><b>");
+      string_join  (&ret, html_encode(cur_entry->name));
+      string_append(&ret, "</b></td><td>");
+      string_join  (&ret, html_encode(cur_entry->value));
+      string_append(&ret, "</td></tr>\n");
    }
 
-   ret = strsav(ret, "</table>\n");
-   return(ret);
-
+   string_append(&ret, "</table>\n");
+   return ret;
 }