DlibCnnModel::getId() - Code Metrics - Inspection of "Bump minimist from 1.2.5 to 1.2.6" - matiasdelellis/facerecognition - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dependabot/npm_and_yarn/minimi... ( f33d6d )

unknown

created 2022-04-11 19:29 UTC

DlibCnnModel::getId() A

↳ Parent: DlibCnnModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
/**
 * @copyright Copyright (c) 2021, Matias De lellis <[email protected]>
 * @copyright Copyright (c) 2018, Branko Kokanovic <[email protected]>
 *
 * @author Branko Kokanovic <[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\Model\DlibCnnModel;

use OCP\IDBConnection;

use OCA\FaceRecognition\Helper\MemoryLimits;

use OCA\FaceRecognition\Service\FileService;
use OCA\FaceRecognition\Service\ModelService;
use OCA\FaceRecognition\Service\SettingsService;

use OCA\FaceRecognition\Model\IModel;

class DlibCnnModel implements IModel {

	/*
	 * Model files.
	 */
	const FACE_MODEL_ID = -1;
	const FACE_MODEL_NAME = "";
	const FACE_MODEL_DESC = "";
	const FACE_MODEL_DOC = "";

	/** Relationship between image size and memory consumed */
	const MEMORY_AREA_RELATIONSHIP = -1;
	const MINIMUM_MEMORY_REQUIREMENTS = -1;

	const FACE_MODEL_BZ2_URLS = array();
	const FACE_MODEL_FILES = array();

	const I_MODEL_DETECTOR = 0;
	const I_MODEL_PREDICTOR = 1;
	const I_MODEL_RESNET = 2;

	const PREFERRED_MIMETYPE = 'image/png';

	/** @var \CnnFaceDetection */
filter:
    dependency_paths: ["lib/*"]
	private $cfd;

	/** @var \FaceLandmarkDetection */
filter:
    dependency_paths: ["lib/*"]
	private $fld;

	/** @var \FaceRecognition */
filter:
    dependency_paths: ["lib/*"]
	private $fr;

	/** @var IDBConnection */
	private $connection;

	/** @var FileService */
	private $fileService;

	/** @var ModelService */
	private $modelService;

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


	/**
	 * DlibCnnModel __construct.
	 *
	 * @param IDBConnection $connection
	 * @param FileService $fileService
	 * @param ModelService $modelService
	 * @param SettingsService $settingsService
	 */
	public function __construct(IDBConnection   $connection,
	                            FileService     $fileService,
	                            ModelService    $modelService,
	                            SettingsService $settingsService)
	{
		$this->connection       = $connection;
		$this->fileService      = $fileService;
		$this->modelService     = $modelService;
		$this->settingsService  = $settingsService;
	}

	public function getId(): int {
		return static::FACE_MODEL_ID;
	}

	public function getName(): string {
		return static::FACE_MODEL_NAME;
	}

	public function getDescription(): string {
		return static::FACE_MODEL_DESC;
	}

	public function getDocumentation(): string {
		return static::FACE_MODEL_DOC;
	}

	public function isInstalled(): bool {
		if (!$this->modelService->modelFileExists($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]))
			return false;
		if (!$this->modelService->modelFileExists($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]))
			return false;
		if (!$this->modelService->modelFileExists($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_RESNET]))
			return false;
		return true;
	}

	public function meetDependencies(string &$error_message): bool {
		if (!extension_loaded('pdlib')) {
			$error_message = "The PDlib PHP extension is not loaded";
			return false;
		}
		$availableMemory = $this->settingsService->getAssignedMemory();
		if ($availableMemory < 0) {
			$error_message = "Seems that you still have to configure the assigned memory for image processing.";
			return false;
		}
		if ($availableMemory < static::MINIMUM_MEMORY_REQUIREMENTS) {
			$error_message = "Your system does not meet the minimum memory requirements.";
			return false;
		}
		return true;
	}

	public function getMaximumArea(): int {
		$assignedMemory = $this->settingsService->getAssignedMemory();
		return intval($assignedMemory/static::MEMORY_AREA_RELATIONSHIP);
	}

	public function getPreferredMimeType(): string {
		return static::PREFERRED_MIMETYPE;
	}

	/**
	 * @return void
	 */
	public function install() {
		if ($this->isInstalled()) {
			return;
		}

		// Create main folder where install models.
		$this->modelService->prepareModelFolder($this->getId());

		/* Download and install models */
		$detectorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_DETECTOR]);
		$this->fileService->bunzip2($detectorModelBz2, $this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]));

		$predictorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_PREDICTOR]);
		$this->fileService->bunzip2($predictorModelBz2, $this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));

		$resnetModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_RESNET]);
		$this->fileService->bunzip2($resnetModelBz2, $this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));

		/* Clean temporary files */
		$this->fileService->clean();

		// Insert on database and enable it
		$qb = $this->connection->getQueryBuilder();
		$query = $qb->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
			->from('facerecog_models')
			->where($qb->expr()->eq('id', $qb->createParameter('id')))
			->setParameter('id', $this->getId());
		$resultStatement = $query->execute();
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
		$resultStatement->closeCursor();

		if ((int)$data[0] <= 0) {
			$query = $this->connection->getQueryBuilder();
			$query->insert('facerecog_models')
			->values([
				'id' => $query->createNamedParameter($this->getId()),
				'name' => $query->createNamedParameter($this->getName()),
				'description' => $query->createNamedParameter($this->getDescription())
			])
			->execute();
		}
	}

	/**
	 * @return void
	 */
	public function open() {
		$this->cfd = new \CnnFaceDetection($this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]));
		$this->fld = new \FaceLandmarkDetection($this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));
		$this->fr = new \FaceRecognition($this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));
	}

	public function detectFaces(string $imagePath, bool $compute = true): array {
		$faces_detected = $this->cfd->detect($imagePath, 0);

		if (!$compute)
			return $faces_detected;

		foreach ($faces_detected as &$face) {
			$landmarks = $this->fld->detect($imagePath, $face);
			$descriptor = $this->fr->computeDescriptor($imagePath, $landmarks);

			$face['landmarks'] = $landmarks['parts'];
			$face['descriptor'] = $descriptor;
		}
		return $faces_detected;
	}

	public function compute(string $imagePath, array $face): array {
		$landmarks = $this->fld->detect($imagePath, $face);
		$descriptor = $this->fr->computeDescriptor($imagePath, $landmarks);

		$face['landmarks'] = $landmarks['parts'];
		$face['descriptor'] = $descriptor;

		return $face;
	}

}


