freepascal.compiler/packages/base/httpd/httpd-2.0/http_config.inc

{ Copyright 1999-2005 The Apache Software Foundation or its licensors, as
 * applicable.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 }

{
  Declarations from other files centered here
}
const
  (* Hook orderings *)
  (** run this hook first, before ANYTHING *)
  APR_HOOK_REALLY_FIRST	= -10;
  (** run this hook first *)
  APR_HOOK_FIRST	= 0;
  (** run this hook somewhere *)
  APR_HOOK_MIDDLE	= 10;
  (** run this hook after every other hook which is defined*)
  APR_HOOK_LAST		= 20;
  (** run this hook last, after EVERYTHING *)
  APR_HOOK_REALLY_LAST	= 30;


//#include "apr_hooks.h"
{.$include util_cfgtree.inc}

{
 * @file http_config.h
 * @brief Apache Configuration
 }

{
 * @defgroup ConfigDirectives Allowed locations for configuration directives.
 *
 * The allowed locations for a configuration directive are the union of
 * those indicated by each set bit in the req_override mask.
 }
const
  OR_NONE = 0;            {< *.conf is not available anywhere in this override }
  OR_LIMIT = 1;	          {< *.conf inside <Directory> or <Location>
				and .htaccess when AllowOverride Limit }
  OR_OPTIONS = 2;         {< *.conf anywhere
                                and .htaccess when AllowOverride Options }
  OR_FILEINFO = 4;        {< *.conf anywhere
				and .htaccess when AllowOverride FileInfo }
  OR_AUTHCFG = 8;         {< *.conf inside <Directory> or <Location>
				and .htaccess when AllowOverride AuthConfig }
  OR_INDEXES = 16;        {< *.conf anywhere
				and .htaccess when AllowOverride Indexes }
  OR_UNSET = 32;          {< unset a directive (in Allow) }
  ACCESS_CONF = 64;       {< *.conf inside <Directory> or <Location> }
  RSRC_CONF = 128;	     {< *.conf outside <Directory> or <Location> }
  EXEC_ON_READ = 256;     {< force directive to execute a command
                which would modify the configuration (like including another
                file, or IFModule }
{ this directive can be placed anywhere }
  OR_ALL = (OR_LIMIT or OR_OPTIONS or OR_FILEINFO or OR_AUTHCFG or OR_INDEXES);

{
 * This can be returned by a function if they don't wish to handle
 * a command. Make it something not likely someone will actually use
 * as an error code.
 }
const
  DECLINE_CMD = '\a\b';

{
 * The central data structures around here...
}

{ Command dispatch structures... }

{
 * How the directives arguments should be parsed.
 * @remark Note that for all of these except RAW_ARGS, the config routine is
 *      passed a freshly allocated string which can be modified or stored
 *      or whatever...
 }
type
  cmd_how = (
    RAW_ARGS,			{< cmd_func parses command line itself }
    TAKE1,			{< one argument only }
    TAKE2,			{< two arguments only }
    ITERATE,			{< one argument, occuring multiple times
				 * (e.g., IndexIgnore)
                                 }
    ITERATE2,			{< two arguments, 2nd occurs multiple times
				 * (e.g., AddIcon)
                                 }
    FLAG,			{< One of 'On' or 'Off' }
    NO_ARGS,			{< No args at all, e.g. </Directory> }
    TAKE12,			{< one or two arguments }
    TAKE3,			{< three arguments only }
    TAKE23,			{< two or three arguments }
    TAKE123,			{< one, two or three arguments }
    TAKE13			{< one or three arguments }
  );

{
 * This structure is passed to a command which is being invoked,
 * to carry a large variety of miscellaneous data which is all of
 * use to *somebody*...
 }
  Pcmd_parms = ^cmd_parms_struct;
  
//#if defined(AP_HAVE_DESIGNATED_INITIALIZER) || defined(DOXYGEN)

{
 * All the types of functions that can be used in directives
 * @internal
 }
  cmd_func = function(cmd: Pcmd_parms; mconfig: Pointer): PChar; cdecl;
  Pcmd_func = ^cmd_func;

  { function to call for a no-args }
  no_args_t = function (parms: Pcmd_parms; mconfig: Pointer): PChar;
  { function to call for a raw-args }
  raw_args_t = function (parms: Pcmd_parms; mconfig: Pointer; const args: PChar): Pchar;
  { function to call for a take1 }
  take1_t = function (parms: Pcmd_parms; mconfig: Pointer; const w: PChar): PChar;
  { function to call for a take2 }
  take2_t = function (parms: Pcmd_parms; mconfig: Pointer; const w, w2: PChar): PChar;
  { function to call for a take3 }
  take3_t = function (parms: Pcmd_parms; mconfig: Pointer; const w, w2, w3: PChar): PChar;
  { function to call for a flag }
  flag_t = function (parms: Pcmd_parms; mconfig: Pointer; on_: Integer): PChar;

//const
  { This configuration directive does not take any arguments }
//  AP_NO_ARGS =	func.no_args;
  { This configuration directive will handle it's own parsing of arguments}
//  AP_RAW_ARGS =	func.raw_args;
  { This configuration directive takes 1 argument}
//  AP_TAKE1 =	func.take1;
  { This configuration directive takes 2 arguments }
//  AP_TAKE2 =	func.take2;
  { This configuration directive takes 3 arguments }
//  AP_TAKE3 =	func.take3;
  { This configuration directive takes a flag (on/off) as a argument}
//  AP_FLAG =	func.flag;

{ method of declaring a directive with no arguments }
//# define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
    // directive, { .no_args=func }, mconfig, where, RAW_ARGS, help }
{ method of declaring a directive with raw argument parsing }
//# define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
    // directive, { .raw_args=func }, mconfig, where, RAW_ARGS, help }
{ method of declaring a directive which takes 1 argument }
//# define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
    // directive, { .take1=func }, mconfig, where, TAKE1, help }
{ method of declaring a directive which takes multiple arguments }
//# define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
    // directive, { .take1=func }, mconfig, where, ITERATE, help }
{ method of declaring a directive which takes 2 arguments }
//# define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
    // directive, { .take2=func }, mconfig, where, TAKE2, help }
{ method of declaring a directive which takes 1 or 2 arguments }
//# define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
    // directive, { .take2=func }, mconfig, where, TAKE12, help }
{ method of declaring a directive which takes multiple 2 arguments }
//# define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
    // directive, { .take2=func }, mconfig, where, ITERATE2, help }
{ method of declaring a directive which takes 1 or 3 arguments }
//# define AP_INIT_TAKE13(directive, func, mconfig, where, help) \
    // directive, { .take3=func }, mconfig, where, TAKE13, help }
{ method of declaring a directive which takes 2 or 3 arguments }
//# define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
    // directive, { .take3=func }, mconfig, where, TAKE23, help }
{ method of declaring a directive which takes 1 to 3 arguments }
//# define AP_INIT_TAKE123(directive, func, mconfig, where, help) \
    // directive, { .take3=func }, mconfig, where, TAKE123, help }
{ method of declaring a directive which takes 3 arguments }
//# define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
    // directive, { .take3=func }, mconfig, where, TAKE3, help }
{ method of declaring a directive which takes a flag (on/off) as a argument}
//# define AP_INIT_FLAG(directive, func, mconfig, where, help) \
    // directive, { .flag=func }, mconfig, where, FLAG, help }

//#else { AP_HAVE_DESIGNATED_INITIALIZER }

//typedef const char *( *cmd_func) ();

//# define AP_NO_ARGS  func
//# define AP_RAW_ARGS func
//# define AP_TAKE1    func
//# define AP_TAKE2    func
//# define AP_TAKE3    func
//# define AP_FLAG     func

//# define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, RAW_ARGS, help }
//# define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, RAW_ARGS, help }
//# define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, TAKE1, help }
//# define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, ITERATE, help }
//# define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, TAKE2, help }
//# define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, TAKE12, help }
//# define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, ITERATE2, help }
//# define AP_INIT_TAKE13(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, TAKE13, help }
//# define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, TAKE23, help }
//# define AP_INIT_TAKE123(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, TAKE123, help }
//# define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, TAKE3, help }
//# define AP_INIT_FLAG(directive, func, mconfig, where, help) \
    { directive, func, mconfig, where, FLAG, help }

//#endif { AP_HAVE_DESIGNATED_INITIALIZER }

{
 * The command record structure.  Each modules can define a table of these
 * to define the directives it will implement.
 }
  command_struct = record
    { Name of this command }
    name: PChar;
    { The function to be called when this directive is parsed }
    func: cmd_func;
    { Extra data, for functions which implement multiple commands... }
    cmd_data: Pointer;
    { What overrides need to be allowed to enable this command. }
    req_override: Integer;
    { What the command expects as arguments
     *  @defvar cmd_how args_how}
    args_how: cmd_how;

    { 'usage' message, in case of syntax errors }
    errmsg: PChar;
  end;
  command_rec = command_struct;
  Pcommand_rec = ^command_rec;

  { Constants here were moved up }

  { Common structure for reading of config files / passwd files etc. }

  getch_t = function (param: Pointer): Integer;
  
  getstr_t = function (buf: Pointer; bufsiz: size_t; param: Pointer): Pointer;
  
  close_t = function (param: Pointer): Integer;

  ap_configfile_t = record
    getch: getch_t;    {< a getc()-like function }
    getstr: getstr_t;  {< a fgets()-like function }
    close: close_t;    {< a close handler function }
    param: Pointer;    {< the argument passed to getch/getstr/close }
    name: PChar;       {< the filename / description }
    line_number: cuint;{< current line number, starting at 1 }
  end;
  
  Pap_configfile_t = ^ap_configfile_t;
  PPap_configfile_t = ^Pap_configfile_t;

{
 * This structure is passed to a command which is being invoked,
 * to carry a large variety of miscellaneous data which is all of
 * use to *somebody*...
 }
  cmd_parms_struct = record
    { Argument to command from cmd_table }
    info: Pointer;
    { Which allow-override bits are set }
    override_: Integer;
    { Which methods are <Limit>ed }
    limited: apr_int64_t;
    { methods which are limited }
    limited_xmethods: Papr_array_header_t;
    { methods which are xlimited }
    xlimited: Pap_method_list_t;

    { Config file structure. }
    config_file: Pap_configfile_t;
    { the directive specifying this command }
    directive: Pap_directive_t;

    { Pool to allocate new storage in }
    pool: Papr_pool_t;
    { Pool for scratch memory; persists during configuration, but
     *  wiped before the first request is served...  }
    temp_pool: Papr_pool_t;
    { Server_rec being configured for }
    server: Pserver_rec;
    { If configuring for a directory, pathname of that directory.
     *  NOPE!  That's what it meant previous to the existance of <Files>, 
     * <Location> and regex matching.  Now the only usefulness that can be 
     * derived from this field is whether a command is being called in a 
     * server context (path == NULL) or being called in a dir context 
     * (path != NULL).  }
    path: PChar;
    { configuration command }
    cmd: Pcommand_rec;

    { per_dir_config vector passed to handle_command }
    context: Pap_conf_vector_t;
    { directive with syntax error }
    err_directive: Pap_directive_t;
  end;

  cmd_parms = cmd_parms_struct;

{
 * Module structures.  Just about everything is dispatched through
 * these, directly or indirectly (through the command and handler
 * tables).
 }
type
  Pmodule_struct = ^module_struct;

  module_struct = record
    { API version, *not* module version; check that module is
     * compatible with this version of the server.
     }
    version: Integer;
    { API minor version. Provides API feature milestones. Not checked
     *  during module init }
    minor_version: Integer;
    { Index to this modules structures in config vectors.  }
    module_index: Integer;

    { The name of the module's C file }
    name: PChar;
    { The handle for the DSO.  Internal use only }
    dynamic_load_handle: Pointer;

    { A pointer to the next module in the list
     *  @defvar module_struct *next }
    next: Pmodule_struct;

    { Magic Cookie to identify a module structure;  It's mainly
     *  important for the DSO facility (see also mod_so).  }
    magic: Cardinal;

    { Function to allow MPMs to re-write command line arguments.  This
     *  hook is only available to MPMs.
     *  @param The process that the server is running in.
     }
    rewrite_args: procedure(process: Pprocess_rec); cdecl;

    { Function to allow all modules to create per directory configuration
     *  structures.
     *  @param p The pool to use for all allocations.
     *  @param dir The directory currently being processed.
     *  @return The per-directory structure created
     }
    create_dir_config: function(p: Papr_pool_t; dir: PChar): Pointer; cdecl;

    { Function to allow all modules to merge the per directory configuration
     *  structures for two directories.
     *  @param p The pool to use for all allocations.
     *  @param base_conf The directory structure created for the parent directory.
     *  @param new_conf The directory structure currently being processed.
     *  @return The new per-directory structure created
     }
    merge_dir_config: function(p: Papr_pool_t; base_conf: Pointer;
      new_conf: Pointer): Pointer; cdecl;

    { Function to allow all modules to create per server configuration
     *  structures.
     *  @param p The pool to use for all allocations.
     *  @param s The server currently being processed.
     *  @return The per-server structure created
     }
    create_server_config: function(p: Papr_pool_t; s: Pserver_rec): Pointer; cdecl;

    { Function to allow all modules to merge the per server configuration
     *  structures for two servers.
     *  @param p The pool to use for all allocations.
     *  @param base_conf The directory structure created for the parent directory.
     *  @param new_conf The directory structure currently being processed.
     *  @return The new per-directory structure created
     }
    merge_server_config: function(p: Papr_pool_t; base_conf: Pointer;
      new_conf: Pointer): Pointer; cdecl;

    { A command_rec table that describes all of the directives this module
     * defines. }
    cmds: Pcommand_rec;

    { A hook to allow modules to hook other points in the request processing.
     *  In this function, modules should call the ap_hook_*() functions to
     *  register an interest in a specific step in processing the current
     *  request.
     *  @param p the pool to use for all allocations
     }
    register_hooks: procedure(p: Papr_pool_t); cdecl;
  end;

  module = module_struct;
  Pmodule = ^module;
  PPmodule = ^Pmodule;

{
 * @defgroup ModuleInit Module structure initializers
 *
 * Initializer for the first few module slots, which are only
 * really set up once we start running.  Note that the first two slots
 * provide a version check; this should allow us to deal with changes to
 * the API. The major number should reflect changes to the API handler table
 * itself or removal of functionality. The minor number should reflect
 * additions of functionality to the existing API. (the server can detect
 * an old-format module, and either handle it back-compatibly, or at least
 * signal an error). See src/include/ap_mmn.h for MMN version history.
 }

{ The one used in Apache 1.3, which will deliberately cause an error }
//#define STANDARD_MODULE_STUFF	this_module_needs_to_be_ported_to_apache_2_0

{ Use this in all standard modules }
procedure STANDARD20_MODULE_STUFF(var mod_: module);

{ Use this only in MPMs }
procedure MPM20_MODULE_STUFF(var mod_: module);

{ CONFIGURATION VECTOR FUNCTIONS }

{ configuration vector structure - Moved to httpd.pas}

{
  ap_get_module_config, ap_set_module_config are both commented out because even thought
 they are on the headers, they are not present on the libhttpd.dll library.
}

{
 * Generic accessors for other modules to get at their own module-specific
 * data
 * @param conf_vector The vector in which the modules configuration is stored.
 *        usually r->per_dir_config or s->module_config
 * @param m The module to get the data for.
 * @return The module-specific data
 }
{
  Function not found on the dll
}
//function ap_get_module_config(const cv: Pap_conf_vector_t; const m: Pmodule): Pointer;
// {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
// external LibHTTPD name LibNamePrefix + 'ap_get_module_config' + LibSuff8;

{
 * Generic accessors for other modules to set at their own module-specific
 * data
 * @param conf_vector The vector in which the modules configuration is stored.
 *        usually r->per_dir_config or s->module_config
 * @param m The module to set the data for.
 * @param val The module-specific data to set
 }
//procedure ap_set_module_config(const cv: Pap_conf_vector_t; const m: Pmodule;
// val: Pointer);
// {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
// external LibHTTPD name LibNamePrefix + 'ap_set_module_config' + LibSuff12;

{$ifndef AP_DEBUG}

function ap_get_module_config(v: Pap_conf_vector_t; m: Pmodule): Pap_conf_vector_t;

procedure ap_set_module_config(v: Pap_conf_vector_t; m: Pmodule; val: Pap_conf_vector_t);

{$endif} { AP_DEBUG }


{
 * Generic command handling function for strings
 * @param cmd The command parameters for this directive
 * @param struct_ptr pointer into a given type
 * @param arg The argument to the directive
 * @return An error string or NULL on success
 }
function ap_set_string_slot(cmd: Pcmd_parms; struct_ptr: Pointer; const arg: PChar): PChar;
 cdecl; external LibHTTPD name 'ap_set_string_slot';

{
 * Generic command handling function for integers
 * @param cmd The command parameters for this directive
 * @param struct_ptr pointer into a given type
 * @param arg The argument to the directive
 * @return An error string or NULL on success
 }
function ap_set_int_slot(cmd: Pcmd_parms; struct_ptr: Pointer; const arg: PChar): PChar;
 cdecl; external LibHTTPD name 'ap_set_int_slot';

{
 * Return true if the specified method is limited by being listed in
 * a <Limit> container, or by *not* being listed in a <LimiteExcept>
 * container.
 *
 * @param   method  Pointer to a string specifying the method to check.
 * @param   cmd     Pointer to the cmd_parms structure passed to the
 *                  directive handler.
 * @return  0 if the method is not limited in the current scope
 }
function ap_method_is_limited(cmd: Pcmd_parms; const method: PChar): Integer;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_method_is_limited' + LibSuff8;

{
 * Generic command handling function for strings, always sets the value
 * to a lowercase string
 * @param cmd The command parameters for this directive
 * @param struct_ptr pointer into a given type
 * @param arg The argument to the directive
 * @return An error string or NULL on success
 }
function ap_set_string_slot_lower(cmd: Pcmd_parms; struct_ptr: Pointer; const arg: PChar): PChar;
 cdecl; external LibHTTPD name 'ap_set_string_slot_lower';

{
 * Generic command handling function for flags
 * @param cmd The command parameters for this directive
 * @param struct_ptr pointer into a given type
 * @param arg The argument to the directive (either 1 or 0)
 * @return An error string or NULL on success
 }
function ap_set_flag_slot(cmd: Pcmd_parms; struct_ptr: Pointer; const arg: PChar): PChar;
 cdecl; external LibHTTPD name 'ap_set_flag_slot';

{
 * Generic command handling function for files
 * @param cmd The command parameters for this directive
 * @param struct_ptr pointer into a given type
 * @param arg The argument to the directive
 * @return An error string or NULL on success
 }
function ap_set_file_slot(cmd: Pcmd_parms; struct_ptr: Pointer; const arg: PChar): PChar;
 cdecl; external LibHTTPD name 'ap_set_file_slot';

{
 * Generic command handling function to respond with cmd->help as an error
 * @param cmd The command parameters for this directive
 * @param struct_ptr pointer into a given type
 * @param arg The argument to the directive
 * @return The cmd->help value as the error string
 * @tip This allows simple declarations such as;
 * <pre>
 *     AP_INIT_RAW_ARGS("Foo", ap_set_deprecated, NULL, OR_ALL, 
 *         "The Foo directive is no longer supported, use Bar"),
 * </pre>
 }
function ap_set_deprecated(cmd: Pcmd_parms; struct_ptr: Pointer; const arg: PChar): PChar;
 cdecl; external LibHTTPD name 'ap_set_deprecated';

{
 * For modules which need to read config files, open logs, etc. this returns
 * the canonical form of fname made absolute to ap_server_root.
 * @param p pool to allocate data from
 * @param fname The file name
 }
function ap_server_root_relative(p: Papr_pool_t; const fname: PChar): PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_server_root_relative' + LibSuff8;

{ Finally, the hook for dynamically loading modules in... }

{
 * Add a module to the server
 * @param m The module structure of the module to add
 * @param p The pool of the same lifetime as the module
 }
procedure ap_add_module(m: Pmodule; p: Papr_pool_t);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_add_module' + LibSuff8;

{
 * Remove a module from the server.  There are some caveats:
 * when the module is removed, its slot is lost so all the current
 * per-dir and per-server configurations are invalid. So we should
 * only ever call this function when you are invalidating almost
 * all our current data. I.e. when doing a restart.
 * @param m the module structure of the module to remove
 }
procedure ap_remove_module(m: Pmodule);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_remove_module' + LibSuff4;

{
 * Add a module to the chained modules list and the list of loaded modules
 * @param m The module structure of the module to add
 * @param p The pool with the same lifetime as the module
 }
procedure ap_add_loaded_module(mod_: Pmodule; p: Papr_pool_t);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_add_loaded_module' + LibSuff8;

{
 * Remove a module fromthe chained modules list and the list of loaded modules
 * @param m the module structure of the module to remove
 }
procedure ap_remove_loaded_module(m: Pmodule);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_remove_loaded_module' + LibSuff4;

{
 * Add a module to the list of loaded module based on the name of the
 * module
 * @param name The name of the module
 * @param p The pool valid for the lifetime of the module
 * @return 1 on success, 0 on failure
 }
function ap_add_named_module(const name: PChar; p: Papr_pool_t): Integer;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_add_named_module' + LibSuff8;

{
 * Find the name of the specified module
 * @param m The module to get the name for
 * @return the name of the module
 }
function ap_find_module_name(m: Pmodule): PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_find_module_name' + LibSuff4;

{
 * Find a module based on the name of the module
 * @param name the name of the module
 * @return the module structure if found, NULL otherwise
 }
function ap_find_linked_module(const name: PChar): Pmodule;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_find_linked_module' + LibSuff4;

{
 * Open a ap_configfile_t as apr_file_t
 * @param ret_cfg open ap_configfile_t struct pointer
 * @param p The pool to allocate the structure from
 * @param name the name of the file to open
 }
function ap_pcfg_openfile(ret_cfg: PPap_configfile_t;
 p: Papr_pool_t; const name: PChar): apr_status_t;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_pcfg_openfile' + LibSuff12;

{
 * Allocate a ap_configfile_t handle with user defined functions and params 
 * @param p The pool to allocate from
 * @param descr The name of the file
 * @param param The argument passed to getch/getstr/close
 * @param getc_func The getch function
 * @param gets_func The getstr function
 * @param close_func The close function
 }
type
  getc_func_t = function (param: Pointer): Integer;
  gets_func_t = function (buf: Pointer; bufsiz: size_t; param: Pointer): Pointer;
  close_func_t = function (param: Pointer): Integer;

function ap_pcfg_open_custom(p: Papr_pool_t;
 const descr: PChar; param: Pointer;
 getc_func: getc_func_t; gets_func: gets_func_t;
 close_func: close_func_t): Pap_configfile_t;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_pcfg_open_custom' + LibSuff24;

{
 * Read one line from open ap_configfile_t, strip LF, increase line number
 * @param buf place to store the line read
 * @param bufsize size of the buffer
 * @param cfp File to read from
 * @return 1 on success, 0 on failure
 }
function ap_cfg_getline(bug: PChar;
 bufsize: size_t; cfp: Pap_configfile_t): Integer;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_cfg_getline' + LibSuff12;

{
 * Read one char from open configfile_t, increase line number upon LF 
 * @param cfp The file to read from
 * @return the character read
 }
function ap_cfg_getc(cfp: Pap_configfile_t): Integer;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_cfg_getc' + LibSuff4;

{
 * Detach from open ap_configfile_t, calling the close handler
 * @param cfp The file to close
 * @return 1 on sucess, 0 on failure
 }
function ap_cfg_closefile(cfp: Pap_configfile_t): Integer;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_cfg_closefile' + LibSuff4;

{
 * Read all data between the current <foo> and the matching </foo>.  All
 * of this data is forgotten immediately.  
 * @param cmd The cmd_parms to pass to the directives inside the container
 * @param directive The directive name to read until
 * @return Error string on failure, NULL on success
 }
function ap_soak_end_container(cmd: Pcmd_parms; directive: PChar): PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_soak_end_container' + LibSuff8;

{
 * Read all data between the current <foo> and the matching </foo> and build
 * a config tree from it
 * @param p pool to allocate from
 * @param temp_pool Temporary pool to allocate from
 * @param parms The cmd_parms to pass to all directives read
 * @param current The current node in the tree
 * @param curr_parent The current parent node
 * @param orig_directive The directive to read until hit.
 * @return Error string on failure, NULL on success
}
function ap_build_cont_config(p, temp_pool: Papr_pool_t;
 parms: Pcmd_parms; current, curr_parent: PPap_directive_t;
 orig_directive: PChar): PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_build_cont_config' + LibSuff24;

{
 * Build a config tree from a config file
 * @param parms The cmd_parms to pass to all of the directives in the file
 * @param conf_pool The pconf pool
 * @param temp_pool The temporary pool
 * @param conftree Place to store the root node of the config tree
 * @return Error string on erro, NULL otherwise
 }
function ap_build_config(parms: Pcmd_parms;
 conf_pool, temp_pool: Papr_pool_t; conftree: PPap_directive_t): PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_build_config' + LibSuff16;

{
 * Walk a config tree and setup the server's internal structures
 * @param conftree The config tree to walk
 * @param parms The cmd_parms to pass to all functions
 * @param section_vector The per-section config vector.
 * @return Error string on error, NULL otherwise
 }
function ap_walk_config(conftree: Pap_directive_t;
 parms: Pcmd_parms; section_vector: Pap_conf_vector_t): PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_walk_config' + LibSuff12;

{
 * @defgroup ap_check_cmd_context ap_check_cmd_context
 }
{
 * Check the context a command is used in.
 * @param cmd The command to check
 * @param forbidden Where the command is forbidden.
 * @return Error string on error, NULL on success
 }
function ap_check_cmd_context(cmd: Pcmd_parms;
 forbidden: cuint): PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_check_cmd_context' + LibSuff8;

const
  NOT_IN_VIRTUALHOST    = $01; {< Forbidden in <Virtualhost> }
  NOT_IN_LIMIT          = $02; {< Forbidden in <Limit> }
  NOT_IN_DIRECTORY      = $04; {< Forbidden in <Directory> }
  NOT_IN_LOCATION       = $08; {< Forbidden in <Location> }
  NOT_IN_FILES          = $10; {< Forbidden in <Files> }
{ Forbidden in <Directory>/<Location>/<Files>}
  NOT_IN_DIR_LOC_FILE   = (NOT_IN_DIRECTORY or NOT_IN_LOCATION or NOT_IN_FILES);
{ Forbidden in <VirtualHost>/<Limit>/<Directory>/<Location>/<Files> }
  GLOBAL_ONLY           = (NOT_IN_VIRTUALHOST or NOT_IN_LIMIT or NOT_IN_DIR_LOC_FILE);

//#ifdef CORE_PRIVATE

{
 * The topmost module in the list
 * @defvar module *ap_top_module
 }
//AP_DECLARE_DATA extern module *ap_top_module;

{
 * Array of all statically linked modules
 * @defvar module *ap_prelinked_modules[]
 }
//AP_DECLARE_DATA extern module *ap_prelinked_modules[];
{
 * Array of all preloaded modules
 * @defvar module *ap_preloaded_modules[]
 }
//AP_DECLARE_DATA extern module *ap_preloaded_modules[];
{
 * Array of all loaded modules
 * @defvar module **ap_loaded_modules
 }
//AP_DECLARE_DATA extern module **ap_loaded_modules;

{ For mod_so.c... }
{ Run a single module's two create_config hooks
 *  @param p the pool to allocate from
 *  @param s The server to configure for.
 *  @param m The module to configure
 }
procedure ap_single_module_configure(p: Papr_pool_t;
 s: Pserver_rec; m: Pmodule);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_single_module_configure' + LibSuff12;

{ For http_main.c... }
{
 * Add all of the prelinked modules into the loaded module list
 * @param process The process that is currently running the server
 }
procedure ap_setup_prelinked_modules(process: Pprocess_rec);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_setup_prelinked_modules' + LibSuff4;

{
 * Show the preloaded configuration directives, the help string explaining
 * the directive arguments, in what module they are handled, and in
 * what parts of the configuration they are allowed.  Used for httpd -h.
 }
procedure ap_show_directives;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_show_directives' + LibSuff0;

{
 * Show the preloaded module names.  Used for httpd -l. 
 }
procedure ap_show_modules;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_show_modules' + LibSuff0;

{
 * Show the MPM name.  Used in reporting modules such as mod_info to
 * provide extra information to the user
 }
function ap_show_mpm: PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_show_mpm' + LibSuff0;

{
 * Read all config files and setup the server
 * @param process The process running the server
 * @param temp_pool A pool to allocate temporary data from.
 * @param config_name The name of the config file
 * @param conftree Place to store the root of the config tree
 * @return The setup server_rec list.
 }
function ap_read_config(process: Pprocess_rec;
 temp_pool: Papr_pool_t; const config_name: PChar;
 conftree: PPap_directive_t): Pserver_rec;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_read_config' + LibSuff16;

{
 * Run all rewrite args hooks for loaded modules
 * @param process The process currently running the server
 }
procedure ap_run_rewrite_args(process: Pprocess_rec);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_run_rewrite_args' + LibSuff4;

{
 * Run the register hooks function for a specified module
 * @param m The module to run the register hooks function fo
 * @param p The pool valid for the lifetime of the module
 }
procedure ap_register_hooks(m: Pmodule; p: Papr_pool_t);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_register_hooks' + LibSuff8;

{
 * Setup all virtual hosts
 * @param p The pool to allocate from
 * @param main_server The head of the server_rec list
 }
procedure ap_fixup_virtual_hosts(p: Papr_pool_t; main_server: Pserver_rec);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_fixup_virtual_hosts' + LibSuff8;

{ For http_request.c... }

{
 * Setup the config vector for a request_rec
 * @param p The pool to allocate the config vector from
 * @return The config vector
 }
function ap_create_request_config(p: Papr_pool_t): Pap_conf_vector_t;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_create_request_config' + LibSuff4;

{
 * Setup the config vector for per dir module configs
 * @param p The pool to allocate the config vector from
 * @return The config vector
 }
function ap_create_per_dir_config(p: Papr_pool_t): Pap_conf_vector_t;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_create_per_dir_config' + LibSuff4;

{
 * Run all of the modules merge per dir config functions
 * @param p The pool to pass to the merge functions
 * @param base The base directory config structure
 * @param new_conf The new directory config structure
 }
function ap_merge_per_dir_configs(p: Papr_pool_t;
 base, new_conf: Pap_conf_vector_t): Pap_conf_vector_t;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_merge_per_dir_configs' + LibSuff12;

{ For http_connection.c... }
{
 * Setup the config vector for a connection_rec
 * @param p The pool to allocate the config vector from
 * @return The config vector
 }
function ap_create_conn_config(p: Papr_pool_t): Pap_conf_vector_t;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_create_conn_config' + LibSuff4;

{ For http_core.c... (<Directory> command and virtual hosts) }

{
 * parse an htaccess file
 * @param resulting htaccess_result
 * @param r The request currently being served
 * @param override Which overrides are active
 * @param path The path to the htaccess file
 * @param access_name The list of possible names for .htaccess files
 * int The status of the current request
 }
function ap_parse_htaccess(result: PPap_conf_vector_t;
 r: Prequest_rec; override_: Integer;
 const path, access_name: PChar): Integer;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_parse_htaccess' + LibSuff20;

{
 * Setup a virtual host
 * @param p The pool to allocate all memory from
 * @param hostname The hostname of the virtual hsot
 * @param main_server The main server for this Apache configuration
 * @param ps Place to store the new server_rec
 * return Error string on error, NULL on success
 }
function ap_init_virtual_host(p: Papr_pool_t;
 const hostname: PChar; main_server: Pserver_rec;
 m: PPserver_rec): PChar;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_init_virtual_host' + LibSuff16;

{
 * Process the config file for Apache
 * @param s The server rec to use for the command parms
 * @param fname The name of the config file
 * @param conftree The root node of the created config tree
 * @param p Pool for general allocation
 * @param ptem Pool for temporary allocation
 }
procedure ap_process_resource_config(s: Pserver_rec;
 const fname: PChar; conftree: PPap_directive_t;
 p, ptemp: Papr_pool_t);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_process_resource_config' + LibSuff20;

{
 * Process all directives in the config tree
 * @param s The server rec to use in the command parms
 * @param conftree The config tree to process
 * @param p The pool for general allocation
 * @param ptemp The pool for temporary allocations
 }
procedure ap_process_config_tree(s: Pserver_rec;
 conftree: Pap_directive_t; p, ptemp: Papr_pool_t);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_process_config_tree' + LibSuff16;

{ Module-method dispatchers, also for http_request.c }
{
 * Run the handler phase of each module until a module accepts the
 * responsibility of serving the request
 * @param r The current request
 * @return The status of the current request
 }
function ap_invoke_handler(r: Prequest_rec): Integer;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_invoke_handler' + LibSuff4;

{ for mod_perl }

{
 * Find a given directive in a command_rec table
 * @param name The directive to search for
 * @param cmds The table to search
 * @return The directive definition of the specified directive
 }
function ap_find_command(const name: PChar;
 const cmds: Pcommand_rec): Pcommand_rec;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_find_command' + LibSuff8;

{
 * Find a given directive in a list module
 * @param cmd_name The directive to search for
 * @param mod The module list to search
 * @return The directive definition of the specified directive
 }
function ap_find_command_in_modules(const cmd_name: PChar;
 mod_: PPmodule): Pcommand_rec;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_find_command_in_modules' + LibSuff8;

{
 * Ask a module to create per-server and per-section (dir/loc/file) configs
 * (if it hasn't happened already). The results are stored in the server's
 * config, and the specified per-section config vector.
 * @param server The server to operate upon.
 * @param section_vector The per-section config vector.
 * @param section Which section to create a config for.
 * @param mod The module which is defining the config data.
 * @param pconf A pool for all configuration allocations.
 * @return The (new) per-section config data.
 }
function ap_set_config_vectors(server: Pserver_rec;
 ection_vector: Pap_conf_vector_t; const section: PChar;
 mod_: Pmodule; pconf: Papr_pool_t): Pointer;
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_set_config_vectors' + LibSuff20;

{#endif}

{ Hooks }

{
 * Run the header parser functions for each module
 * @param r The current request
 * @return OK or DECLINED
 }
type
  ap_HOOK_header_parser_t = function(r: Prequest_rec): Integer; cdecl;

procedure ap_hook_header_parser(pf: ap_HOOK_header_parser_t;
 const aszPre: PPChar; const aszSucc:
 PPChar; nOrder: Integer);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_hook_header_parser' + LibSuff16;

{
 * Run the pre_config function for each module
 * @param pconf The config pool
 * @param plog The logging streams pool
 * @param ptemp The temporary pool
 * @return OK or DECLINED on success anything else is a error
 }
type
  ap_HOOK_pre_config_t = function(pconf: Papr_pool_t; plog: Papr_pool_t;
    ptemp: Papr_pool_t): Integer; cdecl;

procedure ap_hook_pre_config(pf: ap_HOOK_pre_config_t; const aszPre: PPChar;
 const aszSucc: PPChar; nOrder: Integer);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_hook_pre_config' + LibSuff16;

{
 * Run the post_config function for each module
 * @param pconf The config pool
 * @param plog The logging streams pool
 * @param ptemp The temporary pool
 * @param s The list of server_recs
 * @return OK or DECLINED on success anything else is a error
 }
type
  ap_HOOK_post_config_t = function(pconf, plog, ptemp: Papr_pool_t; s: Pserver_rec): Integer; cdecl;

procedure ap_hook_post_config(pf: ap_HOOK_post_config_t; const aszPre: PPChar;
 const aszSucc: PPChar; nOrder: Integer);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_hook_post_config' + LibSuff16;

{
 * Run the open_logs functions for each module
 * @param pconf The config pool
 * @param plog The logging streams pool
 * @param ptemp The temporary pool
 * @param s The list of server_recs
 * @return OK or DECLINED on success anything else is a error
 }
type
  ap_HOOK_open_logs_t = function(pconf: Papr_pool_t; plog: Papr_pool_t;
    ptemp: Papr_pool_t; s: Pserver_rec): Integer; cdecl;

procedure ap_hook_open_logs(pf: ap_HOOK_open_logs_t; const aszPre: PPChar;
 const aszSucc: PPChar; nOrder: Integer);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_hook_open_logs' + LibSuff16;

{
 * Run the child_init functions for each module
 * @param pchild The child pool
 * @param s The list of server_recs in this server 
 }
type
  ap_HOOK_child_init_t = procedure(pchild: Papr_pool_t; s: Pserver_rec); cdecl;

procedure ap_hook_child_init(pf: ap_HOOK_child_init_t; const aszPre: PPChar;
 const aszSucc: PPChar; nOrder: Integer);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_hook_child_init' + LibSuff16;

{
 * Run the handler functions for each module
 * @param r The request_rec
 * @remark non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
 }
type
  ap_HOOK_handler_t = function(r: Prequest_rec): Integer; cdecl;

procedure ap_hook_handler(pf: ap_HOOK_handler_t; const aszPre: PPChar;
 const aszSucc: PPChar; nOrder: Integer);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_hook_handler' + LibSuff16;

{
 * Run the quick handler functions for each module. The quick_handler
 * is run before any other requests hooks are called (location_walk,
 * directory_walk, access checking, et. al.). This hook was added
 * to provide a quick way to serve content from a URI keyed cache.
 * 
 * @param r The request_rec
 * @param lookup_uri Controls whether the caller actually wants content or not.
 * lookup is set when the quick_handler is called out of 
 * ap_sub_req_lookup_uri()
 }
type
  ap_HOOK_quick_handler_t = function(r: Prequest_rec;
    lookup_uri: Integer): Integer; cdecl;

procedure ap_hook_quick_handler(pf: ap_HOOK_quick_handler_t;
 const aszPre: PPChar; const aszSucc: PPChar; nOrder: Integer);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_hook_quick_handler' + LibSuff16;

{
 * Retrieve the optional functions for each module.
 * This is run immediately before the server starts. Optional functions should
 * be registered during the hook registration phase.
 }
type
  ap_HOOK_optional_fn_retrieve_t = procedure; cdecl;

procedure ap_hook_optional_fn_retrieve(pf: ap_HOOK_optional_fn_retrieve_t;
 const aszPre: PPChar; const aszSucc: PPChar; nOrder: Integer);
 {$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
 external LibHTTPD name LibNamePrefix + 'ap_hook_optional_fn_retrieve' + LibSuff16;