You are here

Home » API reference » Automatic IP ban (Autoban) 8 » AutobanAnalyzeForm.php

class AutobanAnalyzeForm in Automatic IP ban (Autoban) 8

Analyze watchdog entries for IP addresses for ban.

Hierarchy

Expanded class hierarchy of AutobanAnalyzeForm

1 string reference to 'AutobanAnalyzeForm'
autoban.routing.yml in ./autoban.routing.yml
autoban.routing.yml

File

src/Form/AutobanAnalyzeForm.php, line 20

Namespace

Drupal\autoban\Form
View source 
class AutobanAnalyzeForm extends FormBase {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

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

  /**
   * The autoban object.
   *
   * @var \Drupal\autoban\Controller\AutobanController
   */
  protected $autoban;

  /**
   * Construct the AutobanAnalyzeForm.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
   *   Entity type manager.
   * @param \Drupal\autoban\Controller\AutobanController $autoban
   *   Autoban object.
   */
  public function __construct(Connection $connection, EntityTypeManager $entity_type_manager, AutobanController $autoban) {
    $this->connection = $connection;
    $this->entityTypeManager = $entity_type_manager;
    $this->autoban = $autoban;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('database'), $container
      ->get('entity_type.manager'), $container
      ->get('autoban'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $rows = [];
    $header = [
      [
        'data' => $this
          ->t('Count'),
        'field' => 'cnt',
        'sort' => 'desc',
      ],
      [
        'data' => $this
          ->t('Type'),
        'field' => 'type',
      ],
      [
        'data' => $this
          ->t('Message'),
        'field' => 'message',
      ],
      $this
        ->t('Operations'),
    ];

    // Run analyze query.
    $threshold_analyze = $this
      ->config('autoban.settings')
      ->get('autoban_threshold_analyze') ?: 5;
    $dblog_type_exclude = $this
      ->config('autoban.settings')
      ->get('autoban_dblog_type_exclude') ?: "autoban\ncron\nphp\nsystem\nuser";
    $dblog_type_exclude_msg = implode(', ', explode("\n", $dblog_type_exclude));
    $result = $this
      ->getAnalyzeResult($header, $threshold_analyze, $dblog_type_exclude);
    if (count($result)) {
      $destination = $this
        ->getDestinationArray();
      $url_destination = $destination['destination'];
      foreach ($result as $item) {
        $message = $this
          ->formatMessage($item);
        $message = Unicode::truncate(Html::decodeEntities(strip_tags($message)), 256, TRUE, TRUE);
        $row = [
          $item->cnt,
          $item->type,
          $message,
        ];
        $links = [];
        $query = [
          'query' => [
            'type' => $item->type,
            'message' => Html::escape($message),
            'destination' => $url_destination,
          ],
        ];
        $links['add_rule'] = [
          'title' => $this
            ->t('Add rule'),
          'url' => Url::fromRoute('entity.autoban.add_form', [], $query),
        ];
        $links['test'] = [
          'title' => $this
            ->t('Test'),
          'url' => Url::fromRoute('autoban.test', [
            'rule' => AutobanUtils::AUTOBAN_FROM_ANALYZE,
          ], $query),
        ];
        $row[] = [
          'data' => [
            '#type' => 'operations',
            '#links' => $links,
          ],
        ];
        $rows[] = $row;
      }
      $form['submit'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Bulk add rules'),
        '#suffix' => '<div><small>' . $this
          ->t('Automatic creation autoban rules for checked rows.') . '</small></div>',
      ];
    }
    $form['info'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Settings info'),
      '#open' => FALSE,
    ];
    $form['info']['title'] = [
      '#markup' => $this
        ->t('<label>Threshold:</label> @threshold <label>Exclude types:</label> @exclude', [
        '@threshold' => $threshold_analyze,
        '@exclude' => $dblog_type_exclude_msg,
      ]),
      '#allowed_tags' => [
        'label',
      ],
    ];
    $form['analyze_table'] = [
      '#type' => 'tableselect',
      '#header' => $header,
      '#options' => $rows,
      '#empty' => $this
        ->t('No data for ban.'),
      '#weight' => 120,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $rules = [];
    foreach ($form_state
      ->getValue('analyze_table') as $key => $value) {
      if ($value != NULL) {
        $rules[$key] = [
          'type' => $form['analyze_table']['#options'][$key][1],
          'message' => $form['analyze_table']['#options'][$key][2],
        ];
      }
    }
    if (!empty($rules)) {

      // Providers list.
      $providers = [];
      $controller = $this->autoban;
      $banManagerList = $controller
        ->getBanProvidersList();
      if (!empty($banManagerList)) {
        foreach ($banManagerList as $id => $item) {
          $providers[$id] = $item['name'];
        }
      }
      else {
        $this
          ->messenger()
          ->addMessage($this
          ->t('List ban providers is empty. You have to enable at least one Autoban providers module.'), 'warning');
        return;
      }
      $provider = NULL;
      if (count($providers) == 1) {
        $provider = array_keys($providers)[0];
      }
      else {
        $last_provider = $this
          ->config('autoban.settings')
          ->get('autoban_provider_last');
        if ($last_provider && isset($providers[$last_provider])) {
          $provider = $last_provider;
        }
      }
      if (empty($provider)) {
        $provider = array_keys($providers)[0];
      }

      // Threshold.
      $threshold = $this
        ->config('autoban.settings')
        ->get('autoban_threshold_analyze') ?: 5;
      $thresholds_config = $this
        ->config('autoban.settings')
        ->get('autoban_thresholds');
      $thresholds = !empty($thresholds_config) ? explode("\n", $thresholds_config) : [
        1,
        2,
        3,
        5,
        10,
        20,
        50,
        100,
      ];
      if (!in_array($threshold, $thresholds)) {
        $threshold = max(array_filter($thresholds, function ($v) use ($threshold) {
          return $v < $threshold;
        }));
      }

      // Create automatic rules.
      foreach ($rules as $key => $value) {
        $value['provider'] = $provider;
        $value['threshold'] = $threshold;
        $value['id'] = "a_" . uniqid();
        $value['rule_type'] = AutobanUtils::AUTOBAN_RULE_AUTO;
        $autoban = $this->entityTypeManager
          ->getStorage('autoban')
          ->create($value);
        $autoban
          ->save();
        $this
          ->messenger()
          ->addMessage($this
          ->t('Create rule %label', [
          '%label' => $autoban
            ->id(),
        ]));
      }
      $this
        ->messenger()
        ->addMessage($this
        ->t('Created rules: @count', [
        '@count' => count($rules),
      ]));
    }
    else {
      $this
        ->messenger()
        ->addMessage($this
        ->t('No rules for generate'), 'warning');
    }
  }

  /**
   * Get analyze result.
   *
   * @param array $header
   *   Query header.
   * @param int $threshold
   *   Threshold for watchdog entries which added to result.
   * @param string $dblog_type_exclude
   *   Exclude dblog types events for log analyze.
   *
   * @return array
   *   Watchdog table data as query result.
   */
  private function getAnalyzeResult(array $header, $threshold, $dblog_type_exclude) {
    $query = $this->connection
      ->select('watchdog', 'log');
    $query
      ->fields('log', [
      'message',
      'variables',
      'type',
    ]);
    $query
      ->addExpression('COUNT(*)', 'cnt');
    $query
      ->condition('log.type', explode("\n", $dblog_type_exclude), 'NOT IN');
    $query
      ->groupBy('log.message, log.variables, log.type');
    $query
      ->having('COUNT(*) >= :threshold', [
      ':threshold' => $threshold,
    ]);
    $table_sort = $query
      ->extend('Drupal\\Core\\Database\\Query\\TableSortExtender')
      ->orderByHeader($header);
    $result = $table_sort
      ->execute()
      ->fetchAll();
    return $result;
  }

  /**
   * Formats a database log message.
   *
   * @param object $row
   *   The record from the watchdog table. The object properties are: wid, uid,
   *   severity, type, timestamp, message, variables, link, name.
   *
   * @return string|\Drupal\Core\StringTranslation\TranslatableMarkup|false
   *   The formatted log message.
   */
  public function formatMessage($row) {

    // Check for required properties.
    if (isset($row->message, $row->variables)) {
      $variables = @unserialize($row->variables);

      // Messages without variables or user specified text.
      if ($variables === NULL) {
        $message = Xss::filterAdmin($row->message);
      }
      elseif (!is_array($variables)) {
        $message = $this
          ->t('Log data is corrupted and cannot be unserialized: @message', [
          '@message' => Xss::filterAdmin($row->message),
        ]);
      }
      else {
        $message = $this
          ->t(Xss::filterAdmin($row->message), $variables);
      }
    }
    else {
      $message = '';
    }
    return $message;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AutobanAnalyzeForm::$autoban protected property The autoban object.
AutobanAnalyzeForm::$connection protected property The database connection.
AutobanAnalyzeForm::$entityTypeManager protected property The entity type manager.
AutobanAnalyzeForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AutobanAnalyzeForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
AutobanAnalyzeForm::formatMessage public function Formats a database log message.
AutobanAnalyzeForm::getAnalyzeResult private function Get analyze result.
AutobanAnalyzeForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AutobanAnalyzeForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AutobanAnalyzeForm::__construct public function Construct the AutobanAnalyzeForm.
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
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.