mod_cache: Add CacheIgnoreHeaders directive.

(Justin made some minor tweaks to the patch.)

PR: 30399
Submitted by:	R�diger Pl�m <r.pluem@t-online.de>
Reviewed by:	Justin Erenkrantz

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@105569 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/CHANGES b/CHANGES
index 540f0726ee914f5aa97cec7810dbeb04fd986ec2..5a5e62477d748fd83cfa56df781e54447777add0 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -2,6 +2,9 @@ Changes with Apache 2.1.0-dev
 
   [Remove entries to the current 2.0 section below, when backported]
 
+  *) mod_cache: Add CacheIgnoreHeaders directive.  PR 30399.
+     [Rüiger Plü <r.pluem t-online.de>]
+
   *) WIN64: API changes to clean up Windows 64bit compile warnings
      [Allan Edwards]
 

diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml
index 1f8957633e3946d8aa1add1c03ae6add296bb3a2..b69310b9b37378ae1ab4ab7bbb6da5ab38321e24 100644 (file)
--- a/docs/manual/mod/mod_cache.xml
+++ b/docs/manual/mod/mod_cache.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
-<!-- $Revision: 1.17 $ -->
+<!-- $Revision: 1.18 $ -->
 
 <!--
  Copyright 2002-2004 The Apache Software Foundation
@@ -332,4 +332,57 @@ will complete caching the file even if the request is cancelled.</description>
 </usage>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>CacheIgnoreHeaders</name>
+<description>Do not store the given HTTP header(s) in the cache.
+</description>
+<syntax>CacheIgnoreHeaders <var>header-string</var> [<var>header-string</var>] ...</syntax>
+<default>CacheIgnoreHeaders None</default>
+<contextlist><context>server config</context><context>virtual host</context>
+</contextlist>
+
+<usage>
+    <p>According to RFC 2616, hop-by-hop HTTP headers are not stored in
+    the cache.  The following HTTP headers are hop-by-hop headers and thus
+    do not get stored in the cache in <em>any</em> case regardless of the
+    setting of <directive>CacheIgnoreHeaders</directive>:</p>
+
+    <ul>
+      <li><code>Connection</code></li>
+      <li><code>Keep-Alive</code></li>
+      <li><code>Proxy-Authenticate</code></li>
+      <li><code>Proxy-Authorization</code></li>
+      <li><code>TE</code></li>
+      <li><code>Trailers</code></li>
+      <li><code>Transfer-Encoding</code></li>
+      <li><code>Upgrade</code></li>
+    </ul>
+
+    <p><directive>CacheIgnoreHeaders</directive> specifies additional HTTP
+    headers that should not to be stored in the cache.  For example, it makes
+    sense in some cases to prevent cookies from being stored in the cache.</p>
+
+    <p><directive>CacheIgnoreHeaders</directive> takes a space separated list
+    of HTTP headers that should not be stored in the cache. If only hop-by-hop
+    headers not should be stored in the cache (the RFC 2616 compliant
+    behaviour), <directive>CacheIgnoreHeaders</directive> can be set to
+    <code>None</code>.</p>
+
+    <example><title>Example 1</title>
+      CacheIgnoreHeaders Set-Cookie
+    </example>
+
+    <example><title>Example 2</title>
+      CacheIgnoreHeaders None
+    </example>
+
+    <note type="warning"><title>Warning:</title>
+      If headers like <code>Expires</code> which are needed for proper cache
+      management are not stored due to a
+      <directive>CacheIgnoreHeaders</directive> setting, the behaviour of
+      mod_cache is undefined.
+    </note>
+</usage>
+</directivesynopsis>
+
 </modulesynopsis>

diff --git a/modules/experimental/cache_util.c b/modules/experimental/cache_util.c
index 9ee9f84c9afc5494c539769420771bc019699394..7c7dc59395d1cc123a5a63b1377d6478b476a1c5 100644 (file)
--- a/modules/experimental/cache_util.c
+++ b/modules/experimental/cache_util.c
@@ -21,6 +21,8 @@
 
 /* -------------------------------------------------------------- */
 
