feature: re-implemented the remaining time related Lua APIs with FFI (like ngx.update_time, ngx.http_time, ngx.parse_http_time, and etc.).

Signed-off-by: Yichun Zhang (agentzh) <agentzh@gmail.com>

Author: spacewander

README.markdown

@@ -205,6 +205,12 @@ API Implemented
 
 * [ngx.time](https://github.com/openresty/lua-nginx-module#ngxtime)
 * [ngx.now](https://github.com/openresty/lua-nginx-module#ngxnow)
+* [ngx.update_time](https://github.com/openresty/lua-nginx-module#ngxupdate_time)
+* [ngx.localtime](https://github.com/openresty/lua-nginx-module#ngxlocaltime)
+* [ngx.utctime](https://github.com/openresty/lua-nginx-module#ngxutctime)
+* [ngx.cookie_time](https://github.com/openresty/lua-nginx-module#ngxcookie_time)
+* [ngx.http_time](https://github.com/openresty/lua-nginx-module#ngxhttp_time)
+* [ngx.parse_http_time](https://github.com/openresty/lua-nginx-module#ngxparse_http_time)
 
 [Back to TOC](#table-of-contents)
 

lib/resty/core/time.lua

@@ -5,14 +5,29 @@ local ffi = require 'ffi'
 local base = require "resty.core.base"
 
 
+local error = error
 local tonumber = tonumber
+local type = type
 local C = ffi.C
+local ffi_new = ffi.new
+local ffi_str = ffi.string
+local time_val = ffi_new("long[1]")
+local get_string_buf = base.get_string_buf
 local ngx = ngx
+local FFI_ERROR = ngx.ERROR
 
 
 ffi.cdef[[
 double ngx_http_lua_ffi_now(void);
 long ngx_http_lua_ffi_time(void);
+void ngx_http_lua_ffi_today(unsigned char *buf);
+void ngx_http_lua_ffi_localtime(unsigned char *buf);
+void ngx_http_lua_ffi_utctime(unsigned char *buf);
+void ngx_http_lua_ffi_update_time(void);
+int ngx_http_lua_ffi_cookie_time(unsigned char *buf, long t);
+void ngx_http_lua_ffi_http_time(unsigned char *buf, long t);
+void ngx_http_lua_ffi_parse_http_time(const unsigned char *str, size_t len,
+    long *time);
 ]]
 
 
@@ -26,6 +41,81 @@ function ngx.time()
 end
 
 
+function ngx.update_time()
+    C.ngx_http_lua_ffi_update_time()
+end
+
+
+function ngx.today()
+    -- the format of today is 2010-11-19
+    local today_buf_size = 10
+    local buf = get_string_buf(today_buf_size)
+    C.ngx_http_lua_ffi_today(buf)
+    return ffi_str(buf, today_buf_size)
+end
+
+
+function ngx.localtime()
+    -- the format of localtime is 2010-11-19 20:56:31
+    local localtime_buf_size = 19
+    local buf = get_string_buf(localtime_buf_size)
+    C.ngx_http_lua_ffi_localtime(buf)
+    return ffi_str(buf, localtime_buf_size)
+end
+
+
+function ngx.utctime()
+    -- the format of utctime is 2010-11-19 20:56:31
+    local utctime_buf_size = 19
+    local buf = get_string_buf(utctime_buf_size)
+    C.ngx_http_lua_ffi_utctime(buf)
+    return ffi_str(buf, utctime_buf_size)
+end
+
+
+function ngx.cookie_time(sec)
+    if type(sec) ~= "number" then
+        return error("number argument only")
+    end
+
+    -- the format of cookie time is Mon, 28-Sep-2038 06:00:00 GMT
+    -- or Mon, 28-Sep-18 06:00:00 GMT
+    local cookie_time_buf_size = 29
+    local buf = get_string_buf(cookie_time_buf_size)
+    local used_size = C.ngx_http_lua_ffi_cookie_time(buf, sec)
+    return ffi_str(buf, used_size)
+end
+
+
+function ngx.http_time(sec)
+    if type(sec) ~= "number" then
+        return error("number argument only")
+    end
+
+    -- the format of http time is Mon, 28 Sep 1970 06:00:00 GMT
+    local http_time_buf_size = 29
+    local buf = get_string_buf(http_time_buf_size)
+    C.ngx_http_lua_ffi_http_time(buf, sec)
+    return ffi_str(buf, http_time_buf_size)
+end
+
+
+function ngx.parse_http_time(time_str)
+    if type(time_str) ~= "string" then
+        return error("string argument only")
+    end
+
+    C.ngx_http_lua_ffi_parse_http_time(time_str, #time_str, time_val)
+
+    local res = time_val[0]
+    if res == FFI_ERROR then
+        return nil
+    end
+
+    return tonumber(res)
+end
+
+
 return {
     version = base.version
 }

t/time.t

@@ -103,3 +103,179 @@ qr/\[TRACE   \d+ content_by_lua\(nginx\.conf:\d+\):3 loop\]/
 [error]
 bad argument type
 stitch
+
+
+
+=== TEST 3: ngx.update_time()
+--- http_config eval: $::HttpConfig
+--- config
+    location = /t {
+        content_by_lua_block {
+            local start = ngx.now()
+            for _ = 1, 1e5 do
+                ngx.update_time()
+            end
+            ngx.say(ngx.now() - start > 0)
+        }
+    }
+--- request
+GET /t
+--- response_body
+true
+--- error_log eval
+qr/\[TRACE   \d+ content_by_lua\(nginx\.conf:\d+\):3 loop\]/
+--- no_error_log
+[error]
+bad argument type
+stitch
+
+
+
+=== TEST 4: ngx.today()
+--- http_config eval: $::HttpConfig
+--- config
+    location = /t {
+        content_by_lua_block {
+            local t
+            for i = 1, 500 do
+                t = ngx.today()
+            end
+            ngx.say(t)
+        }
+    }
+--- request
+GET /t
+--- response_body_like: ^\d{4}-\d{2}-\d{2}
+--- error_log eval
+qr/\[TRACE   \d+ content_by_lua\(nginx\.conf:\d+\):3 loop\]/
+--- no_error_log
+[error]
+bad argument type
+stitch
+
+
+
+=== TEST 5: ngx.localtime()
+--- http_config eval: $::HttpConfig
+--- config
+    location = /t {
+        content_by_lua_block {
+            local t
+            for i = 1, 500 do
+                t = ngx.localtime()
+            end
+            ngx.say(t)
+        }
+    }
+--- request
+GET /t
+--- response_body_like: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
+--- error_log eval
+qr/\[TRACE   \d+ content_by_lua\(nginx\.conf:\d+\):3 loop\]/
+--- no_error_log
+[error]
+bad argument type
+stitch
+
+
+
+=== TEST 6: ngx.utctime()
+--- http_config eval: $::HttpConfig
+--- config
+    location = /t {
+        content_by_lua_block {
+            local t
+            for i = 1, 500 do
+                t = ngx.utctime()
+            end
+            ngx.say(t)
+        }
+    }
+--- request
+GET /t
+--- response_body_like: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
+--- error_log eval
+qr/\[TRACE   \d+ content_by_lua\(nginx\.conf:\d+\):3 loop\]/
+--- no_error_log
+[error]
+bad argument type
+stitch
+
+
+
+=== TEST 7: ngx.cookie_time()
+--- http_config eval: $::HttpConfig
+--- config
+    location /t {
+        content_by_lua_block {
+            local t
+            for i = 1, 500 do
+                t = ngx.cookie_time(1290079655)
+            end
+            ngx.say(t)
+            ngx.say(ngx.cookie_time(2200000000))
+        }
+    }
+--- request
+GET /t
+--- response_body
+Thu, 18-Nov-10 11:27:35 GMT
+Sun, 18-Sep-2039 23:06:40 GMT
+--- error_log eval
+qr/\[TRACE   \d+ content_by_lua\(nginx\.conf:\d+\):3 loop\]/
+--- no_error_log
+[error]
+bad argument type
+stitch
+
+
+
+=== TEST 8: ngx.http_time()
+--- http_config eval: $::HttpConfig
+--- config
+    location /t {
+        content_by_lua_block {
+            local t
+            for i = 1, 500 do
+                t = ngx.http_time(1290079655)
+            end
+            ngx.say(t)
+        }
+    }
+--- request
+GET /t
+--- response_body
+Thu, 18 Nov 2010 11:27:35 GMT
+--- error_log eval
+qr/\[TRACE   \d+ content_by_lua\(nginx\.conf:\d+\):3 loop\]/
+--- no_error_log
+[error]
+bad argument type
+stitch
+
+
+
+=== TEST 9: ngx.parse_http_time()
+--- http_config eval: $::HttpConfig
+--- config
+    location /t {
+        content_by_lua_block {
+            local t
+            for i = 1, 500 do
+                t = ngx.parse_http_time("Thu, 18 Nov 2010 11:27:35 GMT")
+            end
+            ngx.say(t)
+            ngx.say(ngx.parse_http_time("Thu, Nov 2010"))
+        }
+    }
+--- request
+GET /t
+--- response_body
+1290079655
+nil
+--- error_log eval
+qr/\[TRACE   \d+ content_by_lua\(nginx\.conf:\d+\):3 loop\]/
+--- no_error_log
+[error]
+bad argument type
+stitch