ImageManager::getImage() - Code Metrics - Inspection of "Merge pull request #8540 from nextcloud/theming-ad..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3e14f2...b3a0de )

by Morris

created 2018-04-25 06:47 UTC

ImageManager::getImage() A

↳ Parent: ImageManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	1
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2016 Julius Härtl <[email protected]>
 *
 * @author Julius Haertl <[email protected]>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


namespace OCA\Theming;

use OCP\Files\SimpleFS\ISimpleFile;
use OCP\Files\SimpleFS\ISimpleFolder;
use OCP\IConfig;
use OCP\Files\IAppData;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use OCP\IURLGenerator;

/**
 * @property IURLGenerator urlGenerator
 */
class ImageManager {

	/** @var IConfig */
	private $config;
	/** @var IAppData */
	private $appData;

	/** @var array */
	private $supportedImageKeys = ['background', 'logo', 'logoheader', 'favicon'];

	/**
	 * ImageManager constructor.
	 *
	 * @param IConfig $config
	 * @param IAppData $appData
	 * @param IURLGenerator $urlGenerator
	 */
	public function __construct(IConfig $config,
								IAppData $appData,
								IURLGenerator $urlGenerator
	) {
		$this->config = $config;
		$this->appData = $appData;
		$this->urlGenerator = $urlGenerator;
	}

	public function getImageUrl(string $key): string {
		$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
		try {
			$this->getImage($key);
			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
		} catch (NotFoundException $e) {

		}

		switch ($key) {
			case 'logo':
			case 'logoheader':
			case 'favicon':
				return $this->urlGenerator->imagePath('core', 'logo.png') . '?v=' . $cacheBusterCounter;
			case 'background':
				return $this->urlGenerator->imagePath('core', 'background.png') . '?v=' . $cacheBusterCounter;
		}
	}

	public function getImageUrlAbsolute(string $key): string {
		return $this->urlGenerator->getAbsoluteURL($this->getImageUrl($key));
	}

	/**
	 * @param $key
	 * @return ISimpleFile
	 * @throws NotFoundException
	 */
	public function getImage(string $key): ISimpleFile {
		$logo = $this->config->getAppValue('theming', $key . 'Mime', false);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($logo === false) {
			throw new NotFoundException();
		}
		$folder = $this->appData->getFolder('images');
		return $folder->getFile($key);
	}

	public function getCustomImages(): array {
		$images = [];
		foreach ($this->supportedImageKeys as $key) {
			$images[$key] = [
				'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''),
				'url' => $this->getImageUrl($key),
			];
		}
		return $images;
	}

	/**
	 * Get folder for current theming files
	 *
	 * @return ISimpleFolder
	 * @throws NotPermittedException
	 */
	public function getCacheFolder(): ISimpleFolder {
		$cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
		try {
			$folder = $this->appData->getFolder($cacheBusterValue);
		} catch (NotFoundException $e) {
			$folder = $this->appData->newFolder($cacheBusterValue);
			$this->cleanup();
		}
		return $folder;
	}

	/**
	 * Get a file from AppData
	 *
	 * @param string $filename
	 * @throws NotFoundException
	 * @return \OCP\Files\SimpleFS\ISimpleFile
	 * @throws NotPermittedException
	 */
	public function getCachedImage(string $filename): ISimpleFile {
		$currentFolder = $this->getCacheFolder();
		return $currentFolder->getFile($filename);
	}

	/**
	 * Store a file for theming in AppData
	 *
	 * @param string $filename
	 * @param string $data
	 * @return \OCP\Files\SimpleFS\ISimpleFile
	 * @throws NotFoundException
	 * @throws NotPermittedException
	 */
	public function setCachedImage(string $filename, string $data): ISimpleFile {
		$currentFolder = $this->getCacheFolder();
		if ($currentFolder->fileExists($filename)) {
			$file = $currentFolder->getFile($filename);
		} else {
			$file = $currentFolder->newFile($filename);
		}
		$file->putContent($data);
		return $file;
	}

	public function delete(string $key) {
		try {
			$file = $this->appData->getFolder('images')->getFile($key);
			$file->delete();
		} catch (NotFoundException $e) {

		} catch (NotPermittedException $e) {

		}
	}

