123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528 |
- <?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\Serializer\Encoder;
- use Symfony\Component\Serializer\Exception\BadMethodCallException;
- use Symfony\Component\Serializer\Exception\NotEncodableValueException;
- use Symfony\Component\Serializer\SerializerAwareInterface;
- use Symfony\Component\Serializer\SerializerAwareTrait;
- /**
- * Encodes XML data.
- *
- * @author Jordi Boggiano <j.boggiano@seld.be>
- * @author John Wards <jwards@whiteoctober.co.uk>
- * @author Fabian Vogler <fabian@equivalence.ch>
- * @author Kévin Dunglas <dunglas@gmail.com>
- * @author Dany Maillard <danymaillard93b@gmail.com>
- */
- class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface, SerializerAwareInterface
- {
- use SerializerAwareTrait;
- public const FORMAT = 'xml';
- public const AS_COLLECTION = 'as_collection';
- /**
- * An array of ignored XML node types while decoding, each one of the DOM Predefined XML_* constants.
- */
- public const DECODER_IGNORED_NODE_TYPES = 'decoder_ignored_node_types';
- /**
- * An array of ignored XML node types while encoding, each one of the DOM Predefined XML_* constants.
- */
- public const ENCODER_IGNORED_NODE_TYPES = 'encoder_ignored_node_types';
- public const ENCODING = 'xml_encoding';
- public const FORMAT_OUTPUT = 'xml_format_output';
- /**
- * A bit field of LIBXML_* constants.
- */
- public const LOAD_OPTIONS = 'load_options';
- public const REMOVE_EMPTY_TAGS = 'remove_empty_tags';
- public const ROOT_NODE_NAME = 'xml_root_node_name';
- public const STANDALONE = 'xml_standalone';
- public const TYPE_CAST_ATTRIBUTES = 'xml_type_cast_attributes';
- public const VERSION = 'xml_version';
- private $defaultContext = [
- self::AS_COLLECTION => false,
- self::DECODER_IGNORED_NODE_TYPES => [\XML_PI_NODE, \XML_COMMENT_NODE],
- self::ENCODER_IGNORED_NODE_TYPES => [],
- self::LOAD_OPTIONS => \LIBXML_NONET | \LIBXML_NOBLANKS,
- self::REMOVE_EMPTY_TAGS => false,
- self::ROOT_NODE_NAME => 'response',
- self::TYPE_CAST_ATTRIBUTES => true,
- ];
- /**
- * @var \DOMDocument
- */
- private $dom;
- private $format;
- private $context;
- public function __construct(array $defaultContext = [])
- {
- $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
- }
- /**
- * {@inheritdoc}
- */
- public function encode($data, string $format, array $context = [])
- {
- $encoderIgnoredNodeTypes = $context[self::ENCODER_IGNORED_NODE_TYPES] ?? $this->defaultContext[self::ENCODER_IGNORED_NODE_TYPES];
- $ignorePiNode = \in_array(\XML_PI_NODE, $encoderIgnoredNodeTypes, true);
- if ($data instanceof \DOMDocument) {
- return $data->saveXML($ignorePiNode ? $data->documentElement : null);
- }
- $xmlRootNodeName = $context[self::ROOT_NODE_NAME] ?? $this->defaultContext[self::ROOT_NODE_NAME];
- $this->dom = $this->createDomDocument($context);
- $this->format = $format;
- $this->context = $context;
- if (null !== $data && !is_scalar($data)) {
- $root = $this->dom->createElement($xmlRootNodeName);
- $this->dom->appendChild($root);
- $this->buildXml($root, $data, $xmlRootNodeName);
- } else {
- $this->appendNode($this->dom, $data, $xmlRootNodeName);
- }
- return $this->dom->saveXML($ignorePiNode ? $this->dom->documentElement : null);
- }
- /**
- * {@inheritdoc}
- */
- public function decode(string $data, string $format, array $context = [])
- {
- if ('' === trim($data)) {
- throw new NotEncodableValueException('Invalid XML data, it can not be empty.');
- }
- $internalErrors = libxml_use_internal_errors(true);
- if (\LIBXML_VERSION < 20900) {
- $disableEntities = libxml_disable_entity_loader(true);
- }
- libxml_clear_errors();
- $dom = new \DOMDocument();
- $dom->loadXML($data, $context[self::LOAD_OPTIONS] ?? $this->defaultContext[self::LOAD_OPTIONS]);
- libxml_use_internal_errors($internalErrors);
- if (\LIBXML_VERSION < 20900) {
- libxml_disable_entity_loader($disableEntities);
- }
- if ($error = libxml_get_last_error()) {
- libxml_clear_errors();
- throw new NotEncodableValueException($error->message);
- }
- $rootNode = null;
- $decoderIgnoredNodeTypes = $context[self::DECODER_IGNORED_NODE_TYPES] ?? $this->defaultContext[self::DECODER_IGNORED_NODE_TYPES];
- foreach ($dom->childNodes as $child) {
- if (\XML_DOCUMENT_TYPE_NODE === $child->nodeType) {
- throw new NotEncodableValueException('Document types are not allowed.');
- }
- if (!$rootNode && !\in_array($child->nodeType, $decoderIgnoredNodeTypes, true)) {
- $rootNode = $child;
- }
- }
- // todo: throw an exception if the root node name is not correctly configured (bc)
- if ($rootNode->hasChildNodes()) {
- $xpath = new \DOMXPath($dom);
- $data = [];
- foreach ($xpath->query('namespace::*', $dom->documentElement) as $nsNode) {
- $data['@'.$nsNode->nodeName] = $nsNode->nodeValue;
- }
- unset($data['@xmlns:xml']);
- if (empty($data)) {
- return $this->parseXml($rootNode, $context);
- }
- return array_merge($data, (array) $this->parseXml($rootNode, $context));
- }
- if (!$rootNode->hasAttributes()) {
- return $rootNode->nodeValue;
- }
- $data = [];
- foreach ($rootNode->attributes as $attrKey => $attr) {
- $data['@'.$attrKey] = $attr->nodeValue;
- }
- $data['#'] = $rootNode->nodeValue;
- return $data;
- }
- /**
- * {@inheritdoc}
- */
- public function supportsEncoding(string $format)
- {
- return self::FORMAT === $format;
- }
- /**
- * {@inheritdoc}
- */
- public function supportsDecoding(string $format)
- {
- return self::FORMAT === $format;
- }
- final protected function appendXMLString(\DOMNode $node, string $val): bool
- {
- if ('' !== $val) {
- $frag = $this->dom->createDocumentFragment();
- $frag->appendXML($val);
- $node->appendChild($frag);
- return true;
- }
- return false;
- }
- final protected function appendText(\DOMNode $node, string $val): bool
- {
- $nodeText = $this->dom->createTextNode($val);
- $node->appendChild($nodeText);
- return true;
- }
- final protected function appendCData(\DOMNode $node, string $val): bool
- {
- $nodeText = $this->dom->createCDATASection($val);
- $node->appendChild($nodeText);
- return true;
- }
- /**
- * @param \DOMDocumentFragment $fragment
- */
- final protected function appendDocumentFragment(\DOMNode $node, $fragment): bool
- {
- if ($fragment instanceof \DOMDocumentFragment) {
- $node->appendChild($fragment);
- return true;
- }
- return false;
- }
- final protected function appendComment(\DOMNode $node, string $data): bool
- {
- $node->appendChild($this->dom->createComment($data));
- return true;
- }
- /**
- * Checks the name is a valid xml element name.
- */
- final protected function isElementNameValid(string $name): bool
- {
- return $name &&
- false === strpos($name, ' ') &&
- preg_match('#^[\pL_][\pL0-9._:-]*$#ui', $name);
- }
- /**
- * Parse the input DOMNode into an array or a string.
- *
- * @return array|string
- */
- private function parseXml(\DOMNode $node, array $context = [])
- {
- $data = $this->parseXmlAttributes($node, $context);
- $value = $this->parseXmlValue($node, $context);
- if (!\count($data)) {
- return $value;
- }
- if (!\is_array($value)) {
- $data['#'] = $value;
- return $data;
- }
- if (1 === \count($value) && key($value)) {
- $data[key($value)] = current($value);
- return $data;
- }
- foreach ($value as $key => $val) {
- $data[$key] = $val;
- }
- return $data;
- }
- /**
- * Parse the input DOMNode attributes into an array.
- */
- private function parseXmlAttributes(\DOMNode $node, array $context = []): array
- {
- if (!$node->hasAttributes()) {
- return [];
- }
- $data = [];
- $typeCastAttributes = (bool) ($context[self::TYPE_CAST_ATTRIBUTES] ?? $this->defaultContext[self::TYPE_CAST_ATTRIBUTES]);
- foreach ($node->attributes as $attr) {
- if (!is_numeric($attr->nodeValue) || !$typeCastAttributes || (isset($attr->nodeValue[1]) && '0' === $attr->nodeValue[0] && '.' !== $attr->nodeValue[1])) {
- $data['@'.$attr->nodeName] = $attr->nodeValue;
- continue;
- }
- if (false !== $val = filter_var($attr->nodeValue, \FILTER_VALIDATE_INT)) {
- $data['@'.$attr->nodeName] = $val;
- continue;
- }
- $data['@'.$attr->nodeName] = (float) $attr->nodeValue;
- }
- return $data;
- }
- /**
- * Parse the input DOMNode value (content and children) into an array or a string.
- *
- * @return array|string
- */
- private function parseXmlValue(\DOMNode $node, array $context = [])
- {
- if (!$node->hasChildNodes()) {
- return $node->nodeValue;
- }
- if (1 === $node->childNodes->length && \in_array($node->firstChild->nodeType, [\XML_TEXT_NODE, \XML_CDATA_SECTION_NODE])) {
- return $node->firstChild->nodeValue;
- }
- $value = [];
- $decoderIgnoredNodeTypes = $context[self::DECODER_IGNORED_NODE_TYPES] ?? $this->defaultContext[self::DECODER_IGNORED_NODE_TYPES];
- foreach ($node->childNodes as $subnode) {
- if (\in_array($subnode->nodeType, $decoderIgnoredNodeTypes, true)) {
- continue;
- }
- $val = $this->parseXml($subnode, $context);
- if ('item' === $subnode->nodeName && isset($val['@key'])) {
- $value[$val['@key']] = $val['#'] ?? $val;
- } else {
- $value[$subnode->nodeName][] = $val;
- }
- }
- $asCollection = $context[self::AS_COLLECTION] ?? $this->defaultContext[self::AS_COLLECTION];
- foreach ($value as $key => $val) {
- if (!$asCollection && \is_array($val) && 1 === \count($val)) {
- $value[$key] = current($val);
- }
- }
- return $value;
- }
- /**
- * Parse the data and convert it to DOMElements.
- *
- * @param array|object $data
- *
- * @throws NotEncodableValueException
- */
- private function buildXml(\DOMNode $parentNode, $data, string $xmlRootNodeName = null): bool
- {
- $append = true;
- $removeEmptyTags = $this->context[self::REMOVE_EMPTY_TAGS] ?? $this->defaultContext[self::REMOVE_EMPTY_TAGS] ?? false;
- $encoderIgnoredNodeTypes = $this->context[self::ENCODER_IGNORED_NODE_TYPES] ?? $this->defaultContext[self::ENCODER_IGNORED_NODE_TYPES];
- if (\is_array($data) || ($data instanceof \Traversable && (null === $this->serializer || !$this->serializer->supportsNormalization($data, $this->format)))) {
- foreach ($data as $key => $data) {
- //Ah this is the magic @ attribute types.
- if (0 === strpos($key, '@') && $this->isElementNameValid($attributeName = substr($key, 1))) {
- if (!is_scalar($data)) {
- $data = $this->serializer->normalize($data, $this->format, $this->context);
- }
- $parentNode->setAttribute($attributeName, $data);
- } elseif ('#' === $key) {
- $append = $this->selectNodeType($parentNode, $data);
- } elseif ('#comment' === $key) {
- if (!\in_array(\XML_COMMENT_NODE, $encoderIgnoredNodeTypes, true)) {
- $append = $this->appendComment($parentNode, $data);
- }
- } elseif (\is_array($data) && false === is_numeric($key)) {
- // Is this array fully numeric keys?
- if (ctype_digit(implode('', array_keys($data)))) {
- /*
- * Create nodes to append to $parentNode based on the $key of this array
- * Produces <xml><item>0</item><item>1</item></xml>
- * From ["item" => [0,1]];.
- */
- foreach ($data as $subData) {
- $append = $this->appendNode($parentNode, $subData, $key);
- }
- } else {
- $append = $this->appendNode($parentNode, $data, $key);
- }
- } elseif (is_numeric($key) || !$this->isElementNameValid($key)) {
- $append = $this->appendNode($parentNode, $data, 'item', $key);
- } elseif (null !== $data || !$removeEmptyTags) {
- $append = $this->appendNode($parentNode, $data, $key);
- }
- }
- return $append;
- }
- if (\is_object($data)) {
- if (null === $this->serializer) {
- throw new BadMethodCallException(sprintf('The serializer needs to be set to allow "%s()" to be used with object data.', __METHOD__));
- }
- $data = $this->serializer->normalize($data, $this->format, $this->context);
- if (null !== $data && !is_scalar($data)) {
- return $this->buildXml($parentNode, $data, $xmlRootNodeName);
- }
- // top level data object was normalized into a scalar
- if (!$parentNode->parentNode->parentNode) {
- $root = $parentNode->parentNode;
- $root->removeChild($parentNode);
- return $this->appendNode($root, $data, $xmlRootNodeName);
- }
- return $this->appendNode($parentNode, $data, 'data');
- }
- throw new NotEncodableValueException('An unexpected value could not be serialized: '.(!\is_resource($data) ? var_export($data, true) : sprintf('%s resource', get_resource_type($data))));
- }
- /**
- * Selects the type of node to create and appends it to the parent.
- *
- * @param array|object $data
- */
- private function appendNode(\DOMNode $parentNode, $data, string $nodeName, string $key = null): bool
- {
- $node = $this->dom->createElement($nodeName);
- if (null !== $key) {
- $node->setAttribute('key', $key);
- }
- $appendNode = $this->selectNodeType($node, $data);
- // we may have decided not to append this node, either in error or if its $nodeName is not valid
- if ($appendNode) {
- $parentNode->appendChild($node);
- }
- return $appendNode;
- }
- /**
- * Checks if a value contains any characters which would require CDATA wrapping.
- */
- private function needsCdataWrapping(string $val): bool
- {
- return 0 < preg_match('/[<>&]/', $val);
- }
- /**
- * Tests the value being passed and decide what sort of element to create.
- *
- * @throws NotEncodableValueException
- */
- private function selectNodeType(\DOMNode $node, $val): bool
- {
- if (\is_array($val)) {
- return $this->buildXml($node, $val);
- } elseif ($val instanceof \SimpleXMLElement) {
- $child = $this->dom->importNode(dom_import_simplexml($val), true);
- $node->appendChild($child);
- } elseif ($val instanceof \Traversable) {
- $this->buildXml($node, $val);
- } elseif ($val instanceof \DOMNode) {
- $child = $this->dom->importNode($val, true);
- $node->appendChild($child);
- } elseif (\is_object($val)) {
- if (null === $this->serializer) {
- throw new BadMethodCallException(sprintf('The serializer needs to be set to allow "%s()" to be used with object data.', __METHOD__));
- }
- return $this->selectNodeType($node, $this->serializer->normalize($val, $this->format, $this->context));
- } elseif (is_numeric($val)) {
- return $this->appendText($node, (string) $val);
- } elseif (\is_string($val) && $this->needsCdataWrapping($val)) {
- return $this->appendCData($node, $val);
- } elseif (\is_string($val)) {
- return $this->appendText($node, $val);
- } elseif (\is_bool($val)) {
- return $this->appendText($node, (int) $val);
- }
- return true;
- }
- /**
- * Create a DOM document, taking serializer options into account.
- */
- private function createDomDocument(array $context): \DOMDocument
- {
- $document = new \DOMDocument();
- // Set an attribute on the DOM document specifying, as part of the XML declaration,
- $xmlOptions = [
- // nicely formats output with indentation and extra space
- self::FORMAT_OUTPUT => 'formatOutput',
- // the version number of the document
- self::VERSION => 'xmlVersion',
- // the encoding of the document
- self::ENCODING => 'encoding',
- // whether the document is standalone
- self::STANDALONE => 'xmlStandalone',
- ];
- foreach ($xmlOptions as $xmlOption => $documentProperty) {
- if ($contextOption = $context[$xmlOption] ?? $this->defaultContext[$xmlOption] ?? false) {
- $document->$documentProperty = $contextOption;
- }
- }
- return $document;
- }
- }
|