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"
84 #include "pcreposix.h"
86 /* Note: util_uri.h is also included, see below */
94 /* ----------------------------- config dir ------------------------------ */
96 /* Define this to be the default server home dir. Most things later in this
97 * file with a relative pathname will have this added.
101 /* Set default for OS/2 file system */
102 #define HTTPD_ROOT "/os2httpd"
104 /* Set default for Windows file system */
105 #define HTTPD_ROOT "/apache"
107 /* Set the default for BeOS */
108 #define HTTPD_ROOT "/boot/home/apache"
109 #elif defined (NETWARE)
110 /* Set the default for NetWare */
111 #define HTTPD_ROOT "/apache"
113 #define HTTPD_ROOT "/usr/local/apache"
115 #endif /* HTTPD_ROOT */
118 * --------- You shouldn't have to edit anything below this line ----------
120 * Any modifications to any defaults not defined above should be done in the
121 * respective configuration file.
125 /* Default location of documents. Can be overridden by the DocumentRoot
128 #ifndef DOCUMENT_LOCATION
130 /* Set default for OS/2 file system */
131 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
133 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
135 #endif /* DOCUMENT_LOCATION */
137 /* Maximum number of dynamically loaded modules */
138 #ifndef DYNAMIC_MODULE_LIMIT
139 #define DYNAMIC_MODULE_LIMIT 64
142 /* Default administrator's address */
143 #define DEFAULT_ADMIN "[no address given]"
145 /* The name of the log files */
146 #ifndef DEFAULT_ERRORLOG
147 #if defined(OS2) || defined(WIN32)
148 #define DEFAULT_ERRORLOG "logs/error.log"
150 #define DEFAULT_ERRORLOG "logs/error_log"
152 #endif /* DEFAULT_ERRORLOG */
154 /* Define this to be what your per-directory security files are called */
155 #ifndef DEFAULT_ACCESS_FNAME
157 /* Set default for OS/2 file system */
158 #define DEFAULT_ACCESS_FNAME "htaccess"
160 #define DEFAULT_ACCESS_FNAME ".htaccess"
162 #endif /* DEFAULT_ACCESS_FNAME */
164 /* The name of the server config file */
165 #ifndef SERVER_CONFIG_FILE
166 #define SERVER_CONFIG_FILE "conf/httpd.conf"
169 /* Whether we should enable rfc1413 identity checking */
170 #ifndef DEFAULT_RFC1413
171 #define DEFAULT_RFC1413 0
174 /* The default path for CGI scripts if none is currently set */
176 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
179 /* The path to the suExec wrapper, can be overridden in Configuration */
181 #define SUEXEC_BIN HTTPD_ROOT "/sbin/suexec"
184 /* The timeout for waiting for messages */
185 #ifndef DEFAULT_TIMEOUT
186 #define DEFAULT_TIMEOUT 300
189 /* The timeout for waiting for keepalive timeout until next request */
190 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
191 #define DEFAULT_KEEPALIVE_TIMEOUT 15
194 /* The number of requests to entertain per connection */
195 #ifndef DEFAULT_KEEPALIVE
196 #define DEFAULT_KEEPALIVE 100
199 /* Limits on the size of various request items. These limits primarily
200 * exist to prevent simple denial-of-service attacks on a server based
201 * on misuse of the protocol. The recommended values will depend on the
202 * nature of the server resources -- CGI scripts and database backends
203 * might require large values, but most servers could get by with much
204 * smaller limits than we use below. The request message body size can
205 * be limited by the per-dir config directive LimitRequestBody.
207 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
208 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
209 * These two limits can be lowered (but not raised) by the server config
210 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
212 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
213 * the server config directive LimitRequestFields.
215 #ifndef DEFAULT_LIMIT_REQUEST_LINE
216 #define DEFAULT_LIMIT_REQUEST_LINE 8190
217 #endif /* default limit on bytes in Request-Line (Method+URI+HTTP-version) */
218 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
219 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
220 #endif /* default limit on bytes in any one header field */
221 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
222 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
223 #endif /* default limit on number of request header fields */
227 * The default default character set name to add if AddDefaultCharset is
228 * enabled. Overridden with AddDefaultCharsetName.
230 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
232 #endif /* CORE_PRIVATE */
234 #define AP_SERVER_PROTOCOL "HTTP/1.1"
237 /* ------------------ stuff that modules are allowed to look at ----------- */
239 /* Define this to be what your HTML directory content files are called */
240 #ifndef AP_DEFAULT_INDEX
241 #define AP_DEFAULT_INDEX "index.html"
245 /* Define this to be what type you'd like returned for files with unknown */
246 /* suffixes. MUST be all lower case. */
247 #ifndef DEFAULT_CONTENT_TYPE
248 #define DEFAULT_CONTENT_TYPE "text/plain"
251 /* The name of the MIME types file */
252 #ifndef AP_TYPES_CONFIG_FILE
253 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
257 * Define the HTML doctype strings centrally.
259 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
260 "DTD HTML 2.0//EN\">\n"
261 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
262 "DTD HTML 3.2 Final//EN\">\n"
263 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
264 "DTD HTML 4.0//EN\"\n" \
265 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
266 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
267 "DTD HTML 4.0 Transitional//EN\"\n" \
268 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
269 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
270 "DTD HTML 4.0 Frameset//EN\"\n" \
271 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
273 /* -- Internal representation for a HTTP protocol number, e.g., HTTP/1.1 -- */
275 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
276 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
277 #define HTTP_VERSION_MINOR(number) ((number)%1000)
279 /* -------------- Port number for server running standalone --------------- */
281 #define DEFAULT_HTTP_PORT 80
282 #define DEFAULT_HTTPS_PORT 443
284 * Check whether @a port is the default port for the request @a r.
285 * @param port The port number
286 * @param r The request
287 * @see #ap_default_port
289 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
291 * Get the default port for a request (which depends on the scheme).
292 * @param r The request
294 #define ap_default_port(r) ap_run_default_port(r)
296 * Get the scheme for a request.
297 * @param r The request
298 * @bug This should be called ap_http_scheme!
300 #define ap_http_method(r) ap_run_http_method(r)
302 /* The default string lengths */
303 #define MAX_STRING_LEN HUGE_STRING_LEN
304 #define HUGE_STRING_LEN 8192
306 /* The size of the server's internal read-write buffers */
307 #define AP_IOBUFSIZE 8192
309 /* APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
310 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
311 * than that in case the brigade code/filters attempt to read it directly.
312 * ### 4mb is an invention, no idea if it is reasonable.
314 #define AP_MAX_SENDFILE 16777216
318 * Special Apache error codes. These are basically used
319 * in http_main.c so we can keep track of various errors.
324 * A fatal error arising during the server's init sequence
326 * The child died during its init sequence
328 * A fatal error, resulting in the whole server aborting.
329 * If a child exits with this error, the parent process
330 * considers this a server-wide fatal error and aborts.
333 #define APEXIT_OK 0x0
334 #define APEXIT_INIT 0x2
335 #define APEXIT_CHILDINIT 0x3
336 #define APEXIT_CHILDFATAL 0xf
341 * Stuff marked #AP_DECLARE is part of the API, and intended for use
342 * by modules. Its purpose is to allow us to add attributes that
343 * particular platforms or compilers require to every exported function.
345 # define AP_DECLARE(type) type
348 #ifndef AP_DECLARE_NONSTD
350 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
351 * use by modules. The difference between #AP_DECLARE and
352 * #AP_DECLARE_NONSTD is that the latter is required for any functions
353 * which use varargs or are used via indirect function call. This
354 * is to accomodate the two calling conventions in windows dlls.
356 # define AP_DECLARE_NONSTD(type) type
358 #ifndef AP_DECLARE_DATA
359 # define AP_DECLARE_DATA
362 #ifndef AP_MODULE_DECLARE
363 # define AP_MODULE_DECLARE(type) type
365 #ifndef AP_MODULE_DECLARE_NONSTD
366 # define AP_MODULE_DECLARE_NONSTD(type) type
368 #ifndef AP_MODULE_DECLARE_DATA
369 # define AP_MODULE_DECLARE_DATA
372 /* modules should not used functions marked AP_CORE_DECLARE
373 * or AP_CORE_DECLARE_NONSTD */
374 #ifndef AP_CORE_DECLARE
375 # define AP_CORE_DECLARE AP_DECLARE
377 #ifndef AP_CORE_DECLARE_NONSTD
378 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
382 * Get the server version string
383 * @return The server version string
385 AP_DECLARE(const char *) ap_get_server_version(void);
388 * Add a component to the version string
389 * @param pconf The pool to allocate the component from
390 * @param component The string to add
392 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
395 * Get the date a time that the server was built
396 * @return The server build time string
398 AP_DECLARE(const char *) ap_get_server_built(void);
400 #define DECLINED -1 /* Module declines to handle */
401 #define DONE -2 /* Module has served the response completely
402 * - it's safe to die() with no more output
404 #define OK 0 /* Module has handled this stage. */
407 /* ----------------------- HTTP Status Codes ------------------------- */
409 /* The size of the static array in http_protocol.c for storing
410 * all of the potential response status-lines (a sparse table).
411 * A future version should dynamically generate the apr_table_t at startup.
413 #define RESPONSE_CODES 55
415 #define HTTP_CONTINUE 100
416 #define HTTP_SWITCHING_PROTOCOLS 101
417 #define HTTP_PROCESSING 102
419 #define HTTP_CREATED 201
420 #define HTTP_ACCEPTED 202
421 #define HTTP_NON_AUTHORITATIVE 203
422 #define HTTP_NO_CONTENT 204
423 #define HTTP_RESET_CONTENT 205
424 #define HTTP_PARTIAL_CONTENT 206
425 #define HTTP_MULTI_STATUS 207
426 #define HTTP_MULTIPLE_CHOICES 300
427 #define HTTP_MOVED_PERMANENTLY 301
428 #define HTTP_MOVED_TEMPORARILY 302
429 #define HTTP_SEE_OTHER 303
430 #define HTTP_NOT_MODIFIED 304
431 #define HTTP_USE_PROXY 305
432 #define HTTP_TEMPORARY_REDIRECT 307
433 #define HTTP_BAD_REQUEST 400
434 #define HTTP_UNAUTHORIZED 401
435 #define HTTP_PAYMENT_REQUIRED 402
436 #define HTTP_FORBIDDEN 403
437 #define HTTP_NOT_FOUND 404
438 #define HTTP_METHOD_NOT_ALLOWED 405
439 #define HTTP_NOT_ACCEPTABLE 406
440 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
441 #define HTTP_REQUEST_TIME_OUT 408
442 #define HTTP_CONFLICT 409
443 #define HTTP_GONE 410
444 #define HTTP_LENGTH_REQUIRED 411
445 #define HTTP_PRECONDITION_FAILED 412
446 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
447 #define HTTP_REQUEST_URI_TOO_LARGE 414
448 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
449 #define HTTP_RANGE_NOT_SATISFIABLE 416
450 #define HTTP_EXPECTATION_FAILED 417
451 #define HTTP_UNPROCESSABLE_ENTITY 422
452 #define HTTP_LOCKED 423
453 #define HTTP_FAILED_DEPENDENCY 424
454 #define HTTP_INTERNAL_SERVER_ERROR 500
455 #define HTTP_NOT_IMPLEMENTED 501
456 #define HTTP_BAD_GATEWAY 502
457 #define HTTP_SERVICE_UNAVAILABLE 503
458 #define HTTP_GATEWAY_TIME_OUT 504
459 #define HTTP_VERSION_NOT_SUPPORTED 505
460 #define HTTP_VARIANT_ALSO_VARIES 506
461 #define HTTP_INSUFFICIENT_STORAGE 507
462 #define HTTP_NOT_EXTENDED 510
464 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
465 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
466 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
467 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
468 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
469 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
471 #define ap_status_drops_connection(x) \
472 (((x) == HTTP_BAD_REQUEST) || \
473 ((x) == HTTP_REQUEST_TIME_OUT) || \
474 ((x) == HTTP_LENGTH_REQUIRED) || \
475 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
476 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
477 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
478 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
479 ((x) == HTTP_NOT_IMPLEMENTED))
481 /* Methods recognized (but not necessarily handled) by the server.
482 * These constants are used in bit shifting masks of size int, so it is
483 * unsafe to have more methods than bits in an int. HEAD == M_GET.
484 * This list must be tracked by the list in http_protocol.c in routine
485 * ap_method_name_of().
496 #define M_PROPPATCH 9
504 /* METHODS needs to be equal to the number of bits
505 * we are using for limit masks.
510 * The method mask bit to shift for anding with a bitmask.
512 #define AP_METHOD_BIT (apr_int64_t)1
515 typedef struct ap_method_list_t ap_method_list_t;
517 * Structure for handling HTTP methods. Methods known to the server are
518 * accessed via a bitmask shortcut; extension methods are handled by
521 struct ap_method_list_t {
522 /* The bitmask used for known methods */
523 apr_int64_t method_mask;
524 /* the array used for extension methods */
525 apr_array_header_t *method_list;
528 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
529 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
530 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
531 #define DIR_MAGIC_TYPE "httpd/unix-directory"
533 /* Just in case your linefeed isn't the one the other end is expecting. */
534 #if !APR_CHARSET_EBCDIC
537 #define CRLF "\015\012"
538 #else /* APR_CHARSET_EBCDIC */
539 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
540 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
541 * "native EBCDIC" CR and NL characters. These are therefore
548 #endif /* APR_CHARSET_EBCDIC */
550 /* Possible values for request_rec.read_body (set by handling module):
551 * REQUEST_NO_BODY Send 413 error if message has any body
552 * REQUEST_CHUNKED_ERROR Send 411 error if body without Content-Length
553 * REQUEST_CHUNKED_DECHUNK If chunked, remove the chunks for me.
555 #define REQUEST_NO_BODY 0
556 #define REQUEST_CHUNKED_ERROR 1
557 #define REQUEST_CHUNKED_DECHUNK 2
559 /* Things which may vary per file-lookup WITHIN a request ---
560 * e.g., state of MIME config. Basically, the name of an object, info
561 * about the object, and any other info we may ahve which may need to
562 * change as we go poking around looking for it (e.g., overridden by
565 * Note how the default state of almost all these things is properly
566 * zero, so that allocating it with pcalloc does the right thing without
567 * a whole lot of hairy initialization... so long as we are willing to
568 * make the (fairly) portable assumption that the bit pattern of a NULL
569 * pointer is, in fact, zero.
573 * This represents the result of calling htaccess; these are cached for
576 struct htaccess_result {
577 /** the directory to which this applies */
579 /** the overrides allowed for the .htaccess file */
581 /** the configuration directives */
582 struct ap_conf_vector_t *htaccess;
583 /** the next one, or NULL if no more; N.B. never change this */
584 const struct htaccess_result *next;
587 /* The following four types define a hierarchy of activities, so that
588 * given a request_rec r you can write r->connection->server->process
589 * to get to the process_rec. While this reduces substantially the
590 * number of arguments that various hooks require beware that in
591 * threaded versions of the server you must consider multiplexing
594 typedef struct process_rec process_rec;
595 typedef struct server_rec server_rec;
596 typedef struct conn_rec conn_rec;
597 typedef struct request_rec request_rec;
599 /* ### would be nice to not include this from httpd.h ... */
600 /* This comes after we have defined the request_rec type */
603 /** A structure that represents one process */
605 /** Global pool. Please try to cleared on _all_ exits */
607 /** aka configuration pool, cleared on restarts */
609 /** How many command line arguments were pass to the program */
611 /** The command line arguments */
612 const char * const *argv;
613 /** The program name used to execute the program */
614 const char *short_name;
617 /** A structure that represents the current request */
619 /** The pool associated with the request */
621 /** The connection over which this connection has been read */
622 conn_rec *connection;
623 /** The virtual host this request is for */
626 /** If we wind up getting redirected, pointer to the request we
629 /** If this is an internal redirect, pointer to where we redirected
633 /** If this is a sub_request (see request.h) pointer back to the
637 /* Info about the request itself... we begin with stuff that only
638 * protocol.c should ever touch...
640 /** First line of request, so we can log it */
642 /** HTTP/0.9, "simple" request */
644 /** A proxy request (calculated during post_read_request/translate_name)
645 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE
648 /** HEAD request, as opposed to GET */
650 /** Protocol, as given to us, or HTTP/0.9 */
652 /** Number version of protocol; 1.1 = 1001 */
654 /** Host, as set by full URI or Host: */
655 const char *hostname;
657 /** When the request started */
658 apr_time_t request_time;
660 /** Status line, if set by script */
661 const char *status_line;
665 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
666 * look, but don't touch.
669 /** GET, HEAD, POST, etc. */
671 /** M_GET, M_POST, etc. */
675 * allowed is a bitvector of the allowed methods.
677 * A handler must ensure that the request method is one that
678 * it is capable of handling. Generally modules should DECLINE
679 * any request methods they do not handle. Prior to aborting the
680 * handler like this the handler should set r->allowed to the list
681 * of methods that it is willing to handle. This bitvector is used
682 * to construct the "Allow:" header required for OPTIONS requests,
683 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
685 * Since the default_handler deals with OPTIONS, all modules can
686 * usually decline to deal with OPTIONS. TRACE is always allowed,
687 * modules don't need to set it explicitly.
689 * Since the default_handler will always handle a GET, a
690 * module which does *not* implement GET should probably return
691 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
692 * handler can't be installed by mod_actions.
695 /** Array of extension methods */
696 apr_array_header_t *allowed_xmethods;
697 /** List of allowed methods */
698 ap_method_list_t *allowed_methods;
700 /** byte count in stream is for body */
701 apr_off_t sent_bodyct;
702 /** body byte count, for easy access */
703 apr_off_t bytes_sent;
704 /** Time the resource was last modified */
707 /* HTTP/1.1 connection-level features */
709 /** sending chunked transfer-coding */
711 /** multipart/byteranges boundary */
712 const char *boundary;
713 /** The Range: header */
715 /** The "real" content length */
718 /** bytes left to read */
720 /** bytes that have been read */
721 apr_off_t read_length;
722 /** how the request body should be read */
724 /** reading chunked transfer-coding */
726 /** is client waiting for a 100 response? */
727 unsigned expecting_100;
729 /* MIME header environments, in and out. Also, an array containing
730 * environment variables to be passed to subprocesses, so people can
731 * write modules to add to that environment.
733 * The difference between headers_out and err_headers_out is that the
734 * latter are printed even on error, and persist across internal redirects
735 * (so the headers printed for ErrorDocument handlers will have them).
737 * The 'notes' apr_table_t is for notes from one module to another, with no
738 * other set purpose in mind...
741 /** MIME header environment from the request */
742 apr_table_t *headers_in;
743 /** MIME header environment for the response */
744 apr_table_t *headers_out;
745 /** MIME header environment for the response, printed even on errors and
746 * persist across internal redirects */
747 apr_table_t *err_headers_out;
748 /** Array of environment variables to be used for sub processes */
749 apr_table_t *subprocess_env;
750 /** Notes from one module to another */
753 /* content_type, handler, content_encoding, content_language, and all
754 * content_languages MUST be lowercased strings. They may be pointers
755 * to static strings; they should not be modified in place.
757 /** The content-type for the current request */
758 const char *content_type; /* Break these out --- we dispatch on 'em */
759 /** The handler string that we use to call a handler function */
760 const char *handler; /* What we *really* dispatch on */
762 /** How to encode the data */
763 const char *content_encoding;
764 /** for back-compat. only -- do not use */
765 const char *content_language;
766 /** array of (char*) representing the content languages */
767 apr_array_header_t *content_languages;
769 /** variant list validator (if negotiated) */
770 char *vlist_validator;
772 /** If an authentication check was made, this gets set to the user name. */
774 /** If an authentication check was made, this gets set to the auth type. */
777 /** This response is non-cache-able */
779 /** There is no local copy of this response */
782 /* What object is being requested (either directly, or via include
783 * or content-negotiation mapping).
786 /** the uri without any parsing performed */
788 /** the path portion of the URI */
790 /** The filename on disk that this response corresponds to */
792 /** The true filename, we canonicalize r->filename if these don't match */
793 char *canonical_filename;
794 /** The path_info for this request if there is any. */
796 /** QUERY_ARGS, if any */
798 /** ST_MODE set to zero if no such file */
800 /** components of uri, dismantled */
801 apr_uri_t parsed_uri;
803 /* Various other config info which may change with .htaccess files
804 * These are config vectors, with one void* pointer for each module
805 * (the thing pointed to being the module's business).
808 /** Options set in config files, etc. */
809 struct ap_conf_vector_t *per_dir_config;
810 /** Notes on *this* request */
811 struct ap_conf_vector_t *request_config;
814 * a linked list of the configuration directives in the .htaccess files
815 * accessed by this request.
816 * N.B. always add to the head of the list, _never_ to the end.
817 * that way, a sub request's list can (temporarily) point to a parent's list
819 const struct htaccess_result *htaccess;
821 /** A list of output filters to be used for this request */
822 struct ap_filter_t *output_filters;
823 /** A list of input filters to be used for this request */
824 struct ap_filter_t *input_filters;
825 /** A flag to determine if the eos bucket has been sent yet */
828 /* Things placed at the end of the record to avoid breaking binary
829 * compatibility. It would be nice to remember to reorder the entire
830 * record to improve 64bit alignment the next time we need to break
831 * binary compatibility for some other reason.
836 * @defgroup ProxyReq Proxy request types
838 * Possible values of request_rec->proxyreq. A request could be normal,
839 * proxied or reverse proxied. Normally proxied and reverse proxied are
840 * grouped together as just "proxied", but sometimes it's necessary to
841 * tell the difference between the two, such as for authentication.
845 #define PROXYREQ_NONE 0 /**< No proxy */
846 #define PROXYREQ_PROXY 1 /**< Standard proxy */
847 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
852 /** Structure to store things which are per connection */
854 /** Pool associated with this connection */
856 /** Physical vhost this conn came in on */
857 server_rec *base_server;
858 /** used by http_vhost.c */
859 void *vhost_lookup_data;
861 /* Information about the connection itself */
863 /** Connection to the client */
864 apr_socket_t *client_socket;
866 /* Who is the client? */
869 apr_sockaddr_t *local_addr;
870 /** remote address */
871 apr_sockaddr_t *remote_addr;
872 /** Client's IP address */
874 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
875 * "" if it has and no address was found. N.B. Only access this though
876 * get_remote_host() */
878 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
879 * get_remote_logname() */
880 char *remote_logname;
882 /** Are we still talking? */
885 /** Are we going to keep the connection alive for another request?
886 * -1 fatal error, 0 undecided, 1 yes */
887 signed int keepalive:2;
889 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
891 signed int double_reverse:2;
893 /** How many times have we used it? */
895 /** server IP address */
897 /** used for ap_get_server_name when UseCanonicalName is set to DNS
898 * (ignores setting of HostnameLookups) */
901 /** ID of this connection; unique at any point in time */
903 /** Notes on *this* connection */
904 struct ap_conf_vector_t *conn_config;
905 /** send note from one module to another, must remain valid for all
906 * requests on this conn */
908 /** A list of input filters to be used for this connection */
909 struct ap_filter_t *input_filters;
910 /** A list of output filters to be used for this connection */
911 struct ap_filter_t *output_filters;
914 /* Per-vhost config... */
916 /* The address 255.255.255.255, when used as a virtualhost address,
917 * will become the "default" server when the ip doesn't match other vhosts.
919 #define DEFAULT_VHOST_ADDR 0xfffffffful
921 typedef struct server_addr_rec server_addr_rec;
923 /** A structure to be used for Per-vhost config */
924 struct server_addr_rec {
925 /** The next server in the list */
926 server_addr_rec *next;
927 /** The bound address, for this server */
928 apr_sockaddr_t *host_addr;
929 /** The bound port, for this server */
930 apr_port_t host_port;
931 /** The name given in <VirtualHost> */
935 /** A structure to store information for each virtual server */
937 /** The process this server is running in */
938 process_rec *process;
939 /** The next server in the list */
942 /** The name of the server */
943 const char *defn_name;
944 /** The line of the config file that the server was defined on */
945 unsigned defn_line_number;
947 /* Contact information */
949 /** The admin's contact information */
951 /** The server hostname */
952 char *server_hostname;
953 /** for redirects, etc. */
956 /* Log files --- note that transfer log is now in the modules... */
958 /** The name of the error log */
960 /** A file descriptor that references the error log */
961 apr_file_t *error_log;
962 /** The log level for this server */
965 /* Module-specific configuration for server, and defaults... */
967 /** true if this is the virtual server */
969 /** Config vector containing pointers to modules' per-server config
971 struct ap_conf_vector_t *module_config;
972 /** MIME type info, etc., before we start checking per-directory info */
973 struct ap_conf_vector_t *lookup_defaults;
975 /* Transaction handling */
977 /** I haven't got a clue */
978 server_addr_rec *addrs;
979 /** Timeout, in seconds, before we give up */
981 /** Seconds we'll wait for another request */
982 int keep_alive_timeout;
983 /** Maximum requests per connection */
985 /** Use persistent connections? */
988 /** Pathname for ServerPath */
990 /** Length of path */
993 /** Normal names for ServerAlias servers */
994 apr_array_header_t *names;
995 /** Wildcarded names for ServerAlias servers */
996 apr_array_header_t *wild_names;
998 /** limit on size of the HTTP request line */
1000 /** limit on size of any request header field */
1001 int limit_req_fieldsize;
1002 /** limit on number of request header fields */
1003 int limit_req_fields;
1007 * Examine a field value (such as a media-/content-type) string and return
1008 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1009 * @param p Pool to allocate memory from
1010 * @param intype The field to examine
1011 * @return A copy of the field minus any parameters
1013 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1016 * Convert a time from an integer into a string in a specified format
1017 * @param p The pool to allocate memory from
1018 * @param t The time to convert
1019 * @param fmt The format to use for the conversion
1020 * @param gmt Convert the time for GMT?
1021 * @return The string that represents the specified time
1023 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1025 /* String handling. The *_nc variants allow you to use non-const char **s as
1026 arguments (unfortunately C won't automatically convert a char ** to a const
1030 * Get the characters until the first occurance of a specified character
1031 * @param p The pool to allocate memory from
1032 * @param line The string to get the characters from
1033 * @param stop The character to stop at
1034 * @return A copy of the characters up to the first stop character
1036 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1038 * Get the characters until the first occurance of a specified character
1039 * @param p The pool to allocate memory from
1040 * @param line The string to get the characters from
1041 * @param stop The character to stop at
1042 * @return A copy of the characters up to the first stop character
1043 * @note This is the same as ap_getword(), except it doesn't use const char **.
1045 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1048 * Get the first word from a given string. A word is defined as all characters
1049 * up to the first whitespace.
1050 * @param p The pool to allocate memory from
1051 * @param line The string to traverse
1052 * @return The first word in the line
1054 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1056 * Get the first word from a given string. A word is defined as all characters
1057 * up to the first whitespace.
1058 * @param p The pool to allocate memory from
1059 * @param line The string to traverse
1060 * @return The first word in the line
1061 * @note The same as ap_getword_white(), except it doesn't use const char **.
1063 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1066 * Get all characters from the first occurance of @a stop to the first '\0'
1067 * @param p The pool to allocate memory from
1068 * @param line The line to traverse
1069 * @param stop The character to start at
1070 * @return A copy of all caracters after the first occurance of the specified
1073 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1076 * Get all characters from the first occurance of @a stop to the first '\0'
1077 * @param p The pool to allocate memory from
1078 * @param line The line to traverse
1079 * @param stop The character to start at
1080 * @return A copy of all caracters after the first occurance of the specified
1082 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1084 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1087 * Get the second word in the string paying attention to quoting
1088 * @param p The pool to allocate from
1089 * @param line The line to traverse
1090 * @return A copy of the string
1092 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1094 * Get the second word in the string paying attention to quoting
1095 * @param p The pool to allocate from
1096 * @param line The line to traverse
1097 * @return A copy of the string
1098 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1100 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1103 * Check a string for any ${ENV} environment variable construct and replace
1104 * each them by the value of that environment variable, if it exists. If the
1105 * environment value does not exist, leave the ${ENV} construct alone; it
1106 * means something else.
1107 * @param p The pool to allocate from
1108 * @param word The string to check
1109 * @return The string with the replaced environment variables
1111 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1114 * Size an HTTP header field list item, as separated by a comma.
1115 * @param field The field to size
1116 * @param len The length of the field
1117 * @return The return value is a pointer to the beginning of the non-empty
1118 * list item within the original string (or NULL if there is none) and the
1119 * address of field is shifted to the next non-comma, non-whitespace
1120 * character. len is the length of the item excluding any beginning whitespace.
1122 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1125 * Retrieve an HTTP header field list item, as separated by a comma,
1126 * while stripping insignificant whitespace and lowercasing anything not in
1127 * a quoted string or comment.
1128 * @param p The pool to allocate from
1129 * @param field The field to retrieve
1130 * @return The return value is a new string containing the converted list
1131 * item (or NULL if none) and the address pointed to by field is
1132 * shifted to the next non-comma, non-whitespace.
1134 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1137 * Find an item in canonical form (lowercase, no extra spaces) within
1138 * an HTTP field value list.
1139 * @param p The pool to allocate from
1140 * @param line The field value list to search
1141 * @param tok The token to search for
1142 * @return 1 if found, 0 if not found.
1144 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1147 * Retrieve a token, spacing over it and returning a pointer to
1148 * the first non-white byte afterwards. Note that these tokens
1149 * are delimited by semis and commas and can also be delimited
1150 * by whitespace at the caller's option.
1151 * @param p The pool to allocate from
1152 * @param accept_line The line to retrieve the token from
1153 * @param accept_white Is it delimited by whitespace
1154 * @return the first non-white byte after the token
1156 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1159 * Find http tokens, see the definition of token from RFC2068
1160 * @param p The pool to allocate from
1161 * @param line The line to find the token
1162 * @param tok The token to find
1163 * @return 1 if the token is found, 0 otherwise
1165 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1168 * find http tokens from the end of the line
1169 * @param p The pool to allocate from
1170 * @param line The line to find the token
1171 * @param tok The token to find
1172 * @return 1 if the token is found, 0 otherwise
1174 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1177 * Check for an Absolute URI syntax
1178 * @param u The string to check
1179 * @return 1 if URI, 0 otherwise
1181 AP_DECLARE(int) ap_is_url(const char *u);
1185 * @param url The url to unescapte
1186 * @return 0 on success, non-zero otherwise
1188 AP_DECLARE(int) ap_unescape_url(char *url);
1190 * Convert all double slashes to single slashes
1191 * @param name The string to convert
1193 AP_DECLARE(void) ap_no2slash(char *name);
1196 * Remove all ./ and xx/../ substrings from a file name. Also remove
1197 * any leading ../ or /../ substrings.
1198 * @param name the file name to parse
1200 AP_DECLARE(void) ap_getparents(char *name);
1203 * Escape a path segment, as defined in RFC 1808
1204 * @param p The pool to allocate from
1205 * @param s The path to convert
1206 * @return The converted URL
1208 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1210 * convert an OS path to a URL in an OS dependant way.
1211 * @param p The pool to allocate from
1212 * @param path The path to convert
1213 * @param partial if set, assume that the path will be appended to something
1214 * with a '/' in it (and thus does not prefix "./")
1215 * @return The converted URL
1217 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1218 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1221 * Escape an html string
1222 * @param p The pool to allocate from
1223 * @param s The html to escape
1224 * @return The escaped string
1226 AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
1229 * Construct a full hostname
1230 * @param p The pool to allocate from
1231 * @param hostname The hostname of the server
1232 * @param port The port the server is running on
1233 * @param r The current request
1234 * @return The server's hostname
1236 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1237 apr_port_t port, const request_rec *r);
1239 * Escape a shell command
1240 * @param p The pool to allocate from
1241 * @param s The command to escape
1242 * @return The escaped shell command
1244 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1247 * Count the number of directories in a path
1248 * @param path The path to count
1249 * @return The number of directories
1251 AP_DECLARE(int) ap_count_dirs(const char *path);
1254 * Copy at most @a n leading directories of @a s into @a d. @a d
1255 * should be at least as large as @a s plus 1 extra byte
1257 * @param d The location to copy to
1258 * @param s The location to copy from
1259 * @param n The number of directories to copy
1260 * @return value is the ever useful pointer to the trailing \0 of d
1261 * @note on platforms with drive letters, n = 0 returns the "/" root,
1262 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1263 * returns the empty string. */
1264 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1267 * Return the parent directory name (including trailing /) of the file
1269 * @param p The pool to allocate from
1270 * @param s The file to get the parent of
1271 * @return A copy of the file's parent directory
1273 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1276 * Given a directory and filename, create a single path from them. This
1277 * function is smart enough to ensure that there is a sinlge '/' between the
1278 * directory and file names
1279 * @param a The pool to allocate from
1280 * @param dir The directory name
1281 * @param f The filename
1282 * @return A copy of the full path
1283 * @tip Never consider using this function if you are dealing with filesystem
1284 * names that need to remain canonical, unless you are merging an apr_dir_read
1285 * path and returned filename. Otherwise, the result is not canonical.
1287 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1290 * Test if the given path has an an absolute path.
1291 * @param p The pool to allocate from
1292 * @param dir The directory name
1293 * @tip The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1294 * multiple forms of absolute paths. This only reports if the path is absolute
1295 * in a canonical sense.
1297 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1300 * Does the provided string contain wildcard characters? This is useful
1301 * for determining if the string should be passed to strcmp_match or to strcmp.
1302 * The only wildcard characters recognized are '?' and '*'
1303 * @param str The string to check
1304 * @return 1 if the string has wildcards, 0 otherwise
1306 AP_DECLARE(int) ap_is_matchexp(const char *str);
1309 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1310 * @param str The string to check
1311 * @param exp The pattern to match against
1312 * @return 1 if the two strings match, 0 otherwise
1314 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *exp);
1316 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1318 * @param str The string to check
1319 * @param exp The pattern to match against
1320 * @return 1 if the two strings match, 0 otherwise
1322 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *exp);
1325 * Find the first occurrence of the substring s2 in s1, regardless of case
1326 * @param s1 The string to search
1327 * @param s2 The substring to search for
1328 * @return A pointer to the beginning of the substring
1330 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1333 * Return a pointer to the location inside of bigstring immediately after prefix
1334 * @param bigstring The input string
1335 * @param prefix The prefix to strip away
1336 * @return A pointer relative to bigstring after prefix
1338 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1339 const char *prefix);
1342 * Decode a base64 encoded string into memory allocated from a pool
1343 * @param p The pool to allocate from
1344 * @param bufcoded The encoded string
1345 * @return The decoded string
1347 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1350 * Encode a string into memory allocated from a pool in base 64 format
1351 * @param p The pool to allocate from
1352 * @param strin The plaintext string
1353 * @return The encoded string
1355 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1359 * Compile a regular expression to be used later
1360 * @param p The pool to allocate from
1361 * @param pattern the regular expression to compile
1362 * @param cflags The bitwise or of one or more of the following:
1363 * @li #REG_EXTENDED - Use POSIX extended Regular Expressions
1364 * @li #REG_ICASE - Ignore case
1365 * @li #REG_NOSUB - Support for substring addressing of matches
1367 * @li #REG_NEWLINE - Match-any-character operators don't match new-line
1368 * @return The compiled regular expression
1370 AP_DECLARE(regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1374 * Free the memory associated with a compiled regular expression
1375 * @param p The pool the regex was allocated from
1376 * @param reg The regular expression to free
1378 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, regex_t *reg);
1381 * Match a null-terminated string against a pre-compiled regex.
1382 * @param preg The pre-compiled regex
1383 * @param string The string to match
1384 * @param nmatch Provide information regarding the location of any matches
1385 * @param pmatch Provide information regarding the location of any matches
1386 * @param eflags Bitwise or of any of:
1387 * @li #REG_NOTBOL - match-beginning-of-line operator always
1389 * @li #REG_NOTEOL - match-end-of-line operator always fails to match
1390 * @return 0 for successful match, #REG_NOMATCH otherwise
1392 AP_DECLARE(int) ap_regexec(regex_t *preg, const char *string,
1393 size_t nmatch, regmatch_t pmatch[], int eflags);
1396 * Return the error code returned by regcomp or regexec into error messages
1397 * @param errcode the error code returned by regexec or regcomp
1398 * @param preg The precompiled regex
1399 * @param errbuf A buffer to store the error in
1400 * @param errbuf_size The size of the buffer
1402 AP_DECLARE(size_t) ap_regerror(int errcode, const regex_t *preg,
1403 char *errbuf, size_t errbuf_size);
1406 * After performing a successful regex match, you may use this function to
1407 * perform a series of string substitutions based on subexpressions that were
1408 * matched during the call to ap_regexec
1409 * @param p The pool to allocate from
1410 * @param input An arbitrary string containing $1 through $9. These are
1411 * replaced with the corresponding matched sub-expressions
1412 * @param source The string that was originally matched to the regex
1413 * @param nmatch the nmatch returned from ap_pregex
1414 * @param pmatch the pmatch array returned from ap_pregex
1416 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1417 size_t nmatch, regmatch_t pmatch[]);
1420 * We want to downcase the type/subtype for comparison purposes
1421 * but nothing else because ;parameter=foo values are case sensitive.
1422 * @param s The content-type to convert to lowercase
1424 AP_DECLARE(void) ap_content_type_tolower(char *s);
1427 * convert a string to all lowercase
1428 * @param s The string to convert to lowercase
1430 AP_DECLARE(void) ap_str_tolower(char *s);
1433 * Search a string from left to right for the first occurrence of a
1434 * specific character
1435 * @param str The string to search
1436 * @param c The character to search for
1437 * @return The index of the first occurrence of c in str
1439 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1442 * Search a string from right to left for the first occurrence of a
1443 * specific character
1444 * @param str The string to search
1445 * @param c The character to search for
1446 * @return The index of the first occurrence of c in str
1448 AP_DECLARE(int) ap_rind(const char *str, char c);
1451 * Given a string, replace any bare " with \" .
1452 * @param p The pool to allocate memory from
1453 * @param instring The string to search for "
1454 * @return A copy of the string with escaped quotes
1456 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1458 /* Misc system hackery */
1460 * Given the name of an object in the file system determine if it is a directory
1461 * @param p The pool to allocate from
1462 * @param name The name of the object to check
1463 * @return 1 if it is a directory, 0 otherwise
1465 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1468 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1469 * @param p The pool to allocate from
1470 * @param name The name of the object to check
1471 * @return 1 if it is a directory, 0 otherwise
1473 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1476 extern const char *os_set_account(apr_pool_t *p, const char *account);
1477 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1478 #endif /* _OSD_POSIX */
1481 * Determine the local host name for the current machine
1482 * @param p The pool to allocate from
1483 * @return A copy of the local host name
1485 char *ap_get_local_host(apr_pool_t *p);
1488 * Redefine assert() to something more useful for an Apache...
1490 * Use ap_assert() if the condition should always be checked.
1491 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1495 * Log an assertion to the error log
1496 * @param szExp The assertion that failed
1497 * @param szFile The file the assertion is in
1498 * @param nLine The line the assertion is defined on
1500 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1501 __attribute__((noreturn));
1502 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1505 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1507 #define AP_DEBUG_ASSERT(exp) ((void)0)
1510 /* A set of flags which indicate places where the server should raise(SIGSTOP).
1511 * This is useful for debugging, because you can then attach to that process
1512 * with gdb and continue. This is important in cases where one_process
1513 * debugging isn't possible.
1515 #define SIGSTOP_DETACH 1
1516 #define SIGSTOP_MAKE_CHILD 2
1517 #define SIGSTOP_SPAWN_CHILD 4
1518 #define SIGSTOP_PIPED_LOG_SPAWN 8
1519 #define SIGSTOP_CGI_CHILD 16
1521 #ifdef DEBUG_SIGSTOP
1522 extern int raise_sigstop_flags;
1523 #define RAISE_SIGSTOP(x) do { \
1524 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1527 #define RAISE_SIGSTOP(x)
1531 * Get HTML describing the address and (optionally) admin of the server.
1532 * @param prefix Text which is prepended to the return value
1533 * @param r The request_rec
1534 * @return HTML describing the server, allocated in @a r's pool.
1536 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1538 /* strtoul does not exist on sunos4. */
1542 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1544 /* The C library has functions that allow const to be silently dropped ...
1545 these macros detect the drop in maintainer mode, but use the native
1546 methods for normal builds
1548 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1549 to be included before the macros are defined or compilation will fail.
1556 # define strchr(s, c) ap_strchr(s,c)
1558 # define strrchr(s, c) ap_strrchr(s,c)
1560 # define strstr(s, c) ap_strstr(s,c)
1562 char *ap_strchr(char *s, int c);
1563 const char *ap_strchr_c(const char *s, int c);
1564 char *ap_strrchr(char *s, int c);
1565 const char *ap_strrchr_c(const char *s, int c);
1566 char *ap_strstr(char *s, const char *c);
1567 const char *ap_strstr_c(const char *s, const char *c);
1571 # define ap_strchr(s, c) strchr(s, c)
1572 # define ap_strchr_c(s, c) strchr(s, c)
1573 # define ap_strrchr(s, c) strrchr(s, c)
1574 # define ap_strrchr_c(s, c) strrchr(s, c)
1575 # define ap_strstr(s, c) strstr(s, c)
1576 # define ap_strstr_c(s, c) strstr(s, c)
1580 #define AP_NORESTART APR_OS_START_USEERR + 1
1586 #endif /* !APACHE_HTTPD_H */