ConfigService::collectConfig() - Code Metrics - Inspection of "Backport 180316" - interfasys/galleryplus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#39)

by Olivier

created 2016-03-18 23:31 UTC

ConfigService::collectConfig() A

↳ Parent: ConfigService

Complexity

Conditions	4
Paths	5

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	19
ccs	10
cts	10
cp	1
rs	9.2
cc	4
eloc	11
nc	5
nop	5
crap	4

<?php
/**
 * ownCloud - galleryplus
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Olivier Paroz <[email protected]>
 *
 * @copyright Olivier Paroz 2015
 */

namespace OCA\GalleryPlus\Service;

use OCP\Template;
use OCP\Files\Folder;
use OCP\ILogger;

use OCA\GalleryPlus\Config\ConfigParser;
use OCA\GalleryPlus\Config\ConfigException;
use OCA\GalleryPlus\Environment\Environment;
use OCA\GalleryPlus\Preview\Preview;

/**
 * Finds configurations files and returns a configuration array
 *
 * Checks the current and parent folders for configuration files and to see if we're allowed to
 * look for media file
 * Supports explicit inheritance
 *
 * @package OCA\GalleryPlus\Service
 */
class ConfigService extends FilesService {

	/** @var string */
	private $configName = 'gallery.cnf';
	/** @var array <string,bool> */
	private $completionStatus = ['design' => false, 'information' => false, 'sorting' => false];
	/** @var ConfigParser */
	private $configParser;
	/** @var Preview */
	private $previewManager;
	/**
	 * @todo This hard-coded array could be replaced by admin settings
	 *
	 * @var string[]
	 */
	private $baseMimeTypes = [
		'image/png',
		'image/jpeg',
		'image/gif',
		'image/x-xbitmap',
		'image/bmp',
		'image/tiff',
		'image/x-dcraw',
		'application/x-photoshop',
		'application/illustrator',
		'application/postscript',
	];
	/**
	 * These types are useful for files preview in the files app, but
	 * not for the gallery side
	 *
	 * @var string[]
	 */
	private $slideshowMimeTypes = [
		'application/font-sfnt',
		'application/x-font',
	];

	/**
	 * Constructor
	 *
	 * @param string $appName
	 * @param Environment $environment
	 * @param ConfigParser $configParser
	 * @param Preview $previewManager
	 * @param ILogger $logger
	 */
	public function __construct(
		$appName,
		Environment $environment,
		ConfigParser $configParser,
		Preview $previewManager,
		ILogger $logger
	) {
		parent::__construct($appName, $environment, $logger);

		$this->configParser = $configParser;
		$this->previewManager = $previewManager;
	}

	/**
	 * Returns a list of supported features
	 *
	 * @return string[]
	 */
	public function getFeaturesList() {
		$featuresList = [];
		/** @var Folder $rootFolder */
		$rootFolder = $this->environment->getVirtualRootFolder();
		if ($this->isAllowedAndAvailable($rootFolder) && $this->configExists($rootFolder)) {
			try {
				$featuresList =
					$this->configParser->getFeaturesList($rootFolder, $this->configName);
			} catch (ConfigException $exception) {
				$featuresList = $this->buildErrorMessage($exception, $rootFolder);
			}
		}

		return $featuresList;
	}

	/**
	 * This builds and returns a list of all supported media types
	 *
	 * @todo Native SVG could be disabled via admin settings
	 *
	 * @param bool $extraMediaTypes
	 * @param bool $nativeSvgSupport
	 *
	 * @return string[] all supported media types
	 */
	public function getSupportedMediaTypes($extraMediaTypes, $nativeSvgSupport) {
		$supportedMimes = [];
		$wantedMimes = $this->baseMimeTypes;
		if ($extraMediaTypes) {
			$wantedMimes = array_merge($wantedMimes, $this->slideshowMimeTypes);
		}
		foreach ($wantedMimes as $wantedMime) {
			// Let's see if a preview of files of that media type can be generated
			if ($this->isMimeSupported($wantedMime)) {
				// We store the media type
				$supportedMimes[] = $wantedMime;
			}
		}
		$supportedMimes = $this->addSvgSupport($supportedMimes, $nativeSvgSupport);

		//$this->logger->debug("Supported Mimes: {mimes}", ['mimes' => $supportedMimes]);

		return $supportedMimes;
	}

