X-Git-Url: https://git.archive.openwrt.org/?a=blobdiff_plain;f=libs%2Fuci%2Fluasrc%2Fmodel%2Fuci.lua;h=7fc0c79fd4cc36e7ecb0be161bbda1410cdfb80f;hb=b5b0914ae3d05010f8c67766af799285cb888635;hp=bf7ac93156c4d9e427c8e60459a26bd02a39411b;hpb=cd0fb5e44e5cb538d93024d02a14a02c00752641;p=project%2Fluci.git

diff --git a/libs/uci/luasrc/model/uci.lua b/libs/uci/luasrc/model/uci.lua
index bf7ac9315..7fc0c79fd 100644
--- a/libs/uci/luasrc/model/uci.lua
+++ b/libs/uci/luasrc/model/uci.lua
@@ -1,5 +1,5 @@
 --[[
-LuCI - UCI mpdel
+LuCI - UCI model
 
 Description:
 Generalized UCI model
@@ -12,9 +12,9 @@ Copyright 2008 Steven Barth <steven@midlink.org>
 
 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,
@@ -23,54 +23,241 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 ]]--
-local uci  = require("uci")
-local util = require("luci.util")
+local os    = require "os"
+local uci   = require "uci"
+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")
 
-module("luci.model.uci", function(m) setmetatable(m, {__index = uci}) end)
+--- Create a new UCI-Cursor.
+-- @class function
+-- @name cursor
+-- @return	UCI-Cursor
+cursor = uci.cursor
 
-savedir_default = "/tmp/.uci"
-confdir_default = "/etc/config"
+APIVERSION = uci.APIVERSION
+
+--- Create a new Cursor initialized to the state directory.
+-- @return UCI cursor
+function cursor_state()
+	return cursor(nil, "/var/state")
+end
 
-savedir_state = "/var/state"
+--- UCI-Cursor
+-- @class	module
+-- @cstyle	instance
+-- @name	luci.model.uci.Cursor
+local Cursor = getmetatable(cursor())
 
-function delete_all(config, type, comparator)
+--- 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 = {}
-	
-	foreach(config, type,
-		function (section)
-			if not comparator or comparator(section) then
-				table.insert(del, section[".name"])
-			end
-		end)
-		
+	local function helper (section)
+		if not comparator or comparator(section) then
+			table.insert(del, section[".name"])
+		end
+	end
+
+	self:foreach(config, type, helper)
+
 	for i, j in ipairs(del) do
-		uci.delete("config", j)
+		self:delete(config, j)
 	end
 end
 
-function section(config, type, name, values)
+--- 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 = set(config, name, type)
+		stat = self:set(config, name, type)
 	else
-		name = add(config, type)
+		name = self:add(config, type)
 		stat = name and true
 	end
-	
+
 	if stat and values then
-		stat = tset(config, name, values)
+		stat = self:tset(config, name, values)
 	end
-	
+
 	return stat and name
 end
 
-function tset(config, section, values)
+--- 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 set(config, section, k, v)
+			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 Cursor.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.
+-- @class function
+-- @name Cursor.load
+-- @param config	UCI config
+-- @return			Boolean whether operation succeeded
+-- @see Cursor.save
+-- @see Cursor.unload
+
+--- Revert unsaved changes.
+-- @class function
+-- @name Cursor.revert
+-- @param config	UCI config
+-- @return			Boolean whether operation succeeded
+-- @see Cursor.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 Cursor.load
+-- @see Cursor.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 Cursor.load
+-- @see Cursor.save