http_core.h revision fec106c7688e279dfde4403bc3c935fec97c1d62
2N/A/* Licensed to the Apache Software Foundation (ASF) under one or more 2N/A * contributor license agreements. See the NOTICE file distributed with 2N/A * this work for additional information regarding copyright ownership. 2N/A * The ASF licenses this file to You under the Apache License, Version 2.0 2N/A * (the "License"); you may not use this file except in compliance with 2N/A * the License. You may obtain a copy of the License at 2N/A * Unless required by applicable law or agreed to in writing, software 2N/A * distributed under the License is distributed on an "AS IS" BASIS, 2N/A * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 2N/A * See the License for the specific language governing permissions and 2N/A * limitations under the License. 2N/A * @brief CORE HTTP Daemon 700N/A * @defgroup APACHE_CORE_HTTPD Core HTTP Daemon 2N/A * @ingroup APACHE_CORE 26N/A/* **************************************************************** 26N/A * The most basic server code is encapsulated in a single module 26N/A * known as the core, which is just *barely* functional enough to 700N/A * serve documents, though not terribly well. 26N/A * Largely for NCSA back-compatibility reasons, the core needs to 26N/A * make pieces of its config structures available to other modules. 26N/A * The accessors are declared here, along with the interpretation 26N/A * of one of them (allow_options). 26N/A * @defgroup APACHE_CORE_HTTPD_ACESSORS Acessors 26N/A/** No directives */ 26N/A/** Indexes directive */ 26N/A/** SSI is enabled without exec= permission */ 26N/A/** FollowSymLinks directive */ 586N/A/** ExecCGI directive */ 93N/A/** directive unset */ 26N/A/** SSI exec= permission is permitted, iff OPT_INCLUDES is also set */ 379N/A/** SymLinksIfOwnerMatch directive */ 26N/A/** MultiViews directive */ 12N/A * @defgroup get_remote_host Remote Host Resolution 30N/A * @ingroup APACHE_CORE_HTTPD 26N/A/** REMOTE_HOST returns the hostname, or NULL if the hostname 2N/A * lookup fails. It will force a DNS lookup according to the 26N/A * HostnameLookups setting. 2N/A/** REMOTE_NAME returns the hostname, or the dotted quad if the 255N/A * hostname lookup fails. It will force a DNS lookup according 145N/A * to the HostnameLookups setting. 38N/A/** REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is 197N/A/** REMOTE_DOUBLE_REV will always force a DNS lookup, and also force 197N/A * a double reverse lookup, regardless of the HostnameLookups 26N/A * setting. The result is the (double reverse checked) hostname, 30N/A * or NULL if any of the lookups fail. 46N/A/** @} // get_remote_host */ 64N/A/** all of the requirements must be met */ 46N/A/** any of the requirements must be met */ 46N/A/** There are no applicable satisfy lines */ 369N/A/** Make sure we don't write less than 8000 bytes at any one time. 26N/A/** default maximum of internal redirects */ 181N/A/** default maximum subrequest nesting level */ 181N/A * Retrieve the value of Options for this request 181N/A * @param r The current request 76N/A * @return the Options bitmask 185N/A * Retrieve the value of the AllowOverride for this request 185N/A * @param r The current request 185N/A * @return the overrides bitmask 145N/A * Retrieve the document root for this server 117N/A * @param r The current request 84N/A * @warning Don't use this! If your request went through a Userdir, or 145N/A * something like that, it'll screw you. But it's back-compatible... 145N/A * @return The document root 99N/A * Lookup the remote client's DNS name or IP address 196N/A * @ingroup get_remote_host 185N/A * @param conn The current connection 99N/A * @param dir_config The directory config vector from the request 46N/A * @param type The type of lookup to perform. One of: 145N/A * REMOTE_HOST returns the hostname, or NULL if the hostname 26N/A * lookup fails. It will force a DNS lookup according to the 2N/A * HostnameLookups setting. 32N/A * REMOTE_NAME returns the hostname, or the dotted quad if the 32N/A * hostname lookup fails. It will force a DNS lookup according 32N/A * to the HostnameLookups setting. 32N/A * REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is 32N/A * REMOTE_DOUBLE_REV will always force a DNS lookup, and also force 32N/A * a double reverse lookup, regardless of the HostnameLookups 32N/A * setting. The result is the (double reverse checked) 32N/A * hostname, or NULL if any of the lookups fail. 38N/A * @param str_is_ip unless NULL is passed, this will be set to non-zero on output when an IP address 38N/A * string is returned 38N/A * @return The remote hostname 38N/A * Retrieve the login name of the remote user. Undef if it could not be 38N/A * @param r The current request 145N/A * @return The user logged in to the client machine 26N/A/* Used for constructing self-referencing URLs, and things like SERVER_PORT, 26N/A * build a fully qualified URL from the uri and information in the request rec 26N/A * @param p The pool to allocate the URL from 26N/A * @param uri The path to the requested file 26N/A * @param r The current request 32N/A * @return A fully qualified URL 32N/A * Get the current server name from the request 32N/A * @param r The current request 32N/A * @return the server name * Get the current server name from the request for the purposes * of using in a URL. If the server name is an IPv6 literal * address, it will be returned in URL format (e.g., "[fe80::1]"). * @param r The current request * @return the server name * Get the current server port * @param r The current request * @return The server's port * Return the limit on bytes in request msg body * @param r The current request * @return the maximum number of bytes in the request msg body * Return the limit on bytes in XML request msg body * @param r The current request * @return the maximum number of bytes in XML request msg body * Install a custom response handler for a given status * @param r The current request * @param status The status for which the custom response should be used * @param string The custom response. This can be a static string, a file * Check if the current request is beyond the configured max. number of redirects or subrequests * @param r The current request * @return true (is exceeded) or false * Check for a definition from the server command line * @param name The define to check for * @return 1 if defined, 0 otherwise /* FIXME! See STATUS about how */ /* Authentication stuff. This is one of the places where compatibility * with the old config files *really* hurts; they don't discriminate at * all between different authentication schemes, meaning that we need * to maintain common state for all of them in the core, and make it * available to the other modules through interfaces. * @brief A structure to keep track of authorization requirements /** Where the require line is in the config file. */ /** The complete string from the command line */ * Return the type of authorization required for this request * @param r The current request * @return The authorization required * Return the current Authorization realm * @param r The current request * @return The current authorization realm * How the requires lines must be met. * @param r The current request * @return 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 * Core is also unlike other modules in being implemented in more than * one file... so, data structures are declared here, even though most of * the code that cares really is in http_core.c. Also, another accessor. * Accessor for core_module's specific data. Equivalent to * ap_get_module_config(cv, &core_module) but more efficient. * @param cv The vector in which the modules configuration is stored. * usually r->per_dir_config or s->module_config * @return The module-specific data * Accessor to set core_module's specific data. Equivalent to * ap_set_module_config(cv, &core_module, val) but more efficient. * @param cv The vector in which the modules configuration is stored. * usually r->per_dir_config or s->module_config * @param val The module-specific data to set /** Get the socket from the core network filter. This should be used instead of * accessing the core connection config directly. * @param c The connection record * @brief Per-request configuration /** bucket brigade used by getline for look-ahead and * ap_get_client_block for holding left-over request body */ /** an array of per-request working data elements, accessed * by ID using ap_get_request_note() * (Use ap_register_request_note() during initialization /** Custom response strings registered via ap_custom_response(), * or NULL; check per-dir config if nothing found here /** per-request document root of the server. This allows mass vhosting * modules better compatibility with some scripts. Normally the * context_* info should be used instead */ * more fine-grained context information which is set by modules like * mod_alias and mod_userdir /** the context root directory on disk for the current resource, /** the URI prefix that corresponds to the context_document_root directory, /** There is a script processor installed on the output filter chain, * so it needs the default_handler to deliver a (script) file into * the chain so it can process it. Normally, default_handler only * serves files on a GET request (assuming the file is actual content), * since other methods are not content-retrieval. This flag overrides * that behavior, stating that the "content" is actually a script and * won't actually be delivered as the response for the non-GET method. /** Should addition of charset= be suppressed for this request? /* Standard entries that are guaranteed to be accessible via * ap_get_request_note() for each request (additional entries * can be added with ap_register_request_note()) * Reserve an element in the core_request_config->notes array * for some application-specific data * @return An integer key that can be passed to ap_get_request_note() * during request processing to access this element for the * Retrieve a pointer to an element in the core_request_config->notes array * @param note_num A key for the element: either a value obtained from * ap_register_request_note() or one of the predefined AP_NOTE_* * @return NULL if the note_num is invalid, otherwise a pointer to the * requested note element. * @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. * Bits of info that go into making an ETag for a file * document. Why a long? Because char historically * proved too short for Options, and int can be different * sizes on different platforms. /* This is the default value used */ * @brief Server Signature Enumeration * @brief Per-directory configuration /** the number of slashes in d */ /** If (opts & OPT_UNSET) then no absolute assignment to options has * invariant: (opts_add & opts_remove) == 0 * Which said another way means that the last relative (options + or -) * assignment made to each bit is recorded in exactly one of opts_add /* Custom response config. These can contain text or a URL to redirect to. * if response_code_strings is NULL then there are none in the config, * if it's not null then it's allocated to sizeof(char*)*RESPONSE_CODES. * This lets us do quick merges in merge_core_dir_configs(). * ap_custom_response() */ /* Hostname resolution etc */ unsigned int content_md5 :
2;
/* calculate Content-MD5? */ /* since is_fnmatch(conf->d) was being called so frequently in * directory_walk() and its relatives, this field was created and * is set to the result of that call. /* should we force a charset on any outgoing parameterless content-type? /* System Resource Control */ const char *
mime_type;
/* forced with ForceType */ const char *
handler;
/* forced with SetHandler */ * Run-time performance tuning unsigned int enable_mmap :
2;
/* whether files in this dir can be mmap'ed */ unsigned int enable_sendfile :
2;
/* files in this dir can be sendfile'ed */ * pitched indiscriminately */ /** per-dir log config */ /** Table of directives allowed per AllowOverrideList */ /** Number of Ranges before returning HTTP_OK. **/ /** Max number of Range overlaps (merges) allowed **/ /** Max number of Range reversals (eg: 200-300, 100-125) allowed **/ /* macro to implement off by default behaviour */ /* Per-server core configuration */ /* Name translations --- we want the core to be able to do *something* * so it's at least a minimally functional web server on its own (and * can be tested that way). But let's keep it to the bare minimum: /* recursion backstopper */ int subreq_limit;
/* maximum nesting level of subrequests */ /* array of ap_errorlog_format_item for error log format string */ * two arrays of arrays of ap_errorlog_format_item for additional information /* for AddOutputFiltersByType in core.c */ /* Core filters; not exported. */ /* ---------------------------------------------------------------------- /* Handles for core filters */ * their operational status. * @param p A pool to use to create entries in the hash table * @param 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 * @param ht The hash table to store the results. Keys are item names, and * the values point to ap_mgmt_item_t structures. /* ---------------------------------------------------------------------- */ /* ---------------------------------------------------------------------- * I/O logging with mod_logio /* ---------------------------------------------------------------------- * The info structure passed to callback functions of errorlog handlers. * Not all information is available in all contexts. In particular, all * Should be preferred over c->base_server and r->server * Should be preferred over r->connecction /** current request_rec. */ /** r->main if r is a subrequest, otherwise equal to r */ /** name of source file where the log message was produced. */ /** line number in the source file, 0 if N/A */ /** module index of module that produced the log message, APLOG_NO_MODULE if N/A. */ /** log level of error message, -1 if N/A */ /** apr error status related to the log message, 0 if no error */ /** 1 if logging to syslog, 0 otherwise */ /** 1 if APLOG_STARTUP was set for the log message, 0 otherwise */ * callback function prototype for a external errorlog handler * @note To avoid unbounded memory usage, these functions must not allocate * memory from the server, connection, or request pools. If an errorlog * handler absolutely needs a pool to pass to other functions, it must create * and destroy a sub-pool. * Register external errorlog handler * @param p config pool to use * @param tag the new format specifier (i.e. the letter after the %) * @param handler the handler function * @param flags flags (reserved, set to 0) int flags;
/* for future extensions */ /** item starts a new field */ /** item is the actual error message */ /** skip whole line if item is zero-length */ /** log zero-length item as '-' */ /** ap_errorlog_handler function */ /** argument passed to item in {} */ /** a combination of the AP_ERRORLOG_* flags */ /** only log item if the message's log level is higher than this */ /* ---------------------------------------------------------------------- * ident lookups with mod_ident /* ---------------------------------------------------------------------- * authorization values with mod_authz_core /* ---------------------------------------------------------------------- * authorization values with mod_access_compat /* ---------------------------------------------------------------------- */ /** Query the server for some state information * @param query_code Which information is requested * @return the requested state information * possible values for query_code in ap_state_query() /** current status of the server */ /** are we going to serve requests or are we just testing/dumping config */ /** generation of the top-level apache parent */ * return values for ap_state_query() /** return value for unknown query_code */ /* values returned for AP_SQ_MAIN_STATE */ /** before the config preflight */ /** initial configuration run for setting up log config, etc. */ /** tearing down configuration */ /** normal configuration run */ /** cleaning up for exit */ /* values returned for AP_SQ_RUN_MODE */ /** command line not yet parsed */ /** normal operation (server requests or signal server) */ /** only dump some parts of the config */ #
endif /* !APACHE_HTTP_CORE_H */