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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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 <[email protected]>
  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.         'immutable' => false,
  102.         'last_modified' => true,
  103.         'etag' => true,
  104.     ];
  106.     /**
  107.      * @var ResponseHeaderBag
  108.      */
  109.     public $headers;
  111.     /**
  112.      * @var string
  113.      */
  114.     protected $content;
  116.     /**
  117.      * @var string
  118.      */
  119.     protected $version;
  121.     /**
  122.      * @var int
  123.      */
  124.     protected $statusCode;
  126.     /**
  127.      * @var string
  128.      */
  129.     protected $statusText;
  131.     /**
  132.      * @var string
  133.      */
  134.     protected $charset;
  136.     /**
  137.      * Status codes translation table.
  138.      *
  139.      * The list of codes is complete according to the
  140.      * {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml Hypertext Transfer Protocol (HTTP) Status Code Registry}
  141.      * (last updated 2021-10-01).
  142.      *
  143.      * Unless otherwise noted, the status code is defined in RFC2616.
  144.      *
  145.      * @var array
  146.      */
  147.     public static $statusTexts = [
  148.         100 => 'Continue',
  149.         101 => 'Switching Protocols',
  150.         102 => 'Processing',            // RFC2518
  151.         103 => 'Early Hints',
  152.         200 => 'OK',
  153.         201 => 'Created',
  154.         202 => 'Accepted',
  155.         203 => 'Non-Authoritative Information',
  156.         204 => 'No Content',
  157.         205 => 'Reset Content',
  158.         206 => 'Partial Content',
  159.         207 => 'Multi-Status',          // RFC4918
  160.         208 => 'Already Reported',      // RFC5842
  161.         226 => 'IM Used',               // RFC3229
  162.         300 => 'Multiple Choices',
  163.         301 => 'Moved Permanently',
  164.         302 => 'Found',
  165.         303 => 'See Other',
  166.         304 => 'Not Modified',
  167.         305 => 'Use Proxy',
  168.         307 => 'Temporary Redirect',
  169.         308 => 'Permanent Redirect',    // RFC7238
  170.         400 => 'Bad Request',
  171.         401 => 'Unauthorized',
  172.         402 => 'Payment Required',
  173.         403 => 'Forbidden',
  174.         404 => 'Not Found',
  175.         405 => 'Method Not Allowed',
  176.         406 => 'Not Acceptable',
  177.         407 => 'Proxy Authentication Required',
  178.         408 => 'Request Timeout',
  179.         409 => 'Conflict',
  180.         410 => 'Gone',
  181.         411 => 'Length Required',
  182.         412 => 'Precondition Failed',
  183.         413 => 'Content Too Large',                                           // RFC-ietf-httpbis-semantics
  184.         414 => 'URI Too Long',
  185.         415 => 'Unsupported Media Type',
  186.         416 => 'Range Not Satisfiable',
  187.         417 => 'Expectation Failed',
  188.         418 => 'I\'m a teapot',                                               // RFC2324
  189.         421 => 'Misdirected Request',                                         // RFC7540
  190.         422 => 'Unprocessable Content',                                       // RFC-ietf-httpbis-semantics
  191.         423 => 'Locked',                                                      // RFC4918
  192.         424 => 'Failed Dependency',                                           // RFC4918
  193.         425 => 'Too Early',                                                   // RFC-ietf-httpbis-replay-04
  194.         426 => 'Upgrade Required',                                            // RFC2817
  195.         428 => 'Precondition Required',                                       // RFC6585
  196.         429 => 'Too Many Requests',                                           // RFC6585
  197.         431 => 'Request Header Fields Too Large',                             // RFC6585
  198.         451 => 'Unavailable For Legal Reasons',                               // RFC7725
  199.         500 => 'Internal Server Error',
  200.         501 => 'Not Implemented',
  201.         502 => 'Bad Gateway',
  202.         503 => 'Service Unavailable',
  203.         504 => 'Gateway Timeout',
  204.         505 => 'HTTP Version Not Supported',
  205.         506 => 'Variant Also Negotiates',                                     // RFC2295
  206.         507 => 'Insufficient Storage',                                        // RFC4918
  207.         508 => 'Loop Detected',                                               // RFC5842
  208.         510 => 'Not Extended',                                                // RFC2774
  209.         511 => 'Network Authentication Required',                             // RFC6585
  210.     ];
  212.     /**
  213.      * @throws \InvalidArgumentException When the HTTP status code is not valid
  214.      */
  215.     public function __construct(?string $content = '', int $status = 200, array $headers = [])
  216.     {
  217.         $this->headers = new ResponseHeaderBag($headers);
  218.         $this->setContent($content);
  219.         $this->setStatusCode($status);
  220.         $this->setProtocolVersion('1.0');
  221.     }
  223.     /**
  224.      * Returns the Response as an HTTP string.
  225.      *
  226.      * The string representation of the Response is the same as the
  227.      * one that will be sent to the client only if the prepare() method
  228.      * has been called before.
  229.      *
  230.      * @see prepare()
  231.      */
  232.     public function __toString(): string
  233.     {
  234.         return
  235.             sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText)."\r\n".
  236.             $this->headers."\r\n".
  237.             $this->getContent();
  238.     }
  240.     /**
  241.      * Clones the current Response instance.
  242.      */
  243.     public function __clone()
  244.     {
  245.         $this->headers = clone $this->headers;
  246.     }
  248.     /**
  249.      * Prepares the Response before it is sent to the client.
  250.      *
  251.      * This method tweaks the Response to ensure that it is
  252.      * compliant with RFC 2616. Most of the changes are based on
  253.      * the Request that is "associated" with this Response.
  254.      *
  255.      * @return $this
  256.      */
  257.     public function prepare(Request $request): static
  258.     {
  259.         $headers = $this->headers;
  261.         if ($this->isInformational() || $this->isEmpty()) {
  262.             $this->setContent(null);
  263.             $headers->remove('Content-Type');
  264.             $headers->remove('Content-Length');
  265.             // prevent PHP from sending the Content-Type header based on default_mimetype
  266.             ini_set('default_mimetype', '');
  267.         } else {
  268.             // Content-type based on the Request
  269.             if (!$headers->has('Content-Type')) {
  270.                 $format = $request->getRequestFormat(null);
  271.                 if (null !== $format && $mimeType = $request->getMimeType($format)) {
  272.                     $headers->set('Content-Type', $mimeType);
  273.                 }
  274.             }
  276.             // Fix Content-Type
  277.             $charset = $this->charset ?: 'UTF-8';
  278.             if (!$headers->has('Content-Type')) {
  279.                 $headers->set('Content-Type', 'text/html; charset='.$charset);
  280.             } elseif (0 === stripos($headers->get('Content-Type'), 'text/') && false === stripos($headers->get('Content-Type'), 'charset')) {
  281.                 // add the charset
  282.                 $headers->set('Content-Type', $headers->get('Content-Type').'; charset='.$charset);
  283.             }
  285.             // Fix Content-Length
  286.             if ($headers->has('Transfer-Encoding')) {
  287.                 $headers->remove('Content-Length');
  288.             }
  290.             if ($request->isMethod('HEAD')) {
  291.                 // cf. RFC2616 14.13
  292.                 $length = $headers->get('Content-Length');
  293.                 $this->setContent(null);
  294.                 if ($length) {
  295.                     $headers->set('Content-Length', $length);
  296.                 }
  297.             }
  298.         }
  300.         // Fix protocol
  301.         if ('HTTP/1.0' != $request->server->get('SERVER_PROTOCOL')) {
  302.             $this->setProtocolVersion('1.1');
  303.         }
  305.         // Check if we need to send extra expire info headers
  306.         if ('1.0' == $this->getProtocolVersion() && str_contains($headers->get('Cache-Control', ''), 'no-cache')) {
  307.             $headers->set('pragma', 'no-cache');
  308.             $headers->set('expires', -1);
  309.         }
  311.         $this->ensureIEOverSSLCompatibility($request);
  313.         if ($request->isSecure()) {
  314.             foreach ($headers->getCookies() as $cookie) {
  315.                 $cookie->setSecureDefault(true);
  316.             }
  317.         }
  319.         return $this;
  320.     }
  322.     /**
  323.      * Sends HTTP headers.
  324.      *
  325.      * @return $this
  326.      */
  327.     public function sendHeaders(): static
  328.     {
  329.         // headers have already been sent by the developer
  330.         if (headers_sent()) {
  331.             return $this;
  332.         }
  334.         // headers
  335.         foreach ($this->headers->allPreserveCaseWithoutCookies() as $name => $values) {
  336.             $replace = 0 === strcasecmp($name, 'Content-Type');
  337.             foreach ($values as $value) {
  338.                 header($name.': '.$value, $replace, $this->statusCode);
  339.             }
  340.         }
  342.         // cookies
  343.         foreach ($this->headers->getCookies() as $cookie) {
  344.             header('Set-Cookie: '.$cookie, false, $this->statusCode);
  345.         }
  347.         // status
  348.         header(sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText), true, $this->statusCode);
  350.         return $this;
  351.     }
  353.     /**
  354.      * Sends content for the current web response.
  355.      *
  356.      * @return $this
  357.      */
  358.     public function sendContent(): static
  359.     {
  360.         echo $this->content;
  362.         return $this;
  363.     }
  365.     /**
  366.      * Sends HTTP headers and content.
  367.      *
  368.      * @return $this
  369.      */
  370.     public function send(): static
  371.     {
  372.         $this->sendHeaders();
  373.         $this->sendContent();
  375.         if (\function_exists('fastcgi_finish_request')) {
  376.             fastcgi_finish_request();
  377.         } elseif (\function_exists('litespeed_finish_request')) {
  378.             litespeed_finish_request();
  379.         } elseif (!\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true)) {
  380.             static::closeOutputBuffers(0, true);
  381.         }
  383.         return $this;
  384.     }
  386.     /**
  387.      * Sets the response content.
  388.      *
  389.      * @return $this
  390.      */
  391.     public function setContent(?string $content): static
  392.     {
  393.         $this->content = $content ?? '';
  395.         return $this;
  396.     }
  398.     /**
  399.      * Gets the current response content.
  400.      */
  401.     public function getContent(): string|false
  402.     {
  403.         return $this->content;
  404.     }
  406.     /**
  407.      * Sets the HTTP protocol version (1.0 or 1.1).
  408.      *
  409.      * @return $this
  410.      *
  411.      * @final
  412.      */
  413.     public function setProtocolVersion(string $version): static
  414.     {
  415.         $this->version = $version;
  417.         return $this;
  418.     }
  420.     /**
  421.      * Gets the HTTP protocol version.
  422.      *
  423.      * @final
  424.      */
  425.     public function getProtocolVersion(): string
  426.     {
  427.         return $this->version;
  428.     }
  430.     /**
  431.      * Sets the response status code.
  432.      *
  433.      * If the status text is null it will be automatically populated for the known
  434.      * status codes and left empty otherwise.
  435.      *
  436.      * @return $this
  437.      *
  438.      * @throws \InvalidArgumentException When the HTTP status code is not valid
  439.      *
  440.      * @final
  441.      */
  442.     public function setStatusCode(int $code, string $text = null): static
  443.     {
  444.         $this->statusCode = $code;
  445.         if ($this->isInvalid()) {
  446.             throw new \InvalidArgumentException(sprintf('The HTTP status code "%s" is not valid.', $code));
  447.         }
  449.         if (null === $text) {
  450.             $this->statusText = self::$statusTexts[$code] ?? 'unknown status';
  452.             return $this;
  453.         }
  455.         if (false === $text) {
  456.             $this->statusText = '';
  458.             return $this;
  459.         }
  461.         $this->statusText = $text;
  463.         return $this;
  464.     }
  466.     /**
  467.      * Retrieves the status code for the current web response.
  468.      *
  469.      * @final
  470.      */
  471.     public function getStatusCode(): int
  472.     {
  473.         return $this->statusCode;
  474.     }
  476.     /**
  477.      * Sets the response charset.
  478.      *
  479.      * @return $this
  480.      *
  481.      * @final
  482.      */
  483.     public function setCharset(string $charset): static
  484.     {
  485.         $this->charset = $charset;
  487.         return $this;
  488.     }
  490.     /**
  491.      * Retrieves the response charset.
  492.      *
  493.      * @final
  494.      */
  495.     public function getCharset(): ?string
  496.     {
  497.         return $this->charset;
  498.     }
  500.     /**
  501.      * Returns true if the response may safely be kept in a shared (surrogate) cache.
  502.      *
  503.      * Responses marked "private" with an explicit Cache-Control directive are
  504.      * considered uncacheable.
  505.      *
  506.      * Responses with neither a freshness lifetime (Expires, max-age) nor cache
  507.      * validator (Last-Modified, ETag) are considered uncacheable because there is
  508.      * no way to tell when or how to remove them from the cache.
  509.      *
  510.      * Note that RFC 7231 and RFC 7234 possibly allow for a more permissive implementation,
  511.      * for example "status codes that are defined as cacheable by default [...]
  512.      * can be reused by a cache with heuristic expiration unless otherwise indicated"
  513.      * (https://tools.ietf.org/html/rfc7231#section-6.1)
  514.      *
  515.      * @final
  516.      */
  517.     public function isCacheable(): bool
  518.     {
  519.         if (!\in_array($this->statusCode, [200, 203, 300, 301, 302, 404, 410])) {
  520.             return false;
  521.         }
  523.         if ($this->headers->hasCacheControlDirective('no-store') || $this->headers->getCacheControlDirective('private')) {
  524.             return false;
  525.         }
  527.         return $this->isValidateable() || $this->isFresh();
  528.     }
  530.     /**
  531.      * Returns true if the response is "fresh".
  532.      *
  533.      * Fresh responses may be served from cache without any interaction with the
  534.      * origin. A response is considered fresh when it includes a Cache-Control/max-age
  535.      * indicator or Expires header and the calculated age is less than the freshness lifetime.
  536.      *
  537.      * @final
  538.      */
  539.     public function isFresh(): bool
  540.     {
  541.         return $this->getTtl() > 0;
  542.     }
  544.     /**
  545.      * Returns true if the response includes headers that can be used to validate
  546.      * the response with the origin server using a conditional GET request.
  547.      *
  548.      * @final
  549.      */
  550.     public function isValidateable(): bool
  551.     {
  552.         return $this->headers->has('Last-Modified') || $this->headers->has('ETag');
  553.     }
  555.     /**
  556.      * Marks the response as "private".
  557.      *
  558.      * It makes the response ineligible for serving other clients.
  559.      *
  560.      * @return $this
  561.      *
  562.      * @final
  563.      */
  564.     public function setPrivate(): static
  565.     {
  566.         $this->headers->removeCacheControlDirective('public');
  567.         $this->headers->addCacheControlDirective('private');
  569.         return $this;
  570.     }
  572.     /**
  573.      * Marks the response as "public".
  574.      *
  575.      * It makes the response eligible for serving other clients.
  576.      *
  577.      * @return $this
  578.      *
  579.      * @final
  580.      */
  581.     public function setPublic(): static
  582.     {
  583.         $this->headers->addCacheControlDirective('public');
  584.         $this->headers->removeCacheControlDirective('private');
  586.         return $this;
  587.     }
  589.     /**
  590.      * Marks the response as "immutable".
  591.      *
  592.      * @return $this
  593.      *
  594.      * @final
  595.      */
  596.     public function setImmutable(bool $immutable = true): static
  597.     {
  598.         if ($immutable) {
  599.             $this->headers->addCacheControlDirective('immutable');
  600.         } else {
  601.             $this->headers->removeCacheControlDirective('immutable');
  602.         }
  604.         return $this;
  605.     }
  607.     /**
  608.      * Returns true if the response is marked as "immutable".
  609.      *
  610.      * @final
  611.      */
  612.     public function isImmutable(): bool
  613.     {
  614.         return $this->headers->hasCacheControlDirective('immutable');
  615.     }
  617.     /**
  618.      * Returns true if the response must be revalidated by shared caches once it has become stale.
  619.      *
  620.      * This method indicates that the response must not be served stale by a
  621.      * cache in any circumstance without first revalidating with the origin.
  622.      * When present, the TTL of the response should not be overridden to be
  623.      * greater than the value provided by the origin.
  624.      *
  625.      * @final
  626.      */
  627.     public function mustRevalidate(): bool
  628.     {
  629.         return $this->headers->hasCacheControlDirective('must-revalidate') || $this->headers->hasCacheControlDirective('proxy-revalidate');
  630.     }
  632.     /**
  633.      * Returns the Date header as a DateTime instance.
  634.      *
  635.      * @throws \RuntimeException When the header is not parseable
  636.      *
  637.      * @final
  638.      */
  639.     public function getDate(): ?\DateTimeInterface
  640.     {
  641.         return $this->headers->getDate('Date');
  642.     }
  644.     /**
  645.      * Sets the Date header.
  646.      *
  647.      * @return $this
  648.      *
  649.      * @final
  650.      */
  651.     public function setDate(\DateTimeInterface $date): static
  652.     {
  653.         if ($date instanceof \DateTime) {
  654.             $date = \DateTimeImmutable::createFromMutable($date);
  655.         }
  657.         $date = $date->setTimezone(new \DateTimeZone('UTC'));
  658.         $this->headers->set('Date', $date->format('D, d M Y H:i:s').' GMT');
  660.         return $this;
  661.     }
  663.     /**
  664.      * Returns the age of the response in seconds.
  665.      *
  666.      * @final
  667.      */
  668.     public function getAge(): int
  669.     {
  670.         if (null !== $age = $this->headers->get('Age')) {
  671.             return (int) $age;
  672.         }
  674.         return max(time() - (int) $this->getDate()->format('U'), 0);
  675.     }
  677.     /**
  678.      * Marks the response stale by setting the Age header to be equal to the maximum age of the response.
  679.      *
  680.      * @return $this
  681.      */
  682.     public function expire(): static
  683.     {
  684.         if ($this->isFresh()) {
  685.             $this->headers->set('Age', $this->getMaxAge());
  686.             $this->headers->remove('Expires');
  687.         }
  689.         return $this;
  690.     }
  692.     /**
  693.      * Returns the value of the Expires header as a DateTime instance.
  694.      *
  695.      * @final
  696.      */
  697.     public function getExpires(): ?\DateTimeInterface
  698.     {
  699.         try {
  700.             return $this->headers->getDate('Expires');
  701.         } catch (\RuntimeException $e) {
  702.             // according to RFC 2616 invalid date formats (e.g. "0" and "-1") must be treated as in the past
  703.             return \DateTime::createFromFormat('U', time() - 172800);
  704.         }
  705.     }
  707.     /**
  708.      * Sets the Expires HTTP header with a DateTime instance.
  709.      *
  710.      * Passing null as value will remove the header.
  711.      *
  712.      * @return $this
  713.      *
  714.      * @final
  715.      */
  716.     public function setExpires(\DateTimeInterface $date = null): static
  717.     {
  718.         if (null === $date) {
  719.             $this->headers->remove('Expires');
  721.             return $this;
  722.         }
  724.         if ($date instanceof \DateTime) {
  725.             $date = \DateTimeImmutable::createFromMutable($date);
  726.         }
  728.         $date = $date->setTimezone(new \DateTimeZone('UTC'));
  729.         $this->headers->set('Expires', $date->format('D, d M Y H:i:s').' GMT');
  731.         return $this;
  732.     }
  734.     /**
  735.      * Returns the number of seconds after the time specified in the response's Date
  736.      * header when the response should no longer be considered fresh.
  737.      *
  738.      * First, it checks for a s-maxage directive, then a max-age directive, and then it falls
  739.      * back on an expires header. It returns null when no maximum age can be established.
  740.      *
  741.      * @final
  742.      */
  743.     public function getMaxAge(): ?int
  744.     {
  745.         if ($this->headers->hasCacheControlDirective('s-maxage')) {
  746.             return (int) $this->headers->getCacheControlDirective('s-maxage');
  747.         }
  749.         if ($this->headers->hasCacheControlDirective('max-age')) {
  750.             return (int) $this->headers->getCacheControlDirective('max-age');
  751.         }
  753.         if (null !== $this->getExpires()) {
  754.             return (int) $this->getExpires()->format('U') - (int) $this->getDate()->format('U');
  755.         }
  757.         return null;
  758.     }
  760.     /**
  761.      * Sets the number of seconds after which the response should no longer be considered fresh.
  762.      *
  763.      * This methods sets the Cache-Control max-age directive.
  764.      *
  765.      * @return $this
  766.      *
  767.      * @final
  768.      */
  769.     public function setMaxAge(int $value): static
  770.     {
  771.         $this->headers->addCacheControlDirective('max-age', $value);
  773.         return $this;
  774.     }
  776.     /**
  777.      * Sets the number of seconds after which the response should no longer be considered fresh by shared caches.
  778.      *
  779.      * This methods sets the Cache-Control s-maxage directive.
  780.      *
  781.      * @return $this
  782.      *
  783.      * @final
  784.      */
  785.     public function setSharedMaxAge(int $value): static
  786.     {
  787.         $this->setPublic();
  788.         $this->headers->addCacheControlDirective('s-maxage', $value);
  790.         return $this;
  791.     }
  793.     /**
  794.      * Returns the response's time-to-live in seconds.
  795.      *
  796.      * It returns null when no freshness information is present in the response.
  797.      *
  798.      * When the responses TTL is <= 0, the response may not be served from cache without first
  799.      * revalidating with the origin.
  800.      *
  801.      * @final
  802.      */
  803.     public function getTtl(): ?int
  804.     {
  805.         $maxAge = $this->getMaxAge();
  807.         return null !== $maxAge ? $maxAge - $this->getAge() : null;
  808.     }
  810.     /**
  811.      * Sets the response's time-to-live for shared caches in seconds.
  812.      *
  813.      * This method adjusts the Cache-Control/s-maxage directive.
  814.      *
  815.      * @return $this
  816.      *
  817.      * @final
  818.      */
  819.     public function setTtl(int $seconds): static
  820.     {
  821.         $this->setSharedMaxAge($this->getAge() + $seconds);
  823.         return $this;
  824.     }
  826.     /**
  827.      * Sets the response's time-to-live for private/client caches in seconds.
  828.      *
  829.      * This method adjusts the Cache-Control/max-age directive.
  830.      *
  831.      * @return $this
  832.      *
  833.      * @final
  834.      */
  835.     public function setClientTtl(int $seconds): static
  836.     {
  837.         $this->setMaxAge($this->getAge() + $seconds);
  839.         return $this;
  840.     }
  842.     /**
  843.      * Returns the Last-Modified HTTP header as a DateTime instance.
  844.      *
  845.      * @throws \RuntimeException When the HTTP header is not parseable
  846.      *
  847.      * @final
  848.      */
  849.     public function getLastModified(): ?\DateTimeInterface
  850.     {
  851.         return $this->headers->getDate('Last-Modified');
  852.     }
  854.     /**
  855.      * Sets the Last-Modified HTTP header with a DateTime instance.
  856.      *
  857.      * Passing null as value will remove the header.
  858.      *
  859.      * @return $this
  860.      *
  861.      * @final
  862.      */
  863.     public function setLastModified(\DateTimeInterface $date = null): static
  864.     {
  865.         if (null === $date) {
  866.             $this->headers->remove('Last-Modified');
  868.             return $this;
  869.         }
  871.         if ($date instanceof \DateTime) {
  872.             $date = \DateTimeImmutable::createFromMutable($date);
  873.         }
  875.         $date = $date->setTimezone(new \DateTimeZone('UTC'));
  876.         $this->headers->set('Last-Modified', $date->format('D, d M Y H:i:s').' GMT');
  878.         return $this;
  879.     }
  881.     /**
  882.      * Returns the literal value of the ETag HTTP header.
  883.      *
  884.      * @final
  885.      */
  886.     public function getEtag(): ?string
  887.     {
  888.         return $this->headers->get('ETag');
  889.     }
  891.     /**
  892.      * Sets the ETag value.
  893.      *
  894.      * @param string|null $etag The ETag unique identifier or null to remove the header
  895.      * @param bool        $weak Whether you want a weak ETag or not
  896.      *
  897.      * @return $this
  898.      *
  899.      * @final
  900.      */
  901.     public function setEtag(string $etag = null, bool $weak = false): static
  902.     {
  903.         if (null === $etag) {
  904.             $this->headers->remove('Etag');
  905.         } else {
  906.             if (!str_starts_with($etag, '"')) {
  907.                 $etag = '"'.$etag.'"';
  908.             }
  910.             $this->headers->set('ETag', (true === $weak ? 'W/' : '').$etag);
  911.         }
  913.         return $this;
  914.     }
  916.     /**
  917.      * Sets the response's cache headers (validation and/or expiration).
  918.      *
  919.      * Available options are: must_revalidate, no_cache, no_store, no_transform, public, private, proxy_revalidate, max_age, s_maxage, immutable, last_modified and etag.
  920.      *
  921.      * @return $this
  922.      *
  923.      * @throws \InvalidArgumentException
  924.      *
  925.      * @final
  926.      */
  927.     public function setCache(array $options): static
  928.     {
  929.         if ($diff = array_diff(array_keys($options), array_keys(self::HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES))) {
  930.             throw new \InvalidArgumentException(sprintf('Response does not support the following options: "%s".', implode('", "', $diff)));
  931.         }
  933.         if (isset($options['etag'])) {
  934.             $this->setEtag($options['etag']);
  935.         }
  937.         if (isset($options['last_modified'])) {
  938.             $this->setLastModified($options['last_modified']);
  939.         }
  941.         if (isset($options['max_age'])) {
  942.             $this->setMaxAge($options['max_age']);
  943.         }
  945.         if (isset($options['s_maxage'])) {
  946.             $this->setSharedMaxAge($options['s_maxage']);
  947.         }
  949.         foreach (self::HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES as $directive => $hasValue) {
  950.             if (!$hasValue && isset($options[$directive])) {
  951.                 if ($options[$directive]) {
  952.                     $this->headers->addCacheControlDirective(str_replace('_', '-', $directive));
  953.                 } else {
  954.                     $this->headers->removeCacheControlDirective(str_replace('_', '-', $directive));
  955.                 }
  956.             }
  957.         }
  959.         if (isset($options['public'])) {
  960.             if ($options['public']) {
  961.                 $this->setPublic();
  962.             } else {
  963.                 $this->setPrivate();
  964.             }
  965.         }
  967.         if (isset($options['private'])) {
  968.             if ($options['private']) {
  969.                 $this->setPrivate();
  970.             } else {
  971.                 $this->setPublic();
  972.             }
  973.         }
  975.         return $this;
  976.     }
  978.     /**
  979.      * Modifies the response so that it conforms to the rules defined for a 304 status code.
  980.      *
  981.      * This sets the status, removes the body, and discards any headers
  982.      * that MUST NOT be included in 304 responses.
  983.      *
  984.      * @return $this
  985.      *
  986.      * @see https://tools.ietf.org/html/rfc2616#section-10.3.5
  987.      *
  988.      * @final
  989.      */
  990.     public function setNotModified(): static
  991.     {
  992.         $this->setStatusCode(304);
  993.         $this->setContent(null);
  995.         // remove headers that MUST NOT be included with 304 Not Modified responses
  996.         foreach (['Allow', 'Content-Encoding', 'Content-Language', 'Content-Length', 'Content-MD5', 'Content-Type', 'Last-Modified'] as $header) {
  997.             $this->headers->remove($header);
  998.         }
  1000.         return $this;
  1001.     }
  1003.     /**
  1004.      * Returns true if the response includes a Vary header.
  1005.      *
  1006.      * @final
  1007.      */
  1008.     public function hasVary(): bool
  1009.     {
  1010.         return null !== $this->headers->get('Vary');
  1011.     }
  1013.     /**
  1014.      * Returns an array of header names given in the Vary header.
  1015.      *
  1016.      * @final
  1017.      */
  1018.     public function getVary(): array
  1019.     {
  1020.         if (!$vary = $this->headers->all('Vary')) {
  1021.             return [];
  1022.         }
  1024.         $ret = [];
  1025.         foreach ($vary as $item) {
  1026.             $ret[] = preg_split('/[\s,]+/', $item);
  1027.         }
  1029.         return array_merge([], ...$ret);
  1030.     }
  1032.     /**
  1033.      * Sets the Vary header.
  1034.      *
  1035.      * @param bool $replace Whether to replace the actual value or not (true by default)
  1036.      *
  1037.      * @return $this
  1038.      *
  1039.      * @final
  1040.      */
  1041.     public function setVary(string|array $headers, bool $replace = true): static
  1042.     {
  1043.         $this->headers->set('Vary', $headers, $replace);
  1045.         return $this;
  1046.     }
  1048.     /**
  1049.      * Determines if the Response validators (ETag, Last-Modified) match
  1050.      * a conditional value specified in the Request.
  1051.      *
  1052.      * If the Response is not modified, it sets the status code to 304 and
  1053.      * removes the actual content by calling the setNotModified() method.
  1054.      *
  1055.      * @final
  1056.      */
  1057.     public function isNotModified(Request $request): bool
  1058.     {
  1059.         if (!$request->isMethodCacheable()) {
  1060.             return false;
  1061.         }
  1063.         $notModified = false;
  1064.         $lastModified = $this->headers->get('Last-Modified');
  1065.         $modifiedSince = $request->headers->get('If-Modified-Since');
  1067.         if (($ifNoneMatchEtags = $request->getETags()) && (null !== $etag = $this->getEtag())) {
  1068.             if (0 == strncmp($etag, 'W/', 2)) {
  1069.                 $etag = substr($etag, 2);
  1070.             }
  1072.             // Use weak comparison as per https://tools.ietf.org/html/rfc7232#section-3.2.
  1073.             foreach ($ifNoneMatchEtags as $ifNoneMatchEtag) {
  1074.                 if (0 == strncmp($ifNoneMatchEtag, 'W/', 2)) {
  1075.                     $ifNoneMatchEtag = substr($ifNoneMatchEtag, 2);
  1076.                 }
  1078.                 if ($ifNoneMatchEtag === $etag || '*' === $ifNoneMatchEtag) {
  1079.                     $notModified = true;
  1080.                     break;
  1081.                 }
  1082.             }
  1083.         }
  1084.         // 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.
  1085.         elseif ($modifiedSince && $lastModified) {
  1086.             $notModified = strtotime($modifiedSince) >= strtotime($lastModified);
  1087.         }
  1089.         if ($notModified) {
  1090.             $this->setNotModified();
  1091.         }
  1093.         return $notModified;
  1094.     }
  1096.     /**
  1097.      * Is response invalid?
  1098.      *
  1099.      * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
  1100.      *
  1101.      * @final
  1102.      */
  1103.     public function isInvalid(): bool
  1104.     {
  1105.         return $this->statusCode < 100 || $this->statusCode >= 600;
  1106.     }
  1108.     /**
  1109.      * Is response informative?
  1110.      *
  1111.      * @final
  1112.      */
  1113.     public function isInformational(): bool
  1114.     {
  1115.         return $this->statusCode >= 100 && $this->statusCode < 200;
  1116.     }
  1118.     /**
  1119.      * Is response successful?
  1120.      *
  1121.      * @final
  1122.      */
  1123.     public function isSuccessful(): bool
  1124.     {
  1125.         return $this->statusCode >= 200 && $this->statusCode < 300;
  1126.     }
  1128.     /**
  1129.      * Is the response a redirect?
  1130.      *
  1131.      * @final
  1132.      */
  1133.     public function isRedirection(): bool
  1134.     {
  1135.         return $this->statusCode >= 300 && $this->statusCode < 400;
  1136.     }
  1138.     /**
  1139.      * Is there a client error?
  1140.      *
  1141.      * @final
  1142.      */
  1143.     public function isClientError(): bool
  1144.     {
  1145.         return $this->statusCode >= 400 && $this->statusCode < 500;
  1146.     }
  1148.     /**
  1149.      * Was there a server side error?
  1150.      *
  1151.      * @final
  1152.      */
  1153.     public function isServerError(): bool
  1154.     {
  1155.         return $this->statusCode >= 500 && $this->statusCode < 600;
  1156.     }
  1158.     /**
  1159.      * Is the response OK?
  1160.      *
  1161.      * @final
  1162.      */
  1163.     public function isOk(): bool
  1164.     {
  1165.         return 200 === $this->statusCode;
  1166.     }
  1168.     /**
  1169.      * Is the response forbidden?
  1170.      *
  1171.      * @final
  1172.      */
  1173.     public function isForbidden(): bool
  1174.     {
  1175.         return 403 === $this->statusCode;
  1176.     }
  1178.     /**
  1179.      * Is the response a not found error?
  1180.      *
  1181.      * @final
  1182.      */
  1183.     public function isNotFound(): bool
  1184.     {
  1185.         return 404 === $this->statusCode;
  1186.     }
  1188.     /**
  1189.      * Is the response a redirect of some form?
  1190.      *
  1191.      * @final
  1192.      */
  1193.     public function isRedirect(string $location = null): bool
  1194.     {
  1195.         return \in_array($this->statusCode, [201, 301, 302, 303, 307, 308]) && (null === $location ?: $location == $this->headers->get('Location'));
  1196.     }
  1198.     /**
  1199.      * Is the response empty?
  1200.      *
  1201.      * @final
  1202.      */
  1203.     public function isEmpty(): bool
  1204.     {
  1205.         return \in_array($this->statusCode, [204, 304]);
  1206.     }
  1208.     /**
  1209.      * Cleans or flushes output buffers up to target level.
  1210.      *
  1211.      * Resulting level can be greater than target level if a non-removable buffer has been encountered.
  1212.      *
  1213.      * @final
  1214.      */
  1215.     public static function closeOutputBuffers(int $targetLevel, bool $flush): void
  1216.     {
  1217.         $status = ob_get_status(true);
  1218.         $level = \count($status);
  1219.         $flags = \PHP_OUTPUT_HANDLER_REMOVABLE | ($flush ? \PHP_OUTPUT_HANDLER_FLUSHABLE : \PHP_OUTPUT_HANDLER_CLEANABLE);
  1221.         while ($level-- > $targetLevel && ($s = $status[$level]) && (!isset($s['del']) ? !isset($s['flags']) || ($s['flags'] & $flags) === $flags : $s['del'])) {
  1222.             if ($flush) {
  1223.                 ob_end_flush();
  1224.                 flush();
  1225.             } else {
  1226.                 ob_end_clean();
  1227.             }
  1228.         }
  1229.     }
  1231.     /**
  1232.      * Marks a response as safe according to RFC8674.
  1233.      *
  1234.      * @see https://tools.ietf.org/html/rfc8674
  1235.      */
  1236.     public function setContentSafe(bool $safe = true): void
  1237.     {
  1238.         if ($safe) {
  1239.             $this->headers->set('Preference-Applied', 'safe');
  1240.         } elseif ('safe' === $this->headers->get('Preference-Applied')) {
  1241.             $this->headers->remove('Preference-Applied');
  1242.         }
  1244.         $this->setVary('Prefer', false);
  1245.     }
  1247.     /**
  1248.      * Checks if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9.
  1249.      *
  1250.      * @see http://support.microsoft.com/kb/323308
  1251.      *
  1252.      * @final
  1253.      */
  1254.     protected function ensureIEOverSSLCompatibility(Request $request): void
  1255.     {
  1256.         if (false !== stripos($this->headers->get('Content-Disposition') ?? '', 'attachment') && 1 == preg_match('/MSIE (.*?);/i', $request->server->get('HTTP_USER_AGENT') ?? '', $match) && true === $request->isSecure()) {
  1257.             if ((int) preg_replace('/(MSIE )(.*?);/', '$2', $match[0]) < 9) {
  1258.                 $this->headers->remove('Cache-Control');
  1259.             }
  1260.         }
  1261.     }
  1262. }