Locator::getSignature() - Code Metrics - Inspection of "Merge pull request #522 from owncloud/feature/499" - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( af50b6...d203e3 )

by Victor

created 2019-10-10 09:30 UTC

Locator::getSignature() A

↳ Parent: Locator

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	0
cts	8
cp	0
rs	9.9
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	12

<?php
/**
 * @author Victor Dubiniuk <[email protected]>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @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 Owncloud\Updater\Utils;

use \Owncloud\Updater\Console\Application;

/**
 * Class Locator
 *
 * @package Owncloud\Updater\Utils
 */
class Locator {

	/**
	 * absolute path to ownCloud root
	 * @var string
	 */
	protected $ownCloudRootPath;

	/**
	 * absolute path to updater root
	 * @var string
	 */
	protected $updaterRootPath;

	/**
	 *
	 * @param string $baseDir
	 */
	public function __construct($baseDir){
		$this->updaterRootPath = $baseDir;
		$this->ownCloudRootPath = dirname($baseDir);
	}

	/**
	 * @return string
	 */
	public function getOwnCloudRootPath(){
		return $this->ownCloudRootPath;
	}

	/**
	 * expected items in the core
	 * @return string[]
	 */
	public function getRootDirContent(){
		return [
			"3rdparty",
			"config",
			"core",
			"l10n",
			"lib",
			"ocm-provider",
			"ocs",
			"ocs-provider",
			"resources",
			"settings",
			".htaccess",
			".mailmap",
			".tag",
			".user.ini",
			"AUTHORS",
			"CHANGELOG.md",
			"console.php",
			"COPYING",
			"cron.php",
			"db_structure.xml",
			"index.html",
			"index.php",
			"indie.json",
			"occ",
			"public.php",
			"remote.php",
			"robots.txt",
			"status.php",
			"version.php",
		];
	}

	/**
	 * @return array
	 */
	public function getUpdaterContent(){
		return [
			'app',
			'application.php',
			'box.json',
			'composer.json',
			'composer.lock',
			'CHANGELOG.md',
			'CONTRIBUTING.md',
			'COPYING-AGPL',
			'index.php',
			'pub',
			'src',
			'vendor',
			'README.md',
			'.travis.yml',
			'.scrutinizer.yml',
			'nbproject',
		];
	}

	/**
	 * Get all files and directories in the OC root dir using signature.json as a source
	 *
	 * @param string $basePath
	 *
	 * @return array
	 */
	public function getRootDirItemsFromSignature($basePath) {
		$signature = $this->getSignature($basePath);
		$items = [];
		if (isset($signature['hashes'])) {
			$allItems = array_keys($signature['hashes']);
			foreach ($allItems as $k => $v) {
				// Get the part of the string before the first slash or entire string if there is no slash
				$allItems[$k] = strtok($v, '/');
			}
			$items = array_unique($allItems);
		}
		return $items;
	}

	/**
	 * Absolute path to core root dir content
	 * @return array
	 */
	public function getRootDirItems(){
		$items = $this->getRootDirContent();
		$items = array_map(
			function($item){ return $this->ownCloudRootPath . "/" . $item;	},
			$items
		);
		return $items;
	}

	/**
	 * Absolute path
	 * @return string
	 * @throws \Exception
	 */
	public function getDataDir(){
		$container = Application::$container;
		if (isset($container['utils.configReader']) && $container['utils.configReader']->getIsLoaded()){
			return $container['utils.configReader']->getByPath('system.datadirectory');
		}

		// Fallback case
		include $this->getPathToConfigFile();
		if (isset($CONFIG['datadirectory'])){

			return $CONFIG['datadirectory'];
		}

		// Something went wrong
		throw new \Exception('Unable to detect datadirectory');
	}

	/**
	 * Absolute path to updater root dir
	 * @return string
	 */
	public function getUpdaterBaseDir(){
		return $this->getDataDir() . '/updater-data';
	}

	/**
	 * Absolute path to create a core and apps backups
	 * @return string
	 */
	public function getCheckpointDir(){
		return $this->getUpdaterBaseDir() . '/checkpoint';
	}

	/**
	 * Absolute path to store downloaded packages
	 * @return string
	 */
	public function getDownloadBaseDir(){
		return $this->getUpdaterBaseDir() . '/download';
	}

	/**
	 * Absolute path to a temporary directory
	 * to extract downloaded packages into
	 * @return string
	 */
	public function getExtractionBaseDir(){
		 return $this->getUpdaterBaseDir() . "/_oc_upgrade";
	}

	/**
	 *
	 * @return string
	 */
	public function getPathToOccFile(){
		return $this->ownCloudRootPath . '/occ';
	}

	/**
	 *
	 * @return string
	 */
	public function getInstalledVersion(){
		include $this->getPathToVersionFile();

		/** @var $OC_Version string */
		return $OC_Version;

	}

	/**
	 *
	 * @return string
	 */
	public function getChannelFromVersionsFile(){
		include $this->getPathToVersionFile();

		/** @var $OC_Channel string */
		return $OC_Channel;

	}

