require("luci.template")
require("luci.util")
require("luci.http")
-require("luci.model.uci")
require("luci.uvl")
-local uci = luci.model.uci
+local uci = require("luci.model.uci")
local class = luci.util.class
local instanceof = luci.util.instanceof
FORM_VALID = 1
FORM_INVALID = -1
+AUTO = true
+
CREATE_PREFIX = "cbi.cts."
REMOVE_PREFIX = "cbi.rts."
-- Loads a CBI map from given file, creating an environment and returns it
function load(cbimap, ...)
require("luci.fs")
- require("luci.i18n")
+ local i18n = require "luci.i18n"
require("luci.config")
require("luci.util")
local cbidir = luci.util.libpath() .. "/model/cbi/"
- local func, err = loadfile(cbidir..cbimap..".lua")
-
- if not func then
- return nil
- end
+ local func, err = loadfile(cbimap) or loadfile(cbidir..cbimap..".lua")
+ assert(func, err)
luci.i18n.loadc("cbi")
+ luci.i18n.loadc("uvl")
+
+ local env = {
+ translate=i18n.translate,
+ translatef=i18n.translatef,
+ arg={...}
+ }
- luci.util.resfenv(func)
- luci.util.updfenv(func, luci.cbi)
- luci.util.extfenv(func, "translate", luci.i18n.translate)
- luci.util.extfenv(func, "translatef", luci.i18n.translatef)
- luci.util.extfenv(func, "arg", {...})
+ setfenv(func, setmetatable(env, {__index =
+ function(tbl, key)
+ return rawget(tbl, key) or _M[key] or _G[key]
+ end}))
local maps = {func()}
return maps
end
+local function _uvl_validate_section(node, name)
+ local co = node.map:get()
+
+ luci.uvl.STRICT_UNKNOWN_OPTIONS = false
+ luci.uvl.STRICT_UNKNOWN_SECTIONS = false
+
+ local function tag_fields(e)
+ if e.option and node.fields[e.option] then
+ node.fields[e.option].error = e
+ elseif e.childs then
+ for _, c in ipairs(e.childs) do tag_fields(c) end
+ end
+ end
+
+ local function tag_section(e)
+ local s = { }
+ for _, c in ipairs(e.childs) do
+ if c.childs and not c:is(luci.uvl.errors.ERR_DEPENDENCY) then
+ table.insert( s, c.childs[1]:string() )
+ else
+ table.insert( s, c:string() )
+ end
+ end
+ if #s > 0 then node.error = s end
+ end
+
+ local stat, err = node.map.validator:validate_section(node.config, name, co)
+ if err then
+ node.map.save = false
+ tag_fields(err)
+ tag_section(err)
+ end
+
+end
+
+local function _uvl_strip_remote_dependencies(deps)
+ local clean = {}
+
+ for k, v in pairs(deps) do
+ k = k:gsub("%$config%.%$section%.", "")
+ if k:match("^[%w_]+$") and type(v) == "string" then
+ clean[k] = v
+ end
+ end
+
+ return clean
+end
+
+
-- Node pseudo abstract class
Node = class()
self.config = config
self.parsechain = {self.config}
self.template = "cbi/map"
- if not uci.load_config(self.config) then
+ self.apply_on_parse = nil
+ self.uci = uci.cursor()
+ self.save = true
+ if not self.uci:load(self.config) then
error("Unable to read UCI data: " .. self.config)
end
self.validator = luci.uvl.UVL()
self.scheme = self.validator:get_scheme(self.config)
+
end
-function Map.render(self, ...)
- if self.stateful then
- uci.load_state(self.config)
+function Map.get_scheme(self, sectiontype, option)
+ if not option then
+ return self.scheme and self.scheme.sections[sectiontype]
else
- uci.load_config(self.config)
+ return self.scheme and self.scheme.variables[sectiontype]
+ and self.scheme.variables[sectiontype][option]
end
- Node.render(self, ...)
end
-- Use optimized UCI writing
function Map.parse(self, ...)
- if self.stateful then
- uci.load_state(self.config)
- else
- uci.load_config(self.config)
- end
-
Node.parse(self, ...)
-
- for i, config in ipairs(self.parsechain) do
- uci.save_config(config)
- end
- if luci.http.formvalue("cbi.apply") then
- for i, config in ipairs(self.parsechain) do
- uci.commit(config)
- if luci.config.uci_oncommit and luci.config.uci_oncommit[config] then
- luci.util.exec(luci.config.uci_oncommit[config])
- end
- -- Refresh data because commit changes section names
- uci.load_config(config)
+ if self.save then
+ for i, config in ipairs(self.parsechain) do
+ self.uci:save(config)
end
+ if luci.http.formvalue("cbi.apply") then
+ for i, config in ipairs(self.parsechain) do
+ self.uci:commit(config)
- -- Reparse sections
- Node.parse(self, ...)
+ -- Refresh data because commit changes section names
+ self.uci:load(config)
+ end
+ if self.apply_on_parse then
+ self.uci:apply(self.parsechain)
+ else
+ self._apply = function()
+ local cmd = self.uci:apply(self.parsechain, true)
+ return io.popen(cmd)
+ end
+ end
+
+ -- Reparse sections
+ Node.parse(self, ...)
+ end
+ for i, config in ipairs(self.parsechain) do
+ self.uci:unload(config)
+ end
end
- for i, config in ipairs(self.parsechain) do
- uci.unload(config)
+end
+
+function Map.render(self, ...)
+ Node.render(self, ...)
+ if self._apply then
+ local fp = self._apply()
+ fp:read("*a")
+ fp:close()
end
end
-- UCI add
function Map.add(self, sectiontype)
- return uci.add(self.config, sectiontype)
+ return self.uci:add(self.config, sectiontype)
end
-- UCI set
function Map.set(self, section, option, value)
if option then
- return uci.set(self.config, section, option, value)
+ return self.uci:set(self.config, section, option, value)
else
- return uci.set(self.config, section, value)
+ return self.uci:set(self.config, section, value)
end
end
-- UCI del
function Map.del(self, section, option)
if option then
- return uci.delete(self.config, section, option)
+ return self.uci:delete(self.config, section, option)
else
- return uci.delete(self.config, section)
+ return self.uci:delete(self.config, section)
end
end
-- UCI get
function Map.get(self, section, option)
if not section then
- return uci.get_all(self.config)
+ return self.uci:get_all(self.config)
elseif option then
- return uci.get(self.config, section, option)
+ return self.uci:get(self.config, section, option)
else
- return uci.get_all(self.config, section)
+ return self.uci:get_all(self.config, section)
end
end
if luci.http.formvalue("cbi.submit") then
Node.parse(self, 1, ...)
end
-
+
local valid = true
- for k, j in ipairs(self.children) do
+ for k, j in ipairs(self.children) do
for i, v in ipairs(j.children) do
- valid = valid
+ valid = valid
and (not v.tag_missing or not v.tag_missing[1])
and (not v.tag_invalid or not v.tag_invalid[1])
end
end
-
- local state =
+
+ local state =
not luci.http.formvalue("cbi.submit") and 0
or valid and 1
or -1
if not section then
section = self:section(SimpleSection)
end
-
+
if instanceof(class, AbstractValue) then
- local obj = class(self, ...)
+ local obj = class(self, section, ...)
obj.track_missing = true
section:append(obj)
return obj
end
+function SimpleForm.get_scheme()
+ return nil
+end
+
+
--[[
AbstractSection
self.config = map.config
self.optionals = {}
self.defaults = {}
+ self.fields = {}
+ self.tag_error = {}
+ self.tag_invalid = {}
+ self.tag_deperror = {}
self.optional = true
self.addremove = false
-- Appends a new option
function AbstractSection.option(self, class, option, ...)
+ -- Autodetect from UVL
+ if class == true and self.map:get_scheme(self.sectiontype, option) then
+ local vs = self.map:get_scheme(self.sectiontype, option)
+ if vs.type == "boolean" then
+ class = Flag
+ elseif vs.type == "list" then
+ class = DynamicList
+ elseif vs.type == "enum" or vs.type == "reference" then
+ class = ListValue
+ else
+ class = Value
+ end
+ end
+
if instanceof(class, AbstractValue) then
- local obj = class(self.map, option, ...)
+ local obj = class(self.map, self, option, ...)
Node._i18n(obj, self.config, self.section or self.sectiontype, option, ...)
self:append(obj)
+ self.fields[option] = obj
return obj
+ elseif class == true then
+ error("No valid class was given and autodetection failed.")
else
- error("class must be a descendent of AbstractValue")
+ error("class must be a descendant of AbstractValue")
end
end
-- Creates the section
function AbstractSection.create(self, section)
local stat
-
+
if section then
stat = self.map:set(section, nil, self.sectiontype)
else
local datasource = {}
datasource.config = "table"
self.data = data
-
+
function datasource.get(self, section, option)
return data[section] and data[section][option]
end
-
+
function datasource.del(...)
return true
end
-
+
+ function datasource.get_scheme()
+ return nil
+ end
+
AbstractSection.__init__(self, datasource, "table", ...)
self.template = "cbi/tblsection"
self.rowcolors = true
function Table.cfgsections(self)
local sections = {}
-
+
for i, v in luci.util.kspairs(self.data) do
table.insert(sections, i)
end
-
+
return sections
end
self.addremove = false
-- Use defaults from UVL
- if self.map.scheme and self.map.scheme.sections[self.sectiontype] then
- local vs = self.map.scheme.sections[self.sectiontype]
+ if not self.override_scheme and self.map:get_scheme(self.sectiontype) then
+ local vs = self.map:get_scheme(self.sectiontype)
self.addremove = not vs.unique and not vs.required
self.dynamic = vs.dynamic
+ self.title = self.title or vs.title
+ self.description = self.description or vs.descr
end
self.template = "cbi/nsection"
local s = self.section
local active = self:cfgvalue(s)
-
if self.addremove then
local path = self.config.."."..s
if active then -- Remove the section
AbstractSection.parse_dynamic(self, s)
if luci.http.formvalue("cbi.submit") then
Node.parse(self, s)
+
+ if not self.override_scheme and self.map.scheme then
+ _uvl_validate_section(self, s)
+ end
end
AbstractSection.parse_optionals(self, s)
end
self.anonymous = false
-- Use defaults from UVL
- if self.map.scheme and self.map.scheme.sections[self.sectiontype] then
- local vs = self.map.scheme.sections[self.sectiontype]
+ if not self.override_scheme and self.map:get_scheme(self.sectiontype) then
+ local vs = self.map:get_scheme(self.sectiontype)
self.addremove = not vs.unique and not vs.required
self.dynamic = vs.dynamic
self.anonymous = not vs.named
+ self.title = self.title or vs.title
+ self.description = self.description or vs.descr
end
end
-- Return all matching UCI sections for this TypedSection
function TypedSection.cfgsections(self)
local sections = {}
- uci.foreach(self.map.config, self.sectiontype,
+ self.map.uci:foreach(self.map.config, self.sectiontype,
function (section)
if self:checkscope(section[".name"]) then
table.insert(sections, section[".name"])
function TypedSection.parse(self)
if self.addremove then
+ -- Remove
+ local crval = REMOVE_PREFIX .. self.config
+ local name = luci.http.formvaluetable(crval)
+ for k,v in pairs(name) do
+ if k:sub(-2) == ".x" then
+ k = k:sub(1, #k - 2)
+ end
+ if self:cfgvalue(k) and self:checkscope(k) then
+ self:remove(k)
+ end
+ end
+ end
+
+ local co
+ for i, k in ipairs(self:cfgsections()) do
+ AbstractSection.parse_dynamic(self, k)
+ if luci.http.formvalue("cbi.submit") then
+ Node.parse(self, k)
+
+ if not self.override_scheme and self.map.scheme then
+ _uvl_validate_section(self, k)
+ end
+ end
+ AbstractSection.parse_optionals(self, k)
+ end
+
+ if self.addremove then
-- Create
+ local created
local crval = CREATE_PREFIX .. self.config .. "." .. self.sectiontype
local name = luci.http.formvalue(crval)
if self.anonymous then
if name then
- self:create()
+ created = self:create()
end
else
if name then
self.err_invalid = true
end
- if name and name:len() > 0 then
- self:create(name)
+ if name and #name > 0 then
+ created = self:create(name) and name
end
end
end
- -- Remove
- crval = REMOVE_PREFIX .. self.config
- name = luci.http.formvaluetable(crval)
- for k,v in pairs(name) do
- luci.util.perror(k)
- luci.util.perror(self:cfgvalue(k))
- luci.util.perror(self:checkscope(k))
- if self:cfgvalue(k) and self:checkscope(k) then
- self:remove(k)
- end
+ if created then
+ AbstractSection.parse_optionals(self, created)
end
end
-
- for i, k in ipairs(self:cfgsections()) do
- AbstractSection.parse_dynamic(self, k)
- if luci.http.formvalue("cbi.submit") then
- Node.parse(self, k)
- end
- AbstractSection.parse_optionals(self, k)
- end
end
-- Verifies scope of sections
]]--
AbstractValue = class(Node)
-function AbstractValue.__init__(self, map, option, ...)
+function AbstractValue.__init__(self, map, section, option, ...)
Node.__init__(self, ...)
- self.option = option
- self.map = map
- self.config = map.config
+ self.section = section
+ self.option = option
+ self.map = map
+ self.config = map.config
self.tag_invalid = {}
self.tag_missing = {}
+ self.tag_reqerror = {}
self.tag_error = {}
self.deps = {}
self.cast = "string"
self.default = nil
self.size = nil
self.optional = false
+
+ -- Use defaults from UVL
+ if not self.override_scheme
+ and self.map:get_scheme(self.section.sectiontype, self.option) then
+ local vs = self.map:get_scheme(self.section.sectiontype, self.option)
+ self.rmempty = not vs.required
+ self.cast = (vs.type == "list") and "list" or "string"
+ self.title = self.title or vs.title
+ self.description = self.description or vs.descr
+ self.default = vs.default
+
+ if vs.depends and not self.override_dependencies then
+ for i, deps in ipairs(vs.depends) do
+ deps = _uvl_strip_remote_dependencies(deps)
+ if next(deps) then
+ self:depends(deps)
+ end
+ end
+ end
+ end
end
-- Add a dependencie to another section field
else
deps = field
end
-
+
table.insert(self.deps, {deps=deps, add=""})
end
-- DummyValue - This does nothing except being there
DummyValue = class(AbstractValue)
-function DummyValue.__init__(self, map, ...)
- AbstractValue.__init__(self, map, ...)
+function DummyValue.__init__(self, ...)
+ AbstractValue.__init__(self, ...)
self.template = "cbi/dvalue"
self.value = nil
end
function ListValue.__init__(self, ...)
AbstractValue.__init__(self, ...)
self.template = "cbi/lvalue"
+
self.keylist = {}
self.vallist = {}
-
self.size = 1
self.widget = "select"
+
+ if not self.override_scheme
+ and self.map:get_scheme(self.section.sectiontype, self.option) then
+ local vs = self.map:get_scheme(self.section.sectiontype, self.option)
+ if self.value and vs.values and not self.override_values then
+ if self.rmempty or self.optional then
+ self:value("")
+ end
+ for k, v in pairs(vs.values) do
+ local deps = {}
+ if not self.override_dependencies
+ and vs.enum_depends and vs.enum_depends[k] then
+ for i, dep in ipairs(vs.enum_depends[k]) do
+ table.insert(deps, _uvl_strip_remote_dependencies(dep))
+ end
+ end
+ self:value(k, v, unpack(deps))
+ end
+ end
+ end
end
function ListValue.value(self, key, val, ...)
+ if luci.util.contains(self.keylist, key) then
+ return
+ end
+
val = val or key
table.insert(self.keylist, tostring(key))
table.insert(self.vallist, tostring(val))
-
+
for i, deps in ipairs({...}) do
table.insert(self.deps, {add = "-"..key, deps=deps})
end
function MultiValue.__init__(self, ...)
AbstractValue.__init__(self, ...)
self.template = "cbi/mvalue"
+
self.keylist = {}
self.vallist = {}
end
function MultiValue.value(self, key, val)
+ if luci.util.contains(self.keylist, key) then
+ return
+ end
+
val = val or key
table.insert(self.keylist, tostring(key))
table.insert(self.vallist, tostring(val))
MultiValue.__init__(self, ...)
self.cast = "table"
self.valuelist = self.cfgvalue
+
+ if not self.override_scheme
+ and self.map:get_scheme(self.section.sectiontype, self.option) then
+ local vs = self.map:get_scheme(self.section.sectiontype, self.option)
+ if self.value and vs.values and not self.override_values then
+ for k, v in pairs(vs.values) do
+ self:value(k, v)
+ end
+ end
+ end
end
function StaticList.validate(self, value)
AbstractValue.__init__(self, ...)
self.template = "cbi/dynlist"
self.cast = "table"
-
self.keylist = {}
self.vallist = {}
end
function DynamicList.validate(self, value, section)
value = (type(value) == "table") and value or {value}
-
+
local valid = {}
for i, v in ipairs(value) do
- if v and #v > 0 and
- not luci.http.formvalue("cbi.rle."..section.."."..self.option.."."..i) then
+ if v and #v > 0
+ and not luci.http.formvalue("cbi.rle."..section.."."..self.option.."."..i)
+ and not luci.http.formvalue("cbi.rle."..section.."."..self.option.."."..i..".x") then
table.insert(valid, v)
end
end
-
+
return valid
end
self.template = "cbi/button"
self.inputstyle = nil
self.rmempty = true
-end
\ No newline at end of file
+end