Loading core/modules/ban/ban.services.yml +6 −4 Changes for core/modules/ban/ban.services.yml: 6 added lines, 4 removed lines. Original line number Diff line number Diff line Loading @@ -4,8 +4,10 @@ services: arguments: ['@database'] tags: - { name: backend_overridable } ban.subscriber: class: Drupal\ban\EventSubscriber\BanSubscriber tags: - { name: event_subscriber } ban.middleware: class: Drupal\ban\BanMiddleware arguments: ['@ban.ip_manager'] tags: # Ensure to come before page caching, so you don't serve cached pages to # banned users. - { name: http_middleware, priority: 250 } core/modules/ban/src/BanMiddleware.php +58 Changes for core/modules/ban/src/BanMiddleware.php: 58 added lines, 0 removed lines. Original line number Diff line number Diff line <?php /** * @file * Contains \Drupal\ban\BanMiddleware. */ namespace Drupal\ban; use Drupal\Component\Utility\String; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpKernel\HttpKernelInterface; /** * Provides a HTTP middleware to implement IP based banning. */ class BanMiddleware implements HttpKernelInterface { /** * The decorated kernel. * * @var \Symfony\Component\HttpKernel\HttpKernelInterface */ protected $httpKernel; /** * The ban IP manager. * * @var \Drupal\ban\BanIpManagerInterface */ protected $banIpManager; /** * Constructs a BanMiddleware object. * * @param \Symfony\Component\HttpKernel\HttpKernelInterface $http_kernel * The decorated kernel. * @param \Drupal\ban\BanIpManagerInterface $manager * The ban IP manager. */ public function __construct(HttpKernelInterface $http_kernel, BanIpManagerInterface $manager) { $this->httpKernel = $http_kernel; $this->banIpManager = $manager; } /** * {@inheritdoc} */ public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) { $ip = $request->getClientIp(); if ($this->banIpManager->isBanned($ip)) { return new Response(String::format('Sorry @ip has been banned', ['@ip' => $ip]), 403); } return $this->httpKernel->handle($request, $type, $catch); } } core/modules/ban/src/EventSubscriber/BanSubscriber.php −65 File deleted. Show changes core/modules/ban/src/Tests/BanMiddlewareTest.php +97 Changes for core/modules/ban/src/Tests/BanMiddlewareTest.php: 97 added lines, 0 removed lines. Original line number Diff line number Diff line <?php /** * @file * Contains \Drupal\ban\Tests\BanMiddlewareTest. */ namespace Drupal\ban\Tests; use Drupal\ban\BanMiddleware; use Drupal\Tests\UnitTestCase; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpKernel\HttpKernelInterface; /** * @coversDefaultClass \Drupal\ban\BanMiddleware * @group ban */ class BanMiddlewareTest extends UnitTestCase { /** * The mocked wrapped kernel. * * @var \Symfony\Component\HttpKernel\HttpKernelInterface|\PHPUnit_Framework_MockObject_MockObject */ protected $kernel; /** * The mocked ban IP manager. * * @var \Drupal\ban\BanIpManagerInterface|\PHPUnit_Framework_MockObject_MockObject */ protected $banManager; /** * The tested ban middleware. * * @var \Drupal\ban\BanMiddleware */ protected $banMiddleware; /** * {@inheritdoc} */ protected function setUp() { parent::setUp(); $this->kernel = $this->getMock('Symfony\Component\HttpKernel\HttpKernelInterface'); $this->banManager = $this->getMock('Drupal\ban\BanIpManagerInterface'); $this->banMiddleware = new BanMiddleware($this->kernel, $this->banManager); } /** * Tests a banned IP. */ public function testBannedIp() { $banned_ip = '17.0.0.2'; $this->banManager->expects($this->once()) ->method('isBanned') ->with($banned_ip) ->willReturn(TRUE); $this->kernel->expects($this->never()) ->method('handle'); $request = Request::create('/test-path'); $request->server->set('REMOTE_ADDR', $banned_ip); $response = $this->banMiddleware->handle($request); $this->assertEquals(403, $response->getStatusCode()); } /** * Tests an unbanned IP. */ public function testUnbannedIp() { $unbanned_ip = '18.0.0.2'; $this->banManager->expects($this->once()) ->method('isBanned') ->with($unbanned_ip) ->willReturn(FALSE); $request = Request::create('/test-path'); $request->server->set('REMOTE_ADDR', $unbanned_ip); $expected_response = new Response(200); $this->kernel->expects($this->once()) ->method('handle') ->with($request, HttpKernelInterface::MASTER_REQUEST, TRUE) ->willReturn($expected_response); $response = $this->banMiddleware->handle($request); $this->assertSame($expected_response, $response); } } Loading
core/modules/ban/ban.services.yml +6 −4 Changes for core/modules/ban/ban.services.yml: 6 added lines, 4 removed lines. Original line number Diff line number Diff line Loading @@ -4,8 +4,10 @@ services: arguments: ['@database'] tags: - { name: backend_overridable } ban.subscriber: class: Drupal\ban\EventSubscriber\BanSubscriber tags: - { name: event_subscriber } ban.middleware: class: Drupal\ban\BanMiddleware arguments: ['@ban.ip_manager'] tags: # Ensure to come before page caching, so you don't serve cached pages to # banned users. - { name: http_middleware, priority: 250 }
core/modules/ban/src/BanMiddleware.php +58 Changes for core/modules/ban/src/BanMiddleware.php: 58 added lines, 0 removed lines. Original line number Diff line number Diff line <?php /** * @file * Contains \Drupal\ban\BanMiddleware. */ namespace Drupal\ban; use Drupal\Component\Utility\String; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpKernel\HttpKernelInterface; /** * Provides a HTTP middleware to implement IP based banning. */ class BanMiddleware implements HttpKernelInterface { /** * The decorated kernel. * * @var \Symfony\Component\HttpKernel\HttpKernelInterface */ protected $httpKernel; /** * The ban IP manager. * * @var \Drupal\ban\BanIpManagerInterface */ protected $banIpManager; /** * Constructs a BanMiddleware object. * * @param \Symfony\Component\HttpKernel\HttpKernelInterface $http_kernel * The decorated kernel. * @param \Drupal\ban\BanIpManagerInterface $manager * The ban IP manager. */ public function __construct(HttpKernelInterface $http_kernel, BanIpManagerInterface $manager) { $this->httpKernel = $http_kernel; $this->banIpManager = $manager; } /** * {@inheritdoc} */ public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) { $ip = $request->getClientIp(); if ($this->banIpManager->isBanned($ip)) { return new Response(String::format('Sorry @ip has been banned', ['@ip' => $ip]), 403); } return $this->httpKernel->handle($request, $type, $catch); } }
core/modules/ban/src/Tests/BanMiddlewareTest.php +97 Changes for core/modules/ban/src/Tests/BanMiddlewareTest.php: 97 added lines, 0 removed lines. Original line number Diff line number Diff line <?php /** * @file * Contains \Drupal\ban\Tests\BanMiddlewareTest. */ namespace Drupal\ban\Tests; use Drupal\ban\BanMiddleware; use Drupal\Tests\UnitTestCase; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpKernel\HttpKernelInterface; /** * @coversDefaultClass \Drupal\ban\BanMiddleware * @group ban */ class BanMiddlewareTest extends UnitTestCase { /** * The mocked wrapped kernel. * * @var \Symfony\Component\HttpKernel\HttpKernelInterface|\PHPUnit_Framework_MockObject_MockObject */ protected $kernel; /** * The mocked ban IP manager. * * @var \Drupal\ban\BanIpManagerInterface|\PHPUnit_Framework_MockObject_MockObject */ protected $banManager; /** * The tested ban middleware. * * @var \Drupal\ban\BanMiddleware */ protected $banMiddleware; /** * {@inheritdoc} */ protected function setUp() { parent::setUp(); $this->kernel = $this->getMock('Symfony\Component\HttpKernel\HttpKernelInterface'); $this->banManager = $this->getMock('Drupal\ban\BanIpManagerInterface'); $this->banMiddleware = new BanMiddleware($this->kernel, $this->banManager); } /** * Tests a banned IP. */ public function testBannedIp() { $banned_ip = '17.0.0.2'; $this->banManager->expects($this->once()) ->method('isBanned') ->with($banned_ip) ->willReturn(TRUE); $this->kernel->expects($this->never()) ->method('handle'); $request = Request::create('/test-path'); $request->server->set('REMOTE_ADDR', $banned_ip); $response = $this->banMiddleware->handle($request); $this->assertEquals(403, $response->getStatusCode()); } /** * Tests an unbanned IP. */ public function testUnbannedIp() { $unbanned_ip = '18.0.0.2'; $this->banManager->expects($this->once()) ->method('isBanned') ->with($unbanned_ip) ->willReturn(FALSE); $request = Request::create('/test-path'); $request->server->set('REMOTE_ADDR', $unbanned_ip); $expected_response = new Response(200); $this->kernel->expects($this->once()) ->method('handle') ->with($request, HttpKernelInterface::MASTER_REQUEST, TRUE) ->willReturn($expected_response); $response = $this->banMiddleware->handle($request); $this->assertSame($expected_response, $response); } }