1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * @brief HTTP Daemon routines
21 * @defgroup APACHE Apache
23 * Top level group of which all other groups are a member
26 * @defgroup APACHE_MODS Apache Modules
27 * Top level group for Apache Modules
28 * @defgroup APACHE_OS Operating System Specific
29 * @defgroup APACHE_CORE Apache Core
31 * @defgroup APACHE_CORE_DAEMON HTTP Daemon Routine
35 #ifndef APACHE_HTTPD_H
36 #define APACHE_HTTPD_H
38 /* XXX - We need to push more stuff to other .h files, or even .c files, to
39 * make this file smaller
42 /* Headers in which EVERYONE has an interest... */
43 #include "ap_config.h"
46 #include "ap_release.h"
49 #include "apr_general.h"
50 #include "apr_tables.h"
51 #include "apr_pools.h"
53 #include "apr_network_io.h"
54 #include "apr_buckets.h"
56 #include "apr_thread_proc.h"
66 /* Note: apr_uri.h is also included, see below */
72 /* ----------------------------- config dir ------------------------------ */
74 /** Define this to be the default server home dir. Most things later in this
75 * file with a relative pathname will have this added.
79 /** Set default for OS/2 file system */
80 #define HTTPD_ROOT "/os2httpd"
82 /** Set default for Windows file system */
83 #define HTTPD_ROOT "/apache"
84 #elif defined (NETWARE)
85 /** Set the default for NetWare */
86 #define HTTPD_ROOT "/apache"
88 /** Set for all other OSs */
89 #define HTTPD_ROOT "/usr/local/apache"
91 #endif /* HTTPD_ROOT */
94 * --------- You shouldn't have to edit anything below this line ----------
96 * Any modifications to any defaults not defined above should be done in the
97 * respective configuration file.
102 * Default location of documents. Can be overridden by the DocumentRoot
105 #ifndef DOCUMENT_LOCATION
107 /* Set default for OS/2 file system */
108 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
110 /* Set default for non OS/2 file system */
111 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
113 #endif /* DOCUMENT_LOCATION */
115 /** Maximum number of dynamically loaded modules */
116 #ifndef DYNAMIC_MODULE_LIMIT
117 #define DYNAMIC_MODULE_LIMIT 256
120 /** Default administrator's address */
121 #define DEFAULT_ADMIN "[no address given]"
123 /** The name of the log files */
124 #ifndef DEFAULT_ERRORLOG
125 #if defined(OS2) || defined(WIN32)
126 #define DEFAULT_ERRORLOG "logs/error.log"
128 #define DEFAULT_ERRORLOG "logs/error_log"
130 #endif /* DEFAULT_ERRORLOG */
132 /** Define this to be what your per-directory security files are called */
133 #ifndef DEFAULT_ACCESS_FNAME
135 /* Set default for OS/2 file system */
136 #define DEFAULT_ACCESS_FNAME "htaccess"
138 #define DEFAULT_ACCESS_FNAME ".htaccess"
140 #endif /* DEFAULT_ACCESS_FNAME */
142 /** The name of the server config file */
143 #ifndef SERVER_CONFIG_FILE
144 #define SERVER_CONFIG_FILE "conf/httpd.conf"
147 /** The default path for CGI scripts if none is currently set */
149 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
152 /** The path to the suExec wrapper, can be overridden in Configuration */
154 #define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
157 /** The timeout for waiting for messages */
158 #ifndef DEFAULT_TIMEOUT
159 #define DEFAULT_TIMEOUT 300
162 /** The timeout for waiting for keepalive timeout until next request */
163 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
164 #define DEFAULT_KEEPALIVE_TIMEOUT 5
167 /** The number of requests to entertain per connection */
168 #ifndef DEFAULT_KEEPALIVE
169 #define DEFAULT_KEEPALIVE 100
173 * Limits on the size of various request items. These limits primarily
174 * exist to prevent simple denial-of-service attacks on a server based
175 * on misuse of the protocol. The recommended values will depend on the
176 * nature of the server resources -- CGI scripts and database backends
177 * might require large values, but most servers could get by with much
178 * smaller limits than we use below. The request message body size can
179 * be limited by the per-dir config directive LimitRequestBody.
181 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
182 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
183 * These two limits can be lowered or raised by the server config
184 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
186 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
187 * the server config directive LimitRequestFields.
190 /** default limit on bytes in Request-Line (Method+URI+HTTP-version) */
191 #ifndef DEFAULT_LIMIT_REQUEST_LINE
192 #define DEFAULT_LIMIT_REQUEST_LINE 8190
194 /** default limit on bytes in any one header field */
195 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
196 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
198 /** default limit on number of request header fields */
199 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
200 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
204 * The default default character set name to add if AddDefaultCharset is
205 * enabled. Overridden with AddDefaultCharsetName.
207 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
209 /** default HTTP Server protocol */
210 #define AP_SERVER_PROTOCOL "HTTP/1.1"
213 /* ------------------ stuff that modules are allowed to look at ----------- */
215 /** Define this to be what your HTML directory content files are called */
216 #ifndef AP_DEFAULT_INDEX
217 #define AP_DEFAULT_INDEX "index.html"
220 /** The name of the MIME types file */
221 #ifndef AP_TYPES_CONFIG_FILE
222 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
226 * Define the HTML doctype strings centrally.
228 /** HTML 2.0 Doctype */
229 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
230 "DTD HTML 2.0//EN\">\n"
231 /** HTML 3.2 Doctype */
232 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
233 "DTD HTML 3.2 Final//EN\">\n"
234 /** HTML 4.0 Strict Doctype */
235 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
236 "DTD HTML 4.0//EN\"\n" \
237 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
238 /** HTML 4.0 Transitional Doctype */
239 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
240 "DTD HTML 4.0 Transitional//EN\"\n" \
241 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
242 /** HTML 4.0 Frameset Doctype */
243 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
244 "DTD HTML 4.0 Frameset//EN\"\n" \
245 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
246 /** XHTML 1.0 Strict Doctype */
247 #define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
248 "DTD XHTML 1.0 Strict//EN\"\n" \
249 "\"http://www.w3.org/TR/xhtml1/DTD/" \
250 "xhtml1-strict.dtd\">\n"
251 /** XHTML 1.0 Transitional Doctype */
252 #define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
253 "DTD XHTML 1.0 Transitional//EN\"\n" \
254 "\"http://www.w3.org/TR/xhtml1/DTD/" \
255 "xhtml1-transitional.dtd\">\n"
256 /** XHTML 1.0 Frameset Doctype */
257 #define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
258 "DTD XHTML 1.0 Frameset//EN\"\n" \
259 "\"http://www.w3.org/TR/xhtml1/DTD/" \
260 "xhtml1-frameset.dtd\">"
262 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
263 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
264 /** Major part of HTTP protocol */
265 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
266 /** Minor part of HTTP protocol */
267 #define HTTP_VERSION_MINOR(number) ((number)%1000)
269 /* -------------- Port number for server running standalone --------------- */
271 /** default HTTP Port */
272 #define DEFAULT_HTTP_PORT 80
273 /** default HTTPS Port */
274 #define DEFAULT_HTTPS_PORT 443
276 * Check whether @a port is the default port for the request @a r.
277 * @param port The port number
278 * @param r The request
279 * @see #ap_default_port
281 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
283 * Get the default port for a request (which depends on the scheme).
284 * @param r The request
286 #define ap_default_port(r) ap_run_default_port(r)
288 * Get the scheme for a request.
289 * @param r The request
291 #define ap_http_scheme(r) ap_run_http_scheme(r)
293 /** The default string length */
294 #define MAX_STRING_LEN HUGE_STRING_LEN
296 /** The length of a Huge string */
297 #define HUGE_STRING_LEN 8192
299 /** The size of the server's internal read-write buffers */
300 #define AP_IOBUFSIZE 8192
302 /** The max number of regex captures that can be expanded by ap_pregsub */
303 #define AP_MAX_REG_MATCH 10
306 * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
307 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
308 * than that in case the brigade code/filters attempt to read it directly.
309 * ### 16mb is an invention, no idea if it is reasonable.
311 #define AP_MAX_SENDFILE 16777216 /* 2^24 */
314 * Special Apache error codes. These are basically used
315 * in http_main.c so we can keep track of various errors.
319 #define APEXIT_OK 0x0
320 /** A fatal error arising during the server's init sequence */
321 #define APEXIT_INIT 0x2
322 /** The child died during its init sequence */
323 #define APEXIT_CHILDINIT 0x3
325 * The child exited due to a resource shortage.
326 * The parent should limit the rate of forking until
327 * the situation is resolved.
329 #define APEXIT_CHILDSICK 0x7
331 * A fatal error, resulting in the whole server aborting.
332 * If a child exits with this error, the parent process
333 * considers this a server-wide fatal error and aborts.
335 #define APEXIT_CHILDFATAL 0xf
339 * Stuff marked #AP_DECLARE is part of the API, and intended for use
340 * by modules. Its purpose is to allow us to add attributes that
341 * particular platforms or compilers require to every exported function.
343 # define AP_DECLARE(type) type
346 #ifndef AP_DECLARE_NONSTD
348 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
349 * use by modules. The difference between #AP_DECLARE and
350 * #AP_DECLARE_NONSTD is that the latter is required for any functions
351 * which use varargs or are used via indirect function call. This
352 * is to accomodate the two calling conventions in windows dlls.
354 # define AP_DECLARE_NONSTD(type) type
356 #ifndef AP_DECLARE_DATA
357 # define AP_DECLARE_DATA
360 #ifndef AP_MODULE_DECLARE
361 # define AP_MODULE_DECLARE(type) type
363 #ifndef AP_MODULE_DECLARE_NONSTD
364 # define AP_MODULE_DECLARE_NONSTD(type) type
366 #ifndef AP_MODULE_DECLARE_DATA
367 # define AP_MODULE_DECLARE_DATA
372 * modules should not use functions marked AP_CORE_DECLARE
374 #ifndef AP_CORE_DECLARE
375 # define AP_CORE_DECLARE AP_DECLARE
380 * modules should not use functions marked AP_CORE_DECLARE_NONSTD
383 #ifndef AP_CORE_DECLARE_NONSTD
384 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
388 * @brief The numeric version information is broken out into fields within this
392 int major; /**< major number */
393 int minor; /**< minor number */
394 int patch; /**< patch number */
395 const char *add_string; /**< additional string like "-dev" */
399 * Return httpd's version information in a numeric form.
401 * @param version Pointer to a version structure for returning the version
404 AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
407 * Get the server banner in a form suitable for sending over the
408 * network, with the level of information controlled by the
409 * ServerTokens directive.
410 * @return The server banner
412 AP_DECLARE(const char *) ap_get_server_banner(void);
415 * Get the server description in a form suitable for local displays,
416 * status reports, or logging. This includes the detailed server
417 * version and information about some modules. It is not affected
418 * by the ServerTokens directive.
419 * @return The server description
421 AP_DECLARE(const char *) ap_get_server_description(void);
424 * Add a component to the server description and banner strings
425 * @param pconf The pool to allocate the component from
426 * @param component The string to add
428 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
431 * Get the date a time that the server was built
432 * @return The server build time string
434 AP_DECLARE(const char *) ap_get_server_built(void);
436 /* non-HTTP status codes returned by hooks */
438 #define OK 0 /**< Module has handled this stage. */
439 #define DECLINED -1 /**< Module declines to handle */
440 #define DONE -2 /**< Module has served the response completely
441 * - it's safe to die() with no more output
443 #define SUSPENDED -3 /**< Module will handle the remainder of the request.
444 * The core will never invoke the request again, */
446 /** Returned by the bottom-most filter if no data was written.
447 * @see ap_pass_brigade(). */
448 #define AP_NOBODY_WROTE -100
449 /** Returned by the bottom-most filter if no data was read.
450 * @see ap_get_brigade(). */
451 #define AP_NOBODY_READ -101
452 /** Returned by any filter if the filter chain encounters an error
453 * and has already dealt with the error response.
455 #define AP_FILTER_ERROR -102
458 * @defgroup HTTP_Status HTTP Status Codes
462 * The size of the static array in http_protocol.c for storing
463 * all of the potential response status-lines (a sparse table).
464 * A future version should dynamically generate the apr_table_t at startup.
466 #define RESPONSE_CODES 57
468 #define HTTP_CONTINUE 100
469 #define HTTP_SWITCHING_PROTOCOLS 101
470 #define HTTP_PROCESSING 102
472 #define HTTP_CREATED 201
473 #define HTTP_ACCEPTED 202
474 #define HTTP_NON_AUTHORITATIVE 203
475 #define HTTP_NO_CONTENT 204
476 #define HTTP_RESET_CONTENT 205
477 #define HTTP_PARTIAL_CONTENT 206
478 #define HTTP_MULTI_STATUS 207
479 #define HTTP_MULTIPLE_CHOICES 300
480 #define HTTP_MOVED_PERMANENTLY 301
481 #define HTTP_MOVED_TEMPORARILY 302
482 #define HTTP_SEE_OTHER 303
483 #define HTTP_NOT_MODIFIED 304
484 #define HTTP_USE_PROXY 305
485 #define HTTP_TEMPORARY_REDIRECT 307
486 #define HTTP_BAD_REQUEST 400
487 #define HTTP_UNAUTHORIZED 401
488 #define HTTP_PAYMENT_REQUIRED 402
489 #define HTTP_FORBIDDEN 403
490 #define HTTP_NOT_FOUND 404
491 #define HTTP_METHOD_NOT_ALLOWED 405
492 #define HTTP_NOT_ACCEPTABLE 406
493 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
494 #define HTTP_REQUEST_TIME_OUT 408
495 #define HTTP_CONFLICT 409
496 #define HTTP_GONE 410
497 #define HTTP_LENGTH_REQUIRED 411
498 #define HTTP_PRECONDITION_FAILED 412
499 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
500 #define HTTP_REQUEST_URI_TOO_LARGE 414
501 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
502 #define HTTP_RANGE_NOT_SATISFIABLE 416
503 #define HTTP_EXPECTATION_FAILED 417
504 #define HTTP_UNPROCESSABLE_ENTITY 422
505 #define HTTP_LOCKED 423
506 #define HTTP_FAILED_DEPENDENCY 424
507 #define HTTP_UPGRADE_REQUIRED 426
508 #define HTTP_INTERNAL_SERVER_ERROR 500
509 #define HTTP_NOT_IMPLEMENTED 501
510 #define HTTP_BAD_GATEWAY 502
511 #define HTTP_SERVICE_UNAVAILABLE 503
512 #define HTTP_GATEWAY_TIME_OUT 504
513 #define HTTP_VERSION_NOT_SUPPORTED 505
514 #define HTTP_VARIANT_ALSO_VARIES 506
515 #define HTTP_INSUFFICIENT_STORAGE 507
516 #define HTTP_NOT_EXTENDED 510
518 /** is the status code informational */
519 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
520 /** is the status code OK ?*/
521 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
522 /** is the status code a redirect */
523 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
524 /** is the status code a error (client or server) */
525 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
526 /** is the status code a client error */
527 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
528 /** is the status code a server error */
529 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
530 /** is the status code a (potentially) valid response code? */
531 #define ap_is_HTTP_VALID_RESPONSE(x) (((x) >= 100)&&((x) < 600))
533 /** should the status code drop the connection */
534 #define ap_status_drops_connection(x) \
535 (((x) == HTTP_BAD_REQUEST) || \
536 ((x) == HTTP_REQUEST_TIME_OUT) || \
537 ((x) == HTTP_LENGTH_REQUIRED) || \
538 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
539 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
540 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
541 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
542 ((x) == HTTP_NOT_IMPLEMENTED))
546 * @defgroup Methods List of Methods recognized by the server
547 * @ingroup APACHE_CORE_DAEMON
550 * @brief Methods recognized (but not necessarily handled) by the server.
552 * These constants are used in bit shifting masks of size int, so it is
553 * unsafe to have more methods than bits in an int. HEAD == M_GET.
554 * This list must be tracked by the list in http_protocol.c in routine
555 * ap_method_name_of().
559 #define M_GET 0 /** RFC 2616: HTTP */
560 #define M_PUT 1 /* : */
565 #define M_TRACE 6 /** RFC 2616: HTTP */
566 #define M_PATCH 7 /** no rfc(!) ### remove this one? */
567 #define M_PROPFIND 8 /** RFC 2518: WebDAV */
568 #define M_PROPPATCH 9 /* : */
573 #define M_UNLOCK 14 /** RFC 2518: WebDAV */
574 #define M_VERSION_CONTROL 15 /** RFC 3253: WebDAV Versioning */
575 #define M_CHECKOUT 16 /* : */
576 #define M_UNCHECKOUT 17
581 #define M_MKWORKSPACE 22
582 #define M_MKACTIVITY 23
583 #define M_BASELINE_CONTROL 24
585 #define M_INVALID 26 /** RFC 3253: WebDAV Versioning */
588 * METHODS needs to be equal to the number of bits
589 * we are using for limit masks.
594 * The method mask bit to shift for anding with a bitmask.
596 #define AP_METHOD_BIT ((apr_int64_t)1)
600 /** @see ap_method_list_t */
601 typedef struct ap_method_list_t ap_method_list_t;
604 * @struct ap_method_list_t
605 * @brief Structure for handling HTTP methods.
607 * Methods known to the server are accessed via a bitmask shortcut;
608 * extension methods are handled by an array.
610 struct ap_method_list_t {
611 /** The bitmask used for known methods */
612 apr_int64_t method_mask;
613 /** the array used for extension methods */
614 apr_array_header_t *method_list;
618 * @defgroup module_magic Module Magic mime types
621 /** Magic for mod_cgi[d] */
622 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
623 /** Magic for mod_include */
624 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
625 /** Magic for mod_include */
626 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
627 /** Magic for mod_dir */
628 #define DIR_MAGIC_TYPE "httpd/unix-directory"
631 /* Just in case your linefeed isn't the one the other end is expecting. */
632 #if !APR_CHARSET_EBCDIC
635 /** carrige return */
637 /** carrige return /Line Feed Combo */
638 #define CRLF "\015\012"
639 #else /* APR_CHARSET_EBCDIC */
640 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
641 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
642 * "native EBCDIC" CR and NL characters. These are therefore
649 #endif /* APR_CHARSET_EBCDIC */
650 /** Useful for common code with either platform charset. */
651 #define CRLF_ASCII "\015\012"
654 * @defgroup values_request_rec_body Possible values for request_rec.read_body
656 * Possible values for request_rec.read_body (set by handling module):
659 /** Send 413 error if message has any body */
660 #define REQUEST_NO_BODY 0
661 /** Send 411 error if body without Content-Length */
662 #define REQUEST_CHUNKED_ERROR 1
663 /** If chunked, remove the chunks for me. */
664 #define REQUEST_CHUNKED_DECHUNK 2
665 /** @} // values_request_rec_body */
668 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
669 * @ingroup APACHE_CORE_DAEMON
671 * Possible values for request_rec.used_path_info:
674 /** Accept the path_info from the request */
675 #define AP_REQ_ACCEPT_PATH_INFO 0
676 /** Return a 404 error if path_info was given */
677 #define AP_REQ_REJECT_PATH_INFO 1
678 /** Module may chose to use the given path_info */
679 #define AP_REQ_DEFAULT_PATH_INFO 2
681 /** @} // values_request_rec_used_path_info */
685 * Things which may vary per file-lookup WITHIN a request ---
686 * e.g., state of MIME config. Basically, the name of an object, info
687 * about the object, and any other info we may ahve which may need to
688 * change as we go poking around looking for it (e.g., overridden by
691 * Note how the default state of almost all these things is properly
692 * zero, so that allocating it with pcalloc does the right thing without
693 * a whole lot of hairy initialization... so long as we are willing to
694 * make the (fairly) portable assumption that the bit pattern of a NULL
695 * pointer is, in fact, zero.
699 * @brief This represents the result of calling htaccess; these are cached for
702 struct htaccess_result {
703 /** the directory to which this applies */
705 /** the overrides allowed for the .htaccess file */
707 /** the override options allowed for the .htaccess file */
709 /** the configuration directives */
710 struct ap_conf_vector_t *htaccess;
711 /** the next one, or NULL if no more; N.B. never change this */
712 const struct htaccess_result *next;
715 /* The following four types define a hierarchy of activities, so that
716 * given a request_rec r you can write r->connection->server->process
717 * to get to the process_rec. While this reduces substantially the
718 * number of arguments that various hooks require beware that in
719 * threaded versions of the server you must consider multiplexing
723 /** A structure that represents one process */
724 typedef struct process_rec process_rec;
725 /** A structure that represents a virtual server */
726 typedef struct server_rec server_rec;
727 /** A structure that represents one connection */
728 typedef struct conn_rec conn_rec;
729 /** A structure that represents the current request */
730 typedef struct request_rec request_rec;
731 /** A structure that represents the status of the current connection */
732 typedef struct conn_state_t conn_state_t;
734 /* ### would be nice to not include this from httpd.h ... */
735 /* This comes after we have defined the request_rec type */
739 * @brief A structure that represents one process
742 /** Global pool. Cleared upon normal exit */
744 /** Configuration pool. Cleared upon restart */
746 /** The program name used to execute the program */
747 const char *short_name;
748 /** The command line arguments */
749 const char * const *argv;
750 /** Number of command line arguments passed to the program */
755 * @brief A structure that represents the current request
758 /** The pool associated with the request */
760 /** The connection to the client */
761 conn_rec *connection;
762 /** The virtual host for this request */
765 /** Pointer to the redirected request if this is an external redirect */
767 /** Pointer to the previous request if this is an internal redirect */
770 /** Pointer to the main request if this is a sub-request
771 * (see http_request.h) */
774 /* Info about the request itself... we begin with stuff that only
775 * protocol.c should ever touch...
777 /** First line of request */
779 /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
781 /** A proxy request (calculated during post_read_request/translate_name)
782 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
786 /** HEAD request, as opposed to GET */
788 /** Protocol version number of protocol; 1.1 = 1001 */
790 /** Protocol string, as given to us, or HTTP/0.9 */
792 /** Host, as set by full URI or Host: */
793 const char *hostname;
795 /** Time when the request started */
796 apr_time_t request_time;
798 /** Status line, if set by script */
799 const char *status_line;
803 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
804 * look, but don't touch.
807 /** M_GET, M_POST, etc. */
809 /** Request method (eg. GET, HEAD, POST, etc.) */
813 * 'allowed' is a bitvector of the allowed methods.
815 * A handler must ensure that the request method is one that
816 * it is capable of handling. Generally modules should DECLINE
817 * any request methods they do not handle. Prior to aborting the
818 * handler like this the handler should set r->allowed to the list
819 * of methods that it is willing to handle. This bitvector is used
820 * to construct the "Allow:" header required for OPTIONS requests,
821 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
823 * Since the default_handler deals with OPTIONS, all modules can
824 * usually decline to deal with OPTIONS. TRACE is always allowed,
825 * modules don't need to set it explicitly.
827 * Since the default_handler will always handle a GET, a
828 * module which does *not* implement GET should probably return
829 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
830 * handler can't be installed by mod_actions.
833 /** Array of extension methods */
834 apr_array_header_t *allowed_xmethods;
835 /** List of allowed methods */
836 ap_method_list_t *allowed_methods;
838 /** byte count in stream is for body */
839 apr_off_t sent_bodyct;
840 /** body byte count, for easy access */
841 apr_off_t bytes_sent;
842 /** Last modified time of the requested resource */
845 /* HTTP/1.1 connection-level features */
847 /** The Range: header */
849 /** The "real" content length */
851 /** sending chunked transfer-coding */
854 /** Method for reading the request body
855 * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
856 * REQUEST_CHUNKED_DECHUNK, etc...) */
858 /** reading chunked transfer-coding */
860 /** is client waiting for a 100 response? */
861 unsigned expecting_100;
862 /** The optional kept body of the request. */
863 apr_bucket_brigade *kept_body;
864 /** For ap_body_to_table(): parsed body */
865 /* XXX: ap_body_to_table has been removed. Remove body_table too or
866 * XXX: keep it to reintroduce ap_body_to_table without major bump? */
867 apr_table_t *body_table;
868 /** Remaining bytes left to read from the request body */
870 /** Number of bytes that have been read from the request body */
871 apr_off_t read_length;
873 /* MIME header environments, in and out. Also, an array containing
874 * environment variables to be passed to subprocesses, so people can
875 * write modules to add to that environment.
877 * The difference between headers_out and err_headers_out is that the
878 * latter are printed even on error, and persist across internal redirects
879 * (so the headers printed for ErrorDocument handlers will have them).
881 * The 'notes' apr_table_t is for notes from one module to another, with no
882 * other set purpose in mind...
885 /** MIME header environment from the request */
886 apr_table_t *headers_in;
887 /** MIME header environment for the response */
888 apr_table_t *headers_out;
889 /** MIME header environment for the response, printed even on errors and
890 * persist across internal redirects */
891 apr_table_t *err_headers_out;
892 /** Array of environment variables to be used for sub processes */
893 apr_table_t *subprocess_env;
894 /** Notes from one module to another */
897 /* content_type, handler, content_encoding, and all content_languages
898 * MUST be lowercased strings. They may be pointers to static strings;
899 * they should not be modified in place.
901 /** The content-type for the current request */
902 const char *content_type; /* Break these out --- we dispatch on 'em */
903 /** The handler string that we use to call a handler function */
904 const char *handler; /* What we *really* dispatch on */
906 /** How to encode the data */
907 const char *content_encoding;
908 /** Array of strings representing the content languages */
909 apr_array_header_t *content_languages;
911 /** variant list validator (if negotiated) */
912 char *vlist_validator;
914 /** If an authentication check was made, this gets set to the user name. */
916 /** If an authentication check was made, this gets set to the auth type. */
919 /* What object is being requested (either directly, or via include
920 * or content-negotiation mapping).
923 /** The URI without any parsing performed */
925 /** The path portion of the URI, or "/" if no path provided */
927 /** The filename on disk corresponding to this response */
929 /* XXX: What does this mean? Please define "canonicalize" -aaron */
930 /** The true filename, we canonicalize r->filename if these don't match */
931 char *canonical_filename;
932 /** The PATH_INFO extracted from this request */
934 /** The QUERY_ARGS extracted from this request */
938 * Flag for the handler to accept or reject path_info on
939 * the current request. All modules should respect the
940 * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
941 * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
942 * may follow existing conventions. This is set to the
943 * user's preference upon HOOK_VERY_FIRST of the fixups.
947 /** A flag to determine if the eos bucket has been sent yet */
950 /* Various other config info which may change with .htaccess files
951 * These are config vectors, with one void* pointer for each module
952 * (the thing pointed to being the module's business).
955 /** Options set in config files, etc. */
956 struct ap_conf_vector_t *per_dir_config;
957 /** Notes on *this* request */
958 struct ap_conf_vector_t *request_config;
960 /** Optional request log level configuration. Will usually point
961 * to a server or per_dir config, i.e. must be copied before
963 const struct ap_logconf *log;
965 /** Id to identify request in access and error log. Set when the first
966 * error log entry for this request is generated.
971 * A linked list of the .htaccess configuration directives
972 * accessed by this request.
973 * N.B. always add to the head of the list, _never_ to the end.
974 * that way, a sub request's list can (temporarily) point to a parent's list
976 const struct htaccess_result *htaccess;
978 /** A list of output filters to be used for this request */
979 struct ap_filter_t *output_filters;
980 /** A list of input filters to be used for this request */
981 struct ap_filter_t *input_filters;
983 /** A list of protocol level output filters to be used for this
985 struct ap_filter_t *proto_output_filters;
986 /** A list of protocol level input filters to be used for this
988 struct ap_filter_t *proto_input_filters;
990 /** This response can not be cached */
992 /** There is no local copy of this response */
995 /** Mutex protect callbacks registered with ap_mpm_register_timed_callback
996 * from being run before the original handler finishes running
998 apr_thread_mutex_t *invoke_mtx;
1000 /** A struct containing the components of URI */
1001 apr_uri_t parsed_uri;
1002 /** finfo.protection (st_mode) set to zero if no such file */
1007 * @defgroup ProxyReq Proxy request types
1009 * Possible values of request_rec->proxyreq. A request could be normal,
1010 * proxied or reverse proxied. Normally proxied and reverse proxied are
1011 * grouped together as just "proxied", but sometimes it's necessary to
1012 * tell the difference between the two, such as for authentication.
1016 #define PROXYREQ_NONE 0 /**< No proxy */
1017 #define PROXYREQ_PROXY 1 /**< Standard proxy */
1018 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
1019 #define PROXYREQ_RESPONSE 3 /**< Origin response */
1024 * @brief Enumeration of connection keepalive options
1030 } ap_conn_keepalive_e;
1033 * @brief Structure to store things which are per connection
1036 /** Pool associated with this connection */
1038 /** Physical vhost this conn came in on */
1039 server_rec *base_server;
1040 /** used by http_vhost.c */
1041 void *vhost_lookup_data;
1043 /* Information about the connection itself */
1044 /** local address */
1045 apr_sockaddr_t *local_addr;
1046 /** remote address */
1047 apr_sockaddr_t *remote_addr;
1049 /** Client's IP address */
1051 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
1052 * "" if it has and no address was found. N.B. Only access this though
1053 * get_remote_host() */
1055 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
1056 * get_remote_logname() */
1057 char *remote_logname;
1059 /** server IP address */
1061 /** used for ap_get_server_name when UseCanonicalName is set to DNS
1062 * (ignores setting of HostnameLookups) */
1065 /** ID of this connection; unique at any point in time */
1067 /** Config vector containing pointers to connections per-server
1068 * config structures. */
1069 struct ap_conf_vector_t *conn_config;
1070 /** Notes on *this* connection: send note from one module to
1071 * another. must remain valid for all requests on this conn */
1073 /** A list of input filters to be used for this connection */
1074 struct ap_filter_t *input_filters;
1075 /** A list of output filters to be used for this connection */
1076 struct ap_filter_t *output_filters;
1077 /** handle to scoreboard information for this connection */
1079 /** The bucket allocator to use for all bucket/brigade creations */
1080 struct apr_bucket_alloc_t *bucket_alloc;
1081 /** The current state of this connection */
1083 /** Is there data pending in the input filters? */
1084 int data_in_input_filters;
1085 /** Is there data pending in the output filters? */
1086 int data_in_output_filters;
1088 /** Are there any filters that clogg/buffer the input stream, breaking
1091 unsigned int clogging_input_filters:1;
1093 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1095 signed int double_reverse:2;
1097 /** Are we still talking? */
1100 /** Are we going to keep the connection alive for another request?
1101 * @see ap_conn_keepalive_e */
1102 ap_conn_keepalive_e keepalive;
1104 /** How many times have we used it? */
1107 /** Optional connection log level configuration. May point to a server or
1108 * per_dir config, i.e. must be copied before modifying */
1109 const struct ap_logconf *log;
1111 /** Id to identify this connection in error log. Set when the first
1112 * error log entry for this connection is generated.
1117 /** This points to the current thread being used to process this request,
1118 * over the lifetime of a request, the value may change. Users of the connection
1119 * record should not rely upon it staying the same between calls that invole
1123 apr_thread_t *current_thread;
1128 * Enumeration of connection states
1131 CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1132 CONN_STATE_READ_REQUEST_LINE,
1134 CONN_STATE_WRITE_COMPLETION,
1135 CONN_STATE_SUSPENDED,
1140 * @brief A structure to contain connection state information
1142 struct conn_state_t {
1143 /** APR_RING of expiration timeouts */
1144 APR_RING_ENTRY(conn_state_t) timeout_list;
1145 /** the expiration time of the next keepalive timeout */
1146 apr_time_t expiration_time;
1147 /** connection record this struct refers to */
1149 /** memory pool to allocate from */
1151 /** bucket allocator */
1152 apr_bucket_alloc_t *bucket_alloc;
1153 /** poll file descriptor information */
1155 /** Current state of the connection */
1159 /* Per-vhost config... */
1162 * The address 255.255.255.255, when used as a virtualhost address,
1163 * will become the "default" server when the ip doesn't match other vhosts.
1165 #define DEFAULT_VHOST_ADDR 0xfffffffful
1169 * @struct server_addr_rec
1170 * @brief A structure to be used for Per-vhost config
1172 typedef struct server_addr_rec server_addr_rec;
1173 struct server_addr_rec {
1174 /** The next server in the list */
1175 server_addr_rec *next;
1176 /** The name given in "<VirtualHost>" */
1178 /** The bound address, for this server */
1179 apr_sockaddr_t *host_addr;
1180 /** The bound port, for this server */
1181 apr_port_t host_port;
1185 /** The per-module log levels */
1186 signed char *module_levels;
1188 /** The log level for this server */
1192 * @brief A structure to store information for each virtual server
1195 /** The process this server is running in */
1196 process_rec *process;
1197 /** The next server in the list */
1200 /* Log files --- note that transfer log is now in the modules... */
1202 /** The name of the error log */
1204 /** A file descriptor that references the error log */
1205 apr_file_t *error_log;
1206 /** The log level configuration */
1207 struct ap_logconf log;
1209 /* Module-specific configuration for server, and defaults... */
1211 /** Config vector containing pointers to modules' per-server config
1213 struct ap_conf_vector_t *module_config;
1214 /** MIME type info, etc., before we start checking per-directory info */
1215 struct ap_conf_vector_t *lookup_defaults;
1217 /** The name of the server */
1218 const char *defn_name;
1219 /** The line of the config file that the server was defined on */
1220 unsigned defn_line_number;
1221 /** true if this is the virtual server */
1225 /* Information for redirects */
1227 /** for redirects, etc. */
1229 /** The server request scheme for redirect responses */
1230 const char *server_scheme;
1232 /* Contact information */
1234 /** The admin's contact information */
1236 /** The server hostname */
1237 char *server_hostname;
1239 /* Transaction handling */
1241 /** I haven't got a clue */
1242 server_addr_rec *addrs;
1243 /** Timeout, as an apr interval, before we give up */
1244 apr_interval_time_t timeout;
1245 /** The apr interval we will wait for another request */
1246 apr_interval_time_t keep_alive_timeout;
1247 /** Maximum requests per connection */
1249 /** Use persistent connections? */
1252 /** Normal names for ServerAlias servers */
1253 apr_array_header_t *names;
1254 /** Wildcarded names for ServerAlias servers */
1255 apr_array_header_t *wild_names;
1257 /** Pathname for ServerPath */
1259 /** Length of path */
1262 /** limit on size of the HTTP request line */
1264 /** limit on size of any request header field */
1265 int limit_req_fieldsize;
1266 /** limit on number of request header fields */
1267 int limit_req_fields;
1270 /** Opaque storage location */
1274 typedef struct core_output_filter_ctx {
1275 apr_bucket_brigade *buffered_bb;
1276 apr_bucket_brigade *tmp_flush_bb;
1277 apr_pool_t *deferred_write_pool;
1278 apr_size_t bytes_in;
1279 apr_size_t bytes_written;
1280 } core_output_filter_ctx_t;
1282 typedef struct core_filter_ctx {
1283 apr_bucket_brigade *b;
1284 apr_bucket_brigade *tmpbb;
1287 typedef struct core_net_rec {
1288 /** Connection to the client */
1289 apr_socket_t *client_socket;
1291 /** connection record */
1294 core_output_filter_ctx_t *out_ctx;
1299 * Examine a field value (such as a media-/content-type) string and return
1300 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1301 * @param p Pool to allocate memory from
1302 * @param intype The field to examine
1303 * @return A copy of the field minus any parameters
1305 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1308 * Convert a time from an integer into a string in a specified format
1309 * @param p The pool to allocate memory from
1310 * @param t The time to convert
1311 * @param fmt The format to use for the conversion
1312 * @param gmt Convert the time for GMT?
1313 * @return The string that represents the specified time
1315 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1317 /* String handling. The *_nc variants allow you to use non-const char **s as
1318 arguments (unfortunately C won't automatically convert a char ** to a const
1322 * Get the characters until the first occurance of a specified character
1323 * @param p The pool to allocate memory from
1324 * @param line The string to get the characters from
1325 * @param stop The character to stop at
1326 * @return A copy of the characters up to the first stop character
1328 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1331 * Get the characters until the first occurance of a specified character
1332 * @param p The pool to allocate memory from
1333 * @param line The string to get the characters from
1334 * @param stop The character to stop at
1335 * @return A copy of the characters up to the first stop character
1336 * @note This is the same as ap_getword(), except it doesn't use const char **.
1338 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1341 * Get the first word from a given string. A word is defined as all characters
1342 * up to the first whitespace.
1343 * @param p The pool to allocate memory from
1344 * @param line The string to traverse
1345 * @return The first word in the line
1347 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1350 * Get the first word from a given string. A word is defined as all characters
1351 * up to the first whitespace.
1352 * @param p The pool to allocate memory from
1353 * @param line The string to traverse
1354 * @return The first word in the line
1355 * @note The same as ap_getword_white(), except it doesn't use const char**
1357 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1360 * Get all characters from the first occurance of @a stop to the first "\0"
1361 * @param p The pool to allocate memory from
1362 * @param line The line to traverse
1363 * @param stop The character to start at
1364 * @return A copy of all caracters after the first occurance of the specified
1367 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1371 * Get all characters from the first occurance of @a stop to the first "\0"
1372 * @param p The pool to allocate memory from
1373 * @param line The line to traverse
1374 * @param stop The character to start at
1375 * @return A copy of all caracters after the first occurance of the specified
1377 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1379 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1382 * Get the second word in the string paying attention to quoting
1383 * @param p The pool to allocate from
1384 * @param line The line to traverse
1385 * @return A copy of the string
1387 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1390 * Get the second word in the string paying attention to quoting
1391 * @param p The pool to allocate from
1392 * @param line The line to traverse
1393 * @return A copy of the string
1394 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1396 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1399 * Check a string for any config define or environment variable construct
1400 * and replace each of them by the value of that variable, if it exists.
1401 * The default syntax of the constructs is ${ENV} but can be changed by
1402 * setting the define::* config defines. If the variable does not exist,
1403 * leave the ${ENV} construct alone but print a warning.
1404 * @param p The pool to allocate from
1405 * @param word The string to check
1406 * @return The string with the replaced environment variables
1408 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1411 * Size an HTTP header field list item, as separated by a comma.
1412 * @param field The field to size
1413 * @param len The length of the field
1414 * @return The return value is a pointer to the beginning of the non-empty
1415 * list item within the original string (or NULL if there is none) and the
1416 * address of field is shifted to the next non-comma, non-whitespace
1417 * character. len is the length of the item excluding any beginning whitespace.
1419 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1422 * Retrieve an HTTP header field list item, as separated by a comma,
1423 * while stripping insignificant whitespace and lowercasing anything not in
1424 * a quoted string or comment.
1425 * @param p The pool to allocate from
1426 * @param field The field to retrieve
1427 * @return The return value is a new string containing the converted list
1428 * item (or NULL if none) and the address pointed to by field is
1429 * shifted to the next non-comma, non-whitespace.
1431 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1434 * Find an item in canonical form (lowercase, no extra spaces) within
1435 * an HTTP field value list.
1436 * @param p The pool to allocate from
1437 * @param line The field value list to search
1438 * @param tok The token to search for
1439 * @return 1 if found, 0 if not found.
1441 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1444 * Retrieve a token, spacing over it and adjusting the pointer to
1445 * the first non-white byte afterwards. Note that these tokens
1446 * are delimited by semis and commas and can also be delimited
1447 * by whitespace at the caller's option.
1448 * @param p The pool to allocate from
1449 * @param accept_line The line to retrieve the token from (adjusted afterwards)
1450 * @param accept_white Is it delimited by whitespace
1453 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1456 * Find http tokens, see the definition of token from RFC2068
1457 * @param p The pool to allocate from
1458 * @param line The line to find the token
1459 * @param tok The token to find
1460 * @return 1 if the token is found, 0 otherwise
1462 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1465 * find http tokens from the end of the line
1466 * @param p The pool to allocate from
1467 * @param line The line to find the token
1468 * @param tok The token to find
1469 * @return 1 if the token is found, 0 otherwise
1471 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1474 * Check for an Absolute URI syntax
1475 * @param u The string to check
1476 * @return 1 if URI, 0 otherwise
1478 AP_DECLARE(int) ap_is_url(const char *u);
1482 * @param url The string to unescape
1483 * @return 0 on success, non-zero otherwise
1485 AP_DECLARE(int) ap_unescape_all(char *url);
1489 * @param url The url to unescape
1490 * @return 0 on success, non-zero otherwise
1492 AP_DECLARE(int) ap_unescape_url(char *url);
1495 * Unescape a URL, but leaving %2f (slashes) escaped
1496 * @param url The url to unescape
1497 * @param decode_slashes Whether or not slashes should be decoded
1498 * @return 0 on success, non-zero otherwise
1500 AP_DECLARE(int) ap_unescape_url_keep2f(char *url, int decode_slashes);
1503 * Convert all double slashes to single slashes
1504 * @param name The string to convert
1506 AP_DECLARE(void) ap_no2slash(char *name);
1509 * Remove all ./ and xx/../ substrings from a file name. Also remove
1510 * any leading ../ or /../ substrings.
1511 * @param name the file name to parse
1513 AP_DECLARE(void) ap_getparents(char *name);
1516 * Escape a path segment, as defined in RFC 1808
1517 * @param p The pool to allocate from
1518 * @param s The path to convert
1519 * @return The converted URL
1521 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1524 * Escape a path segment, as defined in RFC 1808, to a preallocated buffer.
1525 * @param c The preallocated buffer to write to
1526 * @param s The path to convert
1527 * @return The converted URL (c)
1529 AP_DECLARE(char *) ap_escape_path_segment_buffer(char *c, const char *s);
1532 * convert an OS path to a URL in an OS dependant way.
1533 * @param p The pool to allocate from
1534 * @param path The path to convert
1535 * @param partial if set, assume that the path will be appended to something
1536 * with a '/' in it (and thus does not prefix "./")
1537 * @return The converted URL
1539 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1541 /** @see ap_os_escape_path */
1542 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1545 * Escape an html string
1546 * @param p The pool to allocate from
1547 * @param s The html to escape
1548 * @return The escaped string
1550 #define ap_escape_html(p,s) ap_escape_html2(p,s,0)
1552 * Escape an html string
1553 * @param p The pool to allocate from
1554 * @param s The html to escape
1555 * @param toasc Whether to escape all non-ASCII chars to \&\#nnn;
1556 * @return The escaped string
1558 AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc);
1561 * Escape a string for logging
1562 * @param p The pool to allocate from
1563 * @param str The string to escape
1564 * @return The escaped string
1566 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str);
1569 * Escape a string for logging into the error log (without a pool)
1570 * @param dest The buffer to write to
1571 * @param source The string to escape
1572 * @param buflen The buffer size for the escaped string (including "\0")
1573 * @return The len of the escaped string (always < maxlen)
1575 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1579 * Construct a full hostname
1580 * @param p The pool to allocate from
1581 * @param hostname The hostname of the server
1582 * @param port The port the server is running on
1583 * @param r The current request
1584 * @return The server's hostname
1586 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1587 apr_port_t port, const request_rec *r);
1590 * Escape a shell command
1591 * @param p The pool to allocate from
1592 * @param s The command to escape
1593 * @return The escaped shell command
1595 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1598 * Count the number of directories in a path
1599 * @param path The path to count
1600 * @return The number of directories
1602 AP_DECLARE(int) ap_count_dirs(const char *path);
1605 * Copy at most @a n leading directories of @a s into @a d. @a d
1606 * should be at least as large as @a s plus 1 extra byte
1608 * @param d The location to copy to
1609 * @param s The location to copy from
1610 * @param n The number of directories to copy
1611 * @return value is the ever useful pointer to the trailing "\0" of d
1612 * @note on platforms with drive letters, n = 0 returns the "/" root,
1613 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1614 * returns the empty string. */
1615 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1618 * Return the parent directory name (including trailing /) of the file
1620 * @param p The pool to allocate from
1621 * @param s The file to get the parent of
1622 * @return A copy of the file's parent directory
1624 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1627 * Given a directory and filename, create a single path from them. This
1628 * function is smart enough to ensure that there is a sinlge '/' between the
1629 * directory and file names
1630 * @param a The pool to allocate from
1631 * @param dir The directory name
1632 * @param f The filename
1633 * @return A copy of the full path
1634 * @note Never consider using this function if you are dealing with filesystem
1635 * names that need to remain canonical, unless you are merging an apr_dir_read
1636 * path and returned filename. Otherwise, the result is not canonical.
1638 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1641 * Test if the given path has an an absolute path.
1642 * @param p The pool to allocate from
1643 * @param dir The directory name
1644 * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1645 * multiple forms of absolute paths. This only reports if the path is absolute
1646 * in a canonical sense.
1648 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1651 * Does the provided string contain wildcard characters? This is useful
1652 * for determining if the string should be passed to strcmp_match or to strcmp.
1653 * The only wildcard characters recognized are '?' and '*'
1654 * @param str The string to check
1655 * @return 1 if the string has wildcards, 0 otherwise
1657 AP_DECLARE(int) ap_is_matchexp(const char *str);
1660 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1661 * @param str The string to check
1662 * @param expected The pattern to match against
1663 * @return 1 if the two strings match, 0 otherwise
1665 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected);
1668 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1670 * @param str The string to check
1671 * @param expected The pattern to match against
1672 * @return 1 if the two strings match, 0 otherwise
1674 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected);
1677 * Find the first occurrence of the substring s2 in s1, regardless of case
1678 * @param s1 The string to search
1679 * @param s2 The substring to search for
1680 * @return A pointer to the beginning of the substring
1681 * @remark See apr_strmatch() for a faster alternative
1683 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1686 * Return a pointer to the location inside of bigstring immediately after prefix
1687 * @param bigstring The input string
1688 * @param prefix The prefix to strip away
1689 * @return A pointer relative to bigstring after prefix
1691 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1692 const char *prefix);
1695 * Decode a base64 encoded string into memory allocated from a pool
1696 * @param p The pool to allocate from
1697 * @param bufcoded The encoded string
1698 * @return The decoded string
1700 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1703 * Encode a string into memory allocated from a pool in base 64 format
1704 * @param p The pool to allocate from
1705 * @param string The plaintext string
1706 * @return The encoded string
1708 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1711 * Compile a regular expression to be used later. The regex is freed when
1712 * the pool is destroyed.
1713 * @param p The pool to allocate from
1714 * @param pattern the regular expression to compile
1715 * @param cflags The bitwise or of one or more of the following:
1716 * @li REG_EXTENDED - Use POSIX extended Regular Expressions
1717 * @li REG_ICASE - Ignore case
1718 * @li REG_NOSUB - Support for substring addressing of matches
1720 * @li REG_NEWLINE - Match-any-character operators don't match new-line
1721 * @return The compiled regular expression
1723 AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1727 * Free the memory associated with a compiled regular expression
1728 * @param p The pool the regex was allocated from
1729 * @param reg The regular expression to free
1730 * @note This function is only necessary if the regex should be cleaned
1731 * up before the pool
1733 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
1736 * After performing a successful regex match, you may use this function to
1737 * perform a series of string substitutions based on subexpressions that were
1738 * matched during the call to ap_regexec
1739 * @param p The pool to allocate from
1740 * @param input An arbitrary string containing $1 through $9. These are
1741 * replaced with the corresponding matched sub-expressions
1742 * @param source The string that was originally matched to the regex
1743 * @param nmatch the nmatch returned from ap_pregex
1744 * @param pmatch the pmatch array returned from ap_pregex
1745 * @return The substituted string, or NULL on error
1747 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1748 size_t nmatch, ap_regmatch_t pmatch[]);
1751 * We want to downcase the type/subtype for comparison purposes
1752 * but nothing else because ;parameter=foo values are case sensitive.
1753 * @param s The content-type to convert to lowercase
1755 AP_DECLARE(void) ap_content_type_tolower(char *s);
1758 * convert a string to all lowercase
1759 * @param s The string to convert to lowercase
1761 AP_DECLARE(void) ap_str_tolower(char *s);
1764 * Search a string from left to right for the first occurrence of a
1765 * specific character
1766 * @param str The string to search
1767 * @param c The character to search for
1768 * @return The index of the first occurrence of c in str
1770 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1773 * Search a string from right to left for the first occurrence of a
1774 * specific character
1775 * @param str The string to search
1776 * @param c The character to search for
1777 * @return The index of the first occurrence of c in str
1779 AP_DECLARE(int) ap_rind(const char *str, char c);
1782 * Given a string, replace any bare " with \\" .
1783 * @param p The pool to allocate memory from
1784 * @param instring The string to search for "
1785 * @return A copy of the string with escaped quotes
1787 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1790 * Given a string, append the PID deliminated by delim.
1791 * Usually used to create a pid-appended filepath name
1792 * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
1793 * a macro, to avoid unistd.h dependency
1794 * @param p The pool to allocate memory from
1795 * @param string The string to append the PID to
1796 * @param delim The string to use to deliminate the string from the PID
1797 * @return A copy of the string with the PID appended
1799 AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
1803 * Parse a given timeout parameter string into an apr_interval_time_t value.
1804 * The unit of the time interval is given as postfix string to the numeric
1805 * string. Currently the following units are understood:
1812 * If no unit is contained in the given timeout parameter the default_time_unit
1813 * will be used instead.
1814 * @param timeout_parameter The string containing the timeout parameter.
1815 * @param timeout The timeout value to be returned.
1816 * @param default_time_unit The default time unit to use if none is specified
1817 * in timeout_parameter.
1818 * @return Status value indicating whether the parsing was successful or not.
1820 AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
1821 const char *timeout_parameter,
1822 apr_interval_time_t *timeout,
1823 const char *default_time_unit);
1826 * Determine if a request has a request body or not.
1828 * @param r the request_rec of the request
1829 * @return truth value
1831 AP_DECLARE(int) ap_request_has_body(request_rec *r);
1834 * Cleanup a string (mainly to be filesystem safe)
1835 * We only allow '_' and alphanumeric chars. Non-printable
1836 * map to 'x' and all others map to '_'
1838 * @param p pool to use to allocate dest
1839 * @param src string to clean up
1840 * @param dest cleaned up, allocated string
1841 * @return Status value indicating whether the cleaning was successful or not.
1843 AP_DECLARE(apr_status_t) ap_pstr2_alnum(apr_pool_t *p, const char *src,
1847 * Cleanup a string (mainly to be filesystem safe)
1848 * We only allow '_' and alphanumeric chars. Non-printable
1849 * map to 'x' and all others map to '_'
1851 * @param src string to clean up
1852 * @param dest cleaned up, pre-allocated string
1853 * @return Status value indicating whether the cleaning was successful or not.
1855 AP_DECLARE(apr_status_t) ap_str2_alnum(const char *src, char *dest);
1858 * Structure to store the contents of an HTTP form of the type
1859 * application/x-www-form-urlencoded.
1861 * Currently it contains the name as a char* of maximum length
1862 * HUGE_STRING_LEN, and a value in the form of a bucket brigade
1863 * of arbitrary length.
1867 apr_bucket_brigade *value;
1871 * Read the body and parse any form found, which must be of the
1872 * type application/x-www-form-urlencoded.
1873 * @param r request containing POSTed form data
1875 * @param ptr returned array of ap_form_pair_t
1876 * @param num max num of params or -1 for unlimited
1877 * @param size max size allowed for parsed data
1878 * @return OK or HTTP error
1880 AP_DECLARE(int) ap_parse_form_data(request_rec *r, struct ap_filter_t *f,
1881 apr_array_header_t **ptr,
1882 apr_size_t num, apr_size_t size);
1884 /* Misc system hackery */
1886 * Given the name of an object in the file system determine if it is a directory
1887 * @param p The pool to allocate from
1888 * @param name The name of the object to check
1889 * @return 1 if it is a directory, 0 otherwise
1891 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1894 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1895 * @param p The pool to allocate from
1896 * @param name The name of the object to check
1897 * @return 1 if it is a directory, 0 otherwise
1899 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1902 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1903 #endif /* _OSD_POSIX */
1906 * Determine the local host name for the current machine
1907 * @param p The pool to allocate from
1908 * @return A copy of the local host name
1910 char *ap_get_local_host(apr_pool_t *p);
1913 * Log an assertion to the error log
1914 * @param szExp The assertion that failed
1915 * @param szFile The file the assertion is in
1916 * @param nLine The line the assertion is defined on
1918 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1919 __attribute__((noreturn));
1922 * @internal Internal Assert function
1924 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1927 * Redefine assert() to something more useful for an Apache...
1929 * Use ap_assert() if the condition should always be checked.
1930 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1934 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1936 #define AP_DEBUG_ASSERT(exp) ((void)0)
1940 * @defgroup stopsignal Flags which indicate places where the server should stop for debugging.
1942 * A set of flags which indicate places where the server should raise(SIGSTOP).
1943 * This is useful for debugging, because you can then attach to that process
1944 * with gdb and continue. This is important in cases where one_process
1945 * debugging isn't possible.
1947 /** stop on a Detach */
1948 #define SIGSTOP_DETACH 1
1949 /** stop making a child process */
1950 #define SIGSTOP_MAKE_CHILD 2
1951 /** stop spawning a child process */
1952 #define SIGSTOP_SPAWN_CHILD 4
1953 /** stop spawning a child process with a piped log */
1954 #define SIGSTOP_PIPED_LOG_SPAWN 8
1955 /** stop spawning a CGI child process */
1956 #define SIGSTOP_CGI_CHILD 16
1958 /** Macro to get GDB started */
1959 #ifdef DEBUG_SIGSTOP
1960 extern int raise_sigstop_flags;
1961 #define RAISE_SIGSTOP(x) do { \
1962 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1965 #define RAISE_SIGSTOP(x)
1969 * Get HTML describing the address and (optionally) admin of the server.
1970 * @param prefix Text which is prepended to the return value
1971 * @param r The request_rec
1972 * @return HTML describing the server, allocated in @a r's pool.
1974 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1976 /** strtoul does not exist on sunos4. */
1980 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1982 /* The C library has functions that allow const to be silently dropped ...
1983 these macros detect the drop in maintainer mode, but use the native
1984 methods for normal builds
1986 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1987 to be included before the macros are defined or compilation will fail.
1991 AP_DECLARE(char *) ap_strchr(char *s, int c);
1992 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
1993 AP_DECLARE(char *) ap_strrchr(char *s, int c);
1994 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
1995 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
1996 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
2001 # define strchr(s, c) ap_strchr(s,c)
2003 # define strrchr(s, c) ap_strrchr(s,c)
2005 # define strstr(s, c) ap_strstr(s,c)
2009 /** use this instead of strchr */
2010 # define ap_strchr(s, c) strchr(s, c)
2011 /** use this instead of strchr */
2012 # define ap_strchr_c(s, c) strchr(s, c)
2013 /** use this instead of strrchr */
2014 # define ap_strrchr(s, c) strrchr(s, c)
2015 /** use this instead of strrchr */
2016 # define ap_strrchr_c(s, c) strrchr(s, c)
2017 /** use this instead of strrstr*/
2018 # define ap_strstr(s, c) strstr(s, c)
2019 /** use this instead of strrstr*/
2020 # define ap_strstr_c(s, c) strstr(s, c)
2024 #define AP_NORESTART APR_OS_START_USEERR + 1
2030 #endif /* !APACHE_HTTPD_H */
2032 /** @} //APACHE Daemon */
2033 /** @} //APACHE Core */
2034 /** @} //APACHE super group */