Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

96 lines (68 sloc) 3.421 kB
Name
iconv-nginx-module
Description
This is a nginx module that uses libiconv to convert characters of
different encoding. It brings the 'set_iconv' command to nginx.
This module depends on the ngx_devel_kit(NDK) module.
Installation
Get the nginx source code from nginx.net ( http://nginx.org/ ).
Untar the source code and build nginx with this module.
wget 'http://nginx.org/download/nginx-1.0.8.tar.gz'
tar -xzvf nginx-1.0.8.tar.gz
cd nginx-1.0.8/
./configure \
--add-module=/path/to/iconv-nginx-module/ \
--add-module=/path/to/ngx_devel_kit
make -j2
make install
Usage
set_iconv <destination variable> <from variable> from=<from encoding> to=<to encoding>;
iconv_buffer_size <size>; #default iconv_buffer_size is ngx_pagesize
iconv_filter from=<from encoding> to=<to encoding>;
Here is a basic example:
#nginx.conf
location /foo {
set $src '你好'; #in UTF-8
set_iconv $dst $src from=utf8 to=gbk; #now $dst holds 你好 in GBK
}
#everything generated from /bar will be converted from utf8 to gbk
location /bar {
iconv_filter from=utf-8 to=gbk;
iconv_buffer_size 1k;
#content handler here
}
Compatibility
The following versions of Nginx should work with this module:
* 1.1.x (last tested: 1.1.5)
* 1.0.x (last tested: 1.0.8)
* 0.9.x (last tested: 0.9.4)
* 0.8.x (last tested: 0.8.54)
* 0.7.x (last tested: 0.7.68)
Copyright & License
This program is licenced under the BSD license.
Copyright (c) 2010, 2011, Taobao Inc, Alibaba Group ( http://www.taobao.com/).
Copyright (c) 2010, 2011, Jiale "Calio" Zhi <vipcalio@gmail.com>.
Copyright (c) 2010, 2011, Yichun "agentzh" Zhang <agentzh@gmail.com>.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Changelog
v0.02 add iconv_filter and iconv_buffer_size instruction
v0.01 implement set_iconv instruction
Jump to Line
Something went wrong with that request. Please try again.