Forget about JB_ERR_PARSE. JB_ERR_CGI_PARAMS to the rescue.
[privoxy.git] / cgisimple.c
index 256202d..df973b6 100644 (file)
@@ -1,4 +1,4 @@
-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.61 2008/01/26 11:13:25 fabiankeil Exp $";
+const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.72 2008/04/26 10:34:15 fabiankeil Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
@@ -9,7 +9,7 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.61 2008/01/26 11:13:25 fabian
  *                Functions declared include:
  * 
  *
- * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001-2008 the SourceForge
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
@@ -36,6 +36,47 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.61 2008/01/26 11:13:25 fabian
  *
  * Revisions   :
  *    $Log: cgisimple.c,v $
+ *    Revision 1.72  2008/04/26 10:34:15  fabiankeil
+ *    If zlib support is unavailable and there are content filters active
+ *    but the prevent-compression action is disabled, include a warning
+ *    on the show-url-info page that compression might prevent filtering.
+ *
+ *    Revision 1.71  2008/04/25 13:33:56  fabiankeil
+ *    - Factor cgi_show_file() out of cgi_show_status().
+ *    - Adjust cgi_show_status()'s parameter description to match reality.
+ *
+ *    Revision 1.70  2008/04/24 16:12:38  fabiankeil
+ *    In cgi_show_status(), load the requested file at once.
+ *    Using string_join() for every line really doesn't scale.
+ *
+ *    Revision 1.69  2008/04/17 14:40:48  fabiankeil
+ *    Provide get_http_time() with the buffer size so it doesn't
+ *    have to blindly assume that the buffer is big enough.
+ *
+ *    Revision 1.68  2008/03/27 18:27:21  fabiankeil
+ *    Remove kill-popups action.
+ *
+ *    Revision 1.67  2008/03/27 17:00:05  fabiankeil
+ *    Turn the favicon blobs into locals.
+ *
+ *    Revision 1.66  2008/02/23 16:57:12  fabiankeil
+ *    Rename url_actions() to get_url_actions() and let it
+ *    use the standard parameter ordering.
+ *
+ *    Revision 1.65  2008/02/23 16:33:43  fabiankeil
+ *    Let forward_url() use the standard parameter ordering
+ *    and mark its second parameter immutable.
+ *
+ *    Revision 1.64  2008/02/03 13:56:07  fabiankeil
+ *    Add SOCKS5 support for show-url-info CGI page.
+ *
+ *    Revision 1.63  2008/02/01 06:04:31  fabiankeil
+ *    If edit buttons on the show-url-info CGI page are hidden, explain why.
+ *
+ *    Revision 1.62  2008/02/01 05:52:40  fabiankeil
+ *    Hide edit buttons on the show-url-info CGI page if enable-edit-action
+ *    is disabled. Patch by Lee with additional white space adjustments.
+ *
  *    Revision 1.61  2008/01/26 11:13:25  fabiankeil
  *    If enable-edit-actions is disabled, hide the edit buttons and explain why.
  *
@@ -362,45 +403,11 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.61 2008/01/26 11:13:25 fabian
 
 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
 
-
 static char *show_rcs(void);
 static jb_err show_defines(struct map *exports);
