libs/web: dispatcher.lua: add support for external tree building and indexing
[project/luci.git] / libs / web / luasrc / dispatcher.lua
index 5110209..b2a936a 100644 (file)
@@ -25,11 +25,12 @@ limitations under the License.
 ]]--
 
 --- LuCI web dispatcher.
-local fs = require "luci.fs"
+local fs = require "nixio.fs"
 local sys = require "luci.sys"
 local init = require "luci.init"
 local util = require "luci.util"
 local http = require "luci.http"
+local nixio = require "nixio", require "nixio.util"
 
 module("luci.dispatcher", package.seeall)
 context = util.threadlocal()
@@ -74,12 +75,17 @@ end
 -- @param message      Custom error message (optional)#
 -- @return                     false
 function error500(message)
-       luci.http.status(500, "Internal Server Error")
-
-       require("luci.template")
-       if not luci.util.copcall(luci.template.render, "error500", {message=message}) then
+       luci.util.perror(message)
+       if not context.template_header_sent then
+               luci.http.status(500, "Internal Server Error")
                luci.http.prepare_content("text/plain")
                luci.http.write(message)
+       else
+               require("luci.template")
+               if not luci.util.copcall(luci.template.render, "error500", {message=message}) then
+                       luci.http.prepare_content("text/plain")
+                       luci.http.write(message)
+               end
        end
        return false
 end
@@ -102,7 +108,7 @@ end
 
 --- Dispatch an HTTP request.
 -- @param request      LuCI HTTP Request object
-function httpdispatch(request)
+function httpdispatch(request, prefix, ext_tree)
        luci.http.context.request = request
        context.request = {}
        local pathinfo = http.urldecode(request:getenv("PATH_INFO") or "", true)
@@ -111,11 +117,9 @@ function httpdispatch(request)
                table.insert(context.request, node)
        end
 
-       local stat, err = util.copcall(dispatch, context.request)
-       if not stat then
-               luci.util.perror(err)
-               error500(err)
-       end
+       local stat, err = util.coxpcall(function()
+               dispatch(context.request, ext_tree)
+       end, error500)
 
        luci.http.close()
 
@@ -124,13 +128,16 @@ end
 
 --- Dispatches a LuCI virtual path.
 -- @param request      Virtual path
-function dispatch(request)
-       --context._disable_memtrace = require "luci.debug".trap_memtrace()
+function dispatch(request, ext_tree)
+       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
        if lang == "auto" then
                local aclang = http.getenv("HTTP_ACCEPT_LANGUAGE") or ""
@@ -144,12 +151,14 @@ function dispatch(request)
         end
        require "luci.i18n".setlanguage(lang)
 
-       local c = ctx.tree
-       local stat
-       if not c then
-               c = createtree()
+       if ext_tree then
+               ctx.index, ctx.tree, ctx.treecache, ctx.modifiers = unpack(ext_tree)
+       elseif not ctx.tree then
+               createtree()
        end
 
+       local c = ctx.tree
+       local stat
        local track = {}
        local args = {}
        ctx.args = args
@@ -204,7 +213,8 @@ function dispatch(request)
        if (c and c.index) or not track.notemplate then
                local tpl = require("luci.template")
                local media = track.mediaurlbase or luci.config.main.mediaurlbase
