mod_expires.c revision f54da7877f9e092465df38bfda142f3e71dbb7aa
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering/* ====================================================================
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * The Apache Software License, Version 1.1
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Copyright (c) 2000 The Apache Software Foundation. All rights
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * reserved.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Redistribution and use in source and binary forms, with or without
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * modification, are permitted provided that the following conditions
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * are met:
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * 1. Redistributions of source code must retain the above copyright
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * notice, this list of conditions and the following disclaimer.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * 2. Redistributions in binary form must reproduce the above copyright
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * notice, this list of conditions and the following disclaimer in
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * the documentation and/or other materials provided with the
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * distribution.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * 3. The end-user documentation included with the redistribution,
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * if any, must include the following acknowledgment:
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * "This product includes software developed by the
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Apache Software Foundation (http://www.apache.org/)."
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Alternately, this acknowledgment may appear in the software itself,
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * if and wherever such third-party acknowledgments normally appear.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * 4. The names "Apache" and "Apache Software Foundation" must
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * not be used to endorse or promote products derived from this
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * software without prior written permission. For written
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * permission, please contact apache@apache.org.
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * 5. Products derived from this software may not be called "Apache",
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * nor may "Apache" appear in their name, without prior written
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * permission of the Apache Software Foundation.
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * SUCH DAMAGE.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ====================================================================
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * This software consists of voluntary contributions made by many
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * individuals on behalf of the Apache Software Foundation. For more
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * information on the Apache Software Foundation, please see
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * <http://www.apache.org/>.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Portions of this software are based upon public domain software
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * originally written at the National Center for Supercomputing Applications,
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * University of Illinois, Urbana-Champaign.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering */
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering/*
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * mod_expires.c
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * version 0.0.11
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * status beta
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Andrew Wilson <Andrew.Wilson@cm.cf.ac.uk> 26.Jan.96
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * This module allows you to control the form of the Expires: header
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * that Apache issues for each access. Directives can appear in
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * configuration files or in .htaccess files so expiry semantics can
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering * be defined on a per-directory basis.
c30a0c62fdbf6f11902be9db64ade99fb508adfdLennart Poettering *
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering * DIRECTIVE SYNTAX
c30a0c62fdbf6f11902be9db64ade99fb508adfdLennart Poettering *
c30a0c62fdbf6f11902be9db64ade99fb508adfdLennart Poettering * Valid directives are:
c30a0c62fdbf6f11902be9db64ade99fb508adfdLennart Poettering *
c30a0c62fdbf6f11902be9db64ade99fb508adfdLennart Poettering * ExpiresActive on | off
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ExpiresDefault <code><seconds>
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ExpiresByType type/encoding <code><seconds>
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Valid values for <code> are:
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * 'M' expires header shows file modification date + <seconds>
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * 'A' expires header shows access time + <seconds>
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * [I'm not sure which of these is best under different
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * circumstances, I guess it's for other people to explore.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * The effects may be indistinguishable for a number of cases]
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * <seconds> should be an integer value [acceptable to atoi()]
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * There is NO space between the <code> and <seconds>.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * For example, a directory which contains information which changes
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * frequently might contain:
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * # reports generated by cron every hour. don't let caches
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * # hold onto stale information
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ExpiresDefault M3600
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * Another example, our html pages can change all the time, the gifs
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * tend not to change often:
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering *
23406ce58aa7142e8df3c5c9e5ac34a01e90e3e0Lennart Poettering * # pages are hot (1 week), images are cold (1 month)
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * ExpiresByType text/html A604800
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * ExpiresByType image/gif A2592000
beaafb2ea6be591882aef21fe19b88e3b2461087Lennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Expires can be turned on for all URLs on the server by placing the
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * following directive in a conf file:
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ExpiresActive on
23406ce58aa7142e8df3c5c9e5ac34a01e90e3e0Lennart Poettering *
23406ce58aa7142e8df3c5c9e5ac34a01e90e3e0Lennart Poettering * ExpiresActive can also appear in .htaccess files, enabling the
23406ce58aa7142e8df3c5c9e5ac34a01e90e3e0Lennart Poettering * behaviour to be turned on or off for each chosen directory.
23406ce58aa7142e8df3c5c9e5ac34a01e90e3e0Lennart Poettering *
23406ce58aa7142e8df3c5c9e5ac34a01e90e3e0Lennart Poettering * # turn off Expires behaviour in this directory
6de0e0e500d9d534c6e4baab242fc2a146f021faLennart Poettering * # and subdirectories
95056b27a05c527f4724b6c52abb2a7a69a3a5d0Lennart Poettering * ExpiresActive off
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Directives defined for a directory are valid in subdirectories
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering * unless explicitly overridden by new directives in the subdirectory
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering * .htaccess files.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ALTERNATIVE DIRECTIVE SYNTAX
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering * Directives can also be defined in a more readable syntax of the form:
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ExpiresDefault "<base> [plus] {<num> <type>}*"
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ExpiresByType type/encoding "<base> [plus] {<num> <type>}*"
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * where <base> is one of:
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * access
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * now equivalent to 'access'
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * modification
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * where the 'plus' keyword is optional
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * where <num> should be an integer value [acceptable to atoi()]
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * where <type> is one of:
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * years
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * months
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * weeks
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * days
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * hours
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * minutes
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * seconds
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * For example, any of the following directives can be used to make
8e7fd6ade44ce5dde0867ba748c7978ed1206865Lennart Poettering * documents expire 1 month after being accessed, by default:
8e7fd6ade44ce5dde0867ba748c7978ed1206865Lennart Poettering *
8e7fd6ade44ce5dde0867ba748c7978ed1206865Lennart Poettering * ExpiresDefault "access plus 1 month"
8e7fd6ade44ce5dde0867ba748c7978ed1206865Lennart Poettering * ExpiresDefault "access plus 4 weeks"
8e7fd6ade44ce5dde0867ba748c7978ed1206865Lennart Poettering * ExpiresDefault "access plus 30 days"
8e7fd6ade44ce5dde0867ba748c7978ed1206865Lennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * The expiry time can be fine-tuned by adding several '<num> <type>'
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * clauses:
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek *
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * ExpiresByType text/html "access plus 1 month 15 days 2 hours"
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * ExpiresByType image/gif "modification plus 5 hours 3 minutes"
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering *
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * ---
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering *
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * Change-log:
8e7fd6ade44ce5dde0867ba748c7978ed1206865Lennart Poettering * 29.Jan.96 Hardened the add_* functions. Server will now bail out
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * if bad directives are given in the conf files.
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * 02.Feb.96 Returns DECLINED if not 'ExpiresActive on', giving other
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * expires-aware modules a chance to play with the same
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * directives. [Michael Rutman]
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * 03.Feb.96 Call tzset() before localtime(). Trying to get the module
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * to work properly in non GMT timezones.
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * 12.Feb.96 Modified directive syntax to allow more readable commands:
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ExpiresDefault "now plus 10 days 20 seconds"
8e7fd6ade44ce5dde0867ba748c7978ed1206865Lennart Poettering * ExpiresDefault "access plus 30 days"
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * ExpiresDefault "modification plus 1 year 10 months 30 days"
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering * 13.Feb.96 Fix call to table_get() with NULL 2nd parameter [Rob Hartill]
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * 19.Feb.96 Call gm_timestr_822() to get time formatted correctly, can't
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * rely on presence of HTTP_TIME_FORMAT in Apache 1.1+.
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * 21.Feb.96 This version (0.0.9) reverses assumptions made in 0.0.8
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * about star/star handlers. Reverting to 0.0.7 behaviour.
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * 08.Jun.96 allows ExpiresDefault to be used with responses that use
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * the DefaultType by not DECLINING, but instead skipping
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * the table_get check and then looking for an ExpiresDefault.
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * [Rob Hartill]
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * 04.Nov.96 'const' definitions added.
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering *
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * TODO
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * add support for Cache-Control: max-age=20 from the HTTP/1.1
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * proposal (in this case, a ttl of 20 seconds) [ask roy]
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * add per-file expiry and explicit expiry times - duplicates some
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * of the mod_cern_meta.c functionality. eg:
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek * ExpiresExplicit index.html "modification plus 30 days"
c485437f50450c0087bae3df4aed462e4a86ee83Zbigniew Jędrzejewski-Szmek *
7b77ed8cf36e8eca6017791626044b61ae2d68e7Lennart Poettering * BUGS
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering * Hi, welcome to the internet.
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering */
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering#include "ap_config.h"
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering#ifdef HAVE_CTYPE_H
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering#include <ctype.h>
e9d21f240704f87c6bb5f7fca1c5e6d0f31c84cdLennart Poettering#endif
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#ifdef HAVE_STRINGS_H
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#include <strings.h>
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#endif
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#include "httpd.h"
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#include "http_config.h"
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#include "http_log.h"
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#include "http_request.h"
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#include "apr_strings.h"
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering
cc3773810855956bad92337cee8fa193584ab62eLennart Poetteringtypedef struct {
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering int active;
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering char *expiresdefault;
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering apr_table_t *expiresbytype;
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering} expires_dir_config;
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering/* from mod_dir, why is this alias used?
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering */
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#define DIR_CMD_PERMS OR_INDEXES
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#define ACTIVE_ON 1
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#define ACTIVE_OFF 0
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering#define ACTIVE_DONTCARE 2
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering
cc3773810855956bad92337cee8fa193584ab62eLennart Poetteringmodule AP_MODULE_DECLARE_DATA expires_module;
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering
cc3773810855956bad92337cee8fa193584ab62eLennart Poetteringstatic void *create_dir_expires_config(apr_pool_t *p, char *dummy)
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering{
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering expires_dir_config *new =
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering (expires_dir_config *) apr_pcalloc(p, sizeof(expires_dir_config));
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering new->active = ACTIVE_DONTCARE;
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering new->expiresdefault = "";
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering new->expiresbytype = apr_make_table(p, 4);
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering return (void *) new;
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering}
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering
cc3773810855956bad92337cee8fa193584ab62eLennart Poetteringstatic const char *set_expiresactive(cmd_parms *cmd, void *in_dir_config, int arg)
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering{
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering expires_dir_config *dir_config = in_dir_config;
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering /* if we're here at all it's because someone explicitly
cc3773810855956bad92337cee8fa193584ab62eLennart Poettering * set the active flag
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering */
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering dir_config->active = ACTIVE_ON;
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering if (arg == 0) {
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering dir_config->active = ACTIVE_OFF;
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering };
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering return NULL;
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering}
65b5116220a8ebf8a260716152409aa05377aaccLennart Poettering
/* check_code() parse 'code' and return NULL or an error response
* string. If we return NULL then real_code contains code converted
* to the cnnnn format.
*/
static char *check_code(apr_pool_t *p, const char *code, char **real_code)
{
char *word;
char base = 'X';
int modifier = 0;
int num = 0;
int factor = 0;
/* 0.0.4 compatibility?
*/
if ((code[0] == 'A') || (code[0] == 'M')) {
*real_code = (char *)code;
return NULL;
};
/* <base> [plus] {<num> <type>}*
*/
/* <base>
*/
word = ap_getword_conf(p, &code);
if (!strncasecmp(word, "now", 1) ||
!strncasecmp(word, "access", 1)) {
base = 'A';
}
else if (!strncasecmp(word, "modification", 1)) {
base = 'M';
}
else {
return apr_pstrcat(p, "bad expires code, unrecognised <base> '",
word, "'", NULL);
};
/* [plus]
*/
word = ap_getword_conf(p, &code);
if (!strncasecmp(word, "plus", 1)) {
word = ap_getword_conf(p, &code);
};
/* {<num> <type>}*
*/
while (word[0]) {
/* <num>
*/
if (apr_isdigit(word[0])) {
num = atoi(word);
}
else {
return apr_pstrcat(p, "bad expires code, numeric value expected <num> '",
word, "'", NULL);
};
/* <type>
*/
word = ap_getword_conf(p, &code);
if (word[0]) {
/* do nothing */
}
else {
return apr_pstrcat(p, "bad expires code, missing <type>", NULL);
};
factor = 0;
if (!strncasecmp(word, "years", 1)) {
factor = 60 * 60 * 24 * 365;
}
else if (!strncasecmp(word, "months", 2)) {
factor = 60 * 60 * 24 * 30;
}
else if (!strncasecmp(word, "weeks", 1)) {
factor = 60 * 60 * 24 * 7;
}
else if (!strncasecmp(word, "days", 1)) {
factor = 60 * 60 * 24;
}
else if (!strncasecmp(word, "hours", 1)) {
factor = 60 * 60;
}
else if (!strncasecmp(word, "minutes", 2)) {
factor = 60;
}
else if (!strncasecmp(word, "seconds", 1)) {
factor = 1;
}
else {
return apr_pstrcat(p, "bad expires code, unrecognised <type>",
"'", word, "'", NULL);
};
modifier = modifier + factor * num;
/* next <num>
*/
word = ap_getword_conf(p, &code);
};
*real_code = apr_psprintf(p, "%c%d", base, modifier);
return NULL;
}
static const char *set_expiresbytype(cmd_parms *cmd, void *in_dir_config,
const char *mime, const char *code)
{
expires_dir_config *dir_config = in_dir_config;
char *response, *real_code;
if ((response = check_code(cmd->pool, code, &real_code)) == NULL) {
apr_table_setn(dir_config->expiresbytype, mime, real_code);
return NULL;
};
return apr_pstrcat(cmd->pool,
"'ExpiresByType ", mime, " ", code, "': ", response, NULL);
}
static const char *set_expiresdefault(cmd_parms *cmd, void *in_dir_config,
const char *code)
{
expires_dir_config * dir_config = in_dir_config;
char *response, *real_code;
if ((response = check_code(cmd->pool, code, &real_code)) == NULL) {
dir_config->expiresdefault = real_code;
return NULL;
};
return apr_pstrcat(cmd->pool,
"'ExpiresDefault ", code, "': ", response, NULL);
}
static const command_rec expires_cmds[] =
{
AP_INIT_FLAG("ExpiresActive", set_expiresactive, NULL, DIR_CMD_PERMS,
"Limited to 'on' or 'off'"),
AP_INIT_TAKE2("ExpiresBytype", set_expiresbytype, NULL, DIR_CMD_PERMS,
"a MIME type followed by an expiry date code"),
AP_INIT_TAKE1("ExpiresDefault", set_expiresdefault, NULL, DIR_CMD_PERMS,
"an expiry date code"),
{NULL}
};
static void *merge_expires_dir_configs(apr_pool_t *p, void *basev, void *addv)
{
expires_dir_config *new = (expires_dir_config *) apr_pcalloc(p, sizeof(expires_dir_config));
expires_dir_config *base = (expires_dir_config *) basev;
expires_dir_config *add = (expires_dir_config *) addv;
if (add->active == ACTIVE_DONTCARE) {
new->active = base->active;
}
else {
new->active = add->active;
};
if (add->expiresdefault != '\0') {
new->expiresdefault = add->expiresdefault;
};
new->expiresbytype = apr_overlay_tables(p, add->expiresbytype,
base->expiresbytype);
return new;
}
static int add_expires(request_rec *r)
{
expires_dir_config *conf;
char *code;
apr_time_t base;
apr_time_t additional;
apr_time_t expires;
char *timestr;
if (ap_is_HTTP_ERROR(r->status)) /* Don't add Expires headers to errors */
return DECLINED;
if (r->main != NULL) /* Say no to subrequests */
return DECLINED;
conf = (expires_dir_config *) ap_get_module_config(r->per_dir_config, &expires_module);
if (conf == NULL) {
ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
"internal error: %s", r->filename);
return HTTP_INTERNAL_SERVER_ERROR;
};
if (conf->active != ACTIVE_ON)
return DECLINED;
/* we perhaps could use the default_type(r) in its place but that
* may be 2nd guesing the desired configuration... calling table_get
* with a NULL key will SEGV us
*
* I still don't know *why* r->content_type would ever be NULL, this
* is possibly a result of fixups being called in many different
* places. Fixups is probably the wrong place to be doing all this
* work... Bah.
*
* Changed as of 08.Jun.96 don't DECLINE, look for an ExpiresDefault.
*/
if (r->content_type == NULL)
code = NULL;
else
code = (char *) apr_table_get(conf->expiresbytype,
ap_field_noparam(r->pool, r->content_type));
if (code == NULL) {
/* no expires defined for that type, is there a default? */
code = conf->expiresdefault;
if (code[0] == '\0')
return OK;
};
/* we have our code */
switch (code[0]) {
case 'M':
if (r->finfo.filetype == 0) {
/* file doesn't exist on disk, so we can't do anything based on
* modification time. Note that this does _not_ log an error.
*/
return DECLINED;
}
base = r->finfo.mtime;
additional = atoi(&code[1]);
break;
case 'A':
/* there's been some discussion and it's possible that
* 'access time' will be stored in request structure
*/
base = r->request_time;
additional = atoi(&code[1]);
break;
default:
/* expecting the add_* routines to be case-hardened this
* is just a reminder that module is beta
*/
ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
"internal error: bad expires code: %s", r->filename);
return HTTP_INTERNAL_SERVER_ERROR;
};
expires = base + additional;
apr_table_mergen(r->headers_out, "Cache-Control",
apr_psprintf(r->pool, "max-age=%qd",
(expires - r->request_time)
/ APR_USEC_PER_SEC));
timestr = apr_palloc(r->pool, APR_RFC822_DATE_LEN);
apr_rfc822_date(timestr, expires);
apr_table_setn(r->headers_out, "Expires", timestr);
return OK;
}
static void register_hooks(apr_pool_t *p)
{
ap_hook_fixups(add_expires,NULL,NULL,APR_HOOK_MIDDLE);
}
module AP_MODULE_DECLARE_DATA expires_module =
{
STANDARD20_MODULE_STUFF,
create_dir_expires_config, /* dir config creater */
merge_expires_dir_configs, /* dir merger --- default is to override */
NULL, /* server config */
NULL, /* merge server configs */
expires_cmds, /* command apr_table_t */
register_hooks /* register hooks */
};