Added support for PX5 to PX8 packages

Author: ip2location

ChangeLog.md

@@ -1,5 +1,9 @@
 # Revision history for ip2proxy
 
+## 2.0.0 -- 2019-05-27
+
+* Added support for PX5 to PX8 packages.
+
 ## 1.0.0  -- 2018-11-29
 
 * First version. Released on an unsuspecting world.

IP2Proxy.hs

@@ -1,7 +1,7 @@
 {-|
 Module      : IP2Proxy
 Description : IP2Proxy Haskell package
-Copyright   : (c) IP2Location, 2018
+Copyright   : (c) IP2Location, 2019
 License     : MIT
 Maintainer  : sales@ip2location.com
 Stability   : experimental
@@ -10,7 +10,7 @@ This Haskell package allows users to query an IP address to determine if it was
 
 IP2Proxy LITE BIN databases are available for free at http://lite.ip2location.com/
 -}
-module IP2Proxy (Meta, IP2ProxyRecord(..), getModuleVersion, getPackageVersion, getDatabaseVersion, open, getAll, getCountryShort, getCountryLong, getRegion, getCity, getISP, getProxyType, isProxy) where
+module IP2Proxy (Meta, IP2ProxyRecord(..), getModuleVersion, getPackageVersion, getDatabaseVersion, open, getAll, getCountryShort, getCountryLong, getRegion, getCity, getISP, getProxyType, getDomain, getUsageType, getASN, getAS, getLastSeen, isProxy) where
 
 import qualified Data.ByteString.Lazy as BS
 import qualified Data.ByteString.Lazy.Char8 as BS8
@@ -34,6 +34,16 @@ data IP2ProxyRecord = IP2ProxyRecord {
     isp :: String,
     -- | Proxy type
     proxy_type :: String,
+    -- | Domain
+    domain :: String,
+    -- | Usage type
+    usage_type :: String,
+    -- | ASN
+    asn :: String,
+    -- | AS
+    as :: String,
+    -- | Last seen
+    last_seen :: String,
     -- | Is proxy
     is_proxy :: Int
 } deriving (Show)
@@ -89,7 +99,7 @@ getMeta = do
     The 'getModuleVersion' function returns a string containing the module version.
 -}
 getModuleVersion :: String
-getModuleVersion = "1.0.0"
+getModuleVersion = "2.0.0"
 
 {-|
     The 'getPackageVersion' function returns a string containing the package version.
@@ -173,19 +183,29 @@ readcolstring contents dbtype rowoffset col = do
 
 readrecord :: BS.ByteString -> Int -> Int -> Int -> IP2ProxyRecord
 readrecord contents dbtype rowoffset mode = do
-    let country_position = [0, 2, 3, 3, 3]
-    let region_position = [0, 0, 0, 4, 4]
-    let city_position = [0, 0, 0, 5, 5]
-    let isp_position = [0, 0, 0, 0, 6]
-    let proxytype_position = [0, 0, 2, 2, 2]
-    
+    let country_position = [0, 2, 3, 3, 3, 3, 3, 3, 3]
+    let region_position = [0, 0, 0, 4, 4, 4, 4, 4, 4]
+    let city_position = [0, 0, 0, 5, 5, 5, 5, 5, 5]
+    let isp_position = [0, 0, 0, 0, 6, 6, 6, 6, 6]
+    let proxytype_position = [0, 0, 2, 2, 2, 2, 2, 2, 2]
+    let domain_position = [0, 0, 0, 0, 0, 7, 7, 7, 7]
+    let usagetype_position = [0, 0, 0, 0, 0, 0, 8, 8, 8]
+    let asn_position = [0, 0, 0, 0, 0, 0, 0, 9, 9]
+    let as_position = [0, 0, 0, 0, 0, 0, 0, 10, 10]
+    let lastseen_position = [0, 0, 0, 0, 0, 0, 0, 0, 11]
+     
     let countryshort_field = 1
     let countrylong_field = 2
     let region_field = 4
     let city_field = 8
     let isp_field = 16
     let proxytype_field = 32
     let isproxy_field = 64
+    let domain_field = 128
+    let usagetype_field = 256
+    let asn_field = 512
+    let as_field = 1024
+    let lastseen_field = 2048
 
     let proxy_type = if (((.&.) mode proxytype_field) /= 0) || (((.&.) mode isproxy_field) /= 0)
         then readcolstring contents dbtype rowoffset proxytype_position
@@ -207,13 +227,33 @@ readrecord contents dbtype rowoffset mode = do
         then readcolstring contents dbtype rowoffset isp_position
         else ""
 
+    let domain = if ((.&.) mode domain_field) /= 0
+        then readcolstring contents dbtype rowoffset domain_position
+        else ""
+    
+    let usage_type = if ((.&.) mode usagetype_field) /= 0
+        then readcolstring contents dbtype rowoffset usagetype_position
+        else ""
+    
+    let asn = if ((.&.) mode asn_field) /= 0
+        then readcolstring contents dbtype rowoffset asn_position
+        else ""
+    
+    let as = if ((.&.) mode as_field) /= 0
+        then readcolstring contents dbtype rowoffset as_position
+        else ""
+    
+    let last_seen = if ((.&.) mode lastseen_field) /= 0
+        then readcolstring contents dbtype rowoffset lastseen_position
+        else ""
+    
     let is_proxy = if (country_short == "-") || (proxy_type == "-")
         then 0
-        else if proxy_type == "DCH"
+        else if (proxy_type == "DCH") || (proxy_type == "SES")
             then 2
             else 1
 
-    IP2ProxyRecord country_short country_long region city isp proxy_type is_proxy
+    IP2ProxyRecord country_short country_long region city isp proxy_type domain usage_type asn as last_seen is_proxy
 
 searchtree :: BS.ByteString -> Integer -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> IP2ProxyRecord
 searchtree contents ipnum dbtype low high baseaddr colsize iptype mode = do
@@ -245,7 +285,7 @@ searchtree contents ipnum dbtype low high baseaddr colsize iptype mode = do
                         searchtree contents ipnum dbtype (mid + 1) high baseaddr colsize iptype mode
         else do
             let x = "INVALID IP ADDRESS"
-            IP2ProxyRecord x x x x x x (-1)
+            IP2ProxyRecord x x x x x x x x x x x (-1)
 
 search4 :: BS.ByteString -> Integer -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> IP2ProxyRecord
 search4 contents ipnum dbtype low high baseaddr indexbaseaddr colsize mode = do
@@ -281,7 +321,7 @@ tryfirst myIP = do
 -}
 getAll :: String -> Meta -> String -> IO IP2ProxyRecord
 getAll myfile meta myip = do
