mod_rewrite.h File Reference

#include "apr.h"
#include "apr_want.h"
#include "apr_optional.h"
#include "apr_dbm.h"
#include "ap_config.h"
#include "httpd.h"
#include "http_config.h"
#include "http_request.h"
#include "http_core.h"
#include "http_log.h"
#include "http_vhost.h"

Include dependency graph for mod_rewrite.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	MOD_REWRITE_H   1
#define	APR_WANT_STRFUNC
#define	APR_WANT_MEMFUNC
#define	CORE_PRIVATE
#define	VARY_KEY   "rewrite-Vary"
#define	VARY_KEY_THIS   "rewrite-Vary-this"
#define	ENVVAR_SCRIPT_URL   "SCRIPT_URL"
#define	ENVVAR_SCRIPT_URI   "SCRIPT_URI"
#define	REWRITE_FORCED_MIMETYPE_NOTEVAR   "rewrite-forced-mimetype"
#define	CONDFLAG_NONE   1<<0
#define	CONDFLAG_NOCASE   1<<1
#define	CONDFLAG_NOTMATCH   1<<2
#define	CONDFLAG_ORNEXT   1<<3
#define	RULEFLAG_NONE   1<<0
#define	RULEFLAG_FORCEREDIRECT   1<<1
#define	RULEFLAG_LASTRULE   1<<2
#define	RULEFLAG_NEWROUND   1<<3
#define	RULEFLAG_CHAIN   1<<4
#define	RULEFLAG_IGNOREONSUBREQ   1<<5
#define	RULEFLAG_NOTMATCH   1<<6
#define	RULEFLAG_PROXY   1<<7
#define	RULEFLAG_PASSTHROUGH   1<<8
#define	RULEFLAG_FORBIDDEN   1<<9
#define	RULEFLAG_GONE   1<<10
#define	RULEFLAG_QSAPPEND   1<<11
#define	RULEFLAG_NOCASE   1<<12
#define	RULEFLAG_NOESCAPE   1<<13
#define	ACTION_NORMAL   1<<0
#define	ACTION_NOESCAPE   1<<1
#define	MAPTYPE_TXT   1<<0
#define	MAPTYPE_DBM   1<<1
#define	MAPTYPE_PRG   1<<2
#define	MAPTYPE_INT   1<<3
#define	MAPTYPE_RND   1<<4
#define	ENGINE_DISABLED   1<<0
#define	ENGINE_ENABLED   1<<1
#define	OPTION_NONE   1<<0
#define	OPTION_INHERIT   1<<1
#define	CACHEMODE_TS   1<<0
#define	CACHEMODE_TTL   1<<1
#define	CACHE_TLB_ROWS   1024
#define	CACHE_TLB_COLS   4
#define	FALSE   0
#define	TRUE   !FALSE
#define	NO   FALSE
#define	YES   TRUE
#define	RAND_MAX   32767
#define	LONG_STRING_LEN   2048
#define	MAX_ENV_FLAGS   15
#define	MAX_COOKIE_FLAGS   15
#define	MAX_COOKIE_LEN   4096
#define	REWRITE_REDIRECT_LIMIT   10
Typedefs
typedef cacheentry	cacheentry
typedef tlbentry	cachetlbentry
typedef cachelist	cachelist
typedef cache	cache
typedef backrefinfo	backrefinfo
typedef char *(	rewrite_mapfunc_t )(request_rec *r, char *key)
Functions
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)
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_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)
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)
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)
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)
static void	do_expand_cookie (request_rec *r, char *cookie[], backrefinfo *briRR, backrefinfo *briRC)
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 unsigned	is_absolute_uri (char *uri)
static char *	escape_absolute_uri (apr_pool_t *p, char *uri, unsigned scheme)
static char *	expand_tildepaths (request_rec *r, char *uri)
static char *	lookup_map (request_rec *r, char *name, char *key)
static char *	lookup_map_txtfile (request_rec *r, const char *file, char *key)
static char *	lookup_map_dbmfile (request_rec *r, const char *file, const char *dbmtype, char *key)
static char *	lookup_map_program (request_rec *r, apr_file_t *fpin, apr_file_t *fpout, 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)
static int	open_rewritelog (server_rec *s, apr_pool_t *p)
static void	rewritelog (request_rec *r, int level, const char *text,...) __attribute__((format(printf
static void static char *	current_logtime (request_rec *r)
static apr_status_t	rewritelock_create (server_rec *s, apr_pool_t *p)
static apr_status_t	rewritelock_remove (void *data)
static apr_status_t	run_rewritemap_programs (server_rec *s, apr_pool_t *p)
static apr_status_t	rewritemap_program_child (apr_pool_t *p, const char *progname, char **argv, apr_file_t **fpout, apr_file_t **fpin)
static char *	lookup_variable (request_rec *r, char *var)
static char *	lookup_header (request_rec *r, const char *name)
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)
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_pool_t *pool)
static void	add_env_variable (request_rec *r, char *s)
static void	add_cookie (request_rec *r, char *s)
static int	subreq_ok (request_rec *r)
static int	is_redirect_limit_exceeded (request_rec *r)
static int	compare_lexicography (char *cpNum1, char *cpNum2)
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)

