geoip 1.1.2 → 1.2.1

data/History.rdoc

@@ -1,3 +1,7 @@
+== 1.2.0 2012-10-17
+
+* Added support for GeoLiteCityv6 IPv6 database type
+
 == 0.8.1 2009-06-04
 
 * Added GeoIP#close method to close the file descriptor

data/README.rdoc

@@ -13,6 +13,11 @@ and the city, ISP and other information, if you have that database version.
 Includes support for ASN data files, thanks to Roland Matiz.
 This release adds support for timezone names, thanks to Tonni Aagesen.
 
+If you have required 'io/extra' and have IO#pread, cross-process file-descriptor sharing is enabled.
+Each GeoIP instance keeps the file descriptor open, with a Mutex for thread-safety.
+You should consider this if your process will fork without exec, as
+{modrails does}[http://www.modrails.com/documentation/Users%20guide%20Nginx.html#_smart_spawning_gotcha_1_unintential_file_descriptor_sharing]
+
 == SYNOPSIS:
 
   require 'geoip'
@@ -25,9 +30,9 @@ This release adds support for timezone names, thanks to Tonni Aagesen.
   c.to_hash
   => {:country_code3=>"FIN", :country_name=>"Finland", :continent_code=>"EU", :request=>"www.nokia.com", :country_code=>69, :country_code2=>"FI", :ip=>"147.243.3.83"}
 
-  Returned values are the requested hostname, the IP address as a dotted quad,
-  Maxmind's country code, the ISO3166-1 alpha-2 country code, the ISO3166-2 alpha-3
-  country code, the ISO3166 country name, and the continent code.
+Returned values are the requested hostname, the IP address as a dotted quad,
+Maxmind's country code, the ISO3166-1 alpha-2 country code, the ISO3166-2 alpha-3
+country code, the ISO3166 country name, and the continent code.
 
   # Use the city database:
   c = GeoIP.new('GeoLiteCity.dat').city('github.com')
@@ -40,15 +45,19 @@ This release adds support for timezone names, thanks to Tonni Aagesen.
   GeoIP.new('GeoCity.dat').city('github.com')
   => ["github.com", "207.97.227.239", "US", "USA", "United States", "NA", "CA", "San Francisco", "94110", 37.7484, -122.4156, 807, 415, "America/Los_Angeles"]
 
-  Returned values are the requested hostname, the IP address as a dotted quad,
-  the ISO3166-1 alpha-2 country code, the ISO3166-2 alpha-3 country code, the
-  ISO3166 country name, the continent code, the region (state or territory) name,
-  city name, postal_code/zipcode, latitude, longitude, USA DMA code, USA area code,
-  timezone name.
+  # Use the city ipv6 database:
+  GeoIP.new('GeoLiteCityv6.dat').city('::151.38.39.114')
+  => ["::151.38.39.114", "::151.38.39.114", "IT", "ITA", "Italy", "EU", "05", "Piacenza", "", 45.016699999999986, 9.666699999999992, nil, nil, "Europe/Rome"]
+
+Returned values are the requested hostname, the IP address as a dotted quad,
+the ISO3166-1 alpha-2 country code, the ISO3166-2 alpha-3 country code, the
+ISO3166 country name, the continent code, the region (state or territory) name,
+city name, postal_code/zipcode, latitude, longitude, USA DMA code, USA area code,
+timezone name.
 
-  Result arrays from both city and country have mixed-in accessor methods as appropriate:
-  request, ip, country_code, country_code2, country_code3, country_name, continent_code,
-  region_name, city_name, postal_code, latitude, longitude, dma_code, area_code, timezone
+Result arrays from both city and country have mixed-in accessor methods as appropriate:
+request, ip, country_code, country_code2, country_code3, country_name, continent_code,
+region_name, city_name, postal_code, latitude, longitude, dma_code, area_code, timezone
 
   GeoIP.new('GeoIPASNum.dat').asn("www.fsb.ru")
   => ["AS8342", "RTComm.RU Autonomous System"]
@@ -76,9 +85,12 @@ This version Copyright (C) 2005 Clifford Heath
 Derived from the C version, Copyright (C) 2003 MaxMind LLC
 
 This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
+modify it under the terms of the GNU Lesser General Public License,
+as published by the Free Software Foundation; either version 2.1 of
+the License, or (at your option) any later version. This follows the
+license applied by Maxmind to their C library, for example in the
+version here:
+<http://www.maxmind.com/download/geoip/api/c/GeoIP-1.4.2.tar.gz>.
 
 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of

data/Rakefile

@@ -9,7 +9,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "geoip"
   gem.version = GeoIP::VERSION
   gem.homepage = "http://github.com/cjheath/geoip"
-  gem.license = "MIT"
+  gem.license = "GPL"
   gem.summary = %Q{GeoIP searches a GeoIP database for a given host or IP address, and returns information about the country where the IP address is allocated, and the city, ISP and other information, if you have that database version.}
   gem.description = %Q{GeoIP searches a GeoIP database for a given host or IP address, and
 returns information about the country where the IP address is allocated,
@@ -31,7 +31,7 @@ Rake::TestTask.new(:test) do |test|
 end
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "geoip #{GeoIP::VERSION}"

data/geoip.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "geoip"
-  s.version = "1.1.2"
+  s.version = "1.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Clifford Heath", "Roland Moriz"]
-  s.date = "2012-01-26"
+  s.date = "2012-12-18"
   s.description = "GeoIP searches a GeoIP database for a given host or IP address, and\nreturns information about the country where the IP address is allocated,\nand the city, ISP and other information, if you have that database version."
   s.email = ["clifford.heath@gmail.com", "rmoriz@gmail.com"]
   s.executables = ["geoip"]
@@ -40,9 +40,9 @@ Gem::Specification.new do |s|
     "website/template.rhtml"
   ]
   s.homepage = "http://github.com/cjheath/geoip"
