ResourceLocator::findWebRoot() - Code Metrics - Inspection of "Merge pull request #6394 from nextcloud/navigation..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 485e22...5184f3 )

by Morris

created 2017-09-07 07:30 UTC

ResourceLocator::findWebRoot() C

↳ Parent: ResourceLocator

Complexity

Conditions	7
Paths	12

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	15
nc	12
nop	1
dl	0
loc	27
rs	6.7272
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Bart Visscher <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Jörn Friedrich Dreyer <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin McCorkell <[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\Template;

abstract class ResourceLocator {
	protected $theme;

	protected $mapping;
	protected $serverroot;
	protected $thirdpartyroot;
	protected $webroot;

	protected $resources = array();

	/** @var \OCP\ILogger */
	protected $logger;

	/**
	 * @param \OCP\ILogger $logger
	 * @param string $theme
	 * @param array $core_map
	 * @param array $party_map
	 */
	public function __construct(\OCP\ILogger $logger, $theme, $core_map, $party_map) {
		$this->logger = $logger;
		$this->theme = $theme;
		$this->mapping = $core_map + $party_map;
		$this->serverroot = key($core_map);
		$this->thirdpartyroot = key($party_map);
		$this->webroot = $this->mapping[$this->serverroot];
	}

	/**
	 * @param string $resource
	 */
	abstract public function doFind($resource);

	/**
	 * @param string $resource
	 */
	abstract public function doFindTheme($resource);

	/**
	 * Finds the resources and adds them to the list
	 *
	 * @param array $resources
	 */
	public function find($resources) {
		foreach ($resources as $resource) {
			try {
				$this->doFind($resource);
			} catch (ResourceNotFoundException $e) {
				$resourceApp = substr($resource, 0, strpos($resource, '/'));
				$this->logger->debug('Could not find resource file "' . $e->getResourcePath() . '"', ['app' => $resourceApp]);
			}
		}
		if (!empty($this->theme)) {
			foreach ($resources as $resource) {
				try {
					$this->doFindTheme($resource);
				} catch (ResourceNotFoundException $e) {
					$resourceApp = substr($resource, 0, strpos($resource, '/'));
					$this->logger->debug('Could not find resource file in theme "' . $e->getResourcePath() . '"', ['app' => $resourceApp]);
				}
			}
		}
	}

	/**
	 * append the $file resource if exist at $root
	 *
	 * @param string $root path to check
	 * @param string $file the filename
	 * @param string|null $webRoot base for path, default map $root to $webRoot
	 * @return bool True if the resource was found, false otherwise
	 */
	protected function appendIfExist($root, $file, $webRoot = null) {
		if (is_file($root.'/'.$file)) {
			$this->append($root, $file, $webRoot, false);
			return true;
		}
		return false;
	}

	/**
	 * Attempt to find the webRoot
	 *
	 * traverse the potential web roots upwards in the path
	 *
	 * example:
	 *   - root: /srv/www/apps/myapp
	 *   - available mappings: ['/srv/www']
	 *
	 * First we check if a mapping for /srv/www/apps/myapp is available,
	 * then /srv/www/apps, /srv/www/apps, /srv/www, ... until we find a
	 * valid web root
	 *
	 * @param string $root
	 * @return string|null The web root or null on failure
	 */
	protected function findWebRoot($root) {
		$webRoot = null;
		$tmpRoot = $root;

		while ($webRoot === null) {
			if (isset($this->mapping[$tmpRoot])) {
				$webRoot = $this->mapping[$tmpRoot];
				break;
			}

			if ($tmpRoot === '/') {
				break;
			}

			$tmpRoot = dirname($tmpRoot);
		}

		if (!$webRoot) {
			$realpath = realpath($root);

			if ($realpath && ($realpath !== $root)) {
				return $this->findWebRoot($realpath);
			}
		}

		return $webRoot;
	}

	/**
	 * append the $file resource at $root
	 *
	 * @param string $root path to check
	 * @param string $file the filename
	 * @param string|null $webRoot base for path, default map $root to $webRoot
	 * @param bool $throw Throw an exception, when the route does not exist
	 * @throws ResourceNotFoundException Only thrown when $throw is true and the resource is missing
	 */
	protected function append($root, $file, $webRoot = null, $throw = true) {

		if (!is_string($root)) {
			if ($throw) {
				throw new ResourceNotFoundException($file, $webRoot);
			}
			return;
		}

		if (!$webRoot) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$webRoot = $this->findWebRoot($root);

			if (!$webRoot) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				$webRoot = '';
				$this->logger->error('ResourceLocator can not find a web root (root: {root}, file: {file}, webRoot: {webRoot}, throw: {throw})', [
					'app' => 'lib',
					'root' => $root,
					'file' => $file,
					'webRoot' => $webRoot,
					'throw' => $throw ? 'true' : 'false'
				]);
			}
		}
		$this->resources[] = array($root, $webRoot, $file);

		if ($throw && !is_file($root . '/' . $file)) {
			throw new ResourceNotFoundException($file, $webRoot);
		}
	}

	/**
	 * Returns the list of all resources that should be loaded
	 * @return array
	 */
	public function getResources() {
		return $this->resources;
	}
}