---

Define Documentation

#define ACTION_NOESCAPE   1<<1

Definition at line 128 of file mod_rewrite.h. Referenced by apply_rewrite_list(), hook_fixup(), and hook_uri2file().

#define ACTION_NORMAL   1<<0

Definition at line 127 of file mod_rewrite.h. Referenced by apply_rewrite_list().

#define APR_WANT_MEMFUNC

Definition at line 56 of file mod_rewrite.h.

#define APR_WANT_STRFUNC

Definition at line 55 of file mod_rewrite.h.

#define CACHE_TLB_COLS   4

Definition at line 146 of file mod_rewrite.h. Referenced by cache_tlb_lookup(), cache_tlb_replace(), and store_cache_string().

#define CACHE_TLB_ROWS   1024

Definition at line 145 of file mod_rewrite.h. Referenced by cache_tlb_hash(), and store_cache_string().

#define CACHEMODE_TS   1<<0

Definition at line 142 of file mod_rewrite.h. Referenced by get_cache_string(), and lookup_map().

#define CACHEMODE_TTL   1<<1

Definition at line 143 of file mod_rewrite.h. Referenced by get_cache_string().

#define CONDFLAG_NOCASE   1<<1

Definition at line 108 of file mod_rewrite.h. Referenced by cmd_rewritecond(), and cmd_rewritecond_setflag().

#define CONDFLAG_NONE   1<<0

Definition at line 107 of file mod_rewrite.h. Referenced by cmd_rewritecond().

#define CONDFLAG_NOTMATCH   1<<2

Definition at line 109 of file mod_rewrite.h. Referenced by apply_rewrite_cond(), and cmd_rewritecond().

#define CONDFLAG_ORNEXT   1<<3

Definition at line 110 of file mod_rewrite.h. Referenced by apply_rewrite_rule(), and cmd_rewritecond_setflag().

#define CORE_PRIVATE

Definition at line 81 of file mod_rewrite.h.

#define ENGINE_DISABLED   1<<0

Definition at line 136 of file mod_rewrite.h. Referenced by APR_OPTIONAL_FN_TYPE(), cmd_rewriteengine(), config_perdir_create(), hook_fixup(), hook_uri2file(), and run_rewritemap_programs().

#define ENGINE_ENABLED   1<<1

Definition at line 137 of file mod_rewrite.h. Referenced by cmd_rewriteengine(), and cmd_rewritemap().

#define ENVVAR_SCRIPT_URI   "SCRIPT_URI"

Definition at line 103 of file mod_rewrite.h. Referenced by hook_uri2file().

#define ENVVAR_SCRIPT_URL   "SCRIPT_URL"

Definition at line 102 of file mod_rewrite.h. Referenced by hook_uri2file().

#define FALSE   0

