X-Git-Url: https://git.archive.openwrt.org/?p=project%2Fluci.git;a=blobdiff_plain;f=libs%2Fcore%2Fluasrc%2Futil.lua;h=84c63f240409091588a09821e970f2a4df70c7ea;hp=14bd1e79bfaf6ec1bdb94e7d14428147ed955e2d;hb=7f92fa405cee6b2657325a4b7554be88b217fb9f;hpb=ba22660cb82d0f34bc1080c1fcfec539ef3634eb

diff --git a/libs/core/luasrc/util.lua b/libs/core/luasrc/util.lua
index 14bd1e79b..84c63f240 100644
--- a/libs/core/luasrc/util.lua
+++ b/libs/core/luasrc/util.lua
@@ -24,8 +24,23 @@ limitations under the License.
 
 ]]--
 
+local io = require "io"
+local math = require "math"
+local table = require "table"
+local debug = require "debug"
+local ldebug = require "luci.debug"
+local string = require "string"
+local coroutine = require "coroutine"
+
+local getmetatable, setmetatable = getmetatable, setmetatable
+local rawget, rawset, unpack = rawget, rawset, unpack
+local tostring, type, assert = tostring, type, assert
+local ipairs, pairs, loadstring = ipairs, pairs, loadstring
+local require, pcall, xpcall = require, pcall, xpcall
+local collectgarbage, get_memory_limit = collectgarbage, get_memory_limit
+
 --- LuCI utility functions.
-module("luci.util", package.seeall)
+module "luci.util"
 
 --
 -- Pythonic string formatting extension
@@ -34,8 +49,10 @@ getmetatable("").__mod = function(a, b)
 	if not b then
 		return a
 	elseif type(b) == "table" then
+		for k, _ in pairs(b) do if type(b[k]) == "userdata" then b[k] = tostring(b[k]) end end
 		return a:format(unpack(b))
 	else
+		if type(b) == "userdata" then b = tostring(b) end
 		return a:format(b)
 	end
 end
@@ -45,6 +62,17 @@ end
 -- Class helper routines
 --
 
+-- Instantiates a class
+local function _instantiate(class, ...)
+	local inst = setmetatable({}, {__index = class})
+
+	if inst.__init__ then
+		inst:__init__(...)
+	end
+
+	return inst
+end
+
 --- Create a Class object (Python-style object model).
 -- The class object can be instantiated by calling itself.
 -- Any class functions or shared parameters can be attached to this object.
@@ -60,30 +88,10 @@ end
 -- @see			instanceof
 -- @see			clone
 function class(base)
-	local class = {}
-
-	local create = function(class, ...)
-		local inst = {}
-		setmetatable(inst, {__index = class})
-
-		if inst.__init__ then
-			local stat, err = copcall(inst.__init__, inst, ...)
-			if not stat then
-				error(err)
-			end
-		end
-
-		return inst
-	end
-
-	local classmeta = {__call = create}
-
-	if base then
-		classmeta.__index = base
-	end
-
-	setmetatable(class, classmeta)
-	return class
+	return setmetatable({}, {
+		__call  = _instantiate,
+		__index = base
+	})
 end
 
 --- Test whether the given object is an instance of the given class.
@@ -108,65 +116,31 @@ end
 -- Scope manipulation routines
 --
 
---- Replace a function scope with a shallow copy of itself.
--- This is useful if you want to get rid of several unwanted side effects
--- while changing the scope of a certain Lua function.
--- @param f		Lua function
-function resfenv(f)
-	setfenv(f, clone(getfenv(f)))
-end
-
---- Store given object associated with given key in the scope of a function.
--- @param f		Lua function
--- @param key	String value containg the key of the object to store
--- @param obj	Object to store in the scope
--- @return		Always nil
--- @see updfenv
--- @see resfenv
-function extfenv(f, key, obj)
-	local scope = getfenv(f)
-	scope[key] = obj
-end
-
---- Extend the scope of a function with the contents of a table
--- @param f		Lua function
--- @param key	String value containg the key of the object to store
--- @param obj	Object to store in the scope
--- @return		Always nil
--- @see extfenv
--- @see resfenv
-function updfenv(f, extscope)
-	update(getfenv(f), extscope)
-end
+local tl_meta = {
+	__mode = "k",
 
---- Create a new or get an already existing thread local store associated with
--- the current active coroutine. A thread local store is private a table object
--- whose values can't be accessed from outside of the running coroutine.
--- @return	Table value representing the corresponding thread local store
-function threadlocal()
-	local tbl = {}
-
-	local function get(self, key)
-		local c = coroutine.running()
-		local thread = coxpt[c] or c or 0
-		if not rawget(self, thread) then
-			return nil
-		end
-		return rawget(self, thread)[key]
-	end
+	__index = function(self, key)
+		local t = rawget(self, coxpt[coroutine.running()]
+		 or coroutine.running() or 0)
+		return t and t[key]
+	end,
 
-	local function set(self, key, value)
-		local c = coroutine.running()
-		local thread = coxpt[c] or c or 0
-		if not rawget(self, thread) then
-			rawset(self, thread, {})
+	__newindex = function(self, key, value)
+		local c = coxpt[coroutine.running()] or coroutine.running() or 0
+		if not rawget(self, c) then
+			rawset(self, c, { [key] = value })
+		else
+			rawget(self, c)[key] = value
 		end
-		rawget(self, thread)[key] = value
 	end
+}
 
