5 Utilities for interaction with the Linux system
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.
28 local io = require "io"
29 local os = require "os"
30 local posix = require "posix"
31 local table = require "table"
34 luci.util = require "luci.util"
35 luci.fs = require "luci.fs"
36 luci.ip = require "luci.ip"
38 local tonumber, ipairs, pairs, pcall = tonumber, ipairs, pairs, pcall
41 --- LuCI Linux and POSIX system utilities.
44 --- Execute a given shell command and return the error code
47 -- @param ... Command to call
48 -- @return Error code of the command
50 return os.execute(...) / 256
53 --- Execute a given shell command and capture its standard output
56 -- @param command Command to call
57 -- @return String containg the return the output of the command
60 --- Invoke the luci-flash executable to write an image to the flash memory.
61 -- @param image Local path or URL to image file
62 -- @param kpattern Pattern of files to keep over flash process
63 -- @return Return value of os.execute()
64 function flash(image, kpattern)
65 local cmd = "luci-flash "
67 cmd = cmd .. "-k '" .. kpattern:gsub("'", "") .. "' "
69 cmd = cmd .. "'" .. image:gsub("'", "") .. "' >/dev/null 2>&1"
71 return os.execute(cmd)
74 --- Retrieve information about currently mounted file systems.
75 -- @return Table containing mount information
78 local k = {"fs", "blocks", "used", "available", "percent", "mountpoint"}
79 local ps = luci.util.execi("df")
91 for value in line:gmatch("[^%s]+") do
98 -- this is a rather ugly workaround to cope with wrapped lines in
101 -- /dev/scsi/host0/bus0/target0/lun0/part3
102 -- 114382024 93566472 15005244 86% /mnt/usb
105 if not row[k[2]] then
108 for value in line:gmatch("[^%s]+") do
114 table.insert(data, row)
121 --- Retrieve environment variables. If no variable is given then a table
122 -- containing the whole environment is returned otherwise this function returns
123 -- the corresponding string value for the given name or nil if no such variable
127 -- @param var Name of the environment variable to retrieve (optional)
128 -- @return String containg the value of the specified variable
129 -- @return Table containing all variables if no variable name is given
130 getenv = posix.getenv
132 --- Determine the current hostname.
133 -- @return String containing the system hostname
135 return posix.uname("%n")
138 --- Returns the contents of a documented referred by an URL.
139 -- @param url The URL to retrieve
140 -- @param stream Return a stream instead of a buffer
141 -- @param target Directly write to target file name
142 -- @return String containing the contents of given the URL
143 function httpget(url, stream, target)
145 local source = stream and io.popen or luci.util.exec
146 return source("wget -qO- '"..url:gsub("'", "").."'")
148 return os.execute("wget -qO '%s' '%s'" %
149 {target:gsub("'", ""), url:gsub("'", "")})
153 --- Returns the system load average values.
154 -- @return String containing the average load value 1 minute ago
155 -- @return String containing the average load value 5 minutes ago
156 -- @return String containing the average load value 15 minutes ago
157 -- @return String containing the active and total number of processes
158 -- @return String containing the last used pid
160 local loadavg = io.lines("/proc/loadavg")()
161 return loadavg:match("^(.-) (.-) (.-) (.-) (.-)$")
164 --- Initiate a system reboot.
165 -- @return Return value of os.execute()
167 return os.execute("reboot >/dev/null 2>&1")
170 --- Returns the system type, cpu name and installed physical memory.
171 -- @return String containing the system or platform identifier
172 -- @return String containing hardware model information
173 -- @return String containing the total memory amount in kB
174 -- @return String containing the memory used for caching in kB
175 -- @return String containing the memory used for buffering in kB
176 -- @return String containing the free memory amount in kB
178 local cpuinfo = luci.fs.readfile("/proc/cpuinfo")
179 local meminfo = luci.fs.readfile("/proc/meminfo")
181 local system = cpuinfo:match("system typ.-:%s*([^\n]+)")
183 local memtotal = tonumber(meminfo:match("MemTotal:%s*(%d+)"))
184 local memcached = tonumber(meminfo:match("\nCached:%s*(%d+)"))
185 local memfree = tonumber(meminfo:match("MemFree:%s*(%d+)"))
186 local membuffers = tonumber(meminfo:match("Buffers:%s*(%d+)"))
189 system = posix.uname("%m")
190 model = cpuinfo:match("model name.-:%s*([^\n]+)")
192 model = cpuinfo:match("Processor.-:%s*([^\n]+)")
195 model = cpuinfo:match("cpu model.-:%s*([^\n]+)")
198 return system, model, memtotal, memcached, membuffers, memfree
201 --- Retrieves the output of the "logread" command.
202 -- @return String containing the current log buffer
204 return luci.util.exec("logread")
207 --- Retrieves the output of the "dmesg" command.
208 -- @return String containing the current log buffer
210 return luci.util.exec("dmesg")
213 --- Generates a random id with specified length.
214 -- @param bytes Number of bytes for the unique id
215 -- @return String containing hex encoded id
216 function uniqueid(bytes)
217 local fp = io.open("/dev/urandom")
218 local chunk = { fp:read(bytes):byte(1, bytes) }
223 local pattern = "%02X"
224 for i, byte in ipairs(chunk) do
225 hex = hex .. pattern:format(byte)
231 --- Returns the current system uptime stats.
232 -- @return String containing total uptime in seconds
233 -- @return String containing idle time in seconds
235 local loadavg = io.lines("/proc/uptime")()
236 return loadavg:match("^(.-) (.-)$")
239 --- LuCI system utilities / POSIX user group related functions.
241 -- @name luci.sys.group
244 --- Returns information about a POSIX user group.
247 -- @param group Group ID or name of a system user group
248 -- @return Table with information about the requested group
249 group.getgroup = posix.getgroup
252 --- LuCI system utilities / network related functions.
254 -- @name luci.sys.net
257 --- Returns the current arp-table entries as two-dimensional table.
258 -- @return Table of table containing the current arp entries.
259 -- The following fields are defined for arp entry objects:
260 -- { "IP address", "HW address", "HW type", "Flags", "Mask", "Device" }
261 function net.arptable()
262 return _parse_delimited_table(io.lines("/proc/net/arp"), "%s%s+")
265 --- Returns conntrack information
266 -- @return Table with the currently tracked IP connections
267 function net.conntrack()
269 if luci.fs.access("/proc/net/nf_conntrack") then
270 for line in io.lines("/proc/net/nf_conntrack") do
271 local entry, flags = _parse_mixed_record(line, " +")
272 entry.layer3 = flags[1]
273 entry.layer4 = flags[2]
278 connt[#connt+1] = entry
280 elseif luci.fs.access("/proc/net/ip_conntrack") then
281 for line in io.lines("/proc/net/ip_conntrack") do
282 local entry, flags = _parse_mixed_record(line, " +")
283 entry.layer3 = "ipv4"
284 entry.layer4 = flags[1]
289 connt[#connt+1] = entry
297 --- Determine the current default route.
298 -- @return Table with the properties of the current default route.
299 -- The following fields are defined:
300 -- { "Mask", "RefCnt", "Iface", "Flags", "Window", "IRTT",
301 -- "MTU", "Gateway", "Destination", "Metric", "Use" }
302 function net.defaultroute()
303 local routes = net.routes()
306 for i, r in pairs(luci.sys.net.routes()) do
307 if r.Destination == "00000000" and (not route or route.Metric > r.Metric) then
315 --- Determine the names of available network interfaces.
316 -- @return Table containing all current interface names
317 function net.devices()
319 for line in io.lines("/proc/net/dev") do
320 table.insert(devices, line:match(" *(.-):"))
326 --- Return information about available network interfaces.
327 -- @return Table containing all current interface names and their information
328 function net.deviceinfo()
330 for line in io.lines("/proc/net/dev") do
331 local name, data = line:match("^ *(.-): *(.*)$")
332 if name and data then
333 devices[name] = luci.util.split(data, " +", nil, true)
340 -- Determine the MAC address belonging to the given IP address.
341 -- @param ip IPv4 address
342 -- @return String containing the MAC address or nil if it cannot be found
343 function net.ip4mac(ip)
346 for i, l in ipairs(net.arptable()) do
347 if l["IP address"] == ip then
348 mac = l["HW address"]
355 --- Returns the current kernel routing table entries.
356 -- @return Table of tables with properties of the corresponding routes.
357 -- The following fields are defined for route entry tables:
358 -- { "Mask", "RefCnt", "Iface", "Flags", "Window", "IRTT",
359 -- "MTU", "Gateway", "Destination", "Metric", "Use" }
360 function net.routes()
361 return _parse_delimited_table(io.lines("/proc/net/route"))
365 --- Tests whether the given host responds to ping probes.
366 -- @param host String containing a hostname or IPv4 address
367 -- @return Number containing 0 on success and >= 1 on error
368 function net.pingtest(host)
369 return os.execute("ping -c1 '"..host:gsub("'", '').."' >/dev/null 2>&1")
373 --- LuCI system utilities / process related functions.
375 -- @name luci.sys.process
378 --- Get the current process id.
380 -- @name process.info
381 -- @return Number containing the current pid
382 process.info = posix.getpid
384 --- Retrieve information about currently running processes.
385 -- @return Table containing process information
386 function process.list()
389 local ps = luci.util.execi("top -bn1")
401 k = luci.util.split(luci.util.trim(line), "%s+", nil, true)
402 if k[1] == "PID" then
410 line = luci.util.trim(line)
411 for i, value in ipairs(luci.util.split(line, "%s+", #k-1, true)) do
415 local pid = tonumber(row[k[1]])
424 --- Set the gid of a process identified by given pid.
425 -- @param pid Number containing the process id
426 -- @param gid Number containing the Unix group id
427 -- @return Boolean indicating successful operation
428 -- @return String containing the error message if failed
429 -- @return Number containing the error code if failed
430 function process.setgroup(pid, gid)
431 return posix.setpid("g", pid, gid)
434 --- Set the uid of a process identified by given pid.
435 -- @param pid Number containing the process id
436 -- @param uid Number containing the Unix user id
437 -- @return Boolean indicating successful operation
438 -- @return String containing the error message if failed
439 -- @return Number containing the error code if failed
440 function process.setuser(pid, uid)
441 return posix.setpid("u", pid, uid)
444 --- Send a signal to a process identified by given pid.
446 -- @name process.signal
447 -- @param pid Number containing the process id
448 -- @param sig Signal to send (default: 15 [SIGTERM])
449 -- @return Boolean indicating successful operation
450 -- @return Number containing the error code if failed
451 process.signal = posix.kill
454 --- LuCI system utilities / user related functions.
456 -- @name luci.sys.user
459 --- Retrieve user informations for given uid.
462 -- @param uid Number containing the Unix user id
463 -- @return Table containing the following fields:
464 -- { "uid", "gid", "name", "passwd", "dir", "shell", "gecos" }
465 user.getuser = posix.getpasswd
467 --- Test whether given string matches the password of a given system user.
468 -- @param username String containing the Unix user name
469 -- @param password String containing the password to compare
470 -- @return Boolean indicating wheather the passwords are equal
471 function user.checkpasswd(username, password)
472 local account = user.getuser(username)
475 local pwd = account.passwd
478 if luci.fs.stat("/etc/shadow") then
479 if not pcall(function()
480 for l in io.lines("/etc/shadow") do
481 shadowpw = l:match("^%s:([^:]+)" % username)
488 return nil, "Unable to access shadow-file"
497 if pwd and #pwd > 0 and password and #password > 0 then
498 return (pwd == posix.crypt(password, pwd))
505 --- Change the password of given user.
506 -- @param username String containing the Unix user name
507 -- @param password String containing the password to compare
508 -- @return Number containing 0 on success and >= 1 on error
509 function user.setpasswd(username, password)
511 password = password:gsub("'", "")
515 username = username:gsub("'", "")
518 local cmd = "(echo '"..password.."';sleep 1;echo '"..password.."')|"
519 cmd = cmd .. "passwd '"..username.."' >/dev/null 2>&1"
520 return os.execute(cmd)
524 --- LuCI system utilities / wifi related functions.
526 -- @name luci.sys.wifi
529 --- Get iwconfig output for all wireless devices.
530 -- @return Table of tables containing the iwconfing output for each wifi device
531 function wifi.getiwconfig()
532 local cnt = luci.util.exec("/usr/sbin/iwconfig 2>/dev/null")
535 for i, l in pairs(luci.util.split(luci.util.trim(cnt), "\n\n")) do
536 local k = l:match("^(.-) ")
537 l = l:gsub("^(.-) +", "", 1)
539 local entry, flags = _parse_mixed_record(l)
550 --- Get iwlist scan output from all wireless devices.
551 -- @return Table of tables contaiing all scan results
552 function wifi.iwscan(iface)
553 local siface = iface or ""
554 local cnt = luci.util.exec("iwlist "..siface.." scan 2>/dev/null")
557 for i, l in pairs(luci.util.split(luci.util.trim(cnt), "\n\n")) do
558 local k = l:match("^(.-) ")
559 l = l:gsub("^[^\n]+", "", 1)
560 l = luci.util.trim(l)
563 for j, c in pairs(luci.util.split(l, "\n Cell")) do
564 c = c:gsub("^(.-)- ", "", 1)
565 c = luci.util.split(c, "\n", 7)
566 c = table.concat(c, "\n", 1)
567 local entry, flags = _parse_mixed_record(c)
571 table.insert(iws[k], entry)
576 return iface and (iws[iface] or {}) or iws
580 --- LuCI system utilities / init related functions.
582 -- @name luci.sys.init
584 init.dir = "/etc/init.d/"
586 --- Get the names of all installed init scripts
587 -- @return Table containing the names of all inistalled init scripts
588 function init.names()
590 for _, name in ipairs(luci.fs.glob(init.dir.."*")) do
591 names[#names+1] = luci.fs.basename(name)
596 --- Test whether the given init script is enabled
597 -- @param name Name of the init script
598 -- @return Boolean indicating whether init is enabled
599 function init.enabled(name)
600 if luci.fs.access(init.dir..name) then
601 return ( call(init.dir..name.." enabled") == 0 )
606 --- Get the index of he given init script
607 -- @param name Name of the init script
608 -- @return Numeric index value
609 function init.index(name)
610 if luci.fs.access(init.dir..name) then
611 return call("source "..init.dir..name.."; exit $START")
615 --- Enable the given init script
616 -- @param name Name of the init script
617 -- @return Boolean indicating success
618 function init.enable(name)
619 if luci.fs.access(init.dir..name) then
620 return ( call(init.dir..name.." enable") == 1 )
624 --- Disable the given init script
625 -- @param name Name of the init script
626 -- @return Boolean indicating success
627 function init.disable(name)
628 if luci.fs.access(init.dir..name) then
629 return ( call(init.dir..name.." disable") == 0 )
634 -- Internal functions
636 function _parse_delimited_table(iter, delimiter)
637 delimiter = delimiter or "%s+"
640 local trim = luci.util.trim
641 local split = luci.util.split
643 local keys = split(trim(iter()), delimiter, nil, true)
644 for i, j in pairs(keys) do
645 keys[i] = trim(keys[i])
652 for i, j in pairs(split(line, delimiter, nil, true)) do
658 table.insert(data, row)
664 function _parse_mixed_record(cnt, delimiter)
665 delimiter = delimiter or " "
669 for i, l in pairs(luci.util.split(luci.util.trim(cnt), "\n")) do
670 for j, f in pairs(luci.util.split(luci.util.trim(l), delimiter, nil, true)) do
671 local k, x, v = f:match('([^%s][^:=]+) *([:=]*) *"*([^\n"]*)"*')
675 table.insert(flags, k)