1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * @brief Server Side Include Filter Extension Module for Apache
21 * @defgroup MOD_INCLUDE mod_include
22 * @ingroup APACHE_MODS
26 #ifndef _MOD_INCLUDE_H
27 #define _MOD_INCLUDE_H 1
29 #include "apr_pools.h"
30 #include "apr_optional.h"
33 * Constants used for ap_ssi_get_tag_and_value's decode parameter
35 #define SSI_VALUE_DECODED 1
36 #define SSI_VALUE_RAW 0
39 * Constants used for ap_ssi_parse_string's leave_name parameter
41 #define SSI_EXPAND_LEAVE_NAME 1
42 #define SSI_EXPAND_DROP_NAME 0
45 * This macro creates a bucket which contains an error message and appends it
46 * to the current pass brigade
48 #define SSI_CREATE_ERROR_BUCKET(ctx, f, bb) APR_BRIGADE_INSERT_TAIL((bb), \
49 apr_bucket_pool_create(apr_pstrdup((ctx)->pool, (ctx)->error_str), \
50 strlen((ctx)->error_str), (ctx)->pool, \
51 (f)->c->bucket_alloc))
54 * These constants are used to set or clear flag bits.
56 #define SSI_FLAG_PRINTING (1<<0) /* Printing conditional lines. */
57 #define SSI_FLAG_COND_TRUE (1<<1) /* Conditional eval'd to true. */
58 #define SSI_FLAG_SIZE_IN_BYTES (1<<2) /* Sizes displayed in bytes. */
59 #define SSI_FLAG_NO_EXEC (1<<3) /* No Exec in current context. */
61 #define SSI_FLAG_SIZE_ABBREV (~(SSI_FLAG_SIZE_IN_BYTES))
62 #define SSI_FLAG_CLEAR_PRINT_COND (~((SSI_FLAG_PRINTING) | \
63 (SSI_FLAG_COND_TRUE)))
64 #define SSI_FLAG_CLEAR_PRINTING (~(SSI_FLAG_PRINTING))
67 * The public SSI context structure
70 /* permanent pool, use this for creating bucket data */
73 /* temp pool; will be cleared after the execution of every directive */
76 /* See the SSI_FLAG_XXXXX definitions. */
79 /* nesting of *invisible* ifs */
82 /* if true, the current buffer will be passed down the filter chain before
83 * continuing with next input bucket and the variable will be reset to
88 /* argument counter (of the current directive) */
91 /* currently configured error string */
92 const char *error_str;
94 /* currently configured time format */
97 /* the current request */
100 /* pointer to internal (non-public) data, don't touch */
101 struct ssi_internal_ctx *intern;
105 typedef apr_status_t (include_handler_fn_t)(include_ctx_t *, ap_filter_t *,
106 apr_bucket_brigade *);
108 APR_DECLARE_OPTIONAL_FN(void, ap_ssi_get_tag_and_value,
109 (include_ctx_t *ctx, char **tag, char **tag_val,
112 APR_DECLARE_OPTIONAL_FN(char*, ap_ssi_parse_string,
113 (include_ctx_t *ctx, const char *in, char *out,
114 apr_size_t length, int leave_name));
116 APR_DECLARE_OPTIONAL_FN(void, ap_register_include_handler,
117 (char *tag, include_handler_fn_t *func));
119 #endif /* MOD_INCLUDE */