-  s.licenses = ["MIT"]
+  s.licenses = ["GPL"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.24"
   s.summary = "GeoIP searches a GeoIP database for a given host or IP address, and returns information about the country where the IP address is allocated, and the city, ISP and other information, if you have that database version."
 
   if s.respond_to? :specification_version then

data/lib/geoip.rb

@@ -48,13 +48,18 @@ begin
 rescue LoadError
   # oh well, hope they're not forking after initializing
 end
+begin
+  require 'ipaddr'  # Needed for IPv6 support
+rescue LoadError
+  # Won't work for an IPv6 database
+end
 
 require 'yaml'
 
 class GeoIP
 
   # The GeoIP GEM version number
-  VERSION = "1.1.2"
+  VERSION = "1.2.1"
 
   # The +data/+ directory for geoip
   DATA_DIR = File.expand_path(File.join(File.dirname(__FILE__),'..','data','geoip'))
@@ -87,6 +92,8 @@ class GeoIP
   GEOIP_PROXY_EDITION = 8
   GEOIP_ASNUM_EDITION = 9
   GEOIP_NETSPEED_EDITION = 10
+  GEOIP_COUNTRY_EDITION_V6 = 12
+  GEOIP_CITY_EDITION_REV1_V6 = 30
 
   COUNTRY_BEGIN = 16776960          #:nodoc:
   STATE_BEGIN_REV0 = 16700000       #:nodoc:
@@ -171,23 +178,25 @@ class GeoIP
   #
   def country(hostname)
     if (@database_type == GEOIP_CITY_EDITION_REV0 ||
-        @database_type == GEOIP_CITY_EDITION_REV1)
+        @database_type == GEOIP_CITY_EDITION_REV1 ||
+        @database_type == GEOIP_CITY_EDITION_REV1_V6)
       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)
