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