mod_substitute.html.en revision f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd This file is generated from xml source: DO NOT EDIT
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
2e545ce2450a9953665f701bb05350f0d3f26275nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<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.3</a> > <a href="./">Modules</a></div>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<p><span>Available Languages: </span><a href="/en/mod/mod_substitute.html" title="English"> en </a></p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<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>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>substitute_module</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_substitute.c</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.2.7 and later</td></tr></table>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p><code class="module"><a href="/mod/mod_substitute.html">mod_substitute</a></code> provides a mechanism to perform
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd both regular expression and fixed string substitutions on
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd response bodies.</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div id="quickview"><h3 class="directives">Directives</h3>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<li><img alt="" src="/images/down.gif" /> <a href="#substitute">Substitute</a></li>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div class="directive-section"><h2><a name="Substitute" id="Substitute">Substitute</a> <a name="substitute" id="substitute">Directive</a></h2>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pattern to filter the response content</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Substitute <var>s/pattern/substitution/[infq]</var></code></td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_substitute</td></tr>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri <p>The <code class="directive">Substitute</code> directive specifies a
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd search and replace pattern to apply to the response body.</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>The meaning of the pattern can be modified by using any
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd combination of these flags:</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <dd>By default the pattern is treated as a regular expression.
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar Using the <code>n</code> flag forces the pattern to be treated
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar as a fixed string.</dd>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <dd>The <code>f</code> flag causes mod_substitute to flatten the
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar result of a substitution allowing for later substitutions to
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar take place on the boundary of this one. This is the default.</dd>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <dd>The <code>q</code> flag causes mod_substitute to not
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar flatten the buckets after each substitution. This can
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar result in much faster response and a decrease in memory
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar utilization, but should only be used if there is no possibility
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar that the result of one substitution will ever match a pattern
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar or regex of a subsequent one.</dd>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <Location />
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar </Location>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <p>If either the pattern or the substitution contain a slash
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar character then an alternative delimiter should be used:</p>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <div class="example"><h3>Example of using an alternate delimiter</h3><p><code>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <Location />
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar Substitute "s|<BR */?>|<br />|i"
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar </Location>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <p>Backreferences can be used in the comparison and in the substitution,
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar when regular expressions are used, as illustrated in the following example: </p>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <div class="example"><h3>Example of using backreferences and captures</h3><p><code>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <Location />
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd </Location>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>A common use scenario for <code>mod_substitute</code> is the
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd situation in which a front-end server proxies requests to a back-end
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd server which returns HTML with hard-coded embedded URLs that refer
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd to the back-end server. These URLs don't work for the end-user,
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd since the back-end server is unreachable.</p>
722c4c7fb902aaea0d89d2ec1734869430558cc3nd <p>In this case, <code>mod_substutite</code> can be used to rewrite
722c4c7fb902aaea0d89d2ec1734869430558cc3nd those URLs into something that will work from the front end:</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <div class="example"><h3>Rewriting URLs embedded in proxied content</h3><p><code>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd ProxyPassReverse /blog/ http://internal.blog.example.com/<br />
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd Substitute "s|http://internal.blog.example.com/|http://www.example.com/blog/|i"
20f499565e77defe9dab24dd85c02f38a1175855nd <p><code class="directive"><a href="/mod/mod_proxy.html#proxypassreverse">ProxyPassReverse</a></code>
e487d6c09669296f94a5190cc34586a98e624a00nd modifies any <code>Location</code> (redirect) headers that are sent
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd by the back-end server, and, in this example,
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <code>Substitute</code> takes care of the rest of the problem by
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd fixing up the HTML response as well.</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<p><span>Available Languages: </span><a href="/en/mod/mod_substitute.html" title="English"> en </a></p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<p class="apache">Copyright 2011 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>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>