Added iptools class and the related tests.

Author: ip2location-com

ChangeLog

@@ -1,3 +1,6 @@
+8.7.0 2022-03-16
+	* Added iptools class and the related tests.
+
 8.6.4 2021-11-09
 	* Removed debug line.
 

IP2Location.py

@@ -4,7 +4,8 @@
 import re
 import json
 import os
-# import ipaddress
+import ipaddress
+import binascii
 from re import match
 
 MAX_IPV4_RANGE = 4294967295
@@ -95,6 +96,10 @@ def inet_pton(t, addr):
     socket.inet_pton = inet_pton
 
 def is_ipv4(hostname):
+    ip_parts = hostname.split('.')
+    for i in range(0,len(ip_parts)):
+        if int(ip_parts[i]) > 255:
+            return False
     pattern = r'^([0-9]{1,3}[.]){3}[0-9]{1,3}$'
     if match(pattern, hostname) is not None:
         return 4
@@ -650,7 +655,8 @@ def lookup(self,ip,addons=[],language='en'):
         response = httprequest(parameters, self.usessl)
         if (response == None):
             return False
-        if ('response' in response):
+        # if ('response' in response):
+        if (('response' in response) and (response['response'] != 'OK')):
             raise IP2LocationAPIError(response['response'])
         return response
 
@@ -665,4 +671,100 @@ def getcredit(self):
         return response['response']
 
 class IP2LocationAPIError(Exception):
-    """Raise for IP2Location API Error Message"""
+    """Raise for IP2Location API Error Message"""
+
+class AddressValueError(ValueError):
+    """A Value Error related to the address."""
+
+class IP2LocationIPTools(object):
+
+    def is_ipv4(self, ip):
+        ip_parts = ip.split('.')
+        for i in range(0,len(ip_parts)):
+            if int(ip_parts[i]) > 255:
+                return False
+        pattern = r'^([0-9]{1,3}[.]){3}[0-9]{1,3}$'
+        if match(pattern, ip) is not None:
+            return True
+        return False
+
+    def is_ipv6(self, ip):
+        try:
+            socket.inet_pton(socket.AF_INET6, ip)
+        except socket.error:  # not a valid address
+            return False
+        return True
+    
+    def ipv4_to_decimal(self, ip):
+        try:
+            ipnum = struct.unpack('!L', socket.inet_pton(socket.AF_INET, ip))[0]
+        except (socket.error, OSError, ValueError):
+            # ipnum = -1
+            return
+        return ipnum
+    
+    def decimal_to_ipv4(self, decimal):
+        if (int(decimal) > 4294967295):
+            return
+        else:
+            return (socket.inet_ntoa(struct.pack('!I', int(decimal))))
+    
+    def ipv6_to_decimal(self, ip):
+        return(int(ipaddress.ip_address(u(ip))))
+    
+    def decimal_to_ipv6(self, decimal):
+        result = ipaddress.IPv6Address(int(decimal))
+        if (result.ipv4_mapped != None):
+            return('::ffff:' + str(result.ipv4_mapped))
+        else:
+            return str(result)
+    
+    def ipv4_to_cidr(self, from_ip, to_ip):
+        startip = ipaddress.IPv4Address(u(from_ip))
+        endip = ipaddress.IPv4Address(u(to_ip))
+        ar = [ipaddr for ipaddr in ipaddress.summarize_address_range(startip, endip)]
+        ar1 = []
+        for i in range(len(ar)):
+            ar1.append(str(ar[i]))
+        return (ar1)
+    
+    def ipv6_to_cidr(self, from_ip, to_ip):
+        startip = ipaddress.IPv6Address(u(from_ip))
+        endip = ipaddress.IPv6Address(u(to_ip))
+        ar = [ipaddr for ipaddr in ipaddress.summarize_address_range(startip, endip)]
+        ar1 = []
+        for i in range(len(ar)):
+            ar1.append(str(ar[i]))
+        return (ar1)
+    
+    def cidr_to_ipv4(self, cidr):
+        net=ipaddress.ip_network(u(cidr))
+        return({"ip_start": str(net[0]), "ip_end": str(net[-1])})
+    
+    def cidr_to_ipv6(self, cidr):
+        parts = cidr.split('/')
+        hexstartaddress = binascii.hexlify(socket.inet_pton(socket.AF_INET6, parts[0]))
+        if (len(hexstartaddress) < 16):
+            hexstartaddress = hexstartaddress.zfill(16-hexstartaddress.len())
+        bits = 128 - int(parts[1])
+        hexlastaddress = hexstartaddress
+        pos = 31
+        while (bits > 0):
+            int_value = int(hexlastaddress[pos:pos+1], 16)
+            # new = binascii.hexlify((int_value | (pow(2, min(4, bits)) - 1)).to_bytes(1, 'big'))
+            new = binascii.hexlify((int_value | (pow(2, min(4, bits)) - 1)).to_bytes(1, 'little'))[1:]
+            hexlastaddresslist = list(u(hexlastaddress))
+            hexlastaddresslist[pos] = u(new)
+            string_hexlastaddresslist = [str(int) for int in hexlastaddresslist] 
+            hexlastaddress = ''.join(string_hexlastaddresslist)
+            bits = bits - 4
+            pos = pos - 1
+        binlastaddress = binascii.unhexlify(b(hexlastaddress))
+        return({"ip_start": self.expand_ipv6(parts[0]), "ip_end": self.expand_ipv6(socket.inet_ntop(socket.AF_INET6, binlastaddress))})
+    
+    def compressed_ipv6(self, ip):
+        return ((ipaddress.IPv6Address(u(ip)).compressed))
+    
+    def expand_ipv6(self, ip):
+        return ((ipaddress.IPv6Address(u(ip)).exploded))
+

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: IP2Location
-Version: 8.6.4
+Version: 8.7.0
 Summary: Python API for IP2Location database
 Home-page: http://www.ip2location.com
 Author: IP2Location

