X-Git-Url: https://git.archive.openwrt.org/?p=project%2Fluci.git;a=blobdiff_plain;f=libs%2Fweb%2Fluasrc%2Fdispatcher.lua;h=9ba74c49c91e09ed25dc101d007c73918c3a1678;hp=756f3cc7d50f1f4dabf50dcc735666bb6a141518;hb=e72a526984982f6fa2b6f2ed5ce01523094bfe43;hpb=3ca2844c9fb46145e5c6023e8767137992e558cb diff --git a/libs/web/luasrc/dispatcher.lua b/libs/web/luasrc/dispatcher.lua index 756f3cc7d..9ba74c49c 100644 --- a/libs/web/luasrc/dispatcher.lua +++ b/libs/web/luasrc/dispatcher.lua @@ -23,6 +23,8 @@ See the License for the specific language governing permissions and limitations under the License. ]]-- + +--- LuCI web dispatcher. module("luci.dispatcher", package.seeall) require("luci.init") require("luci.http") @@ -38,12 +40,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.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" @@ -56,7 +62,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") @@ -68,7 +76,9 @@ function error500(message) return false end --- Renders an authorization form +--- Render and evaluate the system authentication login form. +-- @param default Default username +-- @return Authentication status function sysauth(default) local user = luci.http.formvalue("username") local pass = luci.http.formvalue("password") @@ -87,7 +97,8 @@ function sysauth(default) end end --- Creates a request object for dispatching +--- Dispatch an HTTP request. +-- @param request LuCI HTTP Request object function httpdispatch(request) luci.http.context.request = request context.request = {} @@ -101,7 +112,8 @@ function httpdispatch(request) luci.http.close() end --- Dispatches a request +--- Dispatches a LuCI virtual path. +-- @param request Virtual path function dispatch(request) context.path = request @@ -114,9 +126,12 @@ function dispatch(request) local c = context.tree local track = {} + local args = {} + local n for i, s in ipairs(request) do c = c.nodes[s] + n = i if not c or c.leaf then break end @@ -126,6 +141,12 @@ function dispatch(request) 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 @@ -141,6 +162,14 @@ function dispatch(request) viewns.resource = luci.config.main.resourcebase viewns.REQUEST_URI = luci.http.getenv("SCRIPT_NAME") .. (luci.http.getenv("PATH_INFO") or "") + if track.dependent then + local stat, err = pcall(assert, not track.auto) + if not stat then + error500(err) + return + end + end + if track.sysauth then require("luci.sauth") local def = (type(track.sysauth) == "string") and track.sysauth @@ -170,7 +199,7 @@ function dispatch(request) luci.util.updfenv(c.target, mod) end - stat, err = luci.util.copcall(c.target) + stat, err = luci.util.copcall(c.target, unpack(args)) if not stat then error500(err) end @@ -179,9 +208,9 @@ function dispatch(request) 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 @@ -191,7 +220,9 @@ 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 = {} @@ -207,8 +238,9 @@ function createindex_fastindex(path, suffix) 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 = {} @@ -248,7 +280,7 @@ function createindex_plain(path, suffix) index[module] = mod.index if cache then - luci.fs.writefile(cachefile, luci.util.dump(mod.index)) + luci.fs.writefile(cachefile, luci.util.get_bytecode(mod.index)) end end else @@ -257,7 +289,8 @@ function createindex_plain(path, suffix) 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() @@ -289,7 +322,12 @@ function createtree() end 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(unpack(path)) obj.nodes = nil @@ -312,7 +350,12 @@ function assign(path, clone, title, order) 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(unpack(path)) @@ -324,28 +367,16 @@ function entry(path, target, title, order) return c end --- Checks whether a node exists -function registered(...) - local c = context.tree - - for k,v in ipairs(arg) do - if not c.nodes[v] then - return false - end - - c = c.nodes[v] - end - return true -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 for k,v in ipairs(arg) do if not c.nodes[v] then - c.nodes[v] = {nodes={}} + c.nodes[v] = {nodes={}, auto=true} end c = c.nodes[v] @@ -353,11 +384,15 @@ function node(...) c.module = getfenv(2)._NAME c.path = arg + c.auto = nil return c end -- Subdispatchers -- + +--- Create a redirect to another dispatching node. +-- @param ... Virtual path destination function alias(...) local req = arg return function() @@ -365,6 +400,9 @@ function alias(...) 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() @@ -380,22 +418,29 @@ function rewrite(n, ...) 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 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 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() - local stat, maps = luci.util.copcall(luci.cbi.load, model) + return function(...) + local stat, maps = luci.util.copcall(luci.cbi.load, model, ...) if not stat then error500(maps) return true