Collaboration diagram for Proxy request types:

Modules
	Flags which indicate places where the server should stop for debugging.

Data Structures
struct	conn_rec
	Structure to store things which are per connection. More...

struct	conn_slave_rec

struct	conn_state_t
	A structure to contain connection state information. More...

struct	server_addr_rec
	A structure to be used for Per-vhost config. More...

struct	ap_logconf

struct	server_rec
	A structure to store information for each virtual server. More...

struct	ap_sload_t
	A structure to hold server load params. More...

struct	ap_loadavg_t
	A structure to hold various server loadavg. More...

struct	ap_form_pair_t

struct	ap_dir_match_t

Macros
#define	PROXYREQ_NONE 0

#define	PROXYREQ_PROXY 1

#define	PROXYREQ_REVERSE 2

#define	PROXYREQ_RESPONSE 3

#define	DEFAULT_VHOST_ADDR 0xfffffffful

#define	AP_UNESCAPE_URL_KEEP_UNRESERVED (1u << 0)

#define	AP_UNESCAPE_URL_FORBID_SLASHES (1u << 1)

#define	AP_UNESCAPE_URL_KEEP_SLASHES (1u << 2)

#define	AP_NORMALIZE_ALLOW_RELATIVE (1u << 0)

#define	AP_NORMALIZE_NOT_ABOVE_ROOT (1u << 1)

#define	AP_NORMALIZE_DECODE_UNRESERVED (1u << 2)

#define	AP_NORMALIZE_MERGE_SLASHES (1u << 3)

#define	AP_NORMALIZE_DROP_PARAMETERS (0) /* deprecated */

#define	ap_escape_uri(ppool, path) ap_os_escape_path(ppool,path,1)

#define	ap_escape_html(p, s) ap_escape_html2(p,s,0)

#define	AP_TAINT_HTACCESS 0x1

#define	ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))

#define	AP_DEBUG_ASSERT(exp) ((void)0)

#define	ap_strchr(s, c) strchr(s, c)

#define	ap_strchr_c(s, c) strchr(s, c)

#define	ap_strrchr(s, c) strrchr(s, c)

#define	ap_strrchr_c(s, c) strrchr(s, c)

#define	ap_strstr(s, c) strstr(s, c)

#define	ap_strstr_c(s, c) strstr(s, c)

#define	AP_HAS_THREAD_LOCAL 0

#define	AP_NORESTART APR_OS_START_USEERR + 1

#define	AP_DIR_FLAG_NONE 0

#define	AP_DIR_FLAG_OPTIONAL 1

#define	AP_DIR_FLAG_RECURSIVE 2

Typedefs
typedef struct server_addr_rec	server_addr_rec

typedef struct ap_sload_t	ap_sload_t

typedef struct ap_loadavg_t	ap_loadavg_t

typedef struct ap_dir_match_t	ap_dir_match_t

Enumerations
enum	ap_conn_keepalive_e { AP_CONN_UNKNOWN , AP_CONN_CLOSE , AP_CONN_KEEPALIVE }
	Enumeration of connection keepalive options. More...

enum	conn_state_e { CONN_STATE_CHECK_REQUEST_LINE_READABLE , CONN_STATE_READ_REQUEST_LINE , CONN_STATE_HANDLER , CONN_STATE_WRITE_COMPLETION , CONN_STATE_SUSPENDED , CONN_STATE_LINGER , CONN_STATE_LINGER_NORMAL , CONN_STATE_LINGER_SHORT , CONN_STATE_NUM }

enum	conn_sense_e { CONN_SENSE_DEFAULT , CONN_SENSE_WANT_READ , CONN_SENSE_WANT_WRITE }

Functions
const char *	ap_context_document_root (request_rec *r)

const char *	ap_context_prefix (request_rec *r)

void	ap_set_context_info (request_rec r, const char prefix, const char *document_root)

void	ap_set_document_root (request_rec r, const char document_root)

char *	ap_field_noparam (apr_pool_t p, const char intype)

char *	ap_ht_time (apr_pool_t p, apr_time_t t, const char fmt, int gmt)

char *	ap_getword (apr_pool_t p, const char *line, char stop)

char *	ap_getword_nc (apr_pool_t p, char *line, char stop)

char *	ap_getword_white (apr_pool_t p, const char *line)

char *	ap_getword_white_nc (apr_pool_t p, char *line)

char *	ap_getword_nulls (apr_pool_t p, const char *line, char stop)

char *	ap_getword_nulls_nc (apr_pool_t p, char *line, char stop)

char *	ap_getword_conf (apr_pool_t p, const char *line)

char *	ap_getword_conf_nc (apr_pool_t p, char *line)

char *	ap_getword_conf2 (apr_pool_t p, const char *line)

char *	ap_getword_conf2_nc (apr_pool_t p, char *line)

const char *	ap_resolve_env (apr_pool_t p, const char word)

const char *	ap_size_list_item (const char *field, int len)

char *	ap_get_list_item (apr_pool_t p, const char *field)

int	ap_find_list_item (apr_pool_t p, const char line, const char *tok)

int	ap_find_etag_weak (apr_pool_t p, const char line, const char *tok)

int	ap_find_etag_strong (apr_pool_t p, const char line, const char *tok)

const char *	ap_scan_http_field_content (const char *ptr)

const char *	ap_scan_http_token (const char *ptr)

const char *	ap_scan_vchar_obstext (const char *ptr)

const char *	ap_parse_token_list_strict (apr_pool_t p, const char tok, apr_array_header_t **tokens, int skip_invalid)

char *	ap_get_token (apr_pool_t p, const char *accept_line, int accept_white)

int	ap_find_token (apr_pool_t p, const char line, const char *tok)

int	ap_find_last_token (apr_pool_t p, const char line, const char *tok)

int	ap_is_url (const char *u)

int	ap_unescape_all (char *url)

int	ap_unescape_url (char *url)

int	ap_unescape_url_keep2f (char *url, int decode_slashes)

int	ap_unescape_url_ex (char *url, unsigned int flags)

int	ap_unescape_urlencoded (char *query)

void	ap_no2slash (char *name) AP_FN_ATTR_NONNULL_ALL

void	ap_no2slash_ex (char *name, int is_fs_path) AP_FN_ATTR_NONNULL_ALL

int	ap_normalize_path (char *path, unsigned int flags) AP_FN_ATTR_NONNULL((1))

void	ap_getparents (char *name) AP_FN_ATTR_NONNULL_ALL

char *	ap_escape_path_segment (apr_pool_t p, const char s) AP_FN_ATTR_NONNULL_ALL

char *	ap_escape_path_segment_buffer (char c, const char s) AP_FN_ATTR_NONNULL_ALL

char *	ap_os_escape_path (apr_pool_t p, const char path, int partial) AP_FN_ATTR_NONNULL_ALL

char *	ap_escape_urlencoded (apr_pool_t p, const char s) AP_FN_ATTR_NONNULL_ALL

char *	ap_escape_urlencoded_buffer (char c, const char s) AP_FN_ATTR_NONNULL_ALL

char *	ap_escape_html2 (apr_pool_t p, const char s, int toasc) AP_FN_ATTR_NONNULL_ALL

char *	ap_escape_logitem (apr_pool_t p, const char str) AP_FN_ATTR_NONNULL((1))

apr_size_t	ap_escape_errorlog_item (char dest, const char source, apr_size_t buflen) AP_FN_ATTR_NONNULL((1))

