You are here

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

class HostMultipleBanConfirm in http:BL 8

Provides a multiple host blacklisting and banning confirmation form.

Hierarchy

Expanded class hierarchy of HostMultipleBanConfirm

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

File

src/Form/HostMultipleBanConfirm.php, line 18

Namespace

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

  /**
   * The array of hosts to blacklist and 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 HostMultipleBanConfirm 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_ban_confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $banningEnabled = TRUE ? \Drupal::state()
      ->get('httpbl.storage') == HTTPBL_DB_HH_DRUPAL : ($banningEnabled = FALSE);
    if ($banningEnabled) {
      return $this
        ->t('<p>Already banned hosts will be ignored.  Already blacklisted hosts will refresh their expiry.</p><p>These actions are un-doable by using other actions*.</p><p>*If you blacklist yourself, don\'t panic; use "drush sos --stop", fix your IP, then don\'t forget to restart ("drush sos --start").</p>');
    }
    else {
      return $this
        ->t('<p>Already blacklisted hosts will refresh their expiry.</p><p>These actions are un-doable by using other actions*.</p><p>*If you blacklist yourself, don\'t panic; use "drush sos --stop", fix your IP, then don\'t forget to restart ("drush sos --start").</p>');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    $banningEnabled = TRUE ? \Drupal::state()
      ->get('httpbl.storage') == HTTPBL_DB_HH_DRUPAL : ($banningEnabled = FALSE);
    if ($banningEnabled) {
      return $this
        ->formatPlural(count($this->hostInfo), 'Are you sure you want to blacklist and ban this host?', 'Are you sure you want to blacklist and ban these hosts?');
    }
    else {
      return $this
        ->formatPlural(count($this->hostInfo), 'Are you sure you want to blacklist this host?', 'Are you sure you want to blacklist these hosts?');
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    global $blacklistConfirmText;
    return $blacklistConfirmText;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfirmText($userInList = FALSE, $blacklistConfirmText = NULL) {
    global $blacklistConfirmText;
    $banningEnabled = TRUE ? \Drupal::state()
      ->get('httpbl.storage') == HTTPBL_DB_HH_DRUPAL : ($banningEnabled = FALSE);
    if ($userInList && $banningEnabled) {
      $blacklistConfirmText = t('Blacklist and Ban Hosts -- including ME!');
    }
    elseif ($banningEnabled) {
      $blacklistConfirmText = t('Blacklist and Ban');
    }
    if ($userInList && !$banningEnabled) {
      $blacklistConfirmText = t('Blacklist Hosts -- including ME!');
    }
    elseif (!$banningEnabled) {
      $blacklistConfirmText = t('Blacklist');
    }
    return $blacklistConfirmText;
  }

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

    // Prepare default confirm text.
    $this
      ->setConfirmText();

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

    /** @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];
        $key = $id . ':' . $host_ip;
        $default_key = $id . ':' . $host_ip;

        // Check if current user's IP is in the list...
        if ($this_user == $host_ip) {

          // Alter confirm button.
          $this
            ->setConfirmText($userInList = TRUE);
          $this
            ->getConfirmText();

          // Theme a warning in the item list.
          $items[$default_key] = [
            'label' => [
              '#markup' => $this
                ->t('<strong>Your IP (@label) is in this list! YOU ARE ABOUT TO BLACKLIST YOURSELF!</strong>', [
                '@label' => $host
                  ->label(),
              ]),
            ],
            'me' => [
              '#theme' => 'item_list',
            ],
          ];
        }

        // If we have any already banned hosts, we theme up some extra warning about each
        // of them.
        if ($this->banManager
          ->isBanned($host_ip)) {
          $items[$default_key] = [
            'label' => [
              '#markup' => $this
                ->t('@label - <em> Is already banned.</em>', [
                '@label' => $host
                  ->label(),
              ]),
            ],
            'ban 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) {

    // Check if banning is enabled.
    $banningEnabled = TRUE ? \Drupal::state()
      ->get('httpbl.storage') == HTTPBL_DB_HH_DRUPAL : ($banningEnabled = FALSE);
    if ($form_state
      ->getValue('confirm') && !empty($this->hostInfo)) {
      $ban_hosts = [];
      $blacklist_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)) {

            // Only queue the host for blacklisting;
            $blacklist_hosts[$id] = $host;
          }
          elseif (!isset($ban_hosts[$id]) && $banningEnabled) {
            $ban_hosts[$id] = $host;
          }
          $blacklist_hosts[$id] = $host;
        }
      }
      if ($ban_hosts) {
        foreach ($ban_hosts as $ban_host) {
          $this->banManager
            ->banIp($ban_host
            ->getHostIp());
        }
        $this->logTrapper
          ->trapNotice('Banned @count hosts.', array(
          '@count' => count($ban_hosts),
        ));
        $banned_count = count($ban_hosts);
        drupal_set_message($this
          ->formatPlural($banned_count, 'Banned 1 host.', 'Banned @count hosts.'));
      }
      if ($blacklist_hosts) {
        $now = \Drupal::time()
          ->getRequestTime();
        $offset = \Drupal::state()
          ->get('httpbl.blacklist_offset') ?: 31536000;
        $timestamp = $now + $offset;
        foreach ($blacklist_hosts as $id => $blacklist_host) {
          $host = $blacklist_host;
          $host
            ->setHostStatus(HTTPBL_LIST_BLACK);
          $host
            ->setExpiry($timestamp);
          $host
            ->setSource(HTTPBL_ADMIN_SOURCE);
          $host
            ->save();
        }
        $blacklist_count = count($blacklist_hosts);
        $this->logTrapper
          ->trapNotice('Blacklisted @count hosts.', array(
          '@count' => $blacklist_count,
        ));
        drupal_set_message($this
          ->formatPlural($blacklist_count, 'Blacklisted 1 host.', 'Blacklisted @count hosts.'));
      }
      $this->tempStoreFactory
        ->get('host_multiple_ban_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
HostMultipleBanConfirm::$banManager protected property The ban IP manager.
HostMultipleBanConfirm::$hostInfo protected property The array of hosts to blacklist and ban.
HostMultipleBanConfirm::$logTrapper protected property A logger arbitration instance.
HostMultipleBanConfirm::$manager protected property The host entity and storage manager.
HostMultipleBanConfirm::$tempStoreFactory protected property The tempstore factory.
HostMultipleBanConfirm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
HostMultipleBanConfirm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
HostMultipleBanConfirm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
HostMultipleBanConfirm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
HostMultipleBanConfirm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
HostMultipleBanConfirm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
HostMultipleBanConfirm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
HostMultipleBanConfirm::setConfirmText public function
HostMultipleBanConfirm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
HostMultipleBanConfirm::__construct public function Constructs a new HostMultipleBanConfirm 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.