]> granicus.if.org Git - apache/blob - include/httpd.h
In maintainer mode, replace apr_palloc with a version that
[apache] / include / httpd.h
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements.  See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License.  You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /**
18  * @file httpd.h
19  * @brief HTTP Daemon routines
20  *
21  * @defgroup APACHE Apache HTTP Server
22  *
23  * Top level group of which all other groups are a member
24  * @{
25  *
26  * @defgroup APACHE_MODS Loadable modules
27  *           Top level group for modules
28  * @defgroup APACHE_OS Operating System Specific
29  * @defgroup APACHE_INTERNAL Internal interfaces
30  * @defgroup APACHE_CORE Core routines
31  * @{
32  * @defgroup APACHE_CORE_DAEMON HTTP Daemon Routine
33  * @{
34  */
35
36 #ifndef APACHE_HTTPD_H
37 #define APACHE_HTTPD_H
38
39 /* XXX - We need to push more stuff to other .h files, or even .c files, to
40  * make this file smaller
41  */
42
43 /* Headers in which EVERYONE has an interest... */
44 #include "ap_config.h"
45 #include "ap_mmn.h"
46
47 #include "ap_release.h"
48
49 #include "apr.h"
50 #include "apr_general.h"
51 #include "apr_tables.h"
52 #include "apr_pools.h"
53 #include "apr_time.h"
54 #include "apr_network_io.h"
55 #include "apr_buckets.h"
56 #include "apr_poll.h"
57 #include "apr_thread_proc.h"
58
59 #include "os.h"
60
61 #include "ap_regex.h"
62
63 #if APR_HAVE_STDLIB_H
64 #include <stdlib.h>
65 #endif
66
67 /* Note: apr_uri.h is also included, see below */
68
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72
73 /* ----------------------------- config dir ------------------------------ */
74
75 /** Define this to be the default server home dir. Most things later in this
76  * file with a relative pathname will have this added.
77  */
78 #ifndef HTTPD_ROOT
79 #ifdef OS2
80 /** Set default for OS/2 file system */
81 #define HTTPD_ROOT "/os2httpd"
82 #elif defined(WIN32)
83 /** Set default for Windows file system */
84 #define HTTPD_ROOT "/apache"
85 #elif defined (NETWARE)
86 /** Set the default for NetWare */
87 #define HTTPD_ROOT "/apache"
88 #else
89 /** Set for all other OSs */
90 #define HTTPD_ROOT "/usr/local/apache"
91 #endif
92 #endif /* HTTPD_ROOT */
93
94 /*
95  * --------- You shouldn't have to edit anything below this line ----------
96  *
97  * Any modifications to any defaults not defined above should be done in the
98  * respective configuration file.
99  *
100  */
101
102 /**
103  * Default location of documents.  Can be overridden by the DocumentRoot
104  * directive.
105  */
106 #ifndef DOCUMENT_LOCATION
107 #ifdef OS2
108 /* Set default for OS/2 file system */
109 #define DOCUMENT_LOCATION  HTTPD_ROOT "/docs"
110 #else
111 /* Set default for non OS/2 file system */
112 #define DOCUMENT_LOCATION  HTTPD_ROOT "/htdocs"
113 #endif
114 #endif /* DOCUMENT_LOCATION */
115
116 /** Maximum number of dynamically loaded modules */
117 #ifndef DYNAMIC_MODULE_LIMIT
118 #define DYNAMIC_MODULE_LIMIT 256
119 #endif
120
121 /** Default administrator's address */
122 #define DEFAULT_ADMIN "[no address given]"
123
124 /** The name of the log files */
125 #ifndef DEFAULT_ERRORLOG
126 #if defined(OS2) || defined(WIN32)
127 #define DEFAULT_ERRORLOG "logs/error.log"
128 #else
129 #define DEFAULT_ERRORLOG "logs/error_log"
130 #endif
131 #endif /* DEFAULT_ERRORLOG */
132
133 /** Define this to be what your per-directory security files are called */
134 #ifndef DEFAULT_ACCESS_FNAME
135 #ifdef OS2
136 /* Set default for OS/2 file system */
137 #define DEFAULT_ACCESS_FNAME "htaccess"
138 #else
139 #define DEFAULT_ACCESS_FNAME ".htaccess"
140 #endif
141 #endif /* DEFAULT_ACCESS_FNAME */
142
143 /** The name of the server config file */
144 #ifndef SERVER_CONFIG_FILE
145 #define SERVER_CONFIG_FILE "conf/httpd.conf"
146 #endif
147
148 /** The default path for CGI scripts if none is currently set */
149 #ifndef DEFAULT_PATH
150 #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
151 #endif
152
153 /** The path to the suExec wrapper, can be overridden in Configuration */
154 #ifndef SUEXEC_BIN
155 #define SUEXEC_BIN  HTTPD_ROOT "/bin/suexec"
156 #endif
157
158 /** The timeout for waiting for messages */
159 #ifndef DEFAULT_TIMEOUT
160 #define DEFAULT_TIMEOUT 60
161 #endif
162
163 /** The timeout for waiting for keepalive timeout until next request */
164 #ifndef DEFAULT_KEEPALIVE_TIMEOUT
165 #define DEFAULT_KEEPALIVE_TIMEOUT 5
166 #endif
167
168 /** The number of requests to entertain per connection */
169 #ifndef DEFAULT_KEEPALIVE
170 #define DEFAULT_KEEPALIVE 100
171 #endif
172
173 /*
174  * Limits on the size of various request items.  These limits primarily
175  * exist to prevent simple denial-of-service attacks on a server based
176  * on misuse of the protocol.  The recommended values will depend on the
177  * nature of the server resources -- CGI scripts and database backends
178  * might require large values, but most servers could get by with much
179  * smaller limits than we use below.  The request message body size can
180  * be limited by the per-dir config directive LimitRequestBody.
181  *
182  * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
183  * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
184  * These two limits can be lowered or raised by the server config
185  * directives LimitRequestLine and LimitRequestFieldsize, respectively.
186  *
187  * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
188  * the server config directive LimitRequestFields.
189  */
190
191 /** default limit on bytes in Request-Line (Method+URI+HTTP-version) */
192 #ifndef DEFAULT_LIMIT_REQUEST_LINE
193 #define DEFAULT_LIMIT_REQUEST_LINE 8190
194 #endif
195 /** default limit on bytes in any one header field  */
196 #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
197 #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
198 #endif
199 /** default limit on number of request header fields */
200 #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
201 #define DEFAULT_LIMIT_REQUEST_FIELDS 100
202 #endif
203
204 /**
205  * The default default character set name to add if AddDefaultCharset is
206  * enabled.  Overridden with AddDefaultCharsetName.
207  */
208 #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
209
210 /** default HTTP Server protocol */
211 #define AP_SERVER_PROTOCOL "HTTP/1.1"
212
213
214 /* ------------------ stuff that modules are allowed to look at ----------- */
215
216 /** Define this to be what your HTML directory content files are called */
217 #ifndef AP_DEFAULT_INDEX
218 #define AP_DEFAULT_INDEX "index.html"
219 #endif
220
221 /** The name of the MIME types file */
222 #ifndef AP_TYPES_CONFIG_FILE
223 #define AP_TYPES_CONFIG_FILE "conf/mime.types"
224 #endif
225
226 /*
227  * Define the HTML doctype strings centrally.
228  */
229 /** HTML 2.0 Doctype */
230 #define DOCTYPE_HTML_2_0  "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
231                           "DTD HTML 2.0//EN\">\n"
232 /** HTML 3.2 Doctype */
233 #define DOCTYPE_HTML_3_2  "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
234                           "DTD HTML 3.2 Final//EN\">\n"
235 /** HTML 4.0 Strict Doctype */
236 #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
237                           "DTD HTML 4.0//EN\"\n" \
238                           "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
239 /** HTML 4.0 Transitional Doctype */
240 #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
241                           "DTD HTML 4.0 Transitional//EN\"\n" \
242                           "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
243 /** HTML 4.0 Frameset Doctype */
244 #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
245                           "DTD HTML 4.0 Frameset//EN\"\n" \
246                           "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
247 /** XHTML 1.0 Strict Doctype */
248 #define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
249                            "DTD XHTML 1.0 Strict//EN\"\n" \
250                            "\"http://www.w3.org/TR/xhtml1/DTD/" \
251                            "xhtml1-strict.dtd\">\n"
252 /** XHTML 1.0 Transitional Doctype */
253 #define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
254                            "DTD XHTML 1.0 Transitional//EN\"\n" \
255                            "\"http://www.w3.org/TR/xhtml1/DTD/" \
256                            "xhtml1-transitional.dtd\">\n"
257 /** XHTML 1.0 Frameset Doctype */
258 #define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
259                            "DTD XHTML 1.0 Frameset//EN\"\n" \
260                            "\"http://www.w3.org/TR/xhtml1/DTD/" \
261                            "xhtml1-frameset.dtd\">"
262
263 /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
264 #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
265 /** Major part of HTTP protocol */
266 #define HTTP_VERSION_MAJOR(number) ((number)/1000)
267 /** Minor part of HTTP protocol */
268 #define HTTP_VERSION_MINOR(number) ((number)%1000)
269
270 /* -------------- Port number for server running standalone --------------- */
271
272 /** default HTTP Port */
273 #define DEFAULT_HTTP_PORT       80
274 /** default HTTPS Port */
275 #define DEFAULT_HTTPS_PORT      443
276 /**
277  * Check whether @a port is the default port for the request @a r.
278  * @param port The port number
279  * @param r The request
280  * @see #ap_default_port
281  */
282 #define ap_is_default_port(port,r)      ((port) == ap_default_port(r))
283 /**
284  * Get the default port for a request (which depends on the scheme).
285  * @param r The request
286  */
287 #define ap_default_port(r)      ap_run_default_port(r)
288 /**
289  * Get the scheme for a request.
290  * @param r The request
291  */
292 #define ap_http_scheme(r)       ap_run_http_scheme(r)
293
294 /** The default string length */
295 #define MAX_STRING_LEN HUGE_STRING_LEN
296
297 /** The length of a Huge string */
298 #define HUGE_STRING_LEN 8192
299
300 /** The size of the server's internal read-write buffers */
301 #define AP_IOBUFSIZE 8192
302
303 /** The max number of regex captures that can be expanded by ap_pregsub */
304 #define AP_MAX_REG_MATCH 10
305
306 /**
307  * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
308  * mutiple buckets, no greater than MAX(apr_size_t), and more granular
309  * than that in case the brigade code/filters attempt to read it directly.
310  * ### 16mb is an invention, no idea if it is reasonable.
311  */
312 #define AP_MAX_SENDFILE 16777216  /* 2^24 */
313
314 /**
315  * Special Apache error codes. These are basically used
316  *  in http_main.c so we can keep track of various errors.
317  *
318  */
319 /** a normal exit */
320 #define APEXIT_OK               0x0
321 /** A fatal error arising during the server's init sequence */
322 #define APEXIT_INIT             0x2
323 /**  The child died during its init sequence */
324 #define APEXIT_CHILDINIT        0x3
325 /**
326  *   The child exited due to a resource shortage.
327  *   The parent should limit the rate of forking until
328  *   the situation is resolved.
329  */
330 #define APEXIT_CHILDSICK        0x7
331 /**
332  *     A fatal error, resulting in the whole server aborting.
333  *     If a child exits with this error, the parent process
334  *     considers this a server-wide fatal error and aborts.
335  */
336 #define APEXIT_CHILDFATAL       0xf
337
338 #ifndef AP_DECLARE
339 /**
340  * Stuff marked #AP_DECLARE is part of the API, and intended for use
341  * by modules. Its purpose is to allow us to add attributes that
342  * particular platforms or compilers require to every exported function.
343  */
344 # define AP_DECLARE(type)    type
345 #endif
346
347 #ifndef AP_DECLARE_NONSTD
348 /**
349  * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
350  * use by modules.  The difference between #AP_DECLARE and
351  * #AP_DECLARE_NONSTD is that the latter is required for any functions
352  * which use varargs or are used via indirect function call.  This
353  * is to accomodate the two calling conventions in windows dlls.
354  */
355 # define AP_DECLARE_NONSTD(type)    type
356 #endif
357 #ifndef AP_DECLARE_DATA
358 # define AP_DECLARE_DATA
359 #endif
360
361 #ifndef AP_MODULE_DECLARE
362 # define AP_MODULE_DECLARE(type)    type
363 #endif
364 #ifndef AP_MODULE_DECLARE_NONSTD
365 # define AP_MODULE_DECLARE_NONSTD(type)  type
366 #endif
367 #ifndef AP_MODULE_DECLARE_DATA
368 # define AP_MODULE_DECLARE_DATA
369 #endif
370
371 /**
372  * @internal
373  * modules should not use functions marked AP_CORE_DECLARE
374  */
375 #ifndef AP_CORE_DECLARE
376 # define AP_CORE_DECLARE        AP_DECLARE
377 #endif
378
379 /**
380  * @internal
381  * modules should not use functions marked AP_CORE_DECLARE_NONSTD
382  */
383
384 #ifndef AP_CORE_DECLARE_NONSTD
385 # define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
386 #endif
387
388 /**
389  * @defgroup APACHE_APR_STATUS_T HTTPD specific values of apr_status_t
390  * @{
391  */
392 #define AP_START_USERERR            (APR_OS_START_USERERR + 2000)
393 #define AP_USERERR_LEN              1000
394
395 /** The function declines to handle the request */
396 #define AP_DECLINED                 (AP_START_USERERR + 0)
397
398 /** @} */
399
400 /**
401  * @brief The numeric version information is broken out into fields within this
402  * structure.
403  */
404 typedef struct {
405     int major;              /**< major number */
406     int minor;              /**< minor number */
407     int patch;              /**< patch number */
408     const char *add_string; /**< additional string like "-dev" */
409 } ap_version_t;
410
411 /**
412  * Return httpd's version information in a numeric form.
413  *
414  *  @param version Pointer to a version structure for returning the version
415  *                 information.
416  */
417 AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
418
419 /**
420  * Get the server banner in a form suitable for sending over the
421  * network, with the level of information controlled by the
422  * ServerTokens directive.
423  * @return The server banner
424  */
425 AP_DECLARE(const char *) ap_get_server_banner(void);
426
427 /**
428  * Get the server description in a form suitable for local displays,
429  * status reports, or logging.  This includes the detailed server
430  * version and information about some modules.  It is not affected
431  * by the ServerTokens directive.
432  * @return The server description
433  */
434 AP_DECLARE(const char *) ap_get_server_description(void);
435
436 /**
437  * Add a component to the server description and banner strings
438  * @param pconf The pool to allocate the component from
439  * @param component The string to add
440  */
441 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
442
443 /**
444  * Get the date a time that the server was built
445  * @return The server build time string
446  */
447 AP_DECLARE(const char *) ap_get_server_built(void);
448
449 /* non-HTTP status codes returned by hooks */
450
451 #define OK 0                    /**< Module has handled this stage. */
452 #define DECLINED -1             /**< Module declines to handle */
453 #define DONE -2                 /**< Module has served the response completely
454                                  *  - it's safe to die() with no more output
455                                  */
456 #define SUSPENDED -3 /**< Module will handle the remainder of the request.
457                       * The core will never invoke the request again, */
458
459 /** Returned by the bottom-most filter if no data was written.
460  *  @see ap_pass_brigade(). */
461 #define AP_NOBODY_WROTE         -100
462 /** Returned by the bottom-most filter if no data was read.
463  *  @see ap_get_brigade(). */
464 #define AP_NOBODY_READ          -101
465 /** Returned by any filter if the filter chain encounters an error
466  *  and has already dealt with the error response.
467  */
468 #define AP_FILTER_ERROR         -102
469
470 /**
471  * @defgroup HTTP_Status HTTP Status Codes
472  * @{
473  */
474 /**
475  * The size of the static array in http_protocol.c for storing
476  * all of the potential response status-lines (a sparse table).
477  * A future version should dynamically generate the apr_table_t at startup.
478  */
479 #define RESPONSE_CODES 57
480
481 #define HTTP_CONTINUE                      100
482 #define HTTP_SWITCHING_PROTOCOLS           101
483 #define HTTP_PROCESSING                    102
484 #define HTTP_OK                            200
485 #define HTTP_CREATED                       201
486 #define HTTP_ACCEPTED                      202
487 #define HTTP_NON_AUTHORITATIVE             203
488 #define HTTP_NO_CONTENT                    204
489 #define HTTP_RESET_CONTENT                 205
490 #define HTTP_PARTIAL_CONTENT               206
491 #define HTTP_MULTI_STATUS                  207
492 #define HTTP_MULTIPLE_CHOICES              300
493 #define HTTP_MOVED_PERMANENTLY             301
494 #define HTTP_MOVED_TEMPORARILY             302
495 #define HTTP_SEE_OTHER                     303
496 #define HTTP_NOT_MODIFIED                  304
497 #define HTTP_USE_PROXY                     305
498 #define HTTP_TEMPORARY_REDIRECT            307
499 #define HTTP_BAD_REQUEST                   400
500 #define HTTP_UNAUTHORIZED                  401
501 #define HTTP_PAYMENT_REQUIRED              402
502 #define HTTP_FORBIDDEN                     403
503 #define HTTP_NOT_FOUND                     404
504 #define HTTP_METHOD_NOT_ALLOWED            405
505 #define HTTP_NOT_ACCEPTABLE                406
506 #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
507 #define HTTP_REQUEST_TIME_OUT              408
508 #define HTTP_CONFLICT                      409
509 #define HTTP_GONE                          410
510 #define HTTP_LENGTH_REQUIRED               411
511 #define HTTP_PRECONDITION_FAILED           412
512 #define HTTP_REQUEST_ENTITY_TOO_LARGE      413
513 #define HTTP_REQUEST_URI_TOO_LARGE         414
514 #define HTTP_UNSUPPORTED_MEDIA_TYPE        415
515 #define HTTP_RANGE_NOT_SATISFIABLE         416
516 #define HTTP_EXPECTATION_FAILED            417
517 #define HTTP_UNPROCESSABLE_ENTITY          422
518 #define HTTP_LOCKED                        423
519 #define HTTP_FAILED_DEPENDENCY             424
520 #define HTTP_UPGRADE_REQUIRED              426
521 #define HTTP_INTERNAL_SERVER_ERROR         500
522 #define HTTP_NOT_IMPLEMENTED               501
523 #define HTTP_BAD_GATEWAY                   502
524 #define HTTP_SERVICE_UNAVAILABLE           503
525 #define HTTP_GATEWAY_TIME_OUT              504
526 #define HTTP_VERSION_NOT_SUPPORTED         505
527 #define HTTP_VARIANT_ALSO_VARIES           506
528 #define HTTP_INSUFFICIENT_STORAGE          507
529 #define HTTP_NOT_EXTENDED                  510
530
531 /** is the status code informational */
532 #define ap_is_HTTP_INFO(x)         (((x) >= 100)&&((x) < 200))
533 /** is the status code OK ?*/
534 #define ap_is_HTTP_SUCCESS(x)      (((x) >= 200)&&((x) < 300))
535 /** is the status code a redirect */
536 #define ap_is_HTTP_REDIRECT(x)     (((x) >= 300)&&((x) < 400))
537 /** is the status code a error (client or server) */
538 #define ap_is_HTTP_ERROR(x)        (((x) >= 400)&&((x) < 600))
539 /** is the status code a client error  */
540 #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
541 /** is the status code a server error  */
542 #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
543 /** is the status code a (potentially) valid response code?  */
544 #define ap_is_HTTP_VALID_RESPONSE(x) (((x) >= 100)&&((x) < 600))
545
546 /** should the status code drop the connection */
547 #define ap_status_drops_connection(x) \
548                                    (((x) == HTTP_BAD_REQUEST)           || \
549                                     ((x) == HTTP_REQUEST_TIME_OUT)      || \
550                                     ((x) == HTTP_LENGTH_REQUIRED)       || \
551                                     ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
552                                     ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
553                                     ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
554                                     ((x) == HTTP_SERVICE_UNAVAILABLE) || \
555                                     ((x) == HTTP_NOT_IMPLEMENTED))
556 /** @} */
557
558 /**
559  * @defgroup Methods List of Methods recognized by the server
560  * @ingroup APACHE_CORE_DAEMON
561  * @{
562  *
563  * @brief Methods recognized (but not necessarily handled) by the server.
564  *
565  * These constants are used in bit shifting masks of size int, so it is
566  * unsafe to have more methods than bits in an int.  HEAD == M_GET.
567  * This list must be tracked by the list in http_protocol.c in routine
568  * ap_method_name_of().
569  *
570  */
571
572 #define M_GET                   0       /** RFC 2616: HTTP */
573 #define M_PUT                   1       /*  :             */
574 #define M_POST                  2
575 #define M_DELETE                3
576 #define M_CONNECT               4
577 #define M_OPTIONS               5
578 #define M_TRACE                 6       /** RFC 2616: HTTP */
579 #define M_PATCH                 7       /** no rfc(!)  ### remove this one? */
580 #define M_PROPFIND              8       /** RFC 2518: WebDAV */
581 #define M_PROPPATCH             9       /*  :               */
582 #define M_MKCOL                 10
583 #define M_COPY                  11
584 #define M_MOVE                  12
585 #define M_LOCK                  13
586 #define M_UNLOCK                14      /** RFC 2518: WebDAV */
587 #define M_VERSION_CONTROL       15      /** RFC 3253: WebDAV Versioning */
588 #define M_CHECKOUT              16      /*  :                          */
589 #define M_UNCHECKOUT            17
590 #define M_CHECKIN               18
591 #define M_UPDATE                19
592 #define M_LABEL                 20
593 #define M_REPORT                21
594 #define M_MKWORKSPACE           22
595 #define M_MKACTIVITY            23
596 #define M_BASELINE_CONTROL      24
597 #define M_MERGE                 25
598 #define M_INVALID               26      /** RFC 3253: WebDAV Versioning */
599
600 /**
601  * METHODS needs to be equal to the number of bits
602  * we are using for limit masks.
603  */
604 #define METHODS     64
605
606 /**
607  * The method mask bit to shift for anding with a bitmask.
608  */
609 #define AP_METHOD_BIT ((apr_int64_t)1)
610 /** @} */
611
612
613 /** @see ap_method_list_t */
614 typedef struct ap_method_list_t ap_method_list_t;
615
616 /**
617  * @struct ap_method_list_t
618  * @brief  Structure for handling HTTP methods.
619  *
620  * Methods known to the server are accessed via a bitmask shortcut;
621  * extension methods are handled by an array.
622  */
623 struct ap_method_list_t {
624     /** The bitmask used for known methods */
625     apr_int64_t method_mask;
626     /** the array used for extension methods */
627     apr_array_header_t *method_list;
628 };
629
630 /**
631  * @defgroup module_magic Module Magic mime types
632  * @{
633  */
634 /** Magic for mod_cgi[d] */
635 #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
636 /** Magic for mod_include */
637 #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
638 /** Magic for mod_include */
639 #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
640 /** Magic for mod_dir */
641 #define DIR_MAGIC_TYPE "httpd/unix-directory"
642
643 /** @} */
644 /* Just in case your linefeed isn't the one the other end is expecting. */
645 #if !APR_CHARSET_EBCDIC
646 /** linefeed */
647 #define LF 10
648 /** carrige return */
649 #define CR 13
650 /** carrige return /Line Feed Combo */
651 #define CRLF "\015\012"
652 #else /* APR_CHARSET_EBCDIC */
653 /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
654  * in the buff package (bread/bputs/bwrite).  Everywhere else, we use
655  * "native EBCDIC" CR and NL characters. These are therefore
656  * defined as
657  * '\r' and '\n'.
658  */
659 #define CR '\r'
660 #define LF '\n'
661 #define CRLF "\r\n"
662 #endif /* APR_CHARSET_EBCDIC */
663 /** Useful for common code with either platform charset. */
664 #define CRLF_ASCII "\015\012"
665
666 /**
667  * @defgroup values_request_rec_body Possible values for request_rec.read_body
668  * @{
669  * Possible values for request_rec.read_body (set by handling module):
670  */
671
672 /** Send 413 error if message has any body */
673 #define REQUEST_NO_BODY          0
674 /** Send 411 error if body without Content-Length */
675 #define REQUEST_CHUNKED_ERROR    1
676 /** If chunked, remove the chunks for me. */
677 #define REQUEST_CHUNKED_DECHUNK  2
678 /** @} // values_request_rec_body */
679
680 /**
681  * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
682  * @ingroup APACHE_CORE_DAEMON
683  * @{
684  * Possible values for request_rec.used_path_info:
685  */
686
687 /** Accept the path_info from the request */
688 #define AP_REQ_ACCEPT_PATH_INFO    0
689 /** Return a 404 error if path_info was given */
690 #define AP_REQ_REJECT_PATH_INFO    1
691 /** Module may chose to use the given path_info */
692 #define AP_REQ_DEFAULT_PATH_INFO   2
693
694 /** @} // values_request_rec_used_path_info */
695
696
697 /*
698  * Things which may vary per file-lookup WITHIN a request ---
699  * e.g., state of MIME config.  Basically, the name of an object, info
700  * about the object, and any other info we may ahve which may need to
701  * change as we go poking around looking for it (e.g., overridden by
702  * .htaccess files).
703  *
704  * Note how the default state of almost all these things is properly
705  * zero, so that allocating it with pcalloc does the right thing without
706  * a whole lot of hairy initialization... so long as we are willing to
707  * make the (fairly) portable assumption that the bit pattern of a NULL
708  * pointer is, in fact, zero.
709  */
710
711 /**
712  * @brief This represents the result of calling htaccess; these are cached for
713  * each request.
714  */
715 struct htaccess_result {
716     /** the directory to which this applies */
717     const char *dir;
718     /** the overrides allowed for the .htaccess file */
719     int override;
720     /** the override options allowed for the .htaccess file */
721     int override_opts;
722     /** Table of allowed directives for override */
723     apr_table_t *override_list;
724     /** the configuration directives */
725     struct ap_conf_vector_t *htaccess;
726     /** the next one, or NULL if no more; N.B. never change this */
727     const struct htaccess_result *next;
728 };
729
730 /* The following four types define a hierarchy of activities, so that
731  * given a request_rec r you can write r->connection->server->process
732  * to get to the process_rec.  While this reduces substantially the
733  * number of arguments that various hooks require beware that in
734  * threaded versions of the server you must consider multiplexing
735  * issues.  */
736
737
738 /** A structure that represents one process */
739 typedef struct process_rec process_rec;
740 /** A structure that represents a virtual server */
741 typedef struct server_rec server_rec;
742 /** A structure that represents one connection */
743 typedef struct conn_rec conn_rec;
744 /** A structure that represents the current request */
745 typedef struct request_rec request_rec;
746 /** A structure that represents the status of the current connection */
747 typedef struct conn_state_t conn_state_t;
748
749 /* ### would be nice to not include this from httpd.h ... */
750 /* This comes after we have defined the request_rec type */
751 #include "apr_uri.h"
752
753 /**
754  * @brief A structure that represents one process
755  */
756 struct process_rec {
757     /** Global pool. Cleared upon normal exit */
758     apr_pool_t *pool;
759     /** Configuration pool. Cleared upon restart */
760     apr_pool_t *pconf;
761     /** The program name used to execute the program */
762     const char *short_name;
763     /** The command line arguments */
764     const char * const *argv;
765     /** Number of command line arguments passed to the program */
766     int argc;
767 };
768
769 /**
770  * @brief A structure that represents the current request
771  */
772 struct request_rec {
773     /** The pool associated with the request */
774     apr_pool_t *pool;
775     /** The connection to the client */
776     conn_rec *connection;
777     /** The virtual host for this request */
778     server_rec *server;
779
780     /** Pointer to the redirected request if this is an external redirect */
781     request_rec *next;
782     /** Pointer to the previous request if this is an internal redirect */
783     request_rec *prev;
784
785     /** Pointer to the main request if this is a sub-request
786      * (see http_request.h) */
787     request_rec *main;
788
789     /* Info about the request itself... we begin with stuff that only
790      * protocol.c should ever touch...
791      */
792     /** First line of request */
793     char *the_request;
794     /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
795     int assbackwards;
796     /** A proxy request (calculated during post_read_request/translate_name)
797      *  possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
798      *                  PROXYREQ_RESPONSE
799      */
800     int proxyreq;
801     /** HEAD request, as opposed to GET */
802     int header_only;
803     /** Protocol version number of protocol; 1.1 = 1001 */
804     int proto_num;
805     /** Protocol string, as given to us, or HTTP/0.9 */
806     char *protocol;
807     /** Host, as set by full URI or Host: */
808     const char *hostname;
809
810     /** Time when the request started */
811     apr_time_t request_time;
812
813     /** Status line, if set by script */
814     const char *status_line;
815     /** Status line */
816     int status;
817
818     /* Request method, two ways; also, protocol, etc..  Outside of protocol.c,
819      * look, but don't touch.
820      */
821
822     /** M_GET, M_POST, etc. */
823     int method_number;
824     /** Request method (eg. GET, HEAD, POST, etc.) */
825     const char *method;
826
827     /**
828      *  'allowed' is a bitvector of the allowed methods.
829      *
830      *  A handler must ensure that the request method is one that
831      *  it is capable of handling.  Generally modules should DECLINE
832      *  any request methods they do not handle.  Prior to aborting the
833      *  handler like this the handler should set r->allowed to the list
834      *  of methods that it is willing to handle.  This bitvector is used
835      *  to construct the "Allow:" header required for OPTIONS requests,
836      *  and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
837      *
838      *  Since the default_handler deals with OPTIONS, all modules can
839      *  usually decline to deal with OPTIONS.  TRACE is always allowed,
840      *  modules don't need to set it explicitly.
841      *
842      *  Since the default_handler will always handle a GET, a
843      *  module which does *not* implement GET should probably return
844      *  HTTP_METHOD_NOT_ALLOWED.  Unfortunately this means that a Script GET
845      *  handler can't be installed by mod_actions.
846      */
847     apr_int64_t allowed;
848     /** Array of extension methods */
849     apr_array_header_t *allowed_xmethods;
850     /** List of allowed methods */
851     ap_method_list_t *allowed_methods;
852
853     /** byte count in stream is for body */
854     apr_off_t sent_bodyct;
855     /** body byte count, for easy access */
856     apr_off_t bytes_sent;
857     /** Last modified time of the requested resource */
858     apr_time_t mtime;
859
860     /* HTTP/1.1 connection-level features */
861
862     /** The Range: header */
863     const char *range;
864     /** The "real" content length */
865     apr_off_t clength;
866     /** sending chunked transfer-coding */
867     int chunked;
868
869     /** Method for reading the request body
870      * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
871      *  REQUEST_CHUNKED_DECHUNK, etc...) */
872     int read_body;
873     /** reading chunked transfer-coding */
874     int read_chunked;
875     /** is client waiting for a 100 response? */
876     unsigned expecting_100;
877     /** The optional kept body of the request. */
878     apr_bucket_brigade *kept_body;
879     /** For ap_body_to_table(): parsed body */
880     /* XXX: ap_body_to_table has been removed. Remove body_table too or
881      * XXX: keep it to reintroduce ap_body_to_table without major bump? */
882     apr_table_t *body_table;
883     /** Remaining bytes left to read from the request body */
884     apr_off_t remaining;
885     /** Number of bytes that have been read  from the request body */
886     apr_off_t read_length;
887
888     /* MIME header environments, in and out.  Also, an array containing
889      * environment variables to be passed to subprocesses, so people can
890      * write modules to add to that environment.
891      *
892      * The difference between headers_out and err_headers_out is that the
893      * latter are printed even on error, and persist across internal redirects
894      * (so the headers printed for ErrorDocument handlers will have them).
895      *
896      * The 'notes' apr_table_t is for notes from one module to another, with no
897      * other set purpose in mind...
898      */
899
900     /** MIME header environment from the request */
901     apr_table_t *headers_in;
902     /** MIME header environment for the response */
903     apr_table_t *headers_out;
904     /** MIME header environment for the response, printed even on errors and
905      * persist across internal redirects */
906     apr_table_t *err_headers_out;
907     /** Array of environment variables to be used for sub processes */
908     apr_table_t *subprocess_env;
909     /** Notes from one module to another */
910     apr_table_t *notes;
911
912     /* content_type, handler, content_encoding, and all content_languages
913      * MUST be lowercased strings.  They may be pointers to static strings;
914      * they should not be modified in place.
915      */
916     /** The content-type for the current request */
917     const char *content_type;   /* Break these out --- we dispatch on 'em */
918     /** The handler string that we use to call a handler function */
919     const char *handler;        /* What we *really* dispatch on */
920
921     /** How to encode the data */
922     const char *content_encoding;
923     /** Array of strings representing the content languages */
924     apr_array_header_t *content_languages;
925
926     /** variant list validator (if negotiated) */
927     char *vlist_validator;
928
929     /** If an authentication check was made, this gets set to the user name. */
930     char *user;
931     /** If an authentication check was made, this gets set to the auth type. */
932     char *ap_auth_type;
933
934     /* What object is being requested (either directly, or via include
935      * or content-negotiation mapping).
936      */
937
938     /** The URI without any parsing performed */
939     char *unparsed_uri;
940     /** The path portion of the URI, or "/" if no path provided */
941     char *uri;
942     /** The filename on disk corresponding to this response */
943     char *filename;
944     /* XXX: What does this mean? Please define "canonicalize" -aaron */
945     /** The true filename, we canonicalize r->filename if these don't match */
946     char *canonical_filename;
947     /** The PATH_INFO extracted from this request */
948     char *path_info;
949     /** The QUERY_ARGS extracted from this request */
950     char *args;
951
952     /**
953      * Flag for the handler to accept or reject path_info on
954      * the current request.  All modules should respect the
955      * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
956      * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
957      * may follow existing conventions.  This is set to the
958      * user's preference upon HOOK_VERY_FIRST of the fixups.
959      */
960     int used_path_info;
961
962     /** A flag to determine if the eos bucket has been sent yet */
963     int eos_sent;
964
965     /* Various other config info which may change with .htaccess files
966      * These are config vectors, with one void* pointer for each module
967      * (the thing pointed to being the module's business).
968      */
969
970     /** Options set in config files, etc. */
971     struct ap_conf_vector_t *per_dir_config;
972     /** Notes on *this* request */
973     struct ap_conf_vector_t *request_config;
974
975     /** Optional request log level configuration. Will usually point
976      *  to a server or per_dir config, i.e. must be copied before
977      *  modifying */
978     const struct ap_logconf *log;
979
980     /** Id to identify request in access and error log. Set when the first
981      *  error log entry for this request is generated.
982      */
983     const char *log_id;
984
985     /**
986      * A linked list of the .htaccess configuration directives
987      * accessed by this request.
988      * N.B. always add to the head of the list, _never_ to the end.
989      * that way, a sub request's list can (temporarily) point to a parent's list
990      */
991     const struct htaccess_result *htaccess;
992
993     /** A list of output filters to be used for this request */
994     struct ap_filter_t *output_filters;
995     /** A list of input filters to be used for this request */
996     struct ap_filter_t *input_filters;
997
998     /** A list of protocol level output filters to be used for this
999      *  request */
1000     struct ap_filter_t *proto_output_filters;
1001     /** A list of protocol level input filters to be used for this
1002      *  request */
1003     struct ap_filter_t *proto_input_filters;
1004
1005     /** This response can not be cached */
1006     int no_cache;
1007     /** There is no local copy of this response */
1008     int no_local_copy;
1009
1010     /** Mutex protect callbacks registered with ap_mpm_register_timed_callback
1011      * from being run before the original handler finishes running
1012      */
1013     apr_thread_mutex_t *invoke_mtx;
1014
1015     /** A struct containing the components of URI */
1016     apr_uri_t parsed_uri;
1017     /**  finfo.protection (st_mode) set to zero if no such file */
1018     apr_finfo_t finfo;
1019
1020     /** remote address information from conn_rec, can be overridden if
1021      * necessary by a module.
1022      */
1023     apr_sockaddr_t *useragent_addr;
1024     char *useragent_ip;
1025 };
1026
1027 /**
1028  * @defgroup ProxyReq Proxy request types
1029  *
1030  * Possible values of request_rec->proxyreq. A request could be normal,
1031  *  proxied or reverse proxied. Normally proxied and reverse proxied are
1032  *  grouped together as just "proxied", but sometimes it's necessary to
1033  *  tell the difference between the two, such as for authentication.
1034  * @{
1035  */
1036
1037 #define PROXYREQ_NONE     0     /**< No proxy */
1038 #define PROXYREQ_PROXY    1     /**< Standard proxy */
1039 #define PROXYREQ_REVERSE  2     /**< Reverse proxy */
1040 #define PROXYREQ_RESPONSE 3     /**< Origin response */
1041
1042 /* @} */
1043
1044 /**
1045  * @brief Enumeration of connection keepalive options
1046  */
1047 typedef enum {
1048     AP_CONN_UNKNOWN,
1049     AP_CONN_CLOSE,
1050     AP_CONN_KEEPALIVE
1051 } ap_conn_keepalive_e;
1052
1053 /**
1054  * @brief Structure to store things which are per connection
1055  */
1056 struct conn_rec {
1057     /** Pool associated with this connection */
1058     apr_pool_t *pool;
1059     /** Physical vhost this conn came in on */
1060     server_rec *base_server;
1061     /** used by http_vhost.c */
1062     void *vhost_lookup_data;
1063
1064     /* Information about the connection itself */
1065     /** local address */
1066     apr_sockaddr_t *local_addr;
1067     /** remote address */
1068     apr_sockaddr_t *client_addr;
1069
1070     /** Client's IP address */
1071     char *client_ip;
1072     /** Client's DNS name, if known.  NULL if DNS hasn't been checked,
1073      *  "" if it has and no address was found.  N.B. Only access this though
1074      * get_remote_host() */
1075     char *remote_host;
1076     /** Only ever set if doing rfc1413 lookups.  N.B. Only access this through
1077      *  get_remote_logname() */
1078     char *remote_logname;
1079
1080     /** server IP address */
1081     char *local_ip;
1082     /** used for ap_get_server_name when UseCanonicalName is set to DNS
1083      *  (ignores setting of HostnameLookups) */
1084     char *local_host;
1085
1086     /** ID of this connection; unique at any point in time */
1087     long id;
1088     /** Config vector containing pointers to connections per-server
1089      *  config structures. */
1090     struct ap_conf_vector_t *conn_config;
1091     /** Notes on *this* connection: send note from one module to
1092      *  another. must remain valid for all requests on this conn */
1093     apr_table_t *notes;
1094     /** A list of input filters to be used for this connection */
1095     struct ap_filter_t *input_filters;
1096     /** A list of output filters to be used for this connection */
1097     struct ap_filter_t *output_filters;
1098     /** handle to scoreboard information for this connection */
1099     void *sbh;
1100     /** The bucket allocator to use for all bucket/brigade creations */
1101     struct apr_bucket_alloc_t *bucket_alloc;
1102     /** The current state of this connection; may be NULL if not used by MPM */
1103     conn_state_t *cs;
1104     /** Is there data pending in the input filters? */
1105     int data_in_input_filters;
1106     /** Is there data pending in the output filters? */
1107     int data_in_output_filters;
1108
1109     /** Are there any filters that clogg/buffer the input stream, breaking
1110      *  the event mpm.
1111      */
1112     unsigned int clogging_input_filters:1;
1113
1114     /** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1115      *  1 yes/success */
1116     signed int double_reverse:2;
1117
1118     /** Are we still talking? */
1119     unsigned aborted;
1120
1121     /** Are we going to keep the connection alive for another request?
1122      * @see ap_conn_keepalive_e */
1123     ap_conn_keepalive_e keepalive;
1124
1125     /** How many times have we used it? */
1126     int keepalives;
1127
1128     /** Optional connection log level configuration. May point to a server or
1129      *  per_dir config, i.e. must be copied before modifying */
1130     const struct ap_logconf *log;
1131
1132     /** Id to identify this connection in error log. Set when the first
1133      *  error log entry for this connection is generated.
1134      */
1135     const char *log_id;
1136
1137
1138     /** This points to the current thread being used to process this request,
1139      * over the lifetime of a request, the value may change. Users of the connection
1140      * record should not rely upon it staying the same between calls that invole
1141      * the MPM.
1142      */
1143 #if APR_HAS_THREADS
1144     apr_thread_t *current_thread;
1145 #endif
1146 };
1147
1148 /**
1149  * Enumeration of connection states
1150  */
1151 typedef enum  {
1152     CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1153     CONN_STATE_READ_REQUEST_LINE,
1154     CONN_STATE_HANDLER,
1155     CONN_STATE_WRITE_COMPLETION,
1156     CONN_STATE_SUSPENDED,
1157     CONN_STATE_LINGER,
1158     CONN_STATE_LINGER_NORMAL,
1159     CONN_STATE_LINGER_SHORT
1160 } conn_state_e;
1161
1162 /**
1163  * @brief A structure to contain connection state information
1164  */
1165 struct conn_state_t {
1166     /** Current state of the connection */
1167     conn_state_e state;
1168 };
1169
1170 /* Per-vhost config... */
1171
1172 /**
1173  * The address 255.255.255.255, when used as a virtualhost address,
1174  * will become the "default" server when the ip doesn't match other vhosts.
1175  */
1176 #define DEFAULT_VHOST_ADDR 0xfffffffful
1177
1178
1179 /**
1180  * @struct server_addr_rec
1181  * @brief  A structure to be used for Per-vhost config
1182  */
1183 typedef struct server_addr_rec server_addr_rec;
1184 struct server_addr_rec {
1185     /** The next server in the list */
1186     server_addr_rec *next;
1187     /** The name given in "<VirtualHost>" */
1188     char *virthost;
1189     /** The bound address, for this server */
1190     apr_sockaddr_t *host_addr;
1191     /** The bound port, for this server */
1192     apr_port_t host_port;
1193 };
1194
1195 struct ap_logconf {
1196     /** The per-module log levels */
1197     signed char *module_levels;
1198
1199     /** The log level for this server */
1200     int level;
1201 };
1202 /**
1203  * @brief A structure to store information for each virtual server
1204  */
1205 struct server_rec {
1206     /** The process this server is running in */
1207     process_rec *process;
1208     /** The next server in the list */
1209     server_rec *next;
1210
1211     /* Log files --- note that transfer log is now in the modules... */
1212
1213     /** The name of the error log */
1214     char *error_fname;
1215     /** A file descriptor that references the error log */
1216     apr_file_t *error_log;
1217     /** The log level configuration */
1218     struct ap_logconf log;
1219
1220     /* Module-specific configuration for server, and defaults... */
1221
1222     /** Config vector containing pointers to modules' per-server config
1223      *  structures. */
1224     struct ap_conf_vector_t *module_config;
1225     /** MIME type info, etc., before we start checking per-directory info */
1226     struct ap_conf_vector_t *lookup_defaults;
1227
1228     /** The name of the server */
1229     const char *defn_name;
1230     /** The line of the config file that the server was defined on */
1231     unsigned defn_line_number;
1232     /** true if this is the virtual server */
1233     char is_virtual;
1234
1235
1236     /* Information for redirects */
1237
1238     /** for redirects, etc. */
1239     apr_port_t port;
1240     /** The server request scheme for redirect responses */
1241     const char *server_scheme;
1242
1243     /* Contact information */
1244
1245     /** The admin's contact information */
1246     char *server_admin;
1247     /** The server hostname */
1248     char *server_hostname;
1249
1250     /* Transaction handling */
1251
1252     /** I haven't got a clue */
1253     server_addr_rec *addrs;
1254     /** Timeout, as an apr interval, before we give up */
1255     apr_interval_time_t timeout;
1256     /** The apr interval we will wait for another request */
1257     apr_interval_time_t keep_alive_timeout;
1258     /** Maximum requests per connection */
1259     int keep_alive_max;
1260     /** Use persistent connections? */
1261     int keep_alive;
1262
1263     /** Normal names for ServerAlias servers */
1264     apr_array_header_t *names;
1265     /** Wildcarded names for ServerAlias servers */
1266     apr_array_header_t *wild_names;
1267
1268     /** Pathname for ServerPath */
1269     const char *path;
1270     /** Length of path */
1271     int pathlen;
1272
1273     /** limit on size of the HTTP request line    */
1274     int limit_req_line;
1275     /** limit on size of any request header field */
1276     int limit_req_fieldsize;
1277     /** limit on number of request header fields  */
1278     int limit_req_fields;
1279
1280
1281     /** Opaque storage location */
1282     void *context;
1283 };
1284
1285 /**
1286  * Get the context_document_root for a request. This is a generalization of
1287  * the document root, which is too limited in the presence of mappers like
1288  * mod_userdir and mod_alias. The context_document_root is the directory
1289  * on disk that maps to the context_prefix URI prefix.
1290  * @param r The request
1291  * @note For resources that do not map to the file system or for very complex
1292  * mappings, this information may still be wrong.
1293  */
1294 AP_DECLARE(const char *) ap_context_document_root(request_rec *r);
1295
1296 /**
1297  * Get the context_prefix for a request. The context_prefix URI prefix
1298  * maps to the context_document_root on disk.
1299  * @param r The request
1300  */
1301 AP_DECLARE(const char *) ap_context_prefix(request_rec *r);
1302
1303 /** Set context_prefix and context_document_root for a request.
1304  * @param r The request
1305  * @param prefix the URI prefix, without trailing slash
1306  * @param document_root the corresponding directory on disk, without trailing
1307  * slash
1308  * @note If one of prefix of document_root is NULL, the corrsponding
1309  * property will not be changed.
1310  */
1311 AP_DECLARE(void) ap_set_context_info(request_rec *r, const char *prefix,
1312                                      const char *document_root);
1313
1314 /** Set per-request document root. This is for mass virtual hosting modules
1315  * that want to provide the correct DOCUMENT_ROOT value to scripts.
1316  * @param r The request
1317  * @param document_root the document root for the request.
1318  */
1319 AP_DECLARE(void) ap_set_document_root(request_rec *r, const char *document_root);
1320
1321 /**
1322  * Examine a field value (such as a media-/content-type) string and return
1323  * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1324  * @param p Pool to allocate memory from
1325  * @param intype The field to examine
1326  * @return A copy of the field minus any parameters
1327  */
1328 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1329
1330 /**
1331  * Convert a time from an integer into a string in a specified format
1332  * @param p The pool to allocate memory from
1333  * @param t The time to convert
1334  * @param fmt The format to use for the conversion
1335  * @param gmt Convert the time for GMT?
1336  * @return The string that represents the specified time
1337  */
1338 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1339
1340 /* String handling. The *_nc variants allow you to use non-const char **s as
1341    arguments (unfortunately C won't automatically convert a char ** to a const
1342    char **) */
1343
1344 /**
1345  * Get the characters until the first occurance of a specified character
1346  * @param p The pool to allocate memory from
1347  * @param line The string to get the characters from
1348  * @param stop The character to stop at
1349  * @return A copy of the characters up to the first stop character
1350  */
1351 AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1352
1353 /**
1354  * Get the characters until the first occurance of a specified character
1355  * @param p The pool to allocate memory from
1356  * @param line The string to get the characters from
1357  * @param stop The character to stop at
1358  * @return A copy of the characters up to the first stop character
1359  * @note This is the same as ap_getword(), except it doesn't use const char **.
1360  */
1361 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1362
1363 /**
1364  * Get the first word from a given string.  A word is defined as all characters
1365  * up to the first whitespace.
1366  * @param p The pool to allocate memory from
1367  * @param line The string to traverse
1368  * @return The first word in the line
1369  */
1370 AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1371
1372 /**
1373  * Get the first word from a given string.  A word is defined as all characters
1374  * up to the first whitespace.
1375  * @param p The pool to allocate memory from
1376  * @param line The string to traverse
1377  * @return The first word in the line
1378  * @note The same as ap_getword_white(), except it doesn't use const char**
1379  */
1380 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1381
1382 /**
1383  * Get all characters from the first occurance of @a stop to the first "\0"
1384  * @param p The pool to allocate memory from
1385  * @param line The line to traverse
1386  * @param stop The character to start at
1387  * @return A copy of all caracters after the first occurance of the specified
1388  *         character
1389  */
1390 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1391                                     char stop);
1392
1393 /**
1394  * Get all characters from the first occurance of @a stop to the first "\0"
1395  * @param p The pool to allocate memory from
1396  * @param line The line to traverse
1397  * @param stop The character to start at
1398  * @return A copy of all caracters after the first occurance of the specified
1399  *         character
1400  * @note The same as ap_getword_nulls(), except it doesn't use const char **.
1401  */
1402 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1403
1404 /**
1405  * Get the second word in the string paying attention to quoting
1406  * @param p The pool to allocate from
1407  * @param line The line to traverse
1408  * @return A copy of the string
1409  */
1410 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1411
1412 /**
1413  * Get the second word in the string paying attention to quoting
1414  * @param p The pool to allocate from
1415  * @param line The line to traverse
1416  * @return A copy of the string
1417  * @note The same as ap_getword_conf(), except it doesn't use const char **.
1418  */
1419 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1420
1421 /**
1422  * Check a string for any config define or environment variable construct
1423  * and replace each of them by the value of that variable, if it exists.
1424  * The default syntax of the constructs is ${ENV} but can be changed by
1425  * setting the define::* config defines. If the variable does not exist,
1426  * leave the ${ENV} construct alone but print a warning.
1427  * @param p The pool to allocate from
1428  * @param word The string to check
1429  * @return The string with the replaced environment variables
1430  */
1431 AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1432
1433 /**
1434  * Size an HTTP header field list item, as separated by a comma.
1435  * @param field The field to size
1436  * @param len The length of the field
1437  * @return The return value is a pointer to the beginning of the non-empty
1438  * list item within the original string (or NULL if there is none) and the
1439  * address of field is shifted to the next non-comma, non-whitespace
1440  * character.  len is the length of the item excluding any beginning whitespace.
1441  */
1442 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1443
1444 /**
1445  * Retrieve an HTTP header field list item, as separated by a comma,
1446  * while stripping insignificant whitespace and lowercasing anything not in
1447  * a quoted string or comment.
1448  * @param p The pool to allocate from
1449  * @param field The field to retrieve
1450  * @return The return value is a new string containing the converted list
1451  *         item (or NULL if none) and the address pointed to by field is
1452  *         shifted to the next non-comma, non-whitespace.
1453  */
1454 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1455
1456 /**
1457  * Find an item in canonical form (lowercase, no extra spaces) within
1458  * an HTTP field value list.
1459  * @param p The pool to allocate from
1460  * @param line The field value list to search
1461  * @param tok The token to search for
1462  * @return 1 if found, 0 if not found.
1463  */
1464 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1465
1466 /**
1467  * Retrieve a token, spacing over it and adjusting the pointer to
1468  * the first non-white byte afterwards.  Note that these tokens
1469  * are delimited by semis and commas and can also be delimited
1470  * by whitespace at the caller's option.
1471  * @param p The pool to allocate from
1472  * @param accept_line The line to retrieve the token from (adjusted afterwards)
1473  * @param accept_white Is it delimited by whitespace
1474  * @return the token
1475  */
1476 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1477
1478 /**
1479  * Find http tokens, see the definition of token from RFC2068
1480  * @param p The pool to allocate from
1481  * @param line The line to find the token
1482  * @param tok The token to find
1483  * @return 1 if the token is found, 0 otherwise
1484  */
1485 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1486
1487 /**
1488  * find http tokens from the end of the line
1489  * @param p The pool to allocate from
1490  * @param line The line to find the token
1491  * @param tok The token to find
1492  * @return 1 if the token is found, 0 otherwise
1493  */
1494 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1495
1496 /**
1497  * Check for an Absolute URI syntax
1498  * @param u The string to check
1499  * @return 1 if URI, 0 otherwise
1500  */
1501 AP_DECLARE(int) ap_is_url(const char *u);
1502
1503 /**
1504  * Unescape a string
1505  * @param url The string to unescape
1506  * @return 0 on success, non-zero otherwise
1507  */
1508 AP_DECLARE(int) ap_unescape_all(char *url);
1509
1510 /**
1511  * Unescape a URL
1512  * @param url The url to unescape
1513  * @return 0 on success, non-zero otherwise
1514  */
1515 AP_DECLARE(int) ap_unescape_url(char *url);
1516
1517 /**
1518  * Unescape a URL, but leaving %2f (slashes) escaped
1519  * @param url The url to unescape
1520  * @param decode_slashes Whether or not slashes should be decoded
1521  * @return 0 on success, non-zero otherwise
1522  */
1523 AP_DECLARE(int) ap_unescape_url_keep2f(char *url, int decode_slashes);
1524
1525 /**
1526  * Unescape an application/x-www-form-urlencoded string
1527  * @param query The query to unescape
1528  * @return 0 on success, non-zero otherwise
1529  */
1530 AP_DECLARE(int) ap_unescape_urlencoded(char *query);
1531
1532 /**
1533  * Convert all double slashes to single slashes
1534  * @param name The string to convert
1535  */
1536 AP_DECLARE(void) ap_no2slash(char *name);
1537
1538 /**
1539  * Remove all ./ and xx/../ substrings from a file name. Also remove
1540  * any leading ../ or /../ substrings.
1541  * @param name the file name to parse
1542  */
1543 AP_DECLARE(void) ap_getparents(char *name);
1544
1545 /**
1546  * Escape a path segment, as defined in RFC 1808
1547  * @param p The pool to allocate from
1548  * @param s The path to convert
1549  * @return The converted URL
1550  */
1551 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1552
1553 /**
1554  * Escape a path segment, as defined in RFC 1808, to a preallocated buffer.
1555  * @param c The preallocated buffer to write to
1556  * @param s The path to convert
1557  * @return The converted URL (c)
1558  */
1559 AP_DECLARE(char *) ap_escape_path_segment_buffer(char *c, const char *s);
1560
1561 /**
1562  * convert an OS path to a URL in an OS dependant way.
1563  * @param p The pool to allocate from
1564  * @param path The path to convert
1565  * @param partial if set, assume that the path will be appended to something
1566  *        with a '/' in it (and thus does not prefix "./")
1567  * @return The converted URL
1568  */
1569 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1570
1571 /** @see ap_os_escape_path */
1572 #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1573
1574 /**
1575  * Escape a string as application/x-www-form-urlencoded
1576  * @param p The pool to allocate from
1577  * @param s The path to convert
1578  * @return The converted URL
1579  */
1580 AP_DECLARE(char *) ap_escape_urlencoded(apr_pool_t *p, const char *s);
1581
1582 /**
1583  * Escape a string as application/x-www-form-urlencoded, to a preallocated buffer
1584  * @param c The preallocated buffer to write to
1585  * @param s The path to convert
1586  * @return The converted URL (c)
1587  */
1588 AP_DECLARE(char *) ap_escape_urlencoded_buffer(char *c, const char *s);
1589
1590 /**
1591  * Escape an html string
1592  * @param p The pool to allocate from
1593  * @param s The html to escape
1594  * @return The escaped string
1595  */
1596 #define ap_escape_html(p,s) ap_escape_html2(p,s,0)
1597 /**
1598  * Escape an html string
1599  * @param p The pool to allocate from
1600  * @param s The html to escape
1601  * @param toasc Whether to escape all non-ASCII chars to \&\#nnn;
1602  * @return The escaped string
1603  */
1604 AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc);
1605
1606 /**
1607  * Escape a string for logging
1608  * @param p The pool to allocate from
1609  * @param str The string to escape
1610  * @return The escaped string
1611  */
1612 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str);
1613
1614 /**
1615  * Escape a string for logging into the error log (without a pool)
1616  * @param dest The buffer to write to
1617  * @param source The string to escape
1618  * @param buflen The buffer size for the escaped string (including "\0")
1619  * @return The len of the escaped string (always < maxlen)
1620  */
1621 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1622                                                apr_size_t buflen);
1623
1624 /**
1625  * Construct a full hostname
1626  * @param p The pool to allocate from
1627  * @param hostname The hostname of the server
1628  * @param port The port the server is running on
1629  * @param r The current request
1630  * @return The server's hostname
1631  */
1632 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1633                                     apr_port_t port, const request_rec *r);
1634
1635 /**
1636  * Escape a shell command
1637  * @param p The pool to allocate from
1638  * @param s The command to escape
1639  * @return The escaped shell command
1640  */
1641 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1642
1643 /**
1644  * Count the number of directories in a path
1645  * @param path The path to count
1646  * @return The number of directories
1647  */
1648 AP_DECLARE(int) ap_count_dirs(const char *path);
1649
1650 /**
1651  * Copy at most @a n leading directories of @a s into @a d. @a d
1652  * should be at least as large as @a s plus 1 extra byte
1653  *
1654  * @param d The location to copy to
1655  * @param s The location to copy from
1656  * @param n The number of directories to copy
1657  * @return value is the ever useful pointer to the trailing "\0" of d
1658  * @note on platforms with drive letters, n = 0 returns the "/" root,
1659  * whereas n = 1 returns the "d:/" root.  On all other platforms, n = 0
1660  * returns the empty string.  */
1661 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1662
1663 /**
1664  * Return the parent directory name (including trailing /) of the file
1665  * @a s
1666  * @param p The pool to allocate from
1667  * @param s The file to get the parent of
1668  * @return A copy of the file's parent directory
1669  */
1670 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1671
1672 /**
1673  * Given a directory and filename, create a single path from them.  This
1674  * function is smart enough to ensure that there is a sinlge '/' between the
1675  * directory and file names
1676  * @param a The pool to allocate from
1677  * @param dir The directory name
1678  * @param f The filename
1679  * @return A copy of the full path
1680  * @note Never consider using this function if you are dealing with filesystem
1681  * names that need to remain canonical, unless you are merging an apr_dir_read
1682  * path and returned filename.  Otherwise, the result is not canonical.
1683  */
1684 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1685
1686 /**
1687  * Test if the given path has an an absolute path.
1688  * @param p The pool to allocate from
1689  * @param dir The directory name
1690  * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1691  * multiple forms of absolute paths.  This only reports if the path is absolute
1692  * in a canonical sense.
1693  */
1694 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1695
1696 /**
1697  * Does the provided string contain wildcard characters?  This is useful
1698  * for determining if the string should be passed to strcmp_match or to strcmp.
1699  * The only wildcard characters recognized are '?' and '*'
1700  * @param str The string to check
1701  * @return 1 if the string has wildcards, 0 otherwise
1702  */
1703 AP_DECLARE(int) ap_is_matchexp(const char *str);
1704
1705 /**
1706  * Determine if a string matches a patterm containing the wildcards '?' or '*'
1707  * @param str The string to check
1708  * @param expected The pattern to match against
1709  * @return 1 if the two strings match, 0 otherwise
1710  */
1711 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected);
1712
1713 /**
1714  * Determine if a string matches a patterm containing the wildcards '?' or '*',
1715  * ignoring case
1716  * @param str The string to check
1717  * @param expected The pattern to match against
1718  * @return 1 if the two strings match, 0 otherwise
1719  */
1720 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected);
1721
1722 /**
1723  * Find the first occurrence of the substring s2 in s1, regardless of case
1724  * @param s1 The string to search
1725  * @param s2 The substring to search for
1726  * @return A pointer to the beginning of the substring
1727  * @remark See apr_strmatch() for a faster alternative
1728  */
1729 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1730
1731 /**
1732  * Return a pointer to the location inside of bigstring immediately after prefix
1733  * @param bigstring The input string
1734  * @param prefix The prefix to strip away
1735  * @return A pointer relative to bigstring after prefix
1736  */
1737 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1738                                         const char *prefix);
1739
1740 /**
1741  * Decode a base64 encoded string into memory allocated from a pool
1742  * @param p The pool to allocate from
1743  * @param bufcoded The encoded string
1744  * @return The decoded string
1745  */
1746 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1747
1748 /**
1749  * Encode a string into memory allocated from a pool in base 64 format
1750  * @param p The pool to allocate from
1751  * @param string The plaintext string
1752  * @return The encoded string
1753  */
1754 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1755
1756 /**
1757  * Compile a regular expression to be used later. The regex is freed when
1758  * the pool is destroyed.
1759  * @param p The pool to allocate from
1760  * @param pattern the regular expression to compile
1761  * @param cflags The bitwise or of one or more of the following:
1762  *   @li REG_EXTENDED - Use POSIX extended Regular Expressions
1763  *   @li REG_ICASE    - Ignore case
1764  *   @li REG_NOSUB    - Support for substring addressing of matches
1765  *       not required
1766  *   @li REG_NEWLINE  - Match-any-character operators don't match new-line
1767  * @return The compiled regular expression
1768  */
1769 AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1770                                      int cflags);
1771
1772 /**
1773  * Free the memory associated with a compiled regular expression
1774  * @param p The pool the regex was allocated from
1775  * @param reg The regular expression to free
1776  * @note This function is only necessary if the regex should be cleaned
1777  * up before the pool
1778  */
1779 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
1780
1781 /**
1782  * After performing a successful regex match, you may use this function to
1783  * perform a series of string substitutions based on subexpressions that were
1784  * matched during the call to ap_regexec. This function is limited to
1785  * result strings of 64K. Consider using ap_pregsub_ex() instead.
1786  * @param p The pool to allocate from
1787  * @param input An arbitrary string containing $1 through $9.  These are
1788  *              replaced with the corresponding matched sub-expressions
1789  * @param source The string that was originally matched to the regex
1790  * @param nmatch the nmatch returned from ap_pregex
1791  * @param pmatch the pmatch array returned from ap_pregex
1792  * @return The substituted string, or NULL on error
1793  */
1794 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input,
1795                               const char *source, apr_size_t nmatch,
1796                               ap_regmatch_t pmatch[]);
1797
1798 /**
1799  * After performing a successful regex match, you may use this function to
1800  * perform a series of string substitutions based on subexpressions that were
1801  * matched during the call to ap_regexec
1802  * @param p The pool to allocate from
1803  * @param result where to store the result, will be set to NULL on error
1804  * @param input An arbitrary string containing $1 through $9.  These are
1805  *              replaced with the corresponding matched sub-expressions
1806  * @param source The string that was originally matched to the regex
1807  * @param nmatch the nmatch returned from ap_pregex
1808  * @param pmatch the pmatch array returned from ap_pregex
1809  * @param maxlen the maximum string length to return, 0 for unlimited
1810  * @return The substituted string, or NULL on error
1811  */
1812 AP_DECLARE(apr_status_t) ap_pregsub_ex(apr_pool_t *p, char **result,
1813                                        const char *input, const char *source,
1814                                        apr_size_t nmatch,
1815                                        ap_regmatch_t pmatch[],
1816                                        apr_size_t maxlen);
1817
1818 /**
1819  * We want to downcase the type/subtype for comparison purposes
1820  * but nothing else because ;parameter=foo values are case sensitive.
1821  * @param s The content-type to convert to lowercase
1822  */
1823 AP_DECLARE(void) ap_content_type_tolower(char *s);
1824
1825 /**
1826  * convert a string to all lowercase
1827  * @param s The string to convert to lowercase
1828  */
1829 AP_DECLARE(void) ap_str_tolower(char *s);
1830
1831 /**
1832  * convert a string to all uppercase
1833  * @param s The string to convert to uppercase
1834  */
1835 AP_DECLARE(void) ap_str_toupper(char *s);
1836
1837 /**
1838  * Search a string from left to right for the first occurrence of a
1839  * specific character
1840  * @param str The string to search
1841  * @param c The character to search for
1842  * @return The index of the first occurrence of c in str
1843  */
1844 AP_DECLARE(int) ap_ind(const char *str, char c);        /* Sigh... */
1845
1846 /**
1847  * Search a string from right to left for the first occurrence of a
1848  * specific character
1849  * @param str The string to search
1850  * @param c The character to search for
1851  * @return The index of the first occurrence of c in str
1852  */
1853 AP_DECLARE(int) ap_rind(const char *str, char c);
1854
1855 /**
1856  * Given a string, replace any bare &quot; with \\&quot; .
1857  * @param p The pool to allocate memory from
1858  * @param instring The string to search for &quot;
1859  * @return A copy of the string with escaped quotes
1860  */
1861 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1862
1863 /**
1864  * Given a string, append the PID deliminated by delim.
1865  * Usually used to create a pid-appended filepath name
1866  * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
1867  * a macro, to avoid unistd.h dependency
1868  * @param p The pool to allocate memory from
1869  * @param string The string to append the PID to
1870  * @param delim The string to use to deliminate the string from the PID
1871  * @return A copy of the string with the PID appended
1872  */
1873 AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
1874                                  const char *delim);
1875
1876 /**
1877  * Parse a given timeout parameter string into an apr_interval_time_t value.
1878  * The unit of the time interval is given as postfix string to the numeric
1879  * string. Currently the following units are understood:
1880  *
1881  * ms    : milliseconds
1882  * s     : seconds
1883  * mi[n] : minutes
1884  * h     : hours
1885  *
1886  * If no unit is contained in the given timeout parameter the default_time_unit
1887  * will be used instead.
1888  * @param timeout_parameter The string containing the timeout parameter.
1889  * @param timeout The timeout value to be returned.
1890  * @param default_time_unit The default time unit to use if none is specified
1891  * in timeout_parameter.
1892  * @return Status value indicating whether the parsing was successful or not.
1893  */
1894 AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
1895                                                const char *timeout_parameter,
1896                                                apr_interval_time_t *timeout,
1897                                                const char *default_time_unit);
1898
1899 /**
1900  * Determine if a request has a request body or not.
1901  *
1902  * @param r the request_rec of the request
1903  * @return truth value
1904  */
1905 AP_DECLARE(int) ap_request_has_body(request_rec *r);
1906
1907 /**
1908  * Cleanup a string (mainly to be filesystem safe)
1909  * We only allow '_' and alphanumeric chars. Non-printable
1910  * map to 'x' and all others map to '_'
1911  *
1912  * @param  p pool to use to allocate dest
1913  * @param  src string to clean up
1914  * @param  dest cleaned up, allocated string
1915  * @return Status value indicating whether the cleaning was successful or not.
1916  */
1917 AP_DECLARE(apr_status_t) ap_pstr2_alnum(apr_pool_t *p, const char *src,
1918                                         const char **dest);
1919
1920 /**
1921  * Cleanup a string (mainly to be filesystem safe)
1922  * We only allow '_' and alphanumeric chars. Non-printable
1923  * map to 'x' and all others map to '_'
1924  *
1925  * @param  src string to clean up
1926  * @param  dest cleaned up, pre-allocated string
1927  * @return Status value indicating whether the cleaning was successful or not.
1928  */
1929 AP_DECLARE(apr_status_t) ap_str2_alnum(const char *src, char *dest);
1930
1931 /**
1932  * Structure to store the contents of an HTTP form of the type
1933  * application/x-www-form-urlencoded.
1934  *
1935  * Currently it contains the name as a char* of maximum length
1936  * HUGE_STRING_LEN, and a value in the form of a bucket brigade
1937  * of arbitrary length.
1938  */
1939 typedef struct {
1940     const char *name;
1941     apr_bucket_brigade *value;
1942 } ap_form_pair_t;
1943
1944 /**
1945  * Read the body and parse any form found, which must be of the
1946  * type application/x-www-form-urlencoded.
1947  * @param r request containing POSTed form data
1948  * @param f filter
1949  * @param ptr returned array of ap_form_pair_t
1950  * @param num max num of params or -1 for unlimited
1951  * @param size max size allowed for parsed data
1952  * @return OK or HTTP error
1953  */
1954 AP_DECLARE(int) ap_parse_form_data(request_rec *r, struct ap_filter_t *f,
1955                                    apr_array_header_t **ptr,
1956                                    apr_size_t num, apr_size_t size);
1957
1958 /* Misc system hackery */
1959 /**
1960  * Given the name of an object in the file system determine if it is a directory
1961  * @param p The pool to allocate from
1962  * @param name The name of the object to check
1963  * @return 1 if it is a directory, 0 otherwise
1964  */
1965 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1966
1967 /**
1968  * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1969  * @param p The pool to allocate from
1970  * @param name The name of the object to check
1971  * @return 1 if it is a directory, 0 otherwise
1972  */
1973 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1974
1975 #ifdef _OSD_POSIX
1976 extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1977 #endif /* _OSD_POSIX */
1978
1979 /**
1980  * Determine the local host name for the current machine
1981  * @param p The pool to allocate from
1982  * @return A copy of the local host name
1983  */
1984 char *ap_get_local_host(apr_pool_t *p);
1985
1986 /**
1987  * Log an assertion to the error log
1988  * @param szExp The assertion that failed
1989  * @param szFile The file the assertion is in
1990  * @param nLine The line the assertion is defined on
1991  */
1992 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1993                             __attribute__((noreturn));
1994
1995 /**
1996  * @internal Internal Assert function
1997  */
1998 #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1999
2000 /**
2001  * Redefine assert() to something more useful for an Apache...
2002  *
2003  * Use ap_assert() if the condition should always be checked.
2004  * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
2005  * is defined.
2006  */
2007 #ifdef AP_DEBUG
2008 #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
2009 #else
2010 #define AP_DEBUG_ASSERT(exp) ((void)0)
2011 #endif
2012
2013 /**
2014  * @defgroup stopsignal Flags which indicate places where the server should stop for debugging.
2015  * @{
2016  * A set of flags which indicate places where the server should raise(SIGSTOP).
2017  * This is useful for debugging, because you can then attach to that process
2018  * with gdb and continue.  This is important in cases where one_process
2019  * debugging isn't possible.
2020  */
2021 /** stop on a Detach */
2022 #define SIGSTOP_DETACH                  1
2023 /** stop making a child process */
2024 #define SIGSTOP_MAKE_CHILD              2
2025 /** stop spawning a child process */
2026 #define SIGSTOP_SPAWN_CHILD             4
2027 /** stop spawning a child process with a piped log */
2028 #define SIGSTOP_PIPED_LOG_SPAWN         8
2029 /** stop spawning a CGI child process */
2030 #define SIGSTOP_CGI_CHILD               16
2031
2032 /** Macro to get GDB started */
2033 #ifdef DEBUG_SIGSTOP
2034 extern int raise_sigstop_flags;
2035 #define RAISE_SIGSTOP(x)        do { \
2036         if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
2037     } while (0)
2038 #else
2039 #define RAISE_SIGSTOP(x)
2040 #endif
2041 /** @} */
2042 /**
2043  * Get HTML describing the address and (optionally) admin of the server.
2044  * @param prefix Text which is prepended to the return value
2045  * @param r The request_rec
2046  * @return HTML describing the server, allocated in @a r's pool.
2047  */
2048 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
2049
2050 /** strtoul does not exist on sunos4. */
2051 #ifdef strtoul
2052 #undef strtoul
2053 #endif
2054 #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
2055
2056   /* The C library has functions that allow const to be silently dropped ...
2057      these macros detect the drop in maintainer mode, but use the native
2058      methods for normal builds
2059
2060      Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
2061      to be included before the macros are defined or compilation will fail.
2062   */
2063 #include <string.h>
2064
2065 AP_DECLARE(char *) ap_strchr(char *s, int c);
2066 AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
2067 AP_DECLARE(char *) ap_strrchr(char *s, int c);
2068 AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
2069 AP_DECLARE(char *) ap_strstr(char *s, const char *c);
2070 AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
2071 AP_DECLARE(void *) ap_palloc_debug(apr_pool_t *p, apr_size_t size);
2072 AP_DECLARE(void *) ap_pcalloc_debug(apr_pool_t *p, apr_size_t size);
2073
2074 #ifdef AP_DEBUG
2075
2076 #undef strchr
2077 # define strchr(s, c)  ap_strchr(s,c)
2078 #undef strrchr
2079 # define strrchr(s, c) ap_strrchr(s,c)
2080 #undef strstr
2081 # define strstr(s, c)  ap_strstr(s,c)
2082
2083 #ifndef AP_DEBUG_NO_ALLOC_POISON
2084 /*
2085  * ap_palloc_debug initializes allocated memory to non-zero
2086  */
2087 #define apr_palloc     ap_palloc_debug
2088 /*
2089  * this is necessary to avoid useless double memset of memory
2090  * with ap_palloc_debug
2091  */
2092 #ifdef apr_pcalloc
2093 #undef apr_pcalloc
2094 #endif
2095 #define apr_pcalloc    ap_pcalloc_debug
2096 #endif
2097
2098 #else
2099
2100 /** use this instead of strchr */
2101 # define ap_strchr(s, c)     strchr(s, c)
2102 /** use this instead of strchr */
2103 # define ap_strchr_c(s, c)   strchr(s, c)
2104 /** use this instead of strrchr */
2105 # define ap_strrchr(s, c)    strrchr(s, c)
2106 /** use this instead of strrchr */
2107 # define ap_strrchr_c(s, c)  strrchr(s, c)
2108 /** use this instead of strrstr*/
2109 # define ap_strstr(s, c)     strstr(s, c)
2110 /** use this instead of strrstr*/
2111 # define ap_strstr_c(s, c)   strstr(s, c)
2112
2113 #endif
2114
2115 /**
2116  * Generate pseudo random bytes.
2117  * This is a convenience interface to apr_random. It is cheaper but less
2118  * secure than apr_generate_random_bytes().
2119  * @param buf where to store the bytes
2120  * @param size number of bytes to generate
2121  * @note ap_random_insecure_bytes() is thread-safe, it uses a mutex on
2122  *       threaded MPMs.
2123  */
2124 AP_DECLARE(void) ap_random_insecure_bytes(void *buf, apr_size_t size);
2125
2126 /**
2127  * Get a pseudo random number in a range.
2128  * @param min low end of range
2129  * @param max high end of range
2130  * @return a number in the range
2131  */
2132 AP_DECLARE(apr_uint32_t) ap_random_pick(apr_uint32_t min, apr_uint32_t max);
2133
2134 /**
2135  * Abort with a error message signifying out of memory
2136  */
2137 AP_DECLARE(void) ap_abort_on_oom(void) __attribute__((noreturn));
2138
2139 /**
2140  * Wrapper for malloc() that calls ap_abort_on_oom() if out of memory
2141  * @param size size of the memory block
2142  * @return pointer to the allocated memory
2143  * @note ap_malloc may be implemented as a macro
2144  */
2145 AP_DECLARE(void *) ap_malloc(size_t size)
2146                     __attribute__((malloc))
2147                     AP_FN_ATTR_ALLOC_SIZE(1);
2148
2149 /**
2150  * Wrapper for calloc() that calls ap_abort_on_oom() if out of memory
2151  * @param nelem number of elements to allocate memory for
2152  * @param size size of a single element
2153  * @return pointer to the allocated memory
2154  * @note ap_calloc may be implemented as a macro
2155  */
2156 AP_DECLARE(void *) ap_calloc(size_t nelem, size_t size)
2157                    __attribute__((malloc))
2158                    AP_FN_ATTR_ALLOC_SIZE2(1,2);
2159
2160 /**
2161  * Wrapper for realloc() that calls ap_abort_on_oom() if out of memory
2162  * @param ptr pointer to the old memory block (or NULL)
2163  * @param size new size of the memory block
2164  * @return pointer to the reallocated memory
2165  * @note ap_realloc may be implemented as a macro
2166  */
2167 AP_DECLARE(void *) ap_realloc(void *ptr, size_t size)
2168                    AP_FN_ATTR_WARN_UNUSED_RESULT
2169                    AP_FN_ATTR_ALLOC_SIZE(2);
2170
2171
2172 #define AP_NORESTART APR_OS_START_USEERR + 1
2173
2174 #ifdef __cplusplus
2175 }
2176 #endif
2177
2178 #endif  /* !APACHE_HTTPD_H */
2179
2180 /** @} //APACHE Daemon      */
2181 /** @} //APACHE Core        */
2182 /** @} //APACHE super group */
2183