SettingService::setMinimumConfidence() - Code Metrics - Inspection of "Implement a setting service where to handle everyt..." - matiasdelellis/facerecognition - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — settings-service ( fe486d )

by Matias

created 2020-01-13 12:38 UTC

SettingService::setMinimumConfidence() A

↳ Parent: SettingService

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	1
Bugs	0	Features	0

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

<?php
declare(strict_types=1);
/**
 * @copyright Copyright (c) 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 OCA\FaceRecognition\AppInfo\Application;
use OCA\FaceRecognition\Migration\AddDefaultFaceModel;

use OCP\IConfig;

class SettingService {

	/*
	 * Settings keys and default values.
	 */

	/** Current Model used to analyze */
	const CURRENT_MODEL_KEY = 'model';
	/* Default values is taked from AddDefaultFaceModel */

	/** Sensitivity used to clustering */
	const SENSITIVITY_KEY = 'sensitivity';
	const MINIMUM_SENSITIVITY = '0.4';
	const DEFAULT_SENSITIVITY = '0.5';
	const MAXIMUM_SENSITIVITY = '0.6';

	/** Minimum confidence used to try to clustring faces */
	const MINIMUM_CONFIDENCE_KEY = 'min-confidence';
	const MINIMUM_MINIMUM_CONFIDENCE = '0.0';
	const DEFAULT_MINIMUM_CONFIDENCE = '0.9';
	const MAXIMUM_MINIMUM_CONFIDENCE = '1.0';

	/** Memory limit suggested for analysis */
	const MEMORY_LIMITS_KEY = "memory-limits";
	const MINIMUM_MEMORY_LIMITS = 1 * 1024 * 1024 * 1024;
	const DEFAULT_MEMORY_LIMITS = '-1'; // It is dynamically configured according to hardware
	const MAXIMUM_MEMORY_LIMITS = 4 * 1024 * 1024 * 1024;

	/** Show single persons on clustes view */
	const SHOW_NOT_GROUPED_KEY = 'show-not-grouped';
	const DEFAULT_SHOW_NOT_GROUPED = 'false';

	/** User setting what indicates if has the analysis enabled */
	const USER_UNABLED_KEY = 'enabled';
	const DEFAULT_USER_UNABLED = 'false';

	/** User setting that remember last images checked */
	const STALE_IMAGES_LAST_CHECKED_KEY = 'stale_images_last_checked';
	const DEFAULT_STALE_IMAGES_LAST_CHECKED = '0';

	/** Define if for some reason need remove old images */
	const STALE_IMAGES_REMOVAL_NEEDED_KEY = 'stale_images_removal_needed';
	const DEFAULT_STALE_IMAGES_REMOVAL_NEEDED = 'false';

	/** User setting that indicate when scan finished */
	const FULL_IMAGE_SCAN_DONE_KEY = 'full_image_scan_done';
	const DEFAULT_FULL_IMAGE_SCAN_DONE = 'false';

	/** User setting that indicate that need to recreate clusters */
	const USER_RECREATE_CLUSTERS_KEY = 'recreate-clusters';
	const DEFAULT_USER_RECREATE_CLUSTERS = 'false';

	/** @var IConfig Config */
	private $config;

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

	/**
	 * @param IConfig $config
	 * @param string $userId
	 */
	public function __construct(IConfig $config,
	                            $userId)
	{
		$this->config = $config;
		$this->userId = $userId;
	}

	/*
	 * User settings.
	 */
	public function getUserEnabled ($userId = null): bool {
		$enabled = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_ENABLED_KEY, self::DEFAULT_USER_ENABLED);

		return ($enabled === 'true');
	}

	public function setUserEnabled (bool $enabled, $userId = null) {
		 $this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_ENABLED_KEY, $enabled ? "true" : "false");

	}

	public function getUserFullScanDone ($userId = null): bool {
		$fullScanDone = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::FULL_IMAGE_SCAN_DONE_KEY, self::DEFAULT_FULL_IMAGE_SCAN_DONE);
		return ($fullScanDone === 'true');
	}

	public function setUserFullScanDone (bool $fullScanDone, $userId = null) {
		$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_ENABLED_KEY, $fullScanDone ? "true" : "false");

	}

	public function getNeedRecreateClusters ($userId = null): bool {
		$needRecreate = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_RECREATE_CLUSTERS_KEY, self::DEFAULT_USER_RECREATE_CLUSTERS);

		return ($fullScanDone === 'true');

	}

	public function setNeedRecreateClusters (bool $needRecreate, $userId = null) {
		$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_RECREATE_CLUSTERS_KEY, $needRecreate ? "true" : "false");
	}

	/*
	 * Admin and process settings.
	 */
	public function getCurrentFaceModel(): int {
		return intval($this->config->getAppValue(Application::APP_NAME, self::CURRENT_MODEL_KEY, AddDefaultFaceModel::DEFAULT_FACE_MODEL_ID));
	}

	public function setCurrentFaceModel($model) {
		$this->config->setAppValue(Application::APP_NAME, self::CURRENT_MODEL_KEY, $model);
	}

	public function getSensitivity(): float {
		return floatval($this->config->getAppValue(Application::APP_NAME, self::SENSITIVITY_KEY, self::DEFAULT_SENSITIVITY));
	}

	public function setSensitivity($sensitivity) {
		$this->config->setAppValue(Application::APP_NAME, self::SENSITIVITY_KEY, $sensitivity);
	}

	public function getMinimumConfidence(): float {
		return floatval($this->config->getAppValue(Application::APP_NAME, self::MINIMUM_CONFIDENCE_KEY, self::DEFAULT_MINIMUM_CONFIDENCE));
	}

	public function setMinimumConfidence($confidence) {
		$this->config->setAppValue(Application::APP_NAME, self::MINIMUM_CONFIDENCE_KEY, $confidence);
	}

	public function getMemoryLimits(): int {
		return intval($this->config->getAppValue(Application::APP_NAME, self::MEMORY_LIMITS_KEY, self::DEFAULT_MEMORY_LIMITS));
	}

	public function setMemoryLimits(int $memoryLimits) {
		$this->config->setAppValue(Application::APP_NAME, self::MEMORY_LIMITS_KEY, strval($memoryLimits));
	}

	public function getShowNotGrouped (): bool {
		$show = $this->config->getAppValue(Application::APP_NAME, self::SHOW_NOT_GROUPED_KEY, self::DEFAULT_SHOW_NOT_GROUPED);
		return ($show === 'true');
	}

	public function setShowNotGrouped (bool $show) {
		 $this->config->setAppValue(Application::APP_NAME, self::SHOW_NOT_GROUPED_KEY, $show ? "true" : "false");
	}

}


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			use OCA\FaceRecognition\Migration\AddDefaultFaceModel;
29
30			use OCP\IConfig;
31
32			class SettingService {
33
34			/*
35			* Settings keys and default values.
36			*/
37
38			/** Current Model used to analyze */
39			const CURRENT_MODEL_KEY = 'model';
40			/* Default values is taked from AddDefaultFaceModel */
41
42			/** Sensitivity used to clustering */
43			const SENSITIVITY_KEY = 'sensitivity';
44			const MINIMUM_SENSITIVITY = '0.4';
45			const DEFAULT_SENSITIVITY = '0.5';
46			const MAXIMUM_SENSITIVITY = '0.6';
47
48			/** Minimum confidence used to try to clustring faces */
49			const MINIMUM_CONFIDENCE_KEY = 'min-confidence';
50			const MINIMUM_MINIMUM_CONFIDENCE = '0.0';
51			const DEFAULT_MINIMUM_CONFIDENCE = '0.9';
52			const MAXIMUM_MINIMUM_CONFIDENCE = '1.0';
53
54			/** Memory limit suggested for analysis */
55			const MEMORY_LIMITS_KEY = "memory-limits";
56			const MINIMUM_MEMORY_LIMITS = 1 * 1024 * 1024 * 1024;
57			const DEFAULT_MEMORY_LIMITS = '-1'; // It is dynamically configured according to hardware
58			const MAXIMUM_MEMORY_LIMITS = 4 * 1024 * 1024 * 1024;
59
60			/** Show single persons on clustes view */
61			const SHOW_NOT_GROUPED_KEY = 'show-not-grouped';
62			const DEFAULT_SHOW_NOT_GROUPED = 'false';
63
64			/** User setting what indicates if has the analysis enabled */
65			const USER_UNABLED_KEY = 'enabled';
66			const DEFAULT_USER_UNABLED = 'false';
67
68			/** User setting that remember last images checked */
69			const STALE_IMAGES_LAST_CHECKED_KEY = 'stale_images_last_checked';
70			const DEFAULT_STALE_IMAGES_LAST_CHECKED = '0';
71
72			/** Define if for some reason need remove old images */
73			const STALE_IMAGES_REMOVAL_NEEDED_KEY = 'stale_images_removal_needed';
74			const DEFAULT_STALE_IMAGES_REMOVAL_NEEDED = 'false';
75
76			/** User setting that indicate when scan finished */
77			const FULL_IMAGE_SCAN_DONE_KEY = 'full_image_scan_done';
78			const DEFAULT_FULL_IMAGE_SCAN_DONE = 'false';
79
80			/** User setting that indicate that need to recreate clusters */
81			const USER_RECREATE_CLUSTERS_KEY = 'recreate-clusters';
82			const DEFAULT_USER_RECREATE_CLUSTERS = 'false';
83
84			/** @var IConfig Config */
85			private $config;
86
87			/** @var string\|null */
88			private $userId;
89
90			/**
91			* @param IConfig $config
92			* @param string $userId
93			*/
94			public function __construct(IConfig $config,
95			$userId)
96			{
97			$this->config = $config;
98			$this->userId = $userId;
99			}
100
101			/*
102			* User settings.
103			*/
104			public function getUserEnabled ($userId = null): bool {
105			$enabled = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_ENABLED_KEY, self::DEFAULT_USER_ENABLED);
			0 ignored issues – show Bug introduced 2020-01-13 12:41 UTC by Report Bug Copy Issue Report The constant `OCA\FaceRecognition\Serv...e::DEFAULT_USER_ENABLED` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history... Bug introduced 2020-01-13 12:41 UTC by Report Bug Copy Issue Report The constant `OCA\FaceRecognition\Serv...rvice::USER_ENABLED_KEY` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
106			return ($enabled === 'true');
107			}
108
109			public function setUserEnabled (bool $enabled, $userId = null) {
110			$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_ENABLED_KEY, $enabled ? "true" : "false");
			0 ignored issues – show Bug introduced 2020-01-13 12:41 UTC by Report Bug Copy Issue Report The constant `OCA\FaceRecognition\Serv...rvice::USER_ENABLED_KEY` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