char *	ap_construct_server (apr_pool_t p, const char hostname, apr_port_t port, const request_rec *r) AP_FN_ATTR_NONNULL((1

char char *	ap_escape_shell_cmd (apr_pool_t p, const char s) AP_FN_ATTR_NONNULL_ALL

int	ap_count_dirs (const char *path) AP_FN_ATTR_NONNULL_ALL

char *	ap_make_dirstr_prefix (char d, const char s, int n) AP_FN_ATTR_NONNULL_ALL

char *	ap_make_dirstr_parent (apr_pool_t p, const char s) AP_FN_ATTR_NONNULL_ALL

char *	ap_make_full_path (apr_pool_t a, const char dir, const char *f) AP_FN_ATTR_NONNULL_ALL

int	ap_os_is_path_absolute (apr_pool_t p, const char dir) AP_FN_ATTR_NONNULL_ALL

int	ap_is_matchexp (const char *str) AP_FN_ATTR_NONNULL_ALL

int	ap_strcmp_match (const char str, const char expected) AP_FN_ATTR_NONNULL_ALL

int	ap_strcasecmp_match (const char str, const char expected) AP_FN_ATTR_NONNULL_ALL

char *	ap_strcasestr (const char s1, const char s2) AP_FN_ATTR_NONNULL_ALL

const char *	ap_stripprefix (const char bigstring, const char prefix) AP_FN_ATTR_NONNULL_ALL

char *	ap_pbase64decode (apr_pool_t p, const char bufcoded)

apr_status_t	ap_pbase64decode_strict (apr_pool_t p, const char encoded, char *decoded, apr_size_t len)

char *	ap_pbase64encode (apr_pool_t p, char string)

ap_regex_t *	ap_pregcomp (apr_pool_t p, const char pattern, int cflags)

void	ap_pregfree (apr_pool_t p, ap_regex_t reg)

char *	ap_pregsub (apr_pool_t p, const char input, const char *source, apr_size_t nmatch, ap_regmatch_t pmatch[])

apr_status_t	ap_pregsub_ex (apr_pool_t p, char result, const char input, const char *source, apr_size_t nmatch, ap_regmatch_t pmatch[], apr_size_t maxlen)

void	ap_content_type_tolower (char *s)

void	ap_str_tolower (char *s)

void	ap_str_toupper (char *s)

int	ap_ind (const char *str, char c)

int	ap_rind (const char *str, char c)

char *	ap_escape_quotes (apr_pool_t p, const char instring)

char *	ap_append_pid (apr_pool_t p, const char string, const char *delim)

int	ap_parse_strict_length (apr_off_t len, const char str)

apr_status_t	ap_timeout_parameter_parse (const char timeout_parameter, apr_interval_time_t timeout, const char *default_time_unit)

int	ap_request_has_body (request_rec *r)

int	ap_request_tainted (request_rec *r, int flags)

apr_status_t	ap_pstr2_alnum (apr_pool_t p, const char src, const char **dest)

apr_status_t	ap_str2_alnum (const char src, char dest)

int	ap_parse_form_data (request_rec r, struct ap_filter_t f, apr_array_header_t **ptr, apr_size_t num, apr_size_t size)

int	ap_is_rdirectory (apr_pool_t p, const char name)

int	ap_is_directory (apr_pool_t p, const char name)

char *	ap_get_local_host (apr_pool_t *p)

void	ap_log_assert (const char szExp, const char szFile, int nLine) __attribute__((noreturn))

const char *	ap_psignature (const char prefix, request_rec r)

char *	ap_strchr (char *s, int c)

const char *	ap_strchr_c (const char *s, int c)

char *	ap_strrchr (char *s, int c)

const char *	ap_strrchr_c (const char *s, int c)

char *	ap_strstr (char s, const char c)

const char *	ap_strstr_c (const char s, const char c)

void *	ap_palloc_debug (apr_pool_t *p, apr_size_t size)

void *	ap_pcalloc_debug (apr_pool_t *p, apr_size_t size)

void	ap_random_insecure_bytes (void *buf, apr_size_t size)

apr_uint32_t	ap_random_pick (apr_uint32_t min, apr_uint32_t max)

void	ap_abort_on_oom (void) __attribute__((noreturn))

void *	ap_malloc (size_t size) __attribute__((malloc)) AP_FN_ATTR_ALLOC_SIZE(1)

void *	ap_calloc (size_t nelem, size_t size) __attribute__((malloc)) AP_FN_ATTR_ALLOC_SIZE2(1

void void *	ap_realloc (void *ptr, size_t size) AP_FN_ATTR_WARN_UNUSED_RESULT AP_FN_ATTR_ALLOC_SIZE(2)

apr_status_t	ap_thread_create (apr_thread_t *thread, apr_threadattr_t attr, apr_thread_start_t func, void data, apr_pool_t pool)

apr_status_t	ap_thread_main_create (apr_thread_t *thread, apr_pool_t pool)

apr_status_t	ap_thread_current_create (apr_thread_t *current, apr_threadattr_t attr, apr_pool_t *pool)

void	ap_thread_current_after_fork (void)

apr_thread_t *	ap_thread_current (void)

void	ap_get_sload (ap_sload_t *ld) AP_FN_ATTR_NONNULL_ALL

void	ap_get_loadavg (ap_loadavg_t *ld) AP_FN_ATTR_NONNULL_ALL

void	ap_bin2hex (const void src, apr_size_t srclen, char dest) AP_FN_ATTR_NONNULL_ALL

apr_status_t	ap_password_validate (request_rec r, const char username, const char passwd, const char hash)

char *	ap_get_exec_line (apr_pool_t p, const char cmd, const char const argv)

int	ap_array_str_index (const apr_array_header_t array, const char s, int start)

int	ap_array_str_contains (const apr_array_header_t array, const char s)

int	ap_cstr_casecmp (const char s1, const char s2)

int	ap_cstr_casecmpn (const char s1, const char s2, apr_size_t n)

const char *	ap_dir_nofnmatch (ap_dir_match_t w, const char fname) __attribute__((nonnull(1

const char const char *	ap_dir_fnmatch (ap_dir_match_t w, const char path, const char *fname) __attribute__((nonnull(1

const char const char int	ap_is_chunked (apr_pool_t p, const char line)

Detailed Description

Possible values of request_rec->proxyreq. A request could be normal, proxied or reverse proxied. Normally proxied and reverse proxied are grouped together as just "proxied", but sometimes it's necessary to tell the difference between the two, such as for authentication.

Macro Definition Documentation

◆ ap_assert

#define ap_assert ( exp ) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))

Internal Assert function

◆ AP_DEBUG_ASSERT

#define AP_DEBUG_ASSERT ( exp ) ((void)0)

Redefine assert() to something more useful for an Apache...

Use ap_assert() if the condition should always be checked. Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG is defined.

◆ AP_DIR_FLAG_NONE

#define AP_DIR_FLAG_NONE 0

Default flags for ap_dir_*fnmatch().

◆ AP_DIR_FLAG_OPTIONAL

#define AP_DIR_FLAG_OPTIONAL 1

If set, wildcards that match no files or directories will be ignored, otherwise an error is triggered.

◆ AP_DIR_FLAG_RECURSIVE

#define AP_DIR_FLAG_RECURSIVE 2

If set, and the wildcard resolves to a directory, recursively find all files below that directory, otherwise return the directory.

◆ ap_escape_html

#define ap_escape_html	(	p,
		s
	)	ap_escape_html2(p,s,0)

Escape an html string

Parameters

p	The pool to allocate from
s	The html to escape

Returns: The escaped string

Deprecated:: Replaced by apr_pescape_entity() in APR

◆ ap_escape_uri

#define ap_escape_uri	(	ppool,
		path
	)	ap_os_escape_path(ppool,path,1)

See also: ap_os_escape_path

◆ AP_HAS_THREAD_LOCAL

#define AP_HAS_THREAD_LOCAL 0

◆ AP_NORESTART

#define AP_NORESTART APR_OS_START_USEERR + 1

◆ AP_NORMALIZE_ALLOW_RELATIVE

#define AP_NORMALIZE_ALLOW_RELATIVE (1u << 0)

◆ AP_NORMALIZE_DECODE_UNRESERVED

#define AP_NORMALIZE_DECODE_UNRESERVED (1u << 2)

◆ AP_NORMALIZE_DROP_PARAMETERS

#define AP_NORMALIZE_DROP_PARAMETERS (0) /* deprecated */

◆ AP_NORMALIZE_MERGE_SLASHES

#define AP_NORMALIZE_MERGE_SLASHES (1u << 3)

◆ AP_NORMALIZE_NOT_ABOVE_ROOT

#define AP_NORMALIZE_NOT_ABOVE_ROOT (1u << 1)

◆ ap_strchr

#define ap_strchr	(	s,
		c
	)	strchr(s, c)

use this instead of strchr

◆ ap_strchr_c

#define ap_strchr_c	(	s,
		c
	)	strchr(s, c)

use this instead of strchr

◆ ap_strrchr

#define ap_strrchr	(	s,
		c
	)	strrchr(s, c)

use this instead of strrchr

◆ ap_strrchr_c

#define ap_strrchr_c	(	s,
		c
	)	strrchr(s, c)

use this instead of strrchr

◆ ap_strstr

#define ap_strstr	(	s,
		c
	)	strstr(s, c)

use this instead of strrstr

◆ ap_strstr_c

#define ap_strstr_c	(	s,
		c
	)	strstr(s, c)

use this instead of strrstr

◆ AP_TAINT_HTACCESS

#define AP_TAINT_HTACCESS 0x1

Request taint flags. Only .htaccess defined.

◆ AP_UNESCAPE_URL_FORBID_SLASHES

#define AP_UNESCAPE_URL_FORBID_SLASHES (1u << 1)

◆ AP_UNESCAPE_URL_KEEP_SLASHES

#define AP_UNESCAPE_URL_KEEP_SLASHES (1u << 2)

◆ AP_UNESCAPE_URL_KEEP_UNRESERVED

#define AP_UNESCAPE_URL_KEEP_UNRESERVED (1u << 0)

◆ DEFAULT_VHOST_ADDR

#define DEFAULT_VHOST_ADDR 0xfffffffful

The address 255.255.255.255, when used as a virtualhost address, will become the "default" server when the ip doesn't match other vhosts.

◆ PROXYREQ_NONE

#define PROXYREQ_NONE 0

No proxy

◆ PROXYREQ_PROXY

#define PROXYREQ_PROXY 1

Standard proxy

◆ PROXYREQ_RESPONSE

#define PROXYREQ_RESPONSE 3

Origin response

◆ PROXYREQ_REVERSE

#define PROXYREQ_REVERSE 2

Reverse proxy

Typedef Documentation

◆ ap_dir_match_t

typedef struct ap_dir_match_t ap_dir_match_t

Structure to provide the state of a directory match.

◆ ap_loadavg_t

typedef struct ap_loadavg_t ap_loadavg_t

◆ ap_sload_t

typedef struct ap_sload_t ap_sload_t

◆ server_addr_rec

typedef struct server_addr_rec server_addr_rec

Enumeration Type Documentation

◆ ap_conn_keepalive_e

enum ap_conn_keepalive_e

Enumeration of connection keepalive options.

Enumerator
AP_CONN_UNKNOWN
AP_CONN_CLOSE
AP_CONN_KEEPALIVE

◆ conn_sense_e

enum conn_sense_e

Enumerator
CONN_SENSE_DEFAULT
CONN_SENSE_WANT_READ
CONN_SENSE_WANT_WRITE

◆ conn_state_e

enum conn_state_e

Enumeration of connection states The two states CONN_STATE_LINGER_NORMAL and CONN_STATE_LINGER_SHORT may only be set by the MPM. Use CONN_STATE_LINGER outside of the MPM.

Enumerator
CONN_STATE_CHECK_REQUEST_LINE_READABLE
CONN_STATE_READ_REQUEST_LINE
CONN_STATE_HANDLER
CONN_STATE_WRITE_COMPLETION
CONN_STATE_SUSPENDED
CONN_STATE_LINGER
CONN_STATE_LINGER_NORMAL
CONN_STATE_LINGER_SHORT
CONN_STATE_NUM

Function Documentation

◆ ap_abort_on_oom()

void ap_abort_on_oom ( void )

Abort with a error message signifying out of memory

◆ ap_append_pid()

char* ap_append_pid	(	apr_pool_t *	p,
		const char *	string,
		const char *	delim
	)

Given a string, append the PID deliminated by delim. Usually used to create a pid-appended filepath name (eg: /a/b/foo -> /a/b/foo.6726). A function, and not a macro, to avoid unistd.h dependency

Parameters

p	The pool to allocate memory from
string	The string to append the PID to
delim	The string to use to deliminate the string from the PID

Returns: A copy of the string with the PID appended

◆ ap_array_str_contains()

int ap_array_str_contains	(	const apr_array_header_t *	array,
		const char *	s
	)

Check if the string is member of the given array by strcmp.

Parameters

array	The array the check
s	The string to find

Returns: !=0 iff string is member of array (via strcmp)

◆ ap_array_str_index()

int ap_array_str_index	(	const apr_array_header_t *	array,
		const char *	s,
		int	start
	)

Get the first index of the string in the array or -1 if not found. Start searching a start.

Parameters

array	The array the check
s	The string to find
start	Start index for search. If start is out of bounds (negative or equal to array length or greater), -1 will be returned.

Returns: index of string in array or -1

◆ ap_bin2hex()

void ap_bin2hex	(	const void *	src,
		apr_size_t	srclen,
		char *	dest
	)

Convert binary data into a hex string

Parameters

src	pointer to the data
srclen	length of the data
dest	pointer to buffer of length (2 * srclen + 1). The resulting string will be NUL-terminated.

Deprecated:: Replaced by apr_escape_hex() in APR

◆ ap_calloc()

void* ap_calloc	(	size_t	nelem,
		size_t	size
	)

Wrapper for calloc() that calls ap_abort_on_oom() if out of memory

Parameters

nelem	number of elements to allocate memory for
size	size of a single element

Returns: pointer to the allocated memory

Note: ap_calloc may be implemented as a macro

◆ ap_construct_server()

char* ap_construct_server	(	apr_pool_t *	p,
		const char *	hostname,
		apr_port_t	port,
		const request_rec *	r
	)

Construct a full hostname

Parameters

p	The pool to allocate from
hostname	The hostname of the server
port	The port the server is running on
r	The current request

Returns: The server's hostname

◆ ap_content_type_tolower()

void ap_content_type_tolower ( char * s )

We want to downcase the type/subtype for comparison purposes but nothing else because ;parameter=foo values are case sensitive.

Parameters

s	The content-type to convert to lowercase

◆ ap_context_document_root()

const char* ap_context_document_root ( request_rec * r )

Get the context_document_root for a request. This is a generalization of the document root, which is too limited in the presence of mappers like mod_userdir and mod_alias. The context_document_root is the directory on disk that maps to the context_prefix URI prefix.

Parameters

r	The request

Note: For resources that do not map to the file system or for very complex mappings, this information may still be wrong.

◆ ap_context_prefix()

const char* ap_context_prefix ( request_rec * r )

Get the context_prefix for a request. The context_prefix URI prefix maps to the context_document_root on disk.

Parameters

r	The request

◆ ap_count_dirs()

int ap_count_dirs ( const char * path )

Count the number of directories in a path

Parameters

path	The path to count

Returns: The number of directories

◆ ap_cstr_casecmp()

int ap_cstr_casecmp	(	const char *	s1,
		const char *	s2
	)

Perform a case-insensitive comparison of two strings str1 and str2, treating upper and lower case values of the 26 standard C/POSIX alphabetic characters as equivalent. Extended latin characters outside of this set are treated as unique octets, irrespective of the current locale.

Returns in integer greater than, equal to, or less than 0, according to whether str1 is considered greater than, equal to, or less than str2.

Note: Same code as apr_cstr_casecmp, which arrives in APR 1.6

◆ ap_cstr_casecmpn()

int ap_cstr_casecmpn	(	const char *	s1,
		const char *	s2,
		apr_size_t	n
	)

Perform a case-insensitive comparison of two strings str1 and str2, treating upper and lower case values of the 26 standard C/POSIX alphabetic characters as equivalent. Extended latin characters outside of this set are treated as unique octets, irrespective of the current locale.

Returns in integer greater than, equal to, or less than 0, according to whether str1 is considered greater than, equal to, or less than str2.

Note: Same code as apr_cstr_casecmpn, which arrives in APR 1.6

◆ ap_dir_fnmatch()

const char const char* ap_dir_fnmatch	(	ap_dir_match_t *	w,
		const char *	path,
		const char *	fname
	)

Search for files given a wildcard filename with non native separators.

If the filename contains a wildcard, all files and directories that match the wildcard will be returned.

ap_dir_nofnmatch() is called for each directory and file found, and the callback within ap_dir_match_t triggered as described above.

Wildcards may appear in both directory and file components in the path, and wildcards may appear more than once.

Parameters

w	Directory match structure containing callback and context.
path	Path prefix for search, with non native separators and no wildcards.
fname	The name of the file or directory, with non native separators and optional wildcards.

Returns: NULL on success, or a string describing the error.

◆ ap_dir_nofnmatch()

const char* ap_dir_nofnmatch	(	ap_dir_match_t *	w,
		const char *	fname
	)

Search for files given a non wildcard filename with non native separators.

If the provided filename points at a file, the callback within ap_dir_match_t is triggered for that file, and this function returns the result of the callback.

If the provided filename points at a directory, and recursive within ap_dir_match_t is true, the callback will be triggered for every file found recursively beneath that directory, otherwise the callback is triggered once for the directory itself. This function returns the result of the callback.

If the provided path points to neither a file nor a directory, and optional within ap_dir_match_t is true, this function returns NULL. If optional within ap_dir_match_t is false, this function will return an error string indicating that the path does not exist.

Parameters

w	Directory match structure containing callback and context.
fname	The name of the file or directory, with non native separators.

Returns: NULL on success, or a string describing the error.

◆ ap_escape_errorlog_item()

apr_size_t ap_escape_errorlog_item	(	char *	dest,
		const char *	source,
		apr_size_t	buflen
	)

Escape a string for logging into the error log (without a pool)

Parameters

dest	The buffer to write to
source	The string to escape
buflen	The buffer size for the escaped string (including "\0")

Returns: The len of the escaped string (always < maxlen)

Deprecated:: Replaced by apr_escape_echo() in APR

◆ ap_escape_html2()

char* ap_escape_html2	(	apr_pool_t *	p,
		const char *	s,
		int	toasc
	)

Escape an html string

Parameters

p	The pool to allocate from
s	The html to escape
toasc	Whether to escape all non-ASCII chars to &#nnn;

Returns: The escaped string

Deprecated:: Replaced by apr_pescape_entity() in APR

◆ ap_escape_logitem()

char* ap_escape_logitem	(	apr_pool_t *	p,
		const char *	str
	)

Escape a string for logging

Parameters

p	The pool to allocate from
str	The string to escape

Returns: The escaped string

Deprecated:: Replaced by apr_pescape_echo() in APR

◆ ap_escape_path_segment()

char* ap_escape_path_segment	(	apr_pool_t *	p,
		const char *	s
	)

Escape a path segment, as defined in RFC 1808

Parameters

p	The pool to allocate from
s	The path to convert

Returns: The converted URL

Deprecated:: Replaced by apr_pescape_path_segment() in APR

◆ ap_escape_path_segment_buffer()

char* ap_escape_path_segment_buffer	(	char *	c,
		const char *	s
	)

Escape a path segment, as defined in RFC 1808, to a preallocated buffer.

Parameters

c	The preallocated buffer to write to
s	The path to convert

Returns: The converted URL (c)

Deprecated:: Replaced by apr_escape_path_segment() in APR

◆ ap_escape_quotes()

char* ap_escape_quotes	(	apr_pool_t *	p,
		const char *	instring
	)

Given a string, replace any bare " with \" .

Parameters

p	The pool to allocate memory from
instring	The string to search for "

Returns: A copy of the string with escaped quotes

Deprecated:: Replaced by apr_pescape_echo() in APR

◆ ap_escape_shell_cmd()

char char* ap_escape_shell_cmd	(	apr_pool_t *	p,
		const char *	s
	)

Escape a shell command

Parameters

p	The pool to allocate from
s	The command to escape

Returns: The escaped shell command

Deprecated:: Replaced with apr_escape_shell() in APR

◆ ap_escape_urlencoded()

char* ap_escape_urlencoded	(	apr_pool_t *	p,
		const char *	s
	)

Escape a string as application/x-www-form-urlencoded

Parameters

p	The pool to allocate from
s	The path to convert

Returns: The converted URL

Deprecated:: Replaced by apr_pescape_url() in APR

◆ ap_escape_urlencoded_buffer()

char* ap_escape_urlencoded_buffer	(	char *	c,
		const char *	s
	)

Escape a string as application/x-www-form-urlencoded, to a preallocated buffer

Parameters

c	The preallocated buffer to write to
s	The path to convert

Returns: The converted URL (c)

Deprecated:: Replaced by apr_escape_url() in APR

◆ ap_field_noparam()

char* ap_field_noparam	(	apr_pool_t *	p,
		const char *	intype
	)

Examine a field value (such as a media-/content-type) string and return it sans any parameters; e.g., strip off any ';charset=foo' and the like.

Parameters

p	Pool to allocate memory from
intype	The field to examine

Returns: A copy of the field minus any parameters

◆ ap_find_etag_strong()

int ap_find_etag_strong	(	apr_pool_t *	p,
		const char *	line,
		const char *	tok
	)

Do a strong ETag comparison within an HTTP field value list.

Parameters

p	The pool to allocate from
line	The field value list to search
tok	The token to search for

Returns: 1 if found, 0 if not found.

◆ ap_find_etag_weak()

int ap_find_etag_weak	(	apr_pool_t *	p,
		const char *	line,
		const char *	tok
	)

Do a weak ETag comparison within an HTTP field value list.

Parameters

p	The pool to allocate from
line	The field value list to search
tok	The token to search for

Returns: 1 if found, 0 if not found.

◆ ap_find_last_token()

int ap_find_last_token	(	apr_pool_t *	p,
		const char *	line,
		const char *	tok
	)

find http tokens from the end of the line

Parameters

p	The pool to allocate from
line	The line to find the token
tok	The token to find

Returns: 1 if the token is found, 0 otherwise

◆ ap_find_list_item()

int ap_find_list_item	(	apr_pool_t *	p,
		const char *	line,
		const char *	tok
	)

Find an item in canonical form (lowercase, no extra spaces) within an HTTP field value list.

Parameters

p	The pool to allocate from
line	The field value list to search
tok	The token to search for

Returns: 1 if found, 0 if not found.

◆ ap_find_token()

int ap_find_token	(	apr_pool_t *	p,
		const char *	line,
		const char *	tok
	)

Find http tokens, see the definition of token from RFC2068

Parameters

p	The pool to allocate from
line	The line to find the token
tok	The token to find

Returns: 1 if the token is found, 0 otherwise

◆ ap_get_exec_line()

char* ap_get_exec_line	(	apr_pool_t *	p,
		const char *	cmd,
		const char const	argv
	)

Short function to execute a command and return the first line of output minus \r \n. Useful for "obscuring" passwords via exec calls

Parameters

p	the pool to allocate from
cmd	the command to execute
argv	the arguments to pass to the cmd

Returns: ptr to characters or NULL on any error

◆ ap_get_list_item()

char* ap_get_list_item	(	apr_pool_t *	p,
		const char **	field
	)

Retrieve an HTTP header field list item, as separated by a comma, while stripping insignificant whitespace and lowercasing anything not in a quoted string or comment.

Parameters

p	The pool to allocate from
field	The field to retrieve

Returns: The return value is a new string containing the converted list item (or NULL if none) and the address pointed to by field is shifted to the next non-comma, non-whitespace.

◆ ap_get_loadavg()

void ap_get_loadavg ( ap_loadavg_t * ld )

Get server load averages (ala getloadavg)

Parameters

ld	struct to populate: -1 in fields means error

◆ ap_get_local_host()

char* ap_get_local_host ( apr_pool_t * p )

Determine the local host name for the current machine

Parameters

p	The pool to allocate from

Returns: A copy of the local host name

◆ ap_get_sload()

void ap_get_sload ( ap_sload_t * ld )

Get server load params

Parameters

ld	struct to populate: -1 in fields means error

◆ ap_get_token()

char* ap_get_token	(	apr_pool_t *	p,
		const char **	accept_line,
		int	accept_white
	)

Retrieve a token, spacing over it and adjusting the pointer to the first non-white byte afterwards. Note that these tokens are delimited by semis and commas and can also be delimited by whitespace at the caller's option.

Parameters

p	The pool to allocate from
accept_line	The line to retrieve the token from (adjusted afterwards)
accept_white	Is it delimited by whitespace

Returns: the token

◆ ap_getparents()

void ap_getparents ( char * name )

Remove all ./ and xx/../ substrings from a file name. Also remove any leading ../ or /../ substrings.

Parameters

name	the file name to parse

◆ ap_getword()

char* ap_getword	(	apr_pool_t *	p,
		const char **	line,
		char	stop
	)

Get the characters until the first occurrence of a specified character

Parameters

p	The pool to allocate memory from
line	The string to get the characters from
stop	The character to stop at

Returns: A copy of the characters up to the first stop character

◆ ap_getword_conf()

char* ap_getword_conf	(	apr_pool_t *	p,
		const char **	line
	)

Get the second word in the string paying attention to quoting

Parameters

p	The pool to allocate from
line	The line to traverse

Returns: A copy of the string

◆ ap_getword_conf2()

char* ap_getword_conf2	(	apr_pool_t *	p,
		const char **	line
	)

Get the second word in the string paying attention to quoting, with {...} supported as well as "..." and '...'

Parameters

p	The pool to allocate from
line	The line to traverse

Returns: A copy of the string

◆ ap_getword_conf2_nc()

char* ap_getword_conf2_nc	(	apr_pool_t *	p,
		char **	line
	)

Get the second word in the string paying attention to quoting, with {...} supported as well as "..." and '...'

Parameters

p	The pool to allocate from
line	The line to traverse

Returns: A copy of the string

Note: The same as ap_getword_conf2(), except it doesn't use const char **.

◆ ap_getword_conf_nc()

char* ap_getword_conf_nc	(	apr_pool_t *	p,
		char **	line
	)

Get the second word in the string paying attention to quoting

Parameters

p	The pool to allocate from
line	The line to traverse

Returns: A copy of the string

Note: The same as ap_getword_conf(), except it doesn't use const char **.

◆ ap_getword_nc()

char* ap_getword_nc	(	apr_pool_t *	p,
		char **	line,
		char	stop
	)

Get the characters until the first occurrence of a specified character

Parameters

p	The pool to allocate memory from
line	The string to get the characters from
stop	The character to stop at

Returns: A copy of the characters up to the first stop character

Note: This is the same as ap_getword(), except it doesn't use const char **.

◆ ap_getword_nulls()

char* ap_getword_nulls	(	apr_pool_t *	p,
		const char **	line,
		char	stop
	)

Get all characters from the first occurrence of stop to the first "\0"

Parameters

p	The pool to allocate memory from
line	The line to traverse
stop	The character to start at

Returns: A copy of all characters after the first occurrence of the specified character

◆ ap_getword_nulls_nc()

char* ap_getword_nulls_nc	(	apr_pool_t *	p,
		char **	line,
		char	stop
	)

Get all characters from the first occurrence of stop to the first "\0"

Parameters

p	The pool to allocate memory from
line	The line to traverse
stop	The character to start at

Returns: A copy of all characters after the first occurrence of the specified character

Note: The same as ap_getword_nulls(), except it doesn't use const char **.

◆ ap_getword_white()

char* ap_getword_white	(	apr_pool_t *	p,
		const char **	line
	)

Get the first word from a given string. A word is defined as all characters up to the first whitespace.

Parameters

p	The pool to allocate memory from
line	The string to traverse

Returns: The first word in the line

◆ ap_getword_white_nc()

char* ap_getword_white_nc	(	apr_pool_t *	p,
		char **	line
	)

Get the first word from a given string. A word is defined as all characters up to the first whitespace.

Parameters

p	The pool to allocate memory from
line	The string to traverse

Returns: The first word in the line

Note: The same as ap_getword_white(), except it doesn't use const char**

◆ ap_ht_time()

char* ap_ht_time	(	apr_pool_t *	p,
		apr_time_t	t,
		const char *	fmt,
		int	gmt
	)

Convert a time from an integer into a string in a specified format

Parameters

p	The pool to allocate memory from
t	The time to convert
fmt	The format to use for the conversion
gmt	Convert the time for GMT?

Returns: The string that represents the specified time

◆ ap_ind()

int ap_ind	(	const char *	str,
		char	c
	)

Search a string from left to right for the first occurrence of a specific character

Parameters

str	The string to search
c	The character to search for

Returns: The index of the first occurrence of c in str

◆ ap_is_chunked()

const char const char int ap_is_chunked	(	apr_pool_t *	p,
		const char *	line
	)

Determine if the final Transfer-Encoding is "chunked".

Parameters

p	The pool to allocate from
line	the header field-value to scan

Returns: 1 if the last Transfer-Encoding is "chunked", else 0

◆ ap_is_directory()

int ap_is_directory	(	apr_pool_t *	p,
		const char *	name
	)

Given the name of an object in the file system determine if it is a directory - this version is symlink aware

Parameters

p	The pool to allocate from
name	The name of the object to check

Returns: 1 if it is a directory, 0 otherwise

◆ ap_is_matchexp()

int ap_is_matchexp ( const char * str )

Does the provided string contain wildcard characters? This is useful for determining if the string should be passed to strcmp_match or to strcmp. The only wildcard characters recognized are '?' and '*'

Parameters

str	The string to check

Returns: 1 if the string has wildcards, 0 otherwise

◆ ap_is_rdirectory()

int ap_is_rdirectory	(	apr_pool_t *	p,
		const char *	name
	)

Given the name of an object in the file system determine if it is a directory

Parameters

p	The pool to allocate from
name	The name of the object to check

Returns: 1 if it is a directory, 0 otherwise

◆ ap_is_url()

int ap_is_url ( const char * u )

Check for an Absolute URI syntax

Parameters

u	The string to check

Returns: 1 if URI, 0 otherwise

◆ ap_log_assert()

void ap_log_assert	(	const char *	szExp,
		const char *	szFile,
		int	nLine
	)

Log an assertion to the error log

Parameters

szExp	The assertion that failed
szFile	The file the assertion is in
nLine	The line the assertion is defined on

◆ ap_make_dirstr_parent()

char* ap_make_dirstr_parent	(	apr_pool_t *	p,
		const char *	s
	)

Return the parent directory name (including trailing /) of the file s

Parameters

p	The pool to allocate from
s	The file to get the parent of

Returns: A copy of the file's parent directory

◆ ap_make_dirstr_prefix()

char* ap_make_dirstr_prefix	(	char *	d,
		const char *	s,
		int	n
	)

Copy at most n leading directories of s into d. d should be at least as large as s plus 1 extra byte

Parameters

d	The location to copy to
s	The location to copy from
n	The number of directories to copy

Returns: value is the ever useful pointer to the trailing "\0" of d

Note: on platforms with drive letters, n = 0 returns the "/" root, whereas n = 1 returns the "d:/" root. On all other platforms, n = 0 returns the empty string.

◆ ap_make_full_path()

char* ap_make_full_path	(	apr_pool_t *	a,
		const char *	dir,
		const char *	f
	)

Given a directory and filename, create a single path from them. This function is smart enough to ensure that there is a single '/' between the directory and file names

Parameters

a	The pool to allocate from
dir	The directory name
f	The filename

Returns: A copy of the full path, with one byte of extra space after the NUL to allow the caller to add a trailing '/'.

Note: Never consider using this function if you are dealing with filesystem names that need to remain canonical, unless you are merging an apr_dir_read path and returned filename. Otherwise, the result is not canonical.

◆ ap_malloc()

void* ap_malloc ( size_t size )

Wrapper for malloc() that calls ap_abort_on_oom() if out of memory

Parameters

size	size of the memory block

Returns: pointer to the allocated memory

Note: ap_malloc may be implemented as a macro

◆ ap_no2slash()

void ap_no2slash ( char * name )

Convert all double slashes to single slashes, except where significant to the filesystem on the current platform.

Parameters

name	The string to convert, assumed to be a filesystem path

◆ ap_no2slash_ex()

void ap_no2slash_ex	(	char *	name,
		int	is_fs_path
	)

Convert all double slashes to single slashes, except where significant to the filesystem on the current platform.

Parameters

name	The string to convert
is_fs_path	if set to 0, the significance of any double-slashes is ignored.

◆ ap_normalize_path()

int ap_normalize_path	(	char *	path,
		unsigned int	flags
	)

Remove all ////, /./ and /xx/../ substrings from a path, and more depending on passed in flags.

Parameters

path	The path to normalize
flags	bitmask of AP_NORMALIZE_* flags

Returns: non-zero on success

◆ ap_os_escape_path()

char* ap_os_escape_path	(	apr_pool_t *	p,
		const char *	path,
		int	partial
	)

convert an OS path to a URL in an OS dependent way.

Parameters

p	The pool to allocate from
path	The path to convert
partial	if set, assume that the path will be appended to something with a '/' in it (and thus does not prefix "./").

Returns: The converted URL, with one byte of extra space after the NUL to allow the caller to add a trailing '/'.

Deprecated:: Replaced by apr_pescape_path() in APR

◆ ap_os_is_path_absolute()

int ap_os_is_path_absolute	(	apr_pool_t *	p,
		const char *	dir
	)

Test if the given path has an absolute path.

Parameters

p	The pool to allocate from
dir	The directory name

Note: The converse is not necessarily true, some OS's (Win32/OS2/Netware) have multiple forms of absolute paths. This only reports if the path is absolute in a canonical sense.

◆ ap_palloc_debug()

void* ap_palloc_debug	(	apr_pool_t *	p,
		apr_size_t	size
	)

◆ ap_parse_form_data()

int ap_parse_form_data	(	request_rec *	r,
		struct ap_filter_t *	f,
		apr_array_header_t **	ptr,
		apr_size_t	num,
		apr_size_t	size
	)

Read the body and parse any form found, which must be of the type application/x-www-form-urlencoded.

Parameters

r	request containing POSTed form data
f	filter
ptr	returned array of ap_form_pair_t
num	max num of params or -1 for unlimited
size	max size allowed for parsed data

Returns: OK or HTTP error

◆ ap_parse_strict_length()

int ap_parse_strict_length	(	apr_off_t *	len,
		const char *	str
	)

Parse a length string with decimal characters only, no leading sign nor trailing character, like Content-Length or (Content-)Range headers.

Parameters

len	The parsed length (apr_off_t)
str	The string to parse

Returns: 1 (success), 0 (failure)

◆ ap_parse_token_list_strict()

const char* ap_parse_token_list_strict	(	apr_pool_t *	p,
		const char *	tok,
		apr_array_header_t **	tokens,
		int	skip_invalid
	)

Retrieve an array of tokens in the format "1#token" defined in RFC2616. Only accepts ',' as a delimiter, does not accept quoted strings, and errors on any separator.

Parameters

p	The pool to allocate from
tok	The line to read tokens from
tokens	Pointer to an array of tokens. If not NULL, must be an array of char*, otherwise it will be allocated on p when a token is found
skip_invalid	If true, when an invalid separator is encountered, it will be ignored.

Returns: NULL on success, an error string otherwise.

Remarks: *tokens may be NULL on output if NULL in input and no token is found

◆ ap_password_validate()

apr_status_t ap_password_validate	(	request_rec *	r,
		const char *	username,
		const char *	passwd,
		const char *	hash
	)

Wrapper for apr_password_validate() to cache expensive calculations

Parameters

r	the current request
username	username of the user
passwd	password string
hash	hash string to be passwd to apr_password_validate()

Returns: APR_SUCCESS if passwords match, APR_EMISMATCH or error otherwise

Note: Currently, ap_password_validate() only caches the result of the most recent call with the same connection as r. In the future, it may also do rate-limiting against brute-force attacks.

◆ ap_pbase64decode()

char* ap_pbase64decode	(	apr_pool_t *	p,
		const char *	bufcoded
	)

Decode a base64 encoded string into memory allocated from a pool

Parameters

p	The pool to allocate from
bufcoded	The encoded string

Returns: The decoded string

Deprecated:: Replaced by apr_pbase64_decode() in APR.

◆ ap_pbase64decode_strict()

apr_status_t ap_pbase64decode_strict	(	apr_pool_t *	p,
		const char *	encoded,
		char **	decoded,
		apr_size_t *	len
	)

Decode a base64 encoded string into memory allocated from a pool, while ensuring that the input string is in fact valid base64.

Unlike ap_pbase64decode(), this function allows encoded NULLs in the input to be retained by the caller, by inspecting the len argument after the call instead of using strlen(). A NULL terminator is still appended to the buffer to facilitate string use (it is not included in len).

Parameters

p	The pool to allocate from
encoded	The encoded string
decoded	On success, set to the decoded buffer, which is allocated from p
len	On success, set to the length of the decoded buffer (not including the terminating NULL byte)

Returns: APR_SUCCESS if the decoding was successful

◆ ap_pbase64encode()

char* ap_pbase64encode	(	apr_pool_t *	p,
		char *	string
	)

Encode a string into memory allocated from a pool in base 64 format

Parameters

p	The pool to allocate from
string	The plaintext string

Returns: The encoded string

Deprecated:: Replaced by apr_pbase64_encode() in APR.

◆ ap_pcalloc_debug()

void* ap_pcalloc_debug	(	apr_pool_t *	p,
		apr_size_t	size
	)

◆ ap_pregcomp()

ap_regex_t* ap_pregcomp	(	apr_pool_t *	p,
		const char *	pattern,
		int	cflags
	)

Compile a regular expression to be used later. The regex is freed when the pool is destroyed.

Parameters

p	The pool to allocate from
pattern	the regular expression to compile
cflags	The bitwise or of one or more of the following: REG_EXTENDED - Use POSIX extended Regular Expressions REG_ICASE - Ignore case REG_NOSUB - Support for substring addressing of matches not required REG_NEWLINE - Match-any-character operators don't match new-line

Returns: The compiled regular expression

◆ ap_pregfree()

void ap_pregfree	(	apr_pool_t *	p,
		ap_regex_t *	reg
	)

Free the memory associated with a compiled regular expression

Parameters

p	The pool the regex was allocated from
reg	The regular expression to free

Note: This function is only necessary if the regex should be cleaned up before the pool

◆ ap_pregsub()

char* ap_pregsub	(	apr_pool_t *	p,
		const char *	input,
		const char *	source,
		apr_size_t	nmatch,
		ap_regmatch_t	pmatch[]
	)

After performing a successful regex match, you may use this function to perform a series of string substitutions based on subexpressions that were matched during the call to ap_regexec. This function is limited to result strings of 64K. Consider using ap_pregsub_ex() instead.

Parameters

p	The pool to allocate from
input	An arbitrary string containing $1 through $9. These are replaced with the corresponding matched sub-expressions
source	The string that was originally matched to the regex
nmatch	the nmatch returned from ap_pregex
pmatch	the pmatch array returned from ap_pregex

Returns: The substituted string, or NULL on error

◆ ap_pregsub_ex()

apr_status_t ap_pregsub_ex	(	apr_pool_t *	p,
		char **	result,
		const char *	input,
		const char *	source,
		apr_size_t	nmatch,
		ap_regmatch_t	pmatch[],
		apr_size_t	maxlen
	)

After performing a successful regex match, you may use this function to perform a series of string substitutions based on subexpressions that were matched during the call to ap_regexec

Parameters

p	The pool to allocate from
result	where to store the result, will be set to NULL on error
input	An arbitrary string containing $1 through $9. These are replaced with the corresponding matched sub-expressions
source	The string that was originally matched to the regex
nmatch	the nmatch returned from ap_pregex
pmatch	the pmatch array returned from ap_pregex
maxlen	the maximum string length to return, 0 for unlimited

Returns: APR_SUCCESS if successful, APR_ENOMEM or other error code otherwise.

◆ ap_psignature()

const char* ap_psignature	(	const char *	prefix,
		request_rec *	r
	)

Get HTML describing the address and (optionally) admin of the server.

Parameters

prefix	Text which is prepended to the return value
r	The request_rec

Returns: HTML describing the server, allocated in r's pool.

◆ ap_pstr2_alnum()

apr_status_t ap_pstr2_alnum	(	apr_pool_t *	p,
		const char *	src,
		const char **	dest
	)

Cleanup a string (mainly to be filesystem safe) We only allow '_' and alphanumeric chars. Non-printable map to 'x' and all others map to '_'

Parameters

p	pool to use to allocate dest
src	string to clean up
dest	cleaned up, allocated string

Returns: Status value indicating whether the cleaning was successful or not.

◆ ap_random_insecure_bytes()

void ap_random_insecure_bytes	(	void *	buf,
		apr_size_t	size
	)

Generate pseudo random bytes. This is a convenience interface to apr_random. It is cheaper but less secure than apr_generate_random_bytes().

Parameters

buf	where to store the bytes
size	number of bytes to generate

Note: ap_random_insecure_bytes() is thread-safe, it uses a mutex on threaded MPMs.

◆ ap_random_pick()

apr_uint32_t ap_random_pick	(	apr_uint32_t	min,
		apr_uint32_t	max
	)

Get a pseudo random number in a range.

Parameters

min	low end of range
max	high end of range

Returns: a number in the range

◆ ap_realloc()

void void* ap_realloc	(	void *	ptr,
		size_t	size
	)

Wrapper for realloc() that calls ap_abort_on_oom() if out of memory

Parameters

ptr	pointer to the old memory block (or NULL)
size	new size of the memory block

Returns: pointer to the reallocated memory

Note: ap_realloc may be implemented as a macro

◆ ap_request_has_body()

int ap_request_has_body ( request_rec * r )

Determine if a request has a request body or not.

Parameters

r	the request_rec of the request

Returns: truth value

◆ ap_request_tainted()

int ap_request_tainted	(	request_rec *	r,
		int	flags
	)

Check whether a request is tainted by potentially-untrusted sources.

Parameters

r	the request
flags	Taint flags to check

Returns: truth value

◆ ap_resolve_env()

const char* ap_resolve_env	(	apr_pool_t *	p,
		const char *	word
	)

Check a string for any config define or environment variable construct and replace each of them by the value of that variable, if it exists. The default syntax of the constructs is ${ENV} but can be changed by setting the define::* config defines. If the variable does not exist, leave the ${ENV} construct alone but print a warning.

Parameters

p	The pool to allocate from
word	The string to check

Returns: The string with the replaced environment variables

◆ ap_rind()

int ap_rind	(	const char *	str,
		char	c
	)

Search a string from right to left for the first occurrence of a specific character

Parameters

str	The string to search
c	The character to search for

Returns: The index of the first occurrence of c in str

◆ ap_scan_http_field_content()

const char* ap_scan_http_field_content ( const char * ptr )

◆ ap_scan_http_token()

const char* ap_scan_http_token ( const char * ptr )

◆ ap_scan_vchar_obstext()

const char* ap_scan_vchar_obstext ( const char * ptr )

◆ ap_set_context_info()

void ap_set_context_info	(	request_rec *	r,
		const char *	prefix,
		const char *	document_root
	)

Set context_prefix and context_document_root for a request.

Parameters

r	The request
prefix	the URI prefix, without trailing slash
document_root	the corresponding directory on disk, without trailing slash

Note: If one of prefix of document_root is NULL, the corrsponding property will not be changed.

◆ ap_set_document_root()

void ap_set_document_root	(	request_rec *	r,
		const char *	document_root
	)

Set per-request document root. This is for mass virtual hosting modules that want to provide the correct DOCUMENT_ROOT value to scripts.

Parameters

r	The request
document_root	the document root for the request.

◆ ap_size_list_item()

const char* ap_size_list_item	(	const char **	field,
		int *	len
	)

Size an HTTP header field list item, as separated by a comma.

Parameters

field	The field to size
len	The length of the field

Returns: The return value is a pointer to the beginning of the non-empty list item within the original string (or NULL if there is none) and the address of field is shifted to the next non-comma, non-whitespace character. len is the length of the item excluding any beginning whitespace.

◆ ap_str2_alnum()

apr_status_t ap_str2_alnum	(	const char *	src,
		char *	dest
	)

Cleanup a string (mainly to be filesystem safe) We only allow '_' and alphanumeric chars. Non-printable map to 'x' and all others map to '_'

Parameters

src	string to clean up
dest	cleaned up, pre-allocated string

Returns: Status value indicating whether the cleaning was successful or not.

◆ ap_str_tolower()

void ap_str_tolower ( char * s )

convert a string to all lowercase

Parameters

s	The string to convert to lowercase

◆ ap_str_toupper()

void ap_str_toupper ( char * s )

convert a string to all uppercase

Parameters

s	The string to convert to uppercase

◆ ap_strcasecmp_match()

int ap_strcasecmp_match	(	const char *	str,
		const char *	expected
	)

Determine if a string matches a pattern containing the wildcards '?' or '*', ignoring case

Parameters

str	The string to check
expected	The pattern to match against

Returns: 0 if the two strings match, 1 otherwise

◆ ap_strcasestr()

char* ap_strcasestr	(	const char *	s1,
		const char *	s2
	)

Find the first occurrence of the substring s2 in s1, regardless of case

Parameters

s1	The string to search
s2	The substring to search for

Returns: A pointer to the beginning of the substring

Remarks: See apr_strmatch() for a faster alternative

◆ ap_strchr()

char* ap_strchr	(	char *	s,
		int	c
	)

◆ ap_strchr_c()

const char* ap_strchr_c	(	const char *	s,
		int	c
	)

◆ ap_strcmp_match()

int ap_strcmp_match	(	const char *	str,
		const char *	expected
	)

Determine if a string matches a pattern containing the wildcards '?' or '*'

Parameters

str	The string to check
expected	The pattern to match against

Returns: 0 if the two strings match, 1 otherwise

◆ ap_stripprefix()

const char* ap_stripprefix	(	const char *	bigstring,
		const char *	prefix
	)

Return a pointer to the location inside of bigstring immediately after prefix

Parameters

bigstring	The input string
prefix	The prefix to strip away

Returns: A pointer relative to bigstring after prefix

◆ ap_strrchr()

char* ap_strrchr	(	char *	s,
		int	c
	)

◆ ap_strrchr_c()

const char* ap_strrchr_c	(	const char *	s,
		int	c
	)

◆ ap_strstr()

char* ap_strstr	(	char *	s,
		const char *	c
	)

◆ ap_strstr_c()

const char* ap_strstr_c	(	const char *	s,
		const char *	c
	)

◆ ap_thread_create()

apr_status_t ap_thread_create	(	apr_thread_t **	thread,
		apr_threadattr_t *	attr,
		apr_thread_start_t	func,
		void *	data,
		apr_pool_t *	pool
	)

◆ ap_thread_current()

apr_thread_t* ap_thread_current ( void )

◆ ap_thread_current_after_fork()

void ap_thread_current_after_fork ( void )

◆ ap_thread_current_create()

apr_status_t ap_thread_current_create	(	apr_thread_t **	current,
		apr_threadattr_t *	attr,
		apr_pool_t *	pool
	)

AP_THREAD_LOCAL keyword aliases the compiler's.

◆ ap_thread_main_create()

apr_status_t ap_thread_main_create	(	apr_thread_t **	thread,
		apr_pool_t *	pool
	)

◆ ap_timeout_parameter_parse()

apr_status_t ap_timeout_parameter_parse	(	const char *	timeout_parameter,
		apr_interval_time_t *	timeout,
		const char *	default_time_unit
	)

Parse a given timeout parameter string into an apr_interval_time_t value. The unit of the time interval is given as postfix string to the numeric string. Currently the following units are understood (case insensitive):

ms : milliseconds s : seconds mi[n] : minutes h : hours

If no unit is contained in the given timeout parameter the default_time_unit will be used instead.

Parameters

timeout_parameter	The string containing the timeout parameter.
timeout	The timeout value to be returned.
default_time_unit	The default time unit to use if none is specified in timeout_parameter.

Returns: Status value indicating whether the parsing was successful or not.

◆ ap_unescape_all()

int ap_unescape_all ( char * url )

Unescape a string

Parameters

url	The string to unescape

Returns: 0 on success, non-zero otherwise

◆ ap_unescape_url()

int ap_unescape_url ( char * url )

Unescape a URL

Parameters

url	The url to unescape

Returns: 0 on success, non-zero otherwise

Deprecated:: Replaced by apr_unescape_url() in APR

◆ ap_unescape_url_ex()

int ap_unescape_url_ex	(	char *	url,
		unsigned int	flags
	)

Unescape a URL, with options

Parameters

url	The url to unescape
flags	Bitmask of AP_UNESCAPE_URL_* flags

Returns: 0 on success, non-zero otherwise

◆ ap_unescape_url_keep2f()

int ap_unescape_url_keep2f	(	char *	url,
		int	decode_slashes
	)

Unescape a URL, but leaving %2f (slashes) escaped

Parameters

url	The url to unescape
decode_slashes	Whether or not slashes should be decoded

Returns: 0 on success, non-zero otherwise

Deprecated:: Replaced by apr_unescape_url() in APR

◆ ap_unescape_urlencoded()

int ap_unescape_urlencoded ( char * query )

Unescape an application/x-www-form-urlencoded string

Parameters

query The query to unescape

Returns: 0 on success, non-zero otherwise

Deprecated:: Replaced by apr_unescape_url() in APR

Modules

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ ap_assert

◆ AP_DEBUG_ASSERT

◆ AP_DIR_FLAG_NONE

◆ AP_DIR_FLAG_OPTIONAL

◆ AP_DIR_FLAG_RECURSIVE

◆ ap_escape_html

◆ ap_escape_uri

◆ AP_HAS_THREAD_LOCAL

◆ AP_NORESTART

◆ AP_NORMALIZE_ALLOW_RELATIVE

◆ AP_NORMALIZE_DECODE_UNRESERVED

◆ AP_NORMALIZE_DROP_PARAMETERS

◆ AP_NORMALIZE_MERGE_SLASHES

◆ AP_NORMALIZE_NOT_ABOVE_ROOT

◆ ap_strchr

◆ ap_strchr_c

◆ ap_strrchr

◆ ap_strrchr_c

◆ ap_strstr

◆ ap_strstr_c

◆ AP_TAINT_HTACCESS

◆ AP_UNESCAPE_URL_FORBID_SLASHES

◆ AP_UNESCAPE_URL_KEEP_SLASHES

◆ AP_UNESCAPE_URL_KEEP_UNRESERVED

◆ DEFAULT_VHOST_ADDR

◆ PROXYREQ_NONE

◆ PROXYREQ_PROXY

◆ PROXYREQ_RESPONSE

◆ PROXYREQ_REVERSE

Typedef Documentation

◆ ap_dir_match_t

◆ ap_loadavg_t

◆ ap_sload_t

◆ server_addr_rec

Enumeration Type Documentation

◆ ap_conn_keepalive_e

◆ conn_sense_e

◆ conn_state_e

Function Documentation

◆ ap_abort_on_oom()

◆ ap_append_pid()

◆ ap_array_str_contains()

◆ ap_array_str_index()

◆ ap_bin2hex()

◆ ap_calloc()

◆ ap_construct_server()

◆ ap_content_type_tolower()

◆ ap_context_document_root()

◆ ap_context_prefix()

◆ ap_count_dirs()

◆ ap_cstr_casecmp()

◆ ap_cstr_casecmpn()

◆ ap_dir_fnmatch()

◆ ap_dir_nofnmatch()

◆ ap_escape_errorlog_item()

◆ ap_escape_html2()

◆ ap_escape_logitem()

◆ ap_escape_path_segment()

◆ ap_escape_path_segment_buffer()

◆ ap_escape_quotes()

◆ ap_escape_shell_cmd()

◆ ap_escape_urlencoded()

◆ ap_escape_urlencoded_buffer()

◆ ap_field_noparam()

◆ ap_find_etag_strong()

◆ ap_find_etag_weak()

◆ ap_find_last_token()

◆ ap_find_list_item()

◆ ap_find_token()

◆ ap_get_exec_line()

◆ ap_get_list_item()

◆ ap_get_loadavg()