	/**
	 *
	 * @return string
	 */
	public function getBuild(){
		include $this->getPathToVersionFile();

		/** @var $OC_Build string */
		return $OC_Build;

	}

	/**
	 * @return string
	 */
	public function getSecretFromConfig(){
		include $this->getPathToConfigFile();
		if (isset($CONFIG['updater.secret'])){

			return $CONFIG['updater.secret'];
		}
		return '';
	}

	/**
	 * @param string $filePostfix
	 * @return array
	 */
	public function getPathtoConfigFiles($filePostfix = 'config.php'){
		// Only config.php for now
		return [
			$this->ownCloudRootPath . '/config/' . $filePostfix
		];
	}

	/**
	 * @return string
	 */
	public function getPathToConfigFile(){
		return $this->ownCloudRootPath . '/config/config.php';
	}

	/**
	 *
	 * @return string
	 */
	public function getPathToVersionFile(){
		return $this->ownCloudRootPath . '/version.php';
	}

	/**
	 * @param string $rootPath
	 *
	 * @return array|mixed
	 */
	private function getSignature($rootPath) {
		$signature = [];
		$signaturePath = $rootPath . '/core/signature.json';
		if (is_file($signaturePath)) {
			$signature = \json_decode(file_get_contents($signaturePath), true);
			if (!is_array($signature)) {
				$signature = [];
			}
		}
		return $signature;
	}
}


