class HostMultipleWhitelistConfirm in http:BL 8

Provides a multiple host white-listing (and un-banning) confirmation form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\httpbl\Form\HostMultipleWhitelistConfirm

Expanded class hierarchy of HostMultipleWhitelistConfirm

1 string reference to 'HostMultipleWhitelistConfirm'

httpbl.routing.yml in ./httpbl.routing.yml: httpbl.routing.yml

File

src/Form/HostMultipleWhitelistConfirm.php, line 18

Namespace

Drupal\httpbl\Form

View source

class HostMultipleWhitelistConfirm extends ConfirmFormBase {

  /**
   * The array of hosts to whitelist.
   *
   * @var string[][]
   */
  protected $hostInfo = array();

  /**
   * The tempstore factory.
   *
   * @var \Drupal\user\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * The host entity and storage manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $manager;

  /**
   * The ban IP manager.
   *
   * @var \Drupal\ban\BanIpManagerInterface
   */
  protected $banManager;

  /**
   * A logger arbitration instance.
   *
   * @var \Drupal\httpbl\Logger\HttpblLogTrapperInterface
   */
  protected $logTrapper;

  /**
   * Constructs a new HostMultipleWhitelistConfirm form object.
   *
   * @param \Drupal\user\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $manager
   *   The entity manager.
   * @param \Drupal\ban\BanIpManagerInterface $banManager
   *   The Ban manager.
   * @param \Drupal\httpbl\Logger\HttpblLogTrapperInterface $logTrapper
   *   A logger arbitration instance.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $manager, BanIpManagerInterface $banManager, HttpblLogTrapperInterface $logTrapper) {
    $this->tempStoreFactory = $temp_store_factory;

    //Get the storage info from the EntityTypeManager.
    $this->storage = $manager
      ->getStorage('host');
    $this->banManager = $banManager;
    $this->logTrapper = $logTrapper;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('user.private_tempstore'), $container
      ->get('entity_type.manager'), $container
      ->get('ban.ip_manager'), $container
      ->get('httpbl.logtrapper'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'host_multiple_whitelist_confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('<p>Any banned hosts will be un-banned.  Already white-listed hosts will be ignored.</p><p>These actions are un-doable by using other actions*.</p>');
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->formatPlural(count($this->hostInfo), 'Are you sure you want to white-list this host?', 'Are you sure you want to white-list these hosts?');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('entity.host.collection');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return t('White-list');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Retrieve temporary storage.
    $this->hostInfo = $this->tempStoreFactory
      ->get('host_multiple_whitelist_confirm')
      ->get(\Drupal::currentUser()
      ->id());
    if (empty($this->hostInfo)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }

    /** @var \Drupal\httpbl\HostInterface[] $hosts */
    $hosts = $this->storage
      ->loadMultiple(array_keys($this->hostInfo));
    $items = [];

    // Prepare a list of any matching, white-listed IPs, so we can include the
    // fact they are already white-listed in the confirmation message.
    foreach ($this->hostInfo as $id => $host_ips) {
      foreach ($host_ips as $host_ip) {
        $host = $hosts[$id];
        $host_status = $host
          ->getHostStatus();
        $key = $id . ':' . $host_ip;
        $default_key = $id . ':' . $host_ip;

        // If we have any already white-listed hosts, we theme notice they will
        // be ignored.
        if ($host_status == HTTPBL_LIST_SAFE) {
          $items[$default_key] = [
            'label' => [
              '#markup' => $this
                ->t('Ignoring @label - <em> already white-listed.</em>', [
                '@label' => $host
                  ->label(),
              ]),
            ],
            'ignored hosts' => [
              '#theme' => 'item_list',
            ],
          ];
        }
        elseif (!isset($items[$default_key])) {
          $items[$key] = $host
            ->label();
        }
      }
    }
    $form['hosts'] = array(
      '#theme' => 'item_list',
      '#items' => $items,
    );
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('confirm') && !empty($this->hostInfo)) {
      $whitelist_hosts = [];
      $unban_hosts = [];

      /** @var \Drupal\httpbl\HostInterface[] $hosts */
      $hosts = $this->storage
        ->loadMultiple(array_keys($this->hostInfo));
      foreach ($this->hostInfo as $id => $host_ips) {
        foreach ($host_ips as $host_ip) {
          $host = $hosts[$id];
          $host_status = $host
            ->getHostStatus();

          // If this host is banned...
          if ($this->banManager
            ->isBanned($host_ip)) {

            // Queue the host for un-banning;
            $unban_hosts[$id] = $host;
          }

          // If this host is not already white-listed
          if ($host_status != HTTPBL_LIST_SAFE) {

            // Queue the host for white-listing;
            $whitelist_hosts[$id] = $host;
          }
        }
      }
      if ($unban_hosts) {
        foreach ($unban_hosts as $unban_host) {
          $this->banManager
            ->unbanIp($unban_host
            ->getHostIp());
        }
        $this->logTrapper
          ->trapNotice('Un-banned @count hosts.', array(
          '@count' => count($unban_hosts),
        ));
        $unbanned_count = count($unban_hosts);
        drupal_set_message($this
          ->formatPlural($unbanned_count, 'Un-banned 1 host.', 'Un-banned @count hosts.'));
      }
      if ($whitelist_hosts) {
        $now = \Drupal::time()
          ->getRequestTime();
        $offset = \Drupal::state()
          ->get('httpbl.safe_offset') ?: 10800;
        $timestamp = $now + $offset;
        foreach ($whitelist_hosts as $id => $whitelist_host) {
          $host = $whitelist_host;
          $host
            ->setHostStatus(HTTPBL_LIST_SAFE);
          $host
            ->setExpiry($timestamp);
          $host
            ->setSource(HTTPBL_ADMIN_SOURCE);
          $host
            ->save();
        }
        $whitelist_count = count($whitelist_hosts);
        $this->logTrapper
          ->trapNotice('White-listed @count hosts.', array(
          '@count' => $whitelist_count,
        ));
        drupal_set_message($this
          ->formatPlural($whitelist_count, 'White-listed 1 host.', 'White-listed @count hosts.'));
      }
      else {

        // Let user know if there was nothing to do.
        drupal_set_message('No hosts were found banned.  One or more were found already white-listed. There was nothing to do.', 'warning');
      }
      $this->tempStoreFactory
        ->get('host_multiple_whitelist_confirm')
        ->delete(\Drupal::currentUser()
        ->id());
    }
    $form_state
      ->setRedirect('entity.host.collection');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	1
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
HostMultipleWhitelistConfirm::$banManager	protected	property	The ban IP manager.
HostMultipleWhitelistConfirm::$hostInfo	protected	property	The array of hosts to whitelist.
HostMultipleWhitelistConfirm::$logTrapper	protected	property	A logger arbitration instance.
HostMultipleWhitelistConfirm::$manager	protected	property	The host entity and storage manager.
HostMultipleWhitelistConfirm::$tempStoreFactory	protected	property	The tempstore factory.
HostMultipleWhitelistConfirm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
HostMultipleWhitelistConfirm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
HostMultipleWhitelistConfirm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
HostMultipleWhitelistConfirm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
HostMultipleWhitelistConfirm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
HostMultipleWhitelistConfirm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
HostMultipleWhitelistConfirm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
HostMultipleWhitelistConfirm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
HostMultipleWhitelistConfirm::__construct	public	function	Constructs a new HostMultipleWhitelistConfirm form object.
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.

You are here

class HostMultipleWhitelistConfirm in http:BL 8

Hierarchy

File

Namespace

Members

API Navigation