README.md

@@ -1,4 +1,4 @@
-# IP2Location 8.6.4
+# IP2Location 8.7.0
 
 
 This is a IP2Location Python library that enables the user to find the country, region or state, city, latitude and longitude, ZIP code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, usage type, address type and IAB category by IP address or hostname originates from. The library reads the geo location information from **IP2Location BIN data** file.
@@ -10,7 +10,8 @@ For more details, please visit:
 
 # Requirements
 
-1. Python 2.2 and above
+1. Python 2.2 and above for version below than 8.7.0.
+2. Python 3.4 and above for version 8.7.0 and above.
 
 # Installation
 
@@ -72,6 +73,25 @@ Below is the description of the functions available in the **Web Service** looku
 | lookup        | Return the IP information in array.  <ul><li>country_code</li><li>country_name</li><li>region_name</li><li>city_name</li><li>latitude</li><li>longitude</li><li>zip_code</li><li>time_zone</li><li>isp</li><li>domain</li><li>net_speed</li><li>idd_code</li><li>area_code</li><li>weather_station_code</li><li>weather_station_name</li><li>mcc</li><li>mnc</li><li>mobile_brand</li><li>elevation</li><li>usage_type</li><li>address_type</li><li>category</li><li>category_name</li><li>continent<ul><li>name</li><li>code</li><li>hemisphere</li><li>translations</li></ul></li><li>country<ul><li>name</li><li>alpha3_code</li><li>numeric_code</li><li>demonym</li><li>flag</li><li>capital</li><li>total_area</li><li>population</li><li>currency<ul><li>code</li><li>name</li><li>symbol</li></ul></li><li>language<ul><li>code</li><li>name</li></ul></li><li>idd_code</li><li>tld</li><li>translations</li></ul></li><li>region<ul><li>name</li><li>code</li><li>translations</li></ul></li><li>city<ul><li>name</li><li>translations</li></ul></li><li>geotargeting<ul><li>metro</li></ul></li><li>country_groupings</li><li>time_zone_info<ul><li>olson</li><li>current_time</li><li>gmt_offset</li><li>is_dst</li><li>sunrise</li><li>sunset</li></ul></li><ul> |
 | get_credit    | Return remaining credit of the web service account.          |
 
