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