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 "nixio.fs"
+local uci = require "luci.model.uci"
+local util = require "luci.util"
+local nutil = require "nixio.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, collectgarbage = unpack, loadfile, collectgarbage
+module "luci.uvl"
-TYPE_SCHEME = 0x00
-TYPE_CONFIG = 0x01
-TYPE_SECTION = 0x02
-TYPE_VARIABLE = 0x03
-TYPE_OPTION = 0x04
-TYPE_ENUM = 0x05
+local ERR = require "luci.uvl.errors".error
+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
+
+local PAT_EXPR1 = "^%$?[%w_]+$"
+local PAT_EXPR2 = "^%$?[%w_]+%.%$?[%w_]+$"
+local PAT_EXPR3 = "^%$?[%w_]+%.%$?[%w_]+%.%$?[%w_]+$"
--- 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)
for k, v in pairs(co:config()) do
local so = co:section(k)
if not self.beenthere[so:cid()] then
- co:error(ERR.SECT_UNKNOWN(so))
+ co:error(ERR('SECT_UNKNOWN', so))
end
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))
+ co:error(ERR('SECT_REQUIRED', so))
elseif so:scheme('unique') and sc[k] > 1 then
- co:error(ERR.SECT_UNIQUE(so))
+ co:error(ERR('SECT_UNIQUE', so))
end
end
-- @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 = { }
if so:config() then
return self:_validate_section( so )
else
- return false, ERR.SECT_NOTFOUND(so)
+ return false, ERR('SECT_NOTFOUND', so)
end
end
-- @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 )
if so:config() and oo:config() then
return self:_validate_option( oo )
else
- return false, ERR.OPT_NOTFOUND(oo)
+ return false, ERR('OPT_NOTFOUND', oo)
end
end
if section:scheme('named') == true and
section:config('.anonymous') == true
then
- return false, ERR.SECT_NAMED(section)
+ return false, ERR('SECT_NAMED', section)
end
for _, v in ipairs(section:variables()) do
local ok, err = self:_validate_option( v )
if not ok and (
v:scheme('required') or v:scheme('type') == "enum" or (
- not err:is(ERR.ERR_DEP_NOTEQUAL) and
- not err:is(ERR.ERR_DEP_NOVALUE)
+ not err:is('DEP_NOTEQUAL') and
+ not err:is('DEP_NOVALUE')
)
) then
section:error(err)
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
else
- return false, ERR.SECT_NOTFOUND(section)
+ return false, ERR('SECT_NOTFOUND', section)
end
if STRICT_UNKNOWN_OPTIONS and not section:scheme('dynamic') then
for k, v in pairs(section:config()) do
local oo = section:option(k)
- if k:sub(1,1) ~= "." and not self.beenthere[oo:cid()] then
- section:error(ERR.OPT_UNKNOWN(oo))
+ if k:byte(1) == 46 and not self.beenthere[oo:cid()] then
+ section:error(ERR('OPT_UNKNOWN', oo))
end
end
end
self.beenthere[option:cid()] = true
if not option:scheme() and not option:parent():scheme('dynamic') then
- return false, option:error(ERR.OPT_UNKNOWN(option))
+ if STRICT_UNKNOWN_OPTIONS then
+ return false, option:error(ERR('OPT_UNKNOWN', option))
+ else
+ return true
+ 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(
+ 'OPT_REQUIRED',
+ 'DEP_NOTEQUAL',
+ '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))
+ return false, option:error(ERR('OPT_REQUIRED', option))
elseif option:value() then
local val = option:value()
if option:scheme('type') == "reference" or
option:scheme('type') == "enum"
then
- if not option:scheme('values') or
- not option:scheme('values')[val]
- then
- return false, option:error( ERR.OPT_BADVALUE(
- option, luci.util.serialize_data(
- luci.util.keys(option:scheme('values') or {})
- )
- ) )
+ local scheme_values = option:scheme('values') or { }
+ local config_values = ( type(val) == "table" and val or { val } )
+ for _, v in ipairs(config_values) do
+ if not scheme_values[v] then
+ return false, option:error( ERR(
+ 'OPT_BADVALUE',
+ option, { v, util.serialize_data(
+ util.keys(scheme_values)
+ ) }
+ ) )
+ end
end
elseif option:scheme('type') == "list" then
if type(val) ~= "table" and STRICT_LIST_TYPE then
- return false, option:error(ERR.OPT_NOTLIST(option))
+ return false, option:error(ERR('OPT_NOTLIST', option))
end
- elseif option:scheme('datatype') then
+ end
+
+ if option:scheme('datatype') then
local dt = option:scheme('datatype')
if self.datatypes[dt] then
for i, v in ipairs(val) do
if not self.datatypes[dt]( v ) then
return false, option:error(
- ERR.OPT_INVVALUE(option, dt)
+ ERR('OPT_INVVALUE', option, { v, dt })
)
end
end
else
- return false, option:error(ERR.OPT_DATATYPE(option, dt))
+ 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
-function UVL.read_scheme( self, scheme )
+-- @param shm Name of the scheme to parse
+-- @param alias Create an alias for the loaded scheme
+function UVL.read_scheme( self, shm, alias )
- local so = luci.uvl.scheme( self, scheme )
+ local so = scheme( self, shm )
+ local bc = "%s/bytecode/%s.lua" %{ self.schemedir, shm }
- local schemes = { }
- local files = luci.fs.glob(self.schemedir .. '/*/' .. scheme)
+ if not fs.access(bc) then
+ local files = nutil.consume((fs.glob(self.schemedir .. '/*/' .. shm)))
- if files then
- for i, file in ipairs( files ) do
- if not luci.fs.access(file) then
- return so:error(ERR.SME_READ(so,file))
- end
+ if #files > 0 then
+ local ok, err
+ for _, file in ipairs(files) do
+ 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 sd, err = uci:get_all( luci.fs.basename(file) )
+ local sname = fs.basename(file)
+ local sd, err = uci:load( sname )
+
+ if not sd then
+ return false, ERR('UCILOAD', so, err)
+ end
- if not sd then
- return false, ERR.UCILOAD(so, err)
+ ok, err = pcall(function()
+ uci:foreach(sname, "package", function(s)
+ self:_parse_package(so, s[".name"], s)
+ end)
+ uci:foreach(sname, "section", function(s)
+ self:_parse_section(so, s[".name"], s)
+ end)
+ uci:foreach(sname, "variable", function(s)
+ self:_parse_var(so, s[".name"], s)
+ end)
+ uci:foreach(sname, "enum", function(s)
+ self:_parse_enum(so, s[".name"], s)
+ end)
+
+ end)
end
- table.insert( schemes, sd )
+ 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))
end
-
- return self:_read_scheme_parts( so, schemes )
else
- return false, so:error(ERR.SME_FIND(so, self.schemedir))
+ local sc = loadfile(bc)
+ if sc then
+ self.packages[shm] = sc()
+ return true
+ else
+ return false, so:error(ERR('SME_READ',so,bc))
+ end
end
end
--- Process all given parts and construct validation tree
-function UVL._read_scheme_parts( self, scheme, schemes )
-
- -- helper function to check for required fields
- local function _req( c, t, r )
- for i, v in ipairs(r) do
- if not t[v] then
- return false, ERR.SME_REQFLD({c,t}, v)
+-- helper function to check for required fields
+local function _req( t, n, c, r )
+ for i, v in ipairs(r) do
+ if not c[v] then
+ local p, o = scheme:sid(), nil
+
+ if t == TYPE_SECTION then
+ o = section( scheme, nil, p, n )
+ elseif t == TYPE_OPTION then
+ o = option( scheme, nil, p, '(nil)', n )
+ elseif t == TYPE_ENUM then
+ o = enum( scheme, nil, p, '(nil)', '(nil)', n )
end
- end
- return true
- end
- -- helper function to validate references
- local function _ref( c, t )
- local k, n
- if c == TYPE_SECTION then
- k = "package"
- n = 1
- elseif c == TYPE_VARIABLE then
- k = "section"
- n = 2
- elseif c == TYPE_ENUM then
- k = "variable"
- n = 3
+ return false, ERR('SME_REQFLD',o,v)
end
+ end
+ return true
+end
- local r = luci.util.split( t[k], "." )
- r[1] = ( #r[1] > 0 and r[1] or scheme:sid() )
-
- if #r ~= n then
- return false, ERR.SME_BADREF(scheme, k)
- end
+-- helper function to validate references
+local function _ref( c, t )
+ local r, k, n = {}
+ if c == TYPE_SECTION then
+ k = "package"
+ n = 1
+ elseif c == TYPE_OPTION then
+ k = "section"
+ n = 2
+ elseif c == TYPE_ENUM then
+ k = "variable"
+ n = 3
+ end
- return r
+ for o in t[k]:gmatch("[^.]+") do
+ r[#r+1] = o
end
+ r[1] = ( #r[1] > 0 and r[1] or scheme:sid() )
- -- helper function to read bools
- local function _bool( v )
- return ( v == "true" or v == "yes" or v == "on" or v == "1" )
+ if #r ~= n then
+ return false, ERR('SME_BADREF', scheme, k)
end
+ return r
+end
- local ok, err
-
- -- Step 1: get all sections
- for i, conf in ipairs( schemes ) do
- for k, v in pairs( conf ) do
- if v['.type'] == 'section' then
-
- ok, err = _req( TYPE_SECTION, v, { "name", "package" } )
- if err then return false, scheme:error(err) end
-
- local r, err = _ref( TYPE_SECTION, v )
- if err then return false, scheme:error(err) end
-
- self.packages[r[1]] =
- self.packages[r[1]] or {
- ["name"] = r[1];
- ["sections"] = { };
- ["variables"] = { };
- }
-
- local p = self.packages[r[1]]
- p.sections[v.name] = p.sections[v.name] or { }
- p.variables[v.name] = p.variables[v.name] or { }
-
- local s = p.sections[v.name]
- local so = scheme:section(v.name)
-
- for k, v2 in pairs(v) do
- if k ~= "name" and k ~= "package" and k:sub(1,1) ~= "." then
- if k == "depends" 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))
- )
- end
- elseif k == "dynamic" or k == "unique" or
- k == "required" or k == "named"
- then
- s[k] = _bool(v2)
- else
- s[k] = v2
- end
- end
- end
+-- helper function to read bools
+local function _bool( v )
+ return ( v == "true" or v == "yes" or v == "on" or v == "1" )
+end
+
+-- Step 0: get package meta information
+function UVL._parse_package(self, scheme, k, v)
+ local sid = scheme:sid()
+ local pkg = self.packages[sid] or {
+ ["name"] = sid;
+ ["sections"] = { };
+ ["variables"] = { };
+ }
- s.dynamic = s.dynamic or false
- s.unique = s.unique or false
- s.required = s.required or false
- s.named = s.named or false
+ pkg.title = v.title
+ pkg.description = v.description
+
+ self.packages[sid] = pkg
+end
+
+-- Step 1: get all sections
+function UVL._parse_section(self, scheme, k, v)
+ local ok, err = _req( TYPE_SECTION, k, v, { "name", "package" } )
+ if err then error(scheme:error(err)) end
+
+ local r, err = _ref( TYPE_SECTION, v )
+ if err then error(scheme:error(err)) end
+
+ local p = self.packages[r[1]] or {
+ ["name"] = r[1];
+ ["sections"] = { };
+ ["variables"] = { };
+ }
+ p.sections[v.name] = p.sections[v.name] or { }
+ p.variables[v.name] = p.variables[v.name] or { }
+ self.packages[r[1]] = p
+
+ local s = p.sections[v.name]
+ local so = scheme:section(v.name)
+
+ for k, v2 in pairs(v) do
+ if k ~= "name" and k ~= "package" and k:byte(1) == 46 then
+ if k == "depends" then
+ s.depends = self:_read_dependency( v2, s.depends )
+ if not s.depends then
+ return false, scheme:error(
+ ERR('SME_BADDEP', so, util.serialize_data(s.depends))
+ )
+ end
+ elseif k == "dynamic" or k == "unique" or
+ k == "required" or k == "named"
+ then
+ s[k] = _bool(v2)
+ else
+ s[k] = v2
end
end
end
- -- Step 2: get all variables
- for i, conf in ipairs( schemes ) do
- for k, v in pairs( conf ) do
- if v['.type'] == "variable" then
+ s.dynamic = s.dynamic or false
+ s.unique = s.unique or false
+ s.required = s.required or false
+ s.named = s.named or false
+end
- ok, err = _req( TYPE_VARIABLE, v, { "name", "section" } )
- if err then return false, scheme:error(err) end
+-- 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
- local r, err = _ref( TYPE_VARIABLE, v )
- if err then return false, scheme:error(err) end
+ local r, err = _ref( TYPE_OPTION, v )
+ if err then error(scheme:error(err)) end
- local p = self.packages[r[1]]
- if not p then
- return false, scheme:error(
- ERR.SME_VBADPACK({scheme:sid(), '', v.name}, r[1])
- )
- end
+ local p = self.packages[r[1]]
+ if not p then
+ error(scheme:error(
+ ERR('SME_VBADPACK', {scheme:sid(), '', v.name}, r[1])
+ ))
+ end
- local s = p.variables[r[2]]
- if not s then
- return false, scheme:error(
- ERR.SME_VBADSECT({scheme:sid(), '', v.name}, r[2])
- )
- end
+ local s = p.variables[r[2]]
+ if not s then
+ error(scheme:error(
+ ERR('SME_VBADSECT', {scheme:sid(), '', v.name}, r[2])
+ ))
+ end
- s[v.name] = s[v.name] or { }
-
- local t = s[v.name]
- local so = scheme:section(r[2])
- local to = so:option(v.name)
-
- for k, v2 in pairs(v) do
- if k ~= "name" and k ~= "section" and k:sub(1,1) ~= "." then
- if k == "depends" then
- t.depends = self:_read_dependency( v2, t.depends )
- if not t.depends then
- return false, scheme:error(so:error(
- ERR.SME_BADDEP(to, luci.util.serialize_data(v2))
- ))
- end
- elseif k == "validator" then
- t.validators = self:_read_validator( v2, t.validators )
- if not t.validators then
- return false, scheme:error(so:error(
- ERR.SME_BADVAL(to, luci.util.serialize_data(v2))
- ))
- end
- elseif k == "valueof" then
- local values, err = self:_read_reference( v2 )
- if err then
- return false, scheme:error(so:error(
- ERR.REFERENCE(to, luci.util.serialize_data(v2)):child(err)
- ))
- end
- t.type = "reference"
- t.values = values
- elseif k == "required" then
- t[k] = _bool(v2)
- else
- t[k] = t[k] or v2
- end
- end
- end
+ s[v.name] = s[v.name] or { }
+
+ local t = s[v.name]
+ local so = scheme:section(r[2])
+ local to = so:option(v.name)
- t.type = t.type or "variable"
- t.datatype = t.datatype or "string"
- t.required = t.required or false
+ for k, v2 in pairs(v) do
+ if k ~= "name" and k ~= "section" and k:byte(1) == 46 then
+ if k == "depends" then
+ t.depends = self:_read_dependency( v2, t.depends )
+ if not t.depends then
+ error(scheme:error(so:error(
+ 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, 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, 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
end
end
- -- Step 3: get all enums
- for i, conf in ipairs( schemes ) do
- for k, v in pairs( conf ) do
- if v['.type'] == "enum" then
+ t.type = t.type or "variable"
+ t.datatype = t.datatype or "string"
+ t.required = t.required or false
+end
- ok, err = _req( TYPE_ENUM, v, { "value", "variable" } )
- if err then return false, scheme:error(err) end
+-- Step 3: get all enums
+function UVL._parse_enum(self, scheme, k, v)
+ local ok, err = _req( TYPE_ENUM, k, v, { "value", "variable" } )
+ if err then error(scheme:error(err)) end
- local r, err = _ref( TYPE_ENUM, v )
- if err then return false, scheme:error(err) end
+ local r, err = _ref( TYPE_ENUM, v )
+ if err then error(scheme:error(err)) end
- local p = self.packages[r[1]]
- if not p then
- return false, scheme:error(
- ERR.SME_EBADPACK({scheme:sid(), '', '', v.value}, r[1])
- )
- end
+ local p = self.packages[r[1]]
+ if not p then
+ error(scheme:error(
+ ERR('SME_EBADPACK', {scheme:sid(), '', '', v.value}, r[1])
+ ))
+ end
- local s = p.variables[r[2]]
- if not s then
- return false, scheme:error(
- ERR.SME_EBADSECT({scheme:sid(), '', '', v.value}, r[2])
- )
- end
+ local s = p.variables[r[2]]
+ if not s then
+ error(scheme:error(
+ ERR('SME_EBADSECT', {scheme:sid(), '', '', v.value}, r[2])
+ ))
+ end
- local t = s[r[3]]
- if not t then
- return false, scheme:error(
- ERR.SME_EBADOPT({scheme:sid(), '', '', v.value}, r[3])
- )
- end
+ local t = s[r[3]]
+ if not t then
+ error(scheme:error(
+ ERR('SME_EBADOPT', {scheme:sid(), '', '', v.value}, r[3])
+ ))
+ end
- local so = scheme:section(r[2])
- local oo = so:option(r[3])
- local eo = oo:enum(v.value)
+ local so = scheme:section(r[2])
+ local oo = so:option(r[3])
+ local eo = oo:enum(v.value)
- if t.type ~= "enum" then
- return false, scheme:error(ERR.SME_EBADTYPE(eo))
- end
+ if t.type ~= "enum" and t.type ~= "reference" then
+ error(scheme:error(ERR('SME_EBADTYPE', eo)))
+ end
- if not t.values then
- t.values = { [v.value] = v.title or v.value }
- else
- t.values[v.value] = v.title or v.value
- 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
- t.enum_depends = { }
- end
+ if not t.enum_depends then
+ t.enum_depends = { }
+ end
- if v.default then
- if t.default then
- return false, scheme:error(ERR.SME_EBADDEF(eo))
- end
- t.default = v.value
- end
+ if v.default then
+ if t.default then
+ error(scheme:error(ERR('SME_EBADDEF', eo)))
+ end
+ t.default = v.value
+ end
- if v.depends then
- t.enum_depends[v.value] = self:_read_dependency(
- v.depends, t.enum_depends[v.value]
- )
+ if v.depends then
+ t.enum_depends[v.value] = self:_read_dependency(
+ v.depends, t.enum_depends[v.value]
+ )
- if not t.enum_depends[v.value] then
- return false, scheme:error(so:error(oo:error(
- ERR.SME_BADDEP(eo, luci.util.serialize_data(v.depends))
- )))
- end
- end
- end
+ if not t.enum_depends[v.value] then
+ error(scheme:error(so:error(oo:error(
+ ERR('SME_BADDEP', eo, util.serialize_data(v.depends))
+ ))))
end
end
-
- return self
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.."$")
+ k:match(PAT_EXPR1) or k:match(PAT_EXPR2) or k:match(PAT_EXPR3)
) 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
validator = value:gsub("^exec:","")
elseif value:match("^lua:") then
validator = self:_resolve_function( (value:gsub("^lua:","") ) )
+ elseif value:match("^regexp:") then
+ local pattern = value:gsub("^regexp:","")
+ validator = function( type, dtype, pack, sect, optn, arg1, arg2, arg3, arg4, arg5 )
+ local values = { arg1, arg2, arg3, arg4, arg5 }
+ for _, v in ipairs(values) do
+ local ok, match =
+ pcall( string.match, v, pattern )
+
+ if not ok then
+ return false, match
+ elseif not match then
+ return false,
+ 'Value "%s" does not match pattern "%s"' % {
+ v, pattern
+ }
+ end
+ end
+ return true
+ end
end
if validator then
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
if v['.type'] == ref[2] then
if #ref == 2 then
if v['.anonymous'] == true then
- return false, ERR.SME_INVREF('', value)
+ return false, ERR('SME_INVREF', '', value)
end
val[k] = k -- XXX: title/description would be nice
elseif v[ref[3]] then
end
end
else
- return false, ERR.SME_BADREF('', value)
+ return false, ERR('SME_BADREF', '', value)
end
end
-- 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)
- return table.concat( self.cref, '.' )
+ if #self.cref == 1 then
+ return self.cref[1]
+ else
+ local r = { unpack(self.cref) }
+ 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']) .. ']'
+ end
+ return table.concat( r, '.' )
+ end
end
function uvlitem.sid(self)
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
- .packages[self.sref[1]]
- .variables[self.sref[2]][self.sref[3]]
+ 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
- .packages[self.sref[1]]
- .sections[self.sref[2]]
- else
- s = self.s
- .packages[self.sref[1]]
+ s = s and s.sections
+ s = s and s[self.sref[2]]
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
-function uvlitem.error(self, ...)
+function uvlitem.error(self, arg1, arg2, arg3, arg4, arg5)
if not self.e then
- local errconst = { ERR.CONFIG, ERR.SECTION, ERR.OPTION, ERR.OPTION }
- self.e = errconst[#self.cref]( self )
+ local errconst = { 'CONFIG', 'SECTION', 'OPTION', 'OPTION' }
+ self.e = ERR( errconst[#self.cref], self )
end
- return self.e:child( ... )
+ return self.e:child( arg1, arg2, arg3, arg4, arg5 )
end
function uvlitem.errors(self)
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))
+ 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.
-- @return Scheme error context
-function scheme.error(self, ...)
- if not self.e then self.e = ERR.SCHEME( self ) end
- return self.e:child( ... )
+function scheme.error(self, arg1, arg2, arg3, arg4, arg5)
+ if not self.e then self.e = ERR( 'SCHEME', self ) end
+ return self.e:child( arg1, arg2, arg3, arg4, arg5 )
end
--- 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.
-- @return The associated configuration value
function option.value(self)
- return self:config()
+ local v = self:config() or self:scheme('default')
+ if v and self:scheme('multival') then
+ v = util.split( v, "%s+", nil, true )
+ end
+ return v
end
--- Get the associated section information in scheme.
-- @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