class Cdn in GeoIP API 8.2

CDN geolocation provider.

Plugin annotation

@GeoLocator(
  id = "cdn",
  label = "CDN",
  description = "Checks for geolocation headers sent by CDN services",
  weight = -10
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geoip\Plugin\GeoLocator\GeoLocatorBase implements ContainerFactoryPluginInterface, GeoLocatorInterface
      • class \Drupal\geoip\Plugin\GeoLocator\Cdn implements ContainerFactoryPluginInterface

1 file declares its use of Cdn

CdnGeoLocatorTest.php in tests/src/Unit/CdnGeoLocatorTest.php

File

src/Plugin/GeoLocator/Cdn.php, line 17

Namespace

Drupal\geoip\Plugin\GeoLocator

class Cdn extends GeoLocatorBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function geolocate($ip_address) {
    if ($this
      ->checkCloudflare()) {
      $country_code = $this
        ->checkCloudflare();
    }
    elseif ($this
      ->checkCloudFront()) {
      $country_code = $this
        ->checkCloudFront();
    }
    elseif ($this
      ->checkCustomHeader()) {
      $country_code = $this
        ->checkCustomHeader();
    }
    else {

      // Could not geolocate based off of CDN.
      if ($this->geoIpConfig
        ->get('debug')) {
        $this->logger
          ->notice($this
          ->t('Unable to look up %ip_address via CDN header', [
          '%ip_address' => $ip_address,
        ]));
      }
      return NULL;
    }
    if ($this->geoIpConfig
      ->get('debug')) {
      $this->logger
        ->notice($this
        ->t('Discovered %ip_address via CDN header', [
        '%ip_address' => $ip_address,
      ]));
    }
    return $country_code;
  }

  /**
   * Check for Cloudflare geolocation header.
   *
   * @return string
   *   The country code specified in the header.
   */
  protected function checkCloudflare() {
    return !empty($_SERVER['HTTP_CF_IPCOUNTRY']) ? $_SERVER['HTTP_CF_IPCOUNTRY'] : NULL;
  }

  /**
   * Check for Amazon CloudFront geolocation header.
   *
   * @return string
   *   The country code specified in the header.
   */
  protected function checkCloudFront() {
    return !empty($_SERVER['HTTP_CLOUDFRONT_VIEWER_COUNTRY']) ? $_SERVER['HTTP_CLOUDFRONT_VIEWER_COUNTRY'] : NULL;
  }

  /**
   * Check for a custom geolocation header.
   *
   * @return string
   *   The country code specified in the header.
   */
  protected function checkCustomHeader() {

    // @todo: Implement setting for custom header to check.
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Cdn::checkCloudflare	protected	function	Check for Cloudflare geolocation header.
Cdn::checkCloudFront	protected	function	Check for Amazon CloudFront geolocation header.
Cdn::checkCustomHeader	protected	function	Check for a custom geolocation header.
Cdn::geolocate	public	function	Performs geolocation on an address. Overrides GeoLocatorInterface::geolocate
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
GeoLocatorBase::$geoIpConfig	protected	property	The GeoIP module configuration.
GeoLocatorBase::$logger	protected	property	The logger.
GeoLocatorBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
GeoLocatorBase::getDescription	public	function	Get the plugin's description. Overrides GeoLocatorInterface::getDescription
GeoLocatorBase::getId	public	function	Get the plugin's ID. Overrides GeoLocatorInterface::getId
GeoLocatorBase::getLabel	public	function	Get the plugin's label. Overrides GeoLocatorInterface::getLabel
GeoLocatorBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.