5 Several common useful Lua functions
11 Copyright 2008 Steven Barth <steven@midlink.org>
13 Licensed under the Apache License, Version 2.0 (the "License");
14 you may not use this file except in compliance with the License.
15 You may obtain a copy of the License at
17 http://www.apache.org/licenses/LICENSE-2.0
19 Unless required by applicable law or agreed to in writing, software
20 distributed under the License is distributed on an "AS IS" BASIS,
21 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 See the License for the specific language governing permissions and
23 limitations under the License.
27 local io = require "io"
28 local math = require "math"
29 local table = require "table"
30 local debug = require "debug"
31 local ldebug = require "luci.debug"
32 local string = require "string"
33 local coroutine = require "coroutine"
35 local getmetatable, setmetatable = getmetatable, setmetatable
36 local rawget, rawset, unpack = rawget, rawset, unpack
37 local tostring, type, assert = tostring, type, assert
38 local ipairs, pairs, loadstring = ipairs, pairs, loadstring
39 local require, pcall, xpcall = require, pcall, xpcall
41 --- LuCI utility functions.
45 -- Pythonic string formatting extension
47 getmetatable("").__mod = function(a, b)
50 elseif type(b) == "table" then
51 return a:format(unpack(b))
59 -- Class helper routines
62 -- Instantiates a class
63 local function _instantiate(class, ...)
64 local inst = setmetatable({}, {__index = class})
73 --- Create a Class object (Python-style object model).
74 -- The class object can be instantiated by calling itself.
75 -- Any class functions or shared parameters can be attached to this object.
76 -- Attaching a table to the class object makes this table shared between
77 -- all instances of this class. For object parameters use the __init__ function.
78 -- Classes can inherit member functions and values from a base class.
79 -- Class can be instantiated by calling them. All parameters will be passed
80 -- to the __init__ function of this class - if such a function exists.
81 -- The __init__ function must be used to set any object parameters that are not shared
82 -- with other objects of this class. Any return values will be ignored.
83 -- @param base The base class to inherit from (optional)
84 -- @return A class object
88 return setmetatable({}, {
89 __call = _instantiate,
94 --- Test whether the given object is an instance of the given class.
95 -- @param object Object instance
96 -- @param class Class object to test against
97 -- @return Boolean indicating whether the object is an instance
100 function instanceof(object, class)
101 local meta = getmetatable(object)
102 while meta and meta.__index do
103 if meta.__index == class then
106 meta = getmetatable(meta.__index)
113 -- Scope manipulation routines
116 --- Create a new or get an already existing thread local store associated with
117 -- the current active coroutine. A thread local store is private a table object
118 -- whose values can't be accessed from outside of the running coroutine.
119 -- @return Table value representing the corresponding thread local store
120 function threadlocal()
123 local function get(self, key)
124 local c = coroutine.running()
125 local thread = coxpt[c] or c or 0
126 if not rawget(self, thread) then
129 return rawget(self, thread)[key]
132 local function set(self, key, value)
133 local c = coroutine.running()
134 local thread = coxpt[c] or c or 0
135 if not rawget(self, thread) then
136 rawset(self, thread, {})
138 rawget(self, thread)[key] = value
141 setmetatable(tbl, {__index = get, __newindex = set, __mode = "k"})
148 -- Debugging routines
151 --- Write given object to stderr.
152 -- @param obj Value to write to stderr
153 -- @return Boolean indicating whether the write operation was successful
155 return io.stderr:write(tostring(obj) .. "\n")
158 --- Recursively dumps a table to stdout, useful for testing and debugging.
159 -- @param t Table value to dump
160 -- @param maxdepth Maximum depth
161 -- @return Always nil
162 function dumptable(t, maxdepth, i, seen)
164 seen = seen or setmetatable({}, {__mode="k"})
166 for k,v in pairs(t) do
167 perror(string.rep("\t", i) .. tostring(k) .. "\t" .. tostring(v))
168 if type(v) == "table" and (not maxdepth or i < maxdepth) then
171 dumptable(v, maxdepth, i+1, seen)
173 perror(string.rep("\t", i) .. "*** RECURSION ***")
181 -- String and data manipulation routines
184 --- Escapes all occurrences of the given character in given string.
185 -- @param s String value containing unescaped characters
186 -- @param c String value with character to escape (optional, defaults to "\")
187 -- @return String value with each occurrence of character escaped with "\"
188 function escape(s, c)
190 return s:gsub(c, "\\" .. c)
193 --- Create valid XML PCDATA from given string.
194 -- @param value String value containing the data to escape
195 -- @return String value containing the escaped data
196 function pcdata(value)
197 return value and tostring(value):gsub("[&\"'<>]", {
206 --- Strip HTML tags from given string.
207 -- @param value String containing the HTML text
208 -- @return String with HTML tags stripped of
209 function striptags(s)
210 return pcdata(s:gsub("</?[A-Za-z][A-Za-z0-9:_%-]*[^>]*>", " "):gsub("%s+", " "))
213 --- Splits given string on a defined separator sequence and return a table
214 -- containing the resulting substrings. The optional max parameter specifies
215 -- the number of bytes to process, regardless of the actual length of the given
216 -- string. The optional last parameter, regex, specifies whether the separator
217 -- sequence is interpreted as regular expression.
218 -- @param str String value containing the data to split up
219 -- @param pat String with separator pattern (optional, defaults to "\n")
220 -- @param max Maximum times to split (optional)
221 -- @param regex Boolean indicating whether to interpret the separator
222 -- pattern as regular expression (optional, default is false)
223 -- @return Table containing the resulting substrings
224 function split(str, pat, max, regex)
244 local s, e = str:find(pat, c, not regex)
246 if s and max < 0 then
249 t[#t+1] = str:sub(c, s and s - 1)
251 c = e and e + 1 or #str + 1
252 until not s or max < 0
257 --- Remove leading and trailing whitespace from given string value.
258 -- @param str String value containing whitespace padded data
259 -- @return String value with leading and trailing space removed
261 return (str:gsub("^%s*(.-)%s*$", "%1"))
264 --- Parse certain units from the given string and return the canonical integer
265 -- value or 0 if the unit is unknown. Upper- or lower case is irrelevant.
266 -- Recognized units are:
267 -- o "y" - one year (60*60*24*366)
268 -- o "m" - one month (60*60*24*31)
269 -- o "w" - one week (60*60*24*7)
270 -- o "d" - one day (60*60*24)
271 -- o "h" - one hour (60*60)
272 -- o "min" - one minute (60)
273 -- o "kb" - one kilobyte (1024)
274 -- o "mb" - one megabyte (1024*1024)
275 -- o "gb" - one gigabyte (1024*1024*1024)
276 -- o "kib" - one si kilobyte (1000)
277 -- o "mib" - one si megabyte (1000*1000)
278 -- o "gib" - one si gigabyte (1000*1000*1000)
279 -- @param ustr String containing a numerical value with trailing unit
280 -- @return Number containing the canonical value
281 function parse_units(ustr)
288 y = 60 * 60 * 24 * 366,
289 m = 60 * 60 * 24 * 31,
290 w = 60 * 60 * 24 * 7,
298 gb = 1024 * 1024 * 1024,
300 -- storage sizes (si)
303 gib = 1000 * 1000 * 1000
306 -- parse input string
307 for spec in ustr:lower():gmatch("[0-9%.]+[a-zA-Z]*") do
309 local num = spec:gsub("[^0-9%.]+$","")
310 local spn = spec:gsub("^[0-9%.]+", "")
312 if map[spn] or map[spn:sub(1,1)] then
313 val = val + num * ( map[spn] or map[spn:sub(1,1)] )
323 --- Combines two or more numerically indexed tables into one.
324 -- @param tbl1 Table value to combine
325 -- @param tbl2 Table value to combine
326 -- @param ... More tables to combine
327 -- @return Table value containing all values of given tables
328 function combine(...)
330 for i, a in ipairs(arg) do
331 for j, v in ipairs(a) do
332 result[#result+1] = v
338 --- Checks whether the given table contains the given value.
339 -- @param table Table value
340 -- @param value Value to search within the given table
341 -- @return Boolean indicating whether the given value occurs within table
342 function contains(table, value)
343 for k, v in pairs(table) do
351 --- Update values in given table with the values from the second given table.
352 -- Both table are - in fact - merged together.
353 -- @param t Table which should be updated
354 -- @param updates Table containing the values to update
355 -- @return Always nil
356 function update(t, updates)
357 for k, v in pairs(updates) do
362 --- Retrieve all keys of given associative table.
363 -- @param t Table to extract keys from
364 -- @return Sorted table containing the keys
368 for k, _ in kspairs(t) do
375 --- Clones the given object and return it's copy.
376 -- @param object Table value to clone
377 -- @param deep Boolean indicating whether to do recursive cloning
378 -- @return Cloned table value
379 function clone(object, deep)
382 for k, v in pairs(object) do
383 if deep and type(v) == "table" then
389 return setmetatable(copy, getmetatable(object))
393 --- Create a dynamic table which automatically creates subtables.
394 -- @return Dynamic Table
396 return setmetatable({}, { __index =
398 return rawget(tbl, key)
399 or rawget(rawset(tbl, key, dtable()), key)
405 -- Serialize the contents of a table value.
406 function _serialize_table(t, seen)
407 assert(not seen[t], "Recursion detected.")
414 for k, v in pairs(t) do
415 if type(k) ~= "number" or k < 1 or math.floor(k) ~= k or ( k - #t ) > 3 then
416 k = serialize_data(k, seen)
417 v = serialize_data(v, seen)
418 data = data .. ( #data > 0 and ", " or "" ) ..
419 '[' .. k .. '] = ' .. v
426 local v = serialize_data(t[i], seen)
427 idata = idata .. ( #idata > 0 and ", " or "" ) .. v
430 return idata .. ( #data > 0 and #idata > 0 and ", " or "" ) .. data
433 --- Recursively serialize given data to lua code, suitable for restoring
434 -- with loadstring().
435 -- @param val Value containing the data to serialize
436 -- @return String value containing the serialized code
439 function serialize_data(val, seen)
440 seen = seen or setmetatable({}, {__mode="k"})
444 elseif type(val) == "number" then
446 elseif type(val) == "string" then
448 elseif type(val) == "boolean" then
449 return val and "true" or "false"
450 elseif type(val) == "function" then
451 return "loadstring(%q)" % get_bytecode(val)
452 elseif type(val) == "table" then
453 return "{ " .. _serialize_table(val, seen) .. " }"
455 return '"[unhandled data type:' .. type(val) .. ']"'
459 --- Restore data previously serialized with serialize_data().
460 -- @param str String containing the data to restore
461 -- @return Value containing the restored data structure
462 -- @see serialize_data
464 function restore_data(str)
465 return loadstring("return " .. str)()
470 -- Byte code manipulation routines
473 --- Return the current runtime bytecode of the given data. The byte code
474 -- will be stripped before it is returned.
475 -- @param val Value to return as bytecode
476 -- @return String value containing the bytecode of the given data
477 function get_bytecode(val)
480 if type(val) == "function" then
481 code = string.dump(val)
483 code = string.dump( loadstring( "return " .. serialize_data(val) ) )
486 return code and strip_bytecode(code)
489 --- Strips unnescessary lua bytecode from given string. Information like line
490 -- numbers and debugging numbers will be discarded. Original version by
491 -- Peter Cawley (http://lua-users.org/lists/lua-l/2008-02/msg01158.html)
492 -- @param code String value containing the original lua byte code
493 -- @return String value containing the stripped lua byte code
494 function strip_bytecode(code)
495 local version, format, endian, int, size, ins, num, lnum = code:byte(5, 12)
498 subint = function(code, i, l)
501 val = val * 256 + code:byte(i + n - 1)
506 subint = function(code, i, l)
509 val = val * 256 + code:byte(i + n - 1)
516 strip_function = function(code)
517 local count, offset = subint(code, 1, size)
518 local stripped, dirty = string.rep("\0", size), offset + count
519 offset = offset + count + int * 2 + 4
520 offset = offset + int + subint(code, offset, int) * ins
521 count, offset = subint(code, offset, int)
524 t, offset = subint(code, offset, 1)
528 offset = offset + size + subint(code, offset, size)
530 offset = offset + num
531 elseif t == 254 or t == 9 then
532 offset = offset + lnum
535 count, offset = subint(code, offset, int)
536 stripped = stripped .. code:sub(dirty, offset - 1)
538 local proto, off = strip_function(code:sub(offset, -1))
539 stripped, offset = stripped .. proto, offset + off - 1
541 offset = offset + subint(code, offset, int) * int + int
542 count, offset = subint(code, offset, int)
544 offset = offset + subint(code, offset, size) + size + int * 2
546 count, offset = subint(code, offset, int)
548 offset = offset + subint(code, offset, size) + size
550 stripped = stripped .. string.rep("\0", int * 3)
551 return stripped, offset
554 return code:sub(1,12) .. strip_function(code:sub(13,-1))
559 -- Sorting iterator functions
562 function _sortiter( t, f )
565 for k, v in pairs(t) do
571 table.sort( keys, f )
575 if _pos <= #keys then
576 return keys[_pos], t[keys[_pos]]
581 --- Return a key, value iterator which returns the values sorted according to
582 -- the provided callback function.
583 -- @param t The table to iterate
584 -- @param f A callback function to decide the order of elements
585 -- @return Function value containing the corresponding iterator
587 return _sortiter( t, f )
590 --- Return a key, value iterator for the given table.
591 -- The table pairs are sorted by key.
592 -- @param t The table to iterate
593 -- @return Function value containing the corresponding iterator
595 return _sortiter( t )
598 --- Return a key, value iterator for the given table.
599 -- The table pairs are sorted by value.
600 -- @param t The table to iterate
601 -- @return Function value containing the corresponding iterator
603 return _sortiter( t, function (a,b) return t[a] < t[b] end )
608 -- System utility functions
611 --- Test whether the current system is operating in big endian mode.
612 -- @return Boolean value indicating whether system is big endian
614 return string.byte(string.dump(function() end), 7) == 0
617 --- Execute given commandline and gather stdout.
618 -- @param command String containing command to execute
619 -- @return String containing the command's stdout
620 function exec(command)
621 local pp = io.popen(command)
622 local data = pp:read("*a")
628 --- Return a line-buffered iterator over the output of given command.
629 -- @param command String containing the command to execute
631 function execi(command)
632 local pp = io.popen(command)
634 return pp and function()
635 local line = pp:read()
646 function execl(command)
647 local pp = io.popen(command)
653 if (line == nil) then break end
661 --- Returns the absolute path to LuCI base directory.
662 -- @return String containing the directory path
664 return require "luci.fs".dirname(ldebug.__file__)
669 -- Coroutine safe xpcall and pcall versions modified for Luci
671 -- coxpcall 1.13 - Copyright 2005 - Kepler Project (www.keplerproject.org)
673 -- Copyright © 2005 Kepler Project.
674 -- Permission is hereby granted, free of charge, to any person obtaining a
675 -- copy of this software and associated documentation files (the "Software"),
676 -- to deal in the Software without restriction, including without limitation
677 -- the rights to use, copy, modify, merge, publish, distribute, sublicense,
678 -- and/or sell copies of the Software, and to permit persons to whom the
679 -- Software is furnished to do so, subject to the following conditions:
681 -- The above copyright notice and this permission notice shall be
682 -- included in all copies or substantial portions of the Software.
684 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
685 -- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
686 -- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
687 -- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
688 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
689 -- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
690 -- OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
692 local performResume, handleReturnValue
693 local oldpcall, oldxpcall = pcall, xpcall
695 setmetatable(coxpt, {__mode = "kv"})
697 -- Identity function for copcall
698 local function copcall_id(trace, ...)
702 --- This is a coroutine-safe drop-in replacement for Lua's "xpcall"-function
703 -- @param f Lua function to be called protected
704 -- @param err Custom error handler
705 -- @param ... Parameters passed to the function
706 -- @return A boolean whether the function call succeeded and the return
707 -- values of either the function or the error handler
708 function coxpcall(f, err, ...)
709 local res, co = oldpcall(coroutine.create, f)
712 local newf = function() return f(unpack(params)) end
713 co = coroutine.create(newf)
715 local c = coroutine.running()
716 coxpt[co] = coxpt[c] or c or 0
718 return performResume(err, co, ...)
721 --- This is a coroutine-safe drop-in replacement for Lua's "pcall"-function
722 -- @param f Lua function to be called protected
723 -- @param ... Parameters passed to the function
724 -- @return A boolean whether the function call succeeded and the returns
725 -- values of the function or the error object
726 function copcall(f, ...)
727 return coxpcall(f, copcall_id, ...)
730 -- Handle return value of protected call
731 function handleReturnValue(err, co, status, ...)
733 return false, err(debug.traceback(co, (...)), ...)
735 if coroutine.status(co) == 'suspended' then
736 return performResume(err, co, coroutine.yield(...))
742 -- Resume execution of protected function call
743 function performResume(err, co, ...)
744 return handleReturnValue(err, co, coroutine.resume(co, ...))