Tcl Library Source Code

# -------------------------------------------------------------------------
# Load extended command set.

source [file join [file dirname [info script]] ipMore.tcl]

# -------------------------------------------------------------------------

package provide ip 1.3

# -------------------------------------------------------------------------
# Local Variables:
#   indent-tabs-mode: nil
# End:

	set list [concat [lrange $list 0 [expr $index - 1]] \
		      [lrange $list [expr $index +1] end]];
	return $top;
    }
}

# Some additional aliases for backward compatability. Not
# documented. The old names are from previous versions while at Cisco.
#
#               Old command name -->      Documented command name
interp alias {} ::ip::ToInteger           {} ::ip::toInteger
interp alias {} ::ip::ToHex               {} ::ip::toHex
interp alias {} ::ip::MaskToInt           {} ::ip::maskToInt
interp alias {} ::ip::MaskToLength        {} ::ip::maskToLength
interp alias {} ::ip::LengthToMask        {} ::ip::lengthToMask

#        convert dotted form ip to integer
#
# Synopsis:
#       toInteger <ipaddr>
#
# Arguments:
#        <ipaddr>
#            decimal dotted form ip address
#
# Return Values:
#        integer form of <ipaddr>
#
# Description:
#       
# Examples:

#
# See Also:
#
# End of Header

proc ::ip::toInteger {ip} {
    binary scan [ip::Normalize4 $ip] I out
    return [format %lu [expr {$out & 0xffffffff}]]
}

##Procedure Header
# Copyright (c) 2004 Cisco Systems, Inc.
#
# Name:
#       ::ip::toHex

    variable x

    for {set x 0} {$x <33} {incr x} {
	set maskLenToDotted($x) [intToString [maskToInt $x]]
    }
    unset x
}

##Procedure Header
# Copyright (c) 2015 Martin Heinrich <[email protected]>
#
# Name:
#       ::ip::distance
#
# Purpose:
#        Calculate integer distance between two IPv4 addresses (dotted form or int)
#
# Synopsis:
#       distance <ipaddr1> <ipaddr2>
#
# Arguments:
#        <ipaddr1>
#        <ipaddr2>
#            ip address
#
# Return Values:
#        integer distance (addr2 - addr1)
#
# Description:
#       
# Examples:
#   % ::ip::distance 1.1.1.0 1.1.1.5
#   5
#
# Sample Input:
#
# Sample Output:

proc ::ip::distance {ip1 ip2} {
    # use package ip for normalization
    # XXX does not support ipv6
    expr {[toInteger $ip2]-[toInteger $ip1]}
}

##Procedure Header
# Copyright (c) 2015 Martin Heinrich <[email protected]>
#
# Name:
#       ::ip::nextIp
#
# Purpose:
#        Increment the given IPv4 address by an offset.
#        Complement to 'distance'.
#
# Synopsis:
#       nextIp <ipaddr> ?<offset>?
#
# Arguments:
#        <ipaddr>
#            ip address
#
#        <offset>
#            The integer to increment the address by.
#            Default is 1.
#
# Return Values:
#        The increment ip address.
#
# Description:
#       
# Examples:
#   % ::ip::nextIp 1.1.1.0 5 
#   1.1.1.5
#
# Sample Input:
#
# Sample Output:

