Added support for AS domain, AS usage type and AS CIDR

Author: ip2location

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 - 2024 IP2Location
+Copyright (c) 2023 - 2025 IP2Location
 
 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,7 +1,7 @@
 # IP2Location Lua Package
 [![LuaRocks](https://img.shields.io/luarocks/v/ip2location/ip2location)](https://luarocks.org/modules/ip2location/ip2location)
 
-This Lua package provides a fast lookup of country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name, mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district, autonomous system number (ASN) and autonomous system (AS) from IP address by using IP2Location database. This package uses a file based database available at IP2Location.com. This database simply contains IP blocks as keys, and other information such as country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name, mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district, autonomous system number (ASN) and autonomous system (AS) as values. It supports both IP address in IPv4 and IPv6.
+This Lua package provides a fast lookup of country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name, mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district, autonomous system number (ASN) and autonomous system (AS) from IP address by using IP2Location database. This package uses a file based database available at IP2Location.com. This database simply contains IP blocks as keys, and other information such as country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name, mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district, autonomous system number (ASN), autonomous system (AS), AS domain, AS usage type and AS CIDR as values. It supports both IP address in IPv4 and IPv6.
 
 This package can be used in many types of projects such as:
 
@@ -17,9 +17,6 @@ The database will be updated in monthly basis for the greater accuracy. Free LIT
 
 The paid databases are available at https://www.ip2location.com under Premium subscription package.
 
-As an alternative, this library can also call the IP2Location Web Service. This requires an API key. If you don't have an existing API key, you can subscribe for one at the below:
-
-https://www.ip2location.com/web-service/ip2location
 
 ## Developer Documentation
 To learn more about installation, usage, and code examples, please visit the developer documentation at [https://ip2location-lua.readthedocs.io/en/latest/index.html.](https://ip2location-lua.readthedocs.io/en/latest/index.html)

docs/source/code.md

@@ -47,4 +47,7 @@ Retrieve geolocation information for an IP address.
 | district         |     District or county name. |
 | asn              |     Autonomous system number (ASN). BIN databases. |
 | as          |     Autonomous system (AS) name. |
+| asdomain    | Domain name of the AS registrant. |
+| asusagetype    | Usage type of the AS registrant. |
+| ascidr    | CIDR range for the whole AS. |
 ```

docs/source/conf.py

@@ -6,11 +6,11 @@
 # -- Project information
 
 project = 'IP2Location Lua'
-copyright = '2023, IP2Location'
+copyright = '2025, IP2Location'
 author = 'IP2Location'
 
-release = '1.0.0'
-version = '1.0.0'
+release = '8.8.0'
+version = '8.8.0'
 
 # -- General configuration
 
@@ -61,4 +61,4 @@
 
 html_title = "IP2Location Lua"
 
-# html_baseurl = "https://ip2location-d.readthedocs.io/en/latest/"
+# html_baseurl = "https://ip2location-lua.readthedocs.io/en/latest/"

docs/source/index.md

@@ -1,7 +1,7 @@
 # IP2Location Lua Package
 [![LuaRocks](https://img.shields.io/luarocks/v/ip2location/ip2location)](https://luarocks.org/modules/ip2location/ip2location)
 
-This Lua package provides a fast lookup of country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name, mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district, autonomous system number (ASN) and autonomous system (AS) from IP address by using IP2Location database. This package uses a file based database available at IP2Location.com. This database simply contains IP blocks as keys, and other information such as country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name, mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district, autonomous system number (ASN) and autonomous system (AS) as values. It supports both IP address in IPv4 and IPv6.
+This Lua package provides a fast lookup of country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name, mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district, autonomous system number (ASN) and autonomous system (AS) from IP address by using IP2Location database. This package uses a file based database available at IP2Location.com. This database simply contains IP blocks as keys, and other information such as country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name, mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district, autonomous system number (ASN), autonomous system (AS), AS domain, AS usage type and AS CIDR as values. It supports both IP address in IPv4 and IPv6.
 
 This package can be used in many types of projects such as:
 

docs/source/quickstart.md

@@ -55,6 +55,9 @@ print("category: " .. result.category)
 print("district: " .. result.district)
 print("asn: " .. result.asn)
 print("as: " .. result.as)
+print("asdomain: " .. result.asdomain)
+print("asusagetype: " .. result.asusagetype)
+print("ascidr: " .. result.ascidr)
 
 ip2loc:close()
 ```

ip2location-8.7.1-1.rockspec ip2location-8.8.0-1.rockspecip2location-8.7.1-1.rockspec renamed to ip2location-8.8.0-1.rockspec

@@ -1,5 +1,5 @@
 package = "ip2location"
-version = "8.7.1-1"
+version = "8.8.0-1"
 source = {
    url = "git://github.com/ip2location/ip2location-lua.git"
 }
@@ -14,10 +14,10 @@ description = {
       blocks as keys, and other information such as country, region, city, latitude, longitude, ZIP code,
       time zone, ISP, domain name, connection type, IDD code, area code, weather station code, station name,
       mcc, mnc, mobile brand, elevation, usage type, address type, IAB category, district,
-      autonomous system number (ASN) and autonomous system (AS) as values. It supports both IP address
-      in IPv4 and IPv6.
+      autonomous system number (ASN), autonomous system (AS), AS domain, AS usage type, AS CIDR as values.
+      It supports both IP address in IPv4 and IPv6.
    ]],
-   homepage = "https://www.ip2location.com/development-libraries/ip2location/lua",
+   homepage = "https://www.ip2location.com/documentation/ip2location-libraries/lua",
    license = "MIT",
    maintainer = "support@ip2location.com"
 }

ip2location.lua

@@ -44,6 +44,9 @@ ip2location = {
   district_position_offset = 0,
   asn_position_offset = 0,
   as_position_offset = 0,
+  asdomain_position_offset = 0,
+  asusagetype_position_offset = 0,
+  ascidr_position_offset = 0,
   country_enabled = false,
   region_enabled = false,
   city_enabled = false,
@@ -68,6 +71,9 @@ ip2location = {
   district_enabled = false,
   asn_enabled = false,
   as_enabled = false,
+  asdomain_enabled = false,
+  asusagetype_enabled = false,
+  ascidr_enabled = false,
 }
 ip2location.__index = ip2location
 
@@ -97,6 +103,9 @@ ip2locationrecord = {
   district = "",
   asn = "",
   as = "",
+  asdomain = "",
+  asusagetype = "",
+  ascidr = "",
 }
 ip2locationrecord.__index = ip2locationrecord
 
@@ -135,8 +144,11 @@ local category_position = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
 local district_position = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 23 }
 local asn_position = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 24 }
 local as_position = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 25 }
