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 * multiple 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 accommodate 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 /* Additional methods must be registered by the implementor, we have only
616 * room for 64 bit-wise methods available, so do not squander them (more of
617 * the above methods should probably move here)
619 /* #define M_BREW nn */ /** RFC 2324: HTCPCP/1.0 */
620 /* #define M_WHEN nn */ /** RFC 2324: HTCPCP/1.0 */
621 #define M_INVALID 26 /** invalid method value terminates the
622 * listed ap_method_registry_init()
626 * METHODS needs to be equal to the number of bits
627 * we are using for limit masks.
632 * The method mask bit to shift for anding with a bitmask.
634 #define AP_METHOD_BIT ((apr_int64_t)1)
638 /** @see ap_method_list_t */
639 typedef struct ap_method_list_t ap_method_list_t;
642 * @struct ap_method_list_t
643 * @brief Structure for handling HTTP methods.
645 * Methods known to the server are accessed via a bitmask shortcut;
646 * extension methods are handled by an array.
648 struct ap_method_list_t {
649 /** The bitmask used for known methods */
650 apr_int64_t method_mask;
651 /** the array used for extension methods */
652 apr_array_header_t *method_list;
656 * @defgroup module_magic Module Magic mime types
659 /** Magic for mod_cgi[d] */
660 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
661 /** Magic for mod_include */
662 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
663 /** Magic for mod_include */
664 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
665 /** Magic for mod_dir */
666 #define DIR_MAGIC_TYPE "httpd/unix-directory"
667 /** Default for r->handler if no content-type set by type_checker */
668 #define AP_DEFAULT_HANDLER_NAME ""
669 #define AP_IS_DEFAULT_HANDLER_NAME(x) (*x == '\0')
672 /* Just in case your linefeed isn't the one the other end is expecting. */
673 #if !APR_CHARSET_EBCDIC
676 /** carrige return */
678 /** carrige return /Line Feed Combo */
679 #define CRLF "\015\012"
680 #else /* APR_CHARSET_EBCDIC */
681 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
682 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
683 * "native EBCDIC" CR and NL characters. These are therefore
690 #endif /* APR_CHARSET_EBCDIC */
691 /** Useful for common code with either platform charset. */
692 #define CRLF_ASCII "\015\012"
693 #define ZERO_ASCII "\060"
696 * @defgroup values_request_rec_body Possible values for request_rec.read_body
698 * Possible values for request_rec.read_body (set by handling module):
701 /** Send 413 error if message has any body */
702 #define REQUEST_NO_BODY 0
703 /** Send 411 error if body without Content-Length */
704 #define REQUEST_CHUNKED_ERROR 1
705 /** If chunked, remove the chunks for me. */
706 #define REQUEST_CHUNKED_DECHUNK 2
707 /** @} // values_request_rec_body */
710 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
711 * @ingroup APACHE_CORE_DAEMON
713 * Possible values for request_rec.used_path_info:
716 /** Accept the path_info from the request */
717 #define AP_REQ_ACCEPT_PATH_INFO 0
718 /** Return a 404 error if path_info was given */
719 #define AP_REQ_REJECT_PATH_INFO 1
720 /** Module may chose to use the given path_info */
721 #define AP_REQ_DEFAULT_PATH_INFO 2
723 /** @} // values_request_rec_used_path_info */
727 * Things which may vary per file-lookup WITHIN a request ---
728 * e.g., state of MIME config. Basically, the name of an object, info
729 * about the object, and any other info we may ahve which may need to
730 * change as we go poking around looking for it (e.g., overridden by
733 * Note how the default state of almost all these things is properly
734 * zero, so that allocating it with pcalloc does the right thing without
735 * a whole lot of hairy initialization... so long as we are willing to
736 * make the (fairly) portable assumption that the bit pattern of a NULL
737 * pointer is, in fact, zero.
741 * @brief This represents the result of calling htaccess; these are cached for
744 struct htaccess_result {
745 /** the directory to which this applies */
747 /** the overrides allowed for the .htaccess file */
749 /** the override options allowed for the .htaccess file */
751 /** Table of allowed directives for override */
752 apr_table_t *override_list;
753 /** the configuration directives */
754 struct ap_conf_vector_t *htaccess;
755 /** the next one, or NULL if no more; N.B. never change this */
756 const struct htaccess_result *next;
759 /* The following four types define a hierarchy of activities, so that
760 * given a request_rec r you can write r->connection->server->process
761 * to get to the process_rec. While this reduces substantially the
762 * number of arguments that various hooks require beware that in
763 * threaded versions of the server you must consider multiplexing
767 /** A structure that represents one process */
768 typedef struct process_rec process_rec;
769 /** A structure that represents a virtual server */
770 typedef struct server_rec server_rec;
771 /** A structure that represents one connection */
772 typedef struct conn_rec conn_rec;
773 /** A structure that represents one slave connection */
774 typedef struct conn_slave_rec conn_slave_rec;
775 /** A structure that represents the current request */
776 typedef struct request_rec request_rec;
777 /** A structure that represents the status of the current connection */
778 typedef struct conn_state_t conn_state_t;
780 /* ### would be nice to not include this from httpd.h ... */
781 /* This comes after we have defined the request_rec type */
785 * @brief A structure that represents one process
788 /** Global pool. Cleared upon normal exit */
790 /** Configuration pool. Cleared upon restart */
792 /** The program name used to execute the program */
793 const char *short_name;
794 /** The command line arguments */
795 const char * const *argv;
796 /** Number of command line arguments passed to the program */
801 * @brief A structure that represents the current request
804 /** The pool associated with the request */
806 /** The connection to the client */
807 conn_rec *connection;
808 /** The virtual host for this request */
811 /** Pointer to the redirected request if this is an external redirect */
813 /** Pointer to the previous request if this is an internal redirect */
816 /** Pointer to the main request if this is a sub-request
817 * (see http_request.h) */
820 /* Info about the request itself... we begin with stuff that only
821 * protocol.c should ever touch...
823 /** First line of request */
825 /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
827 /** A proxy request (calculated during post_read_request/translate_name)
828 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
832 /** HEAD request, as opposed to GET */
834 /** Protocol version number of protocol; 1.1 = 1001 */
836 /** Protocol string, as given to us, or HTTP/0.9 */
837 const char *protocol;
838 /** Host, as set by full URI or Host: header.
839 * For literal IPv6 addresses, this does NOT include the surrounding [ ]
841 const char *hostname;
843 /** Time when the request started */
844 apr_time_t request_time;
846 /** Status line, if set by script */
847 const char *status_line;
851 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
852 * look, but don't touch.
855 /** M_GET, M_POST, etc. */
857 /** Request method (eg. GET, HEAD, POST, etc.) */
861 * 'allowed' is a bitvector of the allowed methods.
863 * A handler must ensure that the request method is one that
864 * it is capable of handling. Generally modules should DECLINE
865 * any request methods they do not handle. Prior to aborting the
866 * handler like this the handler should set r->allowed to the list
867 * of methods that it is willing to handle. This bitvector is used
868 * to construct the "Allow:" header required for OPTIONS requests,
869 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
871 * Since the default_handler deals with OPTIONS, all modules can
872 * usually decline to deal with OPTIONS. TRACE is always allowed,
873 * modules don't need to set it explicitly.
875 * Since the default_handler will always handle a GET, a
876 * module which does *not* implement GET should probably return
877 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
878 * handler can't be installed by mod_actions.
881 /** Array of extension methods */
882 apr_array_header_t *allowed_xmethods;
883 /** List of allowed methods */
884 ap_method_list_t *allowed_methods;
886 /** byte count in stream is for body */
887 apr_off_t sent_bodyct;
888 /** body byte count, for easy access */
889 apr_off_t bytes_sent;
890 /** Last modified time of the requested resource */
893 /* HTTP/1.1 connection-level features */
895 /** The Range: header */
897 /** The "real" content length */
899 /** sending chunked transfer-coding */
902 /** Method for reading the request body
903 * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
904 * REQUEST_CHUNKED_DECHUNK, etc...) */
906 /** reading chunked transfer-coding */
908 /** is client waiting for a 100 response? */
909 unsigned expecting_100;
910 /** The optional kept body of the request. */
911 apr_bucket_brigade *kept_body;
912 /** For ap_body_to_table(): parsed body */
913 /* XXX: ap_body_to_table has been removed. Remove body_table too or
914 * XXX: keep it to reintroduce ap_body_to_table without major bump? */
915 apr_table_t *body_table;
916 /** Remaining bytes left to read from the request body */
918 /** Number of bytes that have been read from the request body */
919 apr_off_t read_length;
921 /* MIME header environments, in and out. Also, an array containing
922 * environment variables to be passed to subprocesses, so people can
923 * write modules to add to that environment.
925 * The difference between headers_out and err_headers_out is that the
926 * latter are printed even on error, and persist across internal redirects
927 * (so the headers printed for ErrorDocument handlers will have them).
929 * The 'notes' apr_table_t is for notes from one module to another, with no
930 * other set purpose in mind...
933 /** MIME header environment from the request */
934 apr_table_t *headers_in;
935 /** MIME header environment for the response */
936 apr_table_t *headers_out;
937 /** MIME header environment for the response, printed even on errors and
938 * persist across internal redirects */
939 apr_table_t *err_headers_out;
940 /** Array of environment variables to be used for sub processes */
941 apr_table_t *subprocess_env;
942 /** Notes from one module to another */
945 /* content_type, handler, content_encoding, and all content_languages
946 * MUST be lowercased strings. They may be pointers to static strings;
947 * they should not be modified in place.
949 /** The content-type for the current request */
950 const char *content_type; /* Break these out --- we dispatch on 'em */
951 /** The handler string that we use to call a handler function */
952 const char *handler; /* What we *really* dispatch on */
954 /** How to encode the data */
955 const char *content_encoding;
956 /** Array of strings representing the content languages */
957 apr_array_header_t *content_languages;
959 /** variant list validator (if negotiated) */
960 char *vlist_validator;
962 /** If an authentication check was made, this gets set to the user name. */
964 /** If an authentication check was made, this gets set to the auth type. */
967 /* What object is being requested (either directly, or via include
968 * or content-negotiation mapping).
971 /** The URI without any parsing performed */
973 /** The path portion of the URI, or "/" if no path provided */
975 /** The filename on disk corresponding to this response */
977 /** The true filename stored in the filesystem, as in the true alpha case
978 * and alias correction, e.g. "Image.jpeg" not "IMAGE$1.JPE" on Windows.
979 * The core map_to_storage canonicalizes r->filename when they mismatch */
980 char *canonical_filename;
981 /** The PATH_INFO extracted from this request */
983 /** The QUERY_ARGS extracted from this request */
987 * Flag for the handler to accept or reject path_info on
988 * the current request. All modules should respect the
989 * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
990 * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
991 * may follow existing conventions. This is set to the
992 * user's preference upon HOOK_VERY_FIRST of the fixups.
996 /** A flag to determine if the eos bucket has been sent yet */
999 /* Various other config info which may change with .htaccess files
1000 * These are config vectors, with one void* pointer for each module
1001 * (the thing pointed to being the module's business).
1004 /** Options set in config files, etc. */
1005 struct ap_conf_vector_t *per_dir_config;
1006 /** Notes on *this* request */
1007 struct ap_conf_vector_t *request_config;
1009 /** Optional request log level configuration. Will usually point
1010 * to a server or per_dir config, i.e. must be copied before
1012 const struct ap_logconf *log;
1014 /** Id to identify request in access and error log. Set when the first
1015 * error log entry for this request is generated.
1020 * A linked list of the .htaccess configuration directives
1021 * accessed by this request.
1022 * N.B. always add to the head of the list, _never_ to the end.
1023 * that way, a sub request's list can (temporarily) point to a parent's list
1025 const struct htaccess_result *htaccess;
1027 /** A list of output filters to be used for this request */
1028 struct ap_filter_t *output_filters;
1029 /** A list of input filters to be used for this request */
1030 struct ap_filter_t *input_filters;
1032 /** A list of protocol level output filters to be used for this
1034 struct ap_filter_t *proto_output_filters;
1035 /** A list of protocol level input filters to be used for this
1037 struct ap_filter_t *proto_input_filters;
1039 /** This response can not be cached */
1041 /** There is no local copy of this response */
1044 /** Mutex protect callbacks registered with ap_mpm_register_timed_callback
1045 * from being run before the original handler finishes running
1048 apr_thread_mutex_t *invoke_mtx;
1051 /** A struct containing the components of URI */
1052 apr_uri_t parsed_uri;
1053 /** finfo.protection (st_mode) set to zero if no such file */
1056 /** remote address information from conn_rec, can be overridden if
1057 * necessary by a module.
1058 * This is the address that originated the request.
1060 apr_sockaddr_t *useragent_addr;
1063 /** MIME trailer environment from the request */
1064 apr_table_t *trailers_in;
1065 /** MIME trailer environment from the response */
1066 apr_table_t *trailers_out;
1068 /** Originator's DNS name, if known. NULL if DNS hasn't been checked,
1069 * "" if it has and no address was found. N.B. Only access this though
1070 * ap_get_useragent_host() */
1071 char *useragent_host;
1072 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1074 * TODO: 2 bit signed bitfield when this structure is compacted
1080 * @defgroup ProxyReq Proxy request types
1082 * Possible values of request_rec->proxyreq. A request could be normal,
1083 * proxied or reverse proxied. Normally proxied and reverse proxied are
1084 * grouped together as just "proxied", but sometimes it's necessary to
1085 * tell the difference between the two, such as for authentication.
1089 #define PROXYREQ_NONE 0 /**< No proxy */
1090 #define PROXYREQ_PROXY 1 /**< Standard proxy */
1091 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
1092 #define PROXYREQ_RESPONSE 3 /**< Origin response */
1097 * @brief Enumeration of connection keepalive options
1103 } ap_conn_keepalive_e;
1106 * @brief Structure to store things which are per connection
1109 /** Pool associated with this connection */
1111 /** Physical vhost this conn came in on */
1112 server_rec *base_server;
1113 /** used by http_vhost.c */
1114 void *vhost_lookup_data;
1116 /* Information about the connection itself */
1117 /** local address */
1118 apr_sockaddr_t *local_addr;
1119 /** remote address; this is the end-point of the next hop, for the address
1120 * of the request creator, see useragent_addr in request_rec
1122 apr_sockaddr_t *client_addr;
1124 /** Client's IP address; this is the end-point of the next hop, for the
1125 * IP of the request creator, see useragent_ip in request_rec
1128 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
1129 * "" if it has and no address was found. N.B. Only access this though
1130 * get_remote_host() */
1132 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
1133 * get_remote_logname() */
1134 /* TODO: Remove from request_rec, make local to mod_ident */
1135 char *remote_logname;
1137 /** server IP address */
1139 /** used for ap_get_server_name when UseCanonicalName is set to DNS
1140 * (ignores setting of HostnameLookups) */
1143 /** ID of this connection; unique at any point in time */
1145 /** Config vector containing pointers to connections per-server
1146 * config structures. */
1147 struct ap_conf_vector_t *conn_config;
1148 /** Notes on *this* connection: send note from one module to
1149 * another. must remain valid for all requests on this conn */
1151 /** A list of input filters to be used for this connection */
1152 struct ap_filter_t *input_filters;
1153 /** A list of output filters to be used for this connection */
1154 struct ap_filter_t *output_filters;
1155 /** handle to scoreboard information for this connection */
1157 /** The bucket allocator to use for all bucket/brigade creations */
1158 struct apr_bucket_alloc_t *bucket_alloc;
1159 /** The current state of this connection; may be NULL if not used by MPM */
1161 /** Is there data pending in the input filters or connection? */
1162 int data_in_input_filters;
1163 /** No longer used, replaced with ap_filter_should_yield() */
1164 int data_in_output_filters;
1166 /** Are there any filters that clogg/buffer the input stream, breaking
1169 unsigned int clogging_input_filters:1;
1171 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1173 signed int double_reverse:2;
1175 /** Are we still talking? */
1178 /** Are we going to keep the connection alive for another request?
1179 * @see ap_conn_keepalive_e */
1180 ap_conn_keepalive_e keepalive;
1182 /** How many times have we used it? */
1185 /** Optional connection log level configuration. May point to a server or
1186 * per_dir config, i.e. must be copied before modifying */
1187 const struct ap_logconf *log;
1189 /** Id to identify this connection in error log. Set when the first
1190 * error log entry for this connection is generated.
1195 /** This points to the current thread being used to process this request,
1196 * over the lifetime of a request, the value may change. Users of the connection
1197 * record should not rely upon it staying the same between calls that involve
1201 apr_thread_t *current_thread;
1204 /** Array of slave connections (conn_slave_rec *) for this connection. */
1205 apr_array_header_t *slaves;
1207 /** The "real" master connection. NULL if I am the master. */
1210 /** context of this connection */
1213 /** Context under which this connection was suspended */
1214 void *suspended_baton;
1216 /** Array of requests being handled under this connection. */
1217 apr_array_header_t *requests;
1219 /** Empty bucket brigade */
1220 apr_bucket_brigade *empty;
1222 /** Hashtable of filters with setaside buckets for write completion */
1223 apr_hash_t *filters;
1225 /** The minimum level of filter type to allow setaside buckets */
1229 struct conn_slave_rec {
1234 * Enumeration of connection states
1235 * The two states CONN_STATE_LINGER_NORMAL and CONN_STATE_LINGER_SHORT may
1236 * only be set by the MPM. Use CONN_STATE_LINGER outside of the MPM.
1239 CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1240 CONN_STATE_READ_REQUEST_LINE,
1242 CONN_STATE_WRITE_COMPLETION,
1243 CONN_STATE_SUSPENDED,
1244 CONN_STATE_LINGER, /* connection may be closed with lingering */
1245 CONN_STATE_LINGER_NORMAL, /* MPM has started lingering close with normal timeout */
1246 CONN_STATE_LINGER_SHORT /* MPM has started lingering close with short timeout */
1251 CONN_SENSE_WANT_READ, /* next event must be read */
1252 CONN_SENSE_WANT_WRITE /* next event must be write */
1256 * @brief A structure to contain connection state information
1258 struct conn_state_t {
1259 /** Current state of the connection */
1261 /** Whether to read instead of write, or write instead of read */
1265 /* Per-vhost config... */
1268 * The address 255.255.255.255, when used as a virtualhost address,
1269 * will become the "default" server when the ip doesn't match other vhosts.
1271 #define DEFAULT_VHOST_ADDR 0xfffffffful
1275 * @struct server_addr_rec
1276 * @brief A structure to be used for Per-vhost config
1278 typedef struct server_addr_rec server_addr_rec;
1279 struct server_addr_rec {
1280 /** The next server in the list */
1281 server_addr_rec *next;
1282 /** The name given in "<VirtualHost>" */
1284 /** The bound address, for this server */
1285 apr_sockaddr_t *host_addr;
1286 /** The bound port, for this server */
1287 apr_port_t host_port;
1291 /** The per-module log levels */
1292 signed char *module_levels;
1294 /** The log level for this server */
1298 * @brief A structure to store information for each virtual server
1301 /** The process this server is running in */
1302 process_rec *process;
1303 /** The next server in the list */
1306 /* Log files --- note that transfer log is now in the modules... */
1308 /** The name of the error log */
1310 /** A file descriptor that references the error log */
1311 apr_file_t *error_log;
1312 /** The log level configuration */
1313 struct ap_logconf log;
1314 /** External error log writer provider */
1315 struct ap_errorlog_provider *errorlog_provider;
1316 /** Handle to be passed to external log provider's logging method */
1317 void *errorlog_provider_handle;
1319 /* Module-specific configuration for server, and defaults... */
1321 /** Config vector containing pointers to modules' per-server config
1323 struct ap_conf_vector_t *module_config;
1324 /** MIME type info, etc., before we start checking per-directory info */
1325 struct ap_conf_vector_t *lookup_defaults;
1327 /** The name of the server */
1328 const char *defn_name;
1329 /** The line of the config file that the server was defined on */
1330 unsigned defn_line_number;
1331 /** true if this is the virtual server */
1335 /* Information for redirects */
1337 /** for redirects, etc. */
1339 /** The server request scheme for redirect responses */
1340 const char *server_scheme;
1342 /* Contact information */
1344 /** The admin's contact information */
1346 /** The server hostname */
1347 char *server_hostname;
1349 /* Transaction handling */
1351 /** I haven't got a clue */
1352 server_addr_rec *addrs;
1353 /** Timeout, as an apr interval, before we give up */
1354 apr_interval_time_t timeout;
1355 /** The apr interval we will wait for another request */
1356 apr_interval_time_t keep_alive_timeout;
1357 /** Maximum requests per connection */
1359 /** Use persistent connections? */
1362 /** Normal names for ServerAlias servers */
1363 apr_array_header_t *names;
1364 /** Wildcarded names for ServerAlias servers */
1365 apr_array_header_t *wild_names;
1367 /** Pathname for ServerPath */
1369 /** Length of path */
1372 /** limit on size of the HTTP request line */
1374 /** limit on size of any request header field */
1375 int limit_req_fieldsize;
1376 /** limit on number of request header fields */
1377 int limit_req_fields;
1379 /** Opaque storage location */
1382 /** Whether the keepalive timeout is explicit (1) or
1383 * inherited (0) from the base server (either first
1384 * server on the same IP:port or main server) */
1385 unsigned int keep_alive_timeout_set:1;
1389 * @struct ap_sload_t
1390 * @brief A structure to hold server load params
1392 typedef struct ap_sload_t ap_sload_t;
1394 /* percentage of process/threads ready/idle (0->100)*/
1396 /* percentage of process/threads busy (0->100) */
1398 /* total bytes served */
1399 apr_off_t bytes_served;
1400 /* total access count */
1401 unsigned long access_count;
1405 * @struct ap_loadavg_t
1406 * @brief A structure to hold various server loadavg
1408 typedef struct ap_loadavg_t ap_loadavg_t;
1409 struct ap_loadavg_t {
1410 /* current loadavg, ala getloadavg() */
1414 /* 15 min loadavg */
1419 * Get the context_document_root for a request. This is a generalization of
1420 * the document root, which is too limited in the presence of mappers like
1421 * mod_userdir and mod_alias. The context_document_root is the directory
1422 * on disk that maps to the context_prefix URI prefix.
1423 * @param r The request
1424 * @note For resources that do not map to the file system or for very complex
1425 * mappings, this information may still be wrong.
1427 AP_DECLARE(const char *) ap_context_document_root(request_rec *r);
1430 * Get the context_prefix for a request. The context_prefix URI prefix
1431 * maps to the context_document_root on disk.
1432 * @param r The request
1434 AP_DECLARE(const char *) ap_context_prefix(request_rec *r);
1436 /** Set context_prefix and context_document_root for a request.
1437 * @param r The request
1438 * @param prefix the URI prefix, without trailing slash
1439 * @param document_root the corresponding directory on disk, without trailing
1441 * @note If one of prefix of document_root is NULL, the corrsponding
1442 * property will not be changed.
1444 AP_DECLARE(void) ap_set_context_info(request_rec *r, const char *prefix,
1445 const char *document_root);
1447 /** Set per-request document root. This is for mass virtual hosting modules
1448 * that want to provide the correct DOCUMENT_ROOT value to scripts.
1449 * @param r The request
1450 * @param document_root the document root for the request.
1452 AP_DECLARE(void) ap_set_document_root(request_rec *r, const char *document_root);
1455 * Examine a field value (such as a media-/content-type) string and return
1456 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1457 * @param p Pool to allocate memory from
1458 * @param intype The field to examine
1459 * @return A copy of the field minus any parameters
1461 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1464 * Convert a time from an integer into a string in a specified format
1465 * @param p The pool to allocate memory from
1466 * @param t The time to convert
1467 * @param fmt The format to use for the conversion
1468 * @param gmt Convert the time for GMT?
1469 * @return The string that represents the specified time
1471 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1473 /* String handling. The *_nc variants allow you to use non-const char **s as
1474 arguments (unfortunately C won't automatically convert a char ** to a const
1478 * Get the characters until the first occurrence of a specified character
1479 * @param p The pool to allocate memory from
1480 * @param line The string to get the characters from
1481 * @param stop The character to stop at
1482 * @return A copy of the characters up to the first stop character
1484 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1487 * Get the characters until the first occurrence of a specified character
1488 * @param p The pool to allocate memory from
1489 * @param line The string to get the characters from
1490 * @param stop The character to stop at
1491 * @return A copy of the characters up to the first stop character
1492 * @note This is the same as ap_getword(), except it doesn't use const char **.
1494 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1497 * Get the first word from a given string. A word is defined as all characters
1498 * up to the first whitespace.
1499 * @param p The pool to allocate memory from
1500 * @param line The string to traverse
1501 * @return The first word in the line
1503 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1506 * Get the first word from a given string. A word is defined as all characters
1507 * up to the first whitespace.
1508 * @param p The pool to allocate memory from
1509 * @param line The string to traverse
1510 * @return The first word in the line
1511 * @note The same as ap_getword_white(), except it doesn't use const char**
1513 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1516 * Get all characters from the first occurrence of @a stop to the first "\0"
1517 * @param p The pool to allocate memory from
1518 * @param line The line to traverse
1519 * @param stop The character to start at
1520 * @return A copy of all characters after the first occurrence of the specified
1523 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1527 * Get all characters from the first occurrence of @a stop to the first "\0"
1528 * @param p The pool to allocate memory from
1529 * @param line The line to traverse
1530 * @param stop The character to start at
1531 * @return A copy of all characters after the first occurrence of the specified
1533 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1535 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1538 * Get the second word in the string paying attention to quoting
1539 * @param p The pool to allocate from
1540 * @param line The line to traverse
1541 * @return A copy of the string
1543 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1546 * Get the second word in the string paying attention to quoting
1547 * @param p The pool to allocate from
1548 * @param line The line to traverse
1549 * @return A copy of the string
1550 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1552 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1555 * Get the second word in the string paying attention to quoting,
1556 * with {...} supported as well as "..." and '...'
1557 * @param p The pool to allocate from
1558 * @param line The line to traverse
1559 * @return A copy of the string
1561 AP_DECLARE(char *) ap_getword_conf2(apr_pool_t *p, const char **line);
1564 * Get the second word in the string paying attention to quoting,
1565 * with {...} supported as well as "..." and '...'
1566 * @param p The pool to allocate from
1567 * @param line The line to traverse
1568 * @return A copy of the string
1569 * @note The same as ap_getword_conf2(), except it doesn't use const char **.
1571 AP_DECLARE(char *) ap_getword_conf2_nc(apr_pool_t *p, char **line);
1574 * Check a string for any config define or environment variable construct
1575 * and replace each of them by the value of that variable, if it exists.
1576 * The default syntax of the constructs is ${ENV} but can be changed by
1577 * setting the define::* config defines. If the variable does not exist,
1578 * leave the ${ENV} construct alone but print a warning.
1579 * @param p The pool to allocate from
1580 * @param word The string to check
1581 * @return The string with the replaced environment variables
1583 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1586 * Size an HTTP header field list item, as separated by a comma.
1587 * @param field The field to size
1588 * @param len The length of the field
1589 * @return The return value is a pointer to the beginning of the non-empty
1590 * list item within the original string (or NULL if there is none) and the
1591 * address of field is shifted to the next non-comma, non-whitespace
1592 * character. len is the length of the item excluding any beginning whitespace.
1594 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1597 * Retrieve an HTTP header field list item, as separated by a comma,
1598 * while stripping insignificant whitespace and lowercasing anything not in
1599 * a quoted string or comment.
1600 * @param p The pool to allocate from
1601 * @param field The field to retrieve
1602 * @return The return value is a new string containing the converted list
1603 * item (or NULL if none) and the address pointed to by field is
1604 * shifted to the next non-comma, non-whitespace.
1606 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1609 * Find an item in canonical form (lowercase, no extra spaces) within
1610 * an HTTP field value list.
1611 * @param p The pool to allocate from
1612 * @param line The field value list to search
1613 * @param tok The token to search for
1614 * @return 1 if found, 0 if not found.
1616 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1619 * Do a weak ETag comparison within an HTTP field value list.
1620 * @param p The pool to allocate from
1621 * @param line The field value list to search
1622 * @param tok The token to search for
1623 * @return 1 if found, 0 if not found.
1625 AP_DECLARE(int) ap_find_etag_weak(apr_pool_t *p, const char *line, const char *tok);
1628 * Do a strong ETag comparison within an HTTP field value list.
1629 * @param p The pool to allocate from
1630 * @param line The field value list to search
1631 * @param tok The token to search for
1632 * @return 1 if found, 0 if not found.
1634 AP_DECLARE(int) ap_find_etag_strong(apr_pool_t *p, const char *line, const char *tok);
1636 /* Scan a string for field content chars, as defined by RFC7230 section 3.2
1637 * including VCHAR/obs-text, as well as HT and SP
1638 * @param ptr The string to scan
1639 * @return A pointer to the first (non-HT) ASCII ctrl character.
1640 * @note lws and trailing whitespace are scanned, the caller is responsible
1641 * for trimming leading and trailing whitespace
1643 AP_DECLARE(const char *) ap_scan_http_field_content(const char *ptr);
1645 /* Scan a string for token characters, as defined by RFC7230 section 3.2.6
1646 * @param ptr The string to scan
1647 * @return A pointer to the first non-token character.
1649 AP_DECLARE(const char *) ap_scan_http_token(const char *ptr);
1651 /* Scan a string for visible ASCII (0x21-0x7E) or obstext (0x80+)
1652 * and return a pointer to the first SP/CTL/NUL character encountered.
1653 * @param ptr The string to scan
1654 * @return A pointer to the first SP/CTL character.
1656 AP_DECLARE(const char *) ap_scan_vchar_obstext(const char *ptr);
1659 * Retrieve an array of tokens in the format "1#token" defined in RFC2616. Only
1660 * accepts ',' as a delimiter, does not accept quoted strings, and errors on
1662 * @param p The pool to allocate from
1663 * @param tok The line to read tokens from
1664 * @param tokens Pointer to an array of tokens. If not NULL, must be an array
1665 * of char*, otherwise it will be allocated on @a p when a token is found
1666 * @param skip_invalid If true, when an invalid separator is encountered, it
1668 * @return NULL on success, an error string otherwise.
1669 * @remark *tokens may be NULL on output if NULL in input and no token is found
1671 AP_DECLARE(const char *) ap_parse_token_list_strict(apr_pool_t *p, const char *tok,
1672 apr_array_header_t **tokens,
1676 * Retrieve a token, spacing over it and adjusting the pointer to
1677 * the first non-white byte afterwards. Note that these tokens
1678 * are delimited by semis and commas and can also be delimited
1679 * by whitespace at the caller's option.
1680 * @param p The pool to allocate from
1681 * @param accept_line The line to retrieve the token from (adjusted afterwards)
1682 * @param accept_white Is it delimited by whitespace
1685 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1688 * Find http tokens, see the definition of token from RFC2068
1689 * @param p The pool to allocate from
1690 * @param line The line to find the token
1691 * @param tok The token to find
1692 * @return 1 if the token is found, 0 otherwise
1694 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1697 * find http tokens from the end of the line
1698 * @param p The pool to allocate from
1699 * @param line The line to find the token
1700 * @param tok The token to find
1701 * @return 1 if the token is found, 0 otherwise
1703 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1706 * Check for an Absolute URI syntax
1707 * @param u The string to check
1708 * @return 1 if URI, 0 otherwise
1710 AP_DECLARE(int) ap_is_url(const char *u);
1714 * @param url The string to unescape
1715 * @return 0 on success, non-zero otherwise
1717 AP_DECLARE(int) ap_unescape_all(char *url);
1721 * @param url The url to unescape
1722 * @return 0 on success, non-zero otherwise
1723 * @deprecated Replaced by apr_unescape_url() in APR
1725 AP_DECLARE(int) ap_unescape_url(char *url);
1728 * Unescape a URL, but leaving %2f (slashes) escaped
1729 * @param url The url to unescape
1730 * @param decode_slashes Whether or not slashes should be decoded
1731 * @return 0 on success, non-zero otherwise
1732 * @deprecated Replaced by apr_unescape_url() in APR
1734 AP_DECLARE(int) ap_unescape_url_keep2f(char *url, int decode_slashes);
1737 * Unescape an application/x-www-form-urlencoded string
1738 * @param query The query to unescape
1739 * @return 0 on success, non-zero otherwise
1740 * @deprecated Replaced by apr_unescape_url() in APR
1742 AP_DECLARE(int) ap_unescape_urlencoded(char *query);
1745 * Convert all double slashes to single slashes
1746 * @param name The string to convert
1748 AP_DECLARE(void) ap_no2slash(char *name)
1749 AP_FN_ATTR_NONNULL_ALL;
1752 * Remove all ./ and xx/../ substrings from a file name. Also remove
1753 * any leading ../ or /../ substrings.
1754 * @param name the file name to parse
1756 AP_DECLARE(void) ap_getparents(char *name)
1757 AP_FN_ATTR_NONNULL_ALL;
1760 * Escape a path segment, as defined in RFC 1808
1761 * @param p The pool to allocate from
1762 * @param s The path to convert
1763 * @return The converted URL
1764 * @deprecated Replaced by apr_pescape_path_segment() in APR
1766 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s)
1767 AP_FN_ATTR_NONNULL_ALL;
1770 * Escape a path segment, as defined in RFC 1808, to a preallocated buffer.
1771 * @param c The preallocated buffer to write to
1772 * @param s The path to convert
1773 * @return The converted URL (c)
1774 * @deprecated Replaced by apr_escape_path_segment() in APR
1776 AP_DECLARE(char *) ap_escape_path_segment_buffer(char *c, const char *s)
1777 AP_FN_ATTR_NONNULL_ALL;
1780 * convert an OS path to a URL in an OS dependent way.
1781 * @param p The pool to allocate from
1782 * @param path The path to convert
1783 * @param partial if set, assume that the path will be appended to something
1784 * with a '/' in it (and thus does not prefix "./").
1785 * @return The converted URL, with one byte of extra space after the NUL
1786 * to allow the caller to add a trailing '/'.
1787 * @deprecated Replaced by apr_pescape_path() in APR
1789 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial)
1790 AP_FN_ATTR_NONNULL_ALL;
1792 /** @see ap_os_escape_path */
1793 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1796 * Escape a string as application/x-www-form-urlencoded
1797 * @param p The pool to allocate from
1798 * @param s The path to convert
1799 * @return The converted URL
1800 * @deprecated Replaced by apr_pescape_url() in APR
1802 AP_DECLARE(char *) ap_escape_urlencoded(apr_pool_t *p, const char *s)
1803 AP_FN_ATTR_NONNULL_ALL;
1806 * Escape a string as application/x-www-form-urlencoded, to a preallocated buffer
1807 * @param c The preallocated buffer to write to
1808 * @param s The path to convert
1809 * @return The converted URL (c)
1810 * @deprecated Replaced by apr_escape_url() in APR
1812 AP_DECLARE(char *) ap_escape_urlencoded_buffer(char *c, const char *s)
1813 AP_FN_ATTR_NONNULL_ALL;
1816 * Escape an html string
1817 * @param p The pool to allocate from
1818 * @param s The html to escape
1819 * @return The escaped string
1820 * @deprecated Replaced by apr_pescape_entity() in APR
1822 #define ap_escape_html(p,s) ap_escape_html2(p,s,0)
1824 * Escape an html string
1825 * @param p The pool to allocate from
1826 * @param s The html to escape
1827 * @param toasc Whether to escape all non-ASCII chars to \&\#nnn;
1828 * @return The escaped string
1829 * @deprecated Replaced by apr_pescape_entity() in APR
1831 AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc)
1832 AP_FN_ATTR_NONNULL_ALL;
1835 * Escape a string for logging
1836 * @param p The pool to allocate from
1837 * @param str The string to escape
1838 * @return The escaped string
1839 * @deprecated Replaced by apr_pescape_echo() in APR
1841 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str)
1842 AP_FN_ATTR_NONNULL((1));
1845 * Escape a string for logging into the error log (without a pool)
1846 * @param dest The buffer to write to
1847 * @param source The string to escape
1848 * @param buflen The buffer size for the escaped string (including "\0")
1849 * @return The len of the escaped string (always < maxlen)
1850 * @deprecated Replaced by apr_escape_echo() in APR
1852 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1854 AP_FN_ATTR_NONNULL((1));
1857 * Construct a full hostname
1858 * @param p The pool to allocate from
1859 * @param hostname The hostname of the server
1860 * @param port The port the server is running on
1861 * @param r The current request
1862 * @return The server's hostname
1864 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1865 apr_port_t port, const request_rec *r)
1866 AP_FN_ATTR_NONNULL((1,4));
1869 * Escape a shell command
1870 * @param p The pool to allocate from
1871 * @param s The command to escape
1872 * @return The escaped shell command
1873 * @deprecated Replaced with apr_escape_shell() in APR
1875 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s)
1876 AP_FN_ATTR_NONNULL_ALL;
1879 * Count the number of directories in a path
1880 * @param path The path to count
1881 * @return The number of directories
1883 AP_DECLARE(int) ap_count_dirs(const char *path)
1884 AP_FN_ATTR_NONNULL_ALL;
1887 * Copy at most @a n leading directories of @a s into @a d. @a d
1888 * should be at least as large as @a s plus 1 extra byte
1890 * @param d The location to copy to
1891 * @param s The location to copy from
1892 * @param n The number of directories to copy
1893 * @return value is the ever useful pointer to the trailing "\0" of d
1894 * @note on platforms with drive letters, n = 0 returns the "/" root,
1895 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1896 * returns the empty string. */
1897 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n)
1898 AP_FN_ATTR_NONNULL_ALL;
1901 * Return the parent directory name (including trailing /) of the file
1903 * @param p The pool to allocate from
1904 * @param s The file to get the parent of
1905 * @return A copy of the file's parent directory
1907 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s)
1908 AP_FN_ATTR_NONNULL_ALL;
1911 * Given a directory and filename, create a single path from them. This
1912 * function is smart enough to ensure that there is a single '/' between the
1913 * directory and file names
1914 * @param a The pool to allocate from
1915 * @param dir The directory name
1916 * @param f The filename
1917 * @return A copy of the full path, with one byte of extra space after the NUL
1918 * to allow the caller to add a trailing '/'.
1919 * @note Never consider using this function if you are dealing with filesystem
1920 * names that need to remain canonical, unless you are merging an apr_dir_read
1921 * path and returned filename. Otherwise, the result is not canonical.
1923 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f)
1924 AP_FN_ATTR_NONNULL_ALL;
1927 * Test if the given path has an absolute path.
1928 * @param p The pool to allocate from
1929 * @param dir The directory name
1930 * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1931 * multiple forms of absolute paths. This only reports if the path is absolute
1932 * in a canonical sense.
1934 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir)
1935 AP_FN_ATTR_NONNULL_ALL;
1938 * Does the provided string contain wildcard characters? This is useful
1939 * for determining if the string should be passed to strcmp_match or to strcmp.
1940 * The only wildcard characters recognized are '?' and '*'
1941 * @param str The string to check
1942 * @return 1 if the string has wildcards, 0 otherwise
1944 AP_DECLARE(int) ap_is_matchexp(const char *str)
1945 AP_FN_ATTR_NONNULL_ALL;
1948 * Determine if a string matches a pattern containing the wildcards '?' or '*'
1949 * @param str The string to check
1950 * @param expected The pattern to match against
1951 * @return 0 if the two strings match, 1 otherwise
1953 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected)
1954 AP_FN_ATTR_NONNULL_ALL;
1957 * Determine if a string matches a pattern containing the wildcards '?' or '*',
1959 * @param str The string to check
1960 * @param expected The pattern to match against
1961 * @return 0 if the two strings match, 1 otherwise
1963 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected)
1964 AP_FN_ATTR_NONNULL_ALL;
1967 * Find the first occurrence of the substring s2 in s1, regardless of case
1968 * @param s1 The string to search
1969 * @param s2 The substring to search for
1970 * @return A pointer to the beginning of the substring
1971 * @remark See apr_strmatch() for a faster alternative
1973 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2)
1974 AP_FN_ATTR_NONNULL_ALL;
1977 * Return a pointer to the location inside of bigstring immediately after prefix
1978 * @param bigstring The input string
1979 * @param prefix The prefix to strip away
1980 * @return A pointer relative to bigstring after prefix
1982 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1984 AP_FN_ATTR_NONNULL_ALL;
1987 * Decode a base64 encoded string into memory allocated from a pool
1988 * @param p The pool to allocate from
1989 * @param bufcoded The encoded string
1990 * @return The decoded string
1991 * @deprecated Replaced by apr_pbase64_decode() in APR.
1993 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1996 * Encode a string into memory allocated from a pool in base 64 format
1997 * @param p The pool to allocate from
1998 * @param string The plaintext string
1999 * @return The encoded string
2000 * @deprecated Replaced by apr_pbase64_encode() in APR.
2002 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
2005 * Compile a regular expression to be used later. The regex is freed when
2006 * the pool is destroyed.
2007 * @param p The pool to allocate from
2008 * @param pattern the regular expression to compile
2009 * @param cflags The bitwise or of one or more of the following:
2010 * @li REG_EXTENDED - Use POSIX extended Regular Expressions
2011 * @li REG_ICASE - Ignore case
2012 * @li REG_NOSUB - Support for substring addressing of matches
2014 * @li REG_NEWLINE - Match-any-character operators don't match new-line
2015 * @return The compiled regular expression
2017 AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
2021 * Free the memory associated with a compiled regular expression
2022 * @param p The pool the regex was allocated from
2023 * @param reg The regular expression to free
2024 * @note This function is only necessary if the regex should be cleaned
2025 * up before the pool
2027 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
2030 * After performing a successful regex match, you may use this function to
2031 * perform a series of string substitutions based on subexpressions that were
2032 * matched during the call to ap_regexec. This function is limited to
2033 * result strings of 64K. Consider using ap_pregsub_ex() instead.
2034 * @param p The pool to allocate from
2035 * @param input An arbitrary string containing $1 through $9. These are
2036 * replaced with the corresponding matched sub-expressions
2037 * @param source The string that was originally matched to the regex
2038 * @param nmatch the nmatch returned from ap_pregex
2039 * @param pmatch the pmatch array returned from ap_pregex
2040 * @return The substituted string, or NULL on error
2042 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input,
2043 const char *source, apr_size_t nmatch,
2044 ap_regmatch_t pmatch[]);
2047 * After performing a successful regex match, you may use this function to
2048 * perform a series of string substitutions based on subexpressions that were
2049 * matched during the call to ap_regexec
2050 * @param p The pool to allocate from
2051 * @param result where to store the result, will be set to NULL on error
2052 * @param input An arbitrary string containing $1 through $9. These are
2053 * replaced with the corresponding matched sub-expressions
2054 * @param source The string that was originally matched to the regex
2055 * @param nmatch the nmatch returned from ap_pregex
2056 * @param pmatch the pmatch array returned from ap_pregex
2057 * @param maxlen the maximum string length to return, 0 for unlimited
2058 * @return APR_SUCCESS if successful, APR_ENOMEM or other error code otherwise.
2060 AP_DECLARE(apr_status_t) ap_pregsub_ex(apr_pool_t *p, char **result,
2061 const char *input, const char *source,
2063 ap_regmatch_t pmatch[],
2067 * We want to downcase the type/subtype for comparison purposes
2068 * but nothing else because ;parameter=foo values are case sensitive.
2069 * @param s The content-type to convert to lowercase
2071 AP_DECLARE(void) ap_content_type_tolower(char *s);
2074 * convert a string to all lowercase
2075 * @param s The string to convert to lowercase
2077 AP_DECLARE(void) ap_str_tolower(char *s);
2080 * convert a string to all uppercase
2081 * @param s The string to convert to uppercase
2083 AP_DECLARE(void) ap_str_toupper(char *s);
2086 * Search a string from left to right for the first occurrence of a
2087 * specific character
2088 * @param str The string to search
2089 * @param c The character to search for
2090 * @return The index of the first occurrence of c in str
2092 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
2095 * Search a string from right to left for the first occurrence of a
2096 * specific character
2097 * @param str The string to search
2098 * @param c The character to search for
2099 * @return The index of the first occurrence of c in str
2101 AP_DECLARE(int) ap_rind(const char *str, char c);
2104 * Given a string, replace any bare " with \\" .
2105 * @param p The pool to allocate memory from
2106 * @param instring The string to search for "
2107 * @return A copy of the string with escaped quotes
2108 * @deprecated Replaced by apr_pescape_echo() in APR
2110 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
2113 * Given a string, append the PID deliminated by delim.
2114 * Usually used to create a pid-appended filepath name
2115 * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
2116 * a macro, to avoid unistd.h dependency
2117 * @param p The pool to allocate memory from
2118 * @param string The string to append the PID to
2119 * @param delim The string to use to deliminate the string from the PID
2120 * @return A copy of the string with the PID appended
2122 AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
2126 * Parse a given timeout parameter string into an apr_interval_time_t value.
2127 * The unit of the time interval is given as postfix string to the numeric
2128 * string. Currently the following units are understood:
2135 * If no unit is contained in the given timeout parameter the default_time_unit
2136 * will be used instead.
2137 * @param timeout_parameter The string containing the timeout parameter.
2138 * @param timeout The timeout value to be returned.
2139 * @param default_time_unit The default time unit to use if none is specified
2140 * in timeout_parameter.
2141 * @return Status value indicating whether the parsing was successful or not.
2143 AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
2144 const char *timeout_parameter,
2145 apr_interval_time_t *timeout,
2146 const char *default_time_unit);
2149 * Determine if a request has a request body or not.
2151 * @param r the request_rec of the request
2152 * @return truth value
2154 AP_DECLARE(int) ap_request_has_body(request_rec *r);
2157 * Cleanup a string (mainly to be filesystem safe)
2158 * We only allow '_' and alphanumeric chars. Non-printable
2159 * map to 'x' and all others map to '_'
2161 * @param p pool to use to allocate dest
2162 * @param src string to clean up
2163 * @param dest cleaned up, allocated string
2164 * @return Status value indicating whether the cleaning was successful or not.
2166 AP_DECLARE(apr_status_t) ap_pstr2_alnum(apr_pool_t *p, const char *src,
2170 * Cleanup a string (mainly to be filesystem safe)
2171 * We only allow '_' and alphanumeric chars. Non-printable
2172 * map to 'x' and all others map to '_'
2174 * @param src string to clean up
2175 * @param dest cleaned up, pre-allocated string
2176 * @return Status value indicating whether the cleaning was successful or not.
2178 AP_DECLARE(apr_status_t) ap_str2_alnum(const char *src, char *dest);
2181 * Structure to store the contents of an HTTP form of the type
2182 * application/x-www-form-urlencoded.
2184 * Currently it contains the name as a char* of maximum length
2185 * HUGE_STRING_LEN, and a value in the form of a bucket brigade
2186 * of arbitrary length.
2190 apr_bucket_brigade *value;
2194 * Read the body and parse any form found, which must be of the
2195 * type application/x-www-form-urlencoded.
2196 * @param r request containing POSTed form data
2198 * @param ptr returned array of ap_form_pair_t
2199 * @param num max num of params or -1 for unlimited
2200 * @param size max size allowed for parsed data
2201 * @return OK or HTTP error
2203 AP_DECLARE(int) ap_parse_form_data(request_rec *r, struct ap_filter_t *f,
2204 apr_array_header_t **ptr,
2205 apr_size_t num, apr_size_t size);
2207 /* Misc system hackery */
2209 * Given the name of an object in the file system determine if it is a directory
2210 * @param p The pool to allocate from
2211 * @param name The name of the object to check
2212 * @return 1 if it is a directory, 0 otherwise
2214 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
2217 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
2218 * @param p The pool to allocate from
2219 * @param name The name of the object to check
2220 * @return 1 if it is a directory, 0 otherwise
2222 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
2225 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
2226 #endif /* _OSD_POSIX */
2229 * Determine the local host name for the current machine
2230 * @param p The pool to allocate from
2231 * @return A copy of the local host name
2233 char *ap_get_local_host(apr_pool_t *p);
2236 * Log an assertion to the error log
2237 * @param szExp The assertion that failed
2238 * @param szFile The file the assertion is in
2239 * @param nLine The line the assertion is defined on
2241 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
2242 __attribute__((noreturn));
2245 * @internal Internal Assert function
2247 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
2250 * Redefine assert() to something more useful for an Apache...
2252 * Use ap_assert() if the condition should always be checked.
2253 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
2257 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
2259 #define AP_DEBUG_ASSERT(exp) ((void)0)
2263 * @defgroup stopsignal Flags which indicate places where the server should stop for debugging.
2265 * A set of flags which indicate places where the server should raise(SIGSTOP).
2266 * This is useful for debugging, because you can then attach to that process
2267 * with gdb and continue. This is important in cases where one_process
2268 * debugging isn't possible.
2270 /** stop on a Detach */
2271 #define SIGSTOP_DETACH 1
2272 /** stop making a child process */
2273 #define SIGSTOP_MAKE_CHILD 2
2274 /** stop spawning a child process */
2275 #define SIGSTOP_SPAWN_CHILD 4
2276 /** stop spawning a child process with a piped log */
2277 #define SIGSTOP_PIPED_LOG_SPAWN 8
2278 /** stop spawning a CGI child process */
2279 #define SIGSTOP_CGI_CHILD 16
2281 /** Macro to get GDB started */
2282 #ifdef DEBUG_SIGSTOP
2283 extern int raise_sigstop_flags;
2284 #define RAISE_SIGSTOP(x) do { \
2285 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
2288 #define RAISE_SIGSTOP(x)
2292 * Get HTML describing the address and (optionally) admin of the server.
2293 * @param prefix Text which is prepended to the return value
2294 * @param r The request_rec
2295 * @return HTML describing the server, allocated in @a r's pool.
2297 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
2299 /* The C library has functions that allow const to be silently dropped ...
2300 these macros detect the drop in maintainer mode, but use the native
2301 methods for normal builds
2303 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
2304 to be included before the macros are defined or compilation will fail.
2308 AP_DECLARE(char *) ap_strchr(char *s, int c);
2309 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
2310 AP_DECLARE(char *) ap_strrchr(char *s, int c);
2311 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
2312 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
2313 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
2314 AP_DECLARE(void *) ap_palloc_debug(apr_pool_t *p, apr_size_t size);
2315 AP_DECLARE(void *) ap_pcalloc_debug(apr_pool_t *p, apr_size_t size);
2320 # define strchr(s, c) ap_strchr(s,c)
2322 # define strrchr(s, c) ap_strrchr(s,c)
2324 # define strstr(s, c) ap_strstr(s,c)
2326 #if !defined(AP_DEBUG_NO_ALLOC_POISON) && !APR_POOL_DEBUG
2328 * ap_palloc_debug initializes allocated memory to non-zero
2330 #define apr_palloc ap_palloc_debug
2332 * this is necessary to avoid useless double memset of memory
2333 * with ap_palloc_debug
2338 #define apr_pcalloc ap_pcalloc_debug
2343 /** use this instead of strchr */
2344 # define ap_strchr(s, c) strchr(s, c)
2345 /** use this instead of strchr */
2346 # define ap_strchr_c(s, c) strchr(s, c)
2347 /** use this instead of strrchr */
2348 # define ap_strrchr(s, c) strrchr(s, c)
2349 /** use this instead of strrchr */
2350 # define ap_strrchr_c(s, c) strrchr(s, c)
2351 /** use this instead of strrstr*/
2352 # define ap_strstr(s, c) strstr(s, c)
2353 /** use this instead of strrstr*/
2354 # define ap_strstr_c(s, c) strstr(s, c)
2359 * Generate pseudo random bytes.
2360 * This is a convenience interface to apr_random. It is cheaper but less
2361 * secure than apr_generate_random_bytes().
2362 * @param buf where to store the bytes
2363 * @param size number of bytes to generate
2364 * @note ap_random_insecure_bytes() is thread-safe, it uses a mutex on
2367 AP_DECLARE(void) ap_random_insecure_bytes(void *buf, apr_size_t size);
2370 * Get a pseudo random number in a range.
2371 * @param min low end of range
2372 * @param max high end of range
2373 * @return a number in the range
2375 AP_DECLARE(apr_uint32_t) ap_random_pick(apr_uint32_t min, apr_uint32_t max);
2378 * Abort with a error message signifying out of memory
2380 AP_DECLARE(void) ap_abort_on_oom(void) __attribute__((noreturn));
2383 * Wrapper for malloc() that calls ap_abort_on_oom() if out of memory
2384 * @param size size of the memory block
2385 * @return pointer to the allocated memory
2386 * @note ap_malloc may be implemented as a macro
2388 AP_DECLARE(void *) ap_malloc(size_t size)
2389 __attribute__((malloc))
2390 AP_FN_ATTR_ALLOC_SIZE(1);
2393 * Wrapper for calloc() that calls ap_abort_on_oom() if out of memory
2394 * @param nelem number of elements to allocate memory for
2395 * @param size size of a single element
2396 * @return pointer to the allocated memory
2397 * @note ap_calloc may be implemented as a macro
2399 AP_DECLARE(void *) ap_calloc(size_t nelem, size_t size)
2400 __attribute__((malloc))
2401 AP_FN_ATTR_ALLOC_SIZE2(1,2);
2404 * Wrapper for realloc() that calls ap_abort_on_oom() if out of memory
2405 * @param ptr pointer to the old memory block (or NULL)
2406 * @param size new size of the memory block
2407 * @return pointer to the reallocated memory
2408 * @note ap_realloc may be implemented as a macro
2410 AP_DECLARE(void *) ap_realloc(void *ptr, size_t size)
2411 AP_FN_ATTR_WARN_UNUSED_RESULT
2412 AP_FN_ATTR_ALLOC_SIZE(2);
2415 * Get server load params
2416 * @param ld struct to populate: -1 in fields means error
2418 AP_DECLARE(void) ap_get_sload(ap_sload_t *ld)
2419 AP_FN_ATTR_NONNULL_ALL;
2422 * Get server load averages (ala getloadavg)
2423 * @param ld struct to populate: -1 in fields means error
2425 AP_DECLARE(void) ap_get_loadavg(ap_loadavg_t *ld)
2426 AP_FN_ATTR_NONNULL_ALL;
2429 * Convert binary data into a hex string
2430 * @param src pointer to the data
2431 * @param srclen length of the data
2432 * @param dest pointer to buffer of length (2 * srclen + 1). The resulting
2433 * string will be NUL-terminated.
2434 * @deprecated Replaced by apr_escape_hex() in APR
2436 AP_DECLARE(void) ap_bin2hex(const void *src, apr_size_t srclen, char *dest)
2437 AP_FN_ATTR_NONNULL_ALL;
2440 * Wrapper for @a apr_password_validate() to cache expensive calculations
2441 * @param r the current request
2442 * @param username username of the user
2443 * @param passwd password string
2444 * @param hash hash string to be passwd to @a apr_password_validate()
2445 * @return APR_SUCCESS if passwords match, APR_EMISMATCH or error otherwise
2446 * @note Currently, ap_password_validate() only caches the result of the
2447 * most recent call with the same connection as @a r.
2448 * In the future, it may also do rate-limiting against brute-force
2451 AP_DECLARE(apr_status_t) ap_password_validate(request_rec *r,
2452 const char *username,
2457 * Short function to execute a command and return the first line of
2458 * output minus \\r \\n. Useful for "obscuring" passwords via exec calls
2459 * @param p the pool to allocate from
2460 * @param cmd the command to execute
2461 * @param argv the arguments to pass to the cmd
2462 * @return ptr to characters or NULL on any error
2464 AP_DECLARE(char *) ap_get_exec_line(apr_pool_t *p,
2466 const char * const *argv);
2469 #define AP_NORESTART APR_OS_START_USEERR + 1
2472 * Get the first index of the string in the array or -1 if not found. Start
2473 * searching a start.
2474 * @param array The array the check
2475 * @param s The string to find
2476 * @param start Start index for search. If start is out of bounds (negative or
2477 equal to array length or greater), -1 will be returned.
2478 * @return index of string in array or -1
2480 AP_DECLARE(int) ap_array_str_index(const apr_array_header_t *array,
2485 * Check if the string is member of the given array by strcmp.
2486 * @param array The array the check
2487 * @param s The string to find
2488 * @return !=0 iff string is member of array (via strcmp)
2490 AP_DECLARE(int) ap_array_str_contains(const apr_array_header_t *array,
2494 * Perform a case-insensitive comparison of two strings @a atr1 and @a atr2,
2495 * treating upper and lower case values of the 26 standard C/POSIX alphabetic
2496 * characters as equivalent. Extended latin characters outside of this set
2497 * are treated as unique octets, irrespective of the current locale.
2499 * Returns in integer greater than, equal to, or less than 0,
2500 * according to whether @a str1 is considered greater than, equal to,
2501 * or less than @a str2.
2503 * @note Same code as apr_cstr_casecmp, which arrives in APR 1.6
2505 AP_DECLARE(int) ap_cstr_casecmp(const char *s1, const char *s2);
2508 * Perform a case-insensitive comparison of two strings @a atr1 and @a atr2,
2509 * treating upper and lower case values of the 26 standard C/POSIX alphabetic
2510 * characters as equivalent. Extended latin characters outside of this set
2511 * are treated as unique octets, irrespective of the current locale.
2513 * Returns in integer greater than, equal to, or less than 0,
2514 * according to whether @a str1 is considered greater than, equal to,
2515 * or less than @a str2.
2517 * @note Same code as apr_cstr_casecmpn, which arrives in APR 1.6
2519 AP_DECLARE(int) ap_cstr_casecmpn(const char *s1, const char *s2, apr_size_t n);
2525 #endif /* !APACHE_HTTPD_H */
2527 /** @} //APACHE Daemon */
2528 /** @} //APACHE Core */
2529 /** @} //APACHE super group */