SetupCommand::configure() - Code Metrics - matiasdelellis/facerecognition - Measure and Improve Code Quality continuously with Scrutinizer

SetupCommand::configure() A
last analyzed 2025-04-04 20:37 UTC

↳ Parent: SetupCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * @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\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

use OCA\FaceRecognition\Model\IModel;

use OCA\FaceRecognition\Model\ModelManager;

use OCA\FaceRecognition\Service\SettingsService;

use OCA\FaceRecognition\Helper\CommandLock;
use OCA\FaceRecognition\Helper\MemoryLimits;

use OCP\Util as OCP_Util;

class SetupCommand extends Command {

	/** @var ModelManager */
	protected $modelManager;

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

	/** @var OutputInterface */
	protected $logger;

	/**
	 * @param ModelManager $modelManager
	 * @param SettingsService $settingsService
	 */
	public function __construct(ModelManager    $modelManager,
	                            SettingsService $settingsService)
	{
		parent::__construct();

		$this->modelManager    = $modelManager;
		$this->settingsService = $settingsService;
	}

	/**
	 * @return void
	 */
	protected function configure() {
		$this
			->setName('face:setup')
			->setDescription('Basic application settings, such as maximum memory, and the model used.')
			->addOption(
				'memory',
				'M',
				InputOption::VALUE_REQUIRED,
				'The maximum memory assigned for image processing',
				-1
			)
			->addOption(
				'model',
				'm',
				InputOption::VALUE_REQUIRED,
				'The identifier number of the model to install',
				-1
			);
	}

	/**
	 * @param InputInterface $input
	 * @param OutputInterface $output
	 * @return int
	 */
	protected function execute(InputInterface $input, OutputInterface $output) {
		$this->logger = $output;

		$assignMemory = $input->getOption('memory');
		$modelId = $input->getOption('model');

		if ($assignMemory < 0 && $modelId < 0) {
			$this->dumpCurrentSetup();
			return 0;
		}

		// Get lock to avoid potential errors.
		//
		$lock = CommandLock::Lock("face:setup");
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
		if (!$lock) {

			$output->writeln("Another command ('". CommandLock::IsLockedBy().  "') is already running that prevents it from continuing.");
			return 1;
		}

		if ($assignMemory > 0) {
			$ret = $this->setupAssignedMemory(OCP_Util::computerFileSize($assignMemory));
			if ($ret > 0) {
				CommandLock::Unlock($lock);
				return $ret;
			}
		}

		if ($modelId > 0) {
			$ret = $this->setupModel($modelId);
			if ($ret > 0) {
				CommandLock::Unlock($lock);
				return $ret;
			}
		}

		// Release obtained lock
		//
		CommandLock::Unlock($lock);

		return 0;
	}

	private function setupAssignedMemory ($assignMemory): int {
		$systemMemory = MemoryLimits::getSystemMemory();
		$this->logger->writeln("System memory: " . ($systemMemory > 0 ? $this->getHumanMemory($systemMemory) : "Unknown"));
		$phpMemory = MemoryLimits::getPhpMemory();
		$this->logger->writeln("Memory assigned to PHP: " . ($phpMemory > 0 ? $this->getHumanMemory($phpMemory) : "Unlimited"));

		$this->logger->writeln("");
		$availableMemory = MemoryLimits::getAvailableMemory();
		$this->logger->writeln("Minimum value to assign to image processing.: " . $this->getHumanMemory(SettingsService::MINIMUM_ASSIGNED_MEMORY));
		$this->logger->writeln("Maximum value to assign to image processing.: " . ($availableMemory > 0 ? $this->getHumanMemory($availableMemory) : "Unknown"));

		$this->logger->writeln("");
		if ($assignMemory > $availableMemory) {
			$this->logger->writeln("Cannot assign more memory than the maximum...");
			return 1;
		}

		if ($assignMemory < SettingsService::MINIMUM_ASSIGNED_MEMORY) {
			$this->logger->writeln("Cannot assign less memory than the minimum...");
			return 1;
		}

		$this->settingsService->setAssignedMemory ($assignMemory);
		$this->logger->writeln("Maximum memory assigned for image processing: " . $this->getHumanMemory($assignMemory));

		return 0;
	}