+    if (@database_type == GEOIP_COUNTRY_EDITION ||
+        @database_type == GEOIP_PROXY_EDITION ||
+        @database_type == GEOIP_NETSPEED_EDITION)
+        # Convert numeric IP address to an integer
+        ipnum = iptonum(ip)
+        code = (seek_record(ipnum) - COUNTRY_BEGIN)
+    elsif @database_type == GEOIP_COUNTRY_EDITION_V6
+      ipaddr = IPAddr.new ip
+      code = (seek_record_v6(ipaddr.to_i) - COUNTRY_BEGIN)
+    else
       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
@@ -223,16 +232,18 @@ class GeoIP
   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)
+    if (@database_type == GEOIP_CITY_EDITION_REV0 ||
+        @database_type == GEOIP_CITY_EDITION_REV1)
+      # Convert numeric IP address to an integer
+      ipnum = iptonum(ip)
+      pos = seek_record(ipnum)
+    elsif (@database_type == GEOIP_CITY_EDITION_REV1_V6)
+      ipaddr = IPAddr.new ip
+      pos = seek_record_v6(ipaddr.to_i)
+    else
       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
@@ -361,6 +372,7 @@ class GeoIP
           @database_segments = [STATE_BEGIN_REV1]
         elsif (@database_type == GEOIP_CITY_EDITION_REV0 ||
                @database_type == GEOIP_CITY_EDITION_REV1 ||
+               @database_type == GEOIP_CITY_EDITION_REV1_V6 ||
                @database_type == GEOIP_ORG_EDITION ||
                @database_type == GEOIP_ISP_EDITION ||
                @database_type == GEOIP_ASNUM_EDITION)
@@ -384,6 +396,7 @@ class GeoIP
 
     if (@database_type == GEOIP_COUNTRY_EDITION ||
         @database_type == GEOIP_PROXY_EDITION ||
+        @database_type == GEOIP_COUNTRY_EDITION_V6 ||
         @database_type == GEOIP_NETSPEED_EDITION)
       @database_segments = [COUNTRY_BEGIN]
     end
@@ -487,9 +500,11 @@ class GeoIP
   end
 
   def lookup_ip(ip_or_hostname) # :nodoc:
-    return ip_or_hostname unless (ip_or_hostname.kind_of?(String) && ip_or_hostname !~ /^[0-9.]+$/)
+    if !ip_or_hostname.kind_of?(String) or ip_or_hostname =~ /^[0-9.]+$/
+      return ip_or_hostname
+    end
 
-    # Lookup IP address, we were given a name
+    # Lookup IP address, we were given a name or IPv6 address
     ip = IPSocket.getaddress(ip_or_hostname)
     ip = '0.0.0.0' if ip == '::1'
     ip
@@ -528,6 +543,29 @@ class GeoIP
     end
   end
 
+  def seek_record_v6(ipnum)
+
+    # Binary search in the file.
+    # Records are pairs of little-endian integers, each of @record_length.
+    offset = 0
+    mask = 1 << 127
+
+    127.downto(0) do |depth|
+      off = (@record_length * 2 * offset)
+      buf = atomic_read(@record_length * 2, off)
+
+      buf.slice!(0...@record_length) if ((ipnum & mask) != 0)
+      offset = le_to_ui(buf[0...@record_length].unpack("C*"))
+
+      if (offset >= @database_segments[0])
+        return offset
+      end
+
+      mask >>= 1
+    end
+
+  end
+
   # Convert a big-endian array of numeric bytes to unsigned int.
   #
   # Returns the unsigned Integer.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoip
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-26 00:00:00.000000000 Z
+date: 2012-12-18 00:00:00.000000000 Z
 dependencies: []
 description: ! 'GeoIP searches a GeoIP database for a given host or IP address, and
 
@@ -49,7 +49,7 @@ files:
 - website/template.rhtml
 homepage: http://github.com/cjheath/geoip
 licenses:
-- MIT
+- GPL
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: GeoIP searches a GeoIP database for a given host or IP address, and returns