granicus.if.org Git - apache/blob - docs/manual/rewrite/flags.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>RewriteRule Flags - Apache HTTP Server Version 2.5</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body id="manual-page"><div id="page-header">
  17 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  18 <p class="apache">Apache HTTP Server Version 2.5</p>
  19 <img alt="" src="../images/feather.gif" /></div>
  20 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  21 <div id="path">
  22 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Rewrite</a></div><div id="page-content"><div id="preamble"><h1>RewriteRule Flags</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/rewrite/flags.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../fr/rewrite/flags.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  26 </div>
  27
  28 <p>This document discusses the flags which are available to the
  29 <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive,
  30 providing detailed explanations and examples.</p>
  31 </div>
  32 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#introduction">Introduction</a></li>
  33 <li><img alt="" src="../images/down.gif" /> <a href="#flag_b">B (escape backreferences)</a></li>
  34 <li><img alt="" src="../images/down.gif" /> <a href="#flag_bnp">BNP|backrefnoplus (don't escape space to +)</a></li>
  35 <li><img alt="" src="../images/down.gif" /> <a href="#flag_c">C|chain</a></li>
  36 <li><img alt="" src="../images/down.gif" /> <a href="#flag_co">CO|cookie</a></li>
  37 <li><img alt="" src="../images/down.gif" /> <a href="#flag_dpi">DPI|discardpath</a></li>
  38 <li><img alt="" src="../images/down.gif" /> <a href="#flag_e">E|env</a></li>
  39 <li><img alt="" src="../images/down.gif" /> <a href="#flag_end">END</a></li>
  40 <li><img alt="" src="../images/down.gif" /> <a href="#flag_f">F|forbidden</a></li>
  41 <li><img alt="" src="../images/down.gif" /> <a href="#flag_g">G|gone</a></li>
  42 <li><img alt="" src="../images/down.gif" /> <a href="#flag_h">H|handler</a></li>
  43 <li><img alt="" src="../images/down.gif" /> <a href="#flag_l">L|last</a></li>
  44 <li><img alt="" src="../images/down.gif" /> <a href="#flag_n">N|next</a></li>
  45 <li><img alt="" src="../images/down.gif" /> <a href="#flag_nc">NC|nocase</a></li>
  46 <li><img alt="" src="../images/down.gif" /> <a href="#flag_ne">NE|noescape</a></li>
  47 <li><img alt="" src="../images/down.gif" /> <a href="#flag_ns">NS|nosubreq</a></li>
  48 <li><img alt="" src="../images/down.gif" /> <a href="#flag_p">P|proxy</a></li>
  49 <li><img alt="" src="../images/down.gif" /> <a href="#flag_pt">PT|passthrough</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#flag_qsa">QSA|qsappend</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#flag_qsd">QSD|qsdiscard</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#flag_r">R|redirect</a></li>
  53 <li><img alt="" src="../images/down.gif" /> <a href="#flag_s">S|skip</a></li>
  54 <li><img alt="" src="../images/down.gif" /> <a href="#flag_t">T|type</a></li>
  55 </ul><h3>See also</h3><ul class="seealso"><li><a href="../mod/mod_rewrite.html">Module documentation</a></li><li><a href="intro.html">mod_rewrite introduction</a></li><li><a href="remapping.html">Redirection and remapping</a></li><li><a href="access.html">Controlling access</a></li><li><a href="vhosts.html">Virtual hosts</a></li><li><a href="proxy.html">Proxying</a></li><li><a href="rewritemap.html">Using RewriteMap</a></li><li><a href="advanced.html">Advanced techniques</a></li><li><a href="avoid.html">When not to use mod_rewrite</a></li></ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  56 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  57 <div class="section">
  58 <h2><a name="introduction" id="introduction">Introduction</a></h2>
  59 <p>A <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> can have
  60 its behavior modified by one or more flags. Flags are included in
  61 square brackets at the end of the rule, and multiple flags are separated
  62 by commas.</p>
  63 <pre class="prettyprint lang-config">RewriteRule pattern target [Flag1,Flag2,Flag3]</pre>
  64
  65
  66 <p>Each flag (with a few exceptions) has a short form, such as
  67 <code>CO</code>, as well as a longer form, such as <code>cookie</code>.
  68 While it is most common to use
  69 the short form, it is recommended that you familiarize yourself with the
  70 long form, so that you remember what each flag is supposed to do.
  71 Some flags take one or more arguments. Flags are not case sensitive.</p>
  72
  73 <p>Flags that alter metadata associated with the request (T=, H=, E=)
  74 have no affect in per-directory and htaccess context, when a substitution
  75 (other than '-') is performed during the same round of rewrite processing.
  76 </p>
  77
  78 <p>Presented here are each of the available flags, along with an example
  79 of how you might use them.</p>
  80 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  81 <div class="section">
  82 <h2><a name="flag_b" id="flag_b">B (escape backreferences)</a></h2>
  83 <p>The [B] flag instructs <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to escape non-alphanumeric
  84 characters before applying the transformation.</p>
  85 <p>In 2.4.10 and later, you can limit the escaping to specific characters
  86 in backreferences by listing them: <code>[B=#?;]</code>. Note: The space
  87 character can be used in the list of characters to escape, but it cannot be
  88 the last character in the list.</p>
  89
  90 <p><code>mod_rewrite</code> has to unescape URLs before mapping them,
  91 so backreferences are unescaped at the time they are applied.
  92 Using the B flag, non-alphanumeric characters in backreferences
  93 will be escaped. For example, consider the rule:</p>
  94
  95 <pre class="prettyprint lang-config">RewriteRule ^search/(.*)$ /search.php?term=$1</pre>
  96
  97
  98 <p>Given a search term of 'x &amp; y/z', a browser will encode it as
  99 'x%20%26%20y%2Fz', making the request 'search/x%20%26%20y%2Fz'. Without the B
 100 flag, this rewrite rule will map to 'search.php?term=x &amp; y/z', which
 101 isn't a valid URL, and so would be encoded as
 102 <code>search.php?term=x%20&amp;y%2Fz=</code>, which is not what was intended.</p>
 103
 104 <p>With the B flag set on this same rule, the parameters are re-encoded
 105 before being passed on to the output URL, resulting in a correct mapping to
 106 <code>/search.php?term=x%20%26%20y%2Fz</code>.</p>
 107
 108 <p>Note that you may also need to set <code class="directive"><a href="../mod/core.html#allowencodedslashes">AllowEncodedSlashes</a></code> to <code>On</code> to get this
 109 particular example to work, as httpd does not allow encoded slashes in URLs, and
 110 returns a 404 if it sees one.</p>
 111
 112 <p>This escaping is particularly necessary in a proxy situation,
 113 when the backend may break if presented with an unescaped URL.</p>
 114
 115 <p>An alternative to this flag is using a <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> to capture against %{THE_REQUEST} which will capture
 116 strings in the encoded form.</p>
 117 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 118 <div class="section">
 119 <h2><a name="flag_bnp" id="flag_bnp">BNP|backrefnoplus (don't escape space to +)</a></h2>
 120 <p>The [BNP] flag instructs <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to escape the space character
 121 in a backreference to %20 rather than '+'. Useful when the backreference
 122 will be used in the path component rather than the query string.</p>
 123 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 124 <div class="section">
 125 <h2><a name="flag_c" id="flag_c">C|chain</a></h2>
 126 <p>The [C] or [chain] flag indicates that the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is chained to the next
 127 rule. That is, if the rule matches, then it is processed as usual and
 128 control moves on to the next rule. However, if it does not match, then
 129 the next rule, and any other rules that are chained together, are
 130 skipped.</p>
 131
 132 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 133 <div class="section">
 134 <h2><a name="flag_co" id="flag_co">CO|cookie</a></h2>
 135 <p>The [CO], or [cookie] flag, allows you to set a cookie when a
 136 particular <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code>
 137 matches. The argument consists of three required fields and four optional
 138 fields.</p>
 139
 140 <p>The full syntax for the flag, including all attributes, is as
 141 follows:</p>
 142
 143 <div class="example"><p><code>
 144 [CO=NAME:VALUE:DOMAIN:lifetime:path:secure:httponly]
 145 </code></p></div>
 146
 147 <p>You must declare a name, a value, and a domain for the cookie to be set.</p>
 148
 149 <dl>
 150 <dt>Domain</dt>
 151 <dd>The domain for which you want the cookie to be valid. This may be a
 152 hostname, such as <code>www.example.com</code>, or it may be a domain,
 153 such as <code>.example.com</code>. It must be at least two parts
 154 separated by a dot. That is, it may not be merely <code>.com</code> or
 155 <code>.net</code>. Cookies of that kind are forbidden by the cookie
 156 security model.</dd>
 157 </dl>
 158
 159 <p>You may optionally also set the following values:</p>
 160
 161 <dl>
 162 <dt>Lifetime</dt>
 163 <dd>The time for which the cookie will persist, in minutes.</dd>
 164 <dd>A value of 0 indicates that the cookie will persist only for the
 165 current browser session. This is the default value if none is
 166 specified.</dd>
 167
 168 <dt>Path</dt>
 169 <dd>The path, on the current website, for which the cookie is valid,
 170 such as <code>/customers/</code> or <code>/files/download/</code>.</dd>
 171 <dd>By default, this is set to <code>/</code> - that is, the entire
 172 website.</dd>
 173
 174 <dt>Secure</dt>
 175 <dd>If set to <code>secure</code>, <code>true</code>, or <code>1</code>,
 176 the cookie will only be permitted to be translated via secure (https)
 177 connections.</dd>
 178
 179 <dt>httponly</dt>
 180 <dd>If set to <code>HttpOnly</code>, <code>true</code>, or
 181 <code>1</code>, the cookie will have the <code>HttpOnly</code> flag set,
 182 which means that the cookie is inaccessible to JavaScript code on
 183 browsers that support this feature.</dd>
 184 </dl>
 185
 186 <p>Consider this example:</p>
 187
 188 <pre class="prettyprint lang-config">RewriteEngine On
 189 RewriteRule ^/index\.html - [CO=frontdoor:yes:.example.com:1440:/]</pre>
 190
 191
 192 <p>In the example give, the rule doesn't rewrite the request.
 193 The "-" rewrite target tells mod_rewrite to pass the request
 194 through unchanged. Instead, it sets a cookie
 195 called 'frontdoor' to a value of 'yes'. The cookie is valid for any host
 196 in the <code>.example.com</code> domain. It is set to expire in 1440
 197 minutes (24 hours) and is returned for all URIs.</p>
 198
 199 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 200 <div class="section">
 201 <h2><a name="flag_dpi" id="flag_dpi">DPI|discardpath</a></h2>
 202 <p>The DPI flag causes the PATH_INFO portion of the rewritten URI to be
 203 discarded.</p>
 204 <p>This flag is available in version 2.2.12 and later.</p>
 205 <p>In per-directory context, the URI each <code class="directive">RewriteRule</code>
 206 compares against is the concatenation of the current values of the URI
 207 and PATH_INFO.</p>
 208
 209 <p>The current URI can be the initial URI as requested by the client, the
 210 result of a previous round of mod_rewrite processing, or the result of
 211 a prior rule in the current round of mod_rewrite processing.</p>
 212
 213 <p>In contrast, the PATH_INFO that is appended to the URI before each
 214 rule reflects only the value of PATH_INFO before this round of
 215 mod_rewrite processing. As a consequence, if large portions
 216 of the URI are matched and copied into a substitution in multiple
 217 <code class="directive">RewriteRule</code> directives, without regard for
 218 which parts of the URI came from the current PATH_INFO, the final
 219 URI may have multiple copies of PATH_INFO appended to it.</p>
 220
 221 <p>Use this flag on any substitution where the PATH_INFO that resulted
 222 from the previous mapping of this request to the filesystem is not of
 223 interest.  This flag permanently forgets the PATH_INFO established
 224 before this round of mod_rewrite processing began. PATH_INFO will
 225 not be recalculated until the current round of mod_rewrite processing
 226 completes.  Subsequent rules during this round of processing will see
 227 only the direct result of substitutions, without any PATH_INFO
 228 appended.</p>
 229 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 230 <div class="section">
 231 <h2><a name="flag_e" id="flag_e">E|env</a></h2>
 232 <p>With the [E], or [env] flag, you can set the value of an environment
 233 variable. Note that some environment variables may be set after the rule
 234 is run, thus unsetting what you have set. See <a href="../env.html">the
 235 Environment Variables document</a> for more details on how Environment
 236 variables work.</p>
 237
 238 <p>The full syntax for this flag is:</p>
 239
 240 <div class="example"><p><code>
 241 [E=VAR:VAL]
 242 [E=!VAR]
 243 </code></p></div>
 244
 245 <p><code>VAL</code> may contain backreferences (<code>$N</code> or
 246 <code>%N</code>) which are expanded.</p>
 247
 248 <p>Using the short form</p>
 249
 250 <div class="example"><p><code>
 251 [E=VAR]
 252 </code></p></div>
 253
 254 <p>you can set the environment variable named <code>VAR</code> to an
 255 empty value.</p>
 256
 257 <p>The form</p>
 258
 259 <div class="example"><p><code>
 260 [E=!VAR]
 261 </code></p></div>
 262
 263 <p>allows to unset a previously set environment variable named
 264 <code>VAR</code>.</p>
 265
 266 <p>Environment variables can then be used in a variety of
 267 contexts, including CGI programs, other RewriteRule directives, or
 268 CustomLog directives.</p>
 269
 270 <p>The following example sets an environment variable called 'image' to a
 271 value of '1' if the requested URI is an image file. Then, that
 272 environment variable is used to exclude those requests from the access
 273 log.</p>
 274
 275 <pre class="prettyprint lang-config">RewriteRule \.(png|gif|jpg)$ - [E=image:1]
 276 CustomLog logs/access_log combined env=!image</pre>
 277
 278
 279 <p>Note that this same effect can be obtained using <code class="directive"><a href="../mod/mod_setenvif.html#setenvif">SetEnvIf</a></code>. This technique is offered as
 280 an example, not as a recommendation.</p>
 281 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 282 <div class="section">
 283 <h2><a name="flag_end" id="flag_end">END</a></h2>
 284 <p>Using the [END] flag terminates not only the current round of rewrite
 285 processing (like [L]) but also prevents any subsequent rewrite
 286 processing from occurring in per-directory (htaccess) context.</p>
 287
 288 <p>This does not apply to new requests resulting from external
 289 redirects.</p>
 290 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 291 <div class="section">
 292 <h2><a name="flag_f" id="flag_f">F|forbidden</a></h2>
 293 <p>Using the [F] flag causes the server to return a 403 Forbidden status
 294 code to the client. While the same behavior can be accomplished using
 295 the <code class="directive"><a href="../mod/mod_access_compat.html#deny">Deny</a></code> directive, this
 296 allows more flexibility in assigning a Forbidden status.</p>
 297
 298 <p>The following rule will forbid <code>.exe</code> files from being
 299 downloaded from your server.</p>
 300
 301 <pre class="prettyprint lang-config">RewriteRule \.exe - [F]</pre>
 302
 303
 304 <p>This example uses the "-" syntax for the rewrite target, which means
 305 that the requested URI is not modified. There's no reason to rewrite to
 306 another URI, if you're going to forbid the request.</p>
 307
 308 <p>When using [F], an [L] is implied - that is, the response is returned
 309 immediately, and no further rules are evaluated.</p>
 310
 311 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 312 <div class="section">
 313 <h2><a name="flag_g" id="flag_g">G|gone</a></h2>
 314 <p>The [G] flag forces the server to return a 410 Gone status with the
 315 response. This indicates that a resource used to be available, but is no
 316 longer available.</p>
 317
 318 <p>As with the [F] flag, you will typically use the "-" syntax for the
 319 rewrite target when using the [G] flag:</p>
 320
 321 <pre class="prettyprint lang-config">RewriteRule oldproduct - [G,NC]</pre>
 322
 323
 324 <p>When using [G], an [L] is implied - that is, the response is returned
 325 immediately, and no further rules are evaluated.</p>
 326
 327 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 328 <div class="section">
 329 <h2><a name="flag_h" id="flag_h">H|handler</a></h2>
 330 <p>Forces the resulting request to be handled with the specified
 331 handler. For example, one might use this to force all files without a
 332 file extension to be parsed by the php handler:</p>
 333
 334 <pre class="prettyprint lang-config">RewriteRule !\. - [H=application/x-httpd-php]</pre>
 335
 336
 337 <p>
 338 The regular expression above - <code>!\.</code> - will match any request
 339 that does not contain the literal <code>.</code> character.
 340 </p>
 341
 342 <p>This can be also used to force the handler based on some conditions.
 343 For example, the following snippet used in per-server context allows
 344 <code>.php</code> files to be <em>displayed</em> by <code>mod_php</code>
 345 if they are requested with the <code>.phps</code> extension:</p>
 346
 347 <pre class="prettyprint lang-config">RewriteRule ^(/source/.+\.php)s$ $1 [H=application/x-httpd-php-source]</pre>
 348
 349
 350 <p>The regular expression above - <code>^(/source/.+\.php)s$</code> - will
 351 match any request that starts with <code>/source/</code> followed by 1 or
 352 n characters followed by <code>.phps</code> literally. The backreference
 353 $1 referrers to the captured match within parenthesis of the regular
 354 expression.</p>
 355 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 356 <div class="section">
 357 <h2><a name="flag_l" id="flag_l">L|last</a></h2>
 358 <p>The [L] flag causes <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> to stop processing
 359 the rule set. In most contexts, this means that if the rule matches, no
 360 further rules will be processed. This corresponds to the
 361 <code>last</code> command in Perl, or the <code>break</code> command in
 362 C. Use this flag to indicate that the current rule should be applied
 363 immediately without considering further rules.</p>
 364
 365 <p>If you are using <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> in either
 366 <code>.htaccess</code> files or in
 367 <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> sections,
 368 it is important to have some understanding of how the rules are
 369 processed.  The simplified form of this is that once the rules have been
 370 processed, the rewritten request is handed back to the URL parsing
 371 engine to do what it may with it. It is possible that as the rewritten
 372 request is handled, the <code>.htaccess</code> file or
 373 <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> section
 374 may be encountered again, and thus the ruleset may be run again from the
 375 start. Most commonly this will happen if one of the rules causes a
 376 redirect - either internal or external - causing the request process to
 377 start over.</p>
 378
 379 <p>It is therefore important, if you are using <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directives in one of these
 380 contexts, that you take explicit steps to avoid rules looping, and not
 381 count solely on the [L] flag to terminate execution of a series of
 382 rules, as shown below.</p>
 383
 384 <p> An alternative flag, [END], can be used to terminate not only the
 385 current round of rewrite processing but prevent any subsequent
 386 rewrite processing from occurring in per-directory (htaccess)
 387 context. This does not apply to new requests resulting from external
 388 redirects.</p>
 389
 390 <p>The example given here will rewrite any request to
 391 <code>index.php</code>, giving the original request as a query string
 392 argument to <code>index.php</code>, however, the <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> ensures that if the request
 393 is already for <code>index.php</code>, the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> will be skipped.</p>
 394
 395 <pre class="prettyprint lang-config">RewriteBase /
 396 RewriteCond %{REQUEST_URI} !=/index.php
 397 RewriteRule ^(.*) /index.php?req=$1 [L,PT]</pre>
 398
 399 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 400 <div class="section">
 401 <h2><a name="flag_n" id="flag_n">N|next</a></h2>
 402 <p>
 403 The [N] flag causes the ruleset to start over again from the top, using
 404 the result of the ruleset so far as a starting point. Use
 405 with extreme caution, as it may result in loop.
 406 </p>
 407 <p>
 408 The [Next] flag could be used, for example, if you wished to replace a
 409 certain string or letter repeatedly in a request. The example shown here
 410 will replace A with B everywhere in a request, and will continue doing
 411 so until there are no more As to be replaced.
 412 </p>
 413 <pre class="prettyprint lang-config">RewriteRule (.*)A(.*) $1B$2 [N]</pre>
 414
 415 <p>You can think of this as a <code>while</code> loop: While this
 416 pattern still matches (i.e., while the URI still contains an
 417 <code>A</code>), perform this substitution (i.e., replace the
 418 <code>A</code> with a <code>B</code>).</p>
 419
 420 <p>In 2.5.0 and later, this module returns an error after 10,000 iterations to
 421 protect against unintended looping.  An alternative maximum number of
 422 iterations can be specified by adding to the N flag.  </p>
 423 <pre class="prettyprint lang-config"># Be willing to replace 1 character in each pass of the loop
 424 RewriteRule (.+)[&gt;&lt;;]$ $1 [N=32000]
 425 # ... or, give up if after 10 loops
 426 RewriteRule (.+)[&gt;&lt;;]$ $1 [N=10]</pre>
 427
 428
 429 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 430 <div class="section">
 431 <h2><a name="flag_nc" id="flag_nc">NC|nocase</a></h2>
 432 <p>Use of the [NC] flag causes the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to be matched in a
 433 case-insensitive manner. That is, it doesn't care whether letters appear
 434 as upper-case or lower-case in the matched URI.</p>
 435
 436 <p>In the example below, any request for an image file will be proxied
 437 to your dedicated image server. The match is case-insensitive, so that
 438 <code>.jpg</code> and <code>.JPG</code> files are both acceptable, for
 439 example.</p>
 440
 441 <pre class="prettyprint lang-config">RewriteRule (.*\.(jpg|gif|png))$ http://images.example.com$1 [P,NC]</pre>
 442
 443 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 444 <div class="section">
 445 <h2><a name="flag_ne" id="flag_ne">NE|noescape</a></h2>
 446 <p>By default, special characters, such as <code>&amp;</code> and
 447 <code>?</code>, for example, will be converted to their hexcode
 448 equivalent. Using the [NE] flag prevents that from happening.
 449 </p>
 450
 451 <pre class="prettyprint lang-config">RewriteRule ^/anchor/(.+) /bigpage.html#$1 [NE,R]</pre>
 452
 453
 454 <p>
 455 The above example will redirect <code>/anchor/xyz</code> to
 456 <code>/bigpage.html#xyz</code>. Omitting the [NE] will result in the #
 457 being converted to its hexcode equivalent, <code>%23</code>, which will
 458 then result in a 404 Not Found error condition.
 459 </p>
 460
 461 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 462 <div class="section">
 463 <h2><a name="flag_ns" id="flag_ns">NS|nosubreq</a></h2>
 464 <p>Use of the [NS] flag prevents the rule from being used on
 465 subrequests. For example, a page which is included using an SSI (Server
 466 Side Include) is a subrequest, and you may want to avoid rewrites
 467 happening on those subrequests. Also, when <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code>
 468 tries to find out information about possible directory default files
 469 (such as <code>index.html</code> files), this is an internal
 470 subrequest, and you often want to avoid rewrites on such subrequests.
 471 On subrequests, it is not always useful, and can even cause errors, if
 472 the complete set of rules are applied. Use this flag to exclude
 473 problematic rules.</p>
 474
 475 <p>To decide whether or not to use this rule: if you prefix URLs with
 476 CGI-scripts, to force them to be processed by the CGI-script, it's
 477 likely that you will run into problems (or significant overhead)
 478 on sub-requests. In these cases, use this flag.</p>
 479
 480 <p>
 481 Images, javascript files, or css files, loaded as part of an HTML page,
 482 are not subrequests - the browser requests them as separate HTTP
 483 requests.
 484 </p>
 485 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 486 <div class="section">
 487 <h2><a name="flag_p" id="flag_p">P|proxy</a></h2>
 488 <p>Use of the [P] flag causes the request to be handled by
 489 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, and handled via a proxy request. For
 490 example, if you wanted all image requests to be handled by a back-end
 491 image server, you might do something like the following:</p>
 492
 493 <pre class="prettyprint lang-config">RewriteRule /(.*)\.(jpg|gif|png)$ http://images.example.com/$1.$2 [P]</pre>
 494
 495
 496 <p>Use of the [P] flag implies [L] - that is, the request is immediately
 497 pushed through the proxy, and any following rules will not be
 498 considered.</p>
 499
 500 <p>
 501 You must make sure that the substitution string is a valid URI
 502 (typically starting with <code>http://</code><em>hostname</em>) which can be
 503 handled by the <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. If not, you will get an
 504 error from the proxy module. Use this flag to achieve a
 505 more powerful implementation of the <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> directive,
 506 to map remote content into the namespace of the local server.</p>
 507
 508 <div class="warning">
 509 <h3>Security Warning</h3>
 510 <p>Take care when constructing the target URL of the rule, considering
 511 the security impact from allowing the client influence over the set of
 512 URLs to which your server will act as a proxy.  Ensure that the scheme
 513 and hostname part of the URL is either fixed, or does not allow the
 514 client undue influence.</p>
 515 </div>
 516
 517 <div class="warning">
 518 <h3>Performance warning</h3>
 519 <p>Using this flag triggers the use of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, without handling of persistent connections. This
 520 means the performance of your proxy will be better if you set it up with <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> or
 521 <code class="directive"><a href="../mod/mod_proxy.html#proxypassmatch">ProxyPassMatch</a></code></p>
 522 <p>This is because this flag triggers the use of the default worker, which does not handle connection pooling.</p>
 523 <p>Avoid using this flag and prefer those directives, whenever you can.</p>
 524 </div>
 525
 526 <p>Note: <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> must be enabled in order
 527 to use this flag.</p>
 528
 529 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 530 <div class="section">
 531 <h2><a name="flag_pt" id="flag_pt">PT|passthrough</a></h2>
 532
 533 <p>
 534 The target (or substitution string) in a RewriteRule is assumed to be a
 535 file path, by default. The use of the [PT] flag causes it to be treated
 536 as a URI instead. That is to say, the
 537 use of the [PT] flag causes the result of the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to be passed back through
 538 URL mapping, so that location-based mappings, such as <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code>, <code class="directive"><a href="../mod/mod_alias.html#redirect">Redirect</a></code>, or <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>, for example, might have a
 539 chance to take effect.
 540 </p>
 541
 542 <p>
 543 If, for example, you have an
 544 <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code>
 545 for /icons, and have a <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> pointing there, you should
 546 use the [PT] flag to ensure that the
 547 <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code> is evaluated.
 548 </p>
 549
 550 <pre class="prettyprint lang-config">Alias /icons /usr/local/apache/icons
 551 RewriteRule /pics/(.+)\.jpg$ /icons/$1.gif [PT]</pre>
 552
 553
 554 <p>
 555 Omission of the [PT] flag in this case will cause the Alias to be
 556 ignored, resulting in a 'File not found' error being returned.
 557 </p>
 558
 559 <p>The <code>PT</code> flag implies the <code>L</code> flag:
 560 rewriting will be stopped in order to pass the request to
 561 the next phase of processing.</p>
 562
 563 <p>Note that the <code>PT</code> flag is implied in per-directory
 564 contexts such as
 565 <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> sections
 566 or in <code>.htaccess</code> files. The only way to circumvent that
 567 is to rewrite to <code>-</code>.</p>
 568
 569 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 570 <div class="section">
 571 <h2><a name="flag_qsa" id="flag_qsa">QSA|qsappend</a></h2>
 572 <p>
 573 When the replacement URI contains a query string, the default behavior
 574 of <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is to discard
 575 the existing query string, and replace it with the newly generated one.
 576 Using the [QSA] flag causes the query strings to be combined.
 577 </p>
 578
 579 <p>Consider the following rule:</p>
 580
 581 <pre class="prettyprint lang-config">RewriteRule /pages/(.+) /page.php?page=$1 [QSA]</pre>
 582
 583
 584 <p>With the [QSA] flag, a request for <code>/pages/123?one=two</code> will be
 585 mapped to <code>/page.php?page=123&amp;one=two</code>. Without the [QSA]
 586 flag, that same request will be mapped to
 587 <code>/page.php?page=123</code> - that is, the existing query string
 588 will be discarded.
 589 </p>
 590 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 591 <div class="section">
 592 <h2><a name="flag_qsd" id="flag_qsd">QSD|qsdiscard</a></h2>
 593 <p>
 594 When the requested URI contains a query string, and the target URI does
 595 not, the default behavior of <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is to copy that query
 596 string to the target URI. Using the [QSD] flag causes the query string
 597 to be discarded.
 598 </p>
 599
 600 <p>This flag is available in version 2.4.0 and later.</p>
 601
 602 <p>
 603 Using [QSD] and [QSA] together will result in [QSD] taking precedence.
 604 </p>
 605
 606 <p>
 607 If the target URI has a query string, the default behavior will be
 608 observed - that is, the original query string will be discarded and
 609 replaced with the query string in the <code>RewriteRule</code> target
 610 URI.
 611 </p>
 612
 613 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 614 <div class="section">
 615 <h2><a name="flag_r" id="flag_r">R|redirect</a></h2>
 616 <p>
 617 Use of the [R] flag causes a HTTP redirect to be issued to the browser.
 618 If a fully-qualified URL is specified (that is, including
 619 <code>http://servername/</code>) then a redirect will be issued to that
 620 location. Otherwise, the current protocol, servername, and port number
 621 will be used to generate the URL sent with the redirect.
 622 </p>
 623
 624 <p>
 625 <em>Any</em> valid HTTP response  status code may be specified,
 626 using the syntax [R=305], with a 302 status code being used by
 627 default if none is specified. The status code specified need not
 628 necessarily be a redirect (3xx) status code. However,
 629 if a status code is outside the redirect range (300-399) then the
 630 substitution string is dropped entirely, and rewriting is stopped as if
 631 the <code>L</code> were used.</p>
 632
 633 <p>In addition to response status codes, you may also specify redirect
 634 status using their symbolic names: <code>temp</code> (default),
 635 <code>permanent</code>, or <code>seeother</code>.</p>
 636
 637 <p>
 638 You will almost always want to use [R] in conjunction with [L] (that is,
 639 use [R,L]) because on its own, the [R] flag prepends
 640 <code>http://thishost[:thisport]</code> to the URI, but then passes this
 641 on to the next rule in the ruleset, which can often result in 'Invalid
 642 URI in request' warnings.
 643 </p>
 644
 645 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 646 <div class="section">
 647 <h2><a name="flag_s" id="flag_s">S|skip</a></h2>
 648 <p>The [S] flag is used to skip rules that you don't want to run. The
 649 syntax of the skip flag is [S=<em>N</em>], where <em>N</em> signifies
 650 the number of rules to skip (provided the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">
 651 RewriteRule</a></code> and any preceding <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">
 652 RewriteCond</a></code> directives match). This can be thought of as a
 653 <code>goto</code> statement in your rewrite ruleset. In the following
 654 example, we only want to run the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">
 655 RewriteRule</a></code> if the requested URI doesn't correspond with an
 656 actual file.</p>
 657
 658 <pre class="prettyprint lang-config"># Is the request for a non-existent file?
 659 RewriteCond %{REQUEST_FILENAME} !-f
 660 RewriteCond %{REQUEST_FILENAME} !-d
 661 # If so, skip these two RewriteRules
 662 RewriteRule .? - [S=2]
 663
 664 RewriteRule (.*\.gif) images.php?$1
 665 RewriteRule (.*\.html) docs.php?$1</pre>
 666
 667
 668 <p>This technique is useful because a <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> only applies to the
 669 <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> immediately
 670 following it. Thus, if you want to make a <code>RewriteCond</code> apply
 671 to several <code>RewriteRule</code>s, one possible technique is to
 672 negate those conditions and add a <code>RewriteRule</code> with a [Skip] flag. You can
 673 use this to make pseudo if-then-else constructs: The last rule of
 674 the then-clause becomes <code>skip=N</code>, where N is the
 675 number of rules in the else-clause:</p>
 676 <pre class="prettyprint lang-config"># Does the file exist?
 677 RewriteCond %{REQUEST_FILENAME} !-f
 678 RewriteCond %{REQUEST_FILENAME} !-d
 679 # Create an if-then-else construct by skipping 3 lines if we meant to go to the "else" stanza.
 680 RewriteRule .? - [S=3]
 681
 682 # IF the file exists, then:
 683     RewriteRule (.*\.gif) images.php?$1
 684     RewriteRule (.*\.html) docs.php?$1
 685     # Skip past the "else" stanza.
 686     RewriteRule .? - [S=1]
 687 # ELSE...
 688     RewriteRule (.*) 404.php?file=$1
 689 # END</pre>
 690
 691
 692 <p>It is probably easier to accomplish this kind of configuration using
 693 the <code class="directive">&lt;If&gt;</code>, <code class="directive">&lt;ElseIf&gt;</code>, and <code class="directive">&lt;Else&gt;</code> directives instead.</p>
 694
 695 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 696 <div class="section">
 697 <h2><a name="flag_t" id="flag_t">T|type</a></h2>
 698 <p>Sets the MIME type with which the resulting response will be
 699 sent. This has the same effect as the <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code> directive.</p>
 700
 701 <p>For example, you might use the following technique to serve Perl
 702 source code as plain text, if requested in a particular way:</p>
 703
 704 <pre class="prettyprint lang-config"># Serve .pl files as plain text
 705 RewriteRule \.pl$ - [T=text/plain]</pre>
 706
 707
 708 <p>Or, perhaps, if you have a camera that produces jpeg images without
 709 file extensions, you could force those images to be served with the
 710 correct MIME type by virtue of their file names:</p>
 711
 712 <pre class="prettyprint lang-config"># Files with 'IMG' in the name are jpg images.
 713 RewriteRule IMG - [T=image/jpg]</pre>
 714
 715
 716 <p>Please note that this is a trivial example, and could be better done
 717 using <code class="directive"><a href="../mod/core.html#filesmatch">&lt;FilesMatch&gt;</a></code>
 718 instead. Always consider the alternate
 719 solutions to a problem before resorting to rewrite, which will
 720 invariably be a less efficient solution than the alternatives.</p>
 721
 722 <p>
 723 If used in per-directory context, use only <code>-</code> (dash)
 724 as the substitution <em>for the entire round of mod_rewrite processing</em>,
 725 otherwise the MIME-type set with this flag is lost due to an internal
 726 re-processing (including subsequent rounds of mod_rewrite processing).
 727 The <code>L</code> flag can be useful in this context to end the
 728 <em>current</em> round of mod_rewrite processing.</p>
 729
 730 </div></div>
 731 <div class="bottomlang">
 732 <p><span>Available Languages: </span><a href="../en/rewrite/flags.html" title="English">&nbsp;en&nbsp;</a> |
 733 <a href="../fr/rewrite/flags.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 734 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 735 <script type="text/javascript"><!--//--><![CDATA[//><!--
 736 var comments_shortname = 'httpd';
 737 var comments_identifier = 'http://httpd.apache.org/docs/trunk/rewrite/flags.html';
 738 (function(w, d) {
 739     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 740         d.write('<div id="comments_thread"><\/div>');
 741         var s = d.createElement('script');
 742         s.type = 'text/javascript';
 743         s.async = true;
 744         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 745         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 746     }
 747     else {
 748         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 749     }
 750 })(window, document);
 751 //--><!]]></script></div><div id="footer">
 752 <p class="apache">Copyright 2015 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 753 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 754 if (typeof(prettyPrint) !== 'undefined') {
 755     prettyPrint();
 756 }
 757 //--><!]]></script>
 758 </body></html>