+extern module AP_MODULE_DECLARE_DATA cache_module;
+
 /* return true if the request is conditional */
 CACHE_DECLARE(int) ap_cache_request_is_conditional(apr_table_t *table)
 {
@@ -517,8 +519,13 @@ CACHE_DECLARE(char *)generate_name(apr_pool_t *p, int dirlevels,
  * headers table that are allowed to be stored in a cache.
  */
 CACHE_DECLARE(apr_table_t *)ap_cache_cacheable_hdrs_out(apr_pool_t *pool,
-                                                        apr_table_t *t)
+                                                        apr_table_t *t,
+                                                        server_rec *s)
 {
+    cache_server_conf *conf;
+    char **header;
+    int i;
+
     /* Make a copy of the headers, and remove from
      * the copy any hop-by-hop headers, as defined in Section
      * 13.5.1 of RFC 2616
@@ -533,5 +540,15 @@ CACHE_DECLARE(apr_table_t *)ap_cache_cacheable_hdrs_out(apr_pool_t *pool,
     apr_table_unset(headers_out, "Trailers");
     apr_table_unset(headers_out, "Transfer-Encoding");
     apr_table_unset(headers_out, "Upgrade");
+
+    conf = (cache_server_conf *)ap_get_module_config(s->module_config,
+                                                     &cache_module);
+    /* Remove the user defined headers set with CacheIgnoreHeaders.
+     * This may break RFC 2616 compliance on behalf of the administrator.
+     */
+    header = (char **)conf->ignore_headers->elts;
+    for (i = 0; i < conf->ignore_headers->nelts; i++) {
+        apr_table_unset(headers_out, header[i]);
+    }
     return headers_out;
 }

diff --git a/modules/experimental/mod_cache.c b/modules/experimental/mod_cache.c
index b2a6fcd8eed8abb63b5fbb7d3c5cfd012fb0a4f5..1836170fae892d712f27a81016b5bdf2e7da4f25 100644 (file)
--- a/modules/experimental/mod_cache.c
+++ b/modules/experimental/mod_cache.c
@@ -709,6 +709,9 @@ static void * create_cache_config(apr_pool_t *p, server_rec *s)
     ps->no_last_mod_ignore = 0;
     ps->ignorecachecontrol = 0;
     ps->ignorecachecontrol_set = 0 ;
+    /* array of headers that should not be stored in cache */
+    ps->ignore_headers = apr_array_make(p, 10, sizeof(char *));
+    ps->ignore_headers_set = CACHE_IGNORE_HEADERS_UNSET;
     return ps;
 }
 
@@ -745,6 +748,10 @@ static void * merge_cache_config(apr_pool_t *p, void *basev, void *overridesv)
         (overrides->ignorecachecontrol_set == 0)
         ? base->ignorecachecontrol
         : overrides->ignorecachecontrol;
+    ps->ignore_headers =
+        (overrides->ignore_headers_set == CACHE_IGNORE_HEADERS_UNSET)
+        ? base->ignore_headers
+        : overrides->ignore_headers;
     return ps;
 }
 static const char *set_cache_ignore_no_last_mod(cmd_parms *parms, void *dummy,
@@ -774,6 +781,34 @@ static const char *set_cache_ignore_cachecontrol(cmd_parms *parms,
     return NULL;
 }
 
+static const char *add_ignore_header(cmd_parms *parms, void *dummy,
+                                     const char *header)
+{
+    cache_server_conf *conf;
+    char **new;
+
+    conf =
+        (cache_server_conf *)ap_get_module_config(parms->server->module_config,
+                                                  &cache_module);
+    if (!strncasecmp(header, "None", 4)) {
+        /* if header None is listed clear array */
+        conf->ignore_headers->nelts = 0;
+    }
+    else {
+        if ((conf->ignore_headers_set == CACHE_IGNORE_HEADERS_UNSET) ||
+            (conf->ignore_headers->nelts)) {
+            /* Only add header if no "None" has been found in header list
+             * so far.
+             * (When 'None' is passed, IGNORE_HEADERS_SET && nelts == 0.)
+             */
+            new = (char **)apr_array_push(conf->ignore_headers);
+            (*new) = header;
+        }
+    }
+    conf->ignore_headers_set = CACHE_IGNORE_HEADERS_SET;
+    return NULL;
+}
+
 static const char *add_cache_enable(cmd_parms *parms, void *dummy, 
                                     const char *type, 
                                     const char *url)
@@ -906,6 +941,9 @@ static const command_rec cache_cmds[] =
                   NULL, 
                   RSRC_CONF, 
                   "Ignore requests from the client for uncached content"),
+    AP_INIT_ITERATE("CacheIgnoreHeaders", add_ignore_header, NULL, RSRC_CONF,
+                    "A space separated list of headers that should not be "
+                    "stored by the cache"),
     AP_INIT_TAKE1("CacheLastModifiedFactor", set_cache_factor, NULL, RSRC_CONF,
                   "The factor used to estimate Expires date from "
                   "LastModified date"),

