mod_rewrite.h revision 2ae7ad6f58b7e3188ed4bd375a8930808529ba71
87ea898bcffe2ef490e833dc246a1cc0465d783fslive/* ====================================================================
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * The Apache Software License, Version 1.1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * reserved.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * Redistribution and use in source and binary forms, with or without
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * modification, are permitted provided that the following conditions
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * are met:
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * 1. Redistributions of source code must retain the above copyright
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * notice, this list of conditions and the following disclaimer.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * 2. Redistributions in binary form must reproduce the above copyright
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * notice, this list of conditions and the following disclaimer in
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * the documentation and/or other materials provided with the
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * distribution.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * 3. The end-user documentation included with the redistribution,
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * if any, must include the following acknowledgment:
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * "This product includes software developed by the
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * Apache Software Foundation (http://www.apache.org/)."
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * Alternately, this acknowledgment may appear in the software itself,
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * if and wherever such third-party acknowledgments normally appear.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * 4. The names "Apache" and "Apache Software Foundation" must
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * not be used to endorse or promote products derived from this
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * software without prior written permission. For written
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * permission, please contact apache@apache.org.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * 5. Products derived from this software may not be called "Apache",
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * nor may "Apache" appear in their name, without prior written
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * permission of the Apache Software Foundation.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * SUCH DAMAGE.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * ====================================================================
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * This software consists of voluntary contributions made by many
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * individuals on behalf of the Apache Software Foundation. For more
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * information on the Apache Software Foundation, please see
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * <http://www.apache.org/>.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive *
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * Portions of this software are based upon public domain software
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * originally written at the National Center for Supercomputing Applications,
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * University of Illinois, Urbana-Champaign.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#ifndef MOD_REWRITE_H
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define MOD_REWRITE_H 1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive/*
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** _ _ _
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** _ __ ___ ___ __| | _ __ _____ ___ __(_) |_ ___
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** | '_ ` _ \ / _ \ / _` | | '__/ _ \ \ /\ / / '__| | __/ _ \
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** | | | | | | (_) | (_| | | | | __/\ V V /| | | | || __/
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** |_| |_| |_|\___/ \__,_|___|_| \___| \_/\_/ |_| |_|\__\___|
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** |_____|
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** URL Rewriting Module
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** This module uses a rule-based rewriting engine (based on a
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** regular-expression parser) to rewrite requested URLs on the fly.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** It supports an unlimited number of additional rule conditions (which can
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** operate on a lot of variables, even on HTTP headers) for granular
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** matching and even external database lookups (either via plain text
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** tables, DBM hash files or even external processes) for advanced URL
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** substitution.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** It operates on the full URLs (including the PATH_INFO part) both in
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** per-server context (httpd.conf) and per-dir context (.htaccess) and even
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** can generate QUERY_STRING parts on result. The rewriting result finally
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** can lead to internal subprocessing, external request redirection or even
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** to internal proxy throughput.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** This module was originally written in April 1996 and
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** gifted exclusively to the The Apache Software Foundation in July 1997 by
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** Ralf S. Engelschall
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** rse@engelschall.com
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** www.engelschall.com
87ea898bcffe2ef490e833dc246a1cc0465d783fslive*/
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "apr.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define APR_WANT_STRFUNC
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define APR_WANT_MEMFUNC
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "apr_want.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive /* Include from the underlaying Unix system ... */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#if APR_HAVE_STDARG_H
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include <stdarg.h>
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#if APR_HAVE_STDLIB_H
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include <stdlib.h>
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#if APR_HAVE_CTYPE_H
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include <ctype.h>
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#if APR_HAVE_SYS_TYPES_H
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include <sys/types.h>
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#if APR_HAS_THREADS
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "apr_thread_mutex.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "apr_optional.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "ap_config.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive /* Include from the Apache server ... */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CORE_PRIVATE
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "httpd.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "http_config.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "http_request.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "http_core.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "http_log.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include "http_vhost.h"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive /*
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * The key in the r->notes apr_table_t wherein we store our accumulated
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * Vary values, and the one used for per-condition checks in a chain.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define VARY_KEY "rewrite-Vary"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define VARY_KEY_THIS "rewrite-Vary-this"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive /* The NDBM support:
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * We support only NDBM files.
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * But we have to stat the file for the mtime,
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * so we also need to know the file extension
87ea898bcffe2ef490e833dc246a1cc0465d783fslive */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#ifndef NO_DBM_REWRITEMAP
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#if defined(__GLIBC__) && defined(__GLIBC_MINOR__) \
87ea898bcffe2ef490e833dc246a1cc0465d783fslive && __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include <db1/ndbm.h>
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#else
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#include <ndbm.h>
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#if defined(DBM_SUFFIX)
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define NDBM_FILE_SUFFIX DBM_SUFFIX
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#elif defined(__FreeBSD__) || (defined(DB_LOCK) && defined(DB_SHMEM))
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define NDBM_FILE_SUFFIX ".db"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#else
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define NDBM_FILE_SUFFIX ".pag"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive/*
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** Some defines
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive*/
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define ENVVAR_SCRIPT_URL "SCRIPT_URL"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define ENVVAR_SCRIPT_URI "SCRIPT_URI"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#ifndef SUPPORT_DBM_REWRITEMAP
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define SUPPORT_DBM_REWRITEMAP 0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define REWRITE_FORCED_MIMETYPE_NOTEVAR "rewrite-forced-mimetype"
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CONDFLAG_NONE 1<<0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CONDFLAG_NOCASE 1<<1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CONDFLAG_NOTMATCH 1<<2
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CONDFLAG_ORNEXT 1<<3
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_NONE 1<<0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_FORCEREDIRECT 1<<1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_LASTRULE 1<<2
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_NEWROUND 1<<3
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_CHAIN 1<<4
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_IGNOREONSUBREQ 1<<5
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_NOTMATCH 1<<6
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_PROXY 1<<7
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_PASSTHROUGH 1<<8
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_FORBIDDEN 1<<9
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_GONE 1<<10
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_QSAPPEND 1<<11
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_NOCASE 1<<12
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RULEFLAG_NOESCAPE 1<<13
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define ACTION_NORMAL 1<<0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define ACTION_NOESCAPE 1<<1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define MAPTYPE_TXT 1<<0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define MAPTYPE_DBM 1<<1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define MAPTYPE_PRG 1<<2
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define MAPTYPE_INT 1<<3
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define MAPTYPE_RND 1<<4
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define ENGINE_DISABLED 1<<0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define ENGINE_ENABLED 1<<1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define OPTION_NONE 1<<0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define OPTION_INHERIT 1<<1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CACHEMODE_TS 1<<0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CACHEMODE_TTL 1<<1
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CACHE_TLB_ROWS 1024
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define CACHE_TLB_COLS 4
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#ifndef FALSE
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define FALSE 0
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define TRUE !FALSE
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#ifndef NO
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define NO FALSE
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define YES TRUE
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#ifndef RAND_MAX
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define RAND_MAX 32767
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#ifndef LONG_STRING_LEN
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define LONG_STRING_LEN 2048
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#endif
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define MAX_ENV_FLAGS 15
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive#define MAX_NMATCH 10
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive/*
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive** our private data structures we handle with
87ea898bcffe2ef490e833dc246a1cc0465d783fslive**
87ea898bcffe2ef490e833dc246a1cc0465d783fslive*/
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslive /* the list structures for holding the mapfile information
87ea898bcffe2ef490e833dc246a1cc0465d783fslive * and the rewrite rules
87ea898bcffe2ef490e833dc246a1cc0465d783fslive */
87ea898bcffe2ef490e833dc246a1cc0465d783fslivetypedef struct {
87ea898bcffe2ef490e833dc246a1cc0465d783fslive const char *name; /* the name of the map */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive const char *datafile; /* filename for map data files */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive const char *checkfile; /* filename to check for map existence */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive int type; /* the type of the map */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive apr_file_t *fpin; /* in file pointer for program maps */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive apr_file_t *fpout; /* out file pointer for program maps */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive apr_file_t *fperr; /* err file pointer for program maps */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive char *(*func)(request_rec *, /* function pointer for internal maps */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive char *);
87ea898bcffe2ef490e833dc246a1cc0465d783fslive} rewritemap_entry;
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslivetypedef struct {
87ea898bcffe2ef490e833dc246a1cc0465d783fslive char *input; /* Input string of RewriteCond */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive char *pattern; /* the RegExp pattern string */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive regex_t *regexp;
87ea898bcffe2ef490e833dc246a1cc0465d783fslive int flags; /* Flags which control the match */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive} rewritecond_entry;
87ea898bcffe2ef490e833dc246a1cc0465d783fslive
87ea898bcffe2ef490e833dc246a1cc0465d783fslivetypedef struct {
87ea898bcffe2ef490e833dc246a1cc0465d783fslive apr_array_header_t *rewriteconds; /* the corresponding RewriteCond entries */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive char *pattern; /* the RegExp pattern string */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive regex_t *regexp; /* the RegExp pattern compilation */
87ea898bcffe2ef490e833dc246a1cc0465d783fslive char *output; /* the Substitution string */
int flags; /* Flags which control the substitution */
char *forced_mimetype; /* forced MIME type of substitution */
int forced_responsecode; /* forced HTTP redirect response status */
char *env[MAX_ENV_FLAGS+1]; /* added environment variables */
int skip; /* number of next rules to skip */
} rewriterule_entry;
/* the per-server or per-virtual-server configuration
* statically generated once on startup for every server
*/
typedef struct {
int state; /* the RewriteEngine state */
int options; /* the RewriteOption state */
const char *rewritelogfile; /* the RewriteLog filename */
apr_file_t *rewritelogfp; /* the RewriteLog open filepointer */
int rewriteloglevel; /* the RewriteLog level of verbosity */
apr_array_header_t *rewritemaps; /* the RewriteMap entries */
apr_array_header_t *rewriteconds; /* the RewriteCond entries (temporary) */
apr_array_header_t *rewriterules; /* the RewriteRule entries */
server_rec *server; /* the corresponding server indicator */
} rewrite_server_conf;
/* the per-directory configuration
* generated on-the-fly by Apache server for current request
*/
typedef struct {
int state; /* the RewriteEngine state */
int options; /* the RewriteOption state */
apr_array_header_t *rewriteconds; /* the RewriteCond entries (temporary) */
apr_array_header_t *rewriterules; /* the RewriteRule entries */
char *directory; /* the directory where it applies */
const char *baseurl; /* the base-URL where it applies */
} rewrite_perdir_conf;
/* the cache structures,
* a 4-way hash apr_table_t with LRU functionality
*/
typedef struct cacheentry {
apr_time_t time;
char *key;
char *value;
} cacheentry;
typedef struct tlbentry {
int t[CACHE_TLB_COLS];
} cachetlbentry;
typedef struct cachelist {
char *resource;
apr_array_header_t *entries;
apr_array_header_t *tlb;
} cachelist;
typedef struct cache {
apr_pool_t *pool;
apr_array_header_t *lists;
#if APR_HAS_THREADS
apr_thread_mutex_t *lock;
#endif
} cache;
/* the regex structure for the
* substitution of backreferences
*/
typedef struct backrefinfo {
char *source;
int nsub;
regmatch_t regmatch[10];
} backrefinfo;
/*
**
** forward declarations
**
*/
/* config structure handling */
static void *config_server_create(apr_pool_t *p, server_rec *s);
static void *config_server_merge (apr_pool_t *p, void *basev, void *overridesv);
static void *config_perdir_create(apr_pool_t *p, char *path);
static void *config_perdir_merge (apr_pool_t *p, void *basev, void *overridesv);
/* config directive handling */
static const char *cmd_rewriteengine(cmd_parms *cmd,
void *dconf, int flag);
static const char *cmd_rewriteoptions(cmd_parms *cmd,
void *dconf,
const char *option);
static const char *cmd_rewriteoptions_setoption(apr_pool_t *p, int *options,
const char *name);
static const char *cmd_rewritelog (cmd_parms *cmd, void *dconf, const char *a1);
static const char *cmd_rewriteloglevel(cmd_parms *cmd, void *dconf, const char *a1);
static const char *cmd_rewritemap (cmd_parms *cmd, void *dconf,
const char *a1, const char *a2);
static const char *cmd_rewritelock(cmd_parms *cmd, void *dconf, const char *a1);
static const char *cmd_rewritebase(cmd_parms *cmd, void *dconf,
const char *a1);
static const char *cmd_rewritecond(cmd_parms *cmd, void *dconf,
const char *str);
static const char *cmd_rewritecond_parseflagfield(apr_pool_t *p,
rewritecond_entry *new,
char *str);
static const char *cmd_rewritecond_setflag(apr_pool_t *p, rewritecond_entry *cfg,
char *key, char *val);
static const char *cmd_rewriterule(cmd_parms *cmd, void *dconf,
const char *str);
static const char *cmd_rewriterule_parseflagfield(apr_pool_t *p,
rewriterule_entry *new,
char *str);
static const char *cmd_rewriterule_setflag(apr_pool_t *p, rewriterule_entry *cfg,
char *key, char *val);
/* initialisation */
static int pre_config(apr_pool_t *pconf,
apr_pool_t *plog,
apr_pool_t *ptemp);
static int post_config(apr_pool_t *pconf,
apr_pool_t *plog,
apr_pool_t *ptemp,
server_rec *s);
static void init_child(apr_pool_t *p, server_rec *s);
/* runtime hooks */
static int hook_uri2file (request_rec *r);
static int hook_mimetype (request_rec *r);
static int hook_fixup (request_rec *r);
static int handler_redirect(request_rec *r);
/* rewriting engine */
static int apply_rewrite_list(request_rec *r, apr_array_header_t *rewriterules,
char *perdir);
static int apply_rewrite_rule(request_rec *r, rewriterule_entry *p,
char *perdir);
static int apply_rewrite_cond(request_rec *r, rewritecond_entry *p,
char *perdir, backrefinfo *briRR,
backrefinfo *briRC);
static void do_expand(request_rec *r, char *input, char *buffer, int nbuf,
backrefinfo *briRR, backrefinfo *briRC);
static void do_expand_env(request_rec *r, char *env[],
backrefinfo *briRR, backrefinfo *briRC);
/* URI transformation function */
static void splitout_queryargs(request_rec *r, int qsappend);
static void fully_qualify_uri(request_rec *r);
static void reduce_uri(request_rec *r);
static int is_absolute_uri(char *uri);
static char *expand_tildepaths(request_rec *r, char *uri);
/* rewrite map support functions */
static char *lookup_map(request_rec *r, char *name, char *key);
static char *lookup_map_txtfile(request_rec *r, const char *file, char *key);
#ifndef NO_DBM_REWRITEMAP
static char *lookup_map_dbmfile(request_rec *r, const char *file, char *key);
#endif
static char *lookup_map_program(request_rec *r, apr_file_t *fpin,
apr_file_t *fpout, char *key);
typedef char *(rewrite_mapfunc_t)(request_rec *r, char *key);
static void ap_register_rewrite_mapfunc(char *name, rewrite_mapfunc_t *func);
APR_DECLARE_OPTIONAL_FN(void, ap_register_rewrite_mapfunc,
(char *name, rewrite_mapfunc_t *func));
static char *rewrite_mapfunc_toupper(request_rec *r, char *key);
static char *rewrite_mapfunc_tolower(request_rec *r, char *key);
static char *rewrite_mapfunc_escape(request_rec *r, char *key);
static char *rewrite_mapfunc_unescape(request_rec *r, char *key);
static char *select_random_value_part(request_rec *r, char *value);
static void rewrite_rand_init(void);
static int rewrite_rand(int l, int h);
/* rewriting logfile support */
static void open_rewritelog(server_rec *s, apr_pool_t *p);
static void rewritelog(request_rec *r, int level, const char *text, ...)
__attribute__((format(printf,3,4)));
static char *current_logtime(request_rec *r);
/* rewriting lockfile support */
static void rewritelock_create(server_rec *s, apr_pool_t *p);
static apr_status_t rewritelock_remove(void *data);
/* program map support */
static void run_rewritemap_programs(server_rec *s, apr_pool_t *p);
static apr_status_t rewritemap_program_child(apr_pool_t *p, const char *progname,
apr_file_t **fpout, apr_file_t **fpin,
apr_file_t **fperr);
/* env variable support */
static char *lookup_variable(request_rec *r, char *var);
static char *lookup_header(request_rec *r, const char *name);
/* caching functions */
static cache *init_cache(apr_pool_t *p);
static char *get_cache_string(cache *c, const char *res, int mode, apr_time_t mtime,
char *key);
static void set_cache_string(cache *c, const char *res, int mode, apr_time_t mtime,
char *key, char *value);
static cacheentry *retrieve_cache_string(cache *c, const char *res, char *key);
static void store_cache_string(cache *c, const char *res, cacheentry *ce);
/* misc functions */
static char *subst_prefix_path(request_rec *r, char *input, char *match,
const char *subst);
static int parseargline(char *str, char **a1, char **a2, char **a3);
static int prefix_stat(const char *path, apr_finfo_t *sb);
static void add_env_variable(request_rec *r, char *s);
static int subreq_ok(request_rec *r);
/* Lexicographic Comparison */
static int compare_lexicography(char *cpNum1, char *cpNum2);
/* Bracketed expression handling */
static char *find_closing_bracket(char *s, int left, int right);
static char *find_char_in_brackets(char *s, int c, int left, int right);
#endif /* MOD_REWRITE_H */