1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000-2001 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 * ### 4mb is an invention, no idea if it is reasonable.
329 #define AP_MAX_SENDFILE 16777216
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 * A fatal error, resulting in the whole server aborting.
344 * If a child exits with this error, the parent process
345 * considers this a server-wide fatal error and aborts.
347 #define APEXIT_CHILDFATAL 0xf
351 * Stuff marked #AP_DECLARE is part of the API, and intended for use
352 * by modules. Its purpose is to allow us to add attributes that
353 * particular platforms or compilers require to every exported function.
355 # define AP_DECLARE(type) type
358 #ifndef AP_DECLARE_NONSTD
360 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
361 * use by modules. The difference between #AP_DECLARE and
362 * #AP_DECLARE_NONSTD is that the latter is required for any functions
363 * which use varargs or are used via indirect function call. This
364 * is to accomodate the two calling conventions in windows dlls.
366 # define AP_DECLARE_NONSTD(type) type
368 #ifndef AP_DECLARE_DATA
369 # define AP_DECLARE_DATA
372 #ifndef AP_MODULE_DECLARE
373 # define AP_MODULE_DECLARE(type) type
375 #ifndef AP_MODULE_DECLARE_NONSTD
376 # define AP_MODULE_DECLARE_NONSTD(type) type
378 #ifndef AP_MODULE_DECLARE_DATA
379 # define AP_MODULE_DECLARE_DATA
384 * modules should not used functions marked AP_CORE_DECLARE
386 #ifndef AP_CORE_DECLARE
387 # define AP_CORE_DECLARE AP_DECLARE
391 * modules should not used functions marked AP_CORE_DECLARE_NONSTD
394 #ifndef AP_CORE_DECLARE_NONSTD
395 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
399 * Get the server version string
400 * @return The server version string
402 AP_DECLARE(const char *) ap_get_server_version(void);
405 * Add a component to the version string
406 * @param pconf The pool to allocate the component from
407 * @param component The string to add
409 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
412 * Get the date a time that the server was built
413 * @return The server build time string
415 AP_DECLARE(const char *) ap_get_server_built(void);
417 #define DECLINED -1 /**< Module declines to handle */
418 #define DONE -2 /**< Module has served the response completely
419 * - it's safe to die() with no more output
421 #define OK 0 /**< Module has handled this stage. */
425 * @defgroup HTTP_Status HTTP Status Codes
429 * The size of the static array in http_protocol.c for storing
430 * all of the potential response status-lines (a sparse table).
431 * A future version should dynamically generate the apr_table_t at startup.
433 #define RESPONSE_CODES 55
435 #define HTTP_CONTINUE 100
436 #define HTTP_SWITCHING_PROTOCOLS 101
437 #define HTTP_PROCESSING 102
439 #define HTTP_CREATED 201
440 #define HTTP_ACCEPTED 202
441 #define HTTP_NON_AUTHORITATIVE 203
442 #define HTTP_NO_CONTENT 204
443 #define HTTP_RESET_CONTENT 205
444 #define HTTP_PARTIAL_CONTENT 206
445 #define HTTP_MULTI_STATUS 207
446 #define HTTP_MULTIPLE_CHOICES 300
447 #define HTTP_MOVED_PERMANENTLY 301
448 #define HTTP_MOVED_TEMPORARILY 302
449 #define HTTP_SEE_OTHER 303
450 #define HTTP_NOT_MODIFIED 304
451 #define HTTP_USE_PROXY 305
452 #define HTTP_TEMPORARY_REDIRECT 307
453 #define HTTP_BAD_REQUEST 400
454 #define HTTP_UNAUTHORIZED 401
455 #define HTTP_PAYMENT_REQUIRED 402
456 #define HTTP_FORBIDDEN 403
457 #define HTTP_NOT_FOUND 404
458 #define HTTP_METHOD_NOT_ALLOWED 405
459 #define HTTP_NOT_ACCEPTABLE 406
460 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
461 #define HTTP_REQUEST_TIME_OUT 408
462 #define HTTP_CONFLICT 409
463 #define HTTP_GONE 410
464 #define HTTP_LENGTH_REQUIRED 411
465 #define HTTP_PRECONDITION_FAILED 412
466 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
467 #define HTTP_REQUEST_URI_TOO_LARGE 414
468 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
469 #define HTTP_RANGE_NOT_SATISFIABLE 416
470 #define HTTP_EXPECTATION_FAILED 417
471 #define HTTP_UNPROCESSABLE_ENTITY 422
472 #define HTTP_LOCKED 423
473 #define HTTP_FAILED_DEPENDENCY 424
474 #define HTTP_INTERNAL_SERVER_ERROR 500
475 #define HTTP_NOT_IMPLEMENTED 501
476 #define HTTP_BAD_GATEWAY 502
477 #define HTTP_SERVICE_UNAVAILABLE 503
478 #define HTTP_GATEWAY_TIME_OUT 504
479 #define HTTP_VERSION_NOT_SUPPORTED 505
480 #define HTTP_VARIANT_ALSO_VARIES 506
481 #define HTTP_INSUFFICIENT_STORAGE 507
482 #define HTTP_NOT_EXTENDED 510
484 /** is the status code informational */
485 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
486 /** is the status code OK ?*/
487 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
488 /** is the status code a redirect */
489 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
490 /** is the status code a error (client or server) */
491 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
492 /** is the status code a client error */
493 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
494 /** is the status code a server error */
495 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
497 /** should the status code drop the connection */
498 #define ap_status_drops_connection(x) \
499 (((x) == HTTP_BAD_REQUEST) || \
500 ((x) == HTTP_REQUEST_TIME_OUT) || \
501 ((x) == HTTP_LENGTH_REQUIRED) || \
502 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
503 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
504 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
505 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
506 ((x) == HTTP_NOT_IMPLEMENTED))
509 * @defgroup Methods List of Methods recognized by the server
513 * Methods recognized (but not necessarily handled) by the server.
514 * These constants are used in bit shifting masks of size int, so it is
515 * unsafe to have more methods than bits in an int. HEAD == M_GET.
516 * This list must be tracked by the list in http_protocol.c in routine
517 * ap_method_name_of().
528 #define M_PROPPATCH 9
537 * METHODS needs to be equal to the number of bits
538 * we are using for limit masks.
543 * The method mask bit to shift for anding with a bitmask.
545 #define AP_METHOD_BIT (apr_int64_t)1
550 * Structure for handling HTTP methods. Methods known to the server are
551 * accessed via a bitmask shortcut; extension methods are handled by
554 typedef struct ap_method_list_t ap_method_list_t;
555 struct ap_method_list_t {
556 /* The bitmask used for known methods */
557 apr_int64_t method_mask;
558 /* the array used for extension methods */
559 apr_array_header_t *method_list;
562 * @defgroup module_magic Module Magic mime types
565 /** Magic for mod_cgi[d] */
566 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
567 /** Magic for mod_include */
568 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
569 /** Magic for mod_include */
570 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
571 /** Magic for mod_dir */
572 #define DIR_MAGIC_TYPE "httpd/unix-directory"
575 /* Just in case your linefeed isn't the one the other end is expecting. */
576 #if !APR_CHARSET_EBCDIC
579 /** carrige return */
581 /** carrige return /Line Feed Combo */
582 #define CRLF "\015\012"
583 #else /* APR_CHARSET_EBCDIC */
584 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
585 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
586 * "native EBCDIC" CR and NL characters. These are therefore
593 #endif /* APR_CHARSET_EBCDIC */
596 * @defgroup values_requet_rec_body Possible values for request_rec.read_body
598 * Possible values for request_rec.read_body (set by handling module):
601 /** Send 413 error if message has any body */
602 #define REQUEST_NO_BODY 0
603 /** Send 411 error if body without Content-Length */
604 #define REQUEST_CHUNKED_ERROR 1
605 /** If chunked, remove the chunks for me. */
606 #define REQUEST_CHUNKED_DECHUNK 2
610 * Things which may vary per file-lookup WITHIN a request ---
611 * e.g., state of MIME config. Basically, the name of an object, info
612 * about the object, and any other info we may ahve which may need to
613 * change as we go poking around looking for it (e.g., overridden by
616 * Note how the default state of almost all these things is properly
617 * zero, so that allocating it with pcalloc does the right thing without
618 * a whole lot of hairy initialization... so long as we are willing to
619 * make the (fairly) portable assumption that the bit pattern of a NULL
620 * pointer is, in fact, zero.
624 * This represents the result of calling htaccess; these are cached for
627 struct htaccess_result {
628 /** the directory to which this applies */
630 /** the overrides allowed for the .htaccess file */
632 /** the configuration directives */
633 struct ap_conf_vector_t *htaccess;
634 /** the next one, or NULL if no more; N.B. never change this */
635 const struct htaccess_result *next;
638 /* The following four types define a hierarchy of activities, so that
639 * given a request_rec r you can write r->connection->server->process
640 * to get to the process_rec. While this reduces substantially the
641 * number of arguments that various hooks require beware that in
642 * threaded versions of the server you must consider multiplexing
646 /** A structure that represents one process */
647 typedef struct process_rec process_rec;
648 /** A structure that represents a virtual server */
649 typedef struct server_rec server_rec;
650 /** A structure that represents one connection */
651 typedef struct conn_rec conn_rec;
652 /** A structure that represents the current request */
653 typedef struct request_rec request_rec;
655 /* ### would be nice to not include this from httpd.h ... */
656 /* This comes after we have defined the request_rec type */
659 /** A structure that represents one process */
661 /** Global pool. Please try to cleared on _all_ exits */
663 /** aka configuration pool, cleared on restarts */
665 /** How many command line arguments were pass to the program */
667 /** The command line arguments */
668 const char * const *argv;
669 /** The program name used to execute the program */
670 const char *short_name;
673 /** A structure that represents the current request */
675 /** The pool associated with the request */
677 /** The connection over which this connection has been read */
678 conn_rec *connection;
679 /** The virtual host this request is for */
682 /** If we wind up getting redirected, pointer to the request we
685 /** If this is an internal redirect, pointer to where we redirected
689 /** If this is a sub_request (see request.h) pointer back to the
693 /* Info about the request itself... we begin with stuff that only
694 * protocol.c should ever touch...
696 /** First line of request, so we can log it */
698 /** HTTP/0.9, "simple" request */
700 /** A proxy request (calculated during post_read_request/translate_name)
701 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE
704 /** HEAD request, as opposed to GET */
706 /** Protocol, as given to us, or HTTP/0.9 */
708 /** Number version of protocol; 1.1 = 1001 */
710 /** Host, as set by full URI or Host: */
711 const char *hostname;
713 /** When the request started */
714 apr_time_t request_time;
716 /** Status line, if set by script */
717 const char *status_line;
721 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
722 * look, but don't touch.
725 /** GET, HEAD, POST, etc. */
727 /** M_GET, M_POST, etc. */
731 * allowed is a bitvector of the allowed methods.
733 * A handler must ensure that the request method is one that
734 * it is capable of handling. Generally modules should DECLINE
735 * any request methods they do not handle. Prior to aborting the
736 * handler like this the handler should set r->allowed to the list
737 * of methods that it is willing to handle. This bitvector is used
738 * to construct the "Allow:" header required for OPTIONS requests,
739 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
741 * Since the default_handler deals with OPTIONS, all modules can
742 * usually decline to deal with OPTIONS. TRACE is always allowed,
743 * modules don't need to set it explicitly.
745 * Since the default_handler will always handle a GET, a
746 * module which does *not* implement GET should probably return
747 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
748 * handler can't be installed by mod_actions.
751 /** Array of extension methods */
752 apr_array_header_t *allowed_xmethods;
753 /** List of allowed methods */
754 ap_method_list_t *allowed_methods;
756 /** byte count in stream is for body */
757 apr_off_t sent_bodyct;
758 /** body byte count, for easy access */
759 apr_off_t bytes_sent;
760 /** Time the resource was last modified */
763 /* HTTP/1.1 connection-level features */
765 /** sending chunked transfer-coding */
767 /** multipart/byteranges boundary */
768 const char *boundary;
769 /** The Range: header */
771 /** The "real" content length */
774 /** bytes left to read */
776 /** bytes that have been read */
777 apr_off_t read_length;
778 /** how the request body should be read */
780 /** reading chunked transfer-coding */
782 /** is client waiting for a 100 response? */
783 unsigned expecting_100;
785 /* MIME header environments, in and out. Also, an array containing
786 * environment variables to be passed to subprocesses, so people can
787 * write modules to add to that environment.
789 * The difference between headers_out and err_headers_out is that the
790 * latter are printed even on error, and persist across internal redirects
791 * (so the headers printed for ErrorDocument handlers will have them).
793 * The 'notes' apr_table_t is for notes from one module to another, with no
794 * other set purpose in mind...
797 /** MIME header environment from the request */
798 apr_table_t *headers_in;
799 /** MIME header environment for the response */
800 apr_table_t *headers_out;
801 /** MIME header environment for the response, printed even on errors and
802 * persist across internal redirects */
803 apr_table_t *err_headers_out;
804 /** Array of environment variables to be used for sub processes */
805 apr_table_t *subprocess_env;
806 /** Notes from one module to another */
809 /* content_type, handler, content_encoding, and all content_languages
810 * MUST be lowercased strings. They may be pointers to static strings;
811 * they should not be modified in place.
813 /** The content-type for the current request */
814 const char *content_type; /* Break these out --- we dispatch on 'em */
815 /** The handler string that we use to call a handler function */
816 const char *handler; /* What we *really* dispatch on */
818 /** How to encode the data */
819 const char *content_encoding;
820 /** array of (char*) representing the content languages */
821 apr_array_header_t *content_languages;
823 /** variant list validator (if negotiated) */
824 char *vlist_validator;
826 /** If an authentication check was made, this gets set to the user name. */
828 /** If an authentication check was made, this gets set to the auth type. */
831 /** This response is non-cache-able */
833 /** There is no local copy of this response */
836 /* What object is being requested (either directly, or via include
837 * or content-negotiation mapping).
840 /** the uri without any parsing performed */
842 /** the path portion of the URI */
844 /** The filename on disk that this response corresponds to */
846 /** The true filename, we canonicalize r->filename if these don't match */
847 char *canonical_filename;
848 /** The path_info for this request if there is any. */
850 /** QUERY_ARGS, if any */
852 /** ST_MODE set to zero if no such file */
854 /** components of uri, dismantled */
855 apr_uri_t parsed_uri;
857 /* Various other config info which may change with .htaccess files
858 * These are config vectors, with one void* pointer for each module
859 * (the thing pointed to being the module's business).
862 /** Options set in config files, etc. */
863 struct ap_conf_vector_t *per_dir_config;
864 /** Notes on *this* request */
865 struct ap_conf_vector_t *request_config;
868 * a linked list of the configuration directives in the .htaccess files
869 * accessed by this request.
870 * N.B. always add to the head of the list, _never_ to the end.
871 * that way, a sub request's list can (temporarily) point to a parent's list
873 const struct htaccess_result *htaccess;
875 /** A list of output filters to be used for this request */
876 struct ap_filter_t *output_filters;
877 /** A list of input filters to be used for this request */
878 struct ap_filter_t *input_filters;
879 /** A flag to determine if the eos bucket has been sent yet */
882 /* Things placed at the end of the record to avoid breaking binary
883 * compatibility. It would be nice to remember to reorder the entire
884 * record to improve 64bit alignment the next time we need to break
885 * binary compatibility for some other reason.
890 * @defgroup ProxyReq Proxy request types
892 * Possible values of request_rec->proxyreq. A request could be normal,
893 * proxied or reverse proxied. Normally proxied and reverse proxied are
894 * grouped together as just "proxied", but sometimes it's necessary to
895 * tell the difference between the two, such as for authentication.
899 #define PROXYREQ_NONE 0 /**< No proxy */
900 #define PROXYREQ_PROXY 1 /**< Standard proxy */
901 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
906 /** Structure to store things which are per connection */
908 /** Pool associated with this connection */
910 /** Physical vhost this conn came in on */
911 server_rec *base_server;
912 /** used by http_vhost.c */
913 void *vhost_lookup_data;
915 /* Information about the connection itself */
918 apr_sockaddr_t *local_addr;
919 /** remote address */
920 apr_sockaddr_t *remote_addr;
922 /** Client's IP address */
924 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
925 * "" if it has and no address was found. N.B. Only access this though
926 * get_remote_host() */
928 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
929 * get_remote_logname() */
930 char *remote_logname;
932 /** Are we still talking? */
935 /** Are we going to keep the connection alive for another request?
936 * -1 fatal error, 0 undecided, 1 yes */
937 signed int keepalive:2;
939 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
941 signed int double_reverse:2;
943 /** How many times have we used it? */
945 /** server IP address */
947 /** used for ap_get_server_name when UseCanonicalName is set to DNS
948 * (ignores setting of HostnameLookups) */
951 /** ID of this connection; unique at any point in time */
953 /** Notes on *this* connection */
954 struct ap_conf_vector_t *conn_config;
955 /** send note from one module to another, must remain valid for all
956 * requests on this conn */
958 /** A list of input filters to be used for this connection */
959 struct ap_filter_t *input_filters;
960 /** A list of output filters to be used for this connection */
961 struct ap_filter_t *output_filters;
964 /* Per-vhost config... */
967 * The address 255.255.255.255, when used as a virtualhost address,
968 * will become the "default" server when the ip doesn't match other vhosts.
970 #define DEFAULT_VHOST_ADDR 0xfffffffful
973 /** A structure to be used for Per-vhost config */
974 typedef struct server_addr_rec server_addr_rec;
975 struct server_addr_rec {
976 /** The next server in the list */
977 server_addr_rec *next;
978 /** The bound address, for this server */
979 apr_sockaddr_t *host_addr;
980 /** The bound port, for this server */
981 apr_port_t host_port;
982 /** The name given in <VirtualHost> */
986 /** A structure to store information for each virtual server */
988 /** The process this server is running in */
989 process_rec *process;
990 /** The next server in the list */
993 /** The name of the server */
994 const char *defn_name;
995 /** The line of the config file that the server was defined on */
996 unsigned defn_line_number;
998 /* Contact information */
1000 /** The admin's contact information */
1002 /** The server hostname */
1003 char *server_hostname;
1004 /** for redirects, etc. */
1007 /* Log files --- note that transfer log is now in the modules... */
1009 /** The name of the error log */
1011 /** A file descriptor that references the error log */
1012 apr_file_t *error_log;
1013 /** The log level for this server */
1016 /* Module-specific configuration for server, and defaults... */
1018 /** true if this is the virtual server */
1020 /** Config vector containing pointers to modules' per-server config
1022 struct ap_conf_vector_t *module_config;
1023 /** MIME type info, etc., before we start checking per-directory info */
1024 struct ap_conf_vector_t *lookup_defaults;
1026 /* Transaction handling */
1028 /** I haven't got a clue */
1029 server_addr_rec *addrs;
1030 /** Timeout, in seconds, before we give up */
1032 /** Seconds we'll wait for another request */
1033 int keep_alive_timeout;
1034 /** Maximum requests per connection */
1036 /** Use persistent connections? */
1039 /** Pathname for ServerPath */
1041 /** Length of path */
1044 /** Normal names for ServerAlias servers */
1045 apr_array_header_t *names;
1046 /** Wildcarded names for ServerAlias servers */
1047 apr_array_header_t *wild_names;
1049 /** limit on size of the HTTP request line */
1051 /** limit on size of any request header field */
1052 int limit_req_fieldsize;
1053 /** limit on number of request header fields */
1054 int limit_req_fields;
1057 typedef struct core_output_filter_ctx {
1058 apr_bucket_brigade *b;
1059 apr_pool_t *subpool; /* subpool of c->pool used for data saved after a
1060 * request is finished
1062 int subpool_has_stuff; /* anything in the subpool? */
1063 } core_output_filter_ctx_t;
1065 typedef struct core_filter_ctx {
1066 apr_bucket_brigade *b;
1069 typedef struct core_net_rec {
1070 /** Connection to the client */
1071 apr_socket_t *client_socket;
1073 /** connection record */
1076 core_output_filter_ctx_t *out_ctx;
1081 * Examine a field value (such as a media-/content-type) string and return
1082 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1083 * @param p Pool to allocate memory from
1084 * @param intype The field to examine
1085 * @return A copy of the field minus any parameters
1087 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1090 * Convert a time from an integer into a string in a specified format
1091 * @param p The pool to allocate memory from
1092 * @param t The time to convert
1093 * @param fmt The format to use for the conversion
1094 * @param gmt Convert the time for GMT?
1095 * @return The string that represents the specified time
1097 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1099 /* String handling. The *_nc variants allow you to use non-const char **s as
1100 arguments (unfortunately C won't automatically convert a char ** to a const
1104 * Get the characters until the first occurance of a specified character
1105 * @param p The pool to allocate memory from
1106 * @param line The string to get the characters from
1107 * @param stop The character to stop at
1108 * @return A copy of the characters up to the first stop character
1110 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1112 * Get the characters until the first occurance of a specified character
1113 * @param p The pool to allocate memory from
1114 * @param line The string to get the characters from
1115 * @param stop The character to stop at
1116 * @return A copy of the characters up to the first stop character
1117 * @note This is the same as ap_getword(), except it doesn't use const char **.
1119 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1122 * Get the first word from a given string. A word is defined as all characters
1123 * up to the first whitespace.
1124 * @param p The pool to allocate memory from
1125 * @param line The string to traverse
1126 * @return The first word in the line
1128 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1130 * Get the first word from a given string. A word is defined as all characters
1131 * up to the first whitespace.
1132 * @param p The pool to allocate memory from
1133 * @param line The string to traverse
1134 * @return The first word in the line
1135 * @note The same as ap_getword_white(), except it doesn't use const char **.
1137 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1140 * Get all characters from the first occurance of @a stop to the first '\0'
1141 * @param p The pool to allocate memory from
1142 * @param line The line to traverse
1143 * @param stop The character to start at
1144 * @return A copy of all caracters after the first occurance of the specified
1147 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1150 * Get all characters from the first occurance of @a stop to the first '\0'
1151 * @param p The pool to allocate memory from
1152 * @param line The line to traverse
1153 * @param stop The character to start at
1154 * @return A copy of all caracters after the first occurance of the specified
1156 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1158 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1161 * Get the second word in the string paying attention to quoting
1162 * @param p The pool to allocate from
1163 * @param line The line to traverse
1164 * @return A copy of the string
1166 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1168 * Get the second word in the string paying attention to quoting
1169 * @param p The pool to allocate from
1170 * @param line The line to traverse
1171 * @return A copy of the string
1172 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1174 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1177 * Check a string for any ${ENV} environment variable construct and replace
1178 * each them by the value of that environment variable, if it exists. If the
1179 * environment value does not exist, leave the ${ENV} construct alone; it
1180 * means something else.
1181 * @param p The pool to allocate from
1182 * @param word The string to check
1183 * @return The string with the replaced environment variables
1185 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1188 * Size an HTTP header field list item, as separated by a comma.
1189 * @param field The field to size
1190 * @param len The length of the field
1191 * @return The return value is a pointer to the beginning of the non-empty
1192 * list item within the original string (or NULL if there is none) and the
1193 * address of field is shifted to the next non-comma, non-whitespace
1194 * character. len is the length of the item excluding any beginning whitespace.
1196 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1199 * Retrieve an HTTP header field list item, as separated by a comma,
1200 * while stripping insignificant whitespace and lowercasing anything not in
1201 * a quoted string or comment.
1202 * @param p The pool to allocate from
1203 * @param field The field to retrieve
1204 * @return The return value is a new string containing the converted list
1205 * item (or NULL if none) and the address pointed to by field is
1206 * shifted to the next non-comma, non-whitespace.
1208 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1211 * Find an item in canonical form (lowercase, no extra spaces) within
1212 * an HTTP field value list.
1213 * @param p The pool to allocate from
1214 * @param line The field value list to search
1215 * @param tok The token to search for
1216 * @return 1 if found, 0 if not found.
1218 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1221 * Retrieve a token, spacing over it and returning a pointer to
1222 * the first non-white byte afterwards. Note that these tokens
1223 * are delimited by semis and commas and can also be delimited
1224 * by whitespace at the caller's option.
1225 * @param p The pool to allocate from
1226 * @param accept_line The line to retrieve the token from
1227 * @param accept_white Is it delimited by whitespace
1228 * @return the first non-white byte after the token
1230 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1233 * Find http tokens, see the definition of token from RFC2068
1234 * @param p The pool to allocate from
1235 * @param line The line to find the token
1236 * @param tok The token to find
1237 * @return 1 if the token is found, 0 otherwise
1239 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1242 * find http tokens from the end of the line
1243 * @param p The pool to allocate from
1244 * @param line The line to find the token
1245 * @param tok The token to find
1246 * @return 1 if the token is found, 0 otherwise
1248 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1251 * Check for an Absolute URI syntax
1252 * @param u The string to check
1253 * @return 1 if URI, 0 otherwise
1255 AP_DECLARE(int) ap_is_url(const char *u);
1259 * @param url The url to unescapte
1260 * @return 0 on success, non-zero otherwise
1262 AP_DECLARE(int) ap_unescape_url(char *url);
1264 * Convert all double slashes to single slashes
1265 * @param name The string to convert
1267 AP_DECLARE(void) ap_no2slash(char *name);
1270 * Remove all ./ and xx/../ substrings from a file name. Also remove
1271 * any leading ../ or /../ substrings.
1272 * @param name the file name to parse
1274 AP_DECLARE(void) ap_getparents(char *name);
1277 * Escape a path segment, as defined in RFC 1808
1278 * @param p The pool to allocate from
1279 * @param s The path to convert
1280 * @return The converted URL
1282 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1284 * convert an OS path to a URL in an OS dependant way.
1285 * @param p The pool to allocate from
1286 * @param path The path to convert
1287 * @param partial if set, assume that the path will be appended to something
1288 * with a '/' in it (and thus does not prefix "./")
1289 * @return The converted URL
1291 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1292 /** @see ap_os_escape_path */
1293 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1296 * Escape an html string
1297 * @param p The pool to allocate from
1298 * @param s The html to escape
1299 * @return The escaped string
1301 AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
1304 * Construct a full hostname
1305 * @param p The pool to allocate from
1306 * @param hostname The hostname of the server
1307 * @param port The port the server is running on
1308 * @param r The current request
1309 * @return The server's hostname
1311 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1312 apr_port_t port, const request_rec *r);
1314 * Escape a shell command
1315 * @param p The pool to allocate from
1316 * @param s The command to escape
1317 * @return The escaped shell command
1319 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1322 * Count the number of directories in a path
1323 * @param path The path to count
1324 * @return The number of directories
1326 AP_DECLARE(int) ap_count_dirs(const char *path);
1329 * Copy at most @a n leading directories of @a s into @a d. @a d
1330 * should be at least as large as @a s plus 1 extra byte
1332 * @param d The location to copy to
1333 * @param s The location to copy from
1334 * @param n The number of directories to copy
1335 * @return value is the ever useful pointer to the trailing \0 of d
1336 * @note on platforms with drive letters, n = 0 returns the "/" root,
1337 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1338 * returns the empty string. */
1339 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1342 * Return the parent directory name (including trailing /) of the file
1344 * @param p The pool to allocate from
1345 * @param s The file to get the parent of
1346 * @return A copy of the file's parent directory
1348 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1351 * Given a directory and filename, create a single path from them. This
1352 * function is smart enough to ensure that there is a sinlge '/' between the
1353 * directory and file names
1354 * @param a The pool to allocate from
1355 * @param dir The directory name
1356 * @param f The filename
1357 * @return A copy of the full path
1358 * @tip Never consider using this function if you are dealing with filesystem
1359 * names that need to remain canonical, unless you are merging an apr_dir_read
1360 * path and returned filename. Otherwise, the result is not canonical.
1362 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1365 * Test if the given path has an an absolute path.
1366 * @param p The pool to allocate from
1367 * @param dir The directory name
1368 * @tip The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1369 * multiple forms of absolute paths. This only reports if the path is absolute
1370 * in a canonical sense.
1372 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1375 * Does the provided string contain wildcard characters? This is useful
1376 * for determining if the string should be passed to strcmp_match or to strcmp.
1377 * The only wildcard characters recognized are '?' and '*'
1378 * @param str The string to check
1379 * @return 1 if the string has wildcards, 0 otherwise
1381 AP_DECLARE(int) ap_is_matchexp(const char *str);
1384 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1385 * @param str The string to check
1386 * @param exp The pattern to match against
1387 * @return 1 if the two strings match, 0 otherwise
1389 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *exp);
1391 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1393 * @param str The string to check
1394 * @param exp The pattern to match against
1395 * @return 1 if the two strings match, 0 otherwise
1397 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *exp);
1400 * Find the first occurrence of the substring s2 in s1, regardless of case
1401 * @param s1 The string to search
1402 * @param s2 The substring to search for
1403 * @return A pointer to the beginning of the substring
1405 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1408 * Return a pointer to the location inside of bigstring immediately after prefix
1409 * @param bigstring The input string
1410 * @param prefix The prefix to strip away
1411 * @return A pointer relative to bigstring after prefix
1413 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1414 const char *prefix);
1417 * Decode a base64 encoded string into memory allocated from a pool
1418 * @param p The pool to allocate from
1419 * @param bufcoded The encoded string
1420 * @return The decoded string
1422 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1425 * Encode a string into memory allocated from a pool in base 64 format
1426 * @param p The pool to allocate from
1427 * @param strin The plaintext string
1428 * @return The encoded string
1430 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1434 * Compile a regular expression to be used later
1435 * @param p The pool to allocate from
1436 * @param pattern the regular expression to compile
1437 * @param cflags The bitwise or of one or more of the following:
1438 * @li #REG_EXTENDED - Use POSIX extended Regular Expressions
1439 * @li #REG_ICASE - Ignore case
1440 * @li #REG_NOSUB - Support for substring addressing of matches
1442 * @li #REG_NEWLINE - Match-any-character operators don't match new-line
1443 * @return The compiled regular expression
1445 AP_DECLARE(regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1449 * Free the memory associated with a compiled regular expression
1450 * @param p The pool the regex was allocated from
1451 * @param reg The regular expression to free
1453 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, regex_t *reg);
1456 * Match a null-terminated string against a pre-compiled regex.
1457 * @param preg The pre-compiled regex
1458 * @param string The string to match
1459 * @param nmatch Provide information regarding the location of any matches
1460 * @param pmatch Provide information regarding the location of any matches
1461 * @param eflags Bitwise or of any of:
1462 * @li #REG_NOTBOL - match-beginning-of-line operator always
1464 * @li #REG_NOTEOL - match-end-of-line operator always fails to match
1465 * @return 0 for successful match, #REG_NOMATCH otherwise
1467 AP_DECLARE(int) ap_regexec(regex_t *preg, const char *string,
1468 size_t nmatch, regmatch_t pmatch[], int eflags);
1471 * Return the error code returned by regcomp or regexec into error messages
1472 * @param errcode the error code returned by regexec or regcomp
1473 * @param preg The precompiled regex
1474 * @param errbuf A buffer to store the error in
1475 * @param errbuf_size The size of the buffer
1477 AP_DECLARE(size_t) ap_regerror(int errcode, const regex_t *preg,
1478 char *errbuf, size_t errbuf_size);
1481 * After performing a successful regex match, you may use this function to
1482 * perform a series of string substitutions based on subexpressions that were
1483 * matched during the call to ap_regexec
1484 * @param p The pool to allocate from
1485 * @param input An arbitrary string containing $1 through $9. These are
1486 * replaced with the corresponding matched sub-expressions
1487 * @param source The string that was originally matched to the regex
1488 * @param nmatch the nmatch returned from ap_pregex
1489 * @param pmatch the pmatch array returned from ap_pregex
1491 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1492 size_t nmatch, regmatch_t pmatch[]);
1495 * We want to downcase the type/subtype for comparison purposes
1496 * but nothing else because ;parameter=foo values are case sensitive.
1497 * @param s The content-type to convert to lowercase
1499 AP_DECLARE(void) ap_content_type_tolower(char *s);
1502 * convert a string to all lowercase
1503 * @param s The string to convert to lowercase
1505 AP_DECLARE(void) ap_str_tolower(char *s);
1508 * Search a string from left to right for the first occurrence of a
1509 * specific character
1510 * @param str The string to search
1511 * @param c The character to search for
1512 * @return The index of the first occurrence of c in str
1514 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1517 * Search a string from right to left for the first occurrence of a
1518 * specific character
1519 * @param str The string to search
1520 * @param c The character to search for
1521 * @return The index of the first occurrence of c in str
1523 AP_DECLARE(int) ap_rind(const char *str, char c);
1526 * Given a string, replace any bare " with \" .
1527 * @param p The pool to allocate memory from
1528 * @param instring The string to search for "
1529 * @return A copy of the string with escaped quotes
1531 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1533 /* Misc system hackery */
1535 * Given the name of an object in the file system determine if it is a directory
1536 * @param p The pool to allocate from
1537 * @param name The name of the object to check
1538 * @return 1 if it is a directory, 0 otherwise
1540 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1543 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1544 * @param p The pool to allocate from
1545 * @param name The name of the object to check
1546 * @return 1 if it is a directory, 0 otherwise
1548 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1551 extern const char *os_set_account(apr_pool_t *p, const char *account);
1552 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1553 #endif /* _OSD_POSIX */
1556 * Determine the local host name for the current machine
1557 * @param p The pool to allocate from
1558 * @return A copy of the local host name
1560 char *ap_get_local_host(apr_pool_t *p);
1563 * Log an assertion to the error log
1564 * @param szExp The assertion that failed
1565 * @param szFile The file the assertion is in
1566 * @param nLine The line the assertion is defined on
1568 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1569 __attribute__((noreturn));
1572 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1575 * Redefine assert() to something more useful for an Apache...
1577 * Use ap_assert() if the condition should always be checked.
1578 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1583 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1585 #define AP_DEBUG_ASSERT(exp) ((void)0)
1589 * @defgroup stopsignal flags which indicate places where the sever should stop for debugging.
1591 * A set of flags which indicate places where the server should raise(SIGSTOP).
1592 * This is useful for debugging, because you can then attach to that process
1593 * with gdb and continue. This is important in cases where one_process
1594 * debugging isn't possible.
1596 /** stop on a Detach */
1597 #define SIGSTOP_DETACH 1
1598 /** stop making a child process */
1599 #define SIGSTOP_MAKE_CHILD 2
1600 /** stop spawning a child process */
1601 #define SIGSTOP_SPAWN_CHILD 4
1602 /** stop spawning a child process with a piped log */
1603 #define SIGSTOP_PIPED_LOG_SPAWN 8
1604 /** stop spawning a CGI child process */
1605 #define SIGSTOP_CGI_CHILD 16
1607 /** Macro to get GDB started */
1608 #ifdef DEBUG_SIGSTOP
1609 extern int raise_sigstop_flags;
1610 #define RAISE_SIGSTOP(x) do { \
1611 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1614 #define RAISE_SIGSTOP(x)
1618 * Get HTML describing the address and (optionally) admin of the server.
1619 * @param prefix Text which is prepended to the return value
1620 * @param r The request_rec
1621 * @return HTML describing the server, allocated in @a r's pool.
1623 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1625 /** strtoul does not exist on sunos4. */
1629 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1631 /* The C library has functions that allow const to be silently dropped ...
1632 these macros detect the drop in maintainer mode, but use the native
1633 methods for normal builds
1635 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1636 to be included before the macros are defined or compilation will fail.
1643 # define strchr(s, c) ap_strchr(s,c)
1645 # define strrchr(s, c) ap_strrchr(s,c)
1647 # define strstr(s, c) ap_strstr(s,c)
1649 char *ap_strchr(char *s, int c);
1650 const char *ap_strchr_c(const char *s, int c);
1651 char *ap_strrchr(char *s, int c);
1652 const char *ap_strrchr_c(const char *s, int c);
1653 char *ap_strstr(char *s, const char *c);
1654 const char *ap_strstr_c(const char *s, const char *c);
1658 /** use this instead of strchr */
1659 # define ap_strchr(s, c) strchr(s, c)
1660 /** use this instead of strchr */
1661 # define ap_strchr_c(s, c) strchr(s, c)
1662 /** use this instead of strrchr */
1663 # define ap_strrchr(s, c) strrchr(s, c)
1664 /** use this instead of strrchr */
1665 # define ap_strrchr_c(s, c) strrchr(s, c)
1666 /** use this instead of strrstr*/
1667 # define ap_strstr(s, c) strstr(s, c)
1668 /** use this instead of strrstr*/
1669 # define ap_strstr_c(s, c) strstr(s, c)
1673 #define AP_NORESTART APR_OS_START_USEERR + 1
1679 #endif /* !APACHE_HTTPD_H */