Passed
Push — self-contained-model ( 575670...f0e346 )
by Matias
04:11
created

DlibCnnModel::getId()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 2
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 2
ccs 0
cts 2
cp 0
crap 2
rs 10
c 0
b 0
f 0
1
<?php
2
/**
3
 * @copyright Copyright (c) 2020, 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\Requirements;
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
46
	/** Relationship between image size and memory consumed */
47
	const MEMORY_AREA_RELATIONSHIP = -1;
48
49
	const FACE_MODEL_BZ2_URLS = array();
50
	const FACE_MODEL_FILES = array();
51
52
	const I_MODEL_DETECTOR = 0;
53
	const I_MODEL_PREDICTOR = 1;
54
	const I_MODEL_RESNET = 2;
55
56
	/** @var \CnnFaceDetection */
0 ignored issues
show
Bug introduced by
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...
57
	private $cfd;
58
59
	/** @var \FaceLandmarkDetection */
0 ignored issues
show
Bug introduced by
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...
60
	private $fld;
61
62
	/** @var \FaceRecognition */
0 ignored issues
show
Bug introduced by
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...
63
	private $fr;
64
65
	/** @var IDBConnection */
66
	private $connection;
67
68
	/** @var FileService */
69
	private $fileService;
70
71
	/** @var ModelService */
72
	private $modelService;
73
74
	/** @var SettingsService */
75
	private $settingsService;
76
77
78
	/**
79
	 * DlibCnnModel __construct.
80
	 *
81
	 * @param IDBConnection $connection
82
	 * @param FileService $fileService
83
	 * @param ModelService $modelService
84
	 * @param SettingsService $settingsService
85
	 */
86
	public function __construct(IDBConnection   $connection,
87
	                            FileService     $fileService,
88
	                            ModelService    $modelService,
89
	                            SettingsService $settingsService)
90
	{
91
		$this->connection       = $connection;
92
		$this->fileService      = $fileService;
93
		$this->modelService     = $modelService;
94
		$this->settingsService  = $settingsService;
95
	}
96
97
	public function getId(): int {
98
		return static::FACE_MODEL_ID;
99
	}
100
101
	public function getName(): string {
102
		return static::FACE_MODEL_NAME;
103
	}
104
105
	public function getDescription(): string {
106
		return static::FACE_MODEL_DESC;
107
	}
108
109
	public function isInstalled(): bool {
110
		$requirements = new Requirements($this->modelService, $this->getId());
111
		return $requirements->modelFilesPresent();
112
	}
113
114
	public function meetDependencies(): bool {
115
		return extension_loaded('pdlib');
116
	}
117
118
	public function install() {
119
		if ($this->isInstalled()) {
120
			return;
121
		}
122
123
		/* Still not installed but it is necessary to get the model folders */
124
		$this->modelService->useModelVersion($this->getId());
125
126
		/* Download and install models */
127
		$detectorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_DETECTOR]);
128
		$this->fileService->bunzip2($detectorModelBz2, $this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]));
129
130
		$predictorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_PREDICTOR]);
131
		$this->fileService->bunzip2($predictorModelBz2, $this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));
132
133
		$resnetModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_RESNET]);
134
		$this->fileService->bunzip2($resnetModelBz2, $this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));
135
136
		/* Clean temporary files */
137
		$this->fileService->clean();
138
139
		// Insert on database and enable it
140
		$qb = $this->connection->getQueryBuilder();
141
		$query = $qb->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
142
			->from('facerecog_models')
143
			->where($qb->expr()->eq('id', $qb->createParameter('id')))
144
			->setParameter('id', $this->getId());
145
		$resultStatement = $query->execute();
146
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
147
		$resultStatement->closeCursor();
148
149
		if ((int)$data[0] <= 0) {
150
			$query = $this->connection->getQueryBuilder();
151
			$query->insert('facerecog_models')
152
			->values([
153
				'id' => $query->createNamedParameter($this->getId()),
154
				'name' => $query->createNamedParameter($this->getName()),
155
				'description' => $query->createNamedParameter($this->getDescription())
156
			])
157
			->execute();
158
		}
159
	}
160
161
	public function setDefault() {
162
		// Use default model, if it is not set already.
163
		if ($this->settingsService->getCurrentFaceModel() !== $this->getId()) {
164
			$this->settingsService->setCurrentFaceModel($this->getId());
165
		}
166
	}
167
168
	public function open() {
169
		$this->modelService->useModelVersion($this->getId());
170
171
		$this->cfd = new \CnnFaceDetection($this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]));
172
		$this->fld = new \FaceLandmarkDetection($this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));
173
		$this->fr = new \FaceRecognition($this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));
174
	}
175
176
	public function getMemoryAreaRelation(): int {
177
		return static::MEMORY_AREA_RELATIONSHIP;
178
	}
179
180
	public function detectFaces(string $imagePath): array {
181
		return $this->cfd->detect($imagePath);
182
	}
183
184
	public function detectLandmarks(string $imagePath, array $rect): array {
185
		return $this->fld->detect($imagePath, $rect);
186
	}
187
188
	public function computeDescriptor(string $imagePath, array $landmarks): array {
189
		return $this->fr->computeDescriptor($imagePath, $landmarks);
190
	}
191
192
}
193