	/**
	 * remove cached files that are not required any longer
	 *
	 * @throws NotPermittedException
	 * @throws NotFoundException
	 */
	public function cleanup() {
		$currentFolder = $this->getCacheFolder();
		$folders = $this->appData->getDirectoryListing();
		foreach ($folders as $folder) {
			if ($folder->getName() !== 'images' && $folder->getName() !== $currentFolder->getName()) {
				$folder->delete();
			}
		}
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016 Julius Härtl <[email protected]>
4			*
5			* @author Julius Haertl <[email protected]>
6			*
7			* @license GNU AGPL version 3 or any later version
8			*
9			* This program is free software: you can redistribute it and/or modify
10			* it under the terms of the GNU Affero General Public License as
11			* published by the Free Software Foundation, either version 3 of the
12			* License, or (at your option) any later version.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU Affero General Public License for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public License
20			* along with this program. If not, see <http://www.gnu.org/licenses/>.
21			*
22			*/
23
24
25			namespace OCA\Theming;
26
27			use OCP\Files\SimpleFS\ISimpleFile;
28			use OCP\Files\SimpleFS\ISimpleFolder;
29			use OCP\IConfig;
30			use OCP\Files\IAppData;
31			use OCP\Files\NotFoundException;
32			use OCP\Files\NotPermittedException;
33			use OCP\IURLGenerator;
34
35			/**
36			* @property IURLGenerator urlGenerator
37			*/
38			class ImageManager {
39
40			/** @var IConfig */
41			private $config;
42			/** @var IAppData */
43			private $appData;
44
45			/** @var array */
46			private $supportedImageKeys = ['background', 'logo', 'logoheader', 'favicon'];
47
48			/**
49			* ImageManager constructor.
50			*
51			* @param IConfig $config
52			* @param IAppData $appData
53			* @param IURLGenerator $urlGenerator
54			*/
55			public function __construct(IConfig $config,
56			IAppData $appData,
57			IURLGenerator $urlGenerator
58			) {
59			$this->config = $config;
60			$this->appData = $appData;
61			$this->urlGenerator = $urlGenerator;
62			}
63
64			public function getImageUrl(string $key): string {
65			$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
66			try {
67			$this->getImage($key);
68			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
69			} catch (NotFoundException $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2018-02-26 14:02 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
70			}
71
72			switch ($key) {
73			case 'logo':
74			case 'logoheader':
75			case 'favicon':
76			return $this->urlGenerator->imagePath('core', 'logo.png') . '?v=' . $cacheBusterCounter;
77			case 'background':
78			return $this->urlGenerator->imagePath('core', 'background.png') . '?v=' . $cacheBusterCounter;
79			}
80			}
81
82			public function getImageUrlAbsolute(string $key): string {
83			return $this->urlGenerator->getAbsoluteURL($this->getImageUrl($key));
84			}
85
86			/**
87			* @param $key
88			* @return ISimpleFile
89			* @throws NotFoundException
90			*/
91			public function getImage(string $key): ISimpleFile {
92			$logo = $this->config->getAppValue('theming', $key . 'Mime', false);
			0 ignored issues – show Documentation introduced 2017-03-21 12:53 UTC by Report Bug Copy Issue Report `false` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
93			if ($logo === false) {
94			throw new NotFoundException();
95			}
96			$folder = $this->appData->getFolder('images');
97			return $folder->getFile($key);
98			}
99
100			public function getCustomImages(): array {
101			$images = [];
102			foreach ($this->supportedImageKeys as $key) {
103			$images[$key] = [
104			'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''),
105			'url' => $this->getImageUrl($key),
106			];
107			}
108			return $images;
109			}
110
111			/**
112			* Get folder for current theming files
113			*
114			* @return ISimpleFolder
115			* @throws NotPermittedException
116			*/
117			public function getCacheFolder(): ISimpleFolder {
118			$cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
119			try {
120			$folder = $this->appData->getFolder($cacheBusterValue);
121			} catch (NotFoundException $e) {
122			$folder = $this->appData->newFolder($cacheBusterValue);
123			$this->cleanup();
124			}
125			return $folder;
126			}
127
128			/**
129			* Get a file from AppData
130			*
131			* @param string $filename
132			* @throws NotFoundException
133			* @return \OCP\Files\SimpleFS\ISimpleFile
134			* @throws NotPermittedException
135			*/
136			public function getCachedImage(string $filename): ISimpleFile {
137			$currentFolder = $this->getCacheFolder();
138			return $currentFolder->getFile($filename);
139			}
140
141			/**
142			* Store a file for theming in AppData
143			*
144			* @param string $filename
145			* @param string $data
146			* @return \OCP\Files\SimpleFS\ISimpleFile
147			* @throws NotFoundException
148			* @throws NotPermittedException
149			*/
150			public function setCachedImage(string $filename, string $data): ISimpleFile {
151			$currentFolder = $this->getCacheFolder();
152			if ($currentFolder->fileExists($filename)) {
153			$file = $currentFolder->getFile($filename);
154			} else {
155			$file = $currentFolder->newFile($filename);
156			}
157			$file->putContent($data);
158			return $file;
159			}
160
161			public function delete(string $key) {
162			try {
163			$file = $this->appData->getFolder('images')->getFile($key);
164			$file->delete();
165			} catch (NotFoundException $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2018-03-28 15:38 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
166			} catch (NotPermittedException $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2018-04-20 15:11 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
167			}
168			}
169
170			/**
171			* remove cached files that are not required any longer
172			*
173			* @throws NotPermittedException
174			* @throws NotFoundException
175			*/
176			public function cleanup() {
177			$currentFolder = $this->getCacheFolder();
178			$folders = $this->appData->getDirectoryListing();
179			foreach ($folders as $folder) {
180			if ($folder->getName() !== 'images' && $folder->getName() !== $currentFolder->getName()) {
181			$folder->delete();
182			}
183			}
184			}
185			}
186

nextcloud / server

Push — master ( 3e14f2...b3a0de )

ImageManager::getImage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like