InfoParser::isNavigationItem() - Code Metrics - Inspection of "Merge pull request #14343 from nextcloud/bugfix/14..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3459ff...e5cacc )

by Morris

created 2019-02-27 15:08 UTC

InfoParser::isNavigationItem() A

↳ Parent: InfoParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 * @copyright Copyright (c) 2016, Lukas Reschke <[email protected]>
 *
 * @author Andreas Fischer <[email protected]>
 * @author Arthur Schiwon <[email protected]>
 * @author Christoph Wurst <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Thomas Müller <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\App;

use OCP\ICache;

class InfoParser {
	/** @var \OCP\ICache|null */
	private $cache;

	/**
	 * @param ICache|null $cache
	 */
	public function __construct(ICache $cache = null) {
		$this->cache = $cache;
	}

	/**
	 * @param string $file the xml file to be loaded
	 * @return null|array where null is an indicator for an error
	 */
	public function parse($file) {
		if (!file_exists($file)) {
			return null;
		}

		if ($this->cache !== null) {
			$fileCacheKey = $file . filemtime($file);
			if ($cachedValue = $this->cache->get($fileCacheKey)) {
				return json_decode($cachedValue, true);
			}
		}

		libxml_use_internal_errors(true);
		$loadEntities = libxml_disable_entity_loader(false);
		$xml = simplexml_load_file($file);

		libxml_disable_entity_loader($loadEntities);
		if ($xml === false) {
			libxml_clear_errors();
			return null;
		}
		$array = $this->xmlToArray($xml);

		if (is_null($array)) {

			return null;
		}

		if (!array_key_exists('info', $array)) {
			$array['info'] = [];
		}
		if (!array_key_exists('remote', $array)) {
			$array['remote'] = [];
		}
		if (!array_key_exists('public', $array)) {
			$array['public'] = [];
		}
		if (!array_key_exists('types', $array)) {
			$array['types'] = [];
		}
		if (!array_key_exists('repair-steps', $array)) {
			$array['repair-steps'] = [];
		}
		if (!array_key_exists('install', $array['repair-steps'])) {
			$array['repair-steps']['install'] = [];
		}
		if (!array_key_exists('pre-migration', $array['repair-steps'])) {
			$array['repair-steps']['pre-migration'] = [];
		}
		if (!array_key_exists('post-migration', $array['repair-steps'])) {
			$array['repair-steps']['post-migration'] = [];
		}
		if (!array_key_exists('live-migration', $array['repair-steps'])) {
			$array['repair-steps']['live-migration'] = [];
		}
		if (!array_key_exists('uninstall', $array['repair-steps'])) {
			$array['repair-steps']['uninstall'] = [];
		}
		if (!array_key_exists('background-jobs', $array)) {
			$array['background-jobs'] = [];
		}
		if (!array_key_exists('two-factor-providers', $array)) {
			$array['two-factor-providers'] = [];
		}
		if (!array_key_exists('commands', $array)) {
			$array['commands'] = [];
		}
		if (!array_key_exists('activity', $array)) {
			$array['activity'] = [];
		}
		if (!array_key_exists('filters', $array['activity'])) {
			$array['activity']['filters'] = [];
		}
		if (!array_key_exists('settings', $array['activity'])) {
			$array['activity']['settings'] = [];
		}
		if (!array_key_exists('providers', $array['activity'])) {
			$array['activity']['providers'] = [];
		}
		if (!array_key_exists('settings', $array)) {
			$array['settings'] = [];
		}
		if (!array_key_exists('admin', $array['settings'])) {
			$array['settings']['admin'] = [];
		}
		if (!array_key_exists('admin-section', $array['settings'])) {
			$array['settings']['admin-section'] = [];
		}
		if (!array_key_exists('personal', $array['settings'])) {
			$array['settings']['personal'] = [];
		}
		if (!array_key_exists('personal-section', $array['settings'])) {
			$array['settings']['personal-section'] = [];
		}

		if (array_key_exists('types', $array)) {
			if (is_array($array['types'])) {
				foreach ($array['types'] as $type => $v) {
					unset($array['types'][$type]);
					if (is_string($type)) {
						$array['types'][] = $type;
					}
				}
			} else {
				$array['types'] = [];
			}
		}
		if (isset($array['repair-steps']['install']['step']) && is_array($array['repair-steps']['install']['step'])) {
			$array['repair-steps']['install'] = $array['repair-steps']['install']['step'];
		}
		if (isset($array['repair-steps']['pre-migration']['step']) && is_array($array['repair-steps']['pre-migration']['step'])) {
			$array['repair-steps']['pre-migration'] = $array['repair-steps']['pre-migration']['step'];
		}
		if (isset($array['repair-steps']['post-migration']['step']) && is_array($array['repair-steps']['post-migration']['step'])) {
			$array['repair-steps']['post-migration'] = $array['repair-steps']['post-migration']['step'];
		}
		if (isset($array['repair-steps']['live-migration']['step']) && is_array($array['repair-steps']['live-migration']['step'])) {
			$array['repair-steps']['live-migration'] = $array['repair-steps']['live-migration']['step'];
		}
		if (isset($array['repair-steps']['uninstall']['step']) && is_array($array['repair-steps']['uninstall']['step'])) {
			$array['repair-steps']['uninstall'] = $array['repair-steps']['uninstall']['step'];
		}
		if (isset($array['background-jobs']['job']) && is_array($array['background-jobs']['job'])) {
			$array['background-jobs'] = $array['background-jobs']['job'];
		}
		if (isset($array['commands']['command']) && is_array($array['commands']['command'])) {
			$array['commands'] = $array['commands']['command'];
		}
		if (isset($array['two-factor-providers']['provider']) && is_array($array['two-factor-providers']['provider'])) {
			$array['two-factor-providers'] = $array['two-factor-providers']['provider'];
		}
		if (isset($array['activity']['filters']['filter']) && is_array($array['activity']['filters']['filter'])) {
			$array['activity']['filters'] = $array['activity']['filters']['filter'];
		}
		if (isset($array['activity']['settings']['setting']) && is_array($array['activity']['settings']['setting'])) {
			$array['activity']['settings'] = $array['activity']['settings']['setting'];
		}
		if (isset($array['activity']['providers']['provider']) && is_array($array['activity']['providers']['provider'])) {
			$array['activity']['providers'] = $array['activity']['providers']['provider'];
		}
		if (isset($array['collaboration']['collaborators']['searchPlugins']['searchPlugin'])
			&& is_array($array['collaboration']['collaborators']['searchPlugins']['searchPlugin'])
			&& !isset($array['collaboration']['collaborators']['searchPlugins']['searchPlugin']['class'])
		) {
			$array['collaboration']['collaborators']['searchPlugins'] = $array['collaboration']['collaborators']['searchPlugins']['searchPlugin'];
		}
		if (isset($array['settings']['admin']) && !is_array($array['settings']['admin'])) {
			$array['settings']['admin'] = [$array['settings']['admin']];
		}
		if (isset($array['settings']['admin-section']) && !is_array($array['settings']['admin-section'])) {
			$array['settings']['admin-section'] = [$array['settings']['admin-section']];
		}
		if (isset($array['settings']['personal']) && !is_array($array['settings']['personal'])) {
			$array['settings']['personal'] = [$array['settings']['personal']];
		}
		if (isset($array['settings']['personal-section']) && !is_array($array['settings']['personal-section'])) {
			$array['settings']['personal-section'] = [$array['settings']['personal-section']];
		}

		if (isset($array['navigations']['navigation']) && $this->isNavigationItem($array['navigations']['navigation'])) {
			$array['navigations']['navigation'] = [$array['navigations']['navigation']];
		}

		if ($this->cache !== null) {
			$this->cache->set($fileCacheKey, json_encode($array));

		}
		return $array;
	}

