vendor/symfony/http-foundation/Response.php line 898

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpFoundation;
  14. // Help opcache.preload discover always-needed symbols
  15. class_exists(ResponseHeaderBag::class);
  17. /**
  18.  * Response represents an HTTP response.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  */
  22. class Response
  23. {
  24.     public const HTTP_CONTINUE = 100;
  25.     public const HTTP_SWITCHING_PROTOCOLS = 101;
  26.     public const HTTP_PROCESSING = 102;            // RFC2518
  27.     public const HTTP_EARLY_HINTS = 103;           // RFC8297
  28.     public const HTTP_OK = 200;
  29.     public const HTTP_CREATED = 201;
  30.     public const HTTP_ACCEPTED = 202;
  31.     public const HTTP_NON_AUTHORITATIVE_INFORMATION = 203;
  32.     public const HTTP_NO_CONTENT = 204;
  33.     public const HTTP_RESET_CONTENT = 205;
  34.     public const HTTP_PARTIAL_CONTENT = 206;
  35.     public const HTTP_MULTI_STATUS = 207;          // RFC4918
  36.     public const HTTP_ALREADY_REPORTED = 208;      // RFC5842
  37.     public const HTTP_IM_USED = 226;               // RFC3229
  38.     public const HTTP_MULTIPLE_CHOICES = 300;
  39.     public const HTTP_MOVED_PERMANENTLY = 301;
  40.     public const HTTP_FOUND = 302;
  41.     public const HTTP_SEE_OTHER = 303;
  42.     public const HTTP_NOT_MODIFIED = 304;
  43.     public const HTTP_USE_PROXY = 305;
  44.     public const HTTP_RESERVED = 306;
  45.     public const HTTP_TEMPORARY_REDIRECT = 307;
  46.     public const HTTP_PERMANENTLY_REDIRECT = 308;  // RFC7238
  47.     public const HTTP_BAD_REQUEST = 400;
  48.     public const HTTP_UNAUTHORIZED = 401;
  49.     public const HTTP_PAYMENT_REQUIRED = 402;
  50.     public const HTTP_FORBIDDEN = 403;
  51.     public const HTTP_NOT_FOUND = 404;
  52.     public const HTTP_METHOD_NOT_ALLOWED = 405;
  53.     public const HTTP_NOT_ACCEPTABLE = 406;
  54.     public const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407;
  55.     public const HTTP_REQUEST_TIMEOUT = 408;
  56.     public const HTTP_CONFLICT = 409;
  57.     public const HTTP_GONE = 410;
  58.     public const HTTP_LENGTH_REQUIRED = 411;
  59.     public const HTTP_PRECONDITION_FAILED = 412;
  60.     public const HTTP_REQUEST_ENTITY_TOO_LARGE = 413;
  61.     public const HTTP_REQUEST_URI_TOO_LONG = 414;
  62.     public const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
  63.     public const HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
  64.     public const HTTP_EXPECTATION_FAILED = 417;
  65.     public const HTTP_I_AM_A_TEAPOT = 418;                                               // RFC2324
  66.     public const HTTP_MISDIRECTED_REQUEST = 421;                                         // RFC7540
  67.     public const HTTP_UNPROCESSABLE_ENTITY = 422;                                        // RFC4918
  68.     public const HTTP_LOCKED = 423;                                                      // RFC4918
  69.     public const HTTP_FAILED_DEPENDENCY = 424;                                           // RFC4918
  70.     public const HTTP_TOO_EARLY = 425;                                                   // RFC-ietf-httpbis-replay-04
  71.     public const HTTP_UPGRADE_REQUIRED = 426;                                            // RFC2817
  72.     public const HTTP_PRECONDITION_REQUIRED = 428;                                       // RFC6585
  73.     public const HTTP_TOO_MANY_REQUESTS = 429;                                           // RFC6585
  74.     public const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431;                             // RFC6585
  75.     public const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451;                               // RFC7725
  76.     public const HTTP_INTERNAL_SERVER_ERROR = 500;
  77.     public const HTTP_NOT_IMPLEMENTED = 501;
  78.     public const HTTP_BAD_GATEWAY = 502;
  79.     public const HTTP_SERVICE_UNAVAILABLE = 503;
  80.     public const HTTP_GATEWAY_TIMEOUT = 504;
  81.     public const HTTP_VERSION_NOT_SUPPORTED = 505;
  82.     public const HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506;                        // RFC2295
  83.     public const HTTP_INSUFFICIENT_STORAGE = 507;                                        // RFC4918
  84.     public const HTTP_LOOP_DETECTED = 508;                                               // RFC5842
  85.     public const HTTP_NOT_EXTENDED = 510;                                                // RFC2774
  86.     public const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511;                             // RFC6585
  88.     /**
  89.      * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
  90.      */
  91.     private const HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES = [
  92.         'must_revalidate' => false,
  93.         'no_cache' => false,
  94.         'no_store' => false,
  95.         'no_transform' => false,
  96.         'public' => false,
  97.         'private' => false,
  98.         'proxy_revalidate' => false,
  99.         'max_age' => true,
  100.         's_maxage' => true,
  101.         'stale_if_error' => true,         // RFC5861
  102.         'stale_while_revalidate' => true, // RFC5861
  103.         'immutable' => false,
  104.         'last_modified' => true,
  105.         'etag' => true,
  106.     ];
  108.     /**
  109.      * @var ResponseHeaderBag
  110.      */
  111.     public $headers;
  113.     /**
  114.      * @var string
  115.      */
  116.     protected $content;
  118.     /**
  119.      * @var string
  120.      */
  121.     protected $version;
  123.     /**
  124.      * @var int
  125.      */
  126.     protected $statusCode;
  128.     /**
  129.      * @var string
  130.      */
  131.     protected $statusText;
  133.     /**
  134.      * @var string
  135.      */
  136.     protected $charset;
  138.     /**
  139.      * Status codes translation table.
  140.      *
  141.      * The list of codes is complete according to the
  142.      * {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml Hypertext Transfer Protocol (HTTP) Status Code Registry}
  143.      * (last updated 2021-10-01).
  144.      *
  145.      * Unless otherwise noted, the status code is defined in RFC2616.
  146.      *
  147.      * @var array
  148.      */
  149.     public static $statusTexts = [
  150.         100 => 'Continue',
  151.         101 => 'Switching Protocols',
  152.         102 => 'Processing',            // RFC2518
  153.         103 => 'Early Hints',
  154.         200 => 'OK',
  155.         201 => 'Created',
  156.         202 => 'Accepted',
  157.         203 => 'Non-Authoritative Information',
  158.         204 => 'No Content',
  159.         205 => 'Reset Content',
  160.         206 => 'Partial Content',
  161.         207 => 'Multi-Status',          // RFC4918
  162.         208 => 'Already Reported',      // RFC5842
  163.         226 => 'IM Used',               // RFC3229
  164.         300 => 'Multiple Choices',
  165.         301 => 'Moved Permanently',
  166.         302 => 'Found',
  167.         303 => 'See Other',
  168.         304 => 'Not Modified',
  169.         305 => 'Use Proxy',
  170.         307 => 'Temporary Redirect',
  171.         308 => 'Permanent Redirect',    // RFC7238
  172.         400 => 'Bad Request',
  173.         401 => 'Unauthorized',
  174.         402 => 'Payment Required',
  175.         403 => 'Forbidden',
  176.         404 => 'Not Found',
  177.         405 => 'Method Not Allowed',
  178.         406 => 'Not Acceptable',
  179.         407 => 'Proxy Authentication Required',
  180.         408 => 'Request Timeout',
  181.         409 => 'Conflict',
  182.         410 => 'Gone',
  183.         411 => 'Length Required',
  184.         412 => 'Precondition Failed',
  185.         413 => 'Content Too Large',                                           // RFC-ietf-httpbis-semantics
  186.         414 => 'URI Too Long',
  187.         415 => 'Unsupported Media Type',
  188.         416 => 'Range Not Satisfiable',
  189.         417 => 'Expectation Failed',
  190.         418 => 'I\'m a teapot',                                               // RFC2324
  191.         421 => 'Misdirected Request',                                         // RFC7540
  192.         422 => 'Unprocessable Content',                                       // RFC-ietf-httpbis-semantics
  193.         423 => 'Locked',                                                      // RFC4918
  194.         424 => 'Failed Dependency',                                           // RFC4918
  195.         425 => 'Too Early',                                                   // RFC-ietf-httpbis-replay-04
  196.         426 => 'Upgrade Required',                                            // RFC2817
  197.         428 => 'Precondition Required',                                       // RFC6585
  198.         429 => 'Too Many Requests',                                           // RFC6585
  199.         431 => 'Request Header Fields Too Large',                             // RFC6585
  200.         451 => 'Unavailable For Legal Reasons',                               // RFC7725
  201.         500 => 'Internal Server Error',
  202.         501 => 'Not Implemented',
  203.         502 => 'Bad Gateway',
  204.         503 => 'Service Unavailable',
  205.         504 => 'Gateway Timeout',
  206.         505 => 'HTTP Version Not Supported',
  207.         506 => 'Variant Also Negotiates',                                     // RFC2295
  208.         507 => 'Insufficient Storage',                                        // RFC4918
  209.         508 => 'Loop Detected',                                               // RFC5842
  210.         510 => 'Not Extended',                                                // RFC2774
  211.         511 => 'Network Authentication Required',                             // RFC6585
  212.     ];
  214.     /**
  215.      * @throws \InvalidArgumentException When the HTTP status code is not valid
  216.      */
  217.     public function __construct(?string $content = '', int $status = 200, array $headers = [])
  218.     {
  219.         $this->headers = new ResponseHeaderBag($headers);
  220.         $this->setContent($content);
  221.         $this->setStatusCode($status);
  222.         $this->setProtocolVersion('1.0');
  223.     }
  225.     /**
  226.      * Returns the Response as an HTTP string.
  227.      *
  228.      * The string representation of the Response is the same as the
  229.      * one that will be sent to the client only if the prepare() method
  230.      * has been called before.
  231.      *
  232.      * @see prepare()
  233.      */
  234.     public function __toString(): string
  235.     {
  236.         return
  237.             sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText)."\r\n".
  238.             $this->headers."\r\n".
  239.             $this->getContent();
  240.     }
  242.     /**
  243.      * Clones the current Response instance.
  244.      */
  245.     public function __clone()
  246.     {
  247.         $this->headers = clone $this->headers;
  248.     }
  250.     /**
  251.      * Prepares the Response before it is sent to the client.
  252.      *
  253.      * This method tweaks the Response to ensure that it is
  254.      * compliant with RFC 2616. Most of the changes are based on
  255.      * the Request that is "associated" with this Response.
  256.      *
  257.      * @return $this
  258.      */
  259.     public function prepare(Request $request): static
  260.     {
  261.         $headers = $this->headers;
  263.         if ($this->isInformational() || $this->isEmpty()) {
  264.             $this->setContent(null);
  265.             $headers->remove('Content-Type');
  266.             $headers->remove('Content-Length');
  267.             // prevent PHP from sending the Content-Type header based on default_mimetype
  268.             ini_set('default_mimetype', '');
  269.         } else {
  270.             // Content-type based on the Request
  271.             if (!$headers->has('Content-Type')) {
  272.                 $format = $request->getRequestFormat(null);
  273.                 if (null !== $format && $mimeType = $request->getMimeType($format)) {
  274.                     $headers->set('Content-Type', $mimeType);
  275.                 }
  276.             }
  278.             // Fix Content-Type
  279.             $charset = $this->charset ?: 'UTF-8';
  280.             if (!$headers->has('Content-Type')) {
  281.                 $headers->set('Content-Type', 'text/html; charset='.$charset);
  282.             } elseif (0 === stripos($headers->get('Content-Type'), 'text/') && false === stripos($headers->get('Content-Type'), 'charset')) {
  283.                 // add the charset
  284.                 $headers->set('Content-Type', $headers->get('Content-Type').'; charset='.$charset);
  285.             }
  287.             // Fix Content-Length
  288.             if ($headers->has('Transfer-Encoding')) {
  289.                 $headers->remove('Content-Length');
  290.             }
  292.             if ($request->isMethod('HEAD')) {
  293.                 // cf. RFC2616 14.13
  294.                 $length = $headers->get('Content-Length');
  295.                 $this->setContent(null);
  296.                 if ($length) {
  297.                     $headers->set('Content-Length', $length);
  298.                 }
  299.             }
  300.         }
  302.         // Fix protocol
  303.         if ('HTTP/1.0' != $request->server->get('SERVER_PROTOCOL')) {
  304.             $this->setProtocolVersion('1.1');
  305.         }
  307.         // Check if we need to send extra expire info headers
  308.         if ('1.0' == $this->getProtocolVersion() && str_contains($headers->get('Cache-Control', ''), 'no-cache')) {
  309.             $headers->set('pragma', 'no-cache');
  310.             $headers->set('expires', -1);
  311.         }
  313.         $this->ensureIEOverSSLCompatibility($request);
  315.         if ($request->isSecure()) {
  316.             foreach ($headers->getCookies() as $cookie) {
  317.                 $cookie->setSecureDefault(true);
  318.             }
  319.         }
  321.         return $this;
  322.     }
  324.     /**
  325.      * Sends HTTP headers.
  326.      *
  327.      * @return $this
  328.      */
  329.     public function sendHeaders(): static
  330.     {
  331.         // headers have already been sent by the developer
  332.         if (headers_sent()) {
  333.             return $this;
  334.         }
  336.         // headers
  337.         foreach ($this->headers->allPreserveCaseWithoutCookies() as $name => $values) {
  338.             $replace = 0 === strcasecmp($name, 'Content-Type');
  339.             foreach ($values as $value) {
  340.                 header($name.': '.$value, $replace, $this->statusCode);
  341.             }
  342.         }
  344.         // cookies
  345.         foreach ($this->headers->getCookies() as $cookie) {
  346.             header('Set-Cookie: '.$cookie, false, $this->statusCode);
  347.         }
  349.         // status
  350.         header(sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText), true, $this->statusCode);
  352.         return $this;
  353.     }
  355.     /**
  356.      * Sends content for the current web response.
  357.      *
  358.      * @return $this
  359.      */
  360.     public function sendContent(): static
  361.     {
  362.         echo $this->content;
  364.         return $this;
  365.     }
  367.     /**
  368.      * Sends HTTP headers and content.
  369.      *
  370.      * @return $this
  371.      */
  372.     public function send(): static
  373.     {
  374.         $this->sendHeaders();
  375.         $this->sendContent();
  377.         if (\function_exists('fastcgi_finish_request')) {
  378.             fastcgi_finish_request();
  379.         } elseif (\function_exists('litespeed_finish_request')) {
  380.             litespeed_finish_request();
  381.         } elseif (!\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true)) {
  382.             static::closeOutputBuffers(0, true);
  383.             flush();
  384.         }
  386.         return $this;
  387.     }
  389.     /**
  390.      * Sets the response content.
  391.      *
  392.      * @return $this
  393.      */
  394.     public function setContent(?string $content): static
  395.     {
  396.         $this->content = $content ?? '';
  398.         return $this;
  399.     }
  401.     /**
  402.      * Gets the current response content.
  403.      */
  404.     public function getContent(): string|false
  405.     {
  406.         return $this->content;
  407.     }
  409.     /**
  410.      * Sets the HTTP protocol version (1.0 or 1.1).
  411.      *
  412.      * @return $this
  413.      *
  414.      * @final
  415.      */
  416.     public function setProtocolVersion(string $version): static
  417.     {
  418.         $this->version = $version;
  420.         return $this;
  421.     }
  423.     /**
  424.      * Gets the HTTP protocol version.
  425.      *
  426.      * @final
  427.      */
  428.     public function getProtocolVersion(): string
  429.     {
  430.         return $this->version;
  431.     }
  433.     /**
  434.      * Sets the response status code.
  435.      *
  436.      * If the status text is null it will be automatically populated for the known
  437.      * status codes and left empty otherwise.
  438.      *
  439.      * @return $this
  440.      *
  441.      * @throws \InvalidArgumentException When the HTTP status code is not valid
  442.      *
  443.      * @final
  444.      */
  445.     public function setStatusCode(int $code, string $text = null): static
  446.     {
  447.         $this->statusCode = $code;
  448.         if ($this->isInvalid()) {
  449.             throw new \InvalidArgumentException(sprintf('The HTTP status code "%s" is not valid.', $code));
  450.         }
  452.         if (null === $text) {
  453.             $this->statusText = self::$statusTexts[$code] ?? 'unknown status';
  455.             return $this;
  456.         }
  458.         if (false === $text) {
  459.             $this->statusText = '';
  461.             return $this;
  462.         }
  464.         $this->statusText = $text;
  466.         return $this;
  467.     }
  469.     /**
  470.      * Retrieves the status code for the current web response.
  471.      *
  472.      * @final
  473.      */
  474.     public function getStatusCode(): int
  475.     {
  476.         return $this->statusCode;
  477.     }
  479.     /**
  480.      * Sets the response charset.
  481.      *
  482.      * @return $this
  483.      *
  484.      * @final
  485.      */
  486.     public function setCharset(string $charset): static
  487.     {
  488.         $this->charset = $charset;
  490.         return $this;
  491.     }
  493.     /**
  494.      * Retrieves the response charset.
  495.      *
  496.      * @final
  497.      */
  498.     public function getCharset(): ?string
  499.     {
  500.         return $this->charset;
  501.     }
  503.     /**
  504.      * Returns true if the response may safely be kept in a shared (surrogate) cache.
  505.      *
  506.      * Responses marked "private" with an explicit Cache-Control directive are
  507.      * considered uncacheable.
  508.      *
  509.      * Responses with neither a freshness lifetime (Expires, max-age) nor cache
  510.      * validator (Last-Modified, ETag) are considered uncacheable because there is
  511.      * no way to tell when or how to remove them from the cache.
  512.      *
  513.      * Note that RFC 7231 and RFC 7234 possibly allow for a more permissive implementation,
  514.      * for example "status codes that are defined as cacheable by default [...]
  515.      * can be reused by a cache with heuristic expiration unless otherwise indicated"
  516.      * (https://tools.ietf.org/html/rfc7231#section-6.1)
  517.      *
  518.      * @final
  519.      */
  520.     public function isCacheable(): bool
  521.     {
  522.         if (!\in_array($this->statusCode, [200, 203, 300, 301, 302, 404, 410])) {
  523.             return false;
  524.         }
  526.         if ($this->headers->hasCacheControlDirective('no-store') || $this->headers->getCacheControlDirective('private')) {
  527.             return false;
  528.         }
  530.         return $this->isValidateable() || $this->isFresh();
  531.     }
  533.     /**
  534.      * Returns true if the response is "fresh".
  535.      *
  536.      * Fresh responses may be served from cache without any interaction with the
  537.      * origin. A response is considered fresh when it includes a Cache-Control/max-age
  538.      * indicator or Expires header and the calculated age is less than the freshness lifetime.
  539.      *
  540.      * @final
  541.      */
  542.     public function isFresh(): bool
  543.     {
  544.         return $this->getTtl() > 0;
  545.     }
  547.     /**
  548.      * Returns true if the response includes headers that can be used to validate
  549.      * the response with the origin server using a conditional GET request.
  550.      *
  551.      * @final
  552.      */
  553.     public function isValidateable(): bool
  554.     {
  555.         return $this->headers->has('Last-Modified') || $this->headers->has('ETag');
  556.     }
  558.     /**
  559.      * Marks the response as "private".
  560.      *
  561.      * It makes the response ineligible for serving other clients.
  562.      *
  563.      * @return $this
  564.      *
  565.      * @final
  566.      */
  567.     public function setPrivate(): static
  568.     {
  569.         $this->headers->removeCacheControlDirective('public');
  570.         $this->headers->addCacheControlDirective('private');
  572.         return $this;
  573.     }
  575.     /**
  576.      * Marks the response as "public".
  577.      *
  578.      * It makes the response eligible for serving other clients.
  579.      *
  580.      * @return $this
  581.      *
  582.      * @final
  583.      */
  584.     public function setPublic(): static
  585.     {
  586.         $this->headers->addCacheControlDirective('public');
  587.         $this->headers->removeCacheControlDirective('private');
  589.         return $this;
  590.     }
  592.     /**
  593.      * Marks the response as "immutable".
  594.      *
  595.      * @return $this
  596.      *
  597.      * @final
  598.      */
  599.     public function setImmutable(bool $immutable = true): static
  600.     {
  601.         if ($immutable) {
  602.             $this->headers->addCacheControlDirective('immutable');
  603.         } else {
  604.             $this->headers->removeCacheControlDirective('immutable');
  605.         }
  607.         return $this;
  608.     }
  610.     /**
  611.      * Returns true if the response is marked as "immutable".
  612.      *
  613.      * @final
  614.      */
  615.     public function isImmutable(): bool
  616.     {
  617.         return $this->headers->hasCacheControlDirective('immutable');
  618.     }
  620.     /**
  621.      * Returns true if the response must be revalidated by shared caches once it has become stale.
  622.      *
  623.      * This method indicates that the response must not be served stale by a
  624.      * cache in any circumstance without first revalidating with the origin.
  625.      * When present, the TTL of the response should not be overridden to be
  626.      * greater than the value provided by the origin.
  627.      *
  628.      * @final
  629.      */
  630.     public function mustRevalidate(): bool
  631.     {
  632.         return $this->headers->hasCacheControlDirective('must-revalidate') || $this->headers->hasCacheControlDirective('proxy-revalidate');
  633.     }
  635.     /**
  636.      * Returns the Date header as a DateTime instance.
  637.      *
  638.      * @throws \RuntimeException When the header is not parseable
  639.      *
  640.      * @final
  641.      */
  642.     public function getDate(): ?\DateTimeInterface
  643.     {
  644.         return $this->headers->getDate('Date');
  645.     }
  647.     /**
  648.      * Sets the Date header.
  649.      *
  650.      * @return $this
  651.      *
  652.      * @final
  653.      */
  654.     public function setDate(\DateTimeInterface $date): static
  655.     {
  656.         if ($date instanceof \DateTime) {
  657.             $date = \DateTimeImmutable::createFromMutable($date);
  658.         }
  660.         $date = $date->setTimezone(new \DateTimeZone('UTC'));
  661.         $this->headers->set('Date', $date->format('D, d M Y H:i:s').' GMT');
  663.         return $this;
  664.     }
  666.     /**
  667.      * Returns the age of the response in seconds.
  668.      *
  669.      * @final
  670.      */
  671.     public function getAge(): int
  672.     {
  673.         if (null !== $age = $this->headers->get('Age')) {
  674.             return (int) $age;
  675.         }
  677.         return max(time() - (int) $this->getDate()->format('U'), 0);
  678.     }
  680.     /**
  681.      * Marks the response stale by setting the Age header to be equal to the maximum age of the response.
  682.      *
  683.      * @return $this
  684.      */
  685.     public function expire(): static
  686.     {
  687.         if ($this->isFresh()) {
  688.             $this->headers->set('Age', $this->getMaxAge());
  689.             $this->headers->remove('Expires');
  690.         }
  692.         return $this;
  693.     }
  695.     /**
  696.      * Returns the value of the Expires header as a DateTime instance.
  697.      *
  698.      * @final
  699.      */
  700.     public function getExpires(): ?\DateTimeInterface
  701.     {
  702.         try {
  703.             return $this->headers->getDate('Expires');
  704.         } catch (\RuntimeException) {
  705.             // according to RFC 2616 invalid date formats (e.g. "0" and "-1") must be treated as in the past
  706.             return \DateTime::createFromFormat('U', time() - 172800);
  707.         }
  708.     }
  710.     /**
  711.      * Sets the Expires HTTP header with a DateTime instance.
  712.      *
  713.      * Passing null as value will remove the header.
  714.      *
  715.      * @return $this
  716.      *
  717.      * @final
  718.      */
  719.     public function setExpires(\DateTimeInterface $date = null): static
  720.     {
  721.         if (null === $date) {
  722.             $this->headers->remove('Expires');
  724.             return $this;
  725.         }
  727.         if ($date instanceof \DateTime) {
  728.             $date = \DateTimeImmutable::createFromMutable($date);
  729.         }
  731.         $date = $date->setTimezone(new \DateTimeZone('UTC'));
  732.         $this->headers->set('Expires', $date->format('D, d M Y H:i:s').' GMT');
  734.         return $this;
  735.     }
  737.     /**
  738.      * Returns the number of seconds after the time specified in the response's Date
  739.      * header when the response should no longer be considered fresh.
  740.      *
  741.      * First, it checks for a s-maxage directive, then a max-age directive, and then it falls
  742.      * back on an expires header. It returns null when no maximum age can be established.
  743.      *
  744.      * @final
  745.      */
  746.     public function getMaxAge(): ?int
  747.     {
  748.         if ($this->headers->hasCacheControlDirective('s-maxage')) {
  749.             return (int) $this->headers->getCacheControlDirective('s-maxage');
  750.         }
  752.         if ($this->headers->hasCacheControlDirective('max-age')) {
  753.             return (int) $this->headers->getCacheControlDirective('max-age');
  754.         }
  756.         if (null !== $this->getExpires()) {
  757.             return (int) $this->getExpires()->format('U') - (int) $this->getDate()->format('U');
  758.         }
  760.         return null;
  761.     }
  763.     /**
  764.      * Sets the number of seconds after which the response should no longer be considered fresh.
  765.      *
  766.      * This methods sets the Cache-Control max-age directive.
  767.      *
  768.      * @return $this
  769.      *
  770.      * @final
  771.      */
  772.     public function setMaxAge(int $value): static
  773.     {
  774.         $this->headers->addCacheControlDirective('max-age', $value);
  776.         return $this;
  777.     }
  779.     /**
  780.      * Sets the number of seconds after which the response should no longer be returned by shared caches when backend is down.
  781.      *
  782.      * This method sets the Cache-Control stale-if-error directive.
  783.      *
  784.      * @return $this
  785.      *
  786.      * @final
  787.      */
  788.     public function setStaleIfError(int $value): static
  789.     {
  790.         $this->headers->addCacheControlDirective('stale-if-error', $value);
  792.         return $this;
  793.     }
  795.     /**
  796.      * Sets the number of seconds after which the response should no longer return stale content by shared caches.
  797.      *
  798.      * This method sets the Cache-Control stale-while-revalidate directive.
  799.      *
  800.      * @return $this
  801.      *
  802.      * @final
  803.      */
  804.     public function setStaleWhileRevalidate(int $value): static
  805.     {
  806.         $this->headers->addCacheControlDirective('stale-while-revalidate', $value);
  808.         return $this;
  809.     }
  811.     /**
  812.      * Sets the number of seconds after which the response should no longer be considered fresh by shared caches.
  813.      *
  814.      * This methods sets the Cache-Control s-maxage directive.
  815.      *
  816.      * @return $this
  817.      *
  818.      * @final
  819.      */
  820.     public function setSharedMaxAge(int $value): static
  821.     {
  822.         $this->setPublic();
  823.         $this->headers->addCacheControlDirective('s-maxage', $value);
  825.         return $this;
  826.     }
  828.     /**
  829.      * Returns the response's time-to-live in seconds.
  830.      *
  831.      * It returns null when no freshness information is present in the response.
  832.      *
  833.      * When the responses TTL is <= 0, the response may not be served from cache without first
  834.      * revalidating with the origin.
  835.      *
  836.      * @final
  837.      */
  838.     public function getTtl(): ?int
  839.     {
  840.         $maxAge = $this->getMaxAge();
  842.         return null !== $maxAge ? $maxAge - $this->getAge() : null;
  843.     }
  845.     /**
  846.      * Sets the response's time-to-live for shared caches in seconds.
  847.      *
  848.      * This method adjusts the Cache-Control/s-maxage directive.
  849.      *
  850.      * @return $this
  851.      *
  852.      * @final
  853.      */
  854.     public function setTtl(int $seconds): static
  855.     {
  856.         $this->setSharedMaxAge($this->getAge() + $seconds);
  858.         return $this;
  859.     }
  861.     /**
  862.      * Sets the response's time-to-live for private/client caches in seconds.
  863.      *
  864.      * This method adjusts the Cache-Control/max-age directive.
  865.      *
  866.      * @return $this
  867.      *
  868.      * @final
  869.      */
  870.     public function setClientTtl(int $seconds): static
  871.     {
  872.         $this->setMaxAge($this->getAge() + $seconds);
  874.         return $this;
  875.     }
  877.     /**
  878.      * Returns the Last-Modified HTTP header as a DateTime instance.
  879.      *
  880.      * @throws \RuntimeException When the HTTP header is not parseable
  881.      *
  882.      * @final
  883.      */
  884.     public function getLastModified(): ?\DateTimeInterface
  885.     {
  886.         return $this->headers->getDate('Last-Modified');
  887.     }
  889.     /**
  890.      * Sets the Last-Modified HTTP header with a DateTime instance.
  891.      *
  892.      * Passing null as value will remove the header.
  893.      *
  894.      * @return $this
  895.      *
  896.      * @final
  897.      */
  898.     public function setLastModified(\DateTimeInterface $date = null): static
  899.     {
  900.         if (null === $date) {
  901.             $this->headers->remove('Last-Modified');
  903.             return $this;
  904.         }
  906.         if ($date instanceof \DateTime) {
  907.             $date = \DateTimeImmutable::createFromMutable($date);
  908.         }
  910.         $date = $date->setTimezone(new \DateTimeZone('UTC'));
  911.         $this->headers->set('Last-Modified', $date->format('D, d M Y H:i:s').' GMT');
  913.         return $this;
  914.     }
  916.     /**
  917.      * Returns the literal value of the ETag HTTP header.
  918.      *
  919.      * @final
  920.      */
  921.     public function getEtag(): ?string
  922.     {
  923.         return $this->headers->get('ETag');
  924.     }
  926.     /**
  927.      * Sets the ETag value.
  928.      *
  929.      * @param string|null $etag The ETag unique identifier or null to remove the header
  930.      * @param bool        $weak Whether you want a weak ETag or not
  931.      *
  932.      * @return $this
  933.      *
  934.      * @final
  935.      */
  936.     public function setEtag(string $etag = null, bool $weak = false): static
  937.     {
  938.         if (null === $etag) {
  939.             $this->headers->remove('Etag');
  940.         } else {
  941.             if (!str_starts_with($etag, '"')) {
  942.                 $etag = '"'.$etag.'"';
  943.             }
  945.             $this->headers->set('ETag', (true === $weak ? 'W/' : '').$etag);
  946.         }
  948.         return $this;
  949.     }
  951.     /**
  952.      * Sets the response's cache headers (validation and/or expiration).
  953.      *
  954.      * Available options are: must_revalidate, no_cache, no_store, no_transform, public, private, proxy_revalidate, max_age, s_maxage, immutable, last_modified and etag.
  955.      *
  956.      * @return $this
  957.      *
  958.      * @throws \InvalidArgumentException
  959.      *
  960.      * @final
  961.      */
  962.     public function setCache(array $options): static
  963.     {
  964.         if ($diff = array_diff(array_keys($options), array_keys(self::HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES))) {
  965.             throw new \InvalidArgumentException(sprintf('Response does not support the following options: "%s".', implode('", "', $diff)));
  966.         }
  968.         if (isset($options['etag'])) {
  969.             $this->setEtag($options['etag']);
  970.         }
  972.         if (isset($options['last_modified'])) {
  973.             $this->setLastModified($options['last_modified']);
  974.         }
  976.         if (isset($options['max_age'])) {
  977.             $this->setMaxAge($options['max_age']);
  978.         }
  980.         if (isset($options['s_maxage'])) {
  981.             $this->setSharedMaxAge($options['s_maxage']);
  982.         }
  984.         if (isset($options['stale_while_revalidate'])) {
  985.             $this->setStaleWhileRevalidate($options['stale_while_revalidate']);
  986.         }
  988.         if (isset($options['stale_if_error'])) {
  989.             $this->setStaleIfError($options['stale_if_error']);
  990.         }
  992.         foreach (self::HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES as $directive => $hasValue) {
  993.             if (!$hasValue && isset($options[$directive])) {
  994.                 if ($options[$directive]) {
  995.                     $this->headers->addCacheControlDirective(str_replace('_', '-', $directive));
  996.                 } else {
  997.                     $this->headers->removeCacheControlDirective(str_replace('_', '-', $directive));
  998.                 }
  999.             }
  1000.         }
  1002.         if (isset($options['public'])) {
  1003.             if ($options['public']) {
  1004.                 $this->setPublic();
  1005.             } else {
  1006.                 $this->setPrivate();
  1007.             }
  1008.         }
  1010.         if (isset($options['private'])) {
  1011.             if ($options['private']) {
  1012.                 $this->setPrivate();
  1013.             } else {
  1014.                 $this->setPublic();
  1015.             }
  1016.         }
  1018.         return $this;
  1019.     }
  1021.     /**
  1022.      * Modifies the response so that it conforms to the rules defined for a 304 status code.
  1023.      *
  1024.      * This sets the status, removes the body, and discards any headers
  1025.      * that MUST NOT be included in 304 responses.
  1026.      *
  1027.      * @return $this
  1028.      *
  1029.      * @see https://tools.ietf.org/html/rfc2616#section-10.3.5
  1030.      *
  1031.      * @final
  1032.      */
  1033.     public function setNotModified(): static
  1034.     {
  1035.         $this->setStatusCode(304);
  1036.         $this->setContent(null);
  1038.         // remove headers that MUST NOT be included with 304 Not Modified responses
  1039.         foreach (['Allow', 'Content-Encoding', 'Content-Language', 'Content-Length', 'Content-MD5', 'Content-Type', 'Last-Modified'] as $header) {
  1040.             $this->headers->remove($header);
  1041.         }
  1043.         return $this;
  1044.     }
  1046.     /**
  1047.      * Returns true if the response includes a Vary header.
  1048.      *
  1049.      * @final
  1050.      */
  1051.     public function hasVary(): bool
  1052.     {
  1053.         return null !== $this->headers->get('Vary');
  1054.     }
  1056.     /**
  1057.      * Returns an array of header names given in the Vary header.
  1058.      *
  1059.      * @final
  1060.      */
  1061.     public function getVary(): array
  1062.     {
  1063.         if (!$vary = $this->headers->all('Vary')) {
  1064.             return [];
  1065.         }
  1067.         $ret = [];
  1068.         foreach ($vary as $item) {
  1069.             $ret[] = preg_split('/[\s,]+/', $item);
  1070.         }
  1072.         return array_merge([], ...$ret);
  1073.     }
  1075.     /**
  1076.      * Sets the Vary header.
  1077.      *
  1078.      * @param bool $replace Whether to replace the actual value or not (true by default)
  1079.      *
  1080.      * @return $this
  1081.      *
  1082.      * @final
  1083.      */
  1084.     public function setVary(string|array $headers, bool $replace = true): static
  1085.     {
  1086.         $this->headers->set('Vary', $headers, $replace);
  1088.         return $this;
  1089.     }
  1091.     /**
  1092.      * Determines if the Response validators (ETag, Last-Modified) match
  1093.      * a conditional value specified in the Request.
  1094.      *
  1095.      * If the Response is not modified, it sets the status code to 304 and
  1096.      * removes the actual content by calling the setNotModified() method.
  1097.      *
  1098.      * @final
  1099.      */
  1100.     public function isNotModified(Request $request): bool
  1101.     {
  1102.         if (!$request->isMethodCacheable()) {
  1103.             return false;
  1104.         }
  1106.         $notModified = false;
  1107.         $lastModified = $this->headers->get('Last-Modified');
  1108.         $modifiedSince = $request->headers->get('If-Modified-Since');
  1110.         if (($ifNoneMatchEtags = $request->getETags()) && (null !== $etag = $this->getEtag())) {
  1111.             if (0 == strncmp($etag, 'W/', 2)) {
  1112.                 $etag = substr($etag, 2);
  1113.             }
  1115.             // Use weak comparison as per https://tools.ietf.org/html/rfc7232#section-3.2.
  1116.             foreach ($ifNoneMatchEtags as $ifNoneMatchEtag) {
  1117.                 if (0 == strncmp($ifNoneMatchEtag, 'W/', 2)) {
  1118.                     $ifNoneMatchEtag = substr($ifNoneMatchEtag, 2);
  1119.                 }
  1121.                 if ($ifNoneMatchEtag === $etag || '*' === $ifNoneMatchEtag) {
  1122.                     $notModified = true;
  1123.                     break;
  1124.                 }
  1125.             }
  1126.         }
  1127.         // Only do If-Modified-Since date comparison when If-None-Match is not present as per https://tools.ietf.org/html/rfc7232#section-3.3.
  1128.         elseif ($modifiedSince && $lastModified) {
  1129.             $notModified = strtotime($modifiedSince) >= strtotime($lastModified);
  1130.         }
  1132.         if ($notModified) {
  1133.             $this->setNotModified();
  1134.         }
  1136.         return $notModified;
  1137.     }
  1139.     /**
  1140.      * Is response invalid?
  1141.      *
  1142.      * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
  1143.      *
  1144.      * @final
  1145.      */
  1146.     public function isInvalid(): bool
  1147.     {
  1148.         return $this->statusCode < 100 || $this->statusCode >= 600;
  1149.     }
  1151.     /**
  1152.      * Is response informative?
  1153.      *
  1154.      * @final
  1155.      */
  1156.     public function isInformational(): bool
  1157.     {
  1158.         return $this->statusCode >= 100 && $this->statusCode < 200;
  1159.     }
  1161.     /**
  1162.      * Is response successful?
  1163.      *
  1164.      * @final
  1165.      */
  1166.     public function isSuccessful(): bool
  1167.     {
  1168.         return $this->statusCode >= 200 && $this->statusCode < 300;
  1169.     }
  1171.     /**
  1172.      * Is the response a redirect?
  1173.      *
  1174.      * @final
  1175.      */
  1176.     public function isRedirection(): bool
  1177.     {
  1178.         return $this->statusCode >= 300 && $this->statusCode < 400;
  1179.     }
  1181.     /**
  1182.      * Is there a client error?
  1183.      *
  1184.      * @final
  1185.      */
  1186.     public function isClientError(): bool
  1187.     {
  1188.         return $this->statusCode >= 400 && $this->statusCode < 500;
  1189.     }
  1191.     /**
  1192.      * Was there a server side error?
  1193.      *
  1194.      * @final
  1195.      */
  1196.     public function isServerError(): bool
  1197.     {
  1198.         return $this->statusCode >= 500 && $this->statusCode < 600;
  1199.     }
  1201.     /**
  1202.      * Is the response OK?
  1203.      *
  1204.      * @final
  1205.      */
  1206.     public function isOk(): bool
  1207.     {
  1208.         return 200 === $this->statusCode;
  1209.     }
  1211.     /**
  1212.      * Is the response forbidden?
  1213.      *
  1214.      * @final
  1215.      */
  1216.     public function isForbidden(): bool
  1217.     {
  1218.         return 403 === $this->statusCode;
  1219.     }
  1221.     /**
  1222.      * Is the response a not found error?
  1223.      *
  1224.      * @final
  1225.      */
  1226.     public function isNotFound(): bool
  1227.     {
  1228.         return 404 === $this->statusCode;
  1229.     }
  1231.     /**
  1232.      * Is the response a redirect of some form?
  1233.      *
  1234.      * @final
  1235.      */
  1236.     public function isRedirect(string $location = null): bool
  1237.     {
  1238.         return \in_array($this->statusCode, [201, 301, 302, 303, 307, 308]) && (null === $location ?: $location == $this->headers->get('Location'));
  1239.     }
  1241.     /**
  1242.      * Is the response empty?
  1243.      *
  1244.      * @final
  1245.      */
  1246.     public function isEmpty(): bool
  1247.     {
  1248.         return \in_array($this->statusCode, [204, 304]);
  1249.     }
  1251.     /**
  1252.      * Cleans or flushes output buffers up to target level.
  1253.      *
  1254.      * Resulting level can be greater than target level if a non-removable buffer has been encountered.
  1255.      *
  1256.      * @final
  1257.      */
  1258.     public static function closeOutputBuffers(int $targetLevel, bool $flush): void
  1259.     {
  1260.         $status = ob_get_status(true);
  1261.         $level = \count($status);
  1262.         $flags = \PHP_OUTPUT_HANDLER_REMOVABLE | ($flush ? \PHP_OUTPUT_HANDLER_FLUSHABLE : \PHP_OUTPUT_HANDLER_CLEANABLE);
  1264.         while ($level-- > $targetLevel && ($s = $status[$level]) && (!isset($s['del']) ? !isset($s['flags']) || ($s['flags'] & $flags) === $flags : $s['del'])) {
  1265.             if ($flush) {
  1266.                 ob_end_flush();
  1267.             } else {
  1268.                 ob_end_clean();
  1269.             }
  1270.         }
  1271.     }
  1273.     /**
  1274.      * Marks a response as safe according to RFC8674.
  1275.      *
  1276.      * @see https://tools.ietf.org/html/rfc8674
  1277.      */
  1278.     public function setContentSafe(bool $safe = true): void
  1279.     {
  1280.         if ($safe) {
  1281.             $this->headers->set('Preference-Applied', 'safe');
  1282.         } elseif ('safe' === $this->headers->get('Preference-Applied')) {
  1283.             $this->headers->remove('Preference-Applied');
  1284.         }
  1286.         $this->setVary('Prefer', false);
  1287.     }
  1289.     /**
  1290.      * Checks if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9.
  1291.      *
  1292.      * @see http://support.microsoft.com/kb/323308
  1293.      *
  1294.      * @final
  1295.      */
  1296.     protected function ensureIEOverSSLCompatibility(Request $request): void
  1297.     {
  1298.         if (false !== stripos($this->headers->get('Content-Disposition') ?? '', 'attachment') && 1 == preg_match('/MSIE (.*?);/i', $request->server->get('HTTP_USER_AGENT') ?? '', $match) && true === $request->isSecure()) {
  1299.             if ((int) preg_replace('/(MSIE )(.*?);/', '$2', $match[0]) < 9) {
  1300.                 $this->headers->remove('Cache-Control');
  1301.             }
  1302.         }
  1303.     }
  1304. }