dolibarr/htdocs/core/class/dolgeoip.class.php

<?php
/* Copyright (C) 2009-2012  Laurent Destailleur         <eldy@users.sourceforge.net>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024		MDW							<mdeweerd@users.noreply.github.com>
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 program. If not, see <https://www.gnu.org/licenses/>.
 * or see https://www.gnu.org/
 */

/**
 *  \file		htdocs/core/class/dolgeoip.class.php
 * 	\ingroup	geoip
 *  \brief		File of class to manage module geoip
 */


/**
 * 		\class      DolGeoIP
 *      \brief      Class to manage GeoIP conversion
 *      			Usage:
 *					$geoip=new GeoIP('country',$datfile);
 *					$geoip->getCountryCodeFromIP($ip);
 *					$geoip->close();
 */
class DolGeoIP
{
	/**
	 * @var \GeoIp2\Database\Reader|\GeoIP|string
	 */
	public $gi;

	/**
	 * @var string
	 */
	public $error;

	/**
	 * @var string
	 */
	public $errorlabel;

	/**
	 * Constructor
	 *
	 * @param 	'country'|'city'	$type		'country' or 'city'
	 * @param	string	$datfile	Data file
	 */
	public function __construct($type, $datfile)
	{
		global $conf;

		$geoipversion = '2'; // 'php', or geoip version '2'
		if (getDolGlobalString('GEOIP_VERSION')) {
			$geoipversion = getDolGlobalString('GEOIP_VERSION');
		}

		if ($type == 'country') {
			// geoip may have been already included with PEAR
			if ($geoipversion == '2' || ($geoipversion != 'php' && !function_exists('geoip_country_code_by_name'))) {
				if (function_exists('stream_wrapper_restore')) {
					stream_wrapper_restore('phar');
				}
				require_once DOL_DOCUMENT_ROOT.'/includes/geoip2/geoip2.phar';
			}
		} elseif ($type == 'city') {
			// geoip may have been already included with PEAR
			if ($geoipversion == '2' || ($geoipversion != 'php' && !function_exists('geoip_country_code_by_name'))) {
				if (function_exists('stream_wrapper_restore')) {
					stream_wrapper_restore('phar');
				}
				require_once DOL_DOCUMENT_ROOT.'/includes/geoip2/geoip2.phar';
			}
		} else {
			print 'ErrorBadParameterInConstructor';
			return;
		}

		// Here, function exists (embedded into PHP or exists because we made include)
		if (empty($type) || empty($datfile)) {
			$this->errorlabel = 'Constructor was called with no datafile parameter';
			dol_syslog('DolGeoIP '.$this->errorlabel, LOG_ERR);
			return;
		}
		if (!file_exists($datfile) || !is_readable($datfile)) {
			$this->error = 'ErrorGeoIPClassNotInitialized';
			$this->errorlabel = "Datafile ".$datfile." not found";
			dol_syslog('DolGeoIP '.$this->errorlabel, LOG_ERR);
			return;
		}

		if ($geoipversion == '2') {
			try {
				// @phpstan-ignore-next-line
				$this->gi = new GeoIp2\Database\Reader($datfile); // '/usr/local/share/GeoIP/GeoIP2-City.mmdb'
			} catch (Exception $e) {
				$this->error = $e->getMessage();
				dol_syslog('DolGeoIP '.$this->errorlabel, LOG_ERR);
				return;
			}
		} elseif (function_exists('geoip_open') && defined('GEOIP_STANDARD')) {
			$this->gi = geoip_open($datfile, constant('GEOIP_STANDARD'));
		} elseif (function_exists('geoip_country_code_by_name')) {
			$this->gi = 'NOGI'; // We are using embedded php geoip functions
			//print 'function_exists(geoip_country_code_by_name))='.function_exists('geoip_country_code_by_name');
			//print geoip_database_info();
		} else {
			$this->gi = ''; // For avoid error
		}
	}

	/**
	 * Return in lower case the country code from an ip
	 *
	 * @param	string	$ip		IP to scan
	 * @return	string			Country code (two letters)
	 */
	public function getCountryCodeFromIP($ip)
	{
		global $conf;

		$geoipversion = '2'; // 'php', or '2'
		if (getDolGlobalString('GEOIP_VERSION')) {
			$geoipversion = getDolGlobalString('GEOIP_VERSION');
		}

		if (empty($this->gi)) {
			return '';
		}
		if ($this->gi == 'NOGI') {
			// geoip_country_code_by_addr does not exists
			return strtolower(geoip_country_code_by_name($ip));
		} else {
			if (preg_match('/^[0-9]+.[0-9]+\.[0-9]+\.[0-9]+/', $ip)) {
				if ($geoipversion == '2') {
					try {
						$record = $this->gi->country($ip);
						return strtolower($record->country->isoCode);
					} catch (Exception $e) {
						//return $e->getMessage();
						return '';
					}
				} else {
					if (!function_exists('geoip_country_code_by_addr')) {
						return strtolower(geoip_country_code_by_name($ip));
					}
					return strtolower(geoip_country_code_by_addr($this->gi, $ip));
				}
			} else {
				if ($geoipversion == '2') {
					try {
						$record = $this->gi->country($ip);
						return strtolower($record->country->isoCode);
					} catch (Exception $e) {
						//return $e->getMessage();
						return '';
					}
				} else {
					if (function_exists('geoip_country_code_by_addr_v6')) {
						return strtolower(geoip_country_code_by_addr_v6($this->gi, $ip));
					} elseif (function_exists('geoip_country_code_by_name_v6')) {
						return strtolower(geoip_country_code_by_name_v6($this->gi, $ip));
					}
					return '';
				}
			}
		}
	}

	/**
	 * Return in lower case the country code from a host name
	 *
	 * @param	string	$name	FQN of host (example: myserver.xyz.com)
	 * @return	string			Country code (two letters)
	 */
	public function getCountryCodeFromName($name)
	{
		global $conf;

		$geoipversion = '2'; // 'php', or '2'
		if (getDolGlobalString('GEOIP_VERSION')) {
			$geoipversion = getDolGlobalString('GEOIP_VERSION');
		}

		if (empty($this->gi)) {
			return '';
		}

		if ($geoipversion == '2') {
			try {
				$record = $this->gi->country($name);
				return $record->country->isoCode;
			} catch (Exception $e) {
				//return $e->getMessage();
				return '';
			}
		} else {
			return strtolower(geoip_country_code_by_name($name));
		}
	}

	/**
	 * Return version of data file
	 *
	 * @return  string      Version of datafile
	 */
	public function getVersion()
	{
		global $conf;

		$geoipversion = '2'; // 'php', or '2'
		if (getDolGlobalString('GEOIP_VERSION')) {
			$geoipversion = getDolGlobalString('GEOIP_VERSION');
		}

		if ($geoipversion == 'php') {
			if ($this->gi == 'NOGI') {
				return geoip_database_info();
			} else {
				return 'geoip_database_info() function not available';
			}
		}

		return 'Not available (not using PHP internal geo functions - We are using embedded Geoip v'.$geoipversion.')';
	}

	/**
	 * Close geoip object
	 *
	 * @return	void
	 */
	public function close()
	{
		if (function_exists('geoip_close')) {
			// With some geoip with PEAR, geoip_close function may not exists
			geoip_close($this->gi);
		}
	}
}