12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\HttpFoundation;
- /**
- * Response represents an HTTP response.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- *
- * @api
- */
- class Response
- {
- /**
- * @var \Symfony\Component\HttpFoundation\ResponseHeaderBag
- */
- public $headers;
- /**
- * @var string
- */
- protected $content;
- /**
- * @var string
- */
- protected $version;
- /**
- * @var integer
- */
- protected $statusCode;
- /**
- * @var string
- */
- protected $statusText;
- /**
- * @var string
- */
- protected $charset;
- /**
- * Status codes translation table.
- *
- * The list of codes is complete according to the
- * {@link http://www.iana.org/assignments/http-status-codes/ Hypertext Transfer Protocol (HTTP) Status Code Registry}
- * (last updated 2012-02-13).
- *
- * Unless otherwise noted, the status code is defined in RFC2616.
- *
- * @var array
- */
- public static $statusTexts = array(
- 100 => 'Continue',
- 101 => 'Switching Protocols',
- 102 => 'Processing', // RFC2518
- 200 => 'OK',
- 201 => 'Created',
- 202 => 'Accepted',
- 203 => 'Non-Authoritative Information',
- 204 => 'No Content',
- 205 => 'Reset Content',
- 206 => 'Partial Content',
- 207 => 'Multi-Status', // RFC4918
- 208 => 'Already Reported', // RFC5842
- 226 => 'IM Used', // RFC3229
- 300 => 'Multiple Choices',
- 301 => 'Moved Permanently',
- 302 => 'Found',
- 303 => 'See Other',
- 304 => 'Not Modified',
- 305 => 'Use Proxy',
- 306 => 'Reserved',
- 307 => 'Temporary Redirect',
- 308 => 'Permanent Redirect', // RFC-reschke-http-status-308-07
- 400 => 'Bad Request',
- 401 => 'Unauthorized',
- 402 => 'Payment Required',
- 403 => 'Forbidden',
- 404 => 'Not Found',
- 405 => 'Method Not Allowed',
- 406 => 'Not Acceptable',
- 407 => 'Proxy Authentication Required',
- 408 => 'Request Timeout',
- 409 => 'Conflict',
- 410 => 'Gone',
- 411 => 'Length Required',
- 412 => 'Precondition Failed',
- 413 => 'Request Entity Too Large',
- 414 => 'Request-URI Too Long',
- 415 => 'Unsupported Media Type',
- 416 => 'Requested Range Not Satisfiable',
- 417 => 'Expectation Failed',
- 418 => 'I\'m a teapot', // RFC2324
- 422 => 'Unprocessable Entity', // RFC4918
- 423 => 'Locked', // RFC4918
- 424 => 'Failed Dependency', // RFC4918
- 425 => 'Reserved for WebDAV advanced collections expired proposal', // RFC2817
- 426 => 'Upgrade Required', // RFC2817
- 428 => 'Precondition Required', // RFC6585
- 429 => 'Too Many Requests', // RFC6585
- 431 => 'Request Header Fields Too Large', // RFC6585
- 500 => 'Internal Server Error',
- 501 => 'Not Implemented',
- 502 => 'Bad Gateway',
- 503 => 'Service Unavailable',
- 504 => 'Gateway Timeout',
- 505 => 'HTTP Version Not Supported',
- 506 => 'Variant Also Negotiates (Experimental)', // RFC2295
- 507 => 'Insufficient Storage', // RFC4918
- 508 => 'Loop Detected', // RFC5842
- 510 => 'Not Extended', // RFC2774
- 511 => 'Network Authentication Required', // RFC6585
- );
- /**
- * Constructor.
- *
- * @param string $content The response content
- * @param integer $status The response status code
- * @param array $headers An array of response headers
- *
- * @throws \InvalidArgumentException When the HTTP status code is not valid
- *
- * @api
- */
- public function __construct($content = '', $status = 200, $headers = array())
- {
- $this->headers = new ResponseHeaderBag($headers);
- $this->setContent($content);
- $this->setStatusCode($status);
- $this->setProtocolVersion('1.0');
- if (!$this->headers->has('Date')) {
- $this->setDate(new \DateTime(null, new \DateTimeZone('UTC')));
- }
- }
- /**
- * Factory method for chainability
- *
- * Example:
- *
- * return Response::create($body, 200)
- * ->setSharedMaxAge(300);
- *
- * @param string $content The response content
- * @param integer $status The response status code
- * @param array $headers An array of response headers
- *
- * @return Response
- */
- public static function create($content = '', $status = 200, $headers = array())
- {
- return new static($content, $status, $headers);
- }
- /**
- * Returns the Response as an HTTP string.
- *
- * The string representation of the Response is the same as the
- * one that will be sent to the client only if the prepare() method
- * has been called before.
- *
- * @return string The Response as an HTTP string
- *
- * @see prepare()
- */
- public function __toString()
- {
- return
- sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText)."\r\n".
- $this->headers."\r\n".
- $this->getContent();
- }
- /**
- * Clones the current Response instance.
- */
- public function __clone()
- {
- $this->headers = clone $this->headers;
- }
- /**
- * Prepares the Response before it is sent to the client.
- *
- * This method tweaks the Response to ensure that it is
- * compliant with RFC 2616. Most of the changes are based on
- * the Request that is "associated" with this Response.
- *
- * @param Request $request A Request instance
- *
- * @return Response The current response.
- */
- public function prepare(Request $request)
- {
- $headers = $this->headers;
- if ($this->isInformational() || in_array($this->statusCode, array(204, 304))) {
- $this->setContent(null);
- }
- // Content-type based on the Request
- if (!$headers->has('Content-Type')) {
- $format = $request->getRequestFormat();
- if (null !== $format && $mimeType = $request->getMimeType($format)) {
- $headers->set('Content-Type', $mimeType);
- }
- }
- // Fix Content-Type
- $charset = $this->charset ?: 'UTF-8';
- if (!$headers->has('Content-Type')) {
- $headers->set('Content-Type', 'text/html; charset='.$charset);
- } elseif (0 === strpos($headers->get('Content-Type'), 'text/') && false === strpos($headers->get('Content-Type'), 'charset')) {
- // add the charset
- $headers->set('Content-Type', $headers->get('Content-Type').'; charset='.$charset);
- }
- // Fix Content-Length
- if ($headers->has('Transfer-Encoding')) {
- $headers->remove('Content-Length');
- }
- if ($request->isMethod('HEAD')) {
- // cf. RFC2616 14.13
- $length = $headers->get('Content-Length');
- $this->setContent(null);
- if ($length) {
- $headers->set('Content-Length', $length);
- }
- }
- // Fix protocol
- if ('HTTP/1.0' != $request->server->get('SERVER_PROTOCOL')) {
- $this->setProtocolVersion('1.1');
- }
- // Check if we need to send extra expire info headers
- if ('1.0' == $this->getProtocolVersion() && 'no-cache' == $this->headers->get('Cache-Control')) {
- $this->headers->set('pragma', 'no-cache');
- $this->headers->set('expires', -1);
- }
- $this->ensureIEOverSSLCompatibility($request);
- return $this;
- }
- /**
- * Sends HTTP headers.
- *
- * @return Response
- */
- public function sendHeaders()
- {
- // headers have already been sent by the developer
- if (headers_sent()) {
- return $this;
- }
- // status
- header(sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText));
- // headers
- foreach ($this->headers->allPreserveCase() as $name => $values) {
- foreach ($values as $value) {
- header($name.': '.$value, false);
- }
- }
- // cookies
- foreach ($this->headers->getCookies() as $cookie) {
- setcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $cookie->getPath(), $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
- }
- return $this;
- }
- /**
- * Sends content for the current web response.
- *
- * @return Response
- */
- public function sendContent()
- {
- echo $this->content;
- return $this;
- }
- /**
- * Sends HTTP headers and content.
- *
- * @return Response
- *
- * @api
- */
- public function send()
- {
- $this->sendHeaders();
- $this->sendContent();
- if (function_exists('fastcgi_finish_request')) {
- fastcgi_finish_request();
- } elseif ('cli' !== PHP_SAPI) {
- // ob_get_level() never returns 0 on some Windows configurations, so if
- // the level is the same two times in a row, the loop should be stopped.
- $previous = null;
- $obStatus = ob_get_status(1);
- while (($level = ob_get_level()) > 0 && $level !== $previous) {
- $previous = $level;
- if ($obStatus[$level - 1]) {
- if (version_compare(PHP_VERSION, '5.4', '>=')) {
- if (isset($obStatus[$level - 1]['flags']) && ($obStatus[$level - 1]['flags'] & PHP_OUTPUT_HANDLER_REMOVABLE)) {
- ob_end_flush();
- }
- } else {
- if (isset($obStatus[$level - 1]['del']) && $obStatus[$level - 1]['del']) {
- ob_end_flush();
- }
- }
- }
- }
- flush();
- }
- return $this;
- }
- /**
- * Sets the response content.
- *
- * Valid types are strings, numbers, and objects that implement a __toString() method.
- *
- * @param mixed $content
- *
- * @return Response
- *
- * @throws \UnexpectedValueException
- *
- * @api
- */
- public function setContent($content)
- {
- if (null !== $content && !is_string($content) && !is_numeric($content) && !is_callable(array($content, '__toString'))) {
- throw new \UnexpectedValueException(sprintf('The Response content must be a string or object implementing __toString(), "%s" given.', gettype($content)));
- }
- $this->content = (string) $content;
- return $this;
- }
- /**
- * Gets the current response content.
- *
- * @return string Content
- *
- * @api
- */
- public function getContent()
- {
- return $this->content;
- }
- /**
- * Sets the HTTP protocol version (1.0 or 1.1).
- *
- * @param string $version The HTTP protocol version
- *
- * @return Response
- *
- * @api
- */
- public function setProtocolVersion($version)
- {
- $this->version = $version;
- return $this;
- }
- /**
- * Gets the HTTP protocol version.
- *
- * @return string The HTTP protocol version
- *
- * @api
- */
- public function getProtocolVersion()
- {
- return $this->version;
- }
- /**
- * Sets the response status code.
- *
- * @param integer $code HTTP status code
- * @param mixed $text HTTP status text
- *
- * If the status text is null it will be automatically populated for the known
- * status codes and left empty otherwise.
- *
- * @return Response
- *
- * @throws \InvalidArgumentException When the HTTP status code is not valid
- *
- * @api
- */
- public function setStatusCode($code, $text = null)
- {
- $this->statusCode = $code = (int) $code;
- if ($this->isInvalid()) {
- throw new \InvalidArgumentException(sprintf('The HTTP status code "%s" is not valid.', $code));
- }
- if (null === $text) {
- $this->statusText = isset(self::$statusTexts[$code]) ? self::$statusTexts[$code] : '';
- return $this;
- }
- if (false === $text) {
- $this->statusText = '';
- return $this;
- }
- $this->statusText = $text;
- return $this;
- }
- /**
- * Retrieves the status code for the current web response.
- *
- * @return integer Status code
- *
- * @api
- */
- public function getStatusCode()
- {
- return $this->statusCode;
- }
- /**
- * Sets the response charset.
- *
- * @param string $charset Character set
- *
- * @return Response
- *
- * @api
- */
- public function setCharset($charset)
- {
- $this->charset = $charset;
- return $this;
- }
- /**
- * Retrieves the response charset.
- *
- * @return string Character set
- *
- * @api
- */
- public function getCharset()
- {
- return $this->charset;
- }
- /**
- * Returns true if the response is worth caching under any circumstance.
- *
- * Responses marked "private" with an explicit Cache-Control directive are
- * considered uncacheable.
- *
- * Responses with neither a freshness lifetime (Expires, max-age) nor cache
- * validator (Last-Modified, ETag) are considered uncacheable.
- *
- * @return Boolean true if the response is worth caching, false otherwise
- *
- * @api
- */
- public function isCacheable()
- {
- if (!in_array($this->statusCode, array(200, 203, 300, 301, 302, 404, 410))) {
- return false;
- }
- if ($this->headers->hasCacheControlDirective('no-store') || $this->headers->getCacheControlDirective('private')) {
- return false;
- }
- return $this->isValidateable() || $this->isFresh();
- }
- /**
- * Returns true if the response is "fresh".
- *
- * Fresh responses may be served from cache without any interaction with the
- * origin. A response is considered fresh when it includes a Cache-Control/max-age
- * indicator or Expires header and the calculated age is less than the freshness lifetime.
- *
- * @return Boolean true if the response is fresh, false otherwise
- *
- * @api
- */
- public function isFresh()
- {
- return $this->getTtl() > 0;
- }
- /**
- * Returns true if the response includes headers that can be used to validate
- * the response with the origin server using a conditional GET request.
- *
- * @return Boolean true if the response is validateable, false otherwise
- *
- * @api
- */
- public function isValidateable()
- {
- return $this->headers->has('Last-Modified') || $this->headers->has('ETag');
- }
- /**
- * Marks the response as "private".
- *
- * It makes the response ineligible for serving other clients.
- *
- * @return Response
- *
- * @api
- */
- public function setPrivate()
- {
- $this->headers->removeCacheControlDirective('public');
- $this->headers->addCacheControlDirective('private');
- return $this;
- }
- /**
- * Marks the response as "public".
- *
- * It makes the response eligible for serving other clients.
- *
- * @return Response
- *
- * @api
- */
- public function setPublic()
- {
- $this->headers->addCacheControlDirective('public');
- $this->headers->removeCacheControlDirective('private');
- return $this;
- }
- /**
- * Returns true if the response must be revalidated by caches.
- *
- * This method indicates that the response must not be served stale by a
- * cache in any circumstance without first revalidating with the origin.
- * When present, the TTL of the response should not be overridden to be
- * greater than the value provided by the origin.
- *
- * @return Boolean true if the response must be revalidated by a cache, false otherwise
- *
- * @api
- */
- public function mustRevalidate()
- {
- return $this->headers->hasCacheControlDirective('must-revalidate') || $this->headers->has('proxy-revalidate');
- }
- /**
- * Returns the Date header as a DateTime instance.
- *
- * @return \DateTime A \DateTime instance
- *
- * @throws \RuntimeException When the header is not parseable
- *
- * @api
- */
- public function getDate()
- {
- return $this->headers->getDate('Date', new \DateTime());
- }
- /**
- * Sets the Date header.
- *
- * @param \DateTime $date A \DateTime instance
- *
- * @return Response
- *
- * @api
- */
- public function setDate(\DateTime $date)
- {
- $date->setTimezone(new \DateTimeZone('UTC'));
- $this->headers->set('Date', $date->format('D, d M Y H:i:s').' GMT');
- return $this;
- }
- /**
- * Returns the age of the response.
- *
- * @return integer The age of the response in seconds
- */
- public function getAge()
- {
- if (null !== $age = $this->headers->get('Age')) {
- return (int) $age;
- }
- return max(time() - $this->getDate()->format('U'), 0);
- }
- /**
- * Marks the response stale by setting the Age header to be equal to the maximum age of the response.
- *
- * @return Response
- *
- * @api
- */
- public function expire()
- {
- if ($this->isFresh()) {
- $this->headers->set('Age', $this->getMaxAge());
- }
- return $this;
- }
- /**
- * Returns the value of the Expires header as a DateTime instance.
- *
- * @return \DateTime|null A DateTime instance or null if the header does not exist
- *
- * @api
- */
- public function getExpires()
- {
- try {
- return $this->headers->getDate('Expires');
- } catch (\RuntimeException $e) {
- // according to RFC 2616 invalid date formats (e.g. "0" and "-1") must be treated as in the past
- return \DateTime::createFromFormat(DATE_RFC2822, 'Sat, 01 Jan 00 00:00:00 +0000');
- }
- }
- /**
- * Sets the Expires HTTP header with a DateTime instance.
- *
- * Passing null as value will remove the header.
- *
- * @param \DateTime|null $date A \DateTime instance or null to remove the header
- *
- * @return Response
- *
- * @api
- */
- public function setExpires(\DateTime $date = null)
- {
- if (null === $date) {
- $this->headers->remove('Expires');
- } else {
- $date = clone $date;
- $date->setTimezone(new \DateTimeZone('UTC'));
- $this->headers->set('Expires', $date->format('D, d M Y H:i:s').' GMT');
- }
- return $this;
- }
- /**
- * Returns the number of seconds after the time specified in the response's Date
- * header when the response should no longer be considered fresh.
- *
- * First, it checks for a s-maxage directive, then a max-age directive, and then it falls
- * back on an expires header. It returns null when no maximum age can be established.
- *
- * @return integer|null Number of seconds
- *
- * @api
- */
- public function getMaxAge()
- {
- if ($this->headers->hasCacheControlDirective('s-maxage')) {
- return (int) $this->headers->getCacheControlDirective('s-maxage');
- }
- if ($this->headers->hasCacheControlDirective('max-age')) {
- return (int) $this->headers->getCacheControlDirective('max-age');
- }
- if (null !== $this->getExpires()) {
- return $this->getExpires()->format('U') - $this->getDate()->format('U');
- }
- return null;
- }
- /**
- * Sets the number of seconds after which the response should no longer be considered fresh.
- *
- * This methods sets the Cache-Control max-age directive.
- *
- * @param integer $value Number of seconds
- *
- * @return Response
- *
- * @api
- */
- public function setMaxAge($value)
- {
- $this->headers->addCacheControlDirective('max-age', $value);
- return $this;
- }
- /**
- * Sets the number of seconds after which the response should no longer be considered fresh by shared caches.
- *
- * This methods sets the Cache-Control s-maxage directive.
- *
- * @param integer $value Number of seconds
- *
- * @return Response
- *
- * @api
- */
- public function setSharedMaxAge($value)
- {
- $this->setPublic();
- $this->headers->addCacheControlDirective('s-maxage', $value);
- return $this;
- }
- /**
- * Returns the response's time-to-live in seconds.
- *
- * It returns null when no freshness information is present in the response.
- *
- * When the responses TTL is <= 0, the response may not be served from cache without first
- * revalidating with the origin.
- *
- * @return integer|null The TTL in seconds
- *
- * @api
- */
- public function getTtl()
- {
- if (null !== $maxAge = $this->getMaxAge()) {
- return $maxAge - $this->getAge();
- }
- return null;
- }
- /**
- * Sets the response's time-to-live for shared caches.
- *
- * This method adjusts the Cache-Control/s-maxage directive.
- *
- * @param integer $seconds Number of seconds
- *
- * @return Response
- *
- * @api
- */
- public function setTtl($seconds)
- {
- $this->setSharedMaxAge($this->getAge() + $seconds);
- return $this;
- }
- /**
- * Sets the response's time-to-live for private/client caches.
- *
- * This method adjusts the Cache-Control/max-age directive.
- *
- * @param integer $seconds Number of seconds
- *
- * @return Response
- *
- * @api
- */
- public function setClientTtl($seconds)
- {
- $this->setMaxAge($this->getAge() + $seconds);
- return $this;
- }
- /**
- * Returns the Last-Modified HTTP header as a DateTime instance.
- *
- * @return \DateTime|null A DateTime instance or null if the header does not exist
- *
- * @throws \RuntimeException When the HTTP header is not parseable
- *
- * @api
- */
- public function getLastModified()
- {
- return $this->headers->getDate('Last-Modified');
- }
- /**
- * Sets the Last-Modified HTTP header with a DateTime instance.
- *
- * Passing null as value will remove the header.
- *
- * @param \DateTime|null $date A \DateTime instance or null to remove the header
- *
- * @return Response
- *
- * @api
- */
- public function setLastModified(\DateTime $date = null)
- {
- if (null === $date) {
- $this->headers->remove('Last-Modified');
- } else {
- $date = clone $date;
- $date->setTimezone(new \DateTimeZone('UTC'));
- $this->headers->set('Last-Modified', $date->format('D, d M Y H:i:s').' GMT');
- }
- return $this;
- }
- /**
- * Returns the literal value of the ETag HTTP header.
- *
- * @return string|null The ETag HTTP header or null if it does not exist
- *
- * @api
- */
- public function getEtag()
- {
- return $this->headers->get('ETag');
- }
- /**
- * Sets the ETag value.
- *
- * @param string|null $etag The ETag unique identifier or null to remove the header
- * @param Boolean $weak Whether you want a weak ETag or not
- *
- * @return Response
- *
- * @api
- */
- public function setEtag($etag = null, $weak = false)
- {
- if (null === $etag) {
- $this->headers->remove('Etag');
- } else {
- if (0 !== strpos($etag, '"')) {
- $etag = '"'.$etag.'"';
- }
- $this->headers->set('ETag', (true === $weak ? 'W/' : '').$etag);
- }
- return $this;
- }
- /**
- * Sets the response's cache headers (validation and/or expiration).
- *
- * Available options are: etag, last_modified, max_age, s_maxage, private, and public.
- *
- * @param array $options An array of cache options
- *
- * @return Response
- *
- * @throws \InvalidArgumentException
- *
- * @api
- */
- public function setCache(array $options)
- {
- if ($diff = array_diff(array_keys($options), array('etag', 'last_modified', 'max_age', 's_maxage', 'private', 'public'))) {
- throw new \InvalidArgumentException(sprintf('Response does not support the following options: "%s".', implode('", "', array_values($diff))));
- }
- if (isset($options['etag'])) {
- $this->setEtag($options['etag']);
- }
- if (isset($options['last_modified'])) {
- $this->setLastModified($options['last_modified']);
- }
- if (isset($options['max_age'])) {
- $this->setMaxAge($options['max_age']);
- }
- if (isset($options['s_maxage'])) {
- $this->setSharedMaxAge($options['s_maxage']);
- }
- if (isset($options['public'])) {
- if ($options['public']) {
- $this->setPublic();
- } else {
- $this->setPrivate();
- }
- }
- if (isset($options['private'])) {
- if ($options['private']) {
- $this->setPrivate();
- } else {
- $this->setPublic();
- }
- }
- return $this;
- }
- /**
- * Modifies the response so that it conforms to the rules defined for a 304 status code.
- *
- * This sets the status, removes the body, and discards any headers
- * that MUST NOT be included in 304 responses.
- *
- * @return Response
- *
- * @see http://tools.ietf.org/html/rfc2616#section-10.3.5
- *
- * @api
- */
- public function setNotModified()
- {
- $this->setStatusCode(304);
- $this->setContent(null);
- // remove headers that MUST NOT be included with 304 Not Modified responses
- foreach (array('Allow', 'Content-Encoding', 'Content-Language', 'Content-Length', 'Content-MD5', 'Content-Type', 'Last-Modified') as $header) {
- $this->headers->remove($header);
- }
- return $this;
- }
- /**
- * Returns true if the response includes a Vary header.
- *
- * @return Boolean true if the response includes a Vary header, false otherwise
- *
- * @api
- */
- public function hasVary()
- {
- return null !== $this->headers->get('Vary');
- }
- /**
- * Returns an array of header names given in the Vary header.
- *
- * @return array An array of Vary names
- *
- * @api
- */
- public function getVary()
- {
- if (!$vary = $this->headers->get('Vary')) {
- return array();
- }
- return is_array($vary) ? $vary : preg_split('/[\s,]+/', $vary);
- }
- /**
- * Sets the Vary header.
- *
- * @param string|array $headers
- * @param Boolean $replace Whether to replace the actual value of not (true by default)
- *
- * @return Response
- *
- * @api
- */
- public function setVary($headers, $replace = true)
- {
- $this->headers->set('Vary', $headers, $replace);
- return $this;
- }
- /**
- * Determines if the Response validators (ETag, Last-Modified) match
- * a conditional value specified in the Request.
- *
- * If the Response is not modified, it sets the status code to 304 and
- * removes the actual content by calling the setNotModified() method.
- *
- * @param Request $request A Request instance
- *
- * @return Boolean true if the Response validators match the Request, false otherwise
- *
- * @api
- */
- public function isNotModified(Request $request)
- {
- if (!$request->isMethodSafe()) {
- return false;
- }
- $lastModified = $request->headers->get('If-Modified-Since');
- $notModified = false;
- if ($etags = $request->getEtags()) {
- $notModified = (in_array($this->getEtag(), $etags) || in_array('*', $etags)) && (!$lastModified || $this->headers->get('Last-Modified') == $lastModified);
- } elseif ($lastModified) {
- $notModified = $lastModified == $this->headers->get('Last-Modified');
- }
- if ($notModified) {
- $this->setNotModified();
- }
- return $notModified;
- }
- // http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
- /**
- * Is response invalid?
- *
- * @return Boolean
- *
- * @api
- */
- public function isInvalid()
- {
- return $this->statusCode < 100 || $this->statusCode >= 600;
- }
- /**
- * Is response informative?
- *
- * @return Boolean
- *
- * @api
- */
- public function isInformational()
- {
- return $this->statusCode >= 100 && $this->statusCode < 200;
- }
- /**
- * Is response successful?
- *
- * @return Boolean
- *
- * @api
- */
- public function isSuccessful()
- {
- return $this->statusCode >= 200 && $this->statusCode < 300;
- }
- /**
- * Is the response a redirect?
- *
- * @return Boolean
- *
- * @api
- */
- public function isRedirection()
- {
- return $this->statusCode >= 300 && $this->statusCode < 400;
- }
- /**
- * Is there a client error?
- *
- * @return Boolean
- *
- * @api
- */
- public function isClientError()
- {
- return $this->statusCode >= 400 && $this->statusCode < 500;
- }
- /**
- * Was there a server side error?
- *
- * @return Boolean
- *
- * @api
- */
- public function isServerError()
- {
- return $this->statusCode >= 500 && $this->statusCode < 600;
- }
- /**
- * Is the response OK?
- *
- * @return Boolean
- *
- * @api
- */
- public function isOk()
- {
- return 200 === $this->statusCode;
- }
- /**
- * Is the response forbidden?
- *
- * @return Boolean
- *
- * @api
- */
- public function isForbidden()
- {
- return 403 === $this->statusCode;
- }
- /**
- * Is the response a not found error?
- *
- * @return Boolean
- *
- * @api
- */
- public function isNotFound()
- {
- return 404 === $this->statusCode;
- }
- /**
- * Is the response a redirect of some form?
- *
- * @param string $location
- *
- * @return Boolean
- *
- * @api
- */
- public function isRedirect($location = null)
- {
- return in_array($this->statusCode, array(201, 301, 302, 303, 307, 308)) && (null === $location ?: $location == $this->headers->get('Location'));
- }
- /**
- * Is the response empty?
- *
- * @return Boolean
- *
- * @api
- */
- public function isEmpty()
- {
- return in_array($this->statusCode, array(201, 204, 304));
- }
- /**
- * Check if we need to remove Cache-Control for ssl encrypted downloads when using IE < 9
- *
- * @link http://support.microsoft.com/kb/323308
- */
- protected function ensureIEOverSSLCompatibility(Request $request)
- {
- if (false !== stripos($this->headers->get('Content-Disposition'), 'attachment') && preg_match('/MSIE (.*?);/i', $request->server->get('HTTP_USER_AGENT'), $match) == 1 && true === $request->isSecure()) {
- if (intval(preg_replace("/(MSIE )(.*?);/", "$2", $match[0])) < 9) {
- $this->headers->remove('Cache-Control');
- }
- }
- }
- }
|