you may not use this file except in compliance with the License.
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
$Id$
-- @class module
-- @cstyle instance
-module( "luci.uvl", package.seeall )
+local fs = require "luci.fs"
+local uci = require "luci.model.uci"
+local util = require "luci.util"
+local table = require "table"
+local string = require "string"
-require("luci.fs")
-require("luci.util")
-require("luci.model.uci")
-require("luci.uvl.errors")
-require("luci.uvl.datatypes")
-require("luci.uvl.validation")
-require("luci.uvl.dependencies")
+local require, pcall, ipairs, pairs = require, pcall, ipairs, pairs
+local type, error, tonumber, tostring = type, error, tonumber, tostring
+local unpack, loadfile = unpack, loadfile
+module "luci.uvl"
-TYPE_SCHEME = 0x00
-TYPE_CONFIG = 0x01
-TYPE_SECTION = 0x02
-TYPE_OPTION = 0x03
-TYPE_ENUM = 0x04
+local ERR = require "luci.uvl.errors"
+local datatypes = require "luci.uvl.datatypes"
+local validation = require "luci.uvl.validation"
+local dependencies = require "luci.uvl.dependencies"
+
+local TYPE_SCHEME = 0x00
+local TYPE_CONFIG = 0x01
+local TYPE_SECTION = 0x02
+local TYPE_OPTION = 0x03
+local TYPE_ENUM = 0x04
--- Boolean; default true;
-- treat sections found in config but not in scheme as error
local default_schemedir = "/lib/uci/schema"
local default_savedir = "/tmp/.uvl"
-local ERR = luci.uvl.errors
--- Object constructor
-- @class function
-- @name UVL
-- @param schemedir Path to the scheme directory (optional)
+-- @param configdir Override config directory (optional)
-- @return Instance object
-UVL = luci.util.class()
+UVL = util.class()
-function UVL.__init__( self, schemedir )
+function UVL.__init__( self, schemedir, configdir )
self.schemedir = schemedir or default_schemedir
+ self.configdir = configdir
self.packages = { }
self.beenthere = { }
self.depseen = { }
- self.uci = luci.model.uci
- self.err = luci.uvl.errors
- self.dep = luci.uvl.dependencies
- self.datatypes = luci.uvl.datatypes
+ self.uci = uci
+ self.err = ERR
+ self.dep = dependencies
+ self.datatypes = datatypes
end
end
--- Validate given configuration.
--- @param config Name of the configuration to validate
+-- @param cfg Name of the configuration to validate
-- @return Boolean indicating whether the given config validates
-- @return String containing the reason for errors (if any)
-function UVL.validate_config( self, config, uci )
+function UVL.validate_config( self, cfg, uci )
- if not self.packages[config] then
- local ok, err = self:read_scheme(config)
+ if not self.packages[cfg] then
+ local ok, err = self:read_scheme(cfg)
if not ok then
return false, err
end
end
- local co = luci.uvl.config( self, uci or config, uci and config )
+ local co = config( self, uci or cfg, uci and cfg )
local sc = { }
self.beenthere = { }
end
end
- for k, v in pairs( self.packages[config].sections ) do
+ for k, v in pairs( self.packages[cfg].sections ) do
sc[k] = 0
_uci_foreach( k,
function(s)
end
end
- for _, k in ipairs(luci.util.keys(sc)) do
+ for _, k in ipairs(util.keys(sc)) do
local so = co:section(k)
if so:scheme('required') and sc[k] == 0 then
co:error(ERR.SECT_REQUIRED(so))
-- @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, uci )
+function UVL.validate_section( self, cfg, section, uci )
- if not self.packages[config] then
- local ok, err = self:read_scheme( config )
+ if not self.packages[cfg] then
+ local ok, err = self:read_scheme( cfg )
if not ok then
return false, err
end
end
- local co = luci.uvl.config( self, uci or config, uci and config )
+ local co = config( self, uci or cfg, uci and cfg )
local so = co:section( section )
self.beenthere = { }
-- @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, uci )
+function UVL.validate_option( self, cfg, section, option, uci )
- if not self.packages[config] then
- local ok, err = self:read_scheme( config )
+ if not self.packages[cfg] then
+ local ok, err = self:read_scheme( cfg )
if not ok then
return false, err
end
end
- local co = luci.uvl.config( self, uci or config, uci and config )
+ local co = config( self, uci or cfg, uci and cfg )
local so = co:section( section )
local oo = so:option( option )
end
end
- local ok, err = luci.uvl.dependencies.check( self, section )
+ local ok, err = dependencies.check( self, section )
if not ok then
section:error(err)
end
end
elseif option:scheme() then
+ if not nodeps then
+ local ok, err = dependencies.check( self, option )
+ if not ok then
+ if not err:is_all(
+ ERR.ERR_OPT_REQUIRED,
+ ERR.ERR_DEP_NOTEQUAL,
+ ERR.ERR_DEP_NOVALUE
+ ) then
+ option:error(err)
+ return false, option:errors()
+ else
+ return true
+ end
+ end
+ end
+
if option:scheme('required') and not option:value() then
return false, option:error(ERR.OPT_REQUIRED(option))
for _, v in ipairs(config_values) do
if not scheme_values[v] then
return false, option:error( ERR.OPT_BADVALUE(
- option, { v, luci.util.serialize_data(
- luci.util.keys(scheme_values)
+ option, { v, util.serialize_data(
+ util.keys(scheme_values)
) }
) )
end
return false, option:error(ERR.OPT_DATATYPE(option, dt))
end
end
- end
- if not nodeps then
- local ok, err = luci.uvl.dependencies.check( self, option )
- if not ok then
- option:error(err)
+ val = ( type(val) == "table" and val or { val } )
+ for _, v in ipairs(val) do
+ if option:scheme('minlength') then
+ if #v < option:scheme('minlength') then
+ return false, option:error(ERR.OPT_RANGE(option))
+ end
+ end
+
+ if option:scheme('maxlength') then
+ if #v > option:scheme('maxlength') then
+ return false, option:error(ERR.OPT_RANGE(option))
+ end
+ end
+
+ local w = tonumber(v)
+
+ if option:scheme('minimum') then
+ if not w or w < option:scheme('minimum') then
+ return false, option:error(ERR.OPT_RANGE(option))
+ end
+ end
+
+ if option:scheme('maximum') then
+ if not w or w > option:scheme('maximum') then
+ return false, option:error(ERR.OPT_RANGE(option))
+ end
+ end
end
end
- local ok, err = luci.uvl.validation.check( self, option )
+ local ok, err = validation.check( self, option )
if not ok and STRICT_EXTERNAL_VALIDATORS then
return false, option:error(err)
end
--- 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
+-- @param shm Name of the scheme to parse
-- @param alias Create an alias for the loaded scheme
-function UVL.read_scheme( self, scheme, alias )
+function UVL.read_scheme( self, shm, alias )
- local so = luci.uvl.scheme( self, scheme )
- local bc = "%s/bytecode/%s.lua" %{ self.schemedir, scheme }
+ local so = scheme( self, shm )
+ local bc = "%s/bytecode/%s.lua" %{ self.schemedir, shm }
- if not luci.fs.access(bc) then
- local schemes = { }
- local files = luci.fs.glob(self.schemedir .. '/*/' .. scheme)
+ if not fs.access(bc) then
+ local files = fs.glob(self.schemedir .. '/*/' .. shm)
if files then
local ok, err
for i, file in ipairs( files ) do
- if not luci.fs.access(file) then
+ if not fs.access(file) then
return false, so:error(ERR.SME_READ(so,file))
end
- local uci = luci.model.uci.cursor( luci.fs.dirname(file), default_savedir )
+ local uci = uci.cursor( fs.dirname(file), default_savedir )
- local sname = luci.fs.basename(file)
+ local sname = fs.basename(file)
local sd, err = uci:load( sname )
if not sd then
end)
end
- if ok and alias then self.packages[alias] = self.packages[scheme] end
+ if ok and alias then self.packages[alias] = self.packages[shm] end
return ok and self, err
else
return false, so:error(ERR.SME_FIND(so, self.schemedir))
else
local sc = loadfile(bc)
if sc then
- self.packages[scheme] = sc()
+ self.packages[shm] = sc()
return true
else
return false, so:error(ERR.SME_READ(so,bc))
-- helper function to validate references
local function _ref( c, t )
- local k, n
+ local r, k, n = {}
if c == TYPE_SECTION then
k = "package"
n = 1
n = 3
end
- local r = luci.util.split( t[k], "." )
+ for o in t[k]:gmatch("[^.]+") do
+ r[#r+1] = o
+ end
r[1] = ( #r[1] > 0 and r[1] or scheme:sid() )
if #r ~= n then
s.depends = self:_read_dependency( v2, s.depends )
if not s.depends then
return false, scheme:error(
- ERR.SME_BADDEP(so, luci.util.serialize_data(s.depends))
+ ERR.SME_BADDEP(so, util.serialize_data(s.depends))
)
end
elseif k == "dynamic" or k == "unique" or
s.named = s.named or false
end
-
- -- Step 2: get all variables
+-- Step 2: get all variables
function UVL._parse_var(self, scheme, k, v)
local ok, err = _req( TYPE_OPTION, k, v, { "name", "section" } )
if err then error(scheme:error(err)) end
t.depends = self:_read_dependency( v2, t.depends )
if not t.depends then
error(scheme:error(so:error(
- ERR.SME_BADDEP(to, luci.util.serialize_data(v2))
+ ERR.SME_BADDEP(to, util.serialize_data(v2))
)))
end
elseif k == "validator" then
t.validators = self:_read_validator( v2, t.validators )
if not t.validators then
error(scheme:error(so:error(
- ERR.SME_BADVAL(to, luci.util.serialize_data(v2))
+ ERR.SME_BADVAL(to, util.serialize_data(v2))
)))
end
elseif k == "valueof" then
local values, err = self:_read_reference( v2 )
if err then
error(scheme:error(so:error(
- ERR.REFERENCE(to, luci.util.serialize_data(v2)):child(err)
+ ERR.REFERENCE(to, util.serialize_data(v2)):child(err)
)))
end
t.type = "reference"
t.values = values
+ t.valueof = type(v2) == "table" and v2 or {v2}
elseif k == "required" then
t[k] = _bool(v2)
+ elseif k == "minlength" or k == "maxlength" or
+ k == "minimum" or k == "maximum"
+ then
+ t[k] = tonumber(v2)
else
t[k] = t[k] or v2
end
if not t.values then
t.values = { [v.value] = v.title or v.value }
+ t.valuelist = { {value = v.value, title = v.title} }
else
t.values[v.value] = v.title or v.value
+ t.valuelist[#t.valuelist + 1] = {value = v.value, title = v.title}
end
if not t.enum_depends then
if not t.enum_depends[v.value] then
error(scheme:error(so:error(oo:error(
- ERR.SME_BADDEP(eo, luci.util.serialize_data(v.depends))
+ ERR.SME_BADDEP(eo, util.serialize_data(v.depends))
))))
end
end
-- Read a dependency specification
function UVL._read_dependency( self, values, deps )
- local expr = "%$?[a-zA-Z0-9_]+"
+ local expr = "%$?[%w_]+"
if values then
values = ( type(values) == "table" and values or { values } )
for _, value in ipairs(values) do
- local parts = luci.util.split( value, "%s*,%s*", nil, true )
local condition = { }
- for i, val in ipairs(parts) do
- local k, v = unpack(luci.util.split(val, "%s*=%s*", nil, true))
+ for val in value:gmatch("[^,]+") do
+ local k, e, v = val:match("%s*([%w$_.]+)%s*(=?)%s*(.*)")
if k and (
k:match("^"..expr.."%."..expr.."%."..expr.."$") or
k:match("^"..expr.."%."..expr.."$") or
k:match("^"..expr.."$")
) then
- condition[k] = v or true
+ condition[k] = (e == '=') and v or true
else
return nil
end
if not deps then
deps = { condition }
else
- table.insert( deps, condition )
+ deps[#deps+1] = condition
end
end
end
local values = { ... }
for _, v in ipairs(values) do
local ok, match =
- luci.util.copcall( string.match, v, pattern )
+ pcall( string.match, v, pattern )
if not ok then
return false, match
if not validators then
validators = { validator }
else
- table.insert( validators, validator )
+ validators[#validators+1] = validator
end
else
return nil
values = ( type(values) == "table" and values or { values } )
for _, value in ipairs(values) do
- local ref = luci.util.split(value, ".")
+ local ref = util.split(value, ".")
if #ref == 2 or #ref == 3 then
- local co = luci.uvl.config( self, ref[1] )
+ local co = config( self, ref[1] )
if not co:config() then return false, co:errors() end
for k, v in pairs(co:config()) do
-- Resolve given path
function UVL._resolve_function( self, value )
- local path = luci.util.split(value, ".")
+ local path = util.split(value, ".")
for i=1, #path-1 do
- local stat, mod = luci.util.copcall(
+ local stat, mod = pcall(
require, table.concat(path, ".", 1, i)
)
--- Object representation of an uvl item - base class.
-uvlitem = luci.util.class()
+uvlitem = util.class()
function uvlitem.cid(self)
if #self.cref == 1 then
local c = self.c
if c and c[r[2]] and c[r[2]]['.anonymous'] and c[r[2]]['.index'] then
r[2] = '@' .. c[r[2]]['.type'] ..
- '[' .. tostring(c[r[2]]['.index']) .. ']'
+ '[' .. tostring(c[r[2]]['.index']) .. ']'
end
return table.concat( r, '.' )
end
end
function uvlitem.scheme(self, opt)
- local s
-
+ local s = self.s and self.s.packages
+ s = s and s[self.sref[1]]
if #self.sref == 4 or #self.sref == 3 then
- s = self.s and self.s.packages
- s = s and s[self.sref[1]]
s = s and s.variables
s = s and s[self.sref[2]]
s = s and s[self.sref[3]]
elseif #self.sref == 2 then
- s = self.s and self.s.packages
- s = s and s[self.sref[1]]
s = s and s.sections
s = s and s[self.sref[2]]
- else
- s = self.s and self.s.packages
- s = s and s[self.sref[1]]
end
if s and opt then
end
function uvlitem.config(self, opt)
- local c
+ local c = self.c
- if #self.cref == 4 or #self.cref == 3 then
- c = self.c and self.c[self.cref[2]] or nil
- c = c and c[self.cref[3]] or nil
- elseif #self.cref == 2 then
- c = self.c and self.c[self.cref[2]] or nil
- else
- c = self.c
+ if #self.cref >= 2 and #self.cref <= 4 then
+ c = c and self.c[self.cref[2]] or nil
+ if #self.cref >= 3 then
+ c = c and c[self.cref[3]] or nil
+ end
end
if c and opt then
end
function uvlitem.type(self)
- if self.t == luci.uvl.TYPE_CONFIG then
+ if self.t == TYPE_CONFIG then
return 'config'
- elseif self.t == luci.uvl.TYPE_SECTION then
+ elseif self.t == TYPE_SECTION then
return 'section'
- elseif self.t == luci.uvl.TYPE_OPTION then
+ elseif self.t == TYPE_OPTION then
return 'option'
- elseif self.t == luci.uvl.TYPE_ENUM then
+ elseif self.t == TYPE_ENUM then
return 'enum'
end
end
if self.p then
return self.p
elseif #self.cref == 3 or #self.cref == 4 then
- return luci.uvl.section( self.s, self.c, self.cref[1], self.cref[2] )
+ return section( self.s, self.c, self.cref[1], self.cref[2] )
elseif #self.cref == 2 then
- return luci.uvl.config( self.s, self.c, self.cref[1] )
+ return config( self.s, self.c, self.cref[1] )
else
return nil
end
end
-function uvlitem._loadconf(self, co, c)
+function uvlitem._loadconf(self, co, c, configdir)
+ co = co or self._configcache
if not co then
- local uci, err = luci.model.uci.cursor(), nil
- co, err = uci:get_all(c)
+ local err
+ co, err = uci.cursor(configdir):get_all(c)
if err then
self:error(ERR.UCILOAD(self, err))
end
+
+ self._configcache = co
end
return co
end
-- @param co Configuration data
-- @param c Configuration name
-- @return Config instance
-scheme = luci.util.class(uvlitem)
+scheme = util.class(uvlitem)
function scheme.__init__(self, scheme, co, c)
if not c then
self.cref = { c }
self.sref = { c }
- self.c = self:_loadconf(co, c)
+ self.c = self:_loadconf(co, c, scheme.configdir)
self.s = scheme
- self.t = luci.uvl.TYPE_SCHEME
+ self.t = TYPE_SCHEME
end
--- Add an error to scheme.
--- Get an associated config object.
-- @return Config instance
function scheme.config(self)
- local co = luci.uvl.config( self.s, self.cref[1] )
+ local co = config( self.s, self.cref[1] )
co.p = self
return co
local v = { }
if self.s.packages[self.sref[1]].sections then
for o, _ in pairs( self.s.packages[self.sref[1]].sections ) do
- table.insert( v, luci.uvl.option(
+ v[#v+1] = option(
self.s, self.c, self.cref[1], self.cref[2], o
- ) )
+ )
end
end
return v
-- @param s Section to select
-- @return Section instance
function scheme.section(self, s)
- local so = luci.uvl.section( self.s, self.c, self.cref[1], s )
+ local so = section( self.s, self.c, self.cref[1], s )
so.p = self
return so
-- @param co Configuration data
-- @param c Configuration name
-- @return Config instance
-config = luci.util.class(uvlitem)
+config = util.class(uvlitem)
function config.__init__(self, scheme, co, c)
if not c then
c, co = co, nil
end
-
self.cref = { c }
self.sref = { c }
- self.c = self:_loadconf(co, c)
+ self.c = self:_loadconf(co, c, scheme.configdir)
self.s = scheme
- self.t = luci.uvl.TYPE_CONFIG
+ self.t = TYPE_CONFIG
end
--- Get all section objects associated with this config.
local v = { }
if self.s.packages[self.sref[1]].sections then
for o, _ in pairs( self.s.packages[self.sref[1]].sections ) do
- table.insert( v, luci.uvl.option(
+ v[#v+1] = option(
self.s, self.c, self.cref[1], self.cref[2], o
- ) )
+ )
end
end
return v
-- @param s Section to select
-- @return Section instance
function config.section(self, s)
- local so = luci.uvl.section( self.s, self.c, self.cref[1], s )
+ local so = section( self.s, self.c, self.cref[1], s )
so.p = self
return so
-- @param c Configuration name
-- @param s Section name
-- @return Section instance
-section = luci.util.class(uvlitem)
+section = util.class(uvlitem)
function section.__init__(self, scheme, co, c, s)
self.cref = { c, s }
self.sref = { c, co and co[s] and co[s]['.type'] or s }
- self.c = self:_loadconf(co, c)
+ self.c = self:_loadconf(co, c, scheme.configdir)
self.s = scheme
- self.t = luci.uvl.TYPE_SECTION
+ self.t = TYPE_SECTION
end
--- Get all option objects associated with this section.
for o, _ in pairs(
self.s.packages[self.sref[1]].variables[self.sref[2]]
) do
- table.insert( v, luci.uvl.option(
+ v[#v+1] = option(
self.s, self.c, self.cref[1], self.cref[2], o
- ) )
+ )
end
end
return v
-- @param o Option to select
-- @return Option instance
function section.option(self, o)
- local oo = luci.uvl.option( self.s, self.c, self.cref[1], self.cref[2], o )
+ local oo = option( self.s, self.c, self.cref[1], self.cref[2], o )
oo.p = self
return oo
-- @param s Section name
-- @param o Option name
-- @return Option instance
-option = luci.util.class(uvlitem)
+option = util.class(uvlitem)
function option.__init__(self, scheme, co, c, s, o)
self.cref = { c, s, o }
self.sref = { c, co and co[s] and co[s]['.type'] or s, o }
- self.c = self:_loadconf(co, c)
+ self.c = self:_loadconf(co, c, scheme.configdir)
self.s = scheme
- self.t = luci.uvl.TYPE_OPTION
+ self.t = TYPE_OPTION
end
--- Get the value of this option.
function option.value(self)
local v = self:config() or self:scheme('default')
if v and self:scheme('multival') then
- v = luci.util.split( v, "%s+", nil, true )
+ v = util.split( v, "%s+", nil, true )
end
return v
end
-- @param o Enum name
-- @param v Enum value
-- @return Enum value instance
-enum = luci.util.class(option)
+enum = util.class(option)
function enum.__init__(self, scheme, co, c, s, o, v)
self.cref = { c, s, o, v }
self.sref = { c, co and co[s] and co[s]['.type'] or s, o, v }
- self.c = self:_loadconf(co, c)
+ self.c = self:_loadconf(co, c, scheme.configdir)
self.s = scheme
- self.t = luci.uvl.TYPE_ENUM
+ self.t = TYPE_ENUM
end
projects / project / luci.git / blobdiff