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 local fs = require "luci.fs"
29 local sys = require "luci.sys"
30 local init = require "luci.init"
31 local util = require "luci.util"
32 local http = require "luci.http"
34 module("luci.dispatcher", package.seeall)
35 context = 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(...)
51 local sn = http.getenv("SCRIPT_NAME") or ""
52 for k, v in pairs(context.urltoken) do
53 sn = sn .. "/;" .. k .. "=" .. http.urlencode(v)
55 return sn .. ((#path > 0) and "/" .. table.concat(path, "/") or "")
58 --- Send a 404 error code and render the "error404" template if available.
59 -- @param message Custom error message (optional)
61 function error404(message)
62 luci.http.status(404, "Not Found")
63 message = message or "Not Found"
65 require("luci.template")
66 if not luci.util.copcall(luci.template.render, "error404") then
67 luci.http.prepare_content("text/plain")
68 luci.http.write(message)
73 --- Send a 500 error code and render the "error500" template if available.
74 -- @param message Custom error message (optional)#
76 function error500(message)
77 luci.util.perror(message)
78 if not context.template_header_sent then
79 luci.http.status(500, "Internal Server Error")
80 luci.http.prepare_content("text/plain")
81 luci.http.write(message)
83 require("luci.template")
84 if not luci.util.copcall(luci.template.render, "error500", {message=message}) then
85 luci.http.prepare_content("text/plain")
86 luci.http.write(message)
92 function authenticator.htmlauth(validator, accs, default)
93 local user = luci.http.formvalue("username")
94 local pass = luci.http.formvalue("password")
96 if user and validator(user, pass) then
101 require("luci.template")
103 luci.template.render("sysauth", {duser=default, fuser=user})
108 --- Dispatch an HTTP request.
109 -- @param request LuCI HTTP Request object
110 function httpdispatch(request)
111 luci.http.context.request = request
113 local pathinfo = http.urldecode(request:getenv("PATH_INFO") or "", true)
115 for node in pathinfo:gmatch("[^/]+") do
116 table.insert(context.request, node)
119 local stat, err = util.coxpcall(function()
120 dispatch(context.request)
125 --context._disable_memtrace()
128 --- Dispatches a LuCI virtual path.
129 -- @param request Virtual path
130 function dispatch(request)
131 --context._disable_memtrace = require "luci.debug".trap_memtrace()
134 ctx.urltoken = ctx.urltoken or {}
136 local conf = require "luci.config"
138 "/etc/config/luci seems to be corrupt, unable to find section 'main'")
140 local lang = conf.main.lang
141 if lang == "auto" then
142 local aclang = http.getenv("HTTP_ACCEPT_LANGUAGE") or ""
143 for lpat in aclang:gmatch("[%w-]+") do
144 lpat = lpat and lpat:gsub("-", "_")
145 if conf.languages[lpat] then
151 require "luci.i18n".setlanguage(lang)
162 ctx.requestargs = ctx.requestargs or args
165 local token = ctx.urltoken
169 for i, s in ipairs(request) do
172 tkey, tval = s:match(";(%w+)=(.*)")
187 util.update(track, c)
196 for j=n+1, #request do
197 args[#args+1] = request[j]
198 freq[#freq+1] = request[j]
202 ctx.requestpath = freq
206 require("luci.i18n").loadc(track.i18n)
209 -- Init template engine
210 if (c and c.index) or not track.notemplate then
211 local tpl = require("luci.template")
212 local media = track.mediaurlbase or luci.config.main.mediaurlbase
213 if not pcall(tpl.Template, "themes/%s/header" % fs.basename(media)) then
215 for name, theme in pairs(luci.config.themes) do
216 if name:sub(1,1) ~= "." and pcall(tpl.Template,
217 "themes/%s/header" % fs.basename(theme)) then
221 assert(media, "No valid theme found")
224 local viewns = setmetatable({}, {__index=function(table, key)
225 if key == "controller" then
227 elseif key == "REQUEST_URI" then
228 return build_url(unpack(ctx.requestpath))
230 return rawget(table, key) or _G[key]
233 tpl.context.viewns = viewns
234 viewns.write = luci.http.write
235 viewns.include = function(name) tpl.Template(name):render(getfenv(2)) end
236 viewns.translate = function(...) return require("luci.i18n").translate(...) end
237 viewns.striptags = util.striptags
239 viewns.theme = fs.basename(media)
240 viewns.resource = luci.config.main.resourcebase
243 track.dependent = (track.dependent ~= false)
244 assert(not track.dependent or not track.auto, "Access Violation")
246 if track.sysauth then
247 local sauth = require "luci.sauth"
249 local authen = type(track.sysauth_authenticator) == "function"
250 and track.sysauth_authenticator
251 or authenticator[track.sysauth_authenticator]
253 local def = (type(track.sysauth) == "string") and track.sysauth
254 local accs = def and {track.sysauth} or track.sysauth
255 local sess = ctx.authsession
256 local verifytoken = false
258 sess = luci.http.getcookie("sysauth")
259 sess = sess and sess:match("^[A-F0-9]+$")
263 local sdat = sauth.read(sess)
267 sdat = loadstring(sdat)()
268 if not verifytoken or ctx.urltoken.stok == sdat.token then
273 if not util.contains(accs, user) then
275 ctx.urltoken.stok = nil
276 local user, sess = authen(luci.sys.user.checkpasswd, accs, def)
277 if not user or not util.contains(accs, user) then
280 local sid = sess or luci.sys.uniqueid(16)
282 local token = luci.sys.uniqueid(16)
283 sauth.write(sid, util.get_bytecode({
286 secret=luci.sys.uniqueid(16)
288 ctx.urltoken.stok = token
290 luci.http.header("Set-Cookie", "sysauth=" .. sid.."; path="..build_url())
291 ctx.authsession = sid
294 luci.http.status(403, "Forbidden")
298 ctx.authsession = sess
302 if track.setgroup then
303 luci.sys.process.setgroup(track.setgroup)
306 if track.setuser then
307 luci.sys.process.setuser(track.setuser)
312 if type(c.target) == "function" then
314 elseif type(c.target) == "table" then
315 target = c.target.target
319 if c and (c.index or type(target) == "function") then
321 ctx.requested = ctx.requested or ctx.dispatched
324 if c and c.index then
325 local tpl = require "luci.template"
327 if util.copcall(tpl.render, "indexer", {}) then
332 if type(target) == "function" then
333 util.copcall(function()
334 local oldenv = getfenv(target)
335 local module = require(c.module)
336 local env = setmetatable({}, {__index=
339 return rawget(tbl, key) or module[key] or oldenv[key]
345 if type(c.target) == "table" then
346 target(c.target, unpack(args))
355 --- Generate the dispatching index using the best possible strategy.
356 function createindex()
357 local path = luci.util.libpath() .. "/controller/"
360 if luci.util.copcall(require, "luci.fastindex") then
361 createindex_fastindex(path, suff)
363 createindex_plain(path, suff)
367 --- Generate the dispatching index using the fastindex C-indexer.
368 -- @param path Controller base directory
369 -- @param suffix Controller file suffix
370 function createindex_fastindex(path, suffix)
374 fi = luci.fastindex.new("index")
375 fi.add(path .. "*" .. suffix)
376 fi.add(path .. "*/*" .. suffix)
380 for k, v in pairs(fi.indexes) do
385 --- Generate the dispatching index using the native file-cache based strategy.
386 -- @param path Controller base directory
387 -- @param suffix Controller file suffix
388 function createindex_plain(path, suffix)
389 local controllers = util.combine(
390 luci.fs.glob(path .. "*" .. suffix) or {},
391 luci.fs.glob(path .. "*/*" .. suffix) or {}
395 local cachedate = fs.mtime(indexcache)
398 for _, obj in ipairs(controllers) do
399 local omtime = fs.mtime(path .. "/" .. obj)
400 realdate = (omtime and omtime > realdate) and omtime or realdate
403 if cachedate > realdate then
405 sys.process.info("uid") == fs.stat(indexcache, "uid")
406 and fs.stat(indexcache, "mode") == "rw-------",
407 "Fatal: Indexcache is not sane!"
410 index = loadfile(indexcache)()
418 for i,c in ipairs(controllers) do
419 local module = "luci.controller." .. c:sub(#path+1, #c-#suffix):gsub("/", ".")
420 local mod = require(module)
421 local idx = mod.index
423 if type(idx) == "function" then
429 fs.writefile(indexcache, util.get_bytecode(index))
430 fs.chmod(indexcache, "a-rwx,u+rw")
434 --- Create the dispatching tree from the index.
435 -- Build the index before if it does not exist yet.
436 function createtree()
442 local tree = {nodes={}}
445 ctx.treecache = setmetatable({}, {__mode="v"})
449 -- Load default translation
450 require "luci.i18n".loadc("default")
452 local scope = setmetatable({}, {__index = luci.dispatcher})
454 for k, v in pairs(index) do
460 local function modisort(a,b)
461 return modi[a].order < modi[b].order
464 for _, v in util.spairs(modi, modisort) do
465 scope._NAME = v.module
466 setfenv(v.func, scope)
473 --- Register a tree modifier.
474 -- @param func Modifier function
475 -- @param order Modifier order value (optional)
476 function modifier(func, order)
477 context.modifiers[#context.modifiers+1] = {
485 --- Clone a node of the dispatching tree to another position.
486 -- @param path Virtual path destination
487 -- @param clone Virtual path source
488 -- @param title Destination node title (optional)
489 -- @param order Destination node order value (optional)
490 -- @return Dispatching tree node
491 function assign(path, clone, title, order)
492 local obj = node(unpack(path))
499 setmetatable(obj, {__index = _create_node(clone)})
504 --- Create a new dispatching node and define common parameters.
505 -- @param path Virtual path
506 -- @param target Target function to call when dispatched.
507 -- @param title Destination node title
508 -- @param order Destination node order value (optional)
509 -- @return Dispatching tree node
510 function entry(path, target, title, order)
511 local c = node(unpack(path))
516 c.module = getfenv(2)._NAME
521 --- Fetch or create a dispatching node without setting the target module or
522 -- enabling the node.
523 -- @param ... Virtual path
524 -- @return Dispatching tree node
526 return _create_node({...})
529 --- Fetch or create a new dispatching node.
530 -- @param ... Virtual path
531 -- @return Dispatching tree node
533 local c = _create_node({...})
535 c.module = getfenv(2)._NAME
541 function _create_node(path, cache)
546 cache = cache or context.treecache
547 local name = table.concat(path, ".")
548 local c = cache[name]
551 local new = {nodes={}, auto=true, path=util.clone(path)}
552 local last = table.remove(path)
554 c = _create_node(path, cache)
567 --- Create a redirect to another dispatching node.
568 -- @param ... Virtual path destination
572 for _, r in ipairs({...}) do
580 --- Rewrite the first x path values of the request.
581 -- @param n Number of path values to replace
582 -- @param ... Virtual path to replace removed path values with
583 function rewrite(n, ...)
586 local dispatched = util.clone(context.dispatched)
589 table.remove(dispatched, 1)
592 for i, r in ipairs(req) do
593 table.insert(dispatched, i, r)
596 for _, r in ipairs({...}) do
597 dispatched[#dispatched+1] = r
605 local function _call(self, ...)
606 if #self.argv > 0 then
607 return getfenv()[self.name](unpack(self.argv), ...)
609 return getfenv()[self.name](...)
613 --- Create a function-call dispatching target.
614 -- @param name Target function of local controller
615 -- @param ... Additional parameters passed to the function
616 function call(name, ...)
617 return {type = "call", argv = {...}, name = name, target = _call}
621 local _template = function(self, ...)
622 require "luci.template".render(self.view)
625 --- Create a template render dispatching target.
626 -- @param name Template to be rendered
627 function template(name)
628 return {type = "template", view = name, target = _template}
632 local function _cbi(self, ...)
633 local cbi = require "luci.cbi"
634 local tpl = require "luci.template"
635 local http = require "luci.http"
637 local config = self.config or {}
638 local maps = cbi.load(self.model, ...)
642 for i, res in ipairs(maps) do
643 if config.autoapply then
644 res.autoapply = config.autoapply
646 local cstate = res:parse()
647 if cstate and (not state or cstate < state) then
652 if config.on_valid_to and state and state > 0 and state < 2 then
653 http.redirect(config.on_valid_to)
657 if config.on_changed_to and state and state > 1 then
658 http.redirect(config.on_changed_to)
662 if config.on_success_to and state and state > 0 then
663 http.redirect(config.on_success_to)
667 if config.state_handler then
668 if not config.state_handler(state, maps) then
673 local pageaction = true
674 http.header("X-CBI-State", state or 0)
675 tpl.render("cbi/header", {state = state})
676 for i, res in ipairs(maps) do
678 if res.pageaction == false then
682 tpl.render("cbi/footer", {pageaction=pageaction, state = state, autoapply = config.autoapply})
685 --- Create a CBI model dispatching target.
686 -- @param model CBI model to be rendered
687 function cbi(model, config)
688 return {type = "cbi", config = config, model = model, target = _cbi}
692 local function _arcombine(self, ...)
694 local target = #argv > 0 and self.targets[2] or self.targets[1]
695 setfenv(target.target, self.env)
696 target:target(unpack(argv))
699 --- Create a combined dispatching target for non argv and argv requests.
700 -- @param trg1 Overview Target
701 -- @param trg2 Detail Target
702 function arcombine(trg1, trg2)
703 return {type = "arcombine", env = getfenv(), target = _arcombine, targets = {trg1, trg2}}
707 local function _form(self, ...)
708 local cbi = require "luci.cbi"
709 local tpl = require "luci.template"
710 local http = require "luci.http"
712 local maps = luci.cbi.load(self.model, ...)
715 for i, res in ipairs(maps) do
716 local cstate = res:parse()
717 if cstate and (not state or cstate < state) then
722 http.header("X-CBI-State", state or 0)
724 for i, res in ipairs(maps) do
730 --- Create a CBI form model dispatching target.
731 -- @param model CBI form model tpo be rendered
733 return {type = "cbi", model = model, target = _form}