mod_include.h revision 9d129b55f5a43abf43865c6b0eb6dd19bc22aba8
08cb74ca432a8c24e39f17dedce527e6a47b8001jerenkrantz/* Copyright 2000-2005 The Apache Software Foundation or its licensors, as
08cb74ca432a8c24e39f17dedce527e6a47b8001jerenkrantz * applicable.
18343797fadabacf01280b38ea7688690d12aec0rbb *
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * Licensed under the Apache License, Version 2.0 (the "License");
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * you may not use this file except in compliance with the License.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * You may obtain a copy of the License at
18343797fadabacf01280b38ea7688690d12aec0rbb *
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * http://www.apache.org/licenses/LICENSE-2.0
18343797fadabacf01280b38ea7688690d12aec0rbb *
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * Unless required by applicable law or agreed to in writing, software
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * distributed under the License is distributed on an "AS IS" BASIS,
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * See the License for the specific language governing permissions and
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * limitations under the License.
18343797fadabacf01280b38ea7688690d12aec0rbb */
18343797fadabacf01280b38ea7688690d12aec0rbb
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/**
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @file mod_include.h
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @brief Server Side Include Filter Extension Module for Apache
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh *
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @defgroup MOD_INCLUDE mod_include
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @ingroup APACHE_MODS
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @{
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
18343797fadabacf01280b38ea7688690d12aec0rbb#ifndef _MOD_INCLUDE_H
18343797fadabacf01280b38ea7688690d12aec0rbb#define _MOD_INCLUDE_H 1
18343797fadabacf01280b38ea7688690d12aec0rbb
7f1533cc21a93c0744bd40e697ba610a5b1cb68fianh#include "apr_pools.h"
9879245661cccfaece04770166d76312431446f7wrowe#include "apr_optional.h"
7f1533cc21a93c0744bd40e697ba610a5b1cb68fianh
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd/*
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd * Constants used for ap_ssi_get_tag_and_value's decode parameter
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_VALUE_DECODED 1
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_VALUE_RAW 0
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd/*
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd * Constants used for ap_ssi_parse_string's leave_name parameter
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_EXPAND_LEAVE_NAME 1
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_EXPAND_DROP_NAME 0
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd/*
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd * This macro creates a bucket which contains an error message and appends it
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd * to the current pass brigade
18343797fadabacf01280b38ea7688690d12aec0rbb */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_CREATE_ERROR_BUCKET(ctx, f, bb) APR_BRIGADE_INSERT_TAIL((bb), \
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd apr_bucket_pool_create(apr_pstrdup((ctx)->pool, (ctx)->error_str), \
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd strlen((ctx)->error_str), (ctx)->pool, \
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd (f)->c->bucket_alloc))
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd/*
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd * These constants are used to set or clear flag bits.
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_FLAG_PRINTING (1<<0) /* Printing conditional lines. */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_FLAG_COND_TRUE (1<<1) /* Conditional eval'd to true. */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_FLAG_SIZE_IN_BYTES (1<<2) /* Sizes displayed in bytes. */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_FLAG_NO_EXEC (1<<3) /* No Exec in current context. */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_FLAG_SIZE_ABBREV (~(SSI_FLAG_SIZE_IN_BYTES))
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_FLAG_CLEAR_PRINT_COND (~((SSI_FLAG_PRINTING) | \
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd (SSI_FLAG_COND_TRUE)))
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd#define SSI_FLAG_CLEAR_PRINTING (~(SSI_FLAG_PRINTING))
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd/*
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd * The public SSI context structure
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fndtypedef struct {
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* permanent pool, use this for creating bucket data */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd apr_pool_t *pool;
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* temp pool; will be cleared after the execution of every directive */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd apr_pool_t *dpool;
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* See the SSI_FLAG_XXXXX definitions. */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd int flags;
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* nesting of *invisible* ifs */
18343797fadabacf01280b38ea7688690d12aec0rbb int if_nesting_level;
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* if true, the current buffer will be passed down the filter chain before
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd * continuing with next input bucket and the variable will be reset to
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd * false.
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd int flush_now;
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* argument counter (of the current directive) */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd unsigned argc;
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* currently configured error string */
f653f18d041eee9b4f4d5cbfff9bb51d46390f60nd const char *error_str;
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* currently configured time format */
f653f18d041eee9b4f4d5cbfff9bb51d46390f60nd const char *time_str;
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd /* pointer to internal (non-public) data, don't touch */
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd struct ssi_internal_ctx *intern;
18343797fadabacf01280b38ea7688690d12aec0rbb} include_ctx_t;
18343797fadabacf01280b38ea7688690d12aec0rbb
31cd7345e3f8257a89ef1f5ab344fb037c0d941fndtypedef apr_status_t (include_handler_fn_t)(include_ctx_t *, ap_filter_t *,
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd apr_bucket_brigade *);
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fndAPR_DECLARE_OPTIONAL_FN(void, ap_ssi_get_tag_and_value,
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd (include_ctx_t *ctx, char **tag, char **tag_val,
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd int dodecode));
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
31cd7345e3f8257a89ef1f5ab344fb037c0d941fndAPR_DECLARE_OPTIONAL_FN(char*, ap_ssi_parse_string,
98ebafaf350a6b091fe22c2899a80f7855c70a66nd (include_ctx_t *ctx, const char *in, char *out,
98ebafaf350a6b091fe22c2899a80f7855c70a66nd apr_size_t length, int leave_name));
31cd7345e3f8257a89ef1f5ab344fb037c0d941fnd
e08a1745d191d666759873a50edcc520ca273e12wroweAPR_DECLARE_OPTIONAL_FN(void, ap_register_include_handler,
e08a1745d191d666759873a50edcc520ca273e12wrowe (char *tag, include_handler_fn_t *func));
f6e9f5600e77b78fb013bb543d364135961639d1rbb
18343797fadabacf01280b38ea7688690d12aec0rbb#endif /* MOD_INCLUDE */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/** @} */