mod_cache.c revision 2e7ef6efb7164346000607d5b5c2d2d392d1a5ea
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* ====================================================================
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The Apache Software License, Version 1.1
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Copyright (c) 2000-2003 The Apache Software Foundation. All rights
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * reserved.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Redistribution and use in source and binary forms, with or without
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * modification, are permitted provided that the following conditions
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * are met:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * 1. Redistributions of source code must retain the above copyright
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * notice, this list of conditions and the following disclaimer.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * 2. Redistributions in binary form must reproduce the above copyright
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * notice, this list of conditions and the following disclaimer in
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the documentation and/or other materials provided with the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * distribution.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * 3. The end-user documentation included with the redistribution,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * if any, must include the following acknowledgment:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * "This product includes software developed by the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Apache Software Foundation (http://www.apache.org/)."
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor * Alternately, this acknowledgment may appear in the software itself,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * if and wherever such third-party acknowledgments normally appear.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * 4. The names "Apache" and "Apache Software Foundation" must
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * not be used to endorse or promote products derived from this
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * software without prior written permission. For written
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * permission, please contact apache@apache.org.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * 5. Products derived from this software may not be called "Apache",
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * nor may "Apache" appear in their name, without prior written
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * permission of the Apache Software Foundation.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * SUCH DAMAGE.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * ====================================================================
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * This software consists of voluntary contributions made by many
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * individuals on behalf of the Apache Software Foundation. For more
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * information on the Apache Software Foundation, please see
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * <http://www.apache.org/>.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Portions of this software are based upon public domain software
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * originally written at the National Center for Supercomputing Applications,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * University of Illinois, Urbana-Champaign.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor#define CORE_PRIVATE
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor#include "mod_cache.h"
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylormodule AP_MODULE_DECLARE_DATA cache_module;
9e39c5ba00a55fa05777cc94b148296af305e135Bill TaylorAPR_OPTIONAL_FN_TYPE(ap_cache_generate_key) *cache_generate_key;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* -------------------------------------------------------------- */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* Handles for cache filters, resolved at startup to eliminate
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * a name-to-function mapping on each request
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic ap_filter_rec_t *cache_in_filter_handle;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic ap_filter_rec_t *cache_out_filter_handle;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic ap_filter_rec_t *cache_conditional_filter_handle;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * CACHE handler
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * -------------
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Can we deliver this request from the cache?
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If yes:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * deliver the content by installing the CACHE_OUT filter.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If no:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * check whether we're allowed to try cache it
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If yes:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * add CACHE_IN filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If No:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * oh well.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic int cache_url_handler(request_rec *r, int lookup)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_status_t rv;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *cc_in, *pragma, *auth;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_uri_t uri = r->parsed_uri;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor char *url = r->unparsed_uri;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_size_t urllen;
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor char *path = uri.path;
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor const char *types;
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor cache_info *info = NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_request_rec *cache;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf = (cache_server_conf *) ap_get_module_config(r->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* we don't handle anything but GET */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (r->method_number != M_GET) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Which cache module (if any) should handle this request?
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!(types = ap_cache_get_cachetype(r, conf, path))) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor urllen = strlen(url);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (urllen > MAX_URL_LENGTH) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: URL exceeds length threshold: %s", url);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* DECLINE urls ending in / ??? EGP: why? */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (url[urllen-1] == '/') {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor /* make space for the per request config */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache = (cache_request_rec *) ap_get_module_config(r->request_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!cache) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache = apr_pcalloc(r->pool, sizeof(cache_request_rec));
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_set_module_config(r->request_config, &cache_module, cache);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* save away the type */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache->types = types;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Are we allowed to serve cached info at all?
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* find certain cache controlling headers */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cc_in = apr_table_get(r->headers_in, "Cache-Control");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor pragma = apr_table_get(r->headers_in, "Pragma");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor auth = apr_table_get(r->headers_in, "Authorization");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* first things first - does the request allow us to return
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * cached information at all? If not, just decline the request.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Note that there is a big difference between not being allowed
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * to cache a request (no-store) and not being allowed to return
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * a cached request without revalidation (max-age=0).
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Caching is forbidden under the following circumstances:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * - RFC2616 14.9.2 Cache-Control: no-store
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * - Pragma: no-cache
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * - Any requests requiring authorization.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (conf->ignorecachecontrol == 1 && auth == NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "incoming request is asking for a uncached version of "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "%s, but we know better and are ignoring it", url);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (ap_cache_liststr(NULL, cc_in, "no-store", NULL) ||
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_cache_liststr(NULL, pragma, "no-cache", NULL) || (auth != NULL)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* delete the previously cached file */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_remove_url(r, cache->types, url);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: no-store forbids caching of %s", url);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
c7facc54c4abed9e554ff80225311e6b7048d3c9Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Try to serve this request from the cache.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If no existing cache file
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * add cache_in filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If stale cache file
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If conditional request
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * add cache_in filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If non-conditional request
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * fudge response into a conditional
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * add cache_conditional filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If fresh cache file
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * clear filter stack
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * add cache_out filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor rv = cache_select_url(r, cache->types, url);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (DECLINED == rv) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!lookup) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* no existing cache file */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: no cache - add cache_in filter and DECLINE");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* add cache_in filter to cache this request */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_add_output_filter_handle(cache_in_filter_handle, NULL, r,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r->connection);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (OK == rv) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* RFC2616 13.2 - Check cache object expiration */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache->fresh = ap_cache_check_freshness(cache, r);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (cache->fresh) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* fresh data available */
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor apr_bucket_brigade *out;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conn_rec *c = r->connection;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (lookup) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return OK;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor rv = ap_meets_conditions(r);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (rv != OK) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: fresh cache - returning status %d", rv);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return rv;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Not a conditionl request. Serve up the content
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: fresh cache - add cache_out filter and "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "handle request");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* We are in the quick handler hook, which means that no output
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * filters have been set. So lets run the insert_filter hook.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_run_insert_filter(r);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_add_output_filter_handle(cache_out_filter_handle, NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r, r->connection);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* kick off the filter stack */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor out = apr_brigade_create(r->pool, c->bucket_alloc);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (APR_SUCCESS
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor != (rv = ap_pass_brigade(r->output_filters, out))) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_ERR, rv, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: error returned while trying to return %s "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cached data",
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache->type);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return rv;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return OK;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!r->err_headers_out) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r->err_headers_out = apr_table_make(r->pool, 3);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* stale data available */
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor if (lookup) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: stale cache - test conditional");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if conditional request */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (ap_cache_request_is_conditional(r)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: conditional - add cache_in filter and "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "DECLINE");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* Why not add CACHE_CONDITIONAL? */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_add_output_filter_handle(cache_in_filter_handle, NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r, r->connection);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* else if non-conditional request */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* Temporarily hack this to work the way it had been. Its broken,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * but its broken the way it was before. I'm working on figuring
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * out why the filter add in the conditional filter doesn't work. pjr
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * info = &(cache->handle->cache_obj->info);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Uncomment the above when the code in cache_conditional_filter_handle
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * is properly fixed... pjr
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* fudge response into a conditional */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (info && info->etag) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: nonconditional - fudge conditional "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "by etag");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if we have a cached etag */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_table_set(r->headers_in, "If-None-Match", info->etag);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (info && info->lastmods) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: nonconditional - fudge conditional "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "by lastmod");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if we have a cached IMS */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_table_set(r->headers_in,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "If-Modified-Since",
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->lastmods);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* something else - pretend there was no cache */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: nonconditional - no cached "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "etag/lastmods - add cache_in and DECLINE");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_add_output_filter_handle(cache_in_filter_handle, NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r, r->connection);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return DECLINED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* add cache_conditional filter */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: nonconditional - add cache_conditional "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "and DECLINE");
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor ap_add_output_filter_handle(cache_conditional_filter_handle,
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor NULL,
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor r,
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor r->connection);
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor return DECLINED;
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor }
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor }
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor }
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor else {
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor /* error */
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor ap_log_error(APLOG_MARK, APLOG_ERR, rv,
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor r->server,
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor "cache: error returned while checking for cached file by "
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor "%s cache",
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor cache->type);
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor return DECLINED;
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor }
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor}
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor/*
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor * CACHE_OUT filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * ----------------
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor * Deliver cached content (headers and body) up the stack.
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor */
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylorstatic int cache_out_filter(ap_filter_t *f, apr_bucket_brigade *bb)
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor{
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor request_rec *r = f->r;
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor cache_request_rec *cache;
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor cache = (cache_request_rec *) ap_get_module_config(r->request_config,
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor &cache_module);
17a2b317610f531d565bf4e940433aab2d9e6985Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!cache) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* user likely configured CACHE_OUT manually; they should use mod_cache
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * configuration to do that */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "CACHE_OUT enabled unexpectedly");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_remove_output_filter(f);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ap_pass_brigade(f->next, bb);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: running CACHE_OUT filter");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* cache_read_entity_headers() was called in cache_select_url() */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_read_entity_body(cache->handle, r->pool, bb);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* This filter is done once it has served up its content */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_remove_output_filter(f);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: serving %s", r->uri);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ap_pass_brigade(f->next, bb);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * CACHE_CONDITIONAL filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * ------------------------
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Decide whether or not cached content should be delivered
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * based on our fudged conditional request.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If response HTTP_NOT_MODIFIED
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * replace ourselves with cache_out filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Otherwise
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * replace ourselves with cache_in filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic int cache_conditional_filter(ap_filter_t *f, apr_bucket_brigade *in)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, f->r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: running CACHE_CONDITIONAL filter");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (f->r->status == HTTP_NOT_MODIFIED) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* replace ourselves with CACHE_OUT filter */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_add_output_filter_handle(cache_out_filter_handle, NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor f->r, f->r->connection);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* replace ourselves with CACHE_IN filter */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_add_output_filter_handle(cache_in_filter_handle, NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor f->r, f->r->connection);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_remove_output_filter(f);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ap_pass_brigade(f->next, in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * CACHE_IN filter
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * ---------------
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Decide whether or not this content should be cached.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If we decide no it should:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * remove the filter from the chain
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If we decide yes it should:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * pass the data to the storage manager
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * pass the data to the next filter (the network)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic int cache_in_filter(ap_filter_t *f, apr_bucket_brigade *in)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor int rv;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor int date_in_errhdr = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor request_rec *r = f->r;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_request_rec *cache;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor char *url = r->unparsed_uri;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *cc_out, *cl;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *exps, *lastmods, *dates, *etag;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_time_t exp, date, lastmod, now;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_off_t size;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_info *info;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor char *reason;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_pool_t *p;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* check first whether running this filter has any point or not */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if(r->no_cache) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_remove_output_filter(f);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ap_pass_brigade(f->next, in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: running CACHE_IN filter");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* Setup cache_request_rec */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache = (cache_request_rec *) ap_get_module_config(r->request_config, &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!cache) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache = apr_pcalloc(r->pool, sizeof(cache_request_rec));
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_set_module_config(r->request_config, &cache_module, cache);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor p = r->pool;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Pass Data to Cache
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * ------------------
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * This section passes the brigades into the cache modules, but only
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * if the setup section (see below) is complete.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* have we already run the cachability check and set up the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * cached file handle?
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (cache->in_checked) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* pass the brigades into the cache, then pass them
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * up the filter stack
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor rv = cache_write_entity_body(cache->handle, r, in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (rv != APR_SUCCESS) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_remove_output_filter(f);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ap_pass_brigade(f->next, in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Setup Data in Cache
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * -------------------
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * This section opens the cache entity and sets various caching
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * parameters, and decides whether this URL should be cached at
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * all. This section is* run before the above section.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info = apr_pcalloc(r->pool, sizeof(cache_info));
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* read expiry date; if a bad date, then leave it so the client can
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * read it
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor exps = apr_table_get(r->err_headers_out, "Expires");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (exps == NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor exps = apr_table_get(r->headers_out, "Expires");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (exps != NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (APR_DATE_BAD == (exp = apr_date_parse_http(exps))) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor exps = NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor exp = APR_DATE_BAD;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* read the last-modified date; if the date is bad, then delete it */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor lastmods = apr_table_get(r->err_headers_out, "Last-Modified");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (lastmods ==NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor lastmods = apr_table_get(r->headers_out, "Last-Modified");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (lastmods != NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (APR_DATE_BAD == (lastmod = apr_date_parse_http(lastmods))) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor lastmods = NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor lastmod = APR_DATE_BAD;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf = (cache_server_conf *) ap_get_module_config(r->server->module_config, &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* read the etag and cache-control from the entity */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor etag = apr_table_get(r->err_headers_out, "Etag");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (etag == NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor etag = apr_table_get(r->headers_out, "Etag");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cc_out = apr_table_get(r->err_headers_out, "Cache-Control");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (cc_out == NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cc_out = apr_table_get(r->headers_out, "Cache-Control");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * what responses should we not cache?
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * At this point we decide based on the response headers whether it
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * is appropriate _NOT_ to cache the data from the server. There are
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * a whole lot of conditions that prevent us from caching this data.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * They are tested here one by one to be clear and unambiguous.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (r->status != HTTP_OK && r->status != HTTP_NON_AUTHORITATIVE
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor && r->status != HTTP_MULTIPLE_CHOICES
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor && r->status != HTTP_MOVED_PERMANENTLY
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor && r->status != HTTP_NOT_MODIFIED) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* RFC2616 13.4 we are allowed to cache 200, 203, 206, 300, 301 or 410
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * We don't cache 206, because we don't (yet) cache partial responses.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * We include 304 Not Modified here too as this is the origin server
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * telling us to serve the cached copy.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = apr_psprintf(p, "Response status %d", r->status);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (exps != NULL && exp == APR_DATE_BAD) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if a broken Expires header is present, don't cache it */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = apr_pstrcat(p, "Broken expires header: ", exps, NULL);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (r->args && exps == NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if query string present but no expiration time, don't cache it
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * (RFC 2616/13.9)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = "Query string present but no expires header";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (r->status == HTTP_NOT_MODIFIED && (NULL == cache->handle)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if the server said 304 Not Modified but we have no cache
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * file - pass this untouched to the user agent, it's not for us.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = "HTTP Status 304 Not Modified";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (r->status == HTTP_OK && lastmods == NULL && etag == NULL
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor && (exps == NULL) && (conf->no_last_mod_ignore ==0)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* 200 OK response from HTTP/1.0 and up without Last-Modified,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Etag, or Expires headers.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* Note: mod-include clears last_modified/expires/etags - this
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * is why we have an optional function for a key-gen ;-)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = "No Last-Modified, Etag, or Expires headers";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (r->header_only) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* HEAD requests */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = "HTTP HEAD request";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (ap_cache_liststr(NULL, cc_out, "no-store", NULL)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* RFC2616 14.9.2 Cache-Control: no-store response
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * indicating do not cache, or stop now if you are
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * trying to cache it */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = "Cache-Control: no-store present";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (ap_cache_liststr(NULL, cc_out, "private", NULL)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* RFC2616 14.9.1 Cache-Control: private
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * this object is marked for this user's eyes only. Behave
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * as a tunnel.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = "Cache-Control: private present";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (apr_table_get(r->headers_in, "Authorization") != NULL
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor && !(ap_cache_liststr(NULL, cc_out, "s-maxage", NULL)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor || ap_cache_liststr(NULL, cc_out, "must-revalidate", NULL)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor || ap_cache_liststr(NULL, cc_out, "public", NULL))) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* RFC2616 14.8 Authorisation:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * if authorisation is included in the request, we don't cache,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * but we can cache if the following exceptions are true:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * 1) If Cache-Control: s-maxage is included
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * 2) If Cache-Control: must-revalidate is included
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * 3) If Cache-Control: public is included
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = "Authorization required";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (r->no_cache) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* or we've been asked not to cache it above */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor reason = "no_cache present";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (reason) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: %s not cached. Reason: %s", url, reason);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* remove this object from the cache
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * BillS Asks.. Why do we need to make this call to remove_url?
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * leave it in for now..
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_remove_url(r, cache->types, url);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* remove this filter from the chain */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_remove_output_filter(f);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* ship the data up the stack */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ap_pass_brigade(f->next, in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache->in_checked = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* Set the content length if known.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cl = apr_table_get(r->err_headers_out, "Content-Length");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (cl == NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cl = apr_table_get(r->headers_out, "Content-Length");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (cl) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor size = apr_atoi64(cl);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if we don't get the content-length, see if we have all the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * buckets and use their length to calculate the size
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_bucket *e;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor int all_buckets_here=0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor int unresolved_length = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor size=0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor for (e = APR_BRIGADE_FIRST(in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor e != APR_BRIGADE_SENTINEL(in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor e = APR_BUCKET_NEXT(e))
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (APR_BUCKET_IS_EOS(e)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor all_buckets_here=1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor break;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (APR_BUCKET_IS_FLUSH(e)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor unresolved_length = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor continue;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (e->length == (apr_size_t)-1) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor break;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor size += e->length;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!all_buckets_here) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor size = -1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* It's safe to cache the response.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * There are two possiblities at this point:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * - cache->handle == NULL. In this case there is no previously
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * cached entity anywhere on the system. We must create a brand
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * new entity and store the response in it.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * - cache->handle != NULL. In this case there is a stale
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * entity in the system which needs to be replaced by new
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * content (unless the result was 304 Not Modified, which means
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the cached entity is actually fresh, and we should update
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the headers).
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* no cache handle, create a new entity */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!cache->handle) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor rv = cache_create_entity(r, cache->types, url, size);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* pre-existing cache handle and 304, make entity fresh */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else if (r->status == HTTP_NOT_MODIFIED) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* update headers: TODO */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* remove this filter ??? */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* XXX is this right? we must set rv to something other than OK
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * in this path
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor rv = HTTP_NOT_MODIFIED;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* pre-existing cache handle and new entity, replace entity
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * with this one
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_remove_entity(r, cache->types, cache->handle);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor rv = cache_create_entity(r, cache->types, url, size);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (rv != OK) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* Caching layer declined the opportunity to cache the response */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_remove_output_filter(f);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ap_pass_brigade(f->next, in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: Caching url: %s", url);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * We now want to update the cache file header information with
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the new date, last modified, expire and content length and write
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * it away to our cache file. First, we determine these values from
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the response, using heuristics if appropriate.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor *
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * In addition, we make HTTP/1.1 age calculations and write them away
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * too.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* Read the date. Generate one if one is not supplied */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor dates = apr_table_get(r->err_headers_out, "Date");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (dates != NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor date_in_errhdr = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor dates = apr_table_get(r->headers_out, "Date");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (dates != NULL) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->date = apr_date_parse_http(dates);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->date = APR_DATE_BAD;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor now = apr_time_now();
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (info->date == APR_DATE_BAD) { /* No, or bad date */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor char *dates;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* no date header (or bad header)! */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* add one; N.B. use the time _now_ rather than when we were checking
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the cache
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (date_in_errhdr == 1) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_table_unset(r->err_headers_out, "Date");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor date = now;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor dates = apr_pcalloc(r->pool, MAX_STRING_LEN);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_rfc822_date(dates, now);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_table_set(r->headers_out, "Date", dates);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: Added date header");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->date = date;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor date = info->date;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* set response_time for HTTP/1.1 age calculations */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->response_time = now;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* get the request time */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->request_time = r->request_time;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* check last-modified date */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (lastmod != APR_DATE_BAD && lastmod > date) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if it's in the future, then replace by date */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor lastmod = date;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor lastmods = dates;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor r->server,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "cache: Last modified is in the future, "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "replacing with now");
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->lastmod = lastmod;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if no expiry date then
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * if lastmod
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * expiry date = date + min((date - lastmod) * factor, maxexpire)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * else
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * expire date = date + defaultexpire
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (exp == APR_DATE_BAD) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* if lastmod == date then you get 0*conf->factor which results in
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * an expiration time of now. This causes some problems with
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * freshness calculations, so we choose the else path...
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if ((lastmod != APR_DATE_BAD) && (lastmod < date)) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_time_t x = (apr_time_t) ((date - lastmod) * conf->factor);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (x > conf->maxex) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor x = conf->maxex;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor exp = date + x;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor else {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor exp = date + conf->defex;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->expire = exp;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->content_type = apr_pstrdup(r->pool, r->content_type);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->etag = apr_pstrdup(r->pool, etag);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->lastmods = apr_pstrdup(r->pool, lastmods);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor info->filename = apr_pstrdup(r->pool, r->filename );
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /*
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Write away header information to cache.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor rv = cache_write_entity_headers(cache->handle, r, info);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (rv == APR_SUCCESS) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor rv = cache_write_entity_body(cache->handle, r, in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (rv != APR_SUCCESS) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_remove_output_filter(f);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ap_pass_brigade(f->next, in);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* -------------------------------------------------------------- */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* Setup configurable data */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic void * create_cache_config(apr_pool_t *p, server_rec *s)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *ps = apr_pcalloc(p, sizeof(cache_server_conf));
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* array of URL prefixes for which caching is enabled */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->cacheenable = apr_array_make(p, 10, sizeof(struct cache_enable));
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* array of URL prefixes for which caching is disabled */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->cachedisable = apr_array_make(p, 10, sizeof(struct cache_disable));
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* maximum time to cache a document */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->maxex = DEFAULT_CACHE_MAXEXPIRE;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->maxex_set = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* default time to cache a document */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->defex = DEFAULT_CACHE_EXPIRE;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->defex_set = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* factor used to estimate Expires date from LastModified date */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->factor = DEFAULT_CACHE_LMFACTOR;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->factor_set = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* default percentage to force cache completion */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->complete = DEFAULT_CACHE_COMPLETION;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->complete_set = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->no_last_mod_ignore_set = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->no_last_mod_ignore = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->ignorecachecontrol = 0;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->ignorecachecontrol_set = 0 ;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ps;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic void * merge_cache_config(apr_pool_t *p, void *basev, void *overridesv)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *ps = apr_pcalloc(p, sizeof(cache_server_conf));
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *base = (cache_server_conf *) basev;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *overrides = (cache_server_conf *) overridesv;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* array of URL prefixes for which caching is disabled */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->cachedisable = apr_array_append(p,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor base->cachedisable,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor overrides->cachedisable);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* array of URL prefixes for which caching is enabled */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->cacheenable = apr_array_append(p,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor base->cacheenable,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor overrides->cacheenable);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* maximum time to cache a document */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->maxex = (overrides->maxex_set == 0) ? base->maxex : overrides->maxex;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* default time to cache a document */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->defex = (overrides->defex_set == 0) ? base->defex : overrides->defex;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* factor used to estimate Expires date from LastModified date */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->factor =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (overrides->factor_set == 0) ? base->factor : overrides->factor;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* default percentage to force cache completion */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->complete =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (overrides->complete_set == 0) ? base->complete : overrides->complete;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->no_last_mod_ignore =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (overrides->no_last_mod_ignore_set == 0)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ? base->no_last_mod_ignore
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor : overrides->no_last_mod_ignore;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ps->ignorecachecontrol =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (overrides->ignorecachecontrol_set == 0)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ? base->ignorecachecontrol
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor : overrides->ignorecachecontrol;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return ps;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const char *set_cache_ignore_no_last_mod(cmd_parms *parms, void *dummy,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor int flag)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (cache_server_conf *)ap_get_module_config(parms->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->no_last_mod_ignore = flag;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->no_last_mod_ignore_set = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const char *set_cache_ignore_cachecontrol(cmd_parms *parms,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor void *dummy, int flag)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (cache_server_conf *)ap_get_module_config(parms->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->ignorecachecontrol = flag;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->ignorecachecontrol_set = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const char *add_cache_enable(cmd_parms *parms, void *dummy,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *type,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *url)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor struct cache_enable *new;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (cache_server_conf *)ap_get_module_config(parms->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor new = apr_array_push(conf->cacheenable);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor new->type = type;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor new->url = url;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const char *add_cache_disable(cmd_parms *parms, void *dummy,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *url)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor struct cache_enable *new;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (cache_server_conf *)ap_get_module_config(parms->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor new = apr_array_push(conf->cachedisable);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor new->url = url;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const char *set_cache_maxex(cmd_parms *parms, void *dummy,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *arg)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (cache_server_conf *)ap_get_module_config(parms->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->maxex = (apr_time_t) (atol(arg) * MSEC_ONE_SEC);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->maxex_set = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const char *set_cache_defex(cmd_parms *parms, void *dummy,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *arg)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (cache_server_conf *)ap_get_module_config(parms->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->defex = (apr_time_t) (atol(arg) * MSEC_ONE_SEC);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->defex_set = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const char *set_cache_factor(cmd_parms *parms, void *dummy,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *arg)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor double val;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (cache_server_conf *)ap_get_module_config(parms->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (sscanf(arg, "%lg", &val) != 1) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return "CacheLastModifiedFactor value must be a float";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->factor = val;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->factor_set = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const char *set_cache_complete(cmd_parms *parms, void *dummy,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor const char *arg)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_server_conf *conf;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor int val;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (cache_server_conf *)ap_get_module_config(parms->server->module_config,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor &cache_module);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (sscanf(arg, "%u", &val) != 1) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return "CacheForceCompletion value must be a percentage";
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->complete = val;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor conf->complete_set = 1;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return NULL;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic int cache_post_config(apr_pool_t *p, apr_pool_t *plog,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor apr_pool_t *ptemp, server_rec *s)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* This is the means by which unusual (non-unix) os's may find alternate
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * means to run a given command (e.g. shebang/registry parsing on Win32)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_generate_key = APR_RETRIEVE_OPTIONAL_FN(ap_cache_generate_key);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor if (!cache_generate_key) {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_generate_key = cache_generate_key_default;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor }
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor return OK;
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic const command_rec cache_cmds[] =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* XXX
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Consider a new config directive that enables loading specific cache
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * implememtations (like mod_cache_mem, mod_cache_file, etc.).
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Rather than using a LoadModule directive, admin would use something
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * like CacheModule mem_cache_module | file_cache_module, etc,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * which would cause the approprpriate cache module to be loaded.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * This is more intuitive that requiring a LoadModule directive.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_INIT_TAKE2("CacheEnable", add_cache_enable, NULL, RSRC_CONF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "A cache type and partial URL prefix below which "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "caching is enabled"),
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_INIT_TAKE1("CacheDisable", add_cache_disable, NULL, RSRC_CONF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "A partial URL prefix below which caching is disabled"),
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_INIT_TAKE1("CacheMaxExpire", set_cache_maxex, NULL, RSRC_CONF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "The maximum time in seconds to cache a document"),
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_INIT_TAKE1("CacheDefaultExpire", set_cache_defex, NULL, RSRC_CONF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "The default time in seconds to cache a document"),
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_INIT_FLAG("CacheIgnoreNoLastMod", set_cache_ignore_no_last_mod, NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor RSRC_CONF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "Ignore Responses where there is no Last Modified Header"),
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_INIT_FLAG("CacheIgnoreCacheControl", set_cache_ignore_cachecontrol,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor RSRC_CONF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "Ignore requests from the client for uncached content"),
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_INIT_TAKE1("CacheLastModifiedFactor", set_cache_factor, NULL, RSRC_CONF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "The factor used to estimate Expires date from "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "LastModified date"),
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_INIT_TAKE1("CacheForceCompletion", set_cache_complete, NULL, RSRC_CONF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "Percentage of download to arrive for the cache to force "
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor "complete transfer"),
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor {NULL}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor};
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorstatic void register_hooks(apr_pool_t *p)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* cache initializer */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* cache handler */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_hook_quick_handler(cache_url_handler, NULL, NULL, APR_HOOK_FIRST);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* cache filters
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * XXX The cache filters need to run right after the handlers and before
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * any other filters. Consider creating AP_FTYPE_CACHE for this purpose.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Make them AP_FTYPE_CONTENT for now.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * XXX ianhH:they should run AFTER all the other content filters.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_in_filter_handle =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_register_output_filter("CACHE_IN",
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_in_filter,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_FTYPE_CONTENT_SET-1);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor /* CACHE_OUT must go into the filter chain before SUBREQ_CORE to
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * handle subrequsts. Decrementing filter type by 1 ensures this
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * happens.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_out_filter_handle =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_register_output_filter("CACHE_OUT",
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_out_filter,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_FTYPE_CONTENT_SET-1);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_conditional_filter_handle =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_register_output_filter("CACHE_CONDITIONAL",
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_conditional_filter,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor NULL,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor AP_FTYPE_CONTENT_SET);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ap_hook_post_config(cache_post_config, NULL, NULL, APR_HOOK_REALLY_FIRST);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor}
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylormodule AP_MODULE_DECLARE_DATA cache_module =
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor{
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor STANDARD20_MODULE_STUFF,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor NULL, /* create per-directory config structure */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor NULL, /* merge per-directory config structures */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor create_cache_config, /* create per-server config structure */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor merge_cache_config, /* merge per-server config structures */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor cache_cmds, /* command apr_table_t */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor register_hooks
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor};
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor