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
8
* http://www.apache.org/licenses/LICENSE-2.0
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.
19
* @brief HTTP Daemon routines
21
* @defgroup APACHE Apache
23
* Top level group of which all other groups are a member
26
* @defgroup APACHE_MODS Apache Modules
27
* Top level group for Apache Modules
28
* @defgroup APACHE_OS Operating System Specific
29
* @defgroup APACHE_CORE Apache Core
31
* @defgroup APACHE_CORE_DAEMON HTTP Daemon Routine
35
#ifndef APACHE_HTTPD_H
36
#define APACHE_HTTPD_H
38
/* XXX - We need to push more stuff to other .h files, or even .c files, to
39
* make this file smaller
42
/* Headers in which EVERYONE has an interest... */
43
#include "ap_config.h"
46
#include "ap_release.h"
49
#include "apr_general.h"
50
#include "apr_tables.h"
51
#include "apr_pools.h"
53
#include "apr_network_io.h"
54
#include "apr_buckets.h"
65
/* Note: apr_uri.h is also included, see below */
73
/* ----------------------------- config dir ------------------------------ */
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.
80
/** Set default for OS/2 file system */
81
#define HTTPD_ROOT "/os2httpd"
83
/** Set default for Windows file system */
84
#define HTTPD_ROOT "/apache"
86
/** Set the default for BeOS */
87
#define HTTPD_ROOT "/boot/home/apache"
88
#elif defined (NETWARE)
89
/** Set the default for NetWare */
90
#define HTTPD_ROOT "/apache"
92
/** Set for all other OSs */
93
#define HTTPD_ROOT "/usr/local/apache"
95
#endif /* HTTPD_ROOT */
98
* --------- You shouldn't have to edit anything below this line ----------
100
* Any modifications to any defaults not defined above should be done in the
101
* respective configuration file.
106
* Default location of documents. Can be overridden by the DocumentRoot
109
#ifndef DOCUMENT_LOCATION
111
/* Set default for OS/2 file system */
112
#define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
114
/* Set default for non OS/2 file system */
115
#define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
117
#endif /* DOCUMENT_LOCATION */
119
/** Maximum number of dynamically loaded modules */
120
#ifndef DYNAMIC_MODULE_LIMIT
121
#define DYNAMIC_MODULE_LIMIT 128
124
/** Default administrator's address */
125
#define DEFAULT_ADMIN "[no address given]"
127
/** The name of the log files */
128
#ifndef DEFAULT_ERRORLOG
129
#if defined(OS2) || defined(WIN32)
130
#define DEFAULT_ERRORLOG "logs/error.log"
132
#define DEFAULT_ERRORLOG "logs/error_log"
134
#endif /* DEFAULT_ERRORLOG */
136
/** Define this to be what your per-directory security files are called */
137
#ifndef DEFAULT_ACCESS_FNAME
139
/* Set default for OS/2 file system */
140
#define DEFAULT_ACCESS_FNAME "htaccess"
142
#define DEFAULT_ACCESS_FNAME ".htaccess"
144
#endif /* DEFAULT_ACCESS_FNAME */
146
/** The name of the server config file */
147
#ifndef SERVER_CONFIG_FILE
148
#define SERVER_CONFIG_FILE "conf/httpd.conf"
151
/** The default path for CGI scripts if none is currently set */
153
#define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
156
/** The path to the suExec wrapper, can be overridden in Configuration */
158
#define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
161
/** The timeout for waiting for messages */
162
#ifndef DEFAULT_TIMEOUT
163
#define DEFAULT_TIMEOUT 300
166
/** The timeout for waiting for keepalive timeout until next request */
167
#ifndef DEFAULT_KEEPALIVE_TIMEOUT
168
#define DEFAULT_KEEPALIVE_TIMEOUT 5
171
/** The number of requests to entertain per connection */
172
#ifndef DEFAULT_KEEPALIVE
173
#define DEFAULT_KEEPALIVE 100
177
* Limits on the size of various request items. These limits primarily
178
* exist to prevent simple denial-of-service attacks on a server based
179
* on misuse of the protocol. The recommended values will depend on the
180
* nature of the server resources -- CGI scripts and database backends
181
* might require large values, but most servers could get by with much
182
* smaller limits than we use below. The request message body size can
183
* be limited by the per-dir config directive LimitRequestBody.
185
* Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
186
* and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
187
* These two limits can be lowered (but not raised) by the server config
188
* directives LimitRequestLine and LimitRequestFieldsize, respectively.
190
* DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
191
* the server config directive LimitRequestFields.
194
/** default limit on bytes in Request-Line (Method+URI+HTTP-version) */
195
#ifndef DEFAULT_LIMIT_REQUEST_LINE
196
#define DEFAULT_LIMIT_REQUEST_LINE 8190
198
/** default limit on bytes in any one header field */
199
#ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
200
#define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
202
/** default limit on number of request header fields */
203
#ifndef DEFAULT_LIMIT_REQUEST_FIELDS
204
#define DEFAULT_LIMIT_REQUEST_FIELDS 100
208
* The default default character set name to add if AddDefaultCharset is
209
* enabled. Overridden with AddDefaultCharsetName.
211
#define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
213
#endif /* CORE_PRIVATE */
215
/** default HTTP Server protocol */
216
#define AP_SERVER_PROTOCOL "HTTP/1.1"
219
/* ------------------ stuff that modules are allowed to look at ----------- */
221
/** Define this to be what your HTML directory content files are called */
222
#ifndef AP_DEFAULT_INDEX
223
#define AP_DEFAULT_INDEX "index.html"
228
* Define this to be what type you'd like returned for files with unknown
230
* @warning MUST be all lower case.
232
#ifndef DEFAULT_CONTENT_TYPE
233
#define DEFAULT_CONTENT_TYPE "text/plain"
236
/** The name of the MIME types file */
237
#ifndef AP_TYPES_CONFIG_FILE
238
#define AP_TYPES_CONFIG_FILE "conf/mime.types"
242
* Define the HTML doctype strings centrally.
244
/** HTML 2.0 Doctype */
245
#define DOCTYPE_HTML_2_0 "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
246
"DTD HTML 2.0//EN\">\n"
247
/** HTML 3.2 Doctype */
248
#define DOCTYPE_HTML_3_2 "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
249
"DTD HTML 3.2 Final//EN\">\n"
250
/** HTML 4.0 Strict Doctype */
251
#define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
252
"DTD HTML 4.0//EN\"\n" \
253
"\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
254
/** HTML 4.0 Transitional Doctype */
255
#define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
256
"DTD HTML 4.0 Transitional//EN\"\n" \
257
"\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
258
/** HTML 4.0 Frameset Doctype */
259
#define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
260
"DTD HTML 4.0 Frameset//EN\"\n" \
261
"\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
262
/** XHTML 1.0 Strict Doctype */
263
#define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
264
"DTD XHTML 1.0 Strict//EN\"\n" \
265
"\"http://www.w3.org/TR/xhtml1/DTD/" \
266
"xhtml1-strict.dtd\">\n"
267
/** XHTML 1.0 Transitional Doctype */
268
#define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
269
"DTD XHTML 1.0 Transitional//EN\"\n" \
270
"\"http://www.w3.org/TR/xhtml1/DTD/" \
271
"xhtml1-transitional.dtd\">\n"
272
/** XHTML 1.0 Frameset Doctype */
273
#define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
274
"DTD XHTML 1.0 Frameset//EN\"\n" \
275
"\"http://www.w3.org/TR/xhtml1/DTD/" \
276
"xhtml1-frameset.dtd\">"
278
/** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
279
#define HTTP_VERSION(major,minor) (1000*(major)+(minor))
280
/** Major part of HTTP protocol */
281
#define HTTP_VERSION_MAJOR(number) ((number)/1000)
282
/** Minor part of HTTP protocol */
283
#define HTTP_VERSION_MINOR(number) ((number)%1000)
285
/* -------------- Port number for server running standalone --------------- */
287
/** default HTTP Port */
288
#define DEFAULT_HTTP_PORT 80
289
/** default HTTPS Port */
290
#define DEFAULT_HTTPS_PORT 443
292
* Check whether @a port is the default port for the request @a r.
293
* @param port The port number
294
* @param r The request
295
* @see #ap_default_port
297
#define ap_is_default_port(port,r) ((port) == ap_default_port(r))
299
* Get the default port for a request (which depends on the scheme).
300
* @param r The request
302
#define ap_default_port(r) ap_run_default_port(r)
304
* Get the scheme for a request.
305
* @param r The request
307
#define ap_http_scheme(r) ap_run_http_scheme(r)
309
/** The default string length */
310
#define MAX_STRING_LEN HUGE_STRING_LEN
312
/** The length of a Huge string */
313
#define HUGE_STRING_LEN 8192
315
/** The size of the server's internal read-write buffers */
316
#define AP_IOBUFSIZE 8192
318
/** The max number of regex captures that can be expanded by ap_pregsub */
319
#define AP_MAX_REG_MATCH 10
322
* APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into
323
* mutiple buckets, no greater than MAX(apr_size_t), and more granular
324
* than that in case the brigade code/filters attempt to read it directly.
325
* ### 16mb is an invention, no idea if it is reasonable.
327
#define AP_MAX_SENDFILE 16777216 /* 2^24 */
330
* Special Apache error codes. These are basically used
331
* in http_main.c so we can keep track of various errors.
335
#define APEXIT_OK 0x0
336
/** A fatal error arising during the server's init sequence */
337
#define APEXIT_INIT 0x2
338
/** The child died during its init sequence */
339
#define APEXIT_CHILDINIT 0x3
341
* The child exited due to a resource shortage.
342
* The parent should limit the rate of forking until
343
* the situation is resolved.
345
#define APEXIT_CHILDSICK 0x7
347
* A fatal error, resulting in the whole server aborting.
348
* If a child exits with this error, the parent process
349
* considers this a server-wide fatal error and aborts.
351
#define APEXIT_CHILDFATAL 0xf
355
* Stuff marked #AP_DECLARE is part of the API, and intended for use
356
* by modules. Its purpose is to allow us to add attributes that
357
* particular platforms or compilers require to every exported function.
359
# define AP_DECLARE(type) type
362
#ifndef AP_DECLARE_NONSTD
364
* Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
365
* use by modules. The difference between #AP_DECLARE and
366
* #AP_DECLARE_NONSTD is that the latter is required for any functions
367
* which use varargs or are used via indirect function call. This
368
* is to accomodate the two calling conventions in windows dlls.
370
# define AP_DECLARE_NONSTD(type) type
372
#ifndef AP_DECLARE_DATA
373
# define AP_DECLARE_DATA
376
#ifndef AP_MODULE_DECLARE
377
# define AP_MODULE_DECLARE(type) type
379
#ifndef AP_MODULE_DECLARE_NONSTD
380
# define AP_MODULE_DECLARE_NONSTD(type) type
382
#ifndef AP_MODULE_DECLARE_DATA
383
# define AP_MODULE_DECLARE_DATA
388
* modules should not use functions marked AP_CORE_DECLARE
390
#ifndef AP_CORE_DECLARE
391
# define AP_CORE_DECLARE AP_DECLARE
396
* modules should not use functions marked AP_CORE_DECLARE_NONSTD
399
#ifndef AP_CORE_DECLARE_NONSTD
400
# define AP_CORE_DECLARE_NONSTD AP_DECLARE_NONSTD
404
* @brief The numeric version information is broken out into fields within this
408
int major; /**< major number */
409
int minor; /**< minor number */
410
int patch; /**< patch number */
411
const char *add_string; /**< additional string like "-dev" */
415
* Return httpd's version information in a numeric form.
417
* @param version Pointer to a version structure for returning the version
420
AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
423
* Get the server version string
424
* @return The server version string
426
AP_DECLARE(const char *) ap_get_server_version(void);
429
* Add a component to the version string
430
* @param pconf The pool to allocate the component from
431
* @param component The string to add
433
AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
436
* Get the date a time that the server was built
437
* @return The server build time string
439
AP_DECLARE(const char *) ap_get_server_built(void);
441
#define DECLINED -1 /**< Module declines to handle */
442
#define DONE -2 /**< Module has served the response completely
443
* - it's safe to die() with no more output
445
#define OK 0 /**< Module has handled this stage. */
449
* @defgroup HTTP_Status HTTP Status Codes
453
* The size of the static array in http_protocol.c for storing
454
* all of the potential response status-lines (a sparse table).
455
* A future version should dynamically generate the apr_table_t at startup.
457
#define RESPONSE_CODES 57
459
#define HTTP_CONTINUE 100
460
#define HTTP_SWITCHING_PROTOCOLS 101
461
#define HTTP_PROCESSING 102
463
#define HTTP_CREATED 201
464
#define HTTP_ACCEPTED 202
465
#define HTTP_NON_AUTHORITATIVE 203
466
#define HTTP_NO_CONTENT 204
467
#define HTTP_RESET_CONTENT 205
468
#define HTTP_PARTIAL_CONTENT 206
469
#define HTTP_MULTI_STATUS 207
470
#define HTTP_MULTIPLE_CHOICES 300
471
#define HTTP_MOVED_PERMANENTLY 301
472
#define HTTP_MOVED_TEMPORARILY 302
473
#define HTTP_SEE_OTHER 303
474
#define HTTP_NOT_MODIFIED 304
475
#define HTTP_USE_PROXY 305
476
#define HTTP_TEMPORARY_REDIRECT 307
477
#define HTTP_BAD_REQUEST 400
478
#define HTTP_UNAUTHORIZED 401
479
#define HTTP_PAYMENT_REQUIRED 402
480
#define HTTP_FORBIDDEN 403
481
#define HTTP_NOT_FOUND 404
482
#define HTTP_METHOD_NOT_ALLOWED 405
483
#define HTTP_NOT_ACCEPTABLE 406
484
#define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
485
#define HTTP_REQUEST_TIME_OUT 408
486
#define HTTP_CONFLICT 409
487
#define HTTP_GONE 410
488
#define HTTP_LENGTH_REQUIRED 411
489
#define HTTP_PRECONDITION_FAILED 412
490
#define HTTP_REQUEST_ENTITY_TOO_LARGE 413
491
#define HTTP_REQUEST_URI_TOO_LARGE 414
492
#define HTTP_UNSUPPORTED_MEDIA_TYPE 415
493
#define HTTP_RANGE_NOT_SATISFIABLE 416
494
#define HTTP_EXPECTATION_FAILED 417
495
#define HTTP_UNPROCESSABLE_ENTITY 422
496
#define HTTP_LOCKED 423
497
#define HTTP_FAILED_DEPENDENCY 424
498
#define HTTP_UPGRADE_REQUIRED 426
499
#define HTTP_INTERNAL_SERVER_ERROR 500
500
#define HTTP_NOT_IMPLEMENTED 501
501
#define HTTP_BAD_GATEWAY 502
502
#define HTTP_SERVICE_UNAVAILABLE 503
503
#define HTTP_GATEWAY_TIME_OUT 504
504
#define HTTP_VERSION_NOT_SUPPORTED 505
505
#define HTTP_VARIANT_ALSO_VARIES 506
506
#define HTTP_INSUFFICIENT_STORAGE 507
507
#define HTTP_NOT_EXTENDED 510
509
/** is the status code informational */
510
#define ap_is_HTTP_INFO(x) (((x) >= 100)&&((x) < 200))
511
/** is the status code OK ?*/
512
#define ap_is_HTTP_SUCCESS(x) (((x) >= 200)&&((x) < 300))
513
/** is the status code a redirect */
514
#define ap_is_HTTP_REDIRECT(x) (((x) >= 300)&&((x) < 400))
515
/** is the status code a error (client or server) */
516
#define ap_is_HTTP_ERROR(x) (((x) >= 400)&&((x) < 600))
517
/** is the status code a client error */
518
#define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
519
/** is the status code a server error */
520
#define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
522
/** should the status code drop the connection */
523
#define ap_status_drops_connection(x) \
524
(((x) == HTTP_BAD_REQUEST) || \
525
((x) == HTTP_REQUEST_TIME_OUT) || \
526
((x) == HTTP_LENGTH_REQUIRED) || \
527
((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
528
((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
529
((x) == HTTP_INTERNAL_SERVER_ERROR) || \
530
((x) == HTTP_SERVICE_UNAVAILABLE) || \
531
((x) == HTTP_NOT_IMPLEMENTED))
535
* @defgroup Methods List of Methods recognized by the server
536
* @ingroup APACHE_CORE_DAEMON
539
* @brief Methods recognized (but not necessarily handled) by the server.
541
* These constants are used in bit shifting masks of size int, so it is
542
* unsafe to have more methods than bits in an int. HEAD == M_GET.
543
* This list must be tracked by the list in http_protocol.c in routine
544
* ap_method_name_of().
548
#define M_GET 0 /** RFC 2616: HTTP */
549
#define M_PUT 1 /* : */
554
#define M_TRACE 6 /** RFC 2616: HTTP */
555
#define M_PATCH 7 /** no rfc(!) ### remove this one? */
556
#define M_PROPFIND 8 /** RFC 2518: WebDAV */
557
#define M_PROPPATCH 9 /* : */
562
#define M_UNLOCK 14 /** RFC 2518: WebDAV */
563
#define M_VERSION_CONTROL 15 /** RFC 3253: WebDAV Versioning */
564
#define M_CHECKOUT 16 /* : */
565
#define M_UNCHECKOUT 17
570
#define M_MKWORKSPACE 22
571
#define M_MKACTIVITY 23
572
#define M_BASELINE_CONTROL 24
574
#define M_INVALID 26 /** RFC 3253: WebDAV Versioning */
577
* METHODS needs to be equal to the number of bits
578
* we are using for limit masks.
583
* The method mask bit to shift for anding with a bitmask.
585
#define AP_METHOD_BIT ((apr_int64_t)1)
589
/** @see ap_method_list_t */
590
typedef struct ap_method_list_t ap_method_list_t;
593
* @struct ap_method_list_t
594
* @brief Structure for handling HTTP methods.
596
* Methods known to the server are accessed via a bitmask shortcut;
597
* extension methods are handled by an array.
599
struct ap_method_list_t {
600
/** The bitmask used for known methods */
601
apr_int64_t method_mask;
602
/** the array used for extension methods */
603
apr_array_header_t *method_list;
607
* @defgroup module_magic Module Magic mime types
610
/** Magic for mod_cgi[d] */
611
#define CGI_MAGIC_TYPE "application/x-httpd-cgi"
612
/** Magic for mod_include */
613
#define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
614
/** Magic for mod_include */
615
#define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
616
/** Magic for mod_dir */
617
#define DIR_MAGIC_TYPE "httpd/unix-directory"
620
/* Just in case your linefeed isn't the one the other end is expecting. */
621
#if !APR_CHARSET_EBCDIC
624
/** carrige return */
626
/** carrige return /Line Feed Combo */
627
#define CRLF "\015\012"
628
#else /* APR_CHARSET_EBCDIC */
629
/* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
630
* in the buff package (bread/bputs/bwrite). Everywhere else, we use
631
* "native EBCDIC" CR and NL characters. These are therefore
638
#endif /* APR_CHARSET_EBCDIC */
641
* @defgroup values_request_rec_body Possible values for request_rec.read_body
643
* Possible values for request_rec.read_body (set by handling module):
646
/** Send 413 error if message has any body */
647
#define REQUEST_NO_BODY 0
648
/** Send 411 error if body without Content-Length */
649
#define REQUEST_CHUNKED_ERROR 1
650
/** If chunked, remove the chunks for me. */
651
#define REQUEST_CHUNKED_DECHUNK 2
652
/** @} // values_request_rec_body */
655
* @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
656
* @ingroup APACHE_CORE_DAEMON
658
* Possible values for request_rec.used_path_info:
661
/** Accept the path_info from the request */
662
#define AP_REQ_ACCEPT_PATH_INFO 0
663
/** Return a 404 error if path_info was given */
664
#define AP_REQ_REJECT_PATH_INFO 1
665
/** Module may chose to use the given path_info */
666
#define AP_REQ_DEFAULT_PATH_INFO 2
668
/** @} // values_request_rec_used_path_info */
672
* Things which may vary per file-lookup WITHIN a request ---
673
* e.g., state of MIME config. Basically, the name of an object, info
674
* about the object, and any other info we may ahve which may need to
675
* change as we go poking around looking for it (e.g., overridden by
678
* Note how the default state of almost all these things is properly
679
* zero, so that allocating it with pcalloc does the right thing without
680
* a whole lot of hairy initialization... so long as we are willing to
681
* make the (fairly) portable assumption that the bit pattern of a NULL
682
* pointer is, in fact, zero.
686
* @brief This represents the result of calling htaccess; these are cached for
689
struct htaccess_result {
690
/** the directory to which this applies */
692
/** the overrides allowed for the .htaccess file */
694
/** the override options allowed for the .htaccess file */
696
/** the configuration directives */
697
struct ap_conf_vector_t *htaccess;
698
/** the next one, or NULL if no more; N.B. never change this */
699
const struct htaccess_result *next;
702
/* The following four types define a hierarchy of activities, so that
703
* given a request_rec r you can write r->connection->server->process
704
* to get to the process_rec. While this reduces substantially the
705
* number of arguments that various hooks require beware that in
706
* threaded versions of the server you must consider multiplexing
710
/** A structure that represents one process */
711
typedef struct process_rec process_rec;
712
/** A structure that represents a virtual server */
713
typedef struct server_rec server_rec;
714
/** A structure that represents one connection */
715
typedef struct conn_rec conn_rec;
716
/** A structure that represents the current request */
717
typedef struct request_rec request_rec;
718
/** A structure that represents the status of the current connection */
719
typedef struct conn_state_t conn_state_t;
721
/* ### would be nice to not include this from httpd.h ... */
722
/* This comes after we have defined the request_rec type */
726
* @brief A structure that represents one process
729
/** Global pool. Cleared upon normal exit */
731
/** Configuration pool. Cleared upon restart */
733
/** Number of command line arguments passed to the program */
735
/** The command line arguments */
736
const char * const *argv;
737
/** The program name used to execute the program */
738
const char *short_name;
742
* @brief A structure that represents the current request
745
/** The pool associated with the request */
747
/** The connection to the client */
748
conn_rec *connection;
749
/** The virtual host for this request */
752
/** Pointer to the redirected request if this is an external redirect */
754
/** Pointer to the previous request if this is an internal redirect */
757
/** Pointer to the main request if this is a sub-request
758
* (see http_request.h) */
761
/* Info about the request itself... we begin with stuff that only
762
* protocol.c should ever touch...
764
/** First line of request */
766
/** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
768
/** A proxy request (calculated during post_read_request/translate_name)
769
* possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
773
/** HEAD request, as opposed to GET */
775
/** Protocol string, as given to us, or HTTP/0.9 */
777
/** Protocol version number of protocol; 1.1 = 1001 */
779
/** Host, as set by full URI or Host: */
780
const char *hostname;
782
/** Time when the request started */
783
apr_time_t request_time;
785
/** Status line, if set by script */
786
const char *status_line;
790
/* Request method, two ways; also, protocol, etc.. Outside of protocol.c,
791
* look, but don't touch.
794
/** Request method (eg. GET, HEAD, POST, etc.) */
796
/** M_GET, M_POST, etc. */
800
* 'allowed' is a bitvector of the allowed methods.
802
* A handler must ensure that the request method is one that
803
* it is capable of handling. Generally modules should DECLINE
804
* any request methods they do not handle. Prior to aborting the
805
* handler like this the handler should set r->allowed to the list
806
* of methods that it is willing to handle. This bitvector is used
807
* to construct the "Allow:" header required for OPTIONS requests,
808
* and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
810
* Since the default_handler deals with OPTIONS, all modules can
811
* usually decline to deal with OPTIONS. TRACE is always allowed,
812
* modules don't need to set it explicitly.
814
* Since the default_handler will always handle a GET, a
815
* module which does *not* implement GET should probably return
816
* HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET
817
* handler can't be installed by mod_actions.
820
/** Array of extension methods */
821
apr_array_header_t *allowed_xmethods;
822
/** List of allowed methods */
823
ap_method_list_t *allowed_methods;
825
/** byte count in stream is for body */
826
apr_off_t sent_bodyct;
827
/** body byte count, for easy access */
828
apr_off_t bytes_sent;
829
/** Last modified time of the requested resource */
832
/* HTTP/1.1 connection-level features */
834
/** sending chunked transfer-coding */
836
/** The Range: header */
838
/** The "real" content length */
841
/** Remaining bytes left to read from the request body */
843
/** Number of bytes that have been read from the request body */
844
apr_off_t read_length;
845
/** Method for reading the request body
846
* (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
847
* REQUEST_CHUNKED_DECHUNK, etc...) */
849
/** reading chunked transfer-coding */
851
/** is client waiting for a 100 response? */
852
unsigned expecting_100;
854
/* MIME header environments, in and out. Also, an array containing
855
* environment variables to be passed to subprocesses, so people can
856
* write modules to add to that environment.
858
* The difference between headers_out and err_headers_out is that the
859
* latter are printed even on error, and persist across internal redirects
860
* (so the headers printed for ErrorDocument handlers will have them).
862
* The 'notes' apr_table_t is for notes from one module to another, with no
863
* other set purpose in mind...
866
/** MIME header environment from the request */
867
apr_table_t *headers_in;
868
/** MIME header environment for the response */
869
apr_table_t *headers_out;
870
/** MIME header environment for the response, printed even on errors and
871
* persist across internal redirects */
872
apr_table_t *err_headers_out;
873
/** Array of environment variables to be used for sub processes */
874
apr_table_t *subprocess_env;
875
/** Notes from one module to another */
878
/* content_type, handler, content_encoding, and all content_languages
879
* MUST be lowercased strings. They may be pointers to static strings;
880
* they should not be modified in place.
882
/** The content-type for the current request */
883
const char *content_type; /* Break these out --- we dispatch on 'em */
884
/** The handler string that we use to call a handler function */
885
const char *handler; /* What we *really* dispatch on */
887
/** How to encode the data */
888
const char *content_encoding;
889
/** Array of strings representing the content languages */
890
apr_array_header_t *content_languages;
892
/** variant list validator (if negotiated) */
893
char *vlist_validator;
895
/** If an authentication check was made, this gets set to the user name. */
897
/** If an authentication check was made, this gets set to the auth type. */
900
/** This response can not be cached */
902
/** There is no local copy of this response */
905
/* What object is being requested (either directly, or via include
906
* or content-negotiation mapping).
909
/** The URI without any parsing performed */
911
/** The path portion of the URI */
913
/** The filename on disk corresponding to this response */
915
/* XXX: What does this mean? Please define "canonicalize" -aaron */
916
/** The true filename, we canonicalize r->filename if these don't match */
917
char *canonical_filename;
918
/** The PATH_INFO extracted from this request */
920
/** The QUERY_ARGS extracted from this request */
922
/** finfo.protection (st_mode) set to zero if no such file */
924
/** A struct containing the components of URI */
925
apr_uri_t parsed_uri;
928
* Flag for the handler to accept or reject path_info on
929
* the current request. All modules should respect the
930
* AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO
931
* values, while AP_REQ_DEFAULT_PATH_INFO indicates they
932
* may follow existing conventions. This is set to the
933
* user's preference upon HOOK_VERY_FIRST of the fixups.
937
/* Various other config info which may change with .htaccess files
938
* These are config vectors, with one void* pointer for each module
939
* (the thing pointed to being the module's business).
942
/** Options set in config files, etc. */
943
struct ap_conf_vector_t *per_dir_config;
944
/** Notes on *this* request */
945
struct ap_conf_vector_t *request_config;
948
* A linked list of the .htaccess configuration directives
949
* accessed by this request.
950
* N.B. always add to the head of the list, _never_ to the end.
951
* that way, a sub request's list can (temporarily) point to a parent's list
953
const struct htaccess_result *htaccess;
955
/** A list of output filters to be used for this request */
956
struct ap_filter_t *output_filters;
957
/** A list of input filters to be used for this request */
958
struct ap_filter_t *input_filters;
960
/** A list of protocol level output filters to be used for this
962
struct ap_filter_t *proto_output_filters;
963
/** A list of protocol level input filters to be used for this
965
struct ap_filter_t *proto_input_filters;
967
/** A flag to determine if the eos bucket has been sent yet */
970
/* Things placed at the end of the record to avoid breaking binary
971
* compatibility. It would be nice to remember to reorder the entire
972
* record to improve 64bit alignment the next time we need to break
973
* binary compatibility for some other reason.
978
* @defgroup ProxyReq Proxy request types
980
* Possible values of request_rec->proxyreq. A request could be normal,
981
* proxied or reverse proxied. Normally proxied and reverse proxied are
982
* grouped together as just "proxied", but sometimes it's necessary to
983
* tell the difference between the two, such as for authentication.
987
#define PROXYREQ_NONE 0 /**< No proxy */
988
#define PROXYREQ_PROXY 1 /**< Standard proxy */
989
#define PROXYREQ_REVERSE 2 /**< Reverse proxy */
990
#define PROXYREQ_RESPONSE 3 /**< Origin response */
995
* @brief Enumeration of connection keepalive options
1001
} ap_conn_keepalive_e;
1004
* @brief Structure to store things which are per connection
1007
/** Pool associated with this connection */
1009
/** Physical vhost this conn came in on */
1010
server_rec *base_server;
1011
/** used by http_vhost.c */
1012
void *vhost_lookup_data;
1014
/* Information about the connection itself */
1015
/** local address */
1016
apr_sockaddr_t *local_addr;
1017
/** remote address */
1018
apr_sockaddr_t *remote_addr;
1020
/** Client's IP address */
1022
/** Client's DNS name, if known. NULL if DNS hasn't been checked,
1023
* "" if it has and no address was found. N.B. Only access this though
1024
* get_remote_host() */
1026
/** Only ever set if doing rfc1413 lookups. N.B. Only access this through
1027
* get_remote_logname() */
1028
char *remote_logname;
1030
/** Are we still talking? */
1033
/** Are we going to keep the connection alive for another request?
1034
* @see ap_conn_keepalive_e */
1035
ap_conn_keepalive_e keepalive;
1037
/** have we done double-reverse DNS? -1 yes/failure, 0 not yet,
1039
signed int double_reverse:2;
1041
/** How many times have we used it? */
1043
/** server IP address */
1045
/** used for ap_get_server_name when UseCanonicalName is set to DNS
1046
* (ignores setting of HostnameLookups) */
1049
/** ID of this connection; unique at any point in time */
1051
/** Config vector containing pointers to connections per-server
1052
* config structures. */
1053
struct ap_conf_vector_t *conn_config;
1054
/** Notes on *this* connection: send note from one module to
1055
* another. must remain valid for all requests on this conn */
1057
/** A list of input filters to be used for this connection */
1058
struct ap_filter_t *input_filters;
1059
/** A list of output filters to be used for this connection */
1060
struct ap_filter_t *output_filters;
1061
/** handle to scoreboard information for this connection */
1063
/** The bucket allocator to use for all bucket/brigade creations */
1064
struct apr_bucket_alloc_t *bucket_alloc;
1065
/** The current state of this connection */
1067
/** Is there data pending in the input filters? */
1068
int data_in_input_filters;
1072
* Enumeration of connection states
1075
CONN_STATE_CHECK_REQUEST_LINE_READABLE,
1076
CONN_STATE_READ_REQUEST_LINE,
1081
* @brief A structure to contain connection state information
1083
struct conn_state_t {
1084
/** APR_RING of expiration timeouts */
1085
APR_RING_ENTRY(conn_state_t) timeout_list;
1086
/** the expiration time of the next keepalive timeout */
1087
apr_time_t expiration_time;
1088
/** Current state of the connection */
1090
/** connection record this struct refers to */
1092
/** memory pool to allocate from */
1094
/** bucket allocator */
1095
apr_bucket_alloc_t *bucket_alloc;
1096
/** poll file decriptor information */
1100
/* Per-vhost config... */
1103
* The address 255.255.255.255, when used as a virtualhost address,
1104
* will become the "default" server when the ip doesn't match other vhosts.
1106
#define DEFAULT_VHOST_ADDR 0xfffffffful
1110
* @struct server_addr_rec
1111
* @brief A structure to be used for Per-vhost config
1113
typedef struct server_addr_rec server_addr_rec;
1114
struct server_addr_rec {
1115
/** The next server in the list */
1116
server_addr_rec *next;
1117
/** The bound address, for this server */
1118
apr_sockaddr_t *host_addr;
1119
/** The bound port, for this server */
1120
apr_port_t host_port;
1121
/** The name given in "<VirtualHost>" */
1126
* @brief A structure to store information for each virtual server
1129
/** The process this server is running in */
1130
process_rec *process;
1131
/** The next server in the list */
1134
/** The name of the server */
1135
const char *defn_name;
1136
/** The line of the config file that the server was defined on */
1137
unsigned defn_line_number;
1139
/* Contact information */
1141
/** The admin's contact information */
1143
/** The server hostname */
1144
char *server_hostname;
1145
/** for redirects, etc. */
1148
/* Log files --- note that transfer log is now in the modules... */
1150
/** The name of the error log */
1152
/** A file descriptor that references the error log */
1153
apr_file_t *error_log;
1154
/** The log level for this server */
1157
/* Module-specific configuration for server, and defaults... */
1159
/** true if this is the virtual server */
1161
/** Config vector containing pointers to modules' per-server config
1163
struct ap_conf_vector_t *module_config;
1164
/** MIME type info, etc., before we start checking per-directory info */
1165
struct ap_conf_vector_t *lookup_defaults;
1167
/* Transaction handling */
1169
/** I haven't got a clue */
1170
server_addr_rec *addrs;
1171
/** Timeout, as an apr interval, before we give up */
1172
apr_interval_time_t timeout;
1173
/** The apr interval we will wait for another request */
1174
apr_interval_time_t keep_alive_timeout;
1175
/** Maximum requests per connection */
1177
/** Use persistent connections? */
1180
/** Pathname for ServerPath */
1182
/** Length of path */
1185
/** Normal names for ServerAlias servers */
1186
apr_array_header_t *names;
1187
/** Wildcarded names for ServerAlias servers */
1188
apr_array_header_t *wild_names;
1190
/** limit on size of the HTTP request line */
1192
/** limit on size of any request header field */
1193
int limit_req_fieldsize;
1194
/** limit on number of request header fields */
1195
int limit_req_fields;
1197
/** The server request scheme for redirect responses */
1198
const char *server_scheme;
1201
typedef struct core_output_filter_ctx {
1202
apr_bucket_brigade *b;
1203
/** subpool of c->pool used for resources
1204
* which may outlive the request
1206
apr_pool_t *deferred_write_pool;
1207
} core_output_filter_ctx_t;
1209
typedef struct core_filter_ctx {
1210
apr_bucket_brigade *b;
1211
apr_bucket_brigade *tmpbb;
1214
typedef struct core_net_rec {
1215
/** Connection to the client */
1216
apr_socket_t *client_socket;
1218
/** connection record */
1221
core_output_filter_ctx_t *out_ctx;
1226
* Examine a field value (such as a media-/content-type) string and return
1227
* it sans any parameters; e.g., strip off any ';charset=foo' and the like.
1228
* @param p Pool to allocate memory from
1229
* @param intype The field to examine
1230
* @return A copy of the field minus any parameters
1232
AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
1235
* Convert a time from an integer into a string in a specified format
1236
* @param p The pool to allocate memory from
1237
* @param t The time to convert
1238
* @param fmt The format to use for the conversion
1239
* @param gmt Convert the time for GMT?
1240
* @return The string that represents the specified time
1242
AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
1244
/* String handling. The *_nc variants allow you to use non-const char **s as
1245
arguments (unfortunately C won't automatically convert a char ** to a const
1249
* Get the characters until the first occurance of a specified character
1250
* @param p The pool to allocate memory from
1251
* @param line The string to get the characters from
1252
* @param stop The character to stop at
1253
* @return A copy of the characters up to the first stop character
1255
AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
1258
* Get the characters until the first occurance of a specified character
1259
* @param p The pool to allocate memory from
1260
* @param line The string to get the characters from
1261
* @param stop The character to stop at
1262
* @return A copy of the characters up to the first stop character
1263
* @note This is the same as ap_getword(), except it doesn't use const char **.
1265
AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
1268
* Get the first word from a given string. A word is defined as all characters
1269
* up to the first whitespace.
1270
* @param p The pool to allocate memory from
1271
* @param line The string to traverse
1272
* @return The first word in the line
1274
AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
1277
* Get the first word from a given string. A word is defined as all characters
1278
* up to the first whitespace.
1279
* @param p The pool to allocate memory from
1280
* @param line The string to traverse
1281
* @return The first word in the line
1282
* @note The same as ap_getword_white(), except it doesn't use const char**
1284
AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
1287
* Get all characters from the first occurance of @a stop to the first "\0"
1288
* @param p The pool to allocate memory from
1289
* @param line The line to traverse
1290
* @param stop The character to start at
1291
* @return A copy of all caracters after the first occurance of the specified
1294
AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
1298
* Get all characters from the first occurance of @a stop to the first "\0"
1299
* @param p The pool to allocate memory from
1300
* @param line The line to traverse
1301
* @param stop The character to start at
1302
* @return A copy of all caracters after the first occurance of the specified
1304
* @note The same as ap_getword_nulls(), except it doesn't use const char **.
1306
AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
1309
* Get the second word in the string paying attention to quoting
1310
* @param p The pool to allocate from
1311
* @param line The line to traverse
1312
* @return A copy of the string
1314
AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
1317
* Get the second word in the string paying attention to quoting
1318
* @param p The pool to allocate from
1319
* @param line The line to traverse
1320
* @return A copy of the string
1321
* @note The same as ap_getword_conf(), except it doesn't use const char **.
1323
AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
1326
* Check a string for any ${ENV} environment variable construct and replace
1327
* each them by the value of that environment variable, if it exists. If the
1328
* environment value does not exist, leave the ${ENV} construct alone; it
1329
* means something else.
1330
* @param p The pool to allocate from
1331
* @param word The string to check
1332
* @return The string with the replaced environment variables
1334
AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word);
1337
* Size an HTTP header field list item, as separated by a comma.
1338
* @param field The field to size
1339
* @param len The length of the field
1340
* @return The return value is a pointer to the beginning of the non-empty
1341
* list item within the original string (or NULL if there is none) and the
1342
* address of field is shifted to the next non-comma, non-whitespace
1343
* character. len is the length of the item excluding any beginning whitespace.
1345
AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
1348
* Retrieve an HTTP header field list item, as separated by a comma,
1349
* while stripping insignificant whitespace and lowercasing anything not in
1350
* a quoted string or comment.
1351
* @param p The pool to allocate from
1352
* @param field The field to retrieve
1353
* @return The return value is a new string containing the converted list
1354
* item (or NULL if none) and the address pointed to by field is
1355
* shifted to the next non-comma, non-whitespace.
1357
AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
1360
* Find an item in canonical form (lowercase, no extra spaces) within
1361
* an HTTP field value list.
1362
* @param p The pool to allocate from
1363
* @param line The field value list to search
1364
* @param tok The token to search for
1365
* @return 1 if found, 0 if not found.
1367
AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
1370
* Retrieve a token, spacing over it and adjusting the pointer to
1371
* the first non-white byte afterwards. Note that these tokens
1372
* are delimited by semis and commas and can also be delimited
1373
* by whitespace at the caller's option.
1374
* @param p The pool to allocate from
1375
* @param accept_line The line to retrieve the token from (adjusted afterwards)
1376
* @param accept_white Is it delimited by whitespace
1379
AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
1382
* Find http tokens, see the definition of token from RFC2068
1383
* @param p The pool to allocate from
1384
* @param line The line to find the token
1385
* @param tok The token to find
1386
* @return 1 if the token is found, 0 otherwise
1388
AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
1391
* find http tokens from the end of the line
1392
* @param p The pool to allocate from
1393
* @param line The line to find the token
1394
* @param tok The token to find
1395
* @return 1 if the token is found, 0 otherwise
1397
AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
1400
* Check for an Absolute URI syntax
1401
* @param u The string to check
1402
* @return 1 if URI, 0 otherwise
1404
AP_DECLARE(int) ap_is_url(const char *u);
1408
* @param url The url to unescape
1409
* @return 0 on success, non-zero otherwise
1411
AP_DECLARE(int) ap_unescape_url(char *url);
1414
* Unescape a URL, but leaving %2f (slashes) escaped
1415
* @param url The url to unescape
1416
* @return 0 on success, non-zero otherwise
1418
AP_DECLARE(int) ap_unescape_url_keep2f(char *url);
1421
* Convert all double slashes to single slashes
1422
* @param name The string to convert
1424
AP_DECLARE(void) ap_no2slash(char *name);
1427
* Remove all ./ and xx/../ substrings from a file name. Also remove
1428
* any leading ../ or /../ substrings.
1429
* @param name the file name to parse
1431
AP_DECLARE(void) ap_getparents(char *name);
1434
* Escape a path segment, as defined in RFC 1808
1435
* @param p The pool to allocate from
1436
* @param s The path to convert
1437
* @return The converted URL
1439
AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
1442
* convert an OS path to a URL in an OS dependant way.
1443
* @param p The pool to allocate from
1444
* @param path The path to convert
1445
* @param partial if set, assume that the path will be appended to something
1446
* with a '/' in it (and thus does not prefix "./")
1447
* @return The converted URL
1449
AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
1451
/** @see ap_os_escape_path */
1452
#define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
1455
* Escape an html string
1456
* @param p The pool to allocate from
1457
* @param s The html to escape
1458
* @return The escaped string
1460
AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
1463
* Escape a string for logging
1464
* @param p The pool to allocate from
1465
* @param str The string to escape
1466
* @return The escaped string
1468
AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str);
1471
* Escape a string for logging into the error log (without a pool)
1472
* @param dest The buffer to write to
1473
* @param source The string to escape
1474
* @param buflen The buffer size for the escaped string (including "\0")
1475
* @return The len of the escaped string (always < maxlen)
1477
AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1481
* Construct a full hostname
1482
* @param p The pool to allocate from
1483
* @param hostname The hostname of the server
1484
* @param port The port the server is running on
1485
* @param r The current request
1486
* @return The server's hostname
1488
AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1489
apr_port_t port, const request_rec *r);
1492
* Escape a shell command
1493
* @param p The pool to allocate from
1494
* @param s The command to escape
1495
* @return The escaped shell command
1497
AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
1500
* Count the number of directories in a path
1501
* @param path The path to count
1502
* @return The number of directories
1504
AP_DECLARE(int) ap_count_dirs(const char *path);
1507
* Copy at most @a n leading directories of @a s into @a d. @a d
1508
* should be at least as large as @a s plus 1 extra byte
1510
* @param d The location to copy to
1511
* @param s The location to copy from
1512
* @param n The number of directories to copy
1513
* @return value is the ever useful pointer to the trailing "\0" of d
1514
* @note on platforms with drive letters, n = 0 returns the "/" root,
1515
* whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
1516
* returns the empty string. */
1517
AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
1520
* Return the parent directory name (including trailing /) of the file
1522
* @param p The pool to allocate from
1523
* @param s The file to get the parent of
1524
* @return A copy of the file's parent directory
1526
AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
1529
* Given a directory and filename, create a single path from them. This
1530
* function is smart enough to ensure that there is a sinlge '/' between the
1531
* directory and file names
1532
* @param a The pool to allocate from
1533
* @param dir The directory name
1534
* @param f The filename
1535
* @return A copy of the full path
1536
* @note Never consider using this function if you are dealing with filesystem
1537
* names that need to remain canonical, unless you are merging an apr_dir_read
1538
* path and returned filename. Otherwise, the result is not canonical.
1540
AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
1543
* Test if the given path has an an absolute path.
1544
* @param p The pool to allocate from
1545
* @param dir The directory name
1546
* @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
1547
* multiple forms of absolute paths. This only reports if the path is absolute
1548
* in a canonical sense.
1550
AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
1553
* Does the provided string contain wildcard characters? This is useful
1554
* for determining if the string should be passed to strcmp_match or to strcmp.
1555
* The only wildcard characters recognized are '?' and '*'
1556
* @param str The string to check
1557
* @return 1 if the string has wildcards, 0 otherwise
1559
AP_DECLARE(int) ap_is_matchexp(const char *str);
1562
* Determine if a string matches a patterm containing the wildcards '?' or '*'
1563
* @param str The string to check
1564
* @param expected The pattern to match against
1565
* @return 1 if the two strings match, 0 otherwise
1567
AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected);
1570
* Determine if a string matches a patterm containing the wildcards '?' or '*',
1572
* @param str The string to check
1573
* @param expected The pattern to match against
1574
* @return 1 if the two strings match, 0 otherwise
1576
AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected);
1579
* Find the first occurrence of the substring s2 in s1, regardless of case
1580
* @param s1 The string to search
1581
* @param s2 The substring to search for
1582
* @return A pointer to the beginning of the substring
1583
* @remark See apr_strmatch() for a faster alternative
1585
AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
1588
* Return a pointer to the location inside of bigstring immediately after prefix
1589
* @param bigstring The input string
1590
* @param prefix The prefix to strip away
1591
* @return A pointer relative to bigstring after prefix
1593
AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
1594
const char *prefix);
1597
* Decode a base64 encoded string into memory allocated from a pool
1598
* @param p The pool to allocate from
1599
* @param bufcoded The encoded string
1600
* @return The decoded string
1602
AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
1605
* Encode a string into memory allocated from a pool in base 64 format
1606
* @param p The pool to allocate from
1607
* @param string The plaintext string
1608
* @return The encoded string
1610
AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
1613
* Compile a regular expression to be used later
1614
* @param p The pool to allocate from
1615
* @param pattern the regular expression to compile
1616
* @param cflags The bitwise or of one or more of the following:
1617
* @li REG_EXTENDED - Use POSIX extended Regular Expressions
1618
* @li REG_ICASE - Ignore case
1619
* @li REG_NOSUB - Support for substring addressing of matches
1621
* @li REG_NEWLINE - Match-any-character operators don't match new-line
1622
* @return The compiled regular expression
1624
AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
1628
* Free the memory associated with a compiled regular expression
1629
* @param p The pool the regex was allocated from
1630
* @param reg The regular expression to free
1632
AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
1635
* After performing a successful regex match, you may use this function to
1636
* perform a series of string substitutions based on subexpressions that were
1637
* matched during the call to ap_regexec
1638
* @param p The pool to allocate from
1639
* @param input An arbitrary string containing $1 through $9. These are
1640
* replaced with the corresponding matched sub-expressions
1641
* @param source The string that was originally matched to the regex
1642
* @param nmatch the nmatch returned from ap_pregex
1643
* @param pmatch the pmatch array returned from ap_pregex
1645
AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
1646
size_t nmatch, ap_regmatch_t pmatch[]);
1649
* We want to downcase the type/subtype for comparison purposes
1650
* but nothing else because ;parameter=foo values are case sensitive.
1651
* @param s The content-type to convert to lowercase
1653
AP_DECLARE(void) ap_content_type_tolower(char *s);
1656
* convert a string to all lowercase
1657
* @param s The string to convert to lowercase
1659
AP_DECLARE(void) ap_str_tolower(char *s);
1662
* Search a string from left to right for the first occurrence of a
1663
* specific character
1664
* @param str The string to search
1665
* @param c The character to search for
1666
* @return The index of the first occurrence of c in str
1668
AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
1671
* Search a string from right to left for the first occurrence of a
1672
* specific character
1673
* @param str The string to search
1674
* @param c The character to search for
1675
* @return The index of the first occurrence of c in str
1677
AP_DECLARE(int) ap_rind(const char *str, char c);
1680
* Given a string, replace any bare " with \" .
1681
* @param p The pool to allocate memory from
1682
* @param instring The string to search for "
1683
* @return A copy of the string with escaped quotes
1685
AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
1688
* Given a string, append the PID deliminated by delim.
1689
* Usually used to create a pid-appended filepath name
1690
* (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
1691
* a macro, to avoid unistd.h dependency
1692
* @param p The pool to allocate memory from
1693
* @param string The string to append the PID to
1694
* @param delim The string to use to deliminate the string from the PID
1695
* @return A copy of the string with the PID appended
1697
AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
1700
/* Misc system hackery */
1702
* Given the name of an object in the file system determine if it is a directory
1703
* @param p The pool to allocate from
1704
* @param name The name of the object to check
1705
* @return 1 if it is a directory, 0 otherwise
1707
AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
1710
* Given the name of an object in the file system determine if it is a directory - this version is symlink aware
1711
* @param p The pool to allocate from
1712
* @param name The name of the object to check
1713
* @return 1 if it is a directory, 0 otherwise
1715
AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
1718
extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
1719
#endif /* _OSD_POSIX */
1722
* Determine the local host name for the current machine
1723
* @param p The pool to allocate from
1724
* @return A copy of the local host name
1726
char *ap_get_local_host(apr_pool_t *p);
1729
* Log an assertion to the error log
1730
* @param szExp The assertion that failed
1731
* @param szFile The file the assertion is in
1732
* @param nLine The line the assertion is defined on
1734
AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
1735
__attribute__((noreturn));
1738
* @internal Internal Assert function
1740
#define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
1743
* Redefine assert() to something more useful for an Apache...
1745
* Use ap_assert() if the condition should always be checked.
1746
* Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
1750
#define AP_DEBUG_ASSERT(exp) ap_assert(exp)
1752
#define AP_DEBUG_ASSERT(exp) ((void)0)
1756
* @defgroup stopsignal Flags which indicate places where the sever should stop for debugging.
1758
* A set of flags which indicate places where the server should raise(SIGSTOP).
1759
* This is useful for debugging, because you can then attach to that process
1760
* with gdb and continue. This is important in cases where one_process
1761
* debugging isn't possible.
1763
/** stop on a Detach */
1764
#define SIGSTOP_DETACH 1
1765
/** stop making a child process */
1766
#define SIGSTOP_MAKE_CHILD 2
1767
/** stop spawning a child process */
1768
#define SIGSTOP_SPAWN_CHILD 4
1769
/** stop spawning a child process with a piped log */
1770
#define SIGSTOP_PIPED_LOG_SPAWN 8
1771
/** stop spawning a CGI child process */
1772
#define SIGSTOP_CGI_CHILD 16
1774
/** Macro to get GDB started */
1775
#ifdef DEBUG_SIGSTOP
1776
extern int raise_sigstop_flags;
1777
#define RAISE_SIGSTOP(x) do { \
1778
if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
1781
#define RAISE_SIGSTOP(x)
1785
* Get HTML describing the address and (optionally) admin of the server.
1786
* @param prefix Text which is prepended to the return value
1787
* @param r The request_rec
1788
* @return HTML describing the server, allocated in @a r's pool.
1790
AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
1792
/** strtoul does not exist on sunos4. */
1796
#define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
1798
/* The C library has functions that allow const to be silently dropped ...
1799
these macros detect the drop in maintainer mode, but use the native
1800
methods for normal builds
1802
Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs
1803
to be included before the macros are defined or compilation will fail.
1807
AP_DECLARE(char *) ap_strchr(char *s, int c);
1808
AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
1809
AP_DECLARE(char *) ap_strrchr(char *s, int c);
1810
AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
1811
AP_DECLARE(char *) ap_strstr(char *s, const char *c);
1812
AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
1817
# define strchr(s, c) ap_strchr(s,c)
1819
# define strrchr(s, c) ap_strrchr(s,c)
1821
# define strstr(s, c) ap_strstr(s,c)
1825
/** use this instead of strchr */
1826
# define ap_strchr(s, c) strchr(s, c)
1827
/** use this instead of strchr */
1828
# define ap_strchr_c(s, c) strchr(s, c)
1829
/** use this instead of strrchr */
1830
# define ap_strrchr(s, c) strrchr(s, c)
1831
/** use this instead of strrchr */
1832
# define ap_strrchr_c(s, c) strrchr(s, c)
1833
/** use this instead of strrstr*/
1834
# define ap_strstr(s, c) strstr(s, c)
1835
/** use this instead of strrstr*/
1836
# define ap_strstr_c(s, c) strstr(s, c)
1840
#define AP_NORESTART APR_OS_START_USEERR + 1
1846
#endif /* !APACHE_HTTPD_H */
1848
/** @} //APACHE Daemon */
1849
/** @} //APACHE Core */
1850
/** @} //APACHE super group */
added
removed
include/httpd.h
