Difference between revisions of "Apache httpd/mod rewrite"

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
Jump to navigation Jump to search
(Created page with "==Syntax== The [http://httpd.apache.org/docs/2.4/mod/mod_rewrite.html Apache manual] says: * '''RewriteRule''' {{arg|Pattern}} {{arg|Substitution}} [{{arg|flags}}] * '''Rewri...")
 
(→‎RewriteRule: more complete example set)
Line 20: Line 20:
 
** '''filesystem-path''' (only in VirtualHost)
 
** '''filesystem-path''' (only in VirtualHost)
  
Official example:
+
===examples===
* RewriteRule ^(.+) /other/archive/$1 [R]
+
(also from the Apache manual)
 +
 
 +
The following apply inside the per-directory configuration* for <code>/somepath</code> for request <code>GET /somepath/localpath/pathinfo</code>
 +
: (*<code>/physical/path/to/somepath/.htaccess</code>, with <code>RewriteBase "/somepath"</code>)
 +
 
 +
<table class="listing"><tr class="header">
 +
<th>Given Rule</th>
 +
<th>Resulting Substitution</th>
 +
</tr>
 +
<tr>
 +
<td>^localpath(.*) otherpath$1</td>
 +
<td>/somepath/otherpath/pathinfo</td>
 +
</tr>
 +
<tr class="odd">
 +
<td>^localpath(.*) otherpath$1  [R]</td>
 +
<td>http://thishost/somepath/otherpath/pathinfo via external
 +
redirection</td>
 +
</tr>
 +
<tr>
 +
<td>^localpath(.*) otherpath$1  [P]</td>
 +
<td>doesn't make sense, not supported</td>
 +
</tr>
 +
<tr class="odd">
 +
<td>^localpath(.*) /otherpath$1</td>
 +
<td>/otherpath/pathinfo</td>
 +
</tr>
 +
<tr>
 +
<td>^localpath(.*) /otherpath$1 [R]</td>
 +
<td>http://thishost/otherpath/pathinfo via external redirection</td>
 +
</tr>
 +
<tr class="odd">
 +
<td>^localpath(.*) /otherpath$1 [P]</td>
 +
<td>doesn't make sense, not supported</td>
 +
</tr>
 +
<tr>
 +
<td>^localpath(.*) http://thishost/otherpath$1</td>
 +
<td>/otherpath/pathinfo</td>
 +
</tr>
 +
<tr class="odd">
 +
<td>^localpath(.*) http://thishost/otherpath$1 [R]</td>
 +
<td>http://thishost/otherpath/pathinfo via external redirection</td>
 +
</tr>
 +
<tr>
 +
<td>^localpath(.*) http://thishost/otherpath$1 [P]</td>
 +
<td>doesn't make sense, not supported</td>
 +
</tr>
 +
<tr class="odd">
 +
<td>^localpath(.*) http://otherhost/otherpath$1</td>
 +
<td>http://otherhost/otherpath/pathinfo via external redirection</td>
 +
</tr>
 +
<tr>
 +
<td>^localpath(.*) http://otherhost/otherpath$1 [R]</td>
 +
<td>http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant)</td>
 +
</tr>
 +
<tr class="odd">
 +
<td>^localpath(.*) http://otherhost/otherpath$1 [P]</td>
 +
<td>http://otherhost/otherpath/pathinfo via internal proxy</td>
 +
</tr>
 +
</table>

Revision as of 10:47, 3 March 2017

Syntax

The Apache manual says:

  • RewriteRule <Pattern> <Substitution> [<flags>]
  • RewriteCond <TestString> <CondPattern> [<flags>]
  • RewriteBase <URL-path>

I think I still don't really understand RewriteBase. Apparently it does need to refer to a path that actually exists, rather than a mapped path. If the path doesn't exist, Apache will log a "core:alert" error saying "RewriteBase: argument is not a valid URL".

RewriteRule

Arguments:

  • Pattern is a perl compatible regular expression, matched against:
    • if VirtualHost context: the part of the URL after the hostname and port, and before the query string (e.g. "/app1/index.html").
    • if per-directory context (Directory and .htaccess): the partial path to the Directory or .htaccess file
      • e.g. a request of "/app1/index.html" may result in comparison against "app1/index.html" or "index.html" depending on where the RewriteRule is defined.
      • The directory path where the rule is defined is stripped from the currently mapped filesystem path before comparison (up to and including a trailing slash). The net result of this per-directory prefix stripping is that rules in this context only match against the portion of the currently mapped filesystem path "below" where the rule is defined.
  • Substitution may be:
    • URL-path: A DocumentRoot-relative path to the intended target
    • Absolute-URL: if the hostname matches the current host, the scheme and hostname are stripped out and the resulting path is treated as a URL-path. Otherwise, an external redirect is performed.
    • filesystem-path (only in VirtualHost)

examples

(also from the Apache manual)

The following apply inside the per-directory configuration* for /somepath for request GET /somepath/localpath/pathinfo

(*/physical/path/to/somepath/.htaccess, with RewriteBase "/somepath")
Given Rule Resulting Substitution
^localpath(.*) otherpath$1 /somepath/otherpath/pathinfo
^localpath(.*) otherpath$1 [R] http://thishost/somepath/otherpath/pathinfo via external redirection
^localpath(.*) otherpath$1 [P] doesn't make sense, not supported
^localpath(.*) /otherpath$1 /otherpath/pathinfo
^localpath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo via external redirection
^localpath(.*) /otherpath$1 [P] doesn't make sense, not supported
^localpath(.*) http://thishost/otherpath$1 /otherpath/pathinfo
^localpath(.*) http://thishost/otherpath$1 [R] http://thishost/otherpath/pathinfo via external redirection
^localpath(.*) http://thishost/otherpath$1 [P] doesn't make sense, not supported
^localpath(.*) http://otherhost/otherpath$1 http://otherhost/otherpath/pathinfo via external redirection
^localpath(.*) http://otherhost/otherpath$1 [R] http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant)
^localpath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo via internal proxy