1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<?xml version="1.0" ?>
<!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">
<head>
<title>nginx_substitutions_filter</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#nginx_substitutions_filter">nginx_substitutions_filter</a></li>
<ul>
<li><a href="#description">Description</a></li>
<li><a href="#example">Example</a></li>
<li><a href="#directives">Directives</a></li>
<ul>
<li><a href="#subs_filter_types">subs_filter_types</a></li>
<li><a href="#subs_filter">subs_filter</a></li>
<li><a href="#subs_filter_bypass">subs_filter_bypass</a></li>
</ul>
<li><a href="#installation">Installation</a></li>
<li><a href="#known_issue">Known issue</a></li>
<li><a href="#changes">CHANGES</a></li>
<li><a href="#reporting_a_bug">Reporting a bug</a></li>
</ul>
</ul>
<!-- INDEX END -->
<hr />
<p>
</p>
<h1><a name="nginx_substitutions_filter">nginx_substitutions_filter</a></h1>
<p><em>Note: this module is not distributed with the Nginx source. Installation instructions can be found <a href="#installation">below</a>. </em>></p>
<p>
</p>
<h2><a name="description">Description</a></h2>
<p><strong>nginx_substitutions_filter</strong> is a filter module which can do both regular expression and fixed string substitutions on response bodies. This module is quite different from the Nginx's native Substitution Module. It scans the output chains buffer and matches string line by line, just like Apache's mod_substitute (<a href="http://httpd.apache.org/docs/trunk/mod/mod_substitute.html">http://httpd.apache.org/docs/trunk/mod/mod_substitute.html</a>).</p>
<p>
</p>
<h2><a name="example">Example</a></h2>
<p>location / {</p>
<pre>
subs_filter_types text/html text/css text/xml;
subs_filter st(\d*).example.com $1.example.com ir;
subs_filter a.example.com s.example.com;</pre>
<p>}</p>
<p>
</p>
<h2><a name="directives">Directives</a></h2>
<ul>
<li>
<p><a href="#subs_filter_types">subs_filter_types</a></p>
</li>
<li>
<p><a href="#subs_filter">subs_filter</a></p>
</li>
</ul>
<p>
</p>
<h3><a name="subs_filter_types">subs_filter_types</a></h3>
<p><strong>syntax:</strong> <em>subs_filter_types mime-type [mime-types] </em></p>
<p><strong>default:</strong> <em>subs_filter_types text/html</em></p>
<p><strong>context:</strong> <em>http, server, location</em></p>
<p><em>subs_filter_types</em> is used to specify which content types should be checked for <em>subs_filter</em>. The default is only <em>text/html</em>.</p>
<p>This module just works with plain text. If the response is compressed, it can't uncompress the response and will ignore this response. This module can be compatible with gzip filter module. But it will not work with proxy compressed response. You can disable the compressed response like this:</p>
<p>proxy_set_header Accept-Encoding ``'';</p>
<p>
</p>
<h3><a name="subs_filter">subs_filter</a></h3>
<p><strong>syntax:</strong> <em>subs_filter source_str destination_str [gior] </em></p>
<p><strong>default:</strong> <em>none</em></p>
<p><strong>context:</strong> <em>http, server, location</em></p>
<p><em>subs_filter</em> allows replacing source string(regular expression or fixed) in the nginx response with destination string. Substitution text may contain variables. More than one substitution rules per location is supported. The meaning of the third flags are:</p>
<ul>
<li>
<p><em>g</em>(default): Replace all the match strings.</p>
</li>
<li>
<p><em>i</em>: Perform a case-insensitive match.</p>
</li>
<li>
<p><em>o</em>: Just replace the first one.</p>
</li>
<li>
<p><em>r</em>: The pattern is treated as a regular expression, default is fixed string.</p>
</li>
</ul>
<p>
</p>
<h3><a name="subs_filter_bypass">subs_filter_bypass</a></h3>
<p><strong>syntax:</strong> <em>subs_filter_bypass $variable1 ...</em></p>
<p><strong>default:</strong> <em>none</em></p>
<p><strong>context:</strong> <em>http, server, location</em></p>
<p>You can sepcify several variables with this directive. If at least one of the variable is not empty and is not equal to '0', this substitution filter will be disabled.</p>
<p>
</p>
<h2><a name="installation">Installation</a></h2>
<p>To install, get the source with subversion:</p>
<p>git clone <a href="git://github.com/yaoweibin/ngx_http_substitutions_filter_module.git">git://github.com/yaoweibin/ngx_http_substitutions_filter_module.git</a></p>
<p>and then compile nginx with the following option:</p>
<p>./configure --add-module=/path/to/module</p>
<p>
</p>
<h2><a name="known_issue">Known issue</a></h2>
<ul>
<li>
<p>Can't substitute the response header.</p>
</li>
</ul>
<p>
</p>
<h2><a name="changes">CHANGES</a></h2>
<p>Changes with nginx_substitutions_filter 0.6.4 2014-02-15</p>
<ul>
<li>
<p>Now non-200 response will work</p>
</li>
<li>
<p>added the subs_filter_bypass directive</p>
</li>
</ul>
<p>Changes with nginx_substitutions_filter 0.6.2 2012-08-26</p>
<ul>
<li>
<p>fixed a bug of buffer overlap</p>
</li>
<li>
<p>fixed a bug with last zero buffer</p>
</li>
</ul>
<p>Changes with nginx_substitutions_filter 0.6.0 2012-06-30</p>
<ul>
<li>
<p>refactor this module</p>
</li>
</ul>
<p>Changes with nginx_substitutions_filter 0.5.2 2010-08-11</p>
<ul>
<li>
<p>do many optimizing for this module</p>
</li>
<li>
<p>fix a bug of buffer overlap</p>
</li>
<li>
<p>fix a segment fault bug when output chain return NGX_AGAIN.</p>
</li>
<li>
<p>fix a bug about last buffer with no linefeed. This may cause segment fault. Thanks for Josef Fröhle</p>
</li>
</ul>
<p>Changes with nginx_substitutions_filter 0.5 2010-04-15</p>
<ul>
<li>
<p>refactor the source structure, create branches of dev</p>
</li>
<li>
<p>fix a bug of small chunk of buffers causing lose content</p>
</li>
<li>
<p>fix the bug of last_buf and the nginx's compatibility above 0.8.25</p>
</li>
<li>
<p>fix a bug with unwanted capture config error in fix string substitution</p>
</li>
<li>
<p>add feature of regex captures</p>
</li>
</ul>
<p>Changes with nginx_substitutions_filter 0.4 2009-12-23</p>
<ul>
<li>
<p>fix many bugs</p>
</li>
</ul>
<p>Changes with nginx_substitutions_filter 0.3 2009-02-04</p>
<ul>
<li>
<p>Initial public release</p>
</li>
</ul>
<p>
</p>
<h2><a name="reporting_a_bug">Reporting a bug</a></h2>
<p>Questions/patches may be directed to Weibin Yao, <a href="mailto:yaoweibin@gmail.com.">yaoweibin@gmail.com.</a></p>
</body>
</html>
|
