add not_uri_comp argument for ngx.escape_uri

Author: zhuizhuhaomeng

README.markdown

@@ -5581,19 +5581,17 @@ 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_uri_comp?)*
 
 **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 `v0.10.16rc6`, this function accepts an optional boolean `not_component` argument. When this argument is `true`, these characters bellow will not be escaped.
+Since `v0.10.16rc6`, this function accepts an optional boolean `not_uri_comp` argument. When this argument is `true`, these characters bellow will be escaped.
 
 
-    Alphabets: a-zA-Z
-    Digits: 0-9
-    Reserve characters: -_.~!*'();:@&=+$,/?#
-
+    ASCII code: 0~32, 127~255
+    Characters: ?%#!
 
 
 [Back to TOC](#nginx-api-for-lua)

doc/HttpLuaModule.wiki

@@ -4686,21 +4686,19 @@ This method was introduced in the <code>0.5.0rc30</code> release.
 
 == ngx.escape_uri ==
 
-'''syntax:''' ''newstr = ngx.escape_uri(str)''
+'''syntax:''' ''newstr = ngx.escape_uri(str, not_uri_comp?)''
 
 '''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 <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.
+Since `v0.10.16rc6`, this function accepts an optional boolean <code>not_uri_comp</code> argument. When this argument is <code>true</code>, these characters bellow will be escaped.
 
 <geshi lang="text">
-Alphabets: a-zA-Z
-Digits: 0-9
-Reserve characters: -_.~!*'();:@&=+$,/?#
+    ASCII code: 0~32, 127~255
+    Characters: ?%#!
 </geshi>
 
-
 == ngx.unescape_uri ==
 
 '''syntax:''' ''newstr = ngx.unescape_uri(str)''

src/ngx_http_lua_consts.c

@@ -13,6 +13,34 @@
 
 #include "ngx_http_lua_consts.h"
 
+void
+ngx_http_lua_inject_escape_consts(lua_State *L)
+{
+    /* {{{ escape constants */
+    lua_pushinteger(L, NGX_ESCAPE_URI);
+    lua_setfield(L, -2, "NGX_ESCAPE_URI");
+
+    lua_pushinteger(L, NGX_ESCAPE_ARGS);
+    lua_setfield(L, -2, "NGX_ESCAPE_ARGS");
+
+    lua_pushinteger(L, NGX_ESCAPE_URI_COMPONENT);
+    lua_setfield(L, -2, "NGX_ESCAPE_URI_COMPONENT");
+
+    lua_pushinteger(L, NGX_ESCAPE_HTML);
+    lua_setfield(L, -2, "NGX_ESCAPE_HTML");
+
+    lua_pushinteger(L, NGX_ESCAPE_REFRESH);
+    lua_setfield(L, -2, "NGX_ESCAPE_REFRESH");
+
+    lua_pushinteger(L, NGX_ESCAPE_MEMCACHED);
+    lua_setfield(L, -2, "NGX_ESCAPE_MEMCACHED");
+
+    lua_pushinteger(L, NGX_ESCAPE_MAIL_AUTH);
+    lua_setfield(L, -2, "ERNGX_ESCAPE_MAIL_AUTHROR");
+
+    /* }}} */
+}
+
 
 void
 ngx_http_lua_inject_core_consts(lua_State *L)

src/ngx_http_lua_consts.h

@@ -13,6 +13,7 @@
 
 void ngx_http_lua_inject_http_consts(lua_State *L);
 void ngx_http_lua_inject_core_consts(lua_State *L);
+void ngx_http_lua_inject_escape_consts(lua_State *L);
 
 
 #endif /* _NGX_HTTP_LUA_CONSTS_H_INCLUDED_ */

src/ngx_http_lua_string.c

@@ -434,18 +434,16 @@ 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,
-    int not_component)
+    int type)
 {
-    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,
-    int not_component)
+    int type)
 {
-    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

@@ -726,6 +726,7 @@ ngx_http_lua_inject_ngx_api(lua_State *L, ngx_http_lua_main_conf_t *lmcf,
 
     ngx_http_lua_inject_arg_api(L);
 
+    ngx_http_lua_inject_escape_consts(L);
     ngx_http_lua_inject_http_consts(L);
     ngx_http_lua_inject_core_consts(L);
 
@@ -1892,13 +1893,13 @@ 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  /.-, +*)( '&%$ #"!  */
-        0x50000025, /* 0101 0000 0000 0000  0000 0000 0010 0101 */
+        0x80000029, /* 1000 0000 0000 0000  0000 0000 0010 1001 */
 
                     /* _^]\ [ZYX WVUT SRQP  ONML KJIH GFED CBA@ */
-        0x78000000, /* 0111 1000 0000 0000  0000 0000 0000 0000 */
+        0x00000000, /* 0000 0000 0000 0000  0000 0000 0000 0000 */
 
                     /*  ~}| {zyx wvut srqp  onml kjih gfed cba` */
-        0xa8000000, /* 1010 1000 0000 0000  0000 0000 0000 0000 */
+        0x80000000, /* 1000 0000 0000 0000  0000 0000 0000 0000 */
 
         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */

t/006-escape.t

@@ -215,9 +215,9 @@ GET /lua
 GET /lua
 --- response_body
 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
+https://www.google.com/query%3Fq=test
+https://www.google.com/query%3F%0D%0Aq=test
+-_.~!*'();:@&=+$,/%3F%23
+<>[]{}\"%20
 --- no_error_log
 [error]