Definition at line 149 of file mod_rewrite.h. Referenced by am_ConnectComputer(), am_IsComputerConnected(), ap_mpm_child_main(), ap_mpm_run(), ap_proxy_ftp_handler(), ap_proxy_http_process_response(), ApacheManageService(), appendMenuItem(), appendServiceMenu(), apr_create_nt_pipe(), APR_DECLARE(), cache_the_file(), child_control_handler(), clock_restore(), compile_regex(), ConnectDlgProc(), console_control_handler(), ConsoleWaitingThread(), conv_10(), conv_10_quad(), conv_fp(), FindRunningServices(), ftp_check_globbingchars(), GetApacheServicesStatus(), GetNullACL(), GetSystemOSVersion(), grep_or_recurse(), handle_option(), is_anchored(), is_startline(), isdirectory(), IsServiceRunning(), main(), master_main(), match(), match_ref(), monitor_service_9x_thread(), mpm_nt_eventlog_stderr_open(), mpm_service_start(), mpm_service_to_start(), mpm_signal_service(), pcre_compile(), pcre_exec(), pcregrep(), pgrep(), RunAndForgetConsole(), RunRedirectedConsole(), ServiceDlgProc(), set_start_bits(), shmcb_get_division(), shmcb_init_memory(), shmcb_insert_encoded_session(), shmcb_remove_session(), shmcb_remove_session_id(), shmcb_retrieve_session(), shmcb_store_session(), ShowTryPopupMenu(), signal_service_transition(), ssl_callback_proxy_cert(), ssl_callback_SSLVerify(), ssl_callback_SSLVerify_CRL(), ssl_cmd_SSLEngine(), ssl_cmd_SSLOptions(), ssl_cmd_SSLProxyEngine(), ssl_config_global_create(), ssl_config_perdir_create(), ssl_config_perdir_merge(), ssl_expr_comp(), ssl_expr_eval(), ssl_expr_eval_comp(), ssl_expr_eval_word(), ssl_hook_Access(), ssl_hook_default_port(), ssl_hook_http_method(), ssl_init_CheckServers(), ssl_init_ctx_cert_chain(), ssl_init_Module(), ssl_mutex_init(), ssl_mutex_off(), ssl_mutex_on(), ssl_mutex_reinit(), ssl_pphrase_Handle(), ssl_pphrase_Handle_CB(), ssl_scache_dbm_expire(), ssl_scache_dbm_store(), ssl_scache_shmcb_store(), ssl_scache_shmht_expire(), ssl_scache_shmht_store(), ssl_scache_store(), ssl_server_import_cert(), ssl_server_import_key(), ssl_util_path_check(), ssl_var_lookup(), ssl_var_lookup_ssl_cert(), ssl_var_lookup_ssl_cipher(), SSL_X509_getBC(), SSL_X509_getCN(), SSL_X509_INFO_load_file(), SSL_X509_INFO_load_path(), SSL_X509_isSGC(), stop_child_console_handler(), stop_console_handler(), wait_for_many_objects(), WinMain(), and WndProc().

#define LONG_STRING_LEN   2048

Definition at line 163 of file mod_rewrite.h. Referenced by lookup_map_program(), lookup_variable(), and reduce_uri().

#define MAPTYPE_DBM   1<<1

Definition at line 131 of file mod_rewrite.h. Referenced by cmd_rewritemap(), and lookup_map().

#define MAPTYPE_INT   1<<3

Definition at line 133 of file mod_rewrite.h. Referenced by cmd_rewritemap(), and lookup_map().

#define MAPTYPE_PRG   1<<2

Definition at line 132 of file mod_rewrite.h. Referenced by cmd_rewritemap(), lookup_map(), and run_rewritemap_programs().

#define MAPTYPE_RND   1<<4

Definition at line 134 of file mod_rewrite.h. Referenced by cmd_rewritemap(), and lookup_map().

#define MAPTYPE_TXT   1<<0

Definition at line 130 of file mod_rewrite.h. Referenced by cmd_rewritemap(), and lookup_map().

#define MAX_COOKIE_FLAGS   15

Definition at line 167 of file mod_rewrite.h. Referenced by cmd_rewriterule_setflag().

#define MAX_COOKIE_LEN   4096

Definition at line 169 of file mod_rewrite.h.

#define MAX_ENV_FLAGS   15

Definition at line 166 of file mod_rewrite.h. Referenced by cmd_rewriterule_setflag().

#define MOD_REWRITE_H   1

Definition at line 18 of file mod_rewrite.h.

#define NO   FALSE

Definition at line 154 of file mod_rewrite.h. Referenced by APR_DECLARE().

#define OPTION_INHERIT   1<<1

