You are here

Home » API reference » IP-based Determination of a Visitor's Country 8 » Ip2CountryController.php

class Ip2CountryController in IP-based Determination of a Visitor's Country 8

Controller routines for user routes.

Hierarchy

Expanded class hierarchy of Ip2CountryController

File

src/Controller/Ip2CountryController.php, line 16

Namespace

Drupal\ip2country\Controller
View source 
class Ip2CountryController extends ControllerBase {

  /**
   * The logger service.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $logger;

  /**
   * The core country_manager service.
   *
   * @var \Drupal\Core\Locale\CountryManagerInterface
   */
  protected $countryManager;

  /**
   * The ip2country.lookup service.
   *
   * @var \Drupal\ip2country\Ip2CountryLookupInterface
   */
  protected $ip2countryLookup;

  /**
   * The ip2country.manager service.
   *
   * @var \Drupal\ip2country\Ip2CountryManagerInterface
   */
  protected $ip2countryManager;

  /**
   * Constructs an Ip2CountryController.
   *
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger
   *   The logger factory service.
   * @param \Drupal\Core\Locale\CountryManagerInterface $countryManager
   *   The core country_manager service.
   * @param \Drupal\ip2country\Ip2CountryLookupInterface $ip2countryLookup
   *   The ip2country.lookup service.
   * @param \Drupal\ip2country\Ip2CountryManagerInterface $ip2countryManager
   *   The ip2country.manager service.
   */
  public function __construct(LoggerChannelFactoryInterface $logger, CountryManagerInterface $countryManager, Ip2CountryLookupInterface $ip2countryLookup, Ip2CountryManagerInterface $ip2countryManager) {
    $this->logger = $logger;
    $this->countryManager = $countryManager;
    $this->ip2countryLookup = $ip2countryLookup;
    $this->ip2countryManager = $ip2countryManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('logger.factory'), $container
      ->get('country_manager'), $container
      ->get('ip2country.lookup'), $container
      ->get('ip2country.manager'));
  }

  /**
   * AJAX callback to update the IP to Country database.
   *
   * @param string $rir
   *   String with name of IP registry. One of 'afrinic', 'arin', 'lacnic',
   *   'ripe'. Not case sensitive.
   *
   * @return string
   *   JSON object for display by jQuery script.
   */
  public function updateDatabaseAction($rir) {
    $ip2country_config = $this
      ->config('ip2country.settings');
    $watchdog = $ip2country_config
      ->get('watchdog');
    $md5_checksum = $ip2country_config
      ->get('md5_checksum');
    $batch_size = $ip2country_config
      ->get('batch_size');

    // Update DB from RIR.
    $status = $this->ip2countryManager
      ->updateDatabase($rir, $md5_checksum, $batch_size);
    if ($status != FALSE) {
      if ($watchdog) {
        $this->logger
          ->get('ip2country')
          ->notice('Manual database update from @registry server.', [
          '@registry' => mb_strtoupper($rir),
        ]);
      }
      print Json::encode([
        'count' => $this
          ->t('@rows rows affected.', [
          '@rows' => $this->ip2countryManager
            ->getRowCount(),
        ]),
        'server' => $rir,
        'message' => $this
          ->t('The IP to Country database has been updated from @server.', [
          '@server' => mb_strtoupper($rir),
        ]),
      ]);
    }
    else {
      if ($watchdog) {
        $this->logger
          ->get('ip2country')
          ->notice('Manual database update from @registry server FAILED.', [
          '@registry' => mb_strtoupper($rir),
        ]);
      }
      print Json::encode([
        'count' => $this
          ->t('@rows rows affected.', [
          '@rows' => 0,
        ]),
        'server' => $rir,
        'message' => $this
          ->t('The IP to Country database update failed.'),
      ]);
    }
    exit;
  }

  /**
   * AJAX callback to lookup an IP address in the database.
   *
   * @param string $ip_address
   *   String with IP address.
   *
   * @return string
   *   JSON object for display by jQuery script.
   */
  public function lookupAction($ip_address) {

    // Return results of manual lookup.
    $country_code = $this->ip2countryLookup
      ->getCountry($ip_address);
    if ($country_code) {
      $country_list = $this->countryManager
        ->getList();
      $country_name = $country_list[$country_code];
      print Json::encode([
        'message' => $this
          ->t('IP Address @ip is assigned to @country (@code).', [
          '@ip' => $ip_address,
          '@country' => $country_name,
          '@code' => $country_code,
        ]),
      ]);
    }
    else {
      print Json::encode([
        'message' => $this
          ->t('IP Address @ip is not assigned to a country.', [
          '@ip' => $ip_address,
        ]),
      ]);
    }
    exit;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
Ip2CountryController::$countryManager protected property The core country_manager service.
Ip2CountryController::$ip2countryLookup protected property The ip2country.lookup service.
Ip2CountryController::$ip2countryManager protected property The ip2country.manager service.
Ip2CountryController::$logger protected property The logger service.
Ip2CountryController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
Ip2CountryController::lookupAction public function AJAX callback to lookup an IP address in the database.
Ip2CountryController::updateDatabaseAction public function AJAX callback to update the IP to Country database.
Ip2CountryController::__construct public function Constructs an Ip2CountryController.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.