]]--
+
+--- UVL - UCI Validation Layer
+-- @class module
+-- @cstyle instance
+
module( "luci.uvl", package.seeall )
require("luci.fs")
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 )
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
+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.load_config( config )
self.beenthere = { }
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 )
+
+ 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 = { }
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 )
+
+ 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 = { }
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
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
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
end
end
end
+
+ s.dynamic = s.dynamic or false
+ s.unique = s.unique or false
+ s.required = s.required or false
end
end
end
end
t.type = t.type or "variable"
+ t.datatype = t.datatype or "string"
t.required = t.required or false
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