diff --git a/modules/experimental/mod_cache.h b/modules/experimental/mod_cache.h
index 1135a4de1be71dade9d66f1fe4f44fc2cdd980b3..5a4497bb27298675a1f531ee548480adef0f81bd 100644 (file)
--- a/modules/experimental/mod_cache.h
+++ b/modules/experimental/mod_cache.h
@@ -133,6 +133,12 @@ typedef struct {
     /** ignore client's requests for uncached responses */
     int ignorecachecontrol;
     int ignorecachecontrol_set;
+    /** store the headers that should not be stored in the cache */
+    apr_array_header_t *ignore_headers;
+    /* flag if CacheIgnoreHeader has been set */
+    #define CACHE_IGNORE_HEADERS_SET   1
+    #define CACHE_IGNORE_HEADERS_UNSET 0
+    int ignore_headers_set;
 } cache_server_conf;
 
 /* cache info information */
@@ -255,7 +261,9 @@ CACHE_DECLARE(const char *)ap_cache_tokstr(apr_pool_t *p, const char *list, cons
 /* Create a new table consisting of those elements from a request_rec's
  * headers_out that are allowed to be stored in a cache
  */
-CACHE_DECLARE(apr_table_t *)ap_cache_cacheable_hdrs_out(apr_pool_t *pool, apr_table_t *t);
+CACHE_DECLARE(apr_table_t *)ap_cache_cacheable_hdrs_out(apr_pool_t *pool,
+                                                        apr_table_t *t,
+                                                        server_rec *s);
 
 /**
  * cache_storage.c

diff --git a/modules/experimental/mod_disk_cache.c b/modules/experimental/mod_disk_cache.c
index 6ec6fd9e04810fc4ff0b7ed1aa8e7a9bb9657739..dfca6ea1f42e97433f6143112404f3f21d5588f5 100644 (file)
--- a/modules/experimental/mod_disk_cache.c
+++ b/modules/experimental/mod_disk_cache.c
@@ -606,7 +606,8 @@ static apr_status_t store_headers(cache_handle_t *h, request_rec *r, cache_info
         if (r->headers_out) {
             apr_table_t *headers_out;
 
-            headers_out = ap_cache_cacheable_hdrs_out(r->pool, r->headers_out);
+            headers_out = ap_cache_cacheable_hdrs_out(r->pool, r->headers_out,
+                                                      r->server);
 
             if (!apr_table_get(headers_out, "Content-Type") &&
                 r->content_type) {
@@ -627,7 +628,8 @@ static apr_status_t store_headers(cache_handle_t *h, request_rec *r, cache_info
         if (r->headers_in) {
             apr_table_t *headers_in;
 
-            headers_in = ap_cache_cacheable_hdrs_out(r->pool, r->headers_in);
+            headers_in = ap_cache_cacheable_hdrs_out(r->pool, r->headers_in,
+                                                     r->server);
             rv = store_table(dobj->hfd, headers_in);
             if (rv != APR_SUCCESS) {
                 return rv;

diff --git a/modules/experimental/mod_mem_cache.c b/modules/experimental/mod_mem_cache.c
index f34ba809d72cb035c99a1c7bb29cdbc112ef115c..db7cedd5cdbcd88dfcfba72ef24b9fb631682a94 100644 (file)
--- a/modules/experimental/mod_mem_cache.c
+++ b/modules/experimental/mod_mem_cache.c
@@ -744,13 +744,16 @@ static apr_status_t store_headers(cache_handle_t *h, request_rec *r, cache_info
     /* Precompute how much storage we need to hold the headers */
     rc = serialize_table(&mobj->header_out, 
                          &mobj->num_header_out, 
-                         ap_cache_cacheable_hdrs_out(r->pool, r->headers_out));   
+                         ap_cache_cacheable_hdrs_out(r->pool, r->headers_out,
+                                                     r->server));
     if (rc != APR_SUCCESS) {
         return rc;
     }
     rc = serialize_table(&mobj->err_header_out, 
                          &mobj->num_err_header_out, 
-                         ap_cache_cacheable_hdrs_out(r->pool, r->err_headers_out));   
+                         ap_cache_cacheable_hdrs_out(r->pool,
+                                                     r->err_headers_out,
+                                                     r->server));
     if (rc != APR_SUCCESS) {
         return rc;
     }