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 HTTP Server
23 * Top level group of which all other groups are a member
26 * @defgroup APACHE_MODS Loadable modules
27 * Top level group for modules
28 * @defgroup APACHE_OS Operating System Specific
29 * @defgroup APACHE_INTERNAL Internal interfaces
30 * @defgroup APACHE_CORE Core routines
32 * @defgroup APACHE_CORE_DAEMON HTTP Daemon Routine
36 #ifndef APACHE_HTTPD_H
37 #define APACHE_HTTPD_H
39 /* XXX - We need to push more stuff to other .h files, or even .c files, to
40 * make this file smaller
43 /* Headers in which EVERYONE has an interest... */
44 #include "ap_config.h"
47 #include "ap_release.h"
50 #include "apr_general.h"
51 #include "apr_tables.h"
52 #include "apr_pools.h"
54 #include "apr_network_io.h"
55 #include "apr_buckets.h"
57 #include "apr_thread_proc.h"
67 /* Note: apr_uri.h is also included, see below */
73 /* ----------------------------- config dir ------------------------------ */
75 /** Define this to be the default server home dir. Most things later in this
76 * file with a relative pathname will have this added.
80 /** Set default for OS/2 file system */
81 #define HTTPD_ROOT "/os2httpd"
83 /** Set default for Windows file system */
84 #define HTTPD_ROOT "/apache"
85 #elif defined (NETWARE)
86 /** Set the default for NetWare */
87 #define HTTPD_ROOT "/apache"
89 /** Set for all other OSs */
90 #define HTTPD_ROOT "/usr/local/apache"
92 #endif /* HTTPD_ROOT */
95 * --------- You shouldn't have to edit anything below this line ----------
97 * Any modifications to any defaults not defined above should be done in the
98 * respective configuration file.
103 * Default location of documents. Can be overridden by the DocumentRoot
106 #ifndef DOCUMENT_LOCATION
108 /* Set default for OS/2 file system */
109 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
111 /* Set default for non OS/2 file system */
112 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
114 #endif /* DOCUMENT_LOCATION */
116 /** Maximum number of dynamically loaded modules */
117 #ifndef DYNAMIC_MODULE_LIMIT
118 #define DYNAMIC_MODULE_LIMIT 256
121 /** Default administrator's address */
122 #define DEFAULT_ADMIN "[no address given]"
124 /** The name of the log files */
125 #ifndef DEFAULT_ERRORLOG
126 #if defined(OS2) || defined(WIN32)
127 #define DEFAULT_ERRORLOG "logs/error.log"
129 #define DEFAULT_ERRORLOG "logs/error_log"
131 #endif /* DEFAULT_ERRORLOG */
133 /** Define this to be what your per-directory security files are called */
134 #ifndef DEFAULT_ACCESS_FNAME
136 /* Set default for OS/2 file system */
137 #define DEFAULT_ACCESS_FNAME "htaccess"
139 #define DEFAULT_ACCESS_FNAME ".htaccess"
141 #endif /* DEFAULT_ACCESS_FNAME */
143 /** The name of the server config file */
144 #ifndef SERVER_CONFIG_FILE
145 #define SERVER_CONFIG_FILE "conf/httpd.conf"
148 /** The default path for CGI scripts if none is currently set */
150 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
153 /** The path to the suExec wrapper, can be overridden in Configuration */
155 #define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
158 /** The timeout for waiting for messages */
159 #ifndef DEFAULT_TIMEOUT
160 #define DEFAULT_TIMEOUT 60
163 /** The timeout for waiting for keepalive timeout until next request */
164 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
165 #define DEFAULT_KEEPALIVE_TIMEOUT 5
168 /** The number of requests to entertain per connection */
169 #ifndef DEFAULT_KEEPALIVE
170 #define DEFAULT_KEEPALIVE 100
174 * Limits on the size of various request items. These limits primarily
175 * exist to prevent simple denial-of-service attacks on a server based
176 * on misuse of the protocol. The recommended values will depend on the
177 * nature of the server resources -- CGI scripts and database backends
178 * might require large values, but most servers could get by with much
179 * smaller limits than we use below. The request message body size can
180 * be limited by the per-dir config directive LimitRequestBody.
182 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
183 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
184 * These two limits can be lowered or raised by the server config
185 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
187 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
188 * the server config directive LimitRequestFields.
191 /** default limit on bytes in Request-Line (Method+URI+HTTP-version) */
192 #ifndef DEFAULT_LIMIT_REQUEST_LINE
193 #define DEFAULT_LIMIT_REQUEST_LINE 8190
195 /** default limit on bytes in any one header field */
196 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
197 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
199 /** default limit on number of request header fields */
200 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
201 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
205 * The default default character set name to add if AddDefaultCharset is
206 * enabled. Overridden with AddDefaultCharsetName.
208 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
210 /** default HTTP Server protocol */
211 #define AP_SERVER_PROTOCOL "HTTP/1.1"
214 /* ------------------ stuff that modules are allowed to look at ----------- */
216 /** Define this to be what your HTML directory content files are called */
217 #ifndef AP_DEFAULT_INDEX
218 #define AP_DEFAULT_INDEX "index.html"
221 /** The name of the MIME types file */
222 #ifndef AP_TYPES_CONFIG_FILE
223 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
227 * Define the HTML doctype strings centrally.
229 /** HTML 2.0 Doctype */
230 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
231 "DTD HTML 2.0//EN\">\n"
232 /** HTML 3.2 Doctype */
233 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
234 "DTD HTML 3.2 Final//EN\">\n"
235 /** HTML 4.0 Strict Doctype */
236 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
237 "DTD HTML 4.0//EN\"\n" \
238 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
239 /** HTML 4.0 Transitional Doctype */
240 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
241 "DTD HTML 4.0 Transitional//EN\"\n" \
242 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
243 /** HTML 4.0 Frameset Doctype */
244 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
245 "DTD HTML 4.0 Frameset//EN\"\n" \
246 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
247 /** XHTML 1.0 Strict Doctype */
248 #define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
249 "DTD XHTML 1.0 Strict//EN\"\n" \
250 "\"http://www.w3.org/TR/xhtml1/DTD/" \
251 "xhtml1-strict.dtd\">\n"
252 /** XHTML 1.0 Transitional Doctype */
253 #define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
254 "DTD XHTML 1.0 Transitional//EN\"\n" \
255 "\"http://www.w3.org/TR/xhtml1/DTD/" \
256 "xhtml1-transitional.dtd\">\n"
257 /** XHTML 1.0 Frameset Doctype */
258 #define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
259 "DTD XHTML 1.0 Frameset//EN\"\n" \
260 "\"http://www.w3.org/TR/xhtml1/DTD/" \
261 "xhtml1-frameset.dtd\">"
263 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
264 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
265 /** Major part of HTTP protocol */
266 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
267 /** Minor part of HTTP protocol */
268 #define HTTP_VERSION_MINOR(number) ((number)%1000)
270 /* -------------- Port number for server running standalone --------------- */
272 /** default HTTP Port */
273 #define DEFAULT_HTTP_PORT 80
274 /** default HTTPS Port */
275 #define DEFAULT_HTTPS_PORT 443
277 * Check whether @a port is the default port for the request @a r.
278 * @param port The port number
279 * @param r The request
280 * @see #ap_default_port
282 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
284 * Get the default port for a request (which depends on the scheme).
285 * @param r The request
287 #define ap_default_port(r) ap_run_default_port(r)
289 * Get the scheme for a request.
290 * @param r The request
292 #define ap_http_scheme(r) ap_run_http_scheme(r)
294 /** The default string length */
295 #define MAX_STRING_LEN HUGE_STRING_LEN
297 /** The length of a Huge string */
298 #define HUGE_STRING_LEN 8192
300 /** The size of the server's internal read-write buffers */
301 #define AP_IOBUFSIZE 8192
303 /** The max number of regex captures that can be expanded by ap_pregsub */
304 #define AP_MAX_REG_MATCH 10
307 * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
308 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
309 * than that in case the brigade code/filters attempt to read it directly.
310 * ### 16mb is an invention, no idea if it is reasonable.
312 #define AP_MAX_SENDFILE 16777216 /* 2^24 */
315 * Special Apache error codes. These are basically used
316 * in http_main.c so we can keep track of various errors.
320 #define APEXIT_OK 0x0
321 /** A fatal error arising during the server's init sequence */
322 #define APEXIT_INIT 0x2
323 /** The child died during its init sequence */
324 #define APEXIT_CHILDINIT 0x3
326 * The child exited due to a resource shortage.
327 * The parent should limit the rate of forking until
328 * the situation is resolved.
330 #define APEXIT_CHILDSICK 0x7
332 * A fatal error, resulting in the whole server aborting.
333 * If a child exits with this error, the parent process
334 * considers this a server-wide fatal error and aborts.
336 #define APEXIT_CHILDFATAL 0xf
340 * Stuff marked #AP_DECLARE is part of the API, and intended for use
341 * by modules. Its purpose is to allow us to add attributes that
342 * particular platforms or compilers require to every exported function.
344 # define AP_DECLARE(type) type
347 #ifndef AP_DECLARE_NONSTD
349 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
350 * use by modules. The difference between #AP_DECLARE and
351 * #AP_DECLARE_NONSTD is that the latter is required for any functions
352 * which use varargs or are used via indirect function call. This
353 * is to accomodate the two calling conventions in windows dlls.
355 # define AP_DECLARE_NONSTD(type) type
357 #ifndef AP_DECLARE_DATA
358 # define AP_DECLARE_DATA
361 #ifndef AP_MODULE_DECLARE
362 # define AP_MODULE_DECLARE(type) type
364 #ifndef AP_MODULE_DECLARE_NONSTD
365 # define AP_MODULE_DECLARE_NONSTD(type) type
367 #ifndef AP_MODULE_DECLARE_DATA
368 # define AP_MODULE_DECLARE_DATA
373 * modules should not use functions marked AP_CORE_DECLARE
375 #ifndef AP_CORE_DECLARE
376 # define AP_CORE_DECLARE AP_DECLARE
381 * modules should not use functions marked AP_CORE_DECLARE_NONSTD
384 #ifndef AP_CORE_DECLARE_NONSTD
385 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
389 * @brief The numeric version information is broken out into fields within this
393 int major; /**< major number */
394 int minor; /**< minor number */
395 int patch; /**< patch number */
396 const char *add_string; /**< additional string like "-dev" */
400 * Return httpd's version information in a numeric form.
402 * @param version Pointer to a version structure for returning the version
405 AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
408 * Get the server banner in a form suitable for sending over the
409 * network, with the level of information controlled by the
410 * ServerTokens directive.
411 * @return The server banner
413 AP_DECLARE(const char *) ap_get_server_banner(void);
416 * Get the server description in a form suitable for local displays,
417 * status reports, or logging. This includes the detailed server
418 * version and information about some modules. It is not affected
419 * by the ServerTokens directive.
420 * @return The server description
422 AP_DECLARE(const char *) ap_get_server_description(void);
425 * Add a component to the server description and banner strings
426 * @param pconf The pool to allocate the component from
427 * @param component The string to add
429 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
432 * Get the date a time that the server was built
433 * @return The server build time string
435 AP_DECLARE(const char *) ap_get_server_built(void);
437 /* non-HTTP status codes returned by hooks */
439 #define OK 0 /**< Module has handled this stage. */
440 #define DECLINED -1 /**< Module declines to handle */
441 #define DONE -2 /**< Module has served the response completely
442 * - it's safe to die() with no more output
444 #define SUSPENDED -3 /**< Module will handle the remainder of the request.
445 * The core will never invoke the request again, */
447 /** Returned by the bottom-most filter if no data was written.
448 * @see ap_pass_brigade(). */
449 #define AP_NOBODY_WROTE -100
450 /** Returned by the bottom-most filter if no data was read.
451 * @see ap_get_brigade(). */
452 #define AP_NOBODY_READ -101
453 /** Returned by any filter if the filter chain encounters an error
454 * and has already dealt with the error response.
456 #define AP_FILTER_ERROR -102
459 * @defgroup HTTP_Status HTTP Status Codes
463 * The size of the static array in http_protocol.c for storing
464 * all of the potential response status-lines (a sparse table).
465 * A future version should dynamically generate the apr_table_t at startup.
467 #define RESPONSE_CODES 57
469 #define HTTP_CONTINUE 100
470 #define HTTP_SWITCHING_PROTOCOLS 101
471 #define HTTP_PROCESSING 102
473 #define HTTP_CREATED 201
474 #define HTTP_ACCEPTED 202
475 #define HTTP_NON_AUTHORITATIVE 203
476 #define HTTP_NO_CONTENT 204
477 #define HTTP_RESET_CONTENT 205
478 #define HTTP_PARTIAL_CONTENT 206
479 #define HTTP_MULTI_STATUS 207
480 #define HTTP_MULTIPLE_CHOICES 300
481 #define HTTP_MOVED_PERMANENTLY 301
482 #define HTTP_MOVED_TEMPORARILY 302
483 #define HTTP_SEE_OTHER 303
484 #define HTTP_NOT_MODIFIED 304
485 #define HTTP_USE_PROXY 305
486 #define HTTP_TEMPORARY_REDIRECT 307
487 #define HTTP_BAD_REQUEST 400
488 #define HTTP_UNAUTHORIZED 401
489 #define HTTP_PAYMENT_REQUIRED 402
490 #define HTTP_FORBIDDEN 403
491 #define HTTP_NOT_FOUND 404
492 #define HTTP_METHOD_NOT_ALLOWED 405
493 #define HTTP_NOT_ACCEPTABLE 406
494 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
495 #define HTTP_REQUEST_TIME_OUT 408
496 #define HTTP_CONFLICT 409
497 #define HTTP_GONE 410
498 #define HTTP_LENGTH_REQUIRED 411
499 #define HTTP_PRECONDITION_FAILED 412
500 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
501 #define HTTP_REQUEST_URI_TOO_LARGE 414
502 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
503 #define HTTP_RANGE_NOT_SATISFIABLE 416
504 #define HTTP_EXPECTATION_FAILED 417
505 #define HTTP_UNPROCESSABLE_ENTITY 422
506 #define HTTP_LOCKED 423
507 #define HTTP_FAILED_DEPENDENCY 424
508 #define HTTP_UPGRADE_REQUIRED 426
509 #define HTTP_INTERNAL_SERVER_ERROR 500
510 #define HTTP_NOT_IMPLEMENTED 501
511 #define HTTP_BAD_GATEWAY 502
512 #define HTTP_SERVICE_UNAVAILABLE 503
513 #define HTTP_GATEWAY_TIME_OUT 504
514 #define HTTP_VERSION_NOT_SUPPORTED 505
515 #define HTTP_VARIANT_ALSO_VARIES 506
516 #define HTTP_INSUFFICIENT_STORAGE 507
517 #define HTTP_NOT_EXTENDED 510
519 /** is the status code informational */
520 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
521 /** is the status code OK ?*/
522 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
523 /** is the status code a redirect */
524 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
525 /** is the status code a error (client or server) */
526 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
527 /** is the status code a client error */
528 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
529 /** is the status code a server error */
530 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
531 /** is the status code a (potentially) valid response code? */
532 #define ap_is_HTTP_VALID_RESPONSE(x) (((x) >= 100)&&((x) < 600))
534 /** should the status code drop the connection */
535 #define ap_status_drops_connection(x) \
536 (((x) == HTTP_BAD_REQUEST) || \
537 ((x) == HTTP_REQUEST_TIME_OUT) || \
538 ((x) == HTTP_LENGTH_REQUIRED) || \
539 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
540 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
541 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
542 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
543 ((x) == HTTP_NOT_IMPLEMENTED))
547 * @defgroup Methods List of Methods recognized by the server
548 * @ingroup APACHE_CORE_DAEMON
551 * @brief Methods recognized (but not necessarily handled) by the server.
553 * These constants are used in bit shifting masks of size int, so it is
554 * unsafe to have more methods than bits in an int. HEAD == M_GET.
555 * This list must be tracked by the list in http_protocol.c in routine
556 * ap_method_name_of().
560 #define M_GET 0 /** RFC 2616: HTTP */
561 #define M_PUT 1 /* : */
566 #define M_TRACE 6 /** RFC 2616: HTTP */
567 #define M_PATCH 7 /** no rfc(!) ### remove this one? */
568 #define M_PROPFIND 8 /** RFC 2518: WebDAV */
569 #define M_PROPPATCH 9 /* : */
574 #define M_UNLOCK 14 /** RFC 2518: WebDAV */
575 #define M_VERSION_CONTROL 15 /** RFC 3253: WebDAV Versioning */
576 #define M_CHECKOUT 16 /* : */
577 #define M_UNCHECKOUT 17
582 #define M_MKWORKSPACE 22
583 #define M_MKACTIVITY 23
584 #define M_BASELINE_CONTROL 24
586 #define M_INVALID 26 /** RFC 3253: WebDAV Versioning */
589 * METHODS needs to be equal to the number of bits
590 * we are using for limit masks.
595 * The method mask bit to shift for anding with a bitmask.
597 #define AP_METHOD_BIT ((apr_int64_t)1)
601 /** @see ap_method_list_t */
602 typedef struct ap_method_list_t ap_method_list_t;
605 * @struct ap_method_list_t
606 * @brief Structure for handling HTTP methods.
608 * Methods known to the server are accessed via a bitmask shortcut;
609 * extension methods are handled by an array.
611 struct ap_method_list_t {
612 /** The bitmask used for known methods */
613 apr_int64_t method_mask;
614 /** the array used for extension methods */
615 apr_array_header_t *method_list;
619 * @defgroup module_magic Module Magic mime types
622 /** Magic for mod_cgi[d] */
623 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
624 /** Magic for mod_include */
625 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
626 /** Magic for mod_include */
627 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
628 /** Magic for mod_dir */
629 #define DIR_MAGIC_TYPE "httpd/unix-directory"
632 /* Just in case your linefeed isn't the one the other end is expecting. */
633 #if !APR_CHARSET_EBCDIC
636 /** carrige return */
638 /** carrige return /Line Feed Combo */
639 #define CRLF "\015\012"
640 #else /* APR_CHARSET_EBCDIC */
641 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
642 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
643 * "native EBCDIC" CR and NL characters. These are therefore
650 #endif /* APR_CHARSET_EBCDIC */
651 /** Useful for common code with either platform charset. */
652 #define CRLF_ASCII "\015\012"
655 * @defgroup values_request_rec_body Possible values for request_rec.read_body
657 * Possible values for request_rec.read_body (set by handling module):
660 /** Send 413 error if message has any body */
661 #define REQUEST_NO_BODY 0
662 /** Send 411 error if body without Content-Length */
663 #define REQUEST_CHUNKED_ERROR 1
664 /** If chunked, remove the chunks for me. */
665 #define REQUEST_CHUNKED_DECHUNK 2
666 /** @} // values_request_rec_body */
669 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
670 * @ingroup APACHE_CORE_DAEMON
672 * Possible values for request_rec.used_path_info:
675 /** Accept the path_info from the request */
676 #define AP_REQ_ACCEPT_PATH_INFO 0
677 /** Return a 404 error if path_info was given */
678 #define AP_REQ_REJECT_PATH_INFO 1
679 /** Module may chose to use the given path_info */
680 #define AP_REQ_DEFAULT_PATH_INFO 2
682 /** @} // values_request_rec_used_path_info */
686 * Things which may vary per file-lookup WITHIN a request ---
687 * e.g., state of MIME config. Basically, the name of an object, info
688 * about the object, and any other info we may ahve which may need to
689 * change as we go poking around looking for it (e.g., overridden by
692 * Note how the default state of almost all these things is properly
693 * zero, so that allocating it with pcalloc does the right thing without
694 * a whole lot of hairy initialization... so long as we are willing to
695 * make the (fairly) portable assumption that the bit pattern of a NULL
696 * pointer is, in fact, zero.
700 * @brief This represents the result of calling htaccess; these are cached for
703 struct htaccess_result {
704 /** the directory to which this applies */
706 /** the overrides allowed for the .htaccess file */
708 /** the override options allowed for the .htaccess file */
710 /** Table of allowed directives for override */
711 apr_table_t *override_list;
712 /** the configuration directives */
713 struct ap_conf_vector_t *htaccess;
714 /** the next one, or NULL if no more; N.B. never change this */
715 const struct htaccess_result *next;
718 /* The following four types define a hierarchy of activities, so that
719 * given a request_rec r you can write r->connection->server->process
720 * to get to the process_rec. While this reduces substantially the
721 * number of arguments that various hooks require beware that in
722 * threaded versions of the server you must consider multiplexing
726 /** A structure that represents one process */
727 typedef struct process_rec process_rec;
728 /** A structure that represents a virtual server */
729 typedef struct server_rec server_rec;
730 /** A structure that represents one connection */
731 typedef struct conn_rec conn_rec;
732 /** A structure that represents the current request */
733 typedef struct request_rec request_rec;
734 /** A structure that represents the status of the current connection */
735 typedef struct conn_state_t conn_state_t;
737 /* ### would be nice to not include this from httpd.h ... */
738 /* This comes after we have defined the request_rec type */
742 * @brief A structure that represents one process
745 /** Global pool. Cleared upon normal exit */
747 /** Configuration pool. Cleared upon restart */
749 /** The program name used to execute the program */
750 const char *short_name;
751 /** The command line arguments */
752 const char * const *argv;
753 /** Number of command line arguments passed to the program */
758 * @brief A structure that represents the current request
761 /** The pool associated with the request */
763 /** The connection to the client */
764 conn_rec *connection;
765 /** The virtual host for this request */
768 /** Pointer to the redirected request if this is an external redirect */
770 /** Pointer to the previous request if this is an internal redirect */
773 /** Pointer to the main request if this is a sub-request
774 * (see http_request.h) */
777 /* Info about the request itself... we begin with stuff that only
778 * protocol.c should ever touch...
780 /** First line of request */
782 /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
784 /** A proxy request (calculated during post_read_request/translate_name)
785 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
789 /** HEAD request, as opposed to GET */
791 /** Protocol version number of protocol; 1.1 = 1001 */
793 /** Protocol string, as given to us, or HTTP/0.9 */
795 /** Host, as set by full URI or Host: */
796 const char *hostname;
798 /** Time when the request started */
799 apr_time_t request_time;
801 /** Status line, if set by script */
802 const char *status_line;
806 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
807 * look, but don't touch.
810 /** M_GET, M_POST, etc. */
812 /** Request method (eg. GET, HEAD, POST, etc.) */
816 * 'allowed' is a bitvector of the allowed methods.
818 * A handler must ensure that the request method is one that
819 * it is capable of handling. Generally modules should DECLINE
820 * any request methods they do not handle. Prior to aborting the
821 * handler like this the handler should set r->allowed to the list
822 * of methods that it is willing to handle. This bitvector is used
823 * to construct the "Allow:" header required for OPTIONS requests,
824 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
826 * Since the default_handler deals with OPTIONS, all modules can
827 * usually decline to deal with OPTIONS. TRACE is always allowed,
828 * modules don't need to set it explicitly.
830 * Since the default_handler will always handle a GET, a
831 * module which does *not* implement GET should probably return
832 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
833 * handler can't be installed by mod_actions.
836 /** Array of extension methods */
837 apr_array_header_t *allowed_xmethods;
838 /** List of allowed methods */
839 ap_method_list_t *allowed_methods;
841 /** byte count in stream is for body */
842 apr_off_t sent_bodyct;
843 /** body byte count, for easy access */
844 apr_off_t bytes_sent;
845 /** Last modified time of the requested resource */
848 /* HTTP/1.1 connection-level features */
850 /** The Range: header */
852 /** The "real" content length */
854 /** sending chunked transfer-coding */
857 /** Method for reading the request body
858 * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
859 * REQUEST_CHUNKED_DECHUNK, etc...) */
861 /** reading chunked transfer-coding */
863 /** is client waiting for a 100 response? */
864 unsigned expecting_100;
865 /** The optional kept body of the request. */
866 apr_bucket_brigade *kept_body;
867 /** For ap_body_to_table(): parsed body */
868 /* XXX: ap_body_to_table has been removed. Remove body_table too or
869 * XXX: keep it to reintroduce ap_body_to_table without major bump? */
870 apr_table_t *body_table;
871 /** Remaining bytes left to read from the request body */
873 /** Number of bytes that have been read from the request body */
874 apr_off_t read_length;
876 /* MIME header environments, in and out. Also, an array containing
877 * environment variables to be passed to subprocesses, so people can
878 * write modules to add to that environment.
880 * The difference between headers_out and err_headers_out is that the
881 * latter are printed even on error, and persist across internal redirects
882 * (so the headers printed for ErrorDocument handlers will have them).
884 * The 'notes' apr_table_t is for notes from one module to another, with no
885 * other set purpose in mind...
888 /** MIME header environment from the request */
889 apr_table_t *headers_in;
890 /** MIME header environment for the response */
891 apr_table_t *headers_out;
892 /** MIME header environment for the response, printed even on errors and
893 * persist across internal redirects */
894 apr_table_t *err_headers_out;
895 /** Array of environment variables to be used for sub processes */
896 apr_table_t *subprocess_env;
897 /** Notes from one module to another */
900 /* content_type, handler, content_encoding, and all content_languages
901 * MUST be lowercased strings. They may be pointers to static strings;
902 * they should not be modified in place.
904 /** The content-type for the current request */
905 const char *content_type; /* Break these out --- we dispatch on 'em */
906 /** The handler string that we use to call a handler function */
907 const char *handler; /* What we *really* dispatch on */
909 /** How to encode the data */
910 const char *content_encoding;
911 /** Array of strings representing the content languages */
912 apr_array_header_t *content_languages;
914 /** variant list validator (if negotiated) */
915 char *vlist_validator;
917 /** If an authentication check was made, this gets set to the user name. */
919 /** If an authentication check was made, this gets set to the auth type. */
922 /* What object is being requested (either directly, or via include
923 * or content-negotiation mapping).
926 /** The URI without any parsing performed */
928 /** The path portion of the URI, or "/" if no path provided */
930 /** The filename on disk corresponding to this response */
932 /* XXX: What does this mean? Please define "canonicalize" -aaron */
933 /** The true filename, we canonicalize r->filename if these don't match */
934 char *canonical_filename;
935 /** The PATH_INFO extracted from this request */
937 /** The QUERY_ARGS extracted from this request */
941 * Flag for the handler to accept or reject path_info on
942 * the current request. All modules should respect the
943 * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
944 * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
945 * may follow existing conventions. This is set to the
946 * user's preference upon HOOK_VERY_FIRST of the fixups.
950 /** A flag to determine if the eos bucket has been sent yet */
953 /* Various other config info which may change with .htaccess files
954 * These are config vectors, with one void* pointer for each module
955 * (the thing pointed to being the module's business).
958 /** Options set in config files, etc. */
959 struct ap_conf_vector_t *per_dir_config;
960 /** Notes on *this* request */
961 struct ap_conf_vector_t *request_config;
963 /** Optional request log level configuration. Will usually point
964 * to a server or per_dir config, i.e. must be copied before
966 const struct ap_logconf *log;
968 /** Id to identify request in access and error log. Set when the first
969 * error log entry for this request is generated.
974 * A linked list of the .htaccess configuration directives
975 * accessed by this request.
976 * N.B. always add to the head of the list, _never_ to the end.
977 * that way, a sub request's list can (temporarily) point to a parent's list
979 const struct htaccess_result *htaccess;
981 /** A list of output filters to be used for this request */
982 struct ap_filter_t *output_filters;
983 /** A list of input filters to be used for this request */
984 struct ap_filter_t *input_filters;
986 /** A list of protocol level output filters to be used for this
988 struct ap_filter_t *proto_output_filters;
989 /** A list of protocol level input filters to be used for this
991 struct ap_filter_t *proto_input_filters;
993 /** This response can not be cached */
995 /** There is no local copy of this response */
998 /** Mutex protect callbacks registered with ap_mpm_register_timed_callback
999 * from being run before the original handler finishes running
1001 apr_thread_mutex_t *invoke_mtx;
1003 /** A struct containing the components of URI */
1004 apr_uri_t parsed_uri;
1005 /** finfo.protection (st_mode) set to zero if no such file */
1008 /** remote address information from conn_rec, can be overridden if
1009 * necessary by a module.
1011 apr_sockaddr_t *useragent_addr;
1016 * @defgroup ProxyReq Proxy request types
1018 * Possible values of request_rec->proxyreq. A request could be normal,
1019 * proxied or reverse proxied. Normally proxied and reverse proxied are
1020 * grouped together as just "proxied", but sometimes it's necessary to
1021 * tell the difference between the two, such as for authentication.
1025 #define PROXYREQ_NONE 0 /**< No proxy */
1026 #define PROXYREQ_PROXY 1 /**< Standard proxy */
1027 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
1028 #define PROXYREQ_RESPONSE 3 /**< Origin response */
1033 * @brief Enumeration of connection keepalive options
1039 } ap_conn_keepalive_e;
1042 * @brief Structure to store things which are per connection
1045 /** Pool associated with this connection */
1047 /** Physical vhost this conn came in on */
1048 server_rec *base_server;
1049 /** used by http_vhost.c */
1050 void *vhost_lookup_data;
1052 /* Information about the connection itself */
1053 /** local address */
1054 apr_sockaddr_t *local_addr;
1055 /** remote address */
1056 apr_sockaddr_t *peer_addr;
1058 /** Client's IP address */
1060 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
1061 * "" if it has and no address was found. N.B. Only access this though
1062 * get_remote_host() */
1064 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
1065 * get_remote_logname() */
1066 char *remote_logname;
1068 /** server IP address */
1070 /** used for ap_get_server_name when UseCanonicalName is set to DNS
1071 * (ignores setting of HostnameLookups) */
1074 /** ID of this connection; unique at any point in time */
1076 /** Config vector containing pointers to connections per-server
1077 * config structures. */
1078 struct ap_conf_vector_t *conn_config;
1079 /** Notes on *this* connection: send note from one module to
1080 * another. must remain valid for all requests on this conn */
1082 /** A list of input filters to be used for this connection */
1083 struct ap_filter_t *input_filters;
1084 /** A list of output filters to be used for this connection */
1085 struct ap_filter_t *output_filters;
1086 /** handle to scoreboard information for this connection */
1088 /** The bucket allocator to use for all bucket/brigade creations */
1089 struct apr_bucket_alloc_t *bucket_alloc;
1090 /** The current state of this connection; may be NULL if not used by MPM */
1092 /** Is there data pending in the input filters? */
1093 int data_in_input_filters;
1094 /** Is there data pending in the output filters? */
1095 int data_in_output_filters;
1097 /** Are there any filters that clogg/buffer the input stream, breaking
1100 unsigned int clogging_input_filters:1;
1102 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1104 signed int double_reverse:2;
1106 /** Are we still talking? */
1109 /** Are we going to keep the connection alive for another request?
1110 * @see ap_conn_keepalive_e */
1111 ap_conn_keepalive_e keepalive;
1113 /** How many times have we used it? */
1116 /** Optional connection log level configuration. May point to a server or
1117 * per_dir config, i.e. must be copied before modifying */
1118 const struct ap_logconf *log;
1120 /** Id to identify this connection in error log. Set when the first
1121 * error log entry for this connection is generated.
1126 /** This points to the current thread being used to process this request,
1127 * over the lifetime of a request, the value may change. Users of the connection
1128 * record should not rely upon it staying the same between calls that invole
1132 apr_thread_t *current_thread;
1137 * Enumeration of connection states
1140 CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1141 CONN_STATE_READ_REQUEST_LINE,
1143 CONN_STATE_WRITE_COMPLETION,
1144 CONN_STATE_SUSPENDED,
1146 CONN_STATE_LINGER_NORMAL,
1147 CONN_STATE_LINGER_SHORT
1151 * @brief A structure to contain connection state information
1153 struct conn_state_t {
1154 /** Current state of the connection */
1158 /* Per-vhost config... */
1161 * The address 255.255.255.255, when used as a virtualhost address,
1162 * will become the "default" server when the ip doesn't match other vhosts.
1164 #define DEFAULT_VHOST_ADDR 0xfffffffful
1168 * @struct server_addr_rec
1169 * @brief A structure to be used for Per-vhost config
1171 typedef struct server_addr_rec server_addr_rec;
1172 struct server_addr_rec {
1173 /** The next server in the list */
1174 server_addr_rec *next;
1175 /** The name given in "<VirtualHost>" */
1177 /** The bound address, for this server */
1178 apr_sockaddr_t *host_addr;
1179 /** The bound port, for this server */
1180 apr_port_t host_port;
1184 /** The per-module log levels */
1185 signed char *module_levels;
1187 /** The log level for this server */
1191 * @brief A structure to store information for each virtual server
1194 /** The process this server is running in */
1195 process_rec *process;
1196 /** The next server in the list */
1199 /* Log files --- note that transfer log is now in the modules... */
1201 /** The name of the error log */
1203 /** A file descriptor that references the error log */
1204 apr_file_t *error_log;
1205 /** The log level configuration */
1206 struct ap_logconf log;
1208 /* Module-specific configuration for server, and defaults... */
1210 /** Config vector containing pointers to modules' per-server config
1212 struct ap_conf_vector_t *module_config;
1213 /** MIME type info, etc., before we start checking per-directory info */
1214 struct ap_conf_vector_t *lookup_defaults;
1216 /** The name of the server */
1217 const char *defn_name;
1218 /** The line of the config file that the server was defined on */
1219 unsigned defn_line_number;
1220 /** true if this is the virtual server */
1224 /* Information for redirects */
1226 /** for redirects, etc. */
1228 /** The server request scheme for redirect responses */
1229 const char *server_scheme;
1231 /* Contact information */
1233 /** The admin's contact information */
1235 /** The server hostname */
1236 char *server_hostname;
1238 /* Transaction handling */
1240 /** I haven't got a clue */
1241 server_addr_rec *addrs;
1242 /** Timeout, as an apr interval, before we give up */
1243 apr_interval_time_t timeout;
1244 /** The apr interval we will wait for another request */
1245 apr_interval_time_t keep_alive_timeout;
1246 /** Maximum requests per connection */
1248 /** Use persistent connections? */
1251 /** Normal names for ServerAlias servers */
1252 apr_array_header_t *names;
1253 /** Wildcarded names for ServerAlias servers */
1254 apr_array_header_t *wild_names;
1256 /** Pathname for ServerPath */
1258 /** Length of path */
1261 /** limit on size of the HTTP request line */
1263 /** limit on size of any request header field */
1264 int limit_req_fieldsize;
1265 /** limit on number of request header fields */
1266 int limit_req_fields;
1269 /** Opaque storage location */
1273 typedef struct core_output_filter_ctx {
1274 apr_bucket_brigade *buffered_bb;
1275 apr_bucket_brigade *tmp_flush_bb;
1276 apr_pool_t *deferred_write_pool;
1277 apr_size_t bytes_in;
1278 apr_size_t bytes_written;
1279 } core_output_filter_ctx_t;
1281 typedef struct core_filter_ctx {
1282 apr_bucket_brigade *b;
1283 apr_bucket_brigade *tmpbb;
1286 typedef struct core_net_rec {
1287 /** Connection to the client */
1288 apr_socket_t *client_socket;
1290 /** connection record */
1293 core_output_filter_ctx_t *out_ctx;
1298 * Get the context_document_root for a request. This is a generalization of
1299 * the document root, which is too limited in the presence of mappers like
1300 * mod_userdir and mod_alias. The context_document_root is the directory
1301 * on disk that maps to the context_prefix URI prefix.
1302 * @param r The request
1303 * @note For resources that do not map to the file system or for very complex
1304 * mappings, this information may still be wrong.
1306 AP_DECLARE(const char *) ap_context_document_root(request_rec *r);
1309 * Get the context_prefix for a request. The context_prefix URI prefix
1310 * maps to the context_document_root on disk.
1311 * @param r The request
1313 AP_DECLARE(const char *) ap_context_prefix(request_rec *r);
1315 /** Set context_prefix and context_document_root for a request.
1316 * @param r The request
1317 * @param prefix the URI prefix, without trailing slash
1318 * @param document_root the corresponding directory on disk, without trailing
1320 * @note If one of prefix of document_root is NULL, the corrsponding
1321 * property will not be changed.
1323 AP_DECLARE(void) ap_set_context_info(request_rec *r, const char *prefix,
1324 const char *document_root);
1326 /** Set per-request document root. This is for mass virtual hosting modules
1327 * that want to provide the correct DOCUMENT_ROOT value to scripts.
1328 * @param r The request
1329 * @param document_root the document root for the request.
1331 AP_DECLARE(void) ap_set_document_root(request_rec *r, const char *document_root);
1334 * Examine a field value (such as a media-/content-type) string and return
1335 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1336 * @param p Pool to allocate memory from
1337 * @param intype The field to examine
1338 * @return A copy of the field minus any parameters
1340 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1343 * Convert a time from an integer into a string in a specified format
1344 * @param p The pool to allocate memory from
1345 * @param t The time to convert
1346 * @param fmt The format to use for the conversion
1347 * @param gmt Convert the time for GMT?
1348 * @return The string that represents the specified time
1350 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1352 /* String handling. The *_nc variants allow you to use non-const char **s as
1353 arguments (unfortunately C won't automatically convert a char ** to a const
1357 * Get the characters until the first occurance of a specified character
1358 * @param p The pool to allocate memory from
1359 * @param line The string to get the characters from
1360 * @param stop The character to stop at
1361 * @return A copy of the characters up to the first stop character
1363 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1366 * Get the characters until the first occurance of a specified character
1367 * @param p The pool to allocate memory from
1368 * @param line The string to get the characters from
1369 * @param stop The character to stop at
1370 * @return A copy of the characters up to the first stop character
1371 * @note This is the same as ap_getword(), except it doesn't use const char **.
1373 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1376 * Get the first word from a given string. A word is defined as all characters
1377 * up to the first whitespace.
1378 * @param p The pool to allocate memory from
1379 * @param line The string to traverse
1380 * @return The first word in the line
1382 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1385 * Get the first word from a given string. A word is defined as all characters
1386 * up to the first whitespace.
1387 * @param p The pool to allocate memory from
1388 * @param line The string to traverse
1389 * @return The first word in the line
1390 * @note The same as ap_getword_white(), except it doesn't use const char**
1392 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1395 * Get all characters from the first occurance of @a stop to the first "\0"
1396 * @param p The pool to allocate memory from
1397 * @param line The line to traverse
1398 * @param stop The character to start at
1399 * @return A copy of all caracters after the first occurance of the specified
1402 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1406 * Get all characters from the first occurance of @a stop to the first "\0"
1407 * @param p The pool to allocate memory from
1408 * @param line The line to traverse
1409 * @param stop The character to start at
1410 * @return A copy of all caracters after the first occurance of the specified
1412 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1414 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1417 * Get the second word in the string paying attention to quoting
1418 * @param p The pool to allocate from
1419 * @param line The line to traverse
1420 * @return A copy of the string
1422 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1425 * Get the second word in the string paying attention to quoting
1426 * @param p The pool to allocate from
1427 * @param line The line to traverse
1428 * @return A copy of the string
1429 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1431 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1434 * Check a string for any config define or environment variable construct
1435 * and replace each of them by the value of that variable, if it exists.
1436 * The default syntax of the constructs is ${ENV} but can be changed by
1437 * setting the define::* config defines. If the variable does not exist,
1438 * leave the ${ENV} construct alone but print a warning.
1439 * @param p The pool to allocate from
1440 * @param word The string to check
1441 * @return The string with the replaced environment variables
1443 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1446 * Size an HTTP header field list item, as separated by a comma.
1447 * @param field The field to size
1448 * @param len The length of the field
1449 * @return The return value is a pointer to the beginning of the non-empty
1450 * list item within the original string (or NULL if there is none) and the
1451 * address of field is shifted to the next non-comma, non-whitespace
1452 * character. len is the length of the item excluding any beginning whitespace.
1454 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1457 * Retrieve an HTTP header field list item, as separated by a comma,
1458 * while stripping insignificant whitespace and lowercasing anything not in
1459 * a quoted string or comment.
1460 * @param p The pool to allocate from
1461 * @param field The field to retrieve
1462 * @return The return value is a new string containing the converted list
1463 * item (or NULL if none) and the address pointed to by field is
1464 * shifted to the next non-comma, non-whitespace.
1466 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1469 * Find an item in canonical form (lowercase, no extra spaces) within
1470 * an HTTP field value list.
1471 * @param p The pool to allocate from
1472 * @param line The field value list to search
1473 * @param tok The token to search for
1474 * @return 1 if found, 0 if not found.
1476 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1479 * Retrieve a token, spacing over it and adjusting the pointer to
1480 * the first non-white byte afterwards. Note that these tokens
1481 * are delimited by semis and commas and can also be delimited
1482 * by whitespace at the caller's option.
1483 * @param p The pool to allocate from
1484 * @param accept_line The line to retrieve the token from (adjusted afterwards)
1485 * @param accept_white Is it delimited by whitespace
1488 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1491 * Find http tokens, see the definition of token from RFC2068
1492 * @param p The pool to allocate from
1493 * @param line The line to find the token
1494 * @param tok The token to find
1495 * @return 1 if the token is found, 0 otherwise
1497 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1500 * find http tokens from the end of the line
1501 * @param p The pool to allocate from
1502 * @param line The line to find the token
1503 * @param tok The token to find
1504 * @return 1 if the token is found, 0 otherwise
1506 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1509 * Check for an Absolute URI syntax
1510 * @param u The string to check
1511 * @return 1 if URI, 0 otherwise
1513 AP_DECLARE(int) ap_is_url(const char *u);
1517 * @param url The string to unescape
1518 * @return 0 on success, non-zero otherwise
1520 AP_DECLARE(int) ap_unescape_all(char *url);
1524 * @param url The url to unescape
1525 * @return 0 on success, non-zero otherwise
1527 AP_DECLARE(int) ap_unescape_url(char *url);
1530 * Unescape a URL, but leaving %2f (slashes) escaped
1531 * @param url The url to unescape
1532 * @param decode_slashes Whether or not slashes should be decoded
1533 * @return 0 on success, non-zero otherwise
1535 AP_DECLARE(int) ap_unescape_url_keep2f(char *url, int decode_slashes);
1538 * Unescape an application/x-www-form-urlencoded string
1539 * @param query The query to unescape
1540 * @return 0 on success, non-zero otherwise
1542 AP_DECLARE(int) ap_unescape_urlencoded(char *query);
1545 * Convert all double slashes to single slashes
1546 * @param name The string to convert
1548 AP_DECLARE(void) ap_no2slash(char *name);
1551 * Remove all ./ and xx/../ substrings from a file name. Also remove
1552 * any leading ../ or /../ substrings.
1553 * @param name the file name to parse
1555 AP_DECLARE(void) ap_getparents(char *name);
1558 * Escape a path segment, as defined in RFC 1808
1559 * @param p The pool to allocate from
1560 * @param s The path to convert
1561 * @return The converted URL
1563 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1566 * Escape a path segment, as defined in RFC 1808, to a preallocated buffer.
1567 * @param c The preallocated buffer to write to
1568 * @param s The path to convert
1569 * @return The converted URL (c)
1571 AP_DECLARE(char *) ap_escape_path_segment_buffer(char *c, const char *s);
1574 * convert an OS path to a URL in an OS dependant way.
1575 * @param p The pool to allocate from
1576 * @param path The path to convert
1577 * @param partial if set, assume that the path will be appended to something
1578 * with a '/' in it (and thus does not prefix "./")
1579 * @return The converted URL
1581 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1583 /** @see ap_os_escape_path */
1584 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1587 * Escape a string as application/x-www-form-urlencoded
1588 * @param p The pool to allocate from
1589 * @param s The path to convert
1590 * @return The converted URL
1592 AP_DECLARE(char *) ap_escape_urlencoded(apr_pool_t *p, const char *s);
1595 * Escape a string as application/x-www-form-urlencoded, to a preallocated buffer
1596 * @param c The preallocated buffer to write to
1597 * @param s The path to convert
1598 * @return The converted URL (c)
1600 AP_DECLARE(char *) ap_escape_urlencoded_buffer(char *c, const char *s);
1603 * Escape an html string
1604 * @param p The pool to allocate from
1605 * @param s The html to escape
1606 * @return The escaped string
1608 #define ap_escape_html(p,s) ap_escape_html2(p,s,0)
1610 * Escape an html string
1611 * @param p The pool to allocate from
1612 * @param s The html to escape
1613 * @param toasc Whether to escape all non-ASCII chars to \&\#nnn;
1614 * @return The escaped string
1616 AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc);
1619 * Escape a string for logging
1620 * @param p The pool to allocate from
1621 * @param str The string to escape
1622 * @return The escaped string
1624 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str);
1627 * Escape a string for logging into the error log (without a pool)
1628 * @param dest The buffer to write to
1629 * @param source The string to escape
1630 * @param buflen The buffer size for the escaped string (including "\0")
1631 * @return The len of the escaped string (always < maxlen)
1633 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1637 * Construct a full hostname
1638 * @param p The pool to allocate from
1639 * @param hostname The hostname of the server
1640 * @param port The port the server is running on
1641 * @param r The current request
1642 * @return The server's hostname
1644 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1645 apr_port_t port, const request_rec *r);
1648 * Escape a shell command
1649 * @param p The pool to allocate from
1650 * @param s The command to escape
1651 * @return The escaped shell command
1653 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1656 * Count the number of directories in a path
1657 * @param path The path to count
1658 * @return The number of directories
1660 AP_DECLARE(int) ap_count_dirs(const char *path);
1663 * Copy at most @a n leading directories of @a s into @a d. @a d
1664 * should be at least as large as @a s plus 1 extra byte
1666 * @param d The location to copy to
1667 * @param s The location to copy from
1668 * @param n The number of directories to copy
1669 * @return value is the ever useful pointer to the trailing "\0" of d
1670 * @note on platforms with drive letters, n = 0 returns the "/" root,
1671 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1672 * returns the empty string. */
1673 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1676 * Return the parent directory name (including trailing /) of the file
1678 * @param p The pool to allocate from
1679 * @param s The file to get the parent of
1680 * @return A copy of the file's parent directory
1682 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1685 * Given a directory and filename, create a single path from them. This
1686 * function is smart enough to ensure that there is a sinlge '/' between the
1687 * directory and file names
1688 * @param a The pool to allocate from
1689 * @param dir The directory name
1690 * @param f The filename
1691 * @return A copy of the full path
1692 * @note Never consider using this function if you are dealing with filesystem
1693 * names that need to remain canonical, unless you are merging an apr_dir_read
1694 * path and returned filename. Otherwise, the result is not canonical.
1696 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1699 * Test if the given path has an an absolute path.
1700 * @param p The pool to allocate from
1701 * @param dir The directory name
1702 * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1703 * multiple forms of absolute paths. This only reports if the path is absolute
1704 * in a canonical sense.
1706 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1709 * Does the provided string contain wildcard characters? This is useful
1710 * for determining if the string should be passed to strcmp_match or to strcmp.
1711 * The only wildcard characters recognized are '?' and '*'
1712 * @param str The string to check
1713 * @return 1 if the string has wildcards, 0 otherwise
1715 AP_DECLARE(int) ap_is_matchexp(const char *str);
1718 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1719 * @param str The string to check
1720 * @param expected The pattern to match against
1721 * @return 1 if the two strings match, 0 otherwise
1723 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected);
1726 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1728 * @param str The string to check
1729 * @param expected The pattern to match against
1730 * @return 1 if the two strings match, 0 otherwise
1732 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected);
1735 * Find the first occurrence of the substring s2 in s1, regardless of case
1736 * @param s1 The string to search
1737 * @param s2 The substring to search for
1738 * @return A pointer to the beginning of the substring
1739 * @remark See apr_strmatch() for a faster alternative
1741 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1744 * Return a pointer to the location inside of bigstring immediately after prefix
1745 * @param bigstring The input string
1746 * @param prefix The prefix to strip away
1747 * @return A pointer relative to bigstring after prefix
1749 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1750 const char *prefix);
1753 * Decode a base64 encoded string into memory allocated from a pool
1754 * @param p The pool to allocate from
1755 * @param bufcoded The encoded string
1756 * @return The decoded string
1758 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1761 * Encode a string into memory allocated from a pool in base 64 format
1762 * @param p The pool to allocate from
1763 * @param string The plaintext string
1764 * @return The encoded string
1766 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1769 * Compile a regular expression to be used later. The regex is freed when
1770 * the pool is destroyed.
1771 * @param p The pool to allocate from
1772 * @param pattern the regular expression to compile
1773 * @param cflags The bitwise or of one or more of the following:
1774 * @li REG_EXTENDED - Use POSIX extended Regular Expressions
1775 * @li REG_ICASE - Ignore case
1776 * @li REG_NOSUB - Support for substring addressing of matches
1778 * @li REG_NEWLINE - Match-any-character operators don't match new-line
1779 * @return The compiled regular expression
1781 AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1785 * Free the memory associated with a compiled regular expression
1786 * @param p The pool the regex was allocated from
1787 * @param reg The regular expression to free
1788 * @note This function is only necessary if the regex should be cleaned
1789 * up before the pool
1791 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
1794 * After performing a successful regex match, you may use this function to
1795 * perform a series of string substitutions based on subexpressions that were
1796 * matched during the call to ap_regexec. This function is limited to
1797 * result strings of 64K. Consider using ap_pregsub_ex() instead.
1798 * @param p The pool to allocate from
1799 * @param input An arbitrary string containing $1 through $9. These are
1800 * replaced with the corresponding matched sub-expressions
1801 * @param source The string that was originally matched to the regex
1802 * @param nmatch the nmatch returned from ap_pregex
1803 * @param pmatch the pmatch array returned from ap_pregex
1804 * @return The substituted string, or NULL on error
1806 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1807 size_t nmatch, ap_regmatch_t pmatch[]);
1810 * After performing a successful regex match, you may use this function to
1811 * perform a series of string substitutions based on subexpressions that were
1812 * matched during the call to ap_regexec
1813 * @param p The pool to allocate from
1814 * @param result where to store the result, will be set to NULL on error
1815 * @param input An arbitrary string containing $1 through $9. These are
1816 * replaced with the corresponding matched sub-expressions
1817 * @param source The string that was originally matched to the regex
1818 * @param nmatch the nmatch returned from ap_pregex
1819 * @param pmatch the pmatch array returned from ap_pregex
1820 * @param maxlen the maximum string length to return, 0 for unlimited
1821 * @return The substituted string, or NULL on error
1823 AP_DECLARE(apr_status_t) ap_pregsub_ex(apr_pool_t *p, char **result,
1824 const char *input, const char *source,
1825 size_t nmatch, ap_regmatch_t pmatch[],
1829 * We want to downcase the type/subtype for comparison purposes
1830 * but nothing else because ;parameter=foo values are case sensitive.
1831 * @param s The content-type to convert to lowercase
1833 AP_DECLARE(void) ap_content_type_tolower(char *s);
1836 * convert a string to all lowercase
1837 * @param s The string to convert to lowercase
1839 AP_DECLARE(void) ap_str_tolower(char *s);
1842 * convert a string to all uppercase
1843 * @param s The string to convert to uppercase
1845 AP_DECLARE(void) ap_str_toupper(char *s);
1848 * Search a string from left to right for the first occurrence of a
1849 * specific character
1850 * @param str The string to search
1851 * @param c The character to search for
1852 * @return The index of the first occurrence of c in str
1854 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1857 * Search a string from right to left for the first occurrence of a
1858 * specific character
1859 * @param str The string to search
1860 * @param c The character to search for
1861 * @return The index of the first occurrence of c in str
1863 AP_DECLARE(int) ap_rind(const char *str, char c);
1866 * Given a string, replace any bare " with \\" .
1867 * @param p The pool to allocate memory from
1868 * @param instring The string to search for "
1869 * @return A copy of the string with escaped quotes
1871 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1874 * Given a string, append the PID deliminated by delim.
1875 * Usually used to create a pid-appended filepath name
1876 * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
1877 * a macro, to avoid unistd.h dependency
1878 * @param p The pool to allocate memory from
1879 * @param string The string to append the PID to
1880 * @param delim The string to use to deliminate the string from the PID
1881 * @return A copy of the string with the PID appended
1883 AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
1887 * Parse a given timeout parameter string into an apr_interval_time_t value.
1888 * The unit of the time interval is given as postfix string to the numeric
1889 * string. Currently the following units are understood:
1896 * If no unit is contained in the given timeout parameter the default_time_unit
1897 * will be used instead.
1898 * @param timeout_parameter The string containing the timeout parameter.
1899 * @param timeout The timeout value to be returned.
1900 * @param default_time_unit The default time unit to use if none is specified
1901 * in timeout_parameter.
1902 * @return Status value indicating whether the parsing was successful or not.
1904 AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
1905 const char *timeout_parameter,
1906 apr_interval_time_t *timeout,
1907 const char *default_time_unit);
1910 * Determine if a request has a request body or not.
1912 * @param r the request_rec of the request
1913 * @return truth value
1915 AP_DECLARE(int) ap_request_has_body(request_rec *r);
1918 * Cleanup a string (mainly to be filesystem safe)
1919 * We only allow '_' and alphanumeric chars. Non-printable
1920 * map to 'x' and all others map to '_'
1922 * @param p pool to use to allocate dest
1923 * @param src string to clean up
1924 * @param dest cleaned up, allocated string
1925 * @return Status value indicating whether the cleaning was successful or not.
1927 AP_DECLARE(apr_status_t) ap_pstr2_alnum(apr_pool_t *p, const char *src,
1931 * Cleanup a string (mainly to be filesystem safe)
1932 * We only allow '_' and alphanumeric chars. Non-printable
1933 * map to 'x' and all others map to '_'
1935 * @param src string to clean up
1936 * @param dest cleaned up, pre-allocated string
1937 * @return Status value indicating whether the cleaning was successful or not.
1939 AP_DECLARE(apr_status_t) ap_str2_alnum(const char *src, char *dest);
1942 * Structure to store the contents of an HTTP form of the type
1943 * application/x-www-form-urlencoded.
1945 * Currently it contains the name as a char* of maximum length
1946 * HUGE_STRING_LEN, and a value in the form of a bucket brigade
1947 * of arbitrary length.
1951 apr_bucket_brigade *value;
1955 * Read the body and parse any form found, which must be of the
1956 * type application/x-www-form-urlencoded.
1957 * @param r request containing POSTed form data
1959 * @param ptr returned array of ap_form_pair_t
1960 * @param num max num of params or -1 for unlimited
1961 * @param size max size allowed for parsed data
1962 * @return OK or HTTP error
1964 AP_DECLARE(int) ap_parse_form_data(request_rec *r, struct ap_filter_t *f,
1965 apr_array_header_t **ptr,
1966 apr_size_t num, apr_size_t size);
1968 /* Misc system hackery */
1970 * Given the name of an object in the file system determine if it is a directory
1971 * @param p The pool to allocate from
1972 * @param name The name of the object to check
1973 * @return 1 if it is a directory, 0 otherwise
1975 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1978 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1979 * @param p The pool to allocate from
1980 * @param name The name of the object to check
1981 * @return 1 if it is a directory, 0 otherwise
1983 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1986 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1987 #endif /* _OSD_POSIX */
1990 * Determine the local host name for the current machine
1991 * @param p The pool to allocate from
1992 * @return A copy of the local host name
1994 char *ap_get_local_host(apr_pool_t *p);
1997 * Log an assertion to the error log
1998 * @param szExp The assertion that failed
1999 * @param szFile The file the assertion is in
2000 * @param nLine The line the assertion is defined on
2002 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
2003 __attribute__((noreturn));
2006 * @internal Internal Assert function
2008 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
2011 * Redefine assert() to something more useful for an Apache...
2013 * Use ap_assert() if the condition should always be checked.
2014 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
2018 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
2020 #define AP_DEBUG_ASSERT(exp) ((void)0)
2024 * @defgroup stopsignal Flags which indicate places where the server should stop for debugging.
2026 * A set of flags which indicate places where the server should raise(SIGSTOP).
2027 * This is useful for debugging, because you can then attach to that process
2028 * with gdb and continue. This is important in cases where one_process
2029 * debugging isn't possible.
2031 /** stop on a Detach */
2032 #define SIGSTOP_DETACH 1
2033 /** stop making a child process */
2034 #define SIGSTOP_MAKE_CHILD 2
2035 /** stop spawning a child process */
2036 #define SIGSTOP_SPAWN_CHILD 4
2037 /** stop spawning a child process with a piped log */
2038 #define SIGSTOP_PIPED_LOG_SPAWN 8
2039 /** stop spawning a CGI child process */
2040 #define SIGSTOP_CGI_CHILD 16
2042 /** Macro to get GDB started */
2043 #ifdef DEBUG_SIGSTOP
2044 extern int raise_sigstop_flags;
2045 #define RAISE_SIGSTOP(x) do { \
2046 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
2049 #define RAISE_SIGSTOP(x)
2053 * Get HTML describing the address and (optionally) admin of the server.
2054 * @param prefix Text which is prepended to the return value
2055 * @param r The request_rec
2056 * @return HTML describing the server, allocated in @a r's pool.
2058 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
2060 /** strtoul does not exist on sunos4. */
2064 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
2066 /* The C library has functions that allow const to be silently dropped ...
2067 these macros detect the drop in maintainer mode, but use the native
2068 methods for normal builds
2070 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
2071 to be included before the macros are defined or compilation will fail.
2075 AP_DECLARE(char *) ap_strchr(char *s, int c);
2076 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
2077 AP_DECLARE(char *) ap_strrchr(char *s, int c);
2078 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
2079 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
2080 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
2085 # define strchr(s, c) ap_strchr(s,c)
2087 # define strrchr(s, c) ap_strrchr(s,c)
2089 # define strstr(s, c) ap_strstr(s,c)
2093 /** use this instead of strchr */
2094 # define ap_strchr(s, c) strchr(s, c)
2095 /** use this instead of strchr */
2096 # define ap_strchr_c(s, c) strchr(s, c)
2097 /** use this instead of strrchr */
2098 # define ap_strrchr(s, c) strrchr(s, c)
2099 /** use this instead of strrchr */
2100 # define ap_strrchr_c(s, c) strrchr(s, c)
2101 /** use this instead of strrstr*/
2102 # define ap_strstr(s, c) strstr(s, c)
2103 /** use this instead of strrstr*/
2104 # define ap_strstr_c(s, c) strstr(s, c)
2109 * Generate pseudo random bytes.
2110 * This is a convenience interface to apr_random. It is cheaper but less
2111 * secure than apr_generate_random_bytes().
2112 * @param buf where to store the bytes
2113 * @param size number of bytes to generate
2114 * @note ap_random_insecure_bytes() is thread-safe, it uses a mutex on
2117 AP_DECLARE(void) ap_random_insecure_bytes(void *buf, apr_size_t size);
2120 * Get a pseudo random number in a range.
2121 * @param min low end of range
2122 * @param max high end of range
2123 * @return a number in the range
2125 AP_DECLARE(apr_uint32_t) ap_random_pick(apr_uint32_t min, apr_uint32_t max);
2128 * Abort with a error message signifying out of memory
2130 AP_DECLARE(void) ap_abort_on_oom(void) __attribute__((noreturn));
2133 * Wrapper for malloc() that calls ap_abort_on_oom() if out of memory
2134 * @param size size of the memory block
2135 * @return pointer to the allocated memory
2136 * @note ap_malloc may be implemented as a macro
2138 AP_DECLARE(void *) ap_malloc(size_t size) __attribute__((malloc));
2141 * Wrapper for calloc() that calls ap_abort_on_oom() if out of memory
2142 * @param nelem number of elements to allocate memory for
2143 * @param size size of a single element
2144 * @return pointer to the allocated memory
2145 * @note ap_calloc may be implemented as a macro
2147 AP_DECLARE(void *) ap_calloc(size_t nelem, size_t size) __attribute__((malloc));
2150 * Wrapper for realloc() that calls ap_abort_on_oom() if out of memory
2151 * @param ptr pointer to the old memory block (or NULL)
2152 * @param size new size of the memory block
2153 * @return pointer to the reallocated memory
2154 * @note ap_realloc may be implemented as a macro
2156 AP_DECLARE(void *) ap_realloc(void *ptr, size_t size)
2157 ap_func_attr_warn_unused_result;
2160 #define AP_NORESTART APR_OS_START_USEERR + 1
2166 #endif /* !APACHE_HTTPD_H */
2168 /** @} //APACHE Daemon */
2169 /** @} //APACHE Core */
2170 /** @} //APACHE super group */