libs/web: cbi: provide a "last_child" property to allow for more layout control in...
[project/luci.git] / libs / web / luasrc / dispatcher.lua
index 1374270..f277501 100644 (file)
@@ -35,6 +35,7 @@ local nixio = require "nixio", require "nixio.util"
 module("luci.dispatcher", package.seeall)
 context = util.threadlocal()
 uci = require "luci.model.uci"
+i18n = require "luci.i18n"
 _M.fs = fs
 
 authenticator = {}
@@ -51,11 +52,25 @@ local fi
 -- @return             Relative URL
 function build_url(...)
        local path = {...}
-       local sn = http.getenv("SCRIPT_NAME") or ""
+       local url = { http.getenv("SCRIPT_NAME") or "" }
+
+       local k, v
        for k, v in pairs(context.urltoken) do
-               sn = sn .. "/;" .. k .. "=" .. http.urlencode(v)
+               url[#url+1] = "/;"
+               url[#url+1] = http.urlencode(k)
+               url[#url+1] = "="
+               url[#url+1] = http.urlencode(v)
+       end
+
+       local p
+       for _, p in ipairs(path) do
+               if p:match("^[a-zA-Z0-9_%-%.%%/,;]+$") then
+                       url[#url+1] = "/"
+                       url[#url+1] = p
+               end
        end
-       return sn .. ((#path > 0) and "/" .. table.concat(path, "/") or "")
+
+       return table.concat(url, "")
 end
 
 --- Send a 404 error code and render the "error404" template if available.
@@ -115,6 +130,8 @@ function httpdispatch(request, prefix)
 
        local r = {}
        context.request = r
+       context.urltoken = {}
+       
        local pathinfo = http.urldecode(request:getenv("PATH_INFO") or "", true)
 
        if prefix then
@@ -123,8 +140,18 @@ function httpdispatch(request, prefix)
                end
        end
 
+       local tokensok = true
        for node in pathinfo:gmatch("[^/]+") do
-               r[#r+1] = node
+               local tkey, tval
+               if tokensok then
+                       tkey, tval = node:match(";(%w+)=([a-fA-F0-9]*)")
+               end
+               if tkey then
+                       context.urltoken[tkey] = tval
+               else
+                       tokensok = false
+                       r[#r+1] = node
+               end
        end
 
        local stat, err = util.coxpcall(function()
@@ -142,13 +169,12 @@ function dispatch(request)
        --context._disable_memtrace = require "luci.debug".trap_memtrace("l")
        local ctx = context
        ctx.path = request
-       ctx.urltoken   = ctx.urltoken or {}
 
        local conf = require "luci.config"
        assert(conf.main,
                "/etc/config/luci seems to be corrupt, unable to find section 'main'")
 
-       local lang = conf.main.lang
+       local lang = conf.main.lang or "auto"
        if lang == "auto" then
                local aclang = http.getenv("HTTP_ACCEPT_LANGUAGE") or ""
                for lpat in aclang:gmatch("[%w-]+") do
@@ -158,7 +184,7 @@ function dispatch(request)
                                break
                        end
                end
-        end
+       end
        require "luci.i18n".setlanguage(lang)
 
        local c = ctx.tree
@@ -172,34 +198,23 @@ function dispatch(request)
        ctx.args = args
        ctx.requestargs = ctx.requestargs or args
        local n
-       local t = true
        local token = ctx.urltoken
        local preq = {}
        local freq = {}
 
        for i, s in ipairs(request) do
-               local tkey, tval
-               if t then
-                       tkey, tval = s:match(";(%w+)=(.*)")
+               preq[#preq+1] = s
+               freq[#freq+1] = s
+               c = c.nodes[s]
+               n = i
+               if not c then
+                       break
                end
 
-               if tkey then
-                       token[tkey] = tval
-               else
-                       t = false
-                       preq[#preq+1] = s
-                       freq[#freq+1] = s
-                       c = c.nodes[s]
-                       n = i
-                       if not c then
-                               break
-                       end
-
-                       util.update(track, c)
+               util.update(track, c)
 
-                       if c.leaf then
-                               break
-                       end
+               if c.leaf then
+                       break
                end
        end
 
@@ -214,7 +229,7 @@ function dispatch(request)
        ctx.path = preq
 
        if track.i18n then
-               require("luci.i18n").loadc(track.i18n)
+               i18n.loadc(track.i18n)
        end
 
        -- Init template engine
@@ -235,7 +250,8 @@ function dispatch(request)
                tpl.context.viewns = setmetatable({
                   write       = luci.http.write;
                   include     = function(name) tpl.Template(name):render(getfenv(2)) end;
-                  translate   = function(...) return require("luci.i18n").translate(...) end;
+                  translate   = i18n.translate;
+                  export      = function(k, v) if tpl.context.viewns[k] == nil then tpl.context.viewns[k] = v end end;
                   striptags   = util.striptags;
                   pcdata      = util.pcdata;
                   media       = media;
@@ -253,7 +269,12 @@ function dispatch(request)
        end
 
        track.dependent = (track.dependent ~= false)
-       assert(not track.dependent or not track.auto, "Access Violation")
+       assert(not track.dependent or not track.auto,
+               "Access Violation\nThe page at '" .. table.concat(request, "/") .. "/' " ..
+               "has no parent node so the access to this location has been denied.\n" ..
+               "This is a software bug, please report this message at " ..
+               "http://luci.subsignal.org/trac/newticket"
+       )
 
        if track.sysauth then
                local sauth = require "luci.sauth"
@@ -364,13 +385,27 @@ function dispatch(request)
                        setfenv(target, env)
                end)
 
+               local ok, err
                if type(c.target) == "table" then
-                       target(c.target, unpack(args))
+                       ok, err = util.copcall(target, c.target, unpack(args))
                else
-                       target(unpack(args))
+                       ok, err = util.copcall(target, unpack(args))
                end
+               assert(ok,
+                      "Failed to execute " .. (type(c.target) == "function" and "function" or c.target.type or "unknown") ..
+                      " dispatcher target for entry '/" .. table.concat(request, "/") .. "'.\n" ..
+                      "The called action terminated with an exception:\n" .. tostring(err or "(unknown)"))
        else
-               error404()
+               local root = node()
+               if not root or not root.target then
+                       error404("No root node was registered, this usually happens if no module was installed.\n" ..
+                                "Install luci-admin-full and retry. " ..
+                                "If the module is already installed, try removing the /tmp/luci-indexcache file.")
+               else
+                       error404("No page is registered at '/" .. table.concat(request, "/") .. "'.\n" ..
+                                "If this url belongs to an extension, make sure it is properly installed.\n" ..
+                                "If the extension was recently installed, try removing the /tmp/luci-indexcache file.")
+               end
        end
 end
 
@@ -421,7 +456,7 @@ function createindex_plain(path, suffixes)
                if cachedate then
                        local realdate = 0
                        for _, obj in ipairs(controllers) do
-                               local omtime = fs.stat(path .. "/" .. obj, "mtime")
+                               local omtime = fs.stat(obj, "mtime")
                                realdate = (omtime and omtime > realdate) and omtime or realdate
                        end
 
@@ -441,17 +476,26 @@ function createindex_plain(path, suffixes)
        index = {}
 
        for i,c in ipairs(controllers) do
-               local module = "luci.controller." .. c:sub(#path+1, #c):gsub("/", ".")
+               local modname = "luci.controller." .. c:sub(#path+1, #c):gsub("/", ".")
                for _, suffix in ipairs(suffixes) do
-                       module = module:gsub(suffix.."$", "")
+                       modname = modname:gsub(suffix.."$", "")
                end
 
-               local mod = require(module)
+               local mod = require(modname)
+               assert(mod ~= true,
+                      "Invalid controller file found\n" ..
+                      "The file '" .. c .. "' contains an invalid module line.\n" ..
+                      "Please verify whether the module name is set to '" .. modname ..
+                      "' - It must correspond to the file path!")
+               
                local idx = mod.index
+               assert(type(idx) == "function",
+                      "Invalid controller file found\n" ..
+                      "The file '" .. c .. "' contains no index() function.\n" ..
+                      "Please make sure that the controller contains a valid " ..
+                      "index function and verify the spelling!")
 
-               if type(idx) == "function" then
-                       index[module] = idx
-               end
+               index[modname] = idx
        end
 
        if indexcache then
@@ -469,7 +513,7 @@ function createtree()
        end
 
        local ctx  = context
-       local tree = {nodes={}}
+       local tree = {nodes={}, inreq=true}
        local modi = {}
 
        ctx.treecache = setmetatable({}, {__mode="v"})
@@ -568,28 +612,28 @@ function node(...)
        return c
 end
 
-function _create_node(path, cache)
+function _create_node(path)
        if #path == 0 then
                return context.tree
        end
 
-       cache = cache or context.treecache
        local name = table.concat(path, ".")
-       local c = cache[name]
+       local c = context.treecache[name]
 
        if not c then
-               local new = {nodes={}, auto=true, path=util.clone(path)}
                local last = table.remove(path)
+               local parent = _create_node(path)
 
-               c = _create_node(path, cache)
-
-               c.nodes[last] = new
-               cache[name] = new
-
-               return new
-       else
-               return c
+               c = {nodes={}, auto=true}
+               -- the node is "in request" if the request path matches
+               -- at least up to the length of the node path
+               if parent.inreq and context.path[#path+1] == last then
+                 c.inreq = true
+               end
+               parent.nodes[last] = c
+               context.treecache[name] = c
        end
+       return c
 end
 
 -- Subdispatchers --
@@ -702,19 +746,60 @@ local function _cbi(self, ...)
                end
        end
 
-       local pageaction = true
        http.header("X-CBI-State", state or 0)
+
        if not config.noheader then
                tpl.render("cbi/header", {state = state})
        end
+
+       local redirect
+       local messages
+       local applymap   = false
+       local pageaction = true
+       local parsechain = { }
+
        for i, res in ipairs(maps) do
-               res:render()
+               if res.apply_needed and res.parsechain then
+                       local c
+                       for _, c in ipairs(res.parsechain) do
+                               parsechain[#parsechain+1] = c
+                       end
+                       applymap = true
+               end
+
+               if res.redirect then
+                       redirect = redirect or res.redirect
+               end
+
                if res.pageaction == false then
                        pageaction = false
                end
+
+               if res.message then
+                       messages = messages or { }
+                       messages[#messages+1] = res.message
+               end
        end
+
+       for i, res in ipairs(maps) do
+               res:render({
+                       firstmap   = (i == 1),
+                       applymap   = applymap,
+                       redirect   = redirect,
+                       messages   = messages,
+                       pageaction = pageaction,
+                       parsechain = parsechain
+               })
+       end
+
        if not config.nofooter then
-               tpl.render("cbi/footer", {flow = config, pageaction=pageaction, state = state, autoapply = config.autoapply})
+               tpl.render("cbi/footer", {
+                       flow       = config,
+                       pageaction = pageaction,
+                       redirect   = redirect,
+                       state      = state,
+                       autoapply  = config.autoapply
+               })
        end
 end
 
@@ -768,3 +853,16 @@ end
 function form(model)
        return {type = "cbi", model = model, target = _form}
 end
+
+--- Access the luci.i18n translate() api.
+-- @class  function
+-- @name   translate
+-- @param  text    Text to translate
+translate = i18n.translate
+
+--- No-op function used to mark translation entries for menu labels.
+-- This function does not actually translate the given argument but
+-- is used by build/i18n-scan.pl to find translatable entries.
+function _(text)
+       return text
+end