1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000 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 ** _ __ ___ ___ __| | _ __ _____ ___ __(_) |_ ___
61 ** | '_ ` _ \ / _ \ / _` | | '__/ _ \ \ /\ / / '__| | __/ _ \
62 ** | | | | | | (_) | (_| | | | | __/\ V V /| | | | || __/
63 ** |_| |_| |_|\___/ \__,_|___|_| \___| \_/\_/ |_| |_|\__\___|
66 ** URL Rewriting Module
68 ** This module uses a rule-based rewriting engine (based on a
69 ** regular-expression parser) to rewrite requested URLs on the fly.
71 ** It supports an unlimited number of additional rule conditions (which can
72 ** operate on a lot of variables, even on HTTP headers) for granular
73 ** matching and even external database lookups (either via plain text
74 ** tables, DBM hash files or even external processes) for advanced URL
77 ** It operates on the full URLs (including the PATH_INFO part) both in
78 ** per-server context (httpd.conf) and per-dir context (.htaccess) and even
79 ** can generate QUERY_STRING parts on result. The rewriting result finally
80 ** can lead to internal subprocessing, external request redirection or even
81 ** to internal proxy throughput.
83 ** This module was originally written in April 1996 and
84 ** gifted exclusively to the The Apache Software Foundation in July 1997 by
86 ** Ralf S. Engelschall
87 ** rse@engelschall.com
88 ** www.engelschall.com
91 #include "ap_config.h"
93 #include "http_config.h"
94 #include "http_request.h"
95 #include "http_core.h"
97 #include "http_protocol.h"
98 #include "mod_rewrite.h"
99 #include "apr_strings.h"
101 #if !defined(OS2) && !defined(WIN32)
107 #ifdef HAVE_SYS_TYPES_H
108 #include <sys/types.h>
111 #ifdef HAVE_SYS_UIO_H
126 ** +-------------------------------------------------------+
128 ** | static module configuration
130 ** +-------------------------------------------------------+
135 ** Our interface to the Apache server kernel:
137 ** o Runtime logic of a request is as following:
138 ** while(request or subrequest)
139 ** foreach(stage #0...#9)
140 ** foreach(module) (**)
143 ** o the order of modules at (**) is the inverted order as
144 ** given in the "Configuration" file, i.e. the last module
145 ** specified is the first one called for each hook!
146 ** The core module is always the last!
148 ** o there are two different types of result checking and
149 ** continue processing:
150 ** for hook #0,#1,#4,#5,#6,#8:
151 ** hook run loop stops on first modules which gives
152 ** back a result != DECLINED, i.e. it usually returns OK
153 ** which says "OK, module has handled this _stage_" and for #1
154 ** this have not to mean "Ok, the filename is now valid".
155 ** for hook #2,#3,#7,#9:
156 ** all hooks are run, independend of result
158 ** o at the last stage, the core module always
159 ** - says "HTTP_BAD_REQUEST" if r->filename does not begin with "/"
160 ** - prefix URL with document_root or replaced server_root
161 ** with document_root and sets r->filename
162 ** - always return a "OK" independed if the file really exists
166 /* The section for the Configure script:
167 * XXX: this needs updating for apache-2.0 configuration method
168 * MODULE-DEFINITION-START
169 * Name: rewrite_module
171 . ./helpers/find-dbm-lib
172 if [ "x$found_dbm" = "x1" ]; then
173 echo " enabling DBM support for mod_rewrite"
175 echo " disabling DBM support for mod_rewrite"
176 echo " (perhaps you need to add -ldbm, -lndbm or -lgdbm to EXTRA_LIBS)"
177 CFLAGS="$CFLAGS -DNO_DBM_REWRITEMAP"
180 * MODULE-DEFINITION-END
183 /* the apr_table_t of commands we provide */
184 static const command_rec command_table[] = {
185 AP_INIT_FLAG( "RewriteEngine", cmd_rewriteengine, NULL, OR_FILEINFO,
186 "On or Off to enable or disable (default) the whole "
188 AP_INIT_ITERATE( "RewriteOptions", cmd_rewriteoptions, NULL, OR_FILEINFO,
189 "List of option strings to set"),
190 AP_INIT_TAKE1( "RewriteBase", cmd_rewritebase, NULL, OR_FILEINFO,
191 "the base URL of the per-directory context"),
192 AP_INIT_RAW_ARGS("RewriteCond", cmd_rewritecond, NULL, OR_FILEINFO,
193 "an input string and a to be applied regexp-pattern"),
194 AP_INIT_RAW_ARGS("RewriteRule", cmd_rewriterule, NULL, OR_FILEINFO,
195 "an URL-applied regexp-pattern and a substitution URL"),
196 AP_INIT_TAKE2( "RewriteMap", cmd_rewritemap, NULL, RSRC_CONF,
197 "a mapname and a filename"),
198 AP_INIT_TAKE1( "RewriteLock", cmd_rewritelock, NULL, RSRC_CONF,
199 "the filename of a lockfile used for inter-process "
201 AP_INIT_TAKE1( "RewriteLog", cmd_rewritelog, NULL, RSRC_CONF,
202 "the filename of the rewriting logfile"),
203 AP_INIT_TAKE1( "RewriteLogLevel", cmd_rewriteloglevel, NULL, RSRC_CONF,
204 "the level of the rewriting logfile verbosity "
205 "(0=none, 1=std, .., 9=max)"),
209 /* the apr_table_t of content handlers we provide */
210 static const handler_rec handler_table[] = {
211 { "redirect-handler", handler_redirect },
215 static void register_hooks(void)
217 ap_hook_post_config(init_module,NULL,NULL,AP_HOOK_MIDDLE);
218 ap_hook_child_init(init_child,NULL,NULL,AP_HOOK_MIDDLE);
220 ap_hook_fixups(hook_fixup,NULL,NULL,AP_HOOK_FIRST);
221 ap_hook_translate_name(hook_uri2file,NULL,NULL,AP_HOOK_FIRST);
222 ap_hook_type_checker(hook_mimetype,NULL,NULL,AP_HOOK_MIDDLE);
225 /* the main config structure */
226 module AP_MODULE_DECLARE_DATA rewrite_module = {
227 STANDARD20_MODULE_STUFF,
228 config_perdir_create, /* create per-dir config structures */
229 config_perdir_merge, /* merge per-dir config structures */
230 config_server_create, /* create per-server config structures */
231 config_server_merge, /* merge per-server config structures */
232 command_table, /* apr_table_t of config file commands */
233 handler_table, /* [#8] MIME-typed-dispatched handlers */
234 register_hooks /* register hooks */
238 static cache *cachep;
240 /* whether proxy module is available or not */
241 static int proxy_available;
242 static int once_through = 0;
244 static const char *lockname;
245 static apr_lock_t *rewrite_mapr_lock = NULL;
246 static apr_lock_t *rewrite_log_lock = NULL;
249 ** +-------------------------------------------------------+
251 ** | configuration directive handling
253 ** +-------------------------------------------------------+
258 ** per-server configuration structure handling
262 static void *config_server_create(apr_pool_t *p, server_rec *s)
264 rewrite_server_conf *a;
266 a = (rewrite_server_conf *)apr_pcalloc(p, sizeof(rewrite_server_conf));
268 a->state = ENGINE_DISABLED;
269 a->options = OPTION_NONE;
270 a->rewritelogfile = NULL;
271 a->rewritelogfp = NULL;
272 a->rewriteloglevel = 0;
273 a->rewritemaps = apr_make_array(p, 2, sizeof(rewritemap_entry));
274 a->rewriteconds = apr_make_array(p, 2, sizeof(rewritecond_entry));
275 a->rewriterules = apr_make_array(p, 2, sizeof(rewriterule_entry));
281 static void *config_server_merge(apr_pool_t *p, void *basev, void *overridesv)
283 rewrite_server_conf *a, *base, *overrides;
285 a = (rewrite_server_conf *)apr_pcalloc(p, sizeof(rewrite_server_conf));
286 base = (rewrite_server_conf *)basev;
287 overrides = (rewrite_server_conf *)overridesv;
289 a->state = overrides->state;
290 a->options = overrides->options;
291 a->server = overrides->server;
293 if (a->options & OPTION_INHERIT) {
295 * local directives override
296 * and anything else is inherited
298 a->rewriteloglevel = overrides->rewriteloglevel != 0
299 ? overrides->rewriteloglevel
300 : base->rewriteloglevel;
301 a->rewritelogfile = overrides->rewritelogfile != NULL
302 ? overrides->rewritelogfile
303 : base->rewritelogfile;
304 a->rewritelogfp = overrides->rewritelogfp != NULL
305 ? overrides->rewritelogfp
306 : base->rewritelogfp;
307 a->rewritemaps = apr_append_arrays(p, overrides->rewritemaps,
309 a->rewriteconds = apr_append_arrays(p, overrides->rewriteconds,
311 a->rewriterules = apr_append_arrays(p, overrides->rewriterules,
316 * local directives override
317 * and anything else gets defaults
319 a->rewriteloglevel = overrides->rewriteloglevel;
320 a->rewritelogfile = overrides->rewritelogfile;
321 a->rewritelogfp = overrides->rewritelogfp;
322 a->rewritemaps = overrides->rewritemaps;
323 a->rewriteconds = overrides->rewriteconds;
324 a->rewriterules = overrides->rewriterules;
333 ** per-directory configuration structure handling
337 static void *config_perdir_create(apr_pool_t *p, char *path)
339 rewrite_perdir_conf *a;
341 a = (rewrite_perdir_conf *)apr_pcalloc(p, sizeof(rewrite_perdir_conf));
343 a->state = ENGINE_DISABLED;
344 a->options = OPTION_NONE;
346 a->rewriteconds = apr_make_array(p, 2, sizeof(rewritecond_entry));
347 a->rewriterules = apr_make_array(p, 2, sizeof(rewriterule_entry));
353 /* make sure it has a trailing slash */
354 if (path[strlen(path)-1] == '/') {
355 a->directory = apr_pstrdup(p, path);
358 a->directory = apr_pstrcat(p, path, "/", NULL);
365 static void *config_perdir_merge(apr_pool_t *p, void *basev, void *overridesv)
367 rewrite_perdir_conf *a, *base, *overrides;
369 a = (rewrite_perdir_conf *)apr_pcalloc(p,
370 sizeof(rewrite_perdir_conf));
371 base = (rewrite_perdir_conf *)basev;
372 overrides = (rewrite_perdir_conf *)overridesv;
374 a->state = overrides->state;
375 a->options = overrides->options;
376 a->directory = overrides->directory;
377 a->baseurl = overrides->baseurl;
379 if (a->options & OPTION_INHERIT) {
380 a->rewriteconds = apr_append_arrays(p, overrides->rewriteconds,
382 a->rewriterules = apr_append_arrays(p, overrides->rewriterules,
386 a->rewriteconds = overrides->rewriteconds;
387 a->rewriterules = overrides->rewriterules;
396 ** the configuration commands
400 static const char *cmd_rewriteengine(cmd_parms *cmd,
401 void *in_dconf, int flag)
403 rewrite_perdir_conf *dconf = in_dconf;
404 rewrite_server_conf *sconf;
407 (rewrite_server_conf *)ap_get_module_config(cmd->server->module_config,
410 if (cmd->path == NULL) { /* is server command */
411 sconf->state = (flag ? ENGINE_ENABLED : ENGINE_DISABLED);
413 else /* is per-directory command */ {
414 dconf->state = (flag ? ENGINE_ENABLED : ENGINE_DISABLED);
420 static const char *cmd_rewriteoptions(cmd_parms *cmd,
421 void *in_dconf, const char *option)
423 rewrite_perdir_conf *dconf = in_dconf;
424 rewrite_server_conf *sconf;
427 sconf = (rewrite_server_conf *)
428 ap_get_module_config(cmd->server->module_config, &rewrite_module);
430 if (cmd->path == NULL) { /* is server command */
431 err = cmd_rewriteoptions_setoption(cmd->pool,
432 &(sconf->options), option);
434 else { /* is per-directory command */
435 err = cmd_rewriteoptions_setoption(cmd->pool,
436 &(dconf->options), option);
442 static const char *cmd_rewriteoptions_setoption(apr_pool_t *p, int *options,
445 if (strcasecmp(name, "inherit") == 0) {
446 *options |= OPTION_INHERIT;
449 return apr_pstrcat(p, "RewriteOptions: unknown option '",
455 static const char *cmd_rewritelog(cmd_parms *cmd, void *dconf, const char *a1)
457 rewrite_server_conf *sconf;
459 sconf = (rewrite_server_conf *)
460 ap_get_module_config(cmd->server->module_config, &rewrite_module);
462 sconf->rewritelogfile = a1;
467 static const char *cmd_rewriteloglevel(cmd_parms *cmd, void *dconf, const char *a1)
469 rewrite_server_conf *sconf;
471 sconf = (rewrite_server_conf *)
472 ap_get_module_config(cmd->server->module_config, &rewrite_module);
474 sconf->rewriteloglevel = atoi(a1);
479 static const char *cmd_rewritemap(cmd_parms *cmd, void *dconf, const char *a1,
482 rewrite_server_conf *sconf;
483 rewritemap_entry *newmap;
486 sconf = (rewrite_server_conf *)
487 ap_get_module_config(cmd->server->module_config, &rewrite_module);
489 newmap = apr_push_array(sconf->rewritemaps);
493 if (strncmp(a2, "txt:", 4) == 0) {
494 newmap->type = MAPTYPE_TXT;
495 newmap->datafile = a2+4;
496 newmap->checkfile = a2+4;
498 else if (strncmp(a2, "rnd:", 4) == 0) {
499 newmap->type = MAPTYPE_RND;
500 newmap->datafile = a2+4;
501 newmap->checkfile = a2+4;
503 else if (strncmp(a2, "dbm:", 4) == 0) {
504 #ifndef NO_DBM_REWRITEMAP
505 newmap->type = MAPTYPE_DBM;
506 newmap->datafile = a2+4;
507 newmap->checkfile = apr_pstrcat(cmd->pool, a2+4, NDBM_FILE_SUFFIX, NULL);
509 return apr_pstrdup(cmd->pool, "RewriteMap: cannot use NDBM mapfile, "
510 "because no NDBM support is compiled in");
513 else if (strncmp(a2, "prg:", 4) == 0) {
514 newmap->type = MAPTYPE_PRG;
515 newmap->datafile = a2+4;
516 newmap->checkfile = a2+4;
518 else if (strncmp(a2, "int:", 4) == 0) {
519 newmap->type = MAPTYPE_INT;
520 newmap->datafile = NULL;
521 newmap->checkfile = NULL;
522 if (strcmp(a2+4, "tolower") == 0) {
523 newmap->func = rewrite_mapfunc_tolower;
525 else if (strcmp(a2+4, "toupper") == 0) {
526 newmap->func = rewrite_mapfunc_toupper;
528 else if (strcmp(a2+4, "escape") == 0) {
529 newmap->func = rewrite_mapfunc_escape;
531 else if (strcmp(a2+4, "unescape") == 0) {
532 newmap->func = rewrite_mapfunc_unescape;
534 else if (sconf->state == ENGINE_ENABLED) {
535 return apr_pstrcat(cmd->pool, "RewriteMap: internal map not found:",
540 newmap->type = MAPTYPE_TXT;
541 newmap->datafile = a2;
542 newmap->checkfile = a2;
545 newmap->fpout = NULL;
547 if (newmap->checkfile && (sconf->state == ENGINE_ENABLED)
548 && (apr_stat(&st, newmap->checkfile, cmd->pool) != APR_SUCCESS)) {
549 return apr_pstrcat(cmd->pool,
550 "RewriteMap: map file or program not found:",
551 newmap->checkfile, NULL);
557 static const char *cmd_rewritelock(cmd_parms *cmd, void *dconf, const char *a1)
561 if ((error = ap_check_cmd_context(cmd, GLOBAL_ONLY)) != NULL)
569 static const char *cmd_rewritebase(cmd_parms *cmd, void *in_dconf,
572 rewrite_perdir_conf *dconf = in_dconf;
574 if (cmd->path == NULL || dconf == NULL) {
575 return "RewriteBase: only valid in per-directory config files";
578 return "RewriteBase: empty URL not allowed";
581 return "RewriteBase: argument is not a valid URL";
589 static const char *cmd_rewritecond(cmd_parms *cmd, void *in_dconf,
592 rewrite_perdir_conf *dconf = in_dconf;
593 char *str = apr_pstrdup(cmd->pool, in_str);
594 rewrite_server_conf *sconf;
595 rewritecond_entry *newcond;
604 sconf = (rewrite_server_conf *)
605 ap_get_module_config(cmd->server->module_config, &rewrite_module);
607 /* make a new entry in the internal temporary rewrite rule list */
608 if (cmd->path == NULL) { /* is server command */
609 newcond = apr_push_array(sconf->rewriteconds);
611 else { /* is per-directory command */
612 newcond = apr_push_array(dconf->rewriteconds);
615 /* parse the argument line ourself */
616 if (parseargline(str, &a1, &a2, &a3)) {
617 return apr_pstrcat(cmd->pool, "RewriteCond: bad argument line '", str,
621 /* arg1: the input string */
622 newcond->input = apr_pstrdup(cmd->pool, a1);
624 /* arg3: optional flags field
625 (this have to be first parsed, because we need to
626 know if the regex should be compiled with ICASE!) */
627 newcond->flags = CONDFLAG_NONE;
629 if ((err = cmd_rewritecond_parseflagfield(cmd->pool, newcond,
636 try to compile the regexp to test if is ok */
639 newcond->flags |= CONDFLAG_NOTMATCH;
643 /* now be careful: Under the POSIX regex library
644 we can compile the pattern for case insensitive matching,
645 under the old V8 library we have to do it self via a hack */
646 if (newcond->flags & CONDFLAG_NOCASE) {
647 rc = ((regexp = ap_pregcomp(cmd->pool, cp, REG_EXTENDED|REG_ICASE))
651 rc = ((regexp = ap_pregcomp(cmd->pool, cp, REG_EXTENDED)) == NULL);
654 return apr_pstrcat(cmd->pool,
655 "RewriteCond: cannot compile regular expression '",
659 newcond->pattern = apr_pstrdup(cmd->pool, cp);
660 newcond->regexp = regexp;
665 static const char *cmd_rewritecond_parseflagfield(apr_pool_t *p,
666 rewritecond_entry *cfg,
677 if (str[0] != '[' || str[strlen(str)-1] != ']') {
678 return "RewriteCond: bad flag delimiters";
682 str[strlen(str)-1] = ','; /* for simpler parsing */
683 for ( ; *cp != '\0'; ) {
684 /* skip whitespaces */
685 for ( ; (*cp == ' ' || *cp == '\t') && *cp != '\0'; cp++)
691 if ((cp2 = strchr(cp, ',')) != NULL) {
693 for ( ; (*(cp2-1) == ' ' || *(cp2-1) == '\t'); cp2--)
696 if ((cp3 = strchr(cp1, '=')) != NULL) {
705 if ((err = cmd_rewritecond_setflag(p, cfg, key, val)) != NULL) {
717 static const char *cmd_rewritecond_setflag(apr_pool_t *p, rewritecond_entry *cfg,
718 char *key, char *val)
720 if ( strcasecmp(key, "nocase") == 0
721 || strcasecmp(key, "NC") == 0 ) {
722 cfg->flags |= CONDFLAG_NOCASE;
724 else if ( strcasecmp(key, "ornext") == 0
725 || strcasecmp(key, "OR") == 0 ) {
726 cfg->flags |= CONDFLAG_ORNEXT;
729 return apr_pstrcat(p, "RewriteCond: unknown flag '", key, "'", NULL);
734 static const char *cmd_rewriterule(cmd_parms *cmd, void *in_dconf,
737 rewrite_perdir_conf *dconf = in_dconf;
738 char *str = apr_pstrdup(cmd->pool, in_str);
739 rewrite_server_conf *sconf;
740 rewriterule_entry *newrule;
749 sconf = (rewrite_server_conf *)
750 ap_get_module_config(cmd->server->module_config, &rewrite_module);
752 /* make a new entry in the internal rewrite rule list */
753 if (cmd->path == NULL) { /* is server command */
754 newrule = apr_push_array(sconf->rewriterules);
756 else { /* is per-directory command */
757 newrule = apr_push_array(dconf->rewriterules);
760 /* parse the argument line ourself */
761 if (parseargline(str, &a1, &a2, &a3)) {
762 return apr_pstrcat(cmd->pool, "RewriteRule: bad argument line '", str,
766 /* arg3: optional flags field */
767 newrule->forced_mimetype = NULL;
768 newrule->forced_responsecode = HTTP_MOVED_TEMPORARILY;
769 newrule->flags = RULEFLAG_NONE;
770 newrule->env[0] = NULL;
773 if ((err = cmd_rewriterule_parseflagfield(cmd->pool, newrule,
780 * try to compile the regexp to test if is ok
784 newrule->flags |= RULEFLAG_NOTMATCH;
788 if (newrule->flags & RULEFLAG_NOCASE) {
791 if ((regexp = ap_pregcomp(cmd->pool, cp, mode)) == NULL) {
792 return apr_pstrcat(cmd->pool,
793 "RewriteRule: cannot compile regular expression '",
796 newrule->pattern = apr_pstrdup(cmd->pool, cp);
797 newrule->regexp = regexp;
799 /* arg2: the output string
800 * replace the $<N> by \<n> which is needed by the currently
801 * used Regular Expression library
803 * TODO: Is this still required for PCRE? If not, does it *work* with PCRE?
805 newrule->output = apr_pstrdup(cmd->pool, a2);
807 /* now, if the server or per-dir config holds an
808 * array of RewriteCond entries, we take it for us
809 * and clear the array
811 if (cmd->path == NULL) { /* is server command */
812 newrule->rewriteconds = sconf->rewriteconds;
813 sconf->rewriteconds = apr_make_array(cmd->pool, 2,
814 sizeof(rewritecond_entry));
816 else { /* is per-directory command */
817 newrule->rewriteconds = dconf->rewriteconds;
818 dconf->rewriteconds = apr_make_array(cmd->pool, 2,
819 sizeof(rewritecond_entry));
825 static const char *cmd_rewriterule_parseflagfield(apr_pool_t *p,
826 rewriterule_entry *cfg,
837 if (str[0] != '[' || str[strlen(str)-1] != ']') {
838 return "RewriteRule: bad flag delimiters";
842 str[strlen(str)-1] = ','; /* for simpler parsing */
843 for ( ; *cp != '\0'; ) {
844 /* skip whitespaces */
845 for ( ; (*cp == ' ' || *cp == '\t') && *cp != '\0'; cp++)
851 if ((cp2 = strchr(cp, ',')) != NULL) {
853 for ( ; (*(cp2-1) == ' ' || *(cp2-1) == '\t'); cp2--)
856 if ((cp3 = strchr(cp1, '=')) != NULL) {
865 if ((err = cmd_rewriterule_setflag(p, cfg, key, val)) != NULL) {
877 static const char *cmd_rewriterule_setflag(apr_pool_t *p, rewriterule_entry *cfg,
878 char *key, char *val)
883 if ( strcasecmp(key, "redirect") == 0
884 || strcasecmp(key, "R") == 0 ) {
885 cfg->flags |= RULEFLAG_FORCEREDIRECT;
886 if (strlen(val) > 0) {
887 if (strcasecmp(val, "permanent") == 0) {
888 status = HTTP_MOVED_PERMANENTLY;
890 else if (strcasecmp(val, "temp") == 0) {
891 status = HTTP_MOVED_TEMPORARILY;
893 else if (strcasecmp(val, "seeother") == 0) {
894 status = HTTP_SEE_OTHER;
896 else if (apr_isdigit(*val)) {
899 if (!ap_is_HTTP_REDIRECT(status)) {
900 return "RewriteRule: invalid HTTP response code "
903 cfg->forced_responsecode = status;
906 else if ( strcasecmp(key, "last") == 0
907 || strcasecmp(key, "L") == 0 ) {
908 cfg->flags |= RULEFLAG_LASTRULE;
910 else if ( strcasecmp(key, "next") == 0
911 || strcasecmp(key, "N") == 0 ) {
912 cfg->flags |= RULEFLAG_NEWROUND;
914 else if ( strcasecmp(key, "chain") == 0
915 || strcasecmp(key, "C") == 0 ) {
916 cfg->flags |= RULEFLAG_CHAIN;
918 else if ( strcasecmp(key, "type") == 0
919 || strcasecmp(key, "T") == 0 ) {
920 cfg->forced_mimetype = apr_pstrdup(p, val);
921 ap_str_tolower(cfg->forced_mimetype);
923 else if ( strcasecmp(key, "env") == 0
924 || strcasecmp(key, "E") == 0 ) {
925 for (i = 0; (cfg->env[i] != NULL) && (i < MAX_ENV_FLAGS); i++)
927 if (i < MAX_ENV_FLAGS) {
928 cfg->env[i] = apr_pstrdup(p, val);
929 cfg->env[i+1] = NULL;
932 return "RewriteRule: too many environment flags 'E'";
935 else if ( strcasecmp(key, "nosubreq") == 0
936 || strcasecmp(key, "NS") == 0 ) {
937 cfg->flags |= RULEFLAG_IGNOREONSUBREQ;
939 else if ( strcasecmp(key, "proxy") == 0
940 || strcasecmp(key, "P") == 0 ) {
941 cfg->flags |= RULEFLAG_PROXY;
943 else if ( strcasecmp(key, "passthrough") == 0
944 || strcasecmp(key, "PT") == 0 ) {
945 cfg->flags |= RULEFLAG_PASSTHROUGH;
947 else if ( strcasecmp(key, "skip") == 0
948 || strcasecmp(key, "S") == 0 ) {
949 cfg->skip = atoi(val);
951 else if ( strcasecmp(key, "forbidden") == 0
952 || strcasecmp(key, "F") == 0 ) {
953 cfg->flags |= RULEFLAG_FORBIDDEN;
955 else if ( strcasecmp(key, "gone") == 0
956 || strcasecmp(key, "G") == 0 ) {
957 cfg->flags |= RULEFLAG_GONE;
959 else if ( strcasecmp(key, "qsappend") == 0
960 || strcasecmp(key, "QSA") == 0 ) {
961 cfg->flags |= RULEFLAG_QSAPPEND;
963 else if ( strcasecmp(key, "nocase") == 0
964 || strcasecmp(key, "NC") == 0 ) {
965 cfg->flags |= RULEFLAG_NOCASE;
968 return apr_pstrcat(p, "RewriteRule: unknown flag '", key, "'", NULL);
976 ** Global Module Initialization
977 ** [called from read_config() after all
978 ** config commands were already called]
982 static void init_module(apr_pool_t *p,
989 /* check if proxy module is available */
990 proxy_available = (ap_find_linked_module("mod_proxy.c") != NULL);
992 /* create the rewriting lockfiles in the parent */
993 if ((rv = apr_create_lock (&rewrite_log_lock, APR_MUTEX, APR_LOCKALL,
994 NULL, NULL)) != APR_SUCCESS) {
995 ap_log_error(APLOG_MARK, APLOG_CRIT, rv, s,
996 "mod_rewrite: could not create rewrite_log_lock");
1000 rewritelock_create(s, p);
1001 apr_register_cleanup(p, (void *)s, rewritelock_remove, apr_null_cleanup);
1003 /* step through the servers and
1004 * - open each rewriting logfile
1005 * - open the RewriteMap prg:xxx programs
1007 for (; s; s = s->next) {
1008 open_rewritelog(s, p);
1009 if (once_through > 0)
1010 run_rewritemap_programs(s, p);
1019 ** Per-Child Module Initialization
1020 ** [called after a child process is spawned]
1024 static void init_child(apr_pool_t *p, server_rec *s)
1028 if (lockname != NULL && *(lockname) != '\0')
1030 rv = apr_child_init_lock (&rewrite_mapr_lock, lockname, p);
1031 if (rv != APR_SUCCESS) {
1032 ap_log_error(APLOG_MARK, APLOG_CRIT, rv, s,
1033 "mod_rewrite: could not init rewrite_mapr_lock "
1038 /* create the lookup cache */
1039 cachep = init_cache(p);
1044 ** +-------------------------------------------------------+
1048 ** +-------------------------------------------------------+
1053 ** URI-to-filename hook
1055 ** [used for the rewriting engine triggered by
1056 ** the per-server 'RewriteRule' directives]
1060 static int hook_uri2file(request_rec *r)
1063 rewrite_server_conf *conf;
1065 const char *thisserver;
1067 const char *thisurl;
1078 * retrieve the config structures
1080 sconf = r->server->module_config;
1081 conf = (rewrite_server_conf *)ap_get_module_config(sconf,
1085 * only do something under runtime if the engine is really enabled,
1086 * else return immediately!
1088 if (conf->state == ENGINE_DISABLED) {
1093 * check for the ugly API case of a virtual host section where no
1094 * mod_rewrite directives exists. In this situation we became no chance
1095 * by the API to setup our default per-server config so we have to
1096 * on-the-fly assume we have the default config. But because the default
1097 * config has a disabled rewriting engine we are lucky because can
1098 * just stop operating now.
1100 if (conf->server != r->server) {
1105 * add the SCRIPT_URL variable to the env. this is a bit complicated
1106 * due to the fact that apache uses subrequests and internal redirects
1109 if (r->main == NULL) {
1110 var = apr_pstrcat(r->pool, "REDIRECT_", ENVVAR_SCRIPT_URL, NULL);
1111 var = apr_table_get(r->subprocess_env, var);
1113 apr_table_setn(r->subprocess_env, ENVVAR_SCRIPT_URL, r->uri);
1116 apr_table_setn(r->subprocess_env, ENVVAR_SCRIPT_URL, var);
1120 var = apr_table_get(r->main->subprocess_env, ENVVAR_SCRIPT_URL);
1121 apr_table_setn(r->subprocess_env, ENVVAR_SCRIPT_URL, var);
1125 * create the SCRIPT_URI variable for the env
1128 /* add the canonical URI of this URL */
1129 thisserver = ap_get_server_name(r);
1130 port = ap_get_server_port(r);
1131 if (ap_is_default_port(port, r)) {
1135 apr_snprintf(buf, sizeof(buf), ":%u", port);
1138 thisurl = apr_table_get(r->subprocess_env, ENVVAR_SCRIPT_URL);
1140 /* set the variable */
1141 var = apr_pstrcat(r->pool, ap_http_method(r), "://", thisserver, thisport,
1143 apr_table_setn(r->subprocess_env, ENVVAR_SCRIPT_URI, var);
1145 /* if filename was not initially set,
1146 * we start with the requested URI
1148 if (r->filename == NULL) {
1149 r->filename = apr_pstrdup(r->pool, r->uri);
1150 rewritelog(r, 2, "init rewrite engine with requested uri %s",
1155 * now apply the rules ...
1157 if (apply_rewrite_list(r, conf->rewriterules, NULL)) {
1159 if (strlen(r->filename) > 6 &&
1160 strncmp(r->filename, "proxy:", 6) == 0) {
1161 /* it should be go on as an internal proxy request */
1163 /* check if the proxy module is enabled, so
1164 * we can actually use it!
1166 if (!proxy_available) {
1167 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1168 "attempt to make remote request from mod_rewrite "
1169 "without proxy enabled: %s", r->filename);
1170 return HTTP_FORBIDDEN;
1173 /* make sure the QUERY_STRING and
1174 * PATH_INFO parts get incorporated
1176 if (r->path_info != NULL) {
1177 r->filename = apr_pstrcat(r->pool, r->filename,
1178 r->path_info, NULL);
1180 if (r->args != NULL &&
1181 r->uri == r->unparsed_uri) {
1182 /* see proxy_http:proxy_http_canon() */
1183 r->filename = apr_pstrcat(r->pool, r->filename,
1184 "?", r->args, NULL);
1187 /* now make sure the request gets handled by the proxy handler */
1189 r->handler = "proxy-server";
1191 rewritelog(r, 1, "go-ahead with proxy request %s [OK]",
1195 else if (is_absolute_uri(r->filename)) {
1196 /* it was finally rewritten to a remote URL */
1198 /* skip 'scheme:' */
1199 for (cp = r->filename; *cp != ':' && *cp != '\0'; cp++)
1203 /* skip host part */
1204 for ( ; *cp != '/' && *cp != '\0'; cp++)
1207 rewritelog(r, 1, "escaping %s for redirect", r->filename);
1208 cp2 = ap_escape_uri(r->pool, cp);
1210 r->filename = apr_pstrcat(r->pool, r->filename, cp2, NULL);
1213 /* append the QUERY_STRING part */
1214 if (r->args != NULL) {
1215 r->filename = apr_pstrcat(r->pool, r->filename, "?",
1216 ap_escape_uri(r->pool, r->args), NULL);
1219 /* determine HTTP redirect response code */
1220 if (ap_is_HTTP_REDIRECT(r->status)) {
1222 r->status = HTTP_OK; /* make Apache kernel happy */
1225 n = HTTP_MOVED_TEMPORARILY;
1228 /* now do the redirection */
1229 apr_table_setn(r->headers_out, "Location", r->filename);
1230 rewritelog(r, 1, "redirect to %s [REDIRECT/%d]", r->filename, n);
1233 else if (strlen(r->filename) > 10 &&
1234 strncmp(r->filename, "forbidden:", 10) == 0) {
1235 /* This URLs is forced to be forbidden for the requester */
1236 return HTTP_FORBIDDEN;
1238 else if (strlen(r->filename) > 5 &&
1239 strncmp(r->filename, "gone:", 5) == 0) {
1240 /* This URLs is forced to be gone */
1243 else if (strlen(r->filename) > 12 &&
1244 strncmp(r->filename, "passthrough:", 12) == 0) {
1246 * Hack because of underpowered API: passing the current
1247 * rewritten filename through to other URL-to-filename handlers
1248 * just as it were the requested URL. This is to enable
1249 * post-processing by mod_alias, etc. which always act on
1250 * r->uri! The difference here is: We do not try to
1251 * add the document root
1253 r->uri = apr_pstrdup(r->pool, r->filename+12);
1257 /* it was finally rewritten to a local path */
1259 /* expand "/~user" prefix */
1260 #if !defined(WIN32) && !defined(NETWARE)
1261 r->filename = expand_tildepaths(r, r->filename);
1263 rewritelog(r, 2, "local path result: %s", r->filename);
1265 /* the filename has to start with a slash! */
1266 if (r->filename[0] != '/') {
1267 return HTTP_BAD_REQUEST;
1270 /* if there is no valid prefix, we have
1271 * to emulate the translator from the core and
1272 * prefix the filename with document_root
1275 * We cannot leave out the prefix_stat because
1276 * - when we always prefix with document_root
1277 * then no absolute path can be created, e.g. via
1278 * emulating a ScriptAlias directive, etc.
1279 * - when we always NOT prefix with document_root
1280 * then the files under document_root have to
1281 * be references directly and document_root
1282 * gets never used and will be a dummy parameter -
1286 * Under real Unix systems this is no problem,
1287 * because we only do stat() on the first directory
1288 * and this gets cached by the kernel for along time!
1290 n = prefix_stat(r->filename, &finfo);
1292 if ((ccp = ap_document_root(r)) != NULL) {
1293 l = apr_cpystrn(docroot, ccp, sizeof(docroot)) - docroot;
1295 /* always NOT have a trailing slash */
1296 if (docroot[l-1] == '/') {
1297 docroot[l-1] = '\0';
1300 && !strncmp(r->filename, r->server->path,
1301 r->server->pathlen)) {
1302 r->filename = apr_pstrcat(r->pool, docroot,
1304 r->server->pathlen), NULL);
1307 r->filename = apr_pstrcat(r->pool, docroot,
1310 rewritelog(r, 2, "prefixed with document_root to %s",
1315 rewritelog(r, 1, "go-ahead with %s [OK]", r->filename);
1320 rewritelog(r, 1, "pass through %s", r->filename);
1330 ** [used to support the forced-MIME-type feature]
1334 static int hook_mimetype(request_rec *r)
1338 /* now check if we have to force a MIME-type */
1339 t = apr_table_get(r->notes, REWRITE_FORCED_MIMETYPE_NOTEVAR);
1344 rewritelog(r, 1, "force filename %s to have MIME-type '%s'",
1346 r->content_type = t;
1356 ** [used for the rewriting engine triggered by
1357 ** the per-directory 'RewriteRule' directives]
1361 static int hook_fixup(request_rec *r)
1363 rewrite_perdir_conf *dconf;
1372 dconf = (rewrite_perdir_conf *)ap_get_module_config(r->per_dir_config,
1375 /* if there is no per-dir config we return immediately */
1376 if (dconf == NULL) {
1380 /* we shouldn't do anything in subrequests */
1381 if (r->main != NULL) {
1385 /* if there are no real (i.e. no RewriteRule directives!)
1386 per-dir config of us, we return also immediately */
1387 if (dconf->directory == NULL) {
1392 * only do something under runtime if the engine is really enabled,
1393 * for this directory, else return immediately!
1395 if (!(ap_allow_options(r) & (OPT_SYM_LINKS | OPT_SYM_OWNER))) {
1396 /* FollowSymLinks is mandatory! */
1397 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1398 "Options FollowSymLinks or SymLinksIfOwnerMatch is off "
1399 "which implies that RewriteRule directive is forbidden: "
1401 return HTTP_FORBIDDEN;
1404 /* FollowSymLinks is given, but the user can
1405 * still turn off the rewriting engine
1407 if (dconf->state == ENGINE_DISABLED) {
1413 * remember the current filename before rewriting for later check
1414 * to prevent deadlooping because of internal redirects
1415 * on final URL/filename which can be equal to the inital one.
1417 ofilename = r->filename;
1420 * now apply the rules ...
1422 if (apply_rewrite_list(r, dconf->rewriterules, dconf->directory)) {
1424 if (strlen(r->filename) > 6 &&
1425 strncmp(r->filename, "proxy:", 6) == 0) {
1426 /* it should go on as an internal proxy request */
1428 /* make sure the QUERY_STRING and
1429 * PATH_INFO parts get incorporated
1430 * (r->path_info was already appended by the
1431 * rewriting engine because of the per-dir context!)
1433 if (r->args != NULL) {
1434 r->filename = apr_pstrcat(r->pool, r->filename,
1435 "?", r->args, NULL);
1438 /* now make sure the request gets handled by the proxy handler */
1440 r->handler = "proxy-server";
1442 rewritelog(r, 1, "[per-dir %s] go-ahead with proxy request "
1443 "%s [OK]", dconf->directory, r->filename);
1446 else if (is_absolute_uri(r->filename)) {
1447 /* it was finally rewritten to a remote URL */
1449 /* because we are in a per-dir context
1450 * first try to replace the directory with its base-URL
1451 * if there is a base-URL available
1453 if (dconf->baseurl != NULL) {
1454 /* skip 'scheme:' */
1455 for (cp = r->filename; *cp != ':' && *cp != '\0'; cp++)
1459 if ((cp = strchr(cp, '/')) != NULL) {
1461 "[per-dir %s] trying to replace "
1462 "prefix %s with %s",
1463 dconf->directory, dconf->directory,
1465 cp2 = subst_prefix_path(r, cp, dconf->directory,
1467 if (strcmp(cp2, cp) != 0) {
1469 r->filename = apr_pstrcat(r->pool, r->filename,
1475 /* now prepare the redirect... */
1477 /* skip 'scheme:' */
1478 for (cp = r->filename; *cp != ':' && *cp != '\0'; cp++)
1482 /* skip host part */
1483 for ( ; *cp != '/' && *cp != '\0'; cp++)
1486 rewritelog(r, 1, "[per-dir %s] escaping %s for redirect",
1487 dconf->directory, r->filename);
1488 cp2 = ap_escape_uri(r->pool, cp);
1490 r->filename = apr_pstrcat(r->pool, r->filename, cp2, NULL);
1493 /* append the QUERY_STRING part */
1494 if (r->args != NULL) {
1495 r->filename = apr_pstrcat(r->pool, r->filename, "?",
1496 ap_escape_uri(r->pool, r->args), NULL);
1499 /* determine HTTP redirect response code */
1500 if (ap_is_HTTP_REDIRECT(r->status)) {
1502 r->status = HTTP_OK; /* make Apache kernel happy */
1505 n = HTTP_MOVED_TEMPORARILY;
1508 /* now do the redirection */
1509 apr_table_setn(r->headers_out, "Location", r->filename);
1510 rewritelog(r, 1, "[per-dir %s] redirect to %s [REDIRECT/%d]",
1511 dconf->directory, r->filename, n);
1514 else if (strlen(r->filename) > 10 &&
1515 strncmp(r->filename, "forbidden:", 10) == 0) {
1516 /* This URL is forced to be forbidden for the requester */
1517 return HTTP_FORBIDDEN;
1519 else if (strlen(r->filename) > 5 &&
1520 strncmp(r->filename, "gone:", 5) == 0) {
1521 /* This URL is forced to be gone */
1525 /* it was finally rewritten to a local path */
1527 /* if someone used the PASSTHROUGH flag in per-dir
1528 * context we just ignore it. It is only useful
1529 * in per-server context
1531 if (strlen(r->filename) > 12 &&
1532 strncmp(r->filename, "passthrough:", 12) == 0) {
1533 r->filename = apr_pstrdup(r->pool, r->filename+12);
1536 /* the filename has to start with a slash! */
1537 if (r->filename[0] != '/') {
1538 return HTTP_BAD_REQUEST;
1541 /* Check for deadlooping:
1542 * At this point we KNOW that at least one rewriting
1543 * rule was applied, but when the resulting URL is
1544 * the same as the initial URL, we are not allowed to
1545 * use the following internal redirection stuff because
1546 * this would lead to a deadloop.
1548 if (strcmp(r->filename, ofilename) == 0) {
1549 rewritelog(r, 1, "[per-dir %s] initial URL equal rewritten "
1550 "URL: %s [IGNORING REWRITE]",
1551 dconf->directory, r->filename);
1555 /* if there is a valid base-URL then substitute
1556 * the per-dir prefix with this base-URL if the
1557 * current filename still is inside this per-dir
1558 * context. If not then treat the result as a
1561 if (dconf->baseurl != NULL) {
1563 "[per-dir %s] trying to replace prefix %s with %s",
1564 dconf->directory, dconf->directory, dconf->baseurl);
1565 r->filename = subst_prefix_path(r, r->filename,
1570 /* if no explicit base-URL exists we assume
1571 * that the directory prefix is also a valid URL
1572 * for this webserver and only try to remove the
1573 * document_root if it is prefix
1575 if ((ccp = ap_document_root(r)) != NULL) {
1576 prefix = apr_pstrdup(r->pool, ccp);
1577 /* always NOT have a trailing slash */
1579 if (prefix[l-1] == '/') {
1583 if (strncmp(r->filename, prefix, l) == 0) {
1585 "[per-dir %s] strip document_root "
1587 dconf->directory, r->filename,
1589 r->filename = apr_pstrdup(r->pool, r->filename+l);
1594 /* now initiate the internal redirect */
1595 rewritelog(r, 1, "[per-dir %s] internal redirect with %s "
1596 "[INTERNAL REDIRECT]", dconf->directory, r->filename);
1597 r->filename = apr_pstrcat(r->pool, "redirect:", r->filename, NULL);
1598 r->handler = "redirect-handler";
1603 rewritelog(r, 1, "[per-dir %s] pass through %s",
1604 dconf->directory, r->filename);
1614 ** [used for redirect support]
1618 static int handler_redirect(request_rec *r)
1620 /* just make sure that we are really meant! */
1621 if (strncmp(r->filename, "redirect:", 9) != 0) {
1625 /* now do the internal redirect */
1626 ap_internal_redirect(apr_pstrcat(r->pool, r->filename+9,
1627 r->args ? "?" : NULL, r->args, NULL), r);
1629 /* and return gracefully */
1635 ** +-------------------------------------------------------+
1637 ** | the rewriting engine
1639 ** +-------------------------------------------------------+
1643 * Apply a complete rule set,
1644 * i.e. a list of rewrite rules
1646 static int apply_rewrite_list(request_rec *r, apr_array_header_t *rewriterules,
1649 rewriterule_entry *entries;
1650 rewriterule_entry *p;
1657 * Iterate over all existing rules
1659 entries = (rewriterule_entry *)rewriterules->elts;
1662 for (i = 0; i < rewriterules->nelts; i++) {
1666 * Ignore this rule on subrequests if we are explicitly
1667 * asked to do so or this is a proxy-throughput or a
1668 * forced redirect rule.
1670 if (r->main != NULL &&
1671 (p->flags & RULEFLAG_IGNOREONSUBREQ ||
1672 p->flags & RULEFLAG_PROXY ||
1673 p->flags & RULEFLAG_FORCEREDIRECT )) {
1678 * Apply the current rule.
1680 rc = apply_rewrite_rule(r, p, perdir);
1683 * Indicate a change if this was not a match-only rule.
1690 * Pass-Through Feature (`RewriteRule .. .. [PT]'):
1691 * Because the Apache 1.x API is very limited we
1692 * need this hack to pass the rewritten URL to other
1693 * modules like mod_alias, mod_userdir, etc.
1695 if (p->flags & RULEFLAG_PASSTHROUGH) {
1696 rewritelog(r, 2, "forcing '%s' to get passed through "
1697 "to next API URI-to-filename handler", r->filename);
1698 r->filename = apr_pstrcat(r->pool, "passthrough:",
1705 * Rule has the "forbidden" flag set which means that
1706 * we stop processing and indicate this to the caller.
1708 if (p->flags & RULEFLAG_FORBIDDEN) {
1709 rewritelog(r, 2, "forcing '%s' to be forbidden", r->filename);
1710 r->filename = apr_pstrcat(r->pool, "forbidden:",
1717 * Rule has the "gone" flag set which means that
1718 * we stop processing and indicate this to the caller.
1720 if (p->flags & RULEFLAG_GONE) {
1721 rewritelog(r, 2, "forcing '%s' to be gone", r->filename);
1722 r->filename = apr_pstrcat(r->pool, "gone:", r->filename, NULL);
1728 * Stop processing also on proxy pass-through and
1729 * last-rule and new-round flags.
1731 if (p->flags & RULEFLAG_PROXY) {
1734 if (p->flags & RULEFLAG_LASTRULE) {
1739 * On "new-round" flag we just start from the top of
1740 * the rewriting ruleset again.
1742 if (p->flags & RULEFLAG_NEWROUND) {
1747 * If we are forced to skip N next rules, do it now.
1751 while ( i < rewriterules->nelts
1761 * If current rule is chained with next rule(s),
1762 * skip all this next rule(s)
1764 while ( i < rewriterules->nelts
1765 && p->flags & RULEFLAG_CHAIN) {
1775 * Apply a single(!) rewrite rule
1777 static int apply_rewrite_rule(request_rec *r, rewriterule_entry *p,
1783 char newuri[MAX_STRING_LEN];
1785 regmatch_t regmatch[MAX_NMATCH];
1786 backrefinfo *briRR = NULL;
1787 backrefinfo *briRC = NULL;
1790 apr_array_header_t *rewriteconds;
1791 rewritecond_entry *conds;
1792 rewritecond_entry *c;
1804 * Add (perhaps splitted away) PATH_INFO postfix to URL to
1805 * make sure we really match against the complete URL.
1807 if (perdir != NULL && r->path_info != NULL && r->path_info[0] != '\0') {
1808 rewritelog(r, 3, "[per-dir %s] add path info postfix: %s -> %s%s",
1809 perdir, uri, uri, r->path_info);
1810 uri = apr_pstrcat(r->pool, uri, r->path_info, NULL);
1814 * On per-directory context (.htaccess) strip the location
1815 * prefix from the URL to make sure patterns apply only to
1816 * the local part. Additionally indicate this special
1817 * threatment in the logfile.
1820 if (perdir != NULL) {
1821 if ( strlen(uri) >= strlen(perdir)
1822 && strncmp(uri, perdir, strlen(perdir)) == 0) {
1823 rewritelog(r, 3, "[per-dir %s] strip per-dir prefix: %s -> %s",
1824 perdir, uri, uri+strlen(perdir));
1825 uri = uri+strlen(perdir);
1831 * Try to match the URI against the RewriteRule pattern
1832 * and exit immeddiately if it didn't apply.
1834 if (perdir == NULL) {
1835 rewritelog(r, 3, "applying pattern '%s' to uri '%s'",
1839 rewritelog(r, 3, "[per-dir %s] applying pattern '%s' to uri '%s'",
1840 perdir, p->pattern, uri);
1842 rc = (ap_regexec(regexp, uri, regexp->re_nsub+1, regmatch, 0) == 0);
1843 if (! (( rc && !(p->flags & RULEFLAG_NOTMATCH)) ||
1844 (!rc && (p->flags & RULEFLAG_NOTMATCH)) ) ) {
1849 * Else create the RewriteRule `regsubinfo' structure which
1850 * holds the substitution information.
1852 briRR = (backrefinfo *)apr_palloc(r->pool, sizeof(backrefinfo));
1853 if (!rc && (p->flags & RULEFLAG_NOTMATCH)) {
1854 /* empty info on negative patterns */
1859 briRR->source = apr_pstrdup(r->pool, uri);
1860 briRR->nsub = regexp->re_nsub;
1861 memcpy((void *)(briRR->regmatch), (void *)(regmatch),
1866 * Initiallally create the RewriteCond backrefinfo with
1867 * empty backrefinfo, i.e. not subst parts
1868 * (this one is adjusted inside apply_rewrite_cond() later!!)
1870 briRC = (backrefinfo *)apr_pcalloc(r->pool, sizeof(backrefinfo));
1875 * Ok, we already know the pattern has matched, but we now
1876 * additionally have to check for all existing preconditions
1877 * (RewriteCond) which have to be also true. We do this at
1878 * this very late stage to avoid unnessesary checks which
1879 * would slow down the rewriting engine!!
1881 rewriteconds = p->rewriteconds;
1882 conds = (rewritecond_entry *)rewriteconds->elts;
1884 for (i = 0; i < rewriteconds->nelts; i++) {
1886 rc = apply_rewrite_cond(r, c, perdir, briRR, briRC);
1887 if (c->flags & CONDFLAG_ORNEXT) {
1892 /* One condition is false, but another can be
1893 * still true, so we have to continue...
1895 apr_table_unset(r->notes, VARY_KEY_THIS);
1899 /* One true condition is enough in "or" case, so
1900 * skip the other conditions which are "ornext"
1903 while ( i < rewriteconds->nelts
1904 && c->flags & CONDFLAG_ORNEXT) {
1913 * The "AND" case, i.e. no "or" flag,
1914 * so a single failure means total failure.
1921 vary = apr_table_get(r->notes, VARY_KEY_THIS);
1923 apr_table_merge(r->notes, VARY_KEY, vary);
1924 apr_table_unset(r->notes, VARY_KEY_THIS);
1927 /* if any condition fails the complete rule fails */
1929 apr_table_unset(r->notes, VARY_KEY);
1930 apr_table_unset(r->notes, VARY_KEY_THIS);
1935 * Regardless of what we do next, we've found a match. Check to see
1936 * if any of the request header fields were involved, and add them
1937 * to the Vary field of the response.
1939 if ((vary = apr_table_get(r->notes, VARY_KEY)) != NULL) {
1940 apr_table_merge(r->headers_out, "Vary", vary);
1941 apr_table_unset(r->notes, VARY_KEY);
1945 * If this is a pure matching rule (`RewriteRule <pat> -')
1946 * we stop processing and return immediately. The only thing
1947 * we have not to forget are the environment variables
1948 * (`RewriteRule <pat> - [E=...]')
1950 if (strcmp(output, "-") == 0) {
1951 do_expand_env(r, p->env, briRR, briRC);
1952 if (p->forced_mimetype != NULL) {
1953 if (perdir == NULL) {
1954 /* In the per-server context we can force the MIME-type
1955 * the correct way by notifying our MIME-type hook handler
1956 * to do the job when the MIME-type API stage is reached.
1958 rewritelog(r, 2, "remember %s to have MIME-type '%s'",
1959 r->filename, p->forced_mimetype);
1960 apr_table_setn(r->notes, REWRITE_FORCED_MIMETYPE_NOTEVAR,
1961 p->forced_mimetype);
1964 /* In per-directory context we operate in the Fixup API hook
1965 * which is after the MIME-type hook, so our MIME-type handler
1966 * has no chance to set r->content_type. And because we are
1967 * in the situation where no substitution takes place no
1968 * sub-request will happen (which could solve the
1969 * restriction). As a workaround we do it ourself now
1970 * immediately although this is not strictly API-conforming.
1971 * But it's the only chance we have...
1973 rewritelog(r, 1, "[per-dir %s] force %s to have MIME-type "
1974 "'%s'", perdir, r->filename, p->forced_mimetype);
1975 r->content_type = p->forced_mimetype;
1982 * Ok, now we finally know all patterns have matched and
1983 * that there is something to replace, so we create the
1984 * substitution URL string in `newuri'.
1986 do_expand(r, output, newuri, sizeof(newuri), briRR, briRC);
1987 if (perdir == NULL) {
1988 rewritelog(r, 2, "rewrite %s -> %s", uri, newuri);
1991 rewritelog(r, 2, "[per-dir %s] rewrite %s -> %s", perdir, uri, newuri);
1995 * Additionally do expansion for the environment variable
1996 * strings (`RewriteRule .. .. [E=<string>]').
1998 do_expand_env(r, p->env, briRR, briRC);
2001 * Now replace API's knowledge of the current URI:
2002 * Replace r->filename with the new URI string and split out
2003 * an on-the-fly generated QUERY_STRING part into r->args
2005 r->filename = apr_pstrdup(r->pool, newuri);
2006 splitout_queryargs(r, p->flags & RULEFLAG_QSAPPEND);
2009 * Again add the previously stripped per-directory location
2010 * prefix if the new URI is not a new one for this
2011 * location, i.e. if it's not starting with either a slash
2012 * or a fully qualified URL scheme.
2014 if (prefixstrip && r->filename[0] != '/'
2015 && !is_absolute_uri(r->filename)) {
2016 rewritelog(r, 3, "[per-dir %s] add per-dir prefix: %s -> %s%s",
2017 perdir, r->filename, perdir, r->filename);
2018 r->filename = apr_pstrcat(r->pool, perdir, r->filename, NULL);
2022 * If this rule is forced for proxy throughput
2023 * (`RewriteRule ... ... [P]') then emulate mod_proxy's
2024 * URL-to-filename handler to be sure mod_proxy is triggered
2025 * for this URL later in the Apache API. But make sure it is
2026 * a fully-qualified URL. (If not it is qualified with
2029 if (p->flags & RULEFLAG_PROXY) {
2030 fully_qualify_uri(r);
2031 if (perdir == NULL) {
2032 rewritelog(r, 2, "forcing proxy-throughput with %s", r->filename);
2035 rewritelog(r, 2, "[per-dir %s] forcing proxy-throughput with %s",
2036 perdir, r->filename);
2038 r->filename = apr_pstrcat(r->pool, "proxy:", r->filename, NULL);
2043 * If this rule is explicitly forced for HTTP redirection
2044 * (`RewriteRule .. .. [R]') then force an external HTTP
2045 * redirect. But make sure it is a fully-qualified URL. (If
2046 * not it is qualified with ourself).
2048 if (p->flags & RULEFLAG_FORCEREDIRECT) {
2049 fully_qualify_uri(r);
2050 if (perdir == NULL) {
2052 "explicitly forcing redirect with %s", r->filename);
2056 "[per-dir %s] explicitly forcing redirect with %s",
2057 perdir, r->filename);
2059 r->status = p->forced_responsecode;
2064 * Special Rewriting Feature: Self-Reduction
2065 * We reduce the URL by stripping a possible
2066 * http[s]://<ourhost>[:<port>] prefix, i.e. a prefix which
2067 * corresponds to ourself. This is to simplify rewrite maps
2068 * and to avoid recursion, etc. When this prefix is not a
2069 * coincidence then the user has to use [R] explicitly (see
2075 * If this rule is still implicitly forced for HTTP
2076 * redirection (`RewriteRule .. <scheme>://...') then
2077 * directly force an external HTTP redirect.
2079 if (is_absolute_uri(r->filename)) {
2080 if (perdir == NULL) {
2082 "implicitly forcing redirect (rc=%d) with %s",
2083 p->forced_responsecode, r->filename);
2086 rewritelog(r, 2, "[per-dir %s] implicitly forcing redirect "
2087 "(rc=%d) with %s", perdir, p->forced_responsecode,
2090 r->status = p->forced_responsecode;
2095 * Now we are sure it is not a fully qualified URL. But
2096 * there is still one special case left: A local rewrite in
2097 * per-directory context, i.e. a substitution URL which does
2098 * not start with a slash. Here we add again the initially
2099 * stripped per-directory prefix.
2101 if (prefixstrip && r->filename[0] != '/') {
2102 rewritelog(r, 3, "[per-dir %s] add per-dir prefix: %s -> %s%s",
2103 perdir, r->filename, perdir, r->filename);
2104 r->filename = apr_pstrcat(r->pool, perdir, r->filename, NULL);
2108 * Finally we had to remember if a MIME-type should be
2109 * forced for this URL (`RewriteRule .. .. [T=<type>]')
2110 * Later in the API processing phase this is forced by our
2111 * MIME API-hook function. This time its no problem even for
2112 * the per-directory context (where the MIME-type hook was
2113 * already processed) because a sub-request happens ;-)
2115 if (p->forced_mimetype != NULL) {
2116 apr_table_setn(r->notes, REWRITE_FORCED_MIMETYPE_NOTEVAR,
2117 p->forced_mimetype);
2118 if (perdir == NULL) {
2119 rewritelog(r, 2, "remember %s to have MIME-type '%s'",
2120 r->filename, p->forced_mimetype);
2124 "[per-dir %s] remember %s to have MIME-type '%s'",
2125 perdir, r->filename, p->forced_mimetype);
2130 * Puuhhhhhhhh... WHAT COMPLICATED STUFF ;_)
2131 * But now we're done for this particular rule.
2136 static int apply_rewrite_cond(request_rec *r, rewritecond_entry *p,
2137 char *perdir, backrefinfo *briRR,
2140 char input[MAX_STRING_LEN];
2143 regmatch_t regmatch[MAX_NMATCH];
2147 * Construct the string we match against
2150 do_expand(r, p->input, input, sizeof(input), briRR, briRC);
2153 * Apply the patterns
2157 if (strcmp(p->pattern, "-f") == 0) {
2158 if (apr_stat(&sb, input, r->pool) == APR_SUCCESS) {
2159 if (sb.filetype == APR_REG) {
2164 else if (strcmp(p->pattern, "-s") == 0) {
2165 if (apr_stat(&sb, input, r->pool) == APR_SUCCESS) {
2166 if ((sb.filetype == APR_REG) && sb.size > 0) {
2171 else if (strcmp(p->pattern, "-l") == 0) {
2172 #if !defined(OS2) && !defined(WIN32)
2173 if (apr_lstat(&sb, input, r->pool) == APR_SUCCESS) {
2174 if (sb.filetype == APR_LNK) {
2180 else if (strcmp(p->pattern, "-d") == 0) {
2181 if (apr_stat(&sb, input, r->pool) == APR_SUCCESS) {
2182 if (sb.filetype == APR_DIR) {
2187 else if (strcmp(p->pattern, "-U") == 0) {
2188 /* avoid infinite subrequest recursion */
2189 if (strlen(input) > 0 && subreq_ok(r)) {
2191 /* run a URI-based subrequest */
2192 rsub = ap_sub_req_lookup_uri(input, r);
2194 /* URI exists for any result up to 3xx, redirects allowed */
2195 if (rsub->status < 400)
2199 rewritelog(r, 5, "RewriteCond URI (-U) check: "
2200 "path=%s -> status=%d", input, rsub->status);
2202 /* cleanup by destroying the subrequest */
2203 ap_destroy_sub_req(rsub);
2206 else if (strcmp(p->pattern, "-F") == 0) {
2207 /* avoid infinite subrequest recursion */
2208 if (strlen(input) > 0 && subreq_ok(r)) {
2210 /* process a file-based subrequest:
2211 * this differs from -U in that no path translation is done.
2213 rsub = ap_sub_req_lookup_file(input, r);
2215 /* file exists for any result up to 2xx, no redirects */
2216 if (rsub->status < 300 &&
2217 /* double-check that file exists since default result is 200 */
2218 apr_stat(&sb, rsub->filename, r->pool) == APR_SUCCESS) {
2223 rewritelog(r, 5, "RewriteCond file (-F) check: path=%s "
2224 "-> file=%s status=%d", input, rsub->filename,
2227 /* cleanup by destroying the subrequest */
2228 ap_destroy_sub_req(rsub);
2231 else if (strlen(p->pattern) > 1 && *(p->pattern) == '>') {
2232 rc = (compare_lexicography(input, p->pattern+1) == 1 ? 1 : 0);
2234 else if (strlen(p->pattern) > 1 && *(p->pattern) == '<') {
2235 rc = (compare_lexicography(input, p->pattern+1) == -1 ? 1 : 0);
2237 else if (strlen(p->pattern) > 1 && *(p->pattern) == '=') {
2238 if (strcmp(p->pattern+1, "\"\"") == 0) {
2239 rc = (*input == '\0');
2242 rc = (strcmp(input, p->pattern+1) == 0 ? 1 : 0);
2246 /* it is really a regexp pattern, so apply it */
2247 rc = (ap_regexec(p->regexp, input,
2248 p->regexp->re_nsub+1, regmatch,0) == 0);
2250 /* if it isn't a negated pattern and really matched
2251 we update the passed-through regex subst info structure */
2252 if (rc && !(p->flags & CONDFLAG_NOTMATCH)) {
2253 briRC->source = apr_pstrdup(r->pool, input);
2254 briRC->nsub = p->regexp->re_nsub;
2255 memcpy((void *)(briRC->regmatch), (void *)(regmatch),
2260 /* if this is a non-matching regexp, just negate the result */
2261 if (p->flags & CONDFLAG_NOTMATCH) {
2265 rewritelog(r, 4, "RewriteCond: input='%s' pattern='%s%s' => %s",
2266 input, (p->flags & CONDFLAG_NOTMATCH ? "!" : ""),
2267 p->pattern, rc ? "matched" : "not-matched");
2269 /* end just return the result */
2275 ** +-------------------------------------------------------+
2277 ** | URL transformation functions
2279 ** +-------------------------------------------------------+
2285 ** perform all the expansions on the input string
2286 ** leaving the result in the supplied buffer
2290 static void do_expand(request_rec *r, char *input, char *buffer, int nbuf,
2291 backrefinfo *briRR, backrefinfo *briRC)
2297 * for security reasons this expansion must be perfomed in a
2298 * single pass, otherwise an attacker can arrange for the result
2299 * of an earlier expansion to include expansion specifiers that
2300 * are interpreted by a later expansion, producing results that
2301 * were not intended by the administrator.
2306 space = nbuf - 1; /* room for '\0' */
2309 span = strcspn(inp, "$%");
2313 memcpy(outp, inp, span);
2317 if (space == 0 || *inp == '\0') {
2320 /* now we have a '$' or a '%' */
2321 if (inp[1] == '{') {
2323 endp = find_closing_bracket(inp+2, '{', '}');
2328 if (inp[0] == '$') {
2329 /* ${...} map lookup expansion */
2331 * To make rewrite maps useful the lookup key and
2332 * default values must be expanded, so we make
2333 * recursive calls to do the work. For security
2334 * reasons we must never expand a string that includes
2335 * verbatim data from the network. The recursion here
2336 * isn't a problem because the result of expansion is
2337 * only passed to lookup_map() so it cannot be
2338 * re-expanded, only re-looked-up. Another way of
2339 * looking at it is that the recursion is entirely
2340 * driven by the syntax of the nested curly brackets.
2342 char *key, *dflt, *result;
2343 char xkey[MAX_STRING_LEN];
2344 char xdflt[MAX_STRING_LEN];
2346 key = strchr(inp, ':');
2351 dflt = strchr(key, '|');
2358 do_expand(r, key, xkey, sizeof(xkey), briRR, briRC);
2359 do_expand(r, dflt, xdflt, sizeof(xdflt), briRR, briRC);
2360 result = lookup_map(r, inp+2, xkey);
2361 if (result == NULL) {
2364 span = apr_cpystrn(outp, result, space) - outp;
2366 if (dflt != empty) {
2370 else if (inp[0] == '%') {
2371 /* %{...} variable lookup expansion */
2372 span = apr_cpystrn(outp, lookup_variable(r, inp+2), space) - outp;
2383 else if (apr_isdigit(inp[1])) {
2384 int n = inp[1] - '0';
2385 backrefinfo *bri = NULL;
2386 if (inp[0] == '$') {
2387 /* $N RewriteRule regexp backref expansion */
2390 else if (inp[0] == '%') {
2391 /* %N RewriteCond regexp backref expansion */
2394 /* see ap_pregsub() in src/main/util.c */
2395 if (bri && n <= bri->nsub &&
2396 bri->regmatch[n].rm_eo > bri->regmatch[n].rm_so) {
2397 span = bri->regmatch[n].rm_eo - bri->regmatch[n].rm_so;
2401 memcpy(outp, bri->source + bri->regmatch[n].rm_so, span);
2418 ** perform all the expansions on the environment variables
2422 static void do_expand_env(request_rec *r, char *env[],
2423 backrefinfo *briRR, backrefinfo *briRC)
2426 char buf[MAX_STRING_LEN];
2428 for (i = 0; env[i] != NULL; i++) {
2429 do_expand(r, env[i], buf, sizeof(buf), briRR, briRC);
2430 add_env_variable(r, buf);
2437 ** split out a QUERY_STRING part from
2438 ** the current URI string
2442 static void splitout_queryargs(request_rec *r, int qsappend)
2447 q = strchr(r->filename, '?');
2449 olduri = apr_pstrdup(r->pool, r->filename);
2452 r->args = apr_pstrcat(r->pool, q, "&", r->args, NULL);
2455 r->args = apr_pstrdup(r->pool, q);
2457 if (strlen(r->args) == 0) {
2459 rewritelog(r, 3, "split uri=%s -> uri=%s, args=<none>", olduri,
2463 if (r->args[strlen(r->args)-1] == '&') {
2464 r->args[strlen(r->args)-1] = '\0';
2466 rewritelog(r, 3, "split uri=%s -> uri=%s, args=%s", olduri,
2467 r->filename, r->args);
2476 ** strip 'http[s]://ourhost/' from URI
2480 static void reduce_uri(request_rec *r)
2483 unsigned short port;
2488 char host[LONG_STRING_LEN];
2489 char buf[MAX_STRING_LEN];
2493 cp = (char *)ap_http_method(r);
2495 if ( strlen(r->filename) > l+3
2496 && strncasecmp(r->filename, cp, l) == 0
2497 && r->filename[l] == ':'
2498 && r->filename[l+1] == '/'
2499 && r->filename[l+2] == '/' ) {
2500 /* there was really a rewrite to a remote path */
2502 olduri = apr_pstrdup(r->pool, r->filename); /* save for logging */
2504 /* cut the hostname and port out of the URI */
2505 apr_cpystrn(buf, r->filename+(l+3), sizeof(buf));
2507 for (cp = hostp; *cp != '\0' && *cp != '/' && *cp != ':'; cp++)
2512 apr_cpystrn(host, hostp, sizeof(host));
2515 for (; *cp != '\0' && *cp != '/'; cp++)
2521 /* set remaining url */
2524 else if (*cp == '/') {
2527 apr_cpystrn(host, hostp, sizeof(host));
2530 port = ap_default_port(r);
2531 /* set remaining url */
2536 apr_cpystrn(host, hostp, sizeof(host));
2538 port = ap_default_port(r);
2539 /* set remaining url */
2543 /* now check whether we could reduce it to a local path... */
2544 if (ap_matches_request_vhost(r, host, port)) {
2545 /* this is our host, so only the URL remains */
2546 r->filename = apr_pstrdup(r->pool, url);
2547 rewritelog(r, 3, "reduce %s -> %s", olduri, r->filename);
2556 ** add 'http[s]://ourhost[:ourport]/' to URI
2557 ** if URI is still not fully qualified
2561 static void fully_qualify_uri(request_rec *r)
2564 const char *thisserver;
2568 if (!is_absolute_uri(r->filename)) {
2570 thisserver = ap_get_server_name(r);
2571 port = ap_get_server_port(r);
2572 if (ap_is_default_port(port,r)) {
2576 apr_snprintf(buf, sizeof(buf), ":%u", port);
2580 if (r->filename[0] == '/') {
2581 r->filename = apr_psprintf(r->pool, "%s://%s%s%s",
2582 ap_http_method(r), thisserver,
2583 thisport, r->filename);
2586 r->filename = apr_psprintf(r->pool, "%s://%s%s/%s",
2587 ap_http_method(r), thisserver,
2588 thisport, r->filename);
2597 ** return non-zero if the URI is absolute (includes a scheme etc.)
2601 static int is_absolute_uri(char *uri)
2603 int i = strlen(uri);
2604 if ( (i > 7 && strncasecmp(uri, "http://", 7) == 0)
2605 || (i > 8 && strncasecmp(uri, "https://", 8) == 0)
2606 || (i > 9 && strncasecmp(uri, "gopher://", 9) == 0)
2607 || (i > 6 && strncasecmp(uri, "ftp://", 6) == 0)
2608 || (i > 5 && strncasecmp(uri, "ldap:", 5) == 0)
2609 || (i > 5 && strncasecmp(uri, "news:", 5) == 0)
2610 || (i > 7 && strncasecmp(uri, "mailto:", 7) == 0) ) {
2621 ** Expand tilde-paths (/~user) through
2622 ** Unix /etc/passwd database information
2625 #if !defined(WIN32) && !defined(NETWARE)
2626 static char *expand_tildepaths(request_rec *r, char *uri)
2628 char user[LONG_STRING_LEN];
2634 if (uri != NULL && strlen(uri) > 2 && uri[0] == '/' && uri[1] == '~') {
2635 /* cut out the username */
2636 for (j = 0, i = 2; j < sizeof(user)-1
2638 && uri[i] != '/' ; ) {
2639 user[j++] = uri[i++];
2643 /* lookup username in systems passwd file */
2644 if ((pw = getpwnam(user)) != NULL) {
2645 /* ok, user was found, so expand the ~user string */
2646 if (uri[i] != '\0') {
2647 /* ~user/anything... has to be expanded */
2648 if (pw->pw_dir[strlen(pw->pw_dir)-1] == '/') {
2649 pw->pw_dir[strlen(pw->pw_dir)-1] = '\0';
2651 newuri = apr_pstrcat(r->pool, pw->pw_dir, uri+i, NULL);
2654 /* only ~user has to be expanded */
2655 newuri = apr_pstrdup(r->pool, pw->pw_dir);
2666 ** +-------------------------------------------------------+
2668 ** | DBM hashfile support
2670 ** +-------------------------------------------------------+
2674 static char *lookup_map(request_rec *r, char *name, char *key)
2677 rewrite_server_conf *conf;
2678 apr_array_header_t *rewritemaps;
2679 rewritemap_entry *entries;
2680 rewritemap_entry *s;
2686 /* get map configuration */
2687 sconf = r->server->module_config;
2688 conf = (rewrite_server_conf *)ap_get_module_config(sconf,
2690 rewritemaps = conf->rewritemaps;
2692 entries = (rewritemap_entry *)rewritemaps->elts;
2693 for (i = 0; i < rewritemaps->nelts; i++) {
2695 if (strcmp(s->name, name) == 0) {
2696 if (s->type == MAPTYPE_TXT) {
2697 if ((rv = apr_stat(&st, s->checkfile, r->pool)) != APR_SUCCESS) {
2698 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
2699 "mod_rewrite: can't access text RewriteMap "
2700 "file %s", s->checkfile);
2701 rewritelog(r, 1, "can't open RewriteMap file, "
2705 value = get_cache_string(cachep, s->name, CACHEMODE_TS,
2707 if (value == NULL) {
2708 rewritelog(r, 6, "cache lookup FAILED, forcing new "
2711 lookup_map_txtfile(r, s->datafile, key)) != NULL) {
2712 rewritelog(r, 5, "map lookup OK: map=%s key=%s[txt] "
2713 "-> val=%s", s->name, key, value);
2714 set_cache_string(cachep, s->name, CACHEMODE_TS,
2715 st.mtime, key, value);
2719 rewritelog(r, 5, "map lookup FAILED: map=%s[txt] "
2720 "key=%s", s->name, key);
2721 set_cache_string(cachep, s->name, CACHEMODE_TS,
2727 rewritelog(r, 5, "cache lookup OK: map=%s[txt] key=%s "
2728 "-> val=%s", s->name, key, value);
2729 return value[0] != '\0' ? value : NULL;
2732 else if (s->type == MAPTYPE_DBM) {
2733 #ifndef NO_DBM_REWRITEMAP
2734 if ((rv = apr_stat(&st, s->checkfile, r->pool)) != APR_SUCCESS) {
2735 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
2736 "mod_rewrite: can't access DBM RewriteMap "
2737 "file %s", s->checkfile);
2738 rewritelog(r, 1, "can't open DBM RewriteMap file, "
2742 value = get_cache_string(cachep, s->name, CACHEMODE_TS,
2744 if (value == NULL) {
2746 "cache lookup FAILED, forcing new map lookup");
2748 lookup_map_dbmfile(r, s->datafile, key)) != NULL) {
2749 rewritelog(r, 5, "map lookup OK: map=%s[dbm] key=%s "
2750 "-> val=%s", s->name, key, value);
2751 set_cache_string(cachep, s->name, CACHEMODE_TS,
2752 st.mtime, key, value);
2756 rewritelog(r, 5, "map lookup FAILED: map=%s[dbm] "
2757 "key=%s", s->name, key);
2758 set_cache_string(cachep, s->name, CACHEMODE_TS,
2764 rewritelog(r, 5, "cache lookup OK: map=%s[dbm] key=%s "
2765 "-> val=%s", s->name, key, value);
2766 return value[0] != '\0' ? value : NULL;
2772 else if (s->type == MAPTYPE_PRG) {
2774 lookup_map_program(r, s->fpin, s->fpout, key)) != NULL) {
2775 rewritelog(r, 5, "map lookup OK: map=%s key=%s -> val=%s",
2776 s->name, key, value);
2780 rewritelog(r, 5, "map lookup FAILED: map=%s key=%s",
2784 else if (s->type == MAPTYPE_INT) {
2785 if ((value = lookup_map_internal(r, s->func, key)) != NULL) {
2786 rewritelog(r, 5, "map lookup OK: map=%s key=%s -> val=%s",
2787 s->name, key, value);
2791 rewritelog(r, 5, "map lookup FAILED: map=%s key=%s",
2795 else if (s->type == MAPTYPE_RND) {
2796 if ((rv = apr_stat(&st, s->checkfile, r->pool)) != APR_SUCCESS) {
2797 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
2798 "mod_rewrite: can't access text RewriteMap "
2799 "file %s", s->checkfile);
2800 rewritelog(r, 1, "can't open RewriteMap file, "
2804 value = get_cache_string(cachep, s->name, CACHEMODE_TS,
2806 if (value == NULL) {
2807 rewritelog(r, 6, "cache lookup FAILED, forcing new "
2810 lookup_map_txtfile(r, s->datafile, key)) != NULL) {
2811 rewritelog(r, 5, "map lookup OK: map=%s key=%s[txt] "
2812 "-> val=%s", s->name, key, value);
2813 set_cache_string(cachep, s->name, CACHEMODE_TS,
2814 st.mtime, key, value);
2817 rewritelog(r, 5, "map lookup FAILED: map=%s[txt] "
2818 "key=%s", s->name, key);
2819 set_cache_string(cachep, s->name, CACHEMODE_TS,
2825 rewritelog(r, 5, "cache lookup OK: map=%s[txt] key=%s "
2826 "-> val=%s", s->name, key, value);
2828 if (value[0] != '\0') {
2829 value = select_random_value_part(r, value);
2830 rewritelog(r, 5, "randomly choosen the subvalue `%s'", value);
2842 static char *lookup_map_txtfile(request_rec *r, const char *file, char *key)
2844 apr_file_t *fp = NULL;
2853 rc = apr_open(&fp, file, APR_READ, APR_OS_DEFAULT, r->pool);
2854 if (rc != APR_SUCCESS) {
2858 while (apr_fgets(line, sizeof(line), fp) == APR_SUCCESS) {
2860 continue; /* ignore comments */
2863 skip = strcspn(cpT," \t\r\n");
2865 continue; /* ignore lines that start with a space, tab, CR, or LF */
2868 if (strcmp(curkey, key) != 0)
2869 continue; /* key does not match... */
2871 /* found a matching key; now extract and return the value */
2873 skip = strspn(cpT, " \t\r\n");
2876 skip = strcspn(cpT, " \t\r\n");
2878 continue; /* no value... */
2881 value = apr_pstrdup(r->pool, curval);
2888 #ifndef NO_DBM_REWRITEMAP
2889 static char *lookup_map_dbmfile(request_rec *r, const char *file, char *key)
2895 char buf[MAX_STRING_LEN];
2898 dbmkey.dsize = strlen(key);
2899 if ((dbmfp = dbm_open(file, O_RDONLY, 0666)) != NULL) {
2900 dbmval = dbm_fetch(dbmfp, dbmkey);
2901 if (dbmval.dptr != NULL) {
2902 memcpy(buf, dbmval.dptr,
2903 dbmval.dsize < sizeof(buf)-1 ?
2904 dbmval.dsize : sizeof(buf)-1 );
2905 buf[dbmval.dsize] = '\0';
2906 value = apr_pstrdup(r->pool, buf);
2914 static char *lookup_map_program(request_rec *r, apr_file_t *fpin,
2915 apr_file_t *fpout, char *key)
2917 char buf[LONG_STRING_LEN];
2923 struct iovec iova[2];
2927 /* when `RewriteEngine off' was used in the per-server
2928 * context then the rewritemap-programs were not spawned.
2929 * In this case using such a map (usually in per-dir context)
2930 * is useless because it is not available.
2932 if (fpin == NULL || fpout == NULL) {
2938 if (rewrite_mapr_lock) {
2939 apr_lock(rewrite_mapr_lock);
2942 /* write out the request key */
2944 nbytes = strlen(key);
2945 apr_write(fpin, key, &nbytes);
2947 apr_write(fpin, "\n", &nbytes);
2949 iova[0].iov_base = key;
2950 iova[0].iov_len = strlen(key);
2951 iova[1].iov_base = "\n";
2952 iova[1].iov_len = 1;
2955 apr_writev(fpin, iova, niov, &nbytes);
2958 /* read in the response value */
2961 apr_read(fpout, &c, &nbytes);
2962 while (nbytes == 1 && (i < LONG_STRING_LEN-1)) {
2968 apr_read(fpout, &c, &nbytes);
2972 /* give the lock back */
2973 if (rewrite_mapr_lock) {
2974 apr_unlock(rewrite_mapr_lock);
2977 if (strcasecmp(buf, "NULL") == 0) {
2981 return apr_pstrdup(r->pool, buf);
2985 static char *lookup_map_internal(request_rec *r,
2986 char *(*func)(request_rec *, char *),
2989 /* currently we just let the function convert
2990 the key to a corresponding value */
2991 return func(r, key);
2994 static char *rewrite_mapfunc_toupper(request_rec *r, char *key)
2998 for (cp = value = apr_pstrdup(r->pool, key); cp != NULL && *cp != '\0';
3000 *cp = apr_toupper(*cp);
3005 static char *rewrite_mapfunc_tolower(request_rec *r, char *key)
3009 for (cp = value = apr_pstrdup(r->pool, key); cp != NULL && *cp != '\0';
3011 *cp = apr_tolower(*cp);
3016 static char *rewrite_mapfunc_escape(request_rec *r, char *key)
3020 value = ap_escape_uri(r->pool, key);
3024 static char *rewrite_mapfunc_unescape(request_rec *r, char *key)
3028 value = apr_pstrdup(r->pool, key);
3029 ap_unescape_url(value);
3033 static int rewrite_rand_init_done = 0;
3035 static void rewrite_rand_init(void)
3037 if (!rewrite_rand_init_done) {
3038 srand((unsigned)(getpid()));
3039 rewrite_rand_init_done = 1;
3044 static int rewrite_rand(int l, int h)
3046 rewrite_rand_init();
3048 /* Get [0,1) and then scale to the appropriate range. Note that using
3049 * a floating point value ensures that we use all bits of the rand()
3050 * result. Doing an integer modulus would only use the lower-order bits
3051 * which may not be as uniformly random.
3053 return ((double)(rand() % RAND_MAX) / RAND_MAX) * (h - l + 1) + l;
3056 static char *select_random_value_part(request_rec *r, char *value)
3061 /* count number of distinct values */
3062 for (n = 1, i = 0; value[i] != '\0'; i++) {
3063 if (value[i] == '|') {
3068 /* when only one value we have no option to choose */
3073 /* else randomly select one */
3074 k = rewrite_rand(1, n);
3076 /* and grep it out */
3077 for (n = 1, i = 0; value[i] != '\0'; i++) {
3081 if (value[i] == '|') {
3085 buf = apr_pstrdup(r->pool, &value[i]);
3086 for (i = 0; buf[i] != '\0' && buf[i] != '|'; i++)
3094 ** +-------------------------------------------------------+
3096 ** | rewriting logfile support
3098 ** +-------------------------------------------------------+
3102 static void open_rewritelog(server_rec *s, apr_pool_t *p)
3104 rewrite_server_conf *conf;
3108 int rewritelog_flags = ( APR_WRITE | APR_APPEND | APR_CREATE );
3109 mode_t rewritelog_mode = ( APR_UREAD | APR_UWRITE | APR_GREAD | APR_WREAD );
3111 conf = ap_get_module_config(s->module_config, &rewrite_module);
3113 if (conf->rewritelogfile == NULL) {
3116 if (*(conf->rewritelogfile) == '\0') {
3119 if (conf->rewritelogfp != NULL) {
3120 return; /* virtual log shared w/ main server */
3123 fname = ap_server_root_relative(p, conf->rewritelogfile);
3125 if (*conf->rewritelogfile == '|') {
3126 if ((pl = ap_open_piped_log(p, conf->rewritelogfile+1)) == NULL) {
3127 ap_log_error(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, s,
3128 "mod_rewrite: could not open reliable pipe "
3129 "to RewriteLog filter %s", conf->rewritelogfile+1);
3132 conf->rewritelogfp = ap_piped_log_write_fd(pl);
3134 else if (*conf->rewritelogfile != '\0') {
3135 rc = apr_open(&conf->rewritelogfp, fname, rewritelog_flags, rewritelog_mode, p);
3136 if (rc != APR_SUCCESS) {
3137 ap_log_error(APLOG_MARK, APLOG_ERR, rc, s,
3138 "mod_rewrite: could not open RewriteLog "
3146 static void rewritelog(request_rec *r, int level, const char *text, ...)
3148 rewrite_server_conf *conf;
3163 conf = ap_get_module_config(r->server->module_config, &rewrite_module);
3164 conn = r->connection;
3166 if (conf->rewritelogfp == NULL) {
3169 if (conf->rewritelogfile == NULL) {
3172 if (*(conf->rewritelogfile) == '\0') {
3176 if (level > conf->rewriteloglevel) {
3180 if (r->user == NULL) {
3183 else if (strlen(r->user) != 0) {
3190 rhost = ap_get_remote_host(conn, r->server->module_config,
3192 if (rhost == NULL) {
3193 rhost = "UNKNOWN-HOST";
3196 str1 = apr_pstrcat(r->pool, rhost, " ",
3197 (conn->remote_logname != NULL ?
3198 conn->remote_logname : "-"), " ",
3200 apr_vsnprintf(str2, sizeof(str2), text, ap);
3202 if (r->main == NULL) {
3203 strcpy(type, "initial");
3206 strcpy(type, "subreq");
3209 for (i = 0, req = r; req->prev != NULL; req = req->prev) {
3216 apr_snprintf(redir, sizeof(redir), "/redir#%d", i);
3219 apr_snprintf(str3, sizeof(str3),
3220 "%s %s [%s/sid#%lx][rid#%lx/%s%s] (%d) %s\n", str1,
3221 current_logtime(r), ap_get_server_name(r),
3222 (unsigned long)(r->server), (unsigned long)r,
3223 type, redir, level, str2);
3225 apr_lock(rewrite_log_lock);
3226 nbytes = strlen(str3);
3227 apr_write(conf->rewritelogfp, str3, &nbytes);
3228 apr_unlock(rewrite_log_lock);
3234 static char *current_logtime(request_rec *r)
3236 apr_exploded_time_t t;
3240 apr_explode_localtime(&t, apr_now());
3242 apr_strftime(tstr, &len, 80, "[%d/%b/%Y:%H:%M:%S ", &t);
3243 apr_snprintf(tstr + strlen(tstr), 80-strlen(tstr), "%c%.2d%.2d]",
3244 t.tm_gmtoff < 0 ? '-' : '+',
3245 t.tm_gmtoff / (60*60), t.tm_gmtoff % (60*60));
3246 return apr_pstrdup(r->pool, tstr);
3253 ** +-------------------------------------------------------+
3255 ** | rewriting lockfile support
3257 ** +-------------------------------------------------------+
3260 #define REWRITELOCK_MODE ( APR_UREAD | APR_UWRITE | APR_GREAD | APR_WREAD )
3262 static void rewritelock_create(server_rec *s, apr_pool_t *p)
3266 /* only operate if a lockfile is used */
3267 if (lockname == NULL || *(lockname) == '\0') {
3271 /* fixup the path, especially for rewritelock_remove() */
3272 lockname = ap_server_root_relative(p, lockname);
3274 /* create the lockfile */
3275 rc = apr_create_lock (&rewrite_mapr_lock, APR_MUTEX, APR_LOCKALL, lockname, p);
3276 if (rc != APR_SUCCESS) {
3277 ap_log_error(APLOG_MARK, APLOG_ERR, rc, s,
3278 "mod_rewrite: Parent could not create RewriteLock "
3279 "file %s", lockname);
3286 static apr_status_t rewritelock_remove(void *data)
3288 /* only operate if a lockfile is used */
3289 if (lockname == NULL || *(lockname) == '\0') {
3293 /* destroy the rewritelock */
3294 apr_destroy_lock (rewrite_mapr_lock);
3295 rewrite_mapr_lock = NULL;
3302 ** +-------------------------------------------------------+
3304 ** | program map support
3306 ** +-------------------------------------------------------+
3309 static void run_rewritemap_programs(server_rec *s, apr_pool_t *p)
3311 rewrite_server_conf *conf;
3312 apr_file_t *fpin = NULL;
3313 apr_file_t *fpout = NULL;
3314 apr_file_t *fperr = NULL;
3315 apr_array_header_t *rewritemaps;
3316 rewritemap_entry *entries;
3317 rewritemap_entry *map;
3321 conf = ap_get_module_config(s->module_config, &rewrite_module);
3323 /* If the engine isn't turned on,
3324 * don't even try to do anything.
3326 if (conf->state == ENGINE_DISABLED) {
3330 rewritemaps = conf->rewritemaps;
3331 entries = (rewritemap_entry *)rewritemaps->elts;
3332 for (i = 0; i < rewritemaps->nelts; i++) {
3334 if (map->type != MAPTYPE_PRG) {
3337 if (map->datafile == NULL
3338 || *(map->datafile) == '\0'
3339 || map->fpin != NULL
3340 || map->fpout != NULL ) {
3345 rc = rewritemap_program_child(p, map->datafile,
3346 &fpout, &fpin, &fperr);
3347 if (rc != APR_SUCCESS || fpin == NULL || fpout == NULL) {
3348 ap_log_error(APLOG_MARK, APLOG_ERR, rc, s,
3349 "mod_rewrite: could not fork child for "
3350 "RewriteMap process");
3360 /* child process code */
3361 static apr_status_t rewritemap_program_child(apr_pool_t *p, const char *progname,
3362 apr_file_t **fpout, apr_file_t **fpin,
3366 apr_procattr_t *procattr;
3367 apr_proc_t *procnew;
3370 apr_signal(SIGHUP, SIG_IGN);
3374 if (((rc = apr_createprocattr_init(&procattr, p)) != APR_SUCCESS) ||
3375 ((rc = apr_setprocattr_io(procattr, APR_FULL_BLOCK,
3377 APR_FULL_NONBLOCK)) != APR_SUCCESS) ||
3378 ((rc = apr_setprocattr_dir(procattr,
3379 ap_make_dirstr_parent(p, progname)))
3381 ((rc = apr_setprocattr_cmdtype(procattr, APR_PROGRAM)) != APR_SUCCESS)) {
3382 /* Something bad happened, give up and go away. */
3385 procnew = apr_pcalloc(p, sizeof(*procnew));
3386 rc = apr_create_process(procnew, progname, NULL, NULL, procattr, p);
3388 if (rc == APR_SUCCESS) {
3389 apr_note_subprocess(p, procnew, kill_after_timeout);
3392 (*fpin) = procnew->in;
3396 (*fpout) = procnew->out;
3400 (*fperr) = procnew->err;
3412 ** +-------------------------------------------------------+
3414 ** | environment variable support
3416 ** +-------------------------------------------------------+
3420 static char *lookup_variable(request_rec *r, char *var)
3423 char resultbuf[LONG_STRING_LEN];
3424 apr_exploded_time_t tm;
3435 if (strcasecmp(var, "HTTP_USER_AGENT") == 0) {
3436 result = lookup_header(r, "User-Agent");
3438 else if (strcasecmp(var, "HTTP_REFERER") == 0) {
3439 result = lookup_header(r, "Referer");
3441 else if (strcasecmp(var, "HTTP_COOKIE") == 0) {
3442 result = lookup_header(r, "Cookie");
3444 else if (strcasecmp(var, "HTTP_FORWARDED") == 0) {
3445 result = lookup_header(r, "Forwarded");
3447 else if (strcasecmp(var, "HTTP_HOST") == 0) {
3448 result = lookup_header(r, "Host");
3450 else if (strcasecmp(var, "HTTP_PROXY_CONNECTION") == 0) {
3451 result = lookup_header(r, "Proxy-Connection");
3453 else if (strcasecmp(var, "HTTP_ACCEPT") == 0) {
3454 result = lookup_header(r, "Accept");
3456 /* all other headers from which we are still not know about */
3457 else if (strlen(var) > 5 && strncasecmp(var, "HTTP:", 5) == 0) {
3458 result = lookup_header(r, var+5);
3461 /* connection stuff */
3462 else if (strcasecmp(var, "REMOTE_ADDR") == 0) {
3463 result = r->connection->remote_ip;
3465 else if (strcasecmp(var, "REMOTE_HOST") == 0) {
3466 result = (char *)ap_get_remote_host(r->connection,
3467 r->per_dir_config, REMOTE_NAME);
3469 else if (strcasecmp(var, "REMOTE_USER") == 0) {
3472 else if (strcasecmp(var, "REMOTE_IDENT") == 0) {
3473 result = (char *)ap_get_remote_logname(r);
3477 else if (strcasecmp(var, "THE_REQUEST") == 0) { /* non-standard */
3478 result = r->the_request;
3480 else if (strcasecmp(var, "REQUEST_METHOD") == 0) {
3483 else if (strcasecmp(var, "REQUEST_URI") == 0) { /* non-standard */
3486 else if (strcasecmp(var, "SCRIPT_FILENAME") == 0 ||
3487 strcasecmp(var, "REQUEST_FILENAME") == 0 ) {
3488 result = r->filename;
3490 else if (strcasecmp(var, "PATH_INFO") == 0) {
3491 result = r->path_info;
3493 else if (strcasecmp(var, "QUERY_STRING") == 0) {
3496 else if (strcasecmp(var, "AUTH_TYPE") == 0) {
3497 result = r->ap_auth_type;
3499 else if (strcasecmp(var, "IS_SUBREQ") == 0) { /* non-standard */
3500 result = (r->main != NULL ? "true" : "false");
3503 /* internal server stuff */
3504 else if (strcasecmp(var, "DOCUMENT_ROOT") == 0) {
3505 result = ap_document_root(r);
3507 else if (strcasecmp(var, "SERVER_ADMIN") == 0) {
3508 result = r->server->server_admin;
3510 else if (strcasecmp(var, "SERVER_NAME") == 0) {
3511 result = ap_get_server_name(r);
3513 else if (strcasecmp(var, "SERVER_ADDR") == 0) { /* non-standard */
3514 result = r->connection->local_ip;
3516 else if (strcasecmp(var, "SERVER_PORT") == 0) {
3517 apr_snprintf(resultbuf, sizeof(resultbuf), "%u", ap_get_server_port(r));
3520 else if (strcasecmp(var, "SERVER_PROTOCOL") == 0) {
3521 result = r->protocol;
3523 else if (strcasecmp(var, "SERVER_SOFTWARE") == 0) {
3524 result = ap_get_server_version();
3526 else if (strcasecmp(var, "API_VERSION") == 0) { /* non-standard */
3527 apr_snprintf(resultbuf, sizeof(resultbuf), "%d:%d",
3528 MODULE_MAGIC_NUMBER_MAJOR, MODULE_MAGIC_NUMBER_MINOR);
3532 /* XXX: wow this has gotta be slow if you actually use it for a lot, recalculates exploded time for each variable */
3533 /* underlaying Unix system stuff */
3534 else if (strcasecmp(var, "TIME_YEAR") == 0) {
3535 apr_explode_localtime(&tm, apr_now());
3536 apr_snprintf(resultbuf, sizeof(resultbuf), "%04d", tm.tm_year + 1900);
3539 #define MKTIMESTR(format, tmfield) \
3540 apr_explode_localtime(&tm, apr_now()); \
3541 apr_snprintf(resultbuf, sizeof(resultbuf), format, tm.tmfield); \
3543 else if (strcasecmp(var, "TIME_MON") == 0) {
3544 MKTIMESTR("%02d", tm_mon+1)
3546 else if (strcasecmp(var, "TIME_DAY") == 0) {
3547 MKTIMESTR("%02d", tm_mday)
3549 else if (strcasecmp(var, "TIME_HOUR") == 0) {
3550 MKTIMESTR("%02d", tm_hour)
3552 else if (strcasecmp(var, "TIME_MIN") == 0) {
3553 MKTIMESTR("%02d", tm_min)
3555 else if (strcasecmp(var, "TIME_SEC") == 0) {
3556 MKTIMESTR("%02d", tm_sec)
3558 else if (strcasecmp(var, "TIME_WDAY") == 0) {
3559 MKTIMESTR("%d", tm_wday)
3561 else if (strcasecmp(var, "TIME") == 0) {
3562 apr_explode_localtime(&tm, apr_now());
3563 apr_snprintf(resultbuf, sizeof(resultbuf),
3564 "%04d%02d%02d%02d%02d%02d", tm.tm_year + 1900,
3565 tm.tm_mon+1, tm.tm_mday,
3566 tm.tm_hour, tm.tm_min, tm.tm_sec);
3568 rewritelog(r, 1, "RESULT='%s'", result);
3571 /* all other env-variables from the parent Apache process */
3572 else if (strlen(var) > 4 && strncasecmp(var, "ENV:", 4) == 0) {
3573 /* first try the internal Apache notes structure */
3574 result = apr_table_get(r->notes, var+4);
3575 /* second try the internal Apache env structure */
3576 if (result == NULL) {
3577 result = apr_table_get(r->subprocess_env, var+4);
3579 /* third try the external OS env */
3580 if (result == NULL) {
3581 result = getenv(var+4);
3585 #define LOOKAHEAD(subrecfunc) \
3587 /* filename is safe to use */ \
3588 r->filename != NULL \
3589 /* - and we're either not in a subrequest */ \
3590 && ( r->main == NULL \
3591 /* - or in a subrequest where paths are non-NULL... */ \
3592 || ( r->main->uri != NULL && r->uri != NULL \
3593 /* ...and sub and main paths differ */ \
3594 && strcmp(r->main->uri, r->uri) != 0))) { \
3595 /* process a file-based subrequest */ \
3596 rsub = subrecfunc(r->filename, r); \
3597 /* now recursively lookup the variable in the sub_req */ \
3598 result = lookup_variable(rsub, var+5); \
3599 /* copy it up to our scope before we destroy sub_req's apr_pool_t */ \
3600 result = apr_pstrdup(r->pool, result); \
3601 /* cleanup by destroying the subrequest */ \
3602 ap_destroy_sub_req(rsub); \
3604 rewritelog(r, 5, "lookahead: path=%s var=%s -> val=%s", \
3605 r->filename, var+5, result); \
3606 /* return ourself to prevent re-pstrdup */ \
3607 return (char *)result; \
3610 /* look-ahead for parameter through URI-based sub-request */
3611 else if (strlen(var) > 5 && strncasecmp(var, "LA-U:", 5) == 0) {
3612 LOOKAHEAD(ap_sub_req_lookup_uri)
3614 /* look-ahead for parameter through file-based sub-request */
3615 else if (strlen(var) > 5 && strncasecmp(var, "LA-F:", 5) == 0) {
3616 LOOKAHEAD(ap_sub_req_lookup_file)
3619 #if !defined(WIN32) && !defined(NETWARE)
3620 /* Win32 has a rather different view of file ownerships.
3621 For now, just forget it */
3624 else if (strcasecmp(var, "SCRIPT_USER") == 0) {
3625 result = "<unknown>";
3626 if (r->finfo.protection != 0) {
3627 if ((pw = getpwuid(r->finfo.user)) != NULL) {
3628 result = pw->pw_name;
3632 if (apr_stat(&finfo, r->filename, r->pool) == APR_SUCCESS) {
3633 if ((pw = getpwuid(finfo.user)) != NULL) {
3634 result = pw->pw_name;
3639 else if (strcasecmp(var, "SCRIPT_GROUP") == 0) {
3640 result = "<unknown>";
3641 if (r->finfo.protection != 0) {
3642 if ((gr = getgrgid(r->finfo.group)) != NULL) {
3643 result = gr->gr_name;
3647 if (apr_stat(&finfo, r->filename, r->pool) == 0) {
3648 if ((gr = getgrgid(finfo.group)) != NULL) {
3649 result = gr->gr_name;
3654 #endif /* ndef WIN32 && NETWARE*/
3656 if (result == NULL) {
3657 return apr_pstrdup(r->pool, "");
3660 return apr_pstrdup(r->pool, result);
3664 static char *lookup_header(request_rec *r, const char *name)
3666 apr_array_header_t *hdrs_arr;
3667 apr_table_entry_t *hdrs;
3670 hdrs_arr = apr_table_elts(r->headers_in);
3671 hdrs = (apr_table_entry_t *)hdrs_arr->elts;
3672 for (i = 0; i < hdrs_arr->nelts; ++i) {
3673 if (hdrs[i].key == NULL) {
3676 if (strcasecmp(hdrs[i].key, name) == 0) {
3677 apr_table_merge(r->notes, VARY_KEY_THIS, name);
3688 ** +-------------------------------------------------------+
3690 ** | caching support
3692 ** +-------------------------------------------------------+
3696 static cache *init_cache(apr_pool_t *p)
3700 c = (cache *)apr_palloc(p, sizeof(cache));
3701 if (apr_create_pool(&c->pool, p) != APR_SUCCESS)
3703 c->lists = apr_make_array(c->pool, 2, sizeof(cachelist));
3707 static void set_cache_string(cache *c, const char *res, int mode, time_t t,
3708 char *key, char *value)
3715 store_cache_string(c, res, &ce);
3719 static char *get_cache_string(cache *c, const char *res, int mode,
3720 time_t t, char *key)
3724 ce = retrieve_cache_string(c, res, key);
3728 if (mode & CACHEMODE_TS) {
3729 if (t != ce->time) {
3733 else if (mode & CACHEMODE_TTL) {
3738 return apr_pstrdup(c->pool, ce->value);
3741 static int cache_tlb_hash(char *key)
3747 for (p = key; *p != '\0'; p++) {
3748 n = ((n << 5) + n) ^ (unsigned long)(*p++);
3751 return n % CACHE_TLB_ROWS;
3754 static cacheentry *cache_tlb_lookup(cachetlbentry *tlb, cacheentry *elt,
3757 int ix = cache_tlb_hash(key);
3761 for (i=0; i < CACHE_TLB_COLS; ++i) {
3765 if (strcmp(elt[j].key, key) == 0)
3771 static void cache_tlb_replace(cachetlbentry *tlb, cacheentry *elt,
3774 int ix = cache_tlb_hash(e->key);
3779 for (i=1; i < CACHE_TLB_COLS; ++i)
3780 tlb->t[i] = tlb->t[i-1];
3782 tlb->t[0] = e - elt;
3785 static void store_cache_string(cache *c, const char *res, cacheentry *ce)
3795 /* first try to edit an existing entry */
3796 for (i = 0; i < c->lists->nelts; i++) {
3797 l = &(((cachelist *)c->lists->elts)[i]);
3798 if (strcmp(l->resource, res) == 0) {
3801 e = cache_tlb_lookup((cachetlbentry *)l->tlb->elts,
3802 (cacheentry *)l->entries->elts, ce->key);
3805 e->value = apr_pstrdup(c->pool, ce->value);
3809 for (j = 0; j < l->entries->nelts; j++) {
3810 e = &(((cacheentry *)l->entries->elts)[j]);
3811 if (strcmp(e->key, ce->key) == 0) {
3813 e->value = apr_pstrdup(c->pool, ce->value);
3814 cache_tlb_replace((cachetlbentry *)l->tlb->elts,
3815 (cacheentry *)l->entries->elts, e);
3822 /* create a needed new list */
3824 l = apr_push_array(c->lists);
3825 l->resource = apr_pstrdup(c->pool, res);
3826 l->entries = apr_make_array(c->pool, 2, sizeof(cacheentry));
3827 l->tlb = apr_make_array(c->pool, CACHE_TLB_ROWS,
3828 sizeof(cachetlbentry));
3829 for (i=0; i<CACHE_TLB_ROWS; ++i) {
3830 t = &((cachetlbentry *)l->tlb->elts)[i];
3831 for (j=0; j<CACHE_TLB_COLS; ++j)
3836 /* create the new entry */
3837 for (i = 0; i < c->lists->nelts; i++) {
3838 l = &(((cachelist *)c->lists->elts)[i]);
3839 if (strcmp(l->resource, res) == 0) {
3840 e = apr_push_array(l->entries);
3842 e->key = apr_pstrdup(c->pool, ce->key);
3843 e->value = apr_pstrdup(c->pool, ce->value);
3844 cache_tlb_replace((cachetlbentry *)l->tlb->elts,
3845 (cacheentry *)l->entries->elts, e);
3850 /* not reached, but when it is no problem... */
3854 static cacheentry *retrieve_cache_string(cache *c, const char *res, char *key)
3861 for (i = 0; i < c->lists->nelts; i++) {
3862 l = &(((cachelist *)c->lists->elts)[i]);
3863 if (strcmp(l->resource, res) == 0) {
3865 e = cache_tlb_lookup((cachetlbentry *)l->tlb->elts,
3866 (cacheentry *)l->entries->elts, key);
3870 for (j = 0; j < l->entries->nelts; j++) {
3871 e = &(((cacheentry *)l->entries->elts)[j]);
3872 if (strcmp(e->key, key) == 0) {
3885 ** +-------------------------------------------------------+
3889 ** +-------------------------------------------------------+
3892 static char *subst_prefix_path(request_rec *r, char *input, char *match,
3895 char matchbuf[LONG_STRING_LEN];
3896 char substbuf[LONG_STRING_LEN];
3902 /* first create a match string which always has a trailing slash */
3903 l = apr_cpystrn(matchbuf, match, sizeof(matchbuf)) - matchbuf;
3904 if (matchbuf[l-1] != '/') {
3906 matchbuf[l+1] = '\0';
3909 /* now compare the prefix */
3910 if (strncmp(input, matchbuf, l) == 0) {
3911 rewritelog(r, 5, "strip matching prefix: %s -> %s", output, output+l);
3912 output = apr_pstrdup(r->pool, output+l);
3914 /* and now add the base-URL as replacement prefix */
3915 l = apr_cpystrn(substbuf, subst, sizeof(substbuf)) - substbuf;
3916 if (substbuf[l-1] != '/') {
3918 substbuf[l+1] = '\0';
3921 if (output[0] == '/') {
3922 rewritelog(r, 4, "add subst prefix: %s -> %s%s",
3923 output, substbuf, output+1);
3924 output = apr_pstrcat(r->pool, substbuf, output+1, NULL);
3927 rewritelog(r, 4, "add subst prefix: %s -> %s%s",
3928 output, substbuf, output);
3929 output = apr_pstrcat(r->pool, substbuf, output, NULL);
3938 ** own command line parser which don't have the '\\' problem
3942 static int parseargline(char *str, char **a1, char **a2, char **a3)
3947 #define SKIP_WHITESPACE(cp) \
3948 for ( ; *cp == ' ' || *cp == '\t'; ) { \
3952 #define CHECK_QUOTATION(cp,isquoted) \
3959 #define DETERMINE_NEXTSTRING(cp,isquoted) \
3960 for ( ; *cp != '\0'; cp++) { \
3961 if ( (isquoted && (*cp == ' ' || *cp == '\t')) \
3962 || (*cp == '\\' && (*(cp+1) == ' ' || *(cp+1) == '\t'))) { \
3966 if ( (!isquoted && (*cp == ' ' || *cp == '\t')) \
3967 || (isquoted && *cp == '"') ) { \
3973 SKIP_WHITESPACE(cp);
3975 /* determine first argument */
3976 CHECK_QUOTATION(cp, isquoted);
3978 DETERMINE_NEXTSTRING(cp, isquoted);
3984 SKIP_WHITESPACE(cp);
3986 /* determine second argument */
3987 CHECK_QUOTATION(cp, isquoted);
3989 DETERMINE_NEXTSTRING(cp, isquoted);
3997 SKIP_WHITESPACE(cp);
3999 /* again check if there are only two arguments */
4006 /* determine second argument */
4007 CHECK_QUOTATION(cp, isquoted);
4009 DETERMINE_NEXTSTRING(cp, isquoted);
4016 static void add_env_variable(request_rec *r, char *s)
4018 char var[MAX_STRING_LEN];
4019 char val[MAX_STRING_LEN];
4023 if ((cp = strchr(s, ':')) != NULL) {
4024 n = ((cp-s) > MAX_STRING_LEN-1 ? MAX_STRING_LEN-1 : (cp-s));
4027 apr_cpystrn(val, cp+1, sizeof(val));
4028 apr_table_set(r->subprocess_env, var, val);
4029 rewritelog(r, 5, "setting env variable '%s' to '%s'", var, val);
4036 ** check that a subrequest won't cause infinite recursion
4040 static int subreq_ok(request_rec *r)
4043 * either not in a subrequest, or in a subrequest
4044 * and URIs aren't NULL and sub/main URIs differ
4046 return (r->main == NULL ||
4047 (r->main->uri != NULL && r->uri != NULL &&
4048 strcmp(r->main->uri, r->uri) != 0));
4054 ** stat() for only the prefix of a path
4058 static int prefix_stat(const char *path, apr_finfo_t *sb)
4060 char curpath[LONG_STRING_LEN];
4063 apr_cpystrn(curpath, path, sizeof(curpath));
4064 if (curpath[0] != '/') {
4067 if ((cp = strchr(curpath+1, '/')) != NULL) {
4070 if (apr_stat(sb, curpath, NULL) == 0) {
4081 ** Lexicographic Compare
4085 static int compare_lexicography(char *cpNum1, char *cpNum2)
4090 n1 = strlen(cpNum1);
4091 n2 = strlen(cpNum2);
4098 for (i = 0; i < n1; i++) {
4099 if (cpNum1[i] > cpNum2[i]) {
4102 if (cpNum1[i] < cpNum2[i]) {
4111 ** Find end of bracketed expression
4112 ** s points after the opening bracket
4116 static char *find_closing_bracket(char *s, int left, int right)
4120 for (depth = 1; *s; ++s) {
4121 if (*s == right && --depth == 0) {
4124 else if (*s == left) {
4132 int main(int argc, char *argv[])
4134 ExitThread(TSR_THREAD, 0);