http_config.h revision c3f224381c60ae6566ced33d46637edca7a71d56
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen/* ====================================================================
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * The Apache Software License, Version 1.1
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen *
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * reserved.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen *
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * Redistribution and use in source and binary forms, with or without
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * modification, are permitted provided that the following conditions
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * are met:
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen *
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * 1. Redistributions of source code must retain the above copyright
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * notice, this list of conditions and the following disclaimer.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen *
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * 2. Redistributions in binary form must reproduce the above copyright
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * notice, this list of conditions and the following disclaimer in
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * the documentation and/or other materials provided with the
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * distribution.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen *
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * 3. The end-user documentation included with the redistribution,
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * if any, must include the following acknowledgment:
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * "This product includes software developed by the
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * Apache Software Foundation (http://www.apache.org/)."
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * Alternately, this acknowledgment may appear in the software itself,
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * if and wherever such third-party acknowledgments normally appear.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek *
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * 4. The names "Apache" and "Apache Software Foundation" must
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * not be used to endorse or promote products derived from this
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * software without prior written permission. For written
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * permission, please contact apache@apache.org.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek *
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * 5. Products derived from this software may not be called "Apache",
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * nor may "Apache" appear in their name, without prior written
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * permission of the Apache Software Foundation.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek *
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * SUCH DAMAGE.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * ====================================================================
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek *
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * This software consists of voluntary contributions made by many
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * individuals on behalf of the Apache Software Foundation. For more
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * information on the Apache Software Foundation, please see
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * <http://www.apache.org/>.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek *
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * Portions of this software are based upon public domain software
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * originally written at the National Center for Supercomputing Applications,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * University of Illinois, Urbana-Champaign.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen#ifndef APACHE_HTTP_CONFIG_H
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define APACHE_HTTP_CONFIG_H
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#include "apr_hooks.h"
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen#include "util_cfgtree.h"
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#ifdef __cplusplus
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekextern "C" {
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#endif
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/**
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen * @package Apache Configuration
57e27ec0ada6775d85a5201cd25e989d92d0a1afZbigniew Jędrzejewski-Szmek */
57e27ec0ada6775d85a5201cd25e989d92d0a1afZbigniew Jędrzejewski-Szmek
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt/*
57e27ec0ada6775d85a5201cd25e989d92d0a1afZbigniew Jędrzejewski-Szmek * The central data structures around here...
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/* Command dispatch structures... */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/**
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * How the directives arguments should be parsed.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @tip Note that for all of these except RAW_ARGS, the config routine is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * passed a freshly allocated string which can be modified or stored
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * or whatever... it's only necessary to do pstrdup() stuff with
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * <PRE>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * RAW_ARGS -- cmd_func parses command line itself
102bd40e1ed71c7ab980a90435a1c23d4c786c63Lennart Poettering * TAKE1 -- one argument only
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * TAKE2 -- two arguments only
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * ITERATE -- one argument, occuring multiple times
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * * (e.g., IndexIgnore)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * ITERATE2 -- two arguments, 2nd occurs multiple times
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * * (e.g., AddIcon)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * FLAG -- One of 'On' or 'Off'
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * NO_ARGS -- No args at all, e.g. </Directory>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * TAKE12 -- one or two arguments
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * TAKE3 -- three arguments only
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * TAKE23 -- two or three arguments
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * TAKE123 -- one, two or three arguments
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * TAKE13 -- one or three arguments
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * </PRE>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @defvar enum cmd_how
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekenum cmd_how {
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek RAW_ARGS, /* cmd_func parses command line itself */
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen TAKE1, /* one argument only */
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen TAKE2, /* two arguments only */
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen ITERATE, /* one argument, occuring multiple times
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen * (e.g., IndexIgnore)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek ITERATE2, /* two arguments, 2nd occurs multiple times
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * (e.g., AddIcon)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek FLAG, /* One of 'On' or 'Off' */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek NO_ARGS, /* No args at all, e.g. </Directory> */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek TAKE12, /* one or two arguments */
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen TAKE3, /* three arguments only */
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen TAKE23, /* two or three arguments */
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen TAKE123, /* one, two or three arguments */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek TAKE13 /* one or three arguments */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek};
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmektypedef struct cmd_parms_struct cmd_parms;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen#ifdef AP_DEBUG
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmektypedef union {
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *(*no_args) (cmd_parms *parms, void *mconfig);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *(*raw_args) (cmd_parms *parms, void *mconfig,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *args);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *(*take1) (cmd_parms *parms, void *mconfig, const char *w);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *(*take2) (cmd_parms *parms, void *mconfig, const char *w,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *w2);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *(*take3) (cmd_parms *parms, void *mconfig, const char *w,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *w2, const char *w3);
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen const char *(*flag) (cmd_parms *parms, void *mconfig, int on);
5256e00e8b9015dd1a976d647fc71dc7efbd8cf8Tom Gundersen} cmd_func;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_NO_ARGS func.no_args
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_RAW_ARGS func.raw_args
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_TAKE1 func.take1
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_TAKE2 func.take2
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_TAKE3 func.take3
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_FLAG func.flag
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .no_args=func }, mconfig, where, RAW_ARGS, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .raw_args=func }, mconfig, where, RAW_ARGS, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .take1=func }, mconfig, where, TAKE1, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .take1=func }, mconfig, where, ITERATE, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .take2=func }, mconfig, where, TAKE2, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .take2=func }, mconfig, where, TAKE12, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .take2=func }, mconfig, where, ITERATE2, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .take3=func }, mconfig, where, TAKE23, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .take3=func }, mconfig, where, TAKE3, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_FLAG(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, { .flag=func }, mconfig, where, FLAG, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#else
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmektypedef const char *(*cmd_func) ();
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_NO_ARGS func
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_RAW_ARGS func
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_TAKE1 func
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_TAKE2 func
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_TAKE3 func
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_FLAG func
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, RAW_ARGS, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, RAW_ARGS, help }
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen# define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, TAKE1, help }
102bd40e1ed71c7ab980a90435a1c23d4c786c63Lennart Poettering# define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, ITERATE, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
102bd40e1ed71c7ab980a90435a1c23d4c786c63Lennart Poettering { directive, func, mconfig, where, TAKE2, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, TAKE12, help }
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen# define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, ITERATE2, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, TAKE23, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, TAKE3, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek# define AP_INIT_FLAG(directive, func, mconfig, where, help) \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek { directive, func, mconfig, where, FLAG, help }
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#endif
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmektypedef struct command_struct command_rec;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/**
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * The command record structure. Each modules can define a table of these
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * to define the directives it will implement.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekstruct command_struct {
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Name of this command */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *name;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** The function to be called when this directive is parsed */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek cmd_func func;
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen /** Extra data, for functions which implement multiple commands... */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *cmd_data;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** What overrides need to be allowed to enable this command. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek int req_override;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** What the command expects as arguments
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @defvar cmd_how args_how*/
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek enum cmd_how args_how;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** 'usage' message, in case of syntax errors */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *errmsg;
1c25683e0f40c6169676cc44fa1897082597feecTom Gundersen};
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt/* The allowed locations for a configuration directive are the union of
1c25683e0f40c6169676cc44fa1897082597feecTom Gundersen * those indicated by each set bit in the req_override mask.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek *
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * (req_override & RSRC_CONF) => *.conf outside <Directory> or <Location>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * (req_override & ACCESS_CONF) => *.conf inside <Directory> or <Location>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * (req_override & OR_AUTHCFG) => *.conf inside <Directory> or <Location>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * and .htaccess when AllowOverride AuthConfig
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * (req_override & OR_LIMIT) => *.conf inside <Directory> or <Location>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * and .htaccess when AllowOverride Limit
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * (req_override & OR_OPTIONS) => *.conf anywhere
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt * and .htaccess when AllowOverride Options
2e229e0c4c29e8a827be9ffe361741cf5e9aa7afTom Gundersen * (req_override & OR_FILEINFO) => *.conf anywhere
2e229e0c4c29e8a827be9ffe361741cf5e9aa7afTom Gundersen * and .htaccess when AllowOverride FileInfo
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * (req_override & OR_INDEXES) => *.conf anywhere
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * and .htaccess when AllowOverride Indexes
66d3752e812915a549ebee01769ee761c1495667Jacob Keller */
66d3752e812915a549ebee01769ee761c1495667Jacob Keller#define OR_NONE 0
66d3752e812915a549ebee01769ee761c1495667Jacob Keller#define OR_LIMIT 1
66d3752e812915a549ebee01769ee761c1495667Jacob Keller#define OR_OPTIONS 2
66d3752e812915a549ebee01769ee761c1495667Jacob Keller#define OR_FILEINFO 4
66d3752e812915a549ebee01769ee761c1495667Jacob Keller#define OR_AUTHCFG 8
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define OR_INDEXES 16
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define OR_UNSET 32
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define ACCESS_CONF 64
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define RSRC_CONF 128
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define EXEC_ON_READ 256
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define OR_ALL (OR_LIMIT|OR_OPTIONS|OR_FILEINFO|OR_AUTHCFG|OR_INDEXES)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/**
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * This can be returned by a function if they don't wish to handle
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * a command. Make it something not likely someone will actually use
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * as an error code.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @defvar DECLINE_CMD "\a\b"
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define DECLINE_CMD "\a\b"
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmektypedef struct ap_configfile_t ap_configfile_t;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/** Common structure for reading of config files / passwd files etc. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekstruct ap_configfile_t {
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** a getc()-like function
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc int getch(void *param) */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek int (*getch) (void *param);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** a fgets()-like function
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc void *getstr(void *buf, size_t bufsize, void *param)*/
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *(*getstr) (void *buf, size_t bufsiz, void *param);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** a close hander function
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * @deffunc int close(void *param)*/
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek int (*close) (void *param);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** the argument passed to getch/getstr/close */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *param;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** the filename / description */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *name;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** current line number, starting at 1 */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek unsigned line_number;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek};
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/**
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * This structure is passed to a command which is being invoked,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * to carry a large variety of miscellaneous data which is all of
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * use to *somebody*...
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekstruct cmd_parms_struct {
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Argument to command from cmd_table */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *info;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Which allow-override bits are set */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek int override;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Which methods are <Limit>ed */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek int limited;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek apr_array_header_t *limited_xmethods;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek ap_method_list_t *xlimited;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Config file structure. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek ap_configfile_t *config_file;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** the directive specifying this command */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek ap_directive_t *directive;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Pool to allocate new storage in */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek apr_pool_t *pool;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Pool for scratch memory; persists during configuration, but
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * wiped before the first request is served... */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek apr_pool_t *temp_pool;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Server_rec being configured for */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek server_rec *server;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** If configuring for a directory, pathname of that directory.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * NOPE! That's what it meant previous to the existance of <Files>,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * <Location> and regex matching. Now the only usefulness that can be
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * derived from this field is whether a command is being called in a
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * server context (path == NULL) or being called in a dir context
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * (path != NULL). */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek char *path;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** configuration command */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const command_rec *cmd;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** per_dir_config vector passed to handle_command */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek struct ap_conf_vector_t *context;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** directive with syntax error */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const ap_directive_t *err_directive;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek};
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmektypedef struct module_struct module;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/**
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Module structures. Just about everything is dispatched through
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * these, directly or indirectly (through the command and handler
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * tables).
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekstruct module_struct {
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** API version, *not* module version; check that module is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * compatible with this version of the server.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek int version;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** API minor version. Provides API feature milestones. Not checked
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * during module init */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek int minor_version;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Index to this modules structures in config vectors. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek int module_index;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** The name of the module's C file */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek const char *name;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** The handle for the DSO. Internal use only */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *dynamic_load_handle;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** A pointer to the next module in the list
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @defvar module_struct *next */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek struct module_struct *next;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Magic Cookie to identify a module structure; It's mainly
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * important for the DSO facility (see also mod_so). */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek unsigned long magic;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Function to allow MPMs to re-write command line arguments. This
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * hook is only available to MPMs.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param The process that the server is running in.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc void rewrite_args(process_rec *process);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void (*rewrite_args) (process_rec *process);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Function to allow all modules to create per directory configuration
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * structures.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param p The pool to use for all allocations.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param dir The directory currently being processed.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @return The per-directory structure created
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc void *create_dir_config(apr_pool_t *p, char *dir)
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *(*create_dir_config) (apr_pool_t *p, char *dir);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Function to allow all modules to merge the per directory configuration
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * structures for two directories.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param p The pool to use for all allocations.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param base_conf The directory structure created for the parent directory.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param new_conf The directory structure currently being processed.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @return The new per-directory structure created
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc void *merge_dir_config(apr_pool_t *p, void *base_conf, void *new_conf)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *(*merge_dir_config) (apr_pool_t *p, void *base_conf, void *new_conf);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Function to allow all modules to create per server configuration
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * structures.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param p The pool to use for all allocations.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param s The server currently being processed.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @return The per-server structure created
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc void *create_server_config(apr_pool_t *p, server_rec *dir)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *(*create_server_config) (apr_pool_t *p, server_rec *s);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Function to allow all modules to merge the per server configuration
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * structures for two servers.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param p The pool to use for all allocations.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param base_conf The directory structure created for the parent directory.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param new_conf The directory structure currently being processed.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @return The new per-directory structure created
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc void *merge_dir_config(apr_pool_t *p, void *base_conf, void *new_conf)
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek void *(*merge_server_config) (apr_pool_t *p, void *base_conf, void *new_conf);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** A command_rec table that describes all of the directives this module
6c1695be47b2830c79e128e4d05d760eb862184eLennart Poettering * defines. */
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen const command_rec *cmds;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
7abaad1ab099b077ebd6452b14ef351483831245poma /** A hook to allow modules to hook other points in the request processing.
7abaad1ab099b077ebd6452b14ef351483831245poma * In this function, modules should call the ap_hook_*() functions to
7abaad1ab099b077ebd6452b14ef351483831245poma * register an interest in a specific step in processing the current
7abaad1ab099b077ebd6452b14ef351483831245poma * request.
7abaad1ab099b077ebd6452b14ef351483831245poma * @param p the pool to use for all allocations
7abaad1ab099b077ebd6452b14ef351483831245poma * @deffunc void register_hooks(void)
7abaad1ab099b077ebd6452b14ef351483831245poma */
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen void (*register_hooks) (apr_pool_t *p);
7abaad1ab099b077ebd6452b14ef351483831245poma};
7abaad1ab099b077ebd6452b14ef351483831245poma
7abaad1ab099b077ebd6452b14ef351483831245poma/* Initializer for the first few module slots, which are only
7abaad1ab099b077ebd6452b14ef351483831245poma * really set up once we start running. Note that the first two slots
7abaad1ab099b077ebd6452b14ef351483831245poma * provide a version check; this should allow us to deal with changes to
7abaad1ab099b077ebd6452b14ef351483831245poma * the API. The major number should reflect changes to the API handler table
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * itself or removal of functionality. The minor number should reflect
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * additions of functionality to the existing API. (the server can detect
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * an old-format module, and either handle it back-compatibly, or at least
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * signal an error). See src/include/ap_mmn.h for MMN version history.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define STANDARD_MODULE_STUFF this_module_needs_to_be_ported_to_apache_2_0
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek MODULE_MAGIC_NUMBER_MINOR, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek -1, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek __FILE__, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek NULL, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek NULL, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek MODULE_MAGIC_COOKIE, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek NULL /* rewrite args spot */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define MPM20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek MODULE_MAGIC_NUMBER_MINOR, \
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek -1, \
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen __FILE__, \
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen NULL, \
NULL, \
MODULE_MAGIC_COOKIE
/* CONFIGURATION VECTOR FUNCTIONS */
typedef struct ap_conf_vector_t ap_conf_vector_t;
#ifdef AP_DEBUG
/**
* 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
* @deffunc void *ap_get_module_config(const ap_conf_vector_t *cv, module *m)
*/
AP_DECLARE(void *) ap_get_module_config(const ap_conf_vector_t *cv,
const module *m);
/**
* 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
* @deffunc void ap_set_module_config(ap_conf_vector_t *cv, const module *m, void *val)
*/
AP_DECLARE(void) ap_set_module_config(ap_conf_vector_t *cv, const module *m,
void *val);
#else /* AP_DEBUG */
#define ap_get_module_config(v,m) \
(((void **)(v))[(m)->module_index])
#define ap_set_module_config(v,m,val) \
((((void **)(v))[(m)->module_index]) = (val))
#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
* @deffunc const char *ap_set_string_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
*/
AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *cmd, void *struct_ptr,
const char *arg);
/**
* 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
* @deffunc ap_method_is_limited(cmd_parms *cmd, const char *method)
*/
AP_DECLARE(int) ap_method_is_limited(cmd_parms *cmd, const char *method);
/**
* 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
* @deffunc const char *ap_set_string_slot_lower(cmd_parms *cmd, void *struct_ptr, const char *arg)
*/
AP_DECLARE_NONSTD(const char *) ap_set_string_slot_lower(cmd_parms *cmd,
void *struct_ptr, const char *arg);
/**
* 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
* @deffunc const char *ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg)
*/
AP_DECLARE_NONSTD(const char *) ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg);
/**
* 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
* @deffunc const char *ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
*/
AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg);
/**
* For modules which need to read config files, open logs, etc. ...
* this returns the fname argument if it begins with '/'; otherwise
* it relativizes it wrt server_root.
* @param p pool to allocate data out of
* @param fname The file name
* @deffunc const char *ap_server_root_relative(apr_pool_t *p, const char *fname)
*/
AP_DECLARE(const char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
/* 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
* @deffunc void ap_add_module(module *m, apr_pool_t *p)
*/
AP_DECLARE(void) ap_add_module(module *m, apr_pool_t *p);
/**
* 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
* @deffunc void ap_remove_module(module *m)
*/
AP_DECLARE(void) ap_remove_module(module *m);
/**
* 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
* @deffunc void ap_add_loaded_module(module *m, apr_pool_t *p)
*/
AP_DECLARE(void) ap_add_loaded_module(module *mod, apr_pool_t *p);
/**
* Remove a module fromthe chained modules list and the list of loaded modules
* @param m the module structure of the module to remove
* @deffunc void ap_remove_loaded_module(module *m)
*/
AP_DECLARE(void) ap_remove_loaded_module(module *mod);
/**
* 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
* @deffunc int ap_add_named_module(const char *name, apr_pool_t *p)
*/
AP_DECLARE(int) ap_add_named_module(const char *name, apr_pool_t *p);
/**
* Find the name of the specified module
* @param m The module to get the name for
* @return the name of the module
* @deffunc const char *ap_find_module_name(module *m)
*/
AP_DECLARE(const char *) ap_find_module_name(module *m);
/**
* 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
* @deffunc module *ap_find_linked_module(const char *name)
*/
AP_DECLARE(module *) ap_find_linked_module(const char *name);
/**
* 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 out of
* @param name the name of the file to open
* @deffunc apr_status_t ap_pcfg_openfile(ap_configfile_t **ret_cfg, apr_pool_t *p, const char *name)
*/
AP_DECLARE(apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg, apr_pool_t *p, const char *name);
/**
* Allocate a ap_configfile_t handle with user defined functions and params
* @param p The pool to allocate out of
* @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
* @deffunc ap_configfile_t *ap_pcfg_open_custom(apr_pool_t *p, const char *descr, void *param, int(*getc_func)(void*), void *(*gets_func) (void *buf, size_t bufsiz, void *param), int(*close_func)(void *param))
*/
AP_DECLARE(ap_configfile_t *) ap_pcfg_open_custom(apr_pool_t *p, const char *descr,
void *param,
int(*getc_func)(void*),
void *(*gets_func) (void *buf, size_t bufsiz, void *param),
int(*close_func)(void *param));
/**
* 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
* @deffunc int ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp)
*/
AP_DECLARE(int) ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp);
/**
* Read one char from open configfile_t, increase line number upon LF
* @param cfp The file to read from
* @return the character read
* @deffunc int ap_cfg_getc(ap_configfile_t *cfp)
*/
AP_DECLARE(int) ap_cfg_getc(ap_configfile_t *cfp);
/**
* Detach from open ap_configfile_t, calling the close handler
* @param cfp The file to close
* @return 1 on sucess, 0 on failure
* @deffunc int ap_cfg_closefile(ap_configfile_t *cfp)
*/
AP_DECLARE(int) ap_cfg_closefile(ap_configfile_t *cfp);
/**
* 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
* @retrn Error string on failure, NULL on success
* @deffunc const char *ap_soak_end_container(cmd_parms *cmd, char *directive)
*/
AP_DECLARE(const char *) ap_soak_end_container(cmd_parms *cmd, char *directive);
/**
* Read all data between the current <foo> and the matching </foo> and build
* a config tree out of it
* @param p pool to allocate out of
* @param temp_pool Temporary pool to allocate out of
* @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
* @deffunc char *ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool, cmd_parms *parms, ap_directive_t **current, ap_directive_t **curr_parent, char *orig_directive)
*/
const char * ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool,
cmd_parms *parms,
ap_directive_t **current,
ap_directive_t **curr_parent,
char *orig_directive);
/**
* 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
* @deffunc const char *ap_build_config(cmd_parms *parms, apr_pool_t *conf_pool, apr_pool_t *temp_pool, ap_directive_t **conftree)
*/
AP_DECLARE(const char *) ap_build_config(cmd_parms *parms,
apr_pool_t *conf_pool,
apr_pool_t *temp_pool,
ap_directive_t **conftree);
/**
* 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
* @deffunc const char *ap_walk_config(ap_directive_t *conftree, cmd_parms *parms, ap_conf_vector_t *section_vector)
*/
AP_DECLARE(const char *) ap_walk_config(ap_directive_t *conftree,
cmd_parms *parms,
ap_conf_vector_t *section_vector);
/**
* ap_check_cmd_context() definitions:
* @param cmd The cmd_context to check
* @param forbidden Where the command is forbidden. One of:
* <PRE>
* NOT_IN_VIRTUALHOST
* NOT_IN_LIMIT
* NOT_IN_DIRECTORY
* NOT_IN_LOCATION
* NOT_IN_FILES
* NOT_IN_DIR_LOC_FILE
* GLOBAL_ONLY
* </PRE>
* @return Error string on error, NULL on success
* @deffunc const char *ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden)
*/
AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden);
/* ap_check_cmd_context(): Forbidden in: */
#define NOT_IN_VIRTUALHOST 0x01 /* <Virtualhost> */
#define NOT_IN_LIMIT 0x02 /* <Limit> */
#define NOT_IN_DIRECTORY 0x04 /* <Directory> */
#define NOT_IN_LOCATION 0x08 /* <Location> */
#define NOT_IN_FILES 0x10 /* <Files> */
#define NOT_IN_DIR_LOC_FILE (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES) /* <Directory>/<Location>/<Files>*/
#define GLOBAL_ONLY (NOT_IN_VIRTUALHOST|NOT_IN_LIMIT|NOT_IN_DIR_LOC_FILE)
#ifdef CORE_PRIVATE
/**
* The topmost module in the list
* @defvar module *top_module
*/
AP_DECLARE_DATA extern module *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 out of
* @param s The server to configure for.
* @param m The module to configure
*/
AP_DECLARE(void) ap_single_module_configure(apr_pool_t *p, server_rec *s,
module *m);
/* 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
* @deffunc void ap_setup_prelinked_modules(process_rec *process)
*/
AP_DECLARE(void) ap_setup_prelinked_modules(process_rec *process);
/**
*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.
* @deffunc void ap_show_directives(void)
*/
AP_DECLARE(void) ap_show_directives(void);
/**
* Show the preloaded module names. Used for httpd -l.
* @deffunc void ap_show_modules(void)
*/
AP_DECLARE(void) ap_show_modules(void);
/**
* Read all config files and setup the server
* @param process The process running the server
* @param temp_pool A pool to allocate temporary data out of.
* @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.
* @deffunc server_rec *ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree)
*/
AP_DECLARE(server_rec *) ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree);
/**
* Run all rewrite args hooks for loaded modules
* @param process The process currently running the server
* @deffunc void ap_run_rewrite_args(process_rec *process)
*/
AP_DECLARE(void) ap_run_rewrite_args(process_rec *process);
/**
* 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
* @deffunc void ap_register_hooks(module *m, apr_pool_t *p)
*/
AP_DECLARE(void) ap_register_hooks(module *m, apr_pool_t *p);
/**
* Setup all virtual hosts
* @param p The pool to allocate out of
* @param main_server The head of the server_rec list
* @deffunc void ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server)
*/
AP_DECLARE(void) ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server);
/* For http_request.c... */
/**
* Setup the config vector for a request_rec
* @param p The pool to allocate the config vector out of
* @return The config vector
*/
ap_conf_vector_t *ap_create_request_config(apr_pool_t *p);
/**
* Setup the config vector for per dir module configs
* @param p The pool to allocate the config vector out of
* @return The config vector
* @deffunc ap_conf_vector_t *ap_create_per_dir_config(apr_pool_t *p)
*/
AP_CORE_DECLARE(ap_conf_vector_t *) ap_create_per_dir_config(apr_pool_t *p);
/**
* 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
*/
ap_conf_vector_t *ap_merge_per_dir_configs(apr_pool_t *p,
ap_conf_vector_t *base,
ap_conf_vector_t *new_conf);
/* For http_connection.c... */
/**
* Setup the config vector for a connection_rec
* @param p The pool to allocate the config vector out of
* @return The config vector
*/
ap_conf_vector_t *ap_create_conn_config(apr_pool_t *p);
/* 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
*/
int ap_parse_htaccess(ap_conf_vector_t **result, request_rec *r, int override,
const char *path, const char *access_name);
/**
* Setup a virtual host
* @param p The pool to allocate all memory out of
* @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
* @deffunc const char *ap_init_virtual_host(apr_pool_t *p, const char *hostname, server_rec *main_server, server_rec **ps)
*/
AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p, const char *hostname,
server_rec *main_server, server_rec **);
/**
* 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
*/
void ap_process_resource_config(server_rec *s, const char *fname,
ap_directive_t **conftree, apr_pool_t *p, apr_pool_t *ptemp);
/**
* 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
*/
AP_DECLARE(void) ap_process_config_tree(server_rec *s, ap_directive_t *conftree,
apr_pool_t *p, apr_pool_t *ptemp);
/* 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
*/
int ap_invoke_handler(request_rec *);
/* 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
* @deffunc const command_rec *ap_find_command(const char *name, const command_rec *cmds)
*/
AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name, const command_rec *cmds);
/**
* 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
* @deffunc const command_rec *ap_find_command_in_modules(const char *cmd_name,module **mod)
*/
AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name, module **mod);
/**
* 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.
* @deffunc void *ap_set_config_vectors(server_rec *server, ap_conf_vector_t *section_vector, const char *dir, module *mod, apr_pool_t *pconf)
*/
AP_CORE_DECLARE(void *) ap_set_config_vectors(server_rec *server,
ap_conf_vector_t *section_vector,
const char *section,
module *mod, apr_pool_t *pconf);
#endif
/* Hooks */
/**
* Run the header parser functions for each module
* @param r The current request
* @return OK or DECLINED
* @deffunc int ap_run_header_parser(request_rec *r)
*/
AP_DECLARE_HOOK(int,header_parser,(request_rec *r))
/**
* Run the pre_config function for each module
* @param pconf The config pool
* @param plog The logging streams pool
* @param ptemp The temporary pool
* @deffunc void ap_run_pre_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp)
*/
AP_DECLARE_HOOK(void,pre_config,
(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp))
/**
* 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
* @deffunc void ap_run_post_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
*/
AP_DECLARE_HOOK(void,post_config,
(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
/**
* 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
* @deffunc void ap_run_open_logs(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
*/
AP_DECLARE_HOOK(void,open_logs,
(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
/**
* Run the child_init functions for each module
* @param pchild The child pool
* @param s The list of server_recs in this server
* @deffunc void ap_run_child_init(apr_pool_t *pchild, server_rec *s)
*/
AP_DECLARE_HOOK(void,child_init,(apr_pool_t *pchild, server_rec *s))
/**
* Run the handler functions for each module
* @param r The request_rec
* @tip non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
* @deffunc void ap_run_handler(request_rec *r)
*/
AP_DECLARE_HOOK(int,handler,(request_rec *r))
/**
* 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.
* @deffunc void ap_run_optional_fn_retrieve(void)
*/
AP_DECLARE_HOOK(void,optional_fn_retrieve,(void))
#ifdef __cplusplus
}
#endif
#endif /* !APACHE_HTTP_CONFIG_H */