Renamed reworked UCI API to uci2 to allow a peaceful coexistence with the old one
[project/luci.git] / libs / cbi / luasrc / cbi.lua
index 9a94aba..12bf18c 100644 (file)
@@ -29,10 +29,9 @@ module("luci.cbi", package.seeall)
 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
 
@@ -40,6 +39,8 @@ FORM_NODATA  =  0
 FORM_VALID   =  1
 FORM_INVALID = -1
 
+AUTO = true
+
 CREATE_PREFIX = "cbi.cts."
 REMOVE_PREFIX = "cbi.rts."
 
@@ -80,14 +81,14 @@ end
 
 function _uvl_strip_remote_dependencies(deps)
        local clean = {}
-       
+
        for k, v in pairs(deps) do
                k = k:gsub("%$config%.%$section%.", "")
-               if k:match("^[%w_]+$") then
+               if k:match("^[%w_]+$") and type(v) == "string" then
                        clean[k] = v
                end
        end
-       
+
        return clean
 end
 
@@ -173,7 +174,8 @@ function Map.__init__(self, config, ...)
        self.config = config
        self.parsechain = {self.config}
        self.template = "cbi/map"
-       if not uci.load_config(self.config) then
+       self.uci = uci.cursor()
+       if not self.uci:load(self.config) then
                error("Unable to read UCI data: " .. self.config)
        end
 
@@ -190,15 +192,6 @@ function Map.get_scheme(self, sectiontype, option)
        end
 end
 
-function Map.render(self, ...)
-       if self.stateful then
-               uci.load_state(self.config)
-       else
-               uci.load_config(self.config)
-       end
-       Node.render(self, ...)
-end
-
 
 -- Chain foreign config
 function Map.chain(self, config)
@@ -207,26 +200,18 @@ 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)
+               self.uci:save(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
+                       self.uci:commit(config)
+                       self.uci:apply(config)
 
                        -- Refresh data because commit changes section names
-                       uci.load_config(config)
+                       self.uci:load(config)
                end
 
                -- Reparse sections
@@ -234,7 +219,7 @@ function Map.parse(self, ...)
 
        end
        for i, config in ipairs(self.parsechain) do
-               uci.unload(config)
+               self.uci:unload(config)
        end
 end
 
@@ -251,35 +236,35 @@ 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
 
@@ -310,17 +295,17 @@ function SimpleForm.parse(self, ...)
        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
@@ -356,7 +341,7 @@ function SimpleForm.field(self, class, ...)
        if not section then
                section = self:section(SimpleSection)
        end
-       
+
        if instanceof(class, AbstractValue) then
                local obj  = class(self, ...)
                obj.track_missing = true
@@ -382,6 +367,11 @@ function SimpleForm.get(self, section, option)
 end
 
 
+function SimpleForm.get_scheme()
+       return nil
+end
+
+
 
 --[[
 AbstractSection
@@ -403,21 +393,20 @@ end
 
 -- Appends a new option
 function AbstractSection.option(self, class, option, ...)
-       -- Autodetect form UVL
-       if not class or type(class) == "boolean"
-        and self.map:get_scheme(self.sectiontype, option) then
+       -- 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"
+                       class = Flag
                elseif vs.type == "list" then
-                       class = "DynamicList"
+                       class = DynamicList
                elseif vs.type == "enum" or vs.type == "reference" then
-                       class = "ListValue"
+                       class = ListValue
                else
-                       class = "Value"
+                       class = Value
                end
        end
-       
+
        if instanceof(class, AbstractValue) then
                local obj  = class(self.map, self, option, ...)
 
@@ -425,7 +414,7 @@ function AbstractSection.option(self, class, option, ...)
 
                self:append(obj)
                return obj
-       elseif not class or type(class) == "boolean" then
+       elseif class == true then
                error("No valid class was given and autodetection failed.")
        else
                error("class must be a descendant of AbstractValue")
@@ -502,7 +491,7 @@ end
 -- Creates the section
 function AbstractSection.create(self, section)
        local stat
-       
+
        if section then
                stat = self.map:set(section, nil, self.sectiontype)
        else
@@ -540,15 +529,19 @@ function Table.__init__(self, form, data, ...)
        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
@@ -565,11 +558,11 @@ end
 
 function Table.cfgsections(self)
        local sections = {}
-       
+
        for i, v in luci.util.kspairs(self.data) do
                table.insert(sections, i)
        end
-       
+
        return sections
 end
 
@@ -659,7 +652,7 @@ 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"])
@@ -696,7 +689,7 @@ function TypedSection.parse(self)
                                        self.err_invalid = true
                                end
 
-                               if name and name:len() > 0 then
+                               if name and #name > 0 then
                                        self:create(name)
                                end
                        end
@@ -706,9 +699,6 @@ function TypedSection.parse(self)
                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
@@ -785,7 +775,7 @@ function AbstractValue.__init__(self, map, section, option, ...)
        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
@@ -794,7 +784,7 @@ function AbstractValue.__init__(self, map, section, option, ...)
                self.cast        = (vs.type == "list") and "list" or "string"
                self.title       = self.title or vs.title
                self.description = self.description or vs.descr
-               
+
                if vs.depends and not self.override_dependencies then
                        for i, deps in ipairs(vs.depends) do
                                deps = _uvl_strip_remote_dependencies(deps)
@@ -803,12 +793,6 @@ function AbstractValue.__init__(self, map, section, option, ...)
                                end
                        end
                end
-               
-               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
 
@@ -821,7 +805,7 @@ function AbstractValue.depends(self, field, value)
        else
                deps = field
        end
-       
+
        table.insert(self.deps, {deps=deps, add=""})
 end
 
@@ -1012,18 +996,35 @@ ListValue = class(AbstractValue)
 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 vs.enum_depends and vs.enum_depends[k] then
+                                       deps = _uvl_strip_remote_dependencies(vs.enum_depends[k])
+                               end
+                               self:value(k, v, unpack(deps))
+                       end
+               end
+       end
 end
 
 function ListValue.value(self, key, val, ...)
        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
@@ -1049,6 +1050,7 @@ MultiValue = class(AbstractValue)
 function MultiValue.__init__(self, ...)
        AbstractValue.__init__(self, ...)
        self.template = "cbi/mvalue"
+
        self.keylist = {}
        self.vallist = {}
 
@@ -1101,6 +1103,16 @@ function StaticList.__init__(self, ...)
        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)
@@ -1122,7 +1134,6 @@ function DynamicList.__init__(self, ...)
        AbstractValue.__init__(self, ...)
        self.template  = "cbi/dynlist"
        self.cast = "table"
-       
        self.keylist = {}
        self.vallist = {}
 end
@@ -1135,7 +1146,7 @@ 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
@@ -1143,7 +1154,7 @@ function DynamicList.validate(self, value, section)
                        table.insert(valid, v)
                end
        end
-       
+
        return valid
 end
 
@@ -1169,4 +1180,4 @@ function Button.__init__(self, ...)
        self.template  = "cbi/button"
        self.inputstyle = nil
        self.rmempty = true
-end
\ No newline at end of file
+end