	/**
	 * @param $data
	 * @return bool
	 */
	private function isNavigationItem($data): bool {
		return isset($data['name'], $data['route']);
	}

	/**
	 * @param \SimpleXMLElement $xml
	 * @return array
	 */
	public function xmlToArray($xml) {
		if (!$xml->children()) {
			return (string)$xml;

		}

		$array = [];
		foreach ($xml->children() as $element => $node) {
			$totalElement = count($xml->{$element});

			if (!isset($array[$element])) {
				$array[$element] = $totalElement > 1 ? [] : "";
			}
			/** @var \SimpleXMLElement $node */
			// Has attributes
			if ($attributes = $node->attributes()) {
				$data = [
					'@attributes' => [],
				];
				if (!count($node->children())){
					$value = (string)$node;
					if (!empty($value)) {
						$data['@value'] = (string)$node;
					}
				} else {
					$data = array_merge($data, $this->xmlToArray($node));
				}
				foreach ($attributes as $attr => $value) {
					$data['@attributes'][$attr] = (string)$value;
				}

				if ($totalElement > 1) {
					$array[$element][] = $data;
				} else {
					$array[$element] = $data;
				}
				// Just a value
			} else {
				if ($totalElement > 1) {
					$array[$element][] = $this->xmlToArray($node);
				} else {
					$array[$element] = $this->xmlToArray($node);
				}
			}
		}

		return $array;
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016, ownCloud, Inc.
4			* @copyright Copyright (c) 2016, Lukas Reschke <[email protected]>
5			*
6			* @author Andreas Fischer <[email protected]>
7			* @author Arthur Schiwon <[email protected]>
8			* @author Christoph Wurst <[email protected]>
9			* @author Joas Schilling <[email protected]>
10			* @author Lukas Reschke <[email protected]>
11			* @author Morris Jobke <[email protected]>
12			* @author Roeland Jago Douma <[email protected]>
13			* @author Thomas Müller <[email protected]>
14			*
15			* @license AGPL-3.0
16			*
17			* This code is free software: you can redistribute it and/or modify
18			* it under the terms of the GNU Affero General Public License, version 3,
19			* as published by the Free Software Foundation.
20			*
21			* This program is distributed in the hope that it will be useful,
22			* but WITHOUT ANY WARRANTY; without even the implied warranty of
23			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24			* GNU Affero General Public License for more details.
25			*
26			* You should have received a copy of the GNU Affero General Public License, version 3,
27			* along with this program. If not, see <http://www.gnu.org/licenses/>
28			*
29			*/
30
31			namespace OC\App;
32
33			use OCP\ICache;
34
35			class InfoParser {
36			/** @var \OCP\ICache\|null */
37			private $cache;
38
39			/**
40			* @param ICache\|null $cache
41			*/
42			public function __construct(ICache $cache = null) {
43			$this->cache = $cache;
44			}
45
46			/**
47			* @param string $file the xml file to be loaded
48			* @return null\|array where null is an indicator for an error
49			*/
50			public function parse($file) {
51			if (!file_exists($file)) {
52			return null;
53			}
54
55			if ($this->cache !== null) {
56			$fileCacheKey = $file . filemtime($file);
57			if ($cachedValue = $this->cache->get($fileCacheKey)) {
58			return json_decode($cachedValue, true);
59			}
60			}
61
62			libxml_use_internal_errors(true);
63			$loadEntities = libxml_disable_entity_loader(false);
64			$xml = simplexml_load_file($file);
65
66			libxml_disable_entity_loader($loadEntities);
67			if ($xml === false) {
68			libxml_clear_errors();
69			return null;
70			}
71			$array = $this->xmlToArray($xml);
72
73			if (is_null($array)) {
			0 ignored issues – show introduced 2018-10-24 12:40 UTC by Report Bug Copy Issue Report The condition `is_null($array)` is always `false`. Loading history...
74			return null;
75			}
76
77			if (!array_key_exists('info', $array)) {
78			$array['info'] = [];
79			}
80			if (!array_key_exists('remote', $array)) {
81			$array['remote'] = [];
82			}
83			if (!array_key_exists('public', $array)) {
84			$array['public'] = [];
85			}
86			if (!array_key_exists('types', $array)) {
87			$array['types'] = [];
88			}
89			if (!array_key_exists('repair-steps', $array)) {
90			$array['repair-steps'] = [];
91			}
92			if (!array_key_exists('install', $array['repair-steps'])) {
93			$array['repair-steps']['install'] = [];
94			}
95			if (!array_key_exists('pre-migration', $array['repair-steps'])) {
96			$array['repair-steps']['pre-migration'] = [];
97			}
98			if (!array_key_exists('post-migration', $array['repair-steps'])) {
99			$array['repair-steps']['post-migration'] = [];
100			}
101			if (!array_key_exists('live-migration', $array['repair-steps'])) {
102			$array['repair-steps']['live-migration'] = [];
103			}
104			if (!array_key_exists('uninstall', $array['repair-steps'])) {
105			$array['repair-steps']['uninstall'] = [];
106			}
107			if (!array_key_exists('background-jobs', $array)) {
108			$array['background-jobs'] = [];
109			}
110			if (!array_key_exists('two-factor-providers', $array)) {
111			$array['two-factor-providers'] = [];
112			}
113			if (!array_key_exists('commands', $array)) {
114			$array['commands'] = [];
115			}
116			if (!array_key_exists('activity', $array)) {
117			$array['activity'] = [];
118			}
119			if (!array_key_exists('filters', $array['activity'])) {
120			$array['activity']['filters'] = [];
121			}
122			if (!array_key_exists('settings', $array['activity'])) {
123			$array['activity']['settings'] = [];
124			}
125			if (!array_key_exists('providers', $array['activity'])) {
126			$array['activity']['providers'] = [];
127			}
128			if (!array_key_exists('settings', $array)) {
129			$array['settings'] = [];
130			}
131			if (!array_key_exists('admin', $array['settings'])) {
132			$array['settings']['admin'] = [];
133			}
134			if (!array_key_exists('admin-section', $array['settings'])) {
135			$array['settings']['admin-section'] = [];
136			}
137			if (!array_key_exists('personal', $array['settings'])) {
138			$array['settings']['personal'] = [];
139			}
140			if (!array_key_exists('personal-section', $array['settings'])) {
141			$array['settings']['personal-section'] = [];
142			}
143
144			if (array_key_exists('types', $array)) {
145			if (is_array($array['types'])) {
146			foreach ($array['types'] as $type => $v) {
147			unset($array['types'][$type]);
148			if (is_string($type)) {
149			$array['types'][] = $type;
150			}
151			}
152			} else {
153			$array['types'] = [];
154			}
155			}
156			if (isset($array['repair-steps']['install']['step']) && is_array($array['repair-steps']['install']['step'])) {
157			$array['repair-steps']['install'] = $array['repair-steps']['install']['step'];
158			}
159			if (isset($array['repair-steps']['pre-migration']['step']) && is_array($array['repair-steps']['pre-migration']['step'])) {
160			$array['repair-steps']['pre-migration'] = $array['repair-steps']['pre-migration']['step'];
161			}
162			if (isset($array['repair-steps']['post-migration']['step']) && is_array($array['repair-steps']['post-migration']['step'])) {
163			$array['repair-steps']['post-migration'] = $array['repair-steps']['post-migration']['step'];
164			}
165			if (isset($array['repair-steps']['live-migration']['step']) && is_array($array['repair-steps']['live-migration']['step'])) {
166			$array['repair-steps']['live-migration'] = $array['repair-steps']['live-migration']['step'];
167			}
168			if (isset($array['repair-steps']['uninstall']['step']) && is_array($array['repair-steps']['uninstall']['step'])) {
169			$array['repair-steps']['uninstall'] = $array['repair-steps']['uninstall']['step'];
170			}
171			if (isset($array['background-jobs']['job']) && is_array($array['background-jobs']['job'])) {
172			$array['background-jobs'] = $array['background-jobs']['job'];
173			}
174			if (isset($array['commands']['command']) && is_array($array['commands']['command'])) {
175			$array['commands'] = $array['commands']['command'];
176			}
177			if (isset($array['two-factor-providers']['provider']) && is_array($array['two-factor-providers']['provider'])) {
178			$array['two-factor-providers'] = $array['two-factor-providers']['provider'];
179			}
180			if (isset($array['activity']['filters']['filter']) && is_array($array['activity']['filters']['filter'])) {
181			$array['activity']['filters'] = $array['activity']['filters']['filter'];
182			}
183			if (isset($array['activity']['settings']['setting']) && is_array($array['activity']['settings']['setting'])) {
184			$array['activity']['settings'] = $array['activity']['settings']['setting'];
185			}
186			if (isset($array['activity']['providers']['provider']) && is_array($array['activity']['providers']['provider'])) {
187			$array['activity']['providers'] = $array['activity']['providers']['provider'];
188			}
189			if (isset($array['collaboration']['collaborators']['searchPlugins']['searchPlugin'])
190			&& is_array($array['collaboration']['collaborators']['searchPlugins']['searchPlugin'])
191			&& !isset($array['collaboration']['collaborators']['searchPlugins']['searchPlugin']['class'])
192			) {
193			$array['collaboration']['collaborators']['searchPlugins'] = $array['collaboration']['collaborators']['searchPlugins']['searchPlugin'];
194			}
195			if (isset($array['settings']['admin']) && !is_array($array['settings']['admin'])) {
196			$array['settings']['admin'] = [$array['settings']['admin']];
197			}
198			if (isset($array['settings']['admin-section']) && !is_array($array['settings']['admin-section'])) {
199			$array['settings']['admin-section'] = [$array['settings']['admin-section']];
200			}
201			if (isset($array['settings']['personal']) && !is_array($array['settings']['personal'])) {
202			$array['settings']['personal'] = [$array['settings']['personal']];
203			}
204			if (isset($array['settings']['personal-section']) && !is_array($array['settings']['personal-section'])) {
205			$array['settings']['personal-section'] = [$array['settings']['personal-section']];
206			}
207
208			if (isset($array['navigations']['navigation']) && $this->isNavigationItem($array['navigations']['navigation'])) {
209			$array['navigations']['navigation'] = [$array['navigations']['navigation']];
210			}
211
212			if ($this->cache !== null) {
213			$this->cache->set($fileCacheKey, json_encode($array));
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-10-24 12:40 UTC by Report Bug Copy Issue Report The variable `$fileCacheKey` does not seem to be defined for all execution paths leading up to this point. Loading history...
214			}
215			return $array;
216			}
217
218			/**
219			* @param $data
220			* @return bool
221			*/
222			private function isNavigationItem($data): bool {
223			return isset($data['name'], $data['route']);
224			}
225
226			/**
227			* @param \SimpleXMLElement $xml
228			* @return array
229			*/
230			public function xmlToArray($xml) {
231			if (!$xml->children()) {
232			return (string)$xml;
			0 ignored issues – show Bug Best Practice introduced 2018-10-24 12:40 UTC by Report Bug Copy Issue Report The expression `return (string)$xml` returns the type `string` which is incompatible with the documented return type `array`. Loading history...
233			}
234
235			$array = [];
236			foreach ($xml->children() as $element => $node) {
237			$totalElement = count($xml->{$element});
238
239			if (!isset($array[$element])) {
240			$array[$element] = $totalElement > 1 ? [] : "";
241			}
242			/** @var \SimpleXMLElement $node */
243			// Has attributes
244			if ($attributes = $node->attributes()) {
245			$data = [
246			'@attributes' => [],
247			];
248			if (!count($node->children())){
249			$value = (string)$node;
250			if (!empty($value)) {
251			$data['@value'] = (string)$node;
252			}
253			} else {
254			$data = array_merge($data, $this->xmlToArray($node));
255			}
256			foreach ($attributes as $attr => $value) {
257			$data['@attributes'][$attr] = (string)$value;
258			}
259
260			if ($totalElement > 1) {
261			$array[$element][] = $data;
262			} else {
263			$array[$element] = $data;
264			}
265			// Just a value
266			} else {
267			if ($totalElement > 1) {
268			$array[$element][] = $this->xmlToArray($node);
269			} else {
270			$array[$element] = $this->xmlToArray($node);
271			}
272			}
273			}
274
275			return $array;
276			}
277			}
278

nextcloud / server

Push — master ( 3459ff...e5cacc )

InfoParser::isNavigationItem() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like