Changeset 8156

Timestamp:

01/09/12 00:33:47 (17 months ago)

Author:

jow

Message:

libs/web: introduce recursive expression support for datatypes, introduce "or" and "and" datatypes
The commit adds a recursive parser for datatype expressions which allows nesting of validators,
this allows for complex expressions like "list(or(range(0,65535),'infinite'))" to allow a list of
values which are either integers between 0 and 65535 or the literal string "inifinite".
That change also deprecates combined datatypes like "ipaddr" or(ip4addr,ip6addr)? or
"host" or(hostname,ip4addr,ip6addr)?

Location:

luci/trunk/libs/web

Files:

• htdocs/luci-static/resources/cbi.js (modified) (14 diffs)
• luasrc/cbi.lua (modified) (2 diffs)
• luasrc/cbi/datatypes.lua (modified) (2 diffs)

luci/trunk/libs/web/htdocs/luci-static/resources/cbi.js

@@ -3 +3 @@
 
     Copyright 2008 Steven Barth <steven@midlink.org>
-    Copyright 2008-2011 Jo-Philipp Wich <xm@subsignal.org>
+    Copyright 2008-2012 Jo-Philipp Wich <xm@subsignal.org>
 
     Licensed under the Apache License, Version 2.0 (the "License");
@@ -18 +18 @@
 var cbi_validators = {
 
-    'integer': function(v)
-    {
-        return (v.match(/^-?[0-9]+$/) != null);
-    },
-
-    'uinteger': function(v)
-    {
-        return (cbi_validators.integer(v) && (v >= 0));
-    },
-
-    'float': function(v)
-    {
-        return !isNaN(parseFloat(v));
-    },
-
-    'ufloat': function(v)
-    {
-        return (cbi_validators['float'](v) && (v >= 0));
-    },
-
-    'ipaddr': function(v)
-    {
-        return cbi_validators.ip4addr(v) || cbi_validators.ip6addr(v);
-    },
-
-    'ip4addr': function(v)
-    {
-        if (v.match(/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})(\/(\S+))?$/))
+    'integer': function()
+    {
+        return (this.match(/^-?[0-9]+$/) != null);
+    },
+
+    'uinteger': function()
+    {
+        return (cbi_validators.integer.apply(this) && (this >= 0));
+    },
+
+    'float': function()
+    {
+        return !isNaN(parseFloat(this));
+    },
+
+    'ufloat': function()
+    {
+        return (cbi_validators['float'].apply(this) && (this >= 0));
+    },
+
+    'ipaddr': function()
+    {
+        return cbi_validators.ip4addr.apply(this) ||
+            cbi_validators.ip6addr.apply(this);
+    },
+
+    'ip4addr': function()
+    {
+        if (this.match(/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})(\/(\S+))?$/))
         {
             return (RegExp.$1 >= 0) && (RegExp.$1 <= 255) &&
@@ -53 +54 @@
                    ((RegExp.$6.indexOf('.') < 0)
                       ? ((RegExp.$6 >= 0) && (RegExp.$6 <= 32))
-                      : (cbi_validators.ip4addr(RegExp.$6)))
+                      : (cbi_validators.ip4addr.apply(RegExp.$6)))
             ;
         }
@@ -60 +61 @@
     },
 
