add not_component argument for ngx.escape_uri

Author: zhuizhuhaomeng

README.markdown

@@ -5567,13 +5567,20 @@ This method was introduced in the `0.5.0rc30` release.
 ngx.escape_uri
 --------------
 
-**syntax:** *newstr = ngx.escape_uri(str, not_component?)*
+**syntax:** *newstr = ngx.escape_uri(str)*
 
 **context:** *init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua**
 
 Escape `str` as a URI component.
-Since the `v0.10.16rc6` release, this function accepts an optional boolean `not_component` argument. When this argument is `true`, this function act like encodeURI. These characters bellow will not be escape.
-a-zA-Z0-9-_.~!*'();:@&=+$,/?#
+
+Since `v0.10.16rc6`, this function accepts an optional boolean `not_component` argument. When this argument is `true`, these characters bellow will not be escaped.
+
+
+    Alphabets: a-zA-Z
+    Digits: 0-9
+    Reserve characters: -_.~!*'();:@&=+$,/?#
+
+
 
 [Back to TOC](#nginx-api-for-lua)
 

doc/HttpLuaModule.wiki

@@ -4678,6 +4678,15 @@ This method was introduced in the <code>0.5.0rc30</code> release.
 
 Escape <code>str</code> as a URI component.
 
+Since `v0.10.16rc6`, this function accepts an optional boolean <code>not_component</code> argument. When this argument is <code>true</code>, these characters bellow will not be escaped.
+
+<geshi lang="text">
+Alphabets: a-zA-Z
+Digits: 0-9
+Reserve characters: -_.~!*'();:@&=+$,/?#
+</geshi>
+
+
 == ngx.unescape_uri ==
 
 '''syntax:''' ''newstr = ngx.unescape_uri(str)''

src/ngx_http_lua_string.c

@@ -433,7 +433,7 @@ ngx_http_lua_ffi_unescape_uri(const u_char *src, size_t len, u_char *dst)
 
 
 size_t
-ngx_http_lua_ffi_uri_escaped_length(const u_char *src, size_t len, 
+ngx_http_lua_ffi_uri_escaped_length(const u_char *src, size_t len,
     int not_component)
 {
     int type = not_component ? NGX_ESCAPE_URI :  NGX_ESCAPE_URI_COMPONENT;
@@ -442,7 +442,7 @@ ngx_http_lua_ffi_uri_escaped_length(const u_char *src, size_t len,
 
 
 void
-ngx_http_lua_ffi_escape_uri(const u_char *src, size_t len, u_char *dst, 
+ngx_http_lua_ffi_escape_uri(const u_char *src, size_t len, u_char *dst,
     int not_component)
 {
     int type = not_component ? NGX_ESCAPE_URI :  NGX_ESCAPE_URI_COMPONENT;

src/ngx_http_lua_util.c

@@ -1892,7 +1892,7 @@ ngx_http_lua_escape_uri(u_char *dst, u_char *src, size_t size, ngx_uint_t type)
         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
 
                     /* ?>=< ;:98 7654 3210  /.-, +*)( '&%$ #"!  */
-        0x50000051, /* 0101 0000 0000 0000  0000 0000 0010 0101 */
+        0x50000025, /* 0101 0000 0000 0000  0000 0000 0010 0101 */
 
                     /* _^]\ [ZYX WVUT SRQP  ONML KJIH GFED CBA@ */
         0x78000000, /* 0111 1000 0000 0000  0000 0000 0000 0000 */

t/006-escape.t

@@ -207,6 +207,8 @@ GET /lua
             ngx.say(ngx.escape_uri("https://www.google.com", true))
             ngx.say(ngx.escape_uri("https://www.google.com/query?q=test", true))
             ngx.say(ngx.escape_uri("https://www.google.com/query?\r\nq=test", true))
+            ngx.say(ngx.escape_uri("-_.~!*'();:@&=+$,/?#", true))
+            ngx.say(ngx.escape_uri("<>[]{}\\\" ", true))
         }
     }
 --- request
@@ -215,5 +217,7 @@ GET /lua
 https://www.google.com
 https://www.google.com/query?q=test
 https://www.google.com/query?%0D%0Aq=test
+-_.~!*'();:@&=+$,/?#
+%3C%3E%5B%5D%7B%7D%5C%22%20
 --- no_error_log
 [error]