Passed
Pull Request — master (#310)
by Matias
15:02 queued 05:19
created

SettingsService::setMinimumFaceSize()   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
c 0
b 0
f 0
nc 1
nop 1
dl 0
loc 2
ccs 0
cts 2
cp 0
crap 2
rs 10
1
<?php
2
declare(strict_types=1);
3
/**
4
 * @copyright Copyright (c) 2020 Matias De lellis <[email protected]>
5
 *
6
 * @author Matias De lellis <[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\Service;
26
27
use OCA\FaceRecognition\AppInfo\Application;
28
29
use OCA\FaceRecognition\Model\ModelManager;
30
31
use OCP\IConfig;
32
33
class SettingsService {
34
35
	/*
36
	 * System
37
	 */
38
	const MINIMUM_SYSTEM_MEMORY_REQUIREMENTS = 2 * 1024 * 1024 * 1024;
39
40
	/*
41
	 * Settings keys and default values.
42
	 */
43
44
	/** Current Model used to analyze */
45
	const CURRENT_MODEL_KEY = 'model';
46
	const FALLBACK_CURRENT_MODEL = -1;
47
48
	/** Image area that used used for analysis */
49
	const ANALYSIS_IMAGE_AREA_KEY = 'analysis_image_area';
50
	const MINIMUM_ANALYSIS_IMAGE_AREA = 640*480;
51
	const DEFAULT_ANALYSIS_IMAGE_AREA = -1; // It is dynamically configured according to hardware
52
	const MAXIMUM_ANALYSIS_IMAGE_AREA = 3840*2160;
53
54
	/** Sensitivity used to clustering */
55
	const SENSITIVITY_KEY = 'sensitivity';
56
	const MINIMUM_SENSITIVITY = '0.2';
57
	const DEFAULT_SENSITIVITY = '0.4';
58
	const MAXIMUM_SENSITIVITY = '0.6';
59
60
	/** Minimum confidence used to try to clustring faces */
61
	const MINIMUM_CONFIDENCE_KEY = 'min_confidence';
62
	const MINIMUM_MINIMUM_CONFIDENCE = '0.0';
63
	const DEFAULT_MINIMUM_CONFIDENCE = '0.99';
64
	const MAXIMUM_MINIMUM_CONFIDENCE = '1.1';
65
66
	/** Minimum face size used to try to clustring faces */
67
	const MINIMUM_FACE_SIZE_KEY = 'min_face_size';
68
	const MINIMUM_MINIMUM_FACE_SIZE = '0';
69
	const DEFAULT_MINIMUM_FACE_SIZE = '60';
70
	const MAXIMUM_MINIMUM_FACE_SIZE = '250';
71
72
	/** Show single persons on clustes view */
73
	const SHOW_NOT_GROUPED_KEY = 'show_not_grouped';
74
	const DEFAULT_SHOW_NOT_GROUPED = 'false';
75
76
	/** User setting what indicates if has the analysis enabled */
77
	const USER_ENABLED_KEY = 'enabled';
78
	const DEFAULT_USER_ENABLED = 'false';
79
80
	/** User setting that remember last images checked */
81
	const STALE_IMAGES_LAST_CHECKED_KEY = 'stale_images_last_checked';
82
	const DEFAULT_STALE_IMAGES_LAST_CHECKED = '0';
83
84
	/** Define if for some reason need remove old images */
85
	const STALE_IMAGES_REMOVAL_NEEDED_KEY = 'stale_images_removal_needed';
86
	const DEFAULT_STALE_IMAGES_REMOVAL_NEEDED = 'false';
87
88
	/** User setting that indicate when scan finished */
89
	const FULL_IMAGE_SCAN_DONE_KEY = 'full_image_scan_done';
90
	const DEFAULT_FULL_IMAGE_SCAN_DONE = 'false';
91
92
	/** User setting that indicate that need to recreate clusters */
93
	const USER_RECREATE_CLUSTERS_KEY = 'recreate_clusters';
94
	const DEFAULT_USER_RECREATE_CLUSTERS = 'false';
95
96
	/** User setting that indicate that is forced to create clusters */
97
	const FORCE_CREATE_CLUSTERS_KEY = 'force_create_clusters';
98
	const DEFAULT_FORCE_CREATE_CLUSTERS = 'false';
99
100
	/** Hidden setting that allows to analyze shared files */
101
	const HANDLE_SHARED_FILES_KEY = 'handle_shared_files';
102
	const DEFAULT_HANDLE_SHARED_FILES = 'false';
103
104
	/** Hidden setting that allows to analyze external files */
105
	const HANDLE_EXTERNAL_FILES_KEY = 'handle_external_files';
106
	const DEFAULT_HANDLE_EXTERNAL_FILES = 'false';
107
108
	/** Hidden setting that indicate minimum large of image to analyze */
109
	const MINIMUM_IMAGE_SIZE_KEY = 'min_image_size';
110
	const DEFAULT_MINIMUM_IMAGE_SIZE = '512';
111
112
	/** Hidden setting that indicate maximum area of image to analyze */
113
	const MAXIMUM_IMAGE_AREA_KEY = 'max_image_area';
114
	const DEFAULT_MAXIMUM_IMAGE_AREA = '-1';
115
116
	/** Hidden setting that allows obfuscate that faces for security */
117
	const OBFUSCATE_FACE_THUMBS_KEY = 'obfuscate_faces';
118
	const DEFAULT_OBFUSCATE_FACE_THUMBS = 'false';
119
120
	/** System setting to enable mimetypes */
121
	const SYSTEM_ENABLED_MIMETYPES = 'enabledFaceRecognitionMimetype';
122
	private $allowedMimetypes = ['image/jpeg', 'image/png'];
123
	private $cachedAllowedMimetypes = false;
124
125
	/**
126
	 * SettingsService
127
	 */
128
129
	/** @var IConfig Config */
130
	private $config;
131
132
	/**  @var string|null */
133
	private $userId;
134
135
	/**
136
	 * @param IConfig $config
137
	 * @param string $userId
138
	 */
139 1
	public function __construct(IConfig $config,
140
	                            $userId)
141
	{
142 1
		$this->config = $config;
143 1
		$this->userId = $userId;
144 1
	}
145
146
	/*
147
	 * User settings.
148
	 */
149 10
	public function getUserEnabled ($userId = null): bool {
150 10
		$enabled = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_ENABLED_KEY, self::DEFAULT_USER_ENABLED);
151 10
		return ($enabled === 'true');
152
	}
