luci-0.11: merge outstanding trunk changes
[project/luci.git] / libs / core / luasrc / util.lua
index a3ba43246817d49fc721e583f2516aaea49e79ae..e285777c31960d383ece8fc64e9693963ad54020 100644 (file)
@@ -31,11 +31,12 @@ local debug = require "debug"
 local ldebug = require "luci.debug"
 local string = require "string"
 local coroutine = require "coroutine"
+local tparser = require "luci.template.parser"
 
 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 ipairs, pairs, next, loadstring = ipairs, pairs, next, loadstring
 local require, pcall, xpcall = require, pcall, xpcall
 local collectgarbage, get_memory_limit = collectgarbage, get_memory_limit
 
@@ -49,8 +50,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
@@ -114,19 +117,16 @@ end
 -- Scope manipulation routines
 --
 
---- 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 tl_meta = {
+       __mode = "k",
 
-       local function get(self, key)
-               local t = rawget(self, coxpt[coroutine.running()] or coroutine.running() or 0)
+       __index = function(self, key)
+               local t = rawget(self, coxpt[coroutine.running()]
+                or coroutine.running() or 0)
                return t and t[key]
-       end
+       end,
 
-       local function set(self, key, value)
+       __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 })
@@ -134,10 +134,14 @@ function threadlocal()
                        rawget(self, c)[key] = value
                end
        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
 
 
@@ -178,44 +182,18 @@ end
 -- String and data manipulation routines
 --
 
---- Escapes all occurrences of the given character in given string.
--- @param s    String value containing unescaped characters
--- @param c    String value with character to escape (optional, defaults to "\")
--- @return     String value with each occurrence of character escaped with "\"
-function escape(s, c)
-       c = c or "\\"
-       return s:gsub(c, "\\" .. c)
-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)
-       return value and tostring(value):gsub("[&\"'<>%c]", _pcdata_repl)
+       return value and tparser.pcdata(tostring(value))
 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(tostring(s):gsub("</?[A-Za-z][A-Za-z0-9:_%-]*[^>]*>", " "):gsub("%s+", " "))
+function striptags(value)
+       return value and tparser.striptags(tostring(value))
 end
 
 --- Splits given string on a defined separator sequence and return a table
@@ -279,6 +257,36 @@ function cmatch(str, pat)
        return count
 end
 
+--- Return a matching iterator for the given value. The iterator will return
+-- one token per invocation, the tokens are separated by whitespace. If the
+-- input value is a table, it is transformed into a string first. A nil value
+-- will result in a valid interator which aborts with the first invocation.
+-- @param val          The value to scan (table, string or nil)
+-- @return                     Iterator which returns one token per call
+function imatch(v)
+       if type(v) == "table" then
+               local k = nil
+               return function()
+                       k = next(v, k)
+                       return v[k]
+               end
+
+       elseif type(v) == "number" or type(v) == "boolean" then
+               local x = true
+               return function()
+                       if x then
+                               x = false
+                               return tostring(v)
+                       end
+               end
+
+       elseif type(v) == "userdata" or type(v) == "string" then
+               return tostring(v):gmatch("%S+")
+       end
+
+       return function() end
+end
+
 --- Parse certain units from the given string and return the canonical integer
 -- value or 0 if the unit is unknown. Upper- or lower case is irrelevant.
 -- Recognized units are:
@@ -339,7 +347,6 @@ function parse_units(ustr)
 end
 
 -- also register functions above in the central string class for convenience
-string.escape      = escape
 string.pcdata      = pcdata
 string.striptags   = striptags
 string.split       = split
@@ -522,7 +529,7 @@ function get_bytecode(val)
                code = string.dump( loadstring( "return " .. serialize_data(val) ) )
        end
 
-       return code and strip_bytecode(code)
+       return code -- and strip_bytecode(code)
 end
 
 --- Strips unnescessary lua bytecode from given string. Information like line
@@ -768,19 +775,19 @@ function copcall(f, ...)
 end
 
 -- Handle return value of protected call
-function handleReturnValue(err, co, status, arg1, arg2, arg3, arg4, arg5)
+function handleReturnValue(err, co, status, ...)
        if not status then
-               return false, err(debug.traceback(co, arg1), arg1, arg2, arg3, arg4, arg5)
+               return false, err(debug.traceback(co, (...)), ...)
        end
 
        if coroutine.status(co) ~= 'suspended' then
-               return true, arg1, arg2, arg3, arg4, arg5
+               return true, ...
        end
 
-       return performResume(err, co, coroutine.yield(arg1, arg2, arg3, arg4, arg5))
+       return performResume(err, co, coroutine.yield(...))
 end
 
 -- Resume execution of protected function call
-function performResume(err, co, arg1, arg2, arg3, arg4, arg5)
-       return handleReturnValue(err, co, coroutine.resume(co, arg1, arg2, arg3, arg4, arg5))
+function performResume(err, co, ...)
+       return handleReturnValue(err, co, coroutine.resume(co, ...))
 end