diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/manual/rewrite/flags.html | 9 | ||||
| -rw-r--r-- | docs/manual/rewrite/flags.html.en | 842 | ||||
| -rw-r--r-- | docs/manual/rewrite/flags.html.fr.utf8 | 904 |
3 files changed, 1755 insertions, 0 deletions
diff --git a/docs/manual/rewrite/flags.html b/docs/manual/rewrite/flags.html new file mode 100644 index 0000000..e74abb3 --- /dev/null +++ b/docs/manual/rewrite/flags.html @@ -0,0 +1,9 @@ +# GENERATED FROM XML -- DO NOT EDIT + +URI: flags.html.en +Content-Language: en +Content-type: text/html; charset=UTF-8 + +URI: flags.html.fr.utf8 +Content-Language: fr +Content-type: text/html; charset=UTF-8 diff --git a/docs/manual/rewrite/flags.html.en b/docs/manual/rewrite/flags.html.en new file mode 100644 index 0000000..5e175f1 --- /dev/null +++ b/docs/manual/rewrite/flags.html.en @@ -0,0 +1,842 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> +<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> +<!-- + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + This file is generated from xml source: DO NOT EDIT + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + --> +<title>RewriteRule Flags - Apache HTTP Server Version 2.4</title> +<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> +<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> +<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" /> +<script src="../style/scripts/prettify.min.js" type="text/javascript"> +</script> + +<link href="../images/favicon.ico" rel="shortcut icon" /></head> +<body id="manual-page"><div id="page-header"> +<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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> +<p class="apache">Apache HTTP Server Version 2.4</p> +<img alt="" src="../images/feather.png" /></div> +<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> +<div id="path"> +<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Rewrite</a></div><div id="page-content"><div id="preamble"><h1>RewriteRule Flags</h1> +<div class="toplang"> +<p><span>Available Languages: </span><a href="../en/rewrite/flags.html" title="English"> en </a> | +<a href="../fr/rewrite/flags.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> +</div> + +<p>This document discusses the flags which are available to the +<code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive, +providing detailed explanations and examples.</p> +</div> +<div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#introduction">Introduction</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_b">B (escape backreferences)</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_bnp">BNP|backrefnoplus (don't escape space to +)</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_bctls">BCTLS</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_bne">BNE</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_c">C|chain</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_co">CO|cookie</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_dpi">DPI|discardpath</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_e">E|env</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_end">END</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_f">F|forbidden</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_g">G|gone</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_h">H|handler</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_l">L|last</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_n">N|next</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_nc">NC|nocase</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_ne">NE|noescape</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_ns">NS|nosubreq</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_p">P|proxy</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_pt">PT|passthrough</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_qsa">QSA|qsappend</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_qsd">QSD|qsdiscard</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_qsl">QSL|qslast</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_r">R|redirect</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_s">S|skip</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_t">T|type</a></li> +</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><li><a href="#comments_section">Comments</a></li></ul></div> +<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="introduction" id="introduction">Introduction</a></h2> +<p>A <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> can have +its behavior modified by one or more flags. Flags are included in +square brackets at the end of the rule, and multiple flags are separated +by commas.</p> +<pre class="prettyprint lang-config">RewriteRule pattern target [Flag1,Flag2,Flag3]</pre> + + +<p>Each flag (with a few exceptions) has a short form, such as +<code>CO</code>, as well as a longer form, such as <code>cookie</code>. +While it is most common to use +the short form, it is recommended that you familiarize yourself with the +long form, so that you remember what each flag is supposed to do. +Some flags take one or more arguments. Flags are not case sensitive.</p> + +<p>Flags that alter metadata associated with the request (T=, H=, E=) +have no affect in per-directory and htaccess context, when a substitution +(other than '-') is performed during the same round of rewrite processing. +</p> + +<p>Presented here are each of the available flags, along with an example +of how you might use them.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_b" id="flag_b">B (escape backreferences)</a></h2> +<p>The [B] flag instructs <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to escape non-alphanumeric +characters before applying the transformation.</p> + +<p><code>mod_rewrite</code> has to unescape URLs before mapping them, +so backreferences are unescaped at the time they are applied. +Using the B flag, non-alphanumeric characters in backreferences +will be escaped. For example, consider the rule:</p> + +<pre class="prettyprint lang-config">RewriteRule "^search/(.*)$" "/search.php?term=$1"</pre> + + +<p>Given a search term of 'x & y/z', a browser will encode it as +'x%20%26%20y%2Fz', making the request 'search/x%20%26%20y%2Fz'. Without the B +flag, this rewrite rule will map to 'search.php?term=x & y/z', which +isn't a valid URL, and so would be encoded as +<code>search.php?term=x%20&y%2Fz=</code>, which is not what was intended.</p> + +<p>With the B flag set on this same rule, the parameters are re-encoded +before being passed on to the output URL, resulting in a correct mapping to +<code>/search.php?term=x%20%26%20y%2Fz</code>.</p> + +<pre class="prettyprint lang-config">RewriteRule "^search/(.*)$" "/search.php?term=$1" [B,PT]</pre> + + +<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 +particular example to work, as httpd does not allow encoded slashes in URLs, and +returns a 404 if it sees one.</p> + +<p>This escaping is particularly necessary in a proxy situation, +when the backend may break if presented with an unescaped URL.</p> + +<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 +strings in the encoded form.</p> + +<p>In 2.4.26 and later, you can limit the escaping to specific characters +in backreferences by listing them: <code>[B=#?;]</code>. Note: The space +character can be used in the list of characters to escape, but you must quote +the entire third argument of <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> +and the space must not be the last character in the list.</p> + +<pre class="prettyprint lang-config"># Escape spaces and question marks. The quotes around the final argument +# are required when a space is included. +RewriteRule "^search/(.*)$" "/search.php?term=$1" "[B= ?]"</pre> + + +<p>To limit the characters escaped this way, see <a href="flag_bne">flag_bne</a> +and <a href="flag_bctls">flag_bctls</a></p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_bnp" id="flag_bnp">BNP|backrefnoplus (don't escape space to +)</a></h2> +<p>The [BNP] flag instructs <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to escape the space character +in a backreference to %20 rather than '+'. Useful when the backreference +will be used in the path component rather than the query string.</p> + +<pre class="prettyprint lang-config"># Escape spaces to %20 in the path instead of + as used in form submission via +# the query string +RewriteRule "^search/(.*)$" "/search.php/$1" "[B,BNP]"</pre> + + + +<p>This flag is available in version 2.4.26 and later.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_bctls" id="flag_bctls">BCTLS</a></h2> +<p>The [BCTLS] flag is similar to the [B] flag, but only escapes +control characters and the space character. This is the same set of +characters rejected when they are copied into the query string unencoded. +</p> + +<pre class="prettyprint lang-config"># Escape control characters and spaces +RewriteRule "^search/(.*)$" "/search.php/$1" "[BCTLS]"</pre> + + +<p>This flag is available in version 2.4.57 and later.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_bne" id="flag_bne">BNE</a></h2> +<p>The list of characters in [BNE=...] are treated as exclusions to the +characters of the [B] or [BCTLS] flags. The listed characters will not be +escaped. +</p> + +<pre class="prettyprint lang-config"># Escape the default characters, but leave / +RewriteRule "^search/(.*)$" "/search.php?term=$1" "[B,BNE=/]"</pre> + + +<p>This flag is available in version 2.4.57 and later.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_c" id="flag_c">C|chain</a></h2> +<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 +rule. That is, if the rule matches, then it is processed as usual and +control moves on to the next rule. However, if it does not match, then +the next rule, and any other rules that are chained together, are +skipped.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_co" id="flag_co">CO|cookie</a></h2> +<p>The [CO], or [cookie] flag, allows you to set a cookie when a +particular <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> +matches. The argument consists of three required fields and five optional +fields.</p> + +<p>The full syntax for the flag, including all attributes, is as +follows:</p> + +<div class="example"><p><code> +[CO=NAME:VALUE:DOMAIN:lifetime:path:secure:httponly:samesite] +</code></p></div> + +<p>If a literal ':' character is needed in any of the cookie fields, an +alternate syntax is available. To opt-in to the alternate syntax, the cookie +"Name" should be preceded with a ';' character, and field separators should be +specified as ';'.</p> + +<div class="example"><p><code> +[CO=;NAME;VALUE:MOREVALUE;DOMAIN;lifetime;path;secure;httponly;samesite] +</code></p></div> + +<p>You must declare a name, a value, and a domain for the cookie to be set.</p> + +<dl> +<dt>Domain</dt> +<dd>The domain for which you want the cookie to be valid. This may be a +hostname, such as <code>www.example.com</code>, or it may be a domain, +such as <code>.example.com</code>. It must be at least two parts +separated by a dot. That is, it may not be merely <code>.com</code> or +<code>.net</code>. Cookies of that kind are forbidden by the cookie +security model.</dd> +</dl> + +<p>You may optionally also set the following values:</p> + +<dl> +<dt>Lifetime</dt> +<dd>The time for which the cookie will persist, in minutes.</dd> +<dd>A value of 0 indicates that the cookie will persist only for the +current browser session. This is the default value if none is +specified.</dd> + +<dt>Path</dt> +<dd>The path, on the current website, for which the cookie is valid, +such as <code>/customers/</code> or <code>/files/download/</code>.</dd> +<dd>By default, this is set to <code>/</code> - that is, the entire +website.</dd> + +<dt>Secure</dt> +<dd>If set to <code>secure</code>, <code>true</code>, or <code>1</code>, +the cookie will only be permitted to be translated via secure (https) +connections.</dd> + +<dt>httponly</dt> +<dd>If set to <code>HttpOnly</code>, <code>true</code>, or +<code>1</code>, the cookie will have the <code>HttpOnly</code> flag set, +which means that the cookie is inaccessible to JavaScript code on +browsers that support this feature.</dd> + +<dt>samesite</dt> +<dd>If set to anything other than <code>false</code> or <code>0</code>, the <code>SameSite</code> +attribute is set to the specified value. Typical values are <code>None</code>, +<code>Lax</code>, and <code>Strict</code>. Available in 2.4.47 and later.</dd> +</dl> + + +<p>Consider this example:</p> + +<pre class="prettyprint lang-config">RewriteEngine On +RewriteRule "^/index\.html" "-" [CO=frontdoor:yes:.example.com:1440:/]</pre> + + +<p>In the example give, the rule doesn't rewrite the request. +The "-" rewrite target tells mod_rewrite to pass the request +through unchanged. Instead, it sets a cookie +called 'frontdoor' to a value of 'yes'. The cookie is valid for any host +in the <code>.example.com</code> domain. It is set to expire in 1440 +minutes (24 hours) and is returned for all URIs.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_dpi" id="flag_dpi">DPI|discardpath</a></h2> +<p>The DPI flag causes the PATH_INFO portion of the rewritten URI to be +discarded.</p> +<p>This flag is available in version 2.2.12 and later.</p> +<p>In per-directory context, the URI each <code class="directive">RewriteRule</code> +compares against is the concatenation of the current values of the URI +and PATH_INFO.</p> + +<p>The current URI can be the initial URI as requested by the client, the +result of a previous round of mod_rewrite processing, or the result of +a prior rule in the current round of mod_rewrite processing.</p> + +<p>In contrast, the PATH_INFO that is appended to the URI before each +rule reflects only the value of PATH_INFO before this round of +mod_rewrite processing. As a consequence, if large portions +of the URI are matched and copied into a substitution in multiple +<code class="directive">RewriteRule</code> directives, without regard for +which parts of the URI came from the current PATH_INFO, the final +URI may have multiple copies of PATH_INFO appended to it.</p> + +<p>Use this flag on any substitution where the PATH_INFO that resulted +from the previous mapping of this request to the filesystem is not of +interest. This flag permanently forgets the PATH_INFO established +before this round of mod_rewrite processing began. PATH_INFO will +not be recalculated until the current round of mod_rewrite processing +completes. Subsequent rules during this round of processing will see +only the direct result of substitutions, without any PATH_INFO +appended.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_e" id="flag_e">E|env</a></h2> +<p>With the [E], or [env] flag, you can set the value of an environment +variable. Note that some environment variables may be set after the rule +is run, thus unsetting what you have set. See <a href="../env.html">the +Environment Variables document</a> for more details on how Environment +variables work.</p> + +<p>The full syntax for this flag is:</p> + +<pre class="prettyprint lang-config">[E=VAR:VAL] +[E=!VAR]</pre> + + +<p><code>VAL</code> may contain backreferences (<code>$N</code> or +<code>%N</code>) which are expanded.</p> + +<p>Using the short form</p> + +<div class="example"><p><code> +[E=VAR] +</code></p></div> + +<p>you can set the environment variable named <code>VAR</code> to an +empty value.</p> + +<p>The form</p> + +<div class="example"><p><code> +[E=!VAR] +</code></p></div> + +<p>allows to unset a previously set environment variable named +<code>VAR</code>.</p> + +<p>Environment variables can then be used in a variety of +contexts, including CGI programs, other RewriteRule directives, or +CustomLog directives.</p> + +<p>The following example sets an environment variable called 'image' to a +value of '1' if the requested URI is an image file. Then, that +environment variable is used to exclude those requests from the access +log.</p> + +<pre class="prettyprint lang-config">RewriteRule "\.(png|gif|jpg)$" "-" [E=image:1] +CustomLog "logs/access_log" combined env=!image</pre> + + +<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 +an example, not as a recommendation.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_end" id="flag_end">END</a></h2> +<p>Using the [END] flag terminates not only the current round of rewrite +processing (like [L]) but also prevents any subsequent rewrite +processing from occurring in per-directory (htaccess) context.</p> + +<p>This does not apply to new requests resulting from external +redirects.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_f" id="flag_f">F|forbidden</a></h2> +<p>Using the [F] flag causes the server to return a 403 Forbidden status +code to the client. While the same behavior can be accomplished using +the <code class="directive"><a href="../mod/mod_access_compat.html#deny">Deny</a></code> directive, this +allows more flexibility in assigning a Forbidden status.</p> + +<p>The following rule will forbid <code>.exe</code> files from being +downloaded from your server.</p> + +<pre class="prettyprint lang-config">RewriteRule "\.exe" "-" [F]</pre> + + +<p>This example uses the "-" syntax for the rewrite target, which means +that the requested URI is not modified. There's no reason to rewrite to +another URI, if you're going to forbid the request.</p> + +<p>When using [F], an [L] is implied - that is, the response is returned +immediately, and no further rules are evaluated.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_g" id="flag_g">G|gone</a></h2> +<p>The [G] flag forces the server to return a 410 Gone status with the +response. This indicates that a resource used to be available, but is no +longer available.</p> + +<p>As with the [F] flag, you will typically use the "-" syntax for the +rewrite target when using the [G] flag:</p> + +<pre class="prettyprint lang-config">RewriteRule "oldproduct" "-" [G,NC]</pre> + + +<p>When using [G], an [L] is implied - that is, the response is returned +immediately, and no further rules are evaluated.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_h" id="flag_h">H|handler</a></h2> +<p>Forces the resulting request to be handled with the specified +handler. For example, one might use this to force all files without a +file extension to be parsed by the php handler:</p> + +<pre class="prettyprint lang-config">RewriteRule "!\." "-" [H=application/x-httpd-php]</pre> + + +<p> +The regular expression above - <code>!\.</code> - will match any request +that does not contain the literal <code>.</code> character. +</p> + +<p>This can be also used to force the handler based on some conditions. +For example, the following snippet used in per-server context allows +<code>.php</code> files to be <em>displayed</em> by <code>mod_php</code> +if they are requested with the <code>.phps</code> extension:</p> + +<pre class="prettyprint lang-config">RewriteRule "^(/source/.+\.php)s$" "$1" [H=application/x-httpd-php-source]</pre> + + +<p>The regular expression above - <code>^(/source/.+\.php)s$</code> - will +match any request that starts with <code>/source/</code> followed by 1 or +n characters followed by <code>.phps</code> literally. The backreference +$1 referrers to the captured match within parenthesis of the regular +expression.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_l" id="flag_l">L|last</a></h2> +<p>The [L] flag causes <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> to stop processing +the rule set. In most contexts, this means that if the rule matches, no +further rules will be processed. This corresponds to the +<code>last</code> command in Perl, or the <code>break</code> command in +C. Use this flag to indicate that the current rule should be applied +immediately without considering further rules.</p> + +<p>If you are using <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> in either +<code>.htaccess</code> files or in +<code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> sections, +it is important to have some understanding of how the rules are +processed. The simplified form of this is that once the rules have been +processed, the rewritten request is handed back to the URL parsing +engine to do what it may with it. It is possible that as the rewritten +request is handled, the <code>.htaccess</code> file or +<code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> section +may be encountered again, and thus the ruleset may be run again from the +start. Most commonly this will happen if one of the rules causes a +redirect - either internal or external - causing the request process to +start over.</p> + +<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 +contexts, that you take explicit steps to avoid rules looping, and not +count solely on the [L] flag to terminate execution of a series of +rules, as shown below.</p> + +<p> An alternative flag, [END], can be used to terminate not only the +current round of rewrite processing but prevent any subsequent +rewrite processing from occurring in per-directory (htaccess) +context. This does not apply to new requests resulting from external +redirects.</p> + +<p>The example given here will rewrite any request to +<code>index.php</code>, giving the original request as a query string +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 +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> + +<pre class="prettyprint lang-config">RewriteBase "/" +RewriteCond "%{REQUEST_URI}" !=/index.php +RewriteRule "^(.*)" "/index.php?req=$1" [L,PT]</pre> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_n" id="flag_n">N|next</a></h2> +<p> +The [N] flag causes the ruleset to start over again from the top, using +the result of the ruleset so far as a starting point. Use +with extreme caution, as it may result in loop. +</p> +<p> +The [Next] flag could be used, for example, if you wished to replace a +certain string or letter repeatedly in a request. The example shown here +will replace A with B everywhere in a request, and will continue doing +so until there are no more As to be replaced. +</p> +<pre class="prettyprint lang-config">RewriteRule "(.*)A(.*)" "$1B$2" [N]</pre> + +<p>You can think of this as a <code>while</code> loop: While this +pattern still matches (i.e., while the URI still contains an +<code>A</code>), perform this substitution (i.e., replace the +<code>A</code> with a <code>B</code>).</p> + +<p>In 2.4.8 and later, this module returns an error after 10,000 iterations to +protect against unintended looping. An alternative maximum number of +iterations can be specified by adding to the N flag. </p> +<pre class="prettyprint lang-config"># Be willing to replace 1 character in each pass of the loop +RewriteRule "(.+)[><;]$" "$1" [N=32000] +# ... or, give up if after 10 loops +RewriteRule "(.+)[><;]$" "$1" [N=10]</pre> + + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_nc" id="flag_nc">NC|nocase</a></h2> +<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 +case-insensitive manner. That is, it doesn't care whether letters appear +as upper-case or lower-case in the matched URI.</p> + +<p>In the example below, any request for an image file will be proxied +to your dedicated image server. The match is case-insensitive, so that +<code>.jpg</code> and <code>.JPG</code> files are both acceptable, for +example.</p> + +<pre class="prettyprint lang-config">RewriteRule "(.*\.(jpg|gif|png))$" "http://images.example.com$1" [P,NC]</pre> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_ne" id="flag_ne">NE|noescape</a></h2> +<p>By default, special characters, such as <code>&</code> and +<code>?</code>, for example, will be converted to their hexcode +equivalent for rules that result in external redirects. +Using the [NE] flag prevents that from happening. +</p> + +<pre class="prettyprint lang-config">RewriteRule "^/anchor/(.+)" "/bigpage.html#$1" [NE,R]</pre> + + +<p> +The above example will redirect <code>/anchor/xyz</code> to +<code>/bigpage.html#xyz</code>. Omitting the [NE] will result in the # +being converted to its hexcode equivalent, <code>%23</code>, which will +then result in a 404 Not Found error condition. +</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_ns" id="flag_ns">NS|nosubreq</a></h2> +<p>Use of the [NS] flag prevents the rule from being used on +subrequests. For example, a page which is included using an SSI (Server +Side Include) is a subrequest, and you may want to avoid rewrites +happening on those subrequests. Also, when <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> +tries to find out information about possible directory default files +(such as <code>index.html</code> files), this is an internal +subrequest, and you often want to avoid rewrites on such subrequests. +On subrequests, it is not always useful, and can even cause errors, if +the complete set of rules are applied. Use this flag to exclude +problematic rules.</p> + +<p>To decide whether or not to use this rule: if you prefix URLs with +CGI-scripts, to force them to be processed by the CGI-script, it's +likely that you will run into problems (or significant overhead) +on sub-requests. In these cases, use this flag.</p> + +<p> +Images, javascript files, or css files, loaded as part of an HTML page, +are not subrequests - the browser requests them as separate HTTP +requests. +</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_p" id="flag_p">P|proxy</a></h2> +<p>Use of the [P] flag causes the request to be handled by +<code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, and handled via a proxy request. For +example, if you wanted all image requests to be handled by a back-end +image server, you might do something like the following:</p> + +<pre class="prettyprint lang-config">RewriteRule "/(.*)\.(jpg|gif|png)$" "http://images.example.com/$1.$2" [P]</pre> + + +<p>Use of the [P] flag implies [L] - that is, the request is immediately +pushed through the proxy, and any following rules will not be +considered.</p> + +<p> +You must make sure that the substitution string is a valid URI +(typically starting with <code>http://</code><em>hostname</em>) which can be +handled by the <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. If not, you will get an +error from the proxy module. Use this flag to achieve a +more powerful implementation of the <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> directive, +to map remote content into the namespace of the local server.</p> + +<div class="warning"> +<h3>Security Warning</h3> +<p>Take care when constructing the target URL of the rule, considering +the security impact from allowing the client influence over the set of +URLs to which your server will act as a proxy. Ensure that the scheme +and hostname part of the URL is either fixed, or does not allow the +client undue influence.</p> +</div> + +<div class="warning"> +<h3>Performance warning</h3> +<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 +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 +<code class="directive"><a href="../mod/mod_proxy.html#proxypassmatch">ProxyPassMatch</a></code></p> +<p>This is because this flag triggers the use of the default worker, which does not handle connection pooling/reuse.</p> +<p>Avoid using this flag and prefer those directives, whenever you can.</p> +</div> + +<p>Note: <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> must be enabled in order +to use this flag.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_pt" id="flag_pt">PT|passthrough</a></h2> + +<p> +The target (or substitution string) in a RewriteRule is assumed to be a +file path, by default. The use of the [PT] flag causes it to be treated +as a URI instead. That is to say, the +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 +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 +chance to take effect. +</p> + +<p> +If, for example, you have an +<code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code> +for /icons, and have a <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> pointing there, you should +use the [PT] flag to ensure that the +<code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code> is evaluated. +</p> + +<pre class="prettyprint lang-config">Alias "/icons" "/usr/local/apache/icons" +RewriteRule "/pics/(.+)\.jpg$" "/icons/$1.gif" [PT]</pre> + + +<p> +Omission of the [PT] flag in this case will cause the Alias to be +ignored, resulting in a 'File not found' error being returned. +</p> + +<p>The <code>PT</code> flag implies the <code>L</code> flag: +rewriting will be stopped in order to pass the request to +the next phase of processing.</p> + +<p>Note that the <code>PT</code> flag is implied in per-directory +contexts such as +<code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> sections +or in <code>.htaccess</code> files. The only way to circumvent that +is to rewrite to <code>-</code>.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_qsa" id="flag_qsa">QSA|qsappend</a></h2> +<p> +When the replacement URI contains a query string, the default behavior +of <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is to discard +the existing query string, and replace it with the newly generated one. +Using the [QSA] flag causes the query strings to be combined. +</p> + +<p>Consider the following rule:</p> + +<pre class="prettyprint lang-config">RewriteRule "/pages/(.+)" "/page.php?page=$1" [QSA]</pre> + + +<p>With the [QSA] flag, a request for <code>/pages/123?one=two</code> will be +mapped to <code>/page.php?page=123&one=two</code>. Without the [QSA] +flag, that same request will be mapped to +<code>/page.php?page=123</code> - that is, the existing query string +will be discarded. +</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_qsd" id="flag_qsd">QSD|qsdiscard</a></h2> +<p> +When the requested URI contains a query string, and the target URI does +not, the default behavior of <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is to copy that query +string to the target URI. Using the [QSD] flag causes the query string +to be discarded. +</p> + +<p>This flag is available in version 2.4.0 and later.</p> + +<p> +Using [QSD] and [QSA] together will result in [QSD] taking precedence. +</p> + +<p> +If the target URI has a query string, the default behavior will be +observed - that is, the original query string will be discarded and +replaced with the query string in the <code>RewriteRule</code> target +URI. +</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_qsl" id="flag_qsl">QSL|qslast</a></h2> +<p> +By default, the first (left-most) question mark in the substitution +delimits the path from the query string. Using the [QSL] flag instructs +<code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to instead split +the two components using the last (right-most) question mark. </p> + +<p> +This is useful when mapping to files that have literal question marks in +their filename. If no query string is used in the substitution, +a question mark can be appended to it in combination with this flag. </p> + +<p> This flag is available in version 2.4.19 and later.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_r" id="flag_r">R|redirect</a></h2> +<p> +Use of the [R] flag causes a HTTP redirect to be issued to the browser. +If a fully-qualified URL is specified (that is, including +<code>http://servername/</code>) then a redirect will be issued to that +location. Otherwise, the current protocol, servername, and port number +will be used to generate the URL sent with the redirect. +</p> + +<p> +<em>Any</em> valid HTTP response status code may be specified, +using the syntax [R=305], with a 302 status code being used by +default if none is specified. The status code specified need not +necessarily be a redirect (3xx) status code. However, +if a status code is outside the redirect range (300-399) then the +substitution string is dropped entirely, and rewriting is stopped as if +the <code>L</code> were used.</p> + +<p>In addition to response status codes, you may also specify redirect +status using their symbolic names: <code>temp</code> (default), +<code>permanent</code>, or <code>seeother</code>.</p> + +<p> +You will almost always want to use [R] in conjunction with [L] (that is, +use [R,L]) because on its own, the [R] flag prepends +<code>http://thishost[:thisport]</code> to the URI, but then passes this +on to the next rule in the ruleset, which can often result in 'Invalid +URI in request' warnings. +</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_s" id="flag_s">S|skip</a></h2> +<p>The [S] flag is used to skip rules that you don't want to run. The +syntax of the skip flag is [S=<em>N</em>], where <em>N</em> signifies +the number of rules to skip (provided the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule"> +RewriteRule</a></code> and any preceding <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond"> +RewriteCond</a></code> directives match). This can be thought of as a +<code>goto</code> statement in your rewrite ruleset. In the following +example, we only want to run the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule"> +RewriteRule</a></code> if the requested URI doesn't correspond with an +actual file.</p> + +<pre class="prettyprint lang-config"># Is the request for a non-existent file? +RewriteCond "%{REQUEST_FILENAME}" !-f +RewriteCond "%{REQUEST_FILENAME}" !-d +# If so, skip these two RewriteRules +RewriteRule ".?" "-" [S=2] + +RewriteRule "(.*\.gif)" "images.php?$1" +RewriteRule "(.*\.html)" "docs.php?$1"</pre> + + +<p>This technique is useful because a <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> only applies to the +<code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> immediately +following it. Thus, if you want to make a <code>RewriteCond</code> apply +to several <code>RewriteRule</code>s, one possible technique is to +negate those conditions and add a <code>RewriteRule</code> with a [Skip] flag. You can +use this to make pseudo if-then-else constructs: The last rule of +the then-clause becomes <code>skip=N</code>, where N is the +number of rules in the else-clause:</p> +<pre class="prettyprint lang-config"># Does the file exist? +RewriteCond "%{REQUEST_FILENAME}" !-f +RewriteCond "%{REQUEST_FILENAME}" !-d +# Create an if-then-else construct by skipping 3 lines if we meant to go to the "else" stanza. +RewriteRule ".?" "-" [S=3] + +# IF the file exists, then: + RewriteRule "(.*\.gif)" "images.php?$1" + RewriteRule "(.*\.html)" "docs.php?$1" + # Skip past the "else" stanza. + RewriteRule ".?" "-" [S=1] +# ELSE... + RewriteRule "(.*)" "404.php?file=$1" +# END</pre> + + +<p>It is probably easier to accomplish this kind of configuration using +the <code class="directive"><If></code>, <code class="directive"><ElseIf></code>, and <code class="directive"><Else></code> directives instead.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_t" id="flag_t">T|type</a></h2> +<p>Sets the MIME type with which the resulting response will be +sent. This has the same effect as the <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code> directive.</p> + +<p>For example, you might use the following technique to serve Perl +source code as plain text, if requested in a particular way:</p> + +<pre class="prettyprint lang-config"># Serve .pl files as plain text +RewriteRule "\.pl$" "-" [T=text/plain]</pre> + + +<p>Or, perhaps, if you have a camera that produces jpeg images without +file extensions, you could force those images to be served with the +correct MIME type by virtue of their file names:</p> + +<pre class="prettyprint lang-config"># Files with 'IMG' in the name are jpg images. +RewriteRule "IMG" "-" [T=image/jpg]</pre> + + +<p>Please note that this is a trivial example, and could be better done +using <code class="directive"><a href="../mod/core.html#filesmatch"><FilesMatch></a></code> +instead. Always consider the alternate +solutions to a problem before resorting to rewrite, which will +invariably be a less efficient solution than the alternatives.</p> + +<p> +If used in per-directory context, use only <code>-</code> (dash) +as the substitution <em>for the entire round of mod_rewrite processing</em>, +otherwise the MIME-type set with this flag is lost due to an internal +re-processing (including subsequent rounds of mod_rewrite processing). +The <code>L</code> flag can be useful in this context to end the +<em>current</em> round of mod_rewrite processing.</p> + +</div></div> +<div class="bottomlang"> +<p><span>Available Languages: </span><a href="../en/rewrite/flags.html" title="English"> en </a> | +<a href="../fr/rewrite/flags.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> +</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&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div> +<script type="text/javascript"><!--//--><![CDATA[//><!-- +var comments_shortname = 'httpd'; +var comments_identifier = 'http://httpd.apache.org/docs/2.4/rewrite/flags.html'; +(function(w, d) { + if (w.location.hostname.toLowerCase() == "httpd.apache.org") { + d.write('<div id="comments_thread"><\/div>'); + var s = d.createElement('script'); + s.type = 'text/javascript'; + s.async = true; + s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; + (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); + } + else { + d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); + } +})(window, document); +//--><!]]></script></div><div id="footer"> +<p class="apache">Copyright 2023 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> +<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!-- +if (typeof(prettyPrint) !== 'undefined') { + prettyPrint(); +} +//--><!]]></script> +</body></html>
\ No newline at end of file diff --git a/docs/manual/rewrite/flags.html.fr.utf8 b/docs/manual/rewrite/flags.html.fr.utf8 new file mode 100644 index 0000000..4c3e486 --- /dev/null +++ b/docs/manual/rewrite/flags.html.fr.utf8 @@ -0,0 +1,904 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr"><head> +<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> +<!-- + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + This file is generated from xml source: DO NOT EDIT + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + --> +<title>Les drapeaux de réécriture - Serveur HTTP Apache Version 2.4</title> +<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> +<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> +<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" /> +<script src="../style/scripts/prettify.min.js" type="text/javascript"> +</script> + +<link href="../images/favicon.ico" rel="shortcut icon" /></head> +<body id="manual-page"><div id="page-header"> +<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossaire</a> | <a href="../sitemap.html">Plan du site</a></p> +<p class="apache">Serveur HTTP Apache Version 2.4</p> +<img alt="" src="../images/feather.png" /></div> +<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> +<div id="path"> +<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">Serveur HTTP</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Rewrite</a></div><div id="page-content"><div id="preamble"><h1>Les drapeaux de réécriture</h1> +<div class="toplang"> +<p><span>Langues Disponibles: </span><a href="../en/rewrite/flags.html" hreflang="en" rel="alternate" title="English"> en </a> | +<a href="../fr/rewrite/flags.html" title="Français"> fr </a></p> +</div> + +<p>Ce document décrit les drapeaux disponibles dans la directive +<code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code>, en fournissant +des explications détaillées et des exemples.</p> +</div> +<div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#introduction">Introduction</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_b">B (échappement dans les références arrières)</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_bnp">BNP|backrefnoplus (ne pas échapper +l'espace en +)</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_c">C|chain</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_co">CO|cookie</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_dpi">DPI|discardpath</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_e">E|env</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_end">END</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_f">F|forbidden</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_g">G|gone</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_h">H|handler</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_l">L|last</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_n">N|next</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_nc">NC|nocase</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_ne">NE|noescape</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_ns">NS|nosubreq</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_p">P|proxy</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_pt">PT|passthrough</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_qsa">QSA|qsappend</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_qsd">QSD|qsdiscard</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_qsl">QSL|qslast</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_r">R|redirect</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_s">S|skip</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flag_t">T|type</a></li> +</ul><h3>Voir aussi</h3><ul class="seealso"><li><a href="../mod/mod_rewrite.html">Documentation du module</a></li><li><a href="intro.html">Introduction à mod_rewrite</a></li><li><a href="remapping.html">Redirection and remise en +correspondance</a></li><li><a href="access.html">Contrôle d'accès</a></li><li><a href="vhosts.html">Serveurs virtuels</a></li><li><a href="proxy.html">Mise en cache</a></li><li><a href="rewritemap.html">Utilisation de RewriteMap</a></li><li><a href="advanced.html">Techniques avancées</a></li><li><a href="avoid.html">Quand ne pas utiliser mod_rewrite</a></li><li><a href="#comments_section">Commentaires</a></li></ul></div> +<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="introduction" id="introduction">Introduction</a></h2> +<p>Le comportement d'une directive <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> peut être modifié par un ou +plusieurs drapeaux. Les drapeaux sont situés en fin de règle, entourés +de crochets, et séparés le cas échéant par des virgules.</p> +<pre class="prettyprint lang-config">RewriteRule pattern target [Flag1,Flag2,Flag3]</pre> + + +<p>Chaque drapeau (à quelques exceptions près) +possède une forme courte, comme <code>CO</code>, ainsi qu'une forme longue, +comme <code>cookie</code>. Bien que +la forme courte soit la plus couramment utilisée, nous vous recommandons +de vous familiariser avec les drapeaux sous leur forme longue, afin de +bien mémoriser ce que chaque drapeau est supposé faire. +Certains drapeaux acceptent un ou plusieurs arguments. Les drapeaux ne +sont pas sensibles à la casse.</p> + +<p>Les drapeaux qui modifient les métadonnées associées à la requête +(T=, H=, E=) n'ont aucun effet dans un contexte de répertoire ou de +fichier htaccess, lorsqu'une substitution (autre que '-') est effectuée +au cours de la même passe du processus de réécriture. +</p> + +<p>Chaque drapeau disponible est présenté ici, avec un exemple +d'utilisation.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_b" id="flag_b">B (échappement dans les références arrières)</a></h2> +<p>Avec le drapeau [B], la directive <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> échappe les caractères +non-alphanumériques avant d'appliquer la transformation.</p> + +<p><code>mod_rewrite</code> doit supprimer les séquences d'échappement +des URLs avant leur +mise en correspondance avec le système de fichiers ; les séquences +d'échappement sont donc supprimées des références arrières au moment où +ces dernières sont appliquées. Avec le drapeau B, les caractères +non-alphanumériques des références arrières seront échappés. Considérons +par exemple cette règle :</p> + +<pre class="prettyprint lang-config">RewriteRule "^search/(.*)$" "/search.php?term=$1"</pre> + + +<p>Soit le terme de recherche 'x & y/z' ; un navigateur va le coder +en 'x%20%26%20y%2Fz', transformant la requête en +'search/x%20%26%20y%2Fz'. Sans le drapeau B, cette règle de réécriture +va réécrire la requête en 'search.php?term=x & y/z', ce qui ne +correspond pas à une URL valide et cette dernière sera encodée en +<code>search.php?term=x%20&y%2Fz=</code>, ce qui ne correspond pas à +ce que l'on souhaitait.</p> + +<p>Avec le drapeau B, les paramètres sont réencodés avant d'être passés +à l'URL résultante, ce qui fournit une réécriture correcte en +<code>/search.php?term=x%20%26%20y%2Fz</code>.</p> + +<pre class="prettyprint lang-config">RewriteRule "^search/(.*)$" "/search.php?term=$1" [B,PT]</pre> + + +<p>Notez que vous devrez peut-être aussi définir la +directive <code class="directive"><a href="../mod/core.html#allowencodedslashes">AllowEncodedSlashes</a></code> +à <code>On</code> pour +que cet exemple particulier fonctionne, car httpd ne permet pas les +slashes encodés dans les URLs, et renvoie une erreur 404 s'il en +rencontre un.</p> + +<p>Ce processus d'échappement est en particulier nécessaire dans le +contexte d'un mandataire, où l'accès au serveur d'arrière-plan échouera +si on présente à ce dernier une URL non échappée.</p> + +<p>Une alternative à ce drapeau consiste à utiliser une directive +<code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> pour capturer +%{THE_REQUEST}, les chaînes capturées se présentant +alors sous la forme codée.</p> + +<p>A partir +de la version 2.4.26, vous pouvez limiter l'échappement dans les +références arrières à une liste de caractères que vous pouvez spécifiez comme +dans cet exemple : <code>[B=#?;]</code>. Notez que l'espace peut faire +partie de la liste des caractères à échapper, mais que vous devez mettre entre +guillemets le troisième argument de la directive <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> et que l'espace ne doit pas +être le dernier caractère de cette liste. +</p> + +<pre class="prettyprint lang-config"># Échappement des espaces et des points d'interrogation. Les guillemets autour +# du dernier argument sont obligatoires lorsque l'espace est inclus. +RewriteRule "^search/(.*)$" "/search.php?term=$1" "[B= ?]"</pre> + + +<p>Pour définir la liste des caractères à échapper de cette manière, voir <a href="flag_bne">flag_bne</a> et <a href="flag_bctls">flag_bctls</a></p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_bnp" id="flag_bnp">BNP|backrefnoplus (ne pas échapper +l'espace en +)</a></h2> +<p>Si le drapeau [BNP] est spécifié, la directive <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> échappera le caractère +espace en %20 au lieu de '+' dans les références arrières. Ceci s'avère +utile lorsque la référence arrière est utilisée dans la partie chemin, +et non dans les paramètres de la requête.</p> + +<pre class="prettyprint lang-config"># Échappe le caractère espace en %20 dans le chemin au lieu de + comme dans la +# soumission de formulaire à l'aide de la chaîne de paramètres +RewriteRule "^search/(.*)$" "/search.php/$1" "[B,BNP]"</pre> + + +<p>Ce drapeau est disponible à partir de la version 2.4.26 du serveur HTTP +Apache.</p> + +<h3><a name="flag_bctls" id="flag_bctls">BCTLS</a></h3> +<p>Le drapeau [BCTLS] est similaire à [B], à la différence que seuls les espaces +et les caractères de contrôle sont échappés. Il s'agit du même jeu de caractères +rejetés lorsqu'ils sont copiés dans la chaîne de paramètres non codée. +</p> + +<pre class="prettyprint lang-config"># Échappe les espaces et les caractères de contrôle +RewriteRule "^search/(.*)$" "/search.php/$1" "[BCTLS]"</pre> + + +<p>Ce drapeau est disponible à partir de la version 2.4.57 du serveur HTTP +Apache.</p> + + + +<h3><a name="flag_bne" id="flag_bne">BNE</a></h3> +<p>Les caractères listés dans [BNE=...] sont exclus des listes de caractères +correspondant aux drapeaux [B] ou [BCTLS]. Ils ne seront donc pas échappés. +</p> + +<pre class="prettyprint lang-config"># Échappe les caractères par défaut, sauf / +RewriteRule "^search/(.*)$" "/search.php?term=$1" "[B,BNE=/]"</pre> + + +<p>Ce drapeau est disponible à partir de la version 2.4.57 du serveur HTTP +Apache.</p> + + + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_c" id="flag_c">C|chain</a></h2> +<p>Le drapeau [C] ou [chain] indique que la règle <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> est chaînée avec la +suivante. Autrement dit, si la règle s'applique, elle est traitée +normalement et passe le contrôle à la règle suivante. Par contre, si +elle ne s'applique pas, la règle suivante, ainsi que toutes les règles +chaînées qui suivent, seront sautées.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_co" id="flag_co">CO|cookie</a></h2> +<p>Le drapeau [CO], ou [cookie], vous permet de définir un cookie +lorsqu'une règle <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> +s'applique. Il possède trois arguments obligatoires et +cinq arguments optionnels.</p> + +<p>La syntaxe complète de ce drapeau, avec tous ses attributs, est la +suivante :</p> + +<div class="example"><p><code> +[CO=NAME:VALUE:DOMAIN:lifetime:path:secure:httponly:samesite] +</code></p></div> + +<p>Si un caractère littéral ':' doit être insérer dans un des champs du +cookie, une autre syntaxe est disponible. Pour utiliser cette syntaxe +alternative, le contenu du champ "Name" doit être précédé du caractère +';', et les sépateurs de champs deviendront des ';'.</p> + +<div class="example"><p><code> +[CO=;NAME;VALUE:MOREVALUE;DOMAIN;lifetime;path;secure;httponly;samesite] +</code></p></div> + +<p>Vous devez déclarer un nom, une valeur et un domaine pour que +le cookie puisse être défini.</p> + + +<dl> +<dt>Domain</dt> +<dd>Le domaine pour lequel vous souhaitez que le cookie soit valide. Ce +peut être un nom de serveur, comme <code>www.example.com</code>, ou un +domaine, comme <code>.example.com</code>. Il doit comporter au moins +deux parties séparées par un point. C'est à dire que vous ne pouvez pas +utiliser les valeurs <code>.com</code> ou <code>.net</code>. En effet, +ce style de cookie est interdit par le modèle de sécurité des cookies.</dd> +</dl> + +<p>Vous pouvez aussi définir les valeurs suivantes :</p> + +<dl> +<dt>Lifetime</dt> +<dd>La durée de vie du cookie, en minutes.</dd> +<dd>Une valeur de 0 indique une durée de vie correspondant à la session +courante du navigateur. Il s'agit de la valeur par défaut.</dd> + +<dt>Path</dt> +<dd>Le chemin, sur le site web concerné, pour lequel le cookie est +valide, du style <code>/clients/</code> or +<code>/fichiers/telechargement/</code>.</dd> +<dd>La valeur par défaut est <code>/</code> - c'est à dire l'ensemble du +site web.</dd> + +<dt>Secure</dt> +<dd>Si cet argument a pour valeur <code>secure</code>, +<code>true</code>, ou <code>1</code>, le cookie ne pourra être transmis +que dans le cadre d'une connexion sécurisée (https).</dd> + +<dt>httponly</dt> +<dd>Si cet argument a pour valeur <code>HttpOnly</code>, +<code>true</code>, ou <code>1</code>, le cookie aura son drapeau +<code>HttpOnly</code> activé, ce qui signifie qu'il sera inaccessible au +code JavaScript pour les navigateurs qui supportent cette +fonctionnalité.</dd> + +<dt>samesite</dt> +<dd>S'il est différent de <code>false</code> ou <code>0</code>, l'attribut +<code>SameSite</code> est défini à la valeur spécifiée. Les valeurs typiques +sont <code>None</code>, <code>Lax</code> et <code>Strict</code>. Disponible à +partir de la version 2.4.47 du serveur HTTP Apache.</dd> +</dl> + +<p>Voici un exemple :</p> + +<pre class="prettyprint lang-config">RewriteEngine On +RewriteRule "^/index\.html" "-" [CO=frontdoor:yes:.example.com:1440:/]</pre> + + +<p>Dans l'exemple ci-dessus, la règle ne réécrit +pas la requête. La cible de réécriture "-" +indique à mod_rewrite de transmettre la requête sans +modification. Par contre, il +définit un cookie nommé 'frontdoor' avec une valeur 'yes'. Le cookie est +valide pour tout hôte situé dans le domaine <code>.example.org</code>. Sa +durée de vie est limitée à 1440 minutes (24 heures), et il sera renvoyé +pour tous les URIs.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_dpi" id="flag_dpi">DPI|discardpath</a></h2> +<p>Avec le drapeau DPI, la partie PATH_INFO de l'URI +réécrit est supprimée.</p> +<p>Ce drapeau est disponible dans les versions 2.2.12 et supérieures.</p> +<p>Dans un contexte de répertoire, l'URI mis en comparaison par chaque +règle <code class="directive">RewriteRule</code> est la concaténation des +valeurs courantes de l'URI et de PATH_INFO.</p> + +<p>L'URI courant peut être l'URI initial tel qu'il a été fourni par le +client, le résultat d'une passe précédente du processus de réécriture, +ou le résultat de la règle précédente dans le processus courant de +réécriture.</p> + +<p>Par contre, la partie PATH_INFO ajoutée à l'URI avant chaque règle ne +reflète que la valeur de PATH_INFO avant la passe courante du processus +de réécriture. En conséquence, si de larges portions de l'URI +correspondent et sont traduites via plusieurs directives +<code class="directive">RewriteRule</code>, sans prendre en compte +quelles parties de l'URI provenaient du PATH_INFO courant, l'URI final +pourra se voir ajouter plusieurs copies de PATH_INFO.</p> + +<p>Utilisez ce drapeau pour toute substitution où la présence du PATH_INFO qui +résultait de la mise en correspondance précédente de cette requête avec +le système de fichier n'est pas nécessaire. Avec ce drapeau, le +PATH_INFO établi avant que cette passe du processus de réécriture ne +débute est oublié. PATH_INFO ne sera pas recalculé tant que la passe +courante du processus de réécriture ne sera pas achevée. Les règles +suivantes de cette passe ne verront que le résultat direct des +substitutions, sans aucun PATH_INFO ajouté.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_e" id="flag_e">E|env</a></h2> +<p>Avec le drapeau [E], ou [env], vous pouvez définir la valeur d'une +variable d'environnement. Notez que certaines variables d'environnement +peuvent être définies après le traitement de la règle, annulant par +la-même ce que vous avez défini. Voir le <a href="../env.html">document +sur les variables d'environnement</a> pour plus de détails sur le +fonctionnement des variables d'environnement.</p> + +<p>La syntaxe complète pour ce drapeau est :</p> + +<pre class="prettyprint lang-config">[E=!VAR]</pre> + + +<p><code>VAL</code> peut comporter des références arrières +(<code>$N</code> ou <code>%N</code>) qui seront développées.</p> + +<p>En utilisant la version courte</p> + +<div class="example"><p><code> +[E=VAR] +</code></p></div> + +<p>vous pouvez définir la variable d'environnement nommée +<code>VAR</code> avec une valeur vide.</p> + +<p>La forme</p> + +<div class="example"><p><code> +[E=!VAR] +</code></p></div> + +<p>permet d'annuler la définition de la variable <code>VAR</code>.</p> + +<p>Les variables d'environnement s'emploient dans différents contextes, +comme les programmes CGI, d'autres directives RewriteRule, ou des +directives CustomLog.</p> + +<p>L'exemple suivant définit une variable d'environnement nommée 'image' +avec une valeur de '1' si l'URI de la requête correspond à un fichier +image. Cette variable d'environnement est ensuite utilisée pour exclure +une telle requête du journal des accès.</p> + +<pre class="prettyprint lang-config">RewriteRule "\.(png|gif|jpg)$" "-" [E=image:1] +CustomLog "logs/access_log" combined env=!image</pre> + + +<p>Notez que le même effet peut être obtenu à l'aide de la directive +<code class="directive"><a href="../mod/mod_setenvif.html#setenvif">SetEnvIf</a></code>. Cette technique +est présentée à titre d'exemple et non de recommandation.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_end" id="flag_end">END</a></h2> +<p>L'utilisation du drapeau [END] permet non seulement de terminer le +processus de réécriture en cours (comme [L]), mais aussi d'empêcher tout +processus de réécriture ultérieur dans un contexte de répertoire +(htaccess).</p> + +<p>Ceci ne s'applique pas aux nouvelles requêtes résultant d'une +redirection externe.</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_f" id="flag_f">F|forbidden</a></h2> +<p>L'utilisation du drapeau [F] permet de faire envoyer par le serveur au +client un code de statut "403 Forbidden". Le même effet peut être obtenu à +l'aide de la directive <code class="directive"><a href="../mod/mod_access_compat.html#deny">Deny</a></code>, +mais ce drapeau offre plus de souplesse dans l'attribution d'un statut +Forbidden.</p> + +<p>La règle suivante va interdire la téléchargement de fichiers +<code>.exe</code> depuis votre serveur.</p> + +<pre class="prettyprint lang-config">RewriteRule "\.exe" "-" [F]</pre> + + +<p>Cet exemple utilise la syntaxe "-" pour la cible de réécriture, ce +qui signifie que l'URI de la requête n'est pas modifié. Il n'y a aucune +raison de réécrire un URI, si vous avez l'intention d'interdire la +requête.</p> + +<p>Lorsqu'on utilise [F], [L] est implicite - c'est à dire que la +réponse est renvoyée immédiatement, et aucune autre règle n'est évaluée.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_g" id="flag_g">G|gone</a></h2> +<p>Le drapeau [G] permet de faire envoyer par le serveur un code de statut +"410 Gone" avec la réponse. Ce code indique qu'une ressource qui était +disponible auparavant ne l'est plus actuellement.</p> + +<p>Comme dans le cas du drapeau [F], on utilise en général la syntaxe +"-" pour la cible de réécriture lorsqu'on utilise le drapeau [G] :</p> + +<pre class="prettyprint lang-config">RewriteRule "oldproduct" "-" [G,NC]</pre> + + +<p>Lorsqu'on utilise [G], [L] est implicite - c'est à dire que la +réponse est renvoyée immédiatement, et aucune autre règle n'est évaluée.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_h" id="flag_h">H|handler</a></h2> +<p>Force le traitement de la requête résultante par le gestionnaire +spécifié. Par exemple, on peut utiliser ce drapeau pour forcer +l'interprétation de tous les fichiers sans extension par le gestionnaire +php :</p> + +<pre class="prettyprint lang-config">RewriteRule "!\." "-" [H=application/x-httpd-php]</pre> + + +<p> +L'expression rationnelle ci-dessus - <code>!\.</code> - correspond à +toute requête qui ne contient pas le caractère <code>.</code>. +</p> +<p>On peut aussi utiliser ce drapeau pour forcer l'utilisation d'un +certain gestionnaire en fonction de certaines conditions. Par exemple, +l'extrait suivant utilisé dans un contexte de niveau serveur permet de +faire en sorte que les fichiers <code>.php</code> soient +<em>affichés</em> par <code>mod_php</code> dans le cas où ils font +l'objet d'une requête avec l'extension <code>.phps</code> :</p> + +<pre class="prettyprint lang-config">RewriteRule "^(/source/.+\.php)s$" "$1" [H=application/x-httpd-php-source]</pre> + + + +<p>L'expression rationnelle ci-dessus - +<code>^(/source/.+\.php)s$</code> - va correspondre à toute requête qui +débutera par <code>/source/</code>, continuera par 1 ou n caractères +puis par <code>.phps</code>. La référence arrière $1 fait référence à la +correspondance capturée entre parenthèses de l'expression +rationnelle.</p> + + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_l" id="flag_l">L|last</a></h2> +<p>Lorsque le drapeau [L] est présent, <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> +arrête le traitement du jeu de règles. Cela signifie dans la plupart des +situations que si la règle s'applique, aucune autre règle ne sera +traitée. Ce drapeau correspond à la commande Perl <code>last</code>, ou +à la commande <code>break</code> en C. Utilisez ce drapeau pour indiquer +que la règle courante doit être appliquée immédiatement, sans tenir +compte des règles ultérieures.</p> + +<p>Si vous utilisez des règles <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> dans des fichiers +<code>.htaccess</code> ou des sections <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>, il est important d'avoir quelques +notions sur la manière dont les règles sont traitées. Pour simplifier, +une fois les règles traitées, la requête réécrite est passée à nouveau +au moteur d'interprétation des URLs afin que ce dernier puisse la +traiter. Il est possible qu'au cours du traitement de la requête +réécrite, le fichier <code>.htaccess</code> ou la section <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> soient à nouveau +rencontrés, entraînant un nouveau traitement du jeu de règles depuis le +début. Cette situation se présente le plus souvent lorsqu'une des règles +provoque une redirection - interne ou externe - ce qui réinitialise le +traitement de la requête.</p> + +<p>Si vous utilisez des directives <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> dans un de ces contextes, +il importe par conséquent de prévoir explicitement des étapes permettant +d'éviter un bouclage infini sur les règles, +et de ne pas compter seulement sur +le drapeau [L] pour terminer l'exécution d'une série de règles, comme +décrit ci-dessous.</p> + +<p>Un autre drapeau, [END], permet non seulement d'interrompre le cycle +courant du processus de réécriture, mais aussi d'empêcher toute +réécriture ultérieure dans le contexte de répertoire (htaccess). Ceci ne +s'applique pas aux nouvelles requêtes résultant de redirections +externes.</p> + +<p>Dans l'exemple donné ici, toute requête est réécrite en +<code>index.php</code>, la requête originale étant ajoutée comme chaîne +de requête en argument à <code>index.php</code> ; cependant, la +directive <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> permet de s'assurer que si +la requête concerne déjà <code>index.php</code>, la directive <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> sera sautée.</p> + +<pre class="prettyprint lang-config">RewriteBase "/" +RewriteCond "%{REQUEST_URI}" !=/index.php +RewriteRule "^(.*)" "/index.php?req=$1" [L,PT]</pre> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_n" id="flag_n">N|next</a></h2> +<p>Le drapeau [N] provoque un redémarrage du traitement des règles +depuis le début, en utilisant le résultat du jeu de règles, sous +réserve qu'il existe un point de démarrage ; à utiliser avec précautions +car il peut provoquer un bouclage infini. +</p> +<p> +Le drapeau [Next] peut servir, par exemple, +à remplacer de manière répétitive +une chaîne de caractère ou une lettre dans une requête. Dans l'exemple +suivant, chaque occurence de A sera remplacée par B dans la requête, et +ceci jusqu'il n'y ait plus de A à remplacer. +</p> + +<pre class="prettyprint lang-config">RewriteRule "(.*)A(.*)" "$1B$2" [N]</pre> + + +<p>Vous pouvez vous représenter ce traitement comme une boucle +<code>while</code> : tant que le modèle de la règle correspond (c'est à +dire, tant que l'URI contient un <code>A</code>), +effectuer la substitution (c'est à dire, remplacer le <code>A</code> par +un <code>B</code>).</p> + +<p>A partir de la version 2.4.8, ce module renvoie une erreur après +10000 itérations afin d'éviter les boucles infinies. Ce nombre maximum +d'itération peut être modifié via le drapeau N.</p> +<pre class="prettyprint lang-config"># On veut remplacer 1 caractère à chaque itération de la boucle +RewriteRule "(.+)[><;]$" "$1" [N=32000] +# ... ou s'arrêter après 10 itérations +RewriteRule "(.+)[><;]$" "$1" [N=10]</pre> + + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_nc" id="flag_nc">NC|nocase</a></h2> +<p>Avec le drapeau [NC], le modèle de la règle <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> est comparé à la requête de +manière insensible à la casse. C'est à dire que cette comparaison +s'effectue sans tenir compte des majuscules/minuscules dans l'URI +comparé.</p> + +<p>Dans l'exemple suivant, toute requête pour un fichier image sera +transmise par Apache à votre serveur d'images dédié. La correspondance est +insensible à la casse, si bien que par exemple, <code>.jpg</code> aussi +bien que <code>.JPG</code> seront acceptés.</p> + +<pre class="prettyprint lang-config">RewriteRule "(.*\.(jpg|gif|png))$" "http://images.example.com$1" [P,NC]</pre> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_ne" id="flag_ne">NE|noescape</a></h2> +<p>Par défaut, les caractères spéciaux, comme <code>&</code> et +<code>?</code>, sont convertis en leur équivalent hexadécimal pour les règles +qui génèrent des redirections externes. Le drapeau [NE] permet d'éviter cette +conversion.</p> + +<pre class="prettyprint lang-config">RewriteRule "^/anchor/(.+)" "/bigpage.html#$1" [NE,R]</pre> + + +<p> +Dans l'exemple ci-dessus, <code>/anchor/xyz</code> est réécrit en +<code>/bigpage.html#xyz</code>. En l'absence du drapeau [NE], le # +aurait été converti en son équivalent hexadécimal, <code>%23</code>, ce +qui aurait provoqué un code d'erreur "404 Not Found". +</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_ns" id="flag_ns">NS|nosubreq</a></h2> +<p>Le drapeau [NS] empêche la règle de s'appliquer aux sous-requêtes. +Par exemple, une page incluse au moyen d'une SSI (Server +Side Include) est une sous-requête, et vous ne voudrez probablement pas que +la réécriture s'applique à ces sous-requêtes. Ainsi, lorsque +<code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> recherche des informations à propos des +fichiers par défaut du répertoire (comme les fichiers +<code>index.html</code>), il s'agit d'une sous-requête interne, et vous +ne désirez en général pas que ces sous-requêtes soient réécrites. Cette +réécriture +n'est pas toujours utile pour les sous-requêtes, et peut même causer des +erreurs si l'ensemble du jeu de règles est appliqué. L'utilisation de +ce drapeau permet d'exclure les règles qui peuvent poser problème.</p> + +<p>Comment déterminer si vous devez utiliser cette règle ou non : si +vous préfixez les URLs avec des scripts CGI, afin de forcer leur +traitement par le script CGI, vous vous exposez à des problèmes (ou du +moins à une surcharge significative) avec les sous-requêtes. Dans ces +cas, vous devez utiliser ce drapeau.</p> + +<p> +Les images, scripts java, ou fichiers css, chargés en tant que partie +d'une page html, ne sont pas des sous-requêtes - le navigateur les +appelle sous forme de requêtes HTTP à part entière. +</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_p" id="flag_p">P|proxy</a></h2> +<p>L'utilisation du drapeau [P] entraîne le traitement de la requête par +le module <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, et ceci via une requête de +mandataire. Par exemple, si vous voulez que toutes les requêtes d'images +soient traitées par un serveur d'images annexe, vous pouvez utiliser +une règle de ce style :</p> + +<pre class="prettyprint lang-config">RewriteRule "/(.*)\.(jpg|gif|png)$" "http://images.example.com/$1.$2" [P]</pre> + + +<p>L'utilisation du drapeau [P] provoque aussi l'effet du drapeau [L] - +autrement dit, la requête est immédiatement envoyée au mandataire, et +toute règle ultérieure sera ignorée.</p> + +<p> +Vous devez vous assurer que la chaîne de substitution soit un URI valide +(commençant typiquement par <code>http://</code><em>nom-serveur</em>) +qui puisse être traitée par le module <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. Dans +le cas contraire, le module mandataire vous renverra une erreur. +L'utilisation de ce drapeau implémente de manière plus puissante la +directive <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code>, pour +faire correspondre le contenu distant à l'espace de nommage du serveur +local.</p> + +<div class="warning"> + <h3>Avertissement à propos de la sécurité</h3> + <p>Lors de la construction de l'URL cible de la règle, il convient + de prendre en compte l'impact en matière de sécurité qu'aura le + fait de permettre au client d'influencer le jeu d'URLs pour + lesquelles votre serveur agira en tant que mandataire. + Assurez-vous que la partie protocole://nom-serveur de l'URL soit + fixe, ou ne permette pas au client de l'influencer induement.</p> +</div> + +<div class="warning"> + <h3>Avertissement au sujet des performances</h3> + <p>Utiliser ce drapeau fait intervenir <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> sans la gestion des connexions + persistantes, ce qui signifie que vous obtiendrez des performances meilleurs si vous utilisez + <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> ou <code class="directive"><a href="../mod/mod_proxy.html#proxypassmatch">ProxyPassMatch</a></code>.</p> + <p>Ceci est du au fait que ce drapeau induit l'utilisation du worker par défaut, qui + ne gère pas la mise en commun et la réutilisation des connexions.</p> + <p>Partout où cela est possible, préférez l'utilisation de ces directives.</p> +</div> + +<p>Note: <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> doit être activé pour pouvoir +utiliser ce drapeau.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_pt" id="flag_pt">PT|passthrough</a></h2> + +<p> +Par défaut, la cible (ou chaîne de substitution) d'une règle +RewriteRule est sensée être un chemin de fichier. Avec le drapeau [PT], +par contre, elle est traitée comme un URI. Autrement dit, avec le +drapeau [PT], le résultat de la règle <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> est passé à nouveau au +système de mise en correspondance des URLs avec le système de fichiers, +de façon à ce que les systèmes de mise en correspondance basés sur les +chemins de fichiers, comme la directive <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>, ou <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>, par exemple, puissent avoir une +chance d'accomplir leur tâche. +</p> + +<p> +Si par exemple, vous avez un <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code> pour /icons, et une règle <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> qui renvoie vers /icons, +vous devez utiliser le drapeau [PT] pour être sûr que l'<code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code> sera bien évalué. +</p> + +<pre class="prettyprint lang-config">Alias "/icons" "/usr/local/apache/icons" +RewriteRule "/pics/(.+)\.jpg$" "/icons/$1.gif" [PT]</pre> + + +<p> +Dans l'exemple précédent, en l'absence du drapeau [PT], l'Alias aurait +été ignoré, ce qui aurait provoqué une erreur 'File not found'. +</p> + +<p>Avec le drapeau <code>PT</code>, le drapeau <code>L</code> est +implicite : la réécriture s'arrêtera afin de transmettre la requête à la +phase suivante du traitement.</p> + +<p>Notez que le drapeau <code>PT</code> est implicite dans des contextes +de répertoire comme les sections <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> ou les fichiers +<code>.htaccess</code>. Le seul moyen de contourner ceci consiste à +réécrire vers <code>-</code>.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_qsa" id="flag_qsa">QSA|qsappend</a></h2> +<p> +Quand l'URI de remplacement contient une chaîne de requête, le +comportement par défaut de la règle <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> est de supprimer la <code> +query string</code> (il s'agit des paramètres éventuellement passés dans l'URL après le +caractère <code>?</code>, usuellement pour les formulaires traités par la +méthode HTTP <code>GET</code>) existante, et de la remplacer par celle nouvellement créée. +Avec le drapeau [QSA], les chaînes de requête peuvent être combinées. +</p> + +<p>Considérons la règle suivante :</p> + +<pre class="prettyprint lang-config">RewriteRule "/pages/(.+)" "/page.php?page=$1" [QSA]</pre> + + +<p>Avec le drapeau [QSA], une requête pour +<code>/pages/123?one=two</code> sera réécrite en +<code>/page.php?page=123&one=two</code>. Sans le drapeau [QSA], la +même requête sera réécrite en <code>/page.php?page=123</code> - +autrement dit, la chaîne de requête (<code>query string</code>) existante sera supprimée. +</p> +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_qsd" id="flag_qsd">QSD|qsdiscard</a></h2> +<p> +Lorsque l'URI de la requête contient une chaîne de paramètres, et si +l'URI cible n'en contient pas, le comportement par défaut de la +directive <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> consiste à copier cette +chaîne de paramètres dans l'URI cible. Avec le drapeau [QSD], la chaîne +de paramètres est supprimée. +</p> + +<p>Ce drapeau est disponible dans les versions 2.4.0 et supérieures.</p> + +<p> +Lorsque les drapeaux [QSD] et [QSA] sont utilisés ensemble, c'est le +drapeau [QSD] qui l'emporte. +</p> + +<p> +Si l'URI cible possède une chaîne de paramètres, le comportement par +défaut sera respecté - c'est à dire que la chaîne de paramètres +originale sera supprimée et remplacée par la chaîne de paramètres de +l'URI cible. +</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_qsl" id="flag_qsl">QSL|qslast</a></h2> +<p> +Par défaut, le premier (le plus à gauche) point d'interrogation de la +substitution sépare le chemin de la requête de sa chaîne de paramètres. Avec le +drapeau [QSL] au contraire, les deux composants seront séparés en utilisant le +dernier (le plus à droite) point d'interrogation.</p> + +<p> +Cela peut s'avérer utile lorsqu'on recherche un fichier dont le nom contient des +points d'interrogation. Si aucune chaîne de paramètre n'est présente dans la +substitution, il est alors possible d'ajouter un point d'interrogation à la fin +et d'utiliser ce drapeau.</p> + +<p>Ce drapeau est disponible à partir de la version 2.4.19 du serveur HTTP +Apache.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_r" id="flag_r">R|redirect</a></h2> +<p> +L'utilisation du drapeau [R] provoque l'envoi d'une redirection au +navigateur. Si une URL pleinement qualifiée (FQDN - fully qualified domain name) + est spécifiée (c'est à dire incluant <code>http://nom-du-serveur/</code>), + une redirection sera effectuée vers cette adresse. Dans le cas contraire, + le protocole courant, le nom du serveur et le numéro de port seront + utilisés pour générer l'URL envoyée avec la redirection. +</p> + +<p><em>Tout</em> code de statut de réponse HTTP valide peut être +spécifié, en utilisant la syntaxe [R=305], le code de statut 302 étant +utilisé par défaut si aucun code n'est spécifié. Le code de statut +spécifié n'est pas nécessairement un code de statut +de redirection (3xx). Cependant, si le code de statut est en dehors de la plage des codes de +redirection (300-399), la chaîne de substitution est entièrement +supprimée, et la réécriture s'arrête comme si le drapeau <code>L</code> +était utilisé.</p> + +<p>En plus des codes de statut de réponse, vous pouvez spécifier les +codes de redirection en utilisant leurs noms symboliques : +<code>temp</code> (défaut), <code>permanent</code>, ou +<code>seeother</code>.</p> + +<p> +Vous utiliserez presque toujours [R] en conjonction avec [L] (c'est à +dire [R,L]), car employé seul, le drapeau [R] préfixe l'URI avec +<code>http://cet-hôte[:ce-port]</code>, mais passe ensuite cette adresse +à la règle suivante, ce qui provoquera le plus souvent des +avertissements 'Invalid URI in request'. +</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_s" id="flag_s">S|skip</a></h2> +<p>Le drapeau [S] sert à sauter des règles que vous ne voulez pas voir +exécuter. La syntaxe du drapeau [S] est [S=<em>N</em>], où +<em>N</em> correspond au nombre de règles à sauter (sous +réserve que la règle <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> corresponde et qu'au moins +une condition <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> +préalable soit vérifiée). +Ceci peut s'interpréter comme une instruction +<code>goto</code> dans votre jeu de règles de réécriture. Dans +l'exemple suivant, nous ne voulons exécuter la règle <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> que si l'URI demandé ne +correspond pas à un fichier existant.</p> +<pre class="prettyprint lang-config"># La requête concerne-t-elle un fichier qui n'existe pas ? +RewriteCond "%{REQUEST_FILENAME}" !-f +RewriteCond "%{REQUEST_FILENAME}" !-d +# Si c'est la cas, on saute les deux règles de réécriture suivantes +RewriteRule ".?" "-" [S=2] + +RewriteRule "(.*\.gif)" "images.php?$1" +RewriteRule "(.*\.html)" "docs.php?$1"</pre> + + + + +<p>Cette technique trouve son utilité dans le fait qu'une directive +<code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> ne s'applique +qu'à la règle qui la suit immédiatement. Ainsi, si vous voulez +qu'une directive <code>RewriteCond</code> s'applique à plusieurs règles +<code>RewriteRule</code>, une technique possible consiste à inverser ces +conditions et ajouter une <code>RewriteRule</code> avec le drapeau [Skip]. Cette technique permet +d'élaborer des pseudo-constructions if-then-else : la dernière règle du +bloc then contiendra <code>skip=N</code>, où N est le nombre de règles +contenues dans le bloc else :</p> +<pre class="prettyprint lang-config"># Est-ce que le fichier existe ? +RewriteCond "%{REQUEST_FILENAME}" !-f +RewriteCond "%{REQUEST_FILENAME}" !-d +# Créer une structure conditionnelle if-then-else en sautant 3 lignes si nous +# avions l'intention d'aller au bloc "else". +RewriteRule ".?" "-" [S=3] + +# Si le fichier existe, alors : + RewriteRule "(.*\.gif)" "images.php?$1" + RewriteRule "(.*\.html)" "docs.php?$1" + # Passer le bloc "else". + RewriteRule ".?" "-" [S=1] +# ELSE... + RewriteRule "(.*)" "404.php?file=$1" +# END</pre> + + +<p>Il est probablement plus aisé de définir ce genre de configuration +via les directives <code class="directive"><If></code>, <code class="directive"><ElseIf></code>, et <code class="directive"><Else></code>.</p> + +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="section"> +<h2><a name="flag_t" id="flag_t">T|type</a></h2> +<p>Définit le type MIME de la réponse résultante renvoyée. L'effet est +identique à celui de la directive <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code>.</p> + +<p>Par exemple, vous pouvez utiliser la technique suivante pour servir +du code source Perl en tant que plein texte, s'il est requis d'une +certaine manière :</p> + +<pre class="prettyprint lang-config"># Sert les fichier .pl en tant que plein texte +RewriteRule "\.pl$" "-" [T=text/plain]</pre> + + +<p>Ou encore, si vous possédez une caméra qui produit des fichiers +images jpeg sans extension, vous pouvez forcer le renvoi de ces images +avec le type MIME correct en se basant sur le nom du fichier :</p> + +<pre class="prettyprint lang-config"># Les fichiers dont le nom contient 'IMG' sont des images jpg. +RewriteRule "IMG" "-" [T=image/jpg]</pre> + + +<p>Notez cependant qu'il s'agit d'un exemple trivial, et que le problème +aurait pu être résolu en utilisant à la place la directive <code class="directive"><a href="../mod/core.html#filesmatch"><FilesMatch></a></code>. Il faut toujours +envisager la possibilité d'une solution alternative à un problème avant +d'avoir recours à la réécriture, qui sera toujours moins efficace qu'une +solution alternative.</p> + +<p> +Dans un contexte de niveau répertoire, n'utilisez que <code>-</code> +(tiret) comme substitution, <em>dans toute la séquence de réécriture de +mod_rewrite</em>, sinon le type MIME défini avec ce drapeau +sera perdu suite à un retraitement interne (y compris les séquences de +réécriture suivantes de mod_rewrite). Dans ce contexte, vous pouvez +utiliser le drapeau <code>L</code> pour terminer la séquence +<em>courante</em> de réécriture de mod_rewrite.</p> + +</div></div> +<div class="bottomlang"> +<p><span>Langues Disponibles: </span><a href="../en/rewrite/flags.html" hreflang="en" rel="alternate" title="English"> en </a> | +<a href="../fr/rewrite/flags.html" title="Français"> fr </a></p> +</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">Commentaires</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div> +<script type="text/javascript"><!--//--><![CDATA[//><!-- +var comments_shortname = 'httpd'; +var comments_identifier = 'http://httpd.apache.org/docs/2.4/rewrite/flags.html'; +(function(w, d) { + if (w.location.hostname.toLowerCase() == "httpd.apache.org") { + d.write('<div id="comments_thread"><\/div>'); + var s = d.createElement('script'); + s.type = 'text/javascript'; + s.async = true; + s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; + (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); + } + else { + d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); + } +})(window, document); +//--><!]]></script></div><div id="footer"> +<p class="apache">Copyright 2023 The Apache Software Foundation.<br />Autorisé sous <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> +<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossaire</a> | <a href="../sitemap.html">Plan du site</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- +if (typeof(prettyPrint) !== 'undefined') { + prettyPrint(); +} +//--><!]]></script> +</body></html>
\ No newline at end of file |