add not_component argument for ngx.escape_uri

Author: zhuizhuhaomeng

README.markdown

@@ -5567,11 +5567,13 @@ This method was introduced in the `0.5.0rc30` release.
 ngx.escape_uri
 --------------
 
-**syntax:** *newstr = ngx.escape_uri(str)*
+**syntax:** *newstr = ngx.escape_uri(str, not_component?)*
 
 **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-_.~!*'();:@&=+$,/?#
 
 [Back to TOC](#nginx-api-for-lua)
 

src/ngx_http_lua_string.c

@@ -433,17 +433,20 @@ 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)
 {
-    return len + 2 * ngx_http_lua_escape_uri(NULL, (u_char *) src, len,
-                                             NGX_ESCAPE_URI_COMPONENT);
+    int type = not_component ? NGX_ESCAPE_URI :  NGX_ESCAPE_URI_COMPONENT;
+    return len + 2 * ngx_http_lua_escape_uri(NULL, (u_char *) src, len, type);
 }
 
 
 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)
 {
-    ngx_http_lua_escape_uri(dst, (u_char *) src, len, NGX_ESCAPE_URI_COMPONENT);
+    int type = not_component ? NGX_ESCAPE_URI :  NGX_ESCAPE_URI_COMPONENT;
+    ngx_http_lua_escape_uri(dst, (u_char *) src, len, type);
 }
 
 

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  /.-, +*)( '&%$ #"!  */
-        0xfc00886d, /* 1111 1100 0000 0000  1000 1000 0110 1101 */
+        0x50000051, /* 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

@@ -4,7 +4,7 @@ use Test::Nginx::Socket::Lua;
 
 repeat_each(2);
 
-plan tests => repeat_each() * (blocks() * 2 + 2);
+plan tests => repeat_each() * (blocks() * 2 + 3);
 
 no_long_string();
 
@@ -197,3 +197,23 @@ GET /lua
 %2C%24%40%7C%60
 --- no_error_log
 [error]
+
+
+
+=== TEST 15: not component argument
+--- config
+    location /lua {
+        content_by_lua_block {
+            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))
+        }
+    }
+--- request
+GET /lua
+--- response_body
+https://www.google.com
+https://www.google.com/query?q=test
+https://www.google.com/query?%0D%0Aq=test
+--- no_error_log
+[error]