geoip 0.1.0

data/lib/geoip.rb

@@ -0,0 +1,326 @@
+#
+# Native Ruby reader for the GeoIP database
+# Lookup the country where IP address is allocated
+#
+#= COPYRIGHT
+# 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.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#= SYNOPSIS
+#
+#   require 'geoip'
+#   p GeoIP.new('/usr/share/GeoIP/GeoIP.dat').country("www.netscape.sk")
+#
+#= DESCRIPTION
+#
+# GeoIP searches a GeoIP database for a given host or IP address, and
+# returns information about the country where the IP address is allocated.
+#
+#= PREREQUISITES
+#
+# You need at least the free GeoIP.dat, for which the last known download
+# location is <http://www.maxmind.com/download/geoip/database/GeoIP.dat.gz>
+# This API requires the file to be decompressed for searching. Other versions
+# of this database are available for purchase which contain more detailed
+# information, but this information is not returned by this implementation.
+# See www.maxmind.com for more information.
+#
+#=end
+
+require 'socket'
+
+class GeoIP
+    private
+    CountryCode = [
+	"--","AP","EU","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR",
+	"AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ",
+	"BM","BN","BO","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF",
+	"CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CX","CY","CZ",
+	"DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI",
+	"FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GH","GI","GL",
+	"GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR",
+	"HT","HU","ID","IE","IL","IN","IO","IQ","IR","IS","IT","JM","JO","JP",
+	"KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC",
+	"LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","MG","MH","MK",
+	"ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY",
+	"MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM",
+	"PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY",
+	"QA","RE","RO","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ",
+	"SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG",
+	"TH","TJ","TK","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG",
+	"UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE",
+	"YT","YU","ZA","ZM","ZR","ZW","A1","A2","O1" ]
+
+    CountryCode3 = [
+	"--","AP","EU","AND","ARE","AFG","ATG","AIA","ALB","ARM","ANT","AGO",
+	"AQ","ARG","ASM","AUT","AUS","ABW","AZE","BIH","BRB","BGD","BEL","BFA",
+	"BGR","BHR","BDI","BEN","BMU","BRN","BOL","BRA","BHS","BTN","BV","BWA",
+	"BLR","BLZ","CAN","CC","COD","CAF","COG","CHE","CIV","COK","CHL","CMR",
+	"CHN","COL","CRI","CUB","CPV","CX","CYP","CZE","DEU","DJI","DNK","DMA",
+	"DOM","DZA","ECU","EST","EGY","ESH","ERI","ESP","ETH","FIN","FJI","FLK",
+	"FSM","FRO","FRA","FX","GAB","GBR","GRD","GEO","GUF","GHA","GIB","GRL",
+	"GMB","GIN","GLP","GNQ","GRC","GS","GTM","GUM","GNB","GUY","HKG","HM",
+	"HND","HRV","HTI","HUN","IDN","IRL","ISR","IND","IO","IRQ","IRN","ISL",
+	"ITA","JAM","JOR","JPN","KEN","KGZ","KHM","KIR","COM","KNA","PRK","KOR",
+	"KWT","CYM","KAZ","LAO","LBN","LCA","LIE","LKA","LBR","LSO","LTU","LUX",
+	"LVA","LBY","MAR","MCO","MDA","MDG","MHL","MKD","MLI","MMR","MNG","MAC",
+	"MNP","MTQ","MRT","MSR","MLT","MUS","MDV","MWI","MEX","MYS","MOZ","NAM",
+	"NCL","NER","NFK","NGA","NIC","NLD","NOR","NPL","NRU","NIU","NZL","OMN",
+	"PAN","PER","PYF","PNG","PHL","PAK","POL","SPM","PCN","PRI","PSE","PRT",
+	"PLW","PRY","QAT","REU","ROU","RUS","RWA","SAU","SLB","SYC","SDN","SWE",
+	"SGP","SHN","SVN","SJM","SVK","SLE","SMR","SEN","SOM","SUR","STP","SLV",
+	"SYR","SWZ","TCA","TCD","TF","TGO","THA","TJK","TKL","TLS","TKM","TUN",
+	"TON","TUR","TTO","TUV","TWN","TZA","UKR","UGA","UM","USA","URY","UZB",
+	"VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","YEM","YT","YUG",
+	"ZAF","ZMB","ZR","ZWE","A1","A2","O1"]
+
+    CountryName = [
+	"N/A","Asia/Pacific Region","Europe","Andorra","United Arab Emirates",
+	"Afghanistan","Antigua and Barbuda","Anguilla","Albania","Armenia",
+	"Netherlands Antilles","Angola","Antarctica","Argentina",
+	"American Samoa","Austria","Australia","Aruba","Azerbaijan",
+	"Bosnia and Herzegovina","Barbados","Bangladesh","Belgium",
+	"Burkina Faso","Bulgaria","Bahrain","Burundi","Benin","Bermuda",
+	"Brunei Darussalam","Bolivia","Brazil","Bahamas","Bhutan",
+	"Bouvet Island","Botswana","Belarus","Belize","Canada",
+	"Cocos (Keeling) Islands","Congo, The Democratic Republic of the",
+	"Central African Republic","Congo","Switzerland","Cote D'Ivoire",
+	"Cook Islands","Chile","Cameroon","China","Colombia","Costa Rica",
+	"Cuba","Cape Verde","Christmas Island","Cyprus","Czech Republic",
+	"Germany","Djibouti","Denmark","Dominica","Dominican Republic",
+	"Algeria","Ecuador","Estonia","Egypt","Western Sahara","Eritrea",
+	"Spain","Ethiopia","Finland","Fiji","Falkland Islands (Malvinas)",
+	"Micronesia, Federated States of","Faroe Islands","France","France,
+	Metropolitan","Gabon","United Kingdom","Grenada","Georgia",
+	"French Guiana","Ghana","Gibraltar","Greenland","Gambia","Guinea",
+	"Guadeloupe","Equatorial Guinea","Greece",
+	"South Georgia and the South Sandwich Islands","Guatemala","Guam",
+	"Guinea-Bissau","Guyana","Hong Kong",
+	"Heard Island and McDonald Islands","Honduras","Croatia","Haiti",
+	"Hungary","Indonesia","Ireland","Israel","India",
+	"British Indian Ocean Territory","Iraq","Iran, Islamic Republic of",
+	"Iceland","Italy","Jamaica","Jordan","Japan","Kenya","Kyrgyzstan",
+	"Cambodia","Kiribati","Comoros","Saint Kitts and Nevis",
+	"Korea, Democratic People's Republic of","Korea, Republic of","Kuwait",
+	"Cayman Islands","Kazakhstan","Lao People's Democratic Republic",
+	"Lebanon","Saint Lucia","Liechtenstein","Sri Lanka","Liberia","Lesotho",
+	"Lithuania","Luxembourg","Latvia","Libyan Arab Jamahiriya","Morocco",
+	"Monaco","Moldova, Republic of","Madagascar","Marshall Islands",
+	"Macedonia","Mali","Myanmar","Mongolia","Macau",
+	"Northern Mariana Islands","Martinique","Mauritania","Montserrat",
+	"Malta","Mauritius","Maldives","Malawi","Mexico","Malaysia",
+	"Mozambique","Namibia","New Caledonia","Niger","Norfolk Island",
+	"Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","Niue",
+	"New Zealand","Oman","Panama","Peru","French Polynesia",
+	"Papua New Guinea","Philippines","Pakistan","Poland",
+	"Saint Pierre and Miquelon","Pitcairn Islands","Puerto Rico",
+	"Palestinian Territory, Occupied","Portugal","Palau","Paraguay","Qatar",
+	"Reunion","Romania","Russian Federation","Rwanda","Saudi Arabia",
+	"Solomon Islands","Seychelles","Sudan","Sweden","Singapore",
+	"Saint Helena","Slovenia","Svalbard and Jan Mayen","Slovakia",
+	"Sierra Leone","San Marino","Senegal","Somalia","Suriname",
+	"Sao Tome and Principe","El Salvador","Syrian Arab Republic",
+	"Swaziland","Turks and Caicos Islands","Chad",
+	"French Southern Territories","Togo","Thailand","Tajikistan","Tokelau",
+	"Turkmenistan","Tunisia","Tonga","East Timor","Turkey",
+	"Trinidad and Tobago","Tuvalu","Taiwan","Tanzania, United Republic of",
+	"Ukraine","Uganda","United States Minor Outlying Islands",
+	"United States","Uruguay","Uzbekistan","Holy See (Vatican City State)",
+	"Saint Vincent and the Grenadines","Venezuela","Virgin Islands,
+	British","Virgin Islands, U.S.","Vietnam","Vanuatu","Wallis and Futuna",
+	"Samoa","Yemen","Mayotte","Yugoslavia","South Africa","Zambia","Zaire",
+	"Zimbabwe","Anonymous Proxy","Satellite Provider","Other"]
+
+    CountryContinent = [
+	"--","AS","EU","EU","AS","AS","SA","SA","EU","AS","SA","AF","AN","SA",
+	"OC","EU","OC","SA","AS","EU","SA","AS","EU","AF","EU","AS","AF","AF",
+	"SA","AS","SA","SA","SA","AS","AF","AF","EU","SA","NA","AS","AF","AF",
+	"AF","EU","AF","OC","SA","AF","AS","SA","SA","SA","AF","AS","AS","EU",
+	"EU","AF","EU","SA","SA","AF","SA","EU","AF","AF","AF","EU","AF","EU",
+	"OC","SA","OC","EU","EU","EU","AF","EU","SA","AS","SA","AF","EU","SA",
+	"AF","AF","SA","AF","EU","SA","SA","OC","AF","SA","AS","AF","SA","EU",
+	"SA","EU","AS","EU","AS","AS","AS","AS","AS","EU","EU","SA","AS","AS",
+	"AF","AS","AS","OC","AF","SA","AS","AS","AS","SA","AS","AS","AS","SA",
+	"EU","AS","AF","AF","EU","EU","EU","AF","AF","EU","EU","AF","OC","EU",
+	"AF","AS","AS","AS","OC","SA","AF","SA","EU","AF","AS","AF","NA","AS",
+	"AF","AF","OC","AF","OC","AF","SA","EU","EU","AS","OC","OC","OC","AS",
+	"SA","SA","OC","OC","AS","AS","EU","SA","OC","SA","AS","EU","OC","SA",
+	"AS","AF","EU","AS","AF","AS","OC","AF","AF","EU","AS","AF","EU","EU",
+	"EU","AF","EU","AF","AF","SA","AF","SA","AS","AF","SA","AF","AF","AF",
+	"AS","AS","OC","AS","AF","OC","AS","AS","SA","OC","AS","AF","EU","AF",
+	"OC","NA","SA","AS","EU","SA","SA","SA","SA","AS","OC","OC","OC","AS",
+	"AF","EU","AF","AF","AF","AF"]
+
+    private
+    # Edition enumeration:
+    (GEOIP_COUNTRY_EDITION,
+    GEOIP_CITY_EDITION_REV1,
+    GEOIP_REGION_EDITION_REV1,
+    GEOIP_ISP_EDITION,
+    GEOIP_ORG_EDITION,
+    GEOIP_CITY_EDITION_REV0,
+    GEOIP_REGION_EDITION_REV0,
+    GEOIP_PROXY_EDITION,
+    GEOIP_ASNUM_EDITION,
+    GEOIP_NETSPEED_EDITION,
+    ) = *1..10
+
+    COUNTRY_BEGIN = 16776960
+    STATE_BEGIN_REV0 = 16700000
+    STATE_BEGIN_REV1 = 16000000
+    STRUCTURE_INFO_MAX_SIZE = 20
+    DATABASE_INFO_MAX_SIZE = 100
+    MAX_ORG_RECORD_LENGTH = 300
+    US_OFFSET = 1
+    CANADA_OFFSET = 677
+    WORLD_OFFSET = 1353
+    FIPS_RANGE = 360
+
+    STANDARD_RECORD_LENGTH = 3
+    SEGMENT_RECORD_LENGTH = 3
+
+    public
+    # 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)
+    def initialize(filename, flags = 0)
+	@flags = flags
+	@databaseType = GEOIP_COUNTRY_EDITION
+	@record_length = STANDARD_RECORD_LENGTH
+	@file = File.open(filename, 'rb')
+	@file.seek(-31, IO::SEEK_END)
+	1.upto(STRUCTURE_INFO_MAX_SIZE) {
+	    if @file.read(3) == "\xFF\xFF\xFF"
+		@databaseType = @file.getc
+		@databaseType -= 105 if @databaseType >= 106
+
+		puts "Old database file type #{@databaseType}, untested"
+
+		if (@databaseType == GEOIP_REGION_EDITION_REV0)
+		    # Region Edition, pre June 2003
+		    @databaseSegments = [ STATE_BEGIN_REV0 ]
+		elsif (@databaseType == GEOIP_REGION_EDITION_REV1)
+		    # Region Edition, post June 2003
+		    @databaseSegments = [ STATE_BEGIN_REV1 ]
+		elsif (@databaseType == GEOIP_CITY_EDITION_REV0 ||
+		       @databaseType == GEOIP_CITY_EDITION_REV1 ||
+		       @databaseType == GEOIP_ORG_EDITION ||
+		       @databaseType == GEOIP_ISP_EDITION ||
+		       @databaseType == GEOIP_ASNUM_EDITION)
+		    # City/Org Editions have two segments, read offset of second segment
+		    @databaseSegments = [ 0 ]
+		    sr = @file.read(3).unpack("C*")
+		    @databaseSegments[0] += le_to_ui(sr)
+
+		    if (@databaseType == GEOIP_ORG_EDITION ||
+			@databaseType == GEOIP_ISP_EDITION)
+			@record_length = 4
+		    end
+		end
+
+	    else
+		@file.seek(-41, IO::SEEK_CUR)
+	    end
+	}
+	if (@databaseType == GEOIP_COUNTRY_EDITION ||
+	    @databaseType == GEOIP_PROXY_EDITION ||
+	    @databaseType == GEOIP_NETSPEED_EDITION)
+	    @databaseSegments = [ COUNTRY_BEGIN ]
+	end
+    end
+
+    # 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
+    # Return an array of 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
+    # * The ISO3166-1 two-character country code
+    # * The ISO3166-2 three-character country code
+    # * The ISO3166 English-language name of the country
+    # * The two-character continent code
+    #
+    def country(hostname)
+	ip = hostname
+	if ip.kind_of?(String) && ip !~ /^[0-9.]*$/
+	    # Lookup IP address, we were given a name
+	    ip = IPSocket.getaddress(hostname)
+	end
+
+	# Convert numeric IP address to an integer
+	ipnum = iptonum(ip)
+	if (@databaseType != GEOIP_COUNTRY_EDITION && 
+	    @databaseType != GEOIP_PROXY_EDITION &&
+	    @databaseType != GEOIP_NETSPEED_EDITION)
+	    throw "Invalid GeoIP database type, can't look up Country by IP"
+	end
+	code = seek_record(ipnum) - COUNTRY_BEGIN;
+	[   hostname,			# Requested hostname
+	    ip,				# Ip address as dotted quad
+	    code,			# GeoIP's country code
+	    CountryCode[code],		# ISO3166-1 code
+	    CountryCode3[code],		# ISO3166-2 code
+	    CountryName[code],		# Country name, per IS03166
+	    CountryContinent[code] ]	# Continent code.
+    end
+
+    private
+    def iptonum(ip)	# Convert numeric IP address to integer
+	if ip.kind_of?(String) &&
+	    ip =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+)$/
+	    ip = be_to_ui(Regexp.last_match().to_a.slice(1..4))
+	end
+	ip
+    end
+
+    def seek_record(ipnum)
+	# Binary search in the file.
+	# Records are pairs of little-endian integers, each of @record_length.
+	offset = 0
+	mask = 2147483648
+	31.downto(0) { |depth|
+	    @file.seek(@record_length * 2 * offset);
+	    buf = @file.read(@record_length*2);
+	    buf.slice!(0...@record_length) if ((ipnum & mask) != 0)
+	    offset = le_to_ui(buf[0...@record_length].unpack("C*"))
+	    return offset if (offset >= @databaseSegments[0])
+	    mask = mask/2
+	}
+    end
+
+    # Convert a big-endian array of numeric bytes to unsigned int
+    def be_to_ui(s)
+	s.inject(0) { |m, o|
+	    (m<<8)+o.to_i
+	}
+    end
+
+    # Same for little-endian
+    def le_to_ui(s)
+    	be_to_ui(s.reverse)
+    end
+end
+
+if $0 == __FILE__
+    g = GeoIP.new('/usr/share/GeoIP/GeoIP.dat');
+
+    ARGV.each { |a|
+	p g.country(a)
+    }
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.4
+specification_version: 1
+name: geoip
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2005-03-11
+summary: "GeoIP looks up a GeoIP database to provide geographical data for an IP address
+  or Internet hostname. The free version of the GeoIP database available from
+  www.maxmind.com only contains country information, and so far that's all that
+  this library supports. The data is much more reliable than using the country
+  codes at the end of the hosts' domain names."
+require_paths: 
+  - lib
+email: cjh@polyplex.org
+homepage: http://polyplex.org/cjh
+rubyforge_project: 
+description: "GeoIP is a pure-Ruby replacement for some of the functionality in the wrapped C
+  library by Sean Chittenden. Given an IP address or hostname, it looks up the
+  country where that IP address is allocated."
+autorequire: geoip
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Clifford Heath
+files: 
+  - lib/geoip.rb
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: 
+  - The free GeoIP database from www.maxmind.com
+dependencies: []