123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202 |
- <?php
- namespace Drupal\KernelTests\Core\Routing;
- use Drupal\Component\Utility\Html;
- use Drupal\KernelTests\KernelTestBase;
- use Symfony\Component\HttpFoundation\Request;
- use Symfony\Component\HttpFoundation\Response;
- /**
- * Tests the exception handling for various cases.
- *
- * @group Routing
- */
- class ExceptionHandlingTest extends KernelTestBase {
- /**
- * {@inheritdoc}
- */
- public static $modules = ['system', 'router_test'];
- /**
- * {@inheritdoc}
- */
- protected function setUp() {
- parent::setUp();
- $this->installEntitySchema('date_format');
- }
- /**
- * Tests on a route with a non-supported HTTP method.
- */
- public function test405() {
- $request = Request::create('/router_test/test15', 'PATCH');
- /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
- $kernel = \Drupal::getContainer()->get('http_kernel');
- $response = $kernel->handle($request);
- $this->assertEqual(Response::HTTP_METHOD_NOT_ALLOWED, $response->getStatusCode());
- }
- /**
- * Tests the exception handling for json and 403 status code.
- */
- public function testJson403() {
- $request = Request::create('/router_test/test15');
- $request->query->set('_format', 'json');
- $request->setRequestFormat('json');
- /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
- $kernel = \Drupal::getContainer()->get('http_kernel');
- $response = $kernel->handle($request);
- $this->assertEqual($response->getStatusCode(), Response::HTTP_FORBIDDEN);
- $this->assertEqual($response->headers->get('Content-type'), 'application/json');
- $this->assertEqual('{"message":""}', $response->getContent());
- }
- /**
- * Tests the exception handling for json and 404 status code.
- */
- public function testJson404() {
- $request = Request::create('/not-found');
- $request->query->set('_format', 'json');
- $request->setRequestFormat('json');
- /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
- $kernel = \Drupal::getContainer()->get('http_kernel');
- $response = $kernel->handle($request);
- $this->assertEqual($response->getStatusCode(), Response::HTTP_NOT_FOUND);
- $this->assertEqual($response->headers->get('Content-type'), 'application/json');
- $this->assertEqual('{"message":"No route found for \\u0022GET \\/not-found\\u0022"}', $response->getContent());
- }
- /**
- * Tests the exception handling for HTML and 403 status code.
- */
- public function testHtml403() {
- $request = Request::create('/router_test/test15');
- $request->setFormat('html', ['text/html']);
- /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
- $kernel = \Drupal::getContainer()->get('http_kernel');
- $response = $kernel->handle($request)->prepare($request);
- $this->assertEqual($response->getStatusCode(), Response::HTTP_FORBIDDEN);
- $this->assertEqual($response->headers->get('Content-type'), 'text/html; charset=UTF-8');
- }
- /**
- * Tests the exception handling for HTML and 404 status code.
- */
- public function testHtml404() {
- $request = Request::create('/not-found');
- $request->setFormat('html', ['text/html']);
- /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
- $kernel = \Drupal::getContainer()->get('http_kernel');
- $response = $kernel->handle($request)->prepare($request);
- $this->assertEqual($response->getStatusCode(), Response::HTTP_NOT_FOUND);
- $this->assertEqual($response->headers->get('Content-type'), 'text/html; charset=UTF-8');
- }
- /**
- * Tests that the exception response is executed in the original context.
- */
- public function testExceptionResponseGeneratedForOriginalRequest() {
- // Test with 404 path pointing to a route that uses '_controller'.
- $response = $this->doTest404Route('/router_test/test25');
- $this->assertTrue(strpos($response->getContent(), '/not-found') !== FALSE);
- // Test with 404 path pointing to a route that uses '_form'.
- $response = $this->doTest404Route('/router_test/test26');
- $this->assertTrue(strpos($response->getContent(), '<form class="system-logging-settings"') !== FALSE);
- // Test with 404 path pointing to a route that uses '_entity_form'.
- $response = $this->doTest404Route('/router_test/test27');
- $this->assertTrue(strpos($response->getContent(), '<form class="date-format-add-form date-format-form"') !== FALSE);
- }
- /**
- * Sets the given path to use as the 404 page and triggers a 404.
- *
- * @param string $path
- * @return \Drupal\Core\Render\HtmlResponse
- *
- * @see \Drupal\system\Tests\Routing\ExceptionHandlingTest::testExceptionResponseGeneratedForOriginalRequest()
- */
- protected function doTest404Route($path) {
- $this->config('system.site')->set('page.404', $path)->save();
- $request = Request::create('/not-found');
- $request->setFormat('html', ['text/html']);
- /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
- $kernel = \Drupal::getContainer()->get('http_kernel');
- return $kernel->handle($request)->prepare($request);
- }
- /**
- * Tests if exception backtraces are properly escaped when output to HTML.
- */
- public function testBacktraceEscaping() {
- // Enable verbose error logging.
- $this->config('system.logging')->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)->save();
- $request = Request::create('/router_test/test17');
- $request->setFormat('html', ['text/html']);
- /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
- $kernel = \Drupal::getContainer()->get('http_kernel');
- $response = $kernel->handle($request)->prepare($request);
- $this->assertEqual($response->getStatusCode(), Response::HTTP_INTERNAL_SERVER_ERROR);
- $this->assertEqual($response->headers->get('Content-type'), 'text/plain; charset=UTF-8');
- // Test both that the backtrace is properly escaped, and that the unescaped
- // string is not output at all.
- $this->assertTrue(strpos($response->getContent(), Html::escape('<script>alert(\'xss\')</script>')) !== FALSE);
- $this->assertTrue(strpos($response->getContent(), '<script>alert(\'xss\')</script>') === FALSE);
- }
- /**
- * Tests exception message escaping.
- */
- public function testExceptionEscaping() {
- // Enable verbose error logging.
- $this->config('system.logging')->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)->save();
- // Using SafeMarkup::format().
- $request = Request::create('/router_test/test24');
- $request->setFormat('html', ['text/html']);
- /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
- $kernel = \Drupal::getContainer()->get('http_kernel');
- $response = $kernel->handle($request)->prepare($request);
- $this->assertEqual($response->getStatusCode(), Response::HTTP_INTERNAL_SERVER_ERROR);
- $this->assertEqual($response->headers->get('Content-type'), 'text/plain; charset=UTF-8');
- // Test message is properly escaped, and that the unescaped string is not
- // output at all.
- $this->setRawContent($response->getContent());
- $this->assertRaw(Html::escape('Escaped content: <p> <br> <h3>'));
- $this->assertNoRaw('<p> <br> <h3>');
- $string = '<script>alert(123);</script>';
- $request = Request::create('/router_test/test2?_format=json' . urlencode($string), 'GET');
- $kernel = \Drupal::getContainer()->get('http_kernel');
- $response = $kernel->handle($request)->prepare($request);
- // As the Content-type is text/plain the fact that the raw string is
- // contained in the output would not matter, but because it is output by the
- // final exception subscriber, it is printed as partial HTML, and hence
- // escaped.
- $this->assertEqual($response->headers->get('Content-type'), 'text/plain; charset=UTF-8');
- $this->assertStringStartsWith('The website encountered an unexpected error. Please try again later.</br></br><em class="placeholder">Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException</em>: Not acceptable format: json<script>alert(123);</script> in <em class="placeholder">', $response->getContent());
- }
- }
|