proc ::ip::nextIp {ip {offset 1}} {
    set int [toInteger $ip]
    incr int $offset
    set prot {}
    # TODO if ipv4 then set prot -ipv4, but
    # XXX intToString has -ipv4, but never returns ipv6
    intToString $int ;# 8.5-ism, avoid: {*}$prot
}

    } -constraints {
    } -cleanup {
        unset iplist
    } -body {
        set a [lsort -command ip::cmpDotIP $iplist]
    } -result {1.0.0.0 2.2.0.0 3.3.3.3 128.0.0.0}


    ::tcltest::test ip::distance-1 {basic distance} -setup {
    } -constraints {
    } -cleanup {
    } -body {
        ::ip::distance 1.1.1.0 1.1.1.5
    } -result 5

    ::tcltest::test ip::distance-2 {distance, not enough args} -setup {
    } -constraints {
    } -cleanup {
    } -body {
        ::ip::distance
    } -returnCodes error -result {wrong # args: should be "::ip::distance ip1 ip2"}

    ::tcltest::test ip::distance-3 {distance, too many args} -setup {
    } -constraints {
    } -cleanup {
    } -body {
        ::ip::distance 1.1.1.1 1.1.1.5 1.1.1.19
    } -returnCodes error -result {wrong # args: should be "::ip::distance ip1 ip2"}


    ::tcltest::test ip::nextIp-1 {basic nextIp} -setup {
    } -constraints {
    } -cleanup {
    } -body {
        ::ip::nextIp 1.1.1.0 5
    } -result 1.1.1.5

    ::tcltest::test ip::nextIp-2 {nextIp, not enough args} -setup {
    } -constraints {
    } -cleanup {
    } -body {
        ::ip::nextIp
    } -returnCodes error -result {wrong # args: should be "::ip::nextIp ip ?offset?"}

    ::tcltest::test ip::nextIp-3 {nextIp, too many args} -setup {
    } -constraints {
    } -cleanup {
    } -body {
        ::ip::nextIp 1.1.1.1 1.1.1.5 1.1.1.19
    } -returnCodes error -result {wrong # args: should be "::ip::nextIp ip ?offset?"}

    foreach {n delta ip1 ip2} {
        0 4294967295  0.0.0.0         255.255.255.255
        1 -4294967295 255.255.255.255 0.0.0.0
        2 7709        10.11.12.13     10.11.42.42
        3 -7709       10.11.42.42     10.11.12.13
        4 1994195353  54.229.115.42   173.194.116.195
        5 -1994195353 173.194.116.195 54.229.115.42
    } {
        ::tcltest::test ip::distance-4.$n {basic distance} -setup {
        } -constraints {
        } -cleanup {
        } -body {
            ::ip::distance $ip1 $ip2
        } -result $delta

        ::tcltest::test ip::nextIp-4.$n {basic nextIp} -setup {
        } -constraints {
        } -cleanup {
        } -body {
            ::ip::nextIp $ip1 $delta
        } -result $ip2
    }

}

namespace delete ::ip::test

testsuiteCleanup

#

# pkgIndex.tcl -
#
# $Id: pkgIndex.tcl,v 1.21 2010/08/16 17:35:18 andreas_kupries Exp $

if {![package vsatisfies [package provide Tcl] 8.2]} {return}
package ifneeded dns    1.3.5 [list source [file join $dir dns.tcl]]
package ifneeded resolv 1.0.3 [list source [file join $dir resolv.tcl]]
package ifneeded ip     1.3   [list source [file join $dir ip.tcl]]
package ifneeded spf    1.1.1 [list source [file join $dir spf.tcl]]

[vset IP_VERSION 1.3]
[manpage_begin tcllib_ip n [vset IP_VERSION]]
[see_also inet(3)]
[see_also ip(7)]
[see_also ipv6(7)]
[keywords {internet address}]
[keywords ip]
[keywords ipv4]

redundant parts or digts.. This procedure is the opposite of
[cmd contract].

[call [cmd ::ip::contract] [arg address]]

Convert a [cmd normalize]d internet address into a more compact form
suitable for displaying to users.

[call [cmd ::ip::distance] [arg ipaddr1] [arg ipaddr2]]

This command computes the (integer) distance from IPv4 address 
[arg ipaddr1] to IPv4 address [arg ipaddr2], i.e. "ipaddr2 - ipaddr1"

[para]
[example {
   % ::ip::distance 1.1.1.1  1.1.1.5
   4
}]

[call [cmd ::ip::nextIp] [arg ipaddr] [opt [arg offset]]]

This command adds the integer [arg offset] to the IPv4 address [arg ipaddr]
and returns the new IPv4 address.

[para]
[example {
   % ::ip::distance 1.1.1.1  4
   1.1.1.5
}]

[call [cmd ::ip::prefix] [arg address]]

Returns the address prefix generated by masking the address part with
the mask if provided. If there is no mask then it is equivalent to
calling [cmd normalize]