* luci/libs: util: further enhancements to table serialisation
[project/luci.git] / libs / core / luasrc / util.lua
index 2f6cfad..bf463ae 100644 (file)
@@ -28,6 +28,20 @@ limitations under the License.
 module("luci.util", package.seeall)
 
 --
+-- Pythonic string formatting extension
+--
+getmetatable("").__mod = function(a, b)
+       if not b then
+               return a
+       elseif type(b) == "table" then
+               return a:format(unpack(b))
+       else
+               return a:format(b)
+       end
+end
+
+
+--
 -- Class helper routines
 --
 
@@ -171,12 +185,19 @@ end
 -- @param t    Table value to dump
 -- @param i    Number of tabs to prepend to each line
 -- @return     Always nil
-function dumptable(t, i)
+function dumptable(t, i, seen)
        i = i or 0
+       seen = seen or setmetatable({}, {__mode="k"})
+       
        for k,v in pairs(t) do
-               print(string.rep("\t", i) .. tostring(k), tostring(v))
+               perror(string.rep("\t", i) .. tostring(k) .. "\t" .. tostring(v))
                if type(v) == "table" then
-                       dumptable(v, i+1)
+                       if not seen[v] then
+                               seen[v] = true
+                               dumptable(v, i+1, seen)
+                       else
+                               perror(string.rep("\t", i) .. "*** RECURSION ***")
+                       end
                end
        end
 end
@@ -199,6 +220,8 @@ end
 -- @param value        String value containing the data to escape
 -- @return             String value containing the escaped data
 function pcdata(value)
+       if not value then return end
+       value = tostring(value)
        value = value:gsub("&", "&")
        value = value:gsub('"', """)
        value = value:gsub("'", "'")
@@ -206,6 +229,13 @@ function pcdata(value)
        return value:gsub(">", ">")
 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+", " "))
+end
+
 --- Splits given string on a defined separator sequence and return a table
 -- containing the resulting substrings. The optional max parameter specifies
 -- the number of bytes to process, regardless of the actual length of the given
@@ -356,6 +386,19 @@ function update(t, updates)
        end
 end
 
+--- Retrieve all keys of given associative table.
+-- @param t    Table to extract keys from
+-- @return     Sorted table containing the keys
+function keys(t)
+       local keys = { }
+       if t then
+               for k, _ in kspairs(t) do
+                       table.insert( keys, k )
+               end
+       end
+       return keys
+end
+
 --- Clones the given object and return it's copy.
 -- @param object       Table value to clone
 -- @param deep         Boolean indicating whether to do recursive cloning
@@ -389,15 +432,31 @@ end
 
 
 -- Serialize the contents of a table value.
-function _serialize_table(t)
-       local data = ""
+function _serialize_table(t, seen)
+       assert(not seen[t], "Recursion detected.")
+       seen[t] = true
+       
+       local data  = ""
+       local idata = ""
+       local ilen  = 0
+
        for k, v in pairs(t) do
-               k = serialize_data(k)
-               v = serialize_data(v)
-               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 ", " or "" ) .. data
 end
 
 --- Recursively serialize given data to lua code, suitable for restoring
@@ -406,7 +465,9 @@ end
 -- @return             String value containing the serialized code
 -- @see                        restore_data
 -- @see                        get_bytecode
-function serialize_data(val)
+function serialize_data(val, seen)
+       seen = seen or setmetatable({}, {__mode="k"})
+       
        if val == nil then
                return "nil"
        elseif type(val) == "number" then
@@ -418,7 +479,7 @@ function serialize_data(val)
        elseif type(val) == "function" then
                return string.format("loadstring(%q)", get_bytecode(val))
        elseif type(val) == "table" then
-               return "{ " .. _serialize_table(val) .. " }"
+               return "{ " .. _serialize_table(val, seen) .. " }"
        else
                return '"[unhandled data type:' .. type(val) .. ']"'
        end
@@ -594,9 +655,24 @@ function exec(command)
        return data
 end
 
---- Execute given commandline and gather stdout.
+--- Return a line-buffered iterator over the output of given command.
 -- @param command      String containing the command to execute
--- @return                     Table containing the command's stdout splitted up in lines
+-- @return                     Iterator
+function execi(command)
+       local pp = io.popen(command)
+
+       return pp and function()
+               local line = pp:read()
+               
+               if not line then
+                       pp:close()
+               end
+               
+               return line
+       end
+end
+
+-- Deprecated
 function execl(command)
        local pp   = io.popen(command)
        local line = ""
@@ -612,11 +688,36 @@ function execl(command)
        return data
 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__)
+end
+
+
 --
 -- Coroutine safe xpcall and pcall versions modified for Luci
 -- original version:
 -- coxpcall 1.13 - Copyright 2005 - Kepler Project (www.keplerproject.org)
 --
+-- Copyright © 2005 Kepler Project.
+-- Permission is hereby granted, free of charge, to any person obtaining a
+-- copy of this software and associated documentation files (the "Software"),
+-- to deal in the Software without restriction, including without limitation
+-- the rights to use, copy, modify, merge, publish, distribute, sublicense,
+-- and/or sell copies of the Software, and to permit persons to whom the
+-- Software is furnished to do so, subject to the following conditions:
+--
+-- The above copyright notice and this permission notice shall be
+-- included in all copies or substantial portions of the Software.
+--
+-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+-- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+-- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+-- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+-- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+-- OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 local performResume, handleReturnValue
 local oldpcall, oldxpcall = pcall, xpcall