	private function setupModel (int $modelId): int {
		$this->logger->writeln("");

		$model = $this->modelManager->getModel($modelId);
		if (is_null($model)) {
			$this->logger->writeln('Invalid model Id');
			return 1;
		}

		$modelDescription = $model->getId() . ' (' . $model->getName(). ')';

		$error_message = "";
		if (!$model->meetDependencies($error_message)) {
			$this->logger->writeln('You do not meet the dependencies to install the model ' . $modelDescription);
			$this->logger->writeln('Summary: ' . $error_message);
			$this->logger->writeln('Please read the documentation for this model to continue: ' .$model->getDocumentation());
			return 1;
		}

		if ($model->isInstalled()) {
			$this->logger->writeln('The files of model ' . $modelDescription . ' are already installed');
			$this->modelManager->setDefault($modelId);
			$this->logger->writeln('The model ' . $modelDescription . ' was configured as default');

			return 0;
		}

		$this->logger->writeln('The model ' . $modelDescription . ' will be installed');
		$model->install();
		$this->logger->writeln('Install model ' . $modelDescription . ' successfully done');

		$this->modelManager->setDefault($modelId);
		$this->logger->writeln('The model ' . $modelDescription . ' was configured as default');

		return 0;
	}

	private function dumpCurrentSetup (): void {
		$this->logger->writeln("Current setup:");
		$this->logger->writeln('');
		$this->logger->writeln("Minimum value to assign to image processing.: " . $this->getHumanMemory(SettingsService::MINIMUM_ASSIGNED_MEMORY));
		$availableMemory = MemoryLimits::getAvailableMemory();
		$this->logger->writeln("Maximum value to assign to image processing.: " . ($availableMemory > 0 ? $this->getHumanMemory($availableMemory) : "Unknown"));
		$assignedMemory = $this->settingsService->getAssignedMemory();
		$this->logger->writeln("Maximum memory assigned for image processing: " . ($assignedMemory > 0 ? $this->getHumanMemory($assignedMemory) : "Pending configuration"));

		$this->logger->writeln('');
		$this->logger->writeln("Available models:");
		$table = new Table($this->logger);
		$table->setHeaders(['Id', 'Enabled', 'Name', 'Description']);

		$currentModel = $this->modelManager->getCurrentModel();
		$modelId = (!is_null($currentModel)) ? $currentModel->getId() : -1;

		$models = $this->modelManager->getAllModels();
		foreach ($models as $model) {
			$table->addRow([
				$model->getId(),
				($model->getId() === $modelId) ? '*' : '',
				$model->getName(),
				$model->getDescription()
			]);
		}
		$table->render();
	}

	private function getHumanMemory ($memory): string {
		return OCP_Util::humanFileSize($memory) . " (" . intval($memory) . "B)";
	}

}


