X-Git-Url: https://git.archive.openwrt.org/?p=project%2Fluci.git;a=blobdiff_plain;f=libs%2Fweb%2Fluasrc%2Ftemplate.lua;h=2fec888c307d42a54acee64f5c95786b21733c02;hp=907403fcbba7d4ce79ff76475e3f5474017e571d;hb=cf1e1534bc5284ea753a61233c5e6ee8a11ac13d;hpb=50093ed3d97c763d344f8f6b7bf934e593a92178 diff --git a/libs/web/luasrc/template.lua b/libs/web/luasrc/template.lua index 907403fcb..2fec888c3 100644 --- a/libs/web/luasrc/template.lua +++ b/libs/web/luasrc/template.lua @@ -24,191 +24,69 @@ limitations under the License. ]]-- ---- LuCI template library. -module("luci.template", package.seeall) - -require("luci.config") -require("luci.util") -require("luci.fs") -require("luci.sys") -require("luci.http") - -luci.config.template = luci.config.template or {} - -viewdir = luci.config.template.viewdir or luci.util.libpath() .. "/view" -compiledir = luci.config.template.compiledir or luci.util.libpath() .. "/view" +local fs = require "nixio.fs" +local sys = require "luci.sys" +local util = require "luci.util" +local table = require "table" +local string = require "string" +local config = require "luci.config" +local nixio = require "nixio", require "nixio.util" +local tparser = require "luci.template.parser" + +local tostring, pairs, loadstring = tostring, pairs, loadstring +local setmetatable, loadfile = setmetatable, loadfile +local getfenv, setfenv, rawget = getfenv, setfenv, rawget +local assert, type, error = assert, type, error +--- LuCI template library. +module "luci.template" --- Compile modes: --- none: Never compile, only use precompiled data from files --- memory: Always compile, do not save compiled files, ignore precompiled --- file: Compile on demand, save compiled files, update precompiled -compiler_mode = luci.config.template.compiler_mode or "memory" +config.template = config.template or {} +viewdir = config.template.viewdir or util.libpath() .. "/view" -- Define the namespace for template modules -context = luci.util.threadlocal() - -viewns = { - include = function(name) Template(name):render(getfenv(2)) end, -} - ---- Manually compile a given template into an executable Lua function --- @param template LuCI template --- @return Lua template function -function compile(template) - -- Search all <% %> expressions - local function expr_add(ws1, skip1, command, skip2, ws2) - table.insert(expr, command) - return ( #skip1 > 0 and "" or ws1 ) .. - "<%" .. tostring(#expr) .. "%>" .. - ( #skip2 > 0 and "" or ws2 ) - end - - -- As "expr" should be local, we have to assign it to the "expr_add" scope - local expr = {} - luci.util.extfenv(expr_add, "expr", expr) - - -- Save all expressiosn to table "expr" - template = template:gsub("(%s*)<%%(%-?)(.-)(%-?)%%>(%s*)", expr_add) - - local function sanitize(s) - s = string.format("%q", s) - return s:sub(2, #s-1) - end - - -- Escape and sanitize all the template (all non-expressions) - template = sanitize(template) - - -- Template module header/footer declaration - local header = 'write("' - local footer = '")' - - template = header .. template .. footer - - -- Replacements - local r_include = '")\ninclude("%s")\nwrite("' - local r_i18n = '"..translate("%1","%2").."' - local r_i18n2 = '"..translate("%1", "").."' - local r_pexec = '"..(%s or "").."' - local r_exec = '")\n%s\nwrite("' - - -- Parse the expressions - for k,v in pairs(expr) do - local p = v:sub(1, 1) - v = v:gsub("%%", "%%%%") - local re = nil - if p == "+" then - re = r_include:format(sanitize(string.sub(v, 2))) - elseif p == ":" then - if v:find(" ") then - re = sanitize(v):gsub(":(.-) (.*)", r_i18n) - else - re = sanitize(v):gsub(":(.+)", r_i18n2) - end - elseif p == "=" then - re = r_pexec:format(v:sub(2)) - elseif p == "#" then - re = "" - else - re = r_exec:format(v) - end - template = template:gsub("<%%"..tostring(k).."%%>", re) - end - - return loadstring(template) -end +context = util.threadlocal() --- Render a certain template. -- @param name Template name --- @param scope Scope to assign to template -function render(name, scope, ...) - scope = scope or getfenv(2) - local s, t = luci.util.copcall(Template, name) - if not s then - error(t) - else - t:render(scope, ...) - end +-- @param scope Scope to assign to template (optional) +function render(name, scope) + return Template(name):render(scope or getfenv(2)) end -- Template class -Template = luci.util.class() +Template = util.class() -- Shared template cache to store templates in to avoid unnecessary reloading -Template.cache = {} -setmetatable(Template.cache, {__mode = "v"}) +Template.cache = setmetatable({}, {__mode = "v"}) -- Constructor - Reads and compiles the template on-demand function Template.__init__(self, name) + self.template = self.cache[name] + self.name = name -- Create a new namespace for this template - self.viewns = {} - - -- Copy over from general namespace - luci.util.update(self.viewns, viewns) - if context.viewns then - luci.util.update(self.viewns, context.viewns) - end + self.viewns = context.viewns -- If we have a cached template, skip compiling and loading - if self.template then - return - end - - -- Enforce cache security - local cdir = compiledir .. "/" .. luci.sys.process.info("uid") - - -- Compile and build - local sourcefile = viewdir .. "/" .. name .. ".htm" - local compiledfile = cdir .. "/" .. luci.http.urlencode(name) .. ".lua" - local err - - if compiler_mode == "file" then - local tplmt = luci.fs.mtime(sourcefile) - local commt = luci.fs.mtime(compiledfile) - - if not luci.fs.mtime(cdir) then - luci.fs.mkdir(cdir, true) - luci.fs.chmod(luci.fs.dirname(cdir), "a+rxw") - end - - -- Build if there is no compiled file or if compiled file is outdated - if ((commt == nil) and not (tplmt == nil)) - or (not (commt == nil) and not (tplmt == nil) and commt < tplmt) then - local source - source, err = luci.fs.readfile(sourcefile) - - if source then - local compiled, err = compile(source) - - luci.fs.writefile(compiledfile, luci.util.get_bytecode(compiled)) - self.template = compiled - end + if not self.template then + + -- Compile template + local err + local sourcefile = viewdir .. "/" .. name .. ".htm" + + self.template, _, err = tparser.parse(sourcefile) + + -- If we have no valid template throw error, otherwise cache the template + if not self.template then + error(err) else - self.template, err = loadfile(compiledfile) + self.cache[name] = self.template end - - elseif compiler_mode == "none" then - self.template, err = loadfile(self.compiledfile) - - elseif compiler_mode == "memory" then - local source - source, err = luci.fs.readfile(sourcefile) - if source then - self.template, err = compile(source) - end - - end - - -- If we have no valid template throw error, otherwise cache the template - if not self.template then - error(err) - else - self.cache[name] = self.template end end @@ -217,17 +95,15 @@ end function Template.render(self, scope) scope = scope or getfenv(2) - -- Save old environment - local oldfenv = getfenv(self.template) - -- Put our predefined objects in the scope of the template - luci.util.resfenv(self.template) - luci.util.updfenv(self.template, scope) - luci.util.updfenv(self.template, self.viewns) + setfenv(self.template, setmetatable({}, {__index = + function(tbl, key) + return rawget(tbl, key) or self.viewns[key] or scope[key] + end})) -- Now finally render the thing - self.template() - - -- Reset environment - setfenv(self.template, oldfenv) + local stat, err = util.copcall(self.template) + if not stat then + error("Error in template %s: %s" % {self.name, err}) + end end