-	setmetatable(tbl, {__index = get, __newindex = set, __mode = "k"})
-
-	return tbl
+--- Create a new or get an already existing thread local store associated with
+-- the current active coroutine. A thread local store is private a table object
+-- whose values can't be accessed from outside of the running coroutine.
+-- @return	Table value representing the corresponding thread local store
+function threadlocal(tbl)
+	return setmetatable(tbl or {}, tl_meta)
 end
 
 
@@ -183,18 +157,18 @@ end
 
 --- Recursively dumps a table to stdout, useful for testing and debugging.
 -- @param t	Table value to dump
--- @param i	Number of tabs to prepend to each line
+-- @param maxdepth	Maximum depth
 -- @return	Always nil
-function dumptable(t, i, seen)
+function dumptable(t, maxdepth, i, seen)
 	i = i or 0
 	seen = seen or setmetatable({}, {__mode="k"})
-	
+
 	for k,v in pairs(t) do
-		perror(string.rep("\t", i) .. tostring(k), tostring(v))
-		if type(v) == "table" then
+		perror(string.rep("\t", i) .. tostring(k) .. "\t" .. tostring(v))
+		if type(v) == "table" and (not maxdepth or i < maxdepth) then
 			if not seen[v] then
 				seen[v] = true
-				dumptable(v, i+1, seen)
+				dumptable(v, maxdepth, i+1, seen)
 			else
 				perror(string.rep("\t", i) .. "*** RECURSION ***")
 			end
@@ -219,21 +193,32 @@ end
 --- Create valid XML PCDATA from given string.
 -- @param value	String value containing the data to escape
 -- @return		String value containing the escaped data
+local function _pcdata_repl(c)
+	local i = string.byte(c)
+
+	if ( i >= 0x00 and i <= 0x08 ) or ( i >= 0x0B and i <= 0x0C ) or
+	   ( i >= 0x0E and i <= 0x1F ) or ( i == 0x7F )
+	then
+		return ""
+		
+	elseif ( i == 0x26 ) or ( i == 0x27 ) or ( i == 0x22 ) or
+	       ( i == 0x3C ) or ( i == 0x3E )
+	then
+		return string.format("&#%i;", i)
+	end
+
+	return c
+end
+
 function pcdata(value)
-	if not value then return end
-	value = tostring(value)
-	value = value:gsub("&", "&amp;")
-	value = value:gsub('"', "&quot;")
-	value = value:gsub("'", "&apos;")
-	value = value:gsub("<", "&lt;")
-	return value:gsub(">", "&gt;")
+	return value and tostring(value):gsub("[&\"'<>%c]", _pcdata_repl)
 end
 
 --- Strip HTML tags from given string.
 -- @param value	String containing the HTML text
 -- @return	String with HTML tags stripped of
 function striptags(s)
-	return pcdata(s:gsub("</?[A-Za-z][A-Za-z0-9:_%-]*[^>]*>", " "):gsub("%s+", " "))
+	return pcdata(tostring(s):gsub("</?[A-Za-z][A-Za-z0-9:_%-]*[^>]*>", " "):gsub("%s+", " "))
 end
 
 --- Splits given string on a defined separator sequence and return a table
@@ -270,9 +255,9 @@ function split(str, pat, max, regex)
 		local s, e = str:find(pat, c, not regex)
 		max = max - 1
 		if s and max < 0 then
