XmlDeserializationVisitor::visitProperty() - Code Metrics - Inspection of "Generic way to solve setValue on a property which..." - schmittjoh/serializer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#550)

by Jonatan

created 2016-05-12 11:19 UTC

XmlDeserializationVisitor::visitProperty() C

↳ Parent: XmlDeserializationVisitor

Complexity

Conditions	12
Paths	12

Size

Total Lines	69
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	42
CRAP Score	12.0427

Importance

Changes	6
Bugs	1	Features	1

Metric	Value
c	6
b	1
f	1
dl	0
loc	69
ccs	42
cts	45
cp	0.9333
rs	5.7089
cc	12
eloc	42
nc	12
nop	3
crap	12.0427

How to fix Long Method Complexity

<?php

/*
 * Copyright 2013 Johannes M. Schmitt <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace JMS\Serializer;

use JMS\Serializer\Exception\XmlErrorException;
use JMS\Serializer\Exception\LogicException;
use JMS\Serializer\Exception\InvalidArgumentException;
use JMS\Serializer\Exception\RuntimeException;
use JMS\Serializer\Metadata\PropertyMetadata;
use JMS\Serializer\Metadata\ClassMetadata;

class XmlDeserializationVisitor extends AbstractVisitor
{
    private $objectStack;
    private $metadataStack;
    private $objectMetadataStack;
    private $currentObject;
    private $currentMetadata;
    private $result;
    private $navigator;
    private $disableExternalEntities = true;
    private $doctypeWhitelist = array();

    public function enableExternalEntities()
    {
        $this->disableExternalEntities = false;
    }

    public function setNavigator(GraphNavigator $navigator)
    {
        $this->navigator = $navigator;
        $this->objectStack = new \SplStack;
        $this->metadataStack = new \SplStack;
        $this->objectMetadataStack = new \SplStack;
        $this->result = null;
    }

    public function getNavigator()
    {
        return $this->navigator;
    }

    public function prepare($data)
    {
        $previous = libxml_use_internal_errors(true);
        $previousEntityLoaderState = libxml_disable_entity_loader($this->disableExternalEntities);

        if (false !== stripos($data, '<!doctype')) {
            $internalSubset = $this->getDomDocumentTypeEntitySubset($data);
            if (!in_array($internalSubset, $this->doctypeWhitelist, true)) {
                throw new InvalidArgumentException(sprintf(
                    'The document type "%s" is not allowed. If it is safe, you may add it to the whitelist configuration.',
                    $internalSubset
                ));
            }
        }

        $doc = simplexml_load_string($data);

        libxml_use_internal_errors($previous);
        libxml_disable_entity_loader($previousEntityLoaderState);

        if (false === $doc) {
            throw new XmlErrorException(libxml_get_last_error());
        }

        return $doc;
    }

    public function visitNull($data, array $type, Context $context)
    {
        return null;
    }

    public function visitString($data, array $type, Context $context)
    {
        $data = (string) $data;

        if (null === $this->result) {
            $this->result = $data;
        }

        return $data;
    }

    public function visitBoolean($data, array $type, Context $context)
    {
        $data = (string) $data;

        if ('true' === $data || '1' === $data) {
            $data = true;
        } elseif ('false' === $data || '0' === $data) {
            $data = false;
        } else {
            throw new RuntimeException(sprintf('Could not convert data to boolean. Expected "true", "false", "1" or "0", but got %s.', json_encode($data)));
        }

        if (null === $this->result) {
            $this->result = $data;
        }

        return $data;
    }

    public function visitInteger($data, array $type, Context $context)
    {
        $data = (integer) $data;

        if (null === $this->result) {
            $this->result = $data;
        }

        return $data;
    }

    public function visitDouble($data, array $type, Context $context)
    {
        $data = (double) $data;

        if (null === $this->result) {
            $this->result = $data;
        }

        return $data;
    }

    public function visitArray($data, array $type, Context $context)
    {
        $entryName = null !== $this->currentMetadata && $this->currentMetadata->xmlEntryName ? $this->currentMetadata->xmlEntryName : 'entry';
        $namespace = null !== $this->currentMetadata && $this->currentMetadata->xmlEntryNamespace ? $this->currentMetadata->xmlEntryNamespace : null;

        if ($namespace === null && $this->objectMetadataStack->count()) {
            $classMetadata = $this->objectMetadataStack->top();
            $namespace = isset($classMetadata->xmlNamespaces[''])?$classMetadata->xmlNamespaces['']:$namespace;
        }

        if ( ! isset($data->$entryName) ) {
            if (null === $this->result) {
                return $this->result = array();
            }

            return array();
        }

        switch (count($type['params'])) {
            case 0:
                throw new RuntimeException(sprintf('The array type must be specified either as "array<T>", or "array<K,V>".'));

            case 1:
                $result = array();

                if (null === $this->result) {
                    $this->result = &$result;
                }

                $nodes = $data->children($namespace)->$entryName;
                foreach ($nodes as $v) {
                    $result[] = $this->navigator->accept($v, $type['params'][0], $context);
                }

                return $result;

            case 2:
                if (null === $this->currentMetadata) {
                    throw new RuntimeException('Maps are not supported on top-level without metadata.');
                }

                list($keyType, $entryType) = $type['params'];
                $result = array();
                if (null === $this->result) {
                    $this->result = &$result;
                }

                $nodes = $data->children($namespace)->$entryName;
                foreach ($nodes as $v) {
                    $attrs = $v->attributes();
                    if ( ! isset($attrs[$this->currentMetadata->xmlKeyAttribute])) {
                        throw new RuntimeException(sprintf('The key attribute "%s" must be set for each entry of the map.', $this->currentMetadata->xmlKeyAttribute));
                    }

                    $k = $this->navigator->accept($attrs[$this->currentMetadata->xmlKeyAttribute], $keyType, $context);
                    $result[$k] = $this->navigator->accept($v, $entryType, $context);
                }

                return $result;

            default:
                throw new LogicException(sprintf('The array type does not support more than 2 parameters, but got %s.', json_encode($type['params'])));
        }
    }

    public function startVisitingObject(ClassMetadata $metadata, $object, array $type, Context $context)
    {
        $this->setCurrentObject($object);
        $this->objectMetadataStack->push($metadata);
        if (null === $this->result) {
            $this->result = $this->currentObject;
        }
    }

    public function visitProperty(PropertyMetadata $metadata, $data, Context $context)
    {
        $name = $this->namingStrategy->translateName($metadata);

        if ( ! $metadata->type) {
            throw new RuntimeException(sprintf('You must define a type for %s::$%s.', $metadata->reflection->class, $metadata->name));
        }

       if ($metadata->xmlAttribute) {

            $attributes = $data->attributes($metadata->xmlNamespace);
            if (isset($attributes[$name])) {
                $v = $this->navigator->accept($attributes[$name], $metadata->type, $context);
                $metadata->reflection->setValue($this->currentObject, $v);
            }

            return;
        }

        if ($metadata->xmlValue) {
            $v = $this->navigator->accept($data, $metadata->type, $context);
            $metadata->reflection->setValue($this->currentObject, $v);

            return;
        }

        if ($metadata->xmlCollection) {
            $enclosingElem = $data;
            if (!$metadata->xmlCollectionInline) {
                $enclosingElem = $data->children($metadata->xmlNamespace)->$name;
            }

            $this->setCurrentMetadata($metadata);
            $v = $this->navigator->accept($enclosingElem, $metadata->type, $context);
            $this->revertCurrentMetadata();
            $metadata->reflection->setValue($this->currentObject, $v);

            return;
        }

        if ($metadata->xmlNamespace) {
            $node = $data->children($metadata->xmlNamespace)->$name;
            if (!$node->count()) {
                return;
            }
        } else {

            $namespaces = $data->getDocNamespaces();

            if (isset($namespaces[''])) {
                $prefix = uniqid('ns-');
                $data->registerXPathNamespace($prefix, $namespaces['']);
                $nodes = $data->xpath('./'.$prefix. ':'.$name );
                if (empty($nodes)) {
                    return;
                }
                $node = reset($nodes);
            } else {
                if (!isset($data->$name)) {
                    return;
                }
                $node = $data->$name;
            }
        }

        $v = $this->navigator->accept($node, $metadata->type, $context);

        $metadata->setValue($this->currentObject, $v);
    }

    public function endVisitingObject(ClassMetadata $metadata, $data, array $type, Context $context)
    {
        $rs = $this->currentObject;
        $this->objectMetadataStack->pop();
        $this->revertCurrentObject();

        return $rs;
    }

    public function setCurrentObject($object)
    {
        $this->objectStack->push($this->currentObject);
        $this->currentObject = $object;
    }

    public function getCurrentObject()
    {
        return $this->currentObject;
    }

    public function revertCurrentObject()
    {
        return $this->currentObject = $this->objectStack->pop();
    }

    public function setCurrentMetadata(PropertyMetadata $metadata)
    {
        $this->metadataStack->push($this->currentMetadata);
        $this->currentMetadata = $metadata;
    }

    public function getCurrentMetadata()
    {
        return $this->currentMetadata;
    }

    public function revertCurrentMetadata()
    {
        return $this->currentMetadata = $this->metadataStack->pop();
    }

    public function getResult()
    {
        return $this->result;
    }

    /**
     * @param array<string> $doctypeWhitelist
     */
    public function setDoctypeWhitelist(array $doctypeWhitelist)
    {
        $this->doctypeWhitelist = $doctypeWhitelist;
    }

    /**
     * @return array<string>
     */
    public function getDoctypeWhitelist()
    {
        return $this->doctypeWhitelist;
    }

    /**
     * Retrieves internalSubset even in bugfixed php versions
     *
     * @param \DOMDocumentType $child
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $data
     * @return string
     */
    private function getDomDocumentTypeEntitySubset($data)
    {
        $startPos = $endPos = stripos($data, '<!doctype');
        $braces = 0;
        do {
            $char = $data[$endPos++];
            if ($char === '<') {
                ++$braces;
            }
            if ($char === '>') {
                --$braces;
            }
        } while ($braces > 0);

        $internalSubset = substr($data, $startPos, $endPos - $startPos);
        $internalSubset = str_replace(array("\n", "\r"), '', $internalSubset);
        $internalSubset = preg_replace('/\s{2,}/', ' ', $internalSubset);
        $internalSubset = str_replace(array("[ <!", "> ]>"), array('[<!', '>]>'), $internalSubset);

        return $internalSubset;
    }
}