	/**
	 * Returns the configuration of the currently selected folder
	 *
	 *    * information (description, copyright)
	 *    * sorting (date, name, inheritance)
	 *    * design (colour)
	 *    * if the album should be ignored
	 *
	 * @param Folder $folderNode the current folder
	 * @param array $features the list of features retrieved fro the configuration file
	 *
	 * @return array|null
	 * @throws ForbiddenServiceException
	 */
	public function getConfig($folderNode, $features) {
		$this->features = $features;
		list ($albumConfig, $ignored) =
			$this->collectConfig($folderNode, $this->ignoreAlbum, $this->configName);
		if ($ignored) {
			throw new ForbiddenServiceException(
				'The owner has placed a restriction or the storage location is unavailable'
			);
		}

		return $albumConfig;
	}

	/**
	 * Throws an exception if the media type of the file is not part of what the app allows
	 *
	 * @param $mimeType
	 *
	 * @throws ForbiddenServiceException
	 */
	public function validateMimeType($mimeType) {
		if (!in_array($mimeType, $this->getSupportedMediaTypes(true, true))) {
			throw new ForbiddenServiceException('Media type not allowed');
		}
	}

	/**
	 * Determines if we have a configuration file to work with
	 *
	 * @param Folder $rootFolder the virtual root folder
	 *
	 * @return bool
	 */
	private function configExists($rootFolder) {
		return $rootFolder && $rootFolder->nodeExists($this->configName);
	}

	/**
	 * Adds the SVG media type if it's not already there
	 *
	 * If it's enabled, but doesn't work, an exception will be raised when trying to generate a
	 * preview. If it's disabled, we support it via the browser's native support
	 *
	 * @param string[] $supportedMimes
	 * @param bool $nativeSvgSupport
	 *
	 * @return string[]
	 */
	private function addSvgSupport($supportedMimes, $nativeSvgSupport) {
		if (!in_array('image/svg+xml', $supportedMimes) && $nativeSvgSupport) {
			$supportedMimes[] = 'image/svg+xml';
		}

		return $supportedMimes;
	}

	/**
	 * Returns true if the passed mime type is supported
	 *
	 * In case of a failure, we just return that the media type is not supported
	 *
	 * @param string $mimeType
	 *
	 * @return boolean
	 */
	private function isMimeSupported($mimeType = '*') {
		try {
			return $this->previewManager->isMimeSupported($mimeType);
		} catch (\Exception $exception) {
			unset($exception);

			return false;
		}
	}

	/**
	 * Returns an album configuration array
	 *
	 * Goes through all the parent folders until either we're told the album is private or we've
	 * reached the root folder
	 *
	 * @param Folder $folder the current folder
	 * @param string $ignoreAlbum name of the file which blacklists folders
	 * @param string $configName name of the configuration file
	 * @param int $level the starting level is 0 and we add 1 each time we visit a parent folder
	 * @param array $configSoFar the configuration collected so far
	 *
	 * @return array <null|array,bool>
	 */
	private function collectConfig(
		$folder, $ignoreAlbum, $configName, $level = 0, $configSoFar = []
	) {
		if ($folder->nodeExists($ignoreAlbum)) {
			// Cancel as soon as we find out that the folder is private or external
			return [null, true];
		}
		$isRootFolder = $this->isRootFolder($folder, $level);
		if ($folder->nodeExists($configName)) {
			$configSoFar = $this->buildFolderConfig($folder, $configName, $configSoFar, $level);
		}
		if (!$isRootFolder) {
			return $this->getParentConfig($folder, $ignoreAlbum, $configName, $level, $configSoFar);
		}
		$configSoFar = $this->validatesInfoConfig($configSoFar);

		// We have reached the root folder
		return [$configSoFar, false];
	}

	/**
	 * Returns a parsed configuration if one was found in the current folder or generates an error
	 * message to send back
	 *
	 * @param Folder $folder the current folder
	 * @param string $configName name of the configuration file
	 * @param array $collectedConfig the configuration collected so far
	 * @param int $level the starting level is 0 and we add 1 each time we visit a parent folder
	 *
	 * @return array
	 */
	private function buildFolderConfig($folder, $configName, $collectedConfig, $level) {
		try {
			list($collectedConfig, $completionStatus) = $this->configParser->getFolderConfig(
				$folder, $configName, $collectedConfig, $this->completionStatus, $level
			);
			$this->completionStatus = $completionStatus;
		} catch (ConfigException $exception) {
			$collectedConfig = $this->buildErrorMessage($exception, $folder);
		}

		return $collectedConfig;
	}

