You are here

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

class HostMultipleRefreshConfirm in http:BL 8

Provides a multiple host expiry refresh confirmation form.

Hierarchy

Expanded class hierarchy of HostMultipleRefreshConfirm

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

File

src/Form/HostMultipleRefreshConfirm.php, line 17

Namespace

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

  /**
   * The array of hosts to refresh.
   *
   * @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;

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

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

    //Get the storage info from the EntityTypeManager.
    $this->storage = $manager
      ->getStorage('host');
    $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('httpbl.logtrapper'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('<p>Host cron expirations will be refreshed in accordance to their status type (safe, grey or blacklisted).</p><p> This action may be un-doable by using other actions.</p>');
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return t('Refresh Expiry');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->hostInfo = $this->tempStoreFactory
      ->get('host_multiple_refresh_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));

    // Build expiry values.
    $safe_offset = \Drupal::state()
      ->get('httpbl.safe_offset') ?: 10800;
    $safe_timestamp = \Drupal::time()
      ->getRequestTime() + $safe_offset;
    $safe_time_message = \Drupal::service('date.formatter')
      ->formatTimeDiffUntil($safe_timestamp);
    $grey_offset = \Drupal::state()
      ->get('httpbl.greylist_offset') ?: 86400;
    $grey_timestamp = \Drupal::time()
      ->getRequestTime() + $grey_offset;
    $grey_time_message = \Drupal::service('date.formatter')
      ->formatTimeDiffUntil($grey_timestamp);
    $black_offset = \Drupal::state()
      ->get('httpbl.blacklist_offset') ?: 31536000;
    $black_timestamp = \Drupal::time()
      ->getRequestTime() + $black_offset;
    $black_time_message = \Drupal::service('date.formatter')
      ->formatTimeDiffUntil($black_timestamp);
    $items = [];

    // Prepare confirmations.
    foreach ($this->hostInfo as $id => $host_ips) {
      foreach ($host_ips as $host_ip) {
        $host = $hosts[$id];
        $status = $host
          ->getHostStatus();
        $key = $id . ':' . $host_ip;
        $default_key = $id . ':' . $host_ip;
        switch ($status) {
          case '0':
            $items[$default_key] = [
              'label' => [
                '#markup' => $this
                  ->t('White-listed @label expiry will be refreshed to @time.', [
                  '@label' => $host
                    ->label(),
                  '@time' => $safe_time_message,
                ]),
              ],
              'host' => [
                '#theme' => 'item_list',
              ],
            ];
            break;
          case '1':
            $items[$default_key] = [
              'label' => [
                '#markup' => $this
                  ->t('Blacklisted @label expiry will be refreshed to @time.', [
                  '@label' => $host
                    ->label(),
                  '@time' => $black_time_message,
                ]),
              ],
              'host' => [
                '#theme' => 'item_list',
              ],
            ];
            break;
          case '2':
            $items[$default_key] = [
              'label' => [
                '#markup' => $this
                  ->t('Grey-listed @label expiry will be refreshed to @time.', [
                  '@label' => $host
                    ->label(),
                  '@time' => $grey_time_message,
                ]),
              ],
              'host' => [
                '#theme' => 'item_list',
              ],
            ];
            break;
        }
      }
    }
    $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)) {

      // Build expiry values.
      $safe_offset = \Drupal::state()
        ->get('httpbl.safe_offset') ?: 10800;
      $safe_timestamp = \Drupal::time()
        ->getRequestTime() + $safe_offset;
      $safe_time_message = \Drupal::service('date.formatter')
        ->formatTimeDiffUntil($safe_timestamp);
      $grey_offset = \Drupal::state()
        ->get('httpbl.greylist_offset') ?: 86400;
      $grey_timestamp = \Drupal::time()
        ->getRequestTime() + $grey_offset;
      $grey_time_message = \Drupal::service('date.formatter')
        ->formatTimeDiffUntil($grey_timestamp);
      $black_offset = \Drupal::state()
        ->get('httpbl.blacklist_offset') ?: 31536000;
      $black_timestamp = \Drupal::time()
        ->getRequestTime() + $black_offset;
      $black_time_message = \Drupal::service('date.formatter')
        ->formatTimeDiffUntil($black_timestamp);

      // Prepare work arrays for status types.
      $safe_hosts = [];
      $grey_hosts = [];
      $black_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];
          $status = $host
            ->getHostStatus();
          switch ($status) {
            case '0':
              $safe_hosts[$id] = $host;
              break;
            case '1':
              $black_hosts[$id] = $host;
              break;
            case '2':
              $grey_hosts[$id] = $host;
              break;
          }
        }
      }
      if ($safe_hosts) {
        foreach ($safe_hosts as $safe_host) {
          $host = $safe_host;
          $host
            ->setExpiry($safe_timestamp);
          $host
            ->setSource(HTTPBL_ADMIN_SOURCE);
          $host
            ->save();
        }
        $this->logTrapper
          ->trapNotice('Refreshed expiry for @count white-listed hosts to @time.', [
          '@count' => count($safe_hosts),
          '@time' => $safe_time_message,
        ]);
        $safe_count = count($safe_hosts);
        drupal_set_message($this
          ->formatPlural($safe_count, 'Refreshed 1 white-listed host.', 'Refreshed @count white-listed hosts.'));
      }
      if ($grey_hosts) {
        foreach ($grey_hosts as $grey_host) {
          $host = $grey_host;
          $host
            ->setExpiry($grey_timestamp);
          $host
            ->setSource(HTTPBL_ADMIN_SOURCE);
          $host
            ->save();
        }
        $this->logTrapper
          ->trapNotice('Refreshed expiry for @count grey-listed hosts to @time.', [
          '@count' => count($grey_hosts),
          '@time' => $grey_time_message,
        ]);
        $grey_count = count($grey_hosts);
        drupal_set_message($this
          ->formatPlural($grey_count, 'Refreshed 1 grey-listed host.', 'Refreshed @count grey-listed hosts.'));
      }
      if ($black_hosts) {
        foreach ($black_hosts as $black_host) {
          $host = $black_host;
          $host
            ->setExpiry($black_timestamp);
          $host
            ->setSource(HTTPBL_ADMIN_SOURCE);
          $host
            ->save();
        }
        $this->logTrapper
          ->trapNotice('Refreshed expiry for @count blacklisted hosts to @time.', [
          '@count' => count($black_hosts),
          '@time' => $black_time_message,
        ]);
        $black_count = count($black_hosts);
        drupal_set_message($this
          ->formatPlural($black_count, 'Refreshed 1 blacklisted host.', 'Refreshed @count blacklisted hosts.'));
      }
      $this->tempStoreFactory
        ->get('host_multiple_refresh_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
HostMultipleRefreshConfirm::$hostInfo protected property The array of hosts to refresh.
HostMultipleRefreshConfirm::$logTrapper protected property A logger arbitration instance.
HostMultipleRefreshConfirm::$manager protected property The host entity and storage manager.
HostMultipleRefreshConfirm::$tempStoreFactory protected property The tempstore factory.
HostMultipleRefreshConfirm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
HostMultipleRefreshConfirm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
HostMultipleRefreshConfirm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
HostMultipleRefreshConfirm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
HostMultipleRefreshConfirm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
HostMultipleRefreshConfirm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
HostMultipleRefreshConfirm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
HostMultipleRefreshConfirm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
HostMultipleRefreshConfirm::__construct public function Constructs a new HostMultipleRefreshConfirm 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.