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 --- LuCI utility functions.
28 module("luci.util", package.seeall)
31 -- Pythonic string formatting extension
33 getmetatable("").__mod = function(a, b)
36 elseif type(b) == "table" then
37 return a:format(unpack(b))
45 -- Class helper routines
48 --- Create a Class object (Python-style object model).
49 -- The class object can be instantiated by calling itself.
50 -- Any class functions or shared parameters can be attached to this object.
51 -- Attaching a table to the class object makes this table shared between
52 -- all instances of this class. For object parameters use the __init__ function.
53 -- Classes can inherit member functions and values from a base class.
54 -- Class can be instantiated by calling them. All parameters will be passed
55 -- to the __init__ function of this class - if such a function exists.
56 -- The __init__ function must be used to set any object parameters that are not shared
57 -- with other objects of this class. Any return values will be ignored.
58 -- @param base The base class to inherit from (optional)
59 -- @return A class object
65 local create = function(class, ...)
67 setmetatable(inst, {__index = class})
70 local stat, err = copcall(inst.__init__, inst, ...)
79 local classmeta = {__call = create}
82 classmeta.__index = base
85 setmetatable(class, classmeta)
89 --- Test whether the given object is an instance of the given class.
90 -- @param object Object instance
91 -- @param class Class object to test against
92 -- @return Boolean indicating whether the object is an instance
95 function instanceof(object, class)
96 local meta = getmetatable(object)
97 while meta and meta.__index do
98 if meta.__index == class then
101 meta = getmetatable(meta.__index)
108 -- Scope manipulation routines
111 --- Replace a function scope with a shallow copy of itself.
112 -- This is useful if you want to get rid of several unwanted side effects
113 -- while changing the scope of a certain Lua function.
114 -- @param f Lua function
116 setfenv(f, clone(getfenv(f)))
119 --- Store given object associated with given key in the scope of a function.
120 -- @param f Lua function
121 -- @param key String value containg the key of the object to store
122 -- @param obj Object to store in the scope
123 -- @return Always nil
126 function extfenv(f, key, obj)
127 local scope = getfenv(f)
131 --- Extend the scope of a function with the contents of a table
132 -- @param f Lua function
133 -- @param key String value containg the key of the object to store
134 -- @param obj Object to store in the scope
135 -- @return Always nil
138 function updfenv(f, extscope)
139 update(getfenv(f), extscope)
142 --- Create a new or get an already existing thread local store associated with
143 -- the current active coroutine. A thread local store is private a table object
144 -- whose values can't be accessed from outside of the running coroutine.
145 -- @return Table value representing the corresponding thread local store
146 function threadlocal()
149 local function get(self, key)
150 local c = coroutine.running()
151 local thread = coxpt[c] or c or 0
152 if not rawget(self, thread) then
155 return rawget(self, thread)[key]
158 local function set(self, key, value)
159 local c = coroutine.running()
160 local thread = coxpt[c] or c or 0
161 if not rawget(self, thread) then
162 rawset(self, thread, {})
164 rawget(self, thread)[key] = value
167 setmetatable(tbl, {__index = get, __newindex = set, __mode = "k"})
174 -- Debugging routines
177 --- Write given object to stderr.
178 -- @param obj Value to write to stderr
179 -- @return Boolean indicating whether the write operation was successful
181 return io.stderr:write(tostring(obj) .. "\n")
184 --- Recursively dumps a table to stdout, useful for testing and debugging.
185 -- @param t Table value to dump
186 -- @param i Number of tabs to prepend to each line
187 -- @return Always nil
188 function dumptable(t, i, seen)
190 seen = seen or setmetatable({}, {__mode="k"})
192 for k,v in pairs(t) do
193 perror(string.rep("\t", i) .. tostring(k) .. "\t" .. tostring(v))
194 if type(v) == "table" then
197 dumptable(v, i+1, seen)
199 perror(string.rep("\t", i) .. "*** RECURSION ***")
207 -- String and data manipulation routines
210 --- Escapes all occurrences of the given character in given string.
211 -- @param s String value containing unescaped characters
212 -- @param c String value with character to escape (optional, defaults to "\")
213 -- @return String value with each occurrence of character escaped with "\"
214 function escape(s, c)
216 return s:gsub(c, "\\" .. c)
219 --- Create valid XML PCDATA from given string.
220 -- @param value String value containing the data to escape
221 -- @return String value containing the escaped data
222 function pcdata(value)
223 if not value then return end
224 value = tostring(value)
225 value = value:gsub("&", "&")
226 value = value:gsub('"', """)
227 value = value:gsub("'", "'")
228 value = value:gsub("<", "<")
229 return value:gsub(">", ">")
232 --- Strip HTML tags from given string.
233 -- @param value String containing the HTML text
234 -- @return String with HTML tags stripped of
235 function striptags(s)
236 return pcdata(s:gsub("</?[A-Za-z][A-Za-z0-9:_%-]*[^>]*>", " "):gsub("%s+", " "))
239 --- Splits given string on a defined separator sequence and return a table
240 -- containing the resulting substrings. The optional max parameter specifies
241 -- the number of bytes to process, regardless of the actual length of the given
242 -- string. The optional last parameter, regex, specifies whether the separator
243 -- sequence is interpreted as regular expression.
244 -- @param str String value containing the data to split up
245 -- @param pat String with separator pattern (optional, defaults to "\n")
246 -- @param max Maximum times to split (optional)
247 -- @param regex Boolean indicating whether to interpret the separator
248 -- pattern as regular expression (optional, default is false)
249 -- @return Table containing the resulting substrings
250 function split(str, pat, max, regex)
270 local s, e = str:find(pat, c, not regex)
272 if s and max < 0 then
273 table.insert(t, str:sub(c))
275 table.insert(t, str:sub(c, s and s - 1))
277 c = e and e + 1 or #str + 1
278 until not s or max < 0
283 --- Remove leading and trailing whitespace from given string value.
284 -- @param str String value containing whitespace padded data
285 -- @return String value with leading and trailing space removed
287 local s = str:gsub("^%s*(.-)%s*$", "%1")
291 --- Parse certain units from the given string and return the canonical integer
292 -- value or 0 if the unit is unknown. Upper- or lower case is irrelevant.
293 -- Recognized units are:
294 -- o "y" - one year (60*60*24*366)
295 -- o "m" - one month (60*60*24*31)
296 -- o "w" - one week (60*60*24*7)
297 -- o "d" - one day (60*60*24)
298 -- o "h" - one hour (60*60)
299 -- o "min" - one minute (60)
300 -- o "kb" - one kilobyte (1024)
301 -- o "mb" - one megabyte (1024*1024)
302 -- o "gb" - one gigabyte (1024*1024*1024)
303 -- o "kib" - one si kilobyte (1000)
304 -- o "mib" - one si megabyte (1000*1000)
305 -- o "gib" - one si gigabyte (1000*1000*1000)
306 -- @param ustr String containing a numerical value with trailing unit
307 -- @return Number containing the canonical value
308 function parse_units(ustr)
315 y = 60 * 60 * 24 * 366,
316 m = 60 * 60 * 24 * 31,
317 w = 60 * 60 * 24 * 7,
325 gb = 1024 * 1024 * 1024,
327 -- storage sizes (si)
330 gib = 1000 * 1000 * 1000
333 -- parse input string
334 for spec in ustr:lower():gmatch("[0-9%.]+[a-zA-Z]*") do
336 local num = spec:gsub("[^0-9%.]+$","")
337 local spn = spec:gsub("^[0-9%.]+", "")
339 if map[spn] or map[spn:sub(1,1)] then
340 val = val + num * ( map[spn] or map[spn:sub(1,1)] )
350 --- Combines two or more numerically indexed tables into one.
351 -- @param tbl1 Table value to combine
352 -- @param tbl2 Table value to combine
353 -- @param ... More tables to combine
354 -- @return Table value containing all values of given tables
355 function combine(...)
357 for i, a in ipairs(arg) do
358 for j, v in ipairs(a) do
359 table.insert(result, v)
365 --- Checks whether the given table contains the given value.
366 -- @param table Table value
367 -- @param value Value to search within the given table
368 -- @return Boolean indicating whether the given value occurs within table
369 function contains(table, value)
370 for k, v in pairs(table) do
378 --- Update values in given table with the values from the second given table.
379 -- Both table are - in fact - merged together.
380 -- @param t Table which should be updated
381 -- @param updates Table containing the values to update
382 -- @return Always nil
383 function update(t, updates)
384 for k, v in pairs(updates) do
389 --- Retrieve all keys of given associative table.
390 -- @param t Table to extract keys from
391 -- @return Sorted table containing the keys
395 for k, _ in kspairs(t) do
396 table.insert( keys, k )
402 --- Clones the given object and return it's copy.
403 -- @param object Table value to clone
404 -- @param deep Boolean indicating whether to do recursive cloning
405 -- @return Cloned table value
406 function clone(object, deep)
409 for k, v in pairs(object) do
410 if deep and type(v) == "table" then
416 setmetatable(copy, getmetatable(object))
422 --- Create a dynamic table which automatically creates subtables.
423 -- @return Dynamic Table
425 return setmetatable({}, { __index =
427 return rawget(tbl, key)
428 or rawget(rawset(tbl, key, dtable()), key)
434 -- Serialize the contents of a table value.
435 function _serialize_table(t, seen)
436 assert(not seen[t], "Recursion detected.")
441 local v = serialize_data(t[i], seen)
442 data = data .. ( #data > 0 and ", " or "" ) .. v
444 for k, v in pairs(t) do
445 if type(k) ~= "number" then
446 k = serialize_data(k, seen)
447 v = serialize_data(v, seen)
448 data = data .. ( #data > 0 and ", " or "" ) ..
449 '[' .. k .. '] = ' .. v
455 --- Recursively serialize given data to lua code, suitable for restoring
456 -- with loadstring().
457 -- @param val Value containing the data to serialize
458 -- @return String value containing the serialized code
461 function serialize_data(val, seen)
462 seen = seen or setmetatable({}, {__mode="k"})
466 elseif type(val) == "number" then
468 elseif type(val) == "string" then
469 return string.format("%q", val)
470 elseif type(val) == "boolean" then
471 return val and "true" or "false"
472 elseif type(val) == "function" then
473 return string.format("loadstring(%q)", get_bytecode(val))
474 elseif type(val) == "table" then
475 return "{ " .. _serialize_table(val, seen) .. " }"
477 return '"[unhandled data type:' .. type(val) .. ']"'
481 --- Restore data previously serialized with serialize_data().
482 -- @param str String containing the data to restore
483 -- @return Value containing the restored data structure
484 -- @see serialize_data
486 function restore_data(str)
487 return loadstring("return " .. str)()
492 -- Byte code manipulation routines
495 --- Return the current runtime bytecode of the given data. The byte code
496 -- will be stripped before it is returned.
497 -- @param val Value to return as bytecode
498 -- @return String value containing the bytecode of the given data
499 function get_bytecode(val)
502 if type(val) == "function" then
503 code = string.dump(val)
505 code = string.dump( loadstring( "return " .. serialize_data(val) ) )
508 return code and strip_bytecode(code)
511 --- Strips unnescessary lua bytecode from given string. Information like line
512 -- numbers and debugging numbers will be discarded. Original version by
513 -- Peter Cawley (http://lua-users.org/lists/lua-l/2008-02/msg01158.html)
514 -- @param code String value containing the original lua byte code
515 -- @return String value containing the stripped lua byte code
516 function strip_bytecode(code)
517 local version, format, endian, int, size, ins, num, lnum = code:byte(5, 12)
520 subint = function(code, i, l)
523 val = val * 256 + code:byte(i + n - 1)
528 subint = function(code, i, l)
531 val = val * 256 + code:byte(i + n - 1)
538 strip_function = function(code)
539 local count, offset = subint(code, 1, size)
540 local stripped, dirty = string.rep("\0", size), offset + count
541 offset = offset + count + int * 2 + 4
542 offset = offset + int + subint(code, offset, int) * ins
543 count, offset = subint(code, offset, int)
546 t, offset = subint(code, offset, 1)
550 offset = offset + size + subint(code, offset, size)
552 offset = offset + num
553 elseif t == 254 or t == 9 then
554 offset = offset + lnum
557 count, offset = subint(code, offset, int)
558 stripped = stripped .. code:sub(dirty, offset - 1)
560 local proto, off = strip_function(code:sub(offset, -1))
561 stripped, offset = stripped .. proto, offset + off - 1
563 offset = offset + subint(code, offset, int) * int + int
564 count, offset = subint(code, offset, int)
566 offset = offset + subint(code, offset, size) + size + int * 2
568 count, offset = subint(code, offset, int)
570 offset = offset + subint(code, offset, size) + size
572 stripped = stripped .. string.rep("\0", int * 3)
573 return stripped, offset
576 return code:sub(1,12) .. strip_function(code:sub(13,-1))
581 -- Sorting iterator functions
584 function _sortiter( t, f )
587 for k, v in pairs(t) do
588 table.insert( keys, k )
592 local _len = table.getn( keys )
594 table.sort( keys, f )
599 return keys[_pos], t[keys[_pos]]
604 --- Return a key, value iterator which returns the values sorted according to
605 -- the provided callback function.
606 -- @param t The table to iterate
607 -- @param f A callback function to decide the order of elements
608 -- @return Function value containing the corresponding iterator
610 return _sortiter( t, f )
613 --- Return a key, value iterator for the given table.
614 -- The table pairs are sorted by key.
615 -- @param t The table to iterate
616 -- @return Function value containing the corresponding iterator
618 return _sortiter( t )
621 --- Return a key, value iterator for the given table.
622 -- The table pairs are sorted by value.
623 -- @param t The table to iterate
624 -- @return Function value containing the corresponding iterator
626 return _sortiter( t, function (a,b) return t[a] < t[b] end )
631 -- System utility functions
634 --- Test whether the current system is operating in big endian mode.
635 -- @return Boolean value indicating whether system is big endian
637 return string.byte(string.dump(function() end), 7) == 0
640 --- Execute given commandline and gather stdout.
641 -- @param command String containing command to execute
642 -- @return String containing the command's stdout
643 function exec(command)
644 local pp = io.popen(command)
645 local data = pp:read("*a")
651 --- Return a line-buffered iterator over the output of given command.
652 -- @param command String containing the command to execute
654 function execi(command)
655 local pp = io.popen(command)
657 return pp and function()
658 local line = pp:read()
669 function execl(command)
670 local pp = io.popen(command)
676 if (line == nil) then break end
677 table.insert(data, line)
684 --- Returns the absolute path to LuCI base directory.
685 -- @return String containing the directory path
687 return luci.fs.dirname(require("luci.debug").__file__)
692 -- Coroutine safe xpcall and pcall versions modified for Luci
694 -- coxpcall 1.13 - Copyright 2005 - Kepler Project (www.keplerproject.org)
696 -- Copyright © 2005 Kepler Project.
697 -- Permission is hereby granted, free of charge, to any person obtaining a
698 -- copy of this software and associated documentation files (the "Software"),
699 -- to deal in the Software without restriction, including without limitation
700 -- the rights to use, copy, modify, merge, publish, distribute, sublicense,
701 -- and/or sell copies of the Software, and to permit persons to whom the
702 -- Software is furnished to do so, subject to the following conditions:
704 -- The above copyright notice and this permission notice shall be
705 -- included in all copies or substantial portions of the Software.
707 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
708 -- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
709 -- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
710 -- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
711 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
712 -- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
713 -- OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
715 local performResume, handleReturnValue
716 local oldpcall, oldxpcall = pcall, xpcall
718 setmetatable(coxpt, {__mode = "kv"})
720 -- Identity function for copcall
721 local function copcall_id(trace, ...)
725 --- This is a coroutine-safe drop-in replacement for Lua's "xpcall"-function
726 -- @param f Lua function to be called protected
727 -- @param err Custom error handler
728 -- @param ... Parameters passed to the function
729 -- @return A boolean whether the function call succeeded and the return
730 -- values of either the function or the error handler
731 function coxpcall(f, err, ...)
732 local res, co = oldpcall(coroutine.create, f)
735 local newf = function() return f(unpack(params)) end
736 co = coroutine.create(newf)
738 local c = coroutine.running()
739 coxpt[co] = coxpt[c] or c or 0
741 return performResume(err, co, ...)
744 --- This is a coroutine-safe drop-in replacement for Lua's "pcall"-function
745 -- @param f Lua function to be called protected
746 -- @param ... Parameters passed to the function
747 -- @return A boolean whether the function call succeeded and the returns
748 -- values of the function or the error object
749 function copcall(f, ...)
750 return coxpcall(f, copcall_id, ...)
753 -- Handle return value of protected call
754 function handleReturnValue(err, co, status, ...)
756 return false, err(debug.traceback(co, (...)), ...)
758 if coroutine.status(co) == 'suspended' then
759 return performResume(err, co, coroutine.yield(...))
765 -- Resume execution of protected function call
766 function performResume(err, co, ...)
767 return handleReturnValue(err, co, coroutine.resume(co, ...))