XML2Array::convert() - Code Metrics - Inspection of "Update XML2Array.php" - Algo-Web/POData - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 94203c...087b47 )

by Christopher

created 2016-12-21 13:11 UTC

XML2Array::convert() C

↳ Parent: XML2Array

Complexity

Conditions	16
Paths	12

Size

Total Lines	57
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	57
rs	6.5273
cc	16
eloc	36
nc	12
nop	1

How to fix Long Method Complexity

<?php
namespace POData\UriProcessor;

class XML2Array
{
    /**
     * @var string
     */
    private static $encoding = 'UTF-8';
    /**
     * @var \DOMDocument
     */
    private static $xml = null;
    /**
     * Convert an XML to Array.
     *
     * @param string $input_xml
     *
     * @return array
     *
     * @throws \Exception
     */
    public static function createArray($input_xml)
    {
        if (empty($input_xml)) {
            return [];
        }
        $xml = self::getXMLRoot();
        if (is_string($input_xml)) {
            try {
                $xml->loadXML($input_xml);
libxml_disable_entity_loader(true);

$dom = new DOMDocument;
$dom->loadXML($taintedXml);
foreach ($dom->childNodes as $child) {
    if ($child->nodeType === XML_DOCUMENT_TYPE_NODE) {
        throw new InvalidArgumentException(
            'Invalid XML: Detected use of illegal DOCTYPE'
        );
    }
}

// It is now safe to use $taintedXml
$xml = simplexml_load_string($taintedXml);
                if (!is_object($xml) || empty($xml->documentElement)) {
                    throw new \Exception();
                }
            } catch (\Exception $ex) {
                throw new \Exception('[XML2Array] Error parsing the XML string.' . PHP_EOL . $ex->getMessage());
            }
        } elseif (is_object($input_xml)) {
            if (get_class($input_xml) != 'DOMDocument') {
                throw new \Exception('[XML2Array] The input XML object should be of type: DOMDocument.');
            }
            $xml = self::$xml = $input_xml;
        } else {
            throw new \Exception('[XML2Array] Invalid input');
        }
        $array[$xml->documentElement->tagName] = self::convert($xml->documentElement);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        self::$xml = null; // clear the xml node in the class for 2nd time use.
        return $array;
    }
    /**
     * Initialize the root XML node [optional].
     *
     * @param string $version
     * @param string $encoding
     * @param bool   $standalone
     * @param bool   $format_output
     */
    public static function init($version = '1.0', $encoding = 'utf-8', $standalone = false, $format_output = true)
    {
        self::$xml = new \DomDocument($version, $encoding);
        self::$xml->xmlStandalone = $standalone;
        self::$xml->formatOutput = $format_output;
        self::$encoding = $encoding;
    }
    /**
     * Convert an Array to XML.
     *
     * @param \DOMNode $node - XML as a string or as an object of DOMDocument
     *
     * @return array
     */
    private static function convert(\DOMNode $node)
    {
        $output = [];
        switch ($node->nodeType) {
            case XML_CDATA_SECTION_NODE:
                $output['@cdata'] = trim($node->textContent);
                break;
            case XML_TEXT_NODE:
                $output = trim($node->textContent);
                break;
            case XML_ELEMENT_NODE:
                // for each child node, call the covert function recursively
                for ($i = 0, $m = $node->childNodes->length; $i < $m; ++$i) {
                    $child = $node->childNodes->item($i);
                    $v = self::convert($child);
                    if (isset($child->tagName)) {
                        $t = $child->tagName;
                        // assume more nodes of same kind are coming
                        if (!array_key_exists($t, $output)) {
                            $output[$t] = [];
                        }
                        $output[$t][] = $v;
                    } else {
                        //check if it is not an empty node
                        if (!empty($v)) {
                            $output = $v;
                        }
                    }
                }
                if (is_array($output)) {
                    // if only one node of its kind, assign it directly instead if array($value);
                    foreach ($output as $t => $v) {
                        if (is_array($v) && count($v) == 1) {
                            $output[$t] = $v[0];
                        }
                    }
                    if (empty($output)) {
                        //for empty nodes
                        $output = '';
                    }
                }
                // loop through the attributes and collect them
                if ($node->attributes->length) {

                    $a = [];
                    foreach ($node->attributes as $attrName => $attrNode) {
                        $a[$attrName] = $attrNode->value;
                    }
                    // if its an leaf node, store the value in @value instead of directly storing it.
                    if (!is_array($output)) {
                        $output = ['@value' => $output];
                    }
                    $output['@attributes'] = $a;
                }
                break;
        }
        return $output;
    }
    /**
     * Get the root XML node, if there isn't one, create it.
     *
     * @return \DOMDocument
     */
    private static function getXMLRoot()
    {
        if (empty(self::$xml)) {
            self::init();
        }
        return self::$xml;
    }
}


