1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * ====================================================================
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
60 * http_include.c: Handles the server-parsed HTML documents
62 * Original by Rob McCool; substantial fixups by David Robinson;
63 * incorporated into the Apache module framework by rst.
68 #include "apr_strings.h"
69 #include "apr_thread_proc.h"
73 #include "apr_optional.h"
75 #define APR_WANT_STRFUNC
80 #include "ap_config.h"
81 #include "util_filter.h"
83 #include "http_config.h"
84 #include "http_core.h"
85 #include "http_request.h"
86 #include "http_core.h"
87 #include "http_protocol.h"
89 #include "http_main.h"
90 #include "util_script.h"
91 #include "http_core.h"
92 #include "mod_include.h"
93 #include "util_ebcdic.h"
95 module AP_MODULE_DECLARE_DATA include_module;
96 static apr_hash_t *include_hash;
97 static APR_OPTIONAL_FN_TYPE(ap_register_include_handler) *ssi_pfn_register;
99 #define BYTE_COUNT_THRESHOLD AP_MIN_BYTES_TO_WRITE
101 /* ------------------------ Environment function -------------------------- */
103 /* XXX: could use ap_table_overlap here */
104 static void add_include_vars(request_rec *r, char *timefmt)
107 apr_table_t *e = r->subprocess_env;
109 apr_time_t date = r->request_time;
111 apr_table_setn(e, "DATE_LOCAL", ap_ht_time(r->pool, date, timefmt, 0));
112 apr_table_setn(e, "DATE_GMT", ap_ht_time(r->pool, date, timefmt, 1));
113 apr_table_setn(e, "LAST_MODIFIED",
114 ap_ht_time(r->pool, r->finfo.mtime, timefmt, 0));
115 apr_table_setn(e, "DOCUMENT_URI", r->uri);
116 apr_table_setn(e, "DOCUMENT_PATH_INFO", r->path_info);
117 if (apr_get_username(&pwname, r->finfo.user, r->pool) == APR_SUCCESS) {
118 apr_table_setn(e, "USER_NAME", pwname);
121 apr_table_setn(e, "USER_NAME", "<unknown>");
123 if ((t = strrchr(r->filename, '/'))) {
124 apr_table_setn(e, "DOCUMENT_NAME", ++t);
127 apr_table_setn(e, "DOCUMENT_NAME", r->uri);
130 char *arg_copy = apr_pstrdup(r->pool, r->args);
132 ap_unescape_url(arg_copy);
133 apr_table_setn(e, "QUERY_STRING_UNESCAPED",
134 ap_escape_shell_cmd(r->pool, arg_copy));
140 /* --------------------------- Parser functions --------------------------- */
142 /* This function returns either a pointer to the split bucket containing the
143 * first byte of the BEGINNING_SEQUENCE (after finding a complete match) or it
144 * returns NULL if no match found.
146 static apr_bucket *find_start_sequence(apr_bucket *dptr, include_ctx_t *ctx,
147 apr_bucket_brigade *bb, int *do_cleanup)
152 const char *str = STARTING_SEQUENCE;
154 apr_size_t start_index;
159 if (APR_BUCKET_IS_EOS(dptr)) {
162 apr_bucket_read(dptr, &buf, &len, APR_BLOCK_READ);
163 /* XXX handle retcodes */
164 if (len == 0) { /* end of pipe? */
168 while (c - buf != len) {
169 if (ctx->bytes_parsed >= BYTE_COUNT_THRESHOLD) {
170 apr_bucket *start_bucket;
172 if (ctx->head_start_index > 0) {
173 start_index = ctx->head_start_index;
174 start_bucket = ctx->head_start_bucket;
177 start_index = (c - buf);
180 apr_bucket_split(start_bucket, start_index);
181 tmp_bkt = APR_BUCKET_NEXT(start_bucket);
182 if (ctx->head_start_index > 0) {
183 ctx->head_start_index = 0;
184 ctx->head_start_bucket = tmp_bkt;
190 if (*c == str[ctx->parse_pos]) {
191 if (ctx->state == PRE_HEAD) {
192 ctx->state = PARSE_HEAD;
193 ctx->head_start_bucket = dptr;
194 ctx->head_start_index = c - buf;
199 if (str[ctx->parse_pos] == '\0') {
200 /* We want to split the bucket at the '<'. */
202 ctx->state = PARSE_DIRECTIVE;
205 ctx->tag_start_bucket = dptr;
206 ctx->tag_start_index = c - buf;
207 if (ctx->head_start_index > 0) {
208 start_index = (c - buf) - ctx->head_start_index;
209 apr_bucket_split(ctx->head_start_bucket, ctx->head_start_index);
210 tmp_bkt = APR_BUCKET_NEXT(ctx->head_start_bucket);
211 if (dptr == ctx->head_start_bucket) {
212 ctx->tag_start_bucket = tmp_bkt;
213 ctx->tag_start_index = start_index;
215 ctx->head_start_bucket = tmp_bkt;
216 ctx->head_start_index = 0;
218 return ctx->head_start_bucket;
220 else if (ctx->parse_pos != 0) {
221 /* The reason for this, is that we need to make sure
222 * that we catch cases like <<!--#. This makes the
223 * second check after the original check fails.
224 * If parse_pos was already 0 then we already checked this.
229 ctx->state = PARSE_HEAD;
230 ctx->head_start_bucket = dptr;
231 ctx->head_start_index = c - buf;
235 ctx->state = PRE_HEAD;
236 ctx->head_start_bucket = NULL;
237 ctx->head_start_index = 0;
244 dptr = APR_BUCKET_NEXT(dptr);
245 } while (dptr != APR_BRIGADE_SENTINEL(bb));
249 static apr_bucket *find_end_sequence(apr_bucket *dptr, include_ctx_t *ctx, apr_bucket_brigade *bb)
254 const char *str = ENDING_SEQUENCE;
257 if (APR_BUCKET_IS_EOS(dptr)) {
260 apr_bucket_read(dptr, &buf, &len, APR_BLOCK_READ);
261 /* XXX handle retcodes */
262 if (len == 0) { /* end of pipe? */
265 if (dptr == ctx->tag_start_bucket) {
266 c = buf + ctx->tag_start_index;
271 while (c - buf != len) {
272 if (ctx->bytes_parsed >= BYTE_COUNT_THRESHOLD) {
276 if (*c == str[ctx->parse_pos]) {
277 if (ctx->state != PARSE_TAIL) {
278 ctx->state = PARSE_TAIL;
279 ctx->tail_start_bucket = dptr;
280 ctx->tail_start_index = c - buf;
285 if (ctx->state == PARSE_DIRECTIVE) {
286 if (ctx->tag_length == 0) {
287 if (!apr_isspace(*c)) {
288 ctx->tag_start_bucket = dptr;
289 ctx->tag_start_index = c - buf;
291 ctx->directive_length = 1;
295 if (!apr_isspace(*c)) {
296 ctx->directive_length++;
299 ctx->state = PARSE_TAG;
304 else if (ctx->state == PARSE_TAG) {
308 if (str[ctx->parse_pos] == '\0') {
309 apr_bucket *tmp_buck = dptr;
311 /* We want to split the bucket at the '>'. The
312 * end of the END_SEQUENCE is in the current bucket.
313 * The beginning might be in a previous bucket.
318 apr_bucket_split(dptr, c - buf);
319 tmp_buck = APR_BUCKET_NEXT(dptr);
323 else if (ctx->parse_pos != 0) {
324 /* The reason for this, is that we need to make sure
325 * that we catch cases like --->. This makes the
326 * second check after the original check fails.
327 * If parse_pos was already 0 then we already checked this.
329 ctx->tag_length += ctx->parse_pos;
332 ctx->state = PARSE_TAIL;
333 ctx->tail_start_bucket = dptr;
334 ctx->tail_start_index = c - buf;
335 ctx->tag_length += ctx->parse_pos;
339 if (ctx->tag_length > ctx->directive_length) {
340 ctx->state = PARSE_TAG;
343 ctx->state = PARSE_DIRECTIVE;
344 ctx->directive_length += ctx->parse_pos;
346 ctx->tail_start_bucket = NULL;
347 ctx->tail_start_index = 0;
348 ctx->tag_length += ctx->parse_pos;
357 dptr = APR_BUCKET_NEXT(dptr);
358 } while (dptr != APR_BRIGADE_SENTINEL(bb));
362 /* This function culls through the buckets that have been set aside in the
363 * ssi_tag_brigade and copies just the directive part of the SSI tag (none
364 * of the start and end delimiter bytes are copied).
366 static apr_status_t get_combined_directive (include_ctx_t *ctx,
368 apr_bucket_brigade *bb,
369 char *tmp_buf, int tmp_buf_size)
373 const char *tmp_from;
374 apr_size_t tmp_from_len;
376 /* If the tag length is longer than the tmp buffer, allocate space. */
377 if (ctx->tag_length > tmp_buf_size-1) {
378 if ((ctx->combined_tag = apr_pcalloc(r->pool, ctx->tag_length + 1)) == NULL) {
381 } /* Else, just use the temp buffer. */
383 ctx->combined_tag = tmp_buf;
386 /* Prime the pump. Start at the beginning of the tag... */
387 dptr = ctx->tag_start_bucket;
388 apr_bucket_read (dptr, &tmp_from, &tmp_from_len, 0); /* Read the bucket... */
390 /* Adjust the pointer to start at the tag within the bucket... */
391 if (dptr == ctx->tail_start_bucket) {
392 tmp_from_len -= (tmp_from_len - ctx->tail_start_index);
394 tmp_from = &tmp_from[ctx->tag_start_index];
395 tmp_from_len -= ctx->tag_start_index;
396 ctx->curr_tag_pos = ctx->combined_tag;
398 /* Loop through the buckets from the tag_start_bucket until before
399 * the tail_start_bucket copying the contents into the buffer.
402 memcpy (ctx->curr_tag_pos, tmp_from, tmp_from_len);
403 ctx->curr_tag_pos += tmp_from_len;
405 if (dptr == ctx->tail_start_bucket) {
409 dptr = APR_BUCKET_NEXT (dptr);
410 apr_bucket_read (dptr, &tmp_from, &tmp_from_len, 0);
411 /* Adjust the count to stop at the beginning of the tail. */
412 if (dptr == ctx->tail_start_bucket) {
413 tmp_from_len -= (tmp_from_len - ctx->tail_start_index);
417 ((ctx->curr_tag_pos - ctx->combined_tag) < ctx->tag_length));
419 ctx->combined_tag[ctx->tag_length] = '\0';
420 ctx->curr_tag_pos = ctx->combined_tag;
422 return (APR_SUCCESS);
426 * decodes a string containing html entities or numeric character references.
427 * 's' is overwritten with the decoded string.
428 * If 's' is syntatically incorrect, then the followed fixups will be made:
429 * unknown entities will be left undecoded;
430 * references to unused numeric characters will be deleted.
431 * In particular, � will not be decoded, but will be deleted.
436 /* maximum length of any ISO-LATIN-1 HTML entity name. */
437 #define MAXENTLEN (6)
439 /* The following is a shrinking transformation, therefore safe. */
441 static void decodehtml(char *s)
446 static const char * const entlist[MAXENTLEN + 1] =
450 "lt\074gt\076", /* 2 */
451 "amp\046ETH\320eth\360", /* 3 */
452 "quot\042Auml\304Euml\313Iuml\317Ouml\326Uuml\334auml\344euml\353\
453 iuml\357ouml\366uuml\374yuml\377", /* 4 */
454 "Acirc\302Aring\305AElig\306Ecirc\312Icirc\316Ocirc\324Ucirc\333\
455 THORN\336szlig\337acirc\342aring\345aelig\346ecirc\352icirc\356ocirc\364\
456 ucirc\373thorn\376", /* 5 */
457 "Agrave\300Aacute\301Atilde\303Ccedil\307Egrave\310Eacute\311\
458 Igrave\314Iacute\315Ntilde\321Ograve\322Oacute\323Otilde\325Oslash\330\
459 Ugrave\331Uacute\332Yacute\335agrave\340aacute\341atilde\343ccedil\347\
460 egrave\350eacute\351igrave\354iacute\355ntilde\361ograve\362oacute\363\
461 otilde\365oslash\370ugrave\371uacute\372yacute\375" /* 6 */
464 for (; *s != '\0'; s++, p++) {
469 /* find end of entity */
470 for (i = 1; s[i] != ';' && s[i] != '\0'; i++) {
474 if (s[i] == '\0') { /* treat as normal data */
479 /* is it numeric ? */
481 for (j = 2, val = 0; j < i && apr_isdigit(s[j]); j++) {
482 val = val * 10 + s[j] - '0';
485 if (j < i || val <= 8 || (val >= 11 && val <= 31) ||
486 (val >= 127 && val <= 160) || val >= 256) {
487 p--; /* no data to output */
490 *p = RAW_ASCII_CHAR(val);
495 if (j > MAXENTLEN || entlist[j] == NULL) {
498 continue; /* skip it */
500 for (ents = entlist[j]; *ents != '\0'; ents += i) {
501 if (strncmp(s + 1, ents, j) == 0) {
507 *p = '&'; /* unknown */
510 *p = RAW_ASCII_CHAR(((const unsigned char *) ents)[j]);
520 * Extract the next tag name and value.
521 * If there are no more tags, set the tag name to NULL.
522 * The tag value is html decoded if dodecode is non-zero.
523 * The tag value may be NULL if there is no tag value..
525 * [WS]<Tag>[WS]=[WS]['|"]<Value>['|"|WS]
528 #define SKIP_TAG_WHITESPACE(ptr) while ((*ptr != '\0') && (apr_isspace (*ptr))) ptr++
530 static void ap_ssi_get_tag_and_value(include_ctx_t *ctx, char **tag,
531 char **tag_val, int dodecode)
533 char *c = ctx->curr_tag_pos;
538 SKIP_TAG_WHITESPACE(c);
539 *tag = c; /* First non-whitespace character (could be NULL). */
541 while ((*c != '\0') && (*c != '=') && (!apr_isspace(*c))) {
542 *c = apr_tolower(*c); /* find end of tag, lowercasing as we go... */
546 if ((*c == '\0') || (**tag == '=')) {
547 if ((**tag == '\0') || (**tag == '=')) {
550 ctx->curr_tag_pos = c;
551 return; /* We have found the end of the buffer. */
552 } /* We might have a tag, but definitely no value. */
555 *c++ = '\0'; /* Overwrite the '=' with a terminating byte after tag. */
557 else { /* Try skipping WS to find the '='. */
558 *c++ = '\0'; /* Terminate the tag... */
559 SKIP_TAG_WHITESPACE(c);
561 if (*c != '=') { /* There needs to be an equal sign if there's a value. */
562 ctx->curr_tag_pos = c;
563 return; /* There apparently was no value. */
566 c++; /* Skip the equals sign. */
570 SKIP_TAG_WHITESPACE(c);
571 if (*c == '"' || *c == '\'') { /* Allow quoted values for space inclusion. */
572 term = *c++; /* NOTE: This does not pass the quotes on return. */
576 while ((*c != '\0') &&
577 (((term != '\0') && (*c != term)) ||
578 ((term == '\0') && (!apr_isspace(*c))))) {
579 if (*c == '\\') { /* Accept \" and \' as valid char in string. */
581 if (*c == term) { /* Overwrite the "\" during the embedded */
582 shift_val++; /* escape sequence of '\"' or "\'". Shift */
583 } /* bytes from here to next delimiter. */
595 *c++ = '\0'; /* Overwrites delimiter (term or WS) with NULL. */
596 ctx->curr_tag_pos = c;
598 decodehtml(*tag_val);
606 * Do variable substitution on strings
608 static void ap_ssi_parse_string(request_rec *r, const char *in, char *out,
609 size_t length, int leave_name)
615 /* leave room for nul terminator */
616 end_out = out + length - 1;
618 while ((ch = *in++) != '\0') {
621 if (next == end_out) {
635 const char *start_of_var_name;
636 char *end_of_var_name; /* end of var name + 1 */
637 const char *expansion, *temp_end, *val;
641 /* guess that the expansion won't happen */
645 start_of_var_name = in;
646 in = ap_strchr_c(in, '}');
648 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR,
649 0, r, "Missing '}' on variable \"%s\"",
655 end_of_var_name = (char *)temp_end;
659 start_of_var_name = in;
660 while (apr_isalnum(*in) || *in == '_') {
664 end_of_var_name = (char *)temp_end;
666 /* what a pain, too bad there's no table_getn where you can
667 * pass a non-nul terminated string */
668 l = end_of_var_name - start_of_var_name;
670 tmp_store = *end_of_var_name;
671 *end_of_var_name = '\0';
672 val = apr_table_get(r->subprocess_env, start_of_var_name);
673 *end_of_var_name = tmp_store;
677 l = strlen(expansion);
679 else if (leave_name) {
683 break; /* no expansion to be done */
687 /* zero-length variable name causes just the $ to be copied */
690 l = ((int)l > end_out - next) ? (end_out - next) : l;
691 memcpy(next, expansion, l);
696 if (next == end_out) {
709 /* --------------------------- Action handlers ---------------------------- */
711 /* ensure that path is relative, and does not contain ".." elements
712 * ensentially ensure that it does not match the regex:
713 * (^/|(^|/)\.\.(/|$))
714 * XXX: Needs to become apr_is_path_relative() test
716 static int is_only_below(const char *path)
718 #ifdef HAVE_DRIVE_LETTERS
723 if (strchr(path, ':')
726 if (path[0] == '/') {
731 while (path[dots] == '.')
734 /* If the name is canonical this is redundant
735 * but in security, redundancy is worthwhile.
736 * Does OS2 belong here (accepts ... for ..)?
738 if (dots > 1 && (!path[dots] || path[dots] == '/'))
741 if (dots == 2 && (!path[dots] || path[dots] == '/'))
745 while (*path && *(path++) != '/')
751 static int handle_include(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
752 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
755 char *tag_val = NULL;
756 apr_bucket *tmp_buck;
757 char parsed_string[MAX_STRING_LEN];
759 *inserted_head = NULL;
760 if (ctx->flags & FLAG_PRINTING) {
762 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 1);
763 if (tag_val == NULL) {
771 if (!strcmp(tag, "file") || !strcmp(tag, "virtual")) {
772 request_rec *rr = NULL;
773 char *error_fmt = NULL;
775 ap_ssi_parse_string(r, tag_val, parsed_string, sizeof(parsed_string), 0);
777 /* be safe; only files in this directory or below allowed */
778 if (!is_only_below(parsed_string)) {
779 error_fmt = "unable to include file \"%s\" "
783 rr = ap_sub_req_lookup_file(parsed_string, r, f->next);
787 rr = ap_sub_req_lookup_uri(parsed_string, r, f->next);
790 if (!error_fmt && rr->status != HTTP_OK) {
791 error_fmt = "unable to include \"%s\" in parsed file %s";
794 if (!error_fmt && (ctx->flags & FLAG_NO_EXEC) && rr->content_type
795 && (strncmp(rr->content_type, "text/", 5))) {
796 error_fmt = "unable to include potential exec \"%s\" "
799 if (error_fmt == NULL) {
800 /* try to avoid recursive includes. We do this by walking
801 * up the r->main list of subrequests, and at each level
802 * walking back through any internal redirects. At each
803 * step, we compare the filenames and the URIs.
805 * The filename comparison catches a recursive include
806 * with an ever-changing URL, eg.
807 * <!--#include virtual=
808 * "$REQUEST_URI/$QUERY_STRING?$QUERY_STRING/x"-->
809 * which, although they would eventually be caught because
810 * we have a limit on the length of files, etc., can
811 * recurse for a while.
813 * The URI comparison catches the case where the filename
814 * is changed while processing the request, so the
815 * current name is never the same as any previous one.
816 * This can happen with "DocumentRoot /foo" when you
817 * request "/" on the server and it includes "/".
818 * This only applies to modules such as mod_dir that
819 * (somewhat improperly) mess with r->filename outside
820 * of a filename translation phase.
824 for (p = r; p != NULL && !founddupe; p = p->main) {
826 for (q = p; q != NULL; q = q->prev) {
827 if ( (strcmp(q->filename, rr->filename) == 0) ||
828 (strcmp(q->uri, rr->uri) == 0) ){
836 error_fmt = "Recursive include of \"%s\" "
841 /* See the Kludge in send_parsed_file for why */
842 /* Basically, it puts a bread crumb in here, then looks */
843 /* for the crumb later to see if its been here. */
845 ap_set_module_config(rr->request_config, &include_module, r);
848 SPLIT_AND_PASS_PRETAG_BUCKETS(*bb, ctx, f->next);
850 if (ap_run_sub_req(rr)) {
851 error_fmt = "unable to include \"%s\" in parsed file %s";
855 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR,
856 0, r, error_fmt, tag_val, r->filename);
857 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
860 /* destroy the sub request if it's not a nested include (crumb) */
862 && ap_get_module_config(rr->request_config, &include_module)
863 != NESTED_INCLUDE_MAGIC) {
864 ap_destroy_sub_req(rr);
868 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
869 "unknown parameter \"%s\" to tag include in %s",
871 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
879 static int handle_echo(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
880 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
883 char *tag_val = NULL;
884 const char *echo_text = NULL;
885 apr_bucket *tmp_buck;
886 apr_size_t e_len, e_wrt;
887 enum {E_NONE, E_URL, E_ENTITY} encode;
891 *inserted_head = NULL;
892 if (ctx->flags & FLAG_PRINTING) {
894 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 1);
895 if (tag_val == NULL) {
903 if (!strcmp(tag, "var")) {
904 const char *val = apr_table_get(r->subprocess_env, tag_val);
908 case E_NONE: echo_text = val; break;
909 case E_URL: echo_text = ap_escape_uri(r->pool, val); break;
910 case E_ENTITY: echo_text = ap_escape_html(r->pool, val); break;
913 e_len = strlen(echo_text);
914 tmp_buck = apr_bucket_heap_create(echo_text, e_len, 1, &e_wrt);
917 tmp_buck = apr_bucket_immortal_create("(none)", sizeof("none"));
919 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
920 if (*inserted_head == NULL) {
921 *inserted_head = tmp_buck;
924 else if (!strcmp(tag, "encoding")) {
925 if (!strcasecmp(tag_val, "none")) encode = E_NONE;
926 else if (!strcasecmp(tag_val, "url")) encode = E_URL;
927 else if (!strcasecmp(tag_val, "entity")) encode = E_ENTITY;
929 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
930 "unknown value \"%s\" to parameter \"encoding\" of "
931 "tag echo in %s", tag_val, r->filename);
932 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
936 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
937 "unknown parameter \"%s\" in tag echo of %s",
939 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
947 /* error and tf must point to a string with room for at
948 * least MAX_STRING_LEN characters
950 static int handle_config(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
951 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
954 char *tag_val = NULL;
955 char parsed_string[MAX_STRING_LEN];
956 apr_table_t *env = r->subprocess_env;
958 *inserted_head = NULL;
959 if (ctx->flags & FLAG_PRINTING) {
961 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 0);
962 if (tag_val == NULL) {
964 return 0; /* Reached the end of the string. */
967 return 1; /* tags must have values. */
970 if (!strcmp(tag, "errmsg")) {
971 ap_ssi_parse_string(r, tag_val, ctx->error_str, MAX_STRING_LEN, 0);
972 ctx->error_length = strlen(ctx->error_str);
974 else if (!strcmp(tag, "timefmt")) {
975 apr_time_t date = r->request_time;
977 ap_ssi_parse_string(r, tag_val, ctx->time_str, MAX_STRING_LEN, 0);
978 apr_table_setn(env, "DATE_LOCAL", ap_ht_time(r->pool, date, ctx->time_str, 0));
979 apr_table_setn(env, "DATE_GMT", ap_ht_time(r->pool, date, ctx->time_str, 1));
980 apr_table_setn(env, "LAST_MODIFIED",
981 ap_ht_time(r->pool, r->finfo.mtime, ctx->time_str, 0));
983 else if (!strcmp(tag, "sizefmt")) {
984 ap_ssi_parse_string(r, tag_val, parsed_string, sizeof(parsed_string), 0);
985 decodehtml(parsed_string);
986 if (!strcmp(parsed_string, "bytes")) {
987 ctx->flags |= FLAG_SIZE_IN_BYTES;
989 else if (!strcmp(parsed_string, "abbrev")) {
990 ctx->flags &= FLAG_SIZE_ABBREV;
994 apr_bucket *tmp_buck;
996 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
997 "unknown parameter \"%s\" to tag config in %s",
999 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
1007 static int find_file(request_rec *r, const char *directive, const char *tag,
1008 char *tag_val, apr_finfo_t *finfo)
1010 char *to_send = tag_val;
1011 request_rec *rr = NULL;
1013 char *error_fmt = NULL;
1014 apr_status_t rv = APR_SUCCESS;
1016 if (!strcmp(tag, "file")) {
1017 /* be safe; only files in this directory or below allowed */
1018 if (!is_only_below(tag_val)) {
1019 error_fmt = "unable to access file \"%s\" "
1020 "in parsed file %s";
1023 ap_getparents(tag_val); /* get rid of any nasties */
1025 /* note: it is okay to pass NULL for the "next filter" since
1026 we never attempt to "run" this sub request. */
1027 rr = ap_sub_req_lookup_file(tag_val, r, NULL);
1029 if (rr->status == HTTP_OK && rr->finfo.filetype != 0) {
1030 to_send = rr->filename;
1031 if ((rv = apr_stat(finfo, to_send, APR_FINFO_GPROT
1032 | APR_FINFO_MIN, rr->pool)) != APR_SUCCESS
1033 && rv != APR_INCOMPLETE) {
1034 error_fmt = "unable to get information about \"%s\" "
1035 "in parsed file %s";
1039 error_fmt = "unable to lookup information about \"%s\" "
1040 "in parsed file %s";
1046 ap_log_rerror(APLOG_MARK, APLOG_ERR | (rv ? 0 : APLOG_NOERRNO),
1047 rv, r, error_fmt, to_send, r->filename);
1050 if (rr) ap_destroy_sub_req(rr);
1054 else if (!strcmp(tag, "virtual")) {
1055 /* note: it is okay to pass NULL for the "next filter" since
1056 we never attempt to "run" this sub request. */
1057 rr = ap_sub_req_lookup_uri(tag_val, r, NULL);
1059 if (rr->status == HTTP_OK && rr->finfo.filetype != 0) {
1060 memcpy((char *) finfo, (const char *) &rr->finfo,
1062 ap_destroy_sub_req(rr);
1066 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1067 "unable to get information about \"%s\" "
1068 "in parsed file %s",
1069 tag_val, r->filename);
1070 ap_destroy_sub_req(rr);
1075 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1076 "unknown parameter \"%s\" to tag %s in %s",
1077 tag, directive, r->filename);
1082 #define NEG_SIGN " -"
1083 #define ZERO_K " 0k"
1086 static void generate_size(apr_ssize_t size, char *buff, apr_size_t buff_size)
1088 /* XXX: this -1 thing is a gross hack */
1089 if (size == (apr_ssize_t)-1) {
1090 memcpy (buff, NEG_SIGN, sizeof(NEG_SIGN)+1);
1093 memcpy (buff, ZERO_K, sizeof(ZERO_K)+1);
1095 else if (size < 1024) {
1096 memcpy (buff, ONE_K, sizeof(ONE_K)+1);
1098 else if (size < 1048576) {
1099 apr_snprintf(buff, buff_size, "%4" APR_SSIZE_T_FMT "k", (size + 512) / 1024);
1101 else if (size < 103809024) {
1102 apr_snprintf(buff, buff_size, "%4.1fM", size / 1048576.0);
1105 apr_snprintf(buff, buff_size, "%4" APR_SSIZE_T_FMT "M", (size + 524288) / 1048576);
1109 static int handle_fsize(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
1110 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
1113 char *tag_val = NULL;
1115 apr_size_t s_len, s_wrt;
1116 apr_bucket *tmp_buck;
1117 char parsed_string[MAX_STRING_LEN];
1119 *inserted_head = NULL;
1120 if (ctx->flags & FLAG_PRINTING) {
1122 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 1);
1123 if (tag_val == NULL) {
1132 ap_ssi_parse_string(r, tag_val, parsed_string, sizeof(parsed_string), 0);
1133 if (!find_file(r, "fsize", tag, parsed_string, &finfo)) {
1136 if (!(ctx->flags & FLAG_SIZE_IN_BYTES)) {
1137 generate_size(finfo.size, buff, sizeof(buff));
1138 s_len = strlen (buff);
1144 apr_snprintf(tmp_buff, sizeof(tmp_buff), "%" APR_OFF_T_FMT, finfo.size);
1145 l = strlen(tmp_buff); /* grrr */
1146 for (x = 0; x < l; x++) {
1147 if (x && (!((l - x) % 3))) {
1150 buff[pos++] = tmp_buff[x];
1156 tmp_buck = apr_bucket_heap_create(buff, s_len, 1, &s_wrt);
1157 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
1158 if (*inserted_head == NULL) {
1159 *inserted_head = tmp_buck;
1163 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
1171 static int handle_flastmod(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
1172 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
1175 char *tag_val = NULL;
1177 apr_size_t t_len, t_wrt;
1178 apr_bucket *tmp_buck;
1179 char parsed_string[MAX_STRING_LEN];
1181 *inserted_head = NULL;
1182 if (ctx->flags & FLAG_PRINTING) {
1184 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 1);
1185 if (tag_val == NULL) {
1194 ap_ssi_parse_string(r, tag_val, parsed_string, sizeof(parsed_string), 0);
1195 if (!find_file(r, "flastmod", tag, parsed_string, &finfo)) {
1198 t_val = ap_ht_time(r->pool, finfo.mtime, ctx->time_str, 0);
1199 t_len = strlen(t_val);
1201 tmp_buck = apr_bucket_heap_create(t_val, t_len, 1, &t_wrt);
1202 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
1203 if (*inserted_head == NULL) {
1204 *inserted_head = tmp_buck;
1208 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
1216 static int re_check(request_rec *r, char *string, char *rexp)
1221 compiled = ap_pregcomp(r->pool, rexp, REG_EXTENDED | REG_NOSUB);
1222 if (compiled == NULL) {
1223 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1224 "unable to compile pattern \"%s\"", rexp);
1227 regex_error = ap_regexec(compiled, string, 0, (regmatch_t *) NULL, 0);
1228 ap_pregfree(r->pool, compiled);
1229 return (!regex_error);
1234 token_and, token_or, token_not, token_eq, token_ne,
1235 token_rbrace, token_lbrace, token_group,
1236 token_ge, token_le, token_gt, token_lt
1239 enum token_type type;
1240 char value[MAX_STRING_LEN];
1243 /* there is an implicit assumption here that string is at most MAX_STRING_LEN-1
1244 * characters long...
1246 static const char *get_ptoken(request_rec *r, const char *string, struct token *token,
1254 /* Skip leading white space */
1255 if (string == (char *) NULL) {
1256 return (char *) NULL;
1258 while ((ch = *string++)) {
1259 if (!apr_isspace(ch)) {
1264 return (char *) NULL;
1267 token->type = token_string; /* the default type */
1270 token->type = token_lbrace;
1273 token->type = token_rbrace;
1276 token->type = token_eq;
1279 if (*string == '=') {
1280 token->type = token_ne;
1281 return (string + 1);
1284 token->type = token_not;
1288 token->type = token_string;
1292 if (*string == '|') {
1293 token->type = token_or;
1294 return (string + 1);
1298 if (*string == '&') {
1299 token->type = token_and;
1300 return (string + 1);
1304 if (*string == '=') {
1305 token->type = token_ge;
1306 return (string + 1);
1309 token->type = token_gt;
1313 if (*string == '=') {
1314 token->type = token_le;
1315 return (string + 1);
1318 token->type = token_lt;
1322 token->type = token_string;
1325 /* We should only be here if we are in a string */
1327 token->value[next++] = ch;
1331 * Yes I know that goto's are BAD. But, c doesn't allow me to
1332 * exit a loop from a switch statement. Yes, I could use a flag,
1333 * but that is (IMHO) even less readable/maintainable than the goto.
1336 * I used the ++string throughout this section so that string
1337 * ends up pointing to the next token and I can just return it
1339 for (ch = *string; ((ch != '\0') && (!tkn_fnd)); ch = *++string) {
1341 if ((ch = *++string) == '\0') {
1345 token->value[next++] = ch;
1350 if (apr_isspace(ch)) {
1364 if (*(string + 1) == '|') {
1369 if (*(string + 1) == '&') {
1375 token->value[next++] = ch;
1386 token->value[next++] = ch;
1392 /* If qs is still set, I have an unmatched ' */
1397 token->value[next] = '\0';
1403 * Hey I still know that goto's are BAD. I don't think that I've ever
1404 * used two in the same project, let alone the same file before. But,
1405 * I absolutely want to make sure that I clean up the memory in all
1406 * cases. And, without rewriting this completely, the easiest way
1407 * is to just branch to the return code which cleans it up.
1409 /* there is an implicit assumption here that expr is at most MAX_STRING_LEN-1
1410 * characters long...
1412 static int parse_expr(request_rec *r, const char *expr, int *was_error,
1413 int *was_unmatched, char *debug)
1416 struct parse_node *left, *right, *parent;
1419 } *root, *current, *new;
1421 char buffer[MAX_STRING_LEN];
1422 apr_pool_t *expr_pool;
1424 apr_size_t debug_pos = 0;
1426 debug[debug_pos] = '\0';
1429 if ((parse = expr) == (char *) NULL) {
1432 root = current = (struct parse_node *) NULL;
1433 if (apr_pool_create(&expr_pool, r->pool) != APR_SUCCESS)
1436 /* Create Parse Tree */
1438 new = (struct parse_node *) apr_palloc(expr_pool,
1439 sizeof(struct parse_node));
1440 new->parent = new->left = new->right = (struct parse_node *) NULL;
1442 if ((parse = get_ptoken(r, parse, &new->token, was_unmatched)) == (char *) NULL) {
1445 switch (new->token.type) {
1448 #ifdef DEBUG_INCLUDE
1449 debug_pos += sprintf (&debug[debug_pos], " Token: string (%s)\n",
1452 if (current == (struct parse_node *) NULL) {
1453 root = current = new;
1456 switch (current->token.type) {
1458 if (current->token.value[0] != '\0') {
1459 strncat(current->token.value, " ",
1460 sizeof(current->token.value)
1461 - strlen(current->token.value) - 1);
1463 strncat(current->token.value, new->token.value,
1464 sizeof(current->token.value)
1465 - strlen(current->token.value) - 1);
1466 current->token.value[sizeof(current->token.value) - 1] = '\0';
1478 new->parent = current;
1479 current = current->right = new;
1482 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1483 "Invalid expression \"%s\" in file %s",
1492 #ifdef DEBUG_INCLUDE
1493 memcpy (&debug[debug_pos], " Token: and/or\n",
1494 sizeof (" Token: and/or\n"));
1495 debug_pos += sizeof (" Token: and/or\n");
1497 if (current == (struct parse_node *) NULL) {
1498 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1499 "Invalid expression \"%s\" in file %s",
1504 /* Percolate upwards */
1505 while (current != (struct parse_node *) NULL) {
1506 switch (current->token.type) {
1518 current = current->parent;
1523 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1524 "Invalid expression \"%s\" in file %s",
1531 if (current == (struct parse_node *) NULL) {
1533 new->left->parent = new;
1534 new->parent = (struct parse_node *) NULL;
1538 new->left = current->right;
1539 current->right = new;
1540 new->parent = current;
1546 #ifdef DEBUG_INCLUDE
1547 memcpy (&debug[debug_pos], " Token: not\n",
1548 sizeof (" Token: not\n"));
1549 debug_pos += sizeof (" Token: not\n");
1551 if (current == (struct parse_node *) NULL) {
1552 root = current = new;
1555 /* Percolate upwards */
1556 while (current != (struct parse_node *) NULL) {
1557 switch (current->token.type) {
1570 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1571 "Invalid expression \"%s\" in file %s",
1578 if (current == (struct parse_node *) NULL) {
1580 new->left->parent = new;
1581 new->parent = (struct parse_node *) NULL;
1585 new->left = current->right;
1586 current->right = new;
1587 new->parent = current;
1598 #ifdef DEBUG_INCLUDE
1599 memcpy (&debug[debug_pos], " Token: eq/ne/ge/gt/le/lt\n",
1600 sizeof (" Token: eq/ne/ge/gt/le/lt\n"));
1601 debug_pos += sizeof (" Token: eq/ne/ge/gt/le/lt\n");
1603 if (current == (struct parse_node *) NULL) {
1604 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1605 "Invalid expression \"%s\" in file %s",
1610 /* Percolate upwards */
1611 while (current != (struct parse_node *) NULL) {
1612 switch (current->token.type) {
1615 current = current->parent;
1629 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1630 "Invalid expression \"%s\" in file %s",
1637 if (current == (struct parse_node *) NULL) {
1639 new->left->parent = new;
1640 new->parent = (struct parse_node *) NULL;
1644 new->left = current->right;
1645 current->right = new;
1646 new->parent = current;
1652 #ifdef DEBUG_INCLUDE
1653 memcpy (&debug[debug_pos], " Token: rbrace\n",
1654 sizeof (" Token: rbrace\n"));
1655 debug_pos += sizeof (" Token: rbrace\n");
1657 while (current != (struct parse_node *) NULL) {
1658 if (current->token.type == token_lbrace) {
1659 current->token.type = token_group;
1662 current = current->parent;
1664 if (current == (struct parse_node *) NULL) {
1665 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1666 "Unmatched ')' in \"%s\" in file %s",
1674 #ifdef DEBUG_INCLUDE
1675 memcpy (&debug[debug_pos], " Token: lbrace\n",
1676 sizeof (" Token: lbrace\n"));
1677 debug_pos += sizeof (" Token: lbrace\n");
1679 if (current == (struct parse_node *) NULL) {
1680 root = current = new;
1683 /* Percolate upwards */
1684 while (current != (struct parse_node *) NULL) {
1685 switch (current->token.type) {
1700 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1701 "Invalid expression \"%s\" in file %s",
1708 if (current == (struct parse_node *) NULL) {
1710 new->left->parent = new;
1711 new->parent = (struct parse_node *) NULL;
1715 new->left = current->right;
1716 current->right = new;
1717 new->parent = current;
1726 /* Evaluate Parse Tree */
1728 while (current != (struct parse_node *) NULL) {
1729 switch (current->token.type) {
1731 #ifdef DEBUG_INCLUDE
1732 memcpy (&debug[debug_pos], " Evaluate string\n",
1733 sizeof (" Evaluate string\n"));
1734 debug_pos += sizeof (" Evaluate string\n");
1736 ap_ssi_parse_string(r, current->token.value, buffer, sizeof(buffer), 0);
1737 apr_cpystrn(current->token.value, buffer, sizeof(current->token.value));
1738 current->value = (current->token.value[0] != '\0');
1740 current = current->parent;
1745 #ifdef DEBUG_INCLUDE
1746 memcpy (&debug[debug_pos], " Evaluate and/or\n",
1747 sizeof (" Evaluate and/or\n"));
1748 debug_pos += sizeof (" Evaluate and/or\n");
1750 if (current->left == (struct parse_node *) NULL ||
1751 current->right == (struct parse_node *) NULL) {
1752 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1753 "Invalid expression \"%s\" in file %s",
1758 if (!current->left->done) {
1759 switch (current->left->token.type) {
1761 ap_ssi_parse_string(r, current->left->token.value,
1762 buffer, sizeof(buffer), 0);
1763 apr_cpystrn(current->left->token.value, buffer,
1764 sizeof(current->left->token.value));
1765 current->left->value = (current->left->token.value[0] != '\0');
1766 current->left->done = 1;
1769 current = current->left;
1773 if (!current->right->done) {
1774 switch (current->right->token.type) {
1776 ap_ssi_parse_string(r, current->right->token.value,
1777 buffer, sizeof(buffer), 0);
1778 apr_cpystrn(current->right->token.value, buffer,
1779 sizeof(current->right->token.value));
1780 current->right->value = (current->right->token.value[0] != '\0');
1781 current->right->done = 1;
1784 current = current->right;
1788 #ifdef DEBUG_INCLUDE
1789 debug_pos += sprintf (&debug[debug_pos], " Left: %c\n",
1790 current->left->value ? '1' : '0');
1791 debug_pos += sprintf (&debug[debug_pos], " Right: %c\n",
1792 current->right->value ? '1' : '0');
1794 if (current->token.type == token_and) {
1795 current->value = current->left->value && current->right->value;
1798 current->value = current->left->value || current->right->value;
1800 #ifdef DEBUG_INCLUDE
1801 debug_pos += sprintf (&debug[debug_pos], " Returning %c\n",
1802 current->value ? '1' : '0');
1805 current = current->parent;
1810 #ifdef DEBUG_INCLUDE
1811 memcpy (&debug[debug_pos], " Evaluate eq/ne\n",
1812 sizeof (" Evaluate eq/ne\n"));
1813 debug_pos += sizeof (" Evaluate eq/ne\n");
1815 if ((current->left == (struct parse_node *) NULL) ||
1816 (current->right == (struct parse_node *) NULL) ||
1817 (current->left->token.type != token_string) ||
1818 (current->right->token.type != token_string)) {
1819 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1820 "Invalid expression \"%s\" in file %s",
1825 ap_ssi_parse_string(r, current->left->token.value,
1826 buffer, sizeof(buffer), 0);
1827 apr_cpystrn(current->left->token.value, buffer,
1828 sizeof(current->left->token.value));
1829 ap_ssi_parse_string(r, current->right->token.value,
1830 buffer, sizeof(buffer), 0);
1831 apr_cpystrn(current->right->token.value, buffer,
1832 sizeof(current->right->token.value));
1833 if (current->right->token.value[0] == '/') {
1835 len = strlen(current->right->token.value);
1836 if (current->right->token.value[len - 1] == '/') {
1837 current->right->token.value[len - 1] = '\0';
1840 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1841 "Invalid rexp \"%s\" in file %s",
1842 current->right->token.value, r->filename);
1846 #ifdef DEBUG_INCLUDE
1847 debug_pos += sprintf (&debug[debug_pos],
1848 " Re Compare (%s) with /%s/\n",
1849 current->left->token.value,
1850 ¤t->right->token.value[1]);
1853 re_check(r, current->left->token.value,
1854 ¤t->right->token.value[1]);
1857 #ifdef DEBUG_INCLUDE
1858 debug_pos += sprintf (&debug[debug_pos],
1859 " Compare (%s) with (%s)\n",
1860 current->left->token.value,
1861 current->right->token.value);
1864 (strcmp(current->left->token.value,
1865 current->right->token.value) == 0);
1867 if (current->token.type == token_ne) {
1868 current->value = !current->value;
1870 #ifdef DEBUG_INCLUDE
1871 debug_pos += sprintf (&debug[debug_pos], " Returning %c\n",
1872 current->value ? '1' : '0');
1875 current = current->parent;
1881 #ifdef DEBUG_INCLUDE
1882 memcpy (&debug[debug_pos], " Evaluate ge/gt/le/lt\n",
1883 sizeof (" Evaluate ge/gt/le/lt\n"));
1884 debug_pos += sizeof (" Evaluate ge/gt/le/lt\n");
1886 if ((current->left == (struct parse_node *) NULL) ||
1887 (current->right == (struct parse_node *) NULL) ||
1888 (current->left->token.type != token_string) ||
1889 (current->right->token.type != token_string)) {
1890 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1891 "Invalid expression \"%s\" in file %s",
1896 ap_ssi_parse_string(r, current->left->token.value,
1897 buffer, sizeof(buffer), 0);
1898 apr_cpystrn(current->left->token.value, buffer,
1899 sizeof(current->left->token.value));
1900 ap_ssi_parse_string(r, current->right->token.value,
1901 buffer, sizeof(buffer), 0);
1902 apr_cpystrn(current->right->token.value, buffer,
1903 sizeof(current->right->token.value));
1904 #ifdef DEBUG_INCLUDE
1905 debug_pos += sprintf (&debug[debug_pos],
1906 " Compare (%s) with (%s)\n",
1907 current->left->token.value,
1908 current->right->token.value);
1911 strcmp(current->left->token.value,
1912 current->right->token.value);
1913 if (current->token.type == token_ge) {
1914 current->value = current->value >= 0;
1916 else if (current->token.type == token_gt) {
1917 current->value = current->value > 0;
1919 else if (current->token.type == token_le) {
1920 current->value = current->value <= 0;
1922 else if (current->token.type == token_lt) {
1923 current->value = current->value < 0;
1926 current->value = 0; /* Don't return -1 if unknown token */
1928 #ifdef DEBUG_INCLUDE
1929 debug_pos += sprintf (&debug[debug_pos], " Returning %c\n",
1930 current->value ? '1' : '0');
1933 current = current->parent;
1937 if (current->right != (struct parse_node *) NULL) {
1938 if (!current->right->done) {
1939 current = current->right;
1942 current->value = !current->right->value;
1947 #ifdef DEBUG_INCLUDE
1948 debug_pos += sprintf (&debug[debug_pos], " Evaluate !: %c\n",
1949 current->value ? '1' : '0');
1952 current = current->parent;
1956 if (current->right != (struct parse_node *) NULL) {
1957 if (!current->right->done) {
1958 current = current->right;
1961 current->value = current->right->value;
1966 #ifdef DEBUG_INCLUDE
1967 debug_pos += sprintf (&debug[debug_pos], " Evaluate (): %c\n",
1968 current->value ? '1' : '0');
1971 current = current->parent;
1975 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1976 "Unmatched '(' in \"%s\" in file %s",
1982 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1983 "Unmatched ')' in \"%s\" in file %s",
1989 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1996 retval = (root == (struct parse_node *) NULL) ? 0 : root->value;
1998 apr_pool_destroy(expr_pool);
2002 /*-------------------------------------------------------------------------*/
2003 #ifdef DEBUG_INCLUDE
2005 /* XXX overlaying the static string pointed to by cond_txt isn't cool */
2007 #define MAX_DEBUG_SIZE MAX_STRING_LEN
2008 #define LOG_COND_STATUS(cntx, t_buck, h_ptr, ins_head, tag_text) \
2010 char *cond_txt = "**** X conditional_status=\"0\"\n"; \
2013 if (cntx->flags & FLAG_COND_TRUE) { \
2014 cond_txt[31] = '1'; \
2016 memcpy(&cond_txt[5], tag_text, sizeof(tag_text)); \
2017 t_buck = apr_bucket_heap_create(cond_txt, sizeof(cond_txt), 1, &c_wrt); \
2018 APR_BUCKET_INSERT_BEFORE(h_ptr, t_buck); \
2020 if (ins_head == NULL) { \
2021 ins_head = t_buck; \
2024 #define DUMP_PARSE_EXPR_DEBUG(t_buck, h_ptr, d_buf, ins_head) \
2027 if (d_buf[0] != '\0') { \
2028 t_buck = apr_bucket_heap_create(d_buf, strlen(d_buf), 1, &b_wrt); \
2029 APR_BUCKET_INSERT_BEFORE(h_ptr, t_buck); \
2031 if (ins_head == NULL) { \
2032 ins_head = t_buck; \
2038 #define MAX_DEBUG_SIZE 10
2039 #define LOG_COND_STATUS(cntx, t_buck, h_ptr, ins_head, tag_text)
2040 #define DUMP_PARSE_EXPR_DEBUG(t_buck, h_ptr, d_buf, ins_head)
2043 /*-------------------------------------------------------------------------*/
2045 /* pjr - These seem to allow expr="fred" expr="joe" where joe overwrites fred. */
2046 static int handle_if(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
2047 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
2050 char *tag_val = NULL;
2052 int expr_ret, was_error, was_unmatched;
2053 apr_bucket *tmp_buck;
2054 char debug_buf[MAX_DEBUG_SIZE];
2056 *inserted_head = NULL;
2057 if (!ctx->flags & FLAG_PRINTING) {
2058 ctx->if_nesting_level++;
2062 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 0);
2065 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2066 "missing expr in if statement: %s", r->filename);
2067 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2070 expr_ret = parse_expr(r, expr, &was_error, &was_unmatched, debug_buf);
2072 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2075 if (was_unmatched) {
2076 DUMP_PARSE_EXPR_DEBUG(tmp_buck, head_ptr, "\nUnmatched '\n",
2079 DUMP_PARSE_EXPR_DEBUG(tmp_buck, head_ptr, debug_buf, *inserted_head);
2082 ctx->flags |= (FLAG_PRINTING | FLAG_COND_TRUE);
2085 ctx->flags &= FLAG_CLEAR_PRINT_COND;
2087 LOG_COND_STATUS(ctx, tmp_buck, head_ptr, *inserted_head, " if");
2088 ctx->if_nesting_level = 0;
2091 else if (!strcmp(tag, "expr")) {
2093 #ifdef DEBUG_INCLUDE
2095 apr_size_t d_len = 0, d_wrt = 0;
2096 d_len = sprintf(debug_buf, "**** if expr=\"%s\"\n", expr);
2097 tmp_buck = apr_bucket_heap_create(debug_buf, d_len, 1, &d_wrt);
2098 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
2100 if (*inserted_head == NULL) {
2101 *inserted_head = tmp_buck;
2107 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2108 "unknown parameter \"%s\" to tag if in %s", tag, r->filename);
2109 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2117 static int handle_elif(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
2118 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
2121 char *tag_val = NULL;
2123 int expr_ret, was_error, was_unmatched;
2124 apr_bucket *tmp_buck;
2125 char debug_buf[MAX_DEBUG_SIZE];
2127 *inserted_head = NULL;
2128 if (!ctx->if_nesting_level) {
2130 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 0);
2132 LOG_COND_STATUS(ctx, tmp_buck, head_ptr, *inserted_head, " elif");
2134 if (ctx->flags & FLAG_COND_TRUE) {
2135 ctx->flags &= FLAG_CLEAR_PRINTING;
2139 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2140 "missing expr in elif statement: %s", r->filename);
2141 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2144 expr_ret = parse_expr(r, expr, &was_error, &was_unmatched, debug_buf);
2146 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2149 if (was_unmatched) {
2150 DUMP_PARSE_EXPR_DEBUG(tmp_buck, head_ptr, "\nUnmatched '\n",
2153 DUMP_PARSE_EXPR_DEBUG(tmp_buck, head_ptr, debug_buf, *inserted_head);
2156 ctx->flags |= (FLAG_PRINTING | FLAG_COND_TRUE);
2159 ctx->flags &= FLAG_CLEAR_PRINT_COND;
2161 LOG_COND_STATUS(ctx, tmp_buck, head_ptr, *inserted_head, " elif");
2164 else if (!strcmp(tag, "expr")) {
2166 #ifdef DEBUG_INCLUDE
2168 apr_size_t d_len = 0, d_wrt = 0;
2169 d_len = sprintf(debug_buf, "**** elif expr=\"%s\"\n", expr);
2170 tmp_buck = apr_bucket_heap_create(debug_buf, d_len, 1, &d_wrt);
2171 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
2173 if (*inserted_head == NULL) {
2174 *inserted_head = tmp_buck;
2180 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2181 "unknown parameter \"%s\" to tag if in %s", tag, r->filename);
2182 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2189 static int handle_else(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
2190 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
2193 char *tag_val = NULL;
2194 apr_bucket *tmp_buck;
2196 *inserted_head = NULL;
2197 if (!ctx->if_nesting_level) {
2198 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 1);
2199 if ((tag != NULL) || (tag_val != NULL)) {
2200 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2201 "else directive does not take tags in %s", r->filename);
2202 if (ctx->flags & FLAG_PRINTING) {
2203 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2208 LOG_COND_STATUS(ctx, tmp_buck, head_ptr, *inserted_head, " else");
2210 if (ctx->flags & FLAG_COND_TRUE) {
2211 ctx->flags &= FLAG_CLEAR_PRINTING;
2214 ctx->flags |= (FLAG_PRINTING | FLAG_COND_TRUE);
2222 static int handle_endif(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
2223 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
2226 char *tag_val = NULL;
2227 apr_bucket *tmp_buck;
2229 *inserted_head = NULL;
2230 if (!ctx->if_nesting_level) {
2231 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 1);
2232 if ((tag != NULL) || (tag_val != NULL)) {
2233 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2234 "endif directive does not take tags in %s", r->filename);
2235 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2239 LOG_COND_STATUS(ctx, tmp_buck, head_ptr, *inserted_head, "endif");
2240 ctx->flags |= (FLAG_PRINTING | FLAG_COND_TRUE);
2245 ctx->if_nesting_level--;
2250 static int handle_set(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
2251 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
2254 char *tag_val = NULL;
2256 apr_bucket *tmp_buck;
2257 char parsed_string[MAX_STRING_LEN];
2259 *inserted_head = NULL;
2260 if (ctx->flags & FLAG_PRINTING) {
2262 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 1);
2263 if ((tag == NULL) && (tag_val == NULL)) {
2266 else if (tag_val == NULL) {
2269 else if (!strcmp(tag, "var")) {
2272 else if (!strcmp(tag, "value")) {
2273 if (var == (char *) NULL) {
2274 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2275 "variable must precede value in set directive in %s",
2277 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2280 ap_ssi_parse_string(r, tag_val, parsed_string, sizeof(parsed_string), 0);
2281 apr_table_setn(r->subprocess_env, apr_pstrdup(r->pool, var),
2282 apr_pstrdup(r->pool, parsed_string));
2285 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2286 "Invalid tag for set directive in %s", r->filename);
2287 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2295 static int handle_printenv(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
2296 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
2299 char *tag_val = NULL;
2300 apr_bucket *tmp_buck;
2302 if (ctx->flags & FLAG_PRINTING) {
2303 ap_ssi_get_tag_and_value(ctx, &tag, &tag_val, 1);
2304 if ((tag == NULL) && (tag_val == NULL)) {
2305 apr_array_header_t *arr = apr_table_elts(r->subprocess_env);
2306 apr_table_entry_t *elts = (apr_table_entry_t *)arr->elts;
2308 char *key_text, *val_text;
2309 apr_size_t k_len, v_len, t_wrt;
2311 *inserted_head = NULL;
2312 for (i = 0; i < arr->nelts; ++i) {
2313 key_text = ap_escape_html(r->pool, elts[i].key);
2314 val_text = ap_escape_html(r->pool, elts[i].val);
2315 k_len = strlen(key_text);
2316 v_len = strlen(val_text);
2319 tmp_buck = apr_bucket_heap_create(key_text, k_len, 1, &t_wrt);
2320 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
2321 if (*inserted_head == NULL) {
2322 *inserted_head = tmp_buck;
2325 tmp_buck = apr_bucket_immortal_create("=", 1);
2326 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
2328 tmp_buck = apr_bucket_heap_create(val_text, v_len, 1, &t_wrt);
2329 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
2331 tmp_buck = apr_bucket_immortal_create("\n", 1);
2332 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
2337 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2338 "printenv directive does not take tags in %s", r->filename);
2339 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
2346 /* -------------------------- The main function --------------------------- */
2348 static void send_parsed_content(apr_bucket_brigade **bb, request_rec *r,
2351 include_ctx_t *ctx = f->ctx;
2352 apr_bucket *dptr = APR_BRIGADE_FIRST(*bb);
2353 apr_bucket *tmp_dptr;
2354 apr_bucket_brigade *tag_and_after;
2357 if (r->args) { /* add QUERY stuff to env cause it ain't yet */
2358 char *arg_copy = apr_pstrdup(r->pool, r->args);
2360 apr_table_setn(r->subprocess_env, "QUERY_STRING", r->args);
2361 ap_unescape_url(arg_copy);
2362 apr_table_setn(r->subprocess_env, "QUERY_STRING_UNESCAPED",
2363 ap_escape_shell_cmd(r->pool, arg_copy));
2366 while (dptr != APR_BRIGADE_SENTINEL(*bb)) {
2367 /* State to check for the STARTING_SEQUENCE. */
2368 if ((ctx->state == PRE_HEAD) || (ctx->state == PARSE_HEAD)) {
2370 apr_size_t cleanup_bytes = ctx->parse_pos;
2372 tmp_dptr = find_start_sequence(dptr, ctx, *bb, &do_cleanup);
2374 /* The few bytes stored in the ssi_tag_brigade turned out not to
2375 * be a tag after all. This can only happen if the starting
2376 * tag actually spans brigades. This should be very rare.
2378 if ((do_cleanup) && (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade))) {
2379 apr_bucket *tmp_bkt;
2381 tmp_bkt = apr_bucket_immortal_create(STARTING_SEQUENCE, cleanup_bytes);
2382 APR_BRIGADE_INSERT_HEAD(*bb, tmp_bkt);
2384 while (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2385 tmp_bkt = APR_BRIGADE_FIRST(ctx->ssi_tag_brigade);
2386 apr_bucket_delete(tmp_bkt);
2390 /* If I am inside a conditional (if, elif, else) that is false
2391 * then I need to throw away anything contained in it.
2393 if ((!(ctx->flags & FLAG_PRINTING)) && (tmp_dptr != NULL) &&
2394 (dptr != APR_BRIGADE_SENTINEL(*bb))) {
2395 while ((dptr != APR_BRIGADE_SENTINEL(*bb)) &&
2396 (dptr != tmp_dptr)) {
2397 apr_bucket *free_bucket = dptr;
2399 dptr = APR_BUCKET_NEXT (dptr);
2400 apr_bucket_delete(free_bucket);
2404 /* Adjust the current bucket position based on what was found... */
2405 if ((tmp_dptr != NULL) && (ctx->state == PARSE_DIRECTIVE)) {
2406 if (ctx->tag_start_bucket != NULL) {
2407 dptr = ctx->tag_start_bucket;
2410 dptr = APR_BRIGADE_SENTINEL(*bb);
2413 else if ((tmp_dptr != NULL) && (ctx->bytes_parsed >= BYTE_COUNT_THRESHOLD)) {
2414 /* Send the large chunk of pre-tag bytes... */
2415 tag_and_after = apr_brigade_split(*bb, tmp_dptr);
2416 ap_pass_brigade(f->next, *bb);
2417 *bb = tag_and_after;
2419 ctx->bytes_parsed = 0;
2421 else if (tmp_dptr == NULL) { /* There was no possible SSI tag in the */
2422 dptr = APR_BRIGADE_SENTINEL(*bb); /* remainder of this brigade... */
2426 /* State to check for the ENDING_SEQUENCE. */
2427 if (((ctx->state == PARSE_DIRECTIVE) ||
2428 (ctx->state == PARSE_TAG) ||
2429 (ctx->state == PARSE_TAIL)) &&
2430 (dptr != APR_BRIGADE_SENTINEL(*bb))) {
2431 tmp_dptr = find_end_sequence(dptr, ctx, *bb);
2433 if (tmp_dptr != NULL) {
2434 dptr = tmp_dptr; /* Adjust bucket pos... */
2436 /* If some of the tag has already been set aside then set
2437 * aside remainder of tag. Now the full tag is in ssi_tag_brigade.
2438 * If none has yet been set aside, then leave it all where it is.
2439 * In any event after this the entire set of tag buckets will be
2440 * in one place or another.
2442 if (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2443 tag_and_after = apr_brigade_split(*bb, dptr);
2444 APR_BRIGADE_CONCAT(ctx->ssi_tag_brigade, *bb);
2445 *bb = tag_and_after;
2447 else if (ctx->bytes_parsed >= BYTE_COUNT_THRESHOLD) {
2448 SPLIT_AND_PASS_PRETAG_BUCKETS(*bb, ctx, f->next);
2452 dptr = APR_BRIGADE_SENTINEL(*bb); /* remainder of this brigade... */
2456 /* State to processed the directive... */
2457 if (ctx->state == PARSED) {
2458 apr_bucket *content_head = NULL, *tmp_bkt;
2460 char tmp_buf[TMP_BUF_SIZE];
2461 int (*handle_func)(include_ctx_t *, apr_bucket_brigade **, request_rec *,
2462 ap_filter_t *, apr_bucket *, apr_bucket **);
2464 /* By now the full tag (all buckets) should either be set aside into
2465 * ssi_tag_brigade or contained within the current bb. All tag
2466 * processing from here on can assume that.
2469 /* At this point, everything between ctx->head_start_bucket and
2470 * ctx->tail_start_bucket is an SSI
2471 * directive, we just have to deal with it now.
2473 if (get_combined_directive(ctx, r, *bb, tmp_buf,
2474 TMP_BUF_SIZE) != APR_SUCCESS) {
2475 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2476 "mod_include: error copying directive in %s",
2478 CREATE_ERROR_BUCKET(ctx, tmp_bkt, dptr, content_head);
2480 /* DO CLEANUP HERE!!!!! */
2481 tmp_dptr = ctx->head_start_bucket;
2482 if (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2483 while (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2484 tmp_bkt = APR_BRIGADE_FIRST(ctx->ssi_tag_brigade);
2485 apr_bucket_delete(tmp_bkt);
2491 tmp_dptr = APR_BUCKET_NEXT (tmp_dptr);
2492 apr_bucket_delete(tmp_bkt);
2493 } while ((tmp_dptr != dptr) &&
2494 (tmp_dptr != APR_BRIGADE_SENTINEL(*bb)));
2500 /* Can't destroy the tag buckets until I'm done processing
2501 * because the combined_tag might just be pointing to
2502 * the contents of a single bucket!
2505 /* Retrieve the handler function to be called for this directive from the
2506 * functions registered in the hash table.
2507 * Need to lower case the directive for proper matching. Also need to have
2508 * it NULL terminated (and include the NULL in the length) for proper
2511 for (tmp_i = 0; tmp_i < ctx->directive_length; tmp_i++) {
2512 ctx->combined_tag[tmp_i] = apr_tolower(ctx->combined_tag[tmp_i]);
2514 ctx->combined_tag[ctx->directive_length] = '\0';
2515 ctx->curr_tag_pos = &ctx->combined_tag[ctx->directive_length+1];
2518 (int (*)(include_ctx_t *, apr_bucket_brigade **, request_rec *,
2519 ap_filter_t *, apr_bucket *, apr_bucket **))
2520 apr_hash_get(include_hash, ctx->combined_tag, ctx->directive_length+1);
2521 if (handle_func != NULL) {
2522 ret = (*handle_func)(ctx, bb, r, f, dptr, &content_head);
2525 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2526 "unknown directive \"%s\" in parsed doc %s",
2527 ctx->combined_tag, r->filename);
2528 CREATE_ERROR_BUCKET(ctx, tmp_bkt, dptr, content_head);
2531 /* This chunk of code starts at the first bucket in the chain
2532 * of tag buckets (assuming that by this point the bucket for
2533 * the STARTING_SEQUENCE has been split) and loops through to
2534 * the end of the tag buckets freeing them all.
2536 * Remember that some part of this may have been set aside
2537 * into the ssi_tag_brigade and the remainder (possibly as
2538 * little as one byte) will be in the current brigade.
2540 * The value of dptr should have been set during the
2541 * PARSE_TAIL state to the first bucket after the
2544 * The value of content_head may have been set during processing
2545 * of the directive. If so, the content was inserted in front
2546 * of the dptr bucket. The inserted buckets should not be thrown
2547 * away here, but they should also not be parsed later.
2549 if (content_head == NULL) {
2550 content_head = dptr;
2552 tmp_dptr = ctx->head_start_bucket;
2553 if (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2554 while (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2555 tmp_bkt = APR_BRIGADE_FIRST(ctx->ssi_tag_brigade);
2556 apr_bucket_delete(tmp_bkt);
2562 tmp_dptr = APR_BUCKET_NEXT (tmp_dptr);
2563 apr_bucket_delete(tmp_bkt);
2564 } while ((tmp_dptr != content_head) &&
2565 (tmp_dptr != APR_BRIGADE_SENTINEL(*bb)));
2567 if (ctx->combined_tag == tmp_buf) {
2568 memset (ctx->combined_tag, '\0', ctx->tag_length);
2569 ctx->combined_tag = NULL;
2572 /* Don't reset the flags or the nesting level!!! */
2574 ctx->head_start_bucket = NULL;
2575 ctx->head_start_index = 0;
2576 ctx->tag_start_bucket = NULL;
2577 ctx->tag_start_index = 0;
2578 ctx->tail_start_bucket = NULL;
2579 ctx->tail_start_index = 0;
2580 ctx->curr_tag_pos = NULL;
2581 ctx->tag_length = 0;
2582 ctx->directive_length = 0;
2584 if (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2585 while (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2586 tmp_bkt = APR_BRIGADE_FIRST(ctx->ssi_tag_brigade);
2587 apr_bucket_delete(tmp_bkt);
2591 ctx->state = PRE_HEAD;
2595 /* If I am in the middle of parsing an SSI tag then I need to set aside
2596 * the pertinent trailing buckets and pass on the initial part of the
2597 * brigade. The pertinent parts of the next brigades will be added to
2598 * these set aside buckets to form the whole tag and will be processed
2599 * once the whole tag has been found.
2601 if (ctx->state == PRE_HEAD) {
2602 /* Inside a false conditional (if, elif, else), so toss it all... */
2603 if ((dptr != APR_BRIGADE_SENTINEL(*bb)) &&
2604 (!(ctx->flags & FLAG_PRINTING))) {
2605 apr_bucket *free_bucket;
2608 dptr = APR_BUCKET_NEXT (dptr);
2609 apr_bucket_delete(free_bucket);
2610 } while (dptr != APR_BRIGADE_SENTINEL(*bb));
2612 else { /* Otherwise pass it along... */
2613 ap_pass_brigade(f->next, *bb); /* No SSI tags in this brigade... */
2614 ctx->bytes_parsed = 0;
2617 else if (ctx->state == PARSED) { /* Invalid internal condition... */
2618 apr_bucket *content_head = NULL, *tmp_bkt;
2619 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2620 "Invalid mod_include state during file %s", r->filename);
2621 CREATE_ERROR_BUCKET(ctx, tmp_bkt, APR_BRIGADE_FIRST(*bb), content_head);
2623 else { /* Entire brigade is middle chunk of SSI tag... */
2624 if (!APR_BRIGADE_EMPTY(ctx->ssi_tag_brigade)) {
2625 APR_BRIGADE_CONCAT(ctx->ssi_tag_brigade, *bb);
2627 else { /* End of brigade contains part of SSI tag... */
2628 if (ctx->head_start_index > 0) {
2629 apr_bucket_split(ctx->head_start_bucket, ctx->head_start_index);
2630 ctx->head_start_bucket = APR_BUCKET_NEXT(ctx->head_start_bucket);
2631 ctx->head_start_index = 0;
2633 /* Set aside tag, pass pre-tag... */
2634 tag_and_after = apr_brigade_split(*bb, ctx->head_start_bucket);
2635 ap_save_brigade(f, &ctx->ssi_tag_brigade, &tag_and_after);
2636 ap_pass_brigade(f->next, *bb);
2637 ctx->bytes_parsed = 0;
2642 /*****************************************************************
2644 * XBITHACK. Sigh... NB it's configurable per-directory; the compile-time
2645 * option only changes the default.
2648 module include_module;
2650 xbithack_off, xbithack_on, xbithack_full
2654 char *default_error_msg;
2655 char *default_time_fmt;
2656 enum xbithack *xbithack;
2657 } include_dir_config;
2660 #define DEFAULT_XBITHACK xbithack_full
2662 #define DEFAULT_XBITHACK xbithack_off
2665 static void *create_includes_dir_config(apr_pool_t *p, char *dummy)
2667 include_dir_config *result =
2668 (include_dir_config *)apr_palloc(p, sizeof(include_dir_config));
2669 enum xbithack *xbh = (enum xbithack *) apr_palloc(p, sizeof(enum xbithack));
2670 *xbh = DEFAULT_XBITHACK;
2671 result->default_error_msg = DEFAULT_ERROR_MSG;
2672 result->default_time_fmt = DEFAULT_TIME_FORMAT;
2673 result->xbithack = xbh;
2678 static const char *set_xbithack(cmd_parms *cmd, void *xbp, const char *arg)
2680 include_dir_config *conf = (include_dir_config *)xbp;
2682 if (!strcasecmp(arg, "off")) {
2683 *conf->xbithack = xbithack_off;
2685 else if (!strcasecmp(arg, "on")) {
2686 *conf->xbithack = xbithack_on;
2688 else if (!strcasecmp(arg, "full")) {
2689 *conf->xbithack = xbithack_full;
2692 return "XBitHack must be set to Off, On, or Full";
2698 static int includes_filter(ap_filter_t *f, apr_bucket_brigade *b)
2700 request_rec *r = f->r;
2701 include_ctx_t *ctx = f->ctx;
2702 request_rec *parent;
2703 include_dir_config *conf =
2704 (include_dir_config *)ap_get_module_config(r->per_dir_config,
2707 if (!(ap_allow_options(r) & OPT_INCLUDES)) {
2708 return ap_pass_brigade(f->next, b);
2710 r->allowed |= (1 << M_GET);
2711 if (r->method_number != M_GET) {
2712 return ap_pass_brigade(f->next, b);
2716 f->ctx = ctx = apr_pcalloc(f->c->pool, sizeof(*ctx));
2718 ctx->state = PRE_HEAD;
2719 ctx->flags = (FLAG_PRINTING | FLAG_COND_TRUE);
2720 if (ap_allow_options(r) & OPT_INCNOEXEC) {
2721 ctx->flags |= FLAG_NO_EXEC;
2723 ctx->ssi_tag_brigade = apr_brigade_create(f->c->pool);
2725 apr_cpystrn(ctx->error_str, conf->default_error_msg, sizeof(ctx->error_str));
2726 apr_cpystrn(ctx->time_str, conf->default_time_fmt, sizeof(ctx->time_str));
2727 ctx->error_length = strlen(ctx->error_str);
2730 ap_pass_brigade(f->next, b);
2735 ctx->bytes_parsed = 0;
2738 /* Assure the platform supports Group protections */
2739 if ((*conf->xbithack == xbithack_full)
2740 && (r->finfo.valid & APR_FINFO_GPROT)
2741 && (r->finfo.protection & APR_GEXECUTE)) {
2742 ap_update_mtime(r, r->finfo.mtime);
2743 ap_set_last_modified(r);
2746 if ((parent = ap_get_module_config(r->request_config, &include_module))) {
2747 /* Kludge --- for nested includes, we want to keep the subprocess
2748 * environment of the base document (for compatibility); that means
2749 * torquing our own last_modified date as well so that the
2750 * LAST_MODIFIED variable gets reset to the proper value if the
2751 * nested document resets <!--#config timefmt-->.
2752 * We also insist that the memory for this subrequest not be
2753 * destroyed, that's dealt with in handle_include().
2755 r->subprocess_env = r->main->subprocess_env;
2756 apr_pool_join(r->main->pool, r->pool);
2757 r->finfo.mtime = r->main->finfo.mtime;
2760 /* we're not a nested include, so we create an initial
2762 ap_add_common_vars(r);
2764 add_include_vars(r, conf->default_time_fmt);
2766 /* XXX: this is bogus, at some point we're going to do a subrequest,
2767 * and when we do it we're going to be subjecting code that doesn't
2768 * expect to be signal-ready to SIGALRM. There is no clean way to
2769 * fix this, except to put alarm support into BUFF. -djg
2773 /* Always unset the content-length. There is no way to know if
2774 * the content will be modified at some point by send_parsed_content.
2775 * It is very possible for us to not find any content in the first
2776 * 9k of the file, but still have to modify the content of the file.
2777 * If we are going to pass the file through send_parsed_content, then
2778 * the content-length should just be unset.
2780 apr_table_unset(f->r->headers_out, "Content-Length");
2782 send_parsed_content(&b, r, f);
2785 /* signify that the sub request should not be killed */
2786 ap_set_module_config(r->request_config, &include_module,
2787 NESTED_INCLUDE_MAGIC);
2793 static void ap_register_include_handler(char *tag, include_handler func)
2795 apr_hash_set(include_hash, tag, strlen(tag) + 1, (const void *)func);
2798 static void include_post_config(apr_pool_t *p, apr_pool_t *plog,
2799 apr_pool_t *ptemp, server_rec *s)
2801 include_hash = apr_hash_make(p);
2803 ssi_pfn_register = APR_RETRIEVE_OPTIONAL_FN(ap_register_include_handler);
2805 if(ssi_pfn_register) {
2806 ssi_pfn_register("if", handle_if);
2807 ssi_pfn_register("set", handle_set);
2808 ssi_pfn_register("else", handle_else);
2809 ssi_pfn_register("elif", handle_elif);
2810 ssi_pfn_register("echo", handle_echo);
2811 ssi_pfn_register("endif", handle_endif);
2812 ssi_pfn_register("fsize", handle_fsize);
2813 ssi_pfn_register("config", handle_config);
2814 ssi_pfn_register("include", handle_include);
2815 ssi_pfn_register("flastmod", handle_flastmod);
2816 ssi_pfn_register("printenv", handle_printenv);
2820 static const char *set_default_error_msg(cmd_parms *cmd, void *mconfig, const char *msg)
2822 include_dir_config *conf = (include_dir_config *)mconfig;
2823 conf->default_error_msg = apr_pstrdup(cmd->pool, msg);
2827 static const char *set_default_time_fmt(cmd_parms *cmd, void *mconfig, const char *fmt)
2829 include_dir_config *conf = (include_dir_config *)mconfig;
2830 conf->default_time_fmt = apr_pstrdup(cmd->pool, fmt);
2835 * Module definition and configuration data structs...
2837 static const command_rec includes_cmds[] =
2839 AP_INIT_TAKE1("XBitHack", set_xbithack, NULL, OR_OPTIONS,
2840 "Off, On, or Full"),
2841 AP_INIT_TAKE1("SSIErrorMsg", set_default_error_msg, NULL, OR_ALL,
2843 AP_INIT_TAKE1("SSITimeFormat", set_default_time_fmt, NULL, OR_ALL,
2844 "a strftime(3) formatted string"),
2848 static void register_hooks(apr_pool_t *p)
2850 APR_REGISTER_OPTIONAL_FN(ap_ssi_get_tag_and_value);
2851 APR_REGISTER_OPTIONAL_FN(ap_ssi_parse_string);
2852 APR_REGISTER_OPTIONAL_FN(ap_register_include_handler);
2853 ap_hook_post_config(include_post_config, NULL, NULL, APR_HOOK_REALLY_FIRST);
2854 ap_register_output_filter("INCLUDES", includes_filter, AP_FTYPE_CONTENT);
2857 module AP_MODULE_DECLARE_DATA include_module =
2859 STANDARD20_MODULE_STUFF,
2860 create_includes_dir_config, /* dir config creater */
2861 NULL, /* dir merger --- default is to override */
2862 NULL, /* server config */
2863 NULL, /* merge server config */
2864 includes_cmds, /* command apr_table_t */
2865 register_hooks /* register hooks */