MongodbFlood.php in MongoDB 8

Definition of Drupal\mongodb\MongodbFlood.

Namespace

Drupal\mongodb

File

src/MongodbFlood.php

<?php

/**
 * @file
 * Definition of Drupal\mongodb\MongodbFlood.
 */
namespace Drupal\mongodb;

use Drupal\Core\Flood\FloodInterface;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * Defines the mongodb flood backend.
 */
class MongodbFlood implements FloodInterface {

  /**
   * The mongodb factory registered as a service.
   *
   * @var \Drupal\mongodb\MongoCollectionFactory
   */
  protected $mongo;

  /**
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $requestStack;

  /**
   * Construct the DatabaseFileUsageBackend.
   *
   * @param \Drupal\mongodb\MongoCollectionFactory $mongo
   *   The database connection which will be used to store the flood
   *   information.
   */
  public function __construct(MongoCollectionFactory $mongo, RequestStack $request_stack) {
    $this->mongo = $mongo;
    $this->requestStack = $request_stack;
  }

  /**
   * Implements Drupal\Core\Flood\FloodInterface::register().
   */
  public function register($name, $window = 3600, $identifier = NULL) {
    if (!isset($identifier)) {
      $identifier = $this
        ->request()
        ->getClientIp();
    }
    $data = array(
      'event' => $name,
      'identifier' => $identifier,
      'timestamp' => REQUEST_TIME,
      'expiration' => REQUEST_TIME + $window,
    );
    $this->mongo
      ->get('flood')
      ->insert($data);
  }

  /**
   * Implements Drupal\Core\Flood\FloodInterface::clear().
   */
  public function clear($name, $identifier = NULL) {
    if (!isset($identifier)) {
      $identifier = $this
        ->request()
        ->getClientIp();
    }
    $key = array(
      'event' => $name,
      'identifier' => $identifier,
    );
    $this->mongo
      ->get('flood')
      ->remove($key);
  }

  /**
   * Implements Drupal\Core\Flood\FloodInterface::isAllowed().
   */
  public function isAllowed($name, $threshold, $window = 3600, $identifier = NULL) {
    if (!isset($identifier)) {
      $identifier = $this
        ->request()
        ->getClientIp();
    }
    $key = array(
      'event' => $name,
      'identifier' => $identifier,
      'timestamp' => array(
        '$gt' => REQUEST_TIME - $window,
      ),
      'expiration' => array(
        '$gt' => REQUEST_TIME,
      ),
    );
    return $this->mongo
      ->get('flood')
      ->count($key) < $threshold;
  }

  /**
   * Implements Drupal\Core\Flood\FloodInterface::garbageCollection().
   */
  public function garbageCollection() {

    // Since we use TTL collections do nothing here.
  }

  /**
   * @return \Symfony\Component\HttpFoundation\Request
   */
  protected function request() {
    return $this->requestStack
      ->getCurrentRequest();
  }

}

Classes

Name	Description
MongodbFlood	Defines the mongodb flood backend.