5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<?xml version="1.0"?>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

1a6464613c59e35072b90ca296ae402cbe956144Christian Maeder<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<modulesynopsis metafile="mod_rewrite.xml.meta">

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<name>mod_rewrite</name>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<description>Provides a rule-based rewriting engine to rewrite requested

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian MaederURLs on the fly</description>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<status>Extension</status>

d21f1db14625cb0a536fc06b46fcc115d48a25bbChristian Maeder<sourcefile>mod_rewrite.c</sourcefile>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<identifier>rewrite_module</identifier>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<compatibility>Available in Apache 1.3 and later</compatibility>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<summary>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <blockquote>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>``The great thing about mod_rewrite is it gives you

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder all the configurability and flexibility of Sendmail.

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder The downside to mod_rewrite is that it gives you all

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder the configurability and flexibility of Sendmail.''</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p class="cite">-- <cite>Brian Behlendorf</cite><br />

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder Apache Group</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder </blockquote>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <blockquote>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>`` Despite the tons of examples and docs,

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder mod_rewrite is voodoo. Damned cool voodoo, but still

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder voodoo. ''</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p class="cite">-- <cite>Brian Moore</cite><br />

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder bem@news.cmc.net</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder </blockquote>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>Welcome to mod_rewrite, the Swiss Army Knife of URL

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder manipulation!</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>This module uses a rule-based rewriting engine (based on a

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder regular-expression parser) to rewrite requested URLs on the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder fly. It supports an unlimited number of rules and an

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder unlimited number of attached rule conditions for each rule to

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder provide a really flexible and powerful URL manipulation

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder mechanism. The URL manipulations can depend on various tests,

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder for instance server variables, environment variables, HTTP

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder headers, time stamps and even external database lookups in

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder various formats can be used to achieve a really granular URL

0e012772df2ce0dc7e8f0fe3acf458c2871dcfbcChristian Maeder matching.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>This module operates on the full URLs (including the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder path-info part) both in per-server context

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder (<code>httpd.conf</code>) and per-directory context

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder (<code>.htaccess</code>) and can even generate query-string

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder parts on result. The rewritten result can lead to internal

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder sub-processing, external request redirection or even to an

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder internal proxy throughput.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>But all this functionality and flexibility has its

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder drawback: complexity. So don't expect to understand this

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder entire module in just one day.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>This module was invented and originally written in April

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder 1996 and gifted exclusively to the The Apache Group in July 1997

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder by</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p class="indent">

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <a href="http://www.engelschall.com/"><code>Ralf S.

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder Engelschall</code></a><br />

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <a

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder href="mailto:rse@engelschall.com"><code>rse@engelschall.com</code></a><br />

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <a

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder href="http://www.engelschall.com/"><code>www.engelschall.com</code></a>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder </p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</summary>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<section id="Internal"><title>Internal Processing</title>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>The internal processing of this module is very complex but

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder needs to be explained once even to the average user to avoid

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder common mistakes and to let you exploit its full

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder functionality.</p>

ef67402074be14deb95e4ff564737d5593144130Klaus Luettich

ef67402074be14deb95e4ff564737d5593144130Klaus Luettich<section id="InternalAPI"><title>API Phases</title>

ef67402074be14deb95e4ff564737d5593144130Klaus Luettich

ef67402074be14deb95e4ff564737d5593144130Klaus Luettich <p>First you have to understand that when Apache processes a

ef67402074be14deb95e4ff564737d5593144130Klaus Luettich HTTP request it does this in phases. A hook for each of these

ef67402074be14deb95e4ff564737d5593144130Klaus Luettich phases is provided by the Apache API. Mod_rewrite uses two of

725a68ec81cba9b8aa8647bebfb5baa449803e7eKlaus Luettich these hooks: the URL-to-filename translation hook which is

ef67402074be14deb95e4ff564737d5593144130Klaus Luettich used after the HTTP request has been read but before any

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder authorization starts and the Fixup hook which is triggered

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder after the authorization phases and after the per-directory

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder config files (<code>.htaccess</code>) have been read, but

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder before the content handler is activated.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder <p>So, after a request comes in and Apache has determined the

26f228bf3a3fea810223396e5794c217a79a8d5bChristian Maeder corresponding server (or virtual server) the rewriting engine

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder starts processing of all mod_rewrite directives from the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder per-server configuration in the URL-to-filename phase. A few

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder steps later when the final data directories are found, the

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder per-directory configuration directives of mod_rewrite are

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder triggered in the Fixup phase. In both situations mod_rewrite

470ca7a2797069ae4b27c34c1b71419f67be1f84Christian Maeder rewrites URLs either to new URLs or to filenames, although

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder there is no obvious distinction between them. This is a usage

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder of the API which was not intended to be this way when the API

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder was designed, but as of Apache 1.x this is the only way

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder mod_rewrite can operate. To make this point more clear

26f228bf3a3fea810223396e5794c217a79a8d5bChristian Maeder remember the following two points:</p>

26f228bf3a3fea810223396e5794c217a79a8d5bChristian Maeder

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder <ol>

26f228bf3a3fea810223396e5794c217a79a8d5bChristian Maeder <li>Although mod_rewrite rewrites URLs to URLs, URLs to

ba904a15082557e939db689fcfba0c68c9a4f740Christian Maeder filenames and even filenames to filenames, the API

ba904a15082557e939db689fcfba0c68c9a4f740Christian Maeder currently provides only a URL-to-filename hook. In Apache

ba904a15082557e939db689fcfba0c68c9a4f740Christian Maeder 2.0 the two missing hooks will be added to make the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder processing more clear. But this point has no drawbacks for

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder the user, it is just a fact which should be remembered:

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder Apache does more in the URL-to-filename hook than the API

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder intends for it.</li>

26f228bf3a3fea810223396e5794c217a79a8d5bChristian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <li>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder Unbelievably mod_rewrite provides URL manipulations in

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder per-directory context, <em>i.e.</em>, within

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder <code>.htaccess</code> files, although these are reached

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder a very long time after the URLs have been translated to

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder filenames. It has to be this way because

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder <code>.htaccess</code> files live in the filesystem, so

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder processing has already reached this stage. In other

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder words: According to the API phases at this time it is too

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder late for any URL manipulations. To overcome this chicken

b9625461755578f3eed04676d42a63fd2caebd0cChristian Maeder and egg problem mod_rewrite uses a trick: When you

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder manipulate a URL/filename in per-directory context

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder mod_rewrite first rewrites the filename back to its

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder corresponding URL (which is usually impossible, but see

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder the <code>RewriteBase</code> directive below for the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder trick to achieve this) and then initiates a new internal

