mod_cache: Make CacheEnable and CacheDisable configurable per

directory in addition to per server, making them work from within
a LocationMatch.

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

diff --git a/CHANGES b/CHANGES
index 6930b277dd3f130b35013ba2aead8812a3ac5cb3..cd1aa5a3e2bf8bde40e1c7306177be1a142d0efb 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -2,6 +2,10 @@
 
 Changes with Apache 2.3.12
 
+  *) mod_cache: Make CacheEnable and CacheDisable configurable per
+     directory in addition to per server, making them work from within
+     a LocationMatch. [Graham Leggett]
+
   *) worker, event, prefork: Correct several issues when built as
      DSOs; most notably, the scoreboard was reinitialized during graceful
      restart, such that processes of the previous generation were not

diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml
index 97d7c11760241fbb38a4239946b758aecbf74d3f..943ef2f66e3cd11d6065ae401363dc2778de3e65 100644 (file)
--- a/docs/manual/mod/mod_cache.xml
+++ b/docs/manual/mod/mod_cache.xml
@@ -332,17 +332,20 @@
 <name>CacheEnable</name>
 <description>Enable caching of specified URLs using a specified storage
 manager</description>
-<syntax>CacheEnable <var>cache_type</var> <var>url-string</var></syntax>
+<syntax>CacheEnable <var>cache_type</var> [<var>url-string</var>]</syntax>
 <contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
 </contextlist>
 
 <usage>
     <p>The <directive>CacheEnable</directive> directive instructs
     <module>mod_cache</module> to cache urls at or below
     <var>url-string</var>. The cache storage manager is specified with the
-    <var>cache_type</var> argument. If the <directive>CacheEnable</directive>
-    directive is placed inside a <directive type="section">Location</directive>
-    directive, the <var>url-string</var> becomes optional.
+    <var>cache_type</var> argument. The <directive>CacheEnable</directive>
+    directive can alternatively be placed inside either
+    <directive type="section">Location</directive> or
+    <directive type="section">LocationMatch</directive> sections to indicate
+    the content is cacheable.
     <var>cache_type</var> <code>disk</code> instructs
     <module>mod_cache</module> to use the disk based storage manager
     implemented by <module>mod_cache_disk</module>.</p>
@@ -351,13 +354,28 @@ manager</description>
     each possible storage manager will be run until the first one that
     actually processes the request. The order in which the storage managers are
     run is determined by the order of the <directive>CacheEnable</directive>
-    directives in the configuration file.</p>
+    directives in the configuration file. <directive>CacheEnable</directive>
+    directives within <directive type="section">Location</directive> or
+    <directive type="section">LocationMatch</directive> sections are processed
+    before globally defined <directive>CacheEnable</directive> directives.</p>
 
     <p>When acting as a forward proxy server, <var>url-string</var> can
     also be used to specify remote sites and proxy protocols which 
     caching should be enabled for.</p>
- 
+
     <example>
+      # Cache content<br />
+      &lt;Location /foo&gt;<br />
+      <indent>
+        CacheEnable disk<br />
+      </indent>
+      &lt;/Location&gt;<br /><br />
+      # Cache regex<br />
+      &lt;LocationMatch foo$&gt;<br />
+      <indent>
+        CacheEnable disk<br />
+      </indent>
+      &lt;/LocationMatch&gt;<br /><br />
       # Cache proxied url's<br />
       CacheEnable  disk  /<br /><br />
       # Cache FTP-proxied url's<br />
@@ -390,6 +408,7 @@ manager</description>
 <description>Disable caching of specified URLs</description>
 <syntax>CacheDisable <var>url-string</var> | <var>on</var></syntax>
 <contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
 </contextlist>
 
 <usage>
@@ -407,11 +426,13 @@ manager</description>
 
     <example><title>Example</title>
       &lt;Location /foo&gt;<br />
+      <indent>
         CacheDisable on<br />
+      </indent>
       &lt;/Location&gt;<br />
     </example>
 
-    <p> The <code>no-cache</code> environment variable can be set to 
+    <p>The <code>no-cache</code> environment variable can be set to 
     disable caching on a finer grained set of resources in versions
     2.2.12 and later.</p>
 