1		<?php
2
3		/*
4		* Copyright 2013 Johannes M. Schmitt <[email protected]>
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*/
18
19		namespace JMS\Serializer;
20
21		use JMS\Serializer\Exception\XmlErrorException;
22		use JMS\Serializer\Exception\LogicException;
23		use JMS\Serializer\Exception\InvalidArgumentException;
24		use JMS\Serializer\Exception\RuntimeException;
25		use JMS\Serializer\Metadata\PropertyMetadata;
26		use JMS\Serializer\Metadata\ClassMetadata;
27
28		class XmlDeserializationVisitor extends AbstractVisitor
29		{
30		private $objectStack;
31		private $metadataStack;
32		private $objectMetadataStack;
33		private $currentObject;
34		private $currentMetadata;
35		private $result;
36		private $navigator;
37		private $disableExternalEntities = true;
38		private $doctypeWhitelist = array();
39
40		public function enableExternalEntities()
41		{
42		$this->disableExternalEntities = false;
43		}
44
45	49	public function setNavigator(GraphNavigator $navigator)
46		{
47	49	$this->navigator = $navigator;
48	49	$this->objectStack = new \SplStack;
49	49	$this->metadataStack = new \SplStack;
50	49	$this->objectMetadataStack = new \SplStack;
51	49	$this->result = null;
52	49	}
53
54	1	public function getNavigator()
55		{
56	1	return $this->navigator;
57		}
58
59	51	public function prepare($data)
60		{
61	51	$previous = libxml_use_internal_errors(true);
62	51	$previousEntityLoaderState = libxml_disable_entity_loader($this->disableExternalEntities);
63
64	51	if (false !== stripos($data, '<!doctype')) {
65	3	$internalSubset = $this->getDomDocumentTypeEntitySubset($data);
66	3	if (!in_array($internalSubset, $this->doctypeWhitelist, true)) {
67	2	throw new InvalidArgumentException(sprintf(
68	2	'The document type "%s" is not allowed. If it is safe, you may add it to the whitelist configuration.',
69		$internalSubset
70	2	));
71		}
72	1	}
73
74	49	$doc = simplexml_load_string($data);
75
76	49	libxml_use_internal_errors($previous);
77	49	libxml_disable_entity_loader($previousEntityLoaderState);
78
79	49	if (false === $doc) {
80		throw new XmlErrorException(libxml_get_last_error());
81		}
82
83	49	return $doc;
84		}
85
86	1	public function visitNull($data, array $type, Context $context)
87		{
88	1	return null;
89		}
90
91	17	public function visitString($data, array $type, Context $context)
92		{
93	17	$data = (string) $data;
94
95	17	if (null === $this->result) {
96	3	$this->result = $data;
97	3	}
98
99	17	return $data;
100		}
101
102	8	public function visitBoolean($data, array $type, Context $context)
103		{
104	8	$data = (string) $data;
105
106	8	if ('true' === $data \|\| '1' === $data) {
107	4	$data = true;
108	8	} elseif ('false' === $data \|\| '0' === $data) {
109	5	$data = false;
110	5	} else {
111		throw new RuntimeException(sprintf('Could not convert data to boolean. Expected "true", "false", "1" or "0", but got %s.', json_encode($data)));
112		}
113
114	8	if (null === $this->result) {
115	6	$this->result = $data;
116	6	}
117
118	8	return $data;
119		}
120
121	8	public function visitInteger($data, array $type, Context $context)
122		{
123	8	$data = (integer) $data;
124
125	8	if (null === $this->result) {
126	2	$this->result = $data;
127	2	}
128
129	8	return $data;
130		}
131
132	12	public function visitDouble($data, array $type, Context $context)
133		{
134	12	$data = (double) $data;
135
136	12	if (null === $this->result) {
137	6	$this->result = $data;
138	6	}
139
140	12	return $data;
141		}
142
143	12	public function visitArray($data, array $type, Context $context)
144		{
145	12	$entryName = null !== $this->currentMetadata && $this->currentMetadata->xmlEntryName ? $this->currentMetadata->xmlEntryName : 'entry';
146	12	$namespace = null !== $this->currentMetadata && $this->currentMetadata->xmlEntryNamespace ? $this->currentMetadata->xmlEntryNamespace : null;
147
148	12	if ($namespace === null && $this->objectMetadataStack->count()) {
149	7	$classMetadata = $this->objectMetadataStack->top();
150	7	$namespace = isset($classMetadata->xmlNamespaces[''])?$classMetadata->xmlNamespaces['']:$namespace;
151	7	}
152
153	12	if ( ! isset($data->$entryName) ) {
154		if (null === $this->result) {
155		return $this->result = array();
156		}
157
158		return array();
159		}
160
161	12	switch (count($type['params'])) {
162	12	case 0:
163		throw new RuntimeException(sprintf('The array type must be specified either as "array<T>", or "array<K,V>".'));
164
165	12	case 1:
166	12	$result = array();
167
168	12	if (null === $this->result) {
169	5	$this->result = &$result;
170	5	}
171
172	12	$nodes = $data->children($namespace)->$entryName;
173	12	foreach ($nodes as $v) {
174	12	$result[] = $this->navigator->accept($v, $type['params'][0], $context);
175	12	}
176
177	12	return $result;
178
179	3	case 2:
180	3	if (null === $this->currentMetadata) {
181		throw new RuntimeException('Maps are not supported on top-level without metadata.');
182		}
183
184	3	list($keyType, $entryType) = $type['params'];
185	3	$result = array();
186	3	if (null === $this->result) {
187		$this->result = &$result;
188		}
189
190	3	$nodes = $data->children($namespace)->$entryName;
191	3	foreach ($nodes as $v) {
192	3	$attrs = $v->attributes();
193	3	if ( ! isset($attrs[$this->currentMetadata->xmlKeyAttribute])) {
194		throw new RuntimeException(sprintf('The key attribute "%s" must be set for each entry of the map.', $this->currentMetadata->xmlKeyAttribute));
195		}
196
197	3	$k = $this->navigator->accept($attrs[$this->currentMetadata->xmlKeyAttribute], $keyType, $context);
198	3	$result[$k] = $this->navigator->accept($v, $entryType, $context);
199	3	}
200
201	3	return $result;
202
203		default:
204		throw new LogicException(sprintf('The array type does not support more than 2 parameters, but got %s.', json_encode($type['params'])));
205		}
206		}
207
208	22	public function startVisitingObject(ClassMetadata $metadata, $object, array $type, Context $context)
209		{
210	22	$this->setCurrentObject($object);
211	22	$this->objectMetadataStack->push($metadata);
212	22	if (null === $this->result) {
213	21	$this->result = $this->currentObject;
214	21	}
215	22	}
216
217	21	public function visitProperty(PropertyMetadata $metadata, $data, Context $context)
218		{
219	21	$name = $this->namingStrategy->translateName($metadata);
220
221	21	if ( ! $metadata->type) {
222		throw new RuntimeException(sprintf('You must define a type for %s::$%s.', $metadata->reflection->class, $metadata->name));
223		}
224
225	21	if ($metadata->xmlAttribute) {
226
227	4	$attributes = $data->attributes($metadata->xmlNamespace);
228	4	if (isset($attributes[$name])) {
229	4	$v = $this->navigator->accept($attributes[$name], $metadata->type, $context);
230	4	$metadata->reflection->setValue($this->currentObject, $v);
231	4	}
232
233	4	return;
234		}
235
236	21	if ($metadata->xmlValue) {
237	5	$v = $this->navigator->accept($data, $metadata->type, $context);
238	5	$metadata->reflection->setValue($this->currentObject, $v);
239
240	5	return;
241		}
242
243	19	if ($metadata->xmlCollection) {
244	3	$enclosingElem = $data;
245	3	if (!$metadata->xmlCollectionInline) {
246	3	$enclosingElem = $data->children($metadata->xmlNamespace)->$name;
247	3	}
248
249	3	$this->setCurrentMetadata($metadata);
250	3	$v = $this->navigator->accept($enclosingElem, $metadata->type, $context);
251	3	$this->revertCurrentMetadata();
252	3	$metadata->reflection->setValue($this->currentObject, $v);
253
254	3	return;
255		}
256
257	19	if ($metadata->xmlNamespace) {
258	3	$node = $data->children($metadata->xmlNamespace)->$name;
259	3	if (!$node->count()) {
260		return;
261		}
262	3	} else {
263
264	17	$namespaces = $data->getDocNamespaces();
265
266	17	if (isset($namespaces[''])) {
267	1	$prefix = uniqid('ns-');
268	1	$data->registerXPathNamespace($prefix, $namespaces['']);
269	1	$nodes = $data->xpath('./'.$prefix. ':'.$name );
270	1	if (empty($nodes)) {
271		return;
272		}
273	1	$node = reset($nodes);
274	1	} else {
275	16	if (!isset($data->$name)) {
276	1	return;
277		}
278	16	$node = $data->$name;
279		}
280		}
281
282	19	$v = $this->navigator->accept($node, $metadata->type, $context);
283
284	19	$metadata->setValue($this->currentObject, $v);
285	19	}
286
287	22	public function endVisitingObject(ClassMetadata $metadata, $data, array $type, Context $context)
288		{
289	22	$rs = $this->currentObject;
290	22	$this->objectMetadataStack->pop();
291	22	$this->revertCurrentObject();
292
293	22	return $rs;
294		}
295
296	22	public function setCurrentObject($object)
297		{
298	22	$this->objectStack->push($this->currentObject);
299	22	$this->currentObject = $object;
300	22	}
301
302		public function getCurrentObject()
303		{
304		return $this->currentObject;
305		}
306
307	22	public function revertCurrentObject()
308		{
309	22	return $this->currentObject = $this->objectStack->pop();
310		}
311
312	3	public function setCurrentMetadata(PropertyMetadata $metadata)
313		{
314	3	$this->metadataStack->push($this->currentMetadata);
315	3	$this->currentMetadata = $metadata;
316	3	}
317
318		public function getCurrentMetadata()
319		{
320		return $this->currentMetadata;
321		}
322
323	3	public function revertCurrentMetadata()
324		{
325	3	return $this->currentMetadata = $this->metadataStack->pop();
326		}
327
328	48	public function getResult()
329		{
330	48	return $this->result;
331		}
332
333		/**
334		* @param array<string> $doctypeWhitelist
335		*/
336	1	public function setDoctypeWhitelist(array $doctypeWhitelist)
337		{
338	1	$this->doctypeWhitelist = $doctypeWhitelist;
339	1	}
340
341		/**
342		* @return array<string>
343		*/
344		public function getDoctypeWhitelist()
345		{
346		return $this->doctypeWhitelist;
347		}
348
349		/**
350		* Retrieves internalSubset even in bugfixed php versions
351		*
352		* @param \DOMDocumentType $child
		0 ignored issues – show Bug introduced 2016-05-06 14:50 UTC by Report Bug Copy Issue Report There is no parameter named `$child`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
353		* @param string $data
354		* @return string
355		*/
356	3	private function getDomDocumentTypeEntitySubset($data)
357		{
358	3	$startPos = $endPos = stripos($data, '<!doctype');
359	3	$braces = 0;
360		do {
361	3	$char = $data[$endPos++];
362	3	if ($char === '<') {
363	3	++$braces;
364	3	}
365	3	if ($char === '>') {
366	3	--$braces;
367	3	}
368	3	} while ($braces > 0);
369
370	3	$internalSubset = substr($data, $startPos, $endPos - $startPos);
371	3	$internalSubset = str_replace(array("\n", "\r"), '', $internalSubset);
372	3	$internalSubset = preg_replace('/\s{2,}/', ' ', $internalSubset);
373	3	$internalSubset = str_replace(array("[ <!", "> ]>"), array('[<!', '>]>'), $internalSubset);
374
375	3	return $internalSubset;
376		}
377		}
378

schmittjoh / serializer

Pull Request — master (#550)

XmlDeserializationVisitor::visitProperty() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like