HttpKernelBrowser.php 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpKernel;
  11. use Symfony\Component\BrowserKit\AbstractBrowser;
  12. use Symfony\Component\BrowserKit\CookieJar;
  13. use Symfony\Component\BrowserKit\History;
  14. use Symfony\Component\BrowserKit\Request as DomRequest;
  15. use Symfony\Component\BrowserKit\Response as DomResponse;
  16. use Symfony\Component\HttpFoundation\File\UploadedFile;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpFoundation\Response;
  19. /**
  20. * Simulates a browser and makes requests to an HttpKernel instance.
  21. *
  22. * @author Fabien Potencier <fabien@symfony.com>
  23. *
  24. * @template-extends AbstractBrowser<Request, Response>
  25. */
  26. class HttpKernelBrowser extends AbstractBrowser
  27. {
  28. private bool $catchExceptions = true;
  29. /**
  30. * @param array $server The server parameters (equivalent of $_SERVER)
  31. */
  32. public function __construct(
  33. protected HttpKernelInterface $kernel,
  34. array $server = [],
  35. ?History $history = null,
  36. ?CookieJar $cookieJar = null,
  37. ) {
  38. // These class properties must be set before calling the parent constructor, as it may depend on it.
  39. $this->followRedirects = false;
  40. parent::__construct($server, $history, $cookieJar);
  41. }
  42. /**
  43. * Sets whether to catch exceptions when the kernel is handling a request.
  44. */
  45. public function catchExceptions(bool $catchExceptions): void
  46. {
  47. $this->catchExceptions = $catchExceptions;
  48. }
  49. /**
  50. * @param Request $request
  51. */
  52. protected function doRequest(object $request): Response
  53. {
  54. $response = $this->kernel->handle($request, HttpKernelInterface::MAIN_REQUEST, $this->catchExceptions);
  55. if ($this->kernel instanceof TerminableInterface) {
  56. $this->kernel->terminate($request, $response);
  57. }
  58. return $response;
  59. }
  60. /**
  61. * @param Request $request
  62. */
  63. protected function getScript(object $request): string
  64. {
  65. $kernel = var_export(serialize($this->kernel), true);
  66. $request = var_export(serialize($request), true);
  67. $errorReporting = error_reporting();
  68. $requires = '';
  69. foreach (get_declared_classes() as $class) {
  70. if (str_starts_with($class, 'ComposerAutoloaderInit')) {
  71. $r = new \ReflectionClass($class);
  72. $file = \dirname($r->getFileName(), 2).'/autoload.php';
  73. if (file_exists($file)) {
  74. $requires .= 'require_once '.var_export($file, true).";\n";
  75. }
  76. }
  77. }
  78. if (!$requires) {
  79. throw new \RuntimeException('Composer autoloader not found.');
  80. }
  81. $code = <<<EOF
  82. <?php
  83. error_reporting($errorReporting);
  84. $requires
  85. \$kernel = unserialize($kernel);
  86. \$request = unserialize($request);
  87. EOF;
  88. return $code.$this->getHandleScript();
  89. }
  90. protected function getHandleScript(): string
  91. {
  92. return <<<'EOF'
  93. $response = $kernel->handle($request);
  94. if ($kernel instanceof Symfony\Component\HttpKernel\TerminableInterface) {
  95. $kernel->terminate($request, $response);
  96. }
  97. echo serialize($response);
  98. EOF;
  99. }
  100. protected function filterRequest(DomRequest $request): Request
  101. {
  102. $httpRequest = Request::create($request->getUri(), $request->getMethod(), $request->getParameters(), $request->getCookies(), $request->getFiles(), $server = $request->getServer(), $request->getContent());
  103. if (!isset($server['HTTP_ACCEPT'])) {
  104. $httpRequest->headers->remove('Accept');
  105. }
  106. foreach ($this->filterFiles($httpRequest->files->all()) as $key => $value) {
  107. $httpRequest->files->set($key, $value);
  108. }
  109. return $httpRequest;
  110. }
  111. /**
  112. * Filters an array of files.
  113. *
  114. * This method created test instances of UploadedFile so that the move()
  115. * method can be called on those instances.
  116. *
  117. * If the size of a file is greater than the allowed size (from php.ini) then
  118. * an invalid UploadedFile is returned with an error set to UPLOAD_ERR_INI_SIZE.
  119. *
  120. * @see UploadedFile
  121. */
  122. protected function filterFiles(array $files): array
  123. {
  124. $filtered = [];
  125. foreach ($files as $key => $value) {
  126. if (\is_array($value)) {
  127. $filtered[$key] = $this->filterFiles($value);
  128. } elseif ($value instanceof UploadedFile) {
  129. if ($value->isValid() && $value->getSize() > UploadedFile::getMaxFilesize()) {
  130. $filtered[$key] = new UploadedFile(
  131. '',
  132. $value->getClientOriginalName(),
  133. $value->getClientMimeType(),
  134. \UPLOAD_ERR_INI_SIZE,
  135. true
  136. );
  137. } else {
  138. $filtered[$key] = new UploadedFile(
  139. $value->getPathname(),
  140. $value->getClientOriginalName(),
  141. $value->getClientMimeType(),
  142. $value->getError(),
  143. true
  144. );
  145. }
  146. }
  147. }
  148. return $filtered;
  149. }
  150. /**
  151. * @param Response $response
  152. */
  153. protected function filterResponse(object $response): DomResponse
  154. {
  155. // this is needed to support StreamedResponse
  156. ob_start();
  157. $response->sendContent();
  158. $content = ob_get_clean();
  159. return new DomResponse($content, $response->getStatusCode(), $response->headers->all());
  160. }
  161. }