	/**
	 * Builds the error message to send back when there is an error
	 *
	 * @fixme Missing translation
	 *
	 * @param ConfigException $exception
	 * @param Folder $folder the current folder
	 *
	 * @return array<array<string,string>,bool>
	 */
	private function buildErrorMessage($exception, $folder) {
		$configPath = $this->environment->getPathFromVirtualRoot($folder);
		$errorMessage = $exception->getMessage() . ". Config location: /$configPath";
		$this->logger->error($errorMessage);
		$config = ['error' => ['message' => $errorMessage]];

		$completionStatus = $this->completionStatus;
		foreach ($completionStatus as $key) {
			$completionStatus[$key] = true;
		}
		$this->completionStatus = $completionStatus;

		return [$config];
	}

	/**
	 * Removes links if they were collected outside of the virtual root
	 *
	 * This is for shared folders which have a virtual root
	 *
	 * @param array $albumConfig
	 *
	 * @return array
	 */
	private function validatesInfoConfig($albumConfig) {
		$this->virtualRootLevel;
		if (array_key_exists('information', $albumConfig)) {
			$info = $albumConfig['information'];
			if (array_key_exists('level', $info)) {
				$level = $info['level'];
				if ($level > $this->virtualRootLevel) {
					$albumConfig['information']['description_link'] = null;
					$albumConfig['information']['copyright_link'] = null;
				}
			}
		}

		return $albumConfig;
	}

	/**
	 * Looks for an album configuration in the parent folder
	 *
	 * We will look up to the virtual root of a shared folder, for privacy reasons
	 *
	 * @param Folder $folder the current folder
	 * @param string $privacyChecker name of the file which blacklists folders
	 * @param string $configName name of the configuration file
	 * @param int $level the starting level is 0 and we add 1 each time we visit a parent folder
	 * @param array $collectedConfig the configuration collected so far
	 *
	 * @return array<null|array,bool>
	 */
	private function getParentConfig($folder, $privacyChecker, $configName, $level, $collectedConfig
	) {
		$parentFolder = $folder->getParent();
		$level++;

		return $this->collectConfig(
			$parentFolder, $privacyChecker, $configName, $level, $collectedConfig
		);
	}

}