+### IP Tools
+
+Below is the description of the functions available in the **IP Tools** class.
+
+| Function Name   | Description                                                  |
+| --------------- | ------------------------------------------------------------ |
+| is_ipv4         | Return either **true** or **false**. Verify if a string is a valid IPv4 address. |
+| is_ipv6         | Return either **true** or **false**. Verify if a string is a valid IPv6 address. |
+| ipv4_to_decimal | Translate IPv4 address from dotted-decimal address to decimal format. |
+| decimal_to_ipv4 | Translate IPv4 address from decimal number to dotted-decimal address. |
+| ipv6_to_decimal | Translate IPv6 address from hexadecimal address to decimal format. |
+| decimal_to_ipv6 | Translate IPv6 address from decimal number into hexadecimal address. |
+| ipv4_to_cidr    | Convert IPv4 range into a list of IPv4 CIDR notation.        |
+| cidr_to_ipv4    | Convert IPv4 CIDR notation into a list of IPv4 addresses.    |
+| ipv6_to_cidr    | Convert IPv6 range into a list of IPv6 CIDR notation.        |
+| cidr_to_ipv6    | Convert IPv6 CIDR notation into a list of IPv6 addresses.    |
+| compressed_ipv6 | Compress a IPv6 to shorten the length.                       |
+| expand_ipv6     | Expand a shorten IPv6 to full length.                        |
+
 # Testing
 
     python sample.py

sample.py

@@ -49,3 +49,17 @@
 print ("\n")
 print ("Credit Remaining: {}\n".format(ws.getcredit()))
 
+ipTools = IP2Location.IP2LocationIPTools()
+print(str(ipTools.is_ipv4('8.8.8.8')))
+print(str(ipTools.is_ipv6('2001:4860:4860::8888')))
+print(ipTools.ipv4_to_decimal('8.8.8.8'))
+print(ipTools.decimal_to_ipv4(134744072))
+print(ipTools.ipv6_to_decimal('2001:4860:4860::8888'))
+print(ipTools.decimal_to_ipv6(42541956123769884636017138956568135816))
+print(ipTools.ipv4_to_cidr('8.0.0.0', '8.255.255.255'))
+print(ipTools.cidr_to_ipv4('8.0.0.0/8'))
+print(ipTools.ipv6_to_cidr('2002:0000:0000:1234:abcd:ffff:c0a8:0000', '2002:0000:0000:1234:ffff:ffff:ffff:ffff'))
+print(ipTools.cidr_to_ipv6('2002::1234:abcd:ffff:c0a8:101/64'))
+print(ipTools.compressed_ipv6('2002:0000:0000:1234:FFFF:FFFF:FFFF:FFFF'))
+print(ipTools.expand_ipv6('2002::1234:FFFF:FFFF:FFFF:FFFF'))
+

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
 	name="IP2Location",
-	version="8.6.4", 
+	version="8.7.0", 
 	author="IP2Location",
 	author_email="support@ip2location.com",
 	description="This is an IP geolocation library that enables the user to find the country, region, city, latitude and longitude, ZIP code, time zone, ISP, domain name, area code, weather info, mobile info, elevation, usage type, address type and IAB category from an IP address. It supports both IPv4 and IPv6 lookup.",
@@ -19,7 +19,6 @@
 		"Development Status :: 5 - Production/Stable",
 		"Intended Audience :: Developers",
 		"Topic :: Software Development :: Libraries :: Python Modules",
-		"Programming Language :: Python :: 2.7",
 		"Programming Language :: Python :: 3",
 		"License :: OSI Approved :: MIT License",
 		"Operating System :: OS Independent",