home *** CD-ROM | disk | FTP | other *** search
/ PC World 2002 April / PCWorld_2002-04_cd.bin / Komunik / apache / apache_1.3.23-win32-x86-no_src.msi / Data.Cab / F164898_httpd.h < prev    next >
C/C++ Source or Header  |  2002-01-21  |  47KB  |  1,229 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000 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. #ifdef __cplusplus
  63. extern "C" {
  64. #endif
  65.  
  66. /*
  67.  * httpd.h: header for simple (ha! not anymore) http daemon
  68.  */
  69.  
  70. /* Headers in which EVERYONE has an interest... */
  71.  
  72. #include "ap_config.h"
  73. #include "ap_alloc.h"
  74. #include "buff.h"
  75. #include "ap.h"
  76.  
  77. /* ----------------------------- config dir ------------------------------ */
  78.  
  79. /* Define this to be the default server home dir. Most things later in this
  80.  * file with a relative pathname will have this added.
  81.  */
  82. #ifndef HTTPD_ROOT
  83. #ifdef OS2
  84. /* Set default for OS/2 file system */
  85. #define HTTPD_ROOT "/os2httpd"
  86. #elif defined(WIN32)
  87. /* Set default for Windows file system */
  88. #define HTTPD_ROOT "/apache"
  89. #elif defined(BEOS) || defined(BONE)
  90. #define HTTPD_ROOT "/boot/home/apache"
  91. #elif defined(NETWARE)
  92. #define HTTPD_ROOT "sys:/apache"
  93. #else
  94. #define HTTPD_ROOT "/usr/local/apache"
  95. #endif
  96. #endif /* HTTPD_ROOT */
  97.  
  98. /* Default location of documents.  Can be overridden by the DocumentRoot
  99.  * directive.
  100.  */
  101. #ifndef DOCUMENT_LOCATION
  102. #ifdef OS2
  103. /* Set default for OS/2 file system */
  104. #define DOCUMENT_LOCATION  HTTPD_ROOT "/docs"
  105. #else
  106. #define DOCUMENT_LOCATION  HTTPD_ROOT "/htdocs"
  107. #endif
  108. #endif /* DOCUMENT_LOCATION */
  109.  
  110. /* Max. number of dynamically loaded modules */
  111. #ifndef DYNAMIC_MODULE_LIMIT
  112. #define DYNAMIC_MODULE_LIMIT 64
  113. #endif
  114.  
  115. /* Default administrator's address */
  116. #define DEFAULT_ADMIN "[no address given]"
  117.  
  118. /* The target name of the installed Apache */
  119. #ifndef TARGET
  120. #define TARGET "httpd"
  121. #endif
  122.  
  123. /* 
  124.  * --------- You shouldn't have to edit anything below this line ----------
  125.  *
  126.  * Any modifications to any defaults not defined above should be done in the 
  127.  * respective config. file. 
  128.  *
  129.  */
  130.  
  131.  
  132. /* -- Internal representation for a HTTP protocol number, e.g., HTTP/1.1 -- */
  133.  
  134. #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
  135. #define HTTP_VERSION_MAJOR(number) ((number)/1000)
  136. #define HTTP_VERSION_MINOR(number) ((number)%1000)
  137.  
  138.  
  139. /* -------------- Port number for server running standalone --------------- */
  140.  
  141. #define DEFAULT_HTTP_PORT    80
  142. #define DEFAULT_HTTPS_PORT    443
  143. #define ap_is_default_port(port,r)    ((port) == ap_default_port(r))
  144. #ifdef NETWARE
  145. #define ap_http_method(r) ap_os_http_method(r)
  146. #else
  147. #define ap_http_method(r)    "http"
  148. #endif
  149. #define ap_default_port(r)    DEFAULT_HTTP_PORT
  150.  
  151. /* --------- Default user name and group name running standalone ---------- */
  152. /* --- These may be specified as numbers by placing a # before a number --- */
  153.  
  154. #ifndef DEFAULT_USER
  155. #define DEFAULT_USER "#-1"
  156. #endif
  157. #ifndef DEFAULT_GROUP
  158. #define DEFAULT_GROUP "#-1"
  159. #endif
  160.  
  161. /* The name of the log files */
  162. #ifndef DEFAULT_XFERLOG
  163. #if defined(OS2) || defined(WIN32)
  164. #define DEFAULT_XFERLOG "logs/access.log"
  165. #else
  166. #define DEFAULT_XFERLOG "logs/access_log"
  167. #endif
  168. #endif /* DEFAULT_XFERLOG */
  169.  
  170. #ifndef DEFAULT_ERRORLOG
  171. #if defined(OS2) || defined(WIN32)
  172. #define DEFAULT_ERRORLOG "logs/error.log"
  173. #else
  174. #define DEFAULT_ERRORLOG "logs/error_log"
  175. #endif
  176. #endif /* DEFAULT_ERRORLOG */
  177.  
  178. #ifndef DEFAULT_PIDLOG
  179. #define DEFAULT_PIDLOG "logs/httpd.pid"
  180. #endif
  181. #ifndef DEFAULT_SCOREBOARD
  182. #define DEFAULT_SCOREBOARD "logs/apache_runtime_status"
  183. #endif
  184. #ifndef DEFAULT_LOCKFILE
  185. #define DEFAULT_LOCKFILE "logs/accept.lock"
  186. #endif
  187.  
  188. /* Define this to be what your HTML directory content files are called */
  189. #ifndef DEFAULT_INDEX
  190. #define DEFAULT_INDEX "index.html"
  191. #endif
  192.  
  193. /* Define this to 1 if you want fancy indexing, 0 otherwise */
  194. #ifndef DEFAULT_INDEXING
  195. #define DEFAULT_INDEXING 0
  196. #endif
  197.  
  198. /* Define this to be what type you'd like returned for files with unknown */
  199. /* suffixes.  MUST be all lower case. */
  200. #ifndef DEFAULT_CONTENT_TYPE
  201. #define DEFAULT_CONTENT_TYPE "text/plain"
  202. #endif
  203.  
  204. /* Define this to be what your per-directory security files are called */
  205. #ifndef DEFAULT_ACCESS_FNAME
  206. #ifdef OS2
  207. /* Set default for OS/2 file system */
  208. #define DEFAULT_ACCESS_FNAME "htaccess"
  209. #else
  210. #define DEFAULT_ACCESS_FNAME ".htaccess"
  211. #endif
  212. #endif /* DEFAULT_ACCESS_FNAME */
  213.  
  214. /* The name of the server config file */
  215. #ifndef SERVER_CONFIG_FILE
  216. #define SERVER_CONFIG_FILE "conf/httpd.conf"
  217. #endif
  218.  
  219. /* The name of the document config file */
  220. #ifndef RESOURCE_CONFIG_FILE
  221. #define RESOURCE_CONFIG_FILE "conf/srm.conf"
  222. #endif
  223.  
  224. /* The name of the MIME types file */
  225. #ifndef TYPES_CONFIG_FILE
  226. #define TYPES_CONFIG_FILE "conf/mime.types"
  227. #endif
  228.  
  229. /* The name of the access file */
  230. #ifndef ACCESS_CONFIG_FILE
  231. #define ACCESS_CONFIG_FILE "conf/access.conf"
  232. #endif
  233.  
  234. /* Whether we should enable rfc1413 identity checking */
  235. #ifndef DEFAULT_RFC1413
  236. #define DEFAULT_RFC1413 0
  237. #endif
  238. /* The default directory in user's home dir */
  239. #ifndef DEFAULT_USER_DIR
  240. #define DEFAULT_USER_DIR "public_html"
  241. #endif
  242.  
  243. /* The default path for CGI scripts if none is currently set */
  244. #ifndef DEFAULT_PATH
  245. #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
  246. #endif
  247.  
  248. /* The path to the shell interpreter, for parsed docs */
  249. #ifndef SHELL_PATH
  250. #if defined(OS2) || defined(WIN32)
  251. /* Set default for OS/2 and Windows file system */
  252. #define SHELL_PATH "CMD.EXE"
  253. #else
  254. #define SHELL_PATH "/bin/sh"
  255. #endif
  256. #endif /* SHELL_PATH */
  257.  
  258. /* The path to the suExec wrapper, can be overridden in Configuration */
  259. #ifndef SUEXEC_BIN
  260. #define SUEXEC_BIN  HTTPD_ROOT "/bin/suexec"
  261. #endif
  262.  
  263. /* The default string lengths */
  264. #define MAX_STRING_LEN HUGE_STRING_LEN
  265. #define HUGE_STRING_LEN 8192
  266.  
  267. /* The timeout for waiting for messages */
  268. #ifndef DEFAULT_TIMEOUT
  269. #define DEFAULT_TIMEOUT 300
  270. #endif
  271.  
  272. /* The timeout for waiting for keepalive timeout until next request */
  273. #ifndef DEFAULT_KEEPALIVE_TIMEOUT
  274. #define DEFAULT_KEEPALIVE_TIMEOUT 15
  275. #endif
  276.  
  277. /* The number of requests to entertain per connection */
  278. #ifndef DEFAULT_KEEPALIVE
  279. #define DEFAULT_KEEPALIVE 100
  280. #endif
  281.  
  282. /* The size of the server's internal read-write buffers */
  283. #define IOBUFSIZE 8192
  284.  
  285. /* Number of servers to spawn off by default --- also, if fewer than
  286.  * this free when the caretaker checks, it will spawn more.
  287.  */
  288. #ifndef DEFAULT_START_DAEMON
  289. #define DEFAULT_START_DAEMON 5
  290. #endif
  291.  
  292. /* Maximum number of *free* server processes --- more than this, and
  293.  * they will die off.
  294.  */
  295.  
  296. #ifndef DEFAULT_MAX_FREE_DAEMON
  297. #define DEFAULT_MAX_FREE_DAEMON 10
  298. #endif
  299.  
  300. /* Minimum --- fewer than this, and more will be created */
  301.  
  302. #ifndef DEFAULT_MIN_FREE_DAEMON
  303. #define DEFAULT_MIN_FREE_DAEMON 5
  304. #endif
  305.  
  306. /* Limit on the total --- clients will be locked out if more servers than
  307.  * this are needed.  It is intended solely to keep the server from crashing
  308.  * when things get out of hand.
  309.  *
  310.  * We keep a hard maximum number of servers, for two reasons --- first off,
  311.  * in case something goes seriously wrong, we want to stop the fork bomb
  312.  * short of actually crashing the machine we're running on by filling some
  313.  * kernel table.  Secondly, it keeps the size of the scoreboard file small
  314.  * enough that we can read the whole thing without worrying too much about
  315.  * the overhead.
  316.  */
  317. #ifndef HARD_SERVER_LIMIT
  318. #ifdef WIN32
  319. #define HARD_SERVER_LIMIT 1024
  320. #elif defined(NETWARE)
  321. #define HARD_SERVER_LIMIT 2048
  322. #else
  323. #define HARD_SERVER_LIMIT 256
  324. #endif
  325. #endif
  326.  
  327. /*
  328.  * Special Apache error codes. These are basically used
  329.  *  in http_main.c so we can keep track of various errors.
  330.  *
  331.  *   APEXIT_OK:
  332.  *     A normal exit
  333.  *   APEXIT_INIT:
  334.  *     A fatal error arising during the server's init sequence
  335.  *   APEXIT_CHILDINIT:
  336.  *     The child died during it's init sequence
  337.  *   APEXIT_CHILDFATAL:
  338.  *     A fatal error, resulting in the whole server aborting.
  339.  *     If a child exits with this error, the parent process
  340.  *     considers this a server-wide fatal error and aborts.
  341.  *                 
  342.  */
  343. #define APEXIT_OK        0x0
  344. #define APEXIT_INIT        0x2
  345. #define APEXIT_CHILDINIT    0x3
  346. #define APEXIT_CHILDFATAL    0xf
  347.  
  348. /*
  349.  * (Unix, OS/2 only)
  350.  * Interval, in microseconds, between scoreboard maintenance.  During
  351.  * each scoreboard maintenance cycle the parent decides if it needs to
  352.  * spawn a new child (to meet MinSpareServers requirements), or kill off
  353.  * a child (to meet MaxSpareServers requirements).  It will only spawn or
  354.  * kill one child per cycle.  Setting this too low will chew cpu.  The
  355.  * default is probably sufficient for everyone.  But some people may want
  356.  * to raise this on servers which aren't dedicated to httpd and where they
  357.  * don't like the httpd waking up each second to see what's going on.
  358.  */
  359. #ifndef SCOREBOARD_MAINTENANCE_INTERVAL
  360. #define SCOREBOARD_MAINTENANCE_INTERVAL 1000000
  361. #endif
  362.  
  363. /* Number of requests to try to handle in a single process.  If <= 0,
  364.  * the children don't die off.  That's the default here, since I'm still
  365.  * interested in finding and stanching leaks.
  366.  */
  367.  
  368. #ifndef DEFAULT_MAX_REQUESTS_PER_CHILD
  369. #define DEFAULT_MAX_REQUESTS_PER_CHILD 0
  370. #endif
  371.  
  372. #ifndef DEFAULT_THREADS_PER_CHILD
  373. #define DEFAULT_THREADS_PER_CHILD 50
  374. #endif
  375. #ifndef DEFAULT_EXCESS_REQUESTS_PER_CHILD
  376. #define DEFAULT_EXCESS_REQUESTS_PER_CHILD 0
  377. #endif
  378.  
  379. /* The maximum length of the queue of pending connections, as defined
  380.  * by listen(2).  Under some systems, it should be increased if you
  381.  * are experiencing a heavy TCP SYN flood attack.
  382.  *
  383.  * It defaults to 511 instead of 512 because some systems store it 
  384.  * as an 8-bit datatype; 512 truncated to 8-bits is 0, while 511 is 
  385.  * 255 when truncated.
  386.  */
  387.  
  388. #ifndef DEFAULT_LISTENBACKLOG
  389. #define DEFAULT_LISTENBACKLOG 511
  390. #endif
  391.  
  392. /* Limits on the size of various request items.  These limits primarily
  393.  * exist to prevent simple denial-of-service attacks on a server based
  394.  * on misuse of the protocol.  The recommended values will depend on the
  395.  * nature of the server resources -- CGI scripts and database backends
  396.  * might require large values, but most servers could get by with much
  397.  * smaller limits than we use below.  The request message body size can
  398.  * be limited by the per-dir config directive LimitRequestBody.
  399.  *
  400.  * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
  401.  * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
  402.  * These two limits can be lowered (but not raised) by the server config
  403.  * directives LimitRequestLine and LimitRequestFieldsize, respectively.
  404.  *
  405.  * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
  406.  * the server config directive LimitRequestFields.
  407.  */
  408. #ifndef DEFAULT_LIMIT_REQUEST_LINE
  409. #define DEFAULT_LIMIT_REQUEST_LINE 8190
  410. #endif /* default limit on bytes in Request-Line (Method+URI+HTTP-version) */
  411. #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
  412. #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
  413. #endif /* default limit on bytes in any one header field  */
  414. #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
  415. #define DEFAULT_LIMIT_REQUEST_FIELDS 100
  416. #endif /* default limit on number of request header fields */
  417.  
  418. /*
  419.  * The default default character set name to add if AddDefaultCharset is 
  420.  * enabled.  Overridden with AddDefaultCharsetName.
  421.  */
  422. #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
  423.  
  424. /*
  425.  * The below defines the base string of the Server: header. Additional
  426.  * tokens can be added via the ap_add_version_component() API call.
  427.  *
  428.  * The tokens are listed in order of their significance for identifying the
  429.  * application.
  430.  *
  431.  * "Product tokens should be short and to the point -- use of them for 
  432.  * advertizing or other non-essential information is explicitly forbidden."
  433.  *
  434.  * Example: "Apache/1.1.0 MrWidget/0.1-alpha" 
  435.  */
  436.  
  437. #define SERVER_BASEVENDOR   "Apache Group"
  438. #define SERVER_BASEPRODUCT  "Apache"
  439. #define SERVER_BASEREVISION "1.3.23"
  440. #define SERVER_BASEVERSION  SERVER_BASEPRODUCT "/" SERVER_BASEREVISION
  441.  
  442. #define SERVER_PRODUCT  SERVER_BASEPRODUCT
  443. #define SERVER_REVISION SERVER_BASEREVISION
  444. #define SERVER_VERSION  SERVER_PRODUCT "/" SERVER_REVISION
  445. enum server_token_type {
  446.     SrvTk_MIN,        /* eg: Apache/1.3.0 */
  447.     SrvTk_OS,        /* eg: Apache/1.3.0 (UNIX) */
  448.     SrvTk_FULL,        /* eg: Apache/1.3.0 (UNIX) PHP/3.0 FooBar/1.2b */
  449.     SrvTk_PRODUCT_ONLY    /* eg: Apache */
  450. };
  451.  
  452. API_EXPORT(const char *) ap_get_server_version(void);
  453. API_EXPORT(void) ap_add_version_component(const char *component);
  454. API_EXPORT(const char *) ap_get_server_built(void);
  455.  
  456. /* Numeric release version identifier: MMNNFFRBB: major minor fix final beta
  457.  * Always increases along the same track as the source branch.
  458.  * For example, Apache 1.4.2 would be '10402100', 2.5b7 would be '20500007'.
  459.  */
  460. #define APACHE_RELEASE 10323100
  461.  
  462. #define SERVER_PROTOCOL "HTTP/1.1"
  463. #ifndef SERVER_SUPPORT
  464. #define SERVER_SUPPORT "http://www.apache.org/"
  465. #endif
  466.  
  467. #define DECLINED -1        /* Module declines to handle */
  468. #define DONE -2            /* Module has served the response completely 
  469.                  *  - it's safe to die() with no more output
  470.                  */
  471. #define OK 0            /* Module has handled this stage. */
  472.  
  473.  
  474. /* ----------------------- HTTP Status Codes  ------------------------- */
  475.  
  476. /* The size of the static array in http_protocol.c for storing
  477.  * all of the potential response status-lines (a sparse table).
  478.  * A future version should dynamically generate the table at startup.
  479.  */
  480. #define RESPONSE_CODES 55
  481.  
  482. #define HTTP_CONTINUE                      100
  483. #define HTTP_SWITCHING_PROTOCOLS           101
  484. #define HTTP_PROCESSING                    102
  485. #define HTTP_OK                            200
  486. #define HTTP_CREATED                       201
  487. #define HTTP_ACCEPTED                      202
  488. #define HTTP_NON_AUTHORITATIVE             203
  489. #define HTTP_NO_CONTENT                    204
  490. #define HTTP_RESET_CONTENT                 205
  491. #define HTTP_PARTIAL_CONTENT               206
  492. #define HTTP_MULTI_STATUS                  207
  493. #define HTTP_MULTIPLE_CHOICES              300
  494. #define HTTP_MOVED_PERMANENTLY             301
  495. #define HTTP_MOVED_TEMPORARILY             302
  496. #define HTTP_SEE_OTHER                     303
  497. #define HTTP_NOT_MODIFIED                  304
  498. #define HTTP_USE_PROXY                     305
  499. #define HTTP_TEMPORARY_REDIRECT            307
  500. #define HTTP_BAD_REQUEST                   400
  501. #define HTTP_UNAUTHORIZED                  401
  502. #define HTTP_PAYMENT_REQUIRED              402
  503. #define HTTP_FORBIDDEN                     403
  504. #define HTTP_NOT_FOUND                     404
  505. #define HTTP_METHOD_NOT_ALLOWED            405
  506. #define HTTP_NOT_ACCEPTABLE                406
  507. #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
  508. #define HTTP_REQUEST_TIME_OUT              408
  509. #define HTTP_CONFLICT                      409
  510. #define HTTP_GONE                          410
  511. #define HTTP_LENGTH_REQUIRED               411
  512. #define HTTP_PRECONDITION_FAILED           412
  513. #define HTTP_REQUEST_ENTITY_TOO_LARGE      413
  514. #define HTTP_REQUEST_URI_TOO_LARGE         414
  515. #define HTTP_UNSUPPORTED_MEDIA_TYPE        415
  516. #define HTTP_RANGE_NOT_SATISFIABLE         416
  517. #define HTTP_EXPECTATION_FAILED            417
  518. #define HTTP_UNPROCESSABLE_ENTITY          422
  519. #define HTTP_LOCKED                        423
  520. #define HTTP_FAILED_DEPENDENCY             424
  521. #define HTTP_INTERNAL_SERVER_ERROR         500
  522. #define HTTP_NOT_IMPLEMENTED               501
  523. #define HTTP_BAD_GATEWAY                   502
  524. #define HTTP_SERVICE_UNAVAILABLE           503
  525. #define HTTP_GATEWAY_TIME_OUT              504
  526. #define HTTP_VERSION_NOT_SUPPORTED         505
  527. #define HTTP_VARIANT_ALSO_VARIES           506
  528. #define HTTP_INSUFFICIENT_STORAGE          507
  529. #define HTTP_NOT_EXTENDED                  510
  530.  
  531. #define DOCUMENT_FOLLOWS    HTTP_OK
  532. #define PARTIAL_CONTENT     HTTP_PARTIAL_CONTENT
  533. #define MULTIPLE_CHOICES    HTTP_MULTIPLE_CHOICES
  534. #define MOVED               HTTP_MOVED_PERMANENTLY
  535. #define REDIRECT            HTTP_MOVED_TEMPORARILY
  536. #define USE_LOCAL_COPY      HTTP_NOT_MODIFIED
  537. #define BAD_REQUEST         HTTP_BAD_REQUEST
  538. #define AUTH_REQUIRED       HTTP_UNAUTHORIZED
  539. #define FORBIDDEN           HTTP_FORBIDDEN
  540. #define NOT_FOUND           HTTP_NOT_FOUND
  541. #define METHOD_NOT_ALLOWED  HTTP_METHOD_NOT_ALLOWED
  542. #define NOT_ACCEPTABLE      HTTP_NOT_ACCEPTABLE
  543. #define LENGTH_REQUIRED     HTTP_LENGTH_REQUIRED
  544. #define PRECONDITION_FAILED HTTP_PRECONDITION_FAILED
  545. #define SERVER_ERROR        HTTP_INTERNAL_SERVER_ERROR
  546. #define NOT_IMPLEMENTED     HTTP_NOT_IMPLEMENTED
  547. #define BAD_GATEWAY         HTTP_BAD_GATEWAY
  548. #define VARIANT_ALSO_VARIES HTTP_VARIANT_ALSO_VARIES
  549.  
  550. #define ap_is_HTTP_INFO(x)         (((x) >= 100)&&((x) < 200))
  551. #define ap_is_HTTP_SUCCESS(x)      (((x) >= 200)&&((x) < 300))
  552. #define ap_is_HTTP_REDIRECT(x)     (((x) >= 300)&&((x) < 400))
  553. #define ap_is_HTTP_ERROR(x)        (((x) >= 400)&&((x) < 600))
  554. #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
  555. #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
  556.  
  557. #define ap_status_drops_connection(x) \
  558.                                    (((x) == HTTP_BAD_REQUEST)           || \
  559.                                     ((x) == HTTP_REQUEST_TIME_OUT)      || \
  560.                                     ((x) == HTTP_LENGTH_REQUIRED)       || \
  561.                                     ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
  562.                                     ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
  563.                                     ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
  564.                                     ((x) == HTTP_SERVICE_UNAVAILABLE) || \
  565.                     ((x) == HTTP_NOT_IMPLEMENTED))
  566.  
  567. /* Methods recognized (but not necessarily handled) by the server.
  568.  * These constants are used in bit shifting masks of size int, so it is
  569.  * unsafe to have more methods than bits in an int.  HEAD == M_GET.
  570.  */
  571. #define M_GET        0
  572. #define M_PUT        1
  573. #define M_POST       2
  574. #define M_DELETE     3
  575. #define M_CONNECT    4
  576. #define M_OPTIONS    5
  577. #define M_TRACE      6
  578. #define M_PATCH      7
  579. #define M_PROPFIND   8
  580. #define M_PROPPATCH  9
  581. #define M_MKCOL     10
  582. #define M_COPY      11
  583. #define M_MOVE      12
  584. #define M_LOCK      13
  585. #define M_UNLOCK    14
  586. #define M_INVALID   15
  587.  
  588. #define METHODS     16
  589.  
  590. #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
  591. #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
  592. #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
  593. #ifdef CHARSET_EBCDIC
  594. #define ASCIITEXT_MAGIC_TYPE_PREFIX "text/x-ascii-" /* Text files whose content-type starts with this are passed thru unconverted */
  595. #endif /*CHARSET_EBCDIC*/
  596. #define MAP_FILE_MAGIC_TYPE "application/x-type-map"
  597. #define ASIS_MAGIC_TYPE "httpd/send-as-is"
  598. #define DIR_MAGIC_TYPE "httpd/unix-directory"
  599. #define STATUS_MAGIC_TYPE "application/x-httpd-status"
  600.  
  601. /*
  602.  * Define the HTML doctype strings centrally.
  603.  */
  604. #define DOCTYPE_HTML_2_0  "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
  605.                           "DTD HTML 2.0//EN\">\n"
  606. #define DOCTYPE_HTML_3_2  "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  607.                           "DTD HTML 3.2 Final//EN\">\n"
  608. #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  609.                           "DTD HTML 4.0//EN\"\n" \
  610.                           "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
  611. #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  612.                           "DTD HTML 4.0 Transitional//EN\"\n" \
  613.                           "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
  614. #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  615.                           "DTD HTML 4.0 Frameset//EN\"\n" \
  616.                           "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
  617.  
  618. /* Just in case your linefeed isn't the one the other end is expecting. */
  619. #ifndef CHARSET_EBCDIC
  620. #define LF 10
  621. #define CR 13
  622. #define CRLF "\015\012"
  623. #define OS_ASC(c) (c)
  624. #else /* CHARSET_EBCDIC */
  625. #include "ap_ebcdic.h"
  626. /* OSD_POSIX uses the EBCDIC charset. The transition ASCII->EBCDIC is done in
  627.  * the buff package (bread/bputs/bwrite), so everywhere else, we use
  628.  * "native EBCDIC" CR and NL characters. These are therefore defined as
  629.  * '\r' and '\n'.
  630.  * NB: this is not the whole truth - sometimes \015 and \012 are contained
  631.  * in literal (EBCDIC!) strings, so these are not converted but passed.
  632.  */
  633. #define CR '\r'
  634. #define LF '\n'
  635. #define CRLF "\r\n"
  636. #define OS_ASC(c) (os_toascii[c])
  637. #endif /* CHARSET_EBCDIC */
  638.  
  639. /* Possible values for request_rec.read_body (set by handling module):
  640.  *    REQUEST_NO_BODY          Send 413 error if message has any body
  641.  *    REQUEST_CHUNKED_ERROR    Send 411 error if body without Content-Length
  642.  *    REQUEST_CHUNKED_DECHUNK  If chunked, remove the chunks for me.
  643.  *    REQUEST_CHUNKED_PASS     Pass the chunks to me without removal.
  644.  */
  645. #define REQUEST_NO_BODY          0
  646. #define REQUEST_CHUNKED_ERROR    1
  647. #define REQUEST_CHUNKED_DECHUNK  2
  648. #define REQUEST_CHUNKED_PASS     3
  649.  
  650. /* Things which may vary per file-lookup WITHIN a request ---
  651.  * e.g., state of MIME config.  Basically, the name of an object, info
  652.  * about the object, and any other info we may ahve which may need to
  653.  * change as we go poking around looking for it (e.g., overridden by
  654.  * .htaccess files).
  655.  *
  656.  * Note how the default state of almost all these things is properly
  657.  * zero, so that allocating it with pcalloc does the right thing without
  658.  * a whole lot of hairy initialization... so long as we are willing to
  659.  * make the (fairly) portable assumption that the bit pattern of a NULL
  660.  * pointer is, in fact, zero.
  661.  */
  662.  
  663. /* This represents the result of calling htaccess; these are cached for
  664.  * each request.
  665.  */
  666. struct htaccess_result {
  667.     char *dir;            /* the directory to which this applies */
  668.     int override;        /* the overrides allowed for the .htaccess file */
  669.     void *htaccess;        /* the configuration directives */
  670. /* the next one, or NULL if no more; N.B. never change this */
  671.     const struct htaccess_result *next;
  672. };
  673.  
  674. typedef struct conn_rec conn_rec;
  675. typedef struct server_rec server_rec;
  676. typedef struct request_rec request_rec;
  677. typedef struct listen_rec listen_rec;
  678.  
  679. #include "util_uri.h"
  680.  
  681. enum proxyreqtype {
  682.     NOT_PROXY=0,
  683.     STD_PROXY,
  684.     PROXY_PASS
  685. };
  686.  
  687. struct request_rec {
  688.  
  689.     ap_pool *pool;
  690.     conn_rec *connection;
  691.     server_rec *server;
  692.  
  693.     request_rec *next;        /* If we wind up getting redirected,
  694.                  * pointer to the request we redirected to.
  695.                  */
  696.     request_rec *prev;        /* If this is an internal redirect,
  697.                  * pointer to where we redirected *from*.
  698.                  */
  699.  
  700.     request_rec *main;        /* If this is a sub_request (see request.h) 
  701.                  * pointer back to the main request.
  702.                  */
  703.  
  704.     /* Info about the request itself... we begin with stuff that only
  705.      * protocol.c should ever touch...
  706.      */
  707.  
  708.     char *the_request;        /* First line of request, so we can log it */
  709.     int assbackwards;        /* HTTP/0.9, "simple" request */
  710.     enum proxyreqtype proxyreq;/* A proxy request (calculated during
  711.                  * post_read_request or translate_name) */
  712.     int header_only;        /* HEAD request, as opposed to GET */
  713.     char *protocol;        /* Protocol, as given to us, or HTTP/0.9 */
  714.     int proto_num;        /* Number version of protocol; 1.1 = 1001 */
  715.     const char *hostname;    /* Host, as set by full URI or Host: */
  716.  
  717.     time_t request_time;    /* When the request started */
  718.  
  719.     const char *status_line;    /* Status line, if set by script */
  720.     int status;            /* In any case */
  721.  
  722.     /* Request method, two ways; also, protocol, etc..  Outside of protocol.c,
  723.      * look, but don't touch.
  724.      */
  725.  
  726.     const char *method;        /* GET, HEAD, POST, etc. */
  727.     int method_number;        /* M_GET, M_POST, etc. */
  728.  
  729.     /*
  730.     allowed is a bitvector of the allowed methods.
  731.  
  732.     A handler must ensure that the request method is one that
  733.     it is capable of handling.  Generally modules should DECLINE
  734.     any request methods they do not handle.  Prior to aborting the
  735.     handler like this the handler should set r->allowed to the list
  736.     of methods that it is willing to handle.  This bitvector is used
  737.     to construct the "Allow:" header required for OPTIONS requests,
  738.     and METHOD_NOT_ALLOWED and NOT_IMPLEMENTED status codes.
  739.  
  740.     Since the default_handler deals with OPTIONS, all modules can
  741.     usually decline to deal with OPTIONS.  TRACE is always allowed,
  742.     modules don't need to set it explicitly.
  743.  
  744.     Since the default_handler will always handle a GET, a
  745.     module which does *not* implement GET should probably return
  746.     METHOD_NOT_ALLOWED.  Unfortunately this means that a Script GET
  747.     handler can't be installed by mod_actions.
  748.     */
  749.     int allowed;        /* Allowed methods - for 405, OPTIONS, etc */
  750.  
  751.     int sent_bodyct;        /* byte count in stream is for body */
  752.     long bytes_sent;        /* body byte count, for easy access */
  753.     time_t mtime;        /* Time the resource was last modified */
  754.  
  755.     /* HTTP/1.1 connection-level features */
  756.  
  757.     int chunked;        /* sending chunked transfer-coding */
  758.     int byterange;        /* number of byte ranges */
  759.     char *boundary;        /* multipart/byteranges boundary */
  760.     const char *range;        /* The Range: header */
  761.     long clength;        /* The "real" content length */
  762.  
  763.     long remaining;        /* bytes left to read */
  764.     long read_length;        /* bytes that have been read */
  765.     int read_body;        /* how the request body should be read */
  766.     int read_chunked;        /* reading chunked transfer-coding */
  767.     unsigned expecting_100;    /* is client waiting for a 100 response? */
  768.  
  769.     /* MIME header environments, in and out.  Also, an array containing
  770.      * environment variables to be passed to subprocesses, so people can
  771.      * write modules to add to that environment.
  772.      *
  773.      * The difference between headers_out and err_headers_out is that the
  774.      * latter are printed even on error, and persist across internal redirects
  775.      * (so the headers printed for ErrorDocument handlers will have them).
  776.      *
  777.      * The 'notes' table is for notes from one module to another, with no
  778.      * other set purpose in mind...
  779.      */
  780.  
  781.     table *headers_in;
  782.     table *headers_out;
  783.     table *err_headers_out;
  784.     table *subprocess_env;
  785.     table *notes;
  786.  
  787.     /* content_type, handler, content_encoding, content_language, and all
  788.      * content_languages MUST be lowercased strings.  They may be pointers
  789.      * to static strings; they should not be modified in place.
  790.      */
  791.     const char *content_type;    /* Break these out --- we dispatch on 'em */
  792.     const char *handler;    /* What we *really* dispatch on           */
  793.  
  794.     const char *content_encoding;
  795.     const char *content_language;    /* for back-compat. only -- do not use */
  796.     array_header *content_languages;    /* array of (char*) */
  797.  
  798.     char *vlist_validator;      /* variant list validator (if negotiated) */
  799.  
  800.     int no_cache;
  801.     int no_local_copy;
  802.  
  803.     /* What object is being requested (either directly, or via include
  804.      * or content-negotiation mapping).
  805.      */
  806.  
  807.     char *unparsed_uri;        /* the uri without any parsing performed */
  808.     char *uri;            /* the path portion of the URI */
  809.     char *filename;        /* filename if found, otherwise NULL */
  810.     char *path_info;
  811.     char *args;            /* QUERY_ARGS, if any */
  812.     struct stat finfo;        /* ST_MODE set to zero if no such file */
  813.     uri_components parsed_uri;    /* components of uri, dismantled */
  814.  
  815.     /* Various other config info which may change with .htaccess files
  816.      * These are config vectors, with one void* pointer for each module
  817.      * (the thing pointed to being the module's business).
  818.      */
  819.  
  820.     void *per_dir_config;    /* Options set in config files, etc. */
  821.     void *request_config;    /* Notes on *this* request */
  822.  
  823. /*
  824.  * a linked list of the configuration directives in the .htaccess files
  825.  * accessed by this request.
  826.  * N.B. always add to the head of the list, _never_ to the end.
  827.  * that way, a sub request's list can (temporarily) point to a parent's list
  828.  */
  829.     const struct htaccess_result *htaccess;
  830.  
  831.     /* On systems with case insensitive file systems (Windows, OS/2, etc.), 
  832.      * r->filename is case canonicalized (folded to either lower or upper 
  833.      * case, depending on the specific system) to accomodate file access
  834.      * checking. case_preserved_filename is the same as r->filename 
  835.      * except case is preserved. There is at least one instance where Apache 
  836.      * needs access to the case preserved filename: Java class files published 
  837.      * with WebDAV need to preserve filename case to make the Java compiler 
  838.      * happy.
  839.      */
  840.     char *case_preserved_filename;
  841.  
  842. #ifdef CHARSET_EBCDIC
  843.     /* We don't want subrequests to modify our current conversion flags.
  844.      * These flags save the state of the conversion flags when subrequests
  845.      * are run.
  846.      */
  847.     struct {
  848.         unsigned conv_in:1;    /* convert ASCII->EBCDIC when read()ing? */
  849.         unsigned conv_out:1;   /* convert EBCDIC->ASCII when write()ing? */
  850.     } ebcdic;
  851. #endif
  852.  
  853. /* Things placed at the end of the record to avoid breaking binary
  854.  * compatibility.  It would be nice to remember to reorder the entire
  855.  * record to improve 64bit alignment the next time we need to break
  856.  * binary compatibility for some other reason.
  857.  */
  858. };
  859.  
  860.  
  861. /* Things which are per connection
  862.  */
  863.  
  864. struct conn_rec {
  865.  
  866.     ap_pool *pool;
  867.     server_rec *server;
  868.     server_rec *base_server;    /* Physical vhost this conn come in on */
  869.     void *vhost_lookup_data;    /* used by http_vhost.c */
  870.  
  871.     /* Information about the connection itself */
  872.  
  873.     int child_num;        /* The number of the child handling conn_rec */
  874.     BUFF *client;        /* Connection to the guy */
  875.  
  876.     /* Who is the client? */
  877.  
  878.     struct sockaddr_in local_addr;    /* local address */
  879.     struct sockaddr_in remote_addr;    /* remote address */
  880.     char *remote_ip;        /* Client's IP address */
  881.     char *remote_host;        /* Client's DNS name, if known.
  882.                  * NULL if DNS hasn't been checked,
  883.                  * "" if it has and no address was found.
  884.                  * N.B. Only access this though
  885.                  * get_remote_host() */
  886.     char *remote_logname;    /* Only ever set if doing rfc1413 lookups.
  887.                  * N.B. Only access this through
  888.                  * get_remote_logname() */
  889.     char *user;            /* If an authentication check was made,
  890.                  * this gets set to the user name.  We assume
  891.                  * that there's only one user per connection(!)
  892.                  */
  893.     char *ap_auth_type;        /* Ditto. */
  894.  
  895.     unsigned aborted:1;        /* Are we still talking? */
  896.     signed int keepalive:2;    /* Are we using HTTP Keep-Alive?
  897.                  * -1 fatal error, 0 undecided, 1 yes */
  898.     unsigned keptalive:1;    /* Did we use HTTP Keep-Alive? */
  899.     signed int double_reverse:2;/* have we done double-reverse DNS?
  900.                  * -1 yes/failure, 0 not yet, 1 yes/success */
  901.     int keepalives;        /* How many times have we used it? */
  902.     char *local_ip;        /* server IP address */
  903.     char *local_host;        /* used for ap_get_server_name when
  904.                  * UseCanonicalName is set to DNS
  905.                  * (ignores setting of HostnameLookups) */
  906. };
  907.  
  908. /* Per-vhost config... */
  909.  
  910. /* The address 255.255.255.255, when used as a virtualhost address,
  911.  * will become the "default" server when the ip doesn't match other vhosts.
  912.  */
  913. #define DEFAULT_VHOST_ADDR 0xfffffffful
  914.  
  915. typedef struct server_addr_rec server_addr_rec;
  916. struct server_addr_rec {
  917.     server_addr_rec *next;
  918.     struct in_addr host_addr;    /* The bound address, for this server */
  919.     unsigned short host_port;    /* The bound port, for this server */
  920.     char *virthost;        /* The name given in <VirtualHost> */
  921. };
  922.  
  923. struct server_rec {
  924.  
  925.     server_rec *next;
  926.  
  927.     /* description of where the definition came from */
  928.     const char *defn_name;
  929.     unsigned defn_line_number;
  930.  
  931.     /* Full locations of server config info */
  932.  
  933.     char *srm_confname;
  934.     char *access_confname;
  935.  
  936.     /* Contact information */
  937.  
  938.     char *server_admin;
  939.     char *server_hostname;
  940.     unsigned short port;    /* for redirects, etc. */
  941.  
  942.     /* Log files --- note that transfer log is now in the modules... */
  943.  
  944.     char *error_fname;
  945.     FILE *error_log;
  946.     int loglevel;
  947.  
  948.     /* Module-specific configuration for server, and defaults... */
  949.  
  950.     int is_virtual;        /* true if this is the virtual server */
  951.     void *module_config;    /* Config vector containing pointers to
  952.                  * modules' per-server config structures.
  953.                  */
  954.     void *lookup_defaults;    /* MIME type info, etc., before we start
  955.                  * checking per-directory info.
  956.                  */
  957.     /* Transaction handling */
  958.  
  959.     server_addr_rec *addrs;
  960.     int timeout;        /* Timeout, in seconds, before we give up */
  961.     int keep_alive_timeout;    /* Seconds we'll wait for another request */
  962.     int keep_alive_max;        /* Maximum requests per connection */
  963.     int keep_alive;        /* Use persistent connections? */
  964.     int send_buffer_size;    /* size of TCP send buffer (in bytes) */
  965.  
  966.     char *path;            /* Pathname for ServerPath */
  967.     int pathlen;        /* Length of path */
  968.  
  969.     array_header *names;    /* Normal names for ServerAlias servers */
  970.     array_header *wild_names;    /* Wildcarded names for ServerAlias servers */
  971.  
  972.     uid_t server_uid;        /* effective user id when calling exec wrapper */
  973.     gid_t server_gid;        /* effective group id when calling exec wrapper */
  974.  
  975.     int limit_req_line;      /* limit on size of the HTTP request line    */
  976.     int limit_req_fieldsize; /* limit on size of any request header field */
  977.     int limit_req_fields;    /* limit on number of request header fields  */
  978. };
  979.  
  980. /* These are more like real hosts than virtual hosts */
  981. struct listen_rec {
  982.     listen_rec *next;
  983.     struct sockaddr_in local_addr;    /* local IP address and port */
  984.     int fd;
  985.     int used;            /* Only used during restart */        
  986. /* more stuff here, like which protocol is bound to the port */
  987. };
  988.  
  989. /* Prototypes for utilities... util.c.
  990.  */
  991.  
  992. extern void ap_util_init(void);
  993.  
  994. /* Time */
  995. extern API_VAR_EXPORT const char ap_month_snames[12][4];
  996. extern API_VAR_EXPORT const char ap_day_snames[7][4];
  997.  
  998. API_EXPORT(struct tm *) ap_get_gmtoff(int *tz);
  999. API_EXPORT(char *) ap_get_time(void);
  1000. API_EXPORT(char *) ap_field_noparam(pool *p, const char *intype);
  1001. API_EXPORT(char *) ap_ht_time(pool *p, time_t t, const char *fmt, int gmt);
  1002. API_EXPORT(char *) ap_gm_timestr_822(pool *p, time_t t);
  1003.  
  1004. /* String handling. The *_nc variants allow you to use non-const char **s as
  1005.    arguments (unfortunately C won't automatically convert a char ** to a const
  1006.    char **) */
  1007.  
  1008. API_EXPORT(char *) ap_getword(pool *p, const char **line, char stop);
  1009. API_EXPORT(char *) ap_getword_nc(pool *p, char **line, char stop);
  1010. API_EXPORT(char *) ap_getword_white(pool *p, const char **line);
  1011. API_EXPORT(char *) ap_getword_white_nc(pool *p, char **line);
  1012. API_EXPORT(char *) ap_getword_nulls(pool *p, const char **line, char stop);
  1013. API_EXPORT(char *) ap_getword_nulls_nc(pool *p, char **line, char stop);
  1014. API_EXPORT(char *) ap_getword_conf(pool *p, const char **line);
  1015. API_EXPORT(char *) ap_getword_conf_nc(pool *p, char **line);
  1016.  
  1017. API_EXPORT(const char *) ap_size_list_item(const char **field, int *len);
  1018. API_EXPORT(char *) ap_get_list_item(pool *p, const char **field);
  1019. API_EXPORT(int) ap_find_list_item(pool *p, const char *line, const char *tok);
  1020.  
  1021. API_EXPORT(char *) ap_get_token(pool *p, const char **accept_line, int accept_white);
  1022. API_EXPORT(int) ap_find_token(pool *p, const char *line, const char *tok);
  1023. API_EXPORT(int) ap_find_last_token(pool *p, const char *line, const char *tok);
  1024.  
  1025. API_EXPORT(int) ap_is_url(const char *u);
  1026. API_EXPORT(int) ap_unescape_url(char *url);
  1027. API_EXPORT(void) ap_no2slash(char *name);
  1028. API_EXPORT(void) ap_getparents(char *name);
  1029. API_EXPORT(char *) ap_escape_path_segment(pool *p, const char *s);
  1030. API_EXPORT(char *) ap_os_escape_path(pool *p, const char *path, int partial);
  1031. #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
  1032. API_EXPORT(char *) ap_escape_html(pool *p, const char *s);
  1033. API_EXPORT(char *) ap_construct_server(pool *p, const char *hostname,
  1034.                     unsigned port, const request_rec *r);
  1035. API_EXPORT(char *) ap_escape_shell_cmd(pool *p, const char *s);
  1036.  
  1037. API_EXPORT(int) ap_count_dirs(const char *path);
  1038. API_EXPORT(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
  1039. API_EXPORT(char *) ap_make_dirstr_parent(pool *p, const char *s);
  1040. /* deprecated.  The previous two routines are preferred. */
  1041. API_EXPORT(char *) ap_make_dirstr(pool *a, const char *s, int n);
  1042. API_EXPORT(char *) ap_make_full_path(pool *a, const char *dir, const char *f);
  1043.  
  1044. API_EXPORT(int) ap_is_matchexp(const char *str);
  1045. API_EXPORT(int) ap_strcmp_match(const char *str, const char *exp);
  1046. API_EXPORT(int) ap_strcasecmp_match(const char *str, const char *exp);
  1047. API_EXPORT(char *) ap_stripprefix(const char *bigstring, const char *prefix);
  1048. API_EXPORT(char *) ap_strcasestr(const char *s1, const char *s2);
  1049. API_EXPORT(char *) ap_pbase64decode(pool *p, const char *bufcoded);
  1050. API_EXPORT(char *) ap_pbase64encode(pool *p, char *string); 
  1051. API_EXPORT(char *) ap_uudecode(pool *p, const char *bufcoded);
  1052. API_EXPORT(char *) ap_uuencode(pool *p, char *string); 
  1053.  
  1054. #ifdef OS2
  1055. void os2pathname(char *path);
  1056. char *ap_double_quotes(pool *p, char *str);
  1057. #endif
  1058.  
  1059. API_EXPORT(int)    ap_regexec(const regex_t *preg, const char *string,
  1060.                               size_t nmatch, regmatch_t pmatch[], int eflags);
  1061. API_EXPORT(size_t) ap_regerror(int errcode, const regex_t *preg, 
  1062.                                char *errbuf, size_t errbuf_size);
  1063. API_EXPORT(char *) ap_pregsub(pool *p, const char *input, const char *source,
  1064.                               size_t nmatch, regmatch_t pmatch[]);
  1065.  
  1066. API_EXPORT(void) ap_content_type_tolower(char *);
  1067. API_EXPORT(void) ap_str_tolower(char *);
  1068. API_EXPORT(int) ap_ind(const char *, char);    /* Sigh... */
  1069. API_EXPORT(int) ap_rind(const char *, char);
  1070.  
  1071. API_EXPORT(char *) ap_escape_quotes (pool *p, const char *instring);
  1072. API_EXPORT(void) ap_remove_spaces(char *dest, char *src);
  1073.  
  1074. /* Common structure for reading of config files / passwd files etc. */
  1075. typedef struct {
  1076.     int (*getch) (void *param);    /* a getc()-like function */
  1077.     void *(*getstr) (void *buf, size_t bufsiz, void *param); /* a fgets()-like function */
  1078.     int (*close) (void *param);    /* a close hander function */
  1079.     void *param;        /* the argument passed to getch/getstr/close */
  1080.     const char *name;        /* the filename / description */
  1081.     unsigned line_number;    /* current line number, starting at 1 */
  1082. } configfile_t;
  1083.  
  1084. /* Open a configfile_t as FILE, return open configfile_t struct pointer */
  1085. API_EXPORT(configfile_t *) ap_pcfg_openfile(pool *p, const char *name);
  1086.  
  1087. /* Allocate a configfile_t handle with user defined functions and params */
  1088. API_EXPORT(configfile_t *) ap_pcfg_open_custom(pool *p, const char *descr,
  1089.     void *param,
  1090.     int(*getc_func)(void*),
  1091.     void *(*gets_func) (void *buf, size_t bufsiz, void *param),
  1092.     int(*close_func)(void *param));
  1093.  
  1094. /* Read one line from open configfile_t, strip LF, increase line number */
  1095. API_EXPORT(int) ap_cfg_getline(char *buf, size_t bufsize, configfile_t *cfp);
  1096.  
  1097. /* Read one char from open configfile_t, increase line number upon LF */
  1098. API_EXPORT(int) ap_cfg_getc(configfile_t *cfp);
  1099.  
  1100. /* Detach from open configfile_t, calling the close handler */
  1101. API_EXPORT(int) ap_cfg_closefile(configfile_t *cfp);
  1102.  
  1103. #ifdef NEED_STRERROR
  1104. char *strerror(int err);
  1105. #endif
  1106.  
  1107. /* Misc system hackery */
  1108.  
  1109. API_EXPORT(uid_t) ap_uname2id(const char *name);
  1110. API_EXPORT(gid_t) ap_gname2id(const char *name);
  1111. API_EXPORT(int) ap_is_directory(const char *name);
  1112. API_EXPORT(int) ap_is_rdirectory(const char *name);
  1113. API_EXPORT(int) ap_can_exec(const struct stat *);
  1114. API_EXPORT(void) ap_chdir_file(const char *file);
  1115.  
  1116. #ifndef HAVE_CANONICAL_FILENAME
  1117. /*
  1118.  *  We can't define these in os.h because of dependence on pool pointer.
  1119.  */
  1120. #define ap_os_canonical_filename(p,f)  (f)
  1121. #define ap_os_case_canonical_filename(p,f)  (f)
  1122. #define ap_os_systemcase_filename(p,f)  (f)
  1123. #else
  1124. API_EXPORT(char *) ap_os_canonical_filename(pool *p, const char *file);
  1125. #ifdef WIN32
  1126. API_EXPORT(char *) ap_os_case_canonical_filename(pool *pPool, const char *szFile);
  1127. API_EXPORT(char *) ap_os_systemcase_filename(pool *pPool, const char *szFile);
  1128. #elif defined(OS2)
  1129. API_EXPORT(char *) ap_os_case_canonical_filename(pool *pPool, const char *szFile);
  1130. API_EXPORT(char *) ap_os_systemcase_filename(pool *pPool, const char *szFile);
  1131. #else
  1132. #define ap_os_case_canonical_filename(p,f) ap_os_canonical_filename(p,f)
  1133. #define ap_os_systemcase_filename(p,f) ap_os_canonical_filename(p,f)
  1134. #endif
  1135. #endif
  1136.  
  1137. #ifdef CHARSET_EBCDIC
  1138. API_EXPORT(int)    ap_checkconv(struct request_rec *r);    /* for downloads */
  1139. API_EXPORT(int)    ap_checkconv_in(struct request_rec *r); /* for uploads */
  1140. #endif /*#ifdef CHARSET_EBCDIC*/
  1141.  
  1142. API_EXPORT(char *) ap_get_local_host(pool *);
  1143. API_EXPORT(unsigned long) ap_get_virthost_addr(char *hostname, unsigned short *port);
  1144.  
  1145. extern API_VAR_EXPORT time_t ap_restart_time;
  1146.  
  1147. /*
  1148.  * Apache tries to keep all of its long term filehandles (such as log files,
  1149.  * and sockets) above this number.  This is to workaround problems in many
  1150.  * third party libraries that are compiled with a small FD_SETSIZE.  There
  1151.  * should be no reason to lower this, because it's only advisory.  If a file
  1152.  * can't be allocated above this number then it will remain in the "slack"
  1153.  * area.
  1154.  *
  1155.  * Only the low slack line is used by default.  If HIGH_SLACK_LINE is defined
  1156.  * then an attempt is also made to keep all non-FILE * files above the high
  1157.  * slack line.  This is to work around a Solaris C library limitation, where it
  1158.  * uses an unsigned char to store the file descriptor.
  1159.  */
  1160. #ifndef LOW_SLACK_LINE
  1161. #define LOW_SLACK_LINE    15
  1162. #endif
  1163. /* #define HIGH_SLACK_LINE      255 */
  1164.  
  1165. /*
  1166.  * The ap_slack() function takes a fd, and tries to move it above the indicated
  1167.  * line.  It returns an fd which may or may not have moved above the line, and
  1168.  * never fails.  If the high line was requested and it fails it will also try
  1169.  * the low line.
  1170.  */
  1171. #ifdef NO_SLACK
  1172. #define ap_slack(fd,line)   (fd)
  1173. #else
  1174. int ap_slack(int fd, int line);
  1175. #define AP_SLACK_LOW    1
  1176. #define AP_SLACK_HIGH    2
  1177. #endif
  1178.  
  1179. API_EXPORT(char *) ap_escape_quotes(pool *p, const char *instr);
  1180.  
  1181. /*
  1182.  * Redefine assert() to something more useful for an Apache...
  1183.  */
  1184. API_EXPORT(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
  1185.                 __attribute__((noreturn));
  1186. #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
  1187.  
  1188. /* The optimized timeout code only works if we're not MULTITHREAD and we're
  1189.  * also not using a scoreboard file
  1190.  */
  1191. #if !defined (MULTITHREAD) && \
  1192.     (defined (USE_MMAP_SCOREBOARD) || defined (USE_SHMGET_SCOREBOARD))
  1193. #define OPTIMIZE_TIMEOUTS
  1194. #endif
  1195.  
  1196. /* A set of flags which indicate places where the server should raise(SIGSTOP).
  1197.  * This is useful for debugging, because you can then attach to that process
  1198.  * with gdb and continue.  This is important in cases where one_process
  1199.  * debugging isn't possible.
  1200.  */
  1201. #define SIGSTOP_DETACH            1
  1202. #define SIGSTOP_MAKE_CHILD        2
  1203. #define SIGSTOP_SPAWN_CHILD        4
  1204. #define SIGSTOP_PIPED_LOG_SPAWN        8
  1205. #define SIGSTOP_CGI_CHILD        16
  1206.  
  1207. #ifdef DEBUG_SIGSTOP
  1208. extern int raise_sigstop_flags;
  1209. #define RAISE_SIGSTOP(x)    do { \
  1210.     if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
  1211.     } while (0)
  1212. #else
  1213. #define RAISE_SIGSTOP(x)
  1214. #endif
  1215.  
  1216. API_EXPORT(extern const char *) ap_psignature(const char *prefix, request_rec *r);
  1217.  
  1218. /* strtoul does not exist on sunos4. */
  1219. #ifdef strtoul
  1220. #undef strtoul
  1221. #endif
  1222. #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
  1223.  
  1224. #ifdef __cplusplus
  1225. }
  1226. #endif
  1227.  
  1228. #endif    /* !APACHE_HTTPD_H */
  1229.