1		<?php
2		/**
3		* @copyright Copyright (c) 2016, ownCloud, Inc.
4		*
5		* @author Bart Visscher <[email protected]>
6		* @author Joas Schilling <[email protected]>
7		* @author Jörn Friedrich Dreyer <[email protected]>
8		* @author Morris Jobke <[email protected]>
9		* @author Robin McCorkell <[email protected]>
10		*
11		* @license AGPL-3.0
12		*
13		* This code is free software: you can redistribute it and/or modify
14		* it under the terms of the GNU Affero General Public License, version 3,
15		* as published by the Free Software Foundation.
16		*
17		* This program is distributed in the hope that it will be useful,
18		* but WITHOUT ANY WARRANTY; without even the implied warranty of
19		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20		* GNU Affero General Public License for more details.
21		*
22		* You should have received a copy of the GNU Affero General Public License, version 3,
23		* along with this program. If not, see <http://www.gnu.org/licenses/>
24		*
25		*/
26
27		namespace OC\Template;
28
29		abstract class ResourceLocator {
30		protected $theme;
31
32		protected $mapping;
33		protected $serverroot;
34		protected $thirdpartyroot;
35		protected $webroot;
36
37		protected $resources = array();
38
39		/** @var \OCP\ILogger */
40		protected $logger;
41
42		/**
43		* @param \OCP\ILogger $logger
44		* @param string $theme
45		* @param array $core_map
46		* @param array $party_map
47		*/
48		public function __construct(\OCP\ILogger $logger, $theme, $core_map, $party_map) {
49		$this->logger = $logger;
50		$this->theme = $theme;
51		$this->mapping = $core_map + $party_map;
52		$this->serverroot = key($core_map);
53		$this->thirdpartyroot = key($party_map);
54		$this->webroot = $this->mapping[$this->serverroot];
55		}
56
57		/**
58		* @param string $resource
59		*/
60		abstract public function doFind($resource);
61
62		/**
63		* @param string $resource
64		*/
65		abstract public function doFindTheme($resource);
66
67		/**
68		* Finds the resources and adds them to the list
69		*
70		* @param array $resources
71		*/
72		public function find($resources) {
73		foreach ($resources as $resource) {
74		try {
75		$this->doFind($resource);
76		} catch (ResourceNotFoundException $e) {
77		$resourceApp = substr($resource, 0, strpos($resource, '/'));
78		$this->logger->debug('Could not find resource file "' . $e->getResourcePath() . '"', ['app' => $resourceApp]);
79		}
80		}
81		if (!empty($this->theme)) {
82		foreach ($resources as $resource) {
83		try {
84		$this->doFindTheme($resource);
85		} catch (ResourceNotFoundException $e) {
86		$resourceApp = substr($resource, 0, strpos($resource, '/'));
87		$this->logger->debug('Could not find resource file in theme "' . $e->getResourcePath() . '"', ['app' => $resourceApp]);
88		}
89		}
90		}
91		}
92
93		/**
94		* append the $file resource if exist at $root
95		*
96		* @param string $root path to check
97		* @param string $file the filename
98		* @param string\|null $webRoot base for path, default map $root to $webRoot
99		* @return bool True if the resource was found, false otherwise
100		*/
101		protected function appendIfExist($root, $file, $webRoot = null) {
102		if (is_file($root.'/'.$file)) {
103		$this->append($root, $file, $webRoot, false);
104		return true;
105		}
106		return false;
107		}
108
109		/**
110		* Attempt to find the webRoot
111		*
112		* traverse the potential web roots upwards in the path
113		*
114		* example:
115		* - root: /srv/www/apps/myapp
116		* - available mappings: ['/srv/www']
117		*
118		* First we check if a mapping for /srv/www/apps/myapp is available,
119		* then /srv/www/apps, /srv/www/apps, /srv/www, ... until we find a
120		* valid web root
121		*
122		* @param string $root
123		* @return string\|null The web root or null on failure
124		*/
125		protected function findWebRoot($root) {
126		$webRoot = null;
127		$tmpRoot = $root;
128
129		while ($webRoot === null) {
130		if (isset($this->mapping[$tmpRoot])) {
131		$webRoot = $this->mapping[$tmpRoot];
132		break;
133		}
134
135		if ($tmpRoot === '/') {
136		break;
137		}
138
139		$tmpRoot = dirname($tmpRoot);
140		}
141
142		if (!$webRoot) {
143		$realpath = realpath($root);
144
145		if ($realpath && ($realpath !== $root)) {
146		return $this->findWebRoot($realpath);
147		}
148		}
149
150		return $webRoot;
151		}
152
153		/**
154		* append the $file resource at $root
155		*
156		* @param string $root path to check
157		* @param string $file the filename
158		* @param string\|null $webRoot base for path, default map $root to $webRoot
159		* @param bool $throw Throw an exception, when the route does not exist
160		* @throws ResourceNotFoundException Only thrown when $throw is true and the resource is missing
161		*/
162		protected function append($root, $file, $webRoot = null, $throw = true) {
163
164		if (!is_string($root)) {
165		if ($throw) {
166		throw new ResourceNotFoundException($file, $webRoot);
167		}
168		return;
169		}
170
171	View Code Duplication	if (!$webRoot) {
		0 ignored issues – show Bug Best Practice introduced 2017-09-01 10:14 UTC by Report Bug Copy Issue Report The expression `$webRoot` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` 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...
172		$webRoot = $this->findWebRoot($root);
173
174		if (!$webRoot) {
		0 ignored issues – show Bug Best Practice introduced 2017-09-01 10:14 UTC by Report Bug Copy Issue Report The expression `$webRoot` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` 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...
175		$webRoot = '';
176		$this->logger->error('ResourceLocator can not find a web root (root: {root}, file: {file}, webRoot: {webRoot}, throw: {throw})', [
177		'app' => 'lib',
178		'root' => $root,
179		'file' => $file,
180		'webRoot' => $webRoot,
181		'throw' => $throw ? 'true' : 'false'
182		]);
183		}
184		}
185		$this->resources[] = array($root, $webRoot, $file);
186
187		if ($throw && !is_file($root . '/' . $file)) {
188		throw new ResourceNotFoundException($file, $webRoot);
189		}
190		}
191
192		/**
193		* Returns the list of all resources that should be loaded
194		* @return array
195		*/
196		public function getResources() {
197		return $this->resources;
198		}
199		}
200

nextcloud / server

Push — master ( 485e22...5184f3 )

ResourceLocator::findWebRoot() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like