Geo::IP(3) User Contributed Perl Documentation Geo::IP(3)NAMEGeo::IP - Look up location and network information by IP Address
SYNOPSIS
use Geo::IP;
my $gi = Geo::IP->new(GEOIP_STANDARD);
# look up IP address '24.24.24.24'
# returns undef if country is unallocated, or not defined in our database
my $country = $gi->country_code_by_addr('24.24.24.24');
$country = $gi->country_code_by_name('yahoo.com');
# $country is equal to "US"
DESCRIPTION
This module uses a file based database. This database simply contains
IP blocks as keys, and countries as values. This database should be
more complete and accurate than reverse DNS lookups.
This module can be used to automatically select the geographically
closest mirror, to analyze your web server logs to determine the
countries of your visitors, for credit card fraud detection, and for
software export controls.
IP ADDRESS TO COUNTRY DATABASES
Free monthly updates to the database are available from
http://www.maxmind.com/download/geoip/database/
This free database is similar to the database contained in IP::Country,
as well as many paid databases. It uses ARIN, RIPE, APNIC, and LACNIC
whois to obtain the IP->Country mappings.
If you require greater accuracy, MaxMind offers a database on a paid
subscription basis. Also included with this is a service that updates
your database automatically each month, by running a program called
geoipupdate included with the C API from a cronjob. For more details
on the differences between the free and paid databases, see:
http://www.maxmind.com/app/geoip_country
CLASS METHODS
$gi = Geo::IP->new( $flags );
Constructs a new Geo::IP object with the default database located
inside your system's datadir, typically
/usr/local/share/GeoIP/GeoIP.dat.
Flags can be set to either GEOIP_STANDARD, or for faster
performance (at a cost of using more memory), GEOIP_MEMORY_CACHE.
When using memory cache you can force a reload if the file is
updated by setting GEOIP_CHECK_CACHE. GEOIP_INDEX_CACHE caches the
most frequently accessed index portion of the database, resulting
in faster lookups than GEOIP_STANDARD, but less memory usage than
GEOIP_MEMORY_CACHE - useful for larger databases such as GeoIP
Organization and GeoIP City. Note, for GeoIP Country, Region and
Netspeed databases, GEOIP_INDEX_CACHE is equivalent to
GEOIP_MEMORY_CACHE
To combine flags, use the bitwise OR operator, |. For example, to
cache the database in memory, but check for an updated GeoIP.dat
file, use: Geo::IP->new( GEOIP_MEMORY_CACHE | GEOIP_CHECK_CACHE. );
$gi = Geo::IP->open( $database_filename, $flags );
Constructs a new Geo::IP object with the database located at
$database_filename.
$gi = Geo::IP->open_type( $database_type, $flags );
Constructs a new Geo::IP object with the $database_type database
located in the standard location. For example
$gi = Geo::IP->open_type( GEOIP_CITY_EDITION_REV1 , GEOIP_STANDARD );
opens the database file in the standard location for GeoIP City,
typically /usr/local/share/GeoIP/GeoIPCity.dat.
OBJECT METHODS
$code = $gi->country_code_by_addr( $ipaddr );
Returns the ISO 3166 country code for an IP address.
$code = $gi->country_code_by_name( $hostname );
Returns the ISO 3166 country code for a hostname.
$code = $gi->country_code3_by_addr( $ipaddr );
Returns the 3 letter country code for an IP address.
$code = $gi->country_code3_by_name( $hostname );
Returns the 3 letter country code for a hostname.
$name = $gi->country_name_by_addr( $ipaddr );
Returns the full country name for an IP address.
$name = $gi->country_name_by_name( $hostname );
Returns the full country name for a hostname.
$r = $gi->record_by_addr( $ipaddr );
Returns a Geo::IP::Record object containing city location for an IP
address.
$r = $gi->record_by_name( $hostname );
Returns a Geo::IP::Record object containing city location for a
hostname.
$org = $gi->org_by_addr( $ipaddr );
Returns the Organization, ISP name or Domain Name for an IP
address.
$org = $gi->org_by_name( $hostname );
Returns the Organization, ISP name or Domain Name for a hostname.
$info = $gi->database_info;
Returns database string, includes version, date, build number and
copyright notice.
$old_charset = $gi->set_charset( $charset );
Set the charset for the city name - defaults to
GEOIP_CHARSET_ISO_8859_1. To set UTF8, pass GEOIP_CHARSET_UTF8 to
set_charset. For perl >= 5.008 the utf8 flag is honored.
$charset = $gi->charset;
Gets the currently used charset.
( $country, $region ) = $gi->region_by_addr('24.24.24.24');
Returns a list containing country and region. If region and/or
country is unknown, undef is returned. Sure this works only for
region databases.
( $country, $region ) = $gi->region_by_name('www.xyz.com');
Returns a list containing country and region. If region and/or
country is unknown, undef is returned. Sure this works only for
region databases.
$netmask = $gi->last_netmask;
Gets netmask of network block from last lookup.
$gi->netmask(12);
Sets netmask for the last lookup
my ( $from, $to ) = $gi->range_by_ip('24.24.24.24');
Returns the start and end of the current network block. The method
tries to join several continous netblocks.
MAILING LISTS AND CVS
Are available from SourceForge, see
http://sourceforge.net/projects/geoip/
The direct link to the mailing list is
http://lists.sourceforge.net/lists/listinfo/geoip-perl
VERSION
1.38
SEE ALSO
Geo::IP::Record
AUTHOR
Copyright (c) 2009, MaxMind, Inc
All rights reserved. This package is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
perl v5.14.0 2009-05-17 Geo::IP(3)