-               if not pcall(tpl.Template, "themes/%s/header" % fs.basename(media)) then
+               if not tpl.Template("themes/%s/header" % fs.basename(media)) then 
+               --if not pcall(tpl.Template, "themes/%s/header" % fs.basename(media)) then
                        media = nil
                        for name, theme in pairs(luci.config.themes) do
                                if name:sub(1,1) ~= "." and pcall(tpl.Template,
@@ -215,7 +225,15 @@ function dispatch(request)
                        assert(media, "No valid theme found")
                end
 
-               local viewns = setmetatable({}, {__index=function(table, key)
+               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;
+                       striptags   = util.striptags;
+                       media       = media;
+                       theme       = fs.basename(media);
+                       resource    = luci.config.main.resourcebase
+               }, {__index=function(table, key)
                        if key == "controller" then
                                return build_url()
                        elseif key == "REQUEST_URI" then
@@ -224,14 +242,6 @@ function dispatch(request)
                                return rawget(table, key) or _G[key]
                        end
                end})
-               tpl.context.viewns = viewns
-               viewns.write       = luci.http.write
-               viewns.include     = function(name) tpl.Template(name):render(getfenv(2)) end
-               viewns.translate   = function(...) return require("luci.i18n").translate(...) end
-               viewns.striptags   = util.striptags
-               viewns.media       = media
-               viewns.theme       = fs.basename(media)
-               viewns.resource    = luci.config.main.resourcebase
        end
 
        track.dependent = (track.dependent ~= false)
@@ -250,7 +260,7 @@ function dispatch(request)
                local verifytoken = false
                if not sess then
                        sess = luci.http.getcookie("sysauth")
-                       sess = sess and sess:match("^[A-F0-9]+$")
+                       sess = sess and sess:match("^[a-f0-9]+$")
                        verifytoken = true
                end
 
@@ -258,7 +268,9 @@ function dispatch(request)
                local user
 
                if sdat then
-                       sdat = loadstring(sdat)()
+                       sdat = loadstring(sdat)
+                       setfenv(sdat, {})
+                       sdat = sdat()
                        if not verifytoken or ctx.urltoken.stok == sdat.token then
                                user = sdat.user
                        end
@@ -349,55 +361,60 @@ end
 --- Generate the dispatching index using the best possible strategy.
 function createindex()
        local path = luci.util.libpath() .. "/controller/"
-       local suff = ".lua"
+       local suff = { ".lua", ".lua.gz" }
 
        if luci.util.copcall(require, "luci.fastindex") then
-               createindex_fastindex(path, suff)
+               return createindex_fastindex(path, suff)
        else
-               createindex_plain(path, suff)
+               return createindex_plain(path, suff)
        end
 end
 
 --- 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 = {}
+-- @param suffixes     Controller file suffixes
+function createindex_fastindex(path, suffixes)
+       local index = {}
 
        if not fi then
                fi = luci.fastindex.new("index")
-               fi.add(path .. "*" .. suffix)
-               fi.add(path .. "*/*" .. suffix)
+               for _, suffix in ipairs(suffixes) do
+                       fi.add(path .. "*" .. suffix)
+                       fi.add(path .. "*/*" .. suffix)
+               end
        end
        fi.scan()
 
        for k, v in pairs(fi.indexes) do
                index[v[2]] = v[1]
        end
+
+       return index
 end
 
 --- 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)
-       local controllers = util.combine(
-               luci.fs.glob(path .. "*" .. suffix) or {},
-               luci.fs.glob(path .. "*/*" .. suffix) or {}
-       )
+-- @param suffixes     Controller file suffixes
+function createindex_plain(path, suffixes)
+       local controllers = { }
+       for _, suffix in ipairs(suffixes) do
+               nixio.util.consume((fs.glob(path .. "*" .. suffix)), controllers)
+               nixio.util.consume((fs.glob(path .. "*/*" .. suffix)), controllers)
+       end
 
        if indexcache then
-               local cachedate = fs.mtime(indexcache)
+               local cachedate = fs.stat(indexcache, "mtime")
                if cachedate then
                        local realdate = 0
                        for _, obj in ipairs(controllers) do
-                               local omtime = fs.mtime(path .. "/" .. obj)
+                               local omtime = fs.stat(path .. "/" .. obj, "mtime")
                                realdate = (omtime and omtime > realdate) and omtime or realdate
                        end
 
                        if cachedate > realdate then
                                assert(
                                        sys.process.info("uid") == fs.stat(indexcache, "uid")
-                                       and fs.stat(indexcache, "mode") == "rw-------",
+                                       and fs.stat(indexcache, "modestr") == "rw-------",
                                        "Fatal: Indexcache is not sane!"
                                )
 
@@ -407,10 +424,14 @@ function createindex_plain(path, suffix)
                end
        end
 
-       index = {}
+       local index = {}
 
        for i,c in ipairs(controllers) do
