libs/core: fix type in luci.model.wireless
[project/luci.git] / libs / core / luasrc / ip.lua
index bcb821a..3b0ca67 100644 (file)
@@ -17,13 +17,20 @@ $Id$
 --- LuCI IP calculation library.
 module( "luci.ip", package.seeall )
 
-require("bit")
-require("luci.util")
+require "nixio"
+local bit  = nixio.bit
+local util = require "luci.util"
 
-LITTLE_ENDIAN = not luci.util.bigendian()
+--- Boolean; true if system is little endian
+LITTLE_ENDIAN = not util.bigendian()
+
+--- Boolean; true if system is big endian
 BIG_ENDIAN    = not LITTLE_ENDIAN
 
+--- Specifier for IPv4 address family
 FAMILY_INET4  = 0x04
+
+--- Specifier for IPv6 address family
 FAMILY_INET6  = 0x06
 
 
@@ -59,7 +66,7 @@ local function __array16( x, family )
                list = { unpack(x[2]) }
 
        elseif type(x) == "table" then
-               list = x
+               list = { unpack(x) }
        end
 
        assert( list, "Invalid operand" )
@@ -153,6 +160,7 @@ function IPv4(address, netmask)
        local data = {}
        local prefix = address:match("/(.+)")
        address = address:gsub("/.+","")
+       address = address:gsub("^%[(.*)%]$", "%1"):upper():gsub("^::FFFF:", "")
 
        if netmask then
                prefix = obj:prefix(netmask)
@@ -200,6 +208,7 @@ function IPv6(address, netmask)
        local data = {}
        local prefix = address:match("/(.+)")
        address = address:gsub("/.+","")
+       address = address:gsub("^%[(.*)%]$", "%1")
 
        if netmask then
                prefix = obj:prefix(netmask)
@@ -221,7 +230,7 @@ function IPv6(address, netmask)
 
                block = tonumber(address:sub(borderl, borderh - 1), 16)
                if block and block <= 0xFFFF then
