5 The request dispatcher and module dispatcher generators
11 Copyright 2008 Steven Barth <steven@midlink.org>
13 Licensed under the Apache License, Version 2.0 (the "License");
14 you may not use this file except in compliance with the License.
15 You may obtain a copy of the License at
17 http://www.apache.org/licenses/LICENSE-2.0
19 Unless required by applicable law or agreed to in writing, software
20 distributed under the License is distributed on an "AS IS" BASIS,
21 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 See the License for the specific language governing permissions and
23 limitations under the License.
27 --- LuCI web dispatcher.
28 module("luci.dispatcher", package.seeall)
34 context = luci.util.threadlocal()
45 --- Build the URL relative to the server webroot from given virtual path.
46 -- @param ... Virtual path
47 -- @return Relative URL
48 function build_url(...)
49 return luci.http.getenv("SCRIPT_NAME") .. "/" .. table.concat(arg, "/")
52 --- Send a 404 error code and render the "error404" template if available.
53 -- @param message Custom error message (optional)
55 function error404(message)
56 luci.http.status(404, "Not Found")
57 message = message or "Not Found"
59 require("luci.template")
60 if not luci.util.copcall(luci.template.render, "error404") then
61 luci.http.prepare_content("text/plain")
62 luci.http.write(message)
67 --- Send a 500 error code and render the "error500" template if available.
68 -- @param message Custom error message (optional)#
70 function error500(message)
71 luci.http.status(500, "Internal Server Error")
73 require("luci.template")
74 if not luci.util.copcall(luci.template.render, "error500", {message=message}) then
75 luci.http.prepare_content("text/plain")
76 luci.http.write(message)
81 function authenticator.htmlauth(validator, default)
82 local user = luci.http.formvalue("username")
83 local pass = luci.http.formvalue("password")
85 if user and validator(user, pass) then
90 require("luci.template")
92 luci.template.render("sysauth", {duser=default, fuser=user})
97 --- Dispatch an HTTP request.
98 -- @param request LuCI HTTP Request object
99 function httpdispatch(request)
100 luci.http.context.request = request
102 local pathinfo = request:getenv("PATH_INFO") or ""
104 for node in pathinfo:gmatch("[^/]+") do
105 table.insert(context.request, node)
108 dispatch(context.request)
112 --- Dispatches a LuCI virtual path.
113 -- @param request Virtual path
114 function dispatch(request)
115 context.path = request
118 luci.i18n.setlanguage(require("luci.config").main.lang)
120 if not context.tree then
124 local c = context.tree
129 for i, s in ipairs(request) do
132 if not c or c.leaf then
136 for k, v in pairs(c) do
142 for j=n+1, #request do
143 table.insert(args, request[j])
148 require("luci.i18n").loadc(track.i18n)
151 -- Init template engine
152 local tpl = require("luci.template")
154 tpl.context.viewns = viewns
155 viewns.write = luci.http.write
156 viewns.translate = function(...) return require("luci.i18n").translate(...) end
157 viewns.controller = luci.http.getenv("SCRIPT_NAME")
158 viewns.media = luci.config.main.mediaurlbase
159 viewns.resource = luci.config.main.resourcebase
160 viewns.REQUEST_URI = luci.http.getenv("SCRIPT_NAME") .. (luci.http.getenv("PATH_INFO") or "")
162 if track.dependent then
163 local stat, err = pcall(assert, not track.auto)
170 if track.sysauth then
171 require("luci.sauth")
172 local authen = authenticator[track.sysauth_authenticator]
173 local def = (type(track.sysauth) == "string") and track.sysauth
174 local accs = def and {track.sysauth} or track.sysauth
175 local user = luci.sauth.read(luci.http.getcookie("sysauth"))
177 if not luci.util.contains(accs, user) then
179 local user = authen(luci.sys.user.checkpasswd, def)
180 if not user or not luci.util.contains(accs, user) then
183 local sid = luci.sys.uniqueid(16)
184 luci.http.header("Set-Cookie", "sysauth=" .. sid.."; path=/")
185 luci.sauth.write(sid, user)
188 luci.http.status(403, "Forbidden")
194 if track.setgroup then
195 luci.sys.process.setgroup(track.setgroup)
198 if track.setuser then
199 luci.sys.process.setuser(track.setuser)
202 if c and type(c.target) == "function" then
203 context.dispatched = c
204 stat, mod = luci.util.copcall(require, c.module)
206 luci.util.updfenv(c.target, mod)
209 stat, err = luci.util.copcall(c.target, unpack(args))
218 --- Generate the dispatching index using the best possible strategy.
219 function createindex()
220 local path = luci.util.libpath() .. "/controller/"
223 if luci.util.copcall(require, "luci.fastindex") then
224 createindex_fastindex(path, suff)
226 createindex_plain(path, suff)
230 --- Generate the dispatching index using the fastindex C-indexer.
231 -- @param path Controller base directory
232 -- @param suffix Controller file suffix
233 function createindex_fastindex(path, suffix)
237 fi = luci.fastindex.new("index")
238 fi.add(path .. "*" .. suffix)
239 fi.add(path .. "*/*" .. suffix)
243 for k, v in pairs(fi.indexes) do
248 --- Generate the dispatching index using the native file-cache based strategy.
249 -- @param path Controller base directory
250 -- @param suffix Controller file suffix
251 function createindex_plain(path, suffix)
256 local controllers = luci.util.combine(
257 luci.fs.glob(path .. "*" .. suffix) or {},
258 luci.fs.glob(path .. "*/*" .. suffix) or {}
262 cache = luci.fs.mtime(indexcache)
265 luci.fs.mkdir(indexcache)
266 luci.fs.chmod(indexcache, "a=,u=rwx")
267 cache = luci.fs.mtime(indexcache)
271 for i,c in ipairs(controllers) do
272 local module = "luci.controller." .. c:sub(#path+1, #c-#suffix):gsub("/", ".")
278 cachefile = indexcache .. "/" .. module
279 stime = luci.fs.mtime(c) or 0
280 ctime = luci.fs.mtime(cachefile) or 0
283 if not cache or stime > ctime then
284 stat, mod = luci.util.copcall(require, module)
286 if stat and mod and type(mod.index) == "function" then
287 index[module] = mod.index
290 luci.fs.writefile(cachefile, luci.util.get_bytecode(mod.index))
294 index[module] = loadfile(cachefile)
299 --- Create the dispatching tree from the index.
300 -- Build the index before if it does not exist yet.
301 function createtree()
306 context.tree = {nodes={}}
309 -- Load default translation
310 luci.i18n.loadc("default")
312 local scope = luci.util.clone(_G)
313 for k,v in pairs(luci.dispatcher) do
314 if type(v) == "function" then
319 for k, v in pairs(index) do
323 local stat, err = luci.util.copcall(v)
325 error500("createtree failed: " .. k .. ": " .. err)
332 --- Clone a node of the dispatching tree to another position.
333 -- @param path Virtual path destination
334 -- @param clone Virtual path source
335 -- @param title Destination node title (optional)
336 -- @param order Destination node order value (optional)
337 -- @return Dispatching tree node
338 function assign(path, clone, title, order)
339 local obj = node(unpack(path))
346 local c = context.tree
347 for k, v in ipairs(clone) do
348 if not c.nodes[v] then
349 c.nodes[v] = {nodes={}}
355 setmetatable(obj, {__index = c})
360 --- Create a new dispatching node and define common parameters.
361 -- @param path Virtual path
362 -- @param target Target function to call when dispatched.
363 -- @param title Destination node title
364 -- @param order Destination node order value (optional)
365 -- @return Dispatching tree node
366 function entry(path, target, title, order)
367 local c = node(unpack(path))
372 c.module = getfenv(2)._NAME
377 --- Fetch or create a new dispatching node.
378 -- @param ... Virtual path
379 -- @return Dispatching tree node
381 local c = context.tree
384 for k,v in ipairs(arg) do
385 if not c.nodes[v] then
386 c.nodes[v] = {nodes={}, auto=true}
392 c.module = getfenv(2)._NAME
401 --- Create a redirect to another dispatching node.
402 -- @param ... Virtual path destination
410 --- Rewrite the first x path values of the request.
411 -- @param n Number of path values to replace
412 -- @param ... Virtual path to replace removed path values with
413 function rewrite(n, ...)
417 table.remove(context.path, 1)
420 for i,r in ipairs(req) do
421 table.insert(context.path, i, r)
428 --- Create a function-call dispatching target.
429 -- @param name Target function of local controller
430 -- @param ... Additional parameters passed to the function
431 function call(name, ...)
433 return function() return getfenv()[name](unpack(argv)) end
436 --- Create a template render dispatching target.
437 -- @param name Template to be rendered
438 function template(name)
439 require("luci.template")
440 return function() luci.template.render(name) end
443 --- Create a CBI model dispatching target.
444 -- @param model CBI model tpo be rendered
447 require("luci.template")
450 local stat, maps = luci.util.copcall(luci.cbi.load, model, ...)
456 for i, res in ipairs(maps) do
457 local stat, err = luci.util.copcall(res.parse, res)
464 luci.template.render("cbi/header")
465 for i, res in ipairs(maps) do
468 luci.template.render("cbi/footer")
472 --- Create a CBI form model dispatching target.
473 -- @param model CBI form model tpo be rendered
476 require("luci.template")
479 local stat, maps = luci.util.copcall(luci.cbi.load, model, ...)
485 for i, res in ipairs(maps) do
486 local stat, err = luci.util.copcall(res.parse, res)
493 luci.template.render("header")
494 for i, res in ipairs(maps) do
497 luci.template.render("footer")