X-Git-Url: https://git.archive.openwrt.org/?p=project%2Fluci.git;a=blobdiff_plain;f=libs%2Fcbi%2Fluasrc%2Fcbi.lua;h=db76e3b92f338e6b564d0c597ba69b7323605546;hp=78f6b7d5efac6f157dcb16d3061c1e1d7d40c345;hb=2561ed9b7ad5330e8af97047ef420f9bc0b413d0;hpb=14a2e32142cc2bba58de79de8b2b410be21b7ac7 diff --git a/libs/cbi/luasrc/cbi.lua b/libs/cbi/luasrc/cbi.lua index 78f6b7d5e..db76e3b92 100644 --- a/libs/cbi/luasrc/cbi.lua +++ b/libs/cbi/luasrc/cbi.lua @@ -27,21 +27,24 @@ limitations under the License. module("luci.cbi", package.seeall) require("luci.template") -require("luci.util") +local util = require("luci.util") require("luci.http") require("luci.uvl") -require("luci.fs") + --local event = require "luci.sys.event" +local fs = require("nixio.fs") local uci = require("luci.model.uci") -local class = luci.util.class -local instanceof = luci.util.instanceof +local class = util.class +local instanceof = util.instanceof FORM_NODATA = 0 FORM_PROCEED = 0 FORM_VALID = 1 +FORM_DONE = 1 FORM_INVALID = -1 FORM_CHANGED = 2 +FORM_SKIP = 4 AUTO = true @@ -50,14 +53,24 @@ REMOVE_PREFIX = "cbi.rts." -- Loads a CBI map from given file, creating an environment and returns it function load(cbimap, ...) - require("luci.fs") + local fs = require "nixio.fs" local i18n = require "luci.i18n" require("luci.config") require("luci.util") local upldir = "/lib/uci/upload/" local cbidir = luci.util.libpath() .. "/model/cbi/" - local func, err = loadfile(cbimap) or loadfile(cbidir..cbimap..".lua") + + assert(fs.stat(cbimap) or + fs.stat(cbidir..cbimap..".lua") or + fs.stat(cbidir..cbimap..".lua.gz"), + "Model not found!") + + local func, err = loadfile(cbimap) + if not func then + func, err = loadfile(cbidir..cbimap..".lua") or + loadfile(cbidir..cbimap..".lua.gz") + end assert(func, err) luci.i18n.loadc("cbi") @@ -159,7 +172,7 @@ local function _uvl_validate_section(node, name) local function tag_section(e) local s = { } - for _, c in ipairs(e.childs) do + for _, c in ipairs(e.childs or { e }) do if c.childs and not c:is(luci.uvl.errors.ERR_DEPENDENCY) then table.insert( s, c.childs[1]:string() ) else @@ -273,6 +286,11 @@ function Template.render(self) luci.template.render(self.template, {self=self}) end +function Template.parse(self, readinput) + self.readinput = (readinput ~= false) + return Map.formvalue(self, "cbi.submit") and FORM_DONE or FORM_NODATA +end + --[[ Map - A map describing a configuration file @@ -287,11 +305,15 @@ function Map.__init__(self, config, ...) self.parsechain = {self.config} self.template = "cbi/map" self.apply_on_parse = nil + self.readinput = true + self.proceed = false + self.flow = {} + self.uci = uci.cursor() self.save = true - + self.changed = false - + if not self.uci:load(self.config) then error("Unable to read UCI data: " .. self.config) end @@ -301,6 +323,14 @@ function Map.__init__(self, config, ...) end +function Map.formvalue(self, key) + return self.readinput and luci.http.formvalue(key) +end + +function Map.formvaluetable(self, key) + return self.readinput and luci.http.formvaluetable(key) or {} +end + function Map.get_scheme(self, sectiontype, option) if not option then return self.scheme and self.scheme.sections[sectiontype] @@ -311,7 +341,7 @@ function Map.get_scheme(self, sectiontype, option) end function Map.submitstate(self) - return luci.http.formvalue("cbi.submit") + return self:formvalue("cbi.submit") end -- Chain foreign config @@ -319,15 +349,26 @@ function Map.chain(self, config) table.insert(self.parsechain, config) end +function Map.state_handler(self, state) + return state +end + -- Use optimized UCI writing -function Map.parse(self) - Node.parse(self) +function Map.parse(self, readinput, ...) + self.readinput = (readinput ~= false) + + if self:formvalue("cbi.skip") then + self.state = FORM_SKIP + return self:state_handler(self.state) + end + + Node.parse(self, ...) if self.save then for i, config in ipairs(self.parsechain) do self.uci:save(config) end - if self:submitstate() and (self.autoapply or luci.http.formvalue("cbi.apply")) then + if self:submitstate() and not self.proceed and (self.flow.autoapply or luci.http.formvalue("cbi.apply")) then for i, config in ipairs(self.parsechain) do self.uci:commit(config) @@ -356,16 +397,18 @@ function Map.parse(self) end if self:submitstate() then - if self.save then - self.state = self.changed and FORM_CHANGED or FORM_VALID - else + if not self.save then self.state = FORM_INVALID + elseif self.proceed then + self.state = FORM_PROCEED + else + self.state = self.changed and FORM_CHANGED or FORM_VALID end else self.state = FORM_NODATA end - return self.state + return self:state_handler(self.state) end function Map.render(self, ...) @@ -422,6 +465,164 @@ function Map.get(self, section, option) end end +--[[ +Compound - Container +]]-- +Compound = class(Node) + +function Compound.__init__(self, ...) + Node.__init__(self) + self.template = "cbi/compound" + self.children = {...} +end + +function Compound.populate_delegator(self, delegator) + for _, v in ipairs(self.children) do + v.delegator = delegator + end +end + +function Compound.parse(self, ...) + local cstate, state = 0 + + for k, child in ipairs(self.children) do + cstate = child:parse(...) + state = (not state or cstate < state) and cstate or state + end + + return state +end + + +--[[ +Delegator - Node controller +]]-- +Delegator = class(Node) +function Delegator.__init__(self, ...) + Node.__init__(self, ...) + self.nodes = {} + self.defaultpath = {} + self.pageaction = false + self.readinput = true + self.allow_reset = false + self.allow_back = false + self.allow_finish = false + self.template = "cbi/delegator" +end + +function Delegator.set(self, name, node) + if type(node) == "table" and getmetatable(node) == nil then + node = Compound(unpack(node)) + end + assert(type(node) == "function" or instanceof(node, Compound), "Invalid") + assert(not self.nodes[name], "Duplicate entry") + + self.nodes[name] = node +end + +function Delegator.add(self, name, node) + node = self:set(name, node) + self.defaultpath[#self.defaultpath+1] = name +end + +function Delegator.insert_after(self, name, after) + local n = #self.chain + for k, v in ipairs(self.chain) do + if v == state then + n = k + 1 + break + end + end + table.insert(self.chain, n, name) +end + +function Delegator.set_route(self, ...) + local n, chain, route = 0, self.chain, {...} + for i = 1, #chain do + if chain[i] == self.current then + n = i + break + end + end + for i = 1, #route do + n = n + 1 + chain[n] = route[i] + end + for i = n + 1, #chain do + chain[i] = nil + end +end + +function Delegator.get(self, name) + return self.nodes[name] +end + +function Delegator.parse(self, ...) + local newcurrent + self.chain = self.chain or self:get_chain() + self.current = self.current or self:get_active() + self.active = self.active or self:get(self.current) + assert(self.active, "Invalid state") + + local stat = FORM_DONE + if type(self.active) ~= "function" then + self.active:populate_delegator(self) + stat = self.active:parse() + else + self:active() + end + + if stat > FORM_PROCEED then + if Map.formvalue(self, "cbi.delg.back") then + newcurrent = self:get_prev(self.current) + else + newcurrent = self:get_next(self.current) + end + elseif stat < FORM_PROCEED then + return stat + end + + + if not Map.formvalue(self, "cbi.submit") then + return FORM_NODATA + elseif not newcurrent or not self:get(newcurrent) then + return FORM_DONE + else + self.current = newcurrent + self.active = self:get(self.current) + if type(self.active) ~= "function" then + self.active:parse(false) + return FROM_PROCEED + else + return self:parse(...) + end + end +end + +function Delegator.get_next(self, state) + for k, v in ipairs(self.chain) do + if v == state then + return self.chain[k+1] + end + end +end + +function Delegator.get_prev(self, state) + for k, v in ipairs(self.chain) do + if v == state then + return self.chain[k-1] + end + end +end + +function Delegator.get_chain(self) + local x = Map.formvalue(self, "cbi.delg.path") or self.defaultpath + return type(x) == "table" and x or {x} +end + +function Delegator.get_active(self) + return Map.formvalue(self, "cbi.delg.current") or self.chain[1] +end --[[ Page - A simple node @@ -444,10 +645,20 @@ function SimpleForm.__init__(self, config, title, description, data) self.template = "cbi/simpleform" self.dorender = true self.pageaction = false + self.readinput = true end -function SimpleForm.parse(self, ...) - if luci.http.formvalue("cbi.submit") then +SimpleForm.formvalue = Map.formvalue +SimpleForm.formvaluetable = Map.formvaluetable + +function SimpleForm.parse(self, readinput, ...) + self.readinput = (readinput ~= false) + + if self:formvalue("cbi.skip") then + return FORM_SKIP + end + + if self:submitstate() then Node.parse(self, 1, ...) end @@ -457,6 +668,7 @@ function SimpleForm.parse(self, ...) valid = valid and (not v.tag_missing or not v.tag_missing[1]) and (not v.tag_invalid or not v.tag_invalid[1]) + and (not v.error) end end @@ -465,7 +677,12 @@ function SimpleForm.parse(self, ...) or valid and FORM_VALID or FORM_INVALID - self.dorender = not self.handle or self:handle(state, self.data) ~= false + self.dorender = not self.handle + if self.handle then + local nrender, nstate = self:handle(state, self.data) + self.dorender = self.dorender or (nrender ~= false) + state = nstate or state + end return state end @@ -476,7 +693,7 @@ function SimpleForm.render(self, ...) end function SimpleForm.submitstate(self) - return luci.http.formvalue("cbi.submit") + return self:formvalue("cbi.submit") end function SimpleForm.section(self, class, ...) @@ -532,6 +749,13 @@ function SimpleForm.get_scheme() end +Form = class(SimpleForm) + +function Form.__init__(self, ...) + SimpleForm.__init__(self, ...) + self.embedded = true +end + --[[ AbstractSection @@ -595,11 +819,12 @@ function AbstractSection.parse_optionals(self, section) self.optionals[section] = {} - local field = luci.http.formvalue("cbi.opt."..self.config.."."..section) + local field = self.map: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 field = nil + self.map.proceed = true else table.insert(self.optionals[section], v) end @@ -624,7 +849,7 @@ function AbstractSection.parse_dynamic(self, section) end local arr = luci.util.clone(self:cfgvalue(section)) - local form = luci.http.formvaluetable("cbid."..self.config.."."..section) + local form = self.map:formvaluetable("cbid."..self.config.."."..section) for k, v in pairs(form) do arr[k] = v end @@ -639,6 +864,7 @@ function AbstractSection.parse_dynamic(self, section) end if create and key:sub(1, 1) ~= "." then + self.map.proceed = true self:add_dynamic(key, true) end end @@ -657,6 +883,7 @@ end -- Removes the section function AbstractSection.remove(self, section) + self.map.proceed = true return self.map:del(section) end @@ -683,6 +910,8 @@ function AbstractSection.create(self, section) end end + self.map.proceed = true + return stat end @@ -699,15 +928,20 @@ Table = class(AbstractSection) function Table.__init__(self, form, data, ...) local datasource = {} + local tself = self datasource.config = "table" - self.data = data + self.data = data or {} + + datasource.formvalue = Map.formvalue + datasource.formvaluetable = Map.formvaluetable + datasource.readinput = true function datasource.get(self, section, option) - return data[section] and data[section][option] + return tself.data[section] and tself.data[section][option] end - + function datasource.submitstate(self) - return luci.http.formvalue("cbi.submit") + return Map.formvalue(self, "cbi.submit") end function datasource.del(...) @@ -724,7 +958,8 @@ function Table.__init__(self, form, data, ...) self.anonymous = true end -function Table.parse(self) +function Table.parse(self, readinput) + self.map.readinput = (readinput ~= false) for i, k in ipairs(self:cfgsections()) do if self.map:submitstate() then Node.parse(self, k) @@ -742,6 +977,10 @@ function Table.cfgsections(self) return sections end +function Table.update(self, data) + self.data = data +end + --[[ @@ -776,11 +1015,12 @@ function NamedSection.parse(self, novld) if self.addremove then local path = self.config.."."..s if active then -- Remove the section - if luci.http.formvalue("cbi.rns."..path) and self:remove(s) then + if self.map:formvalue("cbi.rns."..path) and self:remove(s) then + self:push_events() return end else -- Create and apply default values - if luci.http.formvalue("cbi.cns."..path) then + if self.map:formvalue("cbi.cns."..path) then self:create(s) return end @@ -797,7 +1037,7 @@ function NamedSection.parse(self, novld) end end AbstractSection.parse_optionals(self, s) - + if self.changed then self:push_events() end @@ -854,7 +1094,7 @@ function TypedSection.parse(self, novld) if self.addremove then -- Remove local crval = REMOVE_PREFIX .. self.config - local name = luci.http.formvaluetable(crval) + local name = self.map:formvaluetable(crval) for k,v in pairs(name) do if k:sub(-2) == ".x" then k = k:sub(1, #k - 2) @@ -869,7 +1109,7 @@ function TypedSection.parse(self, novld) for i, k in ipairs(self:cfgsections()) do AbstractSection.parse_dynamic(self, k) if self.map:submitstate() then - Node.parse(self, k) + Node.parse(self, k, novld) if not novld and not self.override_scheme and self.map.scheme then _uvl_validate_section(self, k) @@ -882,7 +1122,7 @@ function TypedSection.parse(self, novld) -- Create local created local crval = CREATE_PREFIX .. self.config .. "." .. self.sectiontype - local name = luci.http.formvalue(crval) + local name = self.map:formvalue(crval) if self.anonymous then if name then created = self:create() @@ -977,7 +1217,7 @@ function AbstractValue.__init__(self, map, section, option, ...) --self.cast = "string" self.track_missing = false - --self.rmempty = false + self.rmempty = true self.default = nil self.size = nil self.optional = false @@ -988,9 +1228,6 @@ function AbstractValue.prepare(self) 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.rmempty == nil then - self.rmempty = not vs.required - end if self.cast == nil then self.cast = (vs.type == "list") and "list" or "string" end @@ -1034,12 +1271,12 @@ end -- Return whether this object should be created function AbstractValue.formcreated(self, section) local key = "cbi.opt."..self.config.."."..section - return (luci.http.formvalue(key) == self.option) + return (self.map:formvalue(key) == self.option) end -- Returns the formvalue for this object function AbstractValue.formvalue(self, section) - return luci.http.formvalue(self:cbid(section)) + return self.map:formvalue(self:cbid(section)) end function AbstractValue.additional(self, value) @@ -1050,20 +1287,30 @@ function AbstractValue.mandatory(self, value) self.rmempty = not value end -function AbstractValue.parse(self, section) +function AbstractValue.parse(self, section, novld) local fvalue = self:formvalue(section) local cvalue = self:cfgvalue(section) if fvalue and #fvalue > 0 then -- If we have a form value, write it to UCI fvalue = self:transform(self:validate(fvalue, section)) - if not fvalue then - self.tag_invalid[section] = true + if not fvalue and not novld then + if self.error then + self.error[section] = "invalid" + else + self.error = { [section] = "invalid" } + end + if self.section.error then + table.insert(self.section.error[section], "invalid") + else + self.section.error = {[section] = {"invalid"}} + end + self.map.save = false end if fvalue and not (fvalue == cvalue) then if self:write(section, fvalue) then -- Push events self.section.changed = true - --luci.util.append(self.map.events, self.events) + --luci.util.append(self.map.events, self.events) end end else -- Unset the UCI or error @@ -1073,8 +1320,14 @@ function AbstractValue.parse(self, section) self.section.changed = true --luci.util.append(self.map.events, self.events) end - elseif self.track_missing and (not fvalue or fvalue ~= cvalue) then - self.tag_missing[section] = true + elseif cvalue ~= fvalue and not novld then + self:write(section, fvalue or "") + if self.error then + self.error[section] = "missing" + else + self.error = { [section] = "missing" } + end + self.map.save = false end end end @@ -1372,7 +1625,7 @@ function StaticList.validate(self, value) local valid = {} for i, v in ipairs(value) do - if luci.util.contains(self.vallist, v) then + if luci.util.contains(self.keylist, v) then table.insert(valid, v) end end @@ -1396,6 +1649,11 @@ function DynamicList.value(self, key, val) table.insert(self.vallist, tostring(val)) end +function DynamicList.write(self, ...) + self.map.proceed = true + return AbstractValue.write(self, ...) +end + function DynamicList.formvalue(self, section) local value = AbstractValue.formvalue(self, section) value = (type(value) == "table") and value or {value} @@ -1403,8 +1661,8 @@ function DynamicList.formvalue(self, section) 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) - and not luci.http.formvalue("cbi.rle."..section.."."..self.option.."."..i..".x") then + and not self.map:formvalue("cbi.rle."..section.."."..self.option.."."..i) + and not self.map:formvalue("cbi.rle."..section.."."..self.option.."."..i..".x") then table.insert(valid, v) end end @@ -1451,13 +1709,13 @@ end function FileUpload.formcreated(self, section) return AbstractValue.formcreated(self, section) or - luci.http.formvalue("cbi.rlf."..section.."."..self.option) or - luci.http.formvalue("cbi.rlf."..section.."."..self.option..".x") + self.map:formvalue("cbi.rlf."..section.."."..self.option) or + self.map:formvalue("cbi.rlf."..section.."."..self.option..".x") end function FileUpload.cfgvalue(self, section) local val = AbstractValue.cfgvalue(self, section) - if val and luci.fs.access(val) then + if val and fs.access(val) then return val end return nil @@ -1466,12 +1724,12 @@ end function FileUpload.formvalue(self, section) local val = AbstractValue.formvalue(self, section) if val then - if not luci.http.formvalue("cbi.rlf."..section.."."..self.option) and - not luci.http.formvalue("cbi.rlf."..section.."."..self.option..".x") + if not self.map:formvalue("cbi.rlf."..section.."."..self.option) and + not self.map:formvalue("cbi.rlf."..section.."."..self.option..".x") then return val end - luci.fs.unlink(val) + fs.unlink(val) self.value = nil end return nil @@ -1479,7 +1737,7 @@ end function FileUpload.remove(self, section) local val = AbstractValue.formvalue(self, section) - if val and luci.fs.access(val) then luci.fs.unlink(val) end + if val and fs.access(val) then fs.unlink(val) end return AbstractValue.remove(self, section) end