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"
65 /* Note: apr_uri.h is also included, see below */
71 /* ----------------------------- config dir ------------------------------ */
73 /** Define this to be the default server home dir. Most things later in this
74 * file with a relative pathname will have this added.
78 /** Set default for OS/2 file system */
79 #define HTTPD_ROOT "/os2httpd"
81 /** Set default for Windows file system */
82 #define HTTPD_ROOT "/apache"
84 /** Set the default for BeOS */
85 #define HTTPD_ROOT "/boot/home/apache"
86 #elif defined (NETWARE)
87 /** Set the default for NetWare */
88 #define HTTPD_ROOT "/apache"
90 /** Set for all other OSs */
91 #define HTTPD_ROOT "/usr/local/apache"
93 #endif /* HTTPD_ROOT */
96 * --------- You shouldn't have to edit anything below this line ----------
98 * Any modifications to any defaults not defined above should be done in the
99 * respective configuration file.
104 * Default location of documents. Can be overridden by the DocumentRoot
107 #ifndef DOCUMENT_LOCATION
109 /* Set default for OS/2 file system */
110 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
112 /* Set default for non OS/2 file system */
113 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
115 #endif /* DOCUMENT_LOCATION */
117 /** Maximum number of dynamically loaded modules */
118 #ifndef DYNAMIC_MODULE_LIMIT
119 #define DYNAMIC_MODULE_LIMIT 128
122 /** Default administrator's address */
123 #define DEFAULT_ADMIN "[no address given]"
125 /** The name of the log files */
126 #ifndef DEFAULT_ERRORLOG
127 #if defined(OS2) || defined(WIN32)
128 #define DEFAULT_ERRORLOG "logs/error.log"
130 #define DEFAULT_ERRORLOG "logs/error_log"
132 #endif /* DEFAULT_ERRORLOG */
134 /** Define this to be what your per-directory security files are called */
135 #ifndef DEFAULT_ACCESS_FNAME
137 /* Set default for OS/2 file system */
138 #define DEFAULT_ACCESS_FNAME "htaccess"
140 #define DEFAULT_ACCESS_FNAME ".htaccess"
142 #endif /* DEFAULT_ACCESS_FNAME */
144 /** The name of the server config file */
145 #ifndef SERVER_CONFIG_FILE
146 #define SERVER_CONFIG_FILE "conf/httpd.conf"
149 /** The default path for CGI scripts if none is currently set */
151 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
154 /** The path to the suExec wrapper, can be overridden in Configuration */
156 #define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
159 /** The timeout for waiting for messages */
160 #ifndef DEFAULT_TIMEOUT
161 #define DEFAULT_TIMEOUT 300
164 /** The timeout for waiting for keepalive timeout until next request */
165 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
166 #define DEFAULT_KEEPALIVE_TIMEOUT 5
169 /** The number of requests to entertain per connection */
170 #ifndef DEFAULT_KEEPALIVE
171 #define DEFAULT_KEEPALIVE 100
175 * Limits on the size of various request items. These limits primarily
176 * exist to prevent simple denial-of-service attacks on a server based
177 * on misuse of the protocol. The recommended values will depend on the
178 * nature of the server resources -- CGI scripts and database backends
179 * might require large values, but most servers could get by with much
180 * smaller limits than we use below. The request message body size can
181 * be limited by the per-dir config directive LimitRequestBody.
183 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
184 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
185 * These two limits can be lowered (but not raised) by the server config
186 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
188 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
189 * the server config directive LimitRequestFields.
192 /** default limit on bytes in Request-Line (Method+URI+HTTP-version) */
193 #ifndef DEFAULT_LIMIT_REQUEST_LINE
194 #define DEFAULT_LIMIT_REQUEST_LINE 8190
196 /** default limit on bytes in any one header field */
197 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
198 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
200 /** default limit on number of request header fields */
201 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
202 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
206 * The default default character set name to add if AddDefaultCharset is
207 * enabled. Overridden with AddDefaultCharsetName.
209 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
211 /** default HTTP Server protocol */
212 #define AP_SERVER_PROTOCOL "HTTP/1.1"
215 /* ------------------ stuff that modules are allowed to look at ----------- */
217 /** Define this to be what your HTML directory content files are called */
218 #ifndef AP_DEFAULT_INDEX
219 #define AP_DEFAULT_INDEX "index.html"
224 * Define this to be what type you'd like returned for files with unknown
226 * @warning MUST be all lower case.
228 #ifndef DEFAULT_CONTENT_TYPE
229 #define DEFAULT_CONTENT_TYPE "text/plain"
233 * NO_CONTENT_TYPE is an alternative DefaultType value that suppresses
234 * setting any default type when there's no information (e.g. a proxy).
236 #ifndef NO_CONTENT_TYPE
237 #define NO_CONTENT_TYPE "none"
240 /** The name of the MIME types file */
241 #ifndef AP_TYPES_CONFIG_FILE
242 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
246 * Define the HTML doctype strings centrally.
248 /** HTML 2.0 Doctype */
249 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
250 "DTD HTML 2.0//EN\">\n"
251 /** HTML 3.2 Doctype */
252 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
253 "DTD HTML 3.2 Final//EN\">\n"
254 /** HTML 4.0 Strict Doctype */
255 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
256 "DTD HTML 4.0//EN\"\n" \
257 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
258 /** HTML 4.0 Transitional Doctype */
259 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
260 "DTD HTML 4.0 Transitional//EN\"\n" \
261 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
262 /** HTML 4.0 Frameset Doctype */
263 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
264 "DTD HTML 4.0 Frameset//EN\"\n" \
265 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
266 /** XHTML 1.0 Strict Doctype */
267 #define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
268 "DTD XHTML 1.0 Strict//EN\"\n" \
269 "\"http://www.w3.org/TR/xhtml1/DTD/" \
270 "xhtml1-strict.dtd\">\n"
271 /** XHTML 1.0 Transitional Doctype */
272 #define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
273 "DTD XHTML 1.0 Transitional//EN\"\n" \
274 "\"http://www.w3.org/TR/xhtml1/DTD/" \
275 "xhtml1-transitional.dtd\">\n"
276 /** XHTML 1.0 Frameset Doctype */
277 #define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
278 "DTD XHTML 1.0 Frameset//EN\"\n" \
279 "\"http://www.w3.org/TR/xhtml1/DTD/" \
280 "xhtml1-frameset.dtd\">"
282 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
283 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
284 /** Major part of HTTP protocol */
285 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
286 /** Minor part of HTTP protocol */
287 #define HTTP_VERSION_MINOR(number) ((number)%1000)
289 /* -------------- Port number for server running standalone --------------- */
291 /** default HTTP Port */
292 #define DEFAULT_HTTP_PORT 80
293 /** default HTTPS Port */
294 #define DEFAULT_HTTPS_PORT 443
296 * Check whether @a port is the default port for the request @a r.
297 * @param port The port number
298 * @param r The request
299 * @see #ap_default_port
301 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
303 * Get the default port for a request (which depends on the scheme).
304 * @param r The request
306 #define ap_default_port(r) ap_run_default_port(r)
308 * Get the scheme for a request.
309 * @param r The request
311 #define ap_http_scheme(r) ap_run_http_scheme(r)
313 /** The default string length */
314 #define MAX_STRING_LEN HUGE_STRING_LEN
316 /** The length of a Huge string */
317 #define HUGE_STRING_LEN 8192
319 /** The size of the server's internal read-write buffers */
320 #define AP_IOBUFSIZE 8192
322 /** The max number of regex captures that can be expanded by ap_pregsub */
323 #define AP_MAX_REG_MATCH 10
326 * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
327 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
328 * than that in case the brigade code/filters attempt to read it directly.
329 * ### 16mb is an invention, no idea if it is reasonable.
331 #define AP_MAX_SENDFILE 16777216 /* 2^24 */
334 * Special Apache error codes. These are basically used
335 * in http_main.c so we can keep track of various errors.
339 #define APEXIT_OK 0x0
340 /** A fatal error arising during the server's init sequence */
341 #define APEXIT_INIT 0x2
342 /** The child died during its init sequence */
343 #define APEXIT_CHILDINIT 0x3
345 * The child exited due to a resource shortage.
346 * The parent should limit the rate of forking until
347 * the situation is resolved.
349 #define APEXIT_CHILDSICK 0x7
351 * A fatal error, resulting in the whole server aborting.
352 * If a child exits with this error, the parent process
353 * considers this a server-wide fatal error and aborts.
355 #define APEXIT_CHILDFATAL 0xf
359 * Stuff marked #AP_DECLARE is part of the API, and intended for use
360 * by modules. Its purpose is to allow us to add attributes that
361 * particular platforms or compilers require to every exported function.
363 # define AP_DECLARE(type) type
366 #ifndef AP_DECLARE_NONSTD
368 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
369 * use by modules. The difference between #AP_DECLARE and
370 * #AP_DECLARE_NONSTD is that the latter is required for any functions
371 * which use varargs or are used via indirect function call. This
372 * is to accomodate the two calling conventions in windows dlls.
374 # define AP_DECLARE_NONSTD(type) type
376 #ifndef AP_DECLARE_DATA
377 # define AP_DECLARE_DATA
380 #ifndef AP_MODULE_DECLARE
381 # define AP_MODULE_DECLARE(type) type
383 #ifndef AP_MODULE_DECLARE_NONSTD
384 # define AP_MODULE_DECLARE_NONSTD(type) type
386 #ifndef AP_MODULE_DECLARE_DATA
387 # define AP_MODULE_DECLARE_DATA
392 * modules should not use functions marked AP_CORE_DECLARE
394 #ifndef AP_CORE_DECLARE
395 # define AP_CORE_DECLARE AP_DECLARE
400 * modules should not use functions marked AP_CORE_DECLARE_NONSTD
403 #ifndef AP_CORE_DECLARE_NONSTD
404 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
408 * @brief The numeric version information is broken out into fields within this
412 int major; /**< major number */
413 int minor; /**< minor number */
414 int patch; /**< patch number */
415 const char *add_string; /**< additional string like "-dev" */
419 * Return httpd's version information in a numeric form.
421 * @param version Pointer to a version structure for returning the version
424 AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
427 * Get the server banner in a form suitable for sending over the
428 * network, with the level of information controlled by the
429 * ServerTokens directive.
430 * @return The server banner
432 AP_DECLARE(const char *) ap_get_server_banner(void);
435 * Get the server description in a form suitable for local displays,
436 * status reports, or logging. This includes the detailed server
437 * version and information about some modules. It is not affected
438 * by the ServerTokens directive.
439 * @return The server description
441 AP_DECLARE(const char *) ap_get_server_description(void);
444 * Add a component to the server description and banner strings
445 * @param pconf The pool to allocate the component from
446 * @param component The string to add
448 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
451 * Get the date a time that the server was built
452 * @return The server build time string
454 AP_DECLARE(const char *) ap_get_server_built(void);
456 /* non-HTTP status codes retuned by hooks */
458 #define OK 0 /**< Module has handled this stage. */
459 #define DECLINED -1 /**< Module declines to handle */
460 #define DONE -2 /**< Module has served the response completely
461 * - it's safe to die() with no more output
463 #define SUSPENDED -3 /**< Module will handle the remainder of the request.
464 * The core will never invoke the request again, */
466 /** Returned by the bottom-most filter if no data was written.
467 * @see ap_pass_brigade(). */
468 #define AP_NOBODY_WROTE -100
469 /** Returned by the bottom-most filter if no data was read.
470 * @see ap_get_brigade(). */
471 #define AP_NOBODY_READ -101
472 /** Returned by any filter if the filter chain encounters an error
473 * and has already dealt with the error response.
475 #define AP_FILTER_ERROR -102
478 * @defgroup HTTP_Status HTTP Status Codes
482 * The size of the static array in http_protocol.c for storing
483 * all of the potential response status-lines (a sparse table).
484 * A future version should dynamically generate the apr_table_t at startup.
486 #define RESPONSE_CODES 57
488 #define HTTP_CONTINUE 100
489 #define HTTP_SWITCHING_PROTOCOLS 101
490 #define HTTP_PROCESSING 102
492 #define HTTP_CREATED 201
493 #define HTTP_ACCEPTED 202
494 #define HTTP_NON_AUTHORITATIVE 203
495 #define HTTP_NO_CONTENT 204
496 #define HTTP_RESET_CONTENT 205
497 #define HTTP_PARTIAL_CONTENT 206
498 #define HTTP_MULTI_STATUS 207
499 #define HTTP_MULTIPLE_CHOICES 300
500 #define HTTP_MOVED_PERMANENTLY 301
501 #define HTTP_MOVED_TEMPORARILY 302
502 #define HTTP_SEE_OTHER 303
503 #define HTTP_NOT_MODIFIED 304
504 #define HTTP_USE_PROXY 305
505 #define HTTP_TEMPORARY_REDIRECT 307
506 #define HTTP_BAD_REQUEST 400
507 #define HTTP_UNAUTHORIZED 401
508 #define HTTP_PAYMENT_REQUIRED 402
509 #define HTTP_FORBIDDEN 403
510 #define HTTP_NOT_FOUND 404
511 #define HTTP_METHOD_NOT_ALLOWED 405
512 #define HTTP_NOT_ACCEPTABLE 406
513 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
514 #define HTTP_REQUEST_TIME_OUT 408
515 #define HTTP_CONFLICT 409
516 #define HTTP_GONE 410
517 #define HTTP_LENGTH_REQUIRED 411
518 #define HTTP_PRECONDITION_FAILED 412
519 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
520 #define HTTP_REQUEST_URI_TOO_LARGE 414
521 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
522 #define HTTP_RANGE_NOT_SATISFIABLE 416
523 #define HTTP_EXPECTATION_FAILED 417
524 #define HTTP_UNPROCESSABLE_ENTITY 422
525 #define HTTP_LOCKED 423
526 #define HTTP_FAILED_DEPENDENCY 424
527 #define HTTP_UPGRADE_REQUIRED 426
528 #define HTTP_INTERNAL_SERVER_ERROR 500
529 #define HTTP_NOT_IMPLEMENTED 501
530 #define HTTP_BAD_GATEWAY 502
531 #define HTTP_SERVICE_UNAVAILABLE 503
532 #define HTTP_GATEWAY_TIME_OUT 504
533 #define HTTP_VERSION_NOT_SUPPORTED 505
534 #define HTTP_VARIANT_ALSO_VARIES 506
535 #define HTTP_INSUFFICIENT_STORAGE 507
536 #define HTTP_NOT_EXTENDED 510
538 /** is the status code informational */
539 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
540 /** is the status code OK ?*/
541 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
542 /** is the status code a redirect */
543 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
544 /** is the status code a error (client or server) */
545 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
546 /** is the status code a client error */
547 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
548 /** is the status code a server error */
549 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
550 /** is the status code a (potentially) valid response code? */
551 #define ap_is_HTTP_VALID_RESPONSE(x) (((x) >= 100)&&((x) < 600))
553 /** should the status code drop the connection */
554 #define ap_status_drops_connection(x) \
555 (((x) == HTTP_BAD_REQUEST) || \
556 ((x) == HTTP_REQUEST_TIME_OUT) || \
557 ((x) == HTTP_LENGTH_REQUIRED) || \
558 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
559 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
560 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
561 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
562 ((x) == HTTP_NOT_IMPLEMENTED))
566 * @defgroup Methods List of Methods recognized by the server
567 * @ingroup APACHE_CORE_DAEMON
570 * @brief Methods recognized (but not necessarily handled) by the server.
572 * These constants are used in bit shifting masks of size int, so it is
573 * unsafe to have more methods than bits in an int. HEAD == M_GET.
574 * This list must be tracked by the list in http_protocol.c in routine
575 * ap_method_name_of().
579 #define M_GET 0 /** RFC 2616: HTTP */
580 #define M_PUT 1 /* : */
585 #define M_TRACE 6 /** RFC 2616: HTTP */
586 #define M_PATCH 7 /** no rfc(!) ### remove this one? */
587 #define M_PROPFIND 8 /** RFC 2518: WebDAV */
588 #define M_PROPPATCH 9 /* : */
593 #define M_UNLOCK 14 /** RFC 2518: WebDAV */
594 #define M_VERSION_CONTROL 15 /** RFC 3253: WebDAV Versioning */
595 #define M_CHECKOUT 16 /* : */
596 #define M_UNCHECKOUT 17
601 #define M_MKWORKSPACE 22
602 #define M_MKACTIVITY 23
603 #define M_BASELINE_CONTROL 24
605 #define M_INVALID 26 /** RFC 3253: WebDAV Versioning */
608 * METHODS needs to be equal to the number of bits
609 * we are using for limit masks.
614 * The method mask bit to shift for anding with a bitmask.
616 #define AP_METHOD_BIT ((apr_int64_t)1)
620 /** @see ap_method_list_t */
621 typedef struct ap_method_list_t ap_method_list_t;
624 * @struct ap_method_list_t
625 * @brief Structure for handling HTTP methods.
627 * Methods known to the server are accessed via a bitmask shortcut;
628 * extension methods are handled by an array.
630 struct ap_method_list_t {
631 /** The bitmask used for known methods */
632 apr_int64_t method_mask;
633 /** the array used for extension methods */
634 apr_array_header_t *method_list;
638 * @defgroup module_magic Module Magic mime types
641 /** Magic for mod_cgi[d] */
642 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
643 /** Magic for mod_include */
644 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
645 /** Magic for mod_include */
646 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
647 /** Magic for mod_dir */
648 #define DIR_MAGIC_TYPE "httpd/unix-directory"
651 /* Just in case your linefeed isn't the one the other end is expecting. */
652 #if !APR_CHARSET_EBCDIC
655 /** carrige return */
657 /** carrige return /Line Feed Combo */
658 #define CRLF "\015\012"
659 #else /* APR_CHARSET_EBCDIC */
660 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
661 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
662 * "native EBCDIC" CR and NL characters. These are therefore
669 #endif /* APR_CHARSET_EBCDIC */
670 /** Useful for common code with either platform charset. */
671 #define CRLF_ASCII "\015\012"
674 * @defgroup values_request_rec_body Possible values for request_rec.read_body
676 * Possible values for request_rec.read_body (set by handling module):
679 /** Send 413 error if message has any body */
680 #define REQUEST_NO_BODY 0
681 /** Send 411 error if body without Content-Length */
682 #define REQUEST_CHUNKED_ERROR 1
683 /** If chunked, remove the chunks for me. */
684 #define REQUEST_CHUNKED_DECHUNK 2
685 /** @} // values_request_rec_body */
688 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
689 * @ingroup APACHE_CORE_DAEMON
691 * Possible values for request_rec.used_path_info:
694 /** Accept the path_info from the request */
695 #define AP_REQ_ACCEPT_PATH_INFO 0
696 /** Return a 404 error if path_info was given */
697 #define AP_REQ_REJECT_PATH_INFO 1
698 /** Module may chose to use the given path_info */
699 #define AP_REQ_DEFAULT_PATH_INFO 2
701 /** @} // values_request_rec_used_path_info */
705 * Things which may vary per file-lookup WITHIN a request ---
706 * e.g., state of MIME config. Basically, the name of an object, info
707 * about the object, and any other info we may ahve which may need to
708 * change as we go poking around looking for it (e.g., overridden by
711 * Note how the default state of almost all these things is properly
712 * zero, so that allocating it with pcalloc does the right thing without
713 * a whole lot of hairy initialization... so long as we are willing to
714 * make the (fairly) portable assumption that the bit pattern of a NULL
715 * pointer is, in fact, zero.
719 * @brief This represents the result of calling htaccess; these are cached for
722 struct htaccess_result {
723 /** the directory to which this applies */
725 /** the overrides allowed for the .htaccess file */
727 /** the override options allowed for the .htaccess file */
729 /** the configuration directives */
730 struct ap_conf_vector_t *htaccess;
731 /** the next one, or NULL if no more; N.B. never change this */
732 const struct htaccess_result *next;
735 /* The following four types define a hierarchy of activities, so that
736 * given a request_rec r you can write r->connection->server->process
737 * to get to the process_rec. While this reduces substantially the
738 * number of arguments that various hooks require beware that in
739 * threaded versions of the server you must consider multiplexing
743 /** A structure that represents one process */
744 typedef struct process_rec process_rec;
745 /** A structure that represents a virtual server */
746 typedef struct server_rec server_rec;
747 /** A structure that represents one connection */
748 typedef struct conn_rec conn_rec;
749 /** A structure that represents the current request */
750 typedef struct request_rec request_rec;
751 /** A structure that represents the status of the current connection */
752 typedef struct conn_state_t conn_state_t;
754 /* ### would be nice to not include this from httpd.h ... */
755 /* This comes after we have defined the request_rec type */
759 * @brief A structure that represents one process
762 /** Global pool. Cleared upon normal exit */
764 /** Configuration pool. Cleared upon restart */
766 /** Number of command line arguments passed to the program */
768 /** The command line arguments */
769 const char * const *argv;
770 /** The program name used to execute the program */
771 const char *short_name;
775 * @brief A structure that represents the current request
778 /** The pool associated with the request */
780 /** The connection to the client */
781 conn_rec *connection;
782 /** The virtual host for this request */
785 /** Pointer to the redirected request if this is an external redirect */
787 /** Pointer to the previous request if this is an internal redirect */
790 /** Pointer to the main request if this is a sub-request
791 * (see http_request.h) */
794 /* Info about the request itself... we begin with stuff that only
795 * protocol.c should ever touch...
797 /** First line of request */
799 /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
801 /** A proxy request (calculated during post_read_request/translate_name)
802 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
806 /** HEAD request, as opposed to GET */
808 /** Protocol string, as given to us, or HTTP/0.9 */
810 /** Protocol version number of protocol; 1.1 = 1001 */
812 /** Host, as set by full URI or Host: */
813 const char *hostname;
815 /** Time when the request started */
816 apr_time_t request_time;
818 /** Status line, if set by script */
819 const char *status_line;
823 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
824 * look, but don't touch.
827 /** Request method (eg. GET, HEAD, POST, etc.) */
829 /** M_GET, M_POST, etc. */
833 * 'allowed' is a bitvector of the allowed methods.
835 * A handler must ensure that the request method is one that
836 * it is capable of handling. Generally modules should DECLINE
837 * any request methods they do not handle. Prior to aborting the
838 * handler like this the handler should set r->allowed to the list
839 * of methods that it is willing to handle. This bitvector is used
840 * to construct the "Allow:" header required for OPTIONS requests,
841 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
843 * Since the default_handler deals with OPTIONS, all modules can
844 * usually decline to deal with OPTIONS. TRACE is always allowed,
845 * modules don't need to set it explicitly.
847 * Since the default_handler will always handle a GET, a
848 * module which does *not* implement GET should probably return
849 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
850 * handler can't be installed by mod_actions.
853 /** Array of extension methods */
854 apr_array_header_t *allowed_xmethods;
855 /** List of allowed methods */
856 ap_method_list_t *allowed_methods;
858 /** byte count in stream is for body */
859 apr_off_t sent_bodyct;
860 /** body byte count, for easy access */
861 apr_off_t bytes_sent;
862 /** Last modified time of the requested resource */
865 /* HTTP/1.1 connection-level features */
867 /** sending chunked transfer-coding */
869 /** The Range: header */
871 /** The "real" content length */
874 /** Remaining bytes left to read from the request body */
876 /** Number of bytes that have been read from the request body */
877 apr_off_t read_length;
878 /** Method for reading the request body
879 * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
880 * REQUEST_CHUNKED_DECHUNK, etc...) */
882 /** reading chunked transfer-coding */
884 /** is client waiting for a 100 response? */
885 unsigned expecting_100;
887 /* MIME header environments, in and out. Also, an array containing
888 * environment variables to be passed to subprocesses, so people can
889 * write modules to add to that environment.
891 * The difference between headers_out and err_headers_out is that the
892 * latter are printed even on error, and persist across internal redirects
893 * (so the headers printed for ErrorDocument handlers will have them).
895 * The 'notes' apr_table_t is for notes from one module to another, with no
896 * other set purpose in mind...
899 /** MIME header environment from the request */
900 apr_table_t *headers_in;
901 /** MIME header environment for the response */
902 apr_table_t *headers_out;
903 /** MIME header environment for the response, printed even on errors and
904 * persist across internal redirects */
905 apr_table_t *err_headers_out;
906 /** Array of environment variables to be used for sub processes */
907 apr_table_t *subprocess_env;
908 /** Notes from one module to another */
911 /* content_type, handler, content_encoding, and all content_languages
912 * MUST be lowercased strings. They may be pointers to static strings;
913 * they should not be modified in place.
915 /** The content-type for the current request */
916 const char *content_type; /* Break these out --- we dispatch on 'em */
917 /** The handler string that we use to call a handler function */
918 const char *handler; /* What we *really* dispatch on */
920 /** How to encode the data */
921 const char *content_encoding;
922 /** Array of strings representing the content languages */
923 apr_array_header_t *content_languages;
925 /** variant list validator (if negotiated) */
926 char *vlist_validator;
928 /** If an authentication check was made, this gets set to the user name. */
930 /** If an authentication check was made, this gets set to the auth type. */
933 /** This response can not be cached */
935 /** There is no local copy of this response */
938 /* What object is being requested (either directly, or via include
939 * or content-negotiation mapping).
942 /** The URI without any parsing performed */
944 /** The path portion of the URI */
946 /** The filename on disk corresponding to this response */
948 /* XXX: What does this mean? Please define "canonicalize" -aaron */
949 /** The true filename, we canonicalize r->filename if these don't match */
950 char *canonical_filename;
951 /** The PATH_INFO extracted from this request */
953 /** The QUERY_ARGS extracted from this request */
955 /** finfo.protection (st_mode) set to zero if no such file */
957 /** A struct containing the components of URI */
958 apr_uri_t parsed_uri;
961 * Flag for the handler to accept or reject path_info on
962 * the current request. All modules should respect the
963 * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
964 * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
965 * may follow existing conventions. This is set to the
966 * user's preference upon HOOK_VERY_FIRST of the fixups.
970 /* Various other config info which may change with .htaccess files
971 * These are config vectors, with one void* pointer for each module
972 * (the thing pointed to being the module's business).
975 /** Options set in config files, etc. */
976 struct ap_conf_vector_t *per_dir_config;
977 /** Notes on *this* request */
978 struct ap_conf_vector_t *request_config;
981 * A linked list of the .htaccess configuration directives
982 * accessed by this request.
983 * N.B. always add to the head of the list, _never_ to the end.
984 * that way, a sub request's list can (temporarily) point to a parent's list
986 const struct htaccess_result *htaccess;
988 /** A list of output filters to be used for this request */
989 struct ap_filter_t *output_filters;
990 /** A list of input filters to be used for this request */
991 struct ap_filter_t *input_filters;
993 /** A list of protocol level output filters to be used for this
995 struct ap_filter_t *proto_output_filters;
996 /** A list of protocol level input filters to be used for this
998 struct ap_filter_t *proto_input_filters;
1000 /** A flag to determine if the eos bucket has been sent yet */
1003 /** The optional kept body of the request. */
1004 apr_bucket_brigade *kept_body;
1006 apr_thread_mutex_t *invoke_mtx;
1008 apr_table_t *body_table;
1009 /* Things placed at the end of the record to avoid breaking binary
1010 * compatibility. It would be nice to remember to reorder the entire
1011 * record to improve 64bit alignment the next time we need to break
1012 * binary compatibility for some other reason.
1017 * @defgroup ProxyReq Proxy request types
1019 * Possible values of request_rec->proxyreq. A request could be normal,
1020 * proxied or reverse proxied. Normally proxied and reverse proxied are
1021 * grouped together as just "proxied", but sometimes it's necessary to
1022 * tell the difference between the two, such as for authentication.
1026 #define PROXYREQ_NONE 0 /**< No proxy */
1027 #define PROXYREQ_PROXY 1 /**< Standard proxy */
1028 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
1029 #define PROXYREQ_RESPONSE 3 /**< Origin response */
1034 * @brief Enumeration of connection keepalive options
1040 } ap_conn_keepalive_e;
1043 * @brief Structure to store things which are per connection
1046 /** Pool associated with this connection */
1048 /** Physical vhost this conn came in on */
1049 server_rec *base_server;
1050 /** used by http_vhost.c */
1051 void *vhost_lookup_data;
1053 /* Information about the connection itself */
1054 /** local address */
1055 apr_sockaddr_t *local_addr;
1056 /** remote address */
1057 apr_sockaddr_t *remote_addr;
1059 /** Client's IP address */
1061 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
1062 * "" if it has and no address was found. N.B. Only access this though
1063 * get_remote_host() */
1065 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
1066 * get_remote_logname() */
1067 char *remote_logname;
1069 /** Are we still talking? */
1072 /** Are we going to keep the connection alive for another request?
1073 * @see ap_conn_keepalive_e */
1074 ap_conn_keepalive_e keepalive;
1076 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1078 signed int double_reverse:2;
1080 /** How many times have we used it? */
1082 /** server IP address */
1084 /** used for ap_get_server_name when UseCanonicalName is set to DNS
1085 * (ignores setting of HostnameLookups) */
1088 /** ID of this connection; unique at any point in time */
1090 /** Config vector containing pointers to connections per-server
1091 * config structures. */
1092 struct ap_conf_vector_t *conn_config;
1093 /** Notes on *this* connection: send note from one module to
1094 * another. must remain valid for all requests on this conn */
1096 /** A list of input filters to be used for this connection */
1097 struct ap_filter_t *input_filters;
1098 /** A list of output filters to be used for this connection */
1099 struct ap_filter_t *output_filters;
1100 /** handle to scoreboard information for this connection */
1102 /** The bucket allocator to use for all bucket/brigade creations */
1103 struct apr_bucket_alloc_t *bucket_alloc;
1104 /** The current state of this connection */
1106 /** Is there data pending in the input filters? */
1107 int data_in_input_filters;
1108 /** Is there data pending in the output filters? */
1109 int data_in_output_filters;
1111 /** Are there any filters that clogg/buffer the input stream, breaking
1114 int clogging_input_filters;
1118 * Enumeration of connection states
1121 CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1122 CONN_STATE_READ_REQUEST_LINE,
1124 CONN_STATE_WRITE_COMPLETION,
1125 CONN_STATE_SUSPENDED,
1130 * @brief A structure to contain connection state information
1132 struct conn_state_t {
1133 /** APR_RING of expiration timeouts */
1134 APR_RING_ENTRY(conn_state_t) timeout_list;
1135 /** the expiration time of the next keepalive timeout */
1136 apr_time_t expiration_time;
1137 /** Current state of the connection */
1139 /** connection record this struct refers to */
1141 /** memory pool to allocate from */
1143 /** bucket allocator */
1144 apr_bucket_alloc_t *bucket_alloc;
1145 /** poll file decriptor information */
1149 /* Per-vhost config... */
1152 * The address 255.255.255.255, when used as a virtualhost address,
1153 * will become the "default" server when the ip doesn't match other vhosts.
1155 #define DEFAULT_VHOST_ADDR 0xfffffffful
1159 * @struct server_addr_rec
1160 * @brief A structure to be used for Per-vhost config
1162 typedef struct server_addr_rec server_addr_rec;
1163 struct server_addr_rec {
1164 /** The next server in the list */
1165 server_addr_rec *next;
1166 /** The bound address, for this server */
1167 apr_sockaddr_t *host_addr;
1168 /** The bound port, for this server */
1169 apr_port_t host_port;
1170 /** The name given in "<VirtualHost>" */
1175 * @brief A structure to store information for each virtual server
1178 /** The process this server is running in */
1179 process_rec *process;
1180 /** The next server in the list */
1183 /** The name of the server */
1184 const char *defn_name;
1185 /** The line of the config file that the server was defined on */
1186 unsigned defn_line_number;
1188 /* Contact information */
1190 /** The admin's contact information */
1192 /** The server hostname */
1193 char *server_hostname;
1194 /** for redirects, etc. */
1197 /* Log files --- note that transfer log is now in the modules... */
1199 /** The name of the error log */
1201 /** A file descriptor that references the error log */
1202 apr_file_t *error_log;
1203 /** The log level for this server */
1206 /* Module-specific configuration for server, and defaults... */
1208 /** true if this is the virtual server */
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 /* Transaction handling */
1218 /** I haven't got a clue */
1219 server_addr_rec *addrs;
1220 /** Timeout, as an apr interval, before we give up */
1221 apr_interval_time_t timeout;
1222 /** The apr interval we will wait for another request */
1223 apr_interval_time_t keep_alive_timeout;
1224 /** Maximum requests per connection */
1226 /** Use persistent connections? */
1229 /** Pathname for ServerPath */
1231 /** Length of path */
1234 /** Normal names for ServerAlias servers */
1235 apr_array_header_t *names;
1236 /** Wildcarded names for ServerAlias servers */
1237 apr_array_header_t *wild_names;
1239 /** limit on size of the HTTP request line */
1241 /** limit on size of any request header field */
1242 int limit_req_fieldsize;
1243 /** limit on number of request header fields */
1244 int limit_req_fields;
1246 /** The server request scheme for redirect responses */
1247 const char *server_scheme;
1250 typedef struct core_output_filter_ctx {
1251 apr_bucket_brigade *buffered_bb;
1252 apr_size_t bytes_in;
1253 apr_size_t bytes_written;
1254 } core_output_filter_ctx_t;
1256 typedef struct core_filter_ctx {
1257 apr_bucket_brigade *b;
1258 apr_bucket_brigade *tmpbb;
1261 typedef struct core_net_rec {
1262 /** Connection to the client */
1263 apr_socket_t *client_socket;
1265 /** connection record */
1268 core_output_filter_ctx_t *out_ctx;
1273 * Examine a field value (such as a media-/content-type) string and return
1274 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1275 * @param p Pool to allocate memory from
1276 * @param intype The field to examine
1277 * @return A copy of the field minus any parameters
1279 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1282 * Convert a time from an integer into a string in a specified format
1283 * @param p The pool to allocate memory from
1284 * @param t The time to convert
1285 * @param fmt The format to use for the conversion
1286 * @param gmt Convert the time for GMT?
1287 * @return The string that represents the specified time
1289 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1291 /* String handling. The *_nc variants allow you to use non-const char **s as
1292 arguments (unfortunately C won't automatically convert a char ** to a const
1296 * Get the characters until the first occurance of a specified character
1297 * @param p The pool to allocate memory from
1298 * @param line The string to get the characters from
1299 * @param stop The character to stop at
1300 * @return A copy of the characters up to the first stop character
1302 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1305 * Get the characters until the first occurance of a specified character
1306 * @param p The pool to allocate memory from
1307 * @param line The string to get the characters from
1308 * @param stop The character to stop at
1309 * @return A copy of the characters up to the first stop character
1310 * @note This is the same as ap_getword(), except it doesn't use const char **.
1312 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1315 * Get the first word from a given string. A word is defined as all characters
1316 * up to the first whitespace.
1317 * @param p The pool to allocate memory from
1318 * @param line The string to traverse
1319 * @return The first word in the line
1321 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1324 * Get the first word from a given string. A word is defined as all characters
1325 * up to the first whitespace.
1326 * @param p The pool to allocate memory from
1327 * @param line The string to traverse
1328 * @return The first word in the line
1329 * @note The same as ap_getword_white(), except it doesn't use const char**
1331 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1334 * Get all characters from the first occurance of @a stop to the first "\0"
1335 * @param p The pool to allocate memory from
1336 * @param line The line to traverse
1337 * @param stop The character to start at
1338 * @return A copy of all caracters after the first occurance of the specified
1341 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1345 * Get all characters from the first occurance of @a stop to the first "\0"
1346 * @param p The pool to allocate memory from
1347 * @param line The line to traverse
1348 * @param stop The character to start at
1349 * @return A copy of all caracters after the first occurance of the specified
1351 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1353 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1356 * Get the second word in the string paying attention to quoting
1357 * @param p The pool to allocate from
1358 * @param line The line to traverse
1359 * @return A copy of the string
1361 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1364 * Get the second word in the string paying attention to quoting
1365 * @param p The pool to allocate from
1366 * @param line The line to traverse
1367 * @return A copy of the string
1368 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1370 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1373 * Check a string for any ${ENV} environment variable construct and replace
1374 * each them by the value of that environment variable, if it exists. If the
1375 * environment value does not exist, leave the ${ENV} construct alone; it
1376 * means something else.
1377 * @param p The pool to allocate from
1378 * @param word The string to check
1379 * @return The string with the replaced environment variables
1381 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1384 * Size an HTTP header field list item, as separated by a comma.
1385 * @param field The field to size
1386 * @param len The length of the field
1387 * @return The return value is a pointer to the beginning of the non-empty
1388 * list item within the original string (or NULL if there is none) and the
1389 * address of field is shifted to the next non-comma, non-whitespace
1390 * character. len is the length of the item excluding any beginning whitespace.
1392 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1395 * Retrieve an HTTP header field list item, as separated by a comma,
1396 * while stripping insignificant whitespace and lowercasing anything not in
1397 * a quoted string or comment.
1398 * @param p The pool to allocate from
1399 * @param field The field to retrieve
1400 * @return The return value is a new string containing the converted list
1401 * item (or NULL if none) and the address pointed to by field is
1402 * shifted to the next non-comma, non-whitespace.
1404 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1407 * Find an item in canonical form (lowercase, no extra spaces) within
1408 * an HTTP field value list.
1409 * @param p The pool to allocate from
1410 * @param line The field value list to search
1411 * @param tok The token to search for
1412 * @return 1 if found, 0 if not found.
1414 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1417 * Retrieve a token, spacing over it and adjusting the pointer to
1418 * the first non-white byte afterwards. Note that these tokens
1419 * are delimited by semis and commas and can also be delimited
1420 * by whitespace at the caller's option.
1421 * @param p The pool to allocate from
1422 * @param accept_line The line to retrieve the token from (adjusted afterwards)
1423 * @param accept_white Is it delimited by whitespace
1426 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1429 * Find http tokens, see the definition of token from RFC2068
1430 * @param p The pool to allocate from
1431 * @param line The line to find the token
1432 * @param tok The token to find
1433 * @return 1 if the token is found, 0 otherwise
1435 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1438 * find http tokens from the end of the line
1439 * @param p The pool to allocate from
1440 * @param line The line to find the token
1441 * @param tok The token to find
1442 * @return 1 if the token is found, 0 otherwise
1444 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1447 * Check for an Absolute URI syntax
1448 * @param u The string to check
1449 * @return 1 if URI, 0 otherwise
1451 AP_DECLARE(int) ap_is_url(const char *u);
1455 * @param url The string to unescape
1456 * @return 0 on success, non-zero otherwise
1458 AP_DECLARE(int) ap_unescape_all(char *url);
1462 * @param url The url to unescape
1463 * @return 0 on success, non-zero otherwise
1465 AP_DECLARE(int) ap_unescape_url(char *url);
1468 * Unescape a URL, but leaving %2f (slashes) escaped
1469 * @param url The url to unescape
1470 * @return 0 on success, non-zero otherwise
1472 AP_DECLARE(int) ap_unescape_url_keep2f(char *url);
1475 * Convert all double slashes to single slashes
1476 * @param name The string to convert
1478 AP_DECLARE(void) ap_no2slash(char *name);
1481 * Remove all ./ and xx/../ substrings from a file name. Also remove
1482 * any leading ../ or /../ substrings.
1483 * @param name the file name to parse
1485 AP_DECLARE(void) ap_getparents(char *name);
1488 * Escape a path segment, as defined in RFC 1808
1489 * @param p The pool to allocate from
1490 * @param s The path to convert
1491 * @return The converted URL
1493 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1496 * Escape a path segment, as defined in RFC 1808, to a preallocated buffer.
1497 * @param c The preallocated buffer to write to
1498 * @param s The path to convert
1499 * @return The converted URL (c)
1501 AP_DECLARE(char *) ap_escape_path_segment_buffer(char *c, const char *s);
1504 * convert an OS path to a URL in an OS dependant way.
1505 * @param p The pool to allocate from
1506 * @param path The path to convert
1507 * @param partial if set, assume that the path will be appended to something
1508 * with a '/' in it (and thus does not prefix "./")
1509 * @return The converted URL
1511 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1513 /** @see ap_os_escape_path */
1514 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1517 * Escape an html string
1518 * @param p The pool to allocate from
1519 * @param s The html to escape
1520 * @return The escaped string
1522 #define ap_escape_html(p,s) ap_escape_html2(p,s,0)
1524 * Escape an html string
1525 * @param p The pool to allocate from
1526 * @param s The html to escape
1527 * @param toasc Whether to escape all non-ASCII chars to &#nnn;
1528 * @return The escaped string
1530 AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc);
1533 * Escape a string for logging
1534 * @param p The pool to allocate from
1535 * @param str The string to escape
1536 * @return The escaped string
1538 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str);
1541 * Escape a string for logging into the error log (without a pool)
1542 * @param dest The buffer to write to
1543 * @param source The string to escape
1544 * @param buflen The buffer size for the escaped string (including "\0")
1545 * @return The len of the escaped string (always < maxlen)
1547 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1551 * Construct a full hostname
1552 * @param p The pool to allocate from
1553 * @param hostname The hostname of the server
1554 * @param port The port the server is running on
1555 * @param r The current request
1556 * @return The server's hostname
1558 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1559 apr_port_t port, const request_rec *r);
1562 * Escape a shell command
1563 * @param p The pool to allocate from
1564 * @param s The command to escape
1565 * @return The escaped shell command
1567 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1570 * Count the number of directories in a path
1571 * @param path The path to count
1572 * @return The number of directories
1574 AP_DECLARE(int) ap_count_dirs(const char *path);
1577 * Copy at most @a n leading directories of @a s into @a d. @a d
1578 * should be at least as large as @a s plus 1 extra byte
1580 * @param d The location to copy to
1581 * @param s The location to copy from
1582 * @param n The number of directories to copy
1583 * @return value is the ever useful pointer to the trailing "\0" of d
1584 * @note on platforms with drive letters, n = 0 returns the "/" root,
1585 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1586 * returns the empty string. */
1587 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1590 * Return the parent directory name (including trailing /) of the file
1592 * @param p The pool to allocate from
1593 * @param s The file to get the parent of
1594 * @return A copy of the file's parent directory
1596 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1599 * Given a directory and filename, create a single path from them. This
1600 * function is smart enough to ensure that there is a sinlge '/' between the
1601 * directory and file names
1602 * @param a The pool to allocate from
1603 * @param dir The directory name
1604 * @param f The filename
1605 * @return A copy of the full path
1606 * @note Never consider using this function if you are dealing with filesystem
1607 * names that need to remain canonical, unless you are merging an apr_dir_read
1608 * path and returned filename. Otherwise, the result is not canonical.
1610 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1613 * Test if the given path has an an absolute path.
1614 * @param p The pool to allocate from
1615 * @param dir The directory name
1616 * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1617 * multiple forms of absolute paths. This only reports if the path is absolute
1618 * in a canonical sense.
1620 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1623 * Does the provided string contain wildcard characters? This is useful
1624 * for determining if the string should be passed to strcmp_match or to strcmp.
1625 * The only wildcard characters recognized are '?' and '*'
1626 * @param str The string to check
1627 * @return 1 if the string has wildcards, 0 otherwise
1629 AP_DECLARE(int) ap_is_matchexp(const char *str);
1632 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1633 * @param str The string to check
1634 * @param expected The pattern to match against
1635 * @return 1 if the two strings match, 0 otherwise
1637 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected);
1640 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1642 * @param str The string to check
1643 * @param expected The pattern to match against
1644 * @return 1 if the two strings match, 0 otherwise
1646 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected);
1649 * Find the first occurrence of the substring s2 in s1, regardless of case
1650 * @param s1 The string to search
1651 * @param s2 The substring to search for
1652 * @return A pointer to the beginning of the substring
1653 * @remark See apr_strmatch() for a faster alternative
1655 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1658 * Return a pointer to the location inside of bigstring immediately after prefix
1659 * @param bigstring The input string
1660 * @param prefix The prefix to strip away
1661 * @return A pointer relative to bigstring after prefix
1663 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1664 const char *prefix);
1667 * Decode a base64 encoded string into memory allocated from a pool
1668 * @param p The pool to allocate from
1669 * @param bufcoded The encoded string
1670 * @return The decoded string
1672 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1675 * Encode a string into memory allocated from a pool in base 64 format
1676 * @param p The pool to allocate from
1677 * @param string The plaintext string
1678 * @return The encoded string
1680 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1683 * Compile a regular expression to be used later
1684 * @param p The pool to allocate from
1685 * @param pattern the regular expression to compile
1686 * @param cflags The bitwise or of one or more of the following:
1687 * @li REG_EXTENDED - Use POSIX extended Regular Expressions
1688 * @li REG_ICASE - Ignore case
1689 * @li REG_NOSUB - Support for substring addressing of matches
1691 * @li REG_NEWLINE - Match-any-character operators don't match new-line
1692 * @return The compiled regular expression
1694 AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1698 * Free the memory associated with a compiled regular expression
1699 * @param p The pool the regex was allocated from
1700 * @param reg The regular expression to free
1702 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
1705 * After performing a successful regex match, you may use this function to
1706 * perform a series of string substitutions based on subexpressions that were
1707 * matched during the call to ap_regexec
1708 * @param p The pool to allocate from
1709 * @param input An arbitrary string containing $1 through $9. These are
1710 * replaced with the corresponding matched sub-expressions
1711 * @param source The string that was originally matched to the regex
1712 * @param nmatch the nmatch returned from ap_pregex
1713 * @param pmatch the pmatch array returned from ap_pregex
1715 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1716 size_t nmatch, ap_regmatch_t pmatch[]);
1719 * We want to downcase the type/subtype for comparison purposes
1720 * but nothing else because ;parameter=foo values are case sensitive.
1721 * @param s The content-type to convert to lowercase
1723 AP_DECLARE(void) ap_content_type_tolower(char *s);
1726 * convert a string to all lowercase
1727 * @param s The string to convert to lowercase
1729 AP_DECLARE(void) ap_str_tolower(char *s);
1732 * Search a string from left to right for the first occurrence of a
1733 * specific character
1734 * @param str The string to search
1735 * @param c The character to search for
1736 * @return The index of the first occurrence of c in str
1738 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1741 * Search a string from right to left for the first occurrence of a
1742 * specific character
1743 * @param str The string to search
1744 * @param c The character to search for
1745 * @return The index of the first occurrence of c in str
1747 AP_DECLARE(int) ap_rind(const char *str, char c);
1750 * Given a string, replace any bare " with \" .
1751 * @param p The pool to allocate memory from
1752 * @param instring The string to search for "
1753 * @return A copy of the string with escaped quotes
1755 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1758 * Given a string, append the PID deliminated by delim.
1759 * Usually used to create a pid-appended filepath name
1760 * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
1761 * a macro, to avoid unistd.h dependency
1762 * @param p The pool to allocate memory from
1763 * @param string The string to append the PID to
1764 * @param delim The string to use to deliminate the string from the PID
1765 * @return A copy of the string with the PID appended
1767 AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
1771 * Parse a given timeout parameter string into an apr_interval_time_t value.
1772 * The unit of the time interval is given as postfix string to the numeric
1773 * string. Currently the following units are understood:
1780 * If no unit is contained in the given timeout parameter the default_time_unit
1781 * will be used instead.
1782 * @param timeout_parameter The string containing the timeout parameter.
1783 * @param timeout The timeout value to be returned.
1784 * @param default_time_unit The default time unit to use if none is specified
1785 * in timeout_parameter.
1786 * @return Status value indicating whether the parsing was successful or not.
1788 AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
1789 const char *timeout_parameter,
1790 apr_interval_time_t *timeout,
1791 const char *default_time_unit);
1793 /* Misc system hackery */
1795 * Given the name of an object in the file system determine if it is a directory
1796 * @param p The pool to allocate from
1797 * @param name The name of the object to check
1798 * @return 1 if it is a directory, 0 otherwise
1800 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1803 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1804 * @param p The pool to allocate from
1805 * @param name The name of the object to check
1806 * @return 1 if it is a directory, 0 otherwise
1808 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1811 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1812 #endif /* _OSD_POSIX */
1815 * Determine the local host name for the current machine
1816 * @param p The pool to allocate from
1817 * @return A copy of the local host name
1819 char *ap_get_local_host(apr_pool_t *p);
1822 * Log an assertion to the error log
1823 * @param szExp The assertion that failed
1824 * @param szFile The file the assertion is in
1825 * @param nLine The line the assertion is defined on
1827 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1828 __attribute__((noreturn));
1831 * @internal Internal Assert function
1833 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1836 * Redefine assert() to something more useful for an Apache...
1838 * Use ap_assert() if the condition should always be checked.
1839 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1843 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1845 #define AP_DEBUG_ASSERT(exp) ((void)0)
1849 * @defgroup stopsignal Flags which indicate places where the sever should stop for debugging.
1851 * A set of flags which indicate places where the server should raise(SIGSTOP).
1852 * This is useful for debugging, because you can then attach to that process
1853 * with gdb and continue. This is important in cases where one_process
1854 * debugging isn't possible.
1856 /** stop on a Detach */
1857 #define SIGSTOP_DETACH 1
1858 /** stop making a child process */
1859 #define SIGSTOP_MAKE_CHILD 2
1860 /** stop spawning a child process */
1861 #define SIGSTOP_SPAWN_CHILD 4
1862 /** stop spawning a child process with a piped log */
1863 #define SIGSTOP_PIPED_LOG_SPAWN 8
1864 /** stop spawning a CGI child process */
1865 #define SIGSTOP_CGI_CHILD 16
1867 /** Macro to get GDB started */
1868 #ifdef DEBUG_SIGSTOP
1869 extern int raise_sigstop_flags;
1870 #define RAISE_SIGSTOP(x) do { \
1871 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1874 #define RAISE_SIGSTOP(x)
1878 * Get HTML describing the address and (optionally) admin of the server.
1879 * @param prefix Text which is prepended to the return value
1880 * @param r The request_rec
1881 * @return HTML describing the server, allocated in @a r's pool.
1883 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1885 /** strtoul does not exist on sunos4. */
1889 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1891 /* The C library has functions that allow const to be silently dropped ...
1892 these macros detect the drop in maintainer mode, but use the native
1893 methods for normal builds
1895 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1896 to be included before the macros are defined or compilation will fail.
1900 AP_DECLARE(char *) ap_strchr(char *s, int c);
1901 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
1902 AP_DECLARE(char *) ap_strrchr(char *s, int c);
1903 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
1904 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
1905 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
1910 # define strchr(s, c) ap_strchr(s,c)
1912 # define strrchr(s, c) ap_strrchr(s,c)
1914 # define strstr(s, c) ap_strstr(s,c)
1918 /** use this instead of strchr */
1919 # define ap_strchr(s, c) strchr(s, c)
1920 /** use this instead of strchr */
1921 # define ap_strchr_c(s, c) strchr(s, c)
1922 /** use this instead of strrchr */
1923 # define ap_strrchr(s, c) strrchr(s, c)
1924 /** use this instead of strrchr */
1925 # define ap_strrchr_c(s, c) strrchr(s, c)
1926 /** use this instead of strrstr*/
1927 # define ap_strstr(s, c) strstr(s, c)
1928 /** use this instead of strrstr*/
1929 # define ap_strstr_c(s, c) strstr(s, c)
1933 #define AP_NORESTART APR_OS_START_USEERR + 1
1939 #endif /* !APACHE_HTTPD_H */
1941 /** @} //APACHE Daemon */
1942 /** @} //APACHE Core */
1943 /** @} //APACHE super group */