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