Change the Windows taskbar icon when privoxy is toggled off.
[privoxy.git] / filters.c
index a4757be..5e26f50 100644 (file)
--- a/filters.c
+++ b/filters.c
@@ -1,4 +1,4 @@
-const char filters_rcs[] = "$Id: filters.c,v 1.91 2007/09/02 15:31:20 fabiankeil Exp $";
+const char filters_rcs[] = "$Id: filters.c,v 1.110 2008/11/10 16:40:25 fabiankeil Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/filters.c,v $
@@ -10,10 +10,10 @@ const char filters_rcs[] = "$Id: filters.c,v 1.91 2007/09/02 15:31:20 fabiankeil
  *                   `filter_popups', `forward_url', 'redirect_url',
  *                   `ij_untrusted_url', `intercept_url', `pcrs_filter_respose',
  *                   `ijb_send_banner', `trust_url', `gif_deanimate_response',
- *                   `jpeg_inspect_response', `execute_single_pcrs_command',
- *                   `rewrite_url', `get_last_url'
+ *                   `execute_single_pcrs_command', `rewrite_url',
+ *                   `get_last_url'
  *
- * Copyright   :  Written by and Copyright (C) 2001, 2004-2007 the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001, 2004-2008 the SourceForge
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
@@ -40,6 +40,81 @@ const char filters_rcs[] = "$Id: filters.c,v 1.91 2007/09/02 15:31:20 fabiankeil
  *
  * Revisions   :
  *    $Log: filters.c,v $
+ *    Revision 1.110  2008/11/10 16:40:25  fabiankeil
+ *    Fix a gcc44 warning.
+ *
+ *    Revision 1.109  2008/11/08 15:48:41  fabiankeil
+ *    Mention actual values when complaining about
+ *    the chunk size exceeding the buffer size.
+ *
+ *    Revision 1.108  2008/05/21 15:35:08  fabiankeil
+ *    - Mark csp as immutable for block_acl().
+ *    - Remove an obsolete complaint about filter_popups().
+ *
+ *    Revision 1.107  2008/05/04 17:52:56  fabiankeil
+ *    Adjust parse_http_url() call to new prototype.
+ *
+ *    Revision 1.106  2008/05/03 16:40:44  fabiankeil
+ *    Change content_filters_enabled()'s parameter from
+ *    csp->action to action so it can be also used in the
+ *    CGI code. Don't bother checking if there are filters
+ *    loaded, as that's somewhat besides the point.
+ *
+ *    Revision 1.105  2008/03/28 15:13:39  fabiankeil
+ *    Remove inspect-jpegs action.
+ *
+ *    Revision 1.104  2008/03/27 18:27:24  fabiankeil
+ *    Remove kill-popups action.
+ *
+ *    Revision 1.103  2008/03/06 16:33:45  fabiankeil
+ *    If limit-connect isn't used, don't limit CONNECT requests to port 443.
+ *
+ *    Revision 1.102  2008/03/01 14:00:44  fabiankeil
+ *    Let the block action take the reason for the block
+ *    as argument and show it on the "blocked" page.
+ *
+ *    Revision 1.101  2008/02/23 16:57:12  fabiankeil
+ *    Rename url_actions() to get_url_actions() and let it
+ *    use the standard parameter ordering.
+ *
+ *    Revision 1.100  2008/02/23 16:33:43  fabiankeil
+ *    Let forward_url() use the standard parameter ordering
+ *    and mark its second parameter immutable.
+ *
+ *    Revision 1.99  2008/02/03 13:57:58  fabiankeil
+ *    Add SOCKS5 support for forward-override{}.
+ *
+ *    Revision 1.98  2008/01/04 17:43:45  fabiankeil
+ *    Improve the warning messages that get logged if the action files
+ *    "enable" filters but no filters of that type have been loaded.
+ *
+ *    Revision 1.97  2007/11/30 15:37:03  fabiankeil
+ *    Use freez instead of free.
+ *
+ *    Revision 1.96  2007/10/19 16:53:28  fabiankeil
+ *    Add helper function to check if any content filters are enabled.
+ *
+ *    Revision 1.95  2007/10/17 19:31:20  fabiankeil
+ *    Omitting the zero chunk that ends the chunk transfer encoding seems
+ *    to be the new black. Log the problem and continue filtering anyway.
+ *
+ *    Revision 1.94  2007/09/29 13:20:20  fabiankeil
+ *    Remove two redundant and one useless log messages.
+ *
+ *    Revision 1.93  2007/09/29 10:21:16  fabiankeil
+ *    - Move get_filter_function() from jcc.c to filters.c
+ *      so the filter functions can be static.
+ *    - Don't bother filtering body-less responses.
+ *
+ *    Revision 1.92  2007/09/28 16:38:55  fabiankeil
+ *    - Execute content filters through execute_content_filter().
+ *    - Add prepare_for_filtering() so filter functions don't have to
+ *      care about de-chunking and decompression. As a side effect this enables
+ *      decompression for gif_deanimate_response() and jpeg_inspect_response().
+ *    - Change remove_chunked_transfer_coding()'s return type to jb_err.
+ *      Some clowns feel like chunking empty responses in which case
+ *      (size == 0) is valid but previously would be interpreted as error.
+ *
  *    Revision 1.91  2007/09/02 15:31:20  fabiankeil
  *    Move match_portlist() from filter.c to urlmatch.c.
  *    It's used for url matching, not for filtering.
@@ -642,7 +717,7 @@ static jb_err prepare_for_filtering(struct client_state *csp);
  * Returns     : 0 = FALSE (don't block) and 1 = TRUE (do block)
  *
  *********************************************************************/
-int block_acl(struct access_control_addr *dst, struct client_state *csp)
+int block_acl(const struct access_control_addr *dst, const struct client_state *csp)
 {
    struct access_control_list *acl = csp->config->acl;
 
@@ -725,7 +800,7 @@ int acl_addr(const char *aspec, struct access_control_addr *aca)
       *p++ = '\0';
       if (ijb_isdigit(*p) == 0)
       {
-         free(acl_spec);
+         freez(acl_spec);
          return(-1);
       }
       masklength = atoi(p);
@@ -733,7 +808,7 @@ int acl_addr(const char *aspec, struct access_control_addr *aca)
 
    if ((masklength < 0) || (masklength > 32))
    {
-      free(acl_spec);
+      freez(acl_spec);
       return(-1);
    }
 
@@ -746,7 +821,7 @@ int acl_addr(const char *aspec, struct access_control_addr *aca)
 
       if (port <= 0 || port > 65535 || *endptr != '\0')
       {
-         free(acl_spec);
+         freez(acl_spec);
          return(-1);
       }
    }
@@ -754,7 +829,7 @@ int acl_addr(const char *aspec, struct access_control_addr *aca)
    aca->port = (unsigned long)port;
 
    aca->addr = ntohl(resolve_hostname_to_ip(acl_spec));
-   free(acl_spec);
+   freez(acl_spec);
 
    if (aca->addr == INADDR_NONE)
    {
@@ -766,7 +841,7 @@ int acl_addr(const char *aspec, struct access_control_addr *aca)
    aca->mask = 0;
    for (i=1; i <= masklength ; i++)
    {
-      aca->mask |= (1 << (32 - i));
+      aca->mask |= (1U << (32 - i));
    }
 
    /* now mask off the host portion of the ip address
@@ -780,6 +855,28 @@ int acl_addr(const char *aspec, struct access_control_addr *aca)
 #endif /* def FEATURE_ACL */
 
 
+/*********************************************************************
+ *
+ * Function    :  connect_port_is_forbidden
+ *
+ * Description :  Check to see if CONNECT requests to the destination
+ *                port of this request are forbidden. The check is
+ *                independend of the actual request method.
+ *
+ * Parameters  :
+ *          1  :  csp = Current client state (buffers, headers, etc...)
+ *
+ * Returns     :  True if yes, false otherwise.
+ *
+ *********************************************************************/
+int connect_port_is_forbidden(const struct client_state *csp)
+{
+   return ((csp->action->flags & ACTION_LIMIT_CONNECT) &&
+     !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT],
+        csp->http->port));
+}
+
+
 /*********************************************************************
  *
  * Function    :  block_url
@@ -1012,7 +1109,20 @@ struct http_response *block_url(struct client_state *csp)
       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, "path-ue", 1, url_encode(csp->http->path), 0);
-
+      if (!err)
+      {
+         const char *block_reason;
+         if (csp->action->string[ACTION_STRING_BLOCK] != NULL)
+         {
+            block_reason = csp->action->string[ACTION_STRING_BLOCK];
+         }
+         else
+         {
+            assert(connect_port_is_forbidden(csp));
+            block_reason = "Forbidden CONNECT port.";
+         }
+         err = map(exports, "block-reason", 1, html_encode(block_reason), 0);
+      }
       if (err)
       {
          free_map(exports);
@@ -1645,7 +1755,7 @@ int is_untrusted_url(const struct client_state *csp)
    /*
     * If not, do we maybe trust its referrer?
     */
-   err = parse_http_url(referer, rhttp, csp);
+   err = parse_http_url(referer, rhttp, REQUIRE_PROTOCOL);
    if (err)
    {
       return 1;
@@ -1701,7 +1811,7 @@ int is_untrusted_url(const struct client_state *csp)
                   log_error(LOG_LEVEL_ERROR, "Failed to append \'%s\' to trustfile \'%s\': %E",
                      new_entry, csp->config->trustfile);
                }
-               free(new_entry);
+               freez(new_entry);
             }
             else
             {
@@ -1740,7 +1850,7 @@ int is_untrusted_url(const struct client_state *csp)
  *                or NULL if there were no hits or something went wrong
  *
  *********************************************************************/
-char *pcrs_filter_response(struct client_state *csp)
+static char *pcrs_filter_response(struct client_state *csp)
 {
    int hits=0;
    size_t size, prev_size;
@@ -1781,7 +1891,8 @@ char *pcrs_filter_response(struct client_state *csp)
 
    if (0 == found_filters)
    {
-      log_error(LOG_LEVEL_ERROR, "Unable to get current state of regexp filtering.");
+      log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
+         "content filtering enabled, but no content filters available.");
       return(NULL);
    }
 
@@ -1852,7 +1963,7 @@ char *pcrs_filter_response(struct client_state *csp)
                   current_hits += job_hits;
                   if (old != csp->iob->cur)
                   {
-                     free(old);
+                     freez(old);
                   }
                   old = new;
                }
@@ -1898,7 +2009,7 @@ char *pcrs_filter_response(struct client_state *csp)
     */
    if (!hits)
    {
-      free(new);
+      freez(new);
       return(NULL);
    }
 
@@ -1926,7 +2037,7 @@ char *pcrs_filter_response(struct client_state *csp)
  *                or NULL in case something went wrong.
  *
  *********************************************************************/
-char *gif_deanimate_response(struct client_state *csp)
+static char *gif_deanimate_response(struct client_state *csp)
 {
    struct binbuffer *in, *out;
    char *p;
@@ -1947,7 +2058,7 @@ char *gif_deanimate_response(struct client_state *csp)
    if (gif_deanimate(in, out, strncmp("last", csp->action->string[ACTION_STRING_DEANIMATE], 4)))
    {
       log_error(LOG_LEVEL_DEANIMATE, "failed! (gif parsing)");
-      free(in);
+      freez(in);
       buf_free(out);
       return(NULL);
    }
@@ -1964,8 +2075,8 @@ char *gif_deanimate_response(struct client_state *csp)
       csp->content_length = out->offset;
       csp->flags |= CSP_FLAG_MODIFIED;
       p = out->buffer;
-      free(in);
-      free(out);
+      freez(in);
+      freez(out);
       return(p);
    }
 
@@ -1974,63 +2085,71 @@ char *gif_deanimate_response(struct client_state *csp)
 
 /*********************************************************************
  *
- * Function    :  jpeg_inspect_response
+ * Function    :  get_filter_function
  *
- * Description :  
+ * Description :  Decides which content filter function has
+ *                to be applied (if any).
  *
  * Parameters  :
  *          1  :  csp = Current client state (buffers, headers, etc...)
  *
- * Returns     :  a pointer to the (newly allocated) modified buffer
- *                or NULL in case something went wrong.
+ * Returns     :  The content filter function to run, or
+ *                NULL if no content filter is active
  *
  *********************************************************************/
-char *jpeg_inspect_response(struct client_state *csp)
+filter_function_ptr get_filter_function(struct client_state *csp)
 {
-   struct binbuffer  *in = NULL;
-   struct binbuffer *out = NULL;
-   char *p = NULL;
-   size_t size;
+   filter_function_ptr filter_function = NULL;
 
-   size = (size_t)(csp->iob->eod - csp->iob->cur);
-
-   if (NULL == (in =  (struct binbuffer *)zalloc(sizeof *in )))
+   /*
+    * Are we enabling text mode by force?
+    */
+   if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
    {
-      log_error(LOG_LEVEL_DEANIMATE, "failed! (jpeg no mem 1)");
-      return NULL;
+      /*
+       * Do we really have to?
+       */
+      if (csp->content_type & CT_TEXT)
+      {
+         log_error(LOG_LEVEL_HEADER, "Text mode is already enabled.");   
+      }
+      else
+      {
+         csp->content_type |= CT_TEXT;
+         log_error(LOG_LEVEL_HEADER, "Text mode enabled by force. Take cover!");   
+      }
    }
 
-   if (NULL == (out = (struct binbuffer *)zalloc(sizeof *out)))
+   if (!(csp->content_type & CT_DECLARED))
    {
-      log_error(LOG_LEVEL_DEANIMATE, "failed! (jpeg no mem 2)");
-      return NULL;
+      /*
+       * The server didn't bother to declare a MIME-Type.
+       * Assume it's text that can be filtered.
+       *
+       * This also regulary happens with 304 responses,
+       * therefore logging anything here would cause
+       * too much noise.
+       */
+      csp->content_type |= CT_TEXT;
    }
 
-   in->buffer = csp->iob->cur;
-   in->size = size;
-
    /*
-    * Calling jpeg_inspect has the side-effect of creating and 
-    * modifying the image buffer of "out" directly.
+    * Choose the applying filter function based on
+    * the content type and action settings.
     */
-   if (jpeg_inspect(in, out))
+   if ((csp->content_type & CT_TEXT) &&
+       (csp->rlist != NULL) &&
+       (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER])))
    {
-      log_error(LOG_LEVEL_DEANIMATE, "failed! (jpeg parsing)");
-      free(in);
-      buf_free(out);
-      return(NULL);
-
+      filter_function = pcrs_filter_response;
    }
-   else
+   else if ((csp->content_type & CT_GIF)  &&
+            (csp->action->flags & ACTION_DEANIMATE))
    {
-      csp->content_length = out->offset;
-      csp->flags |= CSP_FLAG_MODIFIED;
-      p = out->buffer;
-      free(in);
-      free(out);
-      return(p);
+      filter_function = gif_deanimate_response;
    }
 
+   return filter_function;
 }
 
 
@@ -2066,7 +2185,7 @@ static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
       return JB_ERR_PARSE;
    }
 
-   while (chunksize > 0)
+   while (chunksize > 0U)
    {
       if (NULL == (from_p = strstr(from_p, "\r\n")))
       {
@@ -2076,7 +2195,9 @@ static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
 
       if ((newsize += chunksize) >= *size)
       {
-         log_error(LOG_LEVEL_ERROR, "Chunksize exceeds buffer in  \"chunked\" transfer coding");
+         log_error(LOG_LEVEL_ERROR,
+            "Chunk size %d exceeds buffer size %d in  \"chunked\" transfer coding",
+            chunksize, *size);
          return JB_ERR_PARSE;
       }
       from_p += 2;
@@ -2087,16 +2208,11 @@ static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
 
       if (sscanf(from_p, "%x", &chunksize) != 1)
       {
-         log_error(LOG_LEVEL_ERROR, "Parse error while stripping \"chunked\" transfer coding");
-         return JB_ERR_PARSE;
+         log_error(LOG_LEVEL_INFO, "Invalid \"chunked\" transfer encoding detected and ignored.");
+         break;
       }
    }
    
-   if (0 == newsize)
-   {
-      log_error(LOG_LEVEL_RE_FILTER, "Need to de-chunk first");
-   }
-   
    /* XXX: Should get its own loglevel. */
    log_error(LOG_LEVEL_RE_FILTER, "De-chunking successful. Shrunk from %d to %d", *size, newsize);
 
@@ -2142,7 +2258,6 @@ static jb_err prepare_for_filtering(struct client_state *csp)
       }
       else
       {
-         log_error(LOG_LEVEL_ERROR, "Failed to de-chunk content.");
          return JB_ERR_PARSE;
       }
    }
@@ -2154,6 +2269,12 @@ static jb_err prepare_for_filtering(struct client_state *csp)
     */
    if (csp->content_type & (CT_GZIP|CT_DEFLATE))
    {
+      if (0 == csp->iob->eod - csp->iob->cur)
+      {
+         /* Nothing left after de-chunking. */
+         return JB_ERR_OK;
+      }
+
       err = decompress_iob(csp);
 
       if (JB_ERR_OK == err)
@@ -2169,7 +2290,6 @@ static jb_err prepare_for_filtering(struct client_state *csp)
           */
          csp->content_type &= ~CT_GZIP;
          csp->content_type &= ~CT_DEFLATE;
-         log_error(LOG_LEVEL_ERROR, "Failed to decompress content.");
       }
    }
 #endif
@@ -2188,24 +2308,34 @@ static jb_err prepare_for_filtering(struct client_state *csp)
  *          1  :  csp = Current client state (buffers, headers, etc...)
  *          2  :  content_filter = The filter function to execute
  *
- * Returns     :  JB_ERR_OK for success,
- *                JB_ERR_PARSE otherwise
+ * Returns     :  Pointer to the modified buffer, or
+ *                NULL if filtering failed or wasn't necessary.
  *
  *********************************************************************/
 char *execute_content_filter(struct client_state *csp, filter_function_ptr content_filter)
 {
+   if (0 == csp->iob->eod - csp->iob->cur)
+   {
+      /*
+       * No content (probably status code 301, 302 ...),
+       * no filtering necessary.
+       */
+      return NULL;
+   }
+
    if (JB_ERR_OK != prepare_for_filtering(csp))
    {
       /*
        * failed to de-chunk or decompress.
-       * XXX: if possible, we should continue anyway.
        */
       return NULL;
    }
 
    if (0 == csp->iob->eod - csp->iob->cur)
    {
-      /* Empty buffer, nothing to do. */
+      /*
+       * Clown alarm: chunked and/or compressed nothing delivered.
+       */
       return NULL;
    }
 
@@ -2215,19 +2345,18 @@ char *execute_content_filter(struct client_state *csp, filter_function_ptr conte
 
 /*********************************************************************
  *
- * Function    :  url_actions
+ * Function    :  get_url_actions
  *
  * Description :  Gets the actions for this URL.
  *
  * Parameters  :
- *          1  :  http = http_request request for blocked URLs
- *          2  :  csp = Current client state (buffers, headers, etc...)
+ *          1  :  csp = Current client state (buffers, headers, etc...)
+ *          2  :  http = http_request request for blocked URLs
  *
  * Returns     :  N/A
  *
  *********************************************************************/
-void url_actions(struct http_request *http,
-                 struct client_state *csp)
+void get_url_actions(struct client_state *csp, struct http_request *http)
 {
    struct file_list *fl;
    struct url_actions *b;
@@ -2309,7 +2438,7 @@ void apply_url_actions(struct current_action_spec *action,
  *                Invalid syntax is fatal.
  *
  *********************************************************************/
-static const struct forward_spec *get_forward_override_settings(struct client_state *csp)
+const static struct forward_spec *get_forward_override_settings(struct client_state *csp)
 {
    const char *forward_override_line = csp->action->string[ACTION_STRING_FORWARD_OVERRIDE];
    char forward_settings[BUFFER_SIZE];
@@ -2371,6 +2500,11 @@ static const struct forward_spec *get_forward_override_settings(struct client_st
          fwd->type = SOCKS_4A;
          socks_proxy = vec[1];
       }
+      else if (!strcasecmp(vec[0], "forward-socks5"))
+      {
+         fwd->type = SOCKS_5;
+         socks_proxy = vec[1];
+      }
 
       if (NULL != socks_proxy)
       {
@@ -2431,17 +2565,15 @@ static const struct forward_spec *get_forward_override_settings(struct client_st
  *
  * Description :  Should we forward this to another proxy?
  *
- *                XXX: Should be changed to make use of csp->fwd.
- *
  * Parameters  :
- *          1  :  http = http_request request for current URL
- *          2  :  csp = Current client state (buffers, headers, etc...)
+ *          1  :  csp = Current client state (buffers, headers, etc...)
+ *          2  :  http = http_request request for current URL
  *
  * Returns     :  Pointer to forwarding information.
  *
  *********************************************************************/
-const struct forward_spec * forward_url(struct http_request *http,
-                                        struct client_state *csp)
+const struct forward_spec *forward_url(struct client_state *csp,
+                                       const struct http_request *http)
 {
    static const struct forward_spec fwd_default[1] = { FORWARD_SPEC_INITIALIZER };
    struct forward_spec *fwd = csp->config->forward;
@@ -2539,6 +2671,25 @@ struct http_response *direct_response(struct client_state *csp)
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  content_filters_enabled
+ *
+ * Description :  Checks whether there are any content filters
+ *                enabled for the current request.
+ *
+ * Parameters  :  
+ *          1  :  action = Action spec to check.
+ *
+ * Returns     :  TRUE for yes, FALSE otherwise
+ *
+ *********************************************************************/
+int content_filters_enabled(const struct current_action_spec *action)
+{
+   return ((action->flags & ACTION_DEANIMATE) ||
+      !list_is_empty(action->multi[ACTION_MULTI_FILTER]));
+}
+
 /*
   Local Variables:
   tab-width: 3