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)
35 context = luci.util.threadlocal()
46 --- Build the URL relative to the server webroot from given virtual path.
47 -- @param ... Virtual path
48 -- @return Relative URL
49 function build_url(...)
50 return luci.http.getenv("SCRIPT_NAME") .. "/" .. table.concat(arg, "/")
53 --- Send a 404 error code and render the "error404" template if available.
54 -- @param message Custom error message (optional)
56 function error404(message)
57 luci.http.status(404, "Not Found")
58 message = message or "Not Found"
60 require("luci.template")
61 if not luci.util.copcall(luci.template.render, "error404") then
62 luci.http.prepare_content("text/plain")
63 luci.http.write(message)
68 --- Send a 500 error code and render the "error500" template if available.
69 -- @param message Custom error message (optional)#
71 function error500(message)
72 luci.http.status(500, "Internal Server Error")
74 require("luci.template")
75 if not luci.util.copcall(luci.template.render, "error500", {message=message}) then
76 luci.http.prepare_content("text/plain")
77 luci.http.write(message)
82 function authenticator.htmlauth(validator, accs, default)
83 local user = luci.http.formvalue("username")
84 local pass = luci.http.formvalue("password")
86 if user and validator(user, pass) then
91 require("luci.template")
93 luci.template.render("sysauth", {duser=default, fuser=user})
98 --- Dispatch an HTTP request.
99 -- @param request LuCI HTTP Request object
100 function httpdispatch(request)
101 luci.http.context.request = request
103 local pathinfo = request:getenv("PATH_INFO") or ""
105 for node in pathinfo:gmatch("[^/]+") do
106 table.insert(context.request, node)
109 dispatch(context.request)
113 --- Dispatches a LuCI virtual path.
114 -- @param request Virtual path
115 function dispatch(request)
116 context.path = request
119 luci.i18n.setlanguage(require("luci.config").main.lang)
121 if not context.tree then
125 local c = context.tree
131 for i, s in ipairs(request) do
138 for k, v in pairs(c) do
148 for j=n+1, #request do
149 table.insert(args, request[j])
154 require("luci.i18n").loadc(track.i18n)
157 -- Init template engine
158 local tpl = require("luci.template")
160 tpl.context.viewns = viewns
161 viewns.write = luci.http.write
162 viewns.translate = function(...) return require("luci.i18n").translate(...) end
163 viewns.striptags = luci.util.striptags
164 viewns.controller = luci.http.getenv("SCRIPT_NAME")
165 viewns.media = luci.config.main.mediaurlbase
166 viewns.resource = luci.config.main.resourcebase
167 viewns.REQUEST_URI = (luci.http.getenv("SCRIPT_NAME") or "") .. (luci.http.getenv("PATH_INFO") or "")
169 if track.dependent then
170 local stat, err = pcall(assert, not track.auto)
177 if track.sysauth then
178 require("luci.sauth")
179 local authen = type(track.sysauth_authenticator) == "function"
180 and track.sysauth_authenticator
181 or authenticator[track.sysauth_authenticator]
182 local def = (type(track.sysauth) == "string") and track.sysauth
183 local accs = def and {track.sysauth} or track.sysauth
184 local sess = luci.http.getcookie("sysauth")
185 sess = sess and sess:match("^[A-F0-9]+$")
186 local user = luci.sauth.read(sess)
188 if not luci.util.contains(accs, user) then
190 local user, sess = authen(luci.sys.user.checkpasswd, accs, def)
191 if not user or not luci.util.contains(accs, user) then
194 local sid = sess or luci.sys.uniqueid(16)
195 luci.http.header("Set-Cookie", "sysauth=" .. sid.."; path=/")
197 luci.sauth.write(sid, user)
201 luci.http.status(403, "Forbidden")
207 if track.setgroup then
208 luci.sys.process.setgroup(track.setgroup)
211 if track.setuser then
212 luci.sys.process.setuser(track.setuser)
215 if c and type(c.target) == "function" then
216 context.dispatched = c
217 stat, mod = luci.util.copcall(require, c.module)
219 luci.util.updfenv(c.target, mod)
222 stat, err = luci.util.copcall(c.target, unpack(args))
231 --- Generate the dispatching index using the best possible strategy.
232 function createindex()
233 local path = luci.util.libpath() .. "/controller/"
236 if luci.util.copcall(require, "luci.fastindex") then
237 createindex_fastindex(path, suff)
239 createindex_plain(path, suff)
243 --- Generate the dispatching index using the fastindex C-indexer.
244 -- @param path Controller base directory
245 -- @param suffix Controller file suffix
246 function createindex_fastindex(path, suffix)
250 fi = luci.fastindex.new("index")
251 fi.add(path .. "*" .. suffix)
252 fi.add(path .. "*/*" .. suffix)
256 for k, v in pairs(fi.indexes) do
261 --- Generate the dispatching index using the native file-cache based strategy.
262 -- @param path Controller base directory
263 -- @param suffix Controller file suffix
264 function createindex_plain(path, suffix)
269 local controllers = luci.util.combine(
270 luci.fs.glob(path .. "*" .. suffix) or {},
271 luci.fs.glob(path .. "*/*" .. suffix) or {}
275 cache = luci.fs.mtime(indexcache)
278 luci.fs.mkdir(indexcache)
279 luci.fs.chmod(indexcache, "a=,u=rwx")
280 cache = luci.fs.mtime(indexcache)
284 for i,c in ipairs(controllers) do
285 local module = "luci.controller." .. c:sub(#path+1, #c-#suffix):gsub("/", ".")
291 cachefile = indexcache .. "/" .. module
292 stime = luci.fs.mtime(c) or 0
293 ctime = luci.fs.mtime(cachefile) or 0
296 if not cache or stime > ctime then
297 stat, mod = luci.util.copcall(require, module)
299 if stat and mod and type(mod.index) == "function" then
300 index[module] = mod.index
303 luci.fs.writefile(cachefile, luci.util.get_bytecode(mod.index))
307 index[module] = loadfile(cachefile)
312 --- Create the dispatching tree from the index.
313 -- Build the index before if it does not exist yet.
314 function createtree()
319 context.tree = {nodes={}}
322 -- Load default translation
323 luci.i18n.loadc("default")
325 local scope = luci.util.clone(_G)
326 for k,v in pairs(luci.dispatcher) do
327 if type(v) == "function" then
332 for k, v in pairs(index) do
336 local stat, err = luci.util.copcall(v)
338 error500("createtree failed: " .. k .. ": " .. err)
345 --- Clone a node of the dispatching tree to another position.
346 -- @param path Virtual path destination
347 -- @param clone Virtual path source
348 -- @param title Destination node title (optional)
349 -- @param order Destination node order value (optional)
350 -- @return Dispatching tree node
351 function assign(path, clone, title, order)
352 local obj = node(unpack(path))
359 local c = context.tree
360 for k, v in ipairs(clone) do
361 if not c.nodes[v] then
362 c.nodes[v] = {nodes={}}
368 setmetatable(obj, {__index = c})
373 --- Create a new dispatching node and define common parameters.
374 -- @param path Virtual path
375 -- @param target Target function to call when dispatched.
376 -- @param title Destination node title
377 -- @param order Destination node order value (optional)
378 -- @return Dispatching tree node
379 function entry(path, target, title, order)
380 local c = node(unpack(path))
385 c.module = getfenv(2)._NAME
390 --- Fetch or create a new dispatching node.
391 -- @param ... Virtual path
392 -- @return Dispatching tree node
394 local c = context.tree
397 for k,v in ipairs(arg) do
398 if not c.nodes[v] then
399 c.nodes[v] = {nodes={}, auto=true}
405 c.module = getfenv(2)._NAME
414 --- Create a redirect to another dispatching node.
415 -- @param ... Virtual path destination
423 --- Rewrite the first x path values of the request.
424 -- @param n Number of path values to replace
425 -- @param ... Virtual path to replace removed path values with
426 function rewrite(n, ...)
430 table.remove(context.path, 1)
433 for i,r in ipairs(req) do
434 table.insert(context.path, i, r)
441 --- Create a function-call dispatching target.
442 -- @param name Target function of local controller
443 -- @param ... Additional parameters passed to the function
444 function call(name, ...)
446 return function() return getfenv()[name](unpack(argv)) end
449 --- Create a template render dispatching target.
450 -- @param name Template to be rendered
451 function template(name)
453 require("luci.template")
454 luci.template.render(name)
458 --- Create a CBI model dispatching target.
459 -- @param model CBI model tpo be rendered
463 require("luci.template")
465 local stat, maps = luci.util.copcall(luci.cbi.load, model, ...)
471 for i, res in ipairs(maps) do
472 local stat, err = luci.util.copcall(res.parse, res)
479 luci.template.render("cbi/header")
480 for i, res in ipairs(maps) do
483 luci.template.render("cbi/footer")
487 --- Create a CBI form model dispatching target.
488 -- @param model CBI form model tpo be rendered
492 require("luci.template")
494 local stat, maps = luci.util.copcall(luci.cbi.load, model, ...)
500 for i, res in ipairs(maps) do
501 local stat, err = luci.util.copcall(res.parse, res)
508 luci.template.render("header")
509 for i, res in ipairs(maps) do
512 luci.template.render("footer")