X-Git-Url: https://git.archive.openwrt.org/?p=project%2Fluci.git;a=blobdiff_plain;f=libs%2Fweb%2Fluasrc%2Fdispatcher.lua;h=7692dd2262d158725fd5da263ee0b02d5c647715;hp=d1fcdcd0fc017105eadf7ce859c0e3a70d1a2a0f;hb=cac36db0805f0238f374db15408c6820ab08eb60;hpb=3f5f89451e912039d70eeed9ed3373c72ab1e3f9 diff --git a/libs/web/luasrc/dispatcher.lua b/libs/web/luasrc/dispatcher.lua index d1fcdcd0f..7692dd226 100644 --- a/libs/web/luasrc/dispatcher.lua +++ b/libs/web/luasrc/dispatcher.lua @@ -23,94 +23,187 @@ See the License for the specific language governing permissions and limitations under the License. ]]-- -module("luci.dispatcher", package.seeall) -require("luci.http") -require("luci.sys") -require("luci.fs") --- Local dispatch database -local tree = {nodes={}} +--- 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" --- Index table -local index = {} +module("luci.dispatcher", package.seeall) +context = luci.util.threadlocal() --- Global request object -request = {} +authenticator = {} --- Active dispatched node -dispatched = nil +-- Index table +local index = nil --- Status fields -built_index = false -built_tree = false +-- Fastindex +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, "/") + 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" require("luci.template") - if not pcall(luci.template.render, "error404") then + if not luci.util.copcall(luci.template.render, "error404") then luci.http.prepare_content("text/plain") - print(message) + luci.http.write(message) end 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") require("luci.template") - if not pcall(luci.template.render, "error500", {message=message}) then + if not luci.util.copcall(luci.template.render, "error500", {message=message}) then luci.http.prepare_content("text/plain") - print(message) + luci.http.write(message) end return false end --- Creates a request object for dispatching -function httpdispatch() - local pathinfo = luci.http.env.PATH_INFO or "" - local c = tree +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 - for s in pathinfo:gmatch("([%w-]+)") do - table.insert(request, s) +--- Dispatch an HTTP request. +-- @param request LuCI HTTP Request object +function httpdispatch(request) + luci.http.context.request = request + context.request = {} + local pathinfo = request:getenv("PATH_INFO") or "" + + for node in pathinfo:gmatch("[^/]+") do + table.insert(context.request, node) end - dispatch() + local stat, err = util.copcall(dispatch, context.request) + if not stat then + error500(err) + end + + luci.http.close() end --- Dispatches a request -function dispatch() - if not built_tree then - createtree() +--- Dispatches a LuCI virtual path. +-- @param request Virtual path +function dispatch(request) + 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 = tree + local track = {} + local args = {} + context.args = 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 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 not track.notemplate then + 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.striptags = util.striptags + 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") or "") .. (luci.http.getenv("PATH_INFO") or "") + end + + 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 = 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 + end + else + luci.http.status(403, "Forbidden") + return + end + end + end if track.setgroup then luci.sys.process.setgroup(track.setgroup) @@ -119,55 +212,43 @@ function dispatch() if track.setuser then luci.sys.process.setuser(track.setuser) end - - -- Init template engine - local tpl = require("luci.template") - tpl.viewns.translate = function(...) return require("luci.i18n").translate(...) end - tpl.viewns.controller = luci.http.dispatcher() - tpl.viewns.uploadctrl = luci.http.dispatcher_upload() - tpl.viewns.media = luci.config.main.mediaurlbase - tpl.viewns.resource = luci.config.main.resourcebase - - -- Load default translation - require("luci.i18n").loadc("default") - if c and type(c.target) == "function" then - dispatched = c - stat, mod = pcall(require, c.module) - if stat then - luci.util.updfenv(c.target, mod) - end + context.dispatched = c - stat, err = pcall(c.target) - if not stat then - error500(err) - end + util.copcall(function() + util.updfenv(c.target, require(c.module)) + end) + + c.target(unpack(args)) else error404() end end --- Generates the dispatching tree +--- Generate the dispatching index using the best possible strategy. function createindex() - index = {} - local path = luci.sys.libpath() .. "/controller/" + local path = luci.util.libpath() .. "/controller/" local suff = ".lua" - if pcall(require, "fastindex") then + if luci.util.copcall(require, "luci.fastindex") then createindex_fastindex(path, suff) else createindex_plain(path, suff) end - - built_index = true end --- Uses fastindex to create the dispatching tree -function createindex_fastindex(path, suffix) - local fi = fastindex.new("index") - fi.add(path .. "*" .. suffix) - fi.add(path .. "*/*" .. suffix) +--- 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 @@ -175,156 +256,245 @@ function createindex_fastindex(path, suffix) end end --- Calls the index function of all available controllers +--- 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 cachetime = nil + if indexcache then + local cachedate = fs.mtime(indexcache) + if cachedate and cachedate > fs.mtime(path) 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 - local controllers = luci.util.combine( + index = {} + + local controllers = util.combine( luci.fs.glob(path .. "*" .. suffix) or {}, luci.fs.glob(path .. "*/*" .. suffix) or {} ) - - if indexcache then - cachetime = luci.fs.mtime(indexcache) + + for i,c in ipairs(controllers) do + local module = "luci.controller." .. c:sub(#path+1, #c-#suffix):gsub("/", ".") + local mod = require(module) + local idx = mod.index - if not cachetime then - luci.fs.mkdir(indexcache) - luci.fs.chmod(indexcache, "a=,u=rwx") + if type(idx) == "function" then + index[module] = idx end end - - if not cachetime then - for i,c in ipairs(controllers) do - c = "luci.controller." .. c:sub(#path+1, #c-#suffix):gsub("/", ".") - stat, mod = pcall(require, c) - if stat and mod and type(mod.index) == "function" then - index[c] = mod.index - - if indexcache then - luci.fs.writefile(indexcache .. "/" .. c, string.dump(mod.index)) - end - end - end - else - for i,c in ipairs(luci.fs.dir(indexcache)) do - if c:sub(1) ~= "." then - index[c] = loadfile(indexcache .. "/" .. c) - 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 built_index then + if not index then createindex() end - require("luci.i18n") + local ctx = context + local tree = {nodes={}} + + ctx.treecache = setmetatable({}, {__mode="v"}) + ctx.tree = tree + + -- Load default translation + require "luci.i18n".loadc("default") + + local scope = setmetatable({}, {__index = _G}) + for k,v in pairs(luci.dispatcher) do + if type(v) == "function" then + scope[k] = v + end + end for k, v in pairs(index) do - luci.util.updfenv(v, _M) - luci.util.extfenv(v, "_NAME", k) - - local stat, err = pcall(v) - if not stat then - error500(err) - os.exit(1) - end + scope._NAME = k + setfenv(v, scope) + v() end - built_tree = true + return tree end --- Shortcut for creating a dispatching node -function entry(path, target, title, order, add) - add = add or {} +--- 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(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}) + + return obj +end - local c = node(path) +--- 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(unpack(path)) + c.target = target c.title = title c.order = order c.module = getfenv(2)._NAME - for k,v in pairs(add) do - c[k] = v - end - 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 = tree + local c = _create_node(arg) - if arg[1] and type(arg[1]) == "table" then - arg = arg[1] - end + c.module = getfenv(2)._NAME + c.path = arg + c.auto = nil - for k,v in ipairs(arg) do - if not c.nodes[v] then - c.nodes[v] = {nodes={}, module=getfenv(2)._NAME} - end + return c +end - c = c.nodes[v] +function _create_node(path, cache) + if #path == 0 then + return context.tree + end + + cache = cache or context.treecache + local name = table.concat(path, ".") + local c = cache[name] + + if not c then + local last = table.remove(path) + c = _create_node(path, cache) + + local new = {nodes={}, auto=true} + c.nodes[last] = new + cache[name] = new + + return new + else + return c end - - return c end -- Subdispatchers -- + +--- Create a redirect to another dispatching node. +-- @param ... Virtual path destination function alias(...) local req = arg return function() - request = req - dispatch() + 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(request, 1) + table.remove(context.path, 1) end for i,r in ipairs(req) do - table.insert(request, i, r) + table.insert(context.path, i, r) end dispatch() end end -function call(name) - return function() getfenv()[name]() 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 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 +--- Create a CBI model dispatching target. +-- @param model CBI model tpo be rendered function cbi(model) - require("luci.cbi") - require("luci.template") + return function(...) + require("luci.cbi") + require("luci.template") - return function() - local stat, res = pcall(luci.cbi.load, model) - if not stat then - error500(res) - return true - end + maps = luci.cbi.load(model, ...) - local stat, err = pcall(res.parse, res) - if not stat then - error500(err) - return true + for i, res in ipairs(maps) do + res:parse() end luci.template.render("cbi/header") - res:render() + for i, res in ipairs(maps) do + res:render() + end luci.template.render("cbi/footer") 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") + + maps = luci.cbi.load(model, ...) + + for i, res in ipairs(maps) do + res:parse() + end + + luci.template.render("header") + for i, res in ipairs(maps) do + res:render() + end + luci.template.render("footer") + end +end