mod_cache.c revision c1ba97f41a4526d84fb7a1596afe3dd11e065a2c
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny/* Licensed to the Apache Software Foundation (ASF) under one or more
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * contributor license agreements. See the NOTICE file distributed with
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * this work for additional information regarding copyright ownership.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * The ASF licenses this file to You under the Apache License, Version 2.0
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * (the "License"); you may not use this file except in compliance with
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * the License. You may obtain a copy of the License at
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * http://www.apache.org/licenses/LICENSE-2.0
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Unless required by applicable law or agreed to in writing, software
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * distributed under the License is distributed on an "AS IS" BASIS,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * See the License for the specific language governing permissions and
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * limitations under the License.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny#include "mod_cache.h"
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zelenymodule AP_MODULE_DECLARE_DATA cache_module;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan ZelenyAPR_OPTIONAL_FN_TYPE(ap_cache_generate_key) *cache_generate_key;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny/* -------------------------------------------------------------- */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny/* Handles for cache filters, resolved at startup to eliminate
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * a name-to-function mapping on each request
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozekstatic ap_filter_rec_t *cache_filter_handle;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zelenystatic ap_filter_rec_t *cache_save_filter_handle;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zelenystatic ap_filter_rec_t *cache_save_subreq_filter_handle;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zelenystatic ap_filter_rec_t *cache_out_filter_handle;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zelenystatic ap_filter_rec_t *cache_out_subreq_filter_handle;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zelenystatic ap_filter_rec_t *cache_remove_url_filter_handle;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek/*
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * CACHE handler
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * -------------
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Can we deliver this request from the cache?
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * If yes:
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * deliver the content by installing the CACHE_OUT filter.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * If no:
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * check whether we're allowed to try cache it
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * If yes:
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * add CACHE_SAVE filter
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * If No:
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * oh well.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * By default, the cache handler runs in the quick handler, bypassing
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * virtually all server processing and offering the cache its optimal
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * performance. In this mode, the cache bolts onto the front of the
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * server, and behaves as a discrete RFC2616 caching proxy
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * implementation.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * Under certain circumstances, an admin might want to run the cache as
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * a normal handler instead of a quick handler, allowing the cache to
bdbf4f169e4d5d00b0616df19f7a55debb407f78Pavel Březina * run after the authorisation hooks, or by allowing fine control over
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * the placement of the cache in the filter chain. This option comes at
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * a performance penalty, and should only be used to achieve specific
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * caching goals where the admin understands what they are doing.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zelenystatic int cache_quick_handler(request_rec *r, int lookup)
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek{
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek apr_status_t rv;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny const char *auth;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny cache_provider_list *providers;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek cache_request_rec *cache;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek apr_bucket_brigade *out;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny ap_filter_t *next;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny ap_filter_rec_t *cache_out_handle;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek cache_server_conf *conf;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /* Delay initialization until we know we are handling a GET */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (r->method_number != M_GET) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek return DECLINED;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny conf = (cache_server_conf *) ap_get_module_config(r->server->module_config,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny &cache_module);
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* only run if the quick handler is enabled */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (!conf->quick) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny return DECLINED;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /*
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Which cache module (if any) should handle this request?
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (!(providers = ap_cache_get_providers(r, conf, r->parsed_uri))) {
b668c77874c6fed325471bdcf5954979a0d734e2Stef Walter return DECLINED;
b668c77874c6fed325471bdcf5954979a0d734e2Stef Walter }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov /* make space for the per request config */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny cache = apr_pcalloc(r->pool, sizeof(cache_request_rec));
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny cache->size = -1;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny cache->out = apr_brigade_create(r->pool, r->connection->bucket_alloc);
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
ef2455b63380ecd17bea94270ceaabe15dcf6456Jakub Hrozek /* store away the per request config where the API can find it */
ef2455b63380ecd17bea94270ceaabe15dcf6456Jakub Hrozek apr_pool_userdata_setn(cache, MOD_CACHE_REQUEST_REC, NULL, r->pool);
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* save away the possible providers */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny cache->providers = providers;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /*
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Are we allowed to serve cached info at all?
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* find certain cache controlling headers */
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov auth = apr_table_get(r->headers_in, "Authorization");
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* First things first - does the request allow us to return
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * cached information at all? If not, just decline the request.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (auth) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny return DECLINED;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /*
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * Try to serve this request from the cache.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek *
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * If no existing cache file (DECLINED)
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * add cache_save filter
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * If cached file (OK)
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * clear filter stack
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * add cache_out filter
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * return OK
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek rv = cache_select(r);
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose if (rv != OK) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (rv == DECLINED) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (!lookup) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /* try to obtain a cache lock at this point. if we succeed,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * we are the first to try and cache this url. if we fail,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * it means someone else is already trying to cache this
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * url, and we should just let the request through to the
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * backend without any attempt to cache. this stops
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * duplicated simultaneous attempts to cache an entity.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek rv = ap_cache_try_lock(conf, r, NULL);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (APR_SUCCESS == rv) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /*
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * Add cache_save filter to cache this request. Choose
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * the correct filter by checking if we are a subrequest
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * or not.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (r->main) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek r->server,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek "Adding CACHE_SAVE_SUBREQ filter for %s",
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek r->uri);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_add_output_filter_handle(cache_save_subreq_filter_handle,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek cache, r, r->connection);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek else {
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek r->server, "Adding CACHE_SAVE filter for %s",
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek r->uri);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_add_output_filter_handle(cache_save_filter_handle,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek cache, r, r->connection);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, r->server,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek "Adding CACHE_REMOVE_URL filter for %s",
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov r->uri);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /* Add cache_remove_url filter to this request to remove a
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov * stale cache entry if needed. Also put the current cache
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov * request rec in the filter context, as the request that
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * is available later during running the filter may be
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * different due to an internal redirect.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek cache->remove_url_filter =
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_add_output_filter_handle(cache_remove_url_filter_handle,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek cache, r, r->connection);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek else {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, rv,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek r->server, "Cache locked for url, not caching "
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek "response: %s", r->uri);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek else {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (cache->stale_headers) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS,
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek r->server, "Restoring request headers for %s",
877b92e80bde510d5cd9f03dbf01e2bcf73ab072Michal Židek r->uri);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek r->headers_in = cache->stale_headers;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek else {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /* error */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_log_error(APLOG_MARK, APLOG_ERR, rv, r->server,
ef2455b63380ecd17bea94270ceaabe15dcf6456Jakub Hrozek "cache: error returned while checking for cached "
b6d5f2a91fbce15c7ef4d382fa6b52407adb26ddPavel Březina "file by '%s' cache", cache->provider_name);
b6d5f2a91fbce15c7ef4d382fa6b52407adb26ddPavel Březina }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek return DECLINED;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /* if we are a lookup, we are exiting soon one way or another; Restore
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * the headers. */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (lookup) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (cache->stale_headers) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, r->server,
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose "Restoring request headers.");
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek r->headers_in = cache->stale_headers;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek rv = ap_meets_conditions(r);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (rv != OK) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /* If we are a lookup, we have to return DECLINED as we have no
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * way of knowing if we will be able to serve the content.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (lookup) {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek return DECLINED;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /* Return cached status. */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek return rv;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* If we're a lookup, we can exit now instead of serving the content. */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (lookup) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny return OK;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /* Serve up the content */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* We are in the quick handler hook, which means that no output
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * filters have been set. So lets run the insert_filter hook.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_run_insert_filter(r);
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov /*
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov * Add cache_out filter to serve this request. Choose
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * the correct filter by checking if we are a subrequest
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * or not.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (r->main) {
877b92e80bde510d5cd9f03dbf01e2bcf73ab072Michal Židek cache_out_handle = cache_out_subreq_filter_handle;
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek else {
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek cache_out_handle = cache_out_filter_handle;
877b92e80bde510d5cd9f03dbf01e2bcf73ab072Michal Židek }
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ap_add_output_filter_handle(cache_out_handle, cache, r, r->connection);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek /*
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * Remove all filters that are before the cache_out filter. This ensures
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose * that we kick off the filter stack with our cache_out filter being the
bdbf4f169e4d5d00b0616df19f7a55debb407f78Pavel Březina * first in the chain. This make sense because we want to restore things
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * in the same manner as we saved them.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * There may be filters before our cache_out filter, because
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
ef2455b63380ecd17bea94270ceaabe15dcf6456Jakub Hrozek * 1. We call ap_set_content_type during cache_select. This causes
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * Content-Type specific filters to be added.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * 2. We call the insert_filter hook. This causes filters e.g. like
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * the ones set with SetOutputFilter to be added.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek next = r->output_filters;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny while (next && (next->frec != cache_out_handle)) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny ap_remove_output_filter(next);
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny next = next->next;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* kick off the filter stack */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny out = apr_brigade_create(r->pool, r->connection->bucket_alloc);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek rv = ap_pass_brigade(r->output_filters, out);
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek if (rv != APR_SUCCESS) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (rv != AP_FILTER_ERROR) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny ap_log_error(APLOG_MARK, APLOG_ERR, rv, r->server,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny "cache: error returned while trying to return %s "
65393a294e635822c1d7a15fe5853dc457ad8a2aSimo Sorce "cached data",
65393a294e635822c1d7a15fe5853dc457ad8a2aSimo Sorce cache->provider_name);
65393a294e635822c1d7a15fe5853dc457ad8a2aSimo Sorce }
65393a294e635822c1d7a15fe5853dc457ad8a2aSimo Sorce return rv;
aac3ca699a09090072ae4d68bdda8dec990ae393Sumit Bose }
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov return OK;
aac3ca699a09090072ae4d68bdda8dec990ae393Sumit Bose}
aac3ca699a09090072ae4d68bdda8dec990ae393Sumit Bose
aac3ca699a09090072ae4d68bdda8dec990ae393Sumit Bose/**
aac3ca699a09090072ae4d68bdda8dec990ae393Sumit Bose * If the two filter handles are present within the filter chain, replace
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce * the last instance of the first filter with the last instance of the
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce * second filter, and return true. If the second filter is not present at
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce * all, the first filter is removed, and false is returned. If neither
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce * filter is present, false is returned and this function does nothing.
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce */
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashovstatic int cache_replace_filter(ap_filter_t *next, ap_filter_rec_t *from,
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce ap_filter_rec_t *to) {
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce ap_filter_t *ffrom = NULL, *fto = NULL;
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce while (next) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (next->frec == from && !next->ctx) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny ffrom = next;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (next->frec == to && !next->ctx) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny fto = next;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny next = next->next;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (ffrom && fto) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny ffrom->frec = fto->frec;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny ffrom->ctx = fto->ctx;
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov ap_remove_output_filter(fto);
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov return 1;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (ffrom) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny ap_remove_output_filter(ffrom);
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny return 0;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny}
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny/**
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * The cache handler is functionally similar to the cache_quick_hander,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * however a number of steps that are required by the quick handler are
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * not required here, as the normal httpd processing has already handled
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * these steps.
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose */
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bosestatic int cache_handler(request_rec *r)
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose{
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose apr_status_t rv;
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose cache_provider_list *providers;
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose cache_request_rec *cache;
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose apr_bucket_brigade *out;
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose ap_filter_t *next;
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov ap_filter_rec_t *cache_out_handle;
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov ap_filter_rec_t *cache_save_handle;
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose cache_server_conf *conf;
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose /* Delay initialization until we know we are handling a GET */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (r->method_number != M_GET) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny return DECLINED;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny conf = (cache_server_conf *) ap_get_module_config(r->server->module_config,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny &cache_module);
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* only run if the quick handler is disabled */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny if (conf->quick) {
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny return DECLINED;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny }
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /*
877b92e80bde510d5cd9f03dbf01e2bcf73ab072Michal Židek * Which cache module (if any) should handle this request?
877b92e80bde510d5cd9f03dbf01e2bcf73ab072Michal Židek */
4f118e3e6a25762f40a43e6dbefb09f44adbef32Simo Sorce if (!(providers = ap_cache_get_providers(r, conf, r->parsed_uri))) {
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce return DECLINED;
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce }
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce /* make space for the per request config */
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce cache = apr_pcalloc(r->pool, sizeof(cache_request_rec));
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce cache->size = -1;
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce cache->out = apr_brigade_create(r->pool, r->connection->bucket_alloc);
bba1a5fd62cffcae076d1351df5a83fbc4a6ec17Simo Sorce
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* store away the per request config where the API can find it */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny apr_pool_userdata_setn(cache, MOD_CACHE_REQUEST_REC, NULL, r->pool);
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /* save away the possible providers */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny cache->providers = providers;
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny /*
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * Try to serve this request from the cache.
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek *
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * If no existing cache file (DECLINED)
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * add cache_save filter
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * If cached file (OK)
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * clear filter stack
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * add cache_out filter
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * return OK
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose */
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek rv = cache_select(r);
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek if (rv != OK) {
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek if (rv == DECLINED) {
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose /* try to obtain a cache lock at this point. if we succeed,
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * we are the first to try and cache this url. if we fail,
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * it means someone else is already trying to cache this
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * url, and we should just let the request through to the
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * backend without any attempt to cache. this stops
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * duplicated simultaneous attempts to cache an entity.
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek */
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek rv = ap_cache_try_lock(conf, r, NULL);
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek if (APR_SUCCESS == rv) {
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek /*
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * Add cache_save filter to cache this request. Choose
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * the correct filter by checking if we are a subrequest
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * or not.
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek */
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose if (r->main) {
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS,
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose r->server,
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose "Adding CACHE_SAVE_SUBREQ filter for %s",
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose r->uri);
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose cache_save_handle = cache_save_subreq_filter_handle;
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose }
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose else {
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS,
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose r->server, "Adding CACHE_SAVE filter for %s",
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek r->uri);
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose cache_save_handle = cache_save_filter_handle;
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek }
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose ap_add_output_filter_handle(cache_save_handle,
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov cache, r, r->connection);
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose /*
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * Did the user indicate the precise location of the
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * CACHE_SAVE filter by inserting the CACHE filter as a
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * marker?
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose *
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * If so, we get cunning and replace CACHE with the
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * CACHE_SAVE filter. This has the effect of inserting
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * the CACHE_SAVE filter at the precise location where
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * the admin wants to cache the content. All filters that
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * lie before and after the original location of the CACHE
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * filter will remain in place.
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose */
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose if (cache_replace_filter(r->output_filters,
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek cache_filter_handle, cache_save_handle)) {
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS,
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek r->server, "Replacing CACHE with CACHE_SAVE "
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek "filter for %s", r->uri);
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek }
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, r->server,
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek "Adding CACHE_REMOVE_URL filter for %s",
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose r->uri);
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose /* Add cache_remove_url filter to this request to remove a
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov * stale cache entry if needed. Also put the current cache
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek * request rec in the filter context, as the request that
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * is available later during running the filter may be
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose * different due to an internal redirect.
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose */
0528fdec17d0031996e919fcd852459e86592c35Jakub Hrozek cache->remove_url_filter =
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose ap_add_output_filter_handle(cache_remove_url_filter_handle,
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose cache, r, r->connection);
909a86af4eb99f5d311d7136cab78dca535ae304Sumit Bose
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek else {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, rv,
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek r->server, "Cache locked for url, not caching "
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek "response: %s", r->uri);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina else {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /* error */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek ap_log_error(APLOG_MARK, APLOG_ERR, rv, r->server,
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek "cache: error returned while checking for cached "
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek "file by %s cache", cache->provider_name);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek return DECLINED;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek rv = ap_meets_conditions(r);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek if (rv != OK) {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek return rv;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /* Serve up the content */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /*
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * Add cache_out filter to serve this request. Choose
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * the correct filter by checking if we are a subrequest
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * or not.
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek if (r->main) {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek cache_out_handle = cache_out_subreq_filter_handle;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek else {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek cache_out_handle = cache_out_filter_handle;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek ap_add_output_filter_handle(cache_out_handle, cache, r, r->connection);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /*
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * Did the user indicate the precise location of the CACHE_OUT filter by
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * inserting the CACHE filter as a marker?
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek *
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * If so, we get cunning and replace CACHE with the CACHE_OUT filters.
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * This has the effect of inserting the CACHE_OUT filter at the precise
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * location where the admin wants to cache the content. All filters that
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * lie *after* the original location of the CACHE filter will remain in
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * place.
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek if (cache_replace_filter(r->output_filters, cache_filter_handle, cache_out_handle)) {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS,
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek r->server, "Replacing CACHE with CACHE_OUT filter for %s",
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek r->uri);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /*
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * Remove all filters that are before the cache_out filter. This ensures
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * that we kick off the filter stack with our cache_out filter being the
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * first in the chain. This make sense because we want to restore things
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * in the same manner as we saved them.
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * There may be filters before our cache_out filter, because
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek *
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * 1. We call ap_set_content_type during cache_select. This causes
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * Content-Type specific filters to be added.
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * 2. We call the insert_filter hook. This causes filters e.g. like
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * the ones set with SetOutputFilter to be added.
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek next = r->output_filters;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek while (next && (next->frec != cache_out_handle)) {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek ap_remove_output_filter(next);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek next = next->next;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /* kick off the filter stack */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek out = apr_brigade_create(r->pool, r->connection->bucket_alloc);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek rv = ap_pass_brigade(r->output_filters, out);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek if (rv != APR_SUCCESS) {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek if (rv != AP_FILTER_ERROR) {
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek ap_log_error(APLOG_MARK, APLOG_ERR, rv, r->server,
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek "cache: error returned while trying to return %s "
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek "cached data",
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek cache->provider_name);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek return rv;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek }
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek return OK;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek}
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek/*
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * CACHE_OUT filter
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * ----------------
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina *
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina * Deliver cached content (headers and body) up the stack.
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozekstatic int cache_out_filter(ap_filter_t *f, apr_bucket_brigade *bb)
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek{
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek request_rec *r = f->r;
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina cache_request_rec *cache = (cache_request_rec *)f->ctx;
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina if (!cache) {
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina /* user likely configured CACHE_OUT manually; they should use mod_cache
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina * configuration to do that */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek "CACHE/CACHE_OUT filter enabled while caching is disabled, ignoring");
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina ap_remove_output_filter(f);
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina return ap_pass_brigade(f->next, bb);
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina }
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, r->server,
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek "cache: running CACHE_OUT filter");
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /* restore status of cached response */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /* XXX: This exposes a bug in mem_cache, since it does not
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * restore the status into it's handle. */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek r->status = cache->handle->cache_obj->info.status;
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /* recall_headers() was called in cache_select() */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek cache->provider->recall_body(cache->handle, r->pool, bb);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek /* This filter is done once it has served up its content */
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek ap_remove_output_filter(f);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, r->server,
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina "cache: serving %s", r->uri);
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina return ap_pass_brigade(f->next, bb);
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek}
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek/*
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * Having jumped through all the hoops and decided to cache the
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * response, call store_body() for each brigade, handling the
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * case where the provider can't swallow the full brigade. In this
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * case, we write the brigade we were passed out downstream, and
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * loop around to try and cache some more until the in brigade is
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek * completely empty. As soon as the out brigade contains eos, call
28ebfa4373d1e7ce45b5d70a3619df1c074a661ePavel Březina * commit_entity() to finalise the cached element.
7caf7ed4f2eae1ec1c0717b4ee6ce78bdacd5926Jakub Hrozek */
static int cache_save_store(ap_filter_t *f, apr_bucket_brigade *in,
cache_server_conf *conf, cache_request_rec *cache)
{
int rv = APR_SUCCESS;
apr_bucket *e;
/* pass the brigade in into the cache provider, which is then
* expected to move cached buckets to the out brigade, for us
* to pass up the filter stack. repeat until in is empty, or
* we fail.
*/
while (APR_SUCCESS == rv && !APR_BRIGADE_EMPTY(in)) {
rv = cache->provider->store_body(cache->handle, f->r, in, cache->out);
if (rv != APR_SUCCESS) {
ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, f->r->server,
"cache: Cache provider's store_body failed!");
ap_remove_output_filter(f);
/* give someone else the chance to cache the file */
ap_cache_remove_lock(conf, f->r, cache->handle ?
(char *)cache->handle->cache_obj->key : NULL, NULL);
/* give up trying to cache, just step out the way */
APR_BRIGADE_PREPEND(in, cache->out);
return ap_pass_brigade(f->next, in);
}
/* does the out brigade contain eos? if so, we're done, commit! */
for (e = APR_BRIGADE_FIRST(cache->out);
e != APR_BRIGADE_SENTINEL(cache->out);
e = APR_BUCKET_NEXT(e))
{
if (APR_BUCKET_IS_EOS(e)) {
rv = cache->provider->commit_entity(cache->handle, f->r);
break;
}
}
/* conditionally remove the lock as soon as we see the eos bucket */
ap_cache_remove_lock(conf, f->r, cache->handle ?
(char *)cache->handle->cache_obj->key : NULL, cache->out);
if (APR_BRIGADE_EMPTY(cache->out)) {
if (APR_BRIGADE_EMPTY(in)) {
/* cache provider wants more data before passing the brigade
* upstream, oblige the provider by leaving to fetch more.
*/
break;
}
else {
/* oops, no data out, but not all data read in either, be
* safe and stand down to prevent a spin.
*/
ap_log_error(APLOG_MARK, APLOG_WARNING, rv, f->r->server,
"cache: Cache provider's store_body returned an "
"empty brigade, but didn't consume all of the"
"input brigade, standing down to prevent a spin");
ap_remove_output_filter(f);
/* give someone else the chance to cache the file */
ap_cache_remove_lock(conf, f->r, cache->handle ?
(char *)cache->handle->cache_obj->key : NULL, NULL);
return ap_pass_brigade(f->next, in);
}
}
rv = ap_pass_brigade(f->next, cache->out);
}
return rv;
}
/*
* CACHE_SAVE filter
* ---------------
*
* Decide whether or not this content should be cached.
* If we decide no it should not:
* remove the filter from the chain
* If we decide yes it should:
* Have we already started saving the response?
* If we have started, pass the data to the storage manager via store_body
* Otherwise:
* Check to see if we *can* save this particular response.
* If we can, call cache_create_entity() and save the headers and body
* Finally, pass the data to the next filter (the network or whatever)
*
* After the various failure cases, the cache lock is proactively removed, so
* that another request is given the opportunity to attempt to cache without
* waiting for a potentially slow client to acknowledge the failure.
*/
static int cache_save_filter(ap_filter_t *f, apr_bucket_brigade *in)
{
int rv = !OK;
request_rec *r = f->r;
cache_request_rec *cache = (cache_request_rec *)f->ctx;
cache_server_conf *conf;
const char *cc_out, *cl;
const char *exps, *lastmods, *dates, *etag;
apr_time_t exp, date, lastmod, now;
apr_off_t size = -1;
cache_info *info = NULL;
char *reason;
apr_pool_t *p;
apr_bucket *e;
conf = (cache_server_conf *) ap_get_module_config(r->server->module_config,
&cache_module);
/* Setup cache_request_rec */
if (!cache) {
/* user likely configured CACHE_SAVE manually; they should really use
* mod_cache configuration to do that
*/
ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
"CACHE/CACHE_SAVE filter enabled while caching is disabled, ignoring");
ap_remove_output_filter(f);
return ap_pass_brigade(f->next, in);
}
reason = NULL;
p = r->pool;
/*
* Pass Data to Cache
* ------------------
* This section passes the brigades into the cache modules, but only
* if the setup section (see below) is complete.
*/
if (cache->block_response) {
/* We've already sent down the response and EOS. So, ignore
* whatever comes now.
*/
return APR_SUCCESS;
}
/* have we already run the cachability check and set up the
* cached file handle?
*/
if (cache->in_checked) {
return cache_save_store(f, in, conf, cache);
}
/*
* Setup Data in Cache
* -------------------
* This section opens the cache entity and sets various caching
* parameters, and decides whether this URL should be cached at
* all. This section is* run before the above section.
*/
/* read expiry date; if a bad date, then leave it so the client can
* read it
*/
exps = apr_table_get(r->err_headers_out, "Expires");
if (exps == NULL) {
exps = apr_table_get(r->headers_out, "Expires");
}
if (exps != NULL) {
if (APR_DATE_BAD == (exp = apr_date_parse_http(exps))) {
exps = NULL;
}
}
else {
exp = APR_DATE_BAD;
}
/* read the last-modified date; if the date is bad, then delete it */
lastmods = apr_table_get(r->err_headers_out, "Last-Modified");
if (lastmods == NULL) {
lastmods = apr_table_get(r->headers_out, "Last-Modified");
}
if (lastmods != NULL) {
lastmod = apr_date_parse_http(lastmods);
if (lastmod == APR_DATE_BAD) {
lastmods = NULL;
}
}
else {
lastmod = APR_DATE_BAD;
}
/* read the etag and cache-control from the entity */
etag = apr_table_get(r->err_headers_out, "Etag");
if (etag == NULL) {
etag = apr_table_get(r->headers_out, "Etag");
}
cc_out = apr_table_get(r->err_headers_out, "Cache-Control");
if (cc_out == NULL) {
cc_out = apr_table_get(r->headers_out, "Cache-Control");
}
/*
* what responses should we not cache?
*
* At this point we decide based on the response headers whether it
* is appropriate _NOT_ to cache the data from the server. There are
* a whole lot of conditions that prevent us from caching this data.
* They are tested here one by one to be clear and unambiguous.
*/
if (r->status != HTTP_OK && r->status != HTTP_NON_AUTHORITATIVE
&& r->status != HTTP_PARTIAL_CONTENT
&& r->status != HTTP_MULTIPLE_CHOICES
&& r->status != HTTP_MOVED_PERMANENTLY
&& r->status != HTTP_NOT_MODIFIED) {
/* RFC2616 13.4 we are allowed to cache 200, 203, 206, 300, 301 or 410
* We allow the caching of 206, but a cache implementation might choose
* to decline to cache a 206 if it doesn't know how to.
* We include 304 Not Modified here too as this is the origin server
* telling us to serve the cached copy.
*/
if (exps != NULL || cc_out != NULL) {
/* We are also allowed to cache any response given that it has a
* valid Expires or Cache Control header. If we find a either of
* those here, we pass request through the rest of the tests. From
* the RFC:
*
* A response received with any other status code (e.g. status
* codes 302 and 307) MUST NOT be returned in a reply to a
* subsequent request unless there are cache-control directives or
* another header(s) that explicitly allow it. For example, these
* include the following: an Expires header (section 14.21); a
* "max-age", "s-maxage", "must-revalidate", "proxy-revalidate",
* "public" or "private" cache-control directive (section 14.9).
*/
}
else {
reason = apr_psprintf(p, "Response status %d", r->status);
}
}
if (reason) {
/* noop */
}
else if (exps != NULL && exp == APR_DATE_BAD) {
/* if a broken Expires header is present, don't cache it */
reason = apr_pstrcat(p, "Broken expires header: ", exps, NULL);
}
else if (exp != APR_DATE_BAD && exp < r->request_time)
{
/* if a Expires header is in the past, don't cache it */
reason = "Expires header already expired, not cacheable";
}
else if (!conf->ignorequerystring && r->parsed_uri.query && exps == NULL &&
!ap_cache_liststr(NULL, cc_out, "max-age", NULL) &&
!ap_cache_liststr(NULL, cc_out, "s-maxage", NULL)) {
/* if a query string is present but no explicit expiration time,
* don't cache it (RFC 2616/13.9 & 13.2.1)
*/
reason = "Query string present but no explicit expiration time";
}
else if (r->status == HTTP_NOT_MODIFIED &&
!cache->handle && !cache->stale_handle) {
/* if the server said 304 Not Modified but we have no cache
* file - pass this untouched to the user agent, it's not for us.
*/
reason = "HTTP Status 304 Not Modified";
}
else if (r->status == HTTP_OK && lastmods == NULL && etag == NULL
&& (exps == NULL) && (conf->no_last_mod_ignore ==0) &&
!ap_cache_liststr(NULL, cc_out, "max-age", NULL) &&
!ap_cache_liststr(NULL, cc_out, "s-maxage", NULL)) {
/* 200 OK response from HTTP/1.0 and up without Last-Modified,
* Etag, Expires, Cache-Control:max-age, or Cache-Control:s-maxage
* headers.
*/
/* Note: mod-include clears last_modified/expires/etags - this
* is why we have an optional function for a key-gen ;-)
*/
reason = "No Last-Modified, Etag, Expires, Cache-Control:max-age or Cache-Control:s-maxage headers";
}
else if (r->header_only && !cache->stale_handle) {
/* Forbid HEAD requests unless we have it cached already */
reason = "HTTP HEAD request";
}
else if (!conf->store_nostore &&
ap_cache_liststr(NULL, cc_out, "no-store", NULL)) {
/* RFC2616 14.9.2 Cache-Control: no-store response
* indicating do not cache, or stop now if you are
* trying to cache it.
*/
/* FIXME: The Cache-Control: no-store could have come in on a 304,
* FIXME: while the original request wasn't conditional. IOW, we
* FIXME: made the the request conditional earlier to revalidate
* FIXME: our cached response.
*/
reason = "Cache-Control: no-store present";
}
else if (!conf->store_private &&
ap_cache_liststr(NULL, cc_out, "private", NULL)) {
/* RFC2616 14.9.1 Cache-Control: private response
* this object is marked for this user's eyes only. Behave
* as a tunnel.
*/
/* FIXME: See above (no-store) */
reason = "Cache-Control: private present";
}
else if (apr_table_get(r->headers_in, "Authorization") != NULL
&& !(ap_cache_liststr(NULL, cc_out, "s-maxage", NULL)
|| ap_cache_liststr(NULL, cc_out, "must-revalidate", NULL)
|| ap_cache_liststr(NULL, cc_out, "public", NULL))) {
/* RFC2616 14.8 Authorisation:
* if authorisation is included in the request, we don't cache,
* but we can cache if the following exceptions are true:
* 1) If Cache-Control: s-maxage is included
* 2) If Cache-Control: must-revalidate is included
* 3) If Cache-Control: public is included
*/
reason = "Authorization required";
}
else if (ap_cache_liststr(NULL,
apr_table_get(r->headers_out, "Vary"),
"*", NULL)) {
reason = "Vary header contains '*'";
}
else if (apr_table_get(r->subprocess_env, "no-cache") != NULL) {
reason = "environment variable 'no-cache' is set";
}
else if (r->no_cache) {
/* or we've been asked not to cache it above */
reason = "r->no_cache present";
}
if (reason) {
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
"cache: %s not cached. Reason: %s", r->unparsed_uri,
reason);
/* remove this filter from the chain */
ap_remove_output_filter(f);
/* remove the lock file unconditionally */
ap_cache_remove_lock(conf, r, cache->handle ?
(char *)cache->handle->cache_obj->key : NULL, NULL);
/* ship the data up the stack */
return ap_pass_brigade(f->next, in);
}
/* Make it so that we don't execute this path again. */
cache->in_checked = 1;
/* Set the content length if known.
*/
cl = apr_table_get(r->err_headers_out, "Content-Length");
if (cl == NULL) {
cl = apr_table_get(r->headers_out, "Content-Length");
}
if (cl) {
char *errp;
if (apr_strtoff(&size, cl, &errp, 10) || *errp || size < 0) {
cl = NULL; /* parse error, see next 'if' block */
}
}
if (!cl) {
/* if we don't get the content-length, see if we have all the
* buckets and use their length to calculate the size
*/
int all_buckets_here=0;
size=0;
for (e = APR_BRIGADE_FIRST(in);
e != APR_BRIGADE_SENTINEL(in);
e = APR_BUCKET_NEXT(e))
{
if (APR_BUCKET_IS_EOS(e)) {
all_buckets_here=1;
break;
}
if (APR_BUCKET_IS_FLUSH(e)) {
continue;
}
if (e->length == (apr_size_t)-1) {
break;
}
size += e->length;
}
if (!all_buckets_here) {
size = -1;
}
}
/* remember content length to check response size against later */
cache->size = size;
/* It's safe to cache the response.
*
* There are two possiblities at this point:
* - cache->handle == NULL. In this case there is no previously
* cached entity anywhere on the system. We must create a brand
* new entity and store the response in it.
* - cache->stale_handle != NULL. In this case there is a stale
* entity in the system which needs to be replaced by new
* content (unless the result was 304 Not Modified, which means
* the cached entity is actually fresh, and we should update
* the headers).
*/
/* Did we have a stale cache entry that really is stale?
*
* Note that for HEAD requests, we won't get the body, so for a stale
* HEAD request, we don't remove the entity - instead we let the
* CACHE_REMOVE_URL filter remove the stale item from the cache.
*/
if (cache->stale_handle) {
if (r->status == HTTP_NOT_MODIFIED) {
/* Oh, hey. It isn't that stale! Yay! */
cache->handle = cache->stale_handle;
info = &cache->handle->cache_obj->info;
rv = OK;
}
else if (!r->header_only) {
/* Oh, well. Toss it. */
cache->provider->remove_entity(cache->stale_handle);
/* Treat the request as if it wasn't conditional. */
cache->stale_handle = NULL;
/*
* Restore the original request headers as they may be needed
* by further output filters like the byterange filter to make
* the correct decisions.
*/
r->headers_in = cache->stale_headers;
}
}
/* no cache handle, create a new entity only for non-HEAD requests */
if (!cache->handle && !r->header_only) {
rv = cache_create_entity(r, size, in);
info = apr_pcalloc(r->pool, sizeof(cache_info));
/* We only set info->status upon the initial creation. */
info->status = r->status;
}
if (rv != OK) {
/* Caching layer declined the opportunity to cache the response */
ap_remove_output_filter(f);
ap_cache_remove_lock(conf, r, cache->handle ?
(char *)cache->handle->cache_obj->key : NULL, NULL);
return ap_pass_brigade(f->next, in);
}
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
"cache: Caching url: %s", r->unparsed_uri);
/* We are actually caching this response. So it does not
* make sense to remove this entity any more.
*/
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
"cache: Removing CACHE_REMOVE_URL filter.");
ap_remove_output_filter(cache->remove_url_filter);
/*
* We now want to update the cache file header information with
* the new date, last modified, expire and content length and write
* it away to our cache file. First, we determine these values from
* the response, using heuristics if appropriate.
*
* In addition, we make HTTP/1.1 age calculations and write them away
* too.
*/
/* Read the date. Generate one if one is not supplied */
dates = apr_table_get(r->err_headers_out, "Date");
if (dates == NULL) {
dates = apr_table_get(r->headers_out, "Date");
}
if (dates != NULL) {
info->date = apr_date_parse_http(dates);
}
else {
info->date = APR_DATE_BAD;
}
now = apr_time_now();
if (info->date == APR_DATE_BAD) { /* No, or bad date */
/* no date header (or bad header)! */
info->date = now;
}
date = info->date;
/* set response_time for HTTP/1.1 age calculations */
info->response_time = now;
/* get the request time */
info->request_time = r->request_time;
/* check last-modified date */
if (lastmod != APR_DATE_BAD && lastmod > date) {
/* if it's in the future, then replace by date */
lastmod = date;
lastmods = dates;
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
r->server,
"cache: Last modified is in the future, "
"replacing with now");
}
/* if no expiry date then
* if Cache-Control: max-age
* expiry date = date + max-age
* else if lastmod
* expiry date = date + min((date - lastmod) * factor, maxexpire)
* else
* expire date = date + defaultexpire
*/
if (exp == APR_DATE_BAD) {
char *max_age_val;
if (ap_cache_liststr(r->pool, cc_out, "max-age", &max_age_val) &&
max_age_val != NULL) {
apr_int64_t x;
errno = 0;
x = apr_atoi64(max_age_val);
if (errno) {
x = conf->defex;
}
else {
x = x * MSEC_ONE_SEC;
}
if (x < conf->minex) {
x = conf->minex;
}
if (x > conf->maxex) {
x = conf->maxex;
}
exp = date + x;
}
else if ((lastmod != APR_DATE_BAD) && (lastmod < date)) {
/* if lastmod == date then you get 0*conf->factor which results in
* an expiration time of now. This causes some problems with
* freshness calculations, so we choose the else path...
*/
apr_time_t x = (apr_time_t) ((date - lastmod) * conf->factor);
if (x < conf->minex) {
x = conf->minex;
}
if (x > conf->maxex) {
x = conf->maxex;
}
exp = date + x;
}
else {
exp = date + conf->defex;
}
}
info->expire = exp;
/* We found a stale entry which wasn't really stale. */
if (cache->stale_handle) {
/* Load in the saved status and clear the status line. */
r->status = info->status;
r->status_line = NULL;
/* RFC 2616 10.3.5 states that entity headers are not supposed
* to be in the 304 response. Therefore, we need to combine the
* response headers with the cached headers *before* we update
* the cached headers.
*
* However, before doing that, we need to first merge in
* err_headers_out and we also need to strip any hop-by-hop
* headers that might have snuck in.
*/
r->headers_out = ap_cache_cacheable_headers_out(r);
/* Merge in our cached headers. However, keep any updated values. */
ap_cache_accept_headers(cache->handle, r, 1);
}
/* Write away header information to cache. It is possible that we are
* trying to update headers for an entity which has already been cached.
*
* This may fail, due to an unwritable cache area. E.g. filesystem full,
* permissions problems or a read-only (re)mount. This must be handled
* later.
*/
rv = cache->provider->store_headers(cache->handle, r, info);
/* Did we just update the cached headers on a revalidated response?
*
* If so, we can now decide what to serve to the client. This is done in
* the same way as with a regular response, but conditions are now checked
* against the cached or merged response headers.
*/
if (cache->stale_handle) {
apr_bucket_brigade *bb;
apr_bucket *bkt;
int status;
/* We're just saving response headers, so we are done. Commit
* the response at this point, unless there was a previous error.
*/
if (rv == APR_SUCCESS) {
rv = cache->provider->commit_entity(cache->handle, r);
}
bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
/* Restore the original request headers and see if we need to
* return anything else than the cached response (ie. the original
* request was conditional).
*/
r->headers_in = cache->stale_headers;
status = ap_meets_conditions(r);
if (status != OK) {
r->status = status;
bkt = apr_bucket_flush_create(bb->bucket_alloc);
APR_BRIGADE_INSERT_TAIL(bb, bkt);
}
else {
cache->provider->recall_body(cache->handle, r->pool, bb);
}
cache->block_response = 1;
/* Before returning we need to handle the possible case of an
* unwritable cache. Rather than leaving the entity in the cache
* and having it constantly re-validated, now that we have recalled
* the body it is safe to try and remove the url from the cache.
*/
if (rv != APR_SUCCESS) {
ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, r->server,
"cache: updating headers with store_headers failed. "
"Removing cached url.");
rv = cache->provider->remove_url(cache->stale_handle, r->pool);
if (rv != OK) {
/* Probably a mod_disk_cache cache area has been (re)mounted
* read-only, or that there is a permissions problem.
*/
ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, r->server,
"cache: attempt to remove url from cache unsuccessful.");
}
}
/* let someone else attempt to cache */
ap_cache_remove_lock(conf, r, cache->handle ?
(char *)cache->handle->cache_obj->key : NULL, NULL);
return ap_pass_brigade(f->next, bb);
}
if (rv != APR_SUCCESS) {
ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, r->server,
"cache: store_headers failed");
ap_remove_output_filter(f);
ap_cache_remove_lock(conf, r, cache->handle ?
(char *)cache->handle->cache_obj->key : NULL, NULL);
return ap_pass_brigade(f->next, in);
}
return cache_save_store(f, in, conf, cache);
}
/*
* CACHE_REMOVE_URL filter
* -----------------------
*
* This filter gets added in the quick handler every time the CACHE_SAVE filter
* gets inserted. Its purpose is to remove a confirmed stale cache entry from
* the cache.
*
* CACHE_REMOVE_URL has to be a protocol filter to ensure that is run even if
* the response is a canned error message, which removes the content filters
* and thus the CACHE_SAVE filter from the chain.
*
* CACHE_REMOVE_URL expects cache request rec within its context because the
* request this filter runs on can be different from the one whose cache entry
* should be removed, due to internal redirects.
*
* Note that CACHE_SAVE_URL (as a content-set filter, hence run before the
* protocol filters) will remove this filter if it decides to cache the file.
* Therefore, if this filter is left in, it must mean we need to toss any
* existing files.
*/
static int cache_remove_url_filter(ap_filter_t *f, apr_bucket_brigade *in)
{
request_rec *r = f->r;
cache_request_rec *cache;
/* Setup cache_request_rec */
cache = (cache_request_rec *) f->ctx;
if (!cache) {
/* user likely configured CACHE_REMOVE_URL manually; they should really
* use mod_cache configuration to do that. So:
* 1. Remove ourselves
* 2. Do nothing and bail out
*/
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
"cache: CACHE_REMOVE_URL enabled unexpectedly");
ap_remove_output_filter(f);
return ap_pass_brigade(f->next, in);
}
/* Now remove this cache entry from the cache */
cache_remove_url(cache, r->pool);
/* remove ourselves */
ap_remove_output_filter(f);
return ap_pass_brigade(f->next, in);
}
/*
* CACHE filter
* ------------
*
* This filter can be optionally inserted into the filter chain by the admin as
* a marker representing the precise location within the filter chain where
* caching is to be performed.
*
* When the filter chain is set up in the non-quick version of the URL handler,
* the CACHE filter is replaced by the CACHE_OUT or CACHE_SAVE filter,
* effectively inserting the caching filters at the point indicated by the
* admin. The CACHE filter is then removed.
*
* This allows caching to be performed before the content is passed to the
* INCLUDES filter, or to a filter that might perform transformations unique
* to the specific request and that would otherwise be non-cacheable.
*/
static int cache_filter(ap_filter_t *f, apr_bucket_brigade *in)
{
/* we are just a marker, so let's just remove ourselves */
ap_log_error(APLOG_MARK, APLOG_WARNING, 0, f->r->server,
"cache: CACHE filter was added twice, or was added in quick "
"handler mode and will be ignored.");
ap_remove_output_filter(f);
return ap_pass_brigade(f->next, in);
}
/* -------------------------------------------------------------- */
/* Setup configurable data */
static void * create_cache_config(apr_pool_t *p, server_rec *s)
{
const char *tmppath;
cache_server_conf *ps = apr_pcalloc(p, sizeof(cache_server_conf));
/* array of URL prefixes for which caching is enabled */
ps->cacheenable = apr_array_make(p, 10, sizeof(struct cache_enable));
/* array of URL prefixes for which caching is disabled */
ps->cachedisable = apr_array_make(p, 10, sizeof(struct cache_disable));
/* maximum time to cache a document */
ps->maxex = DEFAULT_CACHE_MAXEXPIRE;
ps->maxex_set = 0;
ps->minex = DEFAULT_CACHE_MINEXPIRE;
ps->minex_set = 0;
/* default time to cache a document */
ps->defex = DEFAULT_CACHE_EXPIRE;
ps->defex_set = 0;
/* factor used to estimate Expires date from LastModified date */
ps->factor = DEFAULT_CACHE_LMFACTOR;
ps->factor_set = 0;
ps->no_last_mod_ignore_set = 0;
ps->no_last_mod_ignore = 0;
ps->ignorecachecontrol = 0;
ps->ignorecachecontrol_set = 0;
ps->store_private = 0;
ps->store_private_set = 0;
ps->store_nostore = 0;
ps->store_nostore_set = 0;
/* array of headers that should not be stored in cache */
ps->ignore_headers = apr_array_make(p, 10, sizeof(char *));
ps->ignore_headers_set = CACHE_IGNORE_HEADERS_UNSET;
/* flag indicating that query-string should be ignored when caching */
ps->ignorequerystring = 0;
ps->ignorequerystring_set = 0;
/* by default, run in the quick handler */
ps->quick = 1;
ps->quick_set = 0;
/* array of identifiers that should not be used for key calculation */
ps->ignore_session_id = apr_array_make(p, 10, sizeof(char *));
ps->ignore_session_id_set = CACHE_IGNORE_SESSION_ID_UNSET;
ps->lock = 0; /* thundering herd lock defaults to off */
ps->lock_set = 0;
apr_temp_dir_get(&tmppath, p);
if (tmppath) {
ps->lockpath = apr_pstrcat(p, tmppath, DEFAULT_CACHE_LOCKPATH, NULL);
}
ps->lockmaxage = apr_time_from_sec(DEFAULT_CACHE_MAXAGE);
return ps;
}
static void * merge_cache_config(apr_pool_t *p, void *basev, void *overridesv)
{
cache_server_conf *ps = apr_pcalloc(p, sizeof(cache_server_conf));
cache_server_conf *base = (cache_server_conf *) basev;
cache_server_conf *overrides = (cache_server_conf *) overridesv;
/* array of URL prefixes for which caching is disabled */
ps->cachedisable = apr_array_append(p,
base->cachedisable,
overrides->cachedisable);
/* array of URL prefixes for which caching is enabled */
ps->cacheenable = apr_array_append(p,
base->cacheenable,
overrides->cacheenable);
/* maximum time to cache a document */
ps->maxex = (overrides->maxex_set == 0) ? base->maxex : overrides->maxex;
ps->minex = (overrides->minex_set == 0) ? base->minex : overrides->minex;
/* default time to cache a document */
ps->defex = (overrides->defex_set == 0) ? base->defex : overrides->defex;
/* factor used to estimate Expires date from LastModified date */
ps->factor =
(overrides->factor_set == 0) ? base->factor : overrides->factor;
ps->no_last_mod_ignore =
(overrides->no_last_mod_ignore_set == 0)
? base->no_last_mod_ignore
: overrides->no_last_mod_ignore;
ps->ignorecachecontrol =
(overrides->ignorecachecontrol_set == 0)
? base->ignorecachecontrol
: overrides->ignorecachecontrol;
ps->store_private =
(overrides->store_private_set == 0)
? base->store_private
: overrides->store_private;
ps->store_nostore =
(overrides->store_nostore_set == 0)
? base->store_nostore
: overrides->store_nostore;
ps->ignore_headers =
(overrides->ignore_headers_set == CACHE_IGNORE_HEADERS_UNSET)
? base->ignore_headers
: overrides->ignore_headers;
ps->ignorequerystring =
(overrides->ignorequerystring_set == 0)
? base->ignorequerystring
: overrides->ignorequerystring;
ps->ignore_session_id =
(overrides->ignore_session_id_set == CACHE_IGNORE_SESSION_ID_UNSET)
? base->ignore_session_id
: overrides->ignore_session_id;
ps->lock =
(overrides->lock_set == 0)
? base->lock
: overrides->lock;
ps->lockpath =
(overrides->lockpath_set == 0)
? base->lockpath
: overrides->lockpath;
ps->lockmaxage =
(overrides->lockmaxage_set == 0)
? base->lockmaxage
: overrides->lockmaxage;
ps->quick =
(overrides->quick_set == 0)
? base->quick
: overrides->quick;
return ps;
}
static const char *set_cache_quick_handler(cmd_parms *parms, void *dummy,
int flag)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config
,
&cache_module);
conf->quick = flag;
conf->quick_set = 1;
return NULL;
}
static const char *set_cache_ignore_no_last_mod(cmd_parms *parms, void *dummy,
int flag)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->no_last_mod_ignore = flag;
conf->no_last_mod_ignore_set = 1;
return NULL;
}
static const char *set_cache_ignore_cachecontrol(cmd_parms *parms,
void *dummy, int flag)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->ignorecachecontrol = flag;
conf->ignorecachecontrol_set = 1;
return NULL;
}
static const char *set_cache_store_private(cmd_parms *parms, void *dummy,
int flag)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->store_private = flag;
conf->store_private_set = 1;
return NULL;
}
static const char *set_cache_store_nostore(cmd_parms *parms, void *dummy,
int flag)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->store_nostore = flag;
conf->store_nostore_set = 1;
return NULL;
}
static const char *add_ignore_header(cmd_parms *parms, void *dummy,
const char *header)
{
cache_server_conf *conf;
char **new;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
if (!strcasecmp(header, "None")) {
/* if header None is listed clear array */
conf->ignore_headers->nelts = 0;
}
else {
if ((conf->ignore_headers_set == CACHE_IGNORE_HEADERS_UNSET) ||
(conf->ignore_headers->nelts)) {
/* Only add header if no "None" has been found in header list
* so far.
* (When 'None' is passed, IGNORE_HEADERS_SET && nelts == 0.)
*/
new = (char **)apr_array_push(conf->ignore_headers);
(*new) = (char *)header;
}
}
conf->ignore_headers_set = CACHE_IGNORE_HEADERS_SET;
return NULL;
}
static const char *add_ignore_session_id(cmd_parms *parms, void *dummy,
const char *identifier)
{
cache_server_conf *conf;
char **new;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
if (!strcasecmp(identifier, "None")) {
/* if identifier None is listed clear array */
conf->ignore_session_id->nelts = 0;
}
else {
if ((conf->ignore_session_id_set == CACHE_IGNORE_SESSION_ID_UNSET) ||
(conf->ignore_session_id->nelts)) {
/*
* Only add identifier if no "None" has been found in identifier
* list so far.
*/
new = (char **)apr_array_push(conf->ignore_session_id);
(*new) = (char *)identifier;
}
}
conf->ignore_session_id_set = CACHE_IGNORE_SESSION_ID_SET;
return NULL;
}
static const char *add_cache_enable(cmd_parms *parms, void *dummy,
const char *type,
const char *url)
{
cache_server_conf *conf;
struct cache_enable *new;
const char *err = ap_check_cmd_context(parms,
NOT_IN_DIRECTORY|NOT_IN_LIMIT|NOT_IN_FILES);
if (err != NULL) {
return err;
}
if (*type == '/') {
return apr_psprintf(parms->pool,
"provider (%s) starts with a '/'. Are url and provider switched?",
type);
}
if (!url) {
url = parms->path;
}
if (!url) {
return apr_psprintf(parms->pool,
"CacheEnable provider (%s) is missing an URL.", type);
}
if (parms->path && strncmp(parms->path, url, strlen(parms->path))) {
return "When in a Location, CacheEnable must specify a path or an URL below "
"that location.";
}
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
new = apr_array_push(conf->cacheenable);
new->type = type;
if (apr_uri_parse(parms->pool, url, &(new->url))) {
return NULL;
}
if (new->url.path) {
new->pathlen = strlen(new->url.path);
} else {
new->pathlen = 1;
new->url.path = "/";
}
return NULL;
}
static const char *add_cache_disable(cmd_parms *parms, void *dummy,
const char *url)
{
cache_server_conf *conf;
struct cache_disable *new;
const char *err = ap_check_cmd_context(parms,
NOT_IN_DIRECTORY|NOT_IN_LIMIT|NOT_IN_FILES);
if (err != NULL) {
return err;
}
if (parms->path && !strcmp(url, "on")) {
url = parms->path;
}
if (url[0] != '/' && !ap_strchr_c(url, ':')) {
return "CacheDisable must specify a path or an URL, or when in a Location, "
"the word 'on'.";
}
if (parms->path && strncmp(parms->path, url, strlen(parms->path))) {
return "When in a Location, CacheDisable must specify a path or an URL below "
"that location.";
}
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
new = apr_array_push(conf->cachedisable);
if (apr_uri_parse(parms->pool, url, &(new->url))) {
return NULL;
}
if (new->url.path) {
new->pathlen = strlen(new->url.path);
} else {
new->pathlen = 1;
new->url.path = "/";
}
return NULL;
}
static const char *set_cache_maxex(cmd_parms *parms, void *dummy,
const char *arg)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->maxex = (apr_time_t) (atol(arg) * MSEC_ONE_SEC);
conf->maxex_set = 1;
return NULL;
}
static const char *set_cache_minex(cmd_parms *parms, void *dummy,
const char *arg)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->minex = (apr_time_t) (atol(arg) * MSEC_ONE_SEC);
conf->minex_set = 1;
return NULL;
}
static const char *set_cache_defex(cmd_parms *parms, void *dummy,
const char *arg)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->defex = (apr_time_t) (atol(arg) * MSEC_ONE_SEC);
conf->defex_set = 1;
return NULL;
}
static const char *set_cache_factor(cmd_parms *parms, void *dummy,
const char *arg)
{
cache_server_conf *conf;
double val;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
if (sscanf(arg, "%lg", &val) != 1) {
return "CacheLastModifiedFactor value must be a float";
}
conf->factor = val;
conf->factor_set = 1;
return NULL;
}
static const char *set_cache_ignore_querystring(cmd_parms *parms, void *dummy,
int flag)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->ignorequerystring = flag;
conf->ignorequerystring_set = 1;
return NULL;
}
static const char *set_cache_lock(cmd_parms *parms, void *dummy,
int flag)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->lock = flag;
conf->lock_set = 1;
return NULL;
}
static const char *set_cache_lock_path(cmd_parms *parms, void *dummy,
const char *arg)
{
cache_server_conf *conf;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
conf->lockpath = ap_server_root_relative(parms->pool, arg);
if (!conf->lockpath) {
return apr_pstrcat(parms->pool, "Invalid CacheLockPath path ",
arg, NULL);
}
conf->lockpath_set = 1;
return NULL;
}
static const char *set_cache_lock_maxage(cmd_parms *parms, void *dummy,
const char *arg)
{
cache_server_conf *conf;
apr_int64_t seconds;
conf =
(cache_server_conf *)ap_get_module_config(parms->server->module_config,
&cache_module);
seconds = apr_atoi64(arg);
if (seconds <= 0) {
return "CacheLockMaxAge value must be a non-zero positive integer";
}
conf->lockmaxage = apr_time_from_sec(seconds);
conf->lockmaxage_set = 1;
return NULL;
}
static int cache_post_config(apr_pool_t *p, apr_pool_t *plog,
apr_pool_t *ptemp, server_rec *s)
{
/* This is the means by which unusual (non-unix) os's may find alternate
* means to run a given command (e.g. shebang/registry parsing on Win32)
*/
cache_generate_key = APR_RETRIEVE_OPTIONAL_FN(ap_cache_generate_key);
if (!cache_generate_key) {
cache_generate_key = cache_generate_key_default;
}
return OK;
}
static const command_rec cache_cmds[] =
{
/* XXX
* Consider a new config directive that enables loading specific cache
* implememtations (like mod_cache_mem, mod_cache_file, etc.).
* Rather than using a LoadModule directive, admin would use something
* like CacheModule mem_cache_module | file_cache_module, etc,
* which would cause the approprpriate cache module to be loaded.
* This is more intuitive that requiring a LoadModule directive.
*/
AP_INIT_TAKE12("CacheEnable", add_cache_enable, NULL, RSRC_CONF|ACCESS_CONF,
"A cache type and partial URL prefix below which "
"caching is enabled"),
AP_INIT_TAKE1("CacheDisable", add_cache_disable, NULL, RSRC_CONF|ACCESS_CONF,
"A partial URL prefix below which caching is disabled"),
AP_INIT_TAKE1("CacheMaxExpire", set_cache_maxex, NULL, RSRC_CONF,
"The maximum time in seconds to cache a document"),
AP_INIT_TAKE1("CacheMinExpire", set_cache_minex, NULL, RSRC_CONF,
"The minimum time in seconds to cache a document"),
AP_INIT_TAKE1("CacheDefaultExpire", set_cache_defex, NULL, RSRC_CONF,
"The default time in seconds to cache a document"),
AP_INIT_FLAG("CacheQuickHandler", set_cache_quick_handler, NULL,
RSRC_CONF,
"Run the cache in the quick handler, default on"),
AP_INIT_FLAG("CacheIgnoreNoLastMod", set_cache_ignore_no_last_mod, NULL,
RSRC_CONF,
"Ignore Responses where there is no Last Modified Header"),
AP_INIT_FLAG("CacheIgnoreCacheControl", set_cache_ignore_cachecontrol,
NULL, RSRC_CONF,
"Ignore requests from the client for uncached content"),
AP_INIT_FLAG("CacheStorePrivate", set_cache_store_private,
NULL, RSRC_CONF,
"Ignore 'Cache-Control: private' and store private content"),
AP_INIT_FLAG("CacheStoreNoStore", set_cache_store_nostore,
NULL, RSRC_CONF,
"Ignore 'Cache-Control: no-store' and store sensitive content"),
AP_INIT_ITERATE("CacheIgnoreHeaders", add_ignore_header, NULL, RSRC_CONF,
"A space separated list of headers that should not be "
"stored by the cache"),
AP_INIT_FLAG("CacheIgnoreQueryString", set_cache_ignore_querystring,
NULL, RSRC_CONF,
"Ignore query-string when caching"),
AP_INIT_ITERATE("CacheIgnoreURLSessionIdentifiers", add_ignore_session_id,
NULL, RSRC_CONF, "A space separated list of session "
"identifiers that should be ignored for creating the key "
"of the cached entity."),
AP_INIT_TAKE1("CacheLastModifiedFactor", set_cache_factor, NULL, RSRC_CONF,
"The factor used to estimate Expires date from "
"LastModified date"),
AP_INIT_FLAG("CacheLock", set_cache_lock,
NULL, RSRC_CONF,
"Enable or disable the thundering herd lock."),
AP_INIT_TAKE1("CacheLockPath", set_cache_lock_path, NULL, RSRC_CONF,
"The thundering herd lock path. Defaults to the '"
DEFAULT_CACHE_LOCKPATH "' directory in the system "
"temp directory."),
AP_INIT_TAKE1("CacheLockMaxAge", set_cache_lock_maxage, NULL, RSRC_CONF,
"Maximum age of any thundering herd lock."),
{NULL}
};
static void register_hooks(apr_pool_t *p)
{
/* cache initializer */
/* cache quick handler */
ap_hook_quick_handler(cache_quick_handler, NULL, NULL, APR_HOOK_FIRST);
/* cache handler */
ap_hook_handler(cache_handler, NULL, NULL, APR_HOOK_REALLY_FIRST);
/* cache filters
* XXX The cache filters need to run right after the handlers and before
* any other filters. Consider creating AP_FTYPE_CACHE for this purpose.
*
* Depending on the type of request (subrequest / main request) they
* need to be run before AP_FTYPE_CONTENT_SET / after AP_FTYPE_CONTENT_SET
* filters. Thus create two filter handles for each type:
* cache_save_filter_handle / cache_out_filter_handle to be used by
* main requests and
* cache_save_subreq_filter_handle / cache_out_subreq_filter_handle
* to be run by subrequest
*/
/*
* CACHE is placed into the filter chain at an admin specified location,
* and when the cache_handler is run, the CACHE filter is swapped with
* the CACHE_OUT filter, or CACHE_SAVE filter as appropriate. This has
* the effect of offering optional fine control of where the cache is
* inserted into the filter chain.
*/
cache_filter_handle =
ap_register_output_filter("CACHE",
cache_filter,
NULL,
AP_FTYPE_RESOURCE);
/*
* CACHE_SAVE must go into the filter chain after a possible DEFLATE
* filter to ensure that the compressed content is stored.
* Incrementing filter type by 1 ensures his happens.
*/
cache_save_filter_handle =
ap_register_output_filter("CACHE_SAVE",
cache_save_filter,
NULL,
AP_FTYPE_CONTENT_SET+1);
/*
* CACHE_SAVE_SUBREQ must go into the filter chain before SUBREQ_CORE to
* handle subrequsts. Decrementing filter type by 1 ensures this
* happens.
*/
cache_save_subreq_filter_handle =
ap_register_output_filter("CACHE_SAVE_SUBREQ",
cache_save_filter,
NULL,
AP_FTYPE_CONTENT_SET-1);
/*
* CACHE_OUT must go into the filter chain after a possible DEFLATE
* filter to ensure that already compressed cache objects do not
* get compressed again. Incrementing filter type by 1 ensures
* his happens.
*/
cache_out_filter_handle =
ap_register_output_filter("CACHE_OUT",
cache_out_filter,
NULL,
AP_FTYPE_CONTENT_SET+1);
/*
* CACHE_OUT_SUBREQ must go into the filter chain before SUBREQ_CORE to
* handle subrequsts. Decrementing filter type by 1 ensures this
* happens.
*/
cache_out_subreq_filter_handle =
ap_register_output_filter("CACHE_OUT_SUBREQ",
cache_out_filter,
NULL,
AP_FTYPE_CONTENT_SET-1);
/* CACHE_REMOVE_URL has to be a protocol filter to ensure that is
* run even if the response is a canned error message, which
* removes the content filters.
*/
cache_remove_url_filter_handle =
ap_register_output_filter("CACHE_REMOVE_URL",
cache_remove_url_filter,
NULL,
AP_FTYPE_PROTOCOL);
ap_hook_post_config(cache_post_config, NULL, NULL, APR_HOOK_REALLY_FIRST);
}
AP_DECLARE_MODULE(cache) =
{
STANDARD20_MODULE_STUFF,
NULL, /* create per-directory config structure */
NULL, /* merge per-directory config structures */
create_cache_config, /* create per-server config structure */
merge_cache_config, /* merge per-server config structures */
cache_cmds, /* command apr_table_t */
register_hooks
};