JsonResponse.php 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  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 in JSON format.
  13. *
  14. * Note that this class does not force the returned JSON content to be an
  15. * object. It is however recommended that you do return an object as it
  16. * protects yourself against XSSI and JSON-JavaScript Hijacking.
  17. *
  18. * @see https://www.owasp.org/index.php/OWASP_AJAX_Security_Guidelines#Always_return_JSON_with_an_Object_on_the_outside
  19. *
  20. * @author Igor Wiedler <igor@wiedler.ch>
  21. */
  22. class JsonResponse extends Response
  23. {
  24. protected $data;
  25. protected $callback;
  26. // Encode <, >, ', &, and " for RFC4627-compliant JSON, which may also be embedded into HTML.
  27. // 15 === JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT
  28. protected $encodingOptions = 15;
  29. /**
  30. * Constructor.
  31. *
  32. * @param mixed $data The response data
  33. * @param int $status The response status code
  34. * @param array $headers An array of response headers
  35. */
  36. public function __construct($data = null, $status = 200, $headers = array())
  37. {
  38. parent::__construct('', $status, $headers);
  39. if (null === $data) {
  40. $data = new \ArrayObject();
  41. }
  42. $this->setData($data);
  43. }
  44. /**
  45. * {@inheritdoc}
  46. */
  47. public static function create($data = null, $status = 200, $headers = array())
  48. {
  49. return new static($data, $status, $headers);
  50. }
  51. /**
  52. * Sets the JSONP callback.
  53. *
  54. * @param string|null $callback The JSONP callback or null to use none
  55. *
  56. * @return JsonResponse
  57. *
  58. * @throws \InvalidArgumentException When the callback name is not valid
  59. */
  60. public function setCallback($callback = null)
  61. {
  62. if (null !== $callback) {
  63. // taken from http://www.geekality.net/2011/08/03/valid-javascript-identifier/
  64. $pattern = '/^[$_\p{L}][$_\p{L}\p{Mn}\p{Mc}\p{Nd}\p{Pc}\x{200C}\x{200D}]*+$/u';
  65. $parts = explode('.', $callback);
  66. foreach ($parts as $part) {
  67. if (!preg_match($pattern, $part)) {
  68. throw new \InvalidArgumentException('The callback name is not valid.');
  69. }
  70. }
  71. }
  72. $this->callback = $callback;
  73. return $this->update();
  74. }
  75. /**
  76. * Sets the data to be sent as JSON.
  77. *
  78. * @param mixed $data
  79. *
  80. * @return JsonResponse
  81. *
  82. * @throws \InvalidArgumentException
  83. */
  84. public function setData($data = array())
  85. {
  86. if (defined('HHVM_VERSION')) {
  87. // HHVM does not trigger any warnings and let exceptions
  88. // thrown from a JsonSerializable object pass through.
  89. // If only PHP did the same...
  90. $data = json_encode($data, $this->encodingOptions);
  91. } else {
  92. try {
  93. // PHP 5.4 and up wrap exceptions thrown by JsonSerializable
  94. // objects in a new exception that needs to be removed.
  95. // Fortunately, PHP 5.5 and up do not trigger any warning anymore.
  96. $data = json_encode($data, $this->encodingOptions);
  97. } catch (\Exception $e) {
  98. if ('Exception' === get_class($e) && 0 === strpos($e->getMessage(), 'Failed calling ')) {
  99. throw $e->getPrevious() ?: $e;
  100. }
  101. throw $e;
  102. }
  103. }
  104. if (JSON_ERROR_NONE !== json_last_error()) {
  105. throw new \InvalidArgumentException(json_last_error_msg());
  106. }
  107. $this->data = $data;
  108. return $this->update();
  109. }
  110. /**
  111. * Returns options used while encoding data to JSON.
  112. *
  113. * @return int
  114. */
  115. public function getEncodingOptions()
  116. {
  117. return $this->encodingOptions;
  118. }
  119. /**
  120. * Sets options used while encoding data to JSON.
  121. *
  122. * @param int $encodingOptions
  123. *
  124. * @return JsonResponse
  125. */
  126. public function setEncodingOptions($encodingOptions)
  127. {
  128. $this->encodingOptions = (int) $encodingOptions;
  129. return $this->setData(json_decode($this->data));
  130. }
  131. /**
  132. * Updates the content and headers according to the JSON data and callback.
  133. *
  134. * @return JsonResponse
  135. */
  136. protected function update()
  137. {
  138. if (null !== $this->callback) {
  139. // Not using application/javascript for compatibility reasons with older browsers.
  140. $this->headers->set('Content-Type', 'text/javascript');
  141. return $this->setContent(sprintf('/**/%s(%s);', $this->callback, $this->data));
  142. }
  143. // Only set the header when there is none or when it equals 'text/javascript' (from a previous update with callback)
  144. // in order to not overwrite a custom definition.
  145. if (!$this->headers->has('Content-Type') || 'text/javascript' === $this->headers->get('Content-Type')) {
  146. $this->headers->set('Content-Type', 'application/json');
  147. }
  148. return $this->setContent($this->data);
  149. }
  150. }