-    result <- doQuery myfile meta myip 127
+    result <- doQuery myfile meta myip 4095
     return result
 
 {-|
@@ -338,6 +378,51 @@ getProxyType myfile meta myip = do
     result <- doQuery myfile meta myip 32
     return (show (proxy_type result))
 
+{-|
+    The 'getDomain' function returns the domain name for an IP address.
+    It takes 3 arguments; the BIN database file path (String), the metadata from 'open' function (Meta record) & either IPv4 or IPv6 address (String).
+-}
+getDomain :: String -> Meta -> String -> IO String
+getDomain myfile meta myip = do
+    result <- doQuery myfile meta myip 128
+    return (show (domain result))
+
+{-|
+    The 'getUsageType' function returns the usage type for an IP address.
+    It takes 3 arguments; the BIN database file path (String), the metadata from 'open' function (Meta record) & either IPv4 or IPv6 address (String).
+-}
+getUsageType :: String -> Meta -> String -> IO String
+getUsageType myfile meta myip = do
+    result <- doQuery myfile meta myip 256
+    return (show (usage_type result))
+
+{-|
+    The 'getASN' function returns the autonomous system number for an IP address.
+    It takes 3 arguments; the BIN database file path (String), the metadata from 'open' function (Meta record) & either IPv4 or IPv6 address (String).
+-}
+getASN :: String -> Meta -> String -> IO String
+getASN myfile meta myip = do
+    result <- doQuery myfile meta myip 512
+    return (show (asn result))
+
+{-|
+    The 'getAS' function returns the autonomous system name for an IP address.
+    It takes 3 arguments; the BIN database file path (String), the metadata from 'open' function (Meta record) & either IPv4 or IPv6 address (String).
+-}
+getAS :: String -> Meta -> String -> IO String
+getAS myfile meta myip = do
+    result <- doQuery myfile meta myip 1024
+    return (show (as result))
+
+{-|
+    The 'getLastSeen' function returns the number of days last seen for an IP address.
+    It takes 3 arguments; the BIN database file path (String), the metadata from 'open' function (Meta record) & either IPv4 or IPv6 address (String).
+-}
+getLastSeen :: String -> Meta -> String -> IO String
+getLastSeen myfile meta myip = do
+    result <- doQuery myfile meta myip 2048
+    return (show (last_seen result))
+
 {-|
     The 'isProxy' function returns 0 if IP is not a proxy, 1 if is a proxy and not data center IP, 2 if is a proxy and is a data center IP, -1 if error.
     It takes 3 arguments; the BIN database file path (String), the metadata from 'open' function (Meta record) & either IPv4 or IPv6 address (String).
@@ -359,7 +444,7 @@ doQuery myfile meta myip mode = do
     if ipnum == -1
         then do
             let x = "INVALID IP ADDRESS"
-            return $ IP2ProxyRecord x x x x x x (-1)
+            return $ IP2ProxyRecord x x x x x x x x x x x (-1)
         else if ipnum >= from && ipnum <= to
             then do
                 return $ search4 contents (ipnum - (toInteger from)) (databasetype meta) 0 (ipv4databasecount meta) (ipv4databaseaddr meta) (ipv4indexbaseaddr meta) (ipv4columnsize meta) mode

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 IP2Location.com
+Copyright (c) 2019 IP2Location.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,9 @@
 # IP2Proxy Haskell Module
 
-This Haskell package allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits. It lookup the proxy IP address from **IP2Proxy BIN Data** file. This data file can be downloaded at
+This Haskell package allows user to query an IP address if it was being used as VPN anonymizer, open proxies, web proxies, Tor exits, data center, web hosting (DCH) range and search engine robots (SES). It lookup the proxy IP address from **IP2Proxy BIN Data** file. This data file can be downloaded at
 
-* Free IP2Proxy BIN Data: http://lite.ip2location.com
-* Commercial IP2Proxy BIN Data: http://www.ip2location.com/proxy-database
+* Free IP2Proxy BIN Data: https://lite.ip2location.com
+* Commercial IP2Proxy BIN Data: https://www.ip2location.com/database/ip2proxy
 
 
 ## Installation
@@ -18,17 +18,22 @@ Below are the methods supported in this package.
 |Method Name|Description|
 |---|---|
 |open|Open the IP2Proxy BIN data for lookup.|
-|getPackageVersion|Get the package version (1 to 4 for PX1 to PX4 respectively).|
+|getPackageVersion|Get the package version (1 to 8 for PX1 to PX8 respectively).|
 |getModuleVersion|Get the module version.|
 |getDatabaseVersion|Get the database version.|
-|isProxy|Check whether if an IP address was a proxy. Returned value:<ul><li>-1 : errors</li><li>0 : not a proxy</li><li>1 : a proxy</li><li>2 : a data center IP address</li></ul>|
+|isProxy|Check whether if an IP address was a proxy. Returned value:<ul><li>-1 : errors</li><li>0 : not a proxy</li><li>1 : a proxy</li><li>2 : a data center IP address or search engine robot</li></ul>|
 |getAll|Return the proxy information in a record.|
-|getProxyType|Return the proxy type. Please visit <a href="https://www.ip2location.com/databases/px4-ip-proxytype-country-region-city-isp" target="_blank">IP2Location</a> for the list of proxy types supported|
+|getProxyType|Return the proxy type. Please visit <a href="https://www.ip2location.com/database/px8-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen" target="_blank">IP2Location</a> for the list of proxy types supported.|
 |getCountryShort|Return the ISO3166-1 country code (2-digits) of the proxy.|
 |getCountryLong|Return the ISO3166-1 country name of the proxy.|
-|getRegion|Return the ISO3166-2 region name of the proxy. Please visit <a href="https://www.ip2location.com/free/iso3166-2" target="_blank">ISO3166-2 Subdivision Code</a> for the information of ISO3166-2 supported|
+|getRegion|Return the ISO3166-2 region name of the proxy. Please visit <a href="https://www.ip2location.com/free/iso3166-2" target="_blank">ISO3166-2 Subdivision Code</a> for the information of ISO3166-2 supported.|
 |getCity|Return the city name of the proxy.|
 |getISP|Return the ISP name of the proxy.|
+|getDomain|Return the domain name of the proxy.|
+|getUsageType|Return the usage type classification of the proxy. Please visit <a href="https://www.ip2location.com/database/px8-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen" target="_blank">IP2Location</a> for the list of usage types supported.|
+|getASN|Return the autonomous system number of the proxy.|
+|getAS|Return the autonomous system name of the proxy.|
+|getLastSeen|Return the number of days that the proxy was last seen.|
 
 ## Example
 
@@ -37,7 +42,7 @@ import IP2Proxy
 
 main :: IO ()
 main = do
-    let myfile = "IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP.BIN"
+    let myfile = "./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN.BIN"
     let ip = "199.83.103.79"
     meta <- open myfile
 
@@ -52,6 +57,11 @@ main = do
     putStrLn $ "city: " ++ (show (city result))
     putStrLn $ "isp: " ++ (show (isp result))
     putStrLn $ "proxy_type: " ++ (show (proxy_type result))
+    putStrLn $ "domain: " ++ (show (domain result))
+    putStrLn $ "usage_type: " ++ (show (usage_type result))
+    putStrLn $ "asn: " ++ (show (asn result))
+    putStrLn $ "as: " ++ (show (as result))
+    putStrLn $ "last_seen: " ++ (show (last_seen result))
     putStrLn $ "is_proxy: " ++ (show (is_proxy result))
 
     result <- getCountryShort myfile meta ip
@@ -66,6 +76,16 @@ main = do
     putStrLn $ "isp: " ++ result
     result <- getProxyType myfile meta ip
     putStrLn $ "proxy_type: " ++ result
+    result <- getDomain myfile meta ip
+    putStrLn $ "domain: " ++ result
+    result <- getUsageType myfile meta ip
+    putStrLn $ "usage_type: " ++ result
+    result <- getASN myfile meta ip
+    putStrLn $ "asn: " ++ result
+    result <- getAS myfile meta ip
+    putStrLn $ "as: " ++ result
+    result <- getLastSeen myfile meta ip
+    putStrLn $ "last_seen: " ++ result
     result <- isProxy myfile meta ip
     putStrLn $ "is_proxy: " ++ result
 ```