1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * ====================================================================
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
59 #ifndef APACHE_HTTPD_H
60 #define APACHE_HTTPD_H
64 * @brief HTTP Daemon routines
67 /* XXX - We need to push more stuff to other .h files, or even .c files, to
68 * make this file smaller
71 /* Headers in which EVERYONE has an interest... */
72 #include "ap_config.h"
75 #include "ap_release.h"
77 #include "apr_general.h"
78 #include "apr_tables.h"
79 #include "apr_pools.h"
81 #include "apr_network_io.h"
82 #include "apr_buckets.h"
86 #include "pcreposix.h"
88 /* Note: util_uri.h is also included, see below */
96 /* ----------------------------- config dir ------------------------------ */
98 /* Define this to be the default server home dir. Most things later in this
99 * file with a relative pathname will have this added.
103 /* Set default for OS/2 file system */
104 #define HTTPD_ROOT "/os2httpd"
106 /* Set default for Windows file system */
107 #define HTTPD_ROOT "/apache"
109 /* Set the default for BeOS */
110 #define HTTPD_ROOT "/boot/home/apache"
111 #elif defined (NETWARE)
112 /* Set the default for NetWare */
113 #define HTTPD_ROOT "/apache"
115 #define HTTPD_ROOT "/usr/local/apache"
117 #endif /* HTTPD_ROOT */
120 * --------- You shouldn't have to edit anything below this line ----------
122 * Any modifications to any defaults not defined above should be done in the
123 * respective configuration file.
127 /* Default location of documents. Can be overridden by the DocumentRoot
130 #ifndef DOCUMENT_LOCATION
132 /* Set default for OS/2 file system */
133 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
135 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
137 #endif /* DOCUMENT_LOCATION */
139 /* Maximum number of dynamically loaded modules */
140 #ifndef DYNAMIC_MODULE_LIMIT
141 #define DYNAMIC_MODULE_LIMIT 64
144 /* Default administrator's address */
145 #define DEFAULT_ADMIN "[no address given]"
147 /* The name of the log files */
148 #ifndef DEFAULT_ERRORLOG
149 #if defined(OS2) || defined(WIN32)
150 #define DEFAULT_ERRORLOG "logs/error.log"
152 #define DEFAULT_ERRORLOG "logs/error_log"
154 #endif /* DEFAULT_ERRORLOG */
156 /* Define this to be what your per-directory security files are called */
157 #ifndef DEFAULT_ACCESS_FNAME
159 /* Set default for OS/2 file system */
160 #define DEFAULT_ACCESS_FNAME "htaccess"
162 #define DEFAULT_ACCESS_FNAME ".htaccess"
164 #endif /* DEFAULT_ACCESS_FNAME */
166 /* The name of the server config file */
167 #ifndef SERVER_CONFIG_FILE
168 #define SERVER_CONFIG_FILE "conf/httpd.conf"
171 /* The default path for CGI scripts if none is currently set */
173 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
176 /* The path to the suExec wrapper, can be overridden in Configuration */
178 #define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
181 /* The timeout for waiting for messages */
182 #ifndef DEFAULT_TIMEOUT
183 #define DEFAULT_TIMEOUT 300
186 /* The timeout for waiting for keepalive timeout until next request */
187 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
188 #define DEFAULT_KEEPALIVE_TIMEOUT 15
191 /* The number of requests to entertain per connection */
192 #ifndef DEFAULT_KEEPALIVE
193 #define DEFAULT_KEEPALIVE 100
196 /* Limits on the size of various request items. These limits primarily
197 * exist to prevent simple denial-of-service attacks on a server based
198 * on misuse of the protocol. The recommended values will depend on the
199 * nature of the server resources -- CGI scripts and database backends
200 * might require large values, but most servers could get by with much
201 * smaller limits than we use below. The request message body size can
202 * be limited by the per-dir config directive LimitRequestBody.
204 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
205 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
206 * These two limits can be lowered (but not raised) by the server config
207 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
209 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
210 * the server config directive LimitRequestFields.
212 #ifndef DEFAULT_LIMIT_REQUEST_LINE
213 #define DEFAULT_LIMIT_REQUEST_LINE 8190
214 #endif /* default limit on bytes in Request-Line (Method+URI+HTTP-version) */
215 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
216 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
217 #endif /* default limit on bytes in any one header field */
218 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
219 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
220 #endif /* default limit on number of request header fields */
224 * The default default character set name to add if AddDefaultCharset is
225 * enabled. Overridden with AddDefaultCharsetName.
227 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
229 #endif /* CORE_PRIVATE */
231 /** default HTTP Server protocol */
232 #define AP_SERVER_PROTOCOL "HTTP/1.1"
235 /* ------------------ stuff that modules are allowed to look at ----------- */
237 /** Define this to be what your HTML directory content files are called */
238 #ifndef AP_DEFAULT_INDEX
239 #define AP_DEFAULT_INDEX "index.html"
244 * Define this to be what type you'd like returned for files with unknown
246 * @warning MUST be all lower case.
248 #ifndef DEFAULT_CONTENT_TYPE
249 #define DEFAULT_CONTENT_TYPE "text/plain"
252 /** The name of the MIME types file */
253 #ifndef AP_TYPES_CONFIG_FILE
254 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
258 * Define the HTML doctype strings centrally.
260 /** HTML 2.0 Doctype */
261 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
262 "DTD HTML 2.0//EN\">\n"
263 /** HTML 3.2 Doctype */
264 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
265 "DTD HTML 3.2 Final//EN\">\n"
266 /** HTML 4.0 Strict Doctype */
267 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
268 "DTD HTML 4.0//EN\"\n" \
269 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
270 /** HTML 4.0 Transitional Doctype */
271 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
272 "DTD HTML 4.0 Transitional//EN\"\n" \
273 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
274 /** HTML 4.0 Frameset Doctype */
275 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
276 "DTD HTML 4.0 Frameset//EN\"\n" \
277 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
279 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
281 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
282 /** Major part of HTTP protocol */
283 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
284 /** Minor part of HTTP protocol */
285 #define HTTP_VERSION_MINOR(number) ((number)%1000)
287 /* -------------- Port number for server running standalone --------------- */
289 /** default HTTP Port */
290 #define DEFAULT_HTTP_PORT 80
291 /** default HTTPS Port */
292 #define DEFAULT_HTTPS_PORT 443
294 * Check whether @a port is the default port for the request @a r.
295 * @param port The port number
296 * @param r The request
297 * @see #ap_default_port
299 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
301 * Get the default port for a request (which depends on the scheme).
302 * @param r The request
304 #define ap_default_port(r) ap_run_default_port(r)
306 * Get the scheme for a request.
307 * @param r The request
308 * @bug This should be called ap_http_scheme!
310 #define ap_http_method(r) ap_run_http_method(r)
312 /** The default string lengths */
313 #define MAX_STRING_LEN HUGE_STRING_LEN
314 #define HUGE_STRING_LEN 8192
316 /** The size of the server's internal read-write buffers */
317 #define AP_IOBUFSIZE 8192
320 * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
321 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
322 * than that in case the brigade code/filters attempt to read it directly.
323 * ### 16mb is an invention, no idea if it is reasonable.
325 #define AP_MAX_SENDFILE 16777216 /* 2^24 */
328 * Special Apache error codes. These are basically used
329 * in http_main.c so we can keep track of various errors.
333 #define APEXIT_OK 0x0
334 /** A fatal error arising during the server's init sequence */
335 #define APEXIT_INIT 0x2
336 /** The child died during its init sequence */
337 #define APEXIT_CHILDINIT 0x3
339 * The child exited due to a resource shortage.
340 * The parent should limit the rate of forking until
341 * the situation is resolved.
343 #define APEXIT_CHILDSICK 0x7
345 * A fatal error, resulting in the whole server aborting.
346 * If a child exits with this error, the parent process
347 * considers this a server-wide fatal error and aborts.
349 #define APEXIT_CHILDFATAL 0xf
353 * Stuff marked #AP_DECLARE is part of the API, and intended for use
354 * by modules. Its purpose is to allow us to add attributes that
355 * particular platforms or compilers require to every exported function.
357 # define AP_DECLARE(type) type
360 #ifndef AP_DECLARE_NONSTD
362 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
363 * use by modules. The difference between #AP_DECLARE and
364 * #AP_DECLARE_NONSTD is that the latter is required for any functions
365 * which use varargs or are used via indirect function call. This
366 * is to accomodate the two calling conventions in windows dlls.
368 # define AP_DECLARE_NONSTD(type) type
370 #ifndef AP_DECLARE_DATA
371 # define AP_DECLARE_DATA
374 #ifndef AP_MODULE_DECLARE
375 # define AP_MODULE_DECLARE(type) type
377 #ifndef AP_MODULE_DECLARE_NONSTD
378 # define AP_MODULE_DECLARE_NONSTD(type) type
380 #ifndef AP_MODULE_DECLARE_DATA
381 # define AP_MODULE_DECLARE_DATA
386 * modules should not used functions marked AP_CORE_DECLARE
388 #ifndef AP_CORE_DECLARE
389 # define AP_CORE_DECLARE AP_DECLARE
393 * modules should not used functions marked AP_CORE_DECLARE_NONSTD
396 #ifndef AP_CORE_DECLARE_NONSTD
397 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
401 * Get the server version string
402 * @return The server version string
404 AP_DECLARE(const char *) ap_get_server_version(void);
407 * Add a component to the version string
408 * @param pconf The pool to allocate the component from
409 * @param component The string to add
411 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
414 * Get the date a time that the server was built
415 * @return The server build time string
417 AP_DECLARE(const char *) ap_get_server_built(void);
419 #define DECLINED -1 /**< Module declines to handle */
420 #define DONE -2 /**< Module has served the response completely
421 * - it's safe to die() with no more output
423 #define OK 0 /**< Module has handled this stage. */
427 * @defgroup HTTP_Status HTTP Status Codes
431 * The size of the static array in http_protocol.c for storing
432 * all of the potential response status-lines (a sparse table).
433 * A future version should dynamically generate the apr_table_t at startup.
435 #define RESPONSE_CODES 57
437 #define HTTP_CONTINUE 100
438 #define HTTP_SWITCHING_PROTOCOLS 101
439 #define HTTP_PROCESSING 102
441 #define HTTP_CREATED 201
442 #define HTTP_ACCEPTED 202
443 #define HTTP_NON_AUTHORITATIVE 203
444 #define HTTP_NO_CONTENT 204
445 #define HTTP_RESET_CONTENT 205
446 #define HTTP_PARTIAL_CONTENT 206
447 #define HTTP_MULTI_STATUS 207
448 #define HTTP_MULTIPLE_CHOICES 300
449 #define HTTP_MOVED_PERMANENTLY 301
450 #define HTTP_MOVED_TEMPORARILY 302
451 #define HTTP_SEE_OTHER 303
452 #define HTTP_NOT_MODIFIED 304
453 #define HTTP_USE_PROXY 305
454 #define HTTP_TEMPORARY_REDIRECT 307
455 #define HTTP_BAD_REQUEST 400
456 #define HTTP_UNAUTHORIZED 401
457 #define HTTP_PAYMENT_REQUIRED 402
458 #define HTTP_FORBIDDEN 403
459 #define HTTP_NOT_FOUND 404
460 #define HTTP_METHOD_NOT_ALLOWED 405
461 #define HTTP_NOT_ACCEPTABLE 406
462 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
463 #define HTTP_REQUEST_TIME_OUT 408
464 #define HTTP_CONFLICT 409
465 #define HTTP_GONE 410
466 #define HTTP_LENGTH_REQUIRED 411
467 #define HTTP_PRECONDITION_FAILED 412
468 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
469 #define HTTP_REQUEST_URI_TOO_LARGE 414
470 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
471 #define HTTP_RANGE_NOT_SATISFIABLE 416
472 #define HTTP_EXPECTATION_FAILED 417
473 #define HTTP_UNPROCESSABLE_ENTITY 422
474 #define HTTP_LOCKED 423
475 #define HTTP_FAILED_DEPENDENCY 424
476 #define HTTP_UPGRADE_REQUIRED 426
477 #define HTTP_INTERNAL_SERVER_ERROR 500
478 #define HTTP_NOT_IMPLEMENTED 501
479 #define HTTP_BAD_GATEWAY 502
480 #define HTTP_SERVICE_UNAVAILABLE 503
481 #define HTTP_GATEWAY_TIME_OUT 504
482 #define HTTP_VERSION_NOT_SUPPORTED 505
483 #define HTTP_VARIANT_ALSO_VARIES 506
484 #define HTTP_INSUFFICIENT_STORAGE 507
485 #define HTTP_NOT_EXTENDED 510
487 /** is the status code informational */
488 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
489 /** is the status code OK ?*/
490 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
491 /** is the status code a redirect */
492 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
493 /** is the status code a error (client or server) */
494 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
495 /** is the status code a client error */
496 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
497 /** is the status code a server error */
498 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
500 /** should the status code drop the connection */
501 #define ap_status_drops_connection(x) \
502 (((x) == HTTP_BAD_REQUEST) || \
503 ((x) == HTTP_REQUEST_TIME_OUT) || \
504 ((x) == HTTP_LENGTH_REQUIRED) || \
505 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
506 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
507 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
508 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
509 ((x) == HTTP_NOT_IMPLEMENTED))
512 * @defgroup Methods List of Methods recognized by the server
516 * Methods recognized (but not necessarily handled) by the server.
517 * These constants are used in bit shifting masks of size int, so it is
518 * unsafe to have more methods than bits in an int. HEAD == M_GET.
519 * This list must be tracked by the list in http_protocol.c in routine
520 * ap_method_name_of().
522 #define M_GET 0 /* RFC 2616: HTTP */
523 #define M_PUT 1 /* : */
528 #define M_TRACE 6 /* RFC 2616: HTTP */
529 #define M_PATCH 7 /* no rfc(!) ### remove this one? */
530 #define M_PROPFIND 8 /* RFC 2518: WebDAV */
531 #define M_PROPPATCH 9 /* : */
536 #define M_UNLOCK 14 /* RFC 2518: WebDAV */
537 #define M_VERSION_CONTROL 15 /* RFC 3253: WebDAV Versioning */
538 #define M_CHECKOUT 16 /* : */
539 #define M_UNCHECKOUT 17
544 #define M_MKWORKSPACE 22
545 #define M_MKACTIVITY 23
546 #define M_BASELINE_CONTROL 24
548 #define M_INVALID 26 /* RFC 3253: WebDAV Versioning */
551 * METHODS needs to be equal to the number of bits
552 * we are using for limit masks.
557 * The method mask bit to shift for anding with a bitmask.
559 #define AP_METHOD_BIT ((apr_int64_t)1)
564 * Structure for handling HTTP methods. Methods known to the server are
565 * accessed via a bitmask shortcut; extension methods are handled by
568 typedef struct ap_method_list_t ap_method_list_t;
569 struct ap_method_list_t {
570 /* The bitmask used for known methods */
571 apr_int64_t method_mask;
572 /* the array used for extension methods */
573 apr_array_header_t *method_list;
576 * @defgroup module_magic Module Magic mime types
579 /** Magic for mod_cgi[d] */
580 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
581 /** Magic for mod_include */
582 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
583 /** Magic for mod_include */
584 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
585 /** Magic for mod_dir */
586 #define DIR_MAGIC_TYPE "httpd/unix-directory"
589 /* Just in case your linefeed isn't the one the other end is expecting. */
590 #if !APR_CHARSET_EBCDIC
593 /** carrige return */
595 /** carrige return /Line Feed Combo */
596 #define CRLF "\015\012"
597 #else /* APR_CHARSET_EBCDIC */
598 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
599 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
600 * "native EBCDIC" CR and NL characters. These are therefore
607 #endif /* APR_CHARSET_EBCDIC */
610 * @defgroup values_request_rec_body Possible values for request_rec.read_body
612 * Possible values for request_rec.read_body (set by handling module):
615 /** Send 413 error if message has any body */
616 #define REQUEST_NO_BODY 0
617 /** Send 411 error if body without Content-Length */
618 #define REQUEST_CHUNKED_ERROR 1
619 /** If chunked, remove the chunks for me. */
620 #define REQUEST_CHUNKED_DECHUNK 2
624 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
626 * Possible values for request_rec.used_path_info:
629 /** Accept the path_info from the request */
630 #define AP_REQ_ACCEPT_PATH_INFO 0
631 /** Return a 404 error if path_info was given */
632 #define AP_REQ_REJECT_PATH_INFO 1
633 /** Module may chose to use the given path_info */
634 #define AP_REQ_DEFAULT_PATH_INFO 2
638 * Things which may vary per file-lookup WITHIN a request ---
639 * e.g., state of MIME config. Basically, the name of an object, info
640 * about the object, and any other info we may ahve which may need to
641 * change as we go poking around looking for it (e.g., overridden by
644 * Note how the default state of almost all these things is properly
645 * zero, so that allocating it with pcalloc does the right thing without
646 * a whole lot of hairy initialization... so long as we are willing to
647 * make the (fairly) portable assumption that the bit pattern of a NULL
648 * pointer is, in fact, zero.
652 * This represents the result of calling htaccess; these are cached for
655 struct htaccess_result {
656 /** the directory to which this applies */
658 /** the overrides allowed for the .htaccess file */
660 /** the configuration directives */
661 struct ap_conf_vector_t *htaccess;
662 /** the next one, or NULL if no more; N.B. never change this */
663 const struct htaccess_result *next;
666 /* The following four types define a hierarchy of activities, so that
667 * given a request_rec r you can write r->connection->server->process
668 * to get to the process_rec. While this reduces substantially the
669 * number of arguments that various hooks require beware that in
670 * threaded versions of the server you must consider multiplexing
674 /** A structure that represents one process */
675 typedef struct process_rec process_rec;
676 /** A structure that represents a virtual server */
677 typedef struct server_rec server_rec;
678 /** A structure that represents one connection */
679 typedef struct conn_rec conn_rec;
680 /** A structure that represents the current request */
681 typedef struct request_rec request_rec;
683 /* ### would be nice to not include this from httpd.h ... */
684 /* This comes after we have defined the request_rec type */
687 /** A structure that represents one process */
689 /** Global pool. Cleared upon normal exit */
691 /** Configuration pool. Cleared upon restart */
693 /** Number of command line arguments passed to the program */
695 /** The command line arguments */
696 const char * const *argv;
697 /** The program name used to execute the program */
698 const char *short_name;
701 /** A structure that represents the current request */
703 /** The pool associated with the request */
705 /** The connection to the client */
706 conn_rec *connection;
707 /** The virtual host for this request */
710 /** Pointer to the redirected request if this is an external redirect */
712 /** Pointer to the previous request if this is an internal redirect */
715 /** Pointer to the main request if this is a sub-request (see 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 /** 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 struct ap_filter_t *output_filters;
914 /** A list of input filters to be used for this request */
915 struct ap_filter_t *input_filters;
917 /** A list of protocol level output filters to be used for this
919 struct ap_filter_t *proto_output_filters;
920 /** A list of protocol level input filters to be used for this
922 struct 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 /** Notes on *this* connection */
1004 struct ap_conf_vector_t *conn_config;
1005 /** send note from one module to another, must remain valid for all
1006 * requests on this conn */
1008 /** A list of input filters to be used for this connection */
1009 struct ap_filter_t *input_filters;
1010 /** A list of output filters to be used for this connection */
1011 struct ap_filter_t *output_filters;
1012 /** handle to scoreboard information for this connection */
1014 /** The bucket allocator to use for all bucket/brigade creations */
1015 struct apr_bucket_alloc_t *bucket_alloc;
1018 /* Per-vhost config... */
1021 * The address 255.255.255.255, when used as a virtualhost address,
1022 * will become the "default" server when the ip doesn't match other vhosts.
1024 #define DEFAULT_VHOST_ADDR 0xfffffffful
1027 /** A structure to be used for Per-vhost config */
1028 typedef struct server_addr_rec server_addr_rec;
1029 struct server_addr_rec {
1030 /** The next server in the list */
1031 server_addr_rec *next;
1032 /** The bound address, for this server */
1033 apr_sockaddr_t *host_addr;
1034 /** The bound port, for this server */
1035 apr_port_t host_port;
1036 /** The name given in <VirtualHost> */
1040 /** A structure to store information for each virtual server */
1042 /** The process this server is running in */
1043 process_rec *process;
1044 /** The next server in the list */
1047 /** The name of the server */
1048 const char *defn_name;
1049 /** The line of the config file that the server was defined on */
1050 unsigned defn_line_number;
1052 /* Contact information */
1054 /** The admin's contact information */
1056 /** The server hostname */
1057 char *server_hostname;
1058 /** for redirects, etc. */
1061 /* Log files --- note that transfer log is now in the modules... */
1063 /** The name of the error log */
1065 /** A file descriptor that references the error log */
1066 apr_file_t *error_log;
1067 /** The log level for this server */
1070 /* Module-specific configuration for server, and defaults... */
1072 /** true if this is the virtual server */
1074 /** Config vector containing pointers to modules' per-server config
1076 struct ap_conf_vector_t *module_config;
1077 /** MIME type info, etc., before we start checking per-directory info */
1078 struct ap_conf_vector_t *lookup_defaults;
1080 /* Transaction handling */
1082 /** I haven't got a clue */
1083 server_addr_rec *addrs;
1084 /** Timeout, as an apr interval, before we give up */
1085 apr_interval_time_t timeout;
1086 /** The apr interval we will wait for another request */
1087 apr_interval_time_t keep_alive_timeout;
1088 /** Maximum requests per connection */
1090 /** Use persistent connections? */
1093 /** Pathname for ServerPath */
1095 /** Length of path */
1098 /** Normal names for ServerAlias servers */
1099 apr_array_header_t *names;
1100 /** Wildcarded names for ServerAlias servers */
1101 apr_array_header_t *wild_names;
1103 /** limit on size of the HTTP request line */
1105 /** limit on size of any request header field */
1106 int limit_req_fieldsize;
1107 /** limit on number of request header fields */
1108 int limit_req_fields;
1111 typedef struct core_output_filter_ctx {
1112 apr_bucket_brigade *b;
1113 apr_pool_t *deferred_write_pool; /* subpool of c->pool used for resources
1114 * which may outlive the request
1116 } core_output_filter_ctx_t;
1118 typedef struct core_filter_ctx {
1119 apr_bucket_brigade *b;
1122 typedef struct core_net_rec {
1123 /** Connection to the client */
1124 apr_socket_t *client_socket;
1126 /** connection record */
1129 core_output_filter_ctx_t *out_ctx;
1134 * Examine a field value (such as a media-/content-type) string and return
1135 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1136 * @param p Pool to allocate memory from
1137 * @param intype The field to examine
1138 * @return A copy of the field minus any parameters
1140 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1143 * Convert a time from an integer into a string in a specified format
1144 * @param p The pool to allocate memory from
1145 * @param t The time to convert
1146 * @param fmt The format to use for the conversion
1147 * @param gmt Convert the time for GMT?
1148 * @return The string that represents the specified time
1150 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1152 /* String handling. The *_nc variants allow you to use non-const char **s as
1153 arguments (unfortunately C won't automatically convert a char ** to a const
1157 * Get the characters until the first occurance of a specified character
1158 * @param p The pool to allocate memory from
1159 * @param line The string to get the characters from
1160 * @param stop The character to stop at
1161 * @return A copy of the characters up to the first stop character
1163 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1165 * Get the characters until the first occurance of a specified character
1166 * @param p The pool to allocate memory from
1167 * @param line The string to get the characters from
1168 * @param stop The character to stop at
1169 * @return A copy of the characters up to the first stop character
1170 * @note This is the same as ap_getword(), except it doesn't use const char **.
1172 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1175 * Get the first word from a given string. A word is defined as all characters
1176 * up to the first whitespace.
1177 * @param p The pool to allocate memory from
1178 * @param line The string to traverse
1179 * @return The first word in the line
1181 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1183 * Get the first word from a given string. A word is defined as all characters
1184 * up to the first whitespace.
1185 * @param p The pool to allocate memory from
1186 * @param line The string to traverse
1187 * @return The first word in the line
1188 * @note The same as ap_getword_white(), except it doesn't use const char **.
1190 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1193 * Get all characters from the first occurance of @a stop to the first '\0'
1194 * @param p The pool to allocate memory from
1195 * @param line The line to traverse
1196 * @param stop The character to start at
1197 * @return A copy of all caracters after the first occurance of the specified
1200 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1203 * Get all characters from the first occurance of @a stop to the first '\0'
1204 * @param p The pool to allocate memory from
1205 * @param line The line to traverse
1206 * @param stop The character to start at
1207 * @return A copy of all caracters after the first occurance of the specified
1209 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1211 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1214 * Get the second word in the string paying attention to quoting
1215 * @param p The pool to allocate from
1216 * @param line The line to traverse
1217 * @return A copy of the string
1219 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1221 * Get the second word in the string paying attention to quoting
1222 * @param p The pool to allocate from
1223 * @param line The line to traverse
1224 * @return A copy of the string
1225 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1227 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1230 * Check a string for any ${ENV} environment variable construct and replace
1231 * each them by the value of that environment variable, if it exists. If the
1232 * environment value does not exist, leave the ${ENV} construct alone; it
1233 * means something else.
1234 * @param p The pool to allocate from
1235 * @param word The string to check
1236 * @return The string with the replaced environment variables
1238 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1241 * Size an HTTP header field list item, as separated by a comma.
1242 * @param field The field to size
1243 * @param len The length of the field
1244 * @return The return value is a pointer to the beginning of the non-empty
1245 * list item within the original string (or NULL if there is none) and the
1246 * address of field is shifted to the next non-comma, non-whitespace
1247 * character. len is the length of the item excluding any beginning whitespace.
1249 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1252 * Retrieve an HTTP header field list item, as separated by a comma,
1253 * while stripping insignificant whitespace and lowercasing anything not in
1254 * a quoted string or comment.
1255 * @param p The pool to allocate from
1256 * @param field The field to retrieve
1257 * @return The return value is a new string containing the converted list
1258 * item (or NULL if none) and the address pointed to by field is
1259 * shifted to the next non-comma, non-whitespace.
1261 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1264 * Find an item in canonical form (lowercase, no extra spaces) within
1265 * an HTTP field value list.
1266 * @param p The pool to allocate from
1267 * @param line The field value list to search
1268 * @param tok The token to search for
1269 * @return 1 if found, 0 if not found.
1271 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1274 * Retrieve a token, spacing over it and returning a pointer to
1275 * the first non-white byte afterwards. Note that these tokens
1276 * are delimited by semis and commas and can also be delimited
1277 * by whitespace at the caller's option.
1278 * @param p The pool to allocate from
1279 * @param accept_line The line to retrieve the token from
1280 * @param accept_white Is it delimited by whitespace
1281 * @return the first non-white byte after the token
1283 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1286 * Find http tokens, see the definition of token from RFC2068
1287 * @param p The pool to allocate from
1288 * @param line The line to find the token
1289 * @param tok The token to find
1290 * @return 1 if the token is found, 0 otherwise
1292 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1295 * find http tokens from the end of the line
1296 * @param p The pool to allocate from
1297 * @param line The line to find the token
1298 * @param tok The token to find
1299 * @return 1 if the token is found, 0 otherwise
1301 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1304 * Check for an Absolute URI syntax
1305 * @param u The string to check
1306 * @return 1 if URI, 0 otherwise
1308 AP_DECLARE(int) ap_is_url(const char *u);
1312 * @param url The url to unescape
1313 * @return 0 on success, non-zero otherwise
1315 AP_DECLARE(int) ap_unescape_url(char *url);
1317 * Unescape a URL, but leaving %2f (slashes) escaped
1318 * @param url The url to unescape
1319 * @return 0 on success, non-zero otherwise
1321 AP_DECLARE(int) ap_unescape_url_keep2f(char *url);
1323 * Convert all double slashes to single slashes
1324 * @param name The string to convert
1326 AP_DECLARE(void) ap_no2slash(char *name);
1329 * Remove all ./ and xx/../ substrings from a file name. Also remove
1330 * any leading ../ or /../ substrings.
1331 * @param name the file name to parse
1333 AP_DECLARE(void) ap_getparents(char *name);
1336 * Escape a path segment, as defined in RFC 1808
1337 * @param p The pool to allocate from
1338 * @param s The path to convert
1339 * @return The converted URL
1341 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1343 * convert an OS path to a URL in an OS dependant way.
1344 * @param p The pool to allocate from
1345 * @param path The path to convert
1346 * @param partial if set, assume that the path will be appended to something
1347 * with a '/' in it (and thus does not prefix "./")
1348 * @return The converted URL
1350 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1351 /** @see ap_os_escape_path */
1352 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1355 * Escape an html string
1356 * @param p The pool to allocate from
1357 * @param s The html to escape
1358 * @return The escaped string
1360 AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
1363 * Construct a full hostname
1364 * @param p The pool to allocate from
1365 * @param hostname The hostname of the server
1366 * @param port The port the server is running on
1367 * @param r The current request
1368 * @return The server's hostname
1370 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1371 apr_port_t port, const request_rec *r);
1373 * Escape a shell command
1374 * @param p The pool to allocate from
1375 * @param s The command to escape
1376 * @return The escaped shell command
1378 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1381 * Count the number of directories in a path
1382 * @param path The path to count
1383 * @return The number of directories
1385 AP_DECLARE(int) ap_count_dirs(const char *path);
1388 * Copy at most @a n leading directories of @a s into @a d. @a d
1389 * should be at least as large as @a s plus 1 extra byte
1391 * @param d The location to copy to
1392 * @param s The location to copy from
1393 * @param n The number of directories to copy
1394 * @return value is the ever useful pointer to the trailing \0 of d
1395 * @note on platforms with drive letters, n = 0 returns the "/" root,
1396 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1397 * returns the empty string. */
1398 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1401 * Return the parent directory name (including trailing /) of the file
1403 * @param p The pool to allocate from
1404 * @param s The file to get the parent of
1405 * @return A copy of the file's parent directory
1407 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1410 * Given a directory and filename, create a single path from them. This
1411 * function is smart enough to ensure that there is a sinlge '/' between the
1412 * directory and file names
1413 * @param a The pool to allocate from
1414 * @param dir The directory name
1415 * @param f The filename
1416 * @return A copy of the full path
1417 * @tip Never consider using this function if you are dealing with filesystem
1418 * names that need to remain canonical, unless you are merging an apr_dir_read
1419 * path and returned filename. Otherwise, the result is not canonical.
1421 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1424 * Test if the given path has an an absolute path.
1425 * @param p The pool to allocate from
1426 * @param dir The directory name
1427 * @tip The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1428 * multiple forms of absolute paths. This only reports if the path is absolute
1429 * in a canonical sense.
1431 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1434 * Does the provided string contain wildcard characters? This is useful
1435 * for determining if the string should be passed to strcmp_match or to strcmp.
1436 * The only wildcard characters recognized are '?' and '*'
1437 * @param str The string to check
1438 * @return 1 if the string has wildcards, 0 otherwise
1440 AP_DECLARE(int) ap_is_matchexp(const char *str);
1443 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1444 * @param str The string to check
1445 * @param exp The pattern to match against
1446 * @return 1 if the two strings match, 0 otherwise
1448 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *exp);
1450 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1452 * @param str The string to check
1453 * @param exp The pattern to match against
1454 * @return 1 if the two strings match, 0 otherwise
1456 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *exp);
1459 * Find the first occurrence of the substring s2 in s1, regardless of case
1460 * @param s1 The string to search
1461 * @param s2 The substring to search for
1462 * @return A pointer to the beginning of the substring
1463 * @remark See apr_strmatch() for a faster alternative
1465 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1468 * Return a pointer to the location inside of bigstring immediately after prefix
1469 * @param bigstring The input string
1470 * @param prefix The prefix to strip away
1471 * @return A pointer relative to bigstring after prefix
1473 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1474 const char *prefix);
1477 * Decode a base64 encoded string into memory allocated from a pool
1478 * @param p The pool to allocate from
1479 * @param bufcoded The encoded string
1480 * @return The decoded string
1482 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1485 * Encode a string into memory allocated from a pool in base 64 format
1486 * @param p The pool to allocate from
1487 * @param strin The plaintext string
1488 * @return The encoded string
1490 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1494 * Compile a regular expression to be used later
1495 * @param p The pool to allocate from
1496 * @param pattern the regular expression to compile
1497 * @param cflags The bitwise or of one or more of the following:
1498 * @li #REG_EXTENDED - Use POSIX extended Regular Expressions
1499 * @li #REG_ICASE - Ignore case
1500 * @li #REG_NOSUB - Support for substring addressing of matches
1502 * @li #REG_NEWLINE - Match-any-character operators don't match new-line
1503 * @return The compiled regular expression
1505 AP_DECLARE(regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1509 * Free the memory associated with a compiled regular expression
1510 * @param p The pool the regex was allocated from
1511 * @param reg The regular expression to free
1513 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, regex_t *reg);
1516 * Match a null-terminated string against a pre-compiled regex.
1517 * @param preg The pre-compiled regex
1518 * @param string The string to match
1519 * @param nmatch Provide information regarding the location of any matches
1520 * @param pmatch Provide information regarding the location of any matches
1521 * @param eflags Bitwise or of any of:
1522 * @li #REG_NOTBOL - match-beginning-of-line operator always
1524 * @li #REG_NOTEOL - match-end-of-line operator always fails to match
1525 * @return 0 for successful match, #REG_NOMATCH otherwise
1527 AP_DECLARE(int) ap_regexec(regex_t *preg, const char *string,
1528 size_t nmatch, regmatch_t pmatch[], int eflags);
1531 * Return the error code returned by regcomp or regexec into error messages
1532 * @param errcode the error code returned by regexec or regcomp
1533 * @param preg The precompiled regex
1534 * @param errbuf A buffer to store the error in
1535 * @param errbuf_size The size of the buffer
1537 AP_DECLARE(size_t) ap_regerror(int errcode, const regex_t *preg,
1538 char *errbuf, size_t errbuf_size);
1541 * After performing a successful regex match, you may use this function to
1542 * perform a series of string substitutions based on subexpressions that were
1543 * matched during the call to ap_regexec
1544 * @param p The pool to allocate from
1545 * @param input An arbitrary string containing $1 through $9. These are
1546 * replaced with the corresponding matched sub-expressions
1547 * @param source The string that was originally matched to the regex
1548 * @param nmatch the nmatch returned from ap_pregex
1549 * @param pmatch the pmatch array returned from ap_pregex
1551 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1552 size_t nmatch, regmatch_t pmatch[]);
1555 * We want to downcase the type/subtype for comparison purposes
1556 * but nothing else because ;parameter=foo values are case sensitive.
1557 * @param s The content-type to convert to lowercase
1559 AP_DECLARE(void) ap_content_type_tolower(char *s);
1562 * convert a string to all lowercase
1563 * @param s The string to convert to lowercase
1565 AP_DECLARE(void) ap_str_tolower(char *s);
1568 * Search a string from left to right for the first occurrence of a
1569 * specific character
1570 * @param str The string to search
1571 * @param c The character to search for
1572 * @return The index of the first occurrence of c in str
1574 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1577 * Search a string from right to left for the first occurrence of a
1578 * specific character
1579 * @param str The string to search
1580 * @param c The character to search for
1581 * @return The index of the first occurrence of c in str
1583 AP_DECLARE(int) ap_rind(const char *str, char c);
1586 * Given a string, replace any bare " with \" .
1587 * @param p The pool to allocate memory from
1588 * @param instring The string to search for "
1589 * @return A copy of the string with escaped quotes
1591 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1593 /* Misc system hackery */
1595 * Given the name of an object in the file system determine if it is a directory
1596 * @param p The pool to allocate from
1597 * @param name The name of the object to check
1598 * @return 1 if it is a directory, 0 otherwise
1600 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1603 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1604 * @param p The pool to allocate from
1605 * @param name The name of the object to check
1606 * @return 1 if it is a directory, 0 otherwise
1608 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1611 extern const char *os_set_account(apr_pool_t *p, const char *account);
1612 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1613 #endif /* _OSD_POSIX */
1616 * Determine the local host name for the current machine
1617 * @param p The pool to allocate from
1618 * @return A copy of the local host name
1620 char *ap_get_local_host(apr_pool_t *p);
1623 * Log an assertion to the error log
1624 * @param szExp The assertion that failed
1625 * @param szFile The file the assertion is in
1626 * @param nLine The line the assertion is defined on
1628 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1629 __attribute__((noreturn));
1632 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1635 * Redefine assert() to something more useful for an Apache...
1637 * Use ap_assert() if the condition should always be checked.
1638 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1643 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1645 #define AP_DEBUG_ASSERT(exp) ((void)0)
1649 * @defgroup stopsignal flags which indicate places where the sever should stop for debugging.
1651 * A set of flags which indicate places where the server should raise(SIGSTOP).
1652 * This is useful for debugging, because you can then attach to that process
1653 * with gdb and continue. This is important in cases where one_process
1654 * debugging isn't possible.
1656 /** stop on a Detach */
1657 #define SIGSTOP_DETACH 1
1658 /** stop making a child process */
1659 #define SIGSTOP_MAKE_CHILD 2
1660 /** stop spawning a child process */
1661 #define SIGSTOP_SPAWN_CHILD 4
1662 /** stop spawning a child process with a piped log */
1663 #define SIGSTOP_PIPED_LOG_SPAWN 8
1664 /** stop spawning a CGI child process */
1665 #define SIGSTOP_CGI_CHILD 16
1667 /** Macro to get GDB started */
1668 #ifdef DEBUG_SIGSTOP
1669 extern int raise_sigstop_flags;
1670 #define RAISE_SIGSTOP(x) do { \
1671 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1674 #define RAISE_SIGSTOP(x)
1678 * Get HTML describing the address and (optionally) admin of the server.
1679 * @param prefix Text which is prepended to the return value
1680 * @param r The request_rec
1681 * @return HTML describing the server, allocated in @a r's pool.
1683 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1685 /** strtoul does not exist on sunos4. */
1689 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1691 /* The C library has functions that allow const to be silently dropped ...
1692 these macros detect the drop in maintainer mode, but use the native
1693 methods for normal builds
1695 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1696 to be included before the macros are defined or compilation will fail.
1703 # define strchr(s, c) ap_strchr(s,c)
1705 # define strrchr(s, c) ap_strrchr(s,c)
1707 # define strstr(s, c) ap_strstr(s,c)
1709 AP_DECLARE(char *) ap_strchr(char *s, int c);
1710 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
1711 AP_DECLARE(char *) ap_strrchr(char *s, int c);
1712 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
1713 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
1714 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
1718 /** use this instead of strchr */
1719 # define ap_strchr(s, c) strchr(s, c)
1720 /** use this instead of strchr */
1721 # define ap_strchr_c(s, c) strchr(s, c)
1722 /** use this instead of strrchr */
1723 # define ap_strrchr(s, c) strrchr(s, c)
1724 /** use this instead of strrchr */
1725 # define ap_strrchr_c(s, c) strrchr(s, c)
1726 /** use this instead of strrstr*/
1727 # define ap_strstr(s, c) strstr(s, c)
1728 /** use this instead of strrstr*/
1729 # define ap_strstr_c(s, c) strstr(s, c)
1733 #define AP_NORESTART APR_OS_START_USEERR + 1
1739 #endif /* !APACHE_HTTPD_H */