vendor/symfony/http-foundation/JsonResponse.php line 25

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. /**
  15.  * Response represents an HTTP response in JSON format.
  16.  *
  17.  * Note that this class does not force the returned JSON content to be an
  18.  * object. It is however recommended that you do return an object as it
  19.  * protects yourself against XSSI and JSON-JavaScript Hijacking.
  20.  *
  21.  * @see https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/AJAX_Security_Cheat_Sheet.md#always-return-json-with-an-object-on-the-outside
  22.  *
  23.  * @author Igor Wiedler <igor@wiedler.ch>
  24.  */
  25. class JsonResponse extends Response
  26. {
  27.     protected $data;
  28.     protected $callback;
  30.     // Encode <, >, ', &, and " characters in the JSON, making it also safe to be embedded into HTML.
  31.     // 15 === JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT
  32.     public const DEFAULT_ENCODING_OPTIONS = 15;
  34.     protected $encodingOptions = self::DEFAULT_ENCODING_OPTIONS;
  36.     /**
  37.      * @param bool $json If the data is already a JSON string
  38.      */
  39.     public function __construct(mixed $data = null, int $status = 200, array $headers = [], bool $json = false)
  40.     {
  41.         parent::__construct('', $status, $headers);
  43.         if ($json && !\is_string($data) && !is_numeric($data) && !\is_callable([$data, '__toString'])) {
  44.             throw new \TypeError(sprintf('"%s": If $json is set to true, argument $data must be a string or object implementing __toString(), "%s" given.', __METHOD__, get_debug_type($data)));
  45.         }
  47.         if (null === $data) {
  48.             $data = new \ArrayObject();
  49.         }
  51.         $json ? $this->setJson($data) : $this->setData($data);
  52.     }
  54.     /**
  55.      * Factory method for chainability.
  56.      *
  57.      * Example:
  58.      *
  59.      *     return JsonResponse::fromJsonString('{"key": "value"}')
  60.      *         ->setSharedMaxAge(300);
  61.      *
  62.      * @param string $data    The JSON response string
  63.      * @param int    $status  The response status code
  64.      * @param array  $headers An array of response headers
  65.      */
  66.     public static function fromJsonString(string $data, int $status = 200, array $headers = []): static
  67.     {
  68.         return new static($data, $status, $headers, true);
  69.     }
  71.     /**
  72.      * Sets the JSONP callback.
  73.      *
  74.      * @param string|null $callback The JSONP callback or null to use none
  75.      *
  76.      * @return $this
  77.      *
  78.      * @throws \InvalidArgumentException When the callback name is not valid
  79.      */
  80.     public function setCallback(string $callback = null): static
  81.     {
  82.         if (null !== $callback) {
  83.             // partially taken from https://geekality.net/2011/08/03/valid-javascript-identifier/
  84.             // partially taken from https://github.com/willdurand/JsonpCallbackValidator
  85.             //      JsonpCallbackValidator is released under the MIT License. See https://github.com/willdurand/JsonpCallbackValidator/blob/v1.1.0/LICENSE for details.
  86.             //      (c) William Durand <william.durand1@gmail.com>
  87.             $pattern = '/^[$_\p{L}][$_\p{L}\p{Mn}\p{Mc}\p{Nd}\p{Pc}\x{200C}\x{200D}]*(?:\[(?:"(?:\\\.|[^"\\\])*"|\'(?:\\\.|[^\'\\\])*\'|\d+)\])*?$/u';
  88.             $reserved = [
  89.                 'break', 'do', 'instanceof', 'typeof', 'case', 'else', 'new', 'var', 'catch', 'finally', 'return', 'void', 'continue', 'for', 'switch', 'while',
  90.                 'debugger', 'function', 'this', 'with', 'default', 'if', 'throw', 'delete', 'in', 'try', 'class', 'enum', 'extends', 'super',  'const', 'export',
  91.                 'import', 'implements', 'let', 'private', 'public', 'yield', 'interface', 'package', 'protected', 'static', 'null', 'true', 'false',
  92.             ];
  93.             $parts = explode('.', $callback);
  94.             foreach ($parts as $part) {
  95.                 if (!preg_match($pattern, $part) || \in_array($part, $reserved, true)) {
  96.                     throw new \InvalidArgumentException('The callback name is not valid.');
  97.                 }
  98.             }
  99.         }
  101.         $this->callback = $callback;
  103.         return $this->update();
  104.     }
  106.     /**
  107.      * Sets a raw string containing a JSON document to be sent.
  108.      *
  109.      * @return $this
  110.      */
  111.     public function setJson(string $json): static
  112.     {
  113.         $this->data = $json;
  115.         return $this->update();
  116.     }
  118.     /**
  119.      * Sets the data to be sent as JSON.
  120.      *
  121.      * @return $this
  122.      *
  123.      * @throws \InvalidArgumentException
  124.      */
  125.     public function setData(mixed $data = []): static
  126.     {
  127.         try {
  128.             $data = json_encode($data, $this->encodingOptions);
  129.         } catch (\Exception $e) {
  130.             if ('Exception' === \get_class($e) && str_starts_with($e->getMessage(), 'Failed calling ')) {
  131.                 throw $e->getPrevious() ?: $e;
  132.             }
  133.             throw $e;
  134.         }
  136.         if (\JSON_THROW_ON_ERROR & $this->encodingOptions) {
  137.             return $this->setJson($data);
  138.         }
  140.         if (\JSON_ERROR_NONE !== json_last_error()) {
  141.             throw new \InvalidArgumentException(json_last_error_msg());
  142.         }
  144.         return $this->setJson($data);
  145.     }
  147.     /**
  148.      * Returns options used while encoding data to JSON.
  149.      */
  150.     public function getEncodingOptions(): int
  151.     {
  152.         return $this->encodingOptions;
  153.     }
  155.     /**
  156.      * Sets options used while encoding data to JSON.
  157.      *
  158.      * @return $this
  159.      */
  160.     public function setEncodingOptions(int $encodingOptions): static
  161.     {
  162.         $this->encodingOptions = $encodingOptions;
  164.         return $this->setData(json_decode($this->data));
  165.     }
  167.     /**
  168.      * Updates the content and headers according to the JSON data and callback.
  169.      *
  170.      * @return $this
  171.      */
  172.     protected function update(): static
  173.     {
  174.         if (null !== $this->callback) {
  175.             // Not using application/javascript for compatibility reasons with older browsers.
  176.             $this->headers->set('Content-Type', 'text/javascript');
  178.             return $this->setContent(sprintf('/**/%s(%s);', $this->callback, $this->data));
  179.         }
  181.         // Only set the header when there is none or when it equals 'text/javascript' (from a previous update with callback)
  182.         // in order to not overwrite a custom definition.
  183.         if (!$this->headers->has('Content-Type') || 'text/javascript' === $this->headers->get('Content-Type')) {
  184.             $this->headers->set('Content-Type', 'application/json');
  185.         }
  187.         return $this->setContent($this->data);
  188.     }
  189. }