+local asdomain_position = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 26 }
+local asusagetype_position = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 27 }
+local ascidr_position = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 28 }
 
-local api_version = "8.7.1"
+local api_version = "8.8.0"
 
 local modes = {
   countryshort = 0x0000001,
@@ -164,6 +176,9 @@ local modes = {
   district = 0x0400000,
   asn = 0x0800000,
   as = 0x1000000,
+  asdomain = 0x2000000,
+  asusagetype = 0x4000000,
+  ascidr = 0x8000000,
 }
 
 modes.all = modes.countryshort
@@ -191,6 +206,9 @@ modes.all = modes.countryshort
 | modes.district
 | modes.asn
 | modes.as
+| modes.asdomain
+| modes.asusagetype
+| modes.ascidr
 
 local invalid_address = "Invalid IP address."
 local missing_file = "Invalid database file."
@@ -467,6 +485,18 @@ function ip2location:new(dbpath)
     x.as_position_offset = (as_position[dbt] - 2) * 4
     x.as_enabled = true
   end
+  if asdomain_position[dbt] ~= 0 then
+    x.asdomain_position_offset = (asdomain_position[dbt] - 2) * 4
+    x.asdomain_enabled = true
+  end
+  if asusagetype_position[dbt] ~= 0 then
+    x.asusagetype_position_offset = (asusagetype_position[dbt] - 2) * 4
+    x.asusagetype_enabled = true
+  end
+  if ascidr_position[dbt] ~= 0 then
+    x.ascidr_position_offset = (ascidr_position[dbt] - 2) * 4
+    x.ascidr_enabled = true
+  end
 
   x.metaok = true
   -- printme(x)
@@ -476,7 +506,9 @@ end
 -- close file and reset
 function ip2location:close()
   self.metaok = false
-  io.close(self.f)
+  if self.f ~= nil then
+    io.close(self.f)
+  end
 end
 
 -- get IP type and calculate IP number; calculates index too if exists
@@ -639,6 +671,9 @@ function ip2locationrecord:loadmessage(mesg)
   x.district = mesg
   x.asn = mesg
   x.as = mesg
+  x.asdomain = mesg
+  x.asusagetype = mesg
+  x.ascidr = mesg
   return x
 end
 
@@ -839,6 +874,18 @@ function ip2location:query(ipaddress, mode)
       if (mode & modes.as ~= 0) and (self.as_enabled == true) then
         result.as = readstr(readuint32row(self.as_position_offset, row):asnumber(), self.f)
       end
+
+      if (mode & modes.asdomain ~= 0) and (self.asdomain_enabled == true) then
+        result.asdomain = readstr(readuint32row(self.asdomain_position_offset, row):asnumber(), self.f)
+      end
+
+      if (mode & modes.asusagetype ~= 0) and (self.asusagetype_enabled == true) then
+        result.asusagetype = readstr(readuint32row(self.asusagetype_position_offset, row):asnumber(), self.f)
+      end
+
+      if (mode & modes.ascidr ~= 0) and (self.ascidr_enabled == true) then
+        result.ascidr = readstr(readuint32row(self.ascidr_position_offset, row):asnumber(), self.f)
+      end
       -- printme(result)
 
       -- Lua style where you must have "return" as the last statement in a block
@@ -988,4 +1035,19 @@ function ip2location:get_as(ipaddress)
   return self:query(ipaddress, modes.as)
 end
 
+-- get AS domain
+function ip2location:get_asdomain(ipaddress)
+  return self:query(ipaddress, modes.asdomain)
+end
+
+-- get AS usage type
+function ip2location:get_asusagetype(ipaddress)
+  return self:query(ipaddress, modes.asusagetype)
+end
+
+-- get AS CIDR
+function ip2location:get_ascidr(ipaddress)
+  return self:query(ipaddress, modes.ascidr)
+end
+
 return ip2location

test.lua

@@ -29,5 +29,8 @@ print("category: " .. result.category)
 print("district: " .. result.district)
 print("asn: " .. result.asn)
 print("as: " .. result.as)
+print("asdomain: " .. result.asdomain)
+print("asusagetype: " .. result.asusagetype)
+print("ascidr: " .. result.ascidr)
 
 ip2loc:close()