-
-/*
- * 16x16 ico blobs for favicon delivery functions.
- */
-const char default_favicon_data[] =
-   "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
-   "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
-   "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
-   "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
-   "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
-   "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
-   "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
-   "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
-   "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
-   "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
-   "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
-   "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
-   "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
-   "\017\000\000";
-const char error_favicon_data[] =
-   "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
-   "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
-   "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
-   "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
-   "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
-   "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
-   "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
-   "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
-   "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
-   "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
-   "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
-   "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
-   "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
-   "\017\000\000";
-const size_t default_favicon_length  = sizeof(default_favicon_data) - 1;
-const size_t error_favicon_length  = sizeof(error_favicon_data) - 1;
+static jb_err cgi_show_file(struct client_state *csp,
+                            struct http_response *rsp,
+                            const struct map *parameters);
 
 /*********************************************************************
  *
@@ -784,8 +791,25 @@ jb_err cgi_send_default_favicon(struct client_state *csp,
                                 struct http_response *rsp,
                                 const struct map *parameters)
 {
-   rsp->body = bindup(default_favicon_data, default_favicon_length);
-   rsp->content_length = default_favicon_length;
+   static const char default_favicon_data[] =
+      "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
+      "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
+      "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
+      "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
+      "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
+      "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
+      "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
+      "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
+      "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
+      "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
+      "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
+      "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
+      "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
+      "\017\000\000";
+   static const size_t favicon_length = sizeof(default_favicon_data) - 1;
+
+   rsp->body = bindup(default_favicon_data, favicon_length);
+   rsp->content_length = favicon_length;
 
    if (rsp->body == NULL)
    {
@@ -825,8 +849,25 @@ jb_err cgi_send_error_favicon(struct client_state *csp,
                               struct http_response *rsp,
                               const struct map *parameters)
 {
-   rsp->body = bindup(error_favicon_data, error_favicon_length);
-   rsp->content_length = error_favicon_length;
+   static const char error_favicon_data[] =
+      "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
+      "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
+      "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
+      "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
+      "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
+      "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
+      "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
+      "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
+      "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
+      "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
+      "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
+      "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
+      "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
+      "\017\000\000";
+   static const size_t favicon_length = sizeof(error_favicon_data) - 1;
+
+   rsp->body = bindup(error_favicon_data, favicon_length);
+   rsp->content_length = favicon_length;
 
    if (rsp->body == NULL)
    {
@@ -1053,7 +1094,7 @@ jb_err cgi_show_version(struct client_state *csp,
    return template_fill_for_cgi(csp, "show-version", exports, rsp);
 }
 
+
 /*********************************************************************
  *
  * Function    :  cgi_show_status
@@ -1069,7 +1110,7 @@ jb_err cgi_show_version(struct client_state *csp,
  * CGI Parameters :
  *        file :  Which file to show.  Only first letter is checked,
  *                valid values are:
- *                - "p"ermissions (actions) file
+ *                - "a"ction file
  *                - "r"egex
  *                - "t"rust
  *                Default is to show menu and other information.
@@ -1086,10 +1127,7 @@ jb_err cgi_show_status(struct client_state *csp,
    unsigned i;
    int j;
 
-   FILE * fp;
    char buf[BUFFER_SIZE];
-   const char * filename = NULL;
-   char * file_description = NULL;
 #ifdef FEATURE_STATISTICS
    float perc_rej;   /* Percentage of http requests rejected */
    int local_urls_read;
