You are here

Home » API reference » http:BL 8 » HostMultipleUnbanConfirm.php

class HostMultipleUnbanConfirm in http:BL 8

Provides a multiple host un-ban blacklisted confirmation form.

Hierarchy

Expanded class hierarchy of HostMultipleUnbanConfirm

1 string reference to 'HostMultipleUnbanConfirm'
httpbl.routing.yml in ./httpbl.routing.yml
httpbl.routing.yml

File

src/Form/HostMultipleUnbanConfirm.php, line 19

Namespace

Drupal\httpbl\Form
View source 
class HostMultipleUnbanConfirm extends ConfirmFormBase {

  /**
   * The array of hosts to un-ban.
   *
   * @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 HostMultipleUnbanConfirm 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_unban_blacklisted_confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('<p>This action will un-ban any selected and banned hosts.  Otherwise, any listed status <em>remains</em> unchanged.</p><p>Any "banned but not blacklisted" hosts will also be un-banned, but that occurrance should be rare and warrants further attention.</p><p>This action can be undone by using other actions.</p>');
  }

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

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

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

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

    // Retrieve temporary storage.
    $this->hostInfo = $this->tempStoreFactory
      ->get('host_multiple_unban_blacklisted_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, banned IPs, so we can include the fact
    // they are already banned in the confirmation message.  Also check and
    // warn user if their own IP is in the list!
    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 non-blacklisted hosts, explain they will be ignored.
        if ($host_status != HTTPBL_LIST_BLACK) {

          // Check also to be certain that it is not somehow banned, anyway.
          if (!$this->banManager
            ->isBanned($host_ip)) {
            $items[$default_key] = [
              'label' => [
                '#markup' => $this
                  ->t('@label - <em> is not blacklisted or banned.</em>', [
                  '@label' => $host
                    ->label(),
                ]),
              ],
              'ignored hosts' => [
                '#theme' => 'item_list',
              ],
            ];
          }
          else {

            // Warn user that a "banned but not blacklisted" occurrance has
            // been found.  This should never happen unless IPs have been banned
            // through direct use of the Ban module.
            // Any "banned but not blacklisted" hosts will be un-banned, but
            // the situation warrants further attention.
            $items[$default_key] = [
              'label' => [
                '#markup' => $this
                  ->t('@label - <em> is banned but not blacklisted!  Restrict access to Ban module!  This host will be un-banned.</em>', [
                  '@label' => $host
                    ->label(),
                ]),
              ],
              'rescued hosts' => [
                '#theme' => 'item_list',
              ],
            ];
            $banUrl = Url::fromUri('internal:/admin/people/permissions#module-ban');
            $banUrl_options = [
              'attributes' => [
                'target' => '_blank',
              ],
            ];
            $banUrl
              ->setOptions($banUrl_options);
            $banLink = Link::fromTextAndUrl(t('review roles with access to the Ban module'), $banUrl)
              ->toString();
            $message = t('Some hosts were found <strong>banned but not blacklisted</strong>. They will be un-banned.</br>Please @ban.', [
              '@ban' => $banLink,
            ]);
            drupal_set_message($message, 'warning', FALSE);
          }
        }
        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)) {
      $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];
          if ($this->banManager
            ->isBanned($host_ip)) {

            // Queue the un-banning of any banned host found;
            $unban_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.'));
      }
      else {

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

}

Members

Namesort descending 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
HostMultipleUnbanConfirm::$banManager protected property The ban IP manager.
HostMultipleUnbanConfirm::$hostInfo protected property The array of hosts to un-ban.
HostMultipleUnbanConfirm::$logTrapper protected property A logger arbitration instance.
HostMultipleUnbanConfirm::$manager protected property The host entity and storage manager.
HostMultipleUnbanConfirm::$tempStoreFactory protected property The tempstore factory.
HostMultipleUnbanConfirm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
HostMultipleUnbanConfirm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
HostMultipleUnbanConfirm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
HostMultipleUnbanConfirm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
HostMultipleUnbanConfirm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
HostMultipleUnbanConfirm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
HostMultipleUnbanConfirm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
HostMultipleUnbanConfirm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
HostMultipleUnbanConfirm::__construct public function Constructs a new HostMultipleUnbanConfirm 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.