]]--
+
+--- UVL - UCI Validation Layer
+-- @class module
+-- @cstyle instance
+
module( "luci.uvl", package.seeall )
require("luci.fs")
require("luci.util")
require("luci.model.uci")
+require("luci.uvl.loghelper")
require("luci.uvl.datatypes")
---require("luci.uvl.validation")
+require("luci.uvl.validation")
require("luci.uvl.dependencies")
+
TYPE_SECTION = 0x01
TYPE_VARIABLE = 0x02
TYPE_ENUM = 0x03
-STRICT_UNKNOWN_SECTIONS = true
-STRICT_UNKNOWN_OPTIONS = true
+--- Boolean; default true;
+-- treat sections found in config but not in scheme as error
+STRICT_UNKNOWN_SECTIONS = true
+
+--- Boolean; default true;
+-- treat options found in config but not in scheme as error
+STRICT_UNKNOWN_OPTIONS = true
+
+--- Boolean; default true;
+-- treat failed external validators as error
+STRICT_EXTERNAL_VALIDATORS = true
local default_schemedir = "/etc/scheme"
end
end
+
+--- Object constructor
+-- @class function
+-- @name UVL
+-- @param schemedir Path to the scheme directory (optional)
+-- @return Instance object
UVL = luci.util.class()
function UVL.__init__( self, schemedir )
self.packages = { }
self.beenthere = { }
self.uci = luci.model.uci
+ self.log = luci.uvl.loghelper
self.datatypes = luci.uvl.datatypes
end
-function UVL._keys( self, tbl )
- local keys = { }
- if tbl then
- for k, _ in luci.util.kspairs(tbl) do
- table.insert( keys, k )
- end
+
+--- Validate given configuration, section or option.
+-- @param config Name of the configuration to validate
+-- @param section Name of the section to validate (optional)
+-- @param option Name of the option to validate (optional)
+-- @return Boolean indicating whether the given config validates
+-- @return String containing the reason for errors (if any)
+function UVL.validate( self, config, section, option )
+ if config and section and option then
+ return self:validate_option( config, section, option )
+ elseif config and section then
+ return self:validate_section( config, section )
+ elseif config then
+ return self:validate_config( config )
end
- return keys
end
-
--- Validate given configuration.
-- @param config Name of the configuration to validate
--- @param scheme Scheme to validate against (optional)
--- @return Boolean indicating weather the given config validates
+-- @return Boolean indicating whether the given config validates
-- @return String containing the reason for errors (if any)
-function UVL.validate( self, config )
+function UVL.validate_config( self, config )
+
+ if not self.packages[config] then
+ local ok, err = pcall( self.read_scheme, self, config )
+ if not ok then
+ return false, self.log.scheme_error( config, err )
+ end
+ end
- self.uci.set_confdir( self.uci.confdir_default )
- self.uci.load( config )
+ self.uci.load_config( config )
+ self.beenthere = { }
local co = self.uci.get_all( config )
+ local sc = { }
local function _uci_foreach( type, func )
local ok, err
for k, v in pairs(co) do
if co[k]['.type'] == type then
+ sc[type] = sc[type] + 1
ok, err = func( k, v )
- if not ok then break end
+ if not ok then
+ err = self.log.config_error( config, err )
+ break
+ end
end
end
return ok, err
end
for k, v in pairs( self.packages[config].sections ) do
+ sc[k] = 0
local ok, err = _uci_foreach( k,
function(s)
local sect = luci.uvl.section( self, co, k, config, s )
if STRICT_UNKNOWN_SECTIONS then
for k, v in pairs(co) do
if not self.beenthere[config..'.'..k] then
- return false, "Section '" .. config .. '.' .. co[k]['.type'] ..
- "' not found in scheme"
+ return false, self.log.config_error( config,
+ "Section '" .. config .. '.' .. co[k]['.type'] ..
+ "' not found in scheme" )
end
end
end
+ for _, k in ipairs(luci.util.keys(sc)) do
+ local s = self.packages[config].sections[k]
+
+ if s.required and sc[k] == 0 then
+ return false, self.log.config_error( config,
+ 'Required section "' .. k .. '" not found in config' )
+ elseif s.unique and sc[k] > 1 then
+ return false, self.log.config_error( config,
+ 'Unique section "' .. k .. '" occurs multiple times in config' )
+ end
+ end
+
return true, nil
end
+--- Validate given config section.
+-- @param config Name of the configuration to validate
+-- @param section Name of the section to validate
+-- @return Boolean indicating whether the given config validates
+-- @return String containing the reason for errors (if any)
function UVL.validate_section( self, config, section )
- self.uci.set_confdir( self.uci.confdir_default )
- self.uci.load( config )
+
+ if not self.packages[config] then
+ local ok, err = pcall( self.read_scheme, self, config )
+ if not ok then
+ return false, self.log.scheme_error( config, err )
+ end
+ end
+
+ self.uci.load_config( config )
+ self.beenthere = { }
local co = self.uci.get_all( config )
if co[section] then
end
end
+--- Validate given config option.
+-- @param config Name of the configuration to validate
+-- @param section Name of the section to validate
+-- @param option Name of the option to validate
+-- @return Boolean indicating whether the given config validates
+-- @return String containing the reason for errors (if any)
function UVL.validate_option( self, config, section, option )
- self.uci.set_confdir( self.uci.confdir_default )
- self.uci.load( config )
+
+ if not self.packages[config] then
+ local ok, err = pcall( self.read_scheme, self, config )
+ if not ok then
+ return false, self.log.scheme_error( config, err )
+ end
+ end
+
+ self.uci.load_config( config )
+ self.beenthere = { }
local co = self.uci.get_all( config )
if co[section] and co[section][option] then
end
end
---- Validate given section of given configuration.
--- @param config Name of the configuration to validate
--- @param section Key of the section to validate
--- @param scheme Scheme to validate against
--- @return Boolean indicating weather the given config validates
--- @return String containing the reason for errors (if any)
+
function UVL._validate_section( self, section )
if section:values() then
local ok, err = self:_validate_option( v )
if not ok then
- return ok, err
+ return ok, self.log.section_error( section, err )
end
end
local ok, err = luci.uvl.dependencies.check( self, section )
if not ok then
- return false, "All possible dependencies failed"
+ return false, err
end
else
print( "Error, scheme section '" .. section:sid() .. "' not found in data" )
return true, nil
end
---- Validate given option within section of given configuration.
--- @param config Name of the configuration to validate
--- @param section Key of the section to validate
--- @param option Name of the option to validate
--- @param scheme Scheme to validate against
--- @return Boolean indicating weather the given config validates
--- @return String containing the reason for errors (if any)
function UVL._validate_option( self, option, nodeps )
if not option:option() and
not ( option:section() and option:section().dynamic )
then
- return false, "Requested option '" .. option:sid() ..
+ return false, "Option '" .. option:cid() ..
"' not found in scheme"
end
return false, "Value '" .. ( option:value() or '<nil>' ) ..
"' of given option '" .. option:cid() ..
"' is not defined in enum { " ..
- table.concat(self:_keys(option:option().values),", ") ..
+ table.concat(luci.util.keys(option:option().values),", ") ..
" }"
end
end
if not nodeps then
return luci.uvl.dependencies.check( self, option )
end
+
+ local ok, err = luci.uvl.validation.check( self, option )
+ if not ok and STRICT_EXTERNAL_VALIDATORS then
+ return false, self.log.validator_error( option, err )
+ end
end
return true, nil
end
---- Find all parts of given scheme and construct validation tree
+--- Find all parts of given scheme and construct validation tree.
+-- This is normally done on demand, so you don't have to call this function
+-- by yourself.
-- @param scheme Name of the scheme to parse
--- @return Parsed scheme
function UVL.read_scheme( self, scheme )
local schemes = { }
+ local files = luci.fs.glob(self.schemedir .. '/*/' .. scheme)
- for i, file in ipairs( luci.fs.glob(self.schemedir .. '/*/' .. scheme) ) do
- _assert( luci.fs.access(file), "Can't access file '%s'", file )
+ if files then
+ for i, file in ipairs( files ) do
+ _assert( luci.fs.access(file), "Can't access file '%s'", file )
- self.uci.set_confdir( luci.fs.dirname(file) )
- self.uci.load( luci.fs.basename(file) )
+ self.uci.set_confdir( luci.fs.dirname(file) )
+ self.uci.load( luci.fs.basename(file) )
- table.insert( schemes, self.uci.get_all( luci.fs.basename(file) ) )
- end
+ table.insert( schemes, self.uci.get_all( luci.fs.basename(file) ) )
+ end
- return self:_read_scheme_parts( scheme, schemes )
+ return self:_read_scheme_parts( scheme, schemes )
+ else
+ error(
+ 'Can\'t find scheme "' .. scheme ..
+ '" in "' .. self.schemedir .. '"'
+ )
+ end
end
-- Process all given parts and construct validation tree
return r
end
+ -- helper function to read bools
+ local function _bool( v )
+ return ( v == "true" or v == "yes" or v == "on" or v == "1" )
+ end
+
-- Step 1: get all sections
for i, conf in ipairs( schemes ) do
for k, v in pairs( conf ) do
"dependency specification in '%s'",
v.name or '<nil>', scheme or '<nil>', k
)
+ elseif k == "dynamic" or k == "unique" or k == "required" then
+ s[k] = _bool(v2)
else
s[k] = v2
end
end
end
+
+ s.dynamic = s.dynamic or false
+ s.unique = s.unique or false
+ s.required = s.required or false
end
end
end
local t = s[v.name]
- for k, v in pairs(v) do
+ for k, v2 in pairs(v) do
if k ~= "name" and k ~= "section" and k:sub(1,1) ~= "." then
if k:match("^depends") then
t["depends"] = _assert(
- self:_read_dependency( v, t["depends"] ),
- "Variable '%s' in scheme '%s' has malformed " ..
- "dependency specification in '%s'",
- v.name, scheme, k
+ self:_read_dependency( v2, t["depends"] ),
+ 'Invalid reference "%s" in "%s.%s.%s"',
+ v2, v.name, scheme, k
)
elseif k:match("^validator") then
t["validators"] = _assert(
- self:_read_validator( v, t["validators"] ),
+ self:_read_validator( v2, t["validators"] ),
"Variable '%s' in scheme '%s' has malformed " ..
"validator specification in '%s'",
v.name, scheme, k
)
+ elseif k == "required" then
+ t[k] = _bool(v2)
else
- t[k] = v
+ t[k] = v2
end
end
end
+
+ t.type = t.type or "variable"
+ t.datatype = t.datatype or "string"
+ t.required = t.required or false
end
end
end
-- Read a validator specification
function UVL._read_validator( self, value, validators )
- local validator
+ if value then
+ local validator
- if value and value:match("/") and self.datatypes.file(value) then
- validator = value
- else
- validator = self:_resolve_function( value )
- end
-
- if validator then
- if not validators then
- validators = { validator }
- else
- table.insert( validators, validator )
+ if value:match("^exec:") then
+ validator = value:gsub("^exec:","")
+ elseif value:match("^lua:") then
+ validator = self:_resolve_function( (value:gsub("^lua:","") ) )
end
- return validators
+ if validator then
+ if not validators then
+ validators = { validator }
+ else
+ table.insert( validators, validator )
+ end
+
+ return validators
+ end
end
end
end
+--- Object representation of a scheme/config section.
+-- @class module
+-- @cstyle instance
+-- @name luci.uvl.section
+
+--- Section instance constructor.
+-- @class function
+-- @name section
+-- @param scheme Scheme instance
+-- @param co Configuration data
+-- @param st Section type
+-- @param c Configuration name
+-- @param s Section name
+-- @return Section instance
section = luci.util.class()
function section.__init__(self, scheme, co, st, c, s)
self.type = luci.uvl.TYPE_SECTION
end
+--- Get the config path of this section.
+-- @return String containing the identifier
function section.cid(self)
return ( self.cref[1] or '?' ) .. '.' .. ( self.cref[2] or '?' )
end
+--- Get the scheme path of this section.
+-- @return String containing the identifier
function section.sid(self)
return ( self.sref[1] or '?' ) .. '.' .. ( self.sref[2] or '?' )
end
+--- Get all configuration values within this section.
+-- @return Table containing the values
function section.values(self)
return self.csection
end
+--- Get the associated section information in scheme.
+-- @return Table containing the scheme properties
function section.section(self)
return self.ssection
end
+--- Get all option objects associated with this section.
+-- @return Table containing all associated luci.uvl.option instances
function section.variables(self)
local v = { }
if self.scheme.packages[self.sref[1]].variables[self.sref[2]] then
end
+--- Object representation of a scheme/config option.
+-- @class module
+-- @cstyle instance
+-- @name luci.uvl.option
+
+--- Section instance constructor.
+-- @class function
+-- @name option
+-- @param scheme Scheme instance
+-- @param co Configuration data
+-- @param st Section type
+-- @param c Configuration name
+-- @param s Section name
+-- @param o Option name
+-- @return Option instance
option = luci.util.class()
function option.__init__(self, scheme, co, st, c, s, o)
self.type = luci.uvl.TYPE_OPTION
end
+--- Get the config path of this option.
+-- @return String containing the identifier
function option.cid(self)
return ( self.cref[1] or '?' ) .. '.' ..
( self.cref[2] or '?' ) .. '.' ..
( self.cref[3] or '?' )
end
+--- Get the scheme path of this option.
+-- @return String containing the identifier
function option.sid(self)
return ( self.sref[1] or '?' ) .. '.' ..
( self.sref[2] or '?' ) .. '.' ..
( self.sref[3] or '?' )
end
+--- Get the value of this option.
+-- @return The associated configuration value
function option.value(self)
return self.coption
end
+--- Get the associated option information in scheme.
+-- @return Table containing the scheme properties
function option.option(self)
return self.soption
end
+--- Get the associated section information in scheme.
+-- @return Table containing the scheme properties
function option.section(self)
return self.scheme.packages[self.sref[1]].sections[self.sref[2]]
end
projects / project / luci.git / blobdiff