HttpKernelBrowser.php 5.7 KB

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