2 LuCI - Configuration Bind Interface
5 Offers an interface for binding configuration values to certain
6 data types. Supports value and range validation and basic dependencies.
12 Copyright 2008 Steven Barth <steven@midlink.org>
14 Licensed under the Apache License, Version 2.0 (the "License");
15 you may not use this file except in compliance with the License.
16 You may obtain a copy of the License at
18 http://www.apache.org/licenses/LICENSE-2.0
20 Unless required by applicable law or agreed to in writing, software
21 distributed under the License is distributed on an "AS IS" BASIS,
22 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 See the License for the specific language governing permissions and
24 limitations under the License.
27 module("luci.cbi", package.seeall)
29 require("luci.template")
32 require("luci.model.uci")
34 local uci = luci.model.uci
35 local class = luci.util.class
36 local instanceof = luci.util.instanceof
42 CREATE_PREFIX = "cbi.cts."
43 REMOVE_PREFIX = "cbi.rts."
45 -- Loads a CBI map from given file, creating an environment and returns it
46 function load(cbimap, ...)
49 require("luci.config")
52 local cbidir = luci.util.libpath() .. "/model/cbi/"
53 local func, err = loadfile(cbidir..cbimap..".lua")
59 luci.i18n.loadc("cbi")
61 luci.util.resfenv(func)
62 luci.util.updfenv(func, luci.cbi)
63 luci.util.extfenv(func, "translate", luci.i18n.translate)
64 luci.util.extfenv(func, "translatef", luci.i18n.translatef)
65 luci.util.extfenv(func, "arg", {...})
69 for i, map in ipairs(maps) do
70 if not instanceof(map, Node) then
71 error("CBI map returns no valid map object!")
79 -- Node pseudo abstract class
82 function Node.__init__(self, title, description)
84 self.title = title or ""
85 self.description = description or ""
86 self.template = "cbi/node"
90 function Node._i18n(self, config, section, option, title, description)
93 if type(luci.i18n) == "table" then
95 local key = config and config:gsub("[^%w]+", "") or ""
97 if section then key = key .. "_" .. section:lower():gsub("[^%w]+", "") end
98 if option then key = key .. "_" .. tostring(option):lower():gsub("[^%w]+", "") end
100 self.title = title or luci.i18n.translate( key, option or section or config )
101 self.description = description or luci.i18n.translate( key .. "_desc", "" )
105 -- Append child nodes
106 function Node.append(self, obj)
107 table.insert(self.children, obj)
110 -- Parse this node and its children
111 function Node.parse(self, ...)
112 for k, child in ipairs(self.children) do
118 function Node.render(self, scope)
122 luci.template.render(self.template, scope)
125 -- Render the children
126 function Node.render_children(self, ...)
127 for k, node in ipairs(self.children) do
134 A simple template element
136 Template = class(Node)
138 function Template.__init__(self, template)
140 self.template = template
143 function Template.render(self)
144 luci.template.render(self.template, {self=self})
149 Map - A map describing a configuration file
153 function Map.__init__(self, config, ...)
154 Node.__init__(self, ...)
155 Node._i18n(self, config, nil, nil, ...)
158 self.parsechain = {self.config}
159 self.template = "cbi/map"
160 if not uci.load(self.config) then
161 error("Unable to read UCI data: " .. self.config)
166 -- Chain foreign config
167 function Map.chain(self, config)
168 table.insert(self.parsechain, config)
171 -- Use optimized UCI writing
172 function Map.parse(self, ...)
173 Node.parse(self, ...)
174 for i, config in ipairs(self.parsechain) do
177 if luci.http.formvalue("cbi.apply") then
178 for i, config in ipairs(self.parsechain) do
180 if luci.config.uci_oncommit and luci.config.uci_oncommit[config] then
181 luci.util.exec(luci.config.uci_oncommit[config])
184 -- Refresh data because commit changes section names
190 Node.parse(self, ...)
193 for i, config in ipairs(self.parsechain) do
198 -- Creates a child section
199 function Map.section(self, class, ...)
200 if instanceof(class, AbstractSection) then
201 local obj = class(self, ...)
205 error("class must be a descendent of AbstractSection")
210 function Map.add(self, sectiontype)
211 return uci.add(self.config, sectiontype)
215 function Map.set(self, section, option, value)
217 return uci.set(self.config, section, option, value)
219 return uci.set(self.config, section, value)
224 function Map.del(self, section, option)
226 return uci.delete(self.config, section, option)
228 return uci.delete(self.config, section)
233 function Map.get(self, section, option)
235 return uci.get_all(self.config)
237 return uci.get(self.config, section, option)
239 return uci.get_all(self.config, section)
244 function Map.stateget(self, section, option)
245 return uci.get_statevalue(self.config, section, option)
254 Page.__init__ = Node.__init__
255 Page.parse = function() end
259 SimpleForm - A Simple non-UCI form
261 SimpleForm = class(Node)
263 function SimpleForm.__init__(self, config, title, description, data)
264 Node.__init__(self, title, description)
266 self.data = data or {}
267 self.template = "cbi/simpleform"
271 function SimpleForm.parse(self, ...)
272 if luci.http.formvalue("cbi.submit") then
273 Node.parse(self, 1, ...)
277 for k, j in ipairs(self.children) do
278 for i, v in ipairs(j.children) do
280 and (not v.tag_missing or not v.tag_missing[1])
281 and (not v.tag_invalid or not v.tag_invalid[1])
286 not luci.http.formvalue("cbi.submit") and 0
290 self.dorender = self:handle(state, self.data) ~= false
293 function SimpleForm.render(self, ...)
294 if self.dorender then
295 Node.render(self, ...)
299 function SimpleForm.section(self, class, ...)
300 if instanceof(class, AbstractSection) then
301 local obj = class(self, ...)
305 error("class must be a descendent of AbstractSection")
309 -- Creates a child field
310 function SimpleForm.field(self, class, ...)
312 for k, v in ipairs(self.children) do
313 if instanceof(v, SimpleSection) then
319 section = self:section(SimpleSection)
322 if instanceof(class, AbstractValue) then
323 local obj = class(self, ...)
324 obj.track_missing = true
328 error("class must be a descendent of AbstractValue")
332 function SimpleForm.set(self, section, option, value)
333 self.data[option] = value
337 function SimpleForm.del(self, section, option)
338 self.data[option] = nil
342 function SimpleForm.get(self, section, option)
343 return self.data[option]
351 AbstractSection = class(Node)
353 function AbstractSection.__init__(self, map, sectiontype, ...)
354 Node.__init__(self, ...)
355 self.sectiontype = sectiontype
357 self.config = map.config
362 self.addremove = false
366 -- Appends a new option
367 function AbstractSection.option(self, class, option, ...)
368 if instanceof(class, AbstractValue) then
369 local obj = class(self.map, option, ...)
371 Node._i18n(obj, self.config, self.section or self.sectiontype, option, ...)
376 error("class must be a descendent of AbstractValue")
380 -- Parse optional options
381 function AbstractSection.parse_optionals(self, section)
382 if not self.optional then
386 self.optionals[section] = {}
388 local field = luci.http.formvalue("cbi.opt."..self.config.."."..section)
389 for k,v in ipairs(self.children) do
390 if v.optional and not v:cfgvalue(section) then
391 if field == v.option then
394 table.insert(self.optionals[section], v)
399 if field and #field > 0 and self.dynamic then
400 self:add_dynamic(field)
404 -- Add a dynamic option
405 function AbstractSection.add_dynamic(self, field, optional)
406 local o = self:option(Value, field, field)
407 o.optional = optional
410 -- Parse all dynamic options
411 function AbstractSection.parse_dynamic(self, section)
412 if not self.dynamic then
416 local arr = luci.util.clone(self:cfgvalue(section))
417 local form = luci.http.formvaluetable("cbid."..self.config.."."..section)
418 for k, v in pairs(form) do
422 for key,val in pairs(arr) do
425 for i,c in ipairs(self.children) do
426 if c.option == key then
431 if create and key:sub(1, 1) ~= "." then
432 self:add_dynamic(key, true)
437 -- Returns the section's UCI table
438 function AbstractSection.cfgvalue(self, section)
439 return self.map:get(section)
442 -- Removes the section
443 function AbstractSection.remove(self, section)
444 return self.map:del(section)
447 -- Creates the section
448 function AbstractSection.create(self, section)
452 stat = self.map:set(section, nil, self.sectiontype)
454 section = self.map:add(self.sectiontype)
459 for k,v in pairs(self.children) do
461 self.map:set(section, v.option, v.default)
465 for k,v in pairs(self.defaults) do
466 self.map:set(section, k, v)
474 SimpleSection = class(AbstractSection)
476 function SimpleSection.__init__(self, form, ...)
477 AbstractSection.__init__(self, form, nil, ...)
478 self.template = "cbi/nullsection"
482 Table = class(AbstractSection)
484 function Table.__init__(self, form, data, ...)
485 local datasource = {}
486 datasource.config = "table"
489 function datasource.get(self, section, option)
490 return data[section][option]
493 AbstractSection.__init__(self, datasource, "table", ...)
494 self.template = "cbi/tblsection"
495 self.rowcolors = true
496 self.anonymous = true
499 function Table.cfgsections(self)
502 for i, v in pairs(self.data) do
503 table.insert(sections, i)
512 NamedSection - A fixed configuration section defined by its name
514 NamedSection = class(AbstractSection)
516 function NamedSection.__init__(self, map, section, type, ...)
517 AbstractSection.__init__(self, map, type, ...)
518 Node._i18n(self, map.config, section, nil, ...)
520 self.template = "cbi/nsection"
521 self.section = section
522 self.addremove = false
525 function NamedSection.parse(self)
526 local s = self.section
527 local active = self:cfgvalue(s)
530 if self.addremove then
531 local path = self.config.."."..s
532 if active then -- Remove the section
533 if luci.http.formvalue("cbi.rns."..path) and self:remove(s) then
536 else -- Create and apply default values
537 if luci.http.formvalue("cbi.cns."..path) then
545 AbstractSection.parse_dynamic(self, s)
546 if luci.http.formvalue("cbi.submit") then
549 AbstractSection.parse_optionals(self, s)
555 TypedSection - A (set of) configuration section(s) defined by the type
556 addremove: Defines whether the user can add/remove sections of this type
557 anonymous: Allow creating anonymous sections
558 validate: a validation function returning nil if the section is invalid
560 TypedSection = class(AbstractSection)
562 function TypedSection.__init__(self, map, type, ...)
563 AbstractSection.__init__(self, map, type, ...)
564 Node._i18n(self, map.config, type, nil, ...)
566 self.template = "cbi/tsection"
569 self.anonymous = false
572 -- Return all matching UCI sections for this TypedSection
573 function TypedSection.cfgsections(self)
575 uci.foreach(self.map.config, self.sectiontype,
577 if self:checkscope(section[".name"]) then
578 table.insert(sections, section[".name"])
585 -- Limits scope to sections that have certain option => value pairs
586 function TypedSection.depends(self, option, value)
587 table.insert(self.deps, {option=option, value=value})
590 function TypedSection.parse(self)
591 if self.addremove then
593 local crval = CREATE_PREFIX .. self.config .. "." .. self.sectiontype
594 local name = luci.http.formvalue(crval)
595 if self.anonymous then
601 -- Ignore if it already exists
602 if self:cfgvalue(name) then
606 name = self:checkscope(name)
609 self.err_invalid = true
612 if name and name:len() > 0 then
619 crval = REMOVE_PREFIX .. self.config
620 name = luci.http.formvaluetable(crval)
621 for k,v in pairs(name) do
622 if self:cfgvalue(k) and self:checkscope(k) then
628 for i, k in ipairs(self:cfgsections()) do
629 AbstractSection.parse_dynamic(self, k)
630 if luci.http.formvalue("cbi.submit") then
633 AbstractSection.parse_optionals(self, k)
637 -- Verifies scope of sections
638 function TypedSection.checkscope(self, section)
639 -- Check if we are not excluded
640 if self.filter and not self:filter(section) then
644 -- Check if at least one dependency is met
645 if #self.deps > 0 and self:cfgvalue(section) then
648 for k, v in ipairs(self.deps) do
649 if self:cfgvalue(section)[v.option] == v.value then
659 return self:validate(section)
663 -- Dummy validate function
664 function TypedSection.validate(self, section)
670 AbstractValue - An abstract Value Type
671 null: Value can be empty
672 valid: A function returning the value if it is valid otherwise nil
673 depends: A table of option => value pairs of which one must be true
674 default: The default value
675 size: The size of the input fields
676 rmempty: Unset value if empty
677 optional: This value is optional (see AbstractSection.optionals)
679 AbstractValue = class(Node)
681 function AbstractValue.__init__(self, map, option, ...)
682 Node.__init__(self, ...)
685 self.config = map.config
686 self.tag_invalid = {}
687 self.tag_missing = {}
690 self.track_missing = false
694 self.optional = false
695 self.stateful = false
698 -- Add a dependencie to another section field
699 function AbstractValue.depends(self, field, value)
700 table.insert(self.deps, {field=field, value=value})
703 -- Return whether this object should be created
704 function AbstractValue.formcreated(self, section)
705 local key = "cbi.opt."..self.config.."."..section
706 return (luci.http.formvalue(key) == self.option)
709 -- Returns the formvalue for this object
710 function AbstractValue.formvalue(self, section)
711 local key = "cbid."..self.map.config.."."..section.."."..self.option
712 return luci.http.formvalue(key)
715 function AbstractValue.additional(self, value)
716 self.optional = value
719 function AbstractValue.mandatory(self, value)
720 self.rmempty = not value
723 function AbstractValue.parse(self, section)
724 local fvalue = self:formvalue(section)
725 local cvalue = self:cfgvalue(section)
727 if fvalue and fvalue ~= "" then -- If we have a form value, write it to UCI
728 fvalue = self:transform(self:validate(fvalue, section))
730 self.tag_invalid[section] = true
732 if fvalue and not (fvalue == cvalue) then
733 self:write(section, fvalue)
735 else -- Unset the UCI or error
736 if self.rmempty or self.optional then
738 elseif self.track_missing and (not fvalue or fvalue ~= cvalue) then
739 self.tag_missing[section] = true
744 -- Render if this value exists or if it is mandatory
745 function AbstractValue.render(self, s, scope)
746 if not self.optional or self:cfgvalue(s) or self:formcreated(s) then
749 scope.cbid = "cbid." .. self.config ..
753 scope.ifattr = function(cond,key,val)
755 return string.format(
756 ' %s="%s"', tostring(key),
757 luci.util.pcdata(tostring( val
759 or (type(self[key]) ~= "function" and self[key])
767 scope.attr = function(...)
768 return scope.ifattr( true, ... )
771 Node.render(self, scope)
775 -- Return the UCI value of this object
776 function AbstractValue.cfgvalue(self, section)
778 and self.map:stateget(section, self.option)
779 or self.map:get(section, self.option)
782 -- Validate the form value
783 function AbstractValue.validate(self, value)
787 AbstractValue.transform = AbstractValue.validate
791 function AbstractValue.write(self, section, value)
792 return self.map:set(section, self.option, value)
796 function AbstractValue.remove(self, section)
797 return self.map:del(section, self.option)
804 Value - A one-line value
805 maxlength: The maximum length
807 Value = class(AbstractValue)
809 function Value.__init__(self, ...)
810 AbstractValue.__init__(self, ...)
811 self.template = "cbi/value"
816 function Value.value(self, key, val)
818 table.insert(self.keylist, tostring(key))
819 table.insert(self.vallist, tostring(val))
823 -- DummyValue - This does nothing except being there
824 DummyValue = class(AbstractValue)
826 function DummyValue.__init__(self, map, ...)
827 AbstractValue.__init__(self, map, ...)
828 self.template = "cbi/dvalue"
832 function DummyValue.parse(self)
838 Flag - A flag being enabled or disabled
840 Flag = class(AbstractValue)
842 function Flag.__init__(self, ...)
843 AbstractValue.__init__(self, ...)
844 self.template = "cbi/fvalue"
850 -- A flag can only have two states: set or unset
851 function Flag.parse(self, section)
852 local fvalue = self:formvalue(section)
855 fvalue = self.enabled
857 fvalue = self.disabled
860 if fvalue == self.enabled or (not self.optional and not self.rmempty) then
861 if not(fvalue == self:cfgvalue(section)) then
862 self:write(section, fvalue)
872 ListValue - A one-line value predefined in a list
873 widget: The widget that will be used (select, radio)
875 ListValue = class(AbstractValue)
877 function ListValue.__init__(self, ...)
878 AbstractValue.__init__(self, ...)
879 self.template = "cbi/lvalue"
884 self.widget = "select"
887 function ListValue.value(self, key, val)
889 table.insert(self.keylist, tostring(key))
890 table.insert(self.vallist, tostring(val))
893 function ListValue.validate(self, val)
894 if luci.util.contains(self.keylist, val) then
904 MultiValue - Multiple delimited values
905 widget: The widget that will be used (select, checkbox)
906 delimiter: The delimiter that will separate the values (default: " ")
908 MultiValue = class(AbstractValue)
910 function MultiValue.__init__(self, ...)
911 AbstractValue.__init__(self, ...)
912 self.template = "cbi/mvalue"
916 self.widget = "checkbox"
920 function MultiValue.render(self, ...)
921 if self.widget == "select" and not self.size then
922 self.size = #self.vallist
925 AbstractValue.render(self, ...)
928 function MultiValue.value(self, key, val)
930 table.insert(self.keylist, tostring(key))
931 table.insert(self.vallist, tostring(val))
934 function MultiValue.valuelist(self, section)
935 local val = self:cfgvalue(section)
937 if not(type(val) == "string") then
941 return luci.util.split(val, self.delimiter)
944 function MultiValue.validate(self, val)
945 val = (type(val) == "table") and val or {val}
949 for i, value in ipairs(val) do
950 if luci.util.contains(self.keylist, value) then
951 result = result and (result .. self.delimiter .. value) or value
959 TextValue - A multi-line value
962 TextValue = class(AbstractValue)
964 function TextValue.__init__(self, ...)
965 AbstractValue.__init__(self, ...)
966 self.template = "cbi/tvalue"