1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * @brief HTTP Daemon routines
21 * @defgroup APACHE Apache HTTP Server
23 * Top level group of which all other groups are a member
26 * @defgroup APACHE_MODS Loadable modules
27 * Top level group for modules
28 * @defgroup APACHE_OS Operating System Specific
29 * @defgroup APACHE_INTERNAL Internal interfaces
30 * @defgroup APACHE_CORE Core routines
32 * @defgroup APACHE_CORE_DAEMON HTTP Daemon Routine
36 #ifndef APACHE_HTTPD_H
37 #define APACHE_HTTPD_H
39 /* XXX - We need to push more stuff to other .h files, or even .c files, to
40 * make this file smaller
43 /* Headers in which EVERYONE has an interest... */
44 #include "ap_config.h"
47 #include "ap_release.h"
50 #include "apr_general.h"
51 #include "apr_tables.h"
52 #include "apr_pools.h"
54 #include "apr_network_io.h"
55 #include "apr_buckets.h"
57 #include "apr_thread_proc.h"
67 /* Note: apr_uri.h is also included, see below */
73 /* ----------------------------- config dir ------------------------------ */
75 /** Define this to be the default server home dir. Most things later in this
76 * file with a relative pathname will have this added.
80 /** Set default for OS/2 file system */
81 #define HTTPD_ROOT "/os2httpd"
83 /** Set default for Windows file system */
84 #define HTTPD_ROOT "/apache"
85 #elif defined (NETWARE)
86 /** Set the default for NetWare */
87 #define HTTPD_ROOT "/apache"
89 /** Set for all other OSs */
90 #define HTTPD_ROOT "/usr/local/apache"
92 #endif /* HTTPD_ROOT */
95 * --------- You shouldn't have to edit anything below this line ----------
97 * Any modifications to any defaults not defined above should be done in the
98 * respective configuration file.
103 * Default location of documents. Can be overridden by the DocumentRoot
106 #ifndef DOCUMENT_LOCATION
108 /* Set default for OS/2 file system */
109 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
111 /* Set default for non OS/2 file system */
112 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
114 #endif /* DOCUMENT_LOCATION */
116 /** Maximum number of dynamically loaded modules */
117 #ifndef DYNAMIC_MODULE_LIMIT
118 #define DYNAMIC_MODULE_LIMIT 256
121 /** Default administrator's address */
122 #define DEFAULT_ADMIN "[no address given]"
124 /** The name of the log files */
125 #ifndef DEFAULT_ERRORLOG
126 #if defined(OS2) || defined(WIN32)
127 #define DEFAULT_ERRORLOG "logs/error.log"
129 #define DEFAULT_ERRORLOG "logs/error_log"
131 #endif /* DEFAULT_ERRORLOG */
133 /** Define this to be what your per-directory security files are called */
134 #ifndef DEFAULT_ACCESS_FNAME
136 /* Set default for OS/2 file system */
137 #define DEFAULT_ACCESS_FNAME "htaccess"
139 #define DEFAULT_ACCESS_FNAME ".htaccess"
141 #endif /* DEFAULT_ACCESS_FNAME */
143 /** The name of the server config file */
144 #ifndef SERVER_CONFIG_FILE
145 #define SERVER_CONFIG_FILE "conf/httpd.conf"
148 /** The default path for CGI scripts if none is currently set */
150 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
153 /** The path to the suExec wrapper, can be overridden in Configuration */
155 #define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
158 /** The timeout for waiting for messages */
159 #ifndef DEFAULT_TIMEOUT
160 #define DEFAULT_TIMEOUT 60
163 /** The timeout for waiting for keepalive timeout until next request */
164 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
165 #define DEFAULT_KEEPALIVE_TIMEOUT 5
168 /** The number of requests to entertain per connection */
169 #ifndef DEFAULT_KEEPALIVE
170 #define DEFAULT_KEEPALIVE 100
174 * Limits on the size of various request items. These limits primarily
175 * exist to prevent simple denial-of-service attacks on a server based
176 * on misuse of the protocol. The recommended values will depend on the
177 * nature of the server resources -- CGI scripts and database backends
178 * might require large values, but most servers could get by with much
179 * smaller limits than we use below. The request message body size can
180 * be limited by the per-dir config directive LimitRequestBody.
182 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
183 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
184 * These two limits can be lowered or raised by the server config
185 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
187 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
188 * the server config directive LimitRequestFields.
191 /** default limit on bytes in Request-Line (Method+URI+HTTP-version) */
192 #ifndef DEFAULT_LIMIT_REQUEST_LINE
193 #define DEFAULT_LIMIT_REQUEST_LINE 8190
195 /** default limit on bytes in any one header field */
196 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
197 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
199 /** default limit on number of request header fields */
200 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
201 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
205 * The default default character set name to add if AddDefaultCharset is
206 * enabled. Overridden with AddDefaultCharsetName.
208 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
210 /** default HTTP Server protocol */
211 #define AP_SERVER_PROTOCOL "HTTP/1.1"
214 /* ------------------ stuff that modules are allowed to look at ----------- */
216 /** Define this to be what your HTML directory content files are called */
217 #ifndef AP_DEFAULT_INDEX
218 #define AP_DEFAULT_INDEX "index.html"
221 /** The name of the MIME types file */
222 #ifndef AP_TYPES_CONFIG_FILE
223 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
227 * Define the HTML doctype strings centrally.
229 /** HTML 2.0 Doctype */
230 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
231 "DTD HTML 2.0//EN\">\n"
232 /** HTML 3.2 Doctype */
233 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
234 "DTD HTML 3.2 Final//EN\">\n"
235 /** HTML 4.0 Strict Doctype */
236 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
237 "DTD HTML 4.0//EN\"\n" \
238 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
239 /** HTML 4.0 Transitional Doctype */
240 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
241 "DTD HTML 4.0 Transitional//EN\"\n" \
242 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
243 /** HTML 4.0 Frameset Doctype */
244 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
245 "DTD HTML 4.0 Frameset//EN\"\n" \
246 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
247 /** XHTML 1.0 Strict Doctype */
248 #define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
249 "DTD XHTML 1.0 Strict//EN\"\n" \
250 "\"http://www.w3.org/TR/xhtml1/DTD/" \
251 "xhtml1-strict.dtd\">\n"
252 /** XHTML 1.0 Transitional Doctype */
253 #define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
254 "DTD XHTML 1.0 Transitional//EN\"\n" \
255 "\"http://www.w3.org/TR/xhtml1/DTD/" \
256 "xhtml1-transitional.dtd\">\n"
257 /** XHTML 1.0 Frameset Doctype */
258 #define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
259 "DTD XHTML 1.0 Frameset//EN\"\n" \
260 "\"http://www.w3.org/TR/xhtml1/DTD/" \
261 "xhtml1-frameset.dtd\">"
263 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
264 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
265 /** Major part of HTTP protocol */
266 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
267 /** Minor part of HTTP protocol */
268 #define HTTP_VERSION_MINOR(number) ((number)%1000)
270 /* -------------- Port number for server running standalone --------------- */
272 /** default HTTP Port */
273 #define DEFAULT_HTTP_PORT 80
274 /** default HTTPS Port */
275 #define DEFAULT_HTTPS_PORT 443
277 * Check whether @a port is the default port for the request @a r.
278 * @param port The port number
279 * @param r The request
280 * @see #ap_default_port
282 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
284 * Get the default port for a request (which depends on the scheme).
285 * @param r The request
287 #define ap_default_port(r) ap_run_default_port(r)
289 * Get the scheme for a request.
290 * @param r The request
292 #define ap_http_scheme(r) ap_run_http_scheme(r)
294 /** The default string length */
295 #define MAX_STRING_LEN HUGE_STRING_LEN
297 /** The length of a Huge string */
298 #define HUGE_STRING_LEN 8192
300 /** The size of the server's internal read-write buffers */
301 #define AP_IOBUFSIZE 8192
303 /** The max number of regex captures that can be expanded by ap_pregsub */
304 #define AP_MAX_REG_MATCH 10
307 * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
308 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
309 * than that in case the brigade code/filters attempt to read it directly.
310 * ### 16mb is an invention, no idea if it is reasonable.
312 #define AP_MAX_SENDFILE 16777216 /* 2^24 */
315 * MPM child process exit status values
316 * The MPM parent process may check the status to see if special
317 * error handling is required.
320 #define APEXIT_OK 0x0
321 /** A fatal error arising during the server's init sequence */
322 #define APEXIT_INIT 0x2
323 /** The child died during its init sequence */
324 #define APEXIT_CHILDINIT 0x3
326 * The child exited due to a resource shortage.
327 * The parent should limit the rate of forking until
328 * the situation is resolved.
330 #define APEXIT_CHILDSICK 0x7
332 * A fatal error, resulting in the whole server aborting.
333 * If a child exits with this error, the parent process
334 * considers this a server-wide fatal error and aborts.
336 #define APEXIT_CHILDFATAL 0xf
340 * Stuff marked #AP_DECLARE is part of the API, and intended for use
341 * by modules. Its purpose is to allow us to add attributes that
342 * particular platforms or compilers require to every exported function.
344 # define AP_DECLARE(type) type
347 #ifndef AP_DECLARE_NONSTD
349 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
350 * use by modules. The difference between #AP_DECLARE and
351 * #AP_DECLARE_NONSTD is that the latter is required for any functions
352 * which use varargs or are used via indirect function call. This
353 * is to accomodate the two calling conventions in windows dlls.
355 # define AP_DECLARE_NONSTD(type) type
357 #ifndef AP_DECLARE_DATA
358 # define AP_DECLARE_DATA
361 #ifndef AP_MODULE_DECLARE
362 # define AP_MODULE_DECLARE(type) type
364 #ifndef AP_MODULE_DECLARE_NONSTD
365 # define AP_MODULE_DECLARE_NONSTD(type) type
367 #ifndef AP_MODULE_DECLARE_DATA
368 # define AP_MODULE_DECLARE_DATA
373 * modules should not use functions marked AP_CORE_DECLARE
375 #ifndef AP_CORE_DECLARE
376 # define AP_CORE_DECLARE AP_DECLARE
381 * modules should not use functions marked AP_CORE_DECLARE_NONSTD
384 #ifndef AP_CORE_DECLARE_NONSTD
385 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
389 * @defgroup APACHE_APR_STATUS_T HTTPD specific values of apr_status_t
392 #define AP_START_USERERR (APR_OS_START_USERERR + 2000)
393 #define AP_USERERR_LEN 1000
395 /** The function declines to handle the request */
396 #define AP_DECLINED (AP_START_USERERR + 0)
401 * @brief The numeric version information is broken out into fields within this
405 int major; /**< major number */
406 int minor; /**< minor number */
407 int patch; /**< patch number */
408 const char *add_string; /**< additional string like "-dev" */
412 * Return httpd's version information in a numeric form.
414 * @param version Pointer to a version structure for returning the version
417 AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
420 * Get the server banner in a form suitable for sending over the
421 * network, with the level of information controlled by the
422 * ServerTokens directive.
423 * @return The server banner
425 AP_DECLARE(const char *) ap_get_server_banner(void);
428 * Get the server description in a form suitable for local displays,
429 * status reports, or logging. This includes the detailed server
430 * version and information about some modules. It is not affected
431 * by the ServerTokens directive.
432 * @return The server description
434 AP_DECLARE(const char *) ap_get_server_description(void);
437 * Add a component to the server description and banner strings
438 * @param pconf The pool to allocate the component from
439 * @param component The string to add
441 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
444 * Get the date a time that the server was built
445 * @return The server build time string
447 AP_DECLARE(const char *) ap_get_server_built(void);
449 /* non-HTTP status codes returned by hooks */
451 #define OK 0 /**< Module has handled this stage. */
452 #define DECLINED -1 /**< Module declines to handle */
453 #define DONE -2 /**< Module has served the response completely
454 * - it's safe to die() with no more output
456 #define SUSPENDED -3 /**< Module will handle the remainder of the request.
457 * The core will never invoke the request again, */
459 /** Returned by the bottom-most filter if no data was written.
460 * @see ap_pass_brigade(). */
461 #define AP_NOBODY_WROTE -100
462 /** Returned by the bottom-most filter if no data was read.
463 * @see ap_get_brigade(). */
464 #define AP_NOBODY_READ -101
465 /** Returned by any filter if the filter chain encounters an error
466 * and has already dealt with the error response.
468 #define AP_FILTER_ERROR -102
471 * @defgroup HTTP_Status HTTP Status Codes
475 * The size of the static status_lines array in http_protocol.c for
476 * storing all of the potential response status-lines (a sparse table).
477 * When adding a new code here add it to status_lines as well.
478 * A future version should dynamically generate the apr_table_t at startup.
480 #define RESPONSE_CODES 83
482 #define HTTP_CONTINUE 100
483 #define HTTP_SWITCHING_PROTOCOLS 101
484 #define HTTP_PROCESSING 102
486 #define HTTP_CREATED 201
487 #define HTTP_ACCEPTED 202
488 #define HTTP_NON_AUTHORITATIVE 203
489 #define HTTP_NO_CONTENT 204
490 #define HTTP_RESET_CONTENT 205
491 #define HTTP_PARTIAL_CONTENT 206
492 #define HTTP_MULTI_STATUS 207
493 #define HTTP_ALREADY_REPORTED 208
494 #define HTTP_IM_USED 226
495 #define HTTP_MULTIPLE_CHOICES 300
496 #define HTTP_MOVED_PERMANENTLY 301
497 #define HTTP_MOVED_TEMPORARILY 302
498 #define HTTP_SEE_OTHER 303
499 #define HTTP_NOT_MODIFIED 304
500 #define HTTP_USE_PROXY 305
501 #define HTTP_TEMPORARY_REDIRECT 307
502 #define HTTP_PERMANENT_REDIRECT 308
503 #define HTTP_BAD_REQUEST 400
504 #define HTTP_UNAUTHORIZED 401
505 #define HTTP_PAYMENT_REQUIRED 402
506 #define HTTP_FORBIDDEN 403
507 #define HTTP_NOT_FOUND 404
508 #define HTTP_METHOD_NOT_ALLOWED 405
509 #define HTTP_NOT_ACCEPTABLE 406
510 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
511 #define HTTP_REQUEST_TIME_OUT 408
512 #define HTTP_CONFLICT 409
513 #define HTTP_GONE 410
514 #define HTTP_LENGTH_REQUIRED 411
515 #define HTTP_PRECONDITION_FAILED 412
516 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
517 #define HTTP_REQUEST_URI_TOO_LARGE 414
518 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
519 #define HTTP_RANGE_NOT_SATISFIABLE 416
520 #define HTTP_EXPECTATION_FAILED 417
521 #define HTTP_UNPROCESSABLE_ENTITY 422
522 #define HTTP_LOCKED 423
523 #define HTTP_FAILED_DEPENDENCY 424
524 #define HTTP_UPGRADE_REQUIRED 426
525 #define HTTP_PRECONDITION_REQUIRED 428
526 #define HTTP_TOO_MANY_REQUESTS 429
527 #define HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE 431
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_LOOP_DETECTED 508
537 #define HTTP_NOT_EXTENDED 510
538 #define HTTP_NETWORK_AUTHENTICATION_REQUIRED 511
540 /** is the status code informational */
541 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
542 /** is the status code OK ?*/
543 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
544 /** is the status code a redirect */
545 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
546 /** is the status code a error (client or server) */
547 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
548 /** is the status code a client error */
549 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
550 /** is the status code a server error */
551 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
552 /** is the status code a (potentially) valid response code? */
553 #define ap_is_HTTP_VALID_RESPONSE(x) (((x) >= 100)&&((x) < 600))
555 /** should the status code drop the connection */
556 #define ap_status_drops_connection(x) \
557 (((x) == HTTP_BAD_REQUEST) || \
558 ((x) == HTTP_REQUEST_TIME_OUT) || \
559 ((x) == HTTP_LENGTH_REQUIRED) || \
560 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
561 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
562 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
563 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
564 ((x) == HTTP_NOT_IMPLEMENTED))
568 * @defgroup Methods List of Methods recognized by the server
569 * @ingroup APACHE_CORE_DAEMON
572 * @brief Methods recognized (but not necessarily handled) by the server.
574 * These constants are used in bit shifting masks of size int, so it is
575 * unsafe to have more methods than bits in an int. HEAD == M_GET.
576 * This list must be tracked by the list in http_protocol.c in routine
577 * ap_method_name_of().
581 #define M_GET 0 /** RFC 2616: HTTP */
582 #define M_PUT 1 /* : */
587 #define M_TRACE 6 /** RFC 2616: HTTP */
588 #define M_PATCH 7 /** no rfc(!) ### remove this one? */
589 #define M_PROPFIND 8 /** RFC 2518: WebDAV */
590 #define M_PROPPATCH 9 /* : */
595 #define M_UNLOCK 14 /** RFC 2518: WebDAV */
596 #define M_VERSION_CONTROL 15 /** RFC 3253: WebDAV Versioning */
597 #define M_CHECKOUT 16 /* : */
598 #define M_UNCHECKOUT 17
603 #define M_MKWORKSPACE 22
604 #define M_MKACTIVITY 23
605 #define M_BASELINE_CONTROL 24
607 #define M_INVALID 26 /** no valid method */
610 * METHODS needs to be equal to the number of bits
611 * we are using for limit masks.
616 * The method mask bit to shift for anding with a bitmask.
618 #define AP_METHOD_BIT ((apr_int64_t)1)
622 /** @see ap_method_list_t */
623 typedef struct ap_method_list_t ap_method_list_t;
626 * @struct ap_method_list_t
627 * @brief Structure for handling HTTP methods.
629 * Methods known to the server are accessed via a bitmask shortcut;
630 * extension methods are handled by an array.
632 struct ap_method_list_t {
633 /** The bitmask used for known methods */
634 apr_int64_t method_mask;
635 /** the array used for extension methods */
636 apr_array_header_t *method_list;
640 * @defgroup module_magic Module Magic mime types
643 /** Magic for mod_cgi[d] */
644 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
645 /** Magic for mod_include */
646 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
647 /** Magic for mod_include */
648 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
649 /** Magic for mod_dir */
650 #define DIR_MAGIC_TYPE "httpd/unix-directory"
651 /** Default for r->handler if no content-type set by type_checker */
652 #define AP_DEFAULT_HANDLER_NAME ""
653 #define AP_IS_DEFAULT_HANDLER_NAME(x) (*x == '\0')
656 /* Just in case your linefeed isn't the one the other end is expecting. */
657 #if !APR_CHARSET_EBCDIC
660 /** carrige return */
662 /** carrige return /Line Feed Combo */
663 #define CRLF "\015\012"
664 #else /* APR_CHARSET_EBCDIC */
665 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
666 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
667 * "native EBCDIC" CR and NL characters. These are therefore
674 #endif /* APR_CHARSET_EBCDIC */
675 /** Useful for common code with either platform charset. */
676 #define CRLF_ASCII "\015\012"
679 * @defgroup values_request_rec_body Possible values for request_rec.read_body
681 * Possible values for request_rec.read_body (set by handling module):
684 /** Send 413 error if message has any body */
685 #define REQUEST_NO_BODY 0
686 /** Send 411 error if body without Content-Length */
687 #define REQUEST_CHUNKED_ERROR 1
688 /** If chunked, remove the chunks for me. */
689 #define REQUEST_CHUNKED_DECHUNK 2
690 /** @} // values_request_rec_body */
693 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
694 * @ingroup APACHE_CORE_DAEMON
696 * Possible values for request_rec.used_path_info:
699 /** Accept the path_info from the request */
700 #define AP_REQ_ACCEPT_PATH_INFO 0
701 /** Return a 404 error if path_info was given */
702 #define AP_REQ_REJECT_PATH_INFO 1
703 /** Module may chose to use the given path_info */
704 #define AP_REQ_DEFAULT_PATH_INFO 2
706 /** @} // values_request_rec_used_path_info */
710 * Things which may vary per file-lookup WITHIN a request ---
711 * e.g., state of MIME config. Basically, the name of an object, info
712 * about the object, and any other info we may ahve which may need to
713 * change as we go poking around looking for it (e.g., overridden by
716 * Note how the default state of almost all these things is properly
717 * zero, so that allocating it with pcalloc does the right thing without
718 * a whole lot of hairy initialization... so long as we are willing to
719 * make the (fairly) portable assumption that the bit pattern of a NULL
720 * pointer is, in fact, zero.
724 * @brief This represents the result of calling htaccess; these are cached for
727 struct htaccess_result {
728 /** the directory to which this applies */
730 /** the overrides allowed for the .htaccess file */
732 /** the override options allowed for the .htaccess file */
734 /** Table of allowed directives for override */
735 apr_table_t *override_list;
736 /** the configuration directives */
737 struct ap_conf_vector_t *htaccess;
738 /** the next one, or NULL if no more; N.B. never change this */
739 const struct htaccess_result *next;
742 /* The following four types define a hierarchy of activities, so that
743 * given a request_rec r you can write r->connection->server->process
744 * to get to the process_rec. While this reduces substantially the
745 * number of arguments that various hooks require beware that in
746 * threaded versions of the server you must consider multiplexing
750 /** A structure that represents one process */
751 typedef struct process_rec process_rec;
752 /** A structure that represents a virtual server */
753 typedef struct server_rec server_rec;
754 /** A structure that represents one connection */
755 typedef struct conn_rec conn_rec;
756 /** A structure that represents one slave connection */
757 typedef struct conn_slave_rec conn_slave_rec;
758 /** A structure that represents the current request */
759 typedef struct request_rec request_rec;
760 /** A structure that represents the status of the current connection */
761 typedef struct conn_state_t conn_state_t;
763 /* ### would be nice to not include this from httpd.h ... */
764 /* This comes after we have defined the request_rec type */
768 * @brief A structure that represents one process
771 /** Global pool. Cleared upon normal exit */
773 /** Configuration pool. Cleared upon restart */
775 /** The program name used to execute the program */
776 const char *short_name;
777 /** The command line arguments */
778 const char * const *argv;
779 /** Number of command line arguments passed to the program */
784 * @brief A structure that represents the current request
787 /** The pool associated with the request */
789 /** The connection to the client */
790 conn_rec *connection;
791 /** The virtual host for this request */
794 /** Pointer to the redirected request if this is an external redirect */
796 /** Pointer to the previous request if this is an internal redirect */
799 /** Pointer to the main request if this is a sub-request
800 * (see http_request.h) */
803 /* Info about the request itself... we begin with stuff that only
804 * protocol.c should ever touch...
806 /** First line of request */
808 /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
810 /** A proxy request (calculated during post_read_request/translate_name)
811 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
815 /** HEAD request, as opposed to GET */
817 /** Protocol version number of protocol; 1.1 = 1001 */
819 /** Protocol string, as given to us, or HTTP/0.9 */
821 /** Host, as set by full URI or Host: header.
822 * For literal IPv6 addresses, this does NOT include the surrounding [ ]
824 const char *hostname;
826 /** Time when the request started */
827 apr_time_t request_time;
829 /** Status line, if set by script */
830 const char *status_line;
834 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
835 * look, but don't touch.
838 /** M_GET, M_POST, etc. */
840 /** Request method (eg. GET, HEAD, POST, etc.) */
844 * 'allowed' is a bitvector of the allowed methods.
846 * A handler must ensure that the request method is one that
847 * it is capable of handling. Generally modules should DECLINE
848 * any request methods they do not handle. Prior to aborting the
849 * handler like this the handler should set r->allowed to the list
850 * of methods that it is willing to handle. This bitvector is used
851 * to construct the "Allow:" header required for OPTIONS requests,
852 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
854 * Since the default_handler deals with OPTIONS, all modules can
855 * usually decline to deal with OPTIONS. TRACE is always allowed,
856 * modules don't need to set it explicitly.
858 * Since the default_handler will always handle a GET, a
859 * module which does *not* implement GET should probably return
860 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
861 * handler can't be installed by mod_actions.
864 /** Array of extension methods */
865 apr_array_header_t *allowed_xmethods;
866 /** List of allowed methods */
867 ap_method_list_t *allowed_methods;
869 /** byte count in stream is for body */
870 apr_off_t sent_bodyct;
871 /** body byte count, for easy access */
872 apr_off_t bytes_sent;
873 /** Last modified time of the requested resource */
876 /* HTTP/1.1 connection-level features */
878 /** The Range: header */
880 /** The "real" content length */
882 /** sending chunked transfer-coding */
885 /** Method for reading the request body
886 * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
887 * REQUEST_CHUNKED_DECHUNK, etc...) */
889 /** reading chunked transfer-coding */
891 /** is client waiting for a 100 response? */
892 unsigned expecting_100;
893 /** The optional kept body of the request. */
894 apr_bucket_brigade *kept_body;
895 /** For ap_body_to_table(): parsed body */
896 /* XXX: ap_body_to_table has been removed. Remove body_table too or
897 * XXX: keep it to reintroduce ap_body_to_table without major bump? */
898 apr_table_t *body_table;
899 /** Remaining bytes left to read from the request body */
901 /** Number of bytes that have been read from the request body */
902 apr_off_t read_length;
904 /* MIME header environments, in and out. Also, an array containing
905 * environment variables to be passed to subprocesses, so people can
906 * write modules to add to that environment.
908 * The difference between headers_out and err_headers_out is that the
909 * latter are printed even on error, and persist across internal redirects
910 * (so the headers printed for ErrorDocument handlers will have them).
912 * The 'notes' apr_table_t is for notes from one module to another, with no
913 * other set purpose in mind...
916 /** MIME header environment from the request */
917 apr_table_t *headers_in;
918 /** MIME header environment for the response */
919 apr_table_t *headers_out;
920 /** MIME header environment for the response, printed even on errors and
921 * persist across internal redirects */
922 apr_table_t *err_headers_out;
923 /** Array of environment variables to be used for sub processes */
924 apr_table_t *subprocess_env;
925 /** Notes from one module to another */
928 /* content_type, handler, content_encoding, and all content_languages
929 * MUST be lowercased strings. They may be pointers to static strings;
930 * they should not be modified in place.
932 /** The content-type for the current request */
933 const char *content_type; /* Break these out --- we dispatch on 'em */
934 /** The handler string that we use to call a handler function */
935 const char *handler; /* What we *really* dispatch on */
937 /** How to encode the data */
938 const char *content_encoding;
939 /** Array of strings representing the content languages */
940 apr_array_header_t *content_languages;
942 /** variant list validator (if negotiated) */
943 char *vlist_validator;
945 /** If an authentication check was made, this gets set to the user name. */
947 /** If an authentication check was made, this gets set to the auth type. */
950 /* What object is being requested (either directly, or via include
951 * or content-negotiation mapping).
954 /** The URI without any parsing performed */
956 /** The path portion of the URI, or "/" if no path provided */
958 /** The filename on disk corresponding to this response */
960 /* XXX: What does this mean? Please define "canonicalize" -aaron */
961 /** The true filename, we canonicalize r->filename if these don't match */
962 char *canonical_filename;
963 /** The PATH_INFO extracted from this request */
965 /** The QUERY_ARGS extracted from this request */
969 * Flag for the handler to accept or reject path_info on
970 * the current request. All modules should respect the
971 * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
972 * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
973 * may follow existing conventions. This is set to the
974 * user's preference upon HOOK_VERY_FIRST of the fixups.
978 /** A flag to determine if the eos bucket has been sent yet */
981 /* Various other config info which may change with .htaccess files
982 * These are config vectors, with one void* pointer for each module
983 * (the thing pointed to being the module's business).
986 /** Options set in config files, etc. */
987 struct ap_conf_vector_t *per_dir_config;
988 /** Notes on *this* request */
989 struct ap_conf_vector_t *request_config;
991 /** Optional request log level configuration. Will usually point
992 * to a server or per_dir config, i.e. must be copied before
994 const struct ap_logconf *log;
996 /** Id to identify request in access and error log. Set when the first
997 * error log entry for this request is generated.
1002 * A linked list of the .htaccess configuration directives
1003 * accessed by this request.
1004 * N.B. always add to the head of the list, _never_ to the end.
1005 * that way, a sub request's list can (temporarily) point to a parent's list
1007 const struct htaccess_result *htaccess;
1009 /** A list of output filters to be used for this request */
1010 struct ap_filter_t *output_filters;
1011 /** A list of input filters to be used for this request */
1012 struct ap_filter_t *input_filters;
1014 /** A list of protocol level output filters to be used for this
1016 struct ap_filter_t *proto_output_filters;
1017 /** A list of protocol level input filters to be used for this
1019 struct ap_filter_t *proto_input_filters;
1021 /** This response can not be cached */
1023 /** There is no local copy of this response */
1026 /** Mutex protect callbacks registered with ap_mpm_register_timed_callback
1027 * from being run before the original handler finishes running
1029 apr_thread_mutex_t *invoke_mtx;
1031 /** A struct containing the components of URI */
1032 apr_uri_t parsed_uri;
1033 /** finfo.protection (st_mode) set to zero if no such file */
1036 /** remote address information from conn_rec, can be overridden if
1037 * necessary by a module.
1038 * This is the address that originated the request.
1040 apr_sockaddr_t *useragent_addr;
1045 * @defgroup ProxyReq Proxy request types
1047 * Possible values of request_rec->proxyreq. A request could be normal,
1048 * proxied or reverse proxied. Normally proxied and reverse proxied are
1049 * grouped together as just "proxied", but sometimes it's necessary to
1050 * tell the difference between the two, such as for authentication.
1054 #define PROXYREQ_NONE 0 /**< No proxy */
1055 #define PROXYREQ_PROXY 1 /**< Standard proxy */
1056 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
1057 #define PROXYREQ_RESPONSE 3 /**< Origin response */
1062 * @brief Enumeration of connection keepalive options
1068 } ap_conn_keepalive_e;
1071 * @brief Structure to store things which are per connection
1074 /** Pool associated with this connection */
1076 /** Physical vhost this conn came in on */
1077 server_rec *base_server;
1078 /** used by http_vhost.c */
1079 void *vhost_lookup_data;
1081 /* Information about the connection itself */
1082 /** local address */
1083 apr_sockaddr_t *local_addr;
1084 /** remote address; this is the end-point of the next hop, for the address
1085 * of the request creator, see useragent_addr in request_rec
1087 apr_sockaddr_t *client_addr;
1089 /** Client's IP address; this is the end-point of the next hop, for the
1090 * IP of the request creator, see useragent_ip in request_rec
1093 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
1094 * "" if it has and no address was found. N.B. Only access this though
1095 * get_remote_host() */
1097 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
1098 * get_remote_logname() */
1099 char *remote_logname;
1101 /** server IP address */
1103 /** used for ap_get_server_name when UseCanonicalName is set to DNS
1104 * (ignores setting of HostnameLookups) */
1107 /** ID of this connection; unique at any point in time */
1109 /** Config vector containing pointers to connections per-server
1110 * config structures. */
1111 struct ap_conf_vector_t *conn_config;
1112 /** Notes on *this* connection: send note from one module to
1113 * another. must remain valid for all requests on this conn */
1115 /** A list of input filters to be used for this connection */
1116 struct ap_filter_t *input_filters;
1117 /** A list of output filters to be used for this connection */
1118 struct ap_filter_t *output_filters;
1119 /** handle to scoreboard information for this connection */
1121 /** The bucket allocator to use for all bucket/brigade creations */
1122 struct apr_bucket_alloc_t *bucket_alloc;
1123 /** The current state of this connection; may be NULL if not used by MPM */
1125 /** Is there data pending in the input filters? */
1126 int data_in_input_filters;
1127 /** Is there data pending in the output filters? */
1128 int data_in_output_filters;
1130 /** Are there any filters that clogg/buffer the input stream, breaking
1133 unsigned int clogging_input_filters:1;
1135 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1137 signed int double_reverse:2;
1139 /** Are we still talking? */
1142 /** Are we going to keep the connection alive for another request?
1143 * @see ap_conn_keepalive_e */
1144 ap_conn_keepalive_e keepalive;
1146 /** How many times have we used it? */
1149 /** Optional connection log level configuration. May point to a server or
1150 * per_dir config, i.e. must be copied before modifying */
1151 const struct ap_logconf *log;
1153 /** Id to identify this connection in error log. Set when the first
1154 * error log entry for this connection is generated.
1159 /** This points to the current thread being used to process this request,
1160 * over the lifetime of a request, the value may change. Users of the connection
1161 * record should not rely upon it staying the same between calls that involve
1165 apr_thread_t *current_thread;
1168 /** Array of slave connections (conn_slave_rec *) for this connection. */
1169 apr_array_header_t *slaves;
1171 /** The "real" master connection. NULL if I am the master. */
1174 /** context of this connection */
1178 struct conn_slave_rec {
1183 * Enumeration of connection states
1184 * The two states CONN_STATE_LINGER_NORMAL and CONN_STATE_LINGER_SHORT may
1185 * only be set by the MPM. Use CONN_STATE_LINGER outside of the MPM.
1188 CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1189 CONN_STATE_READ_REQUEST_LINE,
1191 CONN_STATE_WRITE_COMPLETION,
1192 CONN_STATE_SUSPENDED,
1193 CONN_STATE_LINGER, /* connection may be closed with lingering */
1194 CONN_STATE_LINGER_NORMAL, /* MPM has started lingering close with normal timeout */
1195 CONN_STATE_LINGER_SHORT /* MPM has started lingering close with short timeout */
1200 CONN_SENSE_WANT_READ, /* next event must be read */
1201 CONN_SENSE_WANT_WRITE /* next event must be write */
1205 * @brief A structure to contain connection state information
1207 struct conn_state_t {
1208 /** Current state of the connection */
1210 /** Whether to read instead of write, or write instead of read */
1214 /* Per-vhost config... */
1217 * The address 255.255.255.255, when used as a virtualhost address,
1218 * will become the "default" server when the ip doesn't match other vhosts.
1220 #define DEFAULT_VHOST_ADDR 0xfffffffful
1224 * @struct server_addr_rec
1225 * @brief A structure to be used for Per-vhost config
1227 typedef struct server_addr_rec server_addr_rec;
1228 struct server_addr_rec {
1229 /** The next server in the list */
1230 server_addr_rec *next;
1231 /** The name given in "<VirtualHost>" */
1233 /** The bound address, for this server */
1234 apr_sockaddr_t *host_addr;
1235 /** The bound port, for this server */
1236 apr_port_t host_port;
1240 /** The per-module log levels */
1241 signed char *module_levels;
1243 /** The log level for this server */
1247 * @brief A structure to store information for each virtual server
1250 /** The process this server is running in */
1251 process_rec *process;
1252 /** The next server in the list */
1255 /* Log files --- note that transfer log is now in the modules... */
1257 /** The name of the error log */
1259 /** A file descriptor that references the error log */
1260 apr_file_t *error_log;
1261 /** The log level configuration */
1262 struct ap_logconf log;
1263 /** External error log writer provider */
1264 struct ap_errorlog_provider *errorlog_provider;
1265 /** Handle to be passed to external log provider's logging method */
1266 void *errorlog_provider_handle;
1268 /* Module-specific configuration for server, and defaults... */
1270 /** Config vector containing pointers to modules' per-server config
1272 struct ap_conf_vector_t *module_config;
1273 /** MIME type info, etc., before we start checking per-directory info */
1274 struct ap_conf_vector_t *lookup_defaults;
1276 /** The name of the server */
1277 const char *defn_name;
1278 /** The line of the config file that the server was defined on */
1279 unsigned defn_line_number;
1280 /** true if this is the virtual server */
1284 /* Information for redirects */
1286 /** for redirects, etc. */
1288 /** The server request scheme for redirect responses */
1289 const char *server_scheme;
1291 /* Contact information */
1293 /** The admin's contact information */
1295 /** The server hostname */
1296 char *server_hostname;
1298 /* Transaction handling */
1300 /** I haven't got a clue */
1301 server_addr_rec *addrs;
1302 /** Timeout, as an apr interval, before we give up */
1303 apr_interval_time_t timeout;
1304 /** The apr interval we will wait for another request */
1305 apr_interval_time_t keep_alive_timeout;
1306 /** Maximum requests per connection */
1308 /** Use persistent connections? */
1311 /** Normal names for ServerAlias servers */
1312 apr_array_header_t *names;
1313 /** Wildcarded names for ServerAlias servers */
1314 apr_array_header_t *wild_names;
1316 /** Pathname for ServerPath */
1318 /** Length of path */
1321 /** limit on size of the HTTP request line */
1323 /** limit on size of any request header field */
1324 int limit_req_fieldsize;
1325 /** limit on number of request header fields */
1326 int limit_req_fields;
1329 /** Opaque storage location */
1334 * @struct ap_sload_t
1335 * @brief A structure to hold server load params
1337 typedef struct ap_sload_t ap_sload_t;
1339 /* percentage of process/threads ready/idle (0->100)*/
1341 /* percentage of process/threads busy (0->100) */
1343 /* total bytes served */
1344 apr_off_t bytes_served;
1345 /* total access count */
1346 unsigned long access_count;
1350 * @struct ap_loadavg_t
1351 * @brief A structure to hold various server loadavg
1353 typedef struct ap_loadavg_t ap_loadavg_t;
1354 struct ap_loadavg_t {
1355 /* current loadavg, ala getloadavg() */
1359 /* 15 min loadavg */
1364 * Get the context_document_root for a request. This is a generalization of
1365 * the document root, which is too limited in the presence of mappers like
1366 * mod_userdir and mod_alias. The context_document_root is the directory
1367 * on disk that maps to the context_prefix URI prefix.
1368 * @param r The request
1369 * @note For resources that do not map to the file system or for very complex
1370 * mappings, this information may still be wrong.
1372 AP_DECLARE(const char *) ap_context_document_root(request_rec *r);
1375 * Get the context_prefix for a request. The context_prefix URI prefix
1376 * maps to the context_document_root on disk.
1377 * @param r The request
1379 AP_DECLARE(const char *) ap_context_prefix(request_rec *r);
1381 /** Set context_prefix and context_document_root for a request.
1382 * @param r The request
1383 * @param prefix the URI prefix, without trailing slash
1384 * @param document_root the corresponding directory on disk, without trailing
1386 * @note If one of prefix of document_root is NULL, the corrsponding
1387 * property will not be changed.
1389 AP_DECLARE(void) ap_set_context_info(request_rec *r, const char *prefix,
1390 const char *document_root);
1392 /** Set per-request document root. This is for mass virtual hosting modules
1393 * that want to provide the correct DOCUMENT_ROOT value to scripts.
1394 * @param r The request
1395 * @param document_root the document root for the request.
1397 AP_DECLARE(void) ap_set_document_root(request_rec *r, const char *document_root);
1400 * Examine a field value (such as a media-/content-type) string and return
1401 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1402 * @param p Pool to allocate memory from
1403 * @param intype The field to examine
1404 * @return A copy of the field minus any parameters
1406 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1409 * Convert a time from an integer into a string in a specified format
1410 * @param p The pool to allocate memory from
1411 * @param t The time to convert
1412 * @param fmt The format to use for the conversion
1413 * @param gmt Convert the time for GMT?
1414 * @return The string that represents the specified time
1416 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1418 /* String handling. The *_nc variants allow you to use non-const char **s as
1419 arguments (unfortunately C won't automatically convert a char ** to a const
1423 * Get the characters until the first occurrence of a specified character
1424 * @param p The pool to allocate memory from
1425 * @param line The string to get the characters from
1426 * @param stop The character to stop at
1427 * @return A copy of the characters up to the first stop character
1429 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1432 * Get the characters until the first occurrence of a specified character
1433 * @param p The pool to allocate memory from
1434 * @param line The string to get the characters from
1435 * @param stop The character to stop at
1436 * @return A copy of the characters up to the first stop character
1437 * @note This is the same as ap_getword(), except it doesn't use const char **.
1439 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1442 * Get the first word from a given string. A word is defined as all characters
1443 * up to the first whitespace.
1444 * @param p The pool to allocate memory from
1445 * @param line The string to traverse
1446 * @return The first word in the line
1448 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1451 * Get the first word from a given string. A word is defined as all characters
1452 * up to the first whitespace.
1453 * @param p The pool to allocate memory from
1454 * @param line The string to traverse
1455 * @return The first word in the line
1456 * @note The same as ap_getword_white(), except it doesn't use const char**
1458 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1461 * Get all characters from the first occurrence of @a stop to the first "\0"
1462 * @param p The pool to allocate memory from
1463 * @param line The line to traverse
1464 * @param stop The character to start at
1465 * @return A copy of all characters after the first occurrence of the specified
1468 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1472 * Get all characters from the first occurrence of @a stop to the first "\0"
1473 * @param p The pool to allocate memory from
1474 * @param line The line to traverse
1475 * @param stop The character to start at
1476 * @return A copy of all characters after the first occurrence of the specified
1478 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1480 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1483 * Get the second word in the string paying attention to quoting
1484 * @param p The pool to allocate from
1485 * @param line The line to traverse
1486 * @return A copy of the string
1488 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1491 * Get the second word in the string paying attention to quoting
1492 * @param p The pool to allocate from
1493 * @param line The line to traverse
1494 * @return A copy of the string
1495 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1497 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1500 * Check a string for any config define or environment variable construct
1501 * and replace each of them by the value of that variable, if it exists.
1502 * The default syntax of the constructs is ${ENV} but can be changed by
1503 * setting the define::* config defines. If the variable does not exist,
1504 * leave the ${ENV} construct alone but print a warning.
1505 * @param p The pool to allocate from
1506 * @param word The string to check
1507 * @return The string with the replaced environment variables
1509 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1512 * Size an HTTP header field list item, as separated by a comma.
1513 * @param field The field to size
1514 * @param len The length of the field
1515 * @return The return value is a pointer to the beginning of the non-empty
1516 * list item within the original string (or NULL if there is none) and the
1517 * address of field is shifted to the next non-comma, non-whitespace
1518 * character. len is the length of the item excluding any beginning whitespace.
1520 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1523 * Retrieve an HTTP header field list item, as separated by a comma,
1524 * while stripping insignificant whitespace and lowercasing anything not in
1525 * a quoted string or comment.
1526 * @param p The pool to allocate from
1527 * @param field The field to retrieve
1528 * @return The return value is a new string containing the converted list
1529 * item (or NULL if none) and the address pointed to by field is
1530 * shifted to the next non-comma, non-whitespace.
1532 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1535 * Find an item in canonical form (lowercase, no extra spaces) within
1536 * an HTTP field value list.
1537 * @param p The pool to allocate from
1538 * @param line The field value list to search
1539 * @param tok The token to search for
1540 * @return 1 if found, 0 if not found.
1542 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1545 * Do a weak ETag comparison within an HTTP field value list.
1546 * @param p The pool to allocate from
1547 * @param line The field value list to search
1548 * @param tok The token to search for
1549 * @return 1 if found, 0 if not found.
1551 AP_DECLARE(int) ap_find_etag_weak(apr_pool_t *p, const char *line, const char *tok);
1554 * Do a strong ETag comparison within an HTTP field value list.
1555 * @param p The pool to allocate from
1556 * @param line The field value list to search
1557 * @param tok The token to search for
1558 * @return 1 if found, 0 if not found.
1560 AP_DECLARE(int) ap_find_etag_strong(apr_pool_t *p, const char *line, const char *tok);
1563 * Retrieve a token, spacing over it and adjusting the pointer to
1564 * the first non-white byte afterwards. Note that these tokens
1565 * are delimited by semis and commas and can also be delimited
1566 * by whitespace at the caller's option.
1567 * @param p The pool to allocate from
1568 * @param accept_line The line to retrieve the token from (adjusted afterwards)
1569 * @param accept_white Is it delimited by whitespace
1572 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1575 * Find http tokens, see the definition of token from RFC2068
1576 * @param p The pool to allocate from
1577 * @param line The line to find the token
1578 * @param tok The token to find
1579 * @return 1 if the token is found, 0 otherwise
1581 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1584 * find http tokens from the end of the line
1585 * @param p The pool to allocate from
1586 * @param line The line to find the token
1587 * @param tok The token to find
1588 * @return 1 if the token is found, 0 otherwise
1590 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1593 * Check for an Absolute URI syntax
1594 * @param u The string to check
1595 * @return 1 if URI, 0 otherwise
1597 AP_DECLARE(int) ap_is_url(const char *u);
1601 * @param url The string to unescape
1602 * @return 0 on success, non-zero otherwise
1604 AP_DECLARE(int) ap_unescape_all(char *url);
1608 * @param url The url to unescape
1609 * @return 0 on success, non-zero otherwise
1610 * @deprecated Replaced by apr_unescape_url() in APR
1612 AP_DECLARE(int) ap_unescape_url(char *url);
1615 * Unescape a URL, but leaving %2f (slashes) escaped
1616 * @param url The url to unescape
1617 * @param decode_slashes Whether or not slashes should be decoded
1618 * @return 0 on success, non-zero otherwise
1619 * @deprecated Replaced by apr_unescape_url() in APR
1621 AP_DECLARE(int) ap_unescape_url_keep2f(char *url, int decode_slashes);
1624 * Unescape an application/x-www-form-urlencoded string
1625 * @param query The query to unescape
1626 * @return 0 on success, non-zero otherwise
1627 * @deprecated Replaced by apr_unescape_url() in APR
1629 AP_DECLARE(int) ap_unescape_urlencoded(char *query);
1632 * Convert all double slashes to single slashes
1633 * @param name The string to convert
1635 AP_DECLARE(void) ap_no2slash(char *name)
1636 AP_FN_ATTR_NONNULL_ALL;
1639 * Remove all ./ and xx/../ substrings from a file name. Also remove
1640 * any leading ../ or /../ substrings.
1641 * @param name the file name to parse
1643 AP_DECLARE(void) ap_getparents(char *name)
1644 AP_FN_ATTR_NONNULL_ALL;
1647 * Escape a path segment, as defined in RFC 1808
1648 * @param p The pool to allocate from
1649 * @param s The path to convert
1650 * @return The converted URL
1651 * @deprecated Replaced by apr_pescape_path_segment() in APR
1653 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s)
1654 AP_FN_ATTR_NONNULL_ALL;
1657 * Escape a path segment, as defined in RFC 1808, to a preallocated buffer.
1658 * @param c The preallocated buffer to write to
1659 * @param s The path to convert
1660 * @return The converted URL (c)
1661 * @deprecated Replaced by apr_escape_path_segment() in APR
1663 AP_DECLARE(char *) ap_escape_path_segment_buffer(char *c, const char *s)
1664 AP_FN_ATTR_NONNULL_ALL;
1667 * convert an OS path to a URL in an OS dependent way.
1668 * @param p The pool to allocate from
1669 * @param path The path to convert
1670 * @param partial if set, assume that the path will be appended to something
1671 * with a '/' in it (and thus does not prefix "./").
1672 * @return The converted URL, with one byte of extra space after the NUL
1673 * to allow the caller to add a trailing '/'.
1674 * @deprecated Replaced by apr_pescape_path() in APR
1676 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial)
1677 AP_FN_ATTR_NONNULL_ALL;
1679 /** @see ap_os_escape_path */
1680 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1683 * Escape a string as application/x-www-form-urlencoded
1684 * @param p The pool to allocate from
1685 * @param s The path to convert
1686 * @return The converted URL
1687 * @deprecated Replaced by apr_pescape_url() in APR
1689 AP_DECLARE(char *) ap_escape_urlencoded(apr_pool_t *p, const char *s)
1690 AP_FN_ATTR_NONNULL_ALL;
1693 * Escape a string as application/x-www-form-urlencoded, to a preallocated buffer
1694 * @param c The preallocated buffer to write to
1695 * @param s The path to convert
1696 * @return The converted URL (c)
1697 * @deprecated Replaced by apr_escape_url() in APR
1699 AP_DECLARE(char *) ap_escape_urlencoded_buffer(char *c, const char *s)
1700 AP_FN_ATTR_NONNULL_ALL;
1703 * Escape an html string
1704 * @param p The pool to allocate from
1705 * @param s The html to escape
1706 * @return The escaped string
1707 * @deprecated Replaced by apr_pescape_entity() in APR
1709 #define ap_escape_html(p,s) ap_escape_html2(p,s,0)
1711 * Escape an html string
1712 * @param p The pool to allocate from
1713 * @param s The html to escape
1714 * @param toasc Whether to escape all non-ASCII chars to \&\#nnn;
1715 * @return The escaped string
1716 * @deprecated Replaced by apr_pescape_entity() in APR
1718 AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc)
1719 AP_FN_ATTR_NONNULL_ALL;
1722 * Escape a string for logging
1723 * @param p The pool to allocate from
1724 * @param str The string to escape
1725 * @return The escaped string
1726 * @deprecated Replaced by apr_pescape_echo() in APR
1728 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str)
1729 AP_FN_ATTR_NONNULL((1));
1732 * Escape a string for logging into the error log (without a pool)
1733 * @param dest The buffer to write to
1734 * @param source The string to escape
1735 * @param buflen The buffer size for the escaped string (including "\0")
1736 * @return The len of the escaped string (always < maxlen)
1737 * @deprecated Replaced by apr_escape_echo() in APR
1739 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1741 AP_FN_ATTR_NONNULL((1));
1744 * Construct a full hostname
1745 * @param p The pool to allocate from
1746 * @param hostname The hostname of the server
1747 * @param port The port the server is running on
1748 * @param r The current request
1749 * @return The server's hostname
1751 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1752 apr_port_t port, const request_rec *r)
1753 AP_FN_ATTR_NONNULL((1,4));
1756 * Escape a shell command
1757 * @param p The pool to allocate from
1758 * @param s The command to escape
1759 * @return The escaped shell command
1760 * @deprecated Replaced with apr_escape_shell() in APR
1762 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s)
1763 AP_FN_ATTR_NONNULL_ALL;
1766 * Count the number of directories in a path
1767 * @param path The path to count
1768 * @return The number of directories
1770 AP_DECLARE(int) ap_count_dirs(const char *path)
1771 AP_FN_ATTR_NONNULL_ALL;
1774 * Copy at most @a n leading directories of @a s into @a d. @a d
1775 * should be at least as large as @a s plus 1 extra byte
1777 * @param d The location to copy to
1778 * @param s The location to copy from
1779 * @param n The number of directories to copy
1780 * @return value is the ever useful pointer to the trailing "\0" of d
1781 * @note on platforms with drive letters, n = 0 returns the "/" root,
1782 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1783 * returns the empty string. */
1784 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n)
1785 AP_FN_ATTR_NONNULL_ALL;
1788 * Return the parent directory name (including trailing /) of the file
1790 * @param p The pool to allocate from
1791 * @param s The file to get the parent of
1792 * @return A copy of the file's parent directory
1794 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s)
1795 AP_FN_ATTR_NONNULL_ALL;
1798 * Given a directory and filename, create a single path from them. This
1799 * function is smart enough to ensure that there is a single '/' between the
1800 * directory and file names
1801 * @param a The pool to allocate from
1802 * @param dir The directory name
1803 * @param f The filename
1804 * @return A copy of the full path, with one byte of extra space after the NUL
1805 * to allow the caller to add a trailing '/'.
1806 * @note Never consider using this function if you are dealing with filesystem
1807 * names that need to remain canonical, unless you are merging an apr_dir_read
1808 * path and returned filename. Otherwise, the result is not canonical.
1810 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f)
1811 AP_FN_ATTR_NONNULL_ALL;
1814 * Test if the given path has an an absolute path.
1815 * @param p The pool to allocate from
1816 * @param dir The directory name
1817 * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1818 * multiple forms of absolute paths. This only reports if the path is absolute
1819 * in a canonical sense.
1821 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir)
1822 AP_FN_ATTR_NONNULL_ALL;
1825 * Does the provided string contain wildcard characters? This is useful
1826 * for determining if the string should be passed to strcmp_match or to strcmp.
1827 * The only wildcard characters recognized are '?' and '*'
1828 * @param str The string to check
1829 * @return 1 if the string has wildcards, 0 otherwise
1831 AP_DECLARE(int) ap_is_matchexp(const char *str)
1832 AP_FN_ATTR_NONNULL_ALL;
1835 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1836 * @param str The string to check
1837 * @param expected The pattern to match against
1838 * @return 0 if the two strings match, 1 otherwise
1840 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected)
1841 AP_FN_ATTR_NONNULL_ALL;
1844 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1846 * @param str The string to check
1847 * @param expected The pattern to match against
1848 * @return 0 if the two strings match, 1 otherwise
1850 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected)
1851 AP_FN_ATTR_NONNULL_ALL;
1854 * Find the first occurrence of the substring s2 in s1, regardless of case
1855 * @param s1 The string to search
1856 * @param s2 The substring to search for
1857 * @return A pointer to the beginning of the substring
1858 * @remark See apr_strmatch() for a faster alternative
1860 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2)
1861 AP_FN_ATTR_NONNULL_ALL;
1864 * Return a pointer to the location inside of bigstring immediately after prefix
1865 * @param bigstring The input string
1866 * @param prefix The prefix to strip away
1867 * @return A pointer relative to bigstring after prefix
1869 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1871 AP_FN_ATTR_NONNULL_ALL;
1874 * Decode a base64 encoded string into memory allocated from a pool
1875 * @param p The pool to allocate from
1876 * @param bufcoded The encoded string
1877 * @return The decoded string
1878 * @deprecated Replaced by apr_pbase64_decode() in APR.
1880 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1883 * Encode a string into memory allocated from a pool in base 64 format
1884 * @param p The pool to allocate from
1885 * @param string The plaintext string
1886 * @return The encoded string
1887 * @deprecated Replaced by apr_pbase64_encode() in APR.
1889 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1892 * Compile a regular expression to be used later. The regex is freed when
1893 * the pool is destroyed.
1894 * @param p The pool to allocate from
1895 * @param pattern the regular expression to compile
1896 * @param cflags The bitwise or of one or more of the following:
1897 * @li REG_EXTENDED - Use POSIX extended Regular Expressions
1898 * @li REG_ICASE - Ignore case
1899 * @li REG_NOSUB - Support for substring addressing of matches
1901 * @li REG_NEWLINE - Match-any-character operators don't match new-line
1902 * @return The compiled regular expression
1904 AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1908 * Free the memory associated with a compiled regular expression
1909 * @param p The pool the regex was allocated from
1910 * @param reg The regular expression to free
1911 * @note This function is only necessary if the regex should be cleaned
1912 * up before the pool
1914 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
1917 * After performing a successful regex match, you may use this function to
1918 * perform a series of string substitutions based on subexpressions that were
1919 * matched during the call to ap_regexec. This function is limited to
1920 * result strings of 64K. Consider using ap_pregsub_ex() instead.
1921 * @param p The pool to allocate from
1922 * @param input An arbitrary string containing $1 through $9. These are
1923 * replaced with the corresponding matched sub-expressions
1924 * @param source The string that was originally matched to the regex
1925 * @param nmatch the nmatch returned from ap_pregex
1926 * @param pmatch the pmatch array returned from ap_pregex
1927 * @return The substituted string, or NULL on error
1929 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input,
1930 const char *source, apr_size_t nmatch,
1931 ap_regmatch_t pmatch[]);
1934 * After performing a successful regex match, you may use this function to
1935 * perform a series of string substitutions based on subexpressions that were
1936 * matched during the call to ap_regexec
1937 * @param p The pool to allocate from
1938 * @param result where to store the result, will be set to NULL on error
1939 * @param input An arbitrary string containing $1 through $9. These are
1940 * replaced with the corresponding matched sub-expressions
1941 * @param source The string that was originally matched to the regex
1942 * @param nmatch the nmatch returned from ap_pregex
1943 * @param pmatch the pmatch array returned from ap_pregex
1944 * @param maxlen the maximum string length to return, 0 for unlimited
1945 * @return APR_SUCCESS if successful, APR_ENOMEM or other error code otherwise.
1947 AP_DECLARE(apr_status_t) ap_pregsub_ex(apr_pool_t *p, char **result,
1948 const char *input, const char *source,
1950 ap_regmatch_t pmatch[],
1954 * We want to downcase the type/subtype for comparison purposes
1955 * but nothing else because ;parameter=foo values are case sensitive.
1956 * @param s The content-type to convert to lowercase
1958 AP_DECLARE(void) ap_content_type_tolower(char *s);
1961 * convert a string to all lowercase
1962 * @param s The string to convert to lowercase
1964 AP_DECLARE(void) ap_str_tolower(char *s);
1967 * convert a string to all uppercase
1968 * @param s The string to convert to uppercase
1970 AP_DECLARE(void) ap_str_toupper(char *s);
1973 * Search a string from left to right for the first occurrence of a
1974 * specific character
1975 * @param str The string to search
1976 * @param c The character to search for
1977 * @return The index of the first occurrence of c in str
1979 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1982 * Search a string from right to left for the first occurrence of a
1983 * specific character
1984 * @param str The string to search
1985 * @param c The character to search for
1986 * @return The index of the first occurrence of c in str
1988 AP_DECLARE(int) ap_rind(const char *str, char c);
1991 * Given a string, replace any bare " with \\" .
1992 * @param p The pool to allocate memory from
1993 * @param instring The string to search for "
1994 * @return A copy of the string with escaped quotes
1995 * @deprecated Replaced by apr_pescape_echo() in APR
1997 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
2000 * Given a string, append the PID deliminated by delim.
2001 * Usually used to create a pid-appended filepath name
2002 * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
2003 * a macro, to avoid unistd.h dependency
2004 * @param p The pool to allocate memory from
2005 * @param string The string to append the PID to
2006 * @param delim The string to use to deliminate the string from the PID
2007 * @return A copy of the string with the PID appended
2009 AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
2013 * Parse a given timeout parameter string into an apr_interval_time_t value.
2014 * The unit of the time interval is given as postfix string to the numeric
2015 * string. Currently the following units are understood:
2022 * If no unit is contained in the given timeout parameter the default_time_unit
2023 * will be used instead.
2024 * @param timeout_parameter The string containing the timeout parameter.
2025 * @param timeout The timeout value to be returned.
2026 * @param default_time_unit The default time unit to use if none is specified
2027 * in timeout_parameter.
2028 * @return Status value indicating whether the parsing was successful or not.
2030 AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
2031 const char *timeout_parameter,
2032 apr_interval_time_t *timeout,
2033 const char *default_time_unit);
2036 * Determine if a request has a request body or not.
2038 * @param r the request_rec of the request
2039 * @return truth value
2041 AP_DECLARE(int) ap_request_has_body(request_rec *r);
2044 * Cleanup a string (mainly to be filesystem safe)
2045 * We only allow '_' and alphanumeric chars. Non-printable
2046 * map to 'x' and all others map to '_'
2048 * @param p pool to use to allocate dest
2049 * @param src string to clean up
2050 * @param dest cleaned up, allocated string
2051 * @return Status value indicating whether the cleaning was successful or not.
2053 AP_DECLARE(apr_status_t) ap_pstr2_alnum(apr_pool_t *p, const char *src,
2057 * Cleanup a string (mainly to be filesystem safe)
2058 * We only allow '_' and alphanumeric chars. Non-printable
2059 * map to 'x' and all others map to '_'
2061 * @param src string to clean up
2062 * @param dest cleaned up, pre-allocated string
2063 * @return Status value indicating whether the cleaning was successful or not.
2065 AP_DECLARE(apr_status_t) ap_str2_alnum(const char *src, char *dest);
2068 * Structure to store the contents of an HTTP form of the type
2069 * application/x-www-form-urlencoded.
2071 * Currently it contains the name as a char* of maximum length
2072 * HUGE_STRING_LEN, and a value in the form of a bucket brigade
2073 * of arbitrary length.
2077 apr_bucket_brigade *value;
2081 * Read the body and parse any form found, which must be of the
2082 * type application/x-www-form-urlencoded.
2083 * @param r request containing POSTed form data
2085 * @param ptr returned array of ap_form_pair_t
2086 * @param num max num of params or -1 for unlimited
2087 * @param size max size allowed for parsed data
2088 * @return OK or HTTP error
2090 AP_DECLARE(int) ap_parse_form_data(request_rec *r, struct ap_filter_t *f,
2091 apr_array_header_t **ptr,
2092 apr_size_t num, apr_size_t size);
2094 /* Misc system hackery */
2096 * Given the name of an object in the file system determine if it is a directory
2097 * @param p The pool to allocate from
2098 * @param name The name of the object to check
2099 * @return 1 if it is a directory, 0 otherwise
2101 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
2104 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
2105 * @param p The pool to allocate from
2106 * @param name The name of the object to check
2107 * @return 1 if it is a directory, 0 otherwise
2109 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
2112 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
2113 #endif /* _OSD_POSIX */
2116 * Determine the local host name for the current machine
2117 * @param p The pool to allocate from
2118 * @return A copy of the local host name
2120 char *ap_get_local_host(apr_pool_t *p);
2123 * Log an assertion to the error log
2124 * @param szExp The assertion that failed
2125 * @param szFile The file the assertion is in
2126 * @param nLine The line the assertion is defined on
2128 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
2129 __attribute__((noreturn));
2132 * @internal Internal Assert function
2134 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
2137 * Redefine assert() to something more useful for an Apache...
2139 * Use ap_assert() if the condition should always be checked.
2140 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
2144 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
2146 #define AP_DEBUG_ASSERT(exp) ((void)0)
2150 * @defgroup stopsignal Flags which indicate places where the server should stop for debugging.
2152 * A set of flags which indicate places where the server should raise(SIGSTOP).
2153 * This is useful for debugging, because you can then attach to that process
2154 * with gdb and continue. This is important in cases where one_process
2155 * debugging isn't possible.
2157 /** stop on a Detach */
2158 #define SIGSTOP_DETACH 1
2159 /** stop making a child process */
2160 #define SIGSTOP_MAKE_CHILD 2
2161 /** stop spawning a child process */
2162 #define SIGSTOP_SPAWN_CHILD 4
2163 /** stop spawning a child process with a piped log */
2164 #define SIGSTOP_PIPED_LOG_SPAWN 8
2165 /** stop spawning a CGI child process */
2166 #define SIGSTOP_CGI_CHILD 16
2168 /** Macro to get GDB started */
2169 #ifdef DEBUG_SIGSTOP
2170 extern int raise_sigstop_flags;
2171 #define RAISE_SIGSTOP(x) do { \
2172 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
2175 #define RAISE_SIGSTOP(x)
2179 * Get HTML describing the address and (optionally) admin of the server.
2180 * @param prefix Text which is prepended to the return value
2181 * @param r The request_rec
2182 * @return HTML describing the server, allocated in @a r's pool.
2184 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
2186 /* The C library has functions that allow const to be silently dropped ...
2187 these macros detect the drop in maintainer mode, but use the native
2188 methods for normal builds
2190 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
2191 to be included before the macros are defined or compilation will fail.
2195 AP_DECLARE(char *) ap_strchr(char *s, int c);
2196 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
2197 AP_DECLARE(char *) ap_strrchr(char *s, int c);
2198 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
2199 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
2200 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
2201 AP_DECLARE(void *) ap_palloc_debug(apr_pool_t *p, apr_size_t size);
2202 AP_DECLARE(void *) ap_pcalloc_debug(apr_pool_t *p, apr_size_t size);
2207 # define strchr(s, c) ap_strchr(s,c)
2209 # define strrchr(s, c) ap_strrchr(s,c)
2211 # define strstr(s, c) ap_strstr(s,c)
2213 #if !defined(AP_DEBUG_NO_ALLOC_POISON) && !APR_POOL_DEBUG
2215 * ap_palloc_debug initializes allocated memory to non-zero
2217 #define apr_palloc ap_palloc_debug
2219 * this is necessary to avoid useless double memset of memory
2220 * with ap_palloc_debug
2225 #define apr_pcalloc ap_pcalloc_debug
2230 /** use this instead of strchr */
2231 # define ap_strchr(s, c) strchr(s, c)
2232 /** use this instead of strchr */
2233 # define ap_strchr_c(s, c) strchr(s, c)
2234 /** use this instead of strrchr */
2235 # define ap_strrchr(s, c) strrchr(s, c)
2236 /** use this instead of strrchr */
2237 # define ap_strrchr_c(s, c) strrchr(s, c)
2238 /** use this instead of strrstr*/
2239 # define ap_strstr(s, c) strstr(s, c)
2240 /** use this instead of strrstr*/
2241 # define ap_strstr_c(s, c) strstr(s, c)
2246 * Generate pseudo random bytes.
2247 * This is a convenience interface to apr_random. It is cheaper but less
2248 * secure than apr_generate_random_bytes().
2249 * @param buf where to store the bytes
2250 * @param size number of bytes to generate
2251 * @note ap_random_insecure_bytes() is thread-safe, it uses a mutex on
2254 AP_DECLARE(void) ap_random_insecure_bytes(void *buf, apr_size_t size);
2257 * Get a pseudo random number in a range.
2258 * @param min low end of range
2259 * @param max high end of range
2260 * @return a number in the range
2262 AP_DECLARE(apr_uint32_t) ap_random_pick(apr_uint32_t min, apr_uint32_t max);
2265 * Abort with a error message signifying out of memory
2267 AP_DECLARE(void) ap_abort_on_oom(void) __attribute__((noreturn));
2270 * Wrapper for malloc() that calls ap_abort_on_oom() if out of memory
2271 * @param size size of the memory block
2272 * @return pointer to the allocated memory
2273 * @note ap_malloc may be implemented as a macro
2275 AP_DECLARE(void *) ap_malloc(size_t size)
2276 __attribute__((malloc))
2277 AP_FN_ATTR_ALLOC_SIZE(1);
2280 * Wrapper for calloc() that calls ap_abort_on_oom() if out of memory
2281 * @param nelem number of elements to allocate memory for
2282 * @param size size of a single element
2283 * @return pointer to the allocated memory
2284 * @note ap_calloc may be implemented as a macro
2286 AP_DECLARE(void *) ap_calloc(size_t nelem, size_t size)
2287 __attribute__((malloc))
2288 AP_FN_ATTR_ALLOC_SIZE2(1,2);
2291 * Wrapper for realloc() that calls ap_abort_on_oom() if out of memory
2292 * @param ptr pointer to the old memory block (or NULL)
2293 * @param size new size of the memory block
2294 * @return pointer to the reallocated memory
2295 * @note ap_realloc may be implemented as a macro
2297 AP_DECLARE(void *) ap_realloc(void *ptr, size_t size)
2298 AP_FN_ATTR_WARN_UNUSED_RESULT
2299 AP_FN_ATTR_ALLOC_SIZE(2);
2302 * Get server load params
2303 * @param ld struct to populate: -1 in fields means error
2305 AP_DECLARE(void) ap_get_sload(ap_sload_t *ld)
2306 AP_FN_ATTR_NONNULL_ALL;
2309 * Get server load averages (ala getloadavg)
2310 * @param ld struct to populate: -1 in fields means error
2312 AP_DECLARE(void) ap_get_loadavg(ap_loadavg_t *ld)
2313 AP_FN_ATTR_NONNULL_ALL;
2316 * Convert binary data into a hex string
2317 * @param src pointer to the data
2318 * @param srclen length of the data
2319 * @param dest pointer to buffer of length (2 * srclen + 1). The resulting
2320 * string will be NUL-terminated.
2321 * @deprecated Replaced by apr_escape_hex() in APR
2323 AP_DECLARE(void) ap_bin2hex(const void *src, apr_size_t srclen, char *dest)
2324 AP_FN_ATTR_NONNULL_ALL;
2327 * Check if string contains a control character
2328 * @param str the string to check
2329 * @return 1 if yes, 0 if no control characters
2331 AP_DECLARE(int) ap_has_cntrl(const char *str)
2332 AP_FN_ATTR_NONNULL_ALL;
2335 * Wrapper for @a apr_password_validate() to cache expensive calculations
2336 * @param r the current request
2337 * @param username username of the user
2338 * @param passwd password string
2339 * @param hash hash string to be passwd to @a apr_password_validate()
2340 * @return APR_SUCCESS if passwords match, APR_EMISMATCH or error otherwise
2341 * @note Currently, ap_password_validate() only caches the result of the
2342 * most recent call with the same connection as @a r.
2343 * In the future, it may also do rate-limiting against brute-force
2346 AP_DECLARE(apr_status_t) ap_password_validate(request_rec *r,
2347 const char *username,
2352 * Short function to execute a command and return the first line of
2353 * output minus \\r \\n. Useful for "obscuring" passwords via exec calls
2354 * @param p the pool to allocate from
2355 * @param cmd the command to execute
2356 * @param argv the arguments to pass to the cmd
2357 * @return ptr to characters or NULL on any error
2359 AP_DECLARE(char *) ap_get_exec_line(apr_pool_t *p,
2361 const char * const *argv);
2364 #define AP_NORESTART APR_OS_START_USEERR + 1
2370 #endif /* !APACHE_HTTPD_H */
2372 /** @} //APACHE Daemon */
2373 /** @} //APACHE Core */
2374 /** @} //APACHE super group */