Class: GeoIP
- Inherits:
-
Object
- Object
- GeoIP
- Defined in:
- lib/geoip.rb
Defined Under Namespace
Constant Summary collapse
- VERSION =
The GeoIP GEM version number
"1.1.2"
- DATA_DIR =
The
data/
directory for geoip File.(File.join(File.dirname(__FILE__),'..','data','geoip'))
- CountryCode =
Ordered list of the ISO3166 2-character country codes, ordered by GeoIP ID
YAML.load_file(File.join(DATA_DIR,'country_code.yml'))
- CountryCode3 =
Ordered list of the ISO3166 3-character country codes, ordered by GeoIP ID
YAML.load_file(File.join(DATA_DIR,'country_code3.yml'))
- CountryName =
Ordered list of the English names of the countries, ordered by GeoIP ID
YAML.load_file(File.join(DATA_DIR,'country_name.yml'))
- CountryContinent =
Ordered list of the ISO3166 2-character continent code of the countries, ordered by GeoIP ID
YAML.load_file(File.join(DATA_DIR,'country_continent.yml'))
- TimeZone =
Hash of the timezone codes mapped to timezone name, per zoneinfo
YAML.load_file(File.join(DATA_DIR,'time_zone.yml'))
- GEOIP_COUNTRY_EDITION =
1
- GEOIP_CITY_EDITION_REV1 =
2
- GEOIP_REGION_EDITION_REV1 =
3
- GEOIP_ISP_EDITION =
4
- GEOIP_ORG_EDITION =
5
- GEOIP_CITY_EDITION_REV0 =
6
- GEOIP_REGION_EDITION_REV0 =
7
- GEOIP_PROXY_EDITION =
8
- GEOIP_ASNUM_EDITION =
9
- GEOIP_NETSPEED_EDITION =
10
- COUNTRY_BEGIN =
:nodoc:
16776960
- STATE_BEGIN_REV0 =
:nodoc:
16700000
- STATE_BEGIN_REV1 =
:nodoc:
16000000
- STRUCTURE_INFO_MAX_SIZE =
:nodoc:
20
- DATABASE_INFO_MAX_SIZE =
:nodoc:
100
- MAX_ORG_RECORD_LENGTH =
:nodoc:
300
- MAX_ASN_RECORD_LENGTH =
:nodoc: unverified
300
- US_OFFSET =
:nodoc:
1
- CANADA_OFFSET =
:nodoc:
677
- WORLD_OFFSET =
:nodoc:
1353
- FIPS_RANGE =
:nodoc:
360
- FULL_RECORD_LENGTH =
:nodoc:
50
- STANDARD_RECORD_LENGTH =
:nodoc:
3
- SEGMENT_RECORD_LENGTH =
:nodoc:
3
Instance Attribute Summary collapse
-
#database_type ⇒ Object
(also: #databaseType)
readonly
The Edition number that identifies which kind of database you’ve opened.
Instance Method Summary collapse
-
#asn(hostname) ⇒ Object
Search a ASN GeoIP database for the specified host, returning the AS number and description.
-
#city(hostname) ⇒ Object
Search the GeoIP database for the specified host, returning city info.
-
#country(hostname) ⇒ Object
Search the GeoIP database for the specified host, returning country info.
-
#each ⇒ Object
Iterate through a GeoIP city database.
-
#initialize(filename, flags = 0) ⇒ GeoIP
constructor
Open the GeoIP database and determine the file format version.
-
#isp(hostname) ⇒ Object
(also: #organization)
Search a ISP GeoIP database for the specified host, returning the ISP Not all GeoIP databases contain ISP information.
Constructor Details
#initialize(filename, flags = 0) ⇒ GeoIP
Open the GeoIP database and determine the file format version.
filename
is a String holding the path to the GeoIP.dat file options
is an integer holding caching flags (unimplemented)
140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/geoip.rb', line 140 def initialize(filename, flags = 0) @mutex = unless IO.respond_to?(:pread) Mutex.new end @flags = flags @database_type = GEOIP_COUNTRY_EDITION @record_length = STANDARD_RECORD_LENGTH @file = File.open(filename, 'rb') detect_database_type! end |
Instance Attribute Details
#database_type ⇒ Object (readonly) Also known as: databaseType
The Edition number that identifies which kind of database you’ve opened
131 132 133 |
# File 'lib/geoip.rb', line 131 def database_type @database_type end |
Instance Method Details
#asn(hostname) ⇒ Object
Search a ASN GeoIP database for the specified host, returning the AS number and description.
hostname
is a String holding the host’s DNS name or numeric IP address.
Returns the AS number and description.
Source: geolite.maxmind.com/download/geoip/database/asnum/GeoIPASNum.dat.gz
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/geoip.rb', line 289 def asn(hostname) ip = lookup_ip(hostname) # Convert numeric IP address to an integer ipnum = iptonum(ip) if (@database_type != GEOIP_ASNUM_EDITION) throw "Invalid GeoIP database type, can't look up ASN by IP" end pos = seek_record(ipnum) off = pos + (2*@record_length - 1) * @database_segments[0] record = atomic_read(MAX_ASN_RECORD_LENGTH, off) record = record.sub(/\000.*/n, '') # AS####, Description ASN.new($1, $2) if record =~ /^(AS\d+)\s(.*)$/ end |
#city(hostname) ⇒ Object
Search the GeoIP database for the specified host, returning city info.
hostname
is a String holding the host’s DNS name or numeric IP address.
Returns a City object with the fourteen elements:
-
The host or IP address string as requested
-
The IP address string after looking up the host
-
The two-character country code (ISO 3166-1 alpha-2)
-
The three-character country code (ISO 3166-2 alpha-3)
-
The ISO 3166 English-language name of the country
-
The two-character continent code
-
The region name (state or territory)
-
The city name
-
The postal code (zipcode)
-
The latitude
-
The longitude
-
The USA dma_code if known (only REV1 City database)
-
The USA area_code if known (only REV1 City database)
-
The timezone name, if known
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/geoip.rb', line 223 def city(hostname) ip = lookup_ip(hostname) # Convert numeric IP address to an integer ipnum = iptonum(ip) if (@database_type != GEOIP_CITY_EDITION_REV0 && @database_type != GEOIP_CITY_EDITION_REV1) throw "Invalid GeoIP database type, can't look up City by IP" end pos = seek_record(ipnum) # This next statement was added to MaxMind's C version after it was # rewritten in Ruby. It prevents unassigned IP addresses from returning # bogus data. There was concern over whether the changes to an # application's behaviour were always correct, but this has been tested # using an exhaustive search of the top 16 bits of the IP address space. # The records where the change takes effect contained *no* valid data. # If you're concerned, email me, and I'll send you the test program so # you can test whatever IP range you think is causing problems, # as I don't care to undertake an exhaustive search of the 32-bit space. unless pos == @database_segments[0] read_city(pos, hostname, ip) end end |
#country(hostname) ⇒ Object
Search the GeoIP database for the specified host, returning country info.
hostname
is a String holding the host’s DNS name or numeric IP address.
If the database is a City database (normal), return the result that city
would return.
Otherwise, return a Country object with the seven elements:
-
The host or IP address string as requested
-
The IP address string after looking up the host
-
The GeoIP country-ID as an integer (N.B. this is excluded from the city results!)
-
The two-character country code (ISO 3166-1 alpha-2)
-
The three-character country code (ISO 3166-2 alpha-3)
-
The ISO 3166 English-language name of the country
-
The two-character continent code
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/geoip.rb', line 172 def country(hostname) if (@database_type == GEOIP_CITY_EDITION_REV0 || @database_type == GEOIP_CITY_EDITION_REV1) return city(hostname) end ip = lookup_ip(hostname) # Convert numeric IP address to an integer ipnum = iptonum(ip) if (@database_type != GEOIP_COUNTRY_EDITION && @database_type != GEOIP_PROXY_EDITION && @database_type != GEOIP_NETSPEED_EDITION) throw "Invalid GeoIP database type, can't look up Country by IP" end code = (seek_record(ipnum) - COUNTRY_BEGIN) Country.new( hostname, # Requested hostname ip, # Ip address as dotted quad code, # GeoIP's country code CountryCode[code], # ISO3166-1 alpha-2 code CountryCode3[code], # ISO3166-2 alpha-3 code CountryName[code], # Country name, per ISO 3166 CountryContinent[code] # Continent code. ) end |
#each ⇒ Object
Iterate through a GeoIP city database
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/geoip.rb', line 320 def each return enum_for unless block_given? if (@database_type != GEOIP_CITY_EDITION_REV0 && @database_type != GEOIP_CITY_EDITION_REV1) throw "Invalid GeoIP database type, can't iterate thru non-City database" end @iter_pos = @database_segments[0] + 1 num = 0 until ((rec = read_city(@iter_pos)).nil?) yield rec print "#{num}: #{@iter_pos}\n" if((num += 1) % 1000 == 0) end @iter_pos = nil return self end |
#isp(hostname) ⇒ Object Also known as: organization
Search a ISP GeoIP database for the specified host, returning the ISP Not all GeoIP databases contain ISP information. Check maxmind.com
hostname
is a String holding the host’s DNS name or numeric IP address.
Returns the ISP name.
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/geoip.rb', line 259 def isp(hostname) ip = lookup_ip(hostname) # Convert numeric IP address to an integer ipnum = iptonum(ip) if (@database_type != GEOIP_ISP_EDITION && @database_type != GEOIP_ORG_EDITION) throw "Invalid GeoIP database type, can't look up Organization/ISP by IP" end pos = seek_record(ipnum) off = pos + (2*@record_length - 1) * @database_segments[0] record = atomic_read(MAX_ORG_RECORD_LENGTH, off) record = record.sub(/\000.*/n, '') record end |