1 /* Copyright 1999-2004 The Apache Software Foundation
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef APACHE_HTTPD_H
17 #define APACHE_HTTPD_H
21 * @brief HTTP Daemon routines
24 /* XXX - We need to push more stuff to other .h files, or even .c files, to
25 * make this file smaller
28 /* Headers in which EVERYONE has an interest... */
29 #include "ap_config.h"
32 #include "ap_release.h"
34 #include "apr_general.h"
35 #include "apr_tables.h"
36 #include "apr_pools.h"
38 #include "apr_network_io.h"
39 #include "apr_buckets.h"
44 #include "pcreposix.h"
46 /* Note: util_uri.h is also included, see below */
54 /* ----------------------------- config dir ------------------------------ */
56 /* Define this to be the default server home dir. Most things later in this
57 * file with a relative pathname will have this added.
61 /* Set default for OS/2 file system */
62 #define HTTPD_ROOT "/os2httpd"
64 /* Set default for Windows file system */
65 #define HTTPD_ROOT "/apache"
67 /* Set the default for BeOS */
68 #define HTTPD_ROOT "/boot/home/apache"
69 #elif defined (NETWARE)
70 /* Set the default for NetWare */
71 #define HTTPD_ROOT "/apache"
73 #define HTTPD_ROOT "/usr/local/apache"
75 #endif /* HTTPD_ROOT */
78 * --------- You shouldn't have to edit anything below this line ----------
80 * Any modifications to any defaults not defined above should be done in the
81 * respective configuration file.
85 /* Default location of documents. Can be overridden by the DocumentRoot
88 #ifndef DOCUMENT_LOCATION
90 /* Set default for OS/2 file system */
91 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
93 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
95 #endif /* DOCUMENT_LOCATION */
97 /* Maximum number of dynamically loaded modules */
98 #ifndef DYNAMIC_MODULE_LIMIT
99 #define DYNAMIC_MODULE_LIMIT 128
102 /* Default administrator's address */
103 #define DEFAULT_ADMIN "[no address given]"
105 /* The name of the log files */
106 #ifndef DEFAULT_ERRORLOG
107 #if defined(OS2) || defined(WIN32)
108 #define DEFAULT_ERRORLOG "logs/error.log"
110 #define DEFAULT_ERRORLOG "logs/error_log"
112 #endif /* DEFAULT_ERRORLOG */
114 /* Define this to be what your per-directory security files are called */
115 #ifndef DEFAULT_ACCESS_FNAME
117 /* Set default for OS/2 file system */
118 #define DEFAULT_ACCESS_FNAME "htaccess"
120 #define DEFAULT_ACCESS_FNAME ".htaccess"
122 #endif /* DEFAULT_ACCESS_FNAME */
124 /* The name of the server config file */
125 #ifndef SERVER_CONFIG_FILE
126 #define SERVER_CONFIG_FILE "conf/httpd.conf"
129 /* The default path for CGI scripts if none is currently set */
131 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
134 /* The path to the suExec wrapper, can be overridden in Configuration */
136 #define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
139 /* The timeout for waiting for messages */
140 #ifndef DEFAULT_TIMEOUT
141 #define DEFAULT_TIMEOUT 300
144 /* The timeout for waiting for keepalive timeout until next request */
145 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
146 #define DEFAULT_KEEPALIVE_TIMEOUT 15
149 /* The number of requests to entertain per connection */
150 #ifndef DEFAULT_KEEPALIVE
151 #define DEFAULT_KEEPALIVE 100
154 /* Limits on the size of various request items. These limits primarily
155 * exist to prevent simple denial-of-service attacks on a server based
156 * on misuse of the protocol. The recommended values will depend on the
157 * nature of the server resources -- CGI scripts and database backends
158 * might require large values, but most servers could get by with much
159 * smaller limits than we use below. The request message body size can
160 * be limited by the per-dir config directive LimitRequestBody.
162 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
163 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
164 * These two limits can be lowered (but not raised) by the server config
165 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
167 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
168 * the server config directive LimitRequestFields.
170 #ifndef DEFAULT_LIMIT_REQUEST_LINE
171 #define DEFAULT_LIMIT_REQUEST_LINE 8190
172 #endif /* default limit on bytes in Request-Line (Method+URI+HTTP-version) */
173 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
174 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
175 #endif /* default limit on bytes in any one header field */
176 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
177 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
178 #endif /* default limit on number of request header fields */
182 * The default default character set name to add if AddDefaultCharset is
183 * enabled. Overridden with AddDefaultCharsetName.
185 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
187 #endif /* CORE_PRIVATE */
189 /** default HTTP Server protocol */
190 #define AP_SERVER_PROTOCOL "HTTP/1.1"
193 /* ------------------ stuff that modules are allowed to look at ----------- */
195 /** Define this to be what your HTML directory content files are called */
196 #ifndef AP_DEFAULT_INDEX
197 #define AP_DEFAULT_INDEX "index.html"
202 * Define this to be what type you'd like returned for files with unknown
204 * @warning MUST be all lower case.
206 #ifndef DEFAULT_CONTENT_TYPE
207 #define DEFAULT_CONTENT_TYPE "text/plain"
210 /** The name of the MIME types file */
211 #ifndef AP_TYPES_CONFIG_FILE
212 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
216 * Define the HTML doctype strings centrally.
218 /** HTML 2.0 Doctype */
219 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
220 "DTD HTML 2.0//EN\">\n"
221 /** HTML 3.2 Doctype */
222 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
223 "DTD HTML 3.2 Final//EN\">\n"
224 /** HTML 4.0 Strict Doctype */
225 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
226 "DTD HTML 4.0//EN\"\n" \
227 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
228 /** HTML 4.0 Transitional Doctype */
229 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
230 "DTD HTML 4.0 Transitional//EN\"\n" \
231 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
232 /** HTML 4.0 Frameset Doctype */
233 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
234 "DTD HTML 4.0 Frameset//EN\"\n" \
235 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
236 /** XHTML 1.0 Strict Doctype */
237 #define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
238 "DTD XHTML 1.0 Strict//EN\"\n" \
239 "\"http://www.w3.org/TR/xhtml1/DTD/" \
240 "xhtml1-strict.dtd\">\n"
241 /** XHTML 1.0 Transitional Doctype */
242 #define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
243 "DTD XHTML 1.0 Transitional//EN\"\n" \
244 "\"http://www.w3.org/TR/xhtml1/DTD/" \
245 "xhtml1-transitional.dtd\">\n"
246 /** XHTML 1.0 Frameset Doctype */
247 #define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
248 "DTD XHTML 1.0 Frameset//EN\"\n" \
249 "\"http://www.w3.org/TR/xhtml1/DTD/" \
250 "xhtml1-frameset.dtd\">"
252 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
254 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
255 /** Major part of HTTP protocol */
256 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
257 /** Minor part of HTTP protocol */
258 #define HTTP_VERSION_MINOR(number) ((number)%1000)
260 /* -------------- Port number for server running standalone --------------- */
262 /** default HTTP Port */
263 #define DEFAULT_HTTP_PORT 80
264 /** default HTTPS Port */
265 #define DEFAULT_HTTPS_PORT 443
267 * Check whether @a port is the default port for the request @a r.
268 * @param port The port number
269 * @param r The request
270 * @see #ap_default_port
272 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
274 * Get the default port for a request (which depends on the scheme).
275 * @param r The request
277 #define ap_default_port(r) ap_run_default_port(r)
279 * Get the scheme for a request.
280 * @param r The request
281 * @bug This should be called ap_http_scheme!
283 #define ap_http_method(r) ap_run_http_method(r)
285 /** The default string lengths */
286 #define MAX_STRING_LEN HUGE_STRING_LEN
287 #define HUGE_STRING_LEN 8192
289 /** The size of the server's internal read-write buffers */
290 #define AP_IOBUFSIZE 8192
292 /** The max number of regex captures that can be expanded by ap_pregsub */
293 #define AP_MAX_REG_MATCH 10
296 * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
297 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
298 * than that in case the brigade code/filters attempt to read it directly.
299 * ### 16mb is an invention, no idea if it is reasonable.
301 #define AP_MAX_SENDFILE 16777216 /* 2^24 */
304 * Special Apache error codes. These are basically used
305 * in http_main.c so we can keep track of various errors.
309 #define APEXIT_OK 0x0
310 /** A fatal error arising during the server's init sequence */
311 #define APEXIT_INIT 0x2
312 /** The child died during its init sequence */
313 #define APEXIT_CHILDINIT 0x3
315 * The child exited due to a resource shortage.
316 * The parent should limit the rate of forking until
317 * the situation is resolved.
319 #define APEXIT_CHILDSICK 0x7
321 * A fatal error, resulting in the whole server aborting.
322 * If a child exits with this error, the parent process
323 * considers this a server-wide fatal error and aborts.
325 #define APEXIT_CHILDFATAL 0xf
329 * Stuff marked #AP_DECLARE is part of the API, and intended for use
330 * by modules. Its purpose is to allow us to add attributes that
331 * particular platforms or compilers require to every exported function.
333 # define AP_DECLARE(type) type
336 #ifndef AP_DECLARE_NONSTD
338 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
339 * use by modules. The difference between #AP_DECLARE and
340 * #AP_DECLARE_NONSTD is that the latter is required for any functions
341 * which use varargs or are used via indirect function call. This
342 * is to accomodate the two calling conventions in windows dlls.
344 # define AP_DECLARE_NONSTD(type) type
346 #ifndef AP_DECLARE_DATA
347 # define AP_DECLARE_DATA
350 #ifndef AP_MODULE_DECLARE
351 # define AP_MODULE_DECLARE(type) type
353 #ifndef AP_MODULE_DECLARE_NONSTD
354 # define AP_MODULE_DECLARE_NONSTD(type) type
356 #ifndef AP_MODULE_DECLARE_DATA
357 # define AP_MODULE_DECLARE_DATA
362 * modules should not used functions marked AP_CORE_DECLARE
364 #ifndef AP_CORE_DECLARE
365 # define AP_CORE_DECLARE AP_DECLARE
369 * modules should not used functions marked AP_CORE_DECLARE_NONSTD
372 #ifndef AP_CORE_DECLARE_NONSTD
373 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
377 * The numeric version information is broken out into fields within this
381 int major; /**< major number */
382 int minor; /**< minor number */
383 int patch; /**< patch number */
384 const char *add_string; /**< additional string like "-dev" */
388 * Return httpd's version information in a numeric form.
390 * @param version Pointer to a version structure for returning the version
393 AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
396 * Get the server version string
397 * @return The server version string
399 AP_DECLARE(const char *) ap_get_server_version(void);
402 * Add a component to the version string
403 * @param pconf The pool to allocate the component from
404 * @param component The string to add
406 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
409 * Get the date a time that the server was built
410 * @return The server build time string
412 AP_DECLARE(const char *) ap_get_server_built(void);
414 #define DECLINED -1 /**< Module declines to handle */
415 #define DONE -2 /**< Module has served the response completely
416 * - it's safe to die() with no more output
418 #define OK 0 /**< Module has handled this stage. */
422 * @defgroup HTTP_Status HTTP Status Codes
426 * The size of the static array in http_protocol.c for storing
427 * all of the potential response status-lines (a sparse table).
428 * A future version should dynamically generate the apr_table_t at startup.
430 #define RESPONSE_CODES 57
432 #define HTTP_CONTINUE 100
433 #define HTTP_SWITCHING_PROTOCOLS 101
434 #define HTTP_PROCESSING 102
436 #define HTTP_CREATED 201
437 #define HTTP_ACCEPTED 202
438 #define HTTP_NON_AUTHORITATIVE 203
439 #define HTTP_NO_CONTENT 204
440 #define HTTP_RESET_CONTENT 205
441 #define HTTP_PARTIAL_CONTENT 206
442 #define HTTP_MULTI_STATUS 207
443 #define HTTP_MULTIPLE_CHOICES 300
444 #define HTTP_MOVED_PERMANENTLY 301
445 #define HTTP_MOVED_TEMPORARILY 302
446 #define HTTP_SEE_OTHER 303
447 #define HTTP_NOT_MODIFIED 304
448 #define HTTP_USE_PROXY 305
449 #define HTTP_TEMPORARY_REDIRECT 307
450 #define HTTP_BAD_REQUEST 400
451 #define HTTP_UNAUTHORIZED 401
452 #define HTTP_PAYMENT_REQUIRED 402
453 #define HTTP_FORBIDDEN 403
454 #define HTTP_NOT_FOUND 404
455 #define HTTP_METHOD_NOT_ALLOWED 405
456 #define HTTP_NOT_ACCEPTABLE 406
457 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
458 #define HTTP_REQUEST_TIME_OUT 408
459 #define HTTP_CONFLICT 409
460 #define HTTP_GONE 410
461 #define HTTP_LENGTH_REQUIRED 411
462 #define HTTP_PRECONDITION_FAILED 412
463 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
464 #define HTTP_REQUEST_URI_TOO_LARGE 414
465 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
466 #define HTTP_RANGE_NOT_SATISFIABLE 416
467 #define HTTP_EXPECTATION_FAILED 417
468 #define HTTP_UNPROCESSABLE_ENTITY 422
469 #define HTTP_LOCKED 423
470 #define HTTP_FAILED_DEPENDENCY 424
471 #define HTTP_UPGRADE_REQUIRED 426
472 #define HTTP_INTERNAL_SERVER_ERROR 500
473 #define HTTP_NOT_IMPLEMENTED 501
474 #define HTTP_BAD_GATEWAY 502
475 #define HTTP_SERVICE_UNAVAILABLE 503
476 #define HTTP_GATEWAY_TIME_OUT 504
477 #define HTTP_VERSION_NOT_SUPPORTED 505
478 #define HTTP_VARIANT_ALSO_VARIES 506
479 #define HTTP_INSUFFICIENT_STORAGE 507
480 #define HTTP_NOT_EXTENDED 510
482 /** is the status code informational */
483 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
484 /** is the status code OK ?*/
485 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
486 /** is the status code a redirect */
487 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
488 /** is the status code a error (client or server) */
489 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
490 /** is the status code a client error */
491 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
492 /** is the status code a server error */
493 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
495 /** should the status code drop the connection */
496 #define ap_status_drops_connection(x) \
497 (((x) == HTTP_BAD_REQUEST) || \
498 ((x) == HTTP_REQUEST_TIME_OUT) || \
499 ((x) == HTTP_LENGTH_REQUIRED) || \
500 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
501 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
502 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
503 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
504 ((x) == HTTP_NOT_IMPLEMENTED))
507 * @defgroup Methods List of Methods recognized by the server
511 * Methods recognized (but not necessarily handled) by the server.
512 * These constants are used in bit shifting masks of size int, so it is
513 * unsafe to have more methods than bits in an int. HEAD == M_GET.
514 * This list must be tracked by the list in http_protocol.c in routine
515 * ap_method_name_of().
517 #define M_GET 0 /* RFC 2616: HTTP */
518 #define M_PUT 1 /* : */
523 #define M_TRACE 6 /* RFC 2616: HTTP */
524 #define M_PATCH 7 /* no rfc(!) ### remove this one? */
525 #define M_PROPFIND 8 /* RFC 2518: WebDAV */
526 #define M_PROPPATCH 9 /* : */
531 #define M_UNLOCK 14 /* RFC 2518: WebDAV */
532 #define M_VERSION_CONTROL 15 /* RFC 3253: WebDAV Versioning */
533 #define M_CHECKOUT 16 /* : */
534 #define M_UNCHECKOUT 17
539 #define M_MKWORKSPACE 22
540 #define M_MKACTIVITY 23
541 #define M_BASELINE_CONTROL 24
543 #define M_INVALID 26 /* RFC 3253: WebDAV Versioning */
546 * METHODS needs to be equal to the number of bits
547 * we are using for limit masks.
552 * The method mask bit to shift for anding with a bitmask.
554 #define AP_METHOD_BIT ((apr_int64_t)1)
559 * Structure for handling HTTP methods. Methods known to the server are
560 * accessed via a bitmask shortcut; extension methods are handled by
563 typedef struct ap_method_list_t ap_method_list_t;
564 struct ap_method_list_t {
565 /* The bitmask used for known methods */
566 apr_int64_t method_mask;
567 /* the array used for extension methods */
568 apr_array_header_t *method_list;
571 * @defgroup module_magic Module Magic mime types
574 /** Magic for mod_cgi[d] */
575 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
576 /** Magic for mod_include */
577 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
578 /** Magic for mod_include */
579 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
580 /** Magic for mod_dir */
581 #define DIR_MAGIC_TYPE "httpd/unix-directory"
584 /* Just in case your linefeed isn't the one the other end is expecting. */
585 #if !APR_CHARSET_EBCDIC
588 /** carrige return */
590 /** carrige return /Line Feed Combo */
591 #define CRLF "\015\012"
592 #else /* APR_CHARSET_EBCDIC */
593 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
594 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
595 * "native EBCDIC" CR and NL characters. These are therefore
602 #endif /* APR_CHARSET_EBCDIC */
605 * @defgroup values_request_rec_body Possible values for request_rec.read_body
607 * Possible values for request_rec.read_body (set by handling module):
610 /** Send 413 error if message has any body */
611 #define REQUEST_NO_BODY 0
612 /** Send 411 error if body without Content-Length */
613 #define REQUEST_CHUNKED_ERROR 1
614 /** If chunked, remove the chunks for me. */
615 #define REQUEST_CHUNKED_DECHUNK 2
619 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
621 * Possible values for request_rec.used_path_info:
624 /** Accept the path_info from the request */
625 #define AP_REQ_ACCEPT_PATH_INFO 0
626 /** Return a 404 error if path_info was given */
627 #define AP_REQ_REJECT_PATH_INFO 1
628 /** Module may chose to use the given path_info */
629 #define AP_REQ_DEFAULT_PATH_INFO 2
633 * Things which may vary per file-lookup WITHIN a request ---
634 * e.g., state of MIME config. Basically, the name of an object, info
635 * about the object, and any other info we may ahve which may need to
636 * change as we go poking around looking for it (e.g., overridden by
639 * Note how the default state of almost all these things is properly
640 * zero, so that allocating it with pcalloc does the right thing without
641 * a whole lot of hairy initialization... so long as we are willing to
642 * make the (fairly) portable assumption that the bit pattern of a NULL
643 * pointer is, in fact, zero.
647 * This represents the result of calling htaccess; these are cached for
650 struct htaccess_result {
651 /** the directory to which this applies */
653 /** the overrides allowed for the .htaccess file */
655 /** the override options allowed for the .htaccess file */
657 /** the configuration directives */
658 struct ap_conf_vector_t *htaccess;
659 /** the next one, or NULL if no more; N.B. never change this */
660 const struct htaccess_result *next;
663 /* The following four types define a hierarchy of activities, so that
664 * given a request_rec r you can write r->connection->server->process
665 * to get to the process_rec. While this reduces substantially the
666 * number of arguments that various hooks require beware that in
667 * threaded versions of the server you must consider multiplexing
671 /** A structure that represents one process */
672 typedef struct process_rec process_rec;
673 /** A structure that represents a virtual server */
674 typedef struct server_rec server_rec;
675 /** A structure that represents one connection */
676 typedef struct conn_rec conn_rec;
677 /** A structure that represents the current request */
678 typedef struct request_rec request_rec;
679 /** A structure that represents the status of the current connection */
680 typedef struct conn_state_t conn_state_t;
682 /* ### would be nice to not include this from httpd.h ... */
683 /* This comes after we have defined the request_rec type */
686 /** A structure that represents one process */
688 /** Global pool. Cleared upon normal exit */
690 /** Configuration pool. Cleared upon restart */
692 /** Number of command line arguments passed to the program */
694 /** The command line arguments */
695 const char * const *argv;
696 /** The program name used to execute the program */
697 const char *short_name;
700 /** A structure that represents the current request */
702 /** The pool associated with the request */
704 /** The connection to the client */
705 conn_rec *connection;
706 /** The virtual host for this request */
709 /** Pointer to the redirected request if this is an external redirect */
711 /** Pointer to the previous request if this is an internal redirect */
714 /** Pointer to the main request if this is a sub-request
715 * (see http_request.h) */
718 /* Info about the request itself... we begin with stuff that only
719 * protocol.c should ever touch...
721 /** First line of request */
723 /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
725 /** A proxy request (calculated during post_read_request/translate_name)
726 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
730 /** HEAD request, as opposed to GET */
732 /** Protocol string, as given to us, or HTTP/0.9 */
734 /** Protocol version number of protocol; 1.1 = 1001 */
736 /** Host, as set by full URI or Host: */
737 const char *hostname;
739 /** Time when the request started */
740 apr_time_t request_time;
742 /** Status line, if set by script */
743 const char *status_line;
747 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
748 * look, but don't touch.
751 /** Request method (eg. GET, HEAD, POST, etc.) */
753 /** M_GET, M_POST, etc. */
757 * 'allowed' is a bitvector of the allowed methods.
759 * A handler must ensure that the request method is one that
760 * it is capable of handling. Generally modules should DECLINE
761 * any request methods they do not handle. Prior to aborting the
762 * handler like this the handler should set r->allowed to the list
763 * of methods that it is willing to handle. This bitvector is used
764 * to construct the "Allow:" header required for OPTIONS requests,
765 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
767 * Since the default_handler deals with OPTIONS, all modules can
768 * usually decline to deal with OPTIONS. TRACE is always allowed,
769 * modules don't need to set it explicitly.
771 * Since the default_handler will always handle a GET, a
772 * module which does *not* implement GET should probably return
773 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
774 * handler can't be installed by mod_actions.
777 /** Array of extension methods */
778 apr_array_header_t *allowed_xmethods;
779 /** List of allowed methods */
780 ap_method_list_t *allowed_methods;
782 /** byte count in stream is for body */
783 apr_off_t sent_bodyct;
784 /** body byte count, for easy access */
785 apr_off_t bytes_sent;
786 /** Last modified time of the requested resource */
789 /* HTTP/1.1 connection-level features */
791 /** sending chunked transfer-coding */
793 /** The Range: header */
795 /** The "real" content length */
798 /** Remaining bytes left to read from the request body */
800 /** Number of bytes that have been read from the request body */
801 apr_off_t read_length;
802 /** Method for reading the request body
803 * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
804 * REQUEST_CHUNKED_DECHUNK, etc...) */
806 /** reading chunked transfer-coding */
808 /** is client waiting for a 100 response? */
809 unsigned expecting_100;
811 /* MIME header environments, in and out. Also, an array containing
812 * environment variables to be passed to subprocesses, so people can
813 * write modules to add to that environment.
815 * The difference between headers_out and err_headers_out is that the
816 * latter are printed even on error, and persist across internal redirects
817 * (so the headers printed for ErrorDocument handlers will have them).
819 * The 'notes' apr_table_t is for notes from one module to another, with no
820 * other set purpose in mind...
823 /** MIME header environment from the request */
824 apr_table_t *headers_in;
825 /** MIME header environment for the response */
826 apr_table_t *headers_out;
827 /** MIME header environment for the response, printed even on errors and
828 * persist across internal redirects */
829 apr_table_t *err_headers_out;
830 /** Array of environment variables to be used for sub processes */
831 apr_table_t *subprocess_env;
832 /** Notes from one module to another */
835 /* content_type, handler, content_encoding, and all content_languages
836 * MUST be lowercased strings. They may be pointers to static strings;
837 * they should not be modified in place.
839 /** The content-type for the current request */
840 const char *content_type; /* Break these out --- we dispatch on 'em */
841 /** The handler string that we use to call a handler function */
842 const char *handler; /* What we *really* dispatch on */
844 /** How to encode the data */
845 const char *content_encoding;
846 /** Array of strings representing the content languages */
847 apr_array_header_t *content_languages;
849 /** variant list validator (if negotiated) */
850 char *vlist_validator;
852 /** If an authentication check was made, this gets set to the user name. */
854 /** If an authentication check was made, this gets set to the auth type. */
857 /** This response can not be cached */
859 /** There is no local copy of this response */
862 /* What object is being requested (either directly, or via include
863 * or content-negotiation mapping).
866 /** The URI without any parsing performed */
868 /** The path portion of the URI */
870 /** The filename on disk corresponding to this response */
872 /* XXX: What does this mean? Please define "canonicalize" -aaron */
873 /** The true filename, we canonicalize r->filename if these don't match */
874 char *canonical_filename;
875 /** The PATH_INFO extracted from this request */
877 /** The QUERY_ARGS extracted from this request */
879 /** finfo.protection (st_mode) set to zero if no such file */
881 /** A struct containing the components of URI */
882 apr_uri_t parsed_uri;
885 * Flag for the handler to accept or reject path_info on
886 * the current request. All modules should respect the
887 * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
888 * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
889 * may follow existing conventions. This is set to the
890 * user's preference upon HOOK_VERY_FIRST of the fixups.
894 /* Various other config info which may change with .htaccess files
895 * These are config vectors, with one void* pointer for each module
896 * (the thing pointed to being the module's business).
899 /** Options set in config files, etc. */
900 struct ap_conf_vector_t *per_dir_config;
901 /** Notes on *this* request */
902 struct ap_conf_vector_t *request_config;
905 * A linked list of the .htaccess configuration directives
906 * accessed by this request.
907 * N.B. always add to the head of the list, _never_ to the end.
908 * that way, a sub request's list can (temporarily) point to a parent's list
910 const struct htaccess_result *htaccess;
912 /** A list of output filters to be used for this request */
913 ap_filter_t *output_filters;
914 /** A list of input filters to be used for this request */
915 ap_filter_t *input_filters;
917 /** A list of protocol level output filters to be used for this
919 ap_filter_t *proto_output_filters;
920 /** A list of protocol level input filters to be used for this
922 ap_filter_t *proto_input_filters;
924 /** A flag to determine if the eos bucket has been sent yet */
927 /* Things placed at the end of the record to avoid breaking binary
928 * compatibility. It would be nice to remember to reorder the entire
929 * record to improve 64bit alignment the next time we need to break
930 * binary compatibility for some other reason.
935 * @defgroup ProxyReq Proxy request types
937 * Possible values of request_rec->proxyreq. A request could be normal,
938 * proxied or reverse proxied. Normally proxied and reverse proxied are
939 * grouped together as just "proxied", but sometimes it's necessary to
940 * tell the difference between the two, such as for authentication.
944 #define PROXYREQ_NONE 0 /**< No proxy */
945 #define PROXYREQ_PROXY 1 /**< Standard proxy */
946 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
947 #define PROXYREQ_RESPONSE 3 /**< Origin response */
955 } ap_conn_keepalive_e;
957 /** Structure to store things which are per connection */
959 /** Pool associated with this connection */
961 /** Physical vhost this conn came in on */
962 server_rec *base_server;
963 /** used by http_vhost.c */
964 void *vhost_lookup_data;
966 /* Information about the connection itself */
968 apr_sockaddr_t *local_addr;
969 /** remote address */
970 apr_sockaddr_t *remote_addr;
972 /** Client's IP address */
974 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
975 * "" if it has and no address was found. N.B. Only access this though
976 * get_remote_host() */
978 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
979 * get_remote_logname() */
980 char *remote_logname;
982 /** Are we still talking? */
985 /** Are we going to keep the connection alive for another request?
986 * @see ap_conn_keepalive_e */
987 ap_conn_keepalive_e keepalive;
989 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
991 signed int double_reverse:2;
993 /** How many times have we used it? */
995 /** server IP address */
997 /** used for ap_get_server_name when UseCanonicalName is set to DNS
998 * (ignores setting of HostnameLookups) */
1001 /** ID of this connection; unique at any point in time */
1003 /** Config vector containing pointers to connections per-server
1004 * config structures. */
1005 struct ap_conf_vector_t *conn_config;
1006 /** Notes on *this* connection: send note from one module to
1007 * another. must remain valid for all requests on this conn */
1009 /** A list of input filters to be used for this connection */
1010 ap_filter_t *input_filters;
1011 /** A list of output filters to be used for this connection */
1012 ap_filter_t *output_filters;
1013 /** handle to scoreboard information for this connection */
1015 /** The bucket allocator to use for all bucket/brigade creations */
1016 struct apr_bucket_alloc_t *bucket_alloc;
1017 /** The current state of this connection */
1019 /** Is there data pending in the input filters? */
1020 int data_in_input_filters;
1024 CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1025 CONN_STATE_READ_REQUEST_LINE,
1029 struct conn_state_t {
1030 APR_RING_ENTRY(conn_state_t) timeout_list;
1031 apr_time_t expiration_time;
1035 apr_bucket_alloc_t *bucket_alloc;
1039 /* Per-vhost config... */
1042 * The address 255.255.255.255, when used as a virtualhost address,
1043 * will become the "default" server when the ip doesn't match other vhosts.
1045 #define DEFAULT_VHOST_ADDR 0xfffffffful
1048 /** A structure to be used for Per-vhost config */
1049 typedef struct server_addr_rec server_addr_rec;
1050 struct server_addr_rec {
1051 /** The next server in the list */
1052 server_addr_rec *next;
1053 /** The bound address, for this server */
1054 apr_sockaddr_t *host_addr;
1055 /** The bound port, for this server */
1056 apr_port_t host_port;
1057 /** The name given in <VirtualHost> */
1061 /** A structure to store information for each virtual server */
1063 /** The process this server is running in */
1064 process_rec *process;
1065 /** The next server in the list */
1068 /** The name of the server */
1069 const char *defn_name;
1070 /** The line of the config file that the server was defined on */
1071 unsigned defn_line_number;
1073 /* Contact information */
1075 /** The admin's contact information */
1077 /** The server hostname */
1078 char *server_hostname;
1079 /** for redirects, etc. */
1082 /* Log files --- note that transfer log is now in the modules... */
1084 /** The name of the error log */
1086 /** A file descriptor that references the error log */
1087 apr_file_t *error_log;
1088 /** The log level for this server */
1091 /* Module-specific configuration for server, and defaults... */
1093 /** true if this is the virtual server */
1095 /** Config vector containing pointers to modules' per-server config
1097 struct ap_conf_vector_t *module_config;
1098 /** MIME type info, etc., before we start checking per-directory info */
1099 struct ap_conf_vector_t *lookup_defaults;
1101 /* Transaction handling */
1103 /** I haven't got a clue */
1104 server_addr_rec *addrs;
1105 /** Timeout, as an apr interval, before we give up */
1106 apr_interval_time_t timeout;
1107 /** The apr interval we will wait for another request */
1108 apr_interval_time_t keep_alive_timeout;
1109 /** Maximum requests per connection */
1111 /** Use persistent connections? */
1114 /** Pathname for ServerPath */
1116 /** Length of path */
1119 /** Normal names for ServerAlias servers */
1120 apr_array_header_t *names;
1121 /** Wildcarded names for ServerAlias servers */
1122 apr_array_header_t *wild_names;
1124 /** limit on size of the HTTP request line */
1126 /** limit on size of any request header field */
1127 int limit_req_fieldsize;
1128 /** limit on number of request header fields */
1129 int limit_req_fields;
1132 typedef struct core_output_filter_ctx {
1133 apr_bucket_brigade *b;
1134 apr_pool_t *deferred_write_pool; /* subpool of c->pool used for resources
1135 * which may outlive the request
1137 } core_output_filter_ctx_t;
1139 typedef struct core_filter_ctx {
1140 apr_bucket_brigade *b;
1143 typedef struct core_net_rec {
1144 /** Connection to the client */
1145 apr_socket_t *client_socket;
1147 /** connection record */
1150 core_output_filter_ctx_t *out_ctx;
1155 * Examine a field value (such as a media-/content-type) string and return
1156 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1157 * @param p Pool to allocate memory from
1158 * @param intype The field to examine
1159 * @return A copy of the field minus any parameters
1161 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1164 * Convert a time from an integer into a string in a specified format
1165 * @param p The pool to allocate memory from
1166 * @param t The time to convert
1167 * @param fmt The format to use for the conversion
1168 * @param gmt Convert the time for GMT?
1169 * @return The string that represents the specified time
1171 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1173 /* String handling. The *_nc variants allow you to use non-const char **s as
1174 arguments (unfortunately C won't automatically convert a char ** to a const
1178 * Get the characters until the first occurance of a specified character
1179 * @param p The pool to allocate memory from
1180 * @param line The string to get the characters from
1181 * @param stop The character to stop at
1182 * @return A copy of the characters up to the first stop character
1184 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1186 * Get the characters until the first occurance of a specified character
1187 * @param p The pool to allocate memory from
1188 * @param line The string to get the characters from
1189 * @param stop The character to stop at
1190 * @return A copy of the characters up to the first stop character
1191 * @note This is the same as ap_getword(), except it doesn't use const char **.
1193 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1196 * Get the first word from a given string. A word is defined as all characters
1197 * up to the first whitespace.
1198 * @param p The pool to allocate memory from
1199 * @param line The string to traverse
1200 * @return The first word in the line
1202 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1204 * Get the first word from a given string. A word is defined as all characters
1205 * up to the first whitespace.
1206 * @param p The pool to allocate memory from
1207 * @param line The string to traverse
1208 * @return The first word in the line
1209 * @note The same as ap_getword_white(), except it doesn't use const char **.
1211 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1214 * Get all characters from the first occurance of @a stop to the first '\0'
1215 * @param p The pool to allocate memory from
1216 * @param line The line to traverse
1217 * @param stop The character to start at
1218 * @return A copy of all caracters after the first occurance of the specified
1221 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1224 * Get all characters from the first occurance of @a stop to the first '\0'
1225 * @param p The pool to allocate memory from
1226 * @param line The line to traverse
1227 * @param stop The character to start at
1228 * @return A copy of all caracters after the first occurance of the specified
1230 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1232 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1235 * Get the second word in the string paying attention to quoting
1236 * @param p The pool to allocate from
1237 * @param line The line to traverse
1238 * @return A copy of the string
1240 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1242 * Get the second word in the string paying attention to quoting
1243 * @param p The pool to allocate from
1244 * @param line The line to traverse
1245 * @return A copy of the string
1246 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1248 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1251 * Check a string for any ${ENV} environment variable construct and replace
1252 * each them by the value of that environment variable, if it exists. If the
1253 * environment value does not exist, leave the ${ENV} construct alone; it
1254 * means something else.
1255 * @param p The pool to allocate from
1256 * @param word The string to check
1257 * @return The string with the replaced environment variables
1259 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1262 * Size an HTTP header field list item, as separated by a comma.
1263 * @param field The field to size
1264 * @param len The length of the field
1265 * @return The return value is a pointer to the beginning of the non-empty
1266 * list item within the original string (or NULL if there is none) and the
1267 * address of field is shifted to the next non-comma, non-whitespace
1268 * character. len is the length of the item excluding any beginning whitespace.
1270 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1273 * Retrieve an HTTP header field list item, as separated by a comma,
1274 * while stripping insignificant whitespace and lowercasing anything not in
1275 * a quoted string or comment.
1276 * @param p The pool to allocate from
1277 * @param field The field to retrieve
1278 * @return The return value is a new string containing the converted list
1279 * item (or NULL if none) and the address pointed to by field is
1280 * shifted to the next non-comma, non-whitespace.
1282 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1285 * Find an item in canonical form (lowercase, no extra spaces) within
1286 * an HTTP field value list.
1287 * @param p The pool to allocate from
1288 * @param line The field value list to search
1289 * @param tok The token to search for
1290 * @return 1 if found, 0 if not found.
1292 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1295 * Retrieve a token, spacing over it and adjusting the pointer to
1296 * the first non-white byte afterwards. Note that these tokens
1297 * are delimited by semis and commas and can also be delimited
1298 * by whitespace at the caller's option.
1299 * @param p The pool to allocate from
1300 * @param accept_line The line to retrieve the token from (adjusted afterwards)
1301 * @param accept_white Is it delimited by whitespace
1304 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1307 * Find http tokens, see the definition of token from RFC2068
1308 * @param p The pool to allocate from
1309 * @param line The line to find the token
1310 * @param tok The token to find
1311 * @return 1 if the token is found, 0 otherwise
1313 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1316 * find http tokens from the end of the line
1317 * @param p The pool to allocate from
1318 * @param line The line to find the token
1319 * @param tok The token to find
1320 * @return 1 if the token is found, 0 otherwise
1322 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1325 * Check for an Absolute URI syntax
1326 * @param u The string to check
1327 * @return 1 if URI, 0 otherwise
1329 AP_DECLARE(int) ap_is_url(const char *u);
1333 * @param url The url to unescape
1334 * @return 0 on success, non-zero otherwise
1336 AP_DECLARE(int) ap_unescape_url(char *url);
1338 * Unescape a URL, but leaving %2f (slashes) escaped
1339 * @param url The url to unescape
1340 * @return 0 on success, non-zero otherwise
1342 AP_DECLARE(int) ap_unescape_url_keep2f(char *url);
1344 * Convert all double slashes to single slashes
1345 * @param name The string to convert
1347 AP_DECLARE(void) ap_no2slash(char *name);
1350 * Remove all ./ and xx/../ substrings from a file name. Also remove
1351 * any leading ../ or /../ substrings.
1352 * @param name the file name to parse
1354 AP_DECLARE(void) ap_getparents(char *name);
1357 * Escape a path segment, as defined in RFC 1808
1358 * @param p The pool to allocate from
1359 * @param s The path to convert
1360 * @return The converted URL
1362 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1364 * convert an OS path to a URL in an OS dependant way.
1365 * @param p The pool to allocate from
1366 * @param path The path to convert
1367 * @param partial if set, assume that the path will be appended to something
1368 * with a '/' in it (and thus does not prefix "./")
1369 * @return The converted URL
1371 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1372 /** @see ap_os_escape_path */
1373 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1376 * Escape an html string
1377 * @param p The pool to allocate from
1378 * @param s The html to escape
1379 * @return The escaped string
1381 AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
1384 * Escape a string for logging
1385 * @param p The pool to allocate from
1386 * @param str The string to escape
1387 * @return The escaped string
1389 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str);
1392 * Escape a string for logging into the error log (without a pool)
1393 * @param dest The buffer to write to
1394 * @param source The string to escape
1395 * @param buflen The buffer size for the escaped string (including \0)
1396 * @return The len of the escaped string (always < maxlen)
1398 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1402 * Construct a full hostname
1403 * @param p The pool to allocate from
1404 * @param hostname The hostname of the server
1405 * @param port The port the server is running on
1406 * @param r The current request
1407 * @return The server's hostname
1409 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1410 apr_port_t port, const request_rec *r);
1412 * Escape a shell command
1413 * @param p The pool to allocate from
1414 * @param s The command to escape
1415 * @return The escaped shell command
1417 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1420 * Count the number of directories in a path
1421 * @param path The path to count
1422 * @return The number of directories
1424 AP_DECLARE(int) ap_count_dirs(const char *path);
1427 * Copy at most @a n leading directories of @a s into @a d. @a d
1428 * should be at least as large as @a s plus 1 extra byte
1430 * @param d The location to copy to
1431 * @param s The location to copy from
1432 * @param n The number of directories to copy
1433 * @return value is the ever useful pointer to the trailing \0 of d
1434 * @note on platforms with drive letters, n = 0 returns the "/" root,
1435 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1436 * returns the empty string. */
1437 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1440 * Return the parent directory name (including trailing /) of the file
1442 * @param p The pool to allocate from
1443 * @param s The file to get the parent of
1444 * @return A copy of the file's parent directory
1446 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1449 * Given a directory and filename, create a single path from them. This
1450 * function is smart enough to ensure that there is a sinlge '/' between the
1451 * directory and file names
1452 * @param a The pool to allocate from
1453 * @param dir The directory name
1454 * @param f The filename
1455 * @return A copy of the full path
1456 * @tip Never consider using this function if you are dealing with filesystem
1457 * names that need to remain canonical, unless you are merging an apr_dir_read
1458 * path and returned filename. Otherwise, the result is not canonical.
1460 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1463 * Test if the given path has an an absolute path.
1464 * @param p The pool to allocate from
1465 * @param dir The directory name
1466 * @tip The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1467 * multiple forms of absolute paths. This only reports if the path is absolute
1468 * in a canonical sense.
1470 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1473 * Does the provided string contain wildcard characters? This is useful
1474 * for determining if the string should be passed to strcmp_match or to strcmp.
1475 * The only wildcard characters recognized are '?' and '*'
1476 * @param str The string to check
1477 * @return 1 if the string has wildcards, 0 otherwise
1479 AP_DECLARE(int) ap_is_matchexp(const char *str);
1482 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1483 * @param str The string to check
1484 * @param expected The pattern to match against
1485 * @return 1 if the two strings match, 0 otherwise
1487 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected);
1489 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1491 * @param str The string to check
1492 * @param expected The pattern to match against
1493 * @return 1 if the two strings match, 0 otherwise
1495 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected);
1498 * Find the first occurrence of the substring s2 in s1, regardless of case
1499 * @param s1 The string to search
1500 * @param s2 The substring to search for
1501 * @return A pointer to the beginning of the substring
1502 * @remark See apr_strmatch() for a faster alternative
1504 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1507 * Return a pointer to the location inside of bigstring immediately after prefix
1508 * @param bigstring The input string
1509 * @param prefix The prefix to strip away
1510 * @return A pointer relative to bigstring after prefix
1512 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1513 const char *prefix);
1516 * Decode a base64 encoded string into memory allocated from a pool
1517 * @param p The pool to allocate from
1518 * @param bufcoded The encoded string
1519 * @return The decoded string
1521 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1524 * Encode a string into memory allocated from a pool in base 64 format
1525 * @param p The pool to allocate from
1526 * @param strin The plaintext string
1527 * @return The encoded string
1529 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1533 * Compile a regular expression to be used later
1534 * @param p The pool to allocate from
1535 * @param pattern the regular expression to compile
1536 * @param cflags The bitwise or of one or more of the following:
1537 * @li #REG_EXTENDED - Use POSIX extended Regular Expressions
1538 * @li #REG_ICASE - Ignore case
1539 * @li #REG_NOSUB - Support for substring addressing of matches
1541 * @li #REG_NEWLINE - Match-any-character operators don't match new-line
1542 * @return The compiled regular expression
1544 AP_DECLARE(regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1548 * Free the memory associated with a compiled regular expression
1549 * @param p The pool the regex was allocated from
1550 * @param reg The regular expression to free
1552 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, regex_t *reg);
1555 * Match a null-terminated string against a pre-compiled regex.
1556 * @param preg The pre-compiled regex
1557 * @param string The string to match
1558 * @param nmatch Provide information regarding the location of any matches
1559 * @param pmatch Provide information regarding the location of any matches
1560 * @param eflags Bitwise or of any of:
1561 * @li #REG_NOTBOL - match-beginning-of-line operator always
1563 * @li #REG_NOTEOL - match-end-of-line operator always fails to match
1564 * @return 0 for successful match, #REG_NOMATCH otherwise
1566 AP_DECLARE(int) ap_regexec(regex_t *preg, const char *string,
1567 size_t nmatch, regmatch_t pmatch[], int eflags);
1570 * Return the error code returned by regcomp or regexec into error messages
1571 * @param errcode the error code returned by regexec or regcomp
1572 * @param preg The precompiled regex
1573 * @param errbuf A buffer to store the error in
1574 * @param errbuf_size The size of the buffer
1576 AP_DECLARE(size_t) ap_regerror(int errcode, const regex_t *preg,
1577 char *errbuf, size_t errbuf_size);
1580 * After performing a successful regex match, you may use this function to
1581 * perform a series of string substitutions based on subexpressions that were
1582 * matched during the call to ap_regexec
1583 * @param p The pool to allocate from
1584 * @param input An arbitrary string containing $1 through $9. These are
1585 * replaced with the corresponding matched sub-expressions
1586 * @param source The string that was originally matched to the regex
1587 * @param nmatch the nmatch returned from ap_pregex
1588 * @param pmatch the pmatch array returned from ap_pregex
1590 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1591 size_t nmatch, regmatch_t pmatch[]);
1594 * We want to downcase the type/subtype for comparison purposes
1595 * but nothing else because ;parameter=foo values are case sensitive.
1596 * @param s The content-type to convert to lowercase
1598 AP_DECLARE(void) ap_content_type_tolower(char *s);
1601 * convert a string to all lowercase
1602 * @param s The string to convert to lowercase
1604 AP_DECLARE(void) ap_str_tolower(char *s);
1607 * Search a string from left to right for the first occurrence of a
1608 * specific character
1609 * @param str The string to search
1610 * @param c The character to search for
1611 * @return The index of the first occurrence of c in str
1613 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1616 * Search a string from right to left for the first occurrence of a
1617 * specific character
1618 * @param str The string to search
1619 * @param c The character to search for
1620 * @return The index of the first occurrence of c in str
1622 AP_DECLARE(int) ap_rind(const char *str, char c);
1625 * Given a string, replace any bare " with \" .
1626 * @param p The pool to allocate memory from
1627 * @param instring The string to search for "
1628 * @return A copy of the string with escaped quotes
1630 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1632 /* Misc system hackery */
1634 * Given the name of an object in the file system determine if it is a directory
1635 * @param p The pool to allocate from
1636 * @param name The name of the object to check
1637 * @return 1 if it is a directory, 0 otherwise
1639 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1642 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1643 * @param p The pool to allocate from
1644 * @param name The name of the object to check
1645 * @return 1 if it is a directory, 0 otherwise
1647 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1650 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1651 #endif /* _OSD_POSIX */
1654 * Determine the local host name for the current machine
1655 * @param p The pool to allocate from
1656 * @return A copy of the local host name
1658 char *ap_get_local_host(apr_pool_t *p);
1661 * Log an assertion to the error log
1662 * @param szExp The assertion that failed
1663 * @param szFile The file the assertion is in
1664 * @param nLine The line the assertion is defined on
1666 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1667 __attribute__((noreturn));
1670 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1673 * Redefine assert() to something more useful for an Apache...
1675 * Use ap_assert() if the condition should always be checked.
1676 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1681 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1683 #define AP_DEBUG_ASSERT(exp) ((void)0)
1687 * @defgroup stopsignal flags which indicate places where the sever should stop for debugging.
1689 * A set of flags which indicate places where the server should raise(SIGSTOP).
1690 * This is useful for debugging, because you can then attach to that process
1691 * with gdb and continue. This is important in cases where one_process
1692 * debugging isn't possible.
1694 /** stop on a Detach */
1695 #define SIGSTOP_DETACH 1
1696 /** stop making a child process */
1697 #define SIGSTOP_MAKE_CHILD 2
1698 /** stop spawning a child process */
1699 #define SIGSTOP_SPAWN_CHILD 4
1700 /** stop spawning a child process with a piped log */
1701 #define SIGSTOP_PIPED_LOG_SPAWN 8
1702 /** stop spawning a CGI child process */
1703 #define SIGSTOP_CGI_CHILD 16
1705 /** Macro to get GDB started */
1706 #ifdef DEBUG_SIGSTOP
1707 extern int raise_sigstop_flags;
1708 #define RAISE_SIGSTOP(x) do { \
1709 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1712 #define RAISE_SIGSTOP(x)
1716 * Get HTML describing the address and (optionally) admin of the server.
1717 * @param prefix Text which is prepended to the return value
1718 * @param r The request_rec
1719 * @return HTML describing the server, allocated in @a r's pool.
1721 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1723 /** strtoul does not exist on sunos4. */
1727 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1729 /* The C library has functions that allow const to be silently dropped ...
1730 these macros detect the drop in maintainer mode, but use the native
1731 methods for normal builds
1733 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1734 to be included before the macros are defined or compilation will fail.
1738 AP_DECLARE(char *) ap_strchr(char *s, int c);
1739 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
1740 AP_DECLARE(char *) ap_strrchr(char *s, int c);
1741 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
1742 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
1743 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
1748 # define strchr(s, c) ap_strchr(s,c)
1750 # define strrchr(s, c) ap_strrchr(s,c)
1752 # define strstr(s, c) ap_strstr(s,c)
1756 /** use this instead of strchr */
1757 # define ap_strchr(s, c) strchr(s, c)
1758 /** use this instead of strchr */
1759 # define ap_strchr_c(s, c) strchr(s, c)
1760 /** use this instead of strrchr */
1761 # define ap_strrchr(s, c) strrchr(s, c)
1762 /** use this instead of strrchr */
1763 # define ap_strrchr_c(s, c) strrchr(s, c)
1764 /** use this instead of strrstr*/
1765 # define ap_strstr(s, c) strstr(s, c)
1766 /** use this instead of strrstr*/
1767 # define ap_strstr_c(s, c) strstr(s, c)
1771 #define AP_NORESTART APR_OS_START_USEERR + 1
1777 #endif /* !APACHE_HTTPD_H */