GeoLocationTool.inc.php

<?php
 
include('lib' . DIRECTORY_SEPARATOR . 'geoIp' . DIRECTORY_SEPARATOR . 'geoipcity.inc');
 
class GeoLocationTool {
 
   var $_geoLocationTool;
 
   var $_regionName;
 
   var $_isDbFilePresent;
 
   function __construct() {
      $geoLocationDbFile = dirname(__FILE__) . DIRECTORY_SEPARATOR . "GeoLiteCity.dat";
      if (file_exists($geoLocationDbFile)) {
         $isDbFilePresent = true;
         $this->_geoLocationTool = geoip_open($geoLocationDbFile, GEOIP_STANDARD);
         include('lib' . DIRECTORY_SEPARATOR . 'geoIp' . DIRECTORY_SEPARATOR . 'geoipregionvars.php');
         $this->_regionName = $GEOIP_REGION_NAME;
      } else {
         $isDbFilePresent = false;
      }
 
      $this->_isDbFilePresent = $isDbFilePresent;
   }
 
   //
   // Public methods.
   //
   function isPresent() {
      return $this->_isDbFilePresent;
   }
 
   function getGeoLocation($ip) {
      // If no geolocation tool, the geo database file is missing.
      if (!$this->_geoLocationTool) return array(null, null, null);
 
      $record = geoip_record_by_addr($this->_geoLocationTool, $ip);
 
      if (!$record) {
         return array(null, null, null);
      }
 
      $regionName = null;
      if(isset($this->_regionName[$record->country_code][$record->region])) {
         $regionName = $this->_regionName[$record->country_code][$record->region];
      }
 
      return array(
         $record->country_code,
         utf8_encode($record->city),
         $record->region
      );
   }
 
   function getAllCountryCodes() {
      if (!$this->_geoLocationTool) return null;
 
      $tool = $this->_geoLocationTool;
      $countryCodes = $tool->GEOIP_COUNTRY_CODES;
 
      // Overwrite the first empty record with the code to
      // unknow country.
      $countryCodes[0] = STATISTICS_UNKNOWN_COUNTRY_ID;
      return $countryCodes;
   }
 
   function get3LettersCountryCode($countryCode) {
      return $this->_getCountryCodeOnList($countryCode, 'GEOIP_COUNTRY_CODES3');
   }
 
   function get2LettersCountryCode($countryCode3) {
      return $this->_getCountryCodeOnList($countryCode3, 'GEOIP_COUNTRY_CODES');
   }
 
   function getRegions($countryId) {
      $regions = array();
      $database = $this->_regionName;
      if (isset($database[$countryId])) {
         $regions = $database[$countryId];
      }
 
      return $regions;
   }
 
   function _getCountryCodeOnList($countryCode, $countryCodeListName) {
      $returner = null;
 
      if (!$this->_geoLocationTool) return $returner;
      $tool = $this->_geoLocationTool;
 
      if (isset($tool->$countryCodeListName)) {
         $countryCodeList = $tool->$countryCodeListName;
      } else {
         return $returner;
      }
 
      $countryCodesIndex = $tool->GEOIP_COUNTRY_CODE_TO_NUMBER;
      $countryCodeIndex = null;
 
      if (isset($countryCodesIndex[$countryCode])) {
         $countryCodeIndex = $countryCodesIndex[$countryCode];
      }
 
      if ($countryCodeIndex) {
         if (isset($countryCodeList[$countryCodeIndex])) {
            $returner = $countryCodeList[$countryCodeIndex];
         }
      }
 
      return $returner;
   }
}