49ad22e8dae6b1ed8733a8bada2538d4713ceb34Christian Maeder sub-request with the new URL. This restarts processing of

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder the API phases.

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>Again mod_rewrite tries hard to make this complicated

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder step totally transparent to the user, but you should

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder remember here: While URL manipulations in per-server

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder context are really fast and efficient, per-directory

470ca7a2797069ae4b27c34c1b71419f67be1f84Christian Maeder rewrites are slow and inefficient due to this chicken and

470ca7a2797069ae4b27c34c1b71419f67be1f84Christian Maeder egg problem. But on the other hand this is the only way

470ca7a2797069ae4b27c34c1b71419f67be1f84Christian Maeder mod_rewrite can provide (locally restricted) URL

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder manipulations to the average user.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder </li>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder </ol>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>Don't forget these two points!</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</section>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<section id="InternalRuleset"><title>Ruleset Processing</title>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>Now when mod_rewrite is triggered in these two API phases, it

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder reads the configured rulesets from its configuration

470ca7a2797069ae4b27c34c1b71419f67be1f84Christian Maeder structure (which itself was either created on startup for

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder per-server context or during the directory walk of the Apache

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder kernel for per-directory context). Then the URL rewriting

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder engine is started with the contained ruleset (one or more

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder rules together with their conditions). The operation of the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder URL rewriting engine itself is exactly the same for both

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder configuration contexts. Only the final result processing is

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder different. </p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>The order of rules in the ruleset is important because the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder rewriting engine processes them in a special (and not very

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder obvious) order. The rule is this: The rewriting engine loops

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder through the ruleset rule by rule (<directive

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder module="mod_rewrite">RewriteRule</directive> directives) and

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder when a particular rule matches it optionally loops through

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder existing corresponding conditions (<code>RewriteCond</code>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder directives). For historical reasons the conditions are given

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder first, and so the control flow is a little bit long-winded. See

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder Figure 1 for more details.</p>

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder<p class="figure">

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder <img src="/images/mod_rewrite_fig1.gif" width="428"

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder height="385" alt="[Needs graphics capability to display]" /><br />

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <dfn>Figure 1:</dfn>The control flow through the rewriting ruleset

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</p>

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder <p>As you can see, first the URL is matched against the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <em>Pattern</em> of each rule. When it fails mod_rewrite

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder immediately stops processing this rule and continues with the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder next rule. If the <em>Pattern</em> matches, mod_rewrite looks

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder for corresponding rule conditions. If none are present, it

