FileService::downloaldFile() - Code Metrics - Inspection of "Misc scrutinizer-ci fixes" - matiasdelellis/facerecognition - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — self-contained-model ( bb7bfd...ccd208 )

by Matias

created 2020-02-18 01:44 UTC

FileService::downloaldFile() A

↳ Parent: Project

Complexity

Conditions	5
Paths	6

Size

Total Lines	51
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes

Metric	Value
cc	5
eloc	36
c	0
b	0
f	0
nc	6
nop	1
dl	0
loc	51
ccs	0
cts	28
cp	0
crap	30
rs	9.0328

How to fix Long Method

<?php
declare(strict_types=1);

/**
 * @copyright Copyright (c) 2019-2020 Matias De lellis <[email protected]>
 *
 * @author Matias De lellis <[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\FaceRecognition\Service;

use OCP\Files\IRootFolder;
use OCP\Files\File;
use OCP\Files\Folder;
use OCP\Files\Node;
use OCP\ITempManager;

use OCP\Files\IHomeStorage;
use OCP\Files\NotFoundException;

use OCA\Files_Sharing\External\Storage as SharingExternalStorage;

use OCA\FaceRecognition\Helper\Requirements;
use OCA\FaceRecognition\Service\SettingsService;

class FileService {

	const NOMEDIA_FILE = ".nomedia";

	const FACERECOGNITION_SETTINGS_FILE = ".facerecognition.json";

	/**  @var string|null */
	private $userId;

	/** @var IRootFolder */
	private $rootFolder;

	/** @var ITempManager */
	private $tempManager;

	/** @var SettingsService */
	private $settingsService;

	public function __construct($userId,
	                            IRootFolder     $rootFolder,
	                            ITempManager    $tempManager,
	                            SettingsService $settingsService)
	{
		$this->userId          = $userId;
		$this->rootFolder      = $rootFolder;
		$this->tempManager     = $tempManager;
		$this->settingsService = $settingsService;
	}

	/**
	 * TODO: Describe exactly when necessary.
	 */
	public function setupFS(string $userId) {
		\OC_Util::tearDownFS();
		\OC_Util::setupFS($userId);

		$this->userId = $userId;
	}

	/**
	 * Get a Node from userFolder
	 * @param int $id the id of the Node
	 * @param string $userId
	 * @return Node | null
	 */
	public function getFileById($fileId, $userId = null): ?Node {
		$files = $this->rootFolder->getUserFolder($this->userId ?? $userId)->getById($fileId);
		if (count($files) === 0) {
			return null;
		}

		return $files[0];
	}

	/**
	 * Get a Node from userFolder
	 * @param string $fullpath the fullpath of the Node
	 * @param string $userId
	 * @return Node | null
	 */
	public function getFileByPath($fullpath, $userId = null): ?Node {
		$file = $this->rootFolder->getUserFolder($this->userId ?? $userId)->get($fullpath);
		return $file;
	}

	/**
	 * Checks if this file is located somewhere under .nomedia file and should be therefore ignored.
	 * Or with an .facerecognition.json setting file that disable tha analysis
	 *
	 * @param File $file File to search for
	 * @return bool True if file is located under .nomedia or .facerecognition.json that disabled
	 * analysis, false otherwise
	 */
	public function isUnderNoDetection(Node $node): bool {
		// If we detect .nomedia file anywhere on the path to root folder (id===null), bail out
		$parentNode = $node->getParent();
		while (($parentNode instanceof Folder) && ($parentNode->getId() !== null)) {
			$allowDetection = $this->getDescendantDetection($parentNode);
			if (!$allowDetection)
				return true;
			$parentNode = $parentNode->getParent();
		}
		return false;
	}

	/**
	 * Checks if this folder has .nomedia file an .facerecognition.json setting file that
	 * disable that analysis.
	 *
	 * @param Folder $folder Folder to search for
	 * @return bool true if folder dont have an .nomedia file or .facerecognition.json that disabled
	 * analysis, false otherwise
	 */
	public function getDescendantDetection(Folder $folder): bool {
		if ($folder->nodeExists(FileService::NOMEDIA_FILE)) {
			return false;
		}
		if ($folder->nodeExists(FileService::FACERECOGNITION_SETTINGS_FILE)) {
			$file = $folder->get(FileService::FACERECOGNITION_SETTINGS_FILE);
			$settings = json_decode($file->getContent(), true);
			if ($settings === null || !array_key_exists('detection', $settings))
				return true;

			if ($settings['detection'] === 'off')
				return false;
		}

		return true;
	}

	/**
	 * Set this folder to enable or disable the analysis using the .facerecognition.json file.
	 *
	 * @param Folder $folder Folder to enable/disable for
	 * @return bool true if the change is done. False if failed.
	 */
	public function setDescendantDetection(Folder $folder, bool $detection): bool {
		if ($folder->nodeExists(FileService::FACERECOGNITION_SETTINGS_FILE)) {
			$file = $folder->get(FileService::FACERECOGNITION_SETTINGS_FILE);
			$settings = json_decode($file->getContent(), true);
			if ($settings === null) {
				// Invalid json.
				return false;
			}
		}
		else {
			$file = $folder->newFile(FileService::FACERECOGNITION_SETTINGS_FILE);
			$settings = array();
		}

		$settings['detection'] = $detection ? "on" : "off";
		$file->putContent(json_encode($settings));

		return true;
	}

	/**
	 * Returns if the file is inside a shared storage.
	 */
	public function isSharedFile(Node $node): bool {
		return $node->getStorage()->instanceOfStorage(SharingExternalStorage::class);
	}

	/**
	 * Returns if the file is inside HomeStorage.
	 */
	public function isUserFile(Node $node): bool {
		return $node->getStorage()->instanceOfStorage(IHomeStorage::class);
	}

	/**
	 * Returns if the Node is allowed based on preferences.
	 */
	public function isAllowedNode(Node $node): bool {
		if ($this->isUserFile($node)) {
			return true;
		} else if ($this->isSharedFile($node)) {
			return $this->settingsService->getHandleSharedFiles();
		}
		return false;
	}

	/**
	 * Get a path to either the local file or temporary file
	 *
	 * @param File $file
	 * @param int $maxSize maximum size for temporary files
	 * @return string
	 */
	public function getLocalFile(File $file, int $maxSize = null): string {
		$useTempFile = $file->isEncrypted() || !$file->getStorage()->isLocal();
		if ($useTempFile) {
			$absPath = $this->tempManager->getTemporaryFile();

			$content = $file->fopen('r');
			if ($maxSize !== null) {
				$content = stream_get_contents($content, $maxSize);
			}
			file_put_contents($absPath, $content);

			return $absPath;
		} else {
			return $file->getStorage()->getLocalFile($file->getInternalPath());
		}
	}

	/**
	 * Return all images from a given folder.
	 *
	 * TODO: It is inefficient since it copies the array recursively.
	 *
	 * @param Folder $folder Folder to get images from
	 * @return array List of all images and folders to continue recursive crawling
	 */
	public function getPicturesFromFolder(Folder $folder, $results = array()) {
		$nodes = $folder->getDirectoryListing();
		foreach ($nodes as $node) {
			if (!$this->isAllowedNode($node)) {
				continue;
			}
			if ($node instanceof Folder && $this->getDescendantDetection($node)) {
				$results = $this->getPicturesFromFolder($node, $results);
			}
			else if ($node instanceof File) {
				if (Requirements::isImageTypeSupported($node->getMimeType())) {
					$results[] = $node;
				}
			}
		}
		return $results;
	}


	/**
	 * Download a file in a temporary folder
	 *
	 * @param string $fileUrl url to download.
	 * @return string temp file downloaded.
	 *
	 * @throws \Exception
	 */
	public function downloaldFile(string $fileUrl): string {
		$tempFolder = $this->tempManager->getTemporaryFolder('/facerecognition/');
		$tempFile = $tempFolder . basename($fileUrl);

		$fp = fopen(, 'w+');

		if ($fp === false) {
			throw new \Exception('Could not open the file to write: ' . $tempFile);
		}

		$ch = curl_init($fileUrl);
		if ($ch === false) {
			throw new \Exception('Curl error: ' . curl_error($ch));
		}

		curl_setopt_array($ch, [
			CURLOPT_FILE => $fp,
			CURLOPT_FOLLOWLOCATION => true,
			CURLOPT_SSL_VERIFYPEER => false,
			CURLOPT_SSL_VERIFYHOST => 0,
			CURLOPT_USERAGENT => 'Nextcloud Facerecognition Service',
		]);

		if (curl_exec($ch) === false) {
			throw new \Exception('Curl error: ' . curl_error($ch));
		}

		$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
		if ($httpCode !== 200) {
			$statusCodes = [
				400 => 'Bad request',
				401 => 'Unauthorized',
				403 => 'Forbidden',
				404 => 'Not Found',
				500 => 'Internal Server Error',
				502 => 'Bad Gateway',
				503 => 'Service Unavailable',
				504 => 'Gateway Timeout',
			];

			$message = 'Download failed';
			if(isset($statusCodes[$httpCode])) {
				$message .= ' - ' . $statusCodes[$httpCode] . ' (HTTP ' . $httpCode . ')';
			} else {
				$message .= ' - HTTP status code: ' . $httpCode;
			}

			$curlErrorMessage = curl_error($ch);
			if(!empty($curlErrorMessage)) {
				$message .= ' - curl error message: ' . $curlErrorMessage;
			}
			$message .= ' - URL: ' . htmlentities($fileUrl);

			throw new \Exception($message);
		}

		curl_close($ch);
		fclose($fp);

		return $tempFile;
	}

	/**
	 * Uncompressing the file with the bzip2-extension
	 *
	 * @param string $in
	 * @param string $out
	 *
	 * @throws \Exception
	 */
	public function bunzip2 ($in, $out) {
		if (!file_exists ($in) || !is_readable ($in))
			throw new \Exception('The file '.$in.' not exists or is not readable');

		if ((!file_exists ($out) && !is_writeable (dirname ($out)) || (file_exists($out) && !is_writable($out)) ))
			throw new \Exception('The file '.$out.' exists or is not writable');

		$in_file = bzopen ($in, "r");
		$out_file = fopen ($out, "w");

		if ($out_file === false)
			throw new \Exception('Could not open the file to write: ' . $out_file);

		while ($buffer = bzread ($in_file, 4096)) {
			if($buffer === false)
				throw new \Exception('Read problem: ' . bzerrstr($in_file));
			if(bzerrno($in_file) !== 0)
				throw new \Exception('Compression problem: '. bzerrstr($in_file));

			fwrite ($out_file, $buffer, 4096);
		}

		bzclose ($in_file);
		fclose ($out_file);
	}

	/**
	 * Create a temporary file and return the path
	 */
	public function getTemporaryFile(string $postFix = ''): string {
		return $this->tempManager->getTemporaryFile($postFix);
	}

	/**
	 * Remove any temporary file from the service.
	 */
	public function clean() {
		$this->tempManager->clean();
	}

}


