mirror of
https://github.com/apache/httpd.git
synced 2025-07-19 02:42:17 +03:00
5e8ac7dd19
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96159 13f79535-47bb-0310-9956-ffa450edef68
183 lines
14 KiB
Plaintext
183 lines
14 KiB
Plaintext
<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
|
|
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
This file is generated from xml source: DO NOT EDIT
|
|
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
--><title>mod_setenvif- Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_setenvif</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap" valign="top"><span class="help">Description:</span></td><td>Allows the setting of environment variables based
|
|
on characteristics of the request</td></tr><tr><td nowrap="nowrap"><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td nowrap="nowrap"><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>setenvif_module</td></tr></table></td></tr></table><h2>Summary</h2>
|
|
|
|
<p>The <code><a href="../mod/mod_setenvif.html">mod_setenvif</a></code> module allows you to set
|
|
environment variables according to whether different aspects of
|
|
the request match regular expressions you specify. These
|
|
environment variables can be used by other parts of the server
|
|
to make decisions about actions to be taken.</p>
|
|
|
|
<p>The directives are considered in the order they appear in
|
|
the configuration files. So more complex sequences can be used,
|
|
such as this example, which sets <code>netscape</code> if the
|
|
browser is mozilla but not MSIE.</p>
|
|
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
BrowserMatch ^Mozilla netscape<br>
|
|
BrowserMatch MSIE !netscape<br>
|
|
</code></td></tr></table></blockquote>
|
|
<h2>Directives</h2><ul><li><a href="#browsermatch">BrowserMatch</a></li><li><a href="#browsermatchnocase">BrowserMatchNoCase</a></li><li><a href="#setenvif">SetEnvIf</a></li><li><a href="#setenvifnocase">SetEnvIfNoCase</a></li></ul><p><strong>See also </strong></p><ul><li><a href="../env.html">Environment Variables in Apache</a></li></ul><hr/><h2><a name="BrowserMatch">BrowserMatch</a> <a name="browsermatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Sets environment variables conditional on HTTP User-Agent
|
|
</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>BrowserMatch <em>regex [!]env-variable</em>[=<em>value</em>]
|
|
[[!]<em>env-variable</em>[=<em>value</em>]] ...</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td></tr></table></td></tr></table>
|
|
<p>The <code class="directive">BrowserMatch</code> is a special cases of the
|
|
<a href="#setenvif" class="directive"><code class="directive">SetEnvIf</code></a> directive that
|
|
sets environment variables conditional on the
|
|
<code>User-Agent</code> HTTP request header. The following two
|
|
lines have the same effect:</p>
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
BrowserMatchNoCase Robot is_a_robot<br>
|
|
SetEnvIfNoCase User-Agent Robot is_a_robot<br>
|
|
</code></td></tr></table></blockquote>
|
|
|
|
<p>Some additional examples:</p>
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
BrowserMatch ^Mozilla forms jpeg=yes browser=netscape<br>
|
|
BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript<br>
|
|
BrowserMatch MSIE !javascript<br>
|
|
</code></td></tr></table></blockquote>
|
|
<hr/><h2><a name="BrowserMatchNoCase">BrowserMatchNoCase</a> <a name="browsermatchnocase">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Sets environment variables conditional on User-Agent without
|
|
respect to case</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>BrowserMatchNoCase <em>regex [!]env-variable</em>[=<em>value</em>]
|
|
[[!]<em>env-variable</em>[=<em>value</em>]] ...</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td></tr><tr><td nowrap="nowrap" align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.2 and
|
|
above (in Apache 1.2 this directive was found in the
|
|
now-obsolete mod_browser module)</td></tr></table></td></tr></table>
|
|
|
|
<p>The <code class="directive">BrowserMatchNoCase</code> directive is
|
|
semantically identical to the <a href="#browsermatch" class="directive"><code class="directive">BrowserMatch</code></a> directive.
|
|
However, it provides for case-insensitive matching. For
|
|
example:</p>
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
BrowserMatchNoCase mac platform=macintosh<br>
|
|
BrowserMatchNoCase win platform=windows<br>
|
|
</code></td></tr></table></blockquote>
|
|
|
|
<p>The <code class="directive">BrowserMatch</code> and
|
|
<code class="directive">BrowserMatchNoCase</code> directives are special cases of
|
|
the <a href="#setenvif" class="directive"><code class="directive">SetEnvIf</code></a> and <a href="#setenvifnocase" class="directive"><code class="directive">SetEnvIfNoCase</code></a>
|
|
directives. The following two lines have the same effect:</p>
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
BrowserMatchNoCase Robot is_a_robot<br>
|
|
SetEnvIfNoCase User-Agent Robot is_a_robot<br>
|
|
</code></td></tr></table></blockquote>
|
|
<hr/><h2><a name="SetEnvIf">SetEnvIf</a> <a name="setenvif">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Sets environment variables based on attributes of the request
|
|
</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>SetEnvIf <em>attribute
|
|
regex [!]env-variable</em>[=<em>value</em>]
|
|
[[!]<em>env-variable</em>[=<em>value</em>]] ...</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td></tr></table></td></tr></table>
|
|
<p>The <code class="directive">SetEnvIf</code> directive defines
|
|
environment variables based on attributes of the request. The
|
|
<em>attribute</em> specified in the first argument can be one of three
|
|
things:</p>
|
|
|
|
<ol>
|
|
<li>An HTTP request header field (see <a href="http://www.rfc-editor.org/rfc/rfc2616.txt">RFC2616</a>
|
|
for more information about these); for example: <code>Host</code>,
|
|
<code>User-Agent</code>, <code>Referer</code>, and
|
|
<code>Accept-Language</code>. A regular expression may be
|
|
used to specify a set of request headers.</li>
|
|
|
|
<li>One of the following aspects of the request:
|
|
<ul>
|
|
<li><code>Remote_Host</code> - the hostname (if available) of
|
|
the client making the request</li>
|
|
|
|
<li><code>Remote_Addr</code> - the IP address of the client
|
|
making the request</li>
|
|
|
|
<li><code>Remote_User</code> - the authenticated username (if
|
|
available)</li>
|
|
|
|
<li><code>Request_Method</code> - the name of the method
|
|
being used (<code>GET</code>, <code>POST</code>, <em>et
|
|
cetera</em>)</li>
|
|
|
|
<li><code>Request_Protocol</code> - the name and version of
|
|
the protocol with which the request was made (<em>e.g.</em>,
|
|
"HTTP/0.9", "HTTP/1.1", <em>etc.</em>)</li>
|
|
|
|
<li><code>Request_URI</code> - the resource requested on the HTTP
|
|
request line -- generally the portion of the URL
|
|
following the scheme and host portion without the query string</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>The name of an environment variable in the list of those
|
|
associated with the request. This allows
|
|
<code class="directive">SetEnvIf</code> directives to test against the result
|
|
of prior matches. Only those environment variables defined by earlier
|
|
<code>SetEnvIf[NoCase]</code> directives are available for testing in
|
|
this manner. 'Earlier' means that they were defined at a broader scope
|
|
(such as server-wide) or previously in the current directive's scope.
|
|
Environment variables will be considered only if there was no match
|
|
among request characteristics and a regular expression was not
|
|
used for the <em>attribute</em>.</li>
|
|
</ol>
|
|
|
|
<p>The second argument (<em>regex</em>) is a <a href="http://www.pcre.org/">Perl compatible regular expression</a>.
|
|
This is similar to a POSIX.2 egrep-style regular expression.
|
|
If the <em>regex</em> matches against the <em>attribute</em>,
|
|
then the remainder of the arguments are evaluated.</p>
|
|
|
|
<p>The rest of the arguments give the names of variables to set, and
|
|
optionally values to which they should be set. These take the form
|
|
of</p>
|
|
|
|
<ol>
|
|
<li><code><em>varname</em></code>, or</li>
|
|
|
|
<li><code>!<em>varname</em></code>, or</li>
|
|
|
|
<li><code><em>varname</em>=<em>value</em></code></li>
|
|
</ol>
|
|
|
|
<p>In the first form, the value will be set to "1". The second
|
|
will remove the given variable if already defined, and the
|
|
third will set the variable to the literal value given by
|
|
<code><em>value</em></code>.</p>
|
|
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example:</strong></p><code>
|
|
|
|
SetEnvIf Request_URI "\.gif$" object_is_image=gif<br>
|
|
SetEnvIf Request_URI "\.jpg$" object_is_image=jpg<br>
|
|
SetEnvIf Request_URI "\.xbm$" object_is_image=xbm<br>
|
|
:<br>
|
|
SetEnvIf Referer www\.mydomain\.com intra_site_referral<br>
|
|
:<br>
|
|
SetEnvIf object_is_image xbm XBIT_PROCESSING=1<br>
|
|
:<br>
|
|
SetEnvIf ^TS* ^[a-z].* HAVE_TS<br>
|
|
</code></td></tr></table></blockquote>
|
|
|
|
<p>The first three will set the environment variable
|
|
<code>object_is_image</code> if the request was for an image
|
|
file, and the fourth sets <code>intra_site_referral</code> if
|
|
the referring page was somewhere on the
|
|
<code>www.mydomain.com</code> Web site.</p>
|
|
|
|
<p>The last example will set environment variable
|
|
<code>HAVE_TS</code> if the request contains any headers that
|
|
begin with "TS" whose values begins with any character in the
|
|
set [a-z].</p>
|
|
<p><strong>See also </strong></p><ul><li><a href="../env.html">Environment Variables in Apache</a>,
|
|
for additional examples.
|
|
</li></ul><hr/><h2><a name="SetEnvIfNoCase">SetEnvIfNoCase</a> <a name="setenvifnocase">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Sets environment variables based on attributes of the request
|
|
without respect to case</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>SetEnvIfNoCase <em>attribute regex
|
|
[!]env-variable</em>[=<em>value</em>]
|
|
[[!]<em>env-variable</em>[=<em>value</em>]] ...</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td></tr><tr><td nowrap="nowrap" align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.3 and above</td></tr></table></td></tr></table>
|
|
|
|
<p>The <code class="directive">SetEnvIfNoCase</code> is semantically identical to
|
|
the <a href="#setenvif" class="directive"><code class="directive">SetEnvIf</code></a> directive,
|
|
and differs only in that the regular expression matching is
|
|
performed in a case-insensitive manner. For example:</p>
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
SetEnvIfNoCase Host Apache\.Org site=apache
|
|
</code></td></tr></table></blockquote>
|
|
|
|
<p>This will cause the <code>site</code> environment variable
|
|
to be set to "<code>apache</code>" if the HTTP request header
|
|
field <code>Host:</code> was included and contained
|
|
<code>Apache.Org</code>, <code>apache.org</code>, or any other
|
|
combination.</p>
|
|
<hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="../images/index.gif" alt="Index"/></a><a href="../"><img src="../images/home.gif" alt="Home"/></a></body></html> |