Definition at line 140 of file mod_rewrite.h. Referenced by cmd_rewriteoptions(), config_perdir_merge(), and config_server_merge().

#define OPTION_NONE   1<<0

Definition at line 139 of file mod_rewrite.h. Referenced by APR_OPTIONAL_FN_TYPE(), and config_perdir_create().

#define RAND_MAX   32767

Definition at line 159 of file mod_rewrite.h. Referenced by rewrite_rand(), and ssl_rand_choosenum().

#define REWRITE_FORCED_MIMETYPE_NOTEVAR   "rewrite-forced-mimetype"

Definition at line 105 of file mod_rewrite.h. Referenced by apply_rewrite_rule(), and hook_mimetype().

#define REWRITE_REDIRECT_LIMIT   10

Definition at line 172 of file mod_rewrite.h. Referenced by is_redirect_limit_exceeded().

#define RULEFLAG_CHAIN   1<<4

Definition at line 116 of file mod_rewrite.h. Referenced by apply_rewrite_list(), and cmd_rewriterule_setflag().

#define RULEFLAG_FORBIDDEN   1<<9

Definition at line 121 of file mod_rewrite.h. Referenced by apply_rewrite_list(), and cmd_rewriterule_setflag().

#define RULEFLAG_FORCEREDIRECT   1<<1

Definition at line 113 of file mod_rewrite.h. Referenced by apply_rewrite_list(), apply_rewrite_rule(), and cmd_rewriterule_setflag().

#define RULEFLAG_GONE   1<<10

Definition at line 122 of file mod_rewrite.h. Referenced by apply_rewrite_list(), and cmd_rewriterule_setflag().

#define RULEFLAG_IGNOREONSUBREQ   1<<5

Definition at line 117 of file mod_rewrite.h. Referenced by apply_rewrite_list(), and cmd_rewriterule_setflag().

#define RULEFLAG_LASTRULE   1<<2

Definition at line 114 of file mod_rewrite.h. Referenced by apply_rewrite_list(), and cmd_rewriterule_setflag().

#define RULEFLAG_NEWROUND   1<<3

Definition at line 115 of file mod_rewrite.h. Referenced by apply_rewrite_list(), and cmd_rewriterule_setflag().

#define RULEFLAG_NOCASE   1<<12

Definition at line 124 of file mod_rewrite.h. Referenced by cmd_rewriterule(), and cmd_rewriterule_setflag().

#define RULEFLAG_NOESCAPE   1<<13

Definition at line 125 of file mod_rewrite.h. Referenced by apply_rewrite_list(), and cmd_rewriterule_setflag().

#define RULEFLAG_NONE   1<<0

Definition at line 112 of file mod_rewrite.h. Referenced by cmd_rewriterule().

#define RULEFLAG_NOTMATCH   1<<6

Definition at line 118 of file mod_rewrite.h. Referenced by apply_rewrite_rule(), and cmd_rewriterule().

#define RULEFLAG_PASSTHROUGH   1<<8

Definition at line 120 of file mod_rewrite.h. Referenced by apply_rewrite_list(), and cmd_rewriterule_setflag().

#define RULEFLAG_PROXY   1<<7

Definition at line 119 of file mod_rewrite.h. Referenced by apply_rewrite_list(), apply_rewrite_rule(), and cmd_rewriterule_setflag().

#define RULEFLAG_QSAPPEND   1<<11

Definition at line 123 of file mod_rewrite.h. Referenced by apply_rewrite_rule(), and cmd_rewriterule_setflag().

#define TRUE   !FALSE