-               local module = "luci.controller." .. c:sub(#path+1, #c-#suffix):gsub("/", ".")
+               local module = "luci.controller." .. c:sub(#path+1, #c):gsub("/", ".")
+               for _, suffix in ipairs(suffixes) do
+                       module = module:gsub(suffix.."$", "")
+               end
+
                local mod = require(module)
                local idx = mod.index
 
@@ -420,24 +441,28 @@ function createindex_plain(path, suffix)
        end
 
        if indexcache then
-               fs.writefile(indexcache, util.get_bytecode(index))
-               fs.chmod(indexcache, "a-rwx,u+rw")
+               local f = nixio.open(indexcache, "w", 600)
+               f:writeall(util.get_bytecode(index))
+               f:close()
        end
+
+       return index
 end
 
 --- Create the dispatching tree from the index.
 -- Build the index before if it does not exist yet.
 function createtree()
-       if not index then
-               createindex()
-       end
+       local ctx   = context
+       local tree  = {nodes={}}
+       local cache = setmetatable({}, {__mode="v"})
+       local modi  = {}
 
-       local ctx  = context
-       local tree = {nodes={}}
-       local modi = {}
+       if not ctx.index then
+               ctx.index = createindex()
+       end
 
-       ctx.treecache = setmetatable({}, {__mode="v"})
-       ctx.tree = tree
+       ctx.tree      = tree
+       ctx.treecache = cache
        ctx.modifiers = modi
 
        -- Load default translation
@@ -445,10 +470,10 @@ function createtree()
 
        local scope = setmetatable({}, {__index = luci.dispatcher})
 
-       for k, v in pairs(index) do
+       for k, v in pairs(ctx.index) do
                scope._NAME = k
                setfenv(v, scope)
-               v()
+               pcall(v)
        end
 
        local function modisort(a,b)
@@ -458,10 +483,10 @@ function createtree()
        for _, v in util.spairs(modi, modisort) do
                scope._NAME = v.module
                setfenv(v.func, scope)
-               v.func()
+               pcall(v.func)
        end
 
-       return tree
+       return { index, tree, cache, modi }
 end
 
 --- Register a tree modifier.
@@ -512,6 +537,14 @@ function entry(path, target, title, order)
        return c
 end
 
+--- Fetch or create a dispatching node without setting the target module or
+-- enabling the node.
+-- @param      ...             Virtual path
+-- @return                     Dispatching tree node
+function get(...)
+       return _create_node({...})
+end
+
 --- Fetch or create a new dispatching node.
 -- @param      ...             Virtual path
 -- @return                     Dispatching tree node
@@ -589,7 +622,7 @@ end
 
 
 local function _call(self, ...)
-       if #self.argv > 0 then 
+       if #self.argv > 0 then
                return getfenv()[self.name](unpack(self.argv), ...)
        else
                return getfenv()[self.name](...)
@@ -626,27 +659,29 @@ local function _cbi(self, ...)
        local state = nil
 
        for i, res in ipairs(maps) do
-               if config.autoapply then
-                       res.autoapply = config.autoapply
-               end
+               res.flow = config
                local cstate = res:parse()
-               if not state or cstate < state then
+               if cstate and (not state or cstate < state) then
                        state = cstate
                end
        end
 
+       local function _resolve_path(path)
+               return type(path) == "table" and build_url(unpack(path)) or path
+       end
+
        if config.on_valid_to and state and state > 0 and state < 2 then
-               http.redirect(config.on_valid_to)
+               http.redirect(_resolve_path(config.on_valid_to))
                return
        end
 
        if config.on_changed_to and state and state > 1 then
-               http.redirect(config.on_changed_to)
+               http.redirect(_resolve_path(config.on_changed_to))
                return
        end
 
        if config.on_success_to and state and state > 0 then
-               http.redirect(config.on_success_to)
+               http.redirect(_resolve_path(config.on_success_to))
                return
        end
 
@@ -658,14 +693,18 @@ local function _cbi(self, ...)
 
        local pageaction = true
        http.header("X-CBI-State", state or 0)
-       tpl.render("cbi/header", {state = state})
+       if not config.noheader then
+               tpl.render("cbi/header", {state = state})
+       end
        for i, res in ipairs(maps) do
                res:render()
                if res.pageaction == false then
                        pageaction = false
                end
        end
-       tpl.render("cbi/footer", {pageaction=pageaction, state = state, autoapply = config.autoapply})
+       if not config.nofooter then
+               tpl.render("cbi/footer", {flow = config, pageaction=pageaction, state = state, autoapply = config.autoapply})
+       end
 end
 
 --- Create a CBI model dispatching target.
@@ -700,7 +739,7 @@ local function _form(self, ...)
 
        for i, res in ipairs(maps) do
                local cstate = res:parse()
-               if not state or cstate < state then
+               if cstate and (not state or cstate < state) then
                        state = cstate
                end
        end