1			<?php
2			declare(strict_types=1);
3
4			/**
5			* @copyright Copyright (c) 2019-2020 Matias De lellis <[email protected]>
6			*
7			* @author Matias De lellis <[email protected]>
8			*
9			* @license GNU AGPL version 3 or any later version
10			*
11			* This program is free software: you can redistribute it and/or modify
12			* it under the terms of the GNU Affero General Public License as
13			* published by the Free Software Foundation, either version 3 of the
14			* License, or (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU Affero General Public License for more details.
20			*
21			* You should have received a copy of the GNU Affero General Public License
22			* along with this program. If not, see <http://www.gnu.org/licenses/>.
23			*
24			*/
25
26			namespace OCA\FaceRecognition\Service;
27
28			use OCP\Files\IRootFolder;
29			use OCP\Files\File;
30			use OCP\Files\Folder;
31			use OCP\Files\Node;
32			use OCP\ITempManager;
33
34			use OCP\Files\IHomeStorage;
35			use OCP\Files\NotFoundException;
36
37			use OCA\Files_Sharing\External\Storage as SharingExternalStorage;
38
39			use OCA\FaceRecognition\Helper\Requirements;
40			use OCA\FaceRecognition\Service\SettingsService;
41
42			class FileService {
43
44			const NOMEDIA_FILE = ".nomedia";
45
46			const FACERECOGNITION_SETTINGS_FILE = ".facerecognition.json";
47
48			/** @var string\|null */
49			private $userId;
50
51			/** @var IRootFolder */
52			private $rootFolder;
53
54			/** @var ITempManager */
55			private $tempManager;
56
57			/** @var SettingsService */
58			private $settingsService;
59
60			public function __construct($userId,
61			IRootFolder $rootFolder,
62			ITempManager $tempManager,
63			SettingsService $settingsService)
64			{
65			$this->userId = $userId;
66			$this->rootFolder = $rootFolder;
67			$this->tempManager = $tempManager;
68			$this->settingsService = $settingsService;
69			}
70
71			/**
72			* TODO: Describe exactly when necessary.
73			*/
74			public function setupFS(string $userId) {
75			\OC_Util::tearDownFS();
76			\OC_Util::setupFS($userId);
77
78			$this->userId = $userId;
79			}
80
81			/**
82			* Get a Node from userFolder
83			* @param int $id the id of the Node
84			* @param string $userId
85			* @return Node \| null
86			*/
87			public function getFileById($fileId, $userId = null): ?Node {
88			$files = $this->rootFolder->getUserFolder($this->userId ?? $userId)->getById($fileId);
89			if (count($files) === 0) {
90			return null;
91			}
92
93			return $files[0];
94			}
95
96			/**
97			* Get a Node from userFolder
98			* @param string $fullpath the fullpath of the Node
99			* @param string $userId
100			* @return Node \| null
101			*/
102			public function getFileByPath($fullpath, $userId = null): ?Node {
103			$file = $this->rootFolder->getUserFolder($this->userId ?? $userId)->get($fullpath);
104			return $file;
105			}
106
107			/**
108			* Checks if this file is located somewhere under .nomedia file and should be therefore ignored.
109			* Or with an .facerecognition.json setting file that disable tha analysis
110			*
111			* @param File $file File to search for
112			* @return bool True if file is located under .nomedia or .facerecognition.json that disabled
113			* analysis, false otherwise
114			*/
115			public function isUnderNoDetection(Node $node): bool {
116			// If we detect .nomedia file anywhere on the path to root folder (id===null), bail out
117			$parentNode = $node->getParent();
118			while (($parentNode instanceof Folder) && ($parentNode->getId() !== null)) {
119			$allowDetection = $this->getDescendantDetection($parentNode);
120			if (!$allowDetection)
121			return true;
122			$parentNode = $parentNode->getParent();
123			}
124			return false;
125			}
126
127			/**
128			* Checks if this folder has .nomedia file an .facerecognition.json setting file that
129			* disable that analysis.
130			*
131			* @param Folder $folder Folder to search for
132			* @return bool true if folder dont have an .nomedia file or .facerecognition.json that disabled
133			* analysis, false otherwise
134			*/
135			public function getDescendantDetection(Folder $folder): bool {
136			if ($folder->nodeExists(FileService::NOMEDIA_FILE)) {
137			return false;
138			}
139			if ($folder->nodeExists(FileService::FACERECOGNITION_SETTINGS_FILE)) {
140			$file = $folder->get(FileService::FACERECOGNITION_SETTINGS_FILE);
141			$settings = json_decode($file->getContent(), true);
142			if ($settings === null \|\| !array_key_exists('detection', $settings))
143			return true;
144
145			if ($settings['detection'] === 'off')
146			return false;
147			}
148
149			return true;
150			}
151
152			/**
153			* Set this folder to enable or disable the analysis using the .facerecognition.json file.
154			*
155			* @param Folder $folder Folder to enable/disable for
156			* @return bool true if the change is done. False if failed.
157			*/
158			public function setDescendantDetection(Folder $folder, bool $detection): bool {
159			if ($folder->nodeExists(FileService::FACERECOGNITION_SETTINGS_FILE)) {
160			$file = $folder->get(FileService::FACERECOGNITION_SETTINGS_FILE);
161			$settings = json_decode($file->getContent(), true);
162			if ($settings === null) {
163			// Invalid json.
164			return false;
165			}
166			}
167			else {
168			$file = $folder->newFile(FileService::FACERECOGNITION_SETTINGS_FILE);
169			$settings = array();
170			}
171
172			$settings['detection'] = $detection ? "on" : "off";
173			$file->putContent(json_encode($settings));
174
175			return true;
176			}
177
178			/**
179			* Returns if the file is inside a shared storage.
180			*/
181			public function isSharedFile(Node $node): bool {
182			return $node->getStorage()->instanceOfStorage(SharingExternalStorage::class);
183			}
184
185			/**
186			* Returns if the file is inside HomeStorage.
187			*/
188			public function isUserFile(Node $node): bool {
189			return $node->getStorage()->instanceOfStorage(IHomeStorage::class);
190			}
191
192			/**
193			* Returns if the Node is allowed based on preferences.
194			*/
195			public function isAllowedNode(Node $node): bool {
196			if ($this->isUserFile($node)) {
197			return true;
198			} else if ($this->isSharedFile($node)) {
199			return $this->settingsService->getHandleSharedFiles();
200			}
201			return false;
202			}
203
204			/**
205			* Get a path to either the local file or temporary file
206			*
207			* @param File $file
208			* @param int $maxSize maximum size for temporary files
209			* @return string
210			*/
211			public function getLocalFile(File $file, int $maxSize = null): string {
212			$useTempFile = $file->isEncrypted() \|\| !$file->getStorage()->isLocal();
213			if ($useTempFile) {
214			$absPath = $this->tempManager->getTemporaryFile();
215
216			$content = $file->fopen('r');
217			if ($maxSize !== null) {
218			$content = stream_get_contents($content, $maxSize);
219			}
220			file_put_contents($absPath, $content);
221
222			return $absPath;
223			} else {
224			return $file->getStorage()->getLocalFile($file->getInternalPath());
225			}
226			}
227
228			/**
229			* Return all images from a given folder.
230			*
231			* TODO: It is inefficient since it copies the array recursively.
232			*
233			* @param Folder $folder Folder to get images from
234			* @return array List of all images and folders to continue recursive crawling
235			*/
236			public function getPicturesFromFolder(Folder $folder, $results = array()) {
237			$nodes = $folder->getDirectoryListing();
238			foreach ($nodes as $node) {
239			if (!$this->isAllowedNode($node)) {
240			continue;
241			}
242			if ($node instanceof Folder && $this->getDescendantDetection($node)) {
243			$results = $this->getPicturesFromFolder($node, $results);
244			}
245			else if ($node instanceof File) {
246			if (Requirements::isImageTypeSupported($node->getMimeType())) {
247			$results[] = $node;
248			}
249			}
250			}
251			return $results;
252			}
253
254
255			/**
256			* Download a file in a temporary folder
257			*
258			* @param string $fileUrl url to download.
259			* @return string temp file downloaded.
260			*
261			* @throws \Exception
262			*/
263			public function downloaldFile(string $fileUrl): string {
264			$tempFolder = $this->tempManager->getTemporaryFolder('/facerecognition/');
265			$tempFile = $tempFolder . basename($fileUrl);
266
267			$fp = fopen(, 'w+');
			0 ignored issues – show Bug introduced 2020-02-18 01:50 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected ',' on line 267 at column 14 Loading history...
268			if ($fp === false) {
269			throw new \Exception('Could not open the file to write: ' . $tempFile);
270			}
271
272			$ch = curl_init($fileUrl);
273			if ($ch === false) {
274			throw new \Exception('Curl error: ' . curl_error($ch));
275			}
276
277			curl_setopt_array($ch, [
278			CURLOPT_FILE => $fp,
279			CURLOPT_FOLLOWLOCATION => true,
280			CURLOPT_SSL_VERIFYPEER => false,
281			CURLOPT_SSL_VERIFYHOST => 0,
282			CURLOPT_USERAGENT => 'Nextcloud Facerecognition Service',
283			]);
284
285			if (curl_exec($ch) === false) {
286			throw new \Exception('Curl error: ' . curl_error($ch));
287			}
288
289			$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
290			if ($httpCode !== 200) {
291			$statusCodes = [
292			400 => 'Bad request',
293			401 => 'Unauthorized',
294			403 => 'Forbidden',
295			404 => 'Not Found',
296			500 => 'Internal Server Error',
297			502 => 'Bad Gateway',
298			503 => 'Service Unavailable',
299			504 => 'Gateway Timeout',
300			];
301
302			$message = 'Download failed';
303			if(isset($statusCodes[$httpCode])) {
304			$message .= ' - ' . $statusCodes[$httpCode] . ' (HTTP ' . $httpCode . ')';
305			} else {
306			$message .= ' - HTTP status code: ' . $httpCode;
307			}
308
309			$curlErrorMessage = curl_error($ch);
310			if(!empty($curlErrorMessage)) {
311			$message .= ' - curl error message: ' . $curlErrorMessage;
312			}
313			$message .= ' - URL: ' . htmlentities($fileUrl);
314
315			throw new \Exception($message);
316			}
317
318			curl_close($ch);
319			fclose($fp);
320
321			return $tempFile;
322			}
323
324			/**
325			* Uncompressing the file with the bzip2-extension
326			*
327			* @param string $in
328			* @param string $out
329			*
330			* @throws \Exception
331			*/
332			public function bunzip2 ($in, $out) {
333			if (!file_exists ($in) \|\| !is_readable ($in))
334			throw new \Exception('The file '.$in.' not exists or is not readable');
335
336			if ((!file_exists ($out) && !is_writeable (dirname ($out)) \|\| (file_exists($out) && !is_writable($out)) ))
337			throw new \Exception('The file '.$out.' exists or is not writable');
338
339			$in_file = bzopen ($in, "r");
340			$out_file = fopen ($out, "w");
341
342			if ($out_file === false)
343			throw new \Exception('Could not open the file to write: ' . $out_file);
344
345			while ($buffer = bzread ($in_file, 4096)) {
346			if($buffer === false)
347			throw new \Exception('Read problem: ' . bzerrstr($in_file));
348			if(bzerrno($in_file) !== 0)
349			throw new \Exception('Compression problem: '. bzerrstr($in_file));
350
351			fwrite ($out_file, $buffer, 4096);
352			}
353
354			bzclose ($in_file);
355			fclose ($out_file);
356			}
357
358			/**
359			* Create a temporary file and return the path
360			*/
361			public function getTemporaryFile(string $postFix = ''): string {
362			return $this->tempManager->getTemporaryFile($postFix);
363			}
364
365			/**
366			* Remove any temporary file from the service.
367			*/
368			public function clean() {
369			$this->tempManager->clean();
370			}
371
372			}
373

matiasdelellis / facerecognition

Push — self-contained-model ( bb7bfd...ccd208 )

FileService::downloaldFile() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like