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

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