UserFloodSubscriber.php in Drupal 9

Namespace

Drupal\user\EventSubscriber

File

core/modules/user/src/EventSubscriber/UserFloodSubscriber.php

<?php

namespace Drupal\user\EventSubscriber;

use Drupal\user\Event\UserEvents;
use Drupal\user\Event\UserFloodEvent;
use Drupal\Core\Site\Settings;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Psr\Log\LoggerInterface;

/**
 * Logs details of User Flood Control events.
 */
class UserFloodSubscriber implements EventSubscriberInterface {

  /**
   * The default logger service.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs a UserFloodSubscriber.
   *
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   */
  public function __construct(LoggerInterface $logger = NULL) {
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[UserEvents::FLOOD_BLOCKED_USER][] = [
      'blockedUser',
    ];
    $events[UserEvents::FLOOD_BLOCKED_IP][] = [
      'blockedIp',
    ];
    return $events;
  }

  /**
   * An attempt to login has been blocked based on user name.
   *
   * @param \Drupal\user\Event\UserFloodEvent $floodEvent
   *   The flood event.
   */
  public function blockedUser(UserFloodEvent $floodEvent) {
    if (Settings::get('log_user_flood', TRUE)) {
      $uid = $floodEvent
        ->getUid();
      if ($floodEvent
        ->hasIp()) {
        $ip = $floodEvent
          ->getIp();
        $this->logger
          ->notice('Flood control blocked login attempt for uid %uid from %ip', [
          '%uid' => $uid,
          '%ip' => $ip,
        ]);
        return;
      }
      $this->logger
        ->notice('Flood control blocked login attempt for uid %uid', [
        '%uid' => $uid,
      ]);
    }
  }

  /**
   * An attempt to login has been blocked based on IP.
   *
   * @param \Drupal\user\Event\UserFloodEvent $floodEvent
   *   The flood event.
   */
  public function blockedIp(UserFloodEvent $floodEvent) {
    if (Settings::get('log_user_flood', TRUE)) {
      $this->logger
        ->notice('Flood control blocked login attempt from %ip', [
        '%ip' => $floodEvent
          ->getIp(),
      ]);
    }
  }

}

Classes

Name	Description
UserFloodSubscriber	Logs details of User Flood Control events.