Definition at line 150 of file mod_rewrite.h. Referenced by am_ConnectComputer(), am_IsComputerConnected(), ap_mpm_run(), ap_proxy_ftp_handler(), ap_proxy_http_process_response(), ApacheManageService(), apr_create_nt_pipe(), APR_DECLARE(), cache_the_file(), child_control_handler(), compile_regex(), ConnectDlgProc(), console_control_handler(), ConsoleOutputThread(), conv_apr_sockaddr(), conv_in_addr(), CreateMainWindow(), file_cache_handler(), find_firstchar(), FindRunningServices(), ftp_check_globbingchars(), GetApacheServicesStatus(), GetNullACL(), GetSystemOSVersion(), grep_or_recurse(), handle_option(), is_anchored(), is_startline(), IsServiceRunning(), main(), match(), match_ref(), monitor_service_9x_thread(), mpm_service_to_start(), mpm_signal_service(), mpm_start_child_console_handler(), mpm_start_console_handler(), pcre_compile(), pcre_exec(), perform_idle_server_maintenance(), read_with_timeout(), RunAndForgetConsole(), RunRedirectedConsole(), ServiceDlgProc(), set_start_bits(), shmcb_get_division(), shmcb_init_memory(), shmcb_insert_encoded_session(), shmcb_remove_session_id(), shmcb_store_session(), ShowTryPopupMenu(), ssl_callback_NewSessionCacheEntry(), ssl_callback_proxy_cert(), ssl_callback_SSLVerify(), ssl_cmd_SSLEngine(), ssl_cmd_SSLOptions(), ssl_cmd_SSLProxyEngine(), ssl_cmd_SSLRequireSSL(), ssl_config_global_fix(), ssl_expr_eval(), ssl_expr_eval_comp(), ssl_hook_Access(), ssl_init_CheckServers(), ssl_init_ctx_cert_chain(), ssl_mutex_init(), ssl_mutex_off(), ssl_mutex_on(), ssl_mutex_reinit(), ssl_pphrase_Handle(), ssl_scache_dbm_expire(), ssl_scache_dbm_store(), ssl_scache_shmcb_store(), ssl_scache_shmht_expire(), ssl_scache_shmht_store(), ssl_server_import_cert(), ssl_server_import_key(), ssl_util_path_check(), ssl_var_lookup(), ssl_var_lookup_ssl_cert(), ssl_var_lookup_ssl_cipher(), SSL_X509_getBC(), SSL_X509_getCN(), SSL_X509_INFO_load_file(), SSL_X509_INFO_load_path(), SSL_X509_isSGC(), wait_for_many_objects(), WinMain(), and WndProc().

#define VARY_KEY   "rewrite-Vary"

Definition at line 93 of file mod_rewrite.h. Referenced by apply_rewrite_rule().

#define VARY_KEY_THIS   "rewrite-Vary-this"

Definition at line 94 of file mod_rewrite.h. Referenced by apply_rewrite_rule(), and lookup_header().

#define YES   TRUE

Definition at line 155 of file mod_rewrite.h. Referenced by APR_DECLARE().

---

Typedef Documentation

typedef struct backrefinfo backrefinfo

typedef struct cache cache

typedef struct cacheentry cacheentry

typedef struct cachelist cachelist

typedef struct tlbentry cachetlbentry

typedef char*( rewrite_mapfunc_t)(request_rec *r, char *key)

Definition at line 385 of file mod_rewrite.h.

---

Function Documentation

static void add_cookie (  request_rec *  r, char *  s )  [static]

static void add_env_variable (  request_rec *  r, char *  s )  [static]

static void ap_register_rewrite_mapfunc (  char *  name, rewrite_mapfunc_t *  func )  [static]

static int apply_rewrite_cond (  request_rec *  r, rewritecond_entry *  p, char *  perdir, backrefinfo *  briRR, backrefinfo *  briRC )  [static]

static int apply_rewrite_list (  request_rec *  r, apr_array_header_t *  rewriterules, char *  perdir )  [static]

static int apply_rewrite_rule (  request_rec *  r, rewriterule_entry *  p, char *  perdir )  [static]

APR_DECLARE_OPTIONAL_FN (  void  , ap_register_rewrite_mapfunc  , (char *name, rewrite_mapfunc_t *func)  )

static const char* cmd_rewritebase (  cmd_parms *  cmd, void *  dconf, const char *  a1 )  [static]

static const char* cmd_rewritecond (  cmd_parms *  cmd, void *  dconf, const char *  str )  [static]

static const char* cmd_rewritecond_parseflagfield (  apr_pool_t *  p, rewritecond_entry *  new, char *  str )  [static]

static const char* cmd_rewritecond_setflag (  apr_pool_t *  p, rewritecond_entry *  cfg, char *  key, char *  val )  [static]

static const char* cmd_rewriteengine (  cmd_parms *  cmd, void *  dconf, int  flag )  [static]

static const char* cmd_rewritelock (  cmd_parms *  cmd, void *  dconf,