1			<?php
2			/**
3			* @author Victor Dubiniuk <[email protected]>
4			*
5			* @copyright Copyright (c) 2015, ownCloud, Inc.
6			* @license AGPL-3.0
7			*
8			* This code is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU Affero General Public License, version 3,
10			* as published by the Free Software Foundation.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU Affero General Public License for more details.
16			*
17			* You should have received a copy of the GNU Affero General Public License, version 3,
18			* along with this program. If not, see <http://www.gnu.org/licenses/>
19			*
20			*/
21
22			namespace Owncloud\Updater\Utils;
23
24			use \Owncloud\Updater\Console\Application;
25
26			/**
27			* Class Locator
28			*
29			* @package Owncloud\Updater\Utils
30			*/
31			class Locator {
32
33			/**
34			* absolute path to ownCloud root
35			* @var string
36			*/
37			protected $ownCloudRootPath;
38
39			/**
40			* absolute path to updater root
41			* @var string
42			*/
43			protected $updaterRootPath;
44
45			/**
46			*
47			* @param string $baseDir
48			*/
49			public function __construct($baseDir){
50			$this->updaterRootPath = $baseDir;
51			$this->ownCloudRootPath = dirname($baseDir);
52			}
53
54			/**
55			* @return string
56			*/
57			public function getOwnCloudRootPath(){
58			return $this->ownCloudRootPath;
59			}
60
61			/**
62			* expected items in the core
63			* @return string[]
64			*/
65			public function getRootDirContent(){
66			return [
67			"3rdparty",
68			"config",
69			"core",
70			"l10n",
71			"lib",
72			"ocm-provider",
73			"ocs",
74			"ocs-provider",
75			"resources",
76			"settings",
77			".htaccess",
78			".mailmap",
79			".tag",
80			".user.ini",
81			"AUTHORS",
82			"CHANGELOG.md",
83			"console.php",
84			"COPYING",
85			"cron.php",
86			"db_structure.xml",
87			"index.html",
88			"index.php",
89			"indie.json",
90			"occ",
91			"public.php",
92			"remote.php",
93			"robots.txt",
94			"status.php",
95			"version.php",
96			];
97			}
98
99			/**
100			* @return array
101			*/
102			public function getUpdaterContent(){
103			return [
104			'app',
105			'application.php',
106			'box.json',
107			'composer.json',
108			'composer.lock',
109			'CHANGELOG.md',
110			'CONTRIBUTING.md',
111			'COPYING-AGPL',
112			'index.php',
113			'pub',
114			'src',
115			'vendor',
116			'README.md',
117			'.travis.yml',
118			'.scrutinizer.yml',
119			'nbproject',
120			];
121			}
122
123			/**
124			* Get all files and directories in the OC root dir using signature.json as a source
125			*
126			* @param string $basePath
127			*
128			* @return array
129			*/
130			public function getRootDirItemsFromSignature($basePath) {
131			$signature = $this->getSignature($basePath);
132			$items = [];
133			if (isset($signature['hashes'])) {
134			$allItems = array_keys($signature['hashes']);
135			foreach ($allItems as $k => $v) {
136			// Get the part of the string before the first slash or entire string if there is no slash
137			$allItems[$k] = strtok($v, '/');
138			}
139			$items = array_unique($allItems);
140			}
141			return $items;
142			}
143
144			/**
145			* Absolute path to core root dir content
146			* @return array
147			*/
148			public function getRootDirItems(){
149			$items = $this->getRootDirContent();
150			$items = array_map(
151			function($item){ return $this->ownCloudRootPath . "/" . $item; },
152			$items
153			);
154			return $items;
155			}
156
157			/**
158			* Absolute path
159			* @return string
160			* @throws \Exception
161			*/
162			public function getDataDir(){
163			$container = Application::$container;
164			if (isset($container['utils.configReader']) && $container['utils.configReader']->getIsLoaded()){
165			return $container['utils.configReader']->getByPath('system.datadirectory');
166			}
167
168			// Fallback case
169			include $this->getPathToConfigFile();
170			if (isset($CONFIG['datadirectory'])){
			0 ignored issues – show Bug introduced 2016-02-15 22:27 UTC by Report Bug Copy Issue Report The variable `$CONFIG` seems to never exist, and therefore `isset` should always return `false`. Did you maybe rename this variable? This check looks for calls to `isset(...)` or `empty()` on variables that are yet undefined. These calls will always produce the same result and can be removed. This is most likely caused by the renaming of a variable or the removal of a function/method parameter. Loading history...
171			return $CONFIG['datadirectory'];
172			}
173
174			// Something went wrong
175			throw new \Exception('Unable to detect datadirectory');
176			}
177
178			/**
179			* Absolute path to updater root dir
180			* @return string
181			*/
182			public function getUpdaterBaseDir(){
183			return $this->getDataDir() . '/updater-data';
184			}
185
186			/**
187			* Absolute path to create a core and apps backups
188			* @return string
189			*/
190			public function getCheckpointDir(){
191			return $this->getUpdaterBaseDir() . '/checkpoint';
192			}
193
194			/**
195			* Absolute path to store downloaded packages
196			* @return string
197			*/
198			public function getDownloadBaseDir(){
199			return $this->getUpdaterBaseDir() . '/download';
200			}
201
202			/**
203			* Absolute path to a temporary directory
204			* to extract downloaded packages into
205			* @return string
206			*/
207			public function getExtractionBaseDir(){
208			return $this->getUpdaterBaseDir() . "/_oc_upgrade";
209			}
210
211			/**
212			*
213			* @return string
214			*/
215			public function getPathToOccFile(){
216			return $this->ownCloudRootPath . '/occ';
217			}
218
219			/**
220			*
221			* @return string
222			*/
223			public function getInstalledVersion(){
224			include $this->getPathToVersionFile();
225
226			/** @var $OC_Version string */
227			return $OC_Version;
			0 ignored issues – show Bug introduced 2015-12-21 09:30 UTC by Report Bug Copy Issue Report The variable `$OC_Version` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
228			}
229
230			/**
231			*
232			* @return string
233			*/
234			public function getChannelFromVersionsFile(){
235			include $this->getPathToVersionFile();
236
237			/** @var $OC_Channel string */
238			return $OC_Channel;
			0 ignored issues – show Bug introduced 2016-02-03 13:44 UTC by Report Bug Copy Issue Report The variable `$OC_Channel` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
239			}
240
241			/**
242			*
243			* @return string
244			*/
245			public function getBuild(){
246			include $this->getPathToVersionFile();
247
248			/** @var $OC_Build string */
249			return $OC_Build;
			0 ignored issues – show Bug introduced 2015-12-21 09:30 UTC by Report Bug Copy Issue Report The variable `$OC_Build` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
250			}
251
252			/**
253			* @return string
254			*/
255			public function getSecretFromConfig(){
256			include $this->getPathToConfigFile();
257			if (isset($CONFIG['updater.secret'])){
			0 ignored issues – show Bug introduced 2016-06-14 16:43 UTC by Report Bug Copy Issue Report The variable `$CONFIG` seems to never exist, and therefore `isset` should always return `false`. Did you maybe rename this variable? This check looks for calls to `isset(...)` or `empty()` on variables that are yet undefined. These calls will always produce the same result and can be removed. This is most likely caused by the renaming of a variable or the removal of a function/method parameter. Loading history...
258			return $CONFIG['updater.secret'];
259			}
260			return '';
261			}
262
263			/**
264			* @param string $filePostfix
265			* @return array
266			*/
267			public function getPathtoConfigFiles($filePostfix = 'config.php'){
268			// Only config.php for now
269			return [
270			$this->ownCloudRootPath . '/config/' . $filePostfix
271			];
272			}
273
274			/**
275			* @return string
276			*/
277			public function getPathToConfigFile(){
278			return $this->ownCloudRootPath . '/config/config.php';
279			}
280
281			/**
282			*
283			* @return string
284			*/
285			public function getPathToVersionFile(){
286			return $this->ownCloudRootPath . '/version.php';
287			}
288
289			/**
290			* @param string $rootPath
291			*
292			* @return array\|mixed
293			*/
294			private function getSignature($rootPath) {
295			$signature = [];
296			$signaturePath = $rootPath . '/core/signature.json';
297			if (is_file($signaturePath)) {
298			$signature = \json_decode(file_get_contents($signaturePath), true);
299			if (!is_array($signature)) {
300			$signature = [];
301			}
302			}
303			return $signature;
304			}
305			}
306

owncloud / updater

Push — master ( af50b6...d203e3 )

Locator::getSignature() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like