[Apache]

Package Name: CORE HTTP Daemon

struct require_line

method_mask
requirement

struct require_line


Source:	./include/http_core.h

A structure to keep track of authorization requirements

Member Index

Class Variables

apr_int64_t method_mask;
Where the require line is in the config file.

char *requirement;
The complete string from the command line

Global Functions

(void);
Install a custom response handler for a given status

Parameters

r The current request

status The status for which the custom response should be used

string The custom response. This can be a static string, a file or a URL

(apr_size_t);
Reserve an element in the core_request_config->notes array for some application-specific data

Return Value
An integer key that can be passed to ap_get_request_note() during request processing to access this element for the current request.

(void **);
Retrieve a pointer to an element in the core_request_config->notes array @remark At the start of a request, each note element is NULL. The handle provided by ap_get_request_note() is a pointer-to-pointer so that the caller can point the element to some app-specific data structure. The caller should guarantee that any such structure will last as long as the request itself.

Parameters

r The request

note_num A key for the element: either a value obtained from ap_register_request_note() or one of the predefined AP_NOTE_* values.

Return Value
NULL if the note_num is invalid, otherwise a pointer to the requested note element.

(int, get_mgmt_items, (apr_pool_t *p, const char * val, apr_hash_t *ht));
This hook provdes a way for modules to provide metrics/statistics about their operational status. @ingroup hooks

Parameters

p A pool to use to create entries in the hash table

val The name of the parameter(s) that is wanted. This is tree-structured would be in the form ('*' is all the tree, 'module.*' all of the module , 'module.foo.*', or 'module.foo.bar' )

ht The hash table to store the results. Keys are item names, and the values point to ap_mgmt_item_t structures.

apr_off_tap_get_limit_req_body(const request_rec *r);
Return the limit on bytes in request msg body

Parameters

r The current request

Return Value
the maximum number of bytes in the request msg body

apr_port_tap_get_server_port(const request_rec *r);
Get the current server port

Parameters

The current request

Return Value
The server's port

char*ap_construct_url(apr_pool_t *p, const char *uri, request_rec *r);
build a fully qualified URL from the uri and information in the request rec

Parameters

p The pool to allocate the URL from

uri The path to the requested file

r The current request

Return Value
A fully qualified URL

constchar *ap_default_type(request_rec *r);
Retrieve the value of the DefaultType directive, or text/plain if not set

Parameters

r The current request

Return Value
The default type

constchar *ap_document_root(request_rec *r);
Retrieve the document root for this server
Don't use this! If your request went through a Userdir, or something like that, it'll screw you. But it's back-compatible...

Parameters

r The current request

Return Value
The document root
constchar *ap_get_remote_host(conn_rec *conn, void *dir_config, int type, int *str_is_ip);
Lookup the remote client's DNS name or IP address
Parameters
conn The current connection

dir_config The directory config vector from the request
type
The type of lookup to perform. One of:
    REMOTE_HOST returns the hostname, or NULL if the hostname
                lookup fails.  It will force a DNS lookup according to the
                HostnameLookups setting.
    REMOTE_NAME returns the hostname, or the dotted quad if the
                hostname lookup fails.  It will force a DNS lookup according
                to the HostnameLookups setting.
    REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is
                    never forced.
    REMOTE_DOUBLE_REV will always force a DNS lookup, and also force
                  a double reverse lookup, regardless of the HostnameLookups
                  setting.  The result is the (double reverse checked) 
                  hostname, or NULL if any of the lookups fail.
str_is_ip unless NULL is passed, this will be set to non-zero on output when an IP address string is returned
Return Value
The remote hostname
constchar *ap_get_remote_logname(request_rec *r);
Retrieve the login name of the remote user. Undef if it could not be determined

Parameters

r The current request

Return Value
The user logged in to the client machine

constchar *ap_get_server_name(request_rec *r);
Get the current server name from the request

Parameters

r The current request

Return Value
the server name

constchar *ap_auth_type(request_rec *r);
Return the type of authorization required for this request

Parameters

r The current request

Return Value
The authorization required

constchar *ap_auth_name(request_rec *r);
Return the current Authorization realm

Parameters

r The current request

Return Value
The current authorization realm

constapr_array_header_t *ap_requires(request_rec *r);
Retrieve information about all of the requires directives for this request

Parameters

r The current request

Return Value
An array of all requires directives for this request
intap_satisfies(request_rec *r);
How the requires lines must be met.
Parameters

r The current request

Return Value
How the requirements must be met. One of:
     SATISFY_ANY    -- any of the requirements must be met.
     SATISFY_ALL    -- all of the requirements must be met.
     SATISFY_NOSPEC -- There are no applicable satisfy lines
intap_allow_options(request_rec *r);
Retrieve the value of Options for this request

Parameters

r The current request

Return Value
the Options bitmask

intap_allow_overrides(request_rec *r);
Retrieve the value of the AllowOverride for this request

Parameters

r The current request

Return Value
the overrides bitmask

intap_is_recursion_limit_exceeded(const request_rec *r);
Check if the current request is beyond the configured max. number of redirects or subrequests

Parameters

r The current request

Return Value
true (is exceeded) or false

intap_exists_config_define(const char *name);
Check for a definition from the server command line

Parameters

name The define to check for

Return Value
1 if defined, 0 otherwise

size_tap_get_limit_xml_body(const request_rec *r);
Return the limit on bytes in XML request msg body

Parameters

r The current request

Return Value
the maximum number of bytes in XML request msg body

r	The current request
status	The status for which the custom response should be used
string	The custom response. This can be a static string, a file or a URL

r	The request
note_num	A key for the element: either a value obtained from ap_register_request_note() or one of the predefined AP_NOTE_* values.

p	A pool to use to create entries in the hash table
val	The name of the parameter(s) that is wanted. This is tree-structured would be in the form ('' is all the tree, 'module.' all of the module , 'module.foo.*', or 'module.foo.bar' )
ht	The hash table to store the results. Keys are item names, and the values point to ap_mgmt_item_t structures.

p	The pool to allocate the URL from
uri	The path to the requested file
r	The current request

conn	The current connection
dir_config	The directory config vector from the request
type	The type of lookup to perform. One of: REMOTE_HOST returns the hostname, or NULL if the hostname lookup fails. It will force a DNS lookup according to the HostnameLookups setting. REMOTE_NAME returns the hostname, or the dotted quad if the hostname lookup fails. It will force a DNS lookup according to the HostnameLookups setting. REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is never forced. REMOTE_DOUBLE_REV will always force a DNS lookup, and also force a double reverse lookup, regardless of the HostnameLookups setting. The result is the (double reverse checked) hostname, or NULL if any of the lookups fail.
str_is_ip	unless NULL is passed, this will be set to non-zero on output when an IP address string is returned