HttpKernelBrowser.php 5.8 KB

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