153
154
	public function setUserEnabled (bool $enabled, $userId = null) {
155
		$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_ENABLED_KEY, $enabled ? "true" : "false");
156
	}
157
158 10
	public function getUserFullScanDone ($userId = null): bool {
159 10
		$fullScanDone = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::FULL_IMAGE_SCAN_DONE_KEY, self::DEFAULT_FULL_IMAGE_SCAN_DONE);
160 10
		return ($fullScanDone === 'true');
161
	}
162
163 28
	public function setUserFullScanDone (bool $fullScanDone, $userId = null) {
164 28
		$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::FULL_IMAGE_SCAN_DONE_KEY, $fullScanDone ? "true" : "false");
165 28
	}
166
167 3
	public function getNeedRemoveStaleImages ($userId = null): bool {
168 3
		$needRemoval = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::STALE_IMAGES_REMOVAL_NEEDED_KEY, self::DEFAULT_STALE_IMAGES_REMOVAL_NEEDED);
169 3
		return ($needRemoval === 'true');
170
	}
171
172 2
	public function setNeedRemoveStaleImages (bool $needRemoval, $userId = null) {
173 2
		$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::STALE_IMAGES_REMOVAL_NEEDED_KEY, $needRemoval ? "true" : "false");
174 2
	}
175
176 2
	public function getLastStaleImageChecked ($userId = null): int {
177 2
		return intval($this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::STALE_IMAGES_LAST_CHECKED_KEY, self::DEFAULT_STALE_IMAGES_LAST_CHECKED));
178
	}
179
180 2
	public function setLastStaleImageChecked (int $lastCheck, $userId = null) {
181 2
		$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::STALE_IMAGES_LAST_CHECKED_KEY, $lastCheck);
182 2
	}
183
184
	public function getNeedRecreateClusters ($userId = null): bool {
185
		$needRecreate = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_RECREATE_CLUSTERS_KEY, self::DEFAULT_USER_RECREATE_CLUSTERS);
186
		return ($needRecreate === 'true');
187
	}
188
189 1
	public function setNeedRecreateClusters (bool $needRecreate, $userId = null) {
190 1
		$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_RECREATE_CLUSTERS_KEY, $needRecreate ? "true" : "false");
191 1
	}
192
193
	// Private function used only on tests
194 1
	public function _getForceCreateClusters ($userId = null): bool {
195 1
		$forceCreate = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::FORCE_CREATE_CLUSTERS_KEY, self::DEFAULT_FORCE_CREATE_CLUSTERS);
196 1
		return ($forceCreate === 'true');
197
	}
198
199
	// Private function used only on tests
200 1
	public function _setForceCreateClusters (bool $forceCreate, $userId = null) {
201 1
		$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::FORCE_CREATE_CLUSTERS_KEY, $forceCreate ? "true" : "false");
202 1
	}
203
204
	/*
205
	 * Admin and process settings.
206
	 */
207 12
	public function getCurrentFaceModel(): int {
208 12
		return intval($this->config->getAppValue(Application::APP_NAME, self::CURRENT_MODEL_KEY, self::FALLBACK_CURRENT_MODEL));
209
	}
210
211
	public function setCurrentFaceModel(int $model) {
212
		$this->config->setAppValue(Application::APP_NAME, self::CURRENT_MODEL_KEY, strval($model));
213
	}
