mirror of
https://github.com/apache/httpd.git
synced 2025-11-03 17:53:20 +03:00
deefba6cfc
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1782247 13f79535-47bb-0310-9956-ffa450edef68
217 lines
14 KiB
XML
217 lines
14 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||
<!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=ISO-8859-1" http-equiv="Content-Type" />
|
||
<!--
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
This file is generated from xml source: DO NOT EDIT
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
-->
|
||
<title>mod_substitute - Apache HTTP Server Version 2.5</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>
|
||
<div id="page-header">
|
||
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
|
||
<p class="apache">Apache HTTP Server Version 2.5</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.5</a> > <a href="./">Modules</a></div>
|
||
<div id="page-content">
|
||
<div id="preamble"><h1>Apache Module mod_substitute</h1>
|
||
<div class="toplang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_substitute.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_substitute.html" hreflang="fr" rel="alternate" title="Fran<61>ais"> fr </a></p>
|
||
</div>
|
||
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Perform search and replace operations on response bodies</td></tr>
|
||
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="module-dict.html#ModuleIdentifier">Module<EFBFBD>Identifier:</a></th><td>substitute_module</td></tr>
|
||
<tr><th><a href="module-dict.html#SourceFile">Source<EFBFBD>File:</a></th><td>mod_substitute.c</td></tr></table>
|
||
<h3>Summary</h3>
|
||
|
||
<p><code class="module"><a href="../mod/mod_substitute.html">mod_substitute</a></code> provides a mechanism to perform
|
||
both regular expression and fixed string substitutions on
|
||
response bodies.</p>
|
||
</div>
|
||
<div id="quickview"><h3 class="directives">Directives</h3>
|
||
<ul id="toc">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#substitute">Substitute</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#substituteinheritbefore">SubstituteInheritBefore</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#substitutemaxlinelength">SubstituteMaxLineLength</a></li>
|
||
</ul>
|
||
<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_substitute">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_substitute">Report a bug</a></li></ul><h3>See also</h3>
|
||
<ul class="seealso">
|
||
<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="directive-section"><h2><a name="Substitute" id="Substitute">Substitute</a> <a name="substitute" id="substitute">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pattern to filter the response content</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Substitute <var>s/pattern/substitution/[infq]</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_substitute</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">Substitute</code> directive specifies a
|
||
search and replace pattern to apply to the response body.</p>
|
||
|
||
<p>The meaning of the pattern can be modified by using any
|
||
combination of these flags:</p>
|
||
|
||
<dl>
|
||
<dt><code>i</code></dt>
|
||
<dd>Perform a case-insensitive match.</dd>
|
||
<dt><code>n</code></dt>
|
||
<dd>By default the pattern is treated as a regular expression.
|
||
Using the <code>n</code> flag forces the pattern to be treated
|
||
as a fixed string.</dd>
|
||
<dt><code>f</code></dt>
|
||
<dd>The <code>f</code> flag causes <code>mod_substitute</code> to flatten the
|
||
result of a substitution allowing for later substitutions to
|
||
take place on the boundary of this one. This is the default.</dd>
|
||
<dt><code>q</code></dt>
|
||
<dd>The <code>q</code> flag causes <code>mod_substitute</code> to not
|
||
flatten the buckets after each substitution. This can
|
||
result in much faster response and a decrease in memory
|
||
utilization, but should only be used if there is no possibility
|
||
that the result of one substitution will ever match a pattern
|
||
or regex of a subsequent one.</dd>
|
||
</dl>
|
||
|
||
<div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><Location "/">
|
||
AddOutputFilterByType SUBSTITUTE text/html
|
||
Substitute "s/foo/bar/ni"
|
||
</Location></pre>
|
||
</div>
|
||
|
||
<p>If either the pattern or the substitution contain a slash
|
||
character then an alternative delimiter should be used:</p>
|
||
|
||
<div class="example"><h3>Example of using an alternate delimiter</h3><pre class="prettyprint lang-config"><Location "/">
|
||
AddOutputFilterByType SUBSTITUTE text/html
|
||
Substitute "s|<BR */?>|<br />|i"
|
||
</Location></pre>
|
||
</div>
|
||
|
||
<p>Backreferences can be used in the comparison and in the substitution,
|
||
when regular expressions are used, as illustrated in the following example: </p>
|
||
<div class="example"><h3>Example of using backreferences and captures</h3><pre class="prettyprint lang-config"><Location "/">
|
||
AddOutputFilterByType SUBSTITUTE text/html
|
||
# "foo=k,bar=k" -> "foo/bar=k"
|
||
Substitute "s|foo=(\w+),bar=\1|foo/bar=$1"
|
||
</Location></pre>
|
||
</div>
|
||
|
||
<p>A common use scenario for <code>mod_substitute</code> is the
|
||
situation in which a front-end server proxies requests to a back-end
|
||
server which returns HTML with hard-coded embedded URLs that refer
|
||
to the back-end server. These URLs don't work for the end-user,
|
||
since the back-end server is unreachable.</p>
|
||
|
||
<p>In this case, <code>mod_substitute</code> can be used to rewrite
|
||
those URLs into something that will work from the front end:</p>
|
||
|
||
<div class="example"><h3>Rewriting URLs embedded in proxied content</h3><pre class="prettyprint lang-config">ProxyPass "/blog/" "http://internal.blog.example.com"
|
||
ProxyPassReverse "/blog/" "http://internal.blog.example.com/"
|
||
|
||
Substitute "s|http://internal.blog.example.com/|http://www.example.com/blog/|i"</pre>
|
||
</div>
|
||
|
||
<p><code class="directive"><a href="../mod/mod_proxy.html#proxypassreverse">ProxyPassReverse</a></code>
|
||
modifies any <code>Location</code> (redirect) headers that are sent
|
||
by the back-end server, and, in this example,
|
||
<code class="directive">Substitute</code> takes care of the rest of the problem by
|
||
fixing up the HTML response as well.</p>
|
||
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="SubstituteInheritBefore" id="SubstituteInheritBefore">SubstituteInheritBefore</a> <a name="substituteinheritbefore" id="substituteinheritbefore">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Change the merge order of inherited patterns</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SubstituteInheritBefore on|off</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SubstituteInheritBefore on</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_substitute</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.17 and later</td></tr>
|
||
</table>
|
||
<p>Whether to apply the inherited <code class="directive"><a href="#substitute">Substitute</a></code>
|
||
patterns first (<code>on</code>), or after the ones of the current
|
||
context (<code>off</code>).
|
||
The latter was the default in versions 2.4 and earlier, but changed
|
||
starting with 2.5, hence <code class="directive">SubstituteInheritBefore</code>
|
||
set to <code>off</code> allows to restore the legacy behaviour.
|
||
<code class="directive">SubstituteInheritBefore</code> is itself inherited,
|
||
hence contexts that inherit it (those that don't specify their own
|
||
<code class="directive">SubstituteInheritBefore</code> value) will apply the
|
||
closest defined merge order.</p>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="SubstituteMaxLineLength" id="SubstituteMaxLineLength">SubstituteMaxLineLength</a> <a name="substitutemaxlinelength" id="substitutemaxlinelength">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the maximum line size</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SubstituteMaxLineLength <var>bytes</var>(b|B|k|K|m|M|g|G)</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SubstituteMaxLineLength 1m</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_substitute</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.11 and later</td></tr>
|
||
</table>
|
||
<p>The maximum line size handled by <code class="module"><a href="../mod/mod_substitute.html">mod_substitute</a></code>
|
||
is limited to restrict memory use. The limit can be configured
|
||
using <code class="directive">SubstituteMaxLineLength</code>.
|
||
The value can be given as the number of bytes and can be suffixed
|
||
with a single letter <code>b</code>, <code>B</code>, <code>k</code>,
|
||
<code>K</code>, <code>m</code>, <code>M</code>, <code>g</code>,
|
||
<code>G</code> to provide the size in bytes, kilobytes, megabytes
|
||
or gigabytes respectively.</p>
|
||
|
||
<div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><Location "/">
|
||
AddOutputFilterByType SUBSTITUTE text/html
|
||
SubstituteMaxLineLength 10m
|
||
Substitute "s/foo/bar/ni"
|
||
</Location></pre>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bottomlang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_substitute.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_substitute.html" hreflang="fr" rel="alternate" title="Fran<61>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 again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
|
||
<script type="text/javascript"><!--//--><![CDATA[//><!--
|
||
var comments_shortname = 'httpd';
|
||
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_substitute.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 2017 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/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
|
||
if (typeof(prettyPrint) !== 'undefined') {
|
||
prettyPrint();
|
||
}
|
||
//--><!]]></script>
|
||
</body></html> |