1		<?php
2		/**
3		* @copyright Copyright (c) 2021, Matias De lellis <[email protected]>
4		* @copyright Copyright (c) 2018, Branko Kokanovic <[email protected]>
5		*
6		* @author Branko Kokanovic <[email protected]>
7		*
8		* @license GNU AGPL version 3 or any later version
9		*
10		* This program is free software: you can redistribute it and/or modify
11		* it under the terms of the GNU Affero General Public License as
12		* published by the Free Software Foundation, either version 3 of the
13		* License, or (at your option) any later version.
14		*
15		* This program is distributed in the hope that it will be useful,
16		* but WITHOUT ANY WARRANTY; without even the implied warranty of
17		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		* GNU Affero General Public License for more details.
19		*
20		* You should have received a copy of the GNU Affero General Public License
21		* along with this program. If not, see <http://www.gnu.org/licenses/>.
22		*
23		*/
24
25		namespace OCA\FaceRecognition\Model\DlibCnnModel;
26
27		use OCP\IDBConnection;
28
29		use OCA\FaceRecognition\Helper\MemoryLimits;
30
31		use OCA\FaceRecognition\Service\FileService;
32		use OCA\FaceRecognition\Service\ModelService;
33		use OCA\FaceRecognition\Service\SettingsService;
34
35		use OCA\FaceRecognition\Model\IModel;
36
37		class DlibCnnModel implements IModel {
38
39		/*
40		* Model files.
41		*/
42		const FACE_MODEL_ID = -1;
43		const FACE_MODEL_NAME = "";
44		const FACE_MODEL_DESC = "";
45		const FACE_MODEL_DOC = "";
46
47		/** Relationship between image size and memory consumed */
48		const MEMORY_AREA_RELATIONSHIP = -1;
49		const MINIMUM_MEMORY_REQUIREMENTS = -1;
50
51		const FACE_MODEL_BZ2_URLS = array();
52		const FACE_MODEL_FILES = array();
53
54		const I_MODEL_DETECTOR = 0;
55		const I_MODEL_PREDICTOR = 1;
56		const I_MODEL_RESNET = 2;
57
58		const PREFERRED_MIMETYPE = 'image/png';
59
60		/** @var \CnnFaceDetection */
		0 ignored issues – show Bug introduced 2020-03-28 00:09 UTC by Report Bug Copy Issue Report The type `CnnFaceDetection` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
61		private $cfd;
62
63		/** @var \FaceLandmarkDetection */
		0 ignored issues – show Bug introduced 2020-02-17 15:37 UTC by Report Bug Copy Issue Report The type `FaceLandmarkDetection` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
64		private $fld;
65
66		/** @var \FaceRecognition */
		0 ignored issues – show Bug introduced 2020-02-18 11:58 UTC by Report Bug Copy Issue Report The type `FaceRecognition` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
67		private $fr;
68
69		/** @var IDBConnection */
70		private $connection;
71
72		/** @var FileService */
73		private $fileService;
74
75		/** @var ModelService */
76		private $modelService;
77
78		/** @var SettingsService */
79		private $settingsService;
80
81
82		/**
83		* DlibCnnModel __construct.
84		*
85		* @param IDBConnection $connection
86		* @param FileService $fileService
87		* @param ModelService $modelService
88		* @param SettingsService $settingsService
89		*/
90	1	public function __construct(IDBConnection $connection,
91		FileService $fileService,
92		ModelService $modelService,
93		SettingsService $settingsService)
94		{
95	1	$this->connection = $connection;
96	1	$this->fileService = $fileService;
97	1	$this->modelService = $modelService;
98	1	$this->settingsService = $settingsService;
99		}
100
101	4	public function getId(): int {
102	4	return static::FACE_MODEL_ID;
103		}
104
105		public function getName(): string {
106		return static::FACE_MODEL_NAME;
107		}
108
109		public function getDescription(): string {
110		return static::FACE_MODEL_DESC;
111		}
112
113		public function getDocumentation(): string {
114		return static::FACE_MODEL_DOC;
115		}
116
117	4	public function isInstalled(): bool {
118	4	if (!$this->modelService->modelFileExists($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]))
119	1	return false;
120	3	if (!$this->modelService->modelFileExists($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]))
121		return false;
122	3	if (!$this->modelService->modelFileExists($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_RESNET]))
123		return false;
124	3	return true;
125		}
126
127		public function meetDependencies(string &$error_message): bool {
128		if (!extension_loaded('pdlib')) {
129		$error_message = "The PDlib PHP extension is not loaded";
130		return false;
131		}
132		$availableMemory = $this->settingsService->getAssignedMemory();
133		if ($availableMemory < 0) {
134		$error_message = "Seems that you still have to configure the assigned memory for image processing.";
135		return false;
136		}
137		if ($availableMemory < static::MINIMUM_MEMORY_REQUIREMENTS) {
138		$error_message = "Your system does not meet the minimum memory requirements.";
139		return false;
140		}
141		return true;
142		}
143
144		public function getMaximumArea(): int {
145		$assignedMemory = $this->settingsService->getAssignedMemory();
146		return intval($assignedMemory/static::MEMORY_AREA_RELATIONSHIP);
147		}
148
149	4	public function getPreferredMimeType(): string {
150	4	return static::PREFERRED_MIMETYPE;
151		}
152
153		/**
154		* @return void
155		*/
156	4	public function install() {
157	4	if ($this->isInstalled()) {
158	3	return;
159		}
160
161		// Create main folder where install models.
162	1	$this->modelService->prepareModelFolder($this->getId());
163
164		/* Download and install models */
165	1	$detectorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_DETECTOR]);
166	1	$this->fileService->bunzip2($detectorModelBz2, $this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]));
167
168	1	$predictorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_PREDICTOR]);
169	1	$this->fileService->bunzip2($predictorModelBz2, $this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));
170
171	1	$resnetModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_RESNET]);
172	1	$this->fileService->bunzip2($resnetModelBz2, $this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));
173
174		/* Clean temporary files */
175	1	$this->fileService->clean();
176
177		// Insert on database and enable it
178	1	$qb = $this->connection->getQueryBuilder();
179	1	$query = $qb->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
180	1	->from('facerecog_models')
181	1	->where($qb->expr()->eq('id', $qb->createParameter('id')))
182	1	->setParameter('id', $this->getId());
183	1	$resultStatement = $query->execute();
184	1	$data = $resultStatement->fetch(\PDO::FETCH_NUM);
185	1	$resultStatement->closeCursor();
186
187	1	if ((int)$data[0] <= 0) {
188		$query = $this->connection->getQueryBuilder();
189		$query->insert('facerecog_models')
190		->values([
191		'id' => $query->createNamedParameter($this->getId()),
192		'name' => $query->createNamedParameter($this->getName()),
193		'description' => $query->createNamedParameter($this->getDescription())
194		])
195		->execute();
196		}
197		}
198
199		/**
200		* @return void
201		*/
202	4	public function open() {
203	4	$this->cfd = new \CnnFaceDetection($this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]));
204	4	$this->fld = new \FaceLandmarkDetection($this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));
205	4	$this->fr = new \FaceRecognition($this->modelService->getFileModelPath($this->getId(), static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));
206		}
207
208	2	public function detectFaces(string $imagePath, bool $compute = true): array {
209	2	$faces_detected = $this->cfd->detect($imagePath, 0);
210
211	2	if (!$compute)
212		return $faces_detected;
213
214	2	foreach ($faces_detected as &$face) {
215	1	$landmarks = $this->fld->detect($imagePath, $face);
216	1	$descriptor = $this->fr->computeDescriptor($imagePath, $landmarks);
217
218	1	$face['landmarks'] = $landmarks['parts'];
219	1	$face['descriptor'] = $descriptor;
220		}
221	2	return $faces_detected;
222		}
223
224		public function compute(string $imagePath, array $face): array {
225		$landmarks = $this->fld->detect($imagePath, $face);
226		$descriptor = $this->fr->computeDescriptor($imagePath, $landmarks);
227
228		$face['landmarks'] = $landmarks['parts'];
229		$face['descriptor'] = $descriptor;
230
231		return $face;
232		}
233
234		}
235

matiasdelellis / facerecognition

Push — dependabot/npm_and_yarn/minimi... ( f33d6d )

DlibCnnModel::getId() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like