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"
110 #define HTTPD_ROOT "/usr/local/apache"
112 #endif /* HTTPD_ROOT */
115 * --------- You shouldn't have to edit anything below this line ----------
117 * Any modifications to any defaults not defined above should be done in the
118 * respective configuration file.
122 /* Default location of documents. Can be overridden by the DocumentRoot
125 #ifndef DOCUMENT_LOCATION
127 /* Set default for OS/2 file system */
128 #define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
130 #define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
132 #endif /* DOCUMENT_LOCATION */
134 /* Maximum number of dynamically loaded modules */
135 #ifndef DYNAMIC_MODULE_LIMIT
136 #define DYNAMIC_MODULE_LIMIT 64
139 /* Default administrator's address */
140 #define DEFAULT_ADMIN "[no address given]"
142 /* The name of the log files */
143 #ifndef DEFAULT_ERRORLOG
144 #if defined(OS2) || defined(WIN32)
145 #define DEFAULT_ERRORLOG "logs/error.log"
147 #define DEFAULT_ERRORLOG "logs/error_log"
149 #endif /* DEFAULT_ERRORLOG */
151 /* Define this to be what your per-directory security files are called */
152 #ifndef DEFAULT_ACCESS_FNAME
154 /* Set default for OS/2 file system */
155 #define DEFAULT_ACCESS_FNAME "htaccess"
157 #define DEFAULT_ACCESS_FNAME ".htaccess"
159 #endif /* DEFAULT_ACCESS_FNAME */
161 /* The name of the server config file */
162 #ifndef SERVER_CONFIG_FILE
163 #define SERVER_CONFIG_FILE "conf/httpd.conf"
166 /* Whether we should enable rfc1413 identity checking */
167 #ifndef DEFAULT_RFC1413
168 #define DEFAULT_RFC1413 0
171 /* The default path for CGI scripts if none is currently set */
173 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
176 /* The path to the suExec wrapper, can be overridden in Configuration */
178 #define SUEXEC_BIN HTTPD_ROOT "/sbin/suexec"
181 /* The timeout for waiting for messages */
182 #ifndef DEFAULT_TIMEOUT
183 #define DEFAULT_TIMEOUT 300
186 /* The timeout for waiting for keepalive timeout until next request */
187 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
188 #define DEFAULT_KEEPALIVE_TIMEOUT 15
191 /* The number of requests to entertain per connection */
192 #ifndef DEFAULT_KEEPALIVE
193 #define DEFAULT_KEEPALIVE 100
196 /* Limits on the size of various request items. These limits primarily
197 * exist to prevent simple denial-of-service attacks on a server based
198 * on misuse of the protocol. The recommended values will depend on the
199 * nature of the server resources -- CGI scripts and database backends
200 * might require large values, but most servers could get by with much
201 * smaller limits than we use below. The request message body size can
202 * be limited by the per-dir config directive LimitRequestBody.
204 * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
205 * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
206 * These two limits can be lowered (but not raised) by the server config
207 * directives LimitRequestLine and LimitRequestFieldsize, respectively.
209 * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
210 * the server config directive LimitRequestFields.
212 #ifndef DEFAULT_LIMIT_REQUEST_LINE
213 #define DEFAULT_LIMIT_REQUEST_LINE 8190
214 #endif /* default limit on bytes in Request-Line (Method+URI+HTTP-version) */
215 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
216 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
217 #endif /* default limit on bytes in any one header field */
218 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
219 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
220 #endif /* default limit on number of request header fields */
224 * The default default character set name to add if AddDefaultCharset is
225 * enabled. Overridden with AddDefaultCharsetName.
227 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
229 #endif /* CORE_PRIVATE */
231 #define AP_SERVER_PROTOCOL "HTTP/1.1"
234 /* ------------------ stuff that modules are allowed to look at ----------- */
236 /* Define this to be what your HTML directory content files are called */
237 #ifndef AP_DEFAULT_INDEX
238 #define AP_DEFAULT_INDEX "index.html"
242 /* Define this to be what type you'd like returned for files with unknown */
243 /* suffixes. MUST be all lower case. */
244 #ifndef DEFAULT_CONTENT_TYPE
245 #define DEFAULT_CONTENT_TYPE "text/plain"
248 /* The name of the MIME types file */
249 #ifndef AP_TYPES_CONFIG_FILE
250 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
254 * Define the HTML doctype strings centrally.
256 #define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
257 "DTD HTML 2.0//EN\">\n"
258 #define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
259 "DTD HTML 3.2 Final//EN\">\n"
260 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
261 "DTD HTML 4.0//EN\"\n" \
262 "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
263 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
264 "DTD HTML 4.0 Transitional//EN\"\n" \
265 "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
266 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
267 "DTD HTML 4.0 Frameset//EN\"\n" \
268 "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
270 /* -- Internal representation for a HTTP protocol number, e.g., HTTP/1.1 -- */
272 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
273 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
274 #define HTTP_VERSION_MINOR(number) ((number)%1000)
276 /* -------------- Port number for server running standalone --------------- */
278 #define DEFAULT_HTTP_PORT 80
279 #define DEFAULT_HTTPS_PORT 443
281 * Check whether @a port is the default port for the request @a r.
282 * @param port The port number
283 * @param r The request
284 * @see #ap_default_port
286 #define ap_is_default_port(port,r) ((port) == ap_default_port(r))
288 * Get the default port for a request (which depends on the scheme).
289 * @param r The request
291 #define ap_default_port(r) ap_run_default_port(r)
293 * Get the scheme for a request.
294 * @param r The request
295 * @bug This should be called ap_http_scheme!
297 #define ap_http_method(r) ap_run_http_method(r)
299 /* The default string lengths */
300 #define MAX_STRING_LEN HUGE_STRING_LEN
301 #define HUGE_STRING_LEN 8192
303 /* The size of the server's internal read-write buffers */
304 #define AP_IOBUFSIZE 8192
306 /* APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
307 * mutiple buckets, no greater than MAX(apr_size_t), and more granular
308 * than that in case the brigade code/filters attempt to read it directly.
309 * ### 4mb is an invention, no idea if it is reasonable.
311 #define AP_MAX_SENDFILE 16777216
315 * Special Apache error codes. These are basically used
316 * in http_main.c so we can keep track of various errors.
321 * A fatal error arising during the server's init sequence
323 * The child died during its init sequence
325 * A fatal error, resulting in the whole server aborting.
326 * If a child exits with this error, the parent process
327 * considers this a server-wide fatal error and aborts.
330 #define APEXIT_OK 0x0
331 #define APEXIT_INIT 0x2
332 #define APEXIT_CHILDINIT 0x3
333 #define APEXIT_CHILDFATAL 0xf
338 * Stuff marked #AP_DECLARE is part of the API, and intended for use
339 * by modules. Its purpose is to allow us to add attributes that
340 * particular platforms or compilers require to every exported function.
342 # define AP_DECLARE(type) type
345 #ifndef AP_DECLARE_NONSTD
347 * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
348 * use by modules. The difference between #AP_DECLARE and
349 * #AP_DECLARE_NONSTD is that the latter is required for any functions
350 * which use varargs or are used via indirect function call. This
351 * is to accomodate the two calling conventions in windows dlls.
353 # define AP_DECLARE_NONSTD(type) type
355 #ifndef AP_DECLARE_DATA
356 # define AP_DECLARE_DATA
359 #ifndef AP_MODULE_DECLARE
360 # define AP_MODULE_DECLARE(type) type
362 #ifndef AP_MODULE_DECLARE_NONSTD
363 # define AP_MODULE_DECLARE_NONSTD(type) type
365 #ifndef AP_MODULE_DECLARE_DATA
366 # define AP_MODULE_DECLARE_DATA
369 /* modules should not used functions marked AP_CORE_DECLARE
370 * or AP_CORE_DECLARE_NONSTD */
371 #ifndef AP_CORE_DECLARE
372 # define AP_CORE_DECLARE AP_DECLARE
374 #ifndef AP_CORE_DECLARE_NONSTD
375 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
379 * Get the server version string
380 * @return The server version string
382 AP_DECLARE(const char *) ap_get_server_version(void);
385 * Add a component to the version string
386 * @param pconf The pool to allocate the component from
387 * @param component The string to add
389 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
392 * Get the date a time that the server was built
393 * @return The server build time string
395 AP_DECLARE(const char *) ap_get_server_built(void);
397 #define DECLINED -1 /* Module declines to handle */
398 #define DONE -2 /* Module has served the response completely
399 * - it's safe to die() with no more output
401 #define OK 0 /* Module has handled this stage. */
404 /* ----------------------- HTTP Status Codes ------------------------- */
406 /* The size of the static array in http_protocol.c for storing
407 * all of the potential response status-lines (a sparse table).
408 * A future version should dynamically generate the apr_table_t at startup.
410 #define RESPONSE_CODES 55
412 #define HTTP_CONTINUE 100
413 #define HTTP_SWITCHING_PROTOCOLS 101
414 #define HTTP_PROCESSING 102
416 #define HTTP_CREATED 201
417 #define HTTP_ACCEPTED 202
418 #define HTTP_NON_AUTHORITATIVE 203
419 #define HTTP_NO_CONTENT 204
420 #define HTTP_RESET_CONTENT 205
421 #define HTTP_PARTIAL_CONTENT 206
422 #define HTTP_MULTI_STATUS 207
423 #define HTTP_MULTIPLE_CHOICES 300
424 #define HTTP_MOVED_PERMANENTLY 301
425 #define HTTP_MOVED_TEMPORARILY 302
426 #define HTTP_SEE_OTHER 303
427 #define HTTP_NOT_MODIFIED 304
428 #define HTTP_USE_PROXY 305
429 #define HTTP_TEMPORARY_REDIRECT 307
430 #define HTTP_BAD_REQUEST 400
431 #define HTTP_UNAUTHORIZED 401
432 #define HTTP_PAYMENT_REQUIRED 402
433 #define HTTP_FORBIDDEN 403
434 #define HTTP_NOT_FOUND 404
435 #define HTTP_METHOD_NOT_ALLOWED 405
436 #define HTTP_NOT_ACCEPTABLE 406
437 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
438 #define HTTP_REQUEST_TIME_OUT 408
439 #define HTTP_CONFLICT 409
440 #define HTTP_GONE 410
441 #define HTTP_LENGTH_REQUIRED 411
442 #define HTTP_PRECONDITION_FAILED 412
443 #define HTTP_REQUEST_ENTITY_TOO_LARGE 413
444 #define HTTP_REQUEST_URI_TOO_LARGE 414
445 #define HTTP_UNSUPPORTED_MEDIA_TYPE 415
446 #define HTTP_RANGE_NOT_SATISFIABLE 416
447 #define HTTP_EXPECTATION_FAILED 417
448 #define HTTP_UNPROCESSABLE_ENTITY 422
449 #define HTTP_LOCKED 423
450 #define HTTP_FAILED_DEPENDENCY 424
451 #define HTTP_INTERNAL_SERVER_ERROR 500
452 #define HTTP_NOT_IMPLEMENTED 501
453 #define HTTP_BAD_GATEWAY 502
454 #define HTTP_SERVICE_UNAVAILABLE 503
455 #define HTTP_GATEWAY_TIME_OUT 504
456 #define HTTP_VERSION_NOT_SUPPORTED 505
457 #define HTTP_VARIANT_ALSO_VARIES 506
458 #define HTTP_INSUFFICIENT_STORAGE 507
459 #define HTTP_NOT_EXTENDED 510
461 #define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
462 #define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
463 #define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
464 #define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
465 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
466 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
468 #define ap_status_drops_connection(x) \
469 (((x) == HTTP_BAD_REQUEST) || \
470 ((x) == HTTP_REQUEST_TIME_OUT) || \
471 ((x) == HTTP_LENGTH_REQUIRED) || \
472 ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
473 ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
474 ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
475 ((x) == HTTP_SERVICE_UNAVAILABLE) || \
476 ((x) == HTTP_NOT_IMPLEMENTED))
478 /* Methods recognized (but not necessarily handled) by the server.
479 * These constants are used in bit shifting masks of size int, so it is
480 * unsafe to have more methods than bits in an int. HEAD == M_GET.
481 * This list must be tracked by the list in http_protocol.c in routine
482 * ap_method_name_of().
493 #define M_PROPPATCH 9
501 /* METHODS needs to be equal to the number of bits
502 * we are using for limit masks.
507 * The method mask bit to shift for anding with a bitmask.
509 #define AP_METHOD_BIT (apr_int64_t)1
512 typedef struct ap_method_list_t ap_method_list_t;
514 * Structure for handling HTTP methods. Methods known to the server are
515 * accessed via a bitmask shortcut; extension methods are handled by
518 struct ap_method_list_t {
519 /* The bitmask used for known methods */
520 apr_int64_t method_mask;
521 /* the array used for extension methods */
522 apr_array_header_t *method_list;
525 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
526 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
527 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
528 #define DIR_MAGIC_TYPE "httpd/unix-directory"
530 /* Just in case your linefeed isn't the one the other end is expecting. */
531 #if !APR_CHARSET_EBCDIC
534 #define CRLF "\015\012"
535 #else /* APR_CHARSET_EBCDIC */
536 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
537 * in the buff package (bread/bputs/bwrite). Everywhere else, we use
538 * "native EBCDIC" CR and NL characters. These are therefore
545 #endif /* APR_CHARSET_EBCDIC */
547 /* Possible values for request_rec.read_body (set by handling module):
548 * REQUEST_NO_BODY Send 413 error if message has any body
549 * REQUEST_CHUNKED_ERROR Send 411 error if body without Content-Length
550 * REQUEST_CHUNKED_DECHUNK If chunked, remove the chunks for me.
552 #define REQUEST_NO_BODY 0
553 #define REQUEST_CHUNKED_ERROR 1
554 #define REQUEST_CHUNKED_DECHUNK 2
556 /* Things which may vary per file-lookup WITHIN a request ---
557 * e.g., state of MIME config. Basically, the name of an object, info
558 * about the object, and any other info we may ahve which may need to
559 * change as we go poking around looking for it (e.g., overridden by
562 * Note how the default state of almost all these things is properly
563 * zero, so that allocating it with pcalloc does the right thing without
564 * a whole lot of hairy initialization... so long as we are willing to
565 * make the (fairly) portable assumption that the bit pattern of a NULL
566 * pointer is, in fact, zero.
570 * This represents the result of calling htaccess; these are cached for
573 struct htaccess_result {
574 /** the directory to which this applies */
576 /** the overrides allowed for the .htaccess file */
578 /** the configuration directives */
579 struct ap_conf_vector_t *htaccess;
580 /** the next one, or NULL if no more; N.B. never change this */
581 const struct htaccess_result *next;
584 /* The following four types define a hierarchy of activities, so that
585 * given a request_rec r you can write r->connection->server->process
586 * to get to the process_rec. While this reduces substantially the
587 * number of arguments that various hooks require beware that in
588 * threaded versions of the server you must consider multiplexing
591 typedef struct process_rec process_rec;
592 typedef struct server_rec server_rec;
593 typedef struct conn_rec conn_rec;
594 typedef struct request_rec request_rec;
596 /* ### would be nice to not include this from httpd.h ... */
597 /* This comes after we have defined the request_rec type */
600 /** A structure that represents one process */
602 /** Global pool. Please try to cleared on _all_ exits */
604 /** aka configuration pool, cleared on restarts */
606 /** How many command line arguments were pass to the program */
608 /** The command line arguments */
609 const char * const *argv;
610 /** The program name used to execute the program */
611 const char *short_name;
614 /** A structure that represents the current request */
616 /** The pool associated with the request */
618 /** The connection over which this connection has been read */
619 conn_rec *connection;
620 /** The virtual host this request is for */
623 /** If we wind up getting redirected, pointer to the request we
626 /** If this is an internal redirect, pointer to where we redirected
630 /** If this is a sub_request (see request.h) pointer back to the
634 /* Info about the request itself... we begin with stuff that only
635 * protocol.c should ever touch...
637 /** First line of request, so we can log it */
639 /** HTTP/0.9, "simple" request */
641 /** A proxy request (calculated during post_read_request/translate_name)
642 * possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE
645 /** HEAD request, as opposed to GET */
647 /** Protocol, as given to us, or HTTP/0.9 */
649 /** Number version of protocol; 1.1 = 1001 */
651 /** Host, as set by full URI or Host: */
652 const char *hostname;
654 /** When the request started */
655 apr_time_t request_time;
657 /** Status line, if set by script */
658 const char *status_line;
662 /* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
663 * look, but don't touch.
666 /** GET, HEAD, POST, etc. */
668 /** M_GET, M_POST, etc. */
672 * allowed is a bitvector of the allowed methods.
674 * A handler must ensure that the request method is one that
675 * it is capable of handling. Generally modules should DECLINE
676 * any request methods they do not handle. Prior to aborting the
677 * handler like this the handler should set r->allowed to the list
678 * of methods that it is willing to handle. This bitvector is used
679 * to construct the "Allow:" header required for OPTIONS requests,
680 * and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
682 * Since the default_handler deals with OPTIONS, all modules can
683 * usually decline to deal with OPTIONS. TRACE is always allowed,
684 * modules don't need to set it explicitly.
686 * Since the default_handler will always handle a GET, a
687 * module which does *not* implement GET should probably return
688 * HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
689 * handler can't be installed by mod_actions.
692 /** Array of extension methods */
693 apr_array_header_t *allowed_xmethods;
694 /** List of allowed methods */
695 ap_method_list_t *allowed_methods;
697 /** byte count in stream is for body */
698 apr_off_t sent_bodyct;
699 /** body byte count, for easy access */
700 apr_off_t bytes_sent;
701 /** Time the resource was last modified */
704 /* HTTP/1.1 connection-level features */
706 /** sending chunked transfer-coding */
708 /** multipart/byteranges boundary */
709 const char *boundary;
710 /** The Range: header */
712 /** The "real" content length */
715 /** bytes left to read */
717 /** bytes that have been read */
718 apr_off_t read_length;
719 /** how the request body should be read */
721 /** reading chunked transfer-coding */
723 /** is client waiting for a 100 response? */
724 unsigned expecting_100;
726 /* MIME header environments, in and out. Also, an array containing
727 * environment variables to be passed to subprocesses, so people can
728 * write modules to add to that environment.
730 * The difference between headers_out and err_headers_out is that the
731 * latter are printed even on error, and persist across internal redirects
732 * (so the headers printed for ErrorDocument handlers will have them).
734 * The 'notes' apr_table_t is for notes from one module to another, with no
735 * other set purpose in mind...
738 /** MIME header environment from the request */
739 apr_table_t *headers_in;
740 /** MIME header environment for the response */
741 apr_table_t *headers_out;
742 /** MIME header environment for the response, printed even on errors and
743 * persist across internal redirects */
744 apr_table_t *err_headers_out;
745 /** Array of environment variables to be used for sub processes */
746 apr_table_t *subprocess_env;
747 /** Notes from one module to another */
750 /* content_type, handler, content_encoding, content_language, and all
751 * content_languages MUST be lowercased strings. They may be pointers
752 * to static strings; they should not be modified in place.
754 /** The content-type for the current request */
755 const char *content_type; /* Break these out --- we dispatch on 'em */
756 /** The handler string that we use to call a handler function */
757 const char *handler; /* What we *really* dispatch on */
759 /** How to encode the data */
760 const char *content_encoding;
761 /** for back-compat. only -- do not use */
762 const char *content_language;
763 /** array of (char*) representing the content languages */
764 apr_array_header_t *content_languages;
766 /** variant list validator (if negotiated) */
767 char *vlist_validator;
769 /** If an authentication check was made, this gets set to the user name. */
771 /** If an authentication check was made, this gets set to the auth type. */
774 /** This response is non-cache-able */
776 /** There is no local copy of this response */
779 /* What object is being requested (either directly, or via include
780 * or content-negotiation mapping).
783 /** the uri without any parsing performed */
785 /** the path portion of the URI */
787 /** The filename on disk that this response corresponds to */
789 /** The true filename, we canonicalize if it differs from r->filename */
790 char *canonical_filename;
791 /** The path_info for this request if there is any. */
793 /** QUERY_ARGS, if any */
795 /** ST_MODE set to zero if no such file */
797 /** components of uri, dismantled */
798 apr_uri_t parsed_uri;
800 /* Various other config info which may change with .htaccess files
801 * These are config vectors, with one void* pointer for each module
802 * (the thing pointed to being the module's business).
805 /** Options set in config files, etc. */
806 struct ap_conf_vector_t *per_dir_config;
807 /** Notes on *this* request */
808 struct ap_conf_vector_t *request_config;
811 * a linked list of the configuration directives in the .htaccess files
812 * accessed by this request.
813 * N.B. always add to the head of the list, _never_ to the end.
814 * that way, a sub request's list can (temporarily) point to a parent's list
816 const struct htaccess_result *htaccess;
818 /** A list of output filters to be used for this request */
819 struct ap_filter_t *output_filters;
820 /** A list of input filters to be used for this request */
821 struct ap_filter_t *input_filters;
822 /** A flag to determine if the eos bucket has been sent yet */
825 /* Things placed at the end of the record to avoid breaking binary
826 * compatibility. It would be nice to remember to reorder the entire
827 * record to improve 64bit alignment the next time we need to break
828 * binary compatibility for some other reason.
833 * @defgroup ProxyReq Proxy request types
835 * Possible values of request_rec->proxyreq. A request could be normal,
836 * proxied or reverse proxied. Normally proxied and reverse proxied are
837 * grouped together as just "proxied", but sometimes it's necessary to
838 * tell the difference between the two, such as for authentication.
842 #define PROXYREQ_NONE 0 /**< No proxy */
843 #define PROXYREQ_PROXY 1 /**< Standard proxy */
844 #define PROXYREQ_REVERSE 2 /**< Reverse proxy */
849 /** Structure to store things which are per connection */
851 /** Pool associated with this connection */
853 /** Physical vhost this conn came in on */
854 server_rec *base_server;
855 /** used by http_vhost.c */
856 void *vhost_lookup_data;
858 /* Information about the connection itself */
860 /** Connection to the client */
861 apr_socket_t *client_socket;
863 /* Who is the client? */
866 apr_sockaddr_t *local_addr;
867 /** remote address */
868 apr_sockaddr_t *remote_addr;
869 /** Client's IP address */
871 /** Client's DNS name, if known. NULL if DNS hasn't been checked,
872 * "" if it has and no address was found. N.B. Only access this though
873 * get_remote_host() */
875 /** Only ever set if doing rfc1413 lookups. N.B. Only access this through
876 * get_remote_logname() */
877 char *remote_logname;
879 /** Are we still talking? */
882 /** Are we going to keep the connection alive for another request?
883 * -1 fatal error, 0 undecided, 1 yes */
884 signed int keepalive:2;
886 /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
888 signed int double_reverse:2;
890 /** How many times have we used it? */
892 /** server IP address */
894 /** used for ap_get_server_name when UseCanonicalName is set to DNS
895 * (ignores setting of HostnameLookups) */
898 /** ID of this connection; unique at any point in time */
900 /** Notes on *this* connection */
901 struct ap_conf_vector_t *conn_config;
902 /** send note from one module to another, must remain valid for all
903 * requests on this conn */
905 /** A list of input filters to be used for this connection */
906 struct ap_filter_t *input_filters;
907 /** A list of output filters to be used for this connection */
908 struct ap_filter_t *output_filters;
911 /* Per-vhost config... */
913 /* The address 255.255.255.255, when used as a virtualhost address,
914 * will become the "default" server when the ip doesn't match other vhosts.
916 #define DEFAULT_VHOST_ADDR 0xfffffffful
918 typedef struct server_addr_rec server_addr_rec;
920 /** A structure to be used for Per-vhost config */
921 struct server_addr_rec {
922 /** The next server in the list */
923 server_addr_rec *next;
924 /** The bound address, for this server */
925 apr_sockaddr_t *host_addr;
926 /** The bound port, for this server */
927 apr_port_t host_port;
928 /** The name given in <VirtualHost> */
932 /** A structure to store information for each virtual server */
934 /** The process this server is running in */
935 process_rec *process;
936 /** The next server in the list */
939 /** The name of the server */
940 const char *defn_name;
941 /** The line of the config file that the server was defined on */
942 unsigned defn_line_number;
944 /* Contact information */
946 /** The admin's contact information */
948 /** The server hostname */
949 char *server_hostname;
950 /** for redirects, etc. */
953 /* Log files --- note that transfer log is now in the modules... */
955 /** The name of the error log */
957 /** A file descriptor that references the error log */
958 apr_file_t *error_log;
959 /** The log level for this server */
962 /* Module-specific configuration for server, and defaults... */
964 /** true if this is the virtual server */
966 /** Config vector containing pointers to modules' per-server config
968 struct ap_conf_vector_t *module_config;
969 /** MIME type info, etc., before we start checking per-directory info */
970 struct ap_conf_vector_t *lookup_defaults;
972 /* Transaction handling */
974 /** I haven't got a clue */
975 server_addr_rec *addrs;
976 /** Timeout, in seconds, before we give up */
978 /** Seconds we'll wait for another request */
979 int keep_alive_timeout;
980 /** Maximum requests per connection */
982 /** Use persistent connections? */
985 /** Pathname for ServerPath */
987 /** Length of path */
990 /** Normal names for ServerAlias servers */
991 apr_array_header_t *names;
992 /** Wildcarded names for ServerAlias servers */
993 apr_array_header_t *wild_names;
995 /** limit on size of the HTTP request line */
997 /** limit on size of any request header field */
998 int limit_req_fieldsize;
999 /** limit on number of request header fields */
1000 int limit_req_fields;
1004 * Examine a field value (such as a media-/content-type) string and return
1005 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1006 * @param p Pool to allocate memory from
1007 * @param intype The field to examine
1008 * @return A copy of the field minus any parameters
1010 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1013 * Convert a time from an integer into a string in a specified format
1014 * @param p The pool to allocate memory from
1015 * @param t The time to convert
1016 * @param fmt The format to use for the conversion
1017 * @param gmt Convert the time for GMT?
1018 * @return The string that represents the specified time
1020 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1022 /* String handling. The *_nc variants allow you to use non-const char **s as
1023 arguments (unfortunately C won't automatically convert a char ** to a const
1027 * Get the characters until the first occurance of a specified character
1028 * @param p The pool to allocate memory from
1029 * @param line The string to get the characters from
1030 * @param stop The character to stop at
1031 * @return A copy of the characters up to the first stop character
1033 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1035 * Get the characters until the first occurance of a specified character
1036 * @param p The pool to allocate memory from
1037 * @param line The string to get the characters from
1038 * @param stop The character to stop at
1039 * @return A copy of the characters up to the first stop character
1040 * @note This is the same as ap_getword(), except it doesn't use const char **.
1042 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1045 * Get the first word from a given string. A word is defined as all characters
1046 * up to the first whitespace.
1047 * @param p The pool to allocate memory from
1048 * @param line The string to traverse
1049 * @return The first word in the line
1051 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1053 * Get the first word from a given string. A word is defined as all characters
1054 * up to the first whitespace.
1055 * @param p The pool to allocate memory from
1056 * @param line The string to traverse
1057 * @return The first word in the line
1058 * @note The same as ap_getword_white(), except it doesn't use const char **.
1060 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1063 * Get all characters from the first occurance of @a stop to the first '\0'
1064 * @param p The pool to allocate memory from
1065 * @param line The line to traverse
1066 * @param stop The character to start at
1067 * @return A copy of all caracters after the first occurance of the specified
1070 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1073 * Get all characters from the first occurance of @a stop to the first '\0'
1074 * @param p The pool to allocate memory from
1075 * @param line The line to traverse
1076 * @param stop The character to start at
1077 * @return A copy of all caracters after the first occurance of the specified
1079 * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1081 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1084 * Get the second word in the string paying attention to quoting
1085 * @param p The pool to allocate from
1086 * @param line The line to traverse
1087 * @return A copy of the string
1089 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1091 * Get the second word in the string paying attention to quoting
1092 * @param p The pool to allocate from
1093 * @param line The line to traverse
1094 * @return A copy of the string
1095 * @note The same as ap_getword_conf(), except it doesn't use const char **.
1097 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1100 * Check a string for any ${ENV} environment variable construct and replace
1101 * each them by the value of that environment variable, if it exists. If the
1102 * environment value does not exist, leave the ${ENV} construct alone; it
1103 * means something else.
1104 * @param p The pool to allocate from
1105 * @param word The string to check
1106 * @return The string with the replaced environment variables
1108 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1111 * Size an HTTP header field list item, as separated by a comma.
1112 * @param field The field to size
1113 * @param len The length of the field
1114 * @return The return value is a pointer to the beginning of the non-empty
1115 * list item within the original string (or NULL if there is none) and the
1116 * address of field is shifted to the next non-comma, non-whitespace
1117 * character. len is the length of the item excluding any beginning whitespace.
1119 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1122 * Retrieve an HTTP header field list item, as separated by a comma,
1123 * while stripping insignificant whitespace and lowercasing anything not in
1124 * a quoted string or comment.
1125 * @param p The pool to allocate from
1126 * @param field The field to retrieve
1127 * @return The return value is a new string containing the converted list
1128 * item (or NULL if none) and the address pointed to by field is
1129 * shifted to the next non-comma, non-whitespace.
1131 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1134 * Find an item in canonical form (lowercase, no extra spaces) within
1135 * an HTTP field value list.
1136 * @param p The pool to allocate from
1137 * @param line The field value list to search
1138 * @param tok The token to search for
1139 * @return 1 if found, 0 if not found.
1141 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1144 * Retrieve a token, spacing over it and returning a pointer to
1145 * the first non-white byte afterwards. Note that these tokens
1146 * are delimited by semis and commas and can also be delimited
1147 * by whitespace at the caller's option.
1148 * @param p The pool to allocate from
1149 * @param accept_line The line to retrieve the token from
1150 * @param accept_white Is it delimited by whitespace
1151 * @return the first non-white byte after the token
1153 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1156 * Find http tokens, see the definition of token from RFC2068
1157 * @param p The pool to allocate from
1158 * @param line The line to find the token
1159 * @param tok The token to find
1160 * @return 1 if the token is found, 0 otherwise
1162 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1165 * find http tokens from the end of the line
1166 * @param p The pool to allocate from
1167 * @param line The line to find the token
1168 * @param tok The token to find
1169 * @return 1 if the token is found, 0 otherwise
1171 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1174 * Check for an Absolute URI syntax
1175 * @param u The string to check
1176 * @return 1 if URI, 0 otherwise
1178 AP_DECLARE(int) ap_is_url(const char *u);
1182 * @param url The url to unescapte
1183 * @return 0 on success, non-zero otherwise
1185 AP_DECLARE(int) ap_unescape_url(char *url);
1187 * Convert all double slashes to single slashes
1188 * @param name The string to convert
1190 AP_DECLARE(void) ap_no2slash(char *name);
1193 * Remove all ./ and xx/../ substrings from a file name. Also remove
1194 * any leading ../ or /../ substrings.
1195 * @param name the file name to parse
1197 AP_DECLARE(void) ap_getparents(char *name);
1200 * Escape a path segment, as defined in RFC 1808
1201 * @param p The pool to allocate from
1202 * @param s The path to convert
1203 * @return The converted URL
1205 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1207 * convert an OS path to a URL in an OS dependant way.
1208 * @param p The pool to allocate from
1209 * @param path The path to convert
1210 * @param partial if set, assume that the path will be appended to something
1211 * with a '/' in it (and thus does not prefix "./")
1212 * @return The converted URL
1214 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1215 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1218 * Escape an html string
1219 * @param p The pool to allocate from
1220 * @param s The html to escape
1221 * @return The escaped string
1223 AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
1226 * Construct a full hostname
1227 * @param p The pool to allocate from
1228 * @param hostname The hostname of the server
1229 * @param port The port the server is running on
1230 * @param r The current request
1231 * @return The server's hostname
1233 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1234 apr_port_t port, const request_rec *r);
1236 * Escape a shell command
1237 * @param p The pool to allocate from
1238 * @param s The command to escape
1239 * @return The escaped shell command
1241 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1244 * Count the number of directories in a path
1245 * @param path The path to count
1246 * @return The number of directories
1248 AP_DECLARE(int) ap_count_dirs(const char *path);
1251 * Copy at most @a n leading directories of @a s into @a d. @a d
1252 * should be at least as large as @a s plus 1 extra byte
1254 * @param d The location to copy to
1255 * @param s The location to copy from
1256 * @param n The number of directories to copy
1257 * @return value is the ever useful pointer to the trailing \0 of d
1258 * @note on platforms with drive letters, n = 0 returns the "/" root,
1259 * whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1260 * returns the empty string. */
1261 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1264 * Return the parent directory name (including trailing /) of the file
1266 * @param p The pool to allocate from
1267 * @param s The file to get the parent of
1268 * @return A copy of the file's parent directory
1270 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1273 * Given a directory and filename, create a single path from them. This
1274 * function is smart enough to ensure that there is a sinlge '/' between the
1275 * directory and file names
1276 * @param a The pool to allocate from
1277 * @param dir The directory name
1278 * @param f The filename
1279 * @return A copy of the full path
1280 * @tip Never consider using this function if you are dealing with filesystem
1281 * names that need to remain canonical, unless you are merging an apr_dir_read
1282 * path and returned filename. Otherwise, the result is not canonical.
1284 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1287 * Test if the given path has an an absolute path.
1288 * @param p The pool to allocate from
1289 * @param dir The directory name
1290 * @tip The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1291 * multiple forms of absolute paths. This only reports if the path is absolute
1292 * in a canonical sense.
1294 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1297 * Does the provided string contain wildcard characters? This is useful
1298 * for determining if the string should be passed to strcmp_match or to strcmp.
1299 * The only wildcard characters recognized are '?' and '*'
1300 * @param str The string to check
1301 * @return 1 if the string has wildcards, 0 otherwise
1303 AP_DECLARE(int) ap_is_matchexp(const char *str);
1306 * Determine if a string matches a patterm containing the wildcards '?' or '*'
1307 * @param str The string to check
1308 * @param exp The pattern to match against
1309 * @return 1 if the two strings match, 0 otherwise
1311 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *exp);
1313 * Determine if a string matches a patterm containing the wildcards '?' or '*',
1315 * @param str The string to check
1316 * @param exp The pattern to match against
1317 * @return 1 if the two strings match, 0 otherwise
1319 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *exp);
1322 * Find the first occurrence of the substring s2 in s1, regardless of case
1323 * @param s1 The string to search
1324 * @param s2 The substring to search for
1325 * @return A pointer to the beginning of the substring
1327 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1330 * Return a pointer to the location inside of bigstring immediately after prefix
1331 * @param bigstring The input string
1332 * @param prefix The prefix to strip away
1333 * @return A pointer relative to bigstring after prefix
1335 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1336 const char *prefix);
1339 * Decode a base64 encoded string into memory allocated from a pool
1340 * @param p The pool to allocate from
1341 * @param bufcoded The encoded string
1342 * @return The decoded string
1344 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1347 * Encode a string into memory allocated from a pool in base 64 format
1348 * @param p The pool to allocate from
1349 * @param strin The plaintext string
1350 * @return The encoded string
1352 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1356 * Compile a regular expression to be used later
1357 * @param p The pool to allocate from
1358 * @param pattern the regular expression to compile
1359 * @param cflags The bitwise or of one or more of the following:
1360 * @li #REG_EXTENDED - Use POSIX extended Regular Expressions
1361 * @li #REG_ICASE - Ignore case
1362 * @li #REG_NOSUB - Support for substring addressing of matches
1364 * @li #REG_NEWLINE - Match-any-character operators don't match new-line
1365 * @return The compiled regular expression
1367 AP_DECLARE(regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1371 * Free the memory associated with a compiled regular expression
1372 * @param p The pool the regex was allocated from
1373 * @param reg The regular expression to free
1375 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, regex_t *reg);
1378 * Match a null-terminated string against a pre-compiled regex.
1379 * @param preg The pre-compiled regex
1380 * @param string The string to match
1381 * @param nmatch Provide information regarding the location of any matches
1382 * @param pmatch Provide information regarding the location of any matches
1383 * @param eflags Bitwise or of any of:
1384 * @li #REG_NOTBOL - match-beginning-of-line operator always
1386 * @li #REG_NOTEOL - match-end-of-line operator always fails to match
1387 * @return 0 for successful match, #REG_NOMATCH otherwise
1389 AP_DECLARE(int) ap_regexec(regex_t *preg, const char *string,
1390 size_t nmatch, regmatch_t pmatch[], int eflags);
1393 * Return the error code returned by regcomp or regexec into error messages
1394 * @param errcode the error code returned by regexec or regcomp
1395 * @param preg The precompiled regex
1396 * @param errbuf A buffer to store the error in
1397 * @param errbuf_size The size of the buffer
1399 AP_DECLARE(size_t) ap_regerror(int errcode, const regex_t *preg,
1400 char *errbuf, size_t errbuf_size);
1403 * After performing a successful regex match, you may use this function to
1404 * perform a series of string substitutions based on subexpressions that were
1405 * matched during the call to ap_regexec
1406 * @param p The pool to allocate from
1407 * @param input An arbitrary string containing $1 through $9. These are
1408 * replaced with the corresponding matched sub-expressions
1409 * @param source The string that was originally matched to the regex
1410 * @param nmatch the nmatch returned from ap_pregex
1411 * @param pmatch the pmatch array returned from ap_pregex
1413 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1414 size_t nmatch, regmatch_t pmatch[]);
1417 * We want to downcase the type/subtype for comparison purposes
1418 * but nothing else because ;parameter=foo values are case sensitive.
1419 * @param s The content-type to convert to lowercase
1421 AP_DECLARE(void) ap_content_type_tolower(char *s);
1424 * convert a string to all lowercase
1425 * @param s The string to convert to lowercase
1427 AP_DECLARE(void) ap_str_tolower(char *s);
1430 * Search a string from left to right for the first occurrence of a
1431 * specific character
1432 * @param str The string to search
1433 * @param c The character to search for
1434 * @return The index of the first occurrence of c in str
1436 AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1439 * Search a string from right to left for the first occurrence of a
1440 * specific character
1441 * @param str The string to search
1442 * @param c The character to search for
1443 * @return The index of the first occurrence of c in str
1445 AP_DECLARE(int) ap_rind(const char *str, char c);
1448 * Given a string, replace any bare " with \" .
1449 * @param p The pool to allocate memory from
1450 * @param instring The string to search for "
1451 * @return A copy of the string with escaped quotes
1453 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1455 /* Misc system hackery */
1457 * Given the name of an object in the file system determine if it is a directory
1458 * @param p The pool to allocate from
1459 * @param name The name of the object to check
1460 * @return 1 if it is a directory, 0 otherwise
1462 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1465 * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1466 * @param p The pool to allocate from
1467 * @param name The name of the object to check
1468 * @return 1 if it is a directory, 0 otherwise
1470 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1473 extern const char *os_set_account(apr_pool_t *p, const char *account);
1474 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1475 #endif /* _OSD_POSIX */
1478 * Determine the local host name for the current machine
1479 * @param p The pool to allocate from
1480 * @return A copy of the local host name
1482 char *ap_get_local_host(apr_pool_t *p);
1485 * Redefine assert() to something more useful for an Apache...
1487 * Use ap_assert() if the condition should always be checked.
1488 * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1492 * Log an assertion to the error log
1493 * @param szExp The assertion that failed
1494 * @param szFile The file the assertion is in
1495 * @param nLine The line the assertion is defined on
1497 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1498 __attribute__((noreturn));
1499 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1502 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1504 #define AP_DEBUG_ASSERT(exp) ((void)0)
1507 /* A set of flags which indicate places where the server should raise(SIGSTOP).
1508 * This is useful for debugging, because you can then attach to that process
1509 * with gdb and continue. This is important in cases where one_process
1510 * debugging isn't possible.
1512 #define SIGSTOP_DETACH 1
1513 #define SIGSTOP_MAKE_CHILD 2
1514 #define SIGSTOP_SPAWN_CHILD 4
1515 #define SIGSTOP_PIPED_LOG_SPAWN 8
1516 #define SIGSTOP_CGI_CHILD 16
1518 #ifdef DEBUG_SIGSTOP
1519 extern int raise_sigstop_flags;
1520 #define RAISE_SIGSTOP(x) do { \
1521 if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1524 #define RAISE_SIGSTOP(x)
1528 * Get HTML describing the address and (optionally) admin of the server.
1529 * @param prefix Text which is prepended to the return value
1530 * @param r The request_rec
1531 * @return HTML describing the server, allocated in @a r's pool.
1533 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1535 /* strtoul does not exist on sunos4. */
1539 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1541 /* The C library has functions that allow const to be silently dropped ...
1542 these macros detect the drop in maintainer mode, but use the native
1543 methods for normal builds
1545 Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1546 to be included before the macros are defined or compilation will fail.
1553 # define strchr(s, c) ap_strchr(s,c)
1555 # define strrchr(s, c) ap_strrchr(s,c)
1557 # define strstr(s, c) ap_strstr(s,c)
1559 char *ap_strchr(char *s, int c);
1560 const char *ap_strchr_c(const char *s, int c);
1561 char *ap_strrchr(char *s, int c);
1562 const char *ap_strrchr_c(const char *s, int c);
1563 char *ap_strstr(char *s, const char *c);
1564 const char *ap_strstr_c(const char *s, const char *c);
1568 # define ap_strchr(s, c) strchr(s, c)
1569 # define ap_strchr_c(s, c) strchr(s, c)
1570 # define ap_strrchr(s, c) strrchr(s, c)
1571 # define ap_strrchr_c(s, c) strrchr(s, c)
1572 # define ap_strstr(s, c) strstr(s, c)
1573 # define ap_strstr_c(s, c) strstr(s, c)
1577 #define AP_NORESTART APR_OS_START_USEERR + 1
1583 #endif /* !APACHE_HTTPD_H */