@@ -1103,74 +1141,14 @@ jb_err cgi_show_status(struct client_state *csp,
    assert(rsp);
    assert(parameters);
 
-   if (NULL == (exports = default_exports(csp, "show-status")))
+   if ('\0' != *(lookup(parameters, "file")))
    {
-      return JB_ERR_MEMORY;
-   }
-
-   switch (*(lookup(parameters, "file")))
-   {
-   case 'a':
-      if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
-      {
-         filename = csp->actions_list[i]->filename;
-         file_description = "Actions File";
-      }
-      break;
-
-   case 'f':
-      if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
-      {
-         filename = csp->rlist[i]->filename;
-         file_description = "Filter File";
-      }
-      break;
-
-#ifdef FEATURE_TRUST
-   case 't':
-      if (csp->tlist)
-      {
-         filename = csp->tlist->filename;
-         file_description = "Trust File";
-      }
-      break;
-#endif /* def FEATURE_TRUST */
+      return cgi_show_file(csp, rsp, parameters);
    }
 
-   if (NULL != filename)
+   if (NULL == (exports = default_exports(csp, "show-status")))
    {
-      if ( map(exports, "file-description", 1, file_description, 1)
-        || map(exports, "filepath", 1, html_encode(filename), 0) )
-      {
-         free_map(exports);
-         return JB_ERR_MEMORY;
-      }
-
-      if ((fp = fopen(filename, "r")) == NULL)
-      {
-         if (map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
-         {
-            free_map(exports);
-            return JB_ERR_MEMORY;
-         }
-      }
-      else
-      {
-         s = strdup("");
-         while ((s != NULL) && fgets(buf, sizeof(buf), fp))
-         {
-            string_join  (&s, html_encode(buf));
-         }
-         fclose(fp);
-
-         if (map(exports, "contents", 1, s, 0))
-         {
-            free_map(exports);
-            return JB_ERR_MEMORY;
-         }
-      }
-
-      return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
+      return JB_ERR_MEMORY;
    }
 
    s = strdup("");
@@ -1626,7 +1604,7 @@ jb_err cgi_show_url_info(struct client_state *csp,
        * but luckily it's no longer required later on anyway.
        */
       free_current_action(csp->action);
-      url_actions(url_to_query, csp);
+      get_url_actions(csp, url_to_query);
 
       /*
        * Fill in forwarding settings.
@@ -1642,7 +1620,7 @@ jb_err cgi_show_url_info(struct client_state *csp,
        * display the proxy port and an eventual second forwarder.
        */
       {
-         const struct forward_spec * fwd = forward_url(url_to_query, csp);
+         const struct forward_spec *fwd = forward_url(csp, url_to_query);
 
          if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
          {
@@ -1657,8 +1635,24 @@ jb_err cgi_show_url_info(struct client_state *csp,
 
             if (fwd->gateway_host != NULL)
             {
-               if (!err) err = map(exports, "socks-type", 1, (fwd->type == SOCKS_4) ?
-                                  "socks4" : "socks4a", 1);
+               char *socks_type = NULL;
+
+               switch (fwd->type)
+               {
+                  case SOCKS_4:
+                     socks_type = "socks4";
+                     break;
+                  case SOCKS_4A:
+                     socks_type = "socks4a";
+                     break;
+                  case SOCKS_5:
+                     socks_type = "socks5";
+                     break;
+                  default:
+                     log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
+               }
+
+               if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
                if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
                snprintf(port, sizeof(port), "%d", fwd->gateway_port);
                if (!err) err = map(exports, "gateway-port", 1, port, 1);
@@ -1690,7 +1684,31 @@ jb_err cgi_show_url_info(struct client_state *csp,
          return JB_ERR_MEMORY;
       }
 
-      if (map(exports, "matches", 1, matches , 0))
+#ifdef FEATURE_CGI_EDIT_ACTIONS
+      if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
+      {
+         err = map_block_killer(exports, "cgi-editor-is-disabled");
+      }
+#endif /* FEATURE_CGI_EDIT_ACTIONS */
+
+      /*
+       * If zlib support is available, if no content filters
+       * are enabled or if the prevent-compression action is enabled,
+       * suppress the "compression could prevent filtering" warning.
+       *
+       * XXX: Change content_filters_enabled()'s prototype so we can
+       * use it here.
+       */
+#ifndef FEATURE_ZLIB
+      if ((list_is_empty(action->multi[ACTION_MULTI_FILTER])
+             && !(action->flags & ACTION_DEANIMATE))
+         || (action->flags & ACTION_NO_COMPRESSION))
+#endif
+      {
+         if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
+      }
+
+      if (err || map(exports, "matches", 1, matches , 0))
       {
          free_current_action(action);
          free_map(exports);
@@ -1753,7 +1771,7 @@ jb_err cgi_robots_txt(struct client_state *csp,
 
    rsp->is_static = 1;
 
-   get_http_time(7 * 24 * 60 * 60, buf); /* 7 days into future */
+   get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
    if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
 
    return (err ? JB_ERR_MEMORY : JB_ERR_OK);
@@ -1828,12 +1846,6 @@ static jb_err show_defines(struct map *exports)
    if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
 
-#ifdef FEATURE_KILL_POPUPS
-   if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 1);
-#else /* ifndef FEATURE_KILL_POPUPS */
-   if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 0);
-#endif /* ndef FEATURE_KILL_POPUPS */
-
 #ifdef FEATURE_NO_GIFS
    if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
 #else /* ifndef FEATURE_NO_GIFS */
@@ -1946,10 +1958,6 @@ static char *show_rcs(void)
    SHOW_RCS(jbsockets_rcs)
    SHOW_RCS(jcc_h_rcs)
    SHOW_RCS(jcc_rcs)
-#ifdef FEATURE_KILL_POPUPS
-   SHOW_RCS(killpopup_h_rcs)
-   SHOW_RCS(killpopup_rcs)
-#endif /* def FEATURE_KILL_POPUPS */
    SHOW_RCS(list_h_rcs)
    SHOW_RCS(list_rcs)
    SHOW_RCS(loadcfg_h_rcs)
@@ -1986,6 +1994,148 @@ static char *show_rcs(void)
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  cgi_show_file
+ *
+ * Description :  CGI function that shows the content of a
+ *                configuration file.
+ *
+ * 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 :
+ *        file :  Which file to show.  Only first letter is checked,
+ *                valid values are:
+ *                - "a"ction file
+ *                - "r"egex
+ *                - "t"rust
+ *                Default is to show menu and other information.
+ *
+ * Returns     :  JB_ERR_OK on success
+ *                JB_ERR_MEMORY on out-of-memory error.  
+ *
+ *********************************************************************/
+static jb_err cgi_show_file(struct client_state *csp,
+                            struct http_response *rsp,
+                            const struct map *parameters)
+{
+   unsigned i;
+   const char * filename = NULL;
+   char * file_description = NULL;
+
+   assert(csp);
+   assert(rsp);
+   assert(parameters);
+
+   switch (*(lookup(parameters, "file")))
+   {
+   case 'a':
+      if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
+      {
+         filename = csp->actions_list[i]->filename;
+         file_description = "Actions File";
+      }
+      break;
+
+   case 'f':
+      if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
+      {
+         filename = csp->rlist[i]->filename;
+         file_description = "Filter File";
+      }
+      break;
+
+#ifdef FEATURE_TRUST
+   case 't':
+      if (csp->tlist)
+      {
+         filename = csp->tlist->filename;
+         file_description = "Trust File";
+      }
+      break;
+#endif /* def FEATURE_TRUST */
+   }
+
+   if (NULL != filename)
+   {
+      struct map *exports;
+      char *s;
+      FILE * fp;
+
+      exports = default_exports(csp, "show-status");
+      if (NULL == exports)
+      {
+         return JB_ERR_MEMORY;
+      }
+
+      if ( map(exports, "file-description", 1, file_description, 1)
+        || map(exports, "filepath", 1, html_encode(filename), 0) )
+      {
+         free_map(exports);
+         return JB_ERR_MEMORY;
+      }
+
+      if ((fp = fopen(filename, "rb")) == NULL)
+      {
+         if (map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
+         {
+            free_map(exports);
+            return JB_ERR_MEMORY;
+         }
+      }
+      else
+      {
+         /*
+          * XXX: this code is "quite similar" to the one
+          * in cgi_send_user_manual() and should be refactored.
+          * While at it, the return codes for ftell() and fseek
+          * should be verified.
+          */
+         size_t length;
+         /* Get file length */
+         fseek(fp, 0, SEEK_END);
+         length = (size_t)ftell(fp);
+         fseek(fp, 0, SEEK_SET);
+
+         s = (char *)zalloc(length+1);
+         if (NULL == s)
+         {
+            fclose(fp);
+            return JB_ERR_MEMORY;
+         }
+         if (!fread(s, length, 1, fp))
+         {
+            /*
+             * May happen if the file size changes between fseek() and fread().
+             * If it does, we just log it and serve what we got.
+             */
+            log_error(LOG_LEVEL_ERROR, "Couldn't completely read file %s.", filename);
+         }
+         fclose(fp);
+
+         s = html_encode_and_free_original(s);
+         if (NULL == s)
+         {
+            return JB_ERR_MEMORY;
+         }
+
+         if (map(exports, "contents", 1, s, 0))
+         {
+            free_map(exports);
+            return JB_ERR_MEMORY;
+         }
+      }
+
+      return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
+   }
+
+   return JB_ERR_CGI_PARAMS;
+}
+
 /*
   Local Variables:
   tab-width: 3