1		<?php
2		/**
3		* ownCloud - galleryplus
4		*
5		* This file is licensed under the Affero General Public License version 3 or
6		* later. See the COPYING file.
7		*
8		* @author Olivier Paroz <[email protected]>
9		*
10		* @copyright Olivier Paroz 2015
11		*/
12
13		namespace OCA\GalleryPlus\Service;
14
15		use OCP\Template;
16		use OCP\Files\Folder;
17		use OCP\ILogger;
18
19		use OCA\GalleryPlus\Config\ConfigParser;
20		use OCA\GalleryPlus\Config\ConfigException;
21		use OCA\GalleryPlus\Environment\Environment;
22		use OCA\GalleryPlus\Preview\Preview;
23
24		/**
25		* Finds configurations files and returns a configuration array
26		*
27		* Checks the current and parent folders for configuration files and to see if we're allowed to
28		* look for media file
29		* Supports explicit inheritance
30		*
31		* @package OCA\GalleryPlus\Service
32		*/
33		class ConfigService extends FilesService {
34
35		/** @var string */
36		private $configName = 'gallery.cnf';
37		/** @var array <string,bool> */
38		private $completionStatus = ['design' => false, 'information' => false, 'sorting' => false];
39		/** @var ConfigParser */
40		private $configParser;
41		/** @var Preview */
42		private $previewManager;
43		/**
44		* @todo This hard-coded array could be replaced by admin settings
45		*
46		* @var string[]
47		*/
48		private $baseMimeTypes = [
49		'image/png',
50		'image/jpeg',
51		'image/gif',
52		'image/x-xbitmap',
53		'image/bmp',
54		'image/tiff',
55		'image/x-dcraw',
56		'application/x-photoshop',
57		'application/illustrator',
58		'application/postscript',
59		];
60		/**
61		* These types are useful for files preview in the files app, but
62		* not for the gallery side
63		*
64		* @var string[]
65		*/
66		private $slideshowMimeTypes = [
67		'application/font-sfnt',
68		'application/x-font',
69		];
70
71		/**
72		* Constructor
73		*
74		* @param string $appName
75		* @param Environment $environment
76		* @param ConfigParser $configParser
77		* @param Preview $previewManager
78		* @param ILogger $logger
79		*/
80	57	public function __construct(
81		$appName,
82		Environment $environment,
83		ConfigParser $configParser,
84		Preview $previewManager,
85		ILogger $logger
86		) {
87	57	parent::__construct($appName, $environment, $logger);
88
89	57	$this->configParser = $configParser;
90	57	$this->previewManager = $previewManager;
91	57	}
92
93		/**
94		* Returns a list of supported features
95		*
96		* @return string[]
97		*/
98	6	public function getFeaturesList() {
99	6	$featuresList = [];
100		/** @var Folder $rootFolder */
101	6	$rootFolder = $this->environment->getVirtualRootFolder();
102	6	if ($this->isAllowedAndAvailable($rootFolder) && $this->configExists($rootFolder)) {
103		try {
104		$featuresList =
105	5	$this->configParser->getFeaturesList($rootFolder, $this->configName);
106	1	} catch (ConfigException $exception) {
107	1	$featuresList = $this->buildErrorMessage($exception, $rootFolder);
108		}
109		}
110
111	6	return $featuresList;
112		}
113
114		/**
115		* This builds and returns a list of all supported media types
116		*
117		* @todo Native SVG could be disabled via admin settings
118		*
119		* @param bool $extraMediaTypes
120		* @param bool $nativeSvgSupport
121		*
122		* @return string[] all supported media types
123		*/
124	32	public function getSupportedMediaTypes($extraMediaTypes, $nativeSvgSupport) {
125	32	$supportedMimes = [];
126	32	$wantedMimes = $this->baseMimeTypes;
127	32	if ($extraMediaTypes) {
128	24	$wantedMimes = array_merge($wantedMimes, $this->slideshowMimeTypes);
129		}
130	32	foreach ($wantedMimes as $wantedMime) {
131		// Let's see if a preview of files of that media type can be generated
132	32	if ($this->isMimeSupported($wantedMime)) {
133		// We store the media type
134	32	$supportedMimes[] = $wantedMime;
135		}
136		}
137	32	$supportedMimes = $this->addSvgSupport($supportedMimes, $nativeSvgSupport);
138
139		//$this->logger->debug("Supported Mimes: {mimes}", ['mimes' => $supportedMimes]);
140
141	32	return $supportedMimes;
142		}
143
144		/**
145		* Returns the configuration of the currently selected folder
146		*
147		* * information (description, copyright)
148		* * sorting (date, name, inheritance)
149		* * design (colour)
150		* * if the album should be ignored
151		*
152		* @param Folder $folderNode the current folder
153		* @param array $features the list of features retrieved fro the configuration file
154		*
155		* @return array\|null
156		* @throws ForbiddenServiceException
157		*/
158	6	public function getConfig($folderNode, $features) {
159	6	$this->features = $features;
160		list ($albumConfig, $ignored) =
161	6	$this->collectConfig($folderNode, $this->ignoreAlbum, $this->configName);
162	6	if ($ignored) {
163	1	throw new ForbiddenServiceException(
164	1	'The owner has placed a restriction or the storage location is unavailable'
165		);
166		}
167
168	5	return $albumConfig;
169		}
170
171		/**
172		* Throws an exception if the media type of the file is not part of what the app allows
173		*
174		* @param $mimeType
175		*
176		* @throws ForbiddenServiceException
177		*/
178	21	public function validateMimeType($mimeType) {
179	21	if (!in_array($mimeType, $this->getSupportedMediaTypes(true, true))) {
180	6	throw new ForbiddenServiceException('Media type not allowed');
181		}
182	15	}
183
184		/**
185		* Determines if we have a configuration file to work with
186		*
187		* @param Folder $rootFolder the virtual root folder
188		*
189		* @return bool
190		*/
191	6	private function configExists($rootFolder) {
192	6	return $rootFolder && $rootFolder->nodeExists($this->configName);
193		}
194
195		/**
196		* Adds the SVG media type if it's not already there
197		*
198		* If it's enabled, but doesn't work, an exception will be raised when trying to generate a
199		* preview. If it's disabled, we support it via the browser's native support
200		*
201		* @param string[] $supportedMimes
202		* @param bool $nativeSvgSupport
203		*
204		* @return string[]
205		*/
206	36	private function addSvgSupport($supportedMimes, $nativeSvgSupport) {
207	36	if (!in_array('image/svg+xml', $supportedMimes) && $nativeSvgSupport) {
208	24	$supportedMimes[] = 'image/svg+xml';
209		}
210
211	36	return $supportedMimes;
212		}
213
214		/**
215		* Returns true if the passed mime type is supported
216		*
217		* In case of a failure, we just return that the media type is not supported
218		*
219		* @param string $mimeType
220		*
221		* @return boolean
222		*/
223	32	private function isMimeSupported($mimeType = '*') {
224		try {
225	32	return $this->previewManager->isMimeSupported($mimeType);
226	1	} catch (\Exception $exception) {
227	1	unset($exception);
228
229	1	return false;
230		}
231		}
232
233		/**
234		* Returns an album configuration array
235		*
236		* Goes through all the parent folders until either we're told the album is private or we've
237		* reached the root folder
238		*
239		* @param Folder $folder the current folder
240		* @param string $ignoreAlbum name of the file which blacklists folders
241		* @param string $configName name of the configuration file
242		* @param int $level the starting level is 0 and we add 1 each time we visit a parent folder
243		* @param array $configSoFar the configuration collected so far
244		*
245		* @return array <null\|array,bool>
246		*/
247	6	private function collectConfig(
248		$folder, $ignoreAlbum, $configName, $level = 0, $configSoFar = []
249		) {
250	6	if ($folder->nodeExists($ignoreAlbum)) {
251		// Cancel as soon as we find out that the folder is private or external
252	1	return [null, true];
253		}
254	5	$isRootFolder = $this->isRootFolder($folder, $level);
255	5	if ($folder->nodeExists($configName)) {
256	4	$configSoFar = $this->buildFolderConfig($folder, $configName, $configSoFar, $level);
257		}
258	5	if (!$isRootFolder) {
259	1	return $this->getParentConfig($folder, $ignoreAlbum, $configName, $level, $configSoFar);
260		}
261	5	$configSoFar = $this->validatesInfoConfig($configSoFar);
262
263		// We have reached the root folder
264	5	return [$configSoFar, false];
265		}
266
267		/**
268		* Returns a parsed configuration if one was found in the current folder or generates an error
269		* message to send back
270		*
271		* @param Folder $folder the current folder
272		* @param string $configName name of the configuration file
273		* @param array $collectedConfig the configuration collected so far
274		* @param int $level the starting level is 0 and we add 1 each time we visit a parent folder
275		*
276		* @return array
277		*/
278	5	private function buildFolderConfig($folder, $configName, $collectedConfig, $level) {
279		try {
280	5	list($collectedConfig, $completionStatus) = $this->configParser->getFolderConfig(
281	5	$folder, $configName, $collectedConfig, $this->completionStatus, $level
282		);
283	4	$this->completionStatus = $completionStatus;
284	1	} catch (ConfigException $exception) {
285	1	$collectedConfig = $this->buildErrorMessage($exception, $folder);
286		}
287
288	5	return $collectedConfig;
289		}
290
291		/**
292		* Builds the error message to send back when there is an error
293		*
294		* @fixme Missing translation
295		*
296		* @param ConfigException $exception
297		* @param Folder $folder the current folder
298		*
299		* @return array<array<string,string>,bool>
300		*/
301	2	private function buildErrorMessage($exception, $folder) {
302	2	$configPath = $this->environment->getPathFromVirtualRoot($folder);
303	2	$errorMessage = $exception->getMessage() . ". Config location: /$configPath";
304	2	$this->logger->error($errorMessage);
305	2	$config = ['error' => ['message' => $errorMessage]];
306
307	2	$completionStatus = $this->completionStatus;
308	2	foreach ($completionStatus as $key) {
309	2	$completionStatus[$key] = true;
310		}
311	2	$this->completionStatus = $completionStatus;
312
313	2	return [$config];
314		}
315
316		/**
317		* Removes links if they were collected outside of the virtual root
318		*
319		* This is for shared folders which have a virtual root
320		*
321		* @param array $albumConfig
322		*
323		* @return array
324		*/
325	8	private function validatesInfoConfig($albumConfig) {
326	8	$this->virtualRootLevel;
327	8	if (array_key_exists('information', $albumConfig)) {
328	7	$info = $albumConfig['information'];
329	7	if (array_key_exists('level', $info)) {
330	7	$level = $info['level'];
331	7	if ($level > $this->virtualRootLevel) {
332	1	$albumConfig['information']['description_link'] = null;
333	1	$albumConfig['information']['copyright_link'] = null;
334		}
335		}
336		}
337
338	8	return $albumConfig;
339		}
340
341		/**
342		* Looks for an album configuration in the parent folder
343		*
344		* We will look up to the virtual root of a shared folder, for privacy reasons
345		*
346		* @param Folder $folder the current folder
347		* @param string $privacyChecker name of the file which blacklists folders
348		* @param string $configName name of the configuration file
349		* @param int $level the starting level is 0 and we add 1 each time we visit a parent folder
350		* @param array $collectedConfig the configuration collected so far
351		*
352		* @return array<null\|array,bool>
353		*/
354	1	private function getParentConfig($folder, $privacyChecker, $configName, $level, $collectedConfig
355		) {
356	1	$parentFolder = $folder->getParent();
357	1	$level++;
358
359	1	return $this->collectConfig(
360		$parentFolder, $privacyChecker, $configName, $level, $collectedConfig
361		);
362		}
363
364		}
365

interfasys / galleryplus

Pull Request — master (#39)

ConfigService::collectConfig() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like