class DomainValidator in Domain Access 8

Provides validation of domain strings against RFC standards for hostnames.

Hierarchy

• class \Drupal\domain\DomainValidator implements DomainValidatorInterface uses StringTranslationTrait

1 string reference to 'DomainValidator'

domain.services.yml in domain/domain.services.yml

domain/domain.services.yml

1 service uses DomainValidator

domain.validator in domain/domain.services.yml

Drupal\domain\DomainValidator

File

domain/src/DomainValidator.php, line 15

Namespace

Drupal\domain

class DomainValidator implements DomainValidatorInterface {
  use StringTranslationTrait;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The HTTP client.
   *
   * @var \GuzzleHttp\Client
   */
  protected $httpClient;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a DomainValidator object.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \GuzzleHttp\ClientInterface $http_client
   *   A Guzzle client object.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory, ClientInterface $http_client, EntityTypeManagerInterface $entity_type_manager) {
    $this->moduleHandler = $module_handler;
    $this->configFactory = $config_factory;
    $this->httpClient = $http_client;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function validate($hostname) {
    $error_list = [];

    // Check for at least one dot or the use of 'localhost'.
    // Note that localhost can specify a port.
    $localhost_check = explode(':', $hostname);
    if (substr_count($hostname, '.') == 0 && $localhost_check[0] != 'localhost') {
      $error_list[] = $this
        ->t('At least one dot (.) is required, except when using <em>localhost</em>.');
    }

    // Check for one colon only.
    if (substr_count($hostname, ':') > 1) {
      $error_list[] = $this
        ->t('Only one colon (:) is allowed.');
    }
    elseif (substr_count($hostname, ':') == 1) {
      $parts = explode(':', $hostname);
      $port = (int) $parts[1];
      if (strcmp($port, $parts[1])) {
        $error_list[] = $this
          ->t('The port protocol must be an integer.');
      }
    }

    // The domain cannot begin or end with a period.
    if (substr($hostname, 0, 1) == '.') {
      $error_list[] = $this
        ->t('The domain must not begin with a dot (.)');
    }

    // The domain cannot begin or end with a period.
    if (substr($hostname, -1) == '.') {
      $error_list[] = $this
        ->t('The domain must not end with a dot (.)');
    }

    // Check for valid characters, unless using non-ASCII domains.
    $config = $this->configFactory
      ->get('domain.settings');
    $non_ascii = $config
      ->get('allow_non_ascii');
    if (!$non_ascii) {
      $pattern = '/^[a-z0-9\\.\\-:]*$/i';
      if (!preg_match($pattern, $hostname)) {
        $error_list[] = $this
          ->t('Only alphanumeric characters, dashes, and a colon are allowed.');
      }
    }

    // Check for lower case.
    if ($hostname != mb_strtolower($hostname)) {
      $error_list[] = $this
        ->t('Only lower-case characters are allowed.');
    }

    // Check for 'www' prefix if redirection / handling is
    // enabled under global domain settings.
    // Note that www prefix handling must be set explicitly in the UI.
    // See http://drupal.org/node/1529316 and http://drupal.org/node/1783042
    if ($config
      ->get('www_prefix') && substr($hostname, 0, strpos($hostname, '.')) == 'www') {
      $error_list[] = $this
        ->t('WWW prefix handling: Domains must be registered without the www. prefix.');
    }

    // Allow modules to alter this behavior.
    $this->moduleHandler
      ->alter('domain_validate', $error_list, $hostname);
    return $error_list;
  }

  /**
   * {@inheritdoc}
   */
  public function checkResponse(DomainInterface $domain) {
    $url = $domain
      ->getPath() . drupal_get_path('module', 'domain') . '/tests/200.png';
    try {

      // GuzzleHttp no longer allows for bogus URL calls.
      $request = $this->httpClient
        ->get($url);
    } catch (RequestException $e) {

      // File a general server failure.
      $domain
        ->setResponse(500);
      return $domain
        ->getResponse();
    }

    // Expected result (i.e. no exception thrown.)
    $domain
      ->setResponse($request
      ->getStatusCode());
    return $domain
      ->getResponse();
  }

  /**
   * {@inheritdoc}
   */
  public function getRequiredFields() {
    return [
      'hostname',
      'name',
      'scheme',
      'status',
      'weight',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DomainValidator::$configFactory	protected	property	The config factory.
DomainValidator::$entityTypeManager	protected	property	The entity type manager.
DomainValidator::$httpClient	protected	property	The HTTP client.
DomainValidator::$moduleHandler	protected	property	The module handler.
DomainValidator::checkResponse	public	function	Tests that a domain responds correctly. Overrides DomainValidatorInterface::checkResponse
DomainValidator::getRequiredFields	public	function	Returns the properties required to create a domain record. Overrides DomainValidatorInterface::getRequiredFields
DomainValidator::validate	public	function	Validates the hostname for a domain. Overrides DomainValidatorInterface::validate
DomainValidator::__construct	public	function	Constructs a DomainValidator object.
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.