Automated function-comment nitpicking.
[privoxy.git] / cgisimple.c
index fb1562f..c3836db 100644 (file)
@@ -1,4 +1,4 @@
-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.8 2001/11/13 00:14:07 jongfoster Exp $";
+const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.14 2002/03/02 04:14:50 david__schmidt Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
@@ -36,6 +36,29 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.8 2001/11/13 00:14:07 jongfos
  *
  * Revisions   :
  *    $Log: cgisimple.c,v $
+ *    Revision 1.14  2002/03/02 04:14:50  david__schmidt
+ *    Clean up a little CRLF unpleasantness that suddenly appeared
+ *
+ *    Revision 1.13  2002/02/21 00:10:37  jongfoster
+ *    Adding send-banner?type=auto option
+ *
+ *    Revision 1.12  2002/01/23 01:03:32  jongfoster
+ *    Fixing gcc [CygWin] compiler warnings
+ *
+ *    Revision 1.11  2002/01/23 00:01:04  jongfoster
+ *    Adding cgi_transparent_gif() for http://i.j.b/t
+ *    Adding missing html_encode() to many CGI functions.
+ *    Adding urlmatch.[ch] to http://i.j.b/show-version
+ *
+ *    Revision 1.10  2002/01/17 21:10:37  jongfoster
+ *    Changes to cgi_show_url_info to use new matching code from urlmatch.c.
+ *    Also fixing a problem in the same function with improperly quoted URLs
+ *    in output HTML, and adding code to handle https:// URLs correctly.
+ *
+ *    Revision 1.9  2001/11/30 23:09:15  jongfoster
+ *    Now reports on FEATURE_CGI_EDIT_ACTIONS
+ *    Removing FEATURE_DENY_GZIP from template
+ *
  *    Revision 1.8  2001/11/13 00:14:07  jongfoster
  *    Fixing stupid bug now I've figured out what || means.
  *    (It always returns 0 or 1, not one of it's paramaters.)
@@ -98,6 +121,7 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.8 2001/11/13 00:14:07 jongfos
 #include "miscutil.h"
 #include "loadcfg.h"
 #include "parsers.h"
+#include "urlmatch.h"
 
 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
 
@@ -114,9 +138,9 @@ static jb_err show_defines(struct map *exports);
  *                Lists menu of available unhidden CGIs.
  *               
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -131,7 +155,6 @@ jb_err cgi_default(struct client_state *csp,
                    struct http_response *rsp,
                    const struct map *parameters)
 {
-   char *p;
    char *tmp;
    struct map *exports;
 
@@ -147,15 +170,9 @@ jb_err cgi_default(struct client_state *csp,
    /* If there were other parameters, export a dump as "cgi-parameters" */
    if (parameters->first)
    {
-      if (NULL == (p = dump_map(parameters)))
-      {
-         free_map(exports);
-         return JB_ERR_MEMORY;
-      }
       tmp = strdup("<p>What made you think this cgi takes parameters?\n"
                    "Anyway, here they are, in case you're interested:</p>\n");
-      string_append(&tmp, p);
-      free(p);
+      string_join(&tmp, dump_map(parameters));
       if (tmp == NULL)
       {
          free_map(exports);
@@ -188,9 +205,9 @@ jb_err cgi_default(struct client_state *csp,
  *                given.
  *               
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -232,9 +249,9 @@ jb_err cgi_error_404(struct client_state *csp,
  *                made of it.
  *               
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -271,18 +288,19 @@ jb_err cgi_show_request(struct client_state *csp,
     * be sending to the server if this wasn't a CGI call
     */
 
-   if (map(exports, "client-request", 1, csp->iob->buf, 1))
+   if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
    {
       free_map(exports);
       return JB_ERR_MEMORY;
    }
 
-   if (map(exports, "processed-request", 1, sed(client_patterns, add_client_headers, csp), 0))
+   if (map(exports, "processed-request", 1, html_encode_and_free_original(
+      sed(client_patterns, add_client_headers, csp)), 0))
    {
       free_map(exports);
       return JB_ERR_MEMORY;
    }
-   
+
    return template_fill_for_cgi(csp, "show-request", exports, rsp);
 }
 
@@ -294,13 +312,15 @@ jb_err cgi_show_request(struct client_state *csp,
  * Description :  CGI function that returns a banner. 
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters :
- *           type : Selects the type of banner between "trans" and "jb".
- *                  Defaults to "jb" if absent or != "trans".
+ *           type : Selects the type of banner between "trans", "logo",
+ *                  and "auto". Defaults to "logo" if absent or invalid.
+ *                  "auto" means to select as if we were image-blocking.
+ *                  (Only the first character really counts).
  *
  * Returns     :  JB_ERR_OK on success
  *                JB_ERR_MEMORY on out-of-memory error.  
@@ -310,7 +330,28 @@ jb_err cgi_send_banner(struct client_state *csp,
                        struct http_response *rsp,
                        const struct map *parameters)
 {
-   if (strcmp(lookup(parameters, "type"), "trans"))
+   char imagetype = lookup(parameters, "type")[0];
+
+   if (imagetype == 'a') /* auto */
+   {
+      /* Default to logo */
+      imagetype = 'l';
+#ifdef FEATURE_IMAGE_BLOCKING
+      if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
+      {
+         /* determine HOW images should be blocked */
+         const char * p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
+
+         /* and handle accordingly: */
+         if ((p != NULL) && (0 == strcmpic(p, "blank")))
+         {
+            imagetype = 't';
+         }
+      }
+#endif /* def FEATURE_IMAGE_BLOCKING */
+   }
+      
+   if ((imagetype != 't') && (imagetype != 'b')) /* transparant/blank */
    {
       rsp->body = bindup(image_junkbuster_gif_data, image_junkbuster_gif_length);
       rsp->content_length = image_junkbuster_gif_length;
@@ -338,6 +379,47 @@ jb_err cgi_send_banner(struct client_state *csp,
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  cgi_transparent_gif
+ *
+ * Description :  CGI function that sends a 1x1 transparent GIF.
+ *
+ * Parameters  :
+ *          1  :  csp = Current client state (buffers, headers, etc...)
+ *          2  :  rsp = http_response data structure for output
+ *          3  :  parameters = map of cgi parameters
+ *
+ * CGI Parameters : None
+ *
+ * Returns     :  JB_ERR_OK on success
+ *                JB_ERR_MEMORY on out-of-memory error.  
+ *
+ *********************************************************************/
+jb_err cgi_transparent_gif(struct client_state *csp,
+                           struct http_response *rsp,
+                           const struct map *parameters)
+{
+   rsp->body = bindup(image_blank_gif_data, image_blank_gif_length);
+   rsp->content_length = image_blank_gif_length;
+
+   if (rsp->body == NULL)
+   {
+      return JB_ERR_MEMORY;
+   }
+
+   if (enlist(rsp->headers, "Content-Type: image/gif"))
+   {
+      return JB_ERR_MEMORY;
+   }
+
+   rsp->is_static = 1;
+
+   return JB_ERR_OK;
+
+}
+
+
 /*********************************************************************
  *
  * Function    :  cgi_show_version
@@ -346,9 +428,9 @@ jb_err cgi_send_banner(struct client_state *csp,
  *                file versions of IJB.
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -389,9 +471,9 @@ jb_err cgi_show_version(struct client_state *csp,
  *                current status of IJB.
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters :
  *        file :  Which file to show.  Only first letter is checked,
@@ -414,7 +496,6 @@ jb_err cgi_show_status(struct client_state *csp,
 
    FILE * fp;
    char buf[BUFFER_SIZE];
-   char * p;
    const char * filename = NULL;
    char * file_description = NULL;
 #ifdef FEATURE_STATISTICS
@@ -486,13 +567,8 @@ jb_err cgi_show_status(struct client_state *csp,
          s = strdup("");
          while ((s != NULL) && fgets(buf, sizeof(buf), fp))
          {
-            p = html_encode(buf);
-            if (p)
-            {
-               string_append(&s, p);
-               freez(p);
-               string_append(&s, "<br>");
-            }
+            string_join  (&s, html_encode(buf));
+            string_append(&s, "<br>");
          }
          fclose(fp);
 
@@ -506,16 +582,16 @@ jb_err cgi_show_status(struct client_state *csp,
       return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
    }
 
-   if (map(exports, "redirect-url", 1, REDIRECT_URL, 1))
+   if (map(exports, "redirect-url", 1, html_encode(REDIRECT_URL), 0))
    {
       free_map(exports);
       return JB_ERR_MEMORY;
    }
    
    s = strdup("");
-   for (i=0; i < Argc; i++)
+   for (i = 0; (s != NULL) && (i < Argc); i++)
    {
-      string_append(&s, Argv[i]);
+      string_join  (&s, html_encode(Argv[i]));
       string_append(&s, " ");
    }
    if (map(exports, "invocation", 1, s, 0))
@@ -568,7 +644,7 @@ jb_err cgi_show_status(struct client_state *csp,
 
    if (csp->actions_list)
    {
-      if (!err) err = map(exports, "actions-filename", 1,  csp->actions_list->filename, 1);
+      if (!err) err = map(exports, "actions-filename", 1, html_encode(csp->actions_list->filename), 0);
    }
    else
    {
@@ -577,7 +653,7 @@ jb_err cgi_show_status(struct client_state *csp,
 
    if (csp->rlist)
    {
-      if (!err) err = map(exports, "re-filter-filename", 1,  csp->rlist->filename, 1);
+      if (!err) err = map(exports, "re-filter-filename", 1, html_encode(csp->rlist->filename), 0);
    }
    else
    {
@@ -587,7 +663,7 @@ jb_err cgi_show_status(struct client_state *csp,
 #ifdef FEATURE_TRUST
    if (csp->tlist)
    {
-      if (!err) err = map(exports, "trust-filename", 1,  csp->tlist->filename, 1);
+      if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
    }
    else
    {
@@ -616,9 +692,9 @@ jb_err cgi_show_status(struct client_state *csp,
  *                matches starting from the defaults have lead to that.
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters :
  *            url : The url whose actions are to be determined.
@@ -634,8 +710,7 @@ jb_err cgi_show_url_info(struct client_state *csp,
                          struct http_response *rsp,
                          const struct map *parameters)
 {
-   const char *url_param_const;
-   char *host = NULL;
+   char *url_param;
    struct map *exports;
 
    assert(csp);
@@ -647,9 +722,72 @@ jb_err cgi_show_url_info(struct client_state *csp,
       return JB_ERR_MEMORY;
    }
 
-   url_param_const = lookup(parameters, "url");
-   if (*url_param_const == '\0')
+   /*
+    * Get the url= parameter (if present) and remove any leading/trailing spaces.
+    */
+   url_param = strdup(lookup(parameters, "url"));
+   if (url_param == NULL)
    {
+      free_map(exports);
+      return JB_ERR_MEMORY;
+   }
+   chomp(url_param);
+
+   /*
+    * Handle prefixes.  4 possibilities:
+    * 1) "http://" or "https://" prefix present and followed by URL - OK
+    * 2) Only the "http://" or "https://" part is present, no URL - change
+    *    to empty string so it will be detected later as "no URL".
+    * 3) Parameter specified but doesn't contain "http(s?)://" - add a
+    *    "http://" prefix.
+    * 4) Parameter not specified or is empty string - let this fall through
+    *    for now, next block of code will handle it.
+    */
+   if (0 == strncmp(url_param, "http://", 7))
+   {
+      if (url_param[7] == '\0')
+      {
+         /*
+          * Empty URL (just prefix).
+          * Make it totally empty so it's caught by the next if()
+          */
+         url_param[0] = '\0';
+      }
+   }
+   else if (0 == strncmp(url_param, "https://", 8))
+   {
+      if (url_param[8] == '\0')
+      {
+         /*
+          * Empty URL (just prefix).
+          * Make it totally empty so it's caught by the next if()
+          */
+         url_param[0] = '\0';
+      }
+   }
+   else if (url_param[0] != '\0')
+   {
+      /*
+       * Unknown prefix - assume http://
+       */
+      char * url_param_prefixed = malloc(7 + 1 + strlen(url_param));
+      if (NULL == url_param_prefixed)
+      {
+         free(url_param);
+         free_map(exports);
+         return JB_ERR_MEMORY;
+      }
+      strcpy(url_param_prefixed, "http://");
+      strcpy(url_param_prefixed + 7, url_param);
+      free(url_param);
+      url_param = url_param_prefixed;
+   }
+
+
+   if (url_param[0] == '\0')
+   {
+      /* URL paramater not specified, display query form only. */
+      free(url_param);
       if (map_block_killer(exports, "url-given")
         || map(exports, "url", 1, "", 1))
       {
@@ -659,28 +797,17 @@ jb_err cgi_show_url_info(struct client_state *csp,
    }
    else
    {
-      char *url_param;
+      /* Given a URL, so query it. */
+      jb_err err;
       char *matches;
-      char *path;
       char *s;
-      int port = 80;
       int hits = 0;
       struct file_list *fl;
       struct url_actions *b;
-      struct url_spec url[1];
+      struct http_request url_to_query[1];
       struct current_action_spec action[1];
       
-      if (NULL == (url_param = strdup(url_param_const)))
-      {
-         free_map(exports);
-         return JB_ERR_MEMORY;
-      }
-
-      host = url_param;
-      host += (strncmp(url_param, "http://", 7)) ? 0 : 7;
-
-      if (map(exports, "url", 1, host, 1)
-       || map(exports, "url-html", 1, html_encode(host), 0))
+      if (map(exports, "url", 1, html_encode(url_param), 0))
       {
          free(url_param);
          free_map(exports);
@@ -689,8 +816,8 @@ jb_err cgi_show_url_info(struct client_state *csp,
 
       init_current_action(action);
 
-      s = current_action_to_text(action);
-      if (map(exports, "default", 1, s , 0))
+      if (map(exports, "default", 1, html_encode_and_free_original(
+         current_action_to_text(action)), 0))
       {
          free_current_action(action);
          free(url_param);
@@ -700,10 +827,8 @@ jb_err cgi_show_url_info(struct client_state *csp,
 
       if (((fl = csp->actions_list) == NULL) || ((b = fl->f) == NULL))
       {
-         jb_err err;
-
-         err = map(exports, "matches", 1, "none" , 1)
-            || map(exports, "final", 1, lookup(exports, "default"), 1);
+         err = map(exports, "matches", 1, "none" , 1);
+         if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
 
          free_current_action(action);
          free(url_param);
@@ -717,44 +842,23 @@ jb_err cgi_show_url_info(struct client_state *csp,
          return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
       }
 
-      s = strchr(host, '/');
-      if (s != NULL)
-      {
-         path = strdup(s);
-         *s = '\0';
-      }
-      else
-      {
-         path = strdup("");
-      }
-      if (NULL == path)
+      err = parse_http_url(url_param, url_to_query, csp);
+
+      free(url_param);
+
+      if (err == JB_ERR_MEMORY)
       {
          free_current_action(action);
-         free(url_param);
          free_map(exports);
          return JB_ERR_MEMORY;
       }
-
-      s = strchr(host, ':');
-      if (s != NULL)
+      else if (err)
       {
-         *s++ = '\0';
-         port = atoi(s);
-         s = NULL;
-      }
-
-      *url = dsplit(host);
+         /* Invalid URL */
 
-      /* if splitting the domain fails, punt */
-      if (url->dbuf == NULL)
-      {
-         jb_err err;
-         
-         err = map(exports, "matches", 1, "none" , 1)
-            || map(exports, "final", 1, lookup(exports, "default"), 1);
+         err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
+         if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
 
-         freez(url_param);
-         freez(path);
          free_current_action(action);
 
          if (err)
@@ -766,53 +870,45 @@ jb_err cgi_show_url_info(struct client_state *csp,
          return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
       }
 
+      /*
+       * We have a warning about SSL paths.  Hide it for insecure sites.
+       */
+      if (!url_to_query->ssl)
+      {
+         if (map_block_killer(exports, "https"))
+         {
+            free_current_action(action);
+            free_map(exports);
+            return JB_ERR_MEMORY;
+         }
+      }
+
       matches = strdup("");
 
-      for (b = b->next; NULL != b; b = b->next)
+      for (b = b->next; (b != NULL) && (matches != NULL); b = b->next)
       {
-         if ((b->url->port == 0) || (b->url->port == port))
+         if (url_match(b->url, url_to_query))
          {
-            if ((b->url->domain[0] == '\0') || (domaincmp(b->url, url) == 0))
+            string_append(&matches, "<b>{");
+            string_join  (&matches, html_encode_and_free_original(
+                                    actions_to_text(b->action)));
+            string_append(&matches, " }</b><br>\n<code>");
+            string_join  (&matches, html_encode(b->url->spec));
+            string_append(&matches, "</code><br>\n<br>\n");
+
+            if (merge_current_action(action, b->action))
             {
-               if ((b->url->path == NULL) ||
-#ifdef REGEX
-                  (regexec(b->url->preg, path, 0, NULL, 0) == 0)
-#else
-                  (strncmp(b->url->path, path, b->url->pathlen) == 0)
-#endif
-               )
-               {
-                  s = actions_to_text(b->action);
-                  if (s == NULL)
-                  {
-                     freez(url->dbuf);
-                     freez(url->dvec);
-
-                     free(url_param);
-                     free(path);
-                     free_current_action(action);
-                     free_map(exports);
-                     return JB_ERR_MEMORY;
-                  }
-                  string_append(&matches, "<b>{");
-                  string_append(&matches, s);
-                  string_append(&matches, " }</b><br>\n<code>");
-                  string_append(&matches, b->url->spec);
-                  string_append(&matches, "</code><br>\n<br>\n");
-                  free(s);
-
-                  merge_current_action(action, b->action); /* FIXME: Add error checking */
-                  hits++;
-               }
+               freez(matches);
+               free_http_request(url_to_query);
+               free_current_action(action);
+               free_map(exports);
+               return JB_ERR_MEMORY;
             }
+            hits++;
          }
       }
 
-      freez(url->dbuf);
-      freez(url->dvec);
-
-      free(url_param);
-      free(path);
+      free_http_request(url_to_query);
 
       if (matches == NULL)
       {
@@ -833,7 +929,7 @@ jb_err cgi_show_url_info(struct client_state *csp,
          return JB_ERR_MEMORY;
       }
 
-      s = current_action_to_text(action);
+      s = html_encode_and_free_original(current_action_to_text(action));
 
       free_current_action(action);
 
@@ -855,9 +951,9 @@ jb_err cgi_show_url_info(struct client_state *csp,
  * Description :  CGI function to return "/robots.txt".
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : None
  *
@@ -904,7 +1000,7 @@ jb_err cgi_robots_txt(struct client_state *csp,
  *                used when building
  *
  * Parameters  :
- *           1 :  exports = map to extend
+ *           :  exports = map to extend
  *
  * Returns     :  JB_ERR_OK on success
  *                JB_ERR_MEMORY on out-of-memory error.  
@@ -1095,6 +1191,8 @@ static char *show_rcs(void)
    SHOW_RCS(project_h_rcs)
    SHOW_RCS(ssplit_h_rcs)
    SHOW_RCS(ssplit_rcs)
+   SHOW_RCS(urlmatch_h_rcs)
+   SHOW_RCS(urlmatch_rcs)
 #ifdef _WIN32
 #ifndef _WIN_CONSOLE
    SHOW_RCS(w32log_h_rcs)