<?php
namespace WP_Statistics\Service\Geolocation;
use WP_Error;
use WP_STATISTICS\Option;
use WP_Statistics\Service\Geolocation\Provider\CloudflareGeolocationProvider;
use WP_Statistics\Service\Geolocation\Provider\DbIpProvider;
use WP_Statistics\Service\Geolocation\Provider\MaxmindGeoIPProvider;
class GeolocationFactory
{
/**
* Holds a provider set to override the default provider.
*
* @var GeoServiceProviderInterface|null
*/
private static $forcedProvider = null;
/**
* Get geolocation data for a given IP address using the configured provider.
*
* @param string $ipAddress
* @return array
*/
public static function getLocation(string $ipAddress, $provider = null)
{
self::$forcedProvider = $provider;
$provider = self::getProviderInstance();
$geolocationService = new GeolocationService($provider);
return $geolocationService->getGeolocation($ipAddress);
}
/**
* Download the geolocation database using the configured provider.
*
* @return bool|WP_Error
*/
public static function downloadDatabase($provider = null)
{
self::$forcedProvider = $provider;
$provider = self::getProviderInstance();
$geolocationService = new GeolocationService($provider);
return $geolocationService->downloadDatabase();
}
/**
* Get an instance of the configured geolocation provider.
*
* @return MaxmindGeoIPProvider
*/
public static function getProviderInstance()
{
$locationDetection = Option::get('geoip_location_detection_method', 'maxmind');
if (
'cf' === $locationDetection &&
method_exists(CloudflareGeolocationProvider::class, 'isAvailable') &&
CloudflareGeolocationProvider::isAvailable()
) {
$geoIpProvider = CloudflareGeolocationProvider::class;
} else {
$geoIpProvider = 'dbip' === $locationDetection ? DbIpProvider::class : MaxmindGeoIPProvider::class;
}
if (! is_null(self::$forcedProvider)) {
$geoIpProvider = self::$forcedProvider;
}
/**
* Filter the geolocation provider name. This allows developers to change the provider used for geolocation.
*/
$providerName = apply_filters('wp_statistics_geolocation_provider', $geoIpProvider);
// If the provider class exists, instantiate it
if (class_exists($providerName)) {
return new $providerName();
}
return new MaxmindGeoIPProvider();
}
}