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"
68 /* Note: apr_uri.h is also included, see below */
74 /* ----------------------------- config dir ------------------------------ */
76 /** Define this to be the default server home dir. Most things later in this
77 * file with a relative pathname will have this added.
81 /** Set default for OS/2 file system */
82 #define HTTPD_ROOT "/os2httpd"
84 /** Set default for Windows file system */
85 #define HTTPD_ROOT "/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 256
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 60
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 or 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
204 /** default/hard limit on number of leading/trailing empty lines */
205 #ifndef DEFAULT_LIMIT_BLANK_LINES
206 #define DEFAULT_LIMIT_BLANK_LINES 10
210 * The default default character set name to add if AddDefaultCharset is
211 * enabled. Overridden with AddDefaultCharsetName.
213 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
215 /** default HTTP Server protocol */
216 #define AP_SERVER_PROTOCOL "HTTP/1.1"
219 /* ------------------ stuff that modules are allowed to look at ----------- */
221 /** Define this to be what your HTML directory content files are called */
222 #ifndef AP_DEFAULT_INDEX
223 #define AP_DEFAULT_INDEX "index.html"
226 /** The name of the MIME types file */
227 #ifndef AP_TYPES_CONFIG_FILE
228 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
232 * Define the HTML doctype strings centrally.
234 /** HTML 2.0 Doctype */
235 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
236 "DTD HTML 2.0//EN\">\n"
237 /** HTML 3.2 Doctype */
238 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
239 "DTD HTML 3.2 Final//EN\">\n"
240 /** HTML 4.0 Strict Doctype */
241 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
242 "DTD HTML 4.0//EN\"\n" \
243 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
244 /** HTML 4.0 Transitional Doctype */
245 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
246 "DTD HTML 4.0 Transitional//EN\"\n" \
247 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
248 /** HTML 4.0 Frameset Doctype */
249 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
250 "DTD HTML 4.0 Frameset//EN\"\n" \
251 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
252 /** XHTML 1.0 Strict Doctype */
253 #define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
254 "DTD XHTML 1.0 Strict//EN\"\n" \
255 "\"http://www.w3.org/TR/xhtml1/DTD/" \
256 "xhtml1-strict.dtd\">\n"
257 /** XHTML 1.0 Transitional Doctype */
258 #define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
259 "DTD XHTML 1.0 Transitional//EN\"\n" \
260 "\"http://www.w3.org/TR/xhtml1/DTD/" \
261 "xhtml1-transitional.dtd\">\n"
262 /** XHTML 1.0 Frameset Doctype */
263 #define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
264 "DTD XHTML 1.0 Frameset//EN\"\n" \
265 "\"http://www.w3.org/TR/xhtml1/DTD/" \
266 "xhtml1-frameset.dtd\">"
268 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
269 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
270 /** Major part of HTTP protocol */
271 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
272 /** Minor part of HTTP protocol */
273 #define HTTP_VERSION_MINOR(number) ((number)%1000)
275 /* -------------- Port number for server running standalone --------------- */
277 /** default HTTP Port */
278 #define DEFAULT_HTTP_PORT 80
279 /** default HTTPS Port */
280 #define DEFAULT_HTTPS_PORT 443
282 * Check whether @a port is the default port for the request @a r.
283 * @param port The port number
284 * @param r The request
285 * @see #ap_default_port
287 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
289 * Get the default port for a request (which depends on the scheme).
290 * @param r The request
292 #define ap_default_port(r) ap_run_default_port(r)
294 * Get the scheme for a request.
295 * @param r The request
297 #define ap_http_scheme(r) ap_run_http_scheme(r)
299 /** The default string length */
300 #define MAX_STRING_LEN HUGE_STRING_LEN
302 /** The length of a Huge string */
303 #define HUGE_STRING_LEN 8192
305 /** The size of the server's internal read-write buffers */
306 #define AP_IOBUFSIZE 8192
308 /** The max number of regex captures that can be expanded by ap_pregsub */
309 #define AP_MAX_REG_MATCH 10
312 * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
313 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
314 * than that in case the brigade code/filters attempt to read it directly.
315 * ### 16mb is an invention, no idea if it is reasonable.
317 #define AP_MAX_SENDFILE 16777216 /* 2^24 */
320 * MPM child process exit status values
321 * The MPM parent process may check the status to see if special
322 * error handling is required.
325 #define APEXIT_OK 0x0
326 /** A fatal error arising during the server's init sequence */
327 #define APEXIT_INIT 0x2
328 /** The child died during its init sequence */
329 #define APEXIT_CHILDINIT 0x3
331 * The child exited due to a resource shortage.
332 * The parent should limit the rate of forking until
333 * the situation is resolved.
335 #define APEXIT_CHILDSICK 0x7
337 * A fatal error, resulting in the whole server aborting.
338 * If a child exits with this error, the parent process
339 * considers this a server-wide fatal error and aborts.
341 #define APEXIT_CHILDFATAL 0xf
345 * Stuff marked #AP_DECLARE is part of the API, and intended for use
346 * by modules. Its purpose is to allow us to add attributes that
347 * particular platforms or compilers require to every exported function.
349 # define AP_DECLARE(type) type
352 #ifndef AP_DECLARE_NONSTD
354 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
355 * use by modules. The difference between #AP_DECLARE and
356 * #AP_DECLARE_NONSTD is that the latter is required for any functions
357 * which use varargs or are used via indirect function call. This
358 * is to accomodate the two calling conventions in windows dlls.
360 # define AP_DECLARE_NONSTD(type) type
362 #ifndef AP_DECLARE_DATA
363 # define AP_DECLARE_DATA
366 #ifndef AP_MODULE_DECLARE
367 # define AP_MODULE_DECLARE(type) type
369 #ifndef AP_MODULE_DECLARE_NONSTD
370 # define AP_MODULE_DECLARE_NONSTD(type) type
372 #ifndef AP_MODULE_DECLARE_DATA
373 # define AP_MODULE_DECLARE_DATA
378 * modules should not use functions marked AP_CORE_DECLARE
380 #ifndef AP_CORE_DECLARE
381 # define AP_CORE_DECLARE AP_DECLARE
386 * modules should not use functions marked AP_CORE_DECLARE_NONSTD
389 #ifndef AP_CORE_DECLARE_NONSTD
390 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
394 * @defgroup APACHE_APR_STATUS_T HTTPD specific values of apr_status_t
397 #define AP_START_USERERR (APR_OS_START_USERERR + 2000)
398 #define AP_USERERR_LEN 1000
400 /** The function declines to handle the request */
401 #define AP_DECLINED (AP_START_USERERR + 0)
406 * @brief The numeric version information is broken out into fields within this
410 int major; /**< major number */
411 int minor; /**< minor number */
412 int patch; /**< patch number */
413 const char *add_string; /**< additional string like "-dev" */
417 * Return httpd's version information in a numeric form.
419 * @param version Pointer to a version structure for returning the version
422 AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
425 * Get the server banner in a form suitable for sending over the
426 * network, with the level of information controlled by the
427 * ServerTokens directive.
428 * @return The server banner
430 AP_DECLARE(const char *) ap_get_server_banner(void);
433 * Get the server description in a form suitable for local displays,
434 * status reports, or logging. This includes the detailed server
435 * version and information about some modules. It is not affected
436 * by the ServerTokens directive.
437 * @return The server description
439 AP_DECLARE(const char *) ap_get_server_description(void);
442 * Add a component to the server description and banner strings
443 * @param pconf The pool to allocate the component from
444 * @param component The string to add
446 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
449 * Get the date a time that the server was built
450 * @return The server build time string
452 AP_DECLARE(const char *) ap_get_server_built(void);
454 /* non-HTTP status codes returned by hooks */
456 #define OK 0 /**< Module has handled this stage. */
457 #define DECLINED -1 /**< Module declines to handle */
458 #define DONE -2 /**< Module has served the response completely
459 * - it's safe to die() with no more output
461 #define SUSPENDED -3 /**< Module will handle the remainder of the request.
462 * The core will never invoke the request again, */
464 /** Returned by the bottom-most filter if no data was written.
465 * @see ap_pass_brigade(). */
466 #define AP_NOBODY_WROTE -100
467 /** Returned by the bottom-most filter if no data was read.
468 * @see ap_get_brigade(). */
469 #define AP_NOBODY_READ -101
470 /** Returned by any filter if the filter chain encounters an error
471 * and has already dealt with the error response.
473 #define AP_FILTER_ERROR -102
476 * @defgroup HTTP_Status HTTP Status Codes
480 * The size of the static status_lines array in http_protocol.c for
481 * storing all of the potential response status-lines (a sparse table).
482 * When adding a new code here add it to status_lines as well.
483 * A future version should dynamically generate the apr_table_t at startup.
485 #define RESPONSE_CODES 103
487 #define HTTP_CONTINUE 100
488 #define HTTP_SWITCHING_PROTOCOLS 101
489 #define HTTP_PROCESSING 102
491 #define HTTP_CREATED 201
492 #define HTTP_ACCEPTED 202
493 #define HTTP_NON_AUTHORITATIVE 203
494 #define HTTP_NO_CONTENT 204
495 #define HTTP_RESET_CONTENT 205
496 #define HTTP_PARTIAL_CONTENT 206
497 #define HTTP_MULTI_STATUS 207
498 #define HTTP_ALREADY_REPORTED 208
499 #define HTTP_IM_USED 226
500 #define HTTP_MULTIPLE_CHOICES 300
501 #define HTTP_MOVED_PERMANENTLY 301
502 #define HTTP_MOVED_TEMPORARILY 302
503 #define HTTP_SEE_OTHER 303
504 #define HTTP_NOT_MODIFIED 304
505 #define HTTP_USE_PROXY 305
506 #define HTTP_TEMPORARY_REDIRECT 307
507 #define HTTP_PERMANENT_REDIRECT 308
508 #define HTTP_BAD_REQUEST 400
509 #define HTTP_UNAUTHORIZED 401
510 #define HTTP_PAYMENT_REQUIRED 402
511 #define HTTP_FORBIDDEN 403
512 #define HTTP_NOT_FOUND 404
513 #define HTTP_METHOD_NOT_ALLOWED 405
514 #define HTTP_NOT_ACCEPTABLE 406
515 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
516 #define HTTP_REQUEST_TIME_OUT 408
517 #define HTTP_CONFLICT 409
518 #define HTTP_GONE 410
519 #define HTTP_LENGTH_REQUIRED 411
520 #define HTTP_PRECONDITION_FAILED 412
521 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
522 #define HTTP_REQUEST_URI_TOO_LARGE 414
523 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
524 #define HTTP_RANGE_NOT_SATISFIABLE 416
525 #define HTTP_EXPECTATION_FAILED 417
526 #define HTTP_IM_A_TEAPOT 418
527 #define HTTP_MISDIRECTED_REQUEST 421
528 #define HTTP_UNPROCESSABLE_ENTITY 422
529 #define HTTP_LOCKED 423
530 #define HTTP_FAILED_DEPENDENCY 424
531 #define HTTP_UPGRADE_REQUIRED 426
532 #define HTTP_PRECONDITION_REQUIRED 428
533 #define HTTP_TOO_MANY_REQUESTS 429
534 #define HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE 431
535 #define HTTP_UNAVAILABLE_FOR_LEGAL_REASONS 451
536 #define HTTP_INTERNAL_SERVER_ERROR 500
537 #define HTTP_NOT_IMPLEMENTED 501
538 #define HTTP_BAD_GATEWAY 502
539 #define HTTP_SERVICE_UNAVAILABLE 503
540 #define HTTP_GATEWAY_TIME_OUT 504
541 #define HTTP_VERSION_NOT_SUPPORTED 505
542 #define HTTP_VARIANT_ALSO_VARIES 506
543 #define HTTP_INSUFFICIENT_STORAGE 507
544 #define HTTP_LOOP_DETECTED 508
545 #define HTTP_NOT_EXTENDED 510
546 #define HTTP_NETWORK_AUTHENTICATION_REQUIRED 511
548 /** is the status code informational */
549 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
550 /** is the status code OK ?*/
551 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
552 /** is the status code a redirect */
553 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
554 /** is the status code a error (client or server) */
555 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
556 /** is the status code a client error */
557 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
558 /** is the status code a server error */
559 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
560 /** is the status code a (potentially) valid response code? */
561 #define ap_is_HTTP_VALID_RESPONSE(x) (((x) >= 100)&&((x) < 600))
563 /** should the status code drop the connection */
564 #define ap_status_drops_connection(x) \
565 (((x) == HTTP_BAD_REQUEST) || \
566 ((x) == HTTP_REQUEST_TIME_OUT) || \
567 ((x) == HTTP_LENGTH_REQUIRED) || \
568 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
569 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
570 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
571 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
572 ((x) == HTTP_NOT_IMPLEMENTED))
576 * @defgroup Methods List of Methods recognized by the server
577 * @ingroup APACHE_CORE_DAEMON
580 * @brief Methods recognized (but not necessarily handled) by the server.
582 * These constants are used in bit shifting masks of size int, so it is
583 * unsafe to have more methods than bits in an int. HEAD == M_GET.
584 * This list must be tracked by the list in http_protocol.c in routine
585 * ap_method_name_of().
589 #define M_GET 0 /** RFC 2616: HTTP */
590 #define M_PUT 1 /* : */
595 #define M_TRACE 6 /** RFC 2616: HTTP */
596 #define M_PATCH 7 /** no rfc(!) ### remove this one? */
597 #define M_PROPFIND 8 /** RFC 2518: WebDAV */
598 #define M_PROPPATCH 9 /* : */
603 #define M_UNLOCK 14 /** RFC 2518: WebDAV */
604 #define M_VERSION_CONTROL 15 /** RFC 3253: WebDAV Versioning */
605 #define M_CHECKOUT 16 /* : */
606 #define M_UNCHECKOUT 17
611 #define M_MKWORKSPACE 22
612 #define M_MKACTIVITY 23
613 #define M_BASELINE_CONTROL 24
615 #define M_INVALID 26 /** no valid method */
616 #define M_BREW 27 /** RFC 2324: HTCPCP/1.0 */
617 #define M_WHEN 28 /** RFC 2324: HTCPCP/1.0 */
620 * METHODS needs to be equal to the number of bits
621 * we are using for limit masks.
626 * The method mask bit to shift for anding with a bitmask.
628 #define AP_METHOD_BIT ((apr_int64_t)1)
632 /** @see ap_method_list_t */
633 typedef struct ap_method_list_t ap_method_list_t;
636 * @struct ap_method_list_t
637 * @brief Structure for handling HTTP methods.
639 * Methods known to the server are accessed via a bitmask shortcut;
640 * extension methods are handled by an array.
642 struct ap_method_list_t {
643 /** The bitmask used for known methods */
644 apr_int64_t method_mask;
645 /** the array used for extension methods */
646 apr_array_header_t *method_list;
650 * @defgroup module_magic Module Magic mime types
653 /** Magic for mod_cgi[d] */
654 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
655 /** Magic for mod_include */
656 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
657 /** Magic for mod_include */
658 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
659 /** Magic for mod_dir */
660 #define DIR_MAGIC_TYPE "httpd/unix-directory"
661 /** Default for r->handler if no content-type set by type_checker */
662 #define AP_DEFAULT_HANDLER_NAME ""
663 #define AP_IS_DEFAULT_HANDLER_NAME(x) (*x == '\0')
666 /* Just in case your linefeed isn't the one the other end is expecting. */
667 #if !APR_CHARSET_EBCDIC
670 /** carrige return */
672 /** carrige return /Line Feed Combo */
673 #define CRLF "\015\012"
674 #else /* APR_CHARSET_EBCDIC */
675 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
676 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
677 * "native EBCDIC" CR and NL characters. These are therefore
684 #endif /* APR_CHARSET_EBCDIC */
685 /** Useful for common code with either platform charset. */
686 #define CRLF_ASCII "\015\012"
689 * @defgroup values_request_rec_body Possible values for request_rec.read_body
691 * Possible values for request_rec.read_body (set by handling module):
694 /** Send 413 error if message has any body */
695 #define REQUEST_NO_BODY 0
696 /** Send 411 error if body without Content-Length */
697 #define REQUEST_CHUNKED_ERROR 1
698 /** If chunked, remove the chunks for me. */
699 #define REQUEST_CHUNKED_DECHUNK 2
700 /** @} // values_request_rec_body */
703 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
704 * @ingroup APACHE_CORE_DAEMON
706 * Possible values for request_rec.used_path_info:
709 /** Accept the path_info from the request */
710 #define AP_REQ_ACCEPT_PATH_INFO 0
711 /** Return a 404 error if path_info was given */
712 #define AP_REQ_REJECT_PATH_INFO 1
713 /** Module may chose to use the given path_info */
714 #define AP_REQ_DEFAULT_PATH_INFO 2
716 /** @} // values_request_rec_used_path_info */
720 * Things which may vary per file-lookup WITHIN a request ---
721 * e.g., state of MIME config. Basically, the name of an object, info
722 * about the object, and any other info we may ahve which may need to
723 * change as we go poking around looking for it (e.g., overridden by
726 * Note how the default state of almost all these things is properly
727 * zero, so that allocating it with pcalloc does the right thing without
728 * a whole lot of hairy initialization... so long as we are willing to
729 * make the (fairly) portable assumption that the bit pattern of a NULL
730 * pointer is, in fact, zero.
734 * @brief This represents the result of calling htaccess; these are cached for
737 struct htaccess_result {
738 /** the directory to which this applies */
740 /** the overrides allowed for the .htaccess file */
742 /** the override options allowed for the .htaccess file */
744 /** Table of allowed directives for override */
745 apr_table_t *override_list;
746 /** the configuration directives */
747 struct ap_conf_vector_t *htaccess;
748 /** the next one, or NULL if no more; N.B. never change this */
749 const struct htaccess_result *next;
752 /* The following four types define a hierarchy of activities, so that
753 * given a request_rec r you can write r->connection->server->process
754 * to get to the process_rec. While this reduces substantially the
755 * number of arguments that various hooks require beware that in
756 * threaded versions of the server you must consider multiplexing
760 /** A structure that represents one process */
761 typedef struct process_rec process_rec;
762 /** A structure that represents a virtual server */
763 typedef struct server_rec server_rec;
764 /** A structure that represents one connection */
765 typedef struct conn_rec conn_rec;
766 /** A structure that represents one slave connection */
767 typedef struct conn_slave_rec conn_slave_rec;
768 /** A structure that represents the current request */
769 typedef struct request_rec request_rec;
770 /** A structure that represents the status of the current connection */
771 typedef struct conn_state_t conn_state_t;
773 /* ### would be nice to not include this from httpd.h ... */
774 /* This comes after we have defined the request_rec type */
778 * @brief A structure that represents one process
781 /** Global pool. Cleared upon normal exit */
783 /** Configuration pool. Cleared upon restart */
785 /** The program name used to execute the program */
786 const char *short_name;
787 /** The command line arguments */
788 const char * const *argv;
789 /** Number of command line arguments passed to the program */
794 * @brief A structure that represents the current request
797 /** The pool associated with the request */
799 /** The connection to the client */
800 conn_rec *connection;
801 /** The virtual host for this request */
804 /** Pointer to the redirected request if this is an external redirect */
806 /** Pointer to the previous request if this is an internal redirect */
809 /** Pointer to the main request if this is a sub-request
810 * (see http_request.h) */
813 /* Info about the request itself... we begin with stuff that only
814 * protocol.c should ever touch...
816 /** First line of request */
818 /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
820 /** A proxy request (calculated during post_read_request/translate_name)
821 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
825 /** HEAD request, as opposed to GET */
827 /** Protocol version number of protocol; 1.1 = 1001 */
829 /** Protocol string, as given to us, or HTTP/0.9 */
830 const char *protocol;
831 /** Host, as set by full URI or Host: header.
832 * For literal IPv6 addresses, this does NOT include the surrounding [ ]
834 const char *hostname;
836 /** Time when the request started */
837 apr_time_t request_time;
839 /** Status line, if set by script */
840 const char *status_line;
844 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
845 * look, but don't touch.
848 /** M_GET, M_POST, etc. */
850 /** Request method (eg. GET, HEAD, POST, etc.) */
854 * 'allowed' is a bitvector of the allowed methods.
856 * A handler must ensure that the request method is one that
857 * it is capable of handling. Generally modules should DECLINE
858 * any request methods they do not handle. Prior to aborting the
859 * handler like this the handler should set r->allowed to the list
860 * of methods that it is willing to handle. This bitvector is used
861 * to construct the "Allow:" header required for OPTIONS requests,
862 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
864 * Since the default_handler deals with OPTIONS, all modules can
865 * usually decline to deal with OPTIONS. TRACE is always allowed,
866 * modules don't need to set it explicitly.
868 * Since the default_handler will always handle a GET, a
869 * module which does *not* implement GET should probably return
870 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
871 * handler can't be installed by mod_actions.
874 /** Array of extension methods */
875 apr_array_header_t *allowed_xmethods;
876 /** List of allowed methods */
877 ap_method_list_t *allowed_methods;
879 /** byte count in stream is for body */
880 apr_off_t sent_bodyct;
881 /** body byte count, for easy access */
882 apr_off_t bytes_sent;
883 /** Last modified time of the requested resource */
886 /* HTTP/1.1 connection-level features */
888 /** The Range: header */
890 /** The "real" content length */
892 /** sending chunked transfer-coding */
895 /** Method for reading the request body
896 * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
897 * REQUEST_CHUNKED_DECHUNK, etc...) */
899 /** reading chunked transfer-coding */
901 /** is client waiting for a 100 response? */
902 unsigned expecting_100;
903 /** The optional kept body of the request. */
904 apr_bucket_brigade *kept_body;
905 /** For ap_body_to_table(): parsed body */
906 /* XXX: ap_body_to_table has been removed. Remove body_table too or
907 * XXX: keep it to reintroduce ap_body_to_table without major bump? */
908 apr_table_t *body_table;
909 /** Remaining bytes left to read from the request body */
911 /** Number of bytes that have been read from the request body */
912 apr_off_t read_length;
914 /* MIME header environments, in and out. Also, an array containing
915 * environment variables to be passed to subprocesses, so people can
916 * write modules to add to that environment.
918 * The difference between headers_out and err_headers_out is that the
919 * latter are printed even on error, and persist across internal redirects
920 * (so the headers printed for ErrorDocument handlers will have them).
922 * The 'notes' apr_table_t is for notes from one module to another, with no
923 * other set purpose in mind...
926 /** MIME header environment from the request */
927 apr_table_t *headers_in;
928 /** MIME header environment for the response */
929 apr_table_t *headers_out;
930 /** MIME header environment for the response, printed even on errors and
931 * persist across internal redirects */
932 apr_table_t *err_headers_out;
933 /** Array of environment variables to be used for sub processes */
934 apr_table_t *subprocess_env;
935 /** Notes from one module to another */
938 /* content_type, handler, content_encoding, and all content_languages
939 * MUST be lowercased strings. They may be pointers to static strings;
940 * they should not be modified in place.
942 /** The content-type for the current request */
943 const char *content_type; /* Break these out --- we dispatch on 'em */
944 /** The handler string that we use to call a handler function */
945 const char *handler; /* What we *really* dispatch on */
947 /** How to encode the data */
948 const char *content_encoding;
949 /** Array of strings representing the content languages */
950 apr_array_header_t *content_languages;
952 /** variant list validator (if negotiated) */
953 char *vlist_validator;
955 /** If an authentication check was made, this gets set to the user name. */
957 /** If an authentication check was made, this gets set to the auth type. */
960 /* What object is being requested (either directly, or via include
961 * or content-negotiation mapping).
964 /** The URI without any parsing performed */
966 /** The path portion of the URI, or "/" if no path provided */
968 /** The filename on disk corresponding to this response */
970 /** The true filename stored in the filesystem, as in the true alpha case
971 * and alias correction, e.g. "Image.jpeg" not "IMAGE$1.JPE" on Windows.
972 * The core map_to_storage canonicalizes r->filename when they mismatch */
973 char *canonical_filename;
974 /** The PATH_INFO extracted from this request */
976 /** The QUERY_ARGS extracted from this request */
980 * Flag for the handler to accept or reject path_info on
981 * the current request. All modules should respect the
982 * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
983 * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
984 * may follow existing conventions. This is set to the
985 * user's preference upon HOOK_VERY_FIRST of the fixups.
989 /** A flag to determine if the eos bucket has been sent yet */
992 /* Various other config info which may change with .htaccess files
993 * These are config vectors, with one void* pointer for each module
994 * (the thing pointed to being the module's business).
997 /** Options set in config files, etc. */
998 struct ap_conf_vector_t *per_dir_config;
999 /** Notes on *this* request */
1000 struct ap_conf_vector_t *request_config;
1002 /** Optional request log level configuration. Will usually point
1003 * to a server or per_dir config, i.e. must be copied before
1005 const struct ap_logconf *log;
1007 /** Id to identify request in access and error log. Set when the first
1008 * error log entry for this request is generated.
1013 * A linked list of the .htaccess configuration directives
1014 * accessed by this request.
1015 * N.B. always add to the head of the list, _never_ to the end.
1016 * that way, a sub request's list can (temporarily) point to a parent's list
1018 const struct htaccess_result *htaccess;
1020 /** A list of output filters to be used for this request */
1021 struct ap_filter_t *output_filters;
1022 /** A list of input filters to be used for this request */
1023 struct ap_filter_t *input_filters;
1025 /** A list of protocol level output filters to be used for this
1027 struct ap_filter_t *proto_output_filters;
1028 /** A list of protocol level input filters to be used for this
1030 struct ap_filter_t *proto_input_filters;
1032 /** This response can not be cached */
1034 /** There is no local copy of this response */
1037 /** Mutex protect callbacks registered with ap_mpm_register_timed_callback
1038 * from being run before the original handler finishes running
1041 apr_thread_mutex_t *invoke_mtx;
1044 /** A struct containing the components of URI */
1045 apr_uri_t parsed_uri;
1046 /** finfo.protection (st_mode) set to zero if no such file */
1049 /** remote address information from conn_rec, can be overridden if
1050 * necessary by a module.
1051 * This is the address that originated the request.
1053 apr_sockaddr_t *useragent_addr;
1056 /** MIME trailer environment from the request */
1057 apr_table_t *trailers_in;
1058 /** MIME trailer environment from the response */
1059 apr_table_t *trailers_out;
1061 /** Originator'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 * ap_get_useragent_host() */
1064 char *useragent_host;
1065 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1067 * TODO: 2 bit signed bitfield when this structure is compacted
1073 * @defgroup ProxyReq Proxy request types
1075 * Possible values of request_rec->proxyreq. A request could be normal,
1076 * proxied or reverse proxied. Normally proxied and reverse proxied are
1077 * grouped together as just "proxied", but sometimes it's necessary to
1078 * tell the difference between the two, such as for authentication.
1082 #define PROXYREQ_NONE 0 /**< No proxy */
1083 #define PROXYREQ_PROXY 1 /**< Standard proxy */
1084 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
1085 #define PROXYREQ_RESPONSE 3 /**< Origin response */
1090 * @brief Enumeration of connection keepalive options
1096 } ap_conn_keepalive_e;
1099 * @brief Structure to store things which are per connection
1102 /** Pool associated with this connection */
1104 /** Physical vhost this conn came in on */
1105 server_rec *base_server;
1106 /** used by http_vhost.c */
1107 void *vhost_lookup_data;
1109 /* Information about the connection itself */
1110 /** local address */
1111 apr_sockaddr_t *local_addr;
1112 /** remote address; this is the end-point of the next hop, for the address
1113 * of the request creator, see useragent_addr in request_rec
1115 apr_sockaddr_t *client_addr;
1117 /** Client's IP address; this is the end-point of the next hop, for the
1118 * IP of the request creator, see useragent_ip in request_rec
1121 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
1122 * "" if it has and no address was found. N.B. Only access this though
1123 * get_remote_host() */
1125 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
1126 * get_remote_logname() */
1127 /* TODO: Remove from request_rec, make local to mod_ident */
1128 char *remote_logname;
1130 /** server IP address */
1132 /** used for ap_get_server_name when UseCanonicalName is set to DNS
1133 * (ignores setting of HostnameLookups) */
1136 /** ID of this connection; unique at any point in time */
1138 /** Config vector containing pointers to connections per-server
1139 * config structures. */
1140 struct ap_conf_vector_t *conn_config;
1141 /** Notes on *this* connection: send note from one module to
1142 * another. must remain valid for all requests on this conn */
1144 /** A list of input filters to be used for this connection */
1145 struct ap_filter_t *input_filters;
1146 /** A list of output filters to be used for this connection */
1147 struct ap_filter_t *output_filters;
1148 /** handle to scoreboard information for this connection */
1150 /** The bucket allocator to use for all bucket/brigade creations */
1151 struct apr_bucket_alloc_t *bucket_alloc;
1152 /** The current state of this connection; may be NULL if not used by MPM */
1154 /** Is there data pending in the input filters or connection? */
1155 int data_in_input_filters;
1156 /** No longer used, replaced with ap_filter_should_yield() */
1157 int data_in_output_filters;
1159 /** Are there any filters that clogg/buffer the input stream, breaking
1162 unsigned int clogging_input_filters:1;
1164 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1166 signed int double_reverse:2;
1168 /** Are we still talking? */
1171 /** Are we going to keep the connection alive for another request?
1172 * @see ap_conn_keepalive_e */
1173 ap_conn_keepalive_e keepalive;
1175 /** How many times have we used it? */
1178 /** Optional connection log level configuration. May point to a server or
1179 * per_dir config, i.e. must be copied before modifying */
1180 const struct ap_logconf *log;
1182 /** Id to identify this connection in error log. Set when the first
1183 * error log entry for this connection is generated.
1188 /** This points to the current thread being used to process this request,
1189 * over the lifetime of a request, the value may change. Users of the connection
1190 * record should not rely upon it staying the same between calls that involve
1194 apr_thread_t *current_thread;
1197 /** Array of slave connections (conn_slave_rec *) for this connection. */
1198 apr_array_header_t *slaves;
1200 /** The "real" master connection. NULL if I am the master. */
1203 /** context of this connection */
1206 /** Context under which this connection was suspended */
1207 void *suspended_baton;
1209 /** Array of requests being handled under this connection. */
1210 apr_array_header_t *requests;
1212 /** Empty bucket brigade */
1213 apr_bucket_brigade *empty;
1215 /** Hashtable of filters with setaside buckets for write completion */
1216 apr_hash_t *filters;
1218 /** The minimum level of filter type to allow setaside buckets */
1222 struct conn_slave_rec {
1227 * Enumeration of connection states
1228 * The two states CONN_STATE_LINGER_NORMAL and CONN_STATE_LINGER_SHORT may
1229 * only be set by the MPM. Use CONN_STATE_LINGER outside of the MPM.
1232 CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1233 CONN_STATE_READ_REQUEST_LINE,
1235 CONN_STATE_WRITE_COMPLETION,
1236 CONN_STATE_SUSPENDED,
1237 CONN_STATE_LINGER, /* connection may be closed with lingering */
1238 CONN_STATE_LINGER_NORMAL, /* MPM has started lingering close with normal timeout */
1239 CONN_STATE_LINGER_SHORT /* MPM has started lingering close with short timeout */
1244 CONN_SENSE_WANT_READ, /* next event must be read */
1245 CONN_SENSE_WANT_WRITE /* next event must be write */
1249 * @brief A structure to contain connection state information
1251 struct conn_state_t {
1252 /** Current state of the connection */
1254 /** Whether to read instead of write, or write instead of read */
1258 /* Per-vhost config... */
1261 * The address 255.255.255.255, when used as a virtualhost address,
1262 * will become the "default" server when the ip doesn't match other vhosts.
1264 #define DEFAULT_VHOST_ADDR 0xfffffffful
1268 * @struct server_addr_rec
1269 * @brief A structure to be used for Per-vhost config
1271 typedef struct server_addr_rec server_addr_rec;
1272 struct server_addr_rec {
1273 /** The next server in the list */
1274 server_addr_rec *next;
1275 /** The name given in "<VirtualHost>" */
1277 /** The bound address, for this server */
1278 apr_sockaddr_t *host_addr;
1279 /** The bound port, for this server */
1280 apr_port_t host_port;
1284 /** The per-module log levels */
1285 signed char *module_levels;
1287 /** The log level for this server */
1291 * @brief A structure to store information for each virtual server
1294 /** The process this server is running in */
1295 process_rec *process;
1296 /** The next server in the list */
1299 /* Log files --- note that transfer log is now in the modules... */
1301 /** The name of the error log */
1303 /** A file descriptor that references the error log */
1304 apr_file_t *error_log;
1305 /** The log level configuration */
1306 struct ap_logconf log;
1307 /** External error log writer provider */
1308 struct ap_errorlog_provider *errorlog_provider;
1309 /** Handle to be passed to external log provider's logging method */
1310 void *errorlog_provider_handle;
1312 /* Module-specific configuration for server, and defaults... */
1314 /** Config vector containing pointers to modules' per-server config
1316 struct ap_conf_vector_t *module_config;
1317 /** MIME type info, etc., before we start checking per-directory info */
1318 struct ap_conf_vector_t *lookup_defaults;
1320 /** The name of the server */
1321 const char *defn_name;
1322 /** The line of the config file that the server was defined on */
1323 unsigned defn_line_number;
1324 /** true if this is the virtual server */
1328 /* Information for redirects */
1330 /** for redirects, etc. */
1332 /** The server request scheme for redirect responses */
1333 const char *server_scheme;
1335 /* Contact information */
1337 /** The admin's contact information */
1339 /** The server hostname */
1340 char *server_hostname;
1342 /* Transaction handling */
1344 /** I haven't got a clue */
1345 server_addr_rec *addrs;
1346 /** Timeout, as an apr interval, before we give up */
1347 apr_interval_time_t timeout;
1348 /** The apr interval we will wait for another request */
1349 apr_interval_time_t keep_alive_timeout;
1350 /** Maximum requests per connection */
1352 /** Use persistent connections? */
1355 /** Normal names for ServerAlias servers */
1356 apr_array_header_t *names;
1357 /** Wildcarded names for ServerAlias servers */
1358 apr_array_header_t *wild_names;
1360 /** Pathname for ServerPath */
1362 /** Length of path */
1365 /** limit on size of the HTTP request line */
1367 /** limit on size of any request header field */
1368 int limit_req_fieldsize;
1369 /** limit on number of request header fields */
1370 int limit_req_fields;
1372 /** Opaque storage location */
1375 /** Whether the keepalive timeout is explicit (1) or
1376 * inherited (0) from the base server (either first
1377 * server on the same IP:port or main server) */
1378 unsigned int keep_alive_timeout_set:1;
1382 * @struct ap_sload_t
1383 * @brief A structure to hold server load params
1385 typedef struct ap_sload_t ap_sload_t;
1387 /* percentage of process/threads ready/idle (0->100)*/
1389 /* percentage of process/threads busy (0->100) */
1391 /* total bytes served */
1392 apr_off_t bytes_served;
1393 /* total access count */
1394 unsigned long access_count;
1398 * @struct ap_loadavg_t
1399 * @brief A structure to hold various server loadavg
1401 typedef struct ap_loadavg_t ap_loadavg_t;
1402 struct ap_loadavg_t {
1403 /* current loadavg, ala getloadavg() */
1407 /* 15 min loadavg */
1412 * Get the context_document_root for a request. This is a generalization of
1413 * the document root, which is too limited in the presence of mappers like
1414 * mod_userdir and mod_alias. The context_document_root is the directory
1415 * on disk that maps to the context_prefix URI prefix.
1416 * @param r The request
1417 * @note For resources that do not map to the file system or for very complex
1418 * mappings, this information may still be wrong.
1420 AP_DECLARE(const char *) ap_context_document_root(request_rec *r);
1423 * Get the context_prefix for a request. The context_prefix URI prefix
1424 * maps to the context_document_root on disk.
1425 * @param r The request
1427 AP_DECLARE(const char *) ap_context_prefix(request_rec *r);
1429 /** Set context_prefix and context_document_root for a request.
1430 * @param r The request
1431 * @param prefix the URI prefix, without trailing slash
1432 * @param document_root the corresponding directory on disk, without trailing
1434 * @note If one of prefix of document_root is NULL, the corrsponding
1435 * property will not be changed.
1437 AP_DECLARE(void) ap_set_context_info(request_rec *r, const char *prefix,
1438 const char *document_root);
1440 /** Set per-request document root. This is for mass virtual hosting modules
1441 * that want to provide the correct DOCUMENT_ROOT value to scripts.
1442 * @param r The request
1443 * @param document_root the document root for the request.
1445 AP_DECLARE(void) ap_set_document_root(request_rec *r, const char *document_root);
1448 * Examine a field value (such as a media-/content-type) string and return
1449 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1450 * @param p Pool to allocate memory from
1451 * @param intype The field to examine
1452 * @return A copy of the field minus any parameters
1454 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1457 * Convert a time from an integer into a string in a specified format
1458 * @param p The pool to allocate memory from
1459 * @param t The time to convert
1460 * @param fmt The format to use for the conversion
1461 * @param gmt Convert the time for GMT?
1462 * @return The string that represents the specified time
1464 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1466 /* String handling. The *_nc variants allow you to use non-const char **s as
1467 arguments (unfortunately C won't automatically convert a char ** to a const
1471 * Get the characters until the first occurrence of a specified character
1472 * @param p The pool to allocate memory from
1473 * @param line The string to get the characters from
1474 * @param stop The character to stop at
1475 * @return A copy of the characters up to the first stop character
1477 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1480 * Get the characters until the first occurrence of a specified character
1481 * @param p The pool to allocate memory from
1482 * @param line The string to get the characters from
1483 * @param stop The character to stop at
1484 * @return A copy of the characters up to the first stop character
1485 * @note This is the same as ap_getword(), except it doesn't use const char **.
1487 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1490 * Get the first word from a given string. A word is defined as all characters
1491 * up to the first whitespace.
1492 * @param p The pool to allocate memory from
1493 * @param line The string to traverse
1494 * @return The first word in the line
1496 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1499 * Get the first word from a given string. A word is defined as all characters
1500 * up to the first whitespace.
1501 * @param p The pool to allocate memory from
1502 * @param line The string to traverse
1503 * @return The first word in the line
1504 * @note The same as ap_getword_white(), except it doesn't use const char**
1506 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1509 * Get all characters from the first occurrence of @a stop to the first "\0"
1510 * @param p The pool to allocate memory from
1511 * @param line The line to traverse
1512 * @param stop The character to start at
1513 * @return A copy of all characters after the first occurrence of the specified
1516 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1520 * Get all characters from the first occurrence of @a stop to the first "\0"
1521 * @param p The pool to allocate memory from
1522 * @param line The line to traverse
1523 * @param stop The character to start at
1524 * @return A copy of all characters after the first occurrence of the specified
1526 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1528 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1531 * Get the second word in the string paying attention to quoting
1532 * @param p The pool to allocate from
1533 * @param line The line to traverse
1534 * @return A copy of the string
1536 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1539 * Get the second word in the string paying attention to quoting
1540 * @param p The pool to allocate from
1541 * @param line The line to traverse
1542 * @return A copy of the string
1543 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1545 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1548 * Get the second word in the string paying attention to quoting,
1549 * with {...} supported as well as "..." and '...'
1550 * @param p The pool to allocate from
1551 * @param line The line to traverse
1552 * @return A copy of the string
1554 AP_DECLARE(char *) ap_getword_conf2(apr_pool_t *p, const char **line);
1557 * Get the second word in the string paying attention to quoting,
1558 * with {...} supported as well as "..." and '...'
1559 * @param p The pool to allocate from
1560 * @param line The line to traverse
1561 * @return A copy of the string
1562 * @note The same as ap_getword_conf2(), except it doesn't use const char **.
1564 AP_DECLARE(char *) ap_getword_conf2_nc(apr_pool_t *p, char **line);
1567 * Check a string for any config define or environment variable construct
1568 * and replace each of them by the value of that variable, if it exists.
1569 * The default syntax of the constructs is ${ENV} but can be changed by
1570 * setting the define::* config defines. If the variable does not exist,
1571 * leave the ${ENV} construct alone but print a warning.
1572 * @param p The pool to allocate from
1573 * @param word The string to check
1574 * @return The string with the replaced environment variables
1576 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1579 * Size an HTTP header field list item, as separated by a comma.
1580 * @param field The field to size
1581 * @param len The length of the field
1582 * @return The return value is a pointer to the beginning of the non-empty
1583 * list item within the original string (or NULL if there is none) and the
1584 * address of field is shifted to the next non-comma, non-whitespace
1585 * character. len is the length of the item excluding any beginning whitespace.
1587 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1590 * Retrieve an HTTP header field list item, as separated by a comma,
1591 * while stripping insignificant whitespace and lowercasing anything not in
1592 * a quoted string or comment.
1593 * @param p The pool to allocate from
1594 * @param field The field to retrieve
1595 * @return The return value is a new string containing the converted list
1596 * item (or NULL if none) and the address pointed to by field is
1597 * shifted to the next non-comma, non-whitespace.
1599 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1602 * Find an item in canonical form (lowercase, no extra spaces) within
1603 * an HTTP field value list.
1604 * @param p The pool to allocate from
1605 * @param line The field value list to search
1606 * @param tok The token to search for
1607 * @return 1 if found, 0 if not found.
1609 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1612 * Do a weak ETag comparison within an HTTP field value list.
1613 * @param p The pool to allocate from
1614 * @param line The field value list to search
1615 * @param tok The token to search for
1616 * @return 1 if found, 0 if not found.
1618 AP_DECLARE(int) ap_find_etag_weak(apr_pool_t *p, const char *line, const char *tok);
1621 * Do a strong ETag comparison within an HTTP field value list.
1622 * @param p The pool to allocate from
1623 * @param line The field value list to search
1624 * @param tok The token to search for
1625 * @return 1 if found, 0 if not found.
1627 AP_DECLARE(int) ap_find_etag_strong(apr_pool_t *p, const char *line, const char *tok);
1630 * Retrieve an array of tokens in the format "1#token" defined in RFC2616. Only
1631 * accepts ',' as a delimiter, does not accept quoted strings, and errors on
1633 * @param p The pool to allocate from
1634 * @param tok The line to read tokens from
1635 * @param tokens Pointer to an array of tokens. If not NULL, must be an array
1636 * of char*, otherwise it will be allocated on @a p when a token is found
1637 * @param skip_invalid If true, when an invalid separator is encountered, it
1639 * @return NULL on success, an error string otherwise.
1640 * @remark *tokens may be NULL on output if NULL in input and no token is found
1642 AP_DECLARE(const char *) ap_parse_token_list_strict(apr_pool_t *p, const char *tok,
1643 apr_array_header_t **tokens,
1647 * Retrieve a token, spacing over it and adjusting the pointer to
1648 * the first non-white byte afterwards. Note that these tokens
1649 * are delimited by semis and commas and can also be delimited
1650 * by whitespace at the caller's option.
1651 * @param p The pool to allocate from
1652 * @param accept_line The line to retrieve the token from (adjusted afterwards)
1653 * @param accept_white Is it delimited by whitespace
1656 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1659 * Find http tokens, see the definition of token from RFC2068
1660 * @param p The pool to allocate from
1661 * @param line The line to find the token
1662 * @param tok The token to find
1663 * @return 1 if the token is found, 0 otherwise
1665 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1668 * find http tokens from the end of the line
1669 * @param p The pool to allocate from
1670 * @param line The line to find the token
1671 * @param tok The token to find
1672 * @return 1 if the token is found, 0 otherwise
1674 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1677 * Check for an Absolute URI syntax
1678 * @param u The string to check
1679 * @return 1 if URI, 0 otherwise
1681 AP_DECLARE(int) ap_is_url(const char *u);
1685 * @param url The string to unescape
1686 * @return 0 on success, non-zero otherwise
1688 AP_DECLARE(int) ap_unescape_all(char *url);
1692 * @param url The url to unescape
1693 * @return 0 on success, non-zero otherwise
1694 * @deprecated Replaced by apr_unescape_url() in APR
1696 AP_DECLARE(int) ap_unescape_url(char *url);
1699 * Unescape a URL, but leaving %2f (slashes) escaped
1700 * @param url The url to unescape
1701 * @param decode_slashes Whether or not slashes should be decoded
1702 * @return 0 on success, non-zero otherwise
1703 * @deprecated Replaced by apr_unescape_url() in APR
1705 AP_DECLARE(int) ap_unescape_url_keep2f(char *url, int decode_slashes);
1708 * Unescape an application/x-www-form-urlencoded string
1709 * @param query The query to unescape
1710 * @return 0 on success, non-zero otherwise
1711 * @deprecated Replaced by apr_unescape_url() in APR
1713 AP_DECLARE(int) ap_unescape_urlencoded(char *query);
1716 * Convert all double slashes to single slashes
1717 * @param name The string to convert
1719 AP_DECLARE(void) ap_no2slash(char *name)
1720 AP_FN_ATTR_NONNULL_ALL;
1723 * Remove all ./ and xx/../ substrings from a file name. Also remove
1724 * any leading ../ or /../ substrings.
1725 * @param name the file name to parse
1727 AP_DECLARE(void) ap_getparents(char *name)
1728 AP_FN_ATTR_NONNULL_ALL;
1731 * Escape a path segment, as defined in RFC 1808
1732 * @param p The pool to allocate from
1733 * @param s The path to convert
1734 * @return The converted URL
1735 * @deprecated Replaced by apr_pescape_path_segment() in APR
1737 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s)
1738 AP_FN_ATTR_NONNULL_ALL;
1741 * Escape a path segment, as defined in RFC 1808, to a preallocated buffer.
1742 * @param c The preallocated buffer to write to
1743 * @param s The path to convert
1744 * @return The converted URL (c)
1745 * @deprecated Replaced by apr_escape_path_segment() in APR
1747 AP_DECLARE(char *) ap_escape_path_segment_buffer(char *c, const char *s)
1748 AP_FN_ATTR_NONNULL_ALL;
1751 * convert an OS path to a URL in an OS dependent way.
1752 * @param p The pool to allocate from
1753 * @param path The path to convert
1754 * @param partial if set, assume that the path will be appended to something
1755 * with a '/' in it (and thus does not prefix "./").
1756 * @return The converted URL, with one byte of extra space after the NUL
1757 * to allow the caller to add a trailing '/'.
1758 * @deprecated Replaced by apr_pescape_path() in APR
1760 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial)
1761 AP_FN_ATTR_NONNULL_ALL;
1763 /** @see ap_os_escape_path */
1764 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1767 * Escape a string as application/x-www-form-urlencoded
1768 * @param p The pool to allocate from
1769 * @param s The path to convert
1770 * @return The converted URL
1771 * @deprecated Replaced by apr_pescape_url() in APR
1773 AP_DECLARE(char *) ap_escape_urlencoded(apr_pool_t *p, const char *s)
1774 AP_FN_ATTR_NONNULL_ALL;
1777 * Escape a string as application/x-www-form-urlencoded, to a preallocated buffer
1778 * @param c The preallocated buffer to write to
1779 * @param s The path to convert
1780 * @return The converted URL (c)
1781 * @deprecated Replaced by apr_escape_url() in APR
1783 AP_DECLARE(char *) ap_escape_urlencoded_buffer(char *c, const char *s)
1784 AP_FN_ATTR_NONNULL_ALL;
1787 * Escape an html string
1788 * @param p The pool to allocate from
1789 * @param s The html to escape
1790 * @return The escaped string
1791 * @deprecated Replaced by apr_pescape_entity() in APR
1793 #define ap_escape_html(p,s) ap_escape_html2(p,s,0)
1795 * Escape an html string
1796 * @param p The pool to allocate from
1797 * @param s The html to escape
1798 * @param toasc Whether to escape all non-ASCII chars to \&\#nnn;
1799 * @return The escaped string
1800 * @deprecated Replaced by apr_pescape_entity() in APR
1802 AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc)
1803 AP_FN_ATTR_NONNULL_ALL;
1806 * Escape a string for logging
1807 * @param p The pool to allocate from
1808 * @param str The string to escape
1809 * @return The escaped string
1810 * @deprecated Replaced by apr_pescape_echo() in APR
1812 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str)
1813 AP_FN_ATTR_NONNULL((1));
1816 * Escape a string for logging into the error log (without a pool)
1817 * @param dest The buffer to write to
1818 * @param source The string to escape
1819 * @param buflen The buffer size for the escaped string (including "\0")
1820 * @return The len of the escaped string (always < maxlen)
1821 * @deprecated Replaced by apr_escape_echo() in APR
1823 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1825 AP_FN_ATTR_NONNULL((1));
1828 * Construct a full hostname
1829 * @param p The pool to allocate from
1830 * @param hostname The hostname of the server
1831 * @param port The port the server is running on
1832 * @param r The current request
1833 * @return The server's hostname
1835 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1836 apr_port_t port, const request_rec *r)
1837 AP_FN_ATTR_NONNULL((1,4));
1840 * Escape a shell command
1841 * @param p The pool to allocate from
1842 * @param s The command to escape
1843 * @return The escaped shell command
1844 * @deprecated Replaced with apr_escape_shell() in APR
1846 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s)
1847 AP_FN_ATTR_NONNULL_ALL;
1850 * Count the number of directories in a path
1851 * @param path The path to count
1852 * @return The number of directories
1854 AP_DECLARE(int) ap_count_dirs(const char *path)
1855 AP_FN_ATTR_NONNULL_ALL;
1858 * Copy at most @a n leading directories of @a s into @a d. @a d
1859 * should be at least as large as @a s plus 1 extra byte
1861 * @param d The location to copy to
1862 * @param s The location to copy from
1863 * @param n The number of directories to copy
1864 * @return value is the ever useful pointer to the trailing "\0" of d
1865 * @note on platforms with drive letters, n = 0 returns the "/" root,
1866 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1867 * returns the empty string. */
1868 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n)
1869 AP_FN_ATTR_NONNULL_ALL;
1872 * Return the parent directory name (including trailing /) of the file
1874 * @param p The pool to allocate from
1875 * @param s The file to get the parent of
1876 * @return A copy of the file's parent directory
1878 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s)
1879 AP_FN_ATTR_NONNULL_ALL;
1882 * Given a directory and filename, create a single path from them. This
1883 * function is smart enough to ensure that there is a single '/' between the
1884 * directory and file names
1885 * @param a The pool to allocate from
1886 * @param dir The directory name
1887 * @param f The filename
1888 * @return A copy of the full path, with one byte of extra space after the NUL
1889 * to allow the caller to add a trailing '/'.
1890 * @note Never consider using this function if you are dealing with filesystem
1891 * names that need to remain canonical, unless you are merging an apr_dir_read
1892 * path and returned filename. Otherwise, the result is not canonical.
1894 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f)
1895 AP_FN_ATTR_NONNULL_ALL;
1898 * Test if the given path has an absolute path.
1899 * @param p The pool to allocate from
1900 * @param dir The directory name
1901 * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1902 * multiple forms of absolute paths. This only reports if the path is absolute
1903 * in a canonical sense.
1905 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir)
1906 AP_FN_ATTR_NONNULL_ALL;
1909 * Does the provided string contain wildcard characters? This is useful
1910 * for determining if the string should be passed to strcmp_match or to strcmp.
1911 * The only wildcard characters recognized are '?' and '*'
1912 * @param str The string to check
1913 * @return 1 if the string has wildcards, 0 otherwise
1915 AP_DECLARE(int) ap_is_matchexp(const char *str)
1916 AP_FN_ATTR_NONNULL_ALL;
1919 * Determine if a string matches a pattern containing the wildcards '?' or '*'
1920 * @param str The string to check
1921 * @param expected The pattern to match against
1922 * @return 0 if the two strings match, 1 otherwise
1924 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected)
1925 AP_FN_ATTR_NONNULL_ALL;
1928 * Determine if a string matches a pattern containing the wildcards '?' or '*',
1930 * @param str The string to check
1931 * @param expected The pattern to match against
1932 * @return 0 if the two strings match, 1 otherwise
1934 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected)
1935 AP_FN_ATTR_NONNULL_ALL;
1938 * Find the first occurrence of the substring s2 in s1, regardless of case
1939 * @param s1 The string to search
1940 * @param s2 The substring to search for
1941 * @return A pointer to the beginning of the substring
1942 * @remark See apr_strmatch() for a faster alternative
1944 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2)
1945 AP_FN_ATTR_NONNULL_ALL;
1948 * Return a pointer to the location inside of bigstring immediately after prefix
1949 * @param bigstring The input string
1950 * @param prefix The prefix to strip away
1951 * @return A pointer relative to bigstring after prefix
1953 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1955 AP_FN_ATTR_NONNULL_ALL;
1958 * Decode a base64 encoded string into memory allocated from a pool
1959 * @param p The pool to allocate from
1960 * @param bufcoded The encoded string
1961 * @return The decoded string
1962 * @deprecated Replaced by apr_pbase64_decode() in APR.
1964 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1967 * Encode a string into memory allocated from a pool in base 64 format
1968 * @param p The pool to allocate from
1969 * @param string The plaintext string
1970 * @return The encoded string
1971 * @deprecated Replaced by apr_pbase64_encode() in APR.
1973 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1976 * Compile a regular expression to be used later. The regex is freed when
1977 * the pool is destroyed.
1978 * @param p The pool to allocate from
1979 * @param pattern the regular expression to compile
1980 * @param cflags The bitwise or of one or more of the following:
1981 * @li REG_EXTENDED - Use POSIX extended Regular Expressions
1982 * @li REG_ICASE - Ignore case
1983 * @li REG_NOSUB - Support for substring addressing of matches
1985 * @li REG_NEWLINE - Match-any-character operators don't match new-line
1986 * @return The compiled regular expression
1988 AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1992 * Free the memory associated with a compiled regular expression
1993 * @param p The pool the regex was allocated from
1994 * @param reg The regular expression to free
1995 * @note This function is only necessary if the regex should be cleaned
1996 * up before the pool
1998 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
2001 * After performing a successful regex match, you may use this function to
2002 * perform a series of string substitutions based on subexpressions that were
2003 * matched during the call to ap_regexec. This function is limited to
2004 * result strings of 64K. Consider using ap_pregsub_ex() instead.
2005 * @param p The pool to allocate from
2006 * @param input An arbitrary string containing $1 through $9. These are
2007 * replaced with the corresponding matched sub-expressions
2008 * @param source The string that was originally matched to the regex
2009 * @param nmatch the nmatch returned from ap_pregex
2010 * @param pmatch the pmatch array returned from ap_pregex
2011 * @return The substituted string, or NULL on error
2013 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input,
2014 const char *source, apr_size_t nmatch,
2015 ap_regmatch_t pmatch[]);
2018 * After performing a successful regex match, you may use this function to
2019 * perform a series of string substitutions based on subexpressions that were
2020 * matched during the call to ap_regexec
2021 * @param p The pool to allocate from
2022 * @param result where to store the result, will be set to NULL on error
2023 * @param input An arbitrary string containing $1 through $9. These are
2024 * replaced with the corresponding matched sub-expressions
2025 * @param source The string that was originally matched to the regex
2026 * @param nmatch the nmatch returned from ap_pregex
2027 * @param pmatch the pmatch array returned from ap_pregex
2028 * @param maxlen the maximum string length to return, 0 for unlimited
2029 * @return APR_SUCCESS if successful, APR_ENOMEM or other error code otherwise.
2031 AP_DECLARE(apr_status_t) ap_pregsub_ex(apr_pool_t *p, char **result,
2032 const char *input, const char *source,
2034 ap_regmatch_t pmatch[],
2038 * We want to downcase the type/subtype for comparison purposes
2039 * but nothing else because ;parameter=foo values are case sensitive.
2040 * @param s The content-type to convert to lowercase
2042 AP_DECLARE(void) ap_content_type_tolower(char *s);
2045 * convert a string to all lowercase
2046 * @param s The string to convert to lowercase
2048 AP_DECLARE(void) ap_str_tolower(char *s);
2051 * convert a string to all uppercase
2052 * @param s The string to convert to uppercase
2054 AP_DECLARE(void) ap_str_toupper(char *s);
2057 * Search a string from left to right for the first occurrence of a
2058 * specific character
2059 * @param str The string to search
2060 * @param c The character to search for
2061 * @return The index of the first occurrence of c in str
2063 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
2066 * Search a string from right to left for the first occurrence of a
2067 * specific character
2068 * @param str The string to search
2069 * @param c The character to search for
2070 * @return The index of the first occurrence of c in str
2072 AP_DECLARE(int) ap_rind(const char *str, char c);
2075 * Given a string, replace any bare " with \\" .
2076 * @param p The pool to allocate memory from
2077 * @param instring The string to search for "
2078 * @return A copy of the string with escaped quotes
2079 * @deprecated Replaced by apr_pescape_echo() in APR
2081 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
2084 * Given a string, append the PID deliminated by delim.
2085 * Usually used to create a pid-appended filepath name
2086 * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
2087 * a macro, to avoid unistd.h dependency
2088 * @param p The pool to allocate memory from
2089 * @param string The string to append the PID to
2090 * @param delim The string to use to deliminate the string from the PID
2091 * @return A copy of the string with the PID appended
2093 AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
2097 * Parse a given timeout parameter string into an apr_interval_time_t value.
2098 * The unit of the time interval is given as postfix string to the numeric
2099 * string. Currently the following units are understood:
2106 * If no unit is contained in the given timeout parameter the default_time_unit
2107 * will be used instead.
2108 * @param timeout_parameter The string containing the timeout parameter.
2109 * @param timeout The timeout value to be returned.
2110 * @param default_time_unit The default time unit to use if none is specified
2111 * in timeout_parameter.
2112 * @return Status value indicating whether the parsing was successful or not.
2114 AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
2115 const char *timeout_parameter,
2116 apr_interval_time_t *timeout,
2117 const char *default_time_unit);
2120 * Determine if a request has a request body or not.
2122 * @param r the request_rec of the request
2123 * @return truth value
2125 AP_DECLARE(int) ap_request_has_body(request_rec *r);
2128 * Cleanup a string (mainly to be filesystem safe)
2129 * We only allow '_' and alphanumeric chars. Non-printable
2130 * map to 'x' and all others map to '_'
2132 * @param p pool to use to allocate dest
2133 * @param src string to clean up
2134 * @param dest cleaned up, allocated string
2135 * @return Status value indicating whether the cleaning was successful or not.
2137 AP_DECLARE(apr_status_t) ap_pstr2_alnum(apr_pool_t *p, const char *src,
2141 * Cleanup a string (mainly to be filesystem safe)
2142 * We only allow '_' and alphanumeric chars. Non-printable
2143 * map to 'x' and all others map to '_'
2145 * @param src string to clean up
2146 * @param dest cleaned up, pre-allocated string
2147 * @return Status value indicating whether the cleaning was successful or not.
2149 AP_DECLARE(apr_status_t) ap_str2_alnum(const char *src, char *dest);
2152 * Structure to store the contents of an HTTP form of the type
2153 * application/x-www-form-urlencoded.
2155 * Currently it contains the name as a char* of maximum length
2156 * HUGE_STRING_LEN, and a value in the form of a bucket brigade
2157 * of arbitrary length.
2161 apr_bucket_brigade *value;
2165 * Read the body and parse any form found, which must be of the
2166 * type application/x-www-form-urlencoded.
2167 * @param r request containing POSTed form data
2169 * @param ptr returned array of ap_form_pair_t
2170 * @param num max num of params or -1 for unlimited
2171 * @param size max size allowed for parsed data
2172 * @return OK or HTTP error
2174 AP_DECLARE(int) ap_parse_form_data(request_rec *r, struct ap_filter_t *f,
2175 apr_array_header_t **ptr,
2176 apr_size_t num, apr_size_t size);
2178 /* Misc system hackery */
2180 * Given the name of an object in the file system determine if it is a directory
2181 * @param p The pool to allocate from
2182 * @param name The name of the object to check
2183 * @return 1 if it is a directory, 0 otherwise
2185 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
2188 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
2189 * @param p The pool to allocate from
2190 * @param name The name of the object to check
2191 * @return 1 if it is a directory, 0 otherwise
2193 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
2196 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
2197 #endif /* _OSD_POSIX */
2200 * Determine the local host name for the current machine
2201 * @param p The pool to allocate from
2202 * @return A copy of the local host name
2204 char *ap_get_local_host(apr_pool_t *p);
2207 * Log an assertion to the error log
2208 * @param szExp The assertion that failed
2209 * @param szFile The file the assertion is in
2210 * @param nLine The line the assertion is defined on
2212 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
2213 __attribute__((noreturn));
2216 * @internal Internal Assert function
2218 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
2221 * Redefine assert() to something more useful for an Apache...
2223 * Use ap_assert() if the condition should always be checked.
2224 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
2228 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
2230 #define AP_DEBUG_ASSERT(exp) ((void)0)
2234 * @defgroup stopsignal Flags which indicate places where the server should stop for debugging.
2236 * A set of flags which indicate places where the server should raise(SIGSTOP).
2237 * This is useful for debugging, because you can then attach to that process
2238 * with gdb and continue. This is important in cases where one_process
2239 * debugging isn't possible.
2241 /** stop on a Detach */
2242 #define SIGSTOP_DETACH 1
2243 /** stop making a child process */
2244 #define SIGSTOP_MAKE_CHILD 2
2245 /** stop spawning a child process */
2246 #define SIGSTOP_SPAWN_CHILD 4
2247 /** stop spawning a child process with a piped log */
2248 #define SIGSTOP_PIPED_LOG_SPAWN 8
2249 /** stop spawning a CGI child process */
2250 #define SIGSTOP_CGI_CHILD 16
2252 /** Macro to get GDB started */
2253 #ifdef DEBUG_SIGSTOP
2254 extern int raise_sigstop_flags;
2255 #define RAISE_SIGSTOP(x) do { \
2256 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
2259 #define RAISE_SIGSTOP(x)
2263 * Get HTML describing the address and (optionally) admin of the server.
2264 * @param prefix Text which is prepended to the return value
2265 * @param r The request_rec
2266 * @return HTML describing the server, allocated in @a r's pool.
2268 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
2270 /* The C library has functions that allow const to be silently dropped ...
2271 these macros detect the drop in maintainer mode, but use the native
2272 methods for normal builds
2274 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
2275 to be included before the macros are defined or compilation will fail.
2279 AP_DECLARE(char *) ap_strchr(char *s, int c);
2280 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
2281 AP_DECLARE(char *) ap_strrchr(char *s, int c);
2282 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
2283 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
2284 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
2285 AP_DECLARE(void *) ap_palloc_debug(apr_pool_t *p, apr_size_t size);
2286 AP_DECLARE(void *) ap_pcalloc_debug(apr_pool_t *p, apr_size_t size);
2291 # define strchr(s, c) ap_strchr(s,c)
2293 # define strrchr(s, c) ap_strrchr(s,c)
2295 # define strstr(s, c) ap_strstr(s,c)
2297 #if !defined(AP_DEBUG_NO_ALLOC_POISON) && !APR_POOL_DEBUG
2299 * ap_palloc_debug initializes allocated memory to non-zero
2301 #define apr_palloc ap_palloc_debug
2303 * this is necessary to avoid useless double memset of memory
2304 * with ap_palloc_debug
2309 #define apr_pcalloc ap_pcalloc_debug
2314 /** use this instead of strchr */
2315 # define ap_strchr(s, c) strchr(s, c)
2316 /** use this instead of strchr */
2317 # define ap_strchr_c(s, c) strchr(s, c)
2318 /** use this instead of strrchr */
2319 # define ap_strrchr(s, c) strrchr(s, c)
2320 /** use this instead of strrchr */
2321 # define ap_strrchr_c(s, c) strrchr(s, c)
2322 /** use this instead of strrstr*/
2323 # define ap_strstr(s, c) strstr(s, c)
2324 /** use this instead of strrstr*/
2325 # define ap_strstr_c(s, c) strstr(s, c)
2330 * Generate pseudo random bytes.
2331 * This is a convenience interface to apr_random. It is cheaper but less
2332 * secure than apr_generate_random_bytes().
2333 * @param buf where to store the bytes
2334 * @param size number of bytes to generate
2335 * @note ap_random_insecure_bytes() is thread-safe, it uses a mutex on
2338 AP_DECLARE(void) ap_random_insecure_bytes(void *buf, apr_size_t size);
2341 * Get a pseudo random number in a range.
2342 * @param min low end of range
2343 * @param max high end of range
2344 * @return a number in the range
2346 AP_DECLARE(apr_uint32_t) ap_random_pick(apr_uint32_t min, apr_uint32_t max);
2349 * Abort with a error message signifying out of memory
2351 AP_DECLARE(void) ap_abort_on_oom(void) __attribute__((noreturn));
2354 * Wrapper for malloc() that calls ap_abort_on_oom() if out of memory
2355 * @param size size of the memory block
2356 * @return pointer to the allocated memory
2357 * @note ap_malloc may be implemented as a macro
2359 AP_DECLARE(void *) ap_malloc(size_t size)
2360 __attribute__((malloc))
2361 AP_FN_ATTR_ALLOC_SIZE(1);
2364 * Wrapper for calloc() that calls ap_abort_on_oom() if out of memory
2365 * @param nelem number of elements to allocate memory for
2366 * @param size size of a single element
2367 * @return pointer to the allocated memory
2368 * @note ap_calloc may be implemented as a macro
2370 AP_DECLARE(void *) ap_calloc(size_t nelem, size_t size)
2371 __attribute__((malloc))
2372 AP_FN_ATTR_ALLOC_SIZE2(1,2);
2375 * Wrapper for realloc() that calls ap_abort_on_oom() if out of memory
2376 * @param ptr pointer to the old memory block (or NULL)
2377 * @param size new size of the memory block
2378 * @return pointer to the reallocated memory
2379 * @note ap_realloc may be implemented as a macro
2381 AP_DECLARE(void *) ap_realloc(void *ptr, size_t size)
2382 AP_FN_ATTR_WARN_UNUSED_RESULT
2383 AP_FN_ATTR_ALLOC_SIZE(2);
2386 * Get server load params
2387 * @param ld struct to populate: -1 in fields means error
2389 AP_DECLARE(void) ap_get_sload(ap_sload_t *ld)
2390 AP_FN_ATTR_NONNULL_ALL;
2393 * Get server load averages (ala getloadavg)
2394 * @param ld struct to populate: -1 in fields means error
2396 AP_DECLARE(void) ap_get_loadavg(ap_loadavg_t *ld)
2397 AP_FN_ATTR_NONNULL_ALL;
2400 * Convert binary data into a hex string
2401 * @param src pointer to the data
2402 * @param srclen length of the data
2403 * @param dest pointer to buffer of length (2 * srclen + 1). The resulting
2404 * string will be NUL-terminated.
2405 * @deprecated Replaced by apr_escape_hex() in APR
2407 AP_DECLARE(void) ap_bin2hex(const void *src, apr_size_t srclen, char *dest)
2408 AP_FN_ATTR_NONNULL_ALL;
2411 * Check if string contains a control character
2412 * @param str the string to check
2413 * @return 1 if yes, 0 if no control characters
2415 AP_DECLARE(int) ap_has_cntrl(const char *str)
2416 AP_FN_ATTR_NONNULL_ALL;
2419 * Wrapper for @a apr_password_validate() to cache expensive calculations
2420 * @param r the current request
2421 * @param username username of the user
2422 * @param passwd password string
2423 * @param hash hash string to be passwd to @a apr_password_validate()
2424 * @return APR_SUCCESS if passwords match, APR_EMISMATCH or error otherwise
2425 * @note Currently, ap_password_validate() only caches the result of the
2426 * most recent call with the same connection as @a r.
2427 * In the future, it may also do rate-limiting against brute-force
2430 AP_DECLARE(apr_status_t) ap_password_validate(request_rec *r,
2431 const char *username,
2436 * Short function to execute a command and return the first line of
2437 * output minus \\r \\n. Useful for "obscuring" passwords via exec calls
2438 * @param p the pool to allocate from
2439 * @param cmd the command to execute
2440 * @param argv the arguments to pass to the cmd
2441 * @return ptr to characters or NULL on any error
2443 AP_DECLARE(char *) ap_get_exec_line(apr_pool_t *p,
2445 const char * const *argv);
2448 #define AP_NORESTART APR_OS_START_USEERR + 1
2451 * Get the first index of the string in the array or -1 if not found. Start
2452 * searching a start.
2453 * @param array The array the check
2454 * @param s The string to find
2455 * @param start Start index for search. If start is out of bounds (negative or
2456 equal to array length or greater), -1 will be returned.
2457 * @return index of string in array or -1
2459 AP_DECLARE(int) ap_array_str_index(const apr_array_header_t *array,
2464 * Check if the string is member of the given array by strcmp.
2465 * @param array The array the check
2466 * @param s The string to find
2467 * @return !=0 iff string is member of array (via strcmp)
2469 AP_DECLARE(int) ap_array_str_contains(const apr_array_header_t *array,
2473 * Perform a case-insensitive comparison of two strings @a atr1 and @a atr2,
2474 * treating upper and lower case values of the 26 standard C/POSIX alphabetic
2475 * characters as equivalent. Extended latin characters outside of this set
2476 * are treated as unique octets, irrespective of the current locale.
2478 * Returns in integer greater than, equal to, or less than 0,
2479 * according to whether @a str1 is considered greater than, equal to,
2480 * or less than @a str2.
2482 * @note Same code as apr_cstr_casecmp, which arrives in APR 1.6
2484 AP_DECLARE(int) ap_cstr_casecmp(const char *s1, const char *s2);
2487 * Perform a case-insensitive comparison of two strings @a atr1 and @a atr2,
2488 * treating upper and lower case values of the 26 standard C/POSIX alphabetic
2489 * characters as equivalent. Extended latin characters outside of this set
2490 * are treated as unique octets, irrespective of the current locale.
2492 * Returns in integer greater than, equal to, or less than 0,
2493 * according to whether @a str1 is considered greater than, equal to,
2494 * or less than @a str2.
2496 * @note Same code as apr_cstr_casecmpn, which arrives in APR 1.6
2498 AP_DECLARE(int) ap_cstr_casecmpn(const char *s1, const char *s2, apr_size_t n);
2504 #endif /* !APACHE_HTTPD_H */
2506 /** @} //APACHE Daemon */
2507 /** @} //APACHE Core */
2508 /** @} //APACHE super group */