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