X-Git-Url: https://git.archive.openwrt.org/?a=blobdiff_plain;f=libs%2Fweb%2Fluasrc%2Fdispatcher.lua;h=9e5b78d5e9f93b3bf6737f53fdebe65924697798;hb=848e43a5b47c0467b90e7d9a029e59ec53461da3;hp=5110209aacb21e0ab6781d61b49b016ebe7bce1e;hpb=ab18c3ba1006db94df57c310da97b5ddb07991ad;p=project%2Fluci.git diff --git a/libs/web/luasrc/dispatcher.lua b/libs/web/luasrc/dispatcher.lua index 5110209aa..9e5b78d5e 100644 --- a/libs/web/luasrc/dispatcher.lua +++ b/libs/web/luasrc/dispatcher.lua @@ -25,14 +25,18 @@ limitations under the License. ]]-- --- LuCI web dispatcher. -local fs = require "luci.fs" +local fs = require "nixio.fs" local sys = require "luci.sys" local init = require "luci.init" local util = require "luci.util" local http = require "luci.http" +local nixio = require "nixio", require "nixio.util" module("luci.dispatcher", package.seeall) context = util.threadlocal() +uci = require "luci.model.uci" +i18n = require "luci.i18n" +_M.fs = fs authenticator = {} @@ -48,13 +52,64 @@ local fi -- @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 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 sn .. ((#path > 0) and "/" .. table.concat(path, "/") or "") + return rv end + --- Send a 404 error code and render the "error404" template if available. -- @param message Custom error message (optional) -- @return false @@ -74,12 +129,17 @@ end -- @param message Custom error message (optional)# -- @return false function error500(message) - luci.http.status(500, "Internal Server Error") - - require("luci.template") - if not luci.util.copcall(luci.template.render, "error500", {message=message}) then + luci.util.perror(message) + if not context.template_header_sent then + luci.http.status(500, "Internal Server Error") luci.http.prepare_content("text/plain") luci.http.write(message) + else + require("luci.template") + if not luci.util.copcall(luci.template.render, "error500", {message=message}) then + luci.http.prepare_content("text/plain") + luci.http.write(message) + end end return false end @@ -102,21 +162,39 @@ end --- Dispatch an HTTP request. -- @param request LuCI HTTP Request object -function httpdispatch(request) +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) - for node in pathinfo:gmatch("[^/]+") do - table.insert(context.request, node) + if prefix then + for _, node in ipairs(prefix) do + r[#r+1] = node + end end - local stat, err = util.copcall(dispatch, context.request) - if not stat then - luci.util.perror(err) - error500(err) + local tokensok = true + for node in pathinfo:gmatch("[^/]+") do + 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) + end, error500) + luci.http.close() --context._disable_memtrace() @@ -125,13 +203,15 @@ end --- Dispatches a LuCI virtual path. -- @param request Virtual path function dispatch(request) - --context._disable_memtrace = require "luci.debug".trap_memtrace() + --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" - local lang = conf.main.lang + assert(conf.main, + "/etc/config/luci seems to be corrupt, unable to find section 'main'") + + 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 @@ -141,7 +221,7 @@ function dispatch(request) break end end - end + end require "luci.i18n".setlanguage(lang) local c = ctx.tree @@ -155,34 +235,23 @@ function dispatch(request) 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 @@ -193,11 +262,11 @@ function dispatch(request) 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 @@ -215,7 +284,36 @@ function dispatch(request) assert(media, "No valid theme found") end - local viewns = setmetatable({}, {__index=function(table, key) + 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 = i18n.translate; + translatef = i18n.translatef; + 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() elseif key == "REQUEST_URI" then @@ -224,18 +322,15 @@ function dispatch(request) return rawget(table, key) or _G[key] end end}) - tpl.context.viewns = viewns - viewns.write = luci.http.write - viewns.include = function(name) tpl.Template(name):render(getfenv(2)) end - viewns.translate = function(...) return require("luci.i18n").translate(...) end - viewns.striptags = util.striptags - viewns.media = media - viewns.theme = fs.basename(media) - viewns.resource = luci.config.main.resourcebase 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" @@ -250,7 +345,7 @@ function dispatch(request) 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 @@ -258,10 +353,15 @@ function dispatch(request) local user if sdat then - sdat = loadstring(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 @@ -274,15 +374,17 @@ function dispatch(request) 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") @@ -290,6 +392,7 @@ function dispatch(request) end else ctx.authsession = sess + ctx.authuser = user end end @@ -336,20 +439,34 @@ function dispatch(request) 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 --- Generate the dispatching index using the best possible strategy. function createindex() local path = luci.util.libpath() .. "/controller/" - local suff = ".lua" + local suff = { ".lua", ".lua.gz" } if luci.util.copcall(require, "luci.fastindex") then createindex_fastindex(path, suff) @@ -360,14 +477,16 @@ end --- Generate the dispatching index using the fastindex C-indexer. -- @param path Controller base directory --- @param suffix Controller file suffix -function createindex_fastindex(path, suffix) +-- @param suffixes Controller file suffixes +function createindex_fastindex(path, suffixes) index = {} if not fi then fi = luci.fastindex.new("index") - fi.add(path .. "*" .. suffix) - fi.add(path .. "*/*" .. suffix) + for _, suffix in ipairs(suffixes) do + fi.add(path .. "*" .. suffix) + fi.add(path .. "*/*" .. suffix) + end end fi.scan() @@ -378,26 +497,27 @@ end --- Generate the dispatching index using the native file-cache based strategy. -- @param path Controller base directory --- @param suffix Controller file suffix -function createindex_plain(path, suffix) - local controllers = util.combine( - luci.fs.glob(path .. "*" .. suffix) or {}, - luci.fs.glob(path .. "*/*" .. suffix) or {} - ) +-- @param suffixes Controller file suffixes +function createindex_plain(path, suffixes) + local controllers = { } + for _, suffix in ipairs(suffixes) do + nixio.util.consume((fs.glob(path .. "*" .. suffix)), controllers) + nixio.util.consume((fs.glob(path .. "*/*" .. suffix)), controllers) + end if indexcache then - local cachedate = fs.mtime(indexcache) + local cachedate = fs.stat(indexcache, "mtime") if cachedate then local realdate = 0 for _, obj in ipairs(controllers) do - local omtime = fs.mtime(path .. "/" .. obj) + local omtime = fs.stat(obj, "mtime") realdate = (omtime and omtime > realdate) and omtime or realdate end if cachedate > realdate then assert( sys.process.info("uid") == fs.stat(indexcache, "uid") - and fs.stat(indexcache, "mode") == "rw-------", + and fs.stat(indexcache, "modestr") == "rw-------", "Fatal: Indexcache is not sane!" ) @@ -410,18 +530,32 @@ function createindex_plain(path, suffix) index = {} for i,c in ipairs(controllers) do - local module = "luci.controller." .. c:sub(#path+1, #c-#suffix):gsub("/", ".") - local mod = require(module) + local modname = "luci.controller." .. c:sub(#path+1, #c):gsub("/", ".") + for _, suffix in ipairs(suffixes) do + modname = modname:gsub(suffix.."$", "") + end + + 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 - fs.writefile(indexcache, util.get_bytecode(index)) - fs.chmod(indexcache, "a-rwx,u+rw") + local f = nixio.open(indexcache, "w", 600) + f:writeall(util.get_bytecode(index)) + f:close() end end @@ -433,7 +567,7 @@ function createtree() end local ctx = context - local tree = {nodes={}} + local tree = {nodes={}, inreq=true} local modi = {} ctx.treecache = setmetatable({}, {__mode="v"}) @@ -441,7 +575,7 @@ function createtree() ctx.modifiers = modi -- Load default translation - require "luci.i18n".loadc("default") + require "luci.i18n".loadc("base") local scope = setmetatable({}, {__index = luci.dispatcher}) @@ -512,6 +646,14 @@ function entry(path, target, title, order) return c end +--- Fetch or create a dispatching node without setting the target module or +-- enabling the node. +-- @param ... Virtual path +-- @return Dispatching tree node +function get(...) + return _create_node({...}) +end + --- Fetch or create a new dispatching node. -- @param ... Virtual path -- @return Dispatching tree node @@ -524,32 +666,61 @@ function node(...) 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(...) @@ -589,10 +760,18 @@ end local function _call(self, ...) - if #self.argv > 0 then - return getfenv()[self.name](unpack(self.argv), ...) + 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 func(unpack(self.argv), ...) else - return getfenv()[self.name](...) + return func(...) end end @@ -626,27 +805,29 @@ local function _cbi(self, ...) local state = nil for i, res in ipairs(maps) do - if config.autoapply then - res.autoapply = config.autoapply - end + res.flow = config local cstate = res:parse() - if not state or cstate < state then + if cstate and (not state or cstate < state) then state = cstate end end + local function _resolve_path(path) + return type(path) == "table" and build_url(unpack(path)) or path + end + if config.on_valid_to and state and state > 0 and state < 2 then - http.redirect(config.on_valid_to) + http.redirect(_resolve_path(config.on_valid_to)) return end if config.on_changed_to and state and state > 1 then - http.redirect(config.on_changed_to) + http.redirect(_resolve_path(config.on_changed_to)) return end if config.on_success_to and state and state > 0 then - http.redirect(config.on_success_to) + http.redirect(_resolve_path(config.on_success_to)) return end @@ -656,16 +837,61 @@ local function _cbi(self, ...) end end - local pageaction = true http.header("X-CBI-State", state or 0) - tpl.render("cbi/header", {state = state}) + + 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, + redirect = redirect, + state = state, + autoapply = config.autoapply + }) end - tpl.render("cbi/footer", {pageaction=pageaction, state = state, autoapply = config.autoapply}) end --- Create a CBI model dispatching target. @@ -700,7 +926,7 @@ local function _form(self, ...) for i, res in ipairs(maps) do local cstate = res:parse() - if not state or cstate < state then + if cstate and (not state or cstate < state) then state = cstate end end @@ -718,3 +944,16 @@ 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