You are here

Home » API reference » Smart IP 7.2

README.txt in Smart IP 7.2

Same filename in this branch
  1. 7.2 README.txt
  2. 7.2 modules/device_geolocation/README.txt
  3. 7.2 modules/smart_ip_views_bridge/README.txt
Same filename and directory in other branches
  1. 8.4 README.txt
  2. 8.2 README.txt
  3. 8.3 README.txt
  4. 6.2 README.txt
  5. 6 README.txt
  6. 7 README.txt
Description:
Smart IP identify visitor's geographical location (longitude/latitude), country, 
region, city and postal code based on the IP address of the user. These information 
will be stored at session variable ($_SESSION) with array key 'smart_ip' and  Drupal 
$user->data object with array key 'geoip_location' of the user but optionally it can  
be disabled (by role) at Smart IP admin page. Other modules can use the function 
smart_ip_get_location($ip_address) that returns an array containing the visitor's 
ISO 3166 2-character country code, longitude, latitude, region, city and postal code. It 
provides a feature for you to perform your own IP lookup and admin spoofing of an arbitrary 
IP for testing purposes.

Maxmind's database is the source of Smart IP database that makes the association between IP 
address and geographical location (longitude/latitude), region, city and postal code. It can 
be found at http://www.maxmind.com/app/geolitecountry it has two versions: a very accurate 
and up to date payable version and a not quite accurate free lite version. Smart IP downloads 
and process the CSV files (GeoLiteCity-Location.csv and GeoLiteCity-Blocks.csv) to store to 
Smart IP database. An optional once a month (Maxmind updates its database every first day of 
a month) automatic update of the Smart IP database is provided or it can be manually updated 
at Smart IP admin page. The database of Maxmind is very huge, the two CSV files size is about 
150MB and the size when stored to SQL database is about 450MB with almost 5 million rows and 
about 600MB additional database space for temporary working table for Smart IP database 
update. The process of downloading the archived CSV files from Maxmind's server, extracting 
the downloaded zip file, parsing the CSV files and storing to the database will took more or 
less eight hours (depends on server's speed). It uses the batch system process. If interrupted 
by an unexpected error, it can recover from where it stopped or the administrator can manually 
continue the broken process at Smart IP admin page.

Another source of Smart IP is the IPInfoDB.com service which also uses Maxmind's database, in 
this case IPInfoDB.com will handle database resource load instead of your server's database. 
By default the use of IPInfoDB.com service as source is enabled. If IPInfoDB.com is desired to  
handle database resource load, it can be configured at Smart IP admin page settings.

Note: The Smart IP database is empty upon initial installation of this module. Either manually 
update the Smart IP database at admin page or wait for the cron to run and update Smart IP 
database automatically for you.

Requirements:
PHP 5.4 and up
Drupal 7.x
Geo Time Zone

Installation:
1. Copy the extracted smart_ip directory to your Drupal sites/all/modules directory.
2. Login as an administrator. Enable the module at http://www.example.com/?q=admin/modules
3. Set your private file system path at http://www.example.com/?q=admin/config/media/file-system
4. Configure/update Smart IP database/lookup an IP at 
http://www.example.com/?q=admin/config/people/smart_ip.

Support:
Please use the issue queue for filing bugs with this module at
http://drupal.org/project/issues/smart_ip

File

README.txt
View source 
  1. 

  2. Description:

  3. Smart IP identify visitor's geographical location (longitude/latitude), country, 

  4. region, city and postal code based on the IP address of the user. These information 

  5. will be stored at session variable ($_SESSION) with array key 'smart_ip' and  Drupal 

  6. $user->data object with array key 'geoip_location' of the user but optionally it can  

  7. be disabled (by role) at Smart IP admin page. Other modules can use the function 

  8. smart_ip_get_location($ip_address) that returns an array containing the visitor's 

  9. ISO 3166 2-character country code, longitude, latitude, region, city and postal code. It 

  10. provides a feature for you to perform your own IP lookup and admin spoofing of an arbitrary 

  11. IP for testing purposes.

  12. 

  13. Maxmind's database is the source of Smart IP database that makes the association between IP 

  14. address and geographical location (longitude/latitude), region, city and postal code. It can 

  15. be found at http://www.maxmind.com/app/geolitecountry it has two versions: a very accurate 

  16. and up to date payable version and a not quite accurate free lite version. Smart IP downloads 

  17. and process the CSV files (GeoLiteCity-Location.csv and GeoLiteCity-Blocks.csv) to store to 

  18. Smart IP database. An optional once a month (Maxmind updates its database every first day of 

  19. a month) automatic update of the Smart IP database is provided or it can be manually updated 

  20. at Smart IP admin page. The database of Maxmind is very huge, the two CSV files size is about 

  21. 150MB and the size when stored to SQL database is about 450MB with almost 5 million rows and 

  22. about 600MB additional database space for temporary working table for Smart IP database 

  23. update. The process of downloading the archived CSV files from Maxmind's server, extracting 

  24. the downloaded zip file, parsing the CSV files and storing to the database will took more or 

  25. less eight hours (depends on server's speed). It uses the batch system process. If interrupted 

  26. by an unexpected error, it can recover from where it stopped or the administrator can manually 

  27. continue the broken process at Smart IP admin page.

  28. 

  29. Another source of Smart IP is the IPInfoDB.com service which also uses Maxmind's database, in 

  30. this case IPInfoDB.com will handle database resource load instead of your server's database. 

  31. By default the use of IPInfoDB.com service as source is enabled. If IPInfoDB.com is desired to  

  32. handle database resource load, it can be configured at Smart IP admin page settings.

  33. 

  34. Note: The Smart IP database is empty upon initial installation of this module. Either manually 

  35. update the Smart IP database at admin page or wait for the cron to run and update Smart IP 

  36. database automatically for you.

  37. 

  38. Requirements:

  39. PHP 5.4 and up

  40. Drupal 7.x

  41. Geo Time Zone

  42. 

  43. Installation:

  44. 1. Copy the extracted smart_ip directory to your Drupal sites/all/modules directory.

  45. 2. Login as an administrator. Enable the module at http://www.example.com/?q=admin/modules

  46. 3. Set your private file system path at http://www.example.com/?q=admin/config/media/file-system

  47. 4. Configure/update Smart IP database/lookup an IP at 

  48. http://www.example.com/?q=admin/config/people/smart_ip.

  49. 

  50. Support:

  51. Please use the issue queue for filing bugs with this module at

  52. http://drupal.org/project/issues/smart_ip