X-Git-Url: https://git.archive.openwrt.org/?p=project%2Fluci.git;a=blobdiff_plain;f=libs%2Fweb%2Fluasrc%2Fdispatcher.lua;h=5fb50dcb160de93a841ea649a84ae3ecb0199b9e;hp=e3ebe5b0e427a094512163845dfd03c95e0d5c37;hb=d0939b4e3371fb99d1b14033b54116b5bff4fbe1;hpb=971ffe47da2fa5b154f0601f9ece2984ac7f5d50 diff --git a/libs/web/luasrc/dispatcher.lua b/libs/web/luasrc/dispatcher.lua index e3ebe5b0e..5fb50dcb1 100644 --- a/libs/web/luasrc/dispatcher.lua +++ b/libs/web/luasrc/dispatcher.lua @@ -23,14 +23,19 @@ See the License for the specific language governing permissions and limitations under the License. ]]-- -module("luci.dispatcher", package.seeall) -require("luci.init") -require("luci.http") -require("luci.sys") -require("luci.fs") +--- LuCI web dispatcher. +local fs = require "luci.fs" +local sys = require "luci.sys" +local init = require "luci.init" +local util = require "luci.util" +local http = require "luci.http" + +module("luci.dispatcher", package.seeall) context = luci.util.threadlocal() +authenticator = {} + -- Index table local index = nil @@ -38,24 +43,16 @@ local index = nil local fi --- Builds a URL +--- Build the URL relative to the server webroot from given virtual path. +-- @param ... Virtual path +-- @return Relative URL function build_url(...) - return luci.http.dispatcher() .. "/" .. table.concat(arg, "/") -end - --- Prints an error message or renders the "error401" template if available -function error401(message) - message = message or "Unauthorized" - - require("luci.template") - if not luci.util.copcall(luci.template.render, "error401") then - luci.http.prepare_content("text/plain") - luci.http.write(message) - end - return false + return luci.http.getenv("SCRIPT_NAME") .. "/" .. table.concat(arg, "/") end --- Sends a 404 error code and renders the "error404" template if available +--- Send a 404 error code and render the "error404" template if available. +-- @param message Custom error message (optional) +-- @return false function error404(message) luci.http.status(404, "Not Found") message = message or "Not Found" @@ -68,7 +65,9 @@ function error404(message) return false end --- Sends a 500 error code and renders the "error500" template if available +--- Send a 500 error code and render the "error500" template if available. +-- @param message Custom error message (optional)# +-- @return false function error500(message) luci.http.status(500, "Internal Server Error") @@ -80,66 +79,153 @@ function error500(message) return false end --- Creates a request object for dispatching +function authenticator.htmlauth(validator, accs, default) + local user = luci.http.formvalue("username") + local pass = luci.http.formvalue("password") + + if user and validator(user, pass) then + return user + end + + require("luci.i18n") + require("luci.template") + context.path = {} + luci.template.render("sysauth", {duser=default, fuser=user}) + return false + +end + +--- Dispatch an HTTP request. +-- @param request LuCI HTTP Request object function httpdispatch(request) luci.http.context.request = request context.request = {} - local pathinfo = request.env.PATH_INFO or "" + local pathinfo = request:getenv("PATH_INFO") or "" for node in pathinfo:gmatch("[^/]+") do table.insert(context.request, node) end - dispatch(context.request) + local stat, err = util.copcall(dispatch, context.request) + if not stat then + luci.util.perror(err) + error500(err) + end + luci.http.close() + + --context._disable_memtrace() end --- Dispatches a request +--- Dispatches a LuCI virtual path. +-- @param request Virtual path function dispatch(request) - context.path = request - - require("luci.i18n") - luci.i18n.setlanguage(require("luci.config").main.lang) - - if not context.tree then - createtree() + --context._disable_memtrace = require "luci.debug".trap_memtrace() + local ctx = context + ctx.path = request + + require "luci.i18n".setlanguage(require "luci.config".main.lang) + + local c = ctx.tree + local stat + if not c then + c = createtree() end - - local c = context.tree + local track = {} + local args = {} + ctx.args = args + ctx.requestargs = ctx.requestargs or args + local n for i, s in ipairs(request) do c = c.nodes[s] - if not c or c.leaf then + n = i + if not c then break end - for k, v in pairs(c) do - track[k] = v + util.update(track, c) + + if c.leaf then + break end end - if track.sysauth then - local accs = track.sysauth - accs = (type(accs) == "string") and {accs} or accs - - --[[ - local function sysauth(user, password) - return (luci.util.contains(accs, user) - and luci.sys.user.checkpasswd(user, password)) - end - - if not luci.http.basic_auth(sysauth) then - error401() - return + if c and c.leaf then + for j=n+1, #request do + table.insert(args, request[j]) end - ]]-- end if track.i18n then require("luci.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 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, + "themes/%s/header" % fs.basename(theme)) then + media = theme + end + end + assert(media, "No valid theme found") + end + + local viewns = setmetatable({}, {__index=_G}) + 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.controller = luci.http.getenv("SCRIPT_NAME") + viewns.media = media + viewns.theme = fs.basename(media) + viewns.resource = luci.config.main.resourcebase + viewns.REQUEST_URI = (luci.http.getenv("SCRIPT_NAME") or "") .. (luci.http.getenv("PATH_INFO") or "") + end + + track.dependent = (track.dependent ~= false) + assert(not track.dependent or not track.auto, "Access Violation") + + if track.sysauth then + local sauth = require "luci.sauth" + + local authen = type(track.sysauth_authenticator) == "function" + and track.sysauth_authenticator + or authenticator[track.sysauth_authenticator] + + local def = (type(track.sysauth) == "string") and track.sysauth + local accs = def and {track.sysauth} or track.sysauth + local sess = ctx.authsession or luci.http.getcookie("sysauth") + sess = sess and sess:match("^[A-F0-9]+$") + local user = sauth.read(sess) + + if not util.contains(accs, user) then + if authen then + local user, sess = authen(luci.sys.user.checkpasswd, accs, def) + if not user or not util.contains(accs, user) then + return + else + local sid = sess or luci.sys.uniqueid(16) + luci.http.header("Set-Cookie", "sysauth=" .. sid.."; path=/") + if not sess then + sauth.write(sid, user) + end + ctx.authsession = sid + end + else + luci.http.status(403, "Forbidden") + return + end + end + end + if track.setgroup then luci.sys.process.setgroup(track.setgroup) end @@ -147,40 +233,44 @@ function dispatch(request) if track.setuser then luci.sys.process.setuser(track.setuser) end - - -- Init template engine - local tpl = require("luci.template") - local viewns = {} - tpl.context.viewns = viewns - viewns.write = luci.http.write - viewns.translate = function(...) return require("luci.i18n").translate(...) end - viewns.controller = luci.http.getenv("SCRIPT_NAME") - viewns.media = luci.config.main.mediaurlbase - viewns.resource = luci.config.main.resourcebase - viewns.REQUEST_URI = luci.http.getenv("SCRIPT_NAME") .. (luci.http.getenv("PATH_INFO") or "") - - if c and type(c.target) == "function" then - context.dispatched = c - stat, mod = luci.util.copcall(require, c.module) - if stat then - luci.util.updfenv(c.target, mod) - end - - stat, err = luci.util.copcall(c.target) - if not stat then - error500(err) + if c and (c.index or type(c.target) == "function") then + ctx.dispatched = c + ctx.requested = ctx.requested or ctx.dispatched + end + + if c and c.index then + local tpl = require "luci.template" + + if util.copcall(tpl.render, "indexer", {}) then + return true end + end + + if c and type(c.target) == "function" then + util.copcall(function() + local oldenv = getfenv(c.target) + local module = require(c.module) + local env = setmetatable({}, {__index= + + function(tbl, key) + return rawget(tbl, key) or module[key] or oldenv[key] + end}) + + setfenv(c.target, env) + end) + + c.target(unpack(args)) else error404() end end --- Generates the dispatching tree +--- Generate the dispatching index using the best possible strategy. function createindex() - local path = luci.sys.libpath() .. "/controller/" + local path = luci.util.libpath() .. "/controller/" local suff = ".lua" - + if luci.util.copcall(require, "luci.fastindex") then createindex_fastindex(path, suff) else @@ -188,130 +278,151 @@ function createindex() end end --- Uses fastindex to create the dispatching tree +--- Generate the dispatching index using the fastindex C-indexer. +-- @param path Controller base directory +-- @param suffix Controller file suffix function createindex_fastindex(path, suffix) index = {} - + if not fi then fi = luci.fastindex.new("index") fi.add(path .. "*" .. suffix) fi.add(path .. "*/*" .. suffix) end fi.scan() - + for k, v in pairs(fi.indexes) do index[v[2]] = v[1] end end --- Calls the index function of all available controllers --- Fallback for transition purposes / Leave it in as long as it works otherwise throw it away +--- 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) - index = {} - - local cache = nil - - local controllers = luci.util.combine( + local controllers = util.combine( luci.fs.glob(path .. "*" .. suffix) or {}, luci.fs.glob(path .. "*/*" .. suffix) or {} ) - + if indexcache then - cache = luci.fs.mtime(indexcache) - - if not cache then - luci.fs.mkdir(indexcache) - luci.fs.chmod(indexcache, "a=,u=rwx") - cache = luci.fs.mtime(indexcache) + local cachedate = fs.mtime(indexcache) + if cachedate then + local realdate = 0 + for _, obj in ipairs(controllers) do + local omtime = fs.mtime(path .. "/" .. obj) + 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-------", + "Fatal: Indexcache is not sane!" + ) + + index = loadfile(indexcache)() + return index + end end end + index = {} + for i,c in ipairs(controllers) do local module = "luci.controller." .. c:sub(#path+1, #c-#suffix):gsub("/", ".") - local cachefile - local stime - local ctime - - if cache then - cachefile = indexcache .. "/" .. module - stime = luci.fs.mtime(c) or 0 - ctime = luci.fs.mtime(cachefile) or 0 - end - - if not cache or stime > ctime then - stat, mod = luci.util.copcall(require, module) - - if stat and mod and type(mod.index) == "function" then - index[module] = mod.index - - if cache then - luci.fs.writefile(cachefile, luci.util.dump(mod.index)) - end - end - else - index[module] = loadfile(cachefile) + local mod = require(module) + local idx = mod.index + + if type(idx) == "function" then + index[module] = idx end end + + if indexcache then + fs.writefile(indexcache, util.get_bytecode(index)) + fs.chmod(indexcache, "a-rwx,u+rw") + end end --- Creates the dispatching tree from the index +--- Create the dispatching tree from the index. +-- Build the index before if it does not exist yet. function createtree() if not index then createindex() end - - context.tree = {nodes={}} - require("luci.i18n") - + + local ctx = context + local tree = {nodes={}} + local modi = {} + + ctx.treecache = setmetatable({}, {__mode="v"}) + ctx.tree = tree + ctx.modifiers = modi + -- Load default translation - luci.i18n.loadc("default") - - local scope = luci.util.clone(_G) - for k,v in pairs(_M) do - if type(v) == "function" then - scope[k] = v - end - end + require "luci.i18n".loadc("default") + + local scope = setmetatable({}, {__index = luci.dispatcher}) for k, v in pairs(index) do scope._NAME = k setfenv(v, scope) - - local stat, err = luci.util.copcall(v) - if not stat then - error500(err) - os.exit(1) - end + v() + end + + local function modisort(a,b) + return modi[a].order < modi[b].order end + + for _, v in util.spairs(modi, modisort) do + scope._NAME = v.module + setfenv(v.func, scope) + v.func() + end + + return tree +end + +--- Register a tree modifier. +-- @param func Modifier function +-- @param order Modifier order value (optional) +function modifier(func, order) + context.modifiers[#context.modifiers+1] = { + func = func, + order = order or 0, + module = getfenv(2)._NAME + } end --- Reassigns a node to another position +--- Clone a node of the dispatching tree to another position. +-- @param path Virtual path destination +-- @param clone Virtual path source +-- @param title Destination node title (optional) +-- @param order Destination node order value (optional) +-- @return Dispatching tree node function assign(path, clone, title, order) - local obj = node(path) + local obj = node(unpack(path)) obj.nodes = nil obj.module = nil - + obj.title = title obj.order = order - - local c = context.tree - for k, v in ipairs(clone) do - if not c.nodes[v] then - c.nodes[v] = {nodes={}} - end - c = c.nodes[v] - end - - setmetatable(obj, {__index = c}) - + setmetatable(obj, {__index = _create_node(clone)}) + return obj end --- Shortcut for creating a dispatching node +--- Create a new dispatching node and define common parameters. +-- @param path Virtual path +-- @param target Target function to call when dispatched. +-- @param title Destination node title +-- @param order Destination node order value (optional) +-- @return Dispatching tree node function entry(path, target, title, order) - local c = node(path) - + local c = node(unpack(path)) + c.target = target c.title = title c.order = order @@ -320,82 +431,185 @@ function entry(path, target, title, order) return c end --- Fetch a dispatching node +--- Fetch or create a new dispatching node. +-- @param ... Virtual path +-- @return Dispatching tree node function node(...) - local c = context.tree - arg.n = nil - if arg[1] then - if type(arg[1]) == "table" then - arg = arg[1] - end - end + local c = _create_node({...}) - for k,v in ipairs(arg) do - if not c.nodes[v] then - c.nodes[v] = {nodes={}} - end + c.module = getfenv(2)._NAME + c.auto = nil + + return c +end - c = c.nodes[v] +function _create_node(path, cache) + if #path == 0 then + return context.tree end - c.module = getfenv(2)._NAME - c.path = arg + cache = cache or context.treecache + local name = table.concat(path, ".") + local c = cache[name] - return c + if not c then + local new = {nodes={}, auto=true, path=util.clone(path)} + local last = table.remove(path) + + c = _create_node(path, cache) + + c.nodes[last] = new + cache[name] = new + + return new + else + return c + end end -- Subdispatchers -- + +--- Create a redirect to another dispatching node. +-- @param ... Virtual path destination function alias(...) - local req = arg - return function() + local req = {...} + return function(...) + for _, r in ipairs({...}) do + req[#req+1] = r + end + dispatch(req) end end +--- Rewrite the first x path values of the request. +-- @param n Number of path values to replace +-- @param ... Virtual path to replace removed path values with function rewrite(n, ...) - local req = arg - return function() - for i=1,n do - table.remove(context.path, 1) + local req = {...} + return function(...) + local dispatched = util.clone(context.dispatched) + + for i=1,n do + table.remove(dispatched, 1) end - - for i,r in ipairs(req) do - table.insert(context.path, i, r) + + for i, r in ipairs(req) do + table.insert(dispatched, i, r) + end + + for _, r in ipairs({...}) do + dispatched[#dispatched+1] = r end - - dispatch() + + dispatch(dispatched) end end +--- Create a function-call dispatching target. +-- @param name Target function of local controller +-- @param ... Additional parameters passed to the function function call(name, ...) local argv = {...} - return function() return getfenv()[name](unpack(argv)) end + return function(...) + if #argv > 0 then + return getfenv()[name](unpack(argv), ...) + else + return getfenv()[name](...) + end + end end +--- Create a template render dispatching target. +-- @param name Template to be rendered function template(name) - require("luci.template") - return function() luci.template.render(name) end + return function() + require("luci.template") + luci.template.render(name) + end end -function cbi(model) - require("luci.cbi") - require("luci.template") +--- Create a CBI model dispatching target. +-- @param model CBI model to be rendered +function cbi(model, config) + config = config or {} + return function(...) + require("luci.cbi") + require("luci.template") + local http = require "luci.http" - return function() - local stat, res = luci.util.copcall(luci.cbi.load, model) - if not stat then - error500(res) - return true + maps = luci.cbi.load(model, ...) + + local state = nil + + for i, res in ipairs(maps) do + if config.autoapply then + res.autoapply = config.autoapply + end + local cstate = res:parse() + if not state or cstate < state then + state = cstate + end end - local stat, err = luci.util.copcall(res.parse, res) - if not stat then - error500(err) - return true + if config.on_valid_to and state and state > 0 and state < 2 then + luci.http.redirect(config.on_valid_to) + return + end + + if config.on_changed_to and state and state > 1 then + luci.http.redirect(config.on_changed_to) + return + end + + if config.on_success_to and state and state > 0 then + luci.http.redirect(config.on_success_to) + return + end + + if config.state_handler then + if not config.state_handler(state, maps) then + return + end + end + + local pageaction = true + http.header("X-CBI-State", state or 0) + luci.template.render("cbi/header", {state = state}) + for i, res in ipairs(maps) do + res:render() + if res.pageaction == false then + pageaction = false + end + end + luci.template.render("cbi/footer", {pageaction=pageaction, state = state, autoapply = config.autoapply}) + end +end + +--- Create a CBI form model dispatching target. +-- @param model CBI form model tpo be rendered +function form(model) + return function(...) + require("luci.cbi") + require("luci.template") + local http = require "luci.http" + + maps = luci.cbi.load(model, ...) + + local state = nil + + for i, res in ipairs(maps) do + local cstate = res:parse() + if not state or cstate < state then + state = cstate + end end - luci.template.render("cbi/header") - res:render() - luci.template.render("cbi/footer") + http.header("X-CBI-State", state or 0) + luci.template.render("header") + for i, res in ipairs(maps) do + res:render() + end + luci.template.render("footer") end end