module("luci.dispatcher", package.seeall)
context = util.threadlocal()
+uci = require "luci.model.uci"
+i18n = require "luci.i18n"
+_M.fs = fs
authenticator = {}
-- @return Relative URL
function build_url(...)
local path = {...}
- local sn = http.getenv("SCRIPT_NAME") or ""
+ local url = { http.getenv("SCRIPT_NAME") or "" }
+
+ local k, v
for k, v in pairs(context.urltoken) do
- sn = sn .. "/;" .. k .. "=" .. http.urlencode(v)
+ url[#url+1] = "/;"
+ url[#url+1] = http.urlencode(k)
+ url[#url+1] = "="
+ url[#url+1] = http.urlencode(v)
+ end
+
+ local p
+ for _, p in ipairs(path) do
+ if p:match("^[a-zA-Z0-9_%-%.%%/,;]+$") then
+ url[#url+1] = "/"
+ url[#url+1] = p
+ end
end
- return sn .. ((#path > 0) and "/" .. table.concat(path, "/") or "")
+
+ return table.concat(url, "")
end
+--- Check whether a dispatch node shall be visible
+-- @param node Dispatch node
+-- @return Boolean indicating whether the node should be visible
+function node_visible(node)
+ if node then
+ return not (
+ (not node.title or #node.title == 0) or
+ (not node.target or node.hidden == true) or
+ (type(node.target) == "table" and node.target.type == "firstchild" and
+ (type(node.nodes) ~= "table" or not next(node.nodes)))
+ )
+ end
+ return false
+end
+
+--- Return a sorted table of visible childs within a given node
+-- @param node Dispatch node
+-- @return Ordered table of child node names
+function node_childs(node)
+ local rv = { }
+ if node then
+ local k, v
+ for k, v in util.spairs(node.nodes,
+ function(a, b)
+ return (node.nodes[a].order or 100)
+ < (node.nodes[b].order or 100)
+ end)
+ do
+ if node_visible(v) then
+ rv[#rv+1] = k
+ end
+ end
+ end
+ return rv
+end
+
+
--- Send a 404 error code and render the "error404" template if available.
-- @param message Custom error message (optional)
-- @return false
--- Dispatch an HTTP request.
-- @param request LuCI HTTP Request object
-function httpdispatch(request, prefix, ext_tree)
+function httpdispatch(request, prefix)
luci.http.context.request = request
- context.request = {}
+
+ local r = {}
+ context.request = r
+ context.urltoken = {}
+
local pathinfo = http.urldecode(request:getenv("PATH_INFO") or "", true)
+ if prefix then
+ for _, node in ipairs(prefix) do
+ r[#r+1] = node
+ end
+ end
+
+ local tokensok = true
for node in pathinfo:gmatch("[^/]+") do
- table.insert(context.request, node)
+ local tkey, tval
+ if tokensok then
+ tkey, tval = node:match(";(%w+)=([a-fA-F0-9]*)")
+ end
+ if tkey then
+ context.urltoken[tkey] = tval
+ else
+ tokensok = false
+ r[#r+1] = node
+ end
end
local stat, err = util.coxpcall(function()
- dispatch(context.request, ext_tree)
+ dispatch(context.request)
end, error500)
luci.http.close()
--- Dispatches a LuCI virtual path.
-- @param request Virtual path
-function dispatch(request, ext_tree)
- context._disable_memtrace = require "luci.debug".trap_memtrace("l")
+function dispatch(request)
+ --context._disable_memtrace = require "luci.debug".trap_memtrace("l")
local ctx = context
ctx.path = request
- ctx.urltoken = ctx.urltoken or {}
local conf = require "luci.config"
assert(conf.main,
"/etc/config/luci seems to be corrupt, unable to find section 'main'")
- local lang = conf.main.lang
+ local lang = conf.main.lang or "auto"
if lang == "auto" then
local aclang = http.getenv("HTTP_ACCEPT_LANGUAGE") or ""
for lpat in aclang:gmatch("[%w-]+") do
break
end
end
- end
- require "luci.i18n".setlanguage(lang)
-
- if ext_tree then
- ctx.index, ctx.tree, ctx.treecache, ctx.modifiers = unpack(ext_tree)
- elseif not ctx.tree then
- createtree()
end
+ require "luci.i18n".setlanguage(lang)
local c = ctx.tree
local stat
+ if not c then
+ c = createtree()
+ end
+
local track = {}
local args = {}
ctx.args = args
ctx.requestargs = ctx.requestargs or args
local n
- local t = true
local token = ctx.urltoken
local preq = {}
local freq = {}
for i, s in ipairs(request) do
- local tkey, tval
- if t then
- tkey, tval = s:match(";(%w+)=(.*)")
+ preq[#preq+1] = s
+ freq[#freq+1] = s
+ c = c.nodes[s]
+ n = i
+ if not c then
+ break
end
- if tkey then
- token[tkey] = tval
- else
- t = false
- preq[#preq+1] = s
- freq[#freq+1] = s
- c = c.nodes[s]
- n = i
- if not c then
- break
- end
-
- util.update(track, c)
+ util.update(track, c)
- if c.leaf then
- break
- end
+ if c.leaf then
+ break
end
end
end
end
- ctx.requestpath = freq
+ ctx.requestpath = ctx.requestpath or freq
ctx.path = preq
if track.i18n then
- require("luci.i18n").loadc(track.i18n)
+ i18n.loadc(track.i18n)
end
-- Init template engine
if (c and c.index) or not track.notemplate then
local tpl = require("luci.template")
local media = track.mediaurlbase or luci.config.main.mediaurlbase
- if not tpl.Template("themes/%s/header" % fs.basename(media)) then
- --if not pcall(tpl.Template, "themes/%s/header" % fs.basename(media)) then
+ if not pcall(tpl.Template, "themes/%s/header" % fs.basename(media)) then
media = nil
for name, theme in pairs(luci.config.themes) do
if name:sub(1,1) ~= "." and pcall(tpl.Template,
assert(media, "No valid theme found")
end
+ local function _ifattr(cond, key, val)
+ if cond then
+ local env = getfenv(3)
+ local scope = (type(env.self) == "table") and env.self
+ return string.format(
+ ' %s="%s"', tostring(key),
+ luci.util.pcdata(tostring( val
+ or (type(env[key]) ~= "function" and env[key])
+ or (scope and type(scope[key]) ~= "function" and scope[key])
+ or "" ))
+ )
+ else
+ return ''
+ end
+ end
+
tpl.context.viewns = setmetatable({
- write = luci.http.write;
- include = function(name) tpl.Template(name):render(getfenv(2)) end;
- translate = function(...) return require("luci.i18n").translate(...) end;
- striptags = util.striptags;
- media = media;
- theme = fs.basename(media);
- resource = luci.config.main.resourcebase
+ write = luci.http.write;
+ include = function(name) tpl.Template(name):render(getfenv(2)) end;
+ translate = i18n.translate;
+ export = function(k, v) if tpl.context.viewns[k] == nil then tpl.context.viewns[k] = v end end;
+ striptags = util.striptags;
+ pcdata = util.pcdata;
+ media = media;
+ theme = fs.basename(media);
+ resource = luci.config.main.resourcebase;
+ ifattr = function(...) return _ifattr(...) end;
+ attr = function(...) return _ifattr(true, ...) end;
}, {__index=function(table, key)
if key == "controller" then
return build_url()
end
track.dependent = (track.dependent ~= false)
- assert(not track.dependent or not track.auto, "Access Violation")
+ assert(not track.dependent or not track.auto,
+ "Access Violation\nThe page at '" .. table.concat(request, "/") .. "/' " ..
+ "has no parent node so the access to this location has been denied.\n" ..
+ "This is a software bug, please report this message at " ..
+ "http://luci.subsignal.org/trac/newticket"
+ )
if track.sysauth then
local sauth = require "luci.sauth"
local verifytoken = false
if not sess then
sess = luci.http.getcookie("sysauth")
- sess = sess and sess:match("^[a-f0-9]+$")
+ sess = sess and sess:match("^[a-f0-9]*$")
verifytoken = true
end
local user
if sdat then
- sdat = loadstring(sdat)
- setfenv(sdat, {})
- sdat = sdat()
if not verifytoken or ctx.urltoken.stok == sdat.token then
user = sdat.user
end
+ else
+ local eu = http.getenv("HTTP_AUTH_USER")
+ local ep = http.getenv("HTTP_AUTH_PASS")
+ if eu and ep and luci.sys.user.checkpasswd(eu, ep) then
+ authen = function() return eu end
+ end
end
if not util.contains(accs, user) then
local sid = sess or luci.sys.uniqueid(16)
if not sess then
local token = luci.sys.uniqueid(16)
- sauth.write(sid, util.get_bytecode({
+ sauth.reap()
+ sauth.write(sid, {
user=user,
token=token,
secret=luci.sys.uniqueid(16)
- }))
+ })
ctx.urltoken.stok = token
end
luci.http.header("Set-Cookie", "sysauth=" .. sid.."; path="..build_url())
ctx.authsession = sid
+ ctx.authuser = user
end
else
luci.http.status(403, "Forbidden")
end
else
ctx.authsession = sess
+ ctx.authuser = user
end
end
setfenv(target, env)
end)
+ local ok, err
if type(c.target) == "table" then
- target(c.target, unpack(args))
+ ok, err = util.copcall(target, c.target, unpack(args))
else
- target(unpack(args))
+ ok, err = util.copcall(target, unpack(args))
end
+ assert(ok,
+ "Failed to execute " .. (type(c.target) == "function" and "function" or c.target.type or "unknown") ..
+ " dispatcher target for entry '/" .. table.concat(request, "/") .. "'.\n" ..
+ "The called action terminated with an exception:\n" .. tostring(err or "(unknown)"))
else
- error404()
+ local root = node()
+ if not root or not root.target then
+ error404("No root node was registered, this usually happens if no module was installed.\n" ..
+ "Install luci-mod-admin-full and retry. " ..
+ "If the module is already installed, try removing the /tmp/luci-indexcache file.")
+ else
+ error404("No page is registered at '/" .. table.concat(request, "/") .. "'.\n" ..
+ "If this url belongs to an extension, make sure it is properly installed.\n" ..
+ "If the extension was recently installed, try removing the /tmp/luci-indexcache file.")
+ end
end
end
local suff = { ".lua", ".lua.gz" }
if luci.util.copcall(require, "luci.fastindex") then
- return createindex_fastindex(path, suff)
+ createindex_fastindex(path, suff)
else
- return createindex_plain(path, suff)
+ createindex_plain(path, suff)
end
end
-- @param path Controller base directory
-- @param suffixes Controller file suffixes
function createindex_fastindex(path, suffixes)
- local index = {}
+ index = {}
if not fi then
fi = luci.fastindex.new("index")
for k, v in pairs(fi.indexes) do
index[v[2]] = v[1]
end
-
- return index
end
--- Generate the dispatching index using the native file-cache based strategy.
if cachedate then
local realdate = 0
for _, obj in ipairs(controllers) do
- local omtime = fs.stat(path .. "/" .. obj, "mtime")
+ local omtime = fs.stat(obj, "mtime")
realdate = (omtime and omtime > realdate) and omtime or realdate
end
end
end
- local index = {}
+ index = {}
for i,c in ipairs(controllers) do
- local module = "luci.controller." .. c:sub(#path+1, #c):gsub("/", ".")
+ local modname = "luci.controller." .. c:sub(#path+1, #c):gsub("/", ".")
for _, suffix in ipairs(suffixes) do
- module = module:gsub(suffix.."$", "")
+ modname = modname:gsub(suffix.."$", "")
end
- local mod = require(module)
+ local mod = require(modname)
+ assert(mod ~= true,
+ "Invalid controller file found\n" ..
+ "The file '" .. c .. "' contains an invalid module line.\n" ..
+ "Please verify whether the module name is set to '" .. modname ..
+ "' - It must correspond to the file path!")
+
local idx = mod.index
+ assert(type(idx) == "function",
+ "Invalid controller file found\n" ..
+ "The file '" .. c .. "' contains no index() function.\n" ..
+ "Please make sure that the controller contains a valid " ..
+ "index function and verify the spelling!")
- if type(idx) == "function" then
- index[module] = idx
- end
+ index[modname] = idx
end
if indexcache then
f:writeall(util.get_bytecode(index))
f:close()
end
-
- return index
end
--- Create the dispatching tree from the index.
-- Build the index before if it does not exist yet.
function createtree()
- local ctx = context
- local tree = {nodes={}}
- local cache = setmetatable({}, {__mode="v"})
- local modi = {}
-
- if not ctx.index then
- ctx.index = createindex()
+ if not index then
+ createindex()
end
- ctx.tree = tree
- ctx.treecache = cache
+ local ctx = context
+ local tree = {nodes={}, inreq=true}
+ local modi = {}
+
+ ctx.treecache = setmetatable({}, {__mode="v"})
+ ctx.tree = tree
ctx.modifiers = modi
-- Load default translation
- require "luci.i18n".loadc("default")
+ require "luci.i18n".loadc("base")
local scope = setmetatable({}, {__index = luci.dispatcher})
- for k, v in pairs(ctx.index) do
+ for k, v in pairs(index) do
scope._NAME = k
setfenv(v, scope)
- pcall(v)
+ v()
end
local function modisort(a,b)
for _, v in util.spairs(modi, modisort) do
scope._NAME = v.module
setfenv(v.func, scope)
- pcall(v.func)
+ v.func()
end
- return { index, tree, cache, modi }
+ return tree
end
--- Register a tree modifier.
return c
end
-function _create_node(path, cache)
+function _create_node(path)
if #path == 0 then
return context.tree
end
- cache = cache or context.treecache
local name = table.concat(path, ".")
- local c = cache[name]
+ local c = context.treecache[name]
if not c then
- local new = {nodes={}, auto=true, path=util.clone(path)}
local last = table.remove(path)
+ local parent = _create_node(path)
- c = _create_node(path, cache)
-
- c.nodes[last] = new
- cache[name] = new
-
- return new
- else
- return c
+ c = {nodes={}, auto=true}
+ -- the node is "in request" if the request path matches
+ -- at least up to the length of the node path
+ if parent.inreq and context.path[#path+1] == last then
+ c.inreq = true
+ end
+ parent.nodes[last] = c
+ context.treecache[name] = c
end
+ return c
end
-- Subdispatchers --
+function _firstchild()
+ local path = { unpack(context.path) }
+ local name = table.concat(path, ".")
+ local node = context.treecache[name]
+
+ local lowest
+ if node and node.nodes and next(node.nodes) then
+ local k, v
+ for k, v in pairs(node.nodes) do
+ if not lowest or
+ (v.order or 100) < (node.nodes[lowest].order or 100)
+ then
+ lowest = k
+ end
+ end
+ end
+
+ assert(lowest ~= nil,
+ "The requested node contains no childs, unable to redispatch")
+
+ path[#path+1] = lowest
+ dispatch(path)
+end
+
+--- Alias the first (lowest order) page automatically
+function firstchild()
+ return { type = "firstchild", target = _firstchild }
+end
+
--- Create a redirect to another dispatching node.
-- @param ... Virtual path destination
function alias(...)
local function _call(self, ...)
+ local func = getfenv()[self.name]
+ assert(func ~= nil,
+ 'Cannot resolve function "' .. self.name .. '". Is it misspelled or local?')
+
+ assert(type(func) == "function",
+ 'The symbol "' .. self.name .. '" does not refer to a function but data ' ..
+ 'of type "' .. type(func) .. '".')
+
if #self.argv > 0 then
- return getfenv()[self.name](unpack(self.argv), ...)
+ return func(unpack(self.argv), ...)
else
- return getfenv()[self.name](...)
+ return func(...)
end
end
end
end
- local pageaction = true
http.header("X-CBI-State", state or 0)
+
if not config.noheader then
tpl.render("cbi/header", {state = state})
end
+
+ local redirect
+ local messages
+ local applymap = false
+ local pageaction = true
+ local parsechain = { }
+
for i, res in ipairs(maps) do
- res:render()
+ if res.apply_needed and res.parsechain then
+ local c
+ for _, c in ipairs(res.parsechain) do
+ parsechain[#parsechain+1] = c
+ end
+ applymap = true
+ end
+
+ if res.redirect then
+ redirect = redirect or res.redirect
+ end
+
if res.pageaction == false then
pageaction = false
end
+
+ if res.message then
+ messages = messages or { }
+ messages[#messages+1] = res.message
+ end
+ end
+
+ for i, res in ipairs(maps) do
+ res:render({
+ firstmap = (i == 1),
+ applymap = applymap,
+ redirect = redirect,
+ messages = messages,
+ pageaction = pageaction,
+ parsechain = parsechain
+ })
end
+
if not config.nofooter then
- tpl.render("cbi/footer", {flow = config, pageaction=pageaction, state = state, autoapply = config.autoapply})
+ tpl.render("cbi/footer", {
+ flow = config,
+ pageaction = pageaction,
+ redirect = redirect,
+ state = state,
+ autoapply = config.autoapply
+ })
end
end
function form(model)
return {type = "cbi", model = model, target = _form}
end
+
+--- Access the luci.i18n translate() api.
+-- @class function
+-- @name translate
+-- @param text Text to translate
+translate = i18n.translate
+
+--- No-op function used to mark translation entries for menu labels.
+-- This function does not actually translate the given argument but
+-- is used by build/i18n-scan.pl to find translatable entries.
+function _(text)
+ return text
+end
projects / project / luci.git / blobdiff