diff --git a/modules/cache/cache_util.c b/modules/cache/cache_util.c
index 7c36617f4eaefcd1e21397938e3191816379e7a1..d359f0a8d4f07a7c364b16411b137aef2bbe8a7e 100644 (file)
--- a/modules/cache/cache_util.c
+++ b/modules/cache/cache_util.c
@@ -126,51 +126,58 @@ static int uri_meets_conditions(const apr_uri_t *filter, const int pathlen,
     return !strncmp(filter->path, url->path, pathlen);
 }
 
+static cache_provider_list *get_provider(request_rec *r, struct cache_enable *ent,
+        cache_provider_list *providers)
+{
+    /* Fetch from global config and add to the list. */
+    cache_provider *provider;
+    provider = ap_lookup_provider(CACHE_PROVIDER_GROUP, ent->type,
+                                  "0");
+    if (!provider) {
+        /* Log an error! */
+    }
+    else {
+        cache_provider_list *newp;
+        newp = apr_pcalloc(r->pool, sizeof(cache_provider_list));
+        newp->provider_name = ent->type;
+        newp->provider = provider;
+
+        if (!providers) {
+            providers = newp;
+        }
+        else {
+            cache_provider_list *last = providers;
+
+            while (last->next) {
+                if (last->provider == provider) {
+                    return providers;
+                }
+                last = last->next;
+            }
+            if (last->provider == provider) {
+                return providers;
+            }
+            last->next = newp;
+        }
+    }
+
+    return providers;
+}
+
 cache_provider_list *cache_get_providers(request_rec *r,
         cache_server_conf *conf,
         apr_uri_t uri)
 {
+    cache_dir_conf *dconf = dconf = ap_get_module_config(r->per_dir_config, &cache_module);
     cache_provider_list *providers = NULL;
     int i;
 
-    /* loop through all the cacheenable entries */
-    for (i = 0; i < conf->cacheenable->nelts; i++) {
-        struct cache_enable *ent =
-                                (struct cache_enable *)conf->cacheenable->elts;
-        if (uri_meets_conditions(&ent[i].url, ent[i].pathlen, &uri)) {
-            /* Fetch from global config and add to the list. */
-            cache_provider *provider;
-            provider = ap_lookup_provider(CACHE_PROVIDER_GROUP, ent[i].type,
-                                          "0");
-            if (!provider) {
-                /* Log an error! */
-            }
-            else {
-                cache_provider_list *newp;
-                newp = apr_pcalloc(r->pool, sizeof(cache_provider_list));
-                newp->provider_name = ent[i].type;
-                newp->provider = provider;
-
-                if (!providers) {
-                    providers = newp;
-                }
-                else {
-                    cache_provider_list *last = providers;
-
-                    while (last->next) {
-                        last = last->next;
-                    }
-                    last->next = newp;
-                }
-            }
-        }
+    /* per directory cache disable */
+    if (dconf->disable) {
+        return NULL;
     }
 
-    /* then loop through all the cachedisable entries
-     * Looking for urls that contain the full cachedisable url and possibly
-     * more.
-     * This means we are disabling cachedisable url and below...
-     */
+    /* global cache disable */
     for (i = 0; i < conf->cachedisable->nelts; i++) {
         struct cache_disable *ent =
                                (struct cache_disable *)conf->cachedisable->elts;
@@ -180,6 +187,22 @@ cache_provider_list *cache_get_providers(request_rec *r,
         }
     }
 
+    /* loop through all the per directory cacheenable entries */
+    for (i = 0; i < dconf->cacheenable->nelts; i++) {
+        struct cache_enable *ent =
+                                (struct cache_enable *)dconf->cacheenable->elts;
+        providers = get_provider(r, &ent[i], providers);
+    }
+
+    /* loop through all the global cacheenable entries */
+    for (i = 0; i < conf->cacheenable->nelts; i++) {
+        struct cache_enable *ent =
+                                (struct cache_enable *)conf->cacheenable->elts;
+        if (uri_meets_conditions(&ent[i].url, ent[i].pathlen, &uri)) {
+            providers = get_provider(r, &ent[i], providers);
+        }
+    }
+
     return providers;
 }
 

diff --git a/modules/cache/cache_util.h b/modules/cache/cache_util.h
index ba8c9c31b77603e85069451925dbf49b044bd2a7..dc28b6d2c6bc8711ccbf6e635547dee546f299c1 100644 (file)
--- a/modules/cache/cache_util.h
+++ b/modules/cache/cache_util.h
@@ -164,6 +164,10 @@ typedef struct {
     apr_time_t defex;
     /* factor for estimating expires date */
     double factor;
+    /* cache enabled for this location */
+    apr_array_header_t *cacheenable;
+    /* cache disabled for this location */
+    int disable:1;
     /* set X-Cache headers */
     int x_cache:1;
     int x_cache_detail:1;
@@ -188,6 +192,8 @@ typedef struct {
     int store_expired_set:1;
     int store_private_set:1;
     int store_nostore_set:1;
+    int enable_set:1;
+    int disable_set:1;
 } cache_dir_conf;
 
 /* A linked-list of authn providers. */

diff --git a/modules/cache/mod_cache.c b/modules/cache/mod_cache.c
index afaaf997ee7fad7d1ca1b3a0f9beb338620d14f0..5ff8c2c621da986eefc5cb912a0d37b13811d5db 100644 (file)
--- a/modules/cache/mod_cache.c
+++ b/modules/cache/mod_cache.c
@@ -1720,6 +1720,9 @@ static void *create_dir_config(apr_pool_t *p, char *dummy)
 
     dconf->stale_on_error = DEFAULT_CACHE_STALE_ON_ERROR;
 
+    /* array of providers for this URL space */
+    dconf->cacheenable = apr_array_make(p, 10, sizeof(struct cache_enable));
+
     return dconf;
 }
 
@@ -1764,6 +1767,12 @@ static void *merge_dir_config(apr_pool_t *p, void *basev, void *addv) {
     new->stale_on_error_set = add->stale_on_error_set
             || base->stale_on_error_set;
 
+    new->cacheenable = add->enable_set ? apr_array_append(p, base->cacheenable,
+            add->cacheenable) : base->cacheenable;
+    new->enable_set = add->enable_set || base->enable_set;
+    new->disable = (add->disable_set == 0) ? base->disable : add->disable;
+    new->disable_set = add->disable_set || base->disable_set;
+
     return new;
 }
 
@@ -1993,6 +2002,7 @@ static const char *add_cache_enable(cmd_parms *parms, void *dummy,
                                     const char *type,
                                     const char *url)
 {
+    cache_dir_conf *dconf = (cache_dir_conf *)dummy;
     cache_server_conf *conf;
     struct cache_enable *new;
 
@@ -2023,7 +2033,15 @@ static const char *add_cache_enable(cmd_parms *parms, void *dummy,
     conf =
         (cache_server_conf *)ap_get_module_config(parms->server->module_config,
                                                   &cache_module);
-    new = apr_array_push(conf->cacheenable);
+
+    if (parms->path) {
+        new = apr_array_push(dconf->cacheenable);
+        dconf->enable_set = 1;
+    }
+    else {
+        new = apr_array_push(conf->cacheenable);
+    }
+
     new->type = type;
     if (apr_uri_parse(parms->pool, url, &(new->url))) {
         return NULL;
@@ -2040,6 +2058,7 @@ static const char *add_cache_enable(cmd_parms *parms, void *dummy,
 static const char *add_cache_disable(cmd_parms *parms, void *dummy,
                                      const char *url)
 {
+    cache_dir_conf *dconf = (cache_dir_conf *)dummy;
     cache_server_conf *conf;
     struct cache_disable *new;
 
@@ -2065,6 +2084,13 @@ static const char *add_cache_disable(cmd_parms *parms, void *dummy,
     conf =
         (cache_server_conf *)ap_get_module_config(parms->server->module_config,
                                                   &cache_module);
+
+    if (parms->path) {
+        dconf->disable = 1;
+        dconf->disable_set = 1;
+        return NULL;
+    }
+
     new = apr_array_push(conf->cachedisable);
     if (apr_uri_parse(parms->pool, url, &(new->url))) {
         return NULL;