-                       table.insert(data, block)
+                       data[#data+1] = block
                else
                        if zeroh or borderh - borderl > 1 then return nil end
                        zeroh = #data + 1
@@ -235,7 +244,7 @@ function IPv6(address, netmask)
                block = tonumber(chunk, 16)
                if not block or block > 0xFFFF then return nil end
 
-               table.insert(data, block)
+               data[#data+1] = block
        elseif #chunk > 4 then
                if #data == 7 or #chunk > 15 then return nil end
                borderl = 1
@@ -248,7 +257,7 @@ function IPv6(address, netmask)
                        if not block or block > 255 then return nil end
 
                        if i == 1 or i == 3 then
-                               table.insert(data, block * 256)
+                               data[#data+1] = block * 256
                        else
                                data[#data] = data[#data] + block
                        end
@@ -302,31 +311,32 @@ function Hex( hex, prefix, family, swap )
        for i = 1, ( len / 4 ), 4 do
                local n = tonumber( hex:sub( i, i+3 ), 16 )
                if n then
-                       table.insert( data, n )
+                       data[#data+1] = n
                else
                        return nil
                end
        end
 
-       return __bless({ family, data, len })
+       return __bless({ family, data, prefix })
 end
 
 
 --- LuCI IP Library / CIDR instances
 -- @class      module
+-- @cstyle     instance
 -- @name       luci.ip.cidr
-cidr = luci.util.class()
+cidr = util.class()
 
 --- Test whether the instance is a IPv4 address.
 -- @return     Boolean indicating a IPv4 address type
--- @see                is6
+-- @see                cidr.is6
 function cidr.is4( self )
        return self[1] == FAMILY_INET4
 end
 
 --- Test whether the instance is a IPv6 address.
 -- @return     Boolean indicating a IPv6 address type
--- @see                is4
+-- @see                cidr.is4
 function cidr.is6( self )
        return self[1] == FAMILY_INET6
 end
@@ -360,8 +370,8 @@ end
 -- family than this instance.
 -- @param addr A luci.ip.cidr instance to compare against
 -- @return             Boolean indicating whether this instance is lower
--- @see                        higher
--- @see                        equal
+-- @see                        cidr.higher
+-- @see                        cidr.equal
 function cidr.lower( self, addr )
        assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
        for i = 1, #self[2] do
@@ -377,8 +387,8 @@ end
 -- family than this instance.
 -- @param addr A luci.ip.cidr instance to compare against
 -- @return             Boolean indicating whether this instance is higher
--- @see                        lower
--- @see                        equal
+-- @see                        cidr.lower
+-- @see                        cidr.equal
 function cidr.higher( self, addr )
        assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
        for i = 1, #self[2] do
@@ -389,13 +399,13 @@ function cidr.higher( self, addr )
        return false
 end
 
---- Test whether the value of the instance is uequal to the given address.
+--- Test whether the value of the instance is equal to the given address.
 -- This function will throw an exception if the given address is a different
 -- family than this instance.
 -- @param addr A luci.ip.cidr instance to compare against
 -- @return             Boolean indicating whether this instance is equal
--- @see                        lower
--- @see                        higher
+-- @see                        cidr.lower
+-- @see                        cidr.higher
 function cidr.equal( self, addr )
        assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
        for i = 1, #self[2] do
@@ -407,32 +417,31 @@ function cidr.equal( self, addr )
 end
 
 --- Return the prefix length of this CIDR instance.
--- @return     Prefix length in bit
+-- @param mask Override instance prefix with given netmask (optional)
+-- @return             Prefix length in bit
 function cidr.prefix( self, mask )
        local prefix = self[3]
 
        if mask then
                prefix = 0
+
                local stop = false
-               local obj = self:is4() and IPv4(mask) or IPv6(mask)
+               local obj = type(mask) ~= "table"
+                       and ( self:is4() and IPv4(mask) or IPv6(mask) ) or mask
 
-               if not obj then
-                       return nil
-               end
+               if not obj then return nil end
 
-               for i, block in ipairs(obj[2]) do
-                       local pos = bit.lshift(1, 15)
-                       for i=15, 0, -1 do
-                               if bit.band(block, pos) == pos then
-                                       if not stop then
-                                               prefix = prefix + 1
-                                       else
-                                               return nil
-                                       end
-                               else
-                                       stop = true
+               for _, word in ipairs(obj[2]) do
+                       if word == 0xFFFF then
+                               prefix = prefix + 16
+                       else
+                               local bitmask = bit.lshift(1, 15)
+                               while bit.band(word, bitmask) == bitmask do
+                                       prefix  = prefix + 1
+                                       bitmask = bit.lshift(1, 15 - (prefix % 16))
                                end
-                               pos = bit.rshift(pos, 1)
+
+                               break
                        end
                end
        end
@@ -444,22 +453,22 @@ end
 -- instance.
 -- @param bits Override prefix length of this instance (optional)
 -- @return             CIDR instance containing the network address
--- @see                        host
--- @see                        broadcast
--- @see                        mask
+-- @see                        cidr.host
+-- @see                        cidr.broadcast
+-- @see                        cidr.mask
 function cidr.network( self, bits )
        local data = { }
        bits = bits or self[3]
 
        for i = 1, math.floor( bits / 16 ) do
-               table.insert( data, self[2][i] )
+               data[#data+1] = self[2][i]
        end
 
        if #data < #self[2] then
-               table.insert( data, bit.band( self[2][1+#data], __mask16(bits) ) )
+               data[#data+1] = bit.band( self[2][1+#data], __mask16(bits) )
 
                for i = #data + 1, #self[2] do
-                       table.insert( data, 0 )
+                       data[#data+1] = 0
                end
        end
 
@@ -469,32 +478,32 @@ end
 --- Return a corresponding CIDR representing the host address of this
 -- instance. This is intended to extract the host address from larger subnet.
 -- @return             CIDR instance containing the network address
--- @see                        network
--- @see                        broadcast
--- @see                        mask
+-- @see                        cidr.network
+-- @see                        cidr.broadcast
+-- @see                        cidr.mask
 function cidr.host( self )
-       return __bless({ self[1], data, __maxlen(self[1]) })
+       return __bless({ self[1], self[2], __maxlen(self[1]) })
 end
 
 --- Return a corresponding CIDR representing the netmask of this instance.
 -- @param bits Override prefix length of this instance (optional)
 -- @return             CIDR instance containing the netmask
--- @see                        network
--- @see                        host
--- @see                        broadcast
+-- @see                        cidr.network
+-- @see                        cidr.host
+-- @see                        cidr.broadcast
 function cidr.mask( self, bits )
        local data = { }
        bits = bits or self[3]
 
        for i = 1, math.floor( bits / 16 ) do
-               table.insert( data, 0xFFFF )
+               data[#data+1] = 0xFFFF
        end
 
        if #data < #self[2] then
-               table.insert( data, __mask16(bits) )
+               data[#data+1] = __mask16(bits)
 
                for i = #data + 1, #self[2] do
-                       table.insert( data, 0 )
+                       data[#data+1] = 0
                end
        end
 
@@ -502,11 +511,10 @@ function cidr.mask( self, bits )
 end
 
 --- Return CIDR containing the broadcast address of this instance.
--- @param bits Override prefix length of this instance (optional)
 -- @return             CIDR instance containing the netmask, always nil for IPv6
--- @see                        network
--- @see                        host
--- @see                        mask
+-- @see                        cidr.network
+-- @see                        cidr.host
+-- @see                        cidr.mask
 function cidr.broadcast( self )
        -- IPv6 has no broadcast addresses (XXX: assert() instead?)
        if self[1] == FAMILY_INET4 then
@@ -539,24 +547,22 @@ end
 -- @param amount       Number of hosts to add to this instance
 -- @param inplace      Boolen indicating whether to alter values inplace (optional)
 -- @return                     CIDR representing the new address or nil on overflow error
--- @see                                sub
+-- @see                                cidr.sub
 function cidr.add( self, amount, inplace )
        local data   = { unpack(self[2]) }
        local shorts = __array16( amount, self[1] )
 
-       if shorts then
-               for pos = #data, 1, -1 do
-                       local add = ( #shorts > 0 ) and table.remove( shorts, #shorts ) or 0
-                       if ( data[pos] + add ) > 0xFFFF then
-                               data[pos] = ( data[pos] + add ) % 0xFFFF
-                               if pos > 1 then
-                                       data[pos-1] = data[pos-1] + ( add - data[pos] )
-                               else
-                                       return nil
-                               end
+       for pos = #data, 1, -1 do
+               local add = ( #shorts > 0 ) and table.remove( shorts, #shorts ) or 0
+               if ( data[pos] + add ) > 0xFFFF then
+                       data[pos] = ( data[pos] + add ) % 0xFFFF
+                       if pos > 1 then
+                               data[pos-1] = data[pos-1] + ( add - data[pos] )
                        else
-                               data[pos] = data[pos] + add
+                               return nil
                        end
+               else
+                       data[pos] = data[pos] + add
                end
        end
 
@@ -572,24 +578,22 @@ end
 -- @param amount       Number of hosts to substract from this instance
 -- @param inplace      Boolen indicating whether to alter values inplace (optional)
 -- @return                     CIDR representing the new address or nil on underflow error
--- @see                                add
+-- @see                                cidr.add
 function cidr.sub( self, amount, inplace )
        local data   = { unpack(self[2]) }
        local shorts = __array16( amount, self[1] )
 
-       if shorts then
-               for pos = #data, 1, -1 do
-                       local sub = ( #shorts > 0 ) and table.remove( shorts, #shorts ) or 0
-                       if ( data[pos] - sub ) < 0 then
-                               data[pos] = ( sub - data[pos] ) % 0xFFFF
-                               if pos > 1 then
-                                       data[pos-1] = data[pos-1] - ( sub + data[pos] )
-                               else
-                                       return nil
-                               end
+       for pos = #data, 1, -1 do
+               local sub = ( #shorts > 0 ) and table.remove( shorts, #shorts ) or 0
+               if ( data[pos] - sub ) < 0 then
+                       data[pos] = ( sub - data[pos] ) % 0xFFFF
+                       if pos > 1 then
+                               data[pos-1] = data[pos-1] - ( sub + data[pos] )
                        else
-                               data[pos] = data[pos] - sub
+                               return nil
                        end
+               else
+                       data[pos] = data[pos] - sub
                end
        end
 
@@ -603,7 +607,7 @@ end
 
 --- Return CIDR containing the lowest available host address within this subnet.
 -- @return             CIDR containing the host address, nil if subnet is too small
--- @see                        maxhost
+-- @see                        cidr.maxhost
 function cidr.minhost( self )
        if self[3] <= __sublen(self[1]) then
                -- 1st is Network Address in IPv4 and Subnet-Router Anycast Adresse in IPv6
@@ -613,7 +617,7 @@ end
 
 --- Return CIDR containing the highest available host address within the subnet.
 -- @return             CIDR containing the host address, nil if subnet is too small
--- @see                        minhost
+-- @see                        cidr.minhost
 function cidr.maxhost( self )
        if self[3] <= __sublen(self[1]) then
                local data   = { unpack(self[2]) }