Autoloader::findClass() - Code Metrics - Inspection of "Add a wrapper to allow phpunit4 to run the code ag..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — stable10 (#2295)

by Joas

created 2016-11-24 08:16 UTC

Autoloader::findClass() C

↳ Parent: Autoloader

Complexity

Conditions	12
Paths	10

Size

Total Lines	39
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	12
eloc	26
nc	10
nop	1
dl	0
loc	39
rs	5.1612
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Andreas Fischer <[email protected]>
 * @author Georg Ehrke <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Markus Goetz <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Robin McCorkell <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Thomas Müller <[email protected]>
 * @author Vincent Petry <[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;

use \OCP\AutoloadNotAllowedException;

class Autoloader {
	/** @var bool */
	private $useGlobalClassPath = true;
	/** @var array */
	private $validRoots = [];

	/**
	 * Optional low-latency memory cache for class to path mapping.
	 *
	 * @var \OC\Memcache\Cache
	 */
	protected $memoryCache;

	/**
	 * Autoloader constructor.
	 *
	 * @param string[] $validRoots
	 */
	public function __construct(array $validRoots) {
		foreach ($validRoots as $root) {
			$this->validRoots[$root] = true;
		}
	}

	/**
	 * Add a path to the list of valid php roots for auto loading
	 *
	 * @param string $root
	 */
	public function addValidRoot($root) {
		$root = stream_resolve_include_path($root);
		$this->validRoots[$root] = true;
	}

	/**
	 * disable the usage of the global classpath \OC::$CLASSPATH
	 */
	public function disableGlobalClassPath() {
		$this->useGlobalClassPath = false;
	}

	/**
	 * enable the usage of the global classpath \OC::$CLASSPATH
	 */
	public function enableGlobalClassPath() {
		$this->useGlobalClassPath = true;
	}

	/**
	 * get the possible paths for a class
	 *
	 * @param string $class
	 * @return array|bool an array of possible paths or false if the class is not part of ownCloud
	 */
	public function findClass($class) {
		$class = trim($class, '\\');

		$paths = array();
		if ($this->useGlobalClassPath && array_key_exists($class, \OC::$CLASSPATH)) {
			$paths[] = \OC::$CLASSPATH[$class];
			/**
			 * @TODO: Remove this when necessary
			 * Remove "apps/" from inclusion path for smooth migration to multi app dir
			 */
			if (strpos(\OC::$CLASSPATH[$class], 'apps/') === 0) {
				\OCP\Util::writeLog('core', 'include path for class "' . $class . '" starts with "apps/"', \OCP\Util::DEBUG);
				$paths[] = str_replace('apps/', '', \OC::$CLASSPATH[$class]);
			}
		} elseif (strpos($class, 'OC_') === 0) {
			$paths[] = \OC::$SERVERROOT . '/lib/private/legacy/' . strtolower(str_replace('_', '/', substr($class, 3)) . '.php');
		} elseif (strpos($class, 'OCA\\') === 0) {
			list(, $app, $rest) = explode('\\', $class, 3);
			$app = strtolower($app);
			$appPath = \OC_App::getAppPath($app);
			if ($appPath && stream_resolve_include_path($appPath)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				$paths[] = $appPath . '/' . strtolower(str_replace('\\', '/', $rest) . '.php');
				// If not found in the root of the app directory, insert '/lib' after app id and try again.
				$paths[] = $appPath . '/lib/' . strtolower(str_replace('\\', '/', $rest) . '.php');
			}
		} elseif ($class === 'Test\\TestCase') {
			// This File is considered public API, so we make sure that the class
			// can still be loaded, although the PSR-4 paths have not been loaded.
			$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCase.php';

		} elseif ($class === 'Test\\TestCasePhpUnitCompatibility') {
			$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCasePhpUnitCompatibility.php';
		} elseif ($class === 'Test\\TestCasePhpUnit5') {
			$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCasePhpUnit5.php';
		} elseif ($class === 'Test\\TestCasePhpUnit4') {
			$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCasePhpUnit4.php';
		}
		return $paths;
	}

	/**
	 * @param string $fullPath
	 * @return bool
	 */
	protected function isValidPath($fullPath) {
		foreach ($this->validRoots as $root => $true) {
			if (substr($fullPath, 0, strlen($root) + 1) === $root . '/') {
				return true;
			}
		}
		throw new AutoloadNotAllowedException($fullPath);
	}

	/**
	 * Load the specified class
	 *
	 * @param string $class
	 * @return bool
	 */
	public function load($class) {
		$pathsToRequire = null;
		if ($this->memoryCache) {
			$pathsToRequire = $this->memoryCache->get($class);
		}

		if(class_exists($class, false)) {
			return false;
		}

		if (!is_array($pathsToRequire)) {
			// No cache or cache miss
			$pathsToRequire = array();
			foreach ($this->findClass($class) as $path) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
				$fullPath = stream_resolve_include_path($path);
				if ($fullPath && $this->isValidPath($fullPath)) {
					$pathsToRequire[] = $fullPath;
				}
			}

			if ($this->memoryCache) {
				$this->memoryCache->set($class, $pathsToRequire, 60); // cache 60 sec
			}
		}

		foreach ($pathsToRequire as $fullPath) {
			require_once $fullPath;
		}

		return false;
	}

	/**
	 * Sets the optional low-latency cache for class to path mapping.
	 *
	 * @param \OC\Memcache\Cache $memoryCache Instance of memory cache.
	 */
	public function setMemoryCache(\OC\Memcache\Cache $memoryCache = null) {
		$this->memoryCache = $memoryCache;
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016, ownCloud, Inc.
4			*
5			* @author Andreas Fischer <[email protected]>
6			* @author Georg Ehrke <[email protected]>
7			* @author Joas Schilling <[email protected]>
8			* @author Lukas Reschke <[email protected]>
9			* @author Markus Goetz <[email protected]>
10			* @author Morris Jobke <[email protected]>
11			* @author Robin Appelman <[email protected]>
12			* @author Robin McCorkell <[email protected]>
13			* @author Roeland Jago Douma <[email protected]>
14			* @author Thomas Müller <[email protected]>
15			* @author Vincent Petry <[email protected]>
16			*
17			* @license AGPL-3.0
18			*
19			* This code is free software: you can redistribute it and/or modify
20			* it under the terms of the GNU Affero General Public License, version 3,
21			* as published by the Free Software Foundation.
22			*
23			* This program is distributed in the hope that it will be useful,
24			* but WITHOUT ANY WARRANTY; without even the implied warranty of
25			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26			* GNU Affero General Public License for more details.
27			*
28			* You should have received a copy of the GNU Affero General Public License, version 3,
29			* along with this program. If not, see <http://www.gnu.org/licenses/>
30			*
31			*/
32
33			namespace OC;
34
35			use \OCP\AutoloadNotAllowedException;
36
37			class Autoloader {
38			/** @var bool */
39			private $useGlobalClassPath = true;
40			/** @var array */
41			private $validRoots = [];
42
43			/**
44			* Optional low-latency memory cache for class to path mapping.
45			*
46			* @var \OC\Memcache\Cache
47			*/
48			protected $memoryCache;
49
50			/**
51			* Autoloader constructor.
52			*
53			* @param string[] $validRoots
54			*/
55			public function __construct(array $validRoots) {
56			foreach ($validRoots as $root) {
57			$this->validRoots[$root] = true;
58			}
59			}
60
61			/**
62			* Add a path to the list of valid php roots for auto loading
63			*
64			* @param string $root
65			*/
66			public function addValidRoot($root) {
67			$root = stream_resolve_include_path($root);
68			$this->validRoots[$root] = true;
69			}
70
71			/**
72			* disable the usage of the global classpath \OC::$CLASSPATH
73			*/
74			public function disableGlobalClassPath() {
75			$this->useGlobalClassPath = false;
76			}
77
78			/**
79			* enable the usage of the global classpath \OC::$CLASSPATH
80			*/
81			public function enableGlobalClassPath() {
82			$this->useGlobalClassPath = true;
83			}
84
85			/**
86			* get the possible paths for a class
87			*
88			* @param string $class
89			* @return array\|bool an array of possible paths or false if the class is not part of ownCloud
90			*/
91			public function findClass($class) {
92			$class = trim($class, '\\');
93
94			$paths = array();
95			if ($this->useGlobalClassPath && array_key_exists($class, \OC::$CLASSPATH)) {
96			$paths[] = \OC::$CLASSPATH[$class];
97			/**
98			* @TODO: Remove this when necessary
99			* Remove "apps/" from inclusion path for smooth migration to multi app dir
100			*/
101			if (strpos(\OC::$CLASSPATH[$class], 'apps/') === 0) {
102			\OCP\Util::writeLog('core', 'include path for class "' . $class . '" starts with "apps/"', \OCP\Util::DEBUG);
103			$paths[] = str_replace('apps/', '', \OC::$CLASSPATH[$class]);
104			}
105			} elseif (strpos($class, 'OC_') === 0) {
106			$paths[] = \OC::$SERVERROOT . '/lib/private/legacy/' . strtolower(str_replace('_', '/', substr($class, 3)) . '.php');
107			} elseif (strpos($class, 'OCA\\') === 0) {
108			list(, $app, $rest) = explode('\\', $class, 3);
109			$app = strtolower($app);
110			$appPath = \OC_App::getAppPath($app);
111			if ($appPath && stream_resolve_include_path($appPath)) {
			0 ignored issues – show Bug Best Practice introduced 2016-06-09 12:21 UTC by Report Bug Copy Issue Report The expression `$appPath` of type `false\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
112			$paths[] = $appPath . '/' . strtolower(str_replace('\\', '/', $rest) . '.php');
113			// If not found in the root of the app directory, insert '/lib' after app id and try again.
114			$paths[] = $appPath . '/lib/' . strtolower(str_replace('\\', '/', $rest) . '.php');
115			}
116			} elseif ($class === 'Test\\TestCase') {
117			// This File is considered public API, so we make sure that the class
118			// can still be loaded, although the PSR-4 paths have not been loaded.
119			$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCase.php';
120
121			} elseif ($class === 'Test\\TestCasePhpUnitCompatibility') {
122			$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCasePhpUnitCompatibility.php';
123			} elseif ($class === 'Test\\TestCasePhpUnit5') {
124			$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCasePhpUnit5.php';
125			} elseif ($class === 'Test\\TestCasePhpUnit4') {
126			$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCasePhpUnit4.php';
127			}
128			return $paths;
129			}
130
131			/**
132			* @param string $fullPath
133			* @return bool
134			*/
135			protected function isValidPath($fullPath) {
136			foreach ($this->validRoots as $root => $true) {
137			if (substr($fullPath, 0, strlen($root) + 1) === $root . '/') {
138			return true;
139			}
140			}
141			throw new AutoloadNotAllowedException($fullPath);
142			}
143
144			/**
145			* Load the specified class
146			*
147			* @param string $class
148			* @return bool
149			*/
150			public function load($class) {
151			$pathsToRequire = null;
152			if ($this->memoryCache) {
153			$pathsToRequire = $this->memoryCache->get($class);
154			}
155
156			if(class_exists($class, false)) {
157			return false;
158			}
159
160			if (!is_array($pathsToRequire)) {
161			// No cache or cache miss
162			$pathsToRequire = array();
163			foreach ($this->findClass($class) as $path) {
			0 ignored issues – show Bug introduced 2016-07-22 10:49 UTC by Report Bug Copy Issue Report The expression `$this->findClass($class)` of type `array\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
164			$fullPath = stream_resolve_include_path($path);
165			if ($fullPath && $this->isValidPath($fullPath)) {
166			$pathsToRequire[] = $fullPath;
167			}
168			}
169
170			if ($this->memoryCache) {
171			$this->memoryCache->set($class, $pathsToRequire, 60); // cache 60 sec
172			}
173			}
174
175			foreach ($pathsToRequire as $fullPath) {
176			require_once $fullPath;
177			}
178
179			return false;
180			}
181
182			/**
183			* Sets the optional low-latency cache for class to path mapping.
184			*
185			* @param \OC\Memcache\Cache $memoryCache Instance of memory cache.
186			*/
187			public function setMemoryCache(\OC\Memcache\Cache $memoryCache = null) {
188			$this->memoryCache = $memoryCache;
189			}
190			}
191

nextcloud / server

Pull Request — stable10 (#2295)

Autoloader::findClass() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like