++ed by:
KEEDI

1 PAUSE user
1 non-PAUSE user.

Author image Nigel Wetters Gourlay

NAME

IP::Country - fast lookup of country codes from IP addresses

SYNOPSIS

  use IP::Country::Fast;
  use IP::Country::Medium;
  use IP::Country::Slow;

DESCRIPTION

Finding the home country of a client using only the IP address can be difficult. Looking up the domain name associated with that address can provide some help, but many IP address are not reverse mapped to any useful domain, and the most common domain (.com) offers no help when looking for country.

This module comes bundled with a database of countries where various IP addresses have been assigned. Although the country of assignment will probably be the country associated with a large ISP rather than the client herself, this is probably good enough for most log analysis applications.

This module will probably be most useful when used after domain lookup has failed, or when it has returned a non-useful TLD (.com, .net, etc.).

CONSTRUCTOR

The constructor takes no arguments.

  use IP::Country::Fast;
  my $reg = IP::Country::Fast->new();

OBJECT METHODS

All object methods are designed to be used in an object-oriented fashion.

  $result = $object->foo_method($bar,$baz);

Using the module in a procedural fashion (without the arrow syntax) won't work.

$cc = $reg->inet_atocc(HOSTNAME)

Takes a string giving the name of a host, and translates that to an two-letter country code. Takes arguments of both the 'rtfm.mit.edu' type and '18.181.0.24'. If the host name cannot be resolved, returns undef. If the resolved IP address is not contained within the database, returns undef. For multi-homed hosts (hosts with more than one address), the first address found is returned.

If domain names are submitted to inet_atocc that end with a two-letter top-level domain, this is upper-cased and returned without further effort. If you don't like this behaviour, call Socket::inet_aton() on the hostname and pass it to IP::Country::Fast::inet_ntocc() rather than this method.

$cc = $reg->inet_ntocc(IP_ADDRESS)

Takes a string (an opaque string as returned by Socket::inet_aton()) and translates it into a two-letter country code. If the IP address is not contained within the database, returns undef.

PERFORMANCE

With a random selection of 65,000 IP addresses, the module can look up over 15,000 IP addresses per second on a 730MHz PIII (Coppermine) and over 25,000 IP addresses per second on a 1.3GHz Athlon. Out of this random selection of IP addresses, 43% had an associated country code. Please let me know if you've run this against a set of 'real' IP addresses from your log files, and have details of the proportion of IPs that had associated country codes.

BUGS/LIMITATIONS

Only works with IPv4 addresses.

SEE ALSO

IP::Country::Fast - recommended for lookups of hostnames which are mostly in the dotted-quad form ('213.45.67.89').

IP::Country::Medium - recommended for lookups of hostnames which are mostly in the domain-name form ('www.yahoo.com'). Caches domain-name lookups.

IP::Country::Slow - NOT RECOMMENDED. Only included for completeness. Prefers domain-name lookups to database lookups, which is an expensive strategy of no benefit.

Geo::IP - wrapper around the geoip C libraries. Less portable. Not measurably faster than these native Perl modules. Paid subscription required for database updates.

www.apnic.net - Asia pacific

www.ripe.net - Europe

www.arin.net - North America

www.lacnic.net - Latin America

COPYRIGHT

Copyright (C) 2002 Nigel Wetters. All Rights Reserved.

NO WARRANTY. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Some parts of this software distribution are derived from the APNIC, ARIN and RIPE databases (copyright details below). The author of this module makes no claims of ownership on those parts.

APNIC conditions of use

The files are freely available for download and use on the condition that APNIC will not be held responsible for any loss or damage arising from the application of the information contained in these reports.

APNIC endeavours to the best of its ability to ensure the accuracy of these reports; however, APNIC makes no guarantee in this regard.

In particular, it should be noted that these reports seek to indicate the country where resources were first allocated or assigned. It is not intended that these reports be considered as an authoritative statement of the location in which any specific resource may currently be in use.

ARIN database copyright

Copyright (c) American Registry for Internet Numbers. All rights reserved.

RIPE database copyright

The information in the RIPE Database is available to the public for agreed Internet operation purposes, but is under copyright. The copyright statement is:

"Except for agreed Internet operational purposes, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without prior permission of the RIPE NCC on behalf of the copyright holders. Any use of this material to target advertising or similar activities is explicitly forbidden and may be prosecuted. The RIPE NCC requests to be notified of any such activities or suspicions thereof."