Response.php 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpFoundation;
  11. /**
  12. * Response represents an HTTP response.
  13. *
  14. * @author Fabien Potencier <fabien@symfony.com>
  15. */
  16. class Response
  17. {
  18. const HTTP_CONTINUE = 100;
  19. const HTTP_SWITCHING_PROTOCOLS = 101;
  20. const HTTP_PROCESSING = 102; // RFC2518
  21. const HTTP_OK = 200;
  22. const HTTP_CREATED = 201;
  23. const HTTP_ACCEPTED = 202;
  24. const HTTP_NON_AUTHORITATIVE_INFORMATION = 203;
  25. const HTTP_NO_CONTENT = 204;
  26. const HTTP_RESET_CONTENT = 205;
  27. const HTTP_PARTIAL_CONTENT = 206;
  28. const HTTP_MULTI_STATUS = 207; // RFC4918
  29. const HTTP_ALREADY_REPORTED = 208; // RFC5842
  30. const HTTP_IM_USED = 226; // RFC3229
  31. const HTTP_MULTIPLE_CHOICES = 300;
  32. const HTTP_MOVED_PERMANENTLY = 301;
  33. const HTTP_FOUND = 302;
  34. const HTTP_SEE_OTHER = 303;
  35. const HTTP_NOT_MODIFIED = 304;
  36. const HTTP_USE_PROXY = 305;
  37. const HTTP_RESERVED = 306;
  38. const HTTP_TEMPORARY_REDIRECT = 307;
  39. const HTTP_PERMANENTLY_REDIRECT = 308; // RFC7238
  40. const HTTP_BAD_REQUEST = 400;
  41. const HTTP_UNAUTHORIZED = 401;
  42. const HTTP_PAYMENT_REQUIRED = 402;
  43. const HTTP_FORBIDDEN = 403;
  44. const HTTP_NOT_FOUND = 404;
  45. const HTTP_METHOD_NOT_ALLOWED = 405;
  46. const HTTP_NOT_ACCEPTABLE = 406;
  47. const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407;
  48. const HTTP_REQUEST_TIMEOUT = 408;
  49. const HTTP_CONFLICT = 409;
  50. const HTTP_GONE = 410;
  51. const HTTP_LENGTH_REQUIRED = 411;
  52. const HTTP_PRECONDITION_FAILED = 412;
  53. const HTTP_REQUEST_ENTITY_TOO_LARGE = 413;
  54. const HTTP_REQUEST_URI_TOO_LONG = 414;
  55. const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
  56. const HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
  57. const HTTP_EXPECTATION_FAILED = 417;
  58. const HTTP_I_AM_A_TEAPOT = 418; // RFC2324
  59. const HTTP_UNPROCESSABLE_ENTITY = 422; // RFC4918
  60. const HTTP_LOCKED = 423; // RFC4918
  61. const HTTP_FAILED_DEPENDENCY = 424; // RFC4918
  62. const HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL = 425; // RFC2817
  63. const HTTP_UPGRADE_REQUIRED = 426; // RFC2817
  64. const HTTP_PRECONDITION_REQUIRED = 428; // RFC6585
  65. const HTTP_TOO_MANY_REQUESTS = 429; // RFC6585
  66. const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431; // RFC6585
  67. const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451;
  68. const HTTP_INTERNAL_SERVER_ERROR = 500;
  69. const HTTP_NOT_IMPLEMENTED = 501;
  70. const HTTP_BAD_GATEWAY = 502;
  71. const HTTP_SERVICE_UNAVAILABLE = 503;
  72. const HTTP_GATEWAY_TIMEOUT = 504;
  73. const HTTP_VERSION_NOT_SUPPORTED = 505;
  74. const HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506; // RFC2295
  75. const HTTP_INSUFFICIENT_STORAGE = 507; // RFC4918
  76. const HTTP_LOOP_DETECTED = 508; // RFC5842
  77. const HTTP_NOT_EXTENDED = 510; // RFC2774
  78. const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511; // RFC6585
  79. /**
  80. * @var \Symfony\Component\HttpFoundation\ResponseHeaderBag
  81. */
  82. public $headers;
  83. /**
  84. * @var string
  85. */
  86. protected $content;
  87. /**
  88. * @var string
  89. */
  90. protected $version;
  91. /**
  92. * @var int
  93. */
  94. protected $statusCode;
  95. /**
  96. * @var string
  97. */
  98. protected $statusText;
  99. /**
  100. * @var string
  101. */
  102. protected $charset;
  103. /**
  104. * Status codes translation table.
  105. *
  106. * The list of codes is complete according to the
  107. * {@link http://www.iana.org/assignments/http-status-codes/ Hypertext Transfer Protocol (HTTP) Status Code Registry}
  108. * (last updated 2015-05-19).
  109. *
  110. * Unless otherwise noted, the status code is defined in RFC2616.
  111. *
  112. * @var array
  113. */
  114. public static $statusTexts = array(
  115. 100 => 'Continue',
  116. 101 => 'Switching Protocols',
  117. 102 => 'Processing', // RFC2518
  118. 200 => 'OK',
  119. 201 => 'Created',
  120. 202 => 'Accepted',
  121. 203 => 'Non-Authoritative Information',
  122. 204 => 'No Content',
  123. 205 => 'Reset Content',
  124. 206 => 'Partial Content',
  125. 207 => 'Multi-Status', // RFC4918
  126. 208 => 'Already Reported', // RFC5842
  127. 226 => 'IM Used', // RFC3229
  128. 300 => 'Multiple Choices',
  129. 301 => 'Moved Permanently',
  130. 302 => 'Found',
  131. 303 => 'See Other',
  132. 304 => 'Not Modified',
  133. 305 => 'Use Proxy',
  134. 307 => 'Temporary Redirect',
  135. 308 => 'Permanent Redirect', // RFC7238
  136. 400 => 'Bad Request',
  137. 401 => 'Unauthorized',
  138. 402 => 'Payment Required',
  139. 403 => 'Forbidden',
  140. 404 => 'Not Found',
  141. 405 => 'Method Not Allowed',
  142. 406 => 'Not Acceptable',
  143. 407 => 'Proxy Authentication Required',
  144. 408 => 'Request Timeout',
  145. 409 => 'Conflict',
  146. 410 => 'Gone',
  147. 411 => 'Length Required',
  148. 412 => 'Precondition Failed',
  149. 413 => 'Payload Too Large',
  150. 414 => 'URI Too Long',
  151. 415 => 'Unsupported Media Type',
  152. 416 => 'Range Not Satisfiable',
  153. 417 => 'Expectation Failed',
  154. 418 => 'I\'m a teapot', // RFC2324
  155. 422 => 'Unprocessable Entity', // RFC4918
  156. 423 => 'Locked', // RFC4918
  157. 424 => 'Failed Dependency', // RFC4918
  158. 425 => 'Reserved for WebDAV advanced collections expired proposal', // RFC2817
  159. 426 => 'Upgrade Required', // RFC2817
  160. 428 => 'Precondition Required', // RFC6585
  161. 429 => 'Too Many Requests', // RFC6585
  162. 431 => 'Request Header Fields Too Large', // RFC6585
  163. 451 => 'Unavailable For Legal Reasons',
  164. 500 => 'Internal Server Error',
  165. 501 => 'Not Implemented',
  166. 502 => 'Bad Gateway',
  167. 503 => 'Service Unavailable',
  168. 504 => 'Gateway Timeout',
  169. 505 => 'HTTP Version Not Supported',
  170. 506 => 'Variant Also Negotiates (Experimental)', // RFC2295
  171. 507 => 'Insufficient Storage', // RFC4918
  172. 508 => 'Loop Detected', // RFC5842
  173. 510 => 'Not Extended', // RFC2774
  174. 511 => 'Network Authentication Required', // RFC6585
  175. );
  176. /**
  177. * Constructor.
  178. *
  179. * @param mixed $content The response content, see setContent()
  180. * @param int $status The response status code
  181. * @param array $headers An array of response headers
  182. *
  183. * @throws \InvalidArgumentException When the HTTP status code is not valid
  184. */
  185. public function __construct($content = '', $status = 200, $headers = array())
  186. {
  187. $this->headers = new ResponseHeaderBag($headers);
  188. $this->setContent($content);
  189. $this->setStatusCode($status);
  190. $this->setProtocolVersion('1.0');
  191. }
  192. /**
  193. * Factory method for chainability.
  194. *
  195. * Example:
  196. *
  197. * return Response::create($body, 200)
  198. * ->setSharedMaxAge(300);
  199. *
  200. * @param mixed $content The response content, see setContent()
  201. * @param int $status The response status code
  202. * @param array $headers An array of response headers
  203. *
  204. * @return Response
  205. */
  206. public static function create($content = '', $status = 200, $headers = array())
  207. {
  208. return new static($content, $status, $headers);
  209. }
  210. /**
  211. * Returns the Response as an HTTP string.
  212. *
  213. * The string representation of the Response is the same as the
  214. * one that will be sent to the client only if the prepare() method
  215. * has been called before.
  216. *
  217. * @return string The Response as an HTTP string
  218. *
  219. * @see prepare()
  220. */
  221. public function __toString()
  222. {
  223. return
  224. sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText)."\r\n".
  225. $this->headers."\r\n".
  226. $this->getContent();
  227. }
  228. /**
  229. * Clones the current Response instance.
  230. */
  231. public function __clone()
  232. {
  233. $this->headers = clone $this->headers;
  234. }
  235. /**
  236. * Prepares the Response before it is sent to the client.
  237. *
  238. * This method tweaks the Response to ensure that it is
  239. * compliant with RFC 2616. Most of the changes are based on
  240. * the Request that is "associated" with this Response.
  241. *
  242. * @param Request $request A Request instance
  243. *
  244. * @return Response The current response.
  245. */
  246. public function prepare(Request $request)
  247. {
  248. $headers = $this->headers;
  249. if ($this->isInformational() || $this->isEmpty()) {
  250. $this->setContent(null);
  251. $headers->remove('Content-Type');
  252. $headers->remove('Content-Length');
  253. } else {
  254. // Content-type based on the Request
  255. if (!$headers->has('Content-Type')) {
  256. $format = $request->getRequestFormat();
  257. if (null !== $format && $mimeType = $request->getMimeType($format)) {
  258. $headers->set('Content-Type', $mimeType);
  259. }
  260. }
  261. // Fix Content-Type
  262. $charset = $this->charset ?: 'UTF-8';
  263. if (!$headers->has('Content-Type')) {
  264. $headers->set('Content-Type', 'text/html; charset='.$charset);
  265. } elseif (0 === stripos($headers->get('Content-Type'), 'text/') && false === stripos($headers->get('Content-Type'), 'charset')) {
  266. // add the charset
  267. $headers->set('Content-Type', $headers->get('Content-Type').'; charset='.$charset);
  268. }
  269. // Fix Content-Length
  270. if ($headers->has('Transfer-Encoding')) {
  271. $headers->remove('Content-Length');
  272. }
  273. if ($request->isMethod('HEAD')) {
  274. // cf. RFC2616 14.13
  275. $length = $headers->get('Content-Length');
  276. $this->setContent(null);
  277. if ($length) {
  278. $headers->set('Content-Length', $length);
  279. }
  280. }
  281. }
  282. // Fix protocol
  283. if ('HTTP/1.0' != $request->server->get('SERVER_PROTOCOL')) {
  284. $this->setProtocolVersion('1.1');
  285. }
  286. // Check if we need to send extra expire info headers
  287. if ('1.0' == $this->getProtocolVersion() && 'no-cache' == $this->headers->get('Cache-Control')) {
  288. $this->headers->set('pragma', 'no-cache');
  289. $this->headers->set('expires', -1);
  290. }
  291. $this->ensureIEOverSSLCompatibility($request);
  292. return $this;
  293. }
  294. /**
  295. * Sends HTTP headers.
  296. *
  297. * @return Response
  298. */
  299. public function sendHeaders()
  300. {
  301. // headers have already been sent by the developer
  302. if (headers_sent()) {
  303. return $this;
  304. }
  305. if (!$this->headers->has('Date')) {
  306. $this->setDate(\DateTime::createFromFormat('U', time()));
  307. }
  308. // headers
  309. foreach ($this->headers->allPreserveCase() as $name => $values) {
  310. foreach ($values as $value) {
  311. header($name.': '.$value, false, $this->statusCode);
  312. }
  313. }
  314. // status
  315. header(sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText), true, $this->statusCode);
  316. // cookies
  317. foreach ($this->headers->getCookies() as $cookie) {
  318. setcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $cookie->getPath(), $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
  319. }
  320. return $this;
  321. }
  322. /**
  323. * Sends content for the current web response.
  324. *
  325. * @return Response
  326. */
  327. public function sendContent()
  328. {
  329. echo $this->content;
  330. return $this;
  331. }
  332. /**
  333. * Sends HTTP headers and content.
  334. *
  335. * @return Response
  336. */
  337. public function send()
  338. {
  339. $this->sendHeaders();
  340. $this->sendContent();
  341. if (function_exists('fastcgi_finish_request')) {
  342. fastcgi_finish_request();
  343. } elseif ('cli' !== PHP_SAPI) {
  344. static::closeOutputBuffers(0, true);
  345. }
  346. return $this;
  347. }
  348. /**
  349. * Sets the response content.
  350. *
  351. * Valid types are strings, numbers, null, and objects that implement a __toString() method.
  352. *
  353. * @param mixed $content Content that can be cast to string
  354. *
  355. * @return Response
  356. *
  357. * @throws \UnexpectedValueException
  358. */
  359. public function setContent($content)
  360. {
  361. if (null !== $content && !is_string($content) && !is_numeric($content) && !is_callable(array($content, '__toString'))) {
  362. throw new \UnexpectedValueException(sprintf('The Response content must be a string or object implementing __toString(), "%s" given.', gettype($content)));
  363. }
  364. $this->content = (string) $content;
  365. return $this;
  366. }
  367. /**
  368. * Gets the current response content.
  369. *
  370. * @return string Content
  371. */
  372. public function getContent()
  373. {
  374. return $this->content;
  375. }
  376. /**
  377. * Sets the HTTP protocol version (1.0 or 1.1).
  378. *
  379. * @param string $version The HTTP protocol version
  380. *
  381. * @return Response
  382. */
  383. public function setProtocolVersion($version)
  384. {
  385. $this->version = $version;
  386. return $this;
  387. }
  388. /**
  389. * Gets the HTTP protocol version.
  390. *
  391. * @return string The HTTP protocol version
  392. */
  393. public function getProtocolVersion()
  394. {
  395. return $this->version;
  396. }
  397. /**
  398. * Sets the response status code.
  399. *
  400. * @param int $code HTTP status code
  401. * @param mixed $text HTTP status text
  402. *
  403. * If the status text is null it will be automatically populated for the known
  404. * status codes and left empty otherwise.
  405. *
  406. * @return Response
  407. *
  408. * @throws \InvalidArgumentException When the HTTP status code is not valid
  409. */
  410. public function setStatusCode($code, $text = null)
  411. {
  412. $this->statusCode = $code = (int) $code;
  413. if ($this->isInvalid()) {
  414. throw new \InvalidArgumentException(sprintf('The HTTP status code "%s" is not valid.', $code));
  415. }
  416. if (null === $text) {
  417. $this->statusText = isset(self::$statusTexts[$code]) ? self::$statusTexts[$code] : 'unknown status';
  418. return $this;
  419. }
  420. if (false === $text) {
  421. $this->statusText = '';
  422. return $this;
  423. }
  424. $this->statusText = $text;
  425. return $this;
  426. }
  427. /**
  428. * Retrieves the status code for the current web response.
  429. *
  430. * @return int Status code
  431. */
  432. public function getStatusCode()
  433. {
  434. return $this->statusCode;
  435. }
  436. /**
  437. * Sets the response charset.
  438. *
  439. * @param string $charset Character set
  440. *
  441. * @return Response
  442. */
  443. public function setCharset($charset)
  444. {
  445. $this->charset = $charset;
  446. return $this;
  447. }
  448. /**
  449. * Retrieves the response charset.
  450. *
  451. * @return string Character set
  452. */
  453. public function getCharset()
  454. {
  455. return $this->charset;
  456. }
  457. /**
  458. * Returns true if the response is worth caching under any circumstance.
  459. *
  460. * Responses marked "private" with an explicit Cache-Control directive are
  461. * considered uncacheable.
  462. *
  463. * Responses with neither a freshness lifetime (Expires, max-age) nor cache
  464. * validator (Last-Modified, ETag) are considered uncacheable.
  465. *
  466. * @return bool true if the response is worth caching, false otherwise
  467. */
  468. public function isCacheable()
  469. {
  470. if (!in_array($this->statusCode, array(200, 203, 300, 301, 302, 404, 410))) {
  471. return false;
  472. }
  473. if ($this->headers->hasCacheControlDirective('no-store') || $this->headers->getCacheControlDirective('private')) {
  474. return false;
  475. }
  476. return $this->isValidateable() || $this->isFresh();
  477. }
  478. /**
  479. * Returns true if the response is "fresh".
  480. *
  481. * Fresh responses may be served from cache without any interaction with the
  482. * origin. A response is considered fresh when it includes a Cache-Control/max-age
  483. * indicator or Expires header and the calculated age is less than the freshness lifetime.
  484. *
  485. * @return bool true if the response is fresh, false otherwise
  486. */
  487. public function isFresh()
  488. {
  489. return $this->getTtl() > 0;
  490. }
  491. /**
  492. * Returns true if the response includes headers that can be used to validate
  493. * the response with the origin server using a conditional GET request.
  494. *
  495. * @return bool true if the response is validateable, false otherwise
  496. */
  497. public function isValidateable()
  498. {
  499. return $this->headers->has('Last-Modified') || $this->headers->has('ETag');
  500. }
  501. /**
  502. * Marks the response as "private".
  503. *
  504. * It makes the response ineligible for serving other clients.
  505. *
  506. * @return Response
  507. */
  508. public function setPrivate()
  509. {
  510. $this->headers->removeCacheControlDirective('public');
  511. $this->headers->addCacheControlDirective('private');
  512. return $this;
  513. }
  514. /**
  515. * Marks the response as "public".
  516. *
  517. * It makes the response eligible for serving other clients.
  518. *
  519. * @return Response
  520. */
  521. public function setPublic()
  522. {
  523. $this->headers->addCacheControlDirective('public');
  524. $this->headers->removeCacheControlDirective('private');
  525. return $this;
  526. }
  527. /**
  528. * Returns true if the response must be revalidated by caches.
  529. *
  530. * This method indicates that the response must not be served stale by a
  531. * cache in any circumstance without first revalidating with the origin.
  532. * When present, the TTL of the response should not be overridden to be
  533. * greater than the value provided by the origin.
  534. *
  535. * @return bool true if the response must be revalidated by a cache, false otherwise
  536. */
  537. public function mustRevalidate()
  538. {
  539. return $this->headers->hasCacheControlDirective('must-revalidate') || $this->headers->hasCacheControlDirective('proxy-revalidate');
  540. }
  541. /**
  542. * Returns the Date header as a DateTime instance.
  543. *
  544. * @return \DateTime A \DateTime instance
  545. *
  546. * @throws \RuntimeException When the header is not parseable
  547. */
  548. public function getDate()
  549. {
  550. if (!$this->headers->has('Date')) {
  551. $this->setDate(\DateTime::createFromFormat('U', time()));
  552. }
  553. return $this->headers->getDate('Date');
  554. }
  555. /**
  556. * Sets the Date header.
  557. *
  558. * @param \DateTime $date A \DateTime instance
  559. *
  560. * @return Response
  561. */
  562. public function setDate(\DateTime $date)
  563. {
  564. $date->setTimezone(new \DateTimeZone('UTC'));
  565. $this->headers->set('Date', $date->format('D, d M Y H:i:s').' GMT');
  566. return $this;
  567. }
  568. /**
  569. * Returns the age of the response.
  570. *
  571. * @return int The age of the response in seconds
  572. */
  573. public function getAge()
  574. {
  575. if (null !== $age = $this->headers->get('Age')) {
  576. return (int) $age;
  577. }
  578. return max(time() - $this->getDate()->format('U'), 0);
  579. }
  580. /**
  581. * Marks the response stale by setting the Age header to be equal to the maximum age of the response.
  582. *
  583. * @return Response
  584. */
  585. public function expire()
  586. {
  587. if ($this->isFresh()) {
  588. $this->headers->set('Age', $this->getMaxAge());
  589. }
  590. return $this;
  591. }
  592. /**
  593. * Returns the value of the Expires header as a DateTime instance.
  594. *
  595. * @return \DateTime|null A DateTime instance or null if the header does not exist
  596. */
  597. public function getExpires()
  598. {
  599. try {
  600. return $this->headers->getDate('Expires');
  601. } catch (\RuntimeException $e) {
  602. // according to RFC 2616 invalid date formats (e.g. "0" and "-1") must be treated as in the past
  603. return \DateTime::createFromFormat(DATE_RFC2822, 'Sat, 01 Jan 00 00:00:00 +0000');
  604. }
  605. }
  606. /**
  607. * Sets the Expires HTTP header with a DateTime instance.
  608. *
  609. * Passing null as value will remove the header.
  610. *
  611. * @param \DateTime|null $date A \DateTime instance or null to remove the header
  612. *
  613. * @return Response
  614. */
  615. public function setExpires(\DateTime $date = null)
  616. {
  617. if (null === $date) {
  618. $this->headers->remove('Expires');
  619. } else {
  620. $date = clone $date;
  621. $date->setTimezone(new \DateTimeZone('UTC'));
  622. $this->headers->set('Expires', $date->format('D, d M Y H:i:s').' GMT');
  623. }
  624. return $this;
  625. }
  626. /**
  627. * Returns the number of seconds after the time specified in the response's Date
  628. * header when the response should no longer be considered fresh.
  629. *
  630. * First, it checks for a s-maxage directive, then a max-age directive, and then it falls
  631. * back on an expires header. It returns null when no maximum age can be established.
  632. *
  633. * @return int|null Number of seconds
  634. */
  635. public function getMaxAge()
  636. {
  637. if ($this->headers->hasCacheControlDirective('s-maxage')) {
  638. return (int) $this->headers->getCacheControlDirective('s-maxage');
  639. }
  640. if ($this->headers->hasCacheControlDirective('max-age')) {
  641. return (int) $this->headers->getCacheControlDirective('max-age');
  642. }
  643. if (null !== $this->getExpires()) {
  644. return $this->getExpires()->format('U') - $this->getDate()->format('U');
  645. }
  646. }
  647. /**
  648. * Sets the number of seconds after which the response should no longer be considered fresh.
  649. *
  650. * This methods sets the Cache-Control max-age directive.
  651. *
  652. * @param int $value Number of seconds
  653. *
  654. * @return Response
  655. */
  656. public function setMaxAge($value)
  657. {
  658. $this->headers->addCacheControlDirective('max-age', $value);
  659. return $this;
  660. }
  661. /**
  662. * Sets the number of seconds after which the response should no longer be considered fresh by shared caches.
  663. *
  664. * This methods sets the Cache-Control s-maxage directive.
  665. *
  666. * @param int $value Number of seconds
  667. *
  668. * @return Response
  669. */
  670. public function setSharedMaxAge($value)
  671. {
  672. $this->setPublic();
  673. $this->headers->addCacheControlDirective('s-maxage', $value);
  674. return $this;
  675. }
  676. /**
  677. * Returns the response's time-to-live in seconds.
  678. *
  679. * It returns null when no freshness information is present in the response.
  680. *
  681. * When the responses TTL is <= 0, the response may not be served from cache without first
  682. * revalidating with the origin.
  683. *
  684. * @return int|null The TTL in seconds
  685. */
  686. public function getTtl()
  687. {
  688. if (null !== $maxAge = $this->getMaxAge()) {
  689. return $maxAge - $this->getAge();
  690. }
  691. }
  692. /**
  693. * Sets the response's time-to-live for shared caches.
  694. *
  695. * This method adjusts the Cache-Control/s-maxage directive.
  696. *
  697. * @param int $seconds Number of seconds
  698. *
  699. * @return Response
  700. */
  701. public function setTtl($seconds)
  702. {
  703. $this->setSharedMaxAge($this->getAge() + $seconds);
  704. return $this;
  705. }
  706. /**
  707. * Sets the response's time-to-live for private/client caches.
  708. *
  709. * This method adjusts the Cache-Control/max-age directive.
  710. *
  711. * @param int $seconds Number of seconds
  712. *
  713. * @return Response
  714. */
  715. public function setClientTtl($seconds)
  716. {
  717. $this->setMaxAge($this->getAge() + $seconds);
  718. return $this;
  719. }
  720. /**
  721. * Returns the Last-Modified HTTP header as a DateTime instance.
  722. *
  723. * @return \DateTime|null A DateTime instance or null if the header does not exist
  724. *
  725. * @throws \RuntimeException When the HTTP header is not parseable
  726. */
  727. public function getLastModified()
  728. {
  729. return $this->headers->getDate('Last-Modified');
  730. }
  731. /**
  732. * Sets the Last-Modified HTTP header with a DateTime instance.
  733. *
  734. * Passing null as value will remove the header.
  735. *
  736. * @param \DateTime|null $date A \DateTime instance or null to remove the header
  737. *
  738. * @return Response
  739. */
  740. public function setLastModified(\DateTime $date = null)
  741. {
  742. if (null === $date) {
  743. $this->headers->remove('Last-Modified');
  744. } else {
  745. $date = clone $date;
  746. $date->setTimezone(new \DateTimeZone('UTC'));
  747. $this->headers->set('Last-Modified', $date->format('D, d M Y H:i:s').' GMT');
  748. }
  749. return $this;
  750. }
  751. /**
  752. * Returns the literal value of the ETag HTTP header.
  753. *
  754. * @return string|null The ETag HTTP header or null if it does not exist
  755. */
  756. public function getEtag()
  757. {
  758. return $this->headers->get('ETag');
  759. }
  760. /**
  761. * Sets the ETag value.
  762. *
  763. * @param string|null $etag The ETag unique identifier or null to remove the header
  764. * @param bool $weak Whether you want a weak ETag or not
  765. *
  766. * @return Response
  767. */
  768. public function setEtag($etag = null, $weak = false)
  769. {
  770. if (null === $etag) {
  771. $this->headers->remove('Etag');
  772. } else {
  773. if (0 !== strpos($etag, '"')) {
  774. $etag = '"'.$etag.'"';
  775. }
  776. $this->headers->set('ETag', (true === $weak ? 'W/' : '').$etag);
  777. }
  778. return $this;
  779. }
  780. /**
  781. * Sets the response's cache headers (validation and/or expiration).
  782. *
  783. * Available options are: etag, last_modified, max_age, s_maxage, private, and public.
  784. *
  785. * @param array $options An array of cache options
  786. *
  787. * @return Response
  788. *
  789. * @throws \InvalidArgumentException
  790. */
  791. public function setCache(array $options)
  792. {
  793. if ($diff = array_diff(array_keys($options), array('etag', 'last_modified', 'max_age', 's_maxage', 'private', 'public'))) {
  794. throw new \InvalidArgumentException(sprintf('Response does not support the following options: "%s".', implode('", "', array_values($diff))));
  795. }
  796. if (isset($options['etag'])) {
  797. $this->setEtag($options['etag']);
  798. }
  799. if (isset($options['last_modified'])) {
  800. $this->setLastModified($options['last_modified']);
  801. }
  802. if (isset($options['max_age'])) {
  803. $this->setMaxAge($options['max_age']);
  804. }
  805. if (isset($options['s_maxage'])) {
  806. $this->setSharedMaxAge($options['s_maxage']);
  807. }
  808. if (isset($options['public'])) {
  809. if ($options['public']) {
  810. $this->setPublic();
  811. } else {
  812. $this->setPrivate();
  813. }
  814. }
  815. if (isset($options['private'])) {
  816. if ($options['private']) {
  817. $this->setPrivate();
  818. } else {
  819. $this->setPublic();
  820. }
  821. }
  822. return $this;
  823. }
  824. /**
  825. * Modifies the response so that it conforms to the rules defined for a 304 status code.
  826. *
  827. * This sets the status, removes the body, and discards any headers
  828. * that MUST NOT be included in 304 responses.
  829. *
  830. * @return Response
  831. *
  832. * @see http://tools.ietf.org/html/rfc2616#section-10.3.5
  833. */
  834. public function setNotModified()
  835. {
  836. $this->setStatusCode(304);
  837. $this->setContent(null);
  838. // remove headers that MUST NOT be included with 304 Not Modified responses
  839. foreach (array('Allow', 'Content-Encoding', 'Content-Language', 'Content-Length', 'Content-MD5', 'Content-Type', 'Last-Modified') as $header) {
  840. $this->headers->remove($header);
  841. }
  842. return $this;
  843. }
  844. /**
  845. * Returns true if the response includes a Vary header.
  846. *
  847. * @return bool true if the response includes a Vary header, false otherwise
  848. */
  849. public function hasVary()
  850. {
  851. return null !== $this->headers->get('Vary');
  852. }
  853. /**
  854. * Returns an array of header names given in the Vary header.
  855. *
  856. * @return array An array of Vary names
  857. */
  858. public function getVary()
  859. {
  860. if (!$vary = $this->headers->get('Vary', null, false)) {
  861. return array();
  862. }
  863. $ret = array();
  864. foreach ($vary as $item) {
  865. $ret = array_merge($ret, preg_split('/[\s,]+/', $item));
  866. }
  867. return $ret;
  868. }
  869. /**
  870. * Sets the Vary header.
  871. *
  872. * @param string|array $headers
  873. * @param bool $replace Whether to replace the actual value or not (true by default)
  874. *
  875. * @return Response
  876. */
  877. public function setVary($headers, $replace = true)
  878. {
  879. $this->headers->set('Vary', $headers, $replace);
  880. return $this;
  881. }
  882. /**
  883. * Determines if the Response validators (ETag, Last-Modified) match
  884. * a conditional value specified in the Request.
  885. *
  886. * If the Response is not modified, it sets the status code to 304 and
  887. * removes the actual content by calling the setNotModified() method.
  888. *
  889. * @param Request $request A Request instance
  890. *
  891. * @return bool true if the Response validators match the Request, false otherwise
  892. */
  893. public function isNotModified(Request $request)
  894. {
  895. if (!$request->isMethodSafe()) {
  896. return false;
  897. }
  898. $notModified = false;
  899. $lastModified = $this->headers->get('Last-Modified');
  900. $modifiedSince = $request->headers->get('If-Modified-Since');
  901. if ($etags = $request->getETags()) {
  902. $notModified = in_array($this->getEtag(), $etags) || in_array('*', $etags);
  903. }
  904. if ($modifiedSince && $lastModified) {
  905. $notModified = strtotime($modifiedSince) >= strtotime($lastModified) && (!$etags || $notModified);
  906. }
  907. if ($notModified) {
  908. $this->setNotModified();
  909. }
  910. return $notModified;
  911. }
  912. /**
  913. * Is response invalid?
  914. *
  915. * @return bool
  916. *
  917. * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
  918. */
  919. public function isInvalid()
  920. {
  921. return $this->statusCode < 100 || $this->statusCode >= 600;
  922. }
  923. /**
  924. * Is response informative?
  925. *
  926. * @return bool
  927. */
  928. public function isInformational()
  929. {
  930. return $this->statusCode >= 100 && $this->statusCode < 200;
  931. }
  932. /**
  933. * Is response successful?
  934. *
  935. * @return bool
  936. */
  937. public function isSuccessful()
  938. {
  939. return $this->statusCode >= 200 && $this->statusCode < 300;
  940. }
  941. /**
  942. * Is the response a redirect?
  943. *
  944. * @return bool
  945. */
  946. public function isRedirection()
  947. {
  948. return $this->statusCode >= 300 && $this->statusCode < 400;
  949. }
  950. /**
  951. * Is there a client error?
  952. *
  953. * @return bool
  954. */
  955. public function isClientError()
  956. {
  957. return $this->statusCode >= 400 && $this->statusCode < 500;
  958. }
  959. /**
  960. * Was there a server side error?
  961. *
  962. * @return bool
  963. */
  964. public function isServerError()
  965. {
  966. return $this->statusCode >= 500 && $this->statusCode < 600;
  967. }
  968. /**
  969. * Is the response OK?
  970. *
  971. * @return bool
  972. */
  973. public function isOk()
  974. {
  975. return 200 === $this->statusCode;
  976. }
  977. /**
  978. * Is the response forbidden?
  979. *
  980. * @return bool
  981. */
  982. public function isForbidden()
  983. {
  984. return 403 === $this->statusCode;
  985. }
  986. /**
  987. * Is the response a not found error?
  988. *
  989. * @return bool
  990. */
  991. public function isNotFound()
  992. {
  993. return 404 === $this->statusCode;
  994. }
  995. /**
  996. * Is the response a redirect of some form?
  997. *
  998. * @param string $location
  999. *
  1000. * @return bool
  1001. */
  1002. public function isRedirect($location = null)
  1003. {
  1004. return in_array($this->statusCode, array(201, 301, 302, 303, 307, 308)) && (null === $location ?: $location == $this->headers->get('Location'));
  1005. }
  1006. /**
  1007. * Is the response empty?
  1008. *
  1009. * @return bool
  1010. */
  1011. public function isEmpty()
  1012. {
  1013. return in_array($this->statusCode, array(204, 304));
  1014. }
  1015. /**
  1016. * Cleans or flushes output buffers up to target level.
  1017. *
  1018. * Resulting level can be greater than target level if a non-removable buffer has been encountered.
  1019. *
  1020. * @param int $targetLevel The target output buffering level
  1021. * @param bool $flush Whether to flush or clean the buffers
  1022. */
  1023. public static function closeOutputBuffers($targetLevel, $flush)
  1024. {
  1025. $status = ob_get_status(true);
  1026. $level = count($status);
  1027. $flags = defined('PHP_OUTPUT_HANDLER_REMOVABLE') ? PHP_OUTPUT_HANDLER_REMOVABLE | ($flush ? PHP_OUTPUT_HANDLER_FLUSHABLE : PHP_OUTPUT_HANDLER_CLEANABLE) : -1;
  1028. while ($level-- > $targetLevel && ($s = $status[$level]) && (!isset($s['del']) ? !isset($s['flags']) || $flags === ($s['flags'] & $flags) : $s['del'])) {
  1029. if ($flush) {
  1030. ob_end_flush();
  1031. } else {
  1032. ob_end_clean();
  1033. }
  1034. }
  1035. }
  1036. /**
  1037. * Checks if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9.
  1038. *
  1039. * @link http://support.microsoft.com/kb/323308
  1040. */
  1041. protected function ensureIEOverSSLCompatibility(Request $request)
  1042. {
  1043. if (false !== stripos($this->headers->get('Content-Disposition'), 'attachment') && preg_match('/MSIE (.*?);/i', $request->server->get('HTTP_USER_AGENT'), $match) == 1 && true === $request->isSecure()) {
  1044. if ((int) preg_replace('/(MSIE )(.*?);/', '$2', $match[0]) < 9) {
  1045. $this->headers->remove('Cache-Control');
  1046. }
  1047. }
  1048. }
  1049. }