Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
limitations under the License.
]]--
-local uci = require("uci")
-local util = require("luci.util")
-local setmetatable = setmetatable
-local rawget = rawget
-local rawset = rawset
-local error = error
-local tostring = tostring
-
-module("luci.model.uci", function(m) setmetatable(m, {__index = uci}) end)
-
-local configs_mt = {}
-local sections_mt = {}
-local options_mt = {}
-
-config = {}
-setmetatable(config, configs_mt)
-
--- Level 1 (configs)
-function configs_mt.__index(self, key)
- local node = rawget(self, key)
- if not node then
- node = {}
- node[".name"] = key
- setmetatable(node, sections_mt)
- rawset(self, key, node)
- end
- return node
+local uci = require "uci2"
+local util = require "luci.util"
+local table = require "table"
+
+local setmetatable, rawget, rawset = setmetatable, rawget, rawset
+local error, pairs, ipairs, tostring = error, pairs, ipairs, tostring
+local require, getmetatable = require, getmetatable
+
+--- LuCI UCI model library.
+module("luci.model.uci")
+
+cursor = uci.cursor
+APIVERSION = uci.APIVERSION
+
+--- Creates a new statevalue cursor
+-- @return UCI cursor
+function cursor_state()
+ return cursor(nil, "/var/state")
end
-function configs_mt.__newindex()
- error("invalid operation")
+
+--- UCI-Cursor
+local Cursor = getmetatable(cursor())
+
+--- Applies the new config
+-- @param config UCI config
+function Cursor.apply(self, config)
+ local conf = require "luci.config"
+ return conf.uci_oncommit[config] and os.execute(conf.uci_oncommit[config])
end
+--- Delete all sections of a given type that match certain criteria.
+-- @param config UCI config
+-- @param type UCI section type
+-- @param comparator Function that will be called for each section and
+-- returns a boolean whether to delete the current section (optional)
+function Cursor.delete_all(self, config, type, comparator)
+ local del = {}
+ local function helper (section)
+ if not comparator or comparator(section) then
+ table.insert(del, section[".name"])
+ end
+ end
--- Level 2 (sections)
-function sections_mt.__index(self, key)
- local node = rawget(self, key)
- if not node then
- node = {}
- node[".conf"] = self[".name"]
- node[".name"] = key
- node[".type"] = uci.get(self[".name"], key)
- setmetatable(node, options_mt)
- rawset(self, key, node)
+ self:foreach(config, type, helper)
+
+ for i, j in ipairs(del) do
+ self:delete(config, j)
end
- return node
end
-function sections_mt.__newindex(self, key, value)
- if not value then
- if uci.delete(self[".name"], key) then
- rawset(self, key, nil)
- else
- error("unable to delete section")
- end
- elseif key == "" then
- key = uci.add(self[".name"], tostring(value))
- if key then
- rawset(self, "", self[key])
- else
- error("unable to create section")
- end
+
+--- Create a new section and initialize it with data.
+-- @param config UCI config
+-- @param type UCI section type
+-- @param name UCI section name (optional)
+-- @param values Table of key - value pairs to initialize the section with
+-- @return Name of created section
+function Cursor.section(self, config, type, name, values)
+ local stat = true
+ if name then
+ stat = self:set(config, name, type)
else
- if not uci.set(self[".name"], key, value) then
- error("unable to create section")
- end
+ name = self:add(config, type)
+ stat = name and true
end
-end
+ if stat and values then
+ stat = self:tset(config, name, values)
+ end
--- Level 3 (options)
-function options_mt.__index(self, key)
- return uci.get(self[".conf"], self[".name"], key)
+ return stat and name
end
-function options_mt.__newindex(self, key, value)
- if not value then
- if not uci.delete(self[".conf"], self[".name"], key) then
- error("unable to delete option")
- end
- else
- if not uci.set(self[".conf"], self[".name"], key, tostring(value)) then
- error("unable to write option")
+
+--- Updated the data of a section using data from a table.
+-- @param config UCI config
+-- @param section UCI section name (optional)
+-- @param values Table of key - value pairs to update the section with
+function Cursor.tset(self, config, section, values)
+ local stat = true
+ for k, v in pairs(values) do
+ if k:sub(1, 1) ~= "." then
+ stat = stat and self:set(config, section, k, v)
end
end
+ return stat
+end
+
+--- Get an option or list and return values as table.
+-- @param config UCI config
+-- @param section UCI section name
+-- @param option UCI option
+-- @return UCI value
+function Cursor.get_list(self, config, section, option)
+ if config and section and option then
+ local val = self:get(config, section, option)
+ return ( type(val) == "table" and val or { val } )
+ end
+ return nil
end
+
+--- Set given values as list.
+-- @param config UCI config
+-- @param section UCI section name
+-- @param option UCI option
+-- @param value UCI value
+-- @return Boolean whether operation succeeded
+function Cursor.set_list(self, config, section, option, value)
+ if config and section and option then
+ return self:set(
+ config, section, option,
+ ( type(value) == "table" and value or { value } )
+ )
+ end
+ return false
+end
+
+
+--- Add an anonymous section.
+-- @class function
+-- @name Cursor.add
+-- @param config UCI config
+-- @param type UCI section type
+-- @return Name of created section
+
+--- Get a table of unsaved changes.
+-- @class function
+-- @name Cursor.changes
+-- @param config UCI config
+-- @return Table of changes
+
+--- Commit unsaved changes.
+-- @class function
+-- @name Cursor.commit
+-- @param config UCI config
+-- @return Boolean whether operation succeeded
+-- @see revert
+
+--- Deletes a section or an option.
+-- @class function
+-- @name Cursor.delete
+-- @param config UCI config
+-- @param section UCI section name
+-- @param option UCI option (optional)
+-- @return Boolean whether operation succeeded
+
+--- Call a function for every section of a certain type.
+-- @class function
+-- @name Cursor.foreach
+-- @param config UCI config
+-- @param type UCI section type
+-- @param callback Function to be called
+-- @return Boolean whether operation succeeded
+
+--- Get a section type or an option
+-- @class function
+-- @name Cursor.get
+-- @param config UCI config
+-- @param section UCI section name
+-- @param option UCI option (optional)
+-- @return UCI value
+
+--- Get all sections of a config or all values of a section.
+-- @class function
+-- @name Cursor.get_all
+-- @param config UCI config
+-- @param section UCI section name (optional)
+-- @return Table of UCI sections or table of UCI values
+
+--- Manually load a config.
+-- Warning: This function is unsave! You should use load_config or load_state if possible.
+-- @class function
+-- @name Cursor.load
+-- @param config UCI config
+-- @return Boolean whether operation succeeded
+-- @see load_config
+-- @see load_state
+-- @see save
+-- @see unload
+
+--- Revert unsaved changes.
+-- @class function
+-- @name Cursor.revert
+-- @param config UCI config
+-- @return Boolean whether operation succeeded
+-- @see commit
+
+--- Saves changes made to a config to make them committable.
+-- @class function
+-- @name Cursor.save
+-- @param config UCI config
+-- @return Boolean whether operation succeeded
+-- @see load
+-- @see unload
+
+--- Set a value or create a named section.
+-- @class function
+-- @name Cursor.set
+-- @param config UCI config
+-- @param section UCI section name
+-- @param option UCI option or UCI section type
+-- @param value UCI value or nil if you want to create a section
+-- @return Boolean whether operation succeeded
+
+--- Get the configuration directory.
+-- @class function
+-- @name Cursor.get_confdir
+-- @return Configuration directory
+
+--- Get the directory for uncomitted changes.
+-- @class function
+-- @name Cursor.get_savedir
+-- @return Save directory
+
+--- Set the configuration directory.
+-- @class function
+-- @name Cursor.set_confdir
+-- @param directory UCI configuration directory
+-- @return Boolean whether operation succeeded
+
+--- Set the directory for uncommited changes.
+-- @class function
+-- @name Cursor.set_savedir
+-- @param directory UCI changes directory
+-- @return Boolean whether operation succeeded
+
+--- Discard changes made to a config.
+-- @class function
+-- @name Cursor.unload
+-- @param config UCI config
+-- @return Boolean whether operation succeeded
+-- @see load
+-- @see save
projects / project / luci.git / blobdiff