require("ffluci.http")
require("ffluci.model.uci")
-local Template = ffluci.template.Template
local class = ffluci.util.class
local instanceof = ffluci.util.instanceof
-
+-- Loads a CBI map from given file, creating an environment and returns it
function load(cbimap)
require("ffluci.fs")
require("ffluci.i18n")
local cbidir = ffluci.fs.dirname(ffluci.util.__file__()) .. "model/cbi/"
- local func = loadfile(cbidir..cbimap..".lua")
+ local func, err = loadfile(cbidir..cbimap..".lua")
if not func then
- error("Unable to load CBI map: " .. cbimap)
+ error(err)
return nil
end
return nil
end
+ ffluci.i18n.loadc("cbi")
+
return map
end
self.template = "cbi/node"
end
+-- Append child nodes
function Node.append(self, obj)
table.insert(self.children, obj)
end
-function Node.parse(self)
+-- Parse this node and its children
+function Node.parse(self, ...)
for k, child in ipairs(self.children) do
- child:parse()
+ child:parse(...)
end
end
+-- Render this node
function Node.render(self)
ffluci.template.render(self.template, {self=self})
end
-function Node.render_children(self)
+-- Render the children
+function Node.render_children(self, ...)
for k, node in ipairs(self.children) do
- node:render()
+ node:render(...)
end
end
Node.__init__(self, ...)
self.config = config
self.template = "cbi/map"
-end
-
-function Map.parse(self)
- self.ucidata = ffluci.model.uci.show(self.config)
+ self.uci = ffluci.model.uci.Session()
+ self.ucidata = self.uci:show(self.config)
if not self.ucidata then
error("Unable to read UCI data: " .. self.config)
else
self.ucidata = self.ucidata[self.config]
- end
- Node.parse(self)
-end
-
-function Map.render(self)
- self.ucidata = ffluci.model.uci.show(self.config)
- if not self.ucidata then
- error("Unable to read UCI data: " .. self.config)
- else
- self.ucidata = self.ucidata[self.config]
- end
- Node.render(self)
+ end
end
+-- Creates a child section
function Map.section(self, class, ...)
if instanceof(class, AbstractSection) then
- local obj = class(...)
- obj.map = self
- obj.config = self.config
+ local obj = class(self, ...)
self:append(obj)
return obj
else
end
end
+-- UCI add
+function Map.add(self, sectiontype)
+ local name = self.uci:add(self.config, sectiontype)
+ if name then
+ self.ucidata[name] = self.uci:show(self.config, name)
+ end
+ return name
+end
+
+-- UCI set
+function Map.set(self, section, option, value)
+ local stat = self.uci:set(self.config, section, option, value)
+ if stat then
+ local val = self.uci:get(self.config, section, option)
+ if option then
+ self.ucidata[section][option] = val
+ else
+ if not self.ucidata[section] then
+ self.ucidata[section] = {}
+ end
+ self.ucidata[section][".type"] = val
+ end
+ end
+ return stat
+end
+
+-- UCI del
+function Map.del(self, section, option)
+ local stat = self.uci:del(self.config, section, option)
+ if stat then
+ if option then
+ self.ucidata[section][option] = nil
+ else
+ self.ucidata[section] = nil
+ end
+ end
+ return stat
+end
+
+-- UCI get (cached)
+function Map.get(self, section, option)
+ if not section then
+ return self.ucidata
+ elseif option and self.ucidata[section] then
+ return self.ucidata[section][option]
+ else
+ return self.ucidata[section]
+ end
+end
+
+
--[[
AbstractSection
]]--
AbstractSection = class(Node)
-function AbstractSection.__init__(self, sectiontype, ...)
+function AbstractSection.__init__(self, map, sectiontype, ...)
Node.__init__(self, ...)
self.sectiontype = sectiontype
+ self.map = map
+ self.config = map.config
+ self.optionals = {}
+
+ self.optional = true
+ self.addremove = false
+ self.dynamic = false
end
+-- Appends a new option
function AbstractSection.option(self, class, ...)
if instanceof(class, AbstractValue) then
- local obj = class(...)
- obj.map = self.map
- obj.config = self.config
+ local obj = class(self.map, ...)
self:append(obj)
return obj
else
error("class must be a descendent of AbstractValue")
end
end
+
+-- Parse optional options
+function AbstractSection.parse_optionals(self, section)
+ if not self.optional then
+ return
+ end
+
+ self.optionals[section] = {}
+ local field = ffluci.http.formvalue("cbi.opt."..self.config.."."..section)
+ for k,v in ipairs(self.children) do
+ if v.optional and not v:cfgvalue(section) then
+ if field == v.option then
+ self.map:set(section, field, v.default)
+ field = nil
+ else
+ table.insert(self.optionals[section], v)
+ end
+ end
+ end
+
+ if field and field:len() > 0 and self.dynamic then
+ self:add_dynamic(field)
+ end
+end
+
+-- Add a dynamic option
+function AbstractSection.add_dynamic(self, field, optional)
+ local o = self:option(Value, field, field)
+ o.optional = optional
+end
+
+-- Parse all dynamic options
+function AbstractSection.parse_dynamic(self, section)
+ if not self.dynamic then
+ return
+ end
+
+ local arr = ffluci.util.clone(self:cfgvalue(section))
+ local form = ffluci.http.formvalue("cbid."..self.config.."."..section)
+ if type(form) == "table" then
+ for k,v in pairs(form) do
+ arr[k] = v
+ end
+ end
+
+ for key,val in pairs(arr) do
+ local create = true
+
+ for i,c in ipairs(self.children) do
+ if c.option == key then
+ create = false
+ end
+ end
+
+ if create and key:sub(1, 1) ~= "." then
+ self:add_dynamic(key, true)
+ end
+ end
+end
+
+-- Returns the section's UCI table
+function AbstractSection.cfgvalue(self, section)
+ return self.map:get(section)
+end
+
+-- Removes the section
+function AbstractSection.remove(self, section)
+ return self.map:del(section)
+end
+
+-- Creates the section
+function AbstractSection.create(self, section)
+ return self.map:set(section, nil, self.sectiontype)
+end
+
--[[
]]--
NamedSection = class(AbstractSection)
-function NamedSection.__init__(self, section, ...)
- AbstractSection.__init__(self, ...)
+function NamedSection.__init__(self, map, section, ...)
+ AbstractSection.__init__(self, map, ...)
self.template = "cbi/nsection"
self.section = section
+ self.addremove = false
end
-function NamedSection.option(self, ...)
- local obj = AbstractSection.option(self, ...)
- obj.section = self.section
- return obj
+function NamedSection.parse(self)
+ local s = self.section
+ local active = self:cfgvalue(s)
+
+
+ if self.addremove then
+ local path = self.config.."."..s
+ if active then -- Remove the section
+ if ffluci.http.formvalue("cbi.rns."..path) and self:remove(s) then
+ return
+ end
+ else -- Create and apply default values
+ if ffluci.http.formvalue("cbi.cns."..path) and self:create(s) then
+ for k,v in pairs(self.children) do
+ v:write(s, v.default)
+ end
+ end
+ end
+ end
+
+ if active then
+ AbstractSection.parse_dynamic(self, s)
+ Node.parse(self, s)
+ AbstractSection.parse_optionals(self, s)
+ end
end
TypedSection - A (set of) configuration section(s) defined by the type
addremove: Defines whether the user can add/remove sections of this type
anonymous: Allow creating anonymous sections
- valid: a table with valid names or a function returning nil if invalid
+ valid: a list of names or a validation function for creating sections
+ scope: a list of names or a validation function for editing sections
]]--
TypedSection = class(AbstractSection)
AbstractSection.__init__(self, ...)
self.template = "cbi/tsection"
- self.addremove = true
- self.anonymous = false
- self.valid = nil
+ self.anonymous = false
+ self.valid = nil
+ self.scope = nil
+end
+
+-- Creates a new section of this type with the given name (or anonymous)
+function TypedSection.create(self, name)
+ if name then
+ self.map:set(name, nil, self.sectiontype)
+ else
+ name = self.map:add(self.sectiontype)
+ end
+
+ for k,v in pairs(self.children) do
+ if v.default then
+ self.map:set(name, v.option, v.default)
+ end
+ end
end
function TypedSection.parse(self)
- for k, v in pairs(self:ucisections()) do
- for i, node in ipairs(self.children) do
- node.section = k
- node:parse()
- end
+ if self.addremove then
+ -- Create
+ local crval = "cbi.cts." .. self.config .. "." .. self.sectiontype
+ local name = ffluci.http.formvalue(crval)
+ if self.anonymous then
+ if name then
+ self:create()
+ end
+ else
+ if name then
+ name = ffluci.util.validate(name, self.valid)
+ if not name then
+ self.err_invalid = true
+ end
+ if name and name:len() > 0 then
+ self:create(name)
+ end
+ end
+ end
+
+ -- Remove
+ crval = "cbi.rts." .. self.config
+ name = ffluci.http.formvalue(crval)
+ if type(name) == "table" then
+ for k,v in pairs(name) do
+ if ffluci.util.validate(k, self.valid) then
+ self:remove(k)
+ end
+ end
+ end
+ end
+
+ for k, v in pairs(self:cfgsections()) do
+ AbstractSection.parse_dynamic(self, k)
+ Node.parse(self, k)
+ AbstractSection.parse_optionals(self, k)
end
end
+-- Render the children
function TypedSection.render_children(self, section)
for k, node in ipairs(self.children) do
- node.section = section
- node:render()
+ node:render(section)
end
end
-function TypedSection.ucisections(self)
+-- Return all matching UCI sections for this TypedSection
+function TypedSection.cfgsections(self)
local sections = {}
- for k, v in pairs(self.map.ucidata) do
+ for k, v in pairs(self.map:get()) do
if v[".type"] == self.sectiontype then
- sections[k] = v
+ if ffluci.util.validate(k, self.scope) then
+ sections[k] = v
+ end
end
end
return sections
end
+
--[[
AbstractValue - An abstract Value Type
null: Value can be empty
valid: A function returning the value if it is valid otherwise nil
depends: A table of option => value pairs of which one must be true
default: The default value
+ size: The size of the input fields
+ rmempty: Unset value if empty
+ optional: This value is optional (see AbstractSection.optionals)
]]--
AbstractValue = class(Node)
-function AbstractValue.__init__(self, option, ...)
+function AbstractValue.__init__(self, map, option, ...)
Node.__init__(self, ...)
- self.option = option
+ self.option = option
+ self.map = map
+ self.config = map.config
+ self.tag_invalid = {}
- self.valid = nil
- self.depends = nil
- self.default = nil
+ self.valid = nil
+ self.depends = nil
+ self.default = " "
+ self.size = nil
+ self.optional = false
end
-function AbstractValue.formvalue(self)
- local key = "cbid."..self.map.config.."."..self.section.."."..self.option
+-- Returns the formvalue for this object
+function AbstractValue.formvalue(self, section)
+ local key = "cbid."..self.map.config.."."..section.."."..self.option
return ffluci.http.formvalue(key)
end
-function AbstractValue.parse(self)
- local fvalue = self:validate(self:formvalue())
- if fvalue and not (fvalue == self:ucivalue()) then
- self:write(fvalue)
- end
+function AbstractValue.parse(self, section)
+ local fvalue = self:formvalue(section)
+ if fvalue == "" then
+ fvalue = nil
+ end
+
+
+ if fvalue then -- If we have a form value, validate it and write it to UCI
+ fvalue = self:validate(fvalue)
+ if not fvalue then
+ self.tag_invalid[section] = true
+ end
+ if fvalue and not (fvalue == self:cfgvalue(section)) then
+ self:write(section, fvalue)
+ end
+ elseif ffluci.http.formvalue("cbi.submit") then -- Unset the UCI or error
+ if self.rmempty or self.optional then
+ self:remove(section)
+ else
+ self.tag_invalid[section] = true
+ end
+ end
end
-function AbstractValue.ucivalue(self)
- return self.map.ucidata[self.section][self.option]
+-- Render if this value exists or if it is mandatory
+function AbstractValue.render(self, section)
+ if not self.optional or self:cfgvalue(section) then
+ ffluci.template.render(self.template, {self=self, section=section})
+ end
end
-function AbstractValue.validate(self, value)
- return ffluci.util.validate(value, nil, nil, self.valid)
+-- Return the UCI value of this object
+function AbstractValue.cfgvalue(self, section)
+ return self.map:get(section, self.option)
end
-function AbstractValue.write(self, value)
- return ffluci.model.uci.set(self.config, self.section, self.option, value)
+-- Validate the form value
+function AbstractValue.validate(self, val)
+ return ffluci.util.validate(val, self.valid)
end
+-- Write to UCI
+function AbstractValue.write(self, section, value)
+ return self.map:set(section, self.option, value)
+end
+
+-- Remove from UCI
+function AbstractValue.remove(self, section)
+ return self.map:del(section, self.option)
+end
+
+
+
--[[
Value - A one-line value
maxlength: The maximum length
isnumber: The value must be a valid (floating point) number
isinteger: The value must be a valid integer
+ ispositive: The value must be positive (and a number)
]]--
Value = class(AbstractValue)
AbstractValue.__init__(self, ...)
self.template = "cbi/value"
- self.maxlength = nil
- self.isnumber = false
- self.isinteger = false
+ self.maxlength = nil
+ self.isnumber = false
+ self.isinteger = false
end
+-- This validation is a bit more complex
+function Value.validate(self, val)
+ if self.maxlength and tostring(val):len() > self.maxlength then
+ val = nil
+ end
+
+ return ffluci.util.validate(val, self.valid, self.isnumber, self.isinteger)
+end
+
+
+
+--[[
+Flag - A flag being enabled or disabled
+]]--
+Flag = class(AbstractValue)
+
+function Flag.__init__(self, ...)
+ AbstractValue.__init__(self, ...)
+ self.template = "cbi/fvalue"
+
+ self.enabled = "1"
+ self.disabled = "0"
+end
+
+-- A flag can only have two states: set or unset
+function Flag.parse(self, section)
+ self.default = self.enabled
+ local fvalue = self:formvalue(section)
+
+ if fvalue then
+ fvalue = self.enabled
+ else
+ fvalue = self.disabled
+ end
+
+ if fvalue == self.enabled or (not self.optional and not self.rmempty) then
+ if not(fvalue == self:cfgvalue(section)) then
+ self:write(section, fvalue)
+ end
+ else
+ self:remove(section)
+ end
+end
+
+
--[[
ListValue - A one-line value predefined in a list
+ widget: The widget that will be used (select, radio)
]]--
ListValue = class(AbstractValue)
function ListValue.__init__(self, ...)
AbstractValue.__init__(self, ...)
self.template = "cbi/lvalue"
+ self.keylist = {}
+ self.vallist = {}
+
+ self.size = 1
+ self.widget = "select"
+end
+
+function ListValue.add_value(self, key, val)
+ val = val or key
+ table.insert(self.keylist, tostring(key))
+ table.insert(self.vallist, tostring(val))
+end
+
+function ListValue.validate(self, val)
+ if ffluci.util.contains(self.keylist, val) then
+ return val
+ else
+ return nil
+ end
+end
+
+
+
+--[[
+MultiValue - Multiple delimited values
+ widget: The widget that will be used (select, checkbox)
+ delimiter: The delimiter that will separate the values (default: " ")
+]]--
+MultiValue = class(AbstractValue)
+
+function MultiValue.__init__(self, ...)
+ AbstractValue.__init__(self, ...)
+ self.template = "cbi/mvalue"
+ self.keylist = {}
+ self.vallist = {}
- self.list = {}
+ self.widget = "checkbox"
+ self.delimiter = " "
end
-function ListValue.addValue(self, key, val)
+function MultiValue.add_value(self, key, val)
val = val or key
- self.list[key] = val
+ table.insert(self.keylist, tostring(key))
+ table.insert(self.vallist, tostring(val))
+end
+
+function MultiValue.valuelist(self, section)
+ local val = self:cfgvalue(section)
+
+ if not(type(val) == "string") then
+ return {}
+ end
+
+ return ffluci.util.split(val, self.delimiter)
+end
+
+function MultiValue.validate(self, val)
+ if not(type(val) == "string") then
+ return nil
+ end
+
+ local result = ""
+
+ for value in val:gmatch("[^\n]+") do
+ if ffluci.util.contains(self.keylist, value) then
+ result = result .. self.delimiter .. value
+ end
+ end
+
+ if result:len() > 0 then
+ return result:sub(self.delimiter:len() + 1)
+ else
+ return nil
+ end
end
\ No newline at end of file
projects / project / luci.git / blobdiff