1			<?php
2			namespace POData\UriProcessor;
3
4			class XML2Array
5			{
6			/**
7			* @var string
8			*/
9			private static $encoding = 'UTF-8';
10			/**
11			* @var \DOMDocument
12			*/
13			private static $xml = null;
14			/**
15			* Convert an XML to Array.
16			*
17			* @param string $input_xml
18			*
19			* @return array
20			*
21			* @throws \Exception
22			*/
23			public static function createArray($input_xml)
24			{
25			if (empty($input_xml)) {
26			return [];
27			}
28			$xml = self::getXMLRoot();
29			if (is_string($input_xml)) {
30			try {
31			$xml->loadXML($input_xml);
			0 ignored issues – show Security XML Injection introduced 2016-12-20 11:29 UTC by Report Bug Copy Issue Report `$input_xml` can contain request data and is used in xml context(s) leading to a potential security vulnerability. 8 paths for user data to reach this point 1. Path: `$this->parameters['HTTP_AUTHORIZATION']` seems to return tainted data, and `$authorizationHeader` is assigned in ServerBag.php on line 62 `$this->parameters['HTTP_AUTHORIZATION']` seems to return tainted data, and `$authorizationHeader` is assigned in vendor/ServerBag.php on line 62 ParameterBag::$parameters is assigned in vendor/ServerBag.php on line 77 Tainted property ParameterBag::$parameters is read in vendor/ParameterBag.php on line 45 ParameterBag::all() returns tainted data, and `$input` is assigned in vendor/Request.php on line 335 Request::input() returns tainted data, and `$this->input()` is passed through array_replace_recursive() in vendor/Request.php on line 323 Request::all() returns tainted data in src/POData/OperationContext/Web/Illuminate/IncomingIlluminateRequest.php on line 132 IncomingIlluminateRequest::getAllInput() returns tainted data, and RequestDescription::$_data is assigned in src/POData/UriProcessor/RequestDescription.php on line 282 Tainted property RequestDescription::$_data is read, and `$string` is assigned in src/POData/UriProcessor/RequestDescription.php on line 297 `$string` is passed to XML2Array::createArray() in src/POData/UriProcessor/RequestDescription.php on line 302 2. Path: Read from `$_POST,` and `$_POST` is passed to Request::createRequestFromFactory() in Request.php on line 281 Read from `$_POST,` and `$_POST` is passed to Request::createRequestFromFactory() in vendor/Request.php on line 281 `$request` is passed to Request::__construct() in vendor/Request.php on line 1945 `$request` is passed to Request::initialize() in vendor/Request.php on line 222 `$request` is passed to ParameterBag::__construct() in vendor/Request.php on line 240 ParameterBag::$parameters is assigned in vendor/ParameterBag.php on line 35 Tainted property ParameterBag::$parameters is read in vendor/ParameterBag.php on line 45 ParameterBag::all() returns tainted data, and `$input` is assigned in vendor/Request.php on line 335 Request::input() returns tainted data, and `$this->input()` is passed through array_replace_recursive() in vendor/Request.php on line 323 Request::all() returns tainted data in src/POData/OperationContext/Web/Illuminate/IncomingIlluminateRequest.php on line 132 IncomingIlluminateRequest::getAllInput() returns tainted data, and RequestDescription::$_data is assigned in src/POData/UriProcessor/RequestDescription.php on line 282 Tainted property RequestDescription::$_data is read, and `$string` is assigned in src/POData/UriProcessor/RequestDescription.php on line 297 `$string` is passed to XML2Array::createArray() in src/POData/UriProcessor/RequestDescription.php on line 302 3. Path: Read from `$_SERVER,` and `$server` is assigned in Request.php on line 271 Read from `$_SERVER,` and `$server` is assigned in vendor/Request.php on line 271 `$server` is passed to Request::createRequestFromFactory() in vendor/Request.php on line 281 `$server` is passed to Request::__construct() in vendor/Request.php on line 1945 `$server` is passed to Request::initialize() in vendor/Request.php on line 222 `$server` is passed to ParameterBag::__construct() in vendor/Request.php on line 245 ParameterBag::$parameters is assigned in vendor/ParameterBag.php on line 35 Tainted property ParameterBag::$parameters is read in vendor/ParameterBag.php on line 45 ParameterBag::all() returns tainted data, and `$input` is assigned in vendor/Request.php on line 335 Request::input() returns tainted data, and `$this->input()` is passed through array_replace_recursive() in vendor/Request.php on line 323 Request::all() returns tainted data in src/POData/OperationContext/Web/Illuminate/IncomingIlluminateRequest.php on line 132 IncomingIlluminateRequest::getAllInput() returns tainted data, and RequestDescription::$_data is assigned in src/POData/UriProcessor/RequestDescription.php on line 282 Tainted property RequestDescription::$_data is read, and `$string` is assigned in src/POData/UriProcessor/RequestDescription.php on line 297 `$string` is passed to XML2Array::createArray() in src/POData/UriProcessor/RequestDescription.php on line 302 4. Path: Fetching key `HTTP_CONTENT_LENGTH` from `$_SERVER,` and `$server` is assigned in Request.php on line 274 Fetching key `HTTP_CONTENT_LENGTH` from `$_SERVER,` and `$server` is assigned in vendor/Request.php on line 274 `$server` is passed to Request::createRequestFromFactory() in vendor/Request.php on line 281 `$server` is passed to Request::__construct() in vendor/Request.php on line 1945 `$server` is passed to Request::initialize() in vendor/Request.php on line 222 `$server` is passed to ParameterBag::__construct() in vendor/Request.php on line 245 ParameterBag::$parameters is assigned in vendor/ParameterBag.php on line 35 Tainted property ParameterBag::$parameters is read in vendor/ParameterBag.php on line 45 ParameterBag::all() returns tainted data, and `$input` is assigned in vendor/Request.php on line 335 Request::input() returns tainted data, and `$this->input()` is passed through array_replace_recursive() in vendor/Request.php on line 323 Request::all() returns tainted data in src/POData/OperationContext/Web/Illuminate/IncomingIlluminateRequest.php on line 132 IncomingIlluminateRequest::getAllInput() returns tainted data, and RequestDescription::$_data is assigned in src/POData/UriProcessor/RequestDescription.php on line 282 Tainted property RequestDescription::$_data is read, and `$string` is assigned in src/POData/UriProcessor/RequestDescription.php on line 297 `$string` is passed to XML2Array::createArray() in src/POData/UriProcessor/RequestDescription.php on line 302 5. Path: Fetching key `HTTP_CONTENT_TYPE` from `$_SERVER,` and `$server` is assigned in Request.php on line 277 Fetching key `HTTP_CONTENT_TYPE` from `$_SERVER,` and `$server` is assigned in vendor/Request.php on line 277 `$server` is passed to Request::createRequestFromFactory() in vendor/Request.php on line 281 `$server` is passed to Request::__construct() in vendor/Request.php on line 1945 `$server` is passed to Request::initialize() in vendor/Request.php on line 222 `$server` is passed to ParameterBag::__construct() in vendor/Request.php on line 245 ParameterBag::$parameters is assigned in vendor/ParameterBag.php on line 35 Tainted property ParameterBag::$parameters is read in vendor/ParameterBag.php on line 45 ParameterBag::all() returns tainted data, and `$input` is assigned in vendor/Request.php on line 335 Request::input() returns tainted data, and `$this->input()` is passed through array_replace_recursive() in vendor/Request.php on line 323 Request::all() returns tainted data in src/POData/OperationContext/Web/Illuminate/IncomingIlluminateRequest.php on line 132 IncomingIlluminateRequest::getAllInput() returns tainted data, and RequestDescription::$_data is assigned in src/POData/UriProcessor/RequestDescription.php on line 282 Tainted property RequestDescription::$_data is read, and `$string` is assigned in src/POData/UriProcessor/RequestDescription.php on line 297 `$string` is passed to XML2Array::createArray() in src/POData/UriProcessor/RequestDescription.php on line 302 6. Path: `$server['HTTP_HOST']` seems to return tainted data, and `$server` is assigned in Request.php on line 347 `$server['HTTP_HOST']` seems to return tainted data, and `$server` is assigned in vendor/Request.php on line 347 `$server` is assigned in vendor/Request.php on line 395 `$server` is assigned in vendor/Request.php on line 396 `$server` is passed to Request::createRequestFromFactory() in vendor/Request.php on line 398 `$server` is passed to Request::__construct() in vendor/Request.php on line 1945 `$server` is passed to Request::initialize() in vendor/Request.php on line 222 `$server` is passed to ParameterBag::__construct() in vendor/Request.php on line 245 ParameterBag::$parameters is assigned in vendor/ParameterBag.php on line 35 Tainted property ParameterBag::$parameters is read in vendor/ParameterBag.php on line 45 ParameterBag::all() returns tainted data, and `$input` is assigned in vendor/Request.php on line 335 Request::input() returns tainted data, and `$this->input()` is passed through array_replace_recursive() in vendor/Request.php on line 323 Request::all() returns tainted data in src/POData/OperationContext/Web/Illuminate/IncomingIlluminateRequest.php on line 132 IncomingIlluminateRequest::getAllInput() returns tainted data, and RequestDescription::$_data is assigned in src/POData/UriProcessor/RequestDescription.php on line 282 Tainted property RequestDescription::$_data is read, and `$string` is assigned in src/POData/UriProcessor/RequestDescription.php on line 297 `$string` is passed to XML2Array::createArray() in src/POData/UriProcessor/RequestDescription.php on line 302 7. Path: `$this->parameters['PHP_AUTH_USER']` seems to return tainted data, and `$headers` is assigned in ServerBag.php on line 43 `$this->parameters['PHP_AUTH_USER']` seems to return tainted data, and `$headers` is assigned in vendor/ServerBag.php on line 43 `$headers` is assigned in vendor/ServerBag.php on line 44 ServerBag::getHeaders() returns tainted data, and `$this->server->getHeaders()` is passed to HeaderBag::__construct() in vendor/Request.php on line 246 `$values` is assigned in vendor/HeaderBag.php on line 31 `$values` is passed to HeaderBag::set() in vendor/HeaderBag.php on line 32 `(array) $values` is passed through array_values(), and `$values` is assigned in vendor/HeaderBag.php on line 142 HeaderBag::$headers is assigned in vendor/HeaderBag.php on line 145 Tainted property HeaderBag::$headers is read in vendor/HeaderBag.php on line 125 HeaderBag::get() returns tainted data, and `$requestUri` is assigned in vendor/Request.php on line 1715 `$requestUri` is passed to ParameterBag::set() in vendor/Request.php on line 1746 ParameterBag::$parameters is assigned in vendor/ParameterBag.php on line 99 Tainted property ParameterBag::$parameters is read in vendor/ParameterBag.php on line 45 ParameterBag::all() returns tainted data, and `$input` is assigned in vendor/Request.php on line 335 Request::input() returns tainted data, and `$this->input()` is passed through array_replace_recursive() in vendor/Request.php on line 323 Request::all() returns tainted data in src/POData/OperationContext/Web/Illuminate/IncomingIlluminateRequest.php on line 132 IncomingIlluminateRequest::getAllInput() returns tainted data, and RequestDescription::$_data is assigned in src/POData/UriProcessor/RequestDescription.php on line 282 Tainted property RequestDescription::$_data is read, and `$string` is assigned in src/POData/UriProcessor/RequestDescription.php on line 297 `$string` is passed to XML2Array::createArray() in src/POData/UriProcessor/RequestDescription.php on line 302 8. Path: `$this->parameters['PHP_AUTH_PW']` seems to return tainted data, and `$headers` is assigned in ServerBag.php on line 44 `$this->parameters['PHP_AUTH_PW']` seems to return tainted data, and `$headers` is assigned in vendor/ServerBag.php on line 44 ServerBag::getHeaders() returns tainted data, and `$this->server->getHeaders()` is passed to HeaderBag::__construct() in vendor/Request.php on line 246 `$values` is assigned in vendor/HeaderBag.php on line 31 `$values` is passed to HeaderBag::set() in vendor/HeaderBag.php on line 32 `(array) $values` is passed through array_values(), and `$values` is assigned in vendor/HeaderBag.php on line 142 HeaderBag::$headers is assigned in vendor/HeaderBag.php on line 145 Tainted property HeaderBag::$headers is read in vendor/HeaderBag.php on line 125 HeaderBag::get() returns tainted data, and `$requestUri` is assigned in vendor/Request.php on line 1715 `$requestUri` is passed to ParameterBag::set() in vendor/Request.php on line 1746 ParameterBag::$parameters is assigned in vendor/ParameterBag.php on line 99 Tainted property ParameterBag::$parameters is read in vendor/ParameterBag.php on line 45 ParameterBag::all() returns tainted data, and `$input` is assigned in vendor/Request.php on line 335 Request::input() returns tainted data, and `$this->input()` is passed through array_replace_recursive() in vendor/Request.php on line 323 Request::all() returns tainted data in src/POData/OperationContext/Web/Illuminate/IncomingIlluminateRequest.php on line 132 IncomingIlluminateRequest::getAllInput() returns tainted data, and RequestDescription::$_data is assigned in src/POData/UriProcessor/RequestDescription.php on line 282 Tainted property RequestDescription::$_data is read, and `$string` is assigned in src/POData/UriProcessor/RequestDescription.php on line 297 `$string` is passed to XML2Array::createArray() in src/POData/UriProcessor/RequestDescription.php on line 302 Preventing XML Injection Attacks If you pass user-data to XML parsing functions like `simplexml_load_string()`, this can be abused to inject external entities to gain access to the contents of any file in your filesystem, or it can be used to freeze your PHP process with an entity expansion attack. In order to prevent that, make sure to disable external entity loading and disallow custom doc-types: libxml_disable_entity_loader(true); $dom = new DOMDocument; $dom->loadXML($taintedXml); foreach ($dom->childNodes as $child) { if ($child->nodeType === XML_DOCUMENT_TYPE_NODE) { throw new InvalidArgumentException( 'Invalid XML: Detected use of illegal DOCTYPE' ); } } // It is now safe to use $taintedXml $xml = simplexml_load_string($taintedXml); General Strategies to prevent injection In general, it is advisable to prevent any user-data to reach this point. This can be done by white-listing certain values: if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) { throw new \InvalidArgumentException('This input is not allowed.'); } For numeric data, we recommend to explicitly cast the data: $sanitized = (integer) $tainted; Loading history...
32			if (!is_object($xml) \|\| empty($xml->documentElement)) {
33			throw new \Exception();
34			}
35			} catch (\Exception $ex) {
36			throw new \Exception('[XML2Array] Error parsing the XML string.' . PHP_EOL . $ex->getMessage());
37			}
38			} elseif (is_object($input_xml)) {
39			if (get_class($input_xml) != 'DOMDocument') {
40			throw new \Exception('[XML2Array] The input XML object should be of type: DOMDocument.');
41			}
42			$xml = self::$xml = $input_xml;
43			} else {
44			throw new \Exception('[XML2Array] Invalid input');
45			}
46			$array[$xml->documentElement->tagName] = self::convert($xml->documentElement);
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-04 10:20 UTC by Report Bug Copy Issue Report `$array` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$array = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
47			self::$xml = null; // clear the xml node in the class for 2nd time use.
48			return $array;
49			}
50			/**
51			* Initialize the root XML node [optional].
52			*
53			* @param string $version
54			* @param string $encoding
55			* @param bool $standalone
56			* @param bool $format_output
57			*/
58			public static function init($version = '1.0', $encoding = 'utf-8', $standalone = false, $format_output = true)
59			{
60			self::$xml = new \DomDocument($version, $encoding);
61			self::$xml->xmlStandalone = $standalone;
62			self::$xml->formatOutput = $format_output;
63			self::$encoding = $encoding;
64			}
65			/**
66			* Convert an Array to XML.
67			*
68			* @param \DOMNode $node - XML as a string or as an object of DOMDocument
69			*
70			* @return array
71			*/
72			private static function convert(\DOMNode $node)
73			{
74			$output = [];
75			switch ($node->nodeType) {
76			case XML_CDATA_SECTION_NODE:
77			$output['@cdata'] = trim($node->textContent);
78			break;
79			case XML_TEXT_NODE:
80			$output = trim($node->textContent);
81			break;
82			case XML_ELEMENT_NODE:
83			// for each child node, call the covert function recursively
84			for ($i = 0, $m = $node->childNodes->length; $i < $m; ++$i) {
85			$child = $node->childNodes->item($i);
86			$v = self::convert($child);
87			if (isset($child->tagName)) {
88			$t = $child->tagName;
89			// assume more nodes of same kind are coming
90			if (!array_key_exists($t, $output)) {
91			$output[$t] = [];
92			}
93			$output[$t][] = $v;
94			} else {
95			//check if it is not an empty node
96			if (!empty($v)) {
97			$output = $v;
98			}
99			}
100			}
101			if (is_array($output)) {
102			// if only one node of its kind, assign it directly instead if array($value);
103			foreach ($output as $t => $v) {
104			if (is_array($v) && count($v) == 1) {
105			$output[$t] = $v[0];
106			}
107			}
108			if (empty($output)) {
109			//for empty nodes
110			$output = '';
111			}
112			}
113			// loop through the attributes and collect them
114			if ($node->attributes->length) {
			1 ignored issue – show Bug introduced 2016-11-05 11:21 UTC by Report Bug Copy Issue Report The property `length` does not seem to exist in `DOMNamedNodeMap`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
115			$a = [];
116			foreach ($node->attributes as $attrName => $attrNode) {
117			$a[$attrName] = $attrNode->value;
118			}
119			// if its an leaf node, store the value in @value instead of directly storing it.
120			if (!is_array($output)) {
121			$output = ['@value' => $output];
122			}
123			$output['@attributes'] = $a;
124			}
125			break;
126			}
127			return $output;
128			}
129			/**
130			* Get the root XML node, if there isn't one, create it.
131			*
132			* @return \DOMDocument
133			*/
134			private static function getXMLRoot()
135			{
136			if (empty(self::$xml)) {
137			self::init();
138			}
139			return self::$xml;
140			}
141			}
142

Algo-Web / POData

Push — master ( 94203c...087b47 )

XML2Array::convert() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

8 paths for user data to reach this point

Preventing XML Injection Attacks

General Strategies to prevent injection

Duplication Side-by-Side

Filter issues like