214
215 4
	public function getAnalysisImageArea(): int {
216 4
		return intval($this->config->getAppValue(Application::APP_NAME, self::ANALYSIS_IMAGE_AREA_KEY, self::DEFAULT_ANALYSIS_IMAGE_AREA));
217
	}
218
219
	public function setAnalysisImageArea(int $imageArea) {
220
		$this->config->setAppValue(Application::APP_NAME, self::ANALYSIS_IMAGE_AREA_KEY, strval($imageArea));
221
	}
222
223 1
	public function getSensitivity(): float {
224 1
		return floatval($this->config->getAppValue(Application::APP_NAME, self::SENSITIVITY_KEY, self::DEFAULT_SENSITIVITY));
225
	}
226
227
	public function setSensitivity($sensitivity) {
228
		$this->config->setAppValue(Application::APP_NAME, self::SENSITIVITY_KEY, $sensitivity);
229
	}
230
231 1
	public function getMinimumConfidence(): float {
232 1
		return floatval($this->config->getAppValue(Application::APP_NAME, self::MINIMUM_CONFIDENCE_KEY, self::DEFAULT_MINIMUM_CONFIDENCE));
233
	}
234
235
	public function setMinimumConfidence($confidence) {
236
		$this->config->setAppValue(Application::APP_NAME, self::MINIMUM_CONFIDENCE_KEY, $confidence);
237
	}
238
239
	public function getShowNotGrouped(): bool {
240
		$show = $this->config->getAppValue(Application::APP_NAME, self::SHOW_NOT_GROUPED_KEY, self::DEFAULT_SHOW_NOT_GROUPED);
241
		return ($show === 'true');
242
	}
243
244
	public function setShowNotGrouped(bool $show) {
245
		$this->config->setAppValue(Application::APP_NAME, self::SHOW_NOT_GROUPED_KEY, $show ? "true" : "false");
246
	}
247
248
	/**
249
	 * The next settings are advanced preferences that are not available in gui.
250
	 * See: https://github.com/matiasdelellis/facerecognition/wiki/Settings#hidden-settings
251
	 */
252
	public function getHandleSharedFiles(): bool {
253
		$handle = $this->config->getAppValue(Application::APP_NAME, self::HANDLE_SHARED_FILES_KEY, self::DEFAULT_HANDLE_SHARED_FILES);
254
		return ($handle === 'true');
255
	}
256
257
	public function getHandleExternalFiles(): bool {
258
		$handle = $this->config->getAppValue(Application::APP_NAME, self::HANDLE_EXTERNAL_FILES_KEY, self::DEFAULT_HANDLE_EXTERNAL_FILES);
259
		return ($handle === 'true');
260
	}
261
262 4
	public function getMinimumImageSize(): int {
263 4
		return intval($this->config->getAppValue(Application::APP_NAME, self::MINIMUM_IMAGE_SIZE_KEY, self::DEFAULT_MINIMUM_IMAGE_SIZE));
264
	}
265
266 1
	public function getMinimumFaceSize(): int {
267 1
		$minFaceSize = intval($this->config->getAppValue(Application::APP_NAME, self::MINIMUM_FACE_SIZE_KEY, self::DEFAULT_MINIMUM_FACE_SIZE));
268 1
		$minFaceSize = max(self::MINIMUM_MINIMUM_FACE_SIZE, $minFaceSize);
269 1
		$minFaceSize = min($minFaceSize, self::MAXIMUM_MINIMUM_FACE_SIZE);
270 1
		return $minFaceSize;
271
	}
272
273 4
	public function getMaximumImageArea(): int {
274 4
		return intval($this->config->getAppValue(Application::APP_NAME, self::MAXIMUM_IMAGE_AREA_KEY, self::DEFAULT_MAXIMUM_IMAGE_AREA));
275
	}
276
277
	public function getObfuscateFaces(): bool {
278
		$obfuscate = $this->config->getAppValue(Application::APP_NAME, self::OBFUSCATE_FACE_THUMBS_KEY, self::DEFAULT_OBFUSCATE_FACE_THUMBS);
279
		return ($obfuscate === 'true');
280
	}
281
282
	public function setObfuscateFaces(bool $obfuscate) {
283
		$this->config->setAppValue(Application::APP_NAME, self::OBFUSCATE_FACE_THUMBS_KEY, $obfuscate ? 'true' : 'false');
284
	}
285
286
	/**
287
	 * System settings that must be configured according to the server configuration.
288
	 */
289 8
	public function isAllowedMimetype(string $mimetype): bool {
290 8
		if (!$this->cachedAllowedMimetypes) {
291 1
			$systemMimetypes = $this->config->getSystemValue(self::SYSTEM_ENABLED_MIMETYPES, $this->allowedMimetypes);
292 1
			$this->allowedMimetypes = array_merge($this->allowedMimetypes, $systemMimetypes);
293 1
			$this->allowedMimetypes = array_unique($this->allowedMimetypes);
294
295 1
			$this->cachedAllowedMimetypes = true;
296
		}
297
298 8
		return in_array($mimetype, $this->allowedMimetypes);
299
	}
300
301
}
302