-			table.insert(t, str:sub(c))
+			t[#t+1] = str:sub(c)
 		else
-			table.insert(t, str:sub(c, s and s - 1))
+			t[#t+1] = str:sub(c, s and s - 1)
 		end
 		c = e and e + 1 or #str + 1
 	until not s or max < 0
@@ -284,8 +269,17 @@ end
 -- @param str	String value containing whitespace padded data
 -- @return		String value with leading and trailing space removed
 function trim(str)
-	local s = str:gsub("^%s*(.-)%s*$", "%1")
-	return s
+	return (str:gsub("^%s*(.-)%s*$", "%1"))
+end
+
+--- Count the occurences of given substring in given string.
+-- @param str		String to search in
+-- @param pattern	String containing pattern to find
+-- @return			Number of found occurences
+function cmatch(str, pat)
+	local count = 0
+	for _ in str:gmatch(pat) do count = count + 1 end
+	return count
 end
 
 --- Parse certain units from the given string and return the canonical integer
@@ -347,19 +341,40 @@ function parse_units(ustr)
 	return val
 end
 
---- Combines two or more numerically indexed tables into one.
+-- also register functions above in the central string class for convenience
+string.escape      = escape
+string.pcdata      = pcdata
+string.striptags   = striptags
+string.split       = split
+string.trim        = trim
+string.cmatch      = cmatch
+string.parse_units = parse_units
+
+
+--- Appends numerically indexed tables or single objects to a given table.
+-- @param src	Target table
+-- @param ...	Objects to insert
+-- @return		Target table
+function append(src, ...)
+	for i, a in ipairs({...}) do
+		if type(a) == "table" then
+			for j, v in ipairs(a) do
+				src[#src+1] = v
+			end
+		else
+			src[#src+1] = a
+		end
+	end
+	return src
+end
+
+--- Combines two or more numerically indexed tables and single objects into one table.
 -- @param tbl1	Table value to combine
 -- @param tbl2	Table value to combine
 -- @param ...	More tables to combine
 -- @return		Table value containing all values of given tables
 function combine(...)
-	local result = {}
-	for i, a in ipairs(arg) do
-		for j, v in ipairs(a) do
-			table.insert(result, v)
-		end
-	end
-	return result
+	return append({}, ...)
 end
 
 --- Checks whether the given table contains the given value.
@@ -393,7 +408,7 @@ function keys(t)
 	local keys = { }
 	if t then
 		for k, _ in kspairs(t) do
-			table.insert( keys, k )
+			keys[#keys+1] = k
 		end
 	end
 	return keys
@@ -413,9 +428,7 @@ function clone(object, deep)
 		copy[k] = v
 	end
 
-	setmetatable(copy, getmetatable(object))
-
-	return copy
+	return setmetatable(copy, getmetatable(object))
 end
 
 
@@ -435,15 +448,28 @@ end
 function _serialize_table(t, seen)
 	assert(not seen[t], "Recursion detected.")
 	seen[t] = true
-	
-	local data = ""
+
+	local data  = ""
+	local idata = ""
+	local ilen  = 0
+
 	for k, v in pairs(t) do
-		k = serialize_data(k, seen)
-		v = serialize_data(v, seen)
-		data = data .. ( #data > 0 and ", " or "" ) ..
-			'[' .. k .. '] = ' .. v
+		if type(k) ~= "number" or k < 1 or math.floor(k) ~= k or ( k - #t ) > 3 then
+			k = serialize_data(k, seen)
+			v = serialize_data(v, seen)
+			data = data .. ( #data > 0 and ", " or "" ) ..
+				'[' .. k .. '] = ' .. v
+		elseif k > ilen then
+			ilen = k
+		end
 	end
-	return data
+
+	for i = 1, ilen do
+		local v = serialize_data(t[i], seen)
+		idata = idata .. ( #idata > 0 and ", " or "" ) .. v
+	end
+
+	return idata .. ( #data > 0 and #idata > 0 and ", " or "" ) .. data
 end
 
 --- Recursively serialize given data to lua code, suitable for restoring
@@ -454,17 +480,17 @@ end
 -- @see			get_bytecode
 function serialize_data(val, seen)
 	seen = seen or setmetatable({}, {__mode="k"})
-	
+
 	if val == nil then
 		return "nil"
 	elseif type(val) == "number" then
 		return val
 	elseif type(val) == "string" then
-		return string.format("%q", val)
+		return "%q" % val
 	elseif type(val) == "boolean" then
 		return val and "true" or "false"
 	elseif type(val) == "function" then
-		return string.format("loadstring(%q)", get_bytecode(val))
+		return "loadstring(%q)" % get_bytecode(val)
 	elseif type(val) == "table" then
 		return "{ " .. _serialize_table(val, seen) .. " }"
 	else
@@ -528,10 +554,10 @@ function strip_bytecode(code)
 		end
 	end
 
-	local strip_function
-	strip_function = function(code)
+	local function strip_function(code)
 		local count, offset = subint(code, 1, size)
-		local stripped, dirty = string.rep("\0", size), offset + count
+		local stripped = { string.rep("\0", size) }
+		local dirty = offset + count
 		offset = offset + count + int * 2 + 4
 		offset = offset + int + subint(code, offset, int) * ins
 		count, offset = subint(code, offset, int)
@@ -549,10 +575,11 @@ function strip_bytecode(code)
 			end
 		end
 		count, offset = subint(code, offset, int)
-		stripped = stripped .. code:sub(dirty, offset - 1)
+		stripped[#stripped+1] = code:sub(dirty, offset - 1)
 		for n = 1, count do
 			local proto, off = strip_function(code:sub(offset, -1))
-			stripped, offset = stripped .. proto, offset + off - 1
+			stripped[#stripped+1] = proto
+			offset = offset + off - 1
 		end
 		offset = offset + subint(code, offset, int) * int + int
 		count, offset = subint(code, offset, int)
@@ -563,8 +590,8 @@ function strip_bytecode(code)
 		for n = 1, count do
 			offset = offset + subint(code, offset, size) + size
 		end
-		stripped = stripped .. string.rep("\0", int * 3)
-		return stripped, offset
+		stripped[#stripped+1] = string.rep("\0", int * 3)
+		return table.concat(stripped), offset
 	end
 
 	return code:sub(1,12) .. strip_function(code:sub(13,-1))
@@ -579,17 +606,16 @@ function _sortiter( t, f )
 	local keys = { }
 
 	for k, v in pairs(t) do
-		table.insert( keys, k )
+		keys[#keys+1] = k
 	end
 
 	local _pos = 0
-	local _len = table.getn( keys )
 
 	table.sort( keys, f )
 
 	return function()
 		_pos = _pos + 1
-		if _pos <= _len then
+		if _pos <= #keys then
 			return keys[_pos], t[keys[_pos]]
 		end
 	end
@@ -650,11 +676,11 @@ function execi(command)
 
 	return pp and function()
 		local line = pp:read()
-		
+
 		if not line then
 			pp:close()
 		end
-		
+
 		return line
 	end
 end
@@ -668,7 +694,7 @@ function execl(command)
 	while true do
 		line = pp:read()
 		if (line == nil) then break end
-		table.insert(data, line)
+		data[#data+1] = line
 	end
 	pp:close()
 
@@ -678,7 +704,7 @@ end
 --- Returns the absolute path to LuCI base directory.
 -- @return		String containing the directory path
 function libpath()
-	return luci.fs.dirname(require("luci.debug").__file__)
+	return require "nixio.fs".dirname(ldebug.__file__)
 end
 
 
@@ -745,18 +771,19 @@ function copcall(f, ...)
 end
 
 -- Handle return value of protected call
-function handleReturnValue(err, co, status, ...)
+function handleReturnValue(err, co, status, arg1, arg2, arg3, arg4, arg5)
 	if not status then
-		return false, err(debug.traceback(co, (...)), ...)
+		return false, err(debug.traceback(co, arg1), arg1, arg2, arg3, arg4, arg5)
 	end
-	if coroutine.status(co) == 'suspended' then
-		return performResume(err, co, coroutine.yield(...))
-	else
-		return true, ...
+
+	if coroutine.status(co) ~= 'suspended' then
+		return true, arg1, arg2, arg3, arg4, arg5
 	end
+
+	return performResume(err, co, coroutine.yield(arg1, arg2, arg3, arg4, arg5))
 end
 
 -- Resume execution of protected function call
-function performResume(err, co, ...)
-	return handleReturnValue(err, co, coroutine.resume(co, ...))
+function performResume(err, co, arg1, arg2, arg3, arg4, arg5)
+	return handleReturnValue(err, co, coroutine.resume(co, arg1, arg2, arg3, arg4, arg5))
 end