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"
78 #include "apr_general.h"
79 #include "apr_tables.h"
80 #include "apr_pools.h"
82 #include "apr_network_io.h"
83 #include "apr_buckets.h"
85 #include "pcreposix.h"
87 /* Note: util_uri.h is also included, see below */
95 /* ----------------------------- config dir ------------------------------ */
97 /* Define this to be the default server home dir. Most things later in this
98 * file with a relative pathname will have this added.
102 /* Set default for OS/2 file system */
103 #define HTTPD_ROOT "/os2httpd"
105 /* Set default for Windows file system */
106 #define HTTPD_ROOT "/apache"
108 /* Set the default for BeOS */
109 #define HTTPD_ROOT "/boot/home/apache"
110 #elif defined (NETWARE)
111 /* Set the default for NetWare */
112 #define HTTPD_ROOT "/apache"
114 #define HTTPD_ROOT "/usr/local/apache"
116 #endif /* HTTPD_ROOT */
119 * --------- You shouldn't have to edit anything below this line ----------
121 * Any modifications to any defaults not defined above should be done in the
122 * respective configuration file.
126 /* Default location of documents. Can be overridden by the DocumentRoot
129 #ifndef DOCUMENT_LOCATION
131 /* Set default for OS/2 file system */
132 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
134 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
136 #endif /* DOCUMENT_LOCATION */
138 /* Maximum number of dynamically loaded modules */
139 #ifndef DYNAMIC_MODULE_LIMIT
140 #define DYNAMIC_MODULE_LIMIT 64
143 /* Default administrator's address */
144 #define DEFAULT_ADMIN "[no address given]"
146 /* The name of the log files */
147 #ifndef DEFAULT_ERRORLOG
148 #if defined(OS2) || defined(WIN32)
149 #define DEFAULT_ERRORLOG "logs/error.log"
151 #define DEFAULT_ERRORLOG "logs/error_log"
153 #endif /* DEFAULT_ERRORLOG */
155 /* Define this to be what your per-directory security files are called */
156 #ifndef DEFAULT_ACCESS_FNAME
158 /* Set default for OS/2 file system */
159 #define DEFAULT_ACCESS_FNAME "htaccess"
161 #define DEFAULT_ACCESS_FNAME ".htaccess"
163 #endif /* DEFAULT_ACCESS_FNAME */
165 /* The name of the server config file */
166 #ifndef SERVER_CONFIG_FILE
167 #define SERVER_CONFIG_FILE "conf/httpd.conf"
170 /* Whether we should enable rfc1413 identity checking */
171 #ifndef DEFAULT_RFC1413
172 #define DEFAULT_RFC1413 0
175 /* The default path for CGI scripts if none is currently set */
177 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
180 /* The path to the suExec wrapper, can be overridden in Configuration */
182 #define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
185 /* The timeout for waiting for messages */
186 #ifndef DEFAULT_TIMEOUT
187 #define DEFAULT_TIMEOUT 300
190 /* The timeout for waiting for keepalive timeout until next request */
191 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
192 #define DEFAULT_KEEPALIVE_TIMEOUT 15
195 /* The number of requests to entertain per connection */
196 #ifndef DEFAULT_KEEPALIVE
197 #define DEFAULT_KEEPALIVE 100
200 /* Limits on the size of various request items. These limits primarily
201 * exist to prevent simple denial-of-service attacks on a server based
202 * on misuse of the protocol. The recommended values will depend on the
203 * nature of the server resources -- CGI scripts and database backends
204 * might require large values, but most servers could get by with much
205 * smaller limits than we use below. The request message body size can
206 * be limited by the per-dir config directive LimitRequestBody.
208 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
209 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
210 * These two limits can be lowered (but not raised) by the server config
211 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
213 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
214 * the server config directive LimitRequestFields.
216 #ifndef DEFAULT_LIMIT_REQUEST_LINE
217 #define DEFAULT_LIMIT_REQUEST_LINE 8190
218 #endif /* default limit on bytes in Request-Line (Method+URI+HTTP-version) */
219 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
220 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
221 #endif /* default limit on bytes in any one header field */
222 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
223 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
224 #endif /* default limit on number of request header fields */
228 * The default default character set name to add if AddDefaultCharset is
229 * enabled. Overridden with AddDefaultCharsetName.
231 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
233 #endif /* CORE_PRIVATE */
235 /** default HTTP Server protocol */
236 #define AP_SERVER_PROTOCOL "HTTP/1.1"
239 /* ------------------ stuff that modules are allowed to look at ----------- */
241 /** Define this to be what your HTML directory content files are called */
242 #ifndef AP_DEFAULT_INDEX
243 #define AP_DEFAULT_INDEX "index.html"
248 * Define this to be what type you'd like returned for files with unknown
250 * @warning MUST be all lower case.
252 #ifndef DEFAULT_CONTENT_TYPE
253 #define DEFAULT_CONTENT_TYPE "text/plain"
256 /** The name of the MIME types file */
257 #ifndef AP_TYPES_CONFIG_FILE
258 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
262 * Define the HTML doctype strings centrally.
264 /** HTML 2.0 Doctype */
265 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
266 "DTD HTML 2.0//EN\">\n"
267 /** HTML 3.2 Doctype */
268 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
269 "DTD HTML 3.2 Final//EN\">\n"
270 /** HTML 4.0 Strict Doctype */
271 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
272 "DTD HTML 4.0//EN\"\n" \
273 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
274 /** HTML 4.0 Transitional Doctype */
275 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
276 "DTD HTML 4.0 Transitional//EN\"\n" \
277 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
278 /** HTML 4.0 Frameset Doctype */
279 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
280 "DTD HTML 4.0 Frameset//EN\"\n" \
281 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
283 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
285 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
286 /** Major part of HTTP protocol */
287 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
288 /** Minor part of HTTP protocol */
289 #define HTTP_VERSION_MINOR(number) ((number)%1000)
291 /* -------------- Port number for server running standalone --------------- */
293 /** default HTTP Port */
294 #define DEFAULT_HTTP_PORT 80
295 /** default HTTPS Port */
296 #define DEFAULT_HTTPS_PORT 443
298 * Check whether @a port is the default port for the request @a r.
299 * @param port The port number
300 * @param r The request
301 * @see #ap_default_port
303 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
305 * Get the default port for a request (which depends on the scheme).
306 * @param r The request
308 #define ap_default_port(r) ap_run_default_port(r)
310 * Get the scheme for a request.
311 * @param r The request
312 * @bug This should be called ap_http_scheme!
314 #define ap_http_method(r) ap_run_http_method(r)
316 /** The default string lengths */
317 #define MAX_STRING_LEN HUGE_STRING_LEN
318 #define HUGE_STRING_LEN 8192
320 /** The size of the server's internal read-write buffers */
321 #define AP_IOBUFSIZE 8192
324 * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
325 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
326 * than that in case the brigade code/filters attempt to read it directly.
327 * ### 16mb is an invention, no idea if it is reasonable.
329 #define AP_MAX_SENDFILE 16777216 /* 2^24 */
332 * Special Apache error codes. These are basically used
333 * in http_main.c so we can keep track of various errors.
337 #define APEXIT_OK 0x0
338 /** A fatal error arising during the server's init sequence */
339 #define APEXIT_INIT 0x2
340 /** The child died during its init sequence */
341 #define APEXIT_CHILDINIT 0x3
343 * The child exited due to a resource shortage.
344 * The parent should limit the rate of forking until
345 * the situation is resolved.
347 #define APEXIT_CHILDSICK 0x7
349 * A fatal error, resulting in the whole server aborting.
350 * If a child exits with this error, the parent process
351 * considers this a server-wide fatal error and aborts.
353 #define APEXIT_CHILDFATAL 0xf
357 * Stuff marked #AP_DECLARE is part of the API, and intended for use
358 * by modules. Its purpose is to allow us to add attributes that
359 * particular platforms or compilers require to every exported function.
361 # define AP_DECLARE(type) type
364 #ifndef AP_DECLARE_NONSTD
366 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
367 * use by modules. The difference between #AP_DECLARE and
368 * #AP_DECLARE_NONSTD is that the latter is required for any functions
369 * which use varargs or are used via indirect function call. This
370 * is to accomodate the two calling conventions in windows dlls.
372 # define AP_DECLARE_NONSTD(type) type
374 #ifndef AP_DECLARE_DATA
375 # define AP_DECLARE_DATA
378 #ifndef AP_MODULE_DECLARE
379 # define AP_MODULE_DECLARE(type) type
381 #ifndef AP_MODULE_DECLARE_NONSTD
382 # define AP_MODULE_DECLARE_NONSTD(type) type
384 #ifndef AP_MODULE_DECLARE_DATA
385 # define AP_MODULE_DECLARE_DATA
390 * modules should not used functions marked AP_CORE_DECLARE
392 #ifndef AP_CORE_DECLARE
393 # define AP_CORE_DECLARE AP_DECLARE
397 * modules should not used functions marked AP_CORE_DECLARE_NONSTD
400 #ifndef AP_CORE_DECLARE_NONSTD
401 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
405 * Get the server version string
406 * @return The server version string
408 AP_DECLARE(const char *) ap_get_server_version(void);
411 * Add a component to the version string
412 * @param pconf The pool to allocate the component from
413 * @param component The string to add
415 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
418 * Get the date a time that the server was built
419 * @return The server build time string
421 AP_DECLARE(const char *) ap_get_server_built(void);
423 #define DECLINED -1 /**< Module declines to handle */
424 #define DONE -2 /**< Module has served the response completely
425 * - it's safe to die() with no more output
427 #define OK 0 /**< Module has handled this stage. */
431 * @defgroup HTTP_Status HTTP Status Codes
435 * The size of the static array in http_protocol.c for storing
436 * all of the potential response status-lines (a sparse table).
437 * A future version should dynamically generate the apr_table_t at startup.
439 #define RESPONSE_CODES 55
441 #define HTTP_CONTINUE 100
442 #define HTTP_SWITCHING_PROTOCOLS 101
443 #define HTTP_PROCESSING 102
445 #define HTTP_CREATED 201
446 #define HTTP_ACCEPTED 202
447 #define HTTP_NON_AUTHORITATIVE 203
448 #define HTTP_NO_CONTENT 204
449 #define HTTP_RESET_CONTENT 205
450 #define HTTP_PARTIAL_CONTENT 206
451 #define HTTP_MULTI_STATUS 207
452 #define HTTP_MULTIPLE_CHOICES 300
453 #define HTTP_MOVED_PERMANENTLY 301
454 #define HTTP_MOVED_TEMPORARILY 302
455 #define HTTP_SEE_OTHER 303
456 #define HTTP_NOT_MODIFIED 304
457 #define HTTP_USE_PROXY 305
458 #define HTTP_TEMPORARY_REDIRECT 307
459 #define HTTP_BAD_REQUEST 400
460 #define HTTP_UNAUTHORIZED 401
461 #define HTTP_PAYMENT_REQUIRED 402
462 #define HTTP_FORBIDDEN 403
463 #define HTTP_NOT_FOUND 404
464 #define HTTP_METHOD_NOT_ALLOWED 405
465 #define HTTP_NOT_ACCEPTABLE 406
466 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
467 #define HTTP_REQUEST_TIME_OUT 408
468 #define HTTP_CONFLICT 409
469 #define HTTP_GONE 410
470 #define HTTP_LENGTH_REQUIRED 411
471 #define HTTP_PRECONDITION_FAILED 412
472 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
473 #define HTTP_REQUEST_URI_TOO_LARGE 414
474 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
475 #define HTTP_RANGE_NOT_SATISFIABLE 416
476 #define HTTP_EXPECTATION_FAILED 417
477 #define HTTP_UNPROCESSABLE_ENTITY 422
478 #define HTTP_LOCKED 423
479 #define HTTP_FAILED_DEPENDENCY 424
480 #define HTTP_INTERNAL_SERVER_ERROR 500
481 #define HTTP_NOT_IMPLEMENTED 501
482 #define HTTP_BAD_GATEWAY 502
483 #define HTTP_SERVICE_UNAVAILABLE 503
484 #define HTTP_GATEWAY_TIME_OUT 504
485 #define HTTP_VERSION_NOT_SUPPORTED 505
486 #define HTTP_VARIANT_ALSO_VARIES 506
487 #define HTTP_INSUFFICIENT_STORAGE 507
488 #define HTTP_NOT_EXTENDED 510
490 /** is the status code informational */
491 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
492 /** is the status code OK ?*/
493 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
494 /** is the status code a redirect */
495 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
496 /** is the status code a error (client or server) */
497 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
498 /** is the status code a client error */
499 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
500 /** is the status code a server error */
501 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
503 /** should the status code drop the connection */
504 #define ap_status_drops_connection(x) \
505 (((x) == HTTP_BAD_REQUEST) || \
506 ((x) == HTTP_REQUEST_TIME_OUT) || \
507 ((x) == HTTP_LENGTH_REQUIRED) || \
508 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
509 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
510 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
511 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
512 ((x) == HTTP_NOT_IMPLEMENTED))
515 * @defgroup Methods List of Methods recognized by the server
519 * Methods recognized (but not necessarily handled) by the server.
520 * These constants are used in bit shifting masks of size int, so it is
521 * unsafe to have more methods than bits in an int. HEAD == M_GET.
522 * This list must be tracked by the list in http_protocol.c in routine
523 * ap_method_name_of().
525 #define M_GET 0 /* RFC 2616: HTTP */
526 #define M_PUT 1 /* : */
531 #define M_TRACE 6 /* RFC 2616: HTTP */
532 #define M_PATCH 7 /* no rfc(!) ### remove this one? */
533 #define M_PROPFIND 8 /* RFC 2518: WebDAV */
534 #define M_PROPPATCH 9 /* : */
539 #define M_UNLOCK 14 /* RFC 2518: WebDAV */
540 #define M_VERSION_CONTROL 15 /* RFC 3253: WebDAV Versioning */
541 #define M_CHECKOUT 16 /* : */
542 #define M_UNCHECKOUT 17
547 #define M_MKWORKSPACE 22
548 #define M_MKACTIVITY 23
549 #define M_BASELINE_CONTROL 24
551 #define M_INVALID 26 /* RFC 3253: WebDAV Versioning */
554 * METHODS needs to be equal to the number of bits
555 * we are using for limit masks.
560 * The method mask bit to shift for anding with a bitmask.
562 #define AP_METHOD_BIT ((apr_int64_t)1)
567 * Structure for handling HTTP methods. Methods known to the server are
568 * accessed via a bitmask shortcut; extension methods are handled by
571 typedef struct ap_method_list_t ap_method_list_t;
572 struct ap_method_list_t {
573 /* The bitmask used for known methods */
574 apr_int64_t method_mask;
575 /* the array used for extension methods */
576 apr_array_header_t *method_list;
579 * @defgroup module_magic Module Magic mime types
582 /** Magic for mod_cgi[d] */
583 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
584 /** Magic for mod_include */
585 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
586 /** Magic for mod_include */
587 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
588 /** Magic for mod_dir */
589 #define DIR_MAGIC_TYPE "httpd/unix-directory"
592 /* Just in case your linefeed isn't the one the other end is expecting. */
593 #if !APR_CHARSET_EBCDIC
596 /** carrige return */
598 /** carrige return /Line Feed Combo */
599 #define CRLF "\015\012"
600 #else /* APR_CHARSET_EBCDIC */
601 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
602 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
603 * "native EBCDIC" CR and NL characters. These are therefore
610 #endif /* APR_CHARSET_EBCDIC */
613 * @defgroup values_request_rec_body Possible values for request_rec.read_body
615 * Possible values for request_rec.read_body (set by handling module):
618 /** Send 413 error if message has any body */
619 #define REQUEST_NO_BODY 0
620 /** Send 411 error if body without Content-Length */
621 #define REQUEST_CHUNKED_ERROR 1
622 /** If chunked, remove the chunks for me. */
623 #define REQUEST_CHUNKED_DECHUNK 2
627 * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
629 * Possible values for request_rec.used_path_info:
632 /** Accept request given path_info */
633 #define AP_REQ_ACCEPT_PATH_INFO 0
634 /** Send 404 error if path_info was given */
635 #define AP_REQ_REJECT_PATH_INFO 1
636 /** Module's choice for handling path_info */
637 #define AP_REQ_DEFAULT_PATH_INFO 2
641 * Things which may vary per file-lookup WITHIN a request ---
642 * e.g., state of MIME config. Basically, the name of an object, info
643 * about the object, and any other info we may ahve which may need to
644 * change as we go poking around looking for it (e.g., overridden by
647 * Note how the default state of almost all these things is properly
648 * zero, so that allocating it with pcalloc does the right thing without
649 * a whole lot of hairy initialization... so long as we are willing to
650 * make the (fairly) portable assumption that the bit pattern of a NULL
651 * pointer is, in fact, zero.
655 * This represents the result of calling htaccess; these are cached for
658 struct htaccess_result {
659 /** the directory to which this applies */
661 /** the overrides allowed for the .htaccess file */
663 /** the configuration directives */
664 struct ap_conf_vector_t *htaccess;
665 /** the next one, or NULL if no more; N.B. never change this */
666 const struct htaccess_result *next;
669 /* The following four types define a hierarchy of activities, so that
670 * given a request_rec r you can write r->connection->server->process
671 * to get to the process_rec. While this reduces substantially the
672 * number of arguments that various hooks require beware that in
673 * threaded versions of the server you must consider multiplexing
677 /** A structure that represents one process */
678 typedef struct process_rec process_rec;
679 /** A structure that represents a virtual server */
680 typedef struct server_rec server_rec;
681 /** A structure that represents one connection */
682 typedef struct conn_rec conn_rec;
683 /** A structure that represents the current request */
684 typedef struct request_rec request_rec;
686 /* ### would be nice to not include this from httpd.h ... */
687 /* This comes after we have defined the request_rec type */
690 /** A structure that represents one process */
692 /** Global pool. Please try to cleared on _all_ exits */
694 /** aka configuration pool, cleared on restarts */
696 /** How many command line arguments were pass to the program */
698 /** The command line arguments */
699 const char * const *argv;
700 /** The program name used to execute the program */
701 const char *short_name;
704 /** A structure that represents the current request */
706 /** The pool associated with the request */
708 /** The connection over which this connection has been read */
709 conn_rec *connection;
710 /** The virtual host this request is for */
713 /** If we wind up getting redirected, pointer to the request we
716 /** If this is an internal redirect, pointer to where we redirected
720 /** If this is a sub_request (see request.h) pointer back to the
724 /* Info about the request itself... we begin with stuff that only
725 * protocol.c should ever touch...
727 /** First line of request, so we can log it */
729 /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
731 /** A proxy request (calculated during post_read_request/translate_name)
732 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE
735 /** HEAD request, as opposed to GET */
737 /** Protocol, as given to us, or HTTP/0.9 */
739 /** Number version of protocol; 1.1 = 1001 */
741 /** Host, as set by full URI or Host: */
742 const char *hostname;
744 /** When the request started */
745 apr_time_t request_time;
747 /** Status line, if set by script */
748 const char *status_line;
752 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
753 * look, but don't touch.
756 /** GET, HEAD, POST, etc. */
758 /** M_GET, M_POST, etc. */
762 * allowed is a bitvector of the allowed methods.
764 * A handler must ensure that the request method is one that
765 * it is capable of handling. Generally modules should DECLINE
766 * any request methods they do not handle. Prior to aborting the
767 * handler like this the handler should set r->allowed to the list
768 * of methods that it is willing to handle. This bitvector is used
769 * to construct the "Allow:" header required for OPTIONS requests,
770 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
772 * Since the default_handler deals with OPTIONS, all modules can
773 * usually decline to deal with OPTIONS. TRACE is always allowed,
774 * modules don't need to set it explicitly.
776 * Since the default_handler will always handle a GET, a
777 * module which does *not* implement GET should probably return
778 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
779 * handler can't be installed by mod_actions.
782 /** Array of extension methods */
783 apr_array_header_t *allowed_xmethods;
784 /** List of allowed methods */
785 ap_method_list_t *allowed_methods;
787 /** byte count in stream is for body */
788 apr_off_t sent_bodyct;
789 /** body byte count, for easy access */
790 apr_off_t bytes_sent;
791 /** Time the resource was last modified */
794 /* HTTP/1.1 connection-level features */
796 /** sending chunked transfer-coding */
798 /** multipart/byteranges boundary */
799 const char *boundary;
800 /** The Range: header */
802 /** The "real" content length */
805 /** bytes left to read */
807 /** bytes that have been read */
808 apr_off_t read_length;
809 /** how the request body should be read */
811 /** reading chunked transfer-coding */
813 /** is client waiting for a 100 response? */
814 unsigned expecting_100;
816 /* MIME header environments, in and out. Also, an array containing
817 * environment variables to be passed to subprocesses, so people can
818 * write modules to add to that environment.
820 * The difference between headers_out and err_headers_out is that the
821 * latter are printed even on error, and persist across internal redirects
822 * (so the headers printed for ErrorDocument handlers will have them).
824 * The 'notes' apr_table_t is for notes from one module to another, with no
825 * other set purpose in mind...
828 /** MIME header environment from the request */
829 apr_table_t *headers_in;
830 /** MIME header environment for the response */
831 apr_table_t *headers_out;
832 /** MIME header environment for the response, printed even on errors and
833 * persist across internal redirects */
834 apr_table_t *err_headers_out;
835 /** Array of environment variables to be used for sub processes */
836 apr_table_t *subprocess_env;
837 /** Notes from one module to another */
840 /* content_type, handler, content_encoding, and all content_languages
841 * MUST be lowercased strings. They may be pointers to static strings;
842 * they should not be modified in place.
844 /** The content-type for the current request */
845 const char *content_type; /* Break these out --- we dispatch on 'em */
846 /** The handler string that we use to call a handler function */
847 const char *handler; /* What we *really* dispatch on */
849 /** How to encode the data */
850 const char *content_encoding;
851 /** array of (char*) representing the content languages */
852 apr_array_header_t *content_languages;
854 /** variant list validator (if negotiated) */
855 char *vlist_validator;
857 /** If an authentication check was made, this gets set to the user name. */
859 /** If an authentication check was made, this gets set to the auth type. */
862 /** This response is non-cache-able */
864 /** There is no local copy of this response */
867 /* What object is being requested (either directly, or via include
868 * or content-negotiation mapping).
871 /** the uri without any parsing performed */
873 /** the path portion of the URI */
875 /** The filename on disk that this response corresponds to */
877 /** The true filename, we canonicalize r->filename if these don't match */
878 char *canonical_filename;
879 /** The path_info for this request if there is any. */
881 /** QUERY_ARGS, if any */
883 /** ST_MODE set to zero if no such file */
885 /** components of uri, dismantled */
886 apr_uri_t parsed_uri;
888 /** Flag for the handler to accept or reject path_info on
889 * the current request. All modules should respect the
890 * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
891 * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
892 * may follow existing conventions. This is set to the
893 * user's preference upon HOOK_VERY_FIRST of the fixups.
897 /* Various other config info which may change with .htaccess files
898 * These are config vectors, with one void* pointer for each module
899 * (the thing pointed to being the module's business).
902 /** Options set in config files, etc. */
903 struct ap_conf_vector_t *per_dir_config;
904 /** Notes on *this* request */
905 struct ap_conf_vector_t *request_config;
908 * a linked list of the configuration directives in the .htaccess files
909 * accessed by this request.
910 * N.B. always add to the head of the list, _never_ to the end.
911 * that way, a sub request's list can (temporarily) point to a parent's list
913 const struct htaccess_result *htaccess;
915 /** A list of output filters to be used for this request */
916 struct ap_filter_t *output_filters;
917 /** A list of input filters to be used for this request */
918 struct ap_filter_t *input_filters;
920 /** A list of protocol level output filters to be used for this
922 struct ap_filter_t *proto_output_filters;
923 /** A list of protocol level input filters to be used for this
925 struct ap_filter_t *proto_input_filters;
927 /** A flag to determine if the eos bucket has been sent yet */
930 /* Things placed at the end of the record to avoid breaking binary
931 * compatibility. It would be nice to remember to reorder the entire
932 * record to improve 64bit alignment the next time we need to break
933 * binary compatibility for some other reason.
938 * @defgroup ProxyReq Proxy request types
940 * Possible values of request_rec->proxyreq. A request could be normal,
941 * proxied or reverse proxied. Normally proxied and reverse proxied are
942 * grouped together as just "proxied", but sometimes it's necessary to
943 * tell the difference between the two, such as for authentication.
947 #define PROXYREQ_NONE 0 /**< No proxy */
948 #define PROXYREQ_PROXY 1 /**< Standard proxy */
949 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
954 /** Structure to store things which are per connection */
956 /** Pool associated with this connection */
958 /** Physical vhost this conn came in on */
959 server_rec *base_server;
960 /** used by http_vhost.c */
961 void *vhost_lookup_data;
963 /* Information about the connection itself */
965 apr_sockaddr_t *local_addr;
966 /** remote address */
967 apr_sockaddr_t *remote_addr;
969 /** Client's IP address */
971 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
972 * "" if it has and no address was found. N.B. Only access this though
973 * get_remote_host() */
975 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
976 * get_remote_logname() */
977 char *remote_logname;
979 /** Are we still talking? */
982 /** Are we going to keep the connection alive for another request?
983 * -1 fatal error, 0 undecided, 1 yes */
984 signed int keepalive:2;
986 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
988 signed int double_reverse:2;
990 /** How many times have we used it? */
992 /** server IP address */
994 /** used for ap_get_server_name when UseCanonicalName is set to DNS
995 * (ignores setting of HostnameLookups) */
998 /** ID of this connection; unique at any point in time */
1000 /** Notes on *this* connection */
1001 struct ap_conf_vector_t *conn_config;
1002 /** send note from one module to another, must remain valid for all
1003 * requests on this conn */
1005 /** A list of input filters to be used for this connection */
1006 struct ap_filter_t *input_filters;
1007 /** A list of output filters to be used for this connection */
1008 struct ap_filter_t *output_filters;
1009 /** handle to scoreboard information for this connection */
1013 /* Per-vhost config... */
1016 * The address 255.255.255.255, when used as a virtualhost address,
1017 * will become the "default" server when the ip doesn't match other vhosts.
1019 #define DEFAULT_VHOST_ADDR 0xfffffffful
1022 /** A structure to be used for Per-vhost config */
1023 typedef struct server_addr_rec server_addr_rec;
1024 struct server_addr_rec {
1025 /** The next server in the list */
1026 server_addr_rec *next;
1027 /** The bound address, for this server */
1028 apr_sockaddr_t *host_addr;
1029 /** The bound port, for this server */
1030 apr_port_t host_port;
1031 /** The name given in <VirtualHost> */
1035 /** A structure to store information for each virtual server */
1037 /** The process this server is running in */
1038 process_rec *process;
1039 /** The next server in the list */
1042 /** The name of the server */
1043 const char *defn_name;
1044 /** The line of the config file that the server was defined on */
1045 unsigned defn_line_number;
1047 /* Contact information */
1049 /** The admin's contact information */
1051 /** The server hostname */
1052 char *server_hostname;
1053 /** for redirects, etc. */
1056 /* Log files --- note that transfer log is now in the modules... */
1058 /** The name of the error log */
1060 /** A file descriptor that references the error log */
1061 apr_file_t *error_log;
1062 /** The log level for this server */
1065 /* Module-specific configuration for server, and defaults... */
1067 /** true if this is the virtual server */
1069 /** Config vector containing pointers to modules' per-server config
1071 struct ap_conf_vector_t *module_config;
1072 /** MIME type info, etc., before we start checking per-directory info */
1073 struct ap_conf_vector_t *lookup_defaults;
1075 /* Transaction handling */
1077 /** I haven't got a clue */
1078 server_addr_rec *addrs;
1079 /** Timeout, in seconds, before we give up */
1081 /** Seconds we'll wait for another request */
1082 int keep_alive_timeout;
1083 /** Maximum requests per connection */
1085 /** Use persistent connections? */
1088 /** Pathname for ServerPath */
1090 /** Length of path */
1093 /** Normal names for ServerAlias servers */
1094 apr_array_header_t *names;
1095 /** Wildcarded names for ServerAlias servers */
1096 apr_array_header_t *wild_names;
1098 /** limit on size of the HTTP request line */
1100 /** limit on size of any request header field */
1101 int limit_req_fieldsize;
1102 /** limit on number of request header fields */
1103 int limit_req_fields;
1106 typedef struct core_output_filter_ctx {
1107 apr_bucket_brigade *b;
1108 apr_pool_t *subpool; /* subpool of c->pool used for data saved after a
1109 * request is finished
1111 int subpool_has_stuff; /* anything in the subpool? */
1112 } core_output_filter_ctx_t;
1114 typedef struct core_filter_ctx {
1115 apr_bucket_brigade *b;
1118 typedef struct core_net_rec {
1119 /** Connection to the client */
1120 apr_socket_t *client_socket;
1122 /** connection record */
1125 core_output_filter_ctx_t *out_ctx;
1130 * Examine a field value (such as a media-/content-type) string and return
1131 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1132 * @param p Pool to allocate memory from
1133 * @param intype The field to examine
1134 * @return A copy of the field minus any parameters
1136 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1139 * Convert a time from an integer into a string in a specified format
1140 * @param p The pool to allocate memory from
1141 * @param t The time to convert
1142 * @param fmt The format to use for the conversion
1143 * @param gmt Convert the time for GMT?
1144 * @return The string that represents the specified time
1146 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1148 /* String handling. The *_nc variants allow you to use non-const char **s as
1149 arguments (unfortunately C won't automatically convert a char ** to a const
1153 * Get the characters until the first occurance of a specified character
1154 * @param p The pool to allocate memory from
1155 * @param line The string to get the characters from
1156 * @param stop The character to stop at
1157 * @return A copy of the characters up to the first stop character
1159 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1161 * Get the characters until the first occurance of a specified character
1162 * @param p The pool to allocate memory from
1163 * @param line The string to get the characters from
1164 * @param stop The character to stop at
1165 * @return A copy of the characters up to the first stop character
1166 * @note This is the same as ap_getword(), except it doesn't use const char **.
1168 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1171 * Get the first word from a given string. A word is defined as all characters
1172 * up to the first whitespace.
1173 * @param p The pool to allocate memory from
1174 * @param line The string to traverse
1175 * @return The first word in the line
1177 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1179 * Get the first word from a given string. A word is defined as all characters
1180 * up to the first whitespace.
1181 * @param p The pool to allocate memory from
1182 * @param line The string to traverse
1183 * @return The first word in the line
1184 * @note The same as ap_getword_white(), except it doesn't use const char **.
1186 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1189 * Get all characters from the first occurance of @a stop to the first '\0'
1190 * @param p The pool to allocate memory from
1191 * @param line The line to traverse
1192 * @param stop The character to start at
1193 * @return A copy of all caracters after the first occurance of the specified
1196 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1199 * Get all characters from the first occurance of @a stop to the first '\0'
1200 * @param p The pool to allocate memory from
1201 * @param line The line to traverse
1202 * @param stop The character to start at
1203 * @return A copy of all caracters after the first occurance of the specified
1205 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1207 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1210 * Get the second word in the string paying attention to quoting
1211 * @param p The pool to allocate from
1212 * @param line The line to traverse
1213 * @return A copy of the string
1215 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1217 * Get the second word in the string paying attention to quoting
1218 * @param p The pool to allocate from
1219 * @param line The line to traverse
1220 * @return A copy of the string
1221 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1223 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1226 * Check a string for any ${ENV} environment variable construct and replace
1227 * each them by the value of that environment variable, if it exists. If the
1228 * environment value does not exist, leave the ${ENV} construct alone; it
1229 * means something else.
1230 * @param p The pool to allocate from
1231 * @param word The string to check
1232 * @return The string with the replaced environment variables
1234 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1237 * Size an HTTP header field list item, as separated by a comma.
1238 * @param field The field to size
1239 * @param len The length of the field
1240 * @return The return value is a pointer to the beginning of the non-empty
1241 * list item within the original string (or NULL if there is none) and the
1242 * address of field is shifted to the next non-comma, non-whitespace
1243 * character. len is the length of the item excluding any beginning whitespace.
1245 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1248 * Retrieve an HTTP header field list item, as separated by a comma,
1249 * while stripping insignificant whitespace and lowercasing anything not in
1250 * a quoted string or comment.
1251 * @param p The pool to allocate from
1252 * @param field The field to retrieve
1253 * @return The return value is a new string containing the converted list
1254 * item (or NULL if none) and the address pointed to by field is
1255 * shifted to the next non-comma, non-whitespace.
1257 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1260 * Find an item in canonical form (lowercase, no extra spaces) within
1261 * an HTTP field value list.
1262 * @param p The pool to allocate from
1263 * @param line The field value list to search
1264 * @param tok The token to search for
1265 * @return 1 if found, 0 if not found.
1267 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1270 * Retrieve a token, spacing over it and returning a pointer to
1271 * the first non-white byte afterwards. Note that these tokens
1272 * are delimited by semis and commas and can also be delimited
1273 * by whitespace at the caller's option.
1274 * @param p The pool to allocate from
1275 * @param accept_line The line to retrieve the token from
1276 * @param accept_white Is it delimited by whitespace
1277 * @return the first non-white byte after the token
1279 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1282 * Find http tokens, see the definition of token from RFC2068
1283 * @param p The pool to allocate from
1284 * @param line The line to find the token
1285 * @param tok The token to find
1286 * @return 1 if the token is found, 0 otherwise
1288 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1291 * find http tokens from the end of the line
1292 * @param p The pool to allocate from
1293 * @param line The line to find the token
1294 * @param tok The token to find
1295 * @return 1 if the token is found, 0 otherwise
1297 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1300 * Check for an Absolute URI syntax
1301 * @param u The string to check
1302 * @return 1 if URI, 0 otherwise
1304 AP_DECLARE(int) ap_is_url(const char *u);
1308 * @param url The url to unescapte
1309 * @return 0 on success, non-zero otherwise
1311 AP_DECLARE(int) ap_unescape_url(char *url);
1313 * Convert all double slashes to single slashes
1314 * @param name The string to convert
1316 AP_DECLARE(void) ap_no2slash(char *name);
1319 * Remove all ./ and xx/../ substrings from a file name. Also remove
1320 * any leading ../ or /../ substrings.
1321 * @param name the file name to parse
1323 AP_DECLARE(void) ap_getparents(char *name);
1326 * Escape a path segment, as defined in RFC 1808
1327 * @param p The pool to allocate from
1328 * @param s The path to convert
1329 * @return The converted URL
1331 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1333 * convert an OS path to a URL in an OS dependant way.
1334 * @param p The pool to allocate from
1335 * @param path The path to convert
1336 * @param partial if set, assume that the path will be appended to something
1337 * with a '/' in it (and thus does not prefix "./")
1338 * @return The converted URL
1340 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1341 /** @see ap_os_escape_path */
1342 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1345 * Escape an html string
1346 * @param p The pool to allocate from
1347 * @param s The html to escape
1348 * @return The escaped string
1350 AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
1353 * Construct a full hostname
1354 * @param p The pool to allocate from
1355 * @param hostname The hostname of the server
1356 * @param port The port the server is running on
1357 * @param r The current request
1358 * @return The server's hostname
1360 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1361 apr_port_t port, const request_rec *r);
1363 * Escape a shell command
1364 * @param p The pool to allocate from
1365 * @param s The command to escape
1366 * @return The escaped shell command
1368 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1371 * Count the number of directories in a path
1372 * @param path The path to count
1373 * @return The number of directories
1375 AP_DECLARE(int) ap_count_dirs(const char *path);
1378 * Copy at most @a n leading directories of @a s into @a d. @a d
1379 * should be at least as large as @a s plus 1 extra byte
1381 * @param d The location to copy to
1382 * @param s The location to copy from
1383 * @param n The number of directories to copy
1384 * @return value is the ever useful pointer to the trailing \0 of d
1385 * @note on platforms with drive letters, n = 0 returns the "/" root,
1386 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1387 * returns the empty string. */
1388 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1391 * Return the parent directory name (including trailing /) of the file
1393 * @param p The pool to allocate from
1394 * @param s The file to get the parent of
1395 * @return A copy of the file's parent directory
1397 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1400 * Given a directory and filename, create a single path from them. This
1401 * function is smart enough to ensure that there is a sinlge '/' between the
1402 * directory and file names
1403 * @param a The pool to allocate from
1404 * @param dir The directory name
1405 * @param f The filename
1406 * @return A copy of the full path
1407 * @tip Never consider using this function if you are dealing with filesystem
1408 * names that need to remain canonical, unless you are merging an apr_dir_read
1409 * path and returned filename. Otherwise, the result is not canonical.
1411 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1414 * Test if the given path has an an absolute path.
1415 * @param p The pool to allocate from
1416 * @param dir The directory name
1417 * @tip The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1418 * multiple forms of absolute paths. This only reports if the path is absolute
1419 * in a canonical sense.
1421 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1424 * Does the provided string contain wildcard characters? This is useful
1425 * for determining if the string should be passed to strcmp_match or to strcmp.
1426 * The only wildcard characters recognized are '?' and '*'
1427 * @param str The string to check
1428 * @return 1 if the string has wildcards, 0 otherwise
1430 AP_DECLARE(int) ap_is_matchexp(const char *str);
1433 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1434 * @param str The string to check
1435 * @param exp The pattern to match against
1436 * @return 1 if the two strings match, 0 otherwise
1438 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *exp);
1440 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1442 * @param str The string to check
1443 * @param exp The pattern to match against
1444 * @return 1 if the two strings match, 0 otherwise
1446 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *exp);
1449 * Find the first occurrence of the substring s2 in s1, regardless of case
1450 * @param s1 The string to search
1451 * @param s2 The substring to search for
1452 * @return A pointer to the beginning of the substring
1454 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1457 * Return a pointer to the location inside of bigstring immediately after prefix
1458 * @param bigstring The input string
1459 * @param prefix The prefix to strip away
1460 * @return A pointer relative to bigstring after prefix
1462 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1463 const char *prefix);
1466 * Decode a base64 encoded string into memory allocated from a pool
1467 * @param p The pool to allocate from
1468 * @param bufcoded The encoded string
1469 * @return The decoded string
1471 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1474 * Encode a string into memory allocated from a pool in base 64 format
1475 * @param p The pool to allocate from
1476 * @param strin The plaintext string
1477 * @return The encoded string
1479 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1483 * Compile a regular expression to be used later
1484 * @param p The pool to allocate from
1485 * @param pattern the regular expression to compile
1486 * @param cflags The bitwise or of one or more of the following:
1487 * @li #REG_EXTENDED - Use POSIX extended Regular Expressions
1488 * @li #REG_ICASE - Ignore case
1489 * @li #REG_NOSUB - Support for substring addressing of matches
1491 * @li #REG_NEWLINE - Match-any-character operators don't match new-line
1492 * @return The compiled regular expression
1494 AP_DECLARE(regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1498 * Free the memory associated with a compiled regular expression
1499 * @param p The pool the regex was allocated from
1500 * @param reg The regular expression to free
1502 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, regex_t *reg);
1505 * Match a null-terminated string against a pre-compiled regex.
1506 * @param preg The pre-compiled regex
1507 * @param string The string to match
1508 * @param nmatch Provide information regarding the location of any matches
1509 * @param pmatch Provide information regarding the location of any matches
1510 * @param eflags Bitwise or of any of:
1511 * @li #REG_NOTBOL - match-beginning-of-line operator always
1513 * @li #REG_NOTEOL - match-end-of-line operator always fails to match
1514 * @return 0 for successful match, #REG_NOMATCH otherwise
1516 AP_DECLARE(int) ap_regexec(regex_t *preg, const char *string,
1517 size_t nmatch, regmatch_t pmatch[], int eflags);
1520 * Return the error code returned by regcomp or regexec into error messages
1521 * @param errcode the error code returned by regexec or regcomp
1522 * @param preg The precompiled regex
1523 * @param errbuf A buffer to store the error in
1524 * @param errbuf_size The size of the buffer
1526 AP_DECLARE(size_t) ap_regerror(int errcode, const regex_t *preg,
1527 char *errbuf, size_t errbuf_size);
1530 * After performing a successful regex match, you may use this function to
1531 * perform a series of string substitutions based on subexpressions that were
1532 * matched during the call to ap_regexec
1533 * @param p The pool to allocate from
1534 * @param input An arbitrary string containing $1 through $9. These are
1535 * replaced with the corresponding matched sub-expressions
1536 * @param source The string that was originally matched to the regex
1537 * @param nmatch the nmatch returned from ap_pregex
1538 * @param pmatch the pmatch array returned from ap_pregex
1540 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1541 size_t nmatch, regmatch_t pmatch[]);
1544 * We want to downcase the type/subtype for comparison purposes
1545 * but nothing else because ;parameter=foo values are case sensitive.
1546 * @param s The content-type to convert to lowercase
1548 AP_DECLARE(void) ap_content_type_tolower(char *s);
1551 * convert a string to all lowercase
1552 * @param s The string to convert to lowercase
1554 AP_DECLARE(void) ap_str_tolower(char *s);
1557 * Search a string from left to right for the first occurrence of a
1558 * specific character
1559 * @param str The string to search
1560 * @param c The character to search for
1561 * @return The index of the first occurrence of c in str
1563 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1566 * Search a string from right to left for the first occurrence of a
1567 * specific character
1568 * @param str The string to search
1569 * @param c The character to search for
1570 * @return The index of the first occurrence of c in str
1572 AP_DECLARE(int) ap_rind(const char *str, char c);
1575 * Given a string, replace any bare " with \" .
1576 * @param p The pool to allocate memory from
1577 * @param instring The string to search for "
1578 * @return A copy of the string with escaped quotes
1580 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1582 /* Misc system hackery */
1584 * Given the name of an object in the file system determine if it is a directory
1585 * @param p The pool to allocate from
1586 * @param name The name of the object to check
1587 * @return 1 if it is a directory, 0 otherwise
1589 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1592 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1593 * @param p The pool to allocate from
1594 * @param name The name of the object to check
1595 * @return 1 if it is a directory, 0 otherwise
1597 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1600 extern const char *os_set_account(apr_pool_t *p, const char *account);
1601 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1602 #endif /* _OSD_POSIX */
1605 * Determine the local host name for the current machine
1606 * @param p The pool to allocate from
1607 * @return A copy of the local host name
1609 char *ap_get_local_host(apr_pool_t *p);
1612 * Log an assertion to the error log
1613 * @param szExp The assertion that failed
1614 * @param szFile The file the assertion is in
1615 * @param nLine The line the assertion is defined on
1617 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1618 __attribute__((noreturn));
1621 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1624 * Redefine assert() to something more useful for an Apache...
1626 * Use ap_assert() if the condition should always be checked.
1627 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1632 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1634 #define AP_DEBUG_ASSERT(exp) ((void)0)
1638 * @defgroup stopsignal flags which indicate places where the sever should stop for debugging.
1640 * A set of flags which indicate places where the server should raise(SIGSTOP).
1641 * This is useful for debugging, because you can then attach to that process
1642 * with gdb and continue. This is important in cases where one_process
1643 * debugging isn't possible.
1645 /** stop on a Detach */
1646 #define SIGSTOP_DETACH 1
1647 /** stop making a child process */
1648 #define SIGSTOP_MAKE_CHILD 2
1649 /** stop spawning a child process */
1650 #define SIGSTOP_SPAWN_CHILD 4
1651 /** stop spawning a child process with a piped log */
1652 #define SIGSTOP_PIPED_LOG_SPAWN 8
1653 /** stop spawning a CGI child process */
1654 #define SIGSTOP_CGI_CHILD 16
1656 /** Macro to get GDB started */
1657 #ifdef DEBUG_SIGSTOP
1658 extern int raise_sigstop_flags;
1659 #define RAISE_SIGSTOP(x) do { \
1660 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1663 #define RAISE_SIGSTOP(x)
1667 * Get HTML describing the address and (optionally) admin of the server.
1668 * @param prefix Text which is prepended to the return value
1669 * @param r The request_rec
1670 * @return HTML describing the server, allocated in @a r's pool.
1672 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1674 /** strtoul does not exist on sunos4. */
1678 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1680 /* The C library has functions that allow const to be silently dropped ...
1681 these macros detect the drop in maintainer mode, but use the native
1682 methods for normal builds
1684 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1685 to be included before the macros are defined or compilation will fail.
1692 # define strchr(s, c) ap_strchr(s,c)
1694 # define strrchr(s, c) ap_strrchr(s,c)
1696 # define strstr(s, c) ap_strstr(s,c)
1698 AP_DECLARE(char *) ap_strchr(char *s, int c);
1699 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
1700 AP_DECLARE(char *) ap_strrchr(char *s, int c);
1701 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
1702 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
1703 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
1707 /** use this instead of strchr */
1708 # define ap_strchr(s, c) strchr(s, c)
1709 /** use this instead of strchr */
1710 # define ap_strchr_c(s, c) strchr(s, c)
1711 /** use this instead of strrchr */
1712 # define ap_strrchr(s, c) strrchr(s, c)
1713 /** use this instead of strrchr */
1714 # define ap_strrchr_c(s, c) strrchr(s, c)
1715 /** use this instead of strrstr*/
1716 # define ap_strstr(s, c) strstr(s, c)
1717 /** use this instead of strrstr*/
1718 # define ap_strstr_c(s, c) strstr(s, c)
1722 #define AP_NORESTART APR_OS_START_USEERR + 1
1728 #endif /* !APACHE_HTTPD_H */