-    'ip6addr': function(v)
-    {
-        if( v.match(/^([a-fA-F0-9:.]+)(\/(\d+))?$/) )
+    'ip6addr': function()
+    {
+        if( this.match(/^([a-fA-F0-9:.]+)(\/(\d+))?$/) )
         {
             if( !RegExp.$2 || ((RegExp.$3 >= 0) && (RegExp.$3 <= 128)) )
@@ -77 +78 @@
                     var off = addr.lastIndexOf(':');
 
-                    if( !(off && cbi_validators.ip4addr(addr.substr(off+1))) )
+                    if( !(off && cbi_validators.ip4addr.apply(addr.substr(off+1))) )
                         return false;
 
@@ -110 +111 @@
     },
 
-    'port': function(v)
-    {
-        return cbi_validators.integer(v) && (v >= 0) && (v <= 65535);
-    },
-
-    'portrange': function(v)
-    {
-        if( v.match(/^(\d+)-(\d+)$/) )
+    'port': function()
+    {
+        return cbi_validators.integer.apply(this) &&
+            (this >= 0) && (this <= 65535);
+    },
+
+    'portrange': function()
+    {
+        if (this.match(/^(\d+)-(\d+)$/))
         {
             var p1 = RegExp.$1;
             var p2 = RegExp.$2;
 
-            return cbi_validators.port(p1) &&
-                   cbi_validators.port(p2) &&
+            return cbi_validators.port.apply(p1) &&
+                   cbi_validators.port.apply(p2) &&
                    (parseInt(p1) <= parseInt(p2))
             ;
@@ -129 +131 @@
         else
         {
-            return cbi_validators.port(v);
-        }
-    },
-
-    'macaddr': function(v)
-    {
-        return (v.match(/^([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2}$/) != null);
-    },
-
-    'host': function(v)
-    {
-        return cbi_validators.hostname(v) || cbi_validators.ipaddr(v);
-    },
-
-    'hostname': function(v)
-    {
-        if (v.length <= 253)
-            return (v.match(/^[a-zA-Z]+$/) != null ||
-                    (v.match(/^[a-zA-Z0-9][a-zA-Z0-9\-.]*[a-zA-Z0-9]$/) &&
-                     v.match(/[^0-9.]/)));
+            return cbi_validators.port.apply(this);
+        }
+    },
+
+    'macaddr': function()
+    {
+        return (this.match(/^([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2}$/) != null);
+    },
+
+    'host': function()
+    {
+        return cbi_validators.hostname.apply(this) ||
+            cbi_validators.ipaddr.apply(this);
+    },
+
+    'hostname': function()
+    {
+        if (this.length <= 253)
+            return (this.match(/^[a-zA-Z]+$/) != null ||
+                    (this.match(/^[a-zA-Z0-9][a-zA-Z0-9\-.]*[a-zA-Z0-9]$/) &&
+                     this.match(/[^0-9.]/)));
 
         return false;
     },
 
-    'network': function(v)
-    {
-        return cbi_validators.uciname(v) || cbi_validators.host(v);
-    },
-
-    'wpakey': function(v)
-    {
+    'network': function()
+    {
+        return cbi_validators.uciname.apply(this) ||
+            cbi_validators.host.apply(this);
+    },
+
+    'wpakey': function()
+    {
+        var v = this;
+
         if( v.length == 64 )
             return (v.match(/^[a-fA-F0-9]{64}$/) != null);
@@ -166 +172 @@
     },
 
-    'wepkey': function(v)
-    {
-        if( v.substr(0,2) == 's:' )
+    'wepkey': function()
+    {
+        var v = this;
+
+        if ( v.substr(0,2) == 's:' )
             v = v.substr(2);
 
@@ -177 +185 @@
     },
 
-    'uciname': function(v)
-    {
-        return (v.match(/^[a-zA-Z0-9_]+$/) != null);
-    },
-
-    'range': function(v, args)
-    {
-        var min = parseInt(args[0]);
-        var max = parseInt(args[1]);
-        var val = parseInt(v);
-
+    'uciname': function()
+    {
+        return (this.match(/^[a-zA-Z0-9_]+$/) != null);
+    },
+
+    'range': function(min, max)
+    {
+        var val = parseFloat(this);
         if (!isNaN(min) && !isNaN(max) && !isNaN(val))
             return ((val >= min) && (val <= max));
@@ -194 +199 @@
     },
 
-    'min': function(v, args)
-    {
-        var min = parseInt(args[0]);
-        var val = parseInt(v);
-
+    'min': function(min)
+    {
+        var val = parseFloat(this);
         if (!isNaN(min) && !isNaN(val))
             return (val >= min);
@@ -205 +208 @@
     },
 
-    'max': function(v, args)
-    {
-        var max = parseInt(args[0]);
-        var val = parseInt(v);
-
+    'max': function(max)
+    {
+        var val = parseFloat(this);
         if (!isNaN(max) && !isNaN(val))
             return (val <= max);
@@ -216 +217 @@
     },
 
-    'neg': function(v, args)
-    {
-        if (args[0] && typeof cbi_validators[args[0]] == "function")
-            return cbi_validators[args[0]](v.replace(/^\s*!\s*/, ''));
-
+    'or': function()
+    {
+        for (var i = 0; i < arguments.length; i += 2)
+        {
+            if (typeof arguments[i] != 'function')
+            {
+                if (arguments[i] == this)
+                    return true;
+                i--;
+            }
+            else if (arguments[i].apply(this, arguments[i+1]))
+            {
+                return true;
+            }
+        }
         return false;
     },
 
-    'list': function(v, args)
-    {
-        var cb = cbi_validators[args[0] || 'string'];
-        if (typeof cb == "function")
-        {
-            var cbargs = args.slice(1);
-            var values = v.match(/[^\s]+/g);
-
-            for (var i = 0; i < values.length; i++)
-                if (!cb(values[i], cbargs))
+    'and': function()
+    {
+        for (var i = 0; i < arguments.length; i += 2)
+        {
+            if (typeof arguments[i] != 'function')
+            {
+                if (arguments[i] != this)
                     return false;
-
-            return true;
-        }
-
-        return false;
+                i--;
+            }
+            else if (!arguments[i].apply(this, arguments[i+1]))
+            {
+                return false;
+            }
+        }
+        return true;
+    },
+
+    'neg': function()
+    {
+        return cbi_validators.or.apply(
+            this.replace(/^[ \t]*![ \t]*/, ''), arguments);
+    },
+
+    'list': function(subvalidator, subargs)
+    {
+        if (typeof subvalidator != 'function')
+            return false;
+
+        var tokens = this.match(/[^ \t]+/g);
+        for (var i = 0; i < tokens.length; i++)
+            if (!subvalidator.apply(tokens[i], subargs))
+                return false;
+
+        return true;
     }
 };
@@ -833 +863 @@
 }
 
+function cbi_validate_compile(code)
+{
+    var pos = 0;
+    var esc = false;
+    var depth = 0;
+    var stack = [ ];
+
+    code += ',';
+
+    for (var i = 0; i < code.length; i++)
+    {
+        if (esc)
+        {
+            esc = false;
+            continue;
+        }
+
+        switch (code.charCodeAt(i))
+        {
+        case 92:
+            esc = true;
+            break;
+
+        case 40:
+        case 44:
+            if (depth <= 0)
+            {
+                if (pos < i)
+                {
+                    var label = code.substring(pos, i);
+                        label = label.replace(/\\(.)/g, '$1');
+                        label = label.replace(/^[ \t]+/g, '');
+                        label = label.replace(/[ \t]+$/g, '');
+
+                    if (label && !isNaN(label))
+                    {
+                        stack.push(parseFloat(label));
+                    }
+                    else if (label.match(/^(['"]).*\1$/))
+                    {
+                        stack.push(label.replace(/^(['"])(.*)\1$/, '$2'));
+                    }
+                    else if (typeof cbi_validators[label] == 'function')
+                    {
+                        stack.push(cbi_validators[label]);
+                        stack.push(null);
+                    }
+                    else
+                    {
+                        throw "Syntax error, unhandled token '"+label+"'";
+                    }
+                }
+                pos = i+1;
+            }
+            depth += (code.charCodeAt(i) == 40);
+            break;
+
+        case 41:
+            if (--depth <= 0)
+            {
+                if (typeof stack[stack.length-2] != 'function')
+                    throw "Syntax error, argument list follows non-function";
+
+                stack[stack.length-1] =
+                    arguments.callee(code.substring(pos, i));
+
+                pos = i+1;
+            }
+            break;
+        }
+    }
+
+    return stack;
+}
+
 function cbi_validate_field(cbid, optional, type)
 {
     var field = (typeof cbid == "string") ? document.getElementById(cbid) : cbid;
-    var vargs;
-
-    if( type.match(/^(\w+)\(([^\(\)]+)\)/) )
-    {
-        type  = RegExp.$1;
-        vargs = RegExp.$2.split(/\s*,\s*/);
-    }
-
-    var vldcb = cbi_validators[type];
-
-    if( field && vldcb )
+    var vstack; try { vstack = cbi_validate_compile(type); } catch(e) { };
+
+    if (field && vstack && typeof vstack[0] == "function")
     {
         var validator = function()
@@ -859 +956 @@
                     ? field.options[field.options.selectedIndex].value : field.value;
 
-                if( !(((value.length == 0) && optional) || vldcb(value, vargs)) )
+                if (!(((value.length == 0) && optional) || vstack[0].apply(value, vstack[1])))
                 {
                     // invalid

luci/trunk/libs/web/luasrc/cbi.lua

@@ -153 +153 @@
 end
 
+--
+-- Compile a datatype specification into a parse tree for evaluation later on
+--
+local cdt_cache = { }
+
+function compile_datatype(code)
+    local i
+    local pos = 0
+    local esc = false
+    local depth = 0
+    local stack = { }
+
+    for i = 1, #code+1 do
+        local byte = code:byte(i) or 44
+        if esc then
+            esc = false
+        elseif byte == 92 then
+            esc = true
+        elseif byte == 40 or byte == 44 then
+            if depth <= 0 then
+                if pos < i then
+                    local label = code:sub(pos, i-1)
+                        :gsub("\\(.)", "%1")
+                        :gsub("^%s+", "")
+                        :gsub("%s+$", "")
+
+                    if #label > 0 and tonumber(label) then
+                        stack[#stack+1] = tonumber(label)
+                    elseif label:match("^'.+'$") or label:match('^".+"$') then
+                        stack[#stack+1] = label:gsub("[\"'](.+)[\"']", "%1")
+                    elseif type(datatypes[label]) == "function" then
+                        stack[#stack+1] = datatypes[label]
+                        stack[#stack+1] = { }
+                    else
+                        error("Datatype error, bad token %q" % label)
+                    end
+                end
+                pos = i + 1
+            end
+            depth = depth + (byte == 40 and 1 or 0)
+        elseif byte == 41 then
+            depth = depth - 1
+            if depth <= 0 then
+                if type(stack[#stack-1]) ~= "function" then
+                    error("Datatype error, argument list follows non-function")
+                end
+                stack[#stack] = compile_datatype(code:sub(pos, i-1))
+                pos = i + 1
+            end
+        end
+    end
+
+    return stack
+end
+
+function verify_datatype(dt, value)
+    if dt and #dt > 0 then
+        if not cdt_cache[dt] then
+            local c = compile_datatype(dt)
+            if c and type(c[1]) == "function" then
+                cdt_cache[dt] = c
+            else
+                error("Datatype error, not a function expression")
+            end
+        end
+        if cdt_cache[dt] then
+            return cdt_cache[dt][1](value, unpack(cdt_cache[dt][2]))
+        end
+    end
+    return true
+end
+
 
 -- Node pseudo abstract class
@@ -1357 +1429 @@
 function AbstractValue.validate(self, value)
     if self.datatype and value then
-        local args = { }
-        local dt, ar = self.datatype:match("^(%w+)%(([^%(%)]+)%)")
-
-        if dt and ar then
-            local a
-            for a in ar:gmatch("[^%s,]+") do
-                args[#args+1] = a
-            end
-        else
-            dt = self.datatype
-        end
-
-        if dt and datatypes[dt] then
-            if type(value) == "table" then
-                local v
-                for _, v in ipairs(value) do
-                    if v and #v > 0 and not datatypes[dt](v, unpack(args)) then
-                        return nil
-                    end
-                end
-            else
-                if not datatypes[dt](value, unpack(args)) then
+        if type(value) == "table" then
+            local v
+            for _, v in ipairs(value) do
+                if v and #v > 0 and not verify_datatype(self.datatype, v) then
+                    error('F')
                     return nil
                 end
+            end
+        else
+            if not verify_datatype(self.datatype, value) then
+                error('F')
+                return nil
             end
         end

luci/trunk/libs/web/luasrc/cbi/datatypes.lua

@@ -18 +18 @@
 local math = require "math"
 local util = require "luci.util"
-local tonumber, type = tonumber, type
+local tonumber, type, unpack, select = tonumber, type, unpack, select
 
 
 module "luci.cbi.datatypes"
 
+
+_M['or'] = function(v, ...)
+    local i
+    for i = 1, select('#', ...), 2 do
+        local f = select(i, ...)
+        local a = select(i+1, ...)
+        if type(f) ~= "function" then
+            print("COMP", f, v)
+            if f == v then
+                return true
+            end
+            i = i - 1
+        elseif f(v, unpack(a)) then
+            return true
+        end
+    end
+    return false
+end
+
+_M['and'] = function(v, ...)
+    local i
+    for i = 1, select('#', ...), 2 do
+        local f = select(i, ...)
+        local a = select(i+1, ...)
+        if type(f) ~= "function" then
+            if f ~= v then
+                return false
+            end
+            i = i - 1
+        elseif not f(v, unpack(a)) then
+            return false
+        end
+    end
+    return true
+end
+
+function neg(v, ...)
+    return _M['or'](v:gsub("^%s*!%s*", ""), ...)
+end
+
+function list(v, subvalidator, subargs)
+    if type(subvalidator) ~= "function" then
+        return false
+    end
+    local token
+    for token in v:gmatch("%S+") do
+        if not subvalidator(token, unpack(subargs)) then
+            return false
+        end
+    end
+    return true
+end
 
 function bool(val)
@@ -255 +307 @@
     return false
 end
-
-function neg(val, what)
-    if what and type(_M[what]) == "function" then
-        return _M[what](val:gsub("^%s*!%s*", ""))
-    end
-
-    return false
-end
-
-function list(val, what, ...)
-    if type(val) == "string" and what and type(_M[what]) == "function" then
-        for val in val:gmatch("%S+") do
-            if not _M[what](val, ...) then
-                return false
-            end
-        end
-
-        return true
-    end
-
-    return false
-end