AbstractSurrogate.php 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  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\HttpCache;
  11. use Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\HttpFoundation\Response;
  13. use Symfony\Component\HttpKernel\HttpKernelInterface;
  14. /**
  15. * Abstract class implementing Surrogate capabilities to Request and Response instances.
  16. *
  17. * @author Fabien Potencier <fabien@symfony.com>
  18. * @author Robin Chalas <robin.chalas@gmail.com>
  19. */
  20. abstract class AbstractSurrogate implements SurrogateInterface
  21. {
  22. protected $contentTypes;
  23. /**
  24. * @deprecated since Symfony 6.3
  25. */
  26. protected $phpEscapeMap = [
  27. ['<?', '<%', '<s', '<S'],
  28. ['<?php echo "<?"; ?>', '<?php echo "<%"; ?>', '<?php echo "<s"; ?>', '<?php echo "<S"; ?>'],
  29. ];
  30. /**
  31. * @param array $contentTypes An array of content-type that should be parsed for Surrogate information
  32. * (default: text/html, text/xml, application/xhtml+xml, and application/xml)
  33. */
  34. public function __construct(array $contentTypes = ['text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'])
  35. {
  36. $this->contentTypes = $contentTypes;
  37. }
  38. /**
  39. * Returns a new cache strategy instance.
  40. */
  41. public function createCacheStrategy(): ResponseCacheStrategyInterface
  42. {
  43. return new ResponseCacheStrategy();
  44. }
  45. public function hasSurrogateCapability(Request $request): bool
  46. {
  47. if (null === $value = $request->headers->get('Surrogate-Capability')) {
  48. return false;
  49. }
  50. return str_contains($value, \sprintf('%s/1.0', strtoupper($this->getName())));
  51. }
  52. /**
  53. * @return void
  54. */
  55. public function addSurrogateCapability(Request $request)
  56. {
  57. $current = $request->headers->get('Surrogate-Capability');
  58. $new = \sprintf('symfony="%s/1.0"', strtoupper($this->getName()));
  59. $request->headers->set('Surrogate-Capability', $current ? $current.', '.$new : $new);
  60. }
  61. public function needsParsing(Response $response): bool
  62. {
  63. if (!$control = $response->headers->get('Surrogate-Control')) {
  64. return false;
  65. }
  66. $pattern = \sprintf('#content="[^"]*%s/1.0[^"]*"#', strtoupper($this->getName()));
  67. return (bool) preg_match($pattern, $control);
  68. }
  69. public function handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors): string
  70. {
  71. $subRequest = Request::create($uri, Request::METHOD_GET, [], $cache->getRequest()->cookies->all(), [], $cache->getRequest()->server->all());
  72. try {
  73. $response = $cache->handle($subRequest, HttpKernelInterface::SUB_REQUEST, true);
  74. if (!$response->isSuccessful() && Response::HTTP_NOT_MODIFIED !== $response->getStatusCode()) {
  75. throw new \RuntimeException(\sprintf('Error when rendering "%s" (Status code is %d).', $subRequest->getUri(), $response->getStatusCode()));
  76. }
  77. return $response->getContent();
  78. } catch (\Exception $e) {
  79. if ($alt) {
  80. return $this->handle($cache, $alt, '', $ignoreErrors);
  81. }
  82. if (!$ignoreErrors) {
  83. throw $e;
  84. }
  85. }
  86. return '';
  87. }
  88. /**
  89. * Remove the Surrogate from the Surrogate-Control header.
  90. *
  91. * @return void
  92. */
  93. protected function removeFromControl(Response $response)
  94. {
  95. if (!$response->headers->has('Surrogate-Control')) {
  96. return;
  97. }
  98. $value = $response->headers->get('Surrogate-Control');
  99. $upperName = strtoupper($this->getName());
  100. if (\sprintf('content="%s/1.0"', $upperName) == $value) {
  101. $response->headers->remove('Surrogate-Control');
  102. } elseif (preg_match(\sprintf('#,\s*content="%s/1.0"#', $upperName), $value)) {
  103. $response->headers->set('Surrogate-Control', preg_replace(\sprintf('#,\s*content="%s/1.0"#', $upperName), '', $value));
  104. } elseif (preg_match(\sprintf('#content="%s/1.0",\s*#', $upperName), $value)) {
  105. $response->headers->set('Surrogate-Control', preg_replace(\sprintf('#content="%s/1.0",\s*#', $upperName), '', $value));
  106. }
  107. }
  108. protected static function generateBodyEvalBoundary(): string
  109. {
  110. static $cookie;
  111. $cookie = hash('xxh128', $cookie ?? $cookie = random_bytes(16), true);
  112. $boundary = base64_encode($cookie);
  113. \assert(HttpCache::BODY_EVAL_BOUNDARY_LENGTH === \strlen($boundary));
  114. return $boundary;
  115. }
  116. }