1			<?php
2			/**
3			* @copyright Copyright (c) 2019-2020 Matias De lellis <[email protected]>
4			*
5			* @author Matias De lellis <[email protected]>
6			*
7			* @license GNU AGPL version 3 or any later version
8			*
9			* This program is free software: you can redistribute it and/or modify
10			* it under the terms of the GNU Affero General Public License as
11			* published by the Free Software Foundation, either version 3 of the
12			* License, or (at your option) any later version.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU Affero General Public License for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public License
20			* along with this program. If not, see <http://www.gnu.org/licenses/>.
21			*
22			*/
23			namespace OCA\FaceRecognition\Command;
24
25			use Symfony\Component\Console\Command\Command;
26			use Symfony\Component\Console\Helper\Table;
27			use Symfony\Component\Console\Input\InputOption;
28			use Symfony\Component\Console\Input\InputInterface;
29			use Symfony\Component\Console\Output\OutputInterface;
30
31			use OCA\FaceRecognition\Model\IModel;
32
33			use OCA\FaceRecognition\Model\ModelManager;
34
35			use OCA\FaceRecognition\Service\SettingsService;
36
37			use OCA\FaceRecognition\Helper\CommandLock;
38			use OCA\FaceRecognition\Helper\MemoryLimits;
39
40			use OCP\Util as OCP_Util;
41
42			class SetupCommand extends Command {
43
44			/** @var ModelManager */
45			protected $modelManager;
46
47			/** @var SettingsService */
48			private $settingsService;
49
50			/** @var OutputInterface */
51			protected $logger;
52
53			/**
54			* @param ModelManager $modelManager
55			* @param SettingsService $settingsService
56			*/
57			public function __construct(ModelManager $modelManager,
58			SettingsService $settingsService)
59			{
60			parent::__construct();
61
62			$this->modelManager = $modelManager;
63			$this->settingsService = $settingsService;
64			}
65
66			/**
67			* @return void
68			*/
69			protected function configure() {
70			$this
71			->setName('face:setup')
72			->setDescription('Basic application settings, such as maximum memory, and the model used.')
73			->addOption(
74			'memory',
75			'M',
76			InputOption::VALUE_REQUIRED,
77			'The maximum memory assigned for image processing',
78			-1
79			)
80			->addOption(
81			'model',
82			'm',
83			InputOption::VALUE_REQUIRED,
84			'The identifier number of the model to install',
85			-1
86			);
87			}
88
89			/**
90			* @param InputInterface $input
91			* @param OutputInterface $output
92			* @return int
93			*/
94			protected function execute(InputInterface $input, OutputInterface $output) {
95			$this->logger = $output;
96
97			$assignMemory = $input->getOption('memory');
98			$modelId = $input->getOption('model');
99
100			if ($assignMemory < 0 && $modelId < 0) {
101			$this->dumpCurrentSetup();
102			return 0;
103			}
104
105			// Get lock to avoid potential errors.
106			//
107			$lock = CommandLock::Lock("face:setup");
			0 ignored issues – show Bug introduced 2022-11-16 23:34 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$lock` is correct as `OCA\FaceRecognition\Help...ock::Lock('face:setup')` targeting `OCA\FaceRecognition\Helper\CommandLock::lock()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
108			if (!$lock) {
			0 ignored issues – show introduced 2022-11-16 23:34 UTC by Report Bug Copy Issue Report `$lock` is of type `null`, thus it always evaluated to `false`. Loading history...
109			$output->writeln("Another command ('". CommandLock::IsLockedBy(). "') is already running that prevents it from continuing.");
110			return 1;
111			}
112
113			if ($assignMemory > 0) {
114			$ret = $this->setupAssignedMemory(OCP_Util::computerFileSize($assignMemory));
115			if ($ret > 0) {
116			CommandLock::Unlock($lock);
117			return $ret;
118			}
119			}
120
121			if ($modelId > 0) {
122			$ret = $this->setupModel($modelId);
123			if ($ret > 0) {
124			CommandLock::Unlock($lock);
125			return $ret;
126			}
127			}
128
129			// Release obtained lock
130			//
131			CommandLock::Unlock($lock);
132
133			return 0;
134			}
135
136			private function setupAssignedMemory ($assignMemory): int {
137			$systemMemory = MemoryLimits::getSystemMemory();
138			$this->logger->writeln("System memory: " . ($systemMemory > 0 ? $this->getHumanMemory($systemMemory) : "Unknown"));
139			$phpMemory = MemoryLimits::getPhpMemory();
140			$this->logger->writeln("Memory assigned to PHP: " . ($phpMemory > 0 ? $this->getHumanMemory($phpMemory) : "Unlimited"));
141
142			$this->logger->writeln("");
143			$availableMemory = MemoryLimits::getAvailableMemory();
144			$this->logger->writeln("Minimum value to assign to image processing.: " . $this->getHumanMemory(SettingsService::MINIMUM_ASSIGNED_MEMORY));
145			$this->logger->writeln("Maximum value to assign to image processing.: " . ($availableMemory > 0 ? $this->getHumanMemory($availableMemory) : "Unknown"));
146
147			$this->logger->writeln("");
148			if ($assignMemory > $availableMemory) {
149			$this->logger->writeln("Cannot assign more memory than the maximum...");
150			return 1;
151			}
152
153			if ($assignMemory < SettingsService::MINIMUM_ASSIGNED_MEMORY) {
154			$this->logger->writeln("Cannot assign less memory than the minimum...");
155			return 1;
156			}
157
158			$this->settingsService->setAssignedMemory ($assignMemory);
159			$this->logger->writeln("Maximum memory assigned for image processing: " . $this->getHumanMemory($assignMemory));
160
161			return 0;
162			}
163
164			private function setupModel (int $modelId): int {
165			$this->logger->writeln("");
166
167			$model = $this->modelManager->getModel($modelId);
168			if (is_null($model)) {
169			$this->logger->writeln('Invalid model Id');
170			return 1;
171			}
172
173			$modelDescription = $model->getId() . ' (' . $model->getName(). ')';
174
175			$error_message = "";
176			if (!$model->meetDependencies($error_message)) {
177			$this->logger->writeln('You do not meet the dependencies to install the model ' . $modelDescription);
178			$this->logger->writeln('Summary: ' . $error_message);
179			$this->logger->writeln('Please read the documentation for this model to continue: ' .$model->getDocumentation());
180			return 1;
181			}
182
183			if ($model->isInstalled()) {
184			$this->logger->writeln('The files of model ' . $modelDescription . ' are already installed');
185			$this->modelManager->setDefault($modelId);
186			$this->logger->writeln('The model ' . $modelDescription . ' was configured as default');
187
188			return 0;
189			}
190
191			$this->logger->writeln('The model ' . $modelDescription . ' will be installed');
192			$model->install();
193			$this->logger->writeln('Install model ' . $modelDescription . ' successfully done');
194
195			$this->modelManager->setDefault($modelId);
196			$this->logger->writeln('The model ' . $modelDescription . ' was configured as default');
197
198			return 0;
199			}
200
201			private function dumpCurrentSetup (): void {
202			$this->logger->writeln("Current setup:");
203			$this->logger->writeln('');
204			$this->logger->writeln("Minimum value to assign to image processing.: " . $this->getHumanMemory(SettingsService::MINIMUM_ASSIGNED_MEMORY));
205			$availableMemory = MemoryLimits::getAvailableMemory();
206			$this->logger->writeln("Maximum value to assign to image processing.: " . ($availableMemory > 0 ? $this->getHumanMemory($availableMemory) : "Unknown"));
207			$assignedMemory = $this->settingsService->getAssignedMemory();
208			$this->logger->writeln("Maximum memory assigned for image processing: " . ($assignedMemory > 0 ? $this->getHumanMemory($assignedMemory) : "Pending configuration"));
209
210			$this->logger->writeln('');
211			$this->logger->writeln("Available models:");
212			$table = new Table($this->logger);
213			$table->setHeaders(['Id', 'Enabled', 'Name', 'Description']);
214
215			$currentModel = $this->modelManager->getCurrentModel();
216			$modelId = (!is_null($currentModel)) ? $currentModel->getId() : -1;
217
218			$models = $this->modelManager->getAllModels();
219			foreach ($models as $model) {
220			$table->addRow([
221			$model->getId(),
222			($model->getId() === $modelId) ? '*' : '',
223			$model->getName(),
224			$model->getDescription()
225			]);
226			}
227			$table->render();
228			}
229
230			private function getHumanMemory ($memory): string {
231			return OCP_Util::humanFileSize($memory) . " (" . intval($memory) . "B)";
232			}
233
234			}
235

matiasdelellis / facerecognition

SetupCommand::configure() A last analyzed 2025-04-04 20:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SetupCommand::configure() A
last analyzed 2025-04-04 20:37 UTC