111			}
112
113			public function getUserFullScanDone ($userId = null): bool {
114			$fullScanDone = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::FULL_IMAGE_SCAN_DONE_KEY, self::DEFAULT_FULL_IMAGE_SCAN_DONE);
115			return ($fullScanDone === 'true');
116			}
117
118			public function setUserFullScanDone (bool $fullScanDone, $userId = null) {
119			$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_ENABLED_KEY, $fullScanDone ? "true" : "false");
			0 ignored issues – show Bug introduced 2020-01-13 12:41 UTC by Report Bug Copy Issue Report The constant `OCA\FaceRecognition\Serv...rvice::USER_ENABLED_KEY` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
120			}
121
122			public function getNeedRecreateClusters ($userId = null): bool {
123			$needRecreate = $this->config->getUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_RECREATE_CLUSTERS_KEY, self::DEFAULT_USER_RECREATE_CLUSTERS);
			0 ignored issues – show Unused Code introduced 2020-01-13 12:41 UTC by Report Bug Copy Issue Report The assignment to `$needRecreate` is dead and can be removed. Loading history...
124			return ($fullScanDone === 'true');
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-01-13 12:41 UTC by Report Bug Copy Issue Report The variable `$fullScanDone` seems to be never defined. Loading history...
125			}
126
127			public function setNeedRecreateClusters (bool $needRecreate, $userId = null) {
128			$this->config->setUserValue($userId ?? $this->userId, Application::APP_NAME, self::USER_RECREATE_CLUSTERS_KEY, $needRecreate ? "true" : "false");
129			}
130
131			/*
132			* Admin and process settings.
133			*/
134			public function getCurrentFaceModel(): int {
135			return intval($this->config->getAppValue(Application::APP_NAME, self::CURRENT_MODEL_KEY, AddDefaultFaceModel::DEFAULT_FACE_MODEL_ID));
136			}
137
138			public function setCurrentFaceModel($model) {
139			$this->config->setAppValue(Application::APP_NAME, self::CURRENT_MODEL_KEY, $model);
140			}
141
142			public function getSensitivity(): float {
143			return floatval($this->config->getAppValue(Application::APP_NAME, self::SENSITIVITY_KEY, self::DEFAULT_SENSITIVITY));
144			}
145
146			public function setSensitivity($sensitivity) {
147			$this->config->setAppValue(Application::APP_NAME, self::SENSITIVITY_KEY, $sensitivity);
148			}
149
150			public function getMinimumConfidence(): float {
151			return floatval($this->config->getAppValue(Application::APP_NAME, self::MINIMUM_CONFIDENCE_KEY, self::DEFAULT_MINIMUM_CONFIDENCE));
152			}
153
154			public function setMinimumConfidence($confidence) {
155			$this->config->setAppValue(Application::APP_NAME, self::MINIMUM_CONFIDENCE_KEY, $confidence);
156			}
157
158			public function getMemoryLimits(): int {
159			return intval($this->config->getAppValue(Application::APP_NAME, self::MEMORY_LIMITS_KEY, self::DEFAULT_MEMORY_LIMITS));
160			}
161
162			public function setMemoryLimits(int $memoryLimits) {
163			$this->config->setAppValue(Application::APP_NAME, self::MEMORY_LIMITS_KEY, strval($memoryLimits));
164			}
165
166			public function getShowNotGrouped (): bool {
167			$show = $this->config->getAppValue(Application::APP_NAME, self::SHOW_NOT_GROUPED_KEY, self::DEFAULT_SHOW_NOT_GROUPED);
168			return ($show === 'true');
169			}
170
171			public function setShowNotGrouped (bool $show) {
172			$this->config->setAppValue(Application::APP_NAME, self::SHOW_NOT_GROUPED_KEY, $show ? "true" : "false");
173			}
174
175			}
176

matiasdelellis / facerecognition

Push — settings-service ( fe486d )

SettingService::setMinimumConfidence() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like