5d6ee210ac97051e4d1830d4c346d8a8db01a6b5Christian Maeder just substitutes the URL with a new value which is

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder constructed from the string <em>Substitution</em> and goes on

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder with its rule-looping. But if conditions exist, it starts an

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder inner loop for processing them in the order that they are

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder listed. For conditions the logic is different: we don't match

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder a pattern against the current URL. Instead we first create a

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder string <em>TestString</em> by expanding variables,

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder back-references, map lookups, <em>etc.</em> and then we try

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder to match <em>CondPattern</em> against it. If the pattern

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder doesn't match, the complete set of conditions and the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder corresponding rule fails. If the pattern matches, then the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder next condition is processed until no more conditions are

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder available. If all conditions match, processing is continued

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder with the substitution of the URL with

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <em>Substitution</em>.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</section>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<section id="quoting"><title>Quoting Special Characters</title>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>As of Apache 1.3.20, special characters in

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <em>TestString</em> and <em>Substitution</em> strings can be

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder escaped (that is, treated as normal characters without their

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder usual special meaning) by prefixing them with a slosh ('\')

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder character. In other words, you can include an actual

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder dollar-sign character in a <em>Substitution</em> string by

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder using '<code>\$</code>'; this keeps mod_rewrite from trying

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder to treat it as a backreference.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</section>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder<section id="InternalBackRefs"><title>Regex Back-Reference Availability</title>

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder

d67a33b40578beef2e255a274f89bb9c34aaf056Christian Maeder <p>One important thing here has to be remembered: Whenever you

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder use parentheses in <em>Pattern</em> or in one of the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <em>CondPattern</em>, back-references are internally created

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder which can be used with the strings <code>$N</code> and

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <code>%N</code> (see below). These are available for creating

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder the strings <em>Substitution</em> and <em>TestString</em>.

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder Figure 2 shows to which locations the back-references are

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder transfered for expansion.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<p class="figure">

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <img src="/images/mod_rewrite_fig2.gif" width="381"

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder height="179" alt="[Needs graphics capability to display]" /><br />

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <dfn>Figure 2:</dfn> The back-reference flow through a rule.

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>We know this was a crash course on mod_rewrite's internal

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder processing. But you will benefit from this knowledge when

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder reading the following documentation of the available

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder directives.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</section>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</section>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<section id="EnvVar"><title>Environment Variables</title>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>This module keeps track of two additional (non-standard)

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder CGI/SSI environment variables named <code>SCRIPT_URL</code>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder and <code>SCRIPT_URI</code>. These contain the

1a6464613c59e35072b90ca296ae402cbe956144Christian Maeder <em>logical</em> Web-view to the current resource, while the

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder standard CGI/SSI variables <code>SCRIPT_NAME</code> and

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <code>SCRIPT_FILENAME</code> contain the <em>physical</em>

1a6464613c59e35072b90ca296ae402cbe956144Christian Maeder System-view. </p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder <p>Notice: These variables hold the URI/URL <em>as they were

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder initially requested</em>, <em>i.e.</em>, <em>before</em> any

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder rewriting. This is important because the rewriting process is

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder primarily used to rewrite logical URLs to physical

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder pathnames.</p>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder

1a6464613c59e35072b90ca296ae402cbe956144Christian Maeder<example><title>Example</title>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<pre>

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian MaederSCRIPT_NAME=/sw/lib/w3s/tree/global/u/rse/.www/index.html

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian MaederSCRIPT_FILENAME=/u/rse/.www/index.html

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian MaederSCRIPT_URL=/u/rse/

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian MaederSCRIPT_URI=http://en1.engelschall.com/u/rse/

5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder</pre>

</example>

</section>

<section id="Solutions"><title>Practical Solutions</title>

<p>We also have an <a href="/misc/rewriteguide.html">URL

Rewriting Guide</a> available, which provides a collection of

practical solutions for URL-based problems. There you can

find real-life rulesets and additional information about

mod_rewrite.</p>

</section>

<directivesynopsis>

<name>RewriteEngine</name>

<description>Enables or disables runtime rewriting engine</description>

<syntax>RewriteEngine on|off</syntax>

<default>RewriteEngine off</default>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context></contextlist>

<override>FileInfo</override>

<usage>

<p>The <directive>RewriteEngine</directive> directive enables or

disables the runtime rewriting engine. If it is set to

<code>off</code> this module does no runtime processing at

all. It does not even update the <code>SCRIPT_URx</code>

environment variables.</p>

<p>Use this directive to disable the module instead of

commenting out all the <directive

module="mod_rewrite">RewriteRule</directive> directives!</p>

<p>Note that, by default, rewrite configurations are not

inherited. This means that you need to have a

<code>RewriteEngine on</code> directive for each virtual host

in which you wish to use it.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>RewriteOptions</name>

<description>Sets some special options for the rewrite engine</description>

<syntax>RewriteOptions <var>Options</var></syntax>

<default>RewriteOptions MaxRedirects=10</default>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context></contextlist>

<override>FileInfo</override>

<compatibility><code>MaxRedirects</code> is available in Apache 2.0.45 and

later</compatibility>

<usage>

<p>The <directive>RewriteOptions</directive> directive sets some

special options for the current per-server or per-directory

configuration. The <em>Option</em> strings can be one of the

following:</p>

<dl>

<dt><code>inherit</code></dt>

<dd>This forces the current configuration to inherit the

configuration of the parent. In per-virtual-server context

this means that the maps, conditions and rules of the main

server are inherited. In per-directory context this means

that conditions and rules of the parent directory's

<code>.htaccess</code> configuration are inherited.</dd>

<dt><code>MaxRedirects=<var>number</var></code></dt>

<dd>In order to prevent endless loops of internal redirects

issued by per-directory <directive module="mod_rewrite"

>RewriteRule</directive>s, <module>mod_rewrite</module> aborts

the request after reaching a maximum number of such redirects and

responds with an 500 Internal Server Error. If you really need

more internal redirects than 10 per request, you may increase

the default to the desired value.</dd>

</dl>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>RewriteLog</name>

<description>Sets the name of the file used for logging rewrite engine

processing</description>

<syntax>RewriteLog <em>file-path</em></syntax>

<contextlist><context>server config</context><context>virtual host</context>

</contextlist>

<usage>

<p>The <directive>RewriteLog</directive> directive sets the name

of the file to which the server logs any rewriting actions it

performs. If the name does not begin with a slash

('<code>/</code>') then it is assumed to be relative to the

<em>Server Root</em>. The directive should occur only once per

server config.</p>

<note> To disable the logging of

rewriting actions it is not recommended to set

<em>Filename</em> to <code>/dev/null</code>, because

although the rewriting engine does not then output to a

logfile it still creates the logfile output internally.

<strong>This will slow down the server with no advantage

to the administrator!</strong> To disable logging either

remove or comment out the <directive>RewriteLog</directive>

directive or use <code>RewriteLogLevel 0</code>!

</note>

<note type="securitywarning"><title>Security</title>

See the <a href="/misc/security_tips.html">Apache Security Tips</a>

document for details on why your security could be compromised if the

directory where logfiles are stored is writable by anyone other than

the user that starts the server.

</note>

<example><title>Example</title>

RewriteLog "/usr/local/var/apache/logs/rewrite.log"

</example>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>RewriteLogLevel</name>

<description>Sets the verbosity of the log file used by the rewrite

engine</description>

<syntax>RewriteLogLevel <em>Level</em></syntax>

<default>RewriteLogLevel 0</default>

<contextlist><context>server config</context><context>virtual host</context>

</contextlist>

<usage>

<p>The <directive>RewriteLogLevel</directive> directive sets the

verbosity level of the rewriting logfile. The default level 0

means no logging, while 9 or more means that practically all

actions are logged.</p>

<p>To disable the logging of rewriting actions simply set

<em>Level</em> to 0. This disables all rewrite action

logs.</p>

<note> Using a high value for

<em>Level</em> will slow down your Apache server

dramatically! Use the rewriting logfile at a

<em>Level</em> greater than 2 only for debugging!

</note>

<example><title>Example</title>

RewriteLogLevel 3

</example>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>RewriteLock</name>

<description>Sets the name of the lock file used for <directive

module="mod_rewrite">RewriteMap</directive>

synchronization</description>

<syntax>RewriteLock <em>file-path</em></syntax>

<contextlist><context>server config</context></contextlist>

<usage>

<p>This directive sets the filename for a synchronization

lockfile which mod_rewrite needs to communicate with <directive

module="mod_rewrite">RewriteMap</directive>

<em>programs</em>. Set this lockfile to a local path (not on a

NFS-mounted device) when you want to use a rewriting

map-program. It is not required for other types of rewriting

maps.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>RewriteMap</name>

<description>Defines a mapping function for key-lookup</description>

<syntax>RewriteMap <em>MapName</em> <em>MapType</em>:<em>MapSource</em>

</syntax>

<contextlist><context>server config</context><context>virtual host</context>

</contextlist>

<compatibility>The choice of different dbm types is available in

Apache 2.0.41 and later</compatibility>

<usage>

<p>The <directive>RewriteMap</directive> directive defines a

<em>Rewriting Map</em> which can be used inside rule

substitution strings by the mapping-functions to

insert/substitute fields through a key lookup. The source of

this lookup can be of various types.</p>

<p>The <a id="mapfunc" name="mapfunc"><em>MapName</em></a> is

the name of the map and will be used to specify a

mapping-function for the substitution strings of a rewriting

rule via one of the following constructs:</p>

<p class="indent">

<strong><code>${</code> <em>MapName</em> <code>:</code>

<em>LookupKey</em> <code>}</code><br />

<code>${</code> <em>MapName</em> <code>:</code>

<em>LookupKey</em> <code>|</code> <em>DefaultValue</em>

<code>}</code></strong>

</p>

<p>When such a construct occurs the map <em>MapName</em> is

consulted and the key <em>LookupKey</em> is looked-up. If the

key is found, the map-function construct is substituted by

<em>SubstValue</em>. If the key is not found then it is

substituted by <em>DefaultValue</em> or by the empty string

if no <em>DefaultValue</em> was specified.</p>

<p>The following combinations for <em>MapType</em> and

<em>MapSource</em> can be used:</p>

<ul>

<li>

<strong>Standard Plain Text</strong><br />

MapType: <code>txt</code>, MapSource: Unix filesystem

path to valid regular file

<p>This is the standard rewriting map feature where the

<em>MapSource</em> is a plain ASCII file containing

either blank lines, comment lines (starting with a '#'

character) or pairs like the following - one per

line.</p>

<p class="indent">

<strong><em>MatchingKey</em>

<em>SubstValue</em></strong>

</p>

<example><title>Example</title>

<pre>

##

## map.txt -- rewriting map

##

Ralf.S.Engelschall rse # Bastard Operator From Hell

Mr.Joe.Average joe # Mr. Average

</pre>

</example>

<example>

RewriteMap real-to-user txt:/path/to/file/map.txt

</example>

</li>

<li>

<strong>Randomized Plain Text</strong><br />

MapType: <code>rnd</code>, MapSource: Unix filesystem

path to valid regular file

<p>This is identical to the Standard Plain Text variant

above but with a special post-processing feature: After

looking up a value it is parsed according to contained

``<code>|</code>'' characters which have the meaning of

``or''. In other words they indicate a set of

alternatives from which the actual returned value is

chosen randomly. Although this sounds crazy and useless,

it was actually designed for load balancing in a reverse

proxy situation where the looked up values are server

names. Example:</p>

<example>

<pre>

##

## map.txt -- rewriting map

##

static www1|www2|www3|www4

dynamic www5|www6

</pre>

</example>

<example>

RewriteMap servers rnd:/path/to/file/map.txt

</example>

</li>

<li>

<strong>Hash File</strong><br /> MapType:

<code>dbm[=<em>type</em>]</code>, MapSource: Unix filesystem

path to valid regular file

<p>Here the source is a binary format DBM file containing

the same contents as a <em>Plain Text</em> format file, but

in a special representation which is optimized for really

fast lookups. The <em>type</em> can be sdbm, gdbm, ndbm, or

db depending on <a href="/install.html#dbm">compile-time

settings</a>. If the <em>type</em> is omitted, the

compile-time default will be chosen. You can create such a

file with any DBM tool or with the following Perl

script. Be sure to adjust it to create the appropriate

type of DBM. The example creates an NDBM file.</p>

<example>

<pre>

#!/path/to/bin/perl

##

## txt2dbm -- convert txt map to dbm format

##

use NDBM_File;

use Fcntl;

($txtmap, $dbmmap) = @ARGV;

open(TXT, "&lt;$txtmap") or die "Couldn't open $txtmap!\n";

tie (%DB, 'NDBM_File', $dbmmap,O_RDWR|O_TRUNC|O_CREAT, 0644)

or die "Couldn't create $dbmmap!\n";

while (&lt;TXT&gt;) {

next if (/^\s*#/ or /^\s*$/);

$DB{$1} = $2 if (/^\s*(\S+)\s+(\S+)/);

}

untie %DB;

close(TXT);

</pre>

</example>

<example>

$ txt2dbm map.txt map.db

</example>

</li>

<li>

<strong>Internal Function</strong><br />

MapType: <code>int</code>, MapSource: Internal Apache

function

<p>Here the source is an internal Apache function.

Currently you cannot create your own, but the following

functions already exists:</p>

<ul>

<li><strong>toupper</strong>:<br />

Converts the looked up key to all upper case.</li>

<li><strong>tolower</strong>:<br />

Converts the looked up key to all lower case.</li>

<li><strong>escape</strong>:<br />

Translates special characters in the looked up key to

hex-encodings.</li>

<li><strong>unescape</strong>:<br />

Translates hex-encodings in the looked up key back to

special characters.</li>

</ul>

</li>

<li>

<strong>External Rewriting Program</strong><br />

MapType: <code>prg</code>, MapSource: Unix filesystem

path to valid regular file

<p>Here the source is a program, not a map file. To

create it you can use the language of your choice, but

the result has to be a executable (<em>i.e.</em>, either

object-code or a script with the magic cookie trick

'<code>#!/path/to/interpreter</code>' as the first

line).</p>

<p>This program is started once at startup of the Apache

servers and then communicates with the rewriting engine

over its <code>stdin</code> and <code>stdout</code>

file-handles. For each map-function lookup it will

receive the key to lookup as a newline-terminated string

on <code>stdin</code>. It then has to give back the

looked-up value as a newline-terminated string on

<code>stdout</code> or the four-character string

``<code>NULL</code>'' if it fails (<em>i.e.</em>, there

is no corresponding value for the given key). A trivial

program which will implement a 1:1 map (<em>i.e.</em>,

key == value) could be:</p>

<example>

<pre>

#!/usr/bin/perl

$| = 1;

while (&lt;STDIN&gt;) {

# ...put here any transformations or lookups...

print $_;

}

</pre>

</example>

<p>But be very careful:</p>

<ol>

<li>``<em>Keep it simple, stupid</em>'' (KISS), because

if this program hangs it will hang the Apache server

when the rule occurs.</li>

<li>Avoid one common mistake: never do buffered I/O on

<code>stdout</code>! This will cause a deadloop! Hence

the ``<code>$|=1</code>'' in the above example...</li>

<li>Use the <directive

module="mod_rewrite">RewriteLock</directive> directive to

define a lockfile mod_rewrite can use to synchronize the

communication to the program. By default no such

synchronization takes place.</li>

</ol>

</li>

</ul>

<p>The <directive>RewriteMap</directive> directive can occur more than

once. For each mapping-function use one

<directive>RewriteMap</directive> directive to declare its rewriting

mapfile. While you cannot <strong>declare</strong> a map in

per-directory context it is of course possible to

<strong>use</strong> this map in per-directory context. </p>

<note><title>Note</title> For plain text and DBM format files the

looked-up keys are cached in-core until the <code>mtime</code> of the

mapfile changes or the server does a restart. This way you can have

map-functions in rules which are used for <strong>every</strong>

request. This is no problem, because the external lookup only happens

once!

</note>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>RewriteBase</name>

<description>Sets the base URL for per-directory rewrites</description>

<syntax>RewriteBase <em>URL-path</em></syntax>

<default>See usage for information.</default>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>FileInfo</override>

<usage>

<p>The <directive>RewriteBase</directive> directive explicitly

sets the base URL for per-directory rewrites. As you will see

below, <directive module="mod_rewrite">RewriteRule</directive>

can be used in per-directory config files

(<code>.htaccess</code>). There it will act locally,

<em>i.e.</em>, the local directory prefix is stripped at this

stage of processing and your rewriting rules act only on the

remainder. At the end it is automatically added back to the

path. The default setting is; <directive>RewriteBase</directive> <em>physical-directory-path</em></p>

<p>When a substitution occurs for a new URL, this module has

to re-inject the URL into the server processing. To be able

to do this it needs to know what the corresponding URL-prefix

or URL-base is. By default this prefix is the corresponding

filepath itself. <strong>But at most websites URLs are NOT

directly related to physical filename paths, so this

assumption will usually be wrong!</strong> There you have to

use the <code>RewriteBase</code> directive to specify the

correct URL-prefix.</p>

<note> If your webserver's URLs are <strong>not</strong> directly

related to physical file paths, you have to use

<directive>RewriteBase</directive> in every <code>.htaccess</code>

files where you want to use <directive

module="mod_rewrite">RewriteRule</directive> directives.

</note>

<p> For example, assume the following per-directory config file:</p>

<example>

<pre>

#

# /abc/def/.htaccess -- per-dir config file for directory /abc/def

# Remember: /abc/def is the physical path of /xyz, <em>i.e.</em>, the server

# has a 'Alias /xyz /abc/def' directive <em>e.g.</em>

#

RewriteEngine On

# let the server know that we were reached via /xyz and not

# via the physical path prefix /abc/def

RewriteBase /xyz

# now the rewriting rules

RewriteRule ^oldstuff\.html$ newstuff.html

</pre>

</example>

<p>In the above example, a request to

<code>/xyz/oldstuff.html</code> gets correctly rewritten to

the physical file <code>/abc/def/newstuff.html</code>.</p>

<note><title>For Apache Hackers</title>

<p>The following list gives detailed information about

the internal processing steps:</p>

<pre>

Request:

/xyz/oldstuff.html

Internal Processing:

/xyz/oldstuff.html -&gt; /abc/def/oldstuff.html (per-server Alias)

/abc/def/oldstuff.html -&gt; /abc/def/newstuff.html (per-dir RewriteRule)

/abc/def/newstuff.html -&gt; /xyz/newstuff.html (per-dir RewriteBase)

/xyz/newstuff.html -&gt; /abc/def/newstuff.html (per-server Alias)

Result:

/abc/def/newstuff.html

</pre>

<p>This seems very complicated but is

the correct Apache internal processing, because the

per-directory rewriting comes too late in the

process. So, when it occurs the (rewritten) request

has to be re-injected into the Apache kernel! BUT:

While this seems like a serious overhead, it really

isn't, because this re-injection happens fully

internally to the Apache server and the same

procedure is used by many other operations inside

Apache. So, you can be sure the design and

implementation is correct.</p>

</note>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>RewriteCond</name>

<description>Defines a condition under which rewriting will take place

</description>

<syntax> RewriteCond

<em>TestString</em> <em>CondPattern</em></syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context></contextlist>

<override>FileInfo</override>

<usage>

<p>The <directive>RewriteCond</directive> directive defines a

rule condition. Precede a <directive

module="mod_rewrite">RewriteRule</directive> directive with one

or more <directive>RewriteCond</directive> directives. The following

rewriting rule is only used if its pattern matches the current

state of the URI <strong>and</strong> if these additional

conditions apply too.</p>

<p><em>TestString</em> is a string which can contains the

following expanded constructs in addition to plain text:</p>

<ul>

<li>

<strong>RewriteRule backreferences</strong>: These are

backreferences of the form

<p class="indent">

<strong><code>$N</code></strong>

</p>

(0 &lt;= N &lt;= 9) which provide access to the grouped

parts (parenthesis!) of the pattern from the

corresponding <code>RewriteRule</code> directive (the one

following the current bunch of <code>RewriteCond</code>

directives).

</li>

<li>

<strong>RewriteCond backreferences</strong>: These are

backreferences of the form

<p class="indent">

<strong><code>%N</code></strong>

</p>

(1 &lt;= N &lt;= 9) which provide access to the grouped

parts (parentheses!) of the pattern from the last matched

<code>RewriteCond</code> directive in the current bunch

of conditions.

</li>

<li>

<strong>RewriteMap expansions</strong>: These are

expansions of the form

<p class="indent">

<strong><code>${mapname:key|default}</code></strong>

</p>

See <a href="#mapfunc">the documentation for

RewriteMap</a> for more details.

</li>

<li>

<strong>Server-Variables</strong>: These are variables of

the form

<p class="indent">

<strong><code>%{</code> <em>NAME_OF_VARIABLE</em>

<code>}</code></strong>

</p>

where <em>NAME_OF_VARIABLE</em> can be a string taken

from the following list:

<table>

<tr>

<th>HTTP headers:</th> <th>connection &amp; request:</th> <th></th>

</tr>

<tr>

<td>

HTTP_USER_AGENT<br />

HTTP_REFERER<br />

HTTP_COOKIE<br />

HTTP_FORWARDED<br />

HTTP_HOST<br />

HTTP_PROXY_CONNECTION<br />

HTTP_ACCEPT<br />

</td>

<td>

REMOTE_ADDR<br />

REMOTE_HOST<br />

REMOTE_PORT<br />

REMOTE_USER<br />

REMOTE_IDENT<br />

REQUEST_METHOD<br />

SCRIPT_FILENAME<br />

PATH_INFO<br />

QUERY_STRING<br />

AUTH_TYPE<br />

</td>

<td></td>

</tr>

<tr>

<th>server internals:</th> <th>system stuff:</th> <th>specials:</th>

</tr>

<tr>

<td>

DOCUMENT_ROOT<br />

SERVER_ADMIN<br />

SERVER_NAME<br />

SERVER_ADDR<br />

SERVER_PORT<br />

SERVER_PROTOCOL<br />

SERVER_SOFTWARE<br />

</td>

<td>

TIME_YEAR<br />

TIME_MON<br />

TIME_DAY<br />

TIME_HOUR<br />

TIME_MIN<br />

TIME_SEC<br />

TIME_WDAY<br />

TIME<br />

</td>

<td>

API_VERSION<br />

THE_REQUEST<br />

REQUEST_URI<br />

REQUEST_FILENAME<br />

IS_SUBREQ<br />

</td>

</tr>

</table>

<note>

<p>These variables all

correspond to the similarly named HTTP

MIME-headers, C variables of the Apache server or

<code>struct tm</code> fields of the Unix system.

Most are documented elsewhere in the Manual or in

the CGI specification. Those that are special to

mod_rewrite include:</p>

<dl>

<dt><code>IS_SUBREQ</code></dt>

<dd>Will contain the text "true" if the request

currently being processed is a sub-request,

"false" otherwise. Sub-requests may be generated

by modules that need to resolve additional files

or URIs in order to complete their tasks.</dd>

<dt><code>API_VERSION</code></dt>

<dd>This is the version of the Apache module API

(the internal interface between server and

module) in the current httpd build, as defined in

include/ap_mmn.h. The module API version

corresponds to the version of Apache in use (in

the release version of Apache 1.3.14, for

instance, it is 19990320:10), but is mainly of

interest to module authors.</dd>

<dt><code>THE_REQUEST</code></dt>

<dd>The full HTTP request line sent by the

browser to the server (e.g., "<code>GET

/index.html HTTP/1.1</code>"). This does not

include any additional headers sent by the

browser.</dd>

<dt><code>REQUEST_URI</code></dt>

<dd>The resource requested in the HTTP request

line. (In the example above, this would be

"/index.html".)</dd>

<dt><code>REQUEST_FILENAME</code></dt>

<dd>The full local filesystem path to the file or

script matching the request.</dd>

</dl>

</note>

</li>

</ul>

<p>Special Notes:</p>

<ol>

<li>The variables SCRIPT_FILENAME and REQUEST_FILENAME

contain the same value, <em>i.e.</em>, the value of the

<code>filename</code> field of the internal

<code>request_rec</code> structure of the Apache server.

The first name is just the commonly known CGI variable name

while the second is the consistent counterpart to

REQUEST_URI (which contains the value of the

<code>uri</code> field of <code>request_rec</code>).</li>

<li>There is the special format:

<code>%{ENV:variable}</code> where <em>variable</em> can be

any environment variable. This is looked-up via internal

Apache structures and (if not found there) via

<code>getenv()</code> from the Apache server process.</li>

<li>There is the special format:

<code>%{HTTP:header}</code> where <em>header</em> can be

any HTTP MIME-header name. This is looked-up from the HTTP

request. Example: <code>%{HTTP:Proxy-Connection}</code> is

the value of the HTTP header

``<code>Proxy-Connection:</code>''.</li>

<li>There is the special format

<code>%{LA-U:variable}</code> for look-aheads which perform

an internal (URL-based) sub-request to determine the final

value of <em>variable</em>. Use this when you want to use a

variable for rewriting which is actually set later in an

API phase and thus is not available at the current stage.

For instance when you want to rewrite according to the

<code>REMOTE_USER</code> variable from within the

per-server context (<code>httpd.conf</code> file) you have

to use <code>%{LA-U:REMOTE_USER}</code> because this

variable is set by the authorization phases which come

<em>after</em> the URL translation phase where mod_rewrite

operates. On the other hand, because mod_rewrite implements

its per-directory context (<code>.htaccess</code> file) via

the Fixup phase of the API and because the authorization

phases come <em>before</em> this phase, you just can use

<code>%{REMOTE_USER}</code> there.</li>

<li>There is the special format:

<code>%{LA-F:variable}</code> which performs an internal

(filename-based) sub-request to determine the final value

of <em>variable</em>. Most of the time this is the same as

LA-U above.</li>

</ol>

<p><em>CondPattern</em> is the condition pattern,

<em>i.e.</em>, a regular expression which is applied to the

current instance of the <em>TestString</em>, <em>i.e.</em>,

<em>TestString</em> is evaluated and then matched against

<em>CondPattern</em>.</p>

<p><strong>Remember:</strong> <em>CondPattern</em> is a

<em>perl compatible regular expression</em> with some

additions:</p>

<ol>

<li>You can prefix the pattern string with a

'<code>!</code>' character (exclamation mark) to specify a

<strong>non</strong>-matching pattern.</li>

<li>

There are some special variants of <em>CondPatterns</em>.

Instead of real regular expression strings you can also

use one of the following:

<ul>

<li>'<strong>&lt;CondPattern</strong>' (is lexically

lower)<br />

Treats the <em>CondPattern</em> as a plain string and

compares it lexically to <em>TestString</em>. True if

<em>TestString</em> is lexically lower than

<em>CondPattern</em>.</li>

<li>'<strong>&gt;CondPattern</strong>' (is lexically

greater)<br />

Treats the <em>CondPattern</em> as a plain string and

compares it lexically to <em>TestString</em>. True if

<em>TestString</em> is lexically greater than

<em>CondPattern</em>.</li>

<li>'<strong>=CondPattern</strong>' (is lexically

equal)<br />

Treats the <em>CondPattern</em> as a plain string and

compares it lexically to <em>TestString</em>. True if

<em>TestString</em> is lexically equal to

<em>CondPattern</em>, i.e the two strings are exactly

equal (character by character). If <em>CondPattern</em>

is just <code>""</code> (two quotation marks) this

compares <em>TestString</em> to the empty string.</li>

<li>'<strong>-d</strong>' (is

<strong>d</strong>irectory)<br />

Treats the <em>TestString</em> as a pathname and tests

if it exists and is a directory.</li>

<li>'<strong>-f</strong>' (is regular

<strong>f</strong>ile)<br />

Treats the <em>TestString</em> as a pathname and tests

if it exists and is a regular file.</li>

<li>'<strong>-s</strong>' (is regular file with

<strong>s</strong>ize)<br />

Treats the <em>TestString</em> as a pathname and tests

if it exists and is a regular file with size greater

than zero.</li>

<li>'<strong>-l</strong>' (is symbolic

<strong>l</strong>ink)<br />

Treats the <em>TestString</em> as a pathname and tests

if it exists and is a symbolic link.</li>

<li>'<strong>-x</strong>' (has e<strong>x</strong>ecutable

permissions)<br />

Treats the <em>TestString</em> as a pathname and tests

if it exists and has execution permissions. These permissions

are determined depending on the underlying OS.</li>

<li>'<strong>-F</strong>' (is existing file via

subrequest)<br />

Checks if <em>TestString</em> is a valid file and

accessible via all the server's currently-configured

access controls for that path. This uses an internal

subrequest to determine the check, so use it with care

because it decreases your servers performance!</li>

<li>'<strong>-U</strong>' (is existing URL via

subrequest)<br />

Checks if <em>TestString</em> is a valid URL and

accessible via all the server's currently-configured

access controls for that path. This uses an internal

subrequest to determine the check, so use it with care

because it decreases your server's performance!</li>

</ul>

<note><title>Notice</title>

All of these tests can

also be prefixed by an exclamation mark ('!') to

negate their meaning.

</note>

</li>

</ol>

<p>Additionally you can set special flags for

<em>CondPattern</em> by appending</p>

<p class="indent">

<strong><code>[</code><em>flags</em><code>]</code></strong>

</p>

<p>as the third argument to the <code>RewriteCond</code>

directive. <em>Flags</em> is a comma-separated list of the

following flags:</p>

<ul>

<li>'<strong><code>nocase|NC</code></strong>'

(<strong>n</strong>o <strong>c</strong>ase)<br />

This makes the test case-insensitive, <em>i.e.</em>, there

is no difference between 'A-Z' and 'a-z' both in the

expanded <em>TestString</em> and the <em>CondPattern</em>.

This flag is effective only for comparisons between

<em>TestString</em> and <em>CondPattern</em>. It has no

effect on filesystem and subrequest checks.</li>

<li>

'<strong><code>ornext|OR</code></strong>'

(<strong>or</strong> next condition)<br />

Use this to combine rule conditions with a local OR

instead of the implicit AND. Typical example:

<example>

<pre>

RewriteCond %{REMOTE_HOST} ^host1.* [OR]

RewriteCond %{REMOTE_HOST} ^host2.* [OR]

RewriteCond %{REMOTE_HOST} ^host3.*

RewriteRule ...some special stuff for any of these hosts...

</pre>

</example>

Without this flag you would have to write the cond/rule

three times.

</li>

</ul>

<p><strong>Example:</strong></p>

<p>To rewrite the Homepage of a site according to the

``<code>User-Agent:</code>'' header of the request, you can

use the following: </p>

<example>

<pre>

RewriteCond %{HTTP_USER_AGENT} ^Mozilla.*

RewriteRule ^/$ /homepage.max.html [L]

RewriteCond %{HTTP_USER_AGENT} ^Lynx.*

RewriteRule ^/$ /homepage.min.html [L]

RewriteRule ^/$ /homepage.std.html [L]

</pre>

</example>

<p>Interpretation: If you use Netscape Navigator as your

browser (which identifies itself as 'Mozilla'), then you

get the max homepage, which includes Frames, <em>etc.</em>

If you use the Lynx browser (which is Terminal-based), then

you get the min homepage, which contains no images, no

tables, <em>etc.</em> If you use any other browser you get

the standard homepage.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>RewriteRule</name>

<description>Defines rules for the rewriting engine</description>

<syntax>RewriteRule

<em>Pattern</em> <em>Substitution</em></syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context></contextlist>

<override>FileInfo</override>

<compatibility>The cookie-flag is available in Apache 2.0.40 and later.</compatibility>

<usage>

<p>The <directive>RewriteRule</directive> directive is the real

rewriting workhorse. The directive can occur more than once.

Each directive then defines one single rewriting rule. The

<strong>definition order</strong> of these rules is

<strong>important</strong>, because this order is used when

applying the rules at run-time.</p>

<p><a id="patterns" name="patterns"><em>Pattern</em></a> is

a perl compatible <a id="regexp" name="regexp">regular

expression</a> which gets applied to the current URL. Here

``current'' means the value of the URL when this rule gets

applied. This may not be the originally requested URL,

because any number of rules may already have matched and made

alterations to it.</p>

<p>Some hints about the syntax of regular expressions:</p>

<note><pre>

<strong>Text:</strong>

<strong><code>.</code></strong> Any single character

<strong><code>[</code></strong>chars<strong><code>]</code></strong> Character class: One of chars

<strong><code>[^</code></strong>chars<strong><code>]</code></strong> Character class: None of chars

text1<strong><code>|</code></strong>text2 Alternative: text1 or text2

<strong>Quantifiers:</strong>

<strong><code>?</code></strong> 0 or 1 of the preceding text

<strong><code>*</code></strong> 0 or N of the preceding text (N &gt; 0)

<strong><code>+</code></strong> 1 or N of the preceding text (N &gt; 1)

<strong>Grouping:</strong>

<strong><code>(</code></strong>text<strong><code>)</code></strong> Grouping of text

(either to set the borders of an alternative or

for making backreferences where the <strong>N</strong>th group can

be used on the RHS of a RewriteRule with <code>$</code><strong>N</strong>)

<strong>Anchors:</strong>

<strong><code>^</code></strong> Start of line anchor

<strong><code>$</code></strong> End of line anchor

<strong>Escaping:</strong>

<strong><code>\</code></strong>char escape that particular char

(for instance to specify the chars "<code>.[]()</code>" <em>etc.</em>)

</pre></note>

<p>For more information about regular expressions have a look at the

perl regular expression manpage ("<a

href="http://www.perldoc.com/perl5.6.1/pod/perlre.html">perldoc

perlre</a>"). If you are interested in more detailed

information about regular expressions and their variants

(POSIX regex <em>etc.</em>) have a look at the

following dedicated book on this topic:</p>

<p class="indent">

<em>Mastering Regular Expressions</em><br />

Jeffrey E.F. Friedl<br />

Nutshell Handbook Series<br />

O'Reilly &amp; Associates, Inc. 1997<br />

ISBN 1-56592-257-3<br />

</p>

<p>Additionally in mod_rewrite the NOT character

('<code>!</code>') is a possible pattern prefix. This gives

you the ability to negate a pattern; to say, for instance:

``<em>if the current URL does <strong>NOT</strong> match this

pattern</em>''. This can be used for exceptional cases, where

it is easier to match the negative pattern, or as a last

default rule.</p>

<note><title>Notice</title>

When using the NOT character

to negate a pattern you cannot have grouped wildcard

parts in the pattern. This is impossible because when the

pattern does NOT match, there are no contents for the

groups. In consequence, if negated patterns are used, you

cannot use <code>$N</code> in the substitution

string!

</note>

<p><a id="rhs" name="rhs"><em>Substitution</em></a> of a

rewriting rule is the string which is substituted for (or

replaces) the original URL for which <em>Pattern</em>

matched. Beside plain text you can use</p>

<ol>

<li>back-references <code>$N</code> to the RewriteRule

pattern</li>

<li>back-references <code>%N</code> to the last matched

RewriteCond pattern</li>

<li>server-variables as in rule condition test-strings

(<code>%{VARNAME}</code>)</li>

<li><a href="#mapfunc">mapping-function</a> calls

(<code>${mapname:key|default}</code>)</li>

</ol>

<p>Back-references are <code>$</code><strong>N</strong>

(<strong>N</strong>=0..9) identifiers which will be replaced

by the contents of the <strong>N</strong>th group of the

matched <em>Pattern</em>. The server-variables are the same

as for the <em>TestString</em> of a <code>RewriteCond</code>

directive. The mapping-functions come from the

<code>RewriteMap</code> directive and are explained there.

These three types of variables are expanded in the order of

the above list. </p>

<p>As already mentioned above, all the rewriting rules are

applied to the <em>Substitution</em> (in the order of

definition in the config file). The URL is <strong>completely

replaced</strong> by the <em>Substitution</em> and the

rewriting process goes on until there are no more rules

unless explicitly terminated by a

<code><strong>L</strong></code> flag - see below.</p>

<p>There is a special substitution string named

'<code>-</code>' which means: <strong>NO

substitution</strong>! Sounds silly? No, it is useful to

provide rewriting rules which <strong>only</strong> match

some URLs but do no substitution, <em>e.g.</em>, in

conjunction with the <strong>C</strong> (chain) flag to be

able to have more than one pattern to be applied before a

substitution occurs.</p>

<p>One more note: You can even create URLs in the

substitution string containing a query string part. Just use

a question mark inside the substitution string to indicate

that the following stuff should be re-injected into the

QUERY_STRING. When you want to erase an existing query

string, end the substitution string with just the question

mark.</p>

<note><title>Note</title>

There is a special feature:

When you prefix a substitution field with

<code>http://</code><em>thishost</em>[<em>:thisport</em>]

then <strong>mod_rewrite</strong> automatically strips it

out. This auto-reduction on implicit external redirect

URLs is a useful and important feature when used in

combination with a mapping-function which generates the

hostname part. Have a look at the first example in the

example section below to understand this.

</note>

<note><title>Remember</title>

An unconditional external

redirect to your own server will not work with the prefix

<code>http://thishost</code> because of this feature. To

achieve such a self-redirect, you have to use the

<strong>R</strong>-flag (see below).

</note>

<p>Additionally you can set special flags for

<em>Substitution</em> by appending</p>

<p class="indent">

<strong><code>[</code><em>flags</em><code>]</code></strong>

</p>

<p>

as the third argument to the <code>RewriteRule</code>

directive. <em>Flags</em> is a comma-separated list of the

following flags: </p>

<ul>

<li>

'<strong><code>redirect|R</code>

[=<em>code</em>]</strong>' (force <a id="redirect"

name="redirect"><strong>r</strong>edirect</a>)<br />

Prefix <em>Substitution</em> with

<code>http://thishost[:thisport]/</code> (which makes the

new URL a URI) to force a external redirection. If no

<em>code</em> is given a HTTP response of 302 (MOVED

TEMPORARILY) is used. If you want to use other response

codes in the range 300-400 just specify them as a number

or use one of the following symbolic names:

<code>temp</code> (default), <code>permanent</code>,

<code>seeother</code>. Use it for rules which should

canonicalize the URL and give it back to the client,

<em>e.g.</em>, translate ``<code>/~</code>'' into

``<code>/u/</code>'' or always append a slash to

<code>/u/</code><em>user</em>, etc.<br />

<p><strong>Note:</strong> When you use this flag, make

sure that the substitution field is a valid URL! If not,

you are redirecting to an invalid location! And remember

that this flag itself only prefixes the URL with

<code>http://thishost[:thisport]/</code>, rewriting

continues. Usually you also want to stop and do the

redirection immediately. To stop the rewriting you also

have to provide the 'L' flag.</p>

</li>

<li>'<strong><code>forbidden|F</code></strong>' (force URL

to be <strong>f</strong>orbidden)<br />

This forces the current URL to be forbidden,

<em>i.e.</em>, it immediately sends back a HTTP response of

403 (FORBIDDEN). Use this flag in conjunction with

appropriate RewriteConds to conditionally block some

URLs.</li>

<li>'<strong><code>gone|G</code></strong>' (force URL to be

<strong>g</strong>one)<br />

This forces the current URL to be gone, <em>i.e.</em>, it

immediately sends back a HTTP response of 410 (GONE). Use

this flag to mark pages which no longer exist as gone.</li>

<li>

'<strong><code>proxy|P</code></strong>' (force

<strong>p</strong>roxy)<br />

This flag forces the substitution part to be internally

forced as a proxy request and immediately (<em>i.e.</em>,

rewriting rule processing stops here) put through the <a

href="mod_proxy.html">proxy module</a>. You have to make

sure that the substitution string is a valid URI

(<em>e.g.</em>, typically starting with

<code>http://</code><em>hostname</em>) which can be

handled by the Apache proxy module. If not you get an

error from the proxy module. Use this flag to achieve a

more powerful implementation of the <a

href="mod_proxy.html#proxypass">ProxyPass</a> directive,

to map some remote stuff into the namespace of the local

server.

<p>Notice: To use this functionality make sure you have

the proxy module compiled into your Apache server

program. If you don't know please check whether

<code>mod_proxy.c</code> is part of the ``<code>httpd

-l</code>'' output. If yes, this functionality is

available to mod_rewrite. If not, then you first have to

rebuild the ``<code>httpd</code>'' program with mod_proxy

enabled.</p>

</li>

<li>'<strong><code>last|L</code></strong>'

(<strong>l</strong>ast rule)<br />

Stop the rewriting process here and don't apply any more

rewriting rules. This corresponds to the Perl

<code>last</code> command or the <code>break</code> command

from the C language. Use this flag to prevent the currently

rewritten URL from being rewritten further by following

rules. For example, use it to rewrite the root-path URL

('<code>/</code>') to a real one, <em>e.g.</em>,

'<code>/e/www/</code>'.</li>

<li>'<strong><code>next|N</code></strong>'

(<strong>n</strong>ext round)<br />

Re-run the rewriting process (starting again with the

first rewriting rule). Here the URL to match is again not

the original URL but the URL from the last rewriting rule.

This corresponds to the Perl <code>next</code> command or

the <code>continue</code> command from the C language. Use

this flag to restart the rewriting process, <em>i.e.</em>,

to immediately go to the top of the loop.<br />

<strong>But be careful not to create an infinite

loop!</strong></li>

<li>'<strong><code>chain|C</code></strong>'

(<strong>c</strong>hained with next rule)<br />

This flag chains the current rule with the next rule

(which itself can be chained with the following rule,

<em>etc.</em>). This has the following effect: if a rule

matches, then processing continues as usual, <em>i.e.</em>,

the flag has no effect. If the rule does

<strong>not</strong> match, then all following chained

rules are skipped. For instance, use it to remove the

``<code>.www</code>'' part inside a per-directory rule set

when you let an external redirect happen (where the

``<code>.www</code>'' part should not to occur!).</li>