manual/mod/mod_substitute.html.en

	mod_substitute.html.en revision 7f0952c0239ea2d6e37b472db6fde4ef2718343d
2d0611ffc9f91c5fc2ddccb93f9a3d17791ae650takashi<?xml version="1.0" encoding="ISO-8859-1"?>
2d0611ffc9f91c5fc2ddccb93f9a3d17791ae650takashi<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd              This file is generated from xml source: DO NOT EDIT
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd      -->
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd<title>mod_substitute - Apache HTTP Server</title>
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd<body>
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd<div id="page-header">
cd7c928b185ceb2b481d1149dd90f0fc40f83da1nd<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>
cd7c928b185ceb2b481d1149dd90f0fc40f83da1nd<p class="apache">Apache HTTP Server Version 2.3</p>
cd7c928b185ceb2b481d1149dd90f0fc40f83da1nd<img alt="" src="/images/feather.gif" /></div>
cd7c928b185ceb2b481d1149dd90f0fc40f83da1nd<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
6ae232055d4d8a97267517c5e50074c2c819941and<div id="path">
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
6ae232055d4d8a97267517c5e50074c2c819941and<div id="page-content">
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd<div id="preamble"><h1>Apache Module mod_substitute</h1>
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd<div class="toplang">
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd<p><span>Available Languages: </span><a href="/en/mod/mod_substitute.html" title="English">&nbsp;en&nbsp;</a></p>
dc0d8d65d35787d30a275895ccad8d8e1b58a5ednd</div>
d80509b9594c1cd4ae2cfb4bb5c416a25d27b150pctony<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>
d80509b9594c1cd4ae2cfb4bb5c416a25d27b150pctony<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
d80509b9594c1cd4ae2cfb4bb5c416a25d27b150pctony<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>substitute_module</td></tr>
d80509b9594c1cd4ae2cfb4bb5c416a25d27b150pctony<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_substitute.c</td></tr>
<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>
<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>
</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 mod_substitute 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 mod_substitute 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><p><code>
        &lt;Location /&gt;
        <span class="indent">
            AddOutputFilterByType SUBSTITUTE text/html<br />
            Substitute s/foo/bar/ni<br />
        </span>
        &lt;/Location&gt;
    </code></p></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><p><code>
        &lt;Location /&gt;
        <span class="indent">
            AddOutputFilterByType SUBSTITUTE text/html<br />
            Substitute "s|&lt;BR */?&gt;|&lt;br /&gt;|i"
        </span>
        &lt;/Location&gt;
    </code></p></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><p><code>
        &lt;Location /&gt;
        <span class="indent">
            AddOutputFilterByType SUBSTITUTE text/html<br />
            # "foo=k,bar=k" -&gt; "foo/bar=k" <br />
            Substitute "s|foo=(\w+),bar=\1|foo/bar=$1"
        </span>
        &lt;/Location&gt;
    </code></p></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_substutite</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><p><code>
    ProxyPass /blog/ http://internal.blog.example.com<br />
    ProxyPassReverse /blog/ http://internal.blog.example.com/<br />
    <br />
    Substitute "s|http://internal.blog.example.com/|http://www.example.com/blog/|i"
    </code></p></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>Substitute</code> takes care of the rest of the problem by
    fixing up the HTML response as well.</p>


</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/mod/mod_substitute.html" title="English">&nbsp;en&nbsp;</a></p>
</div><div id="footer">
<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>
<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>
</body></html>