matiasdelellis / facerecognition

lib/Command/ResetCommand.php

<?php
/**
 * @copyright Copyright (c) 2020, Matias De lellis <mati86dl@gmail.com>
 * @copyright Copyright (c) 2019, Branko Kokanovic <branko@kokanovic.org>
 *
 * @author Branko Kokanovic <branko@kokanovic.org>
 *
 * @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 OCP\IUserManager;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;

use OCA\FaceRecognition\Helper\CommandLock;

use OCA\FaceRecognition\Service\FaceManagementService;

class ResetCommand extends Command {

	/** @var FaceManagementService */
	protected $faceManagementService;

	/** @var IUserManager */
	protected $userManager;

	/** @var InputInterface */
	protected $input;

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

	/** @var  QuestionHelper */
	protected $questionHelper;

	/**
	 * @param FaceManagementService $faceManagementService
	 * @param IUserManager $userManager
	 * @param QuestionHelper $questionHelper
	 */
	public function __construct(FaceManagementService $faceManagementService,
	                            IUserManager          $userManager,
	                            QuestionHelper        $questionHelper) {
		parent::__construct();

		$this->faceManagementService = $faceManagementService;
		$this->userManager           = $userManager;
		$this->questionHelper        = $questionHelper;
	}

	/**
	 * @return void
	 */
	protected function configure() {
		$this
			->setName('face:reset')
			->setDescription(
				'Resets and deletes everything. Good for starting over. ' .
				'BEWARE: Next runs of face:background_job will re-analyze all images.')
			->addOption(
				'user_id',
				'u',
				InputOption::VALUE_REQUIRED,
				'Resets data for a given user only. If not given, resets everything for all users.',
				null
			)
			->addOption(
				'all',
				null,
				InputOption::VALUE_NONE,
				'Reset everything.',
				null
			)
			->addOption(
				'model',
				null,
				InputOption::VALUE_NONE,
				'Reset current model.',
				null
			)
			->addOption(
				'image-errors',
				null,
				InputOption::VALUE_NONE,
				'Reset errors in images to re-analyze again',
				null
			)
			->addOption(
				'clustering',
				null,
				InputOption::VALUE_NONE,
				'Just reset the clustering.',
				null
			);
	}

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

		// Extract user, if any
		//
		$userId = $input->getOption('user_id');
		$user = null;

		if (!is_null($userId)) {
			$user = $this->userManager->get($userId);

It seems like $userId can also be of type string[]; however, parameter $uid of OCP\IUserManager::get() does only seem to accept string, maybe add an additional type check?

			if ($user === null) {
				$output->writeln("User with id <$userId> in unknown.");
				return 1;
			}
		}

		// Get lock to avoid potential errors.
		//
		$lock = CommandLock::Lock('face:reset');

Are you sure the assignment to $lock is correct as OCA\FaceRecognition\Helper\CommandLock::Lock('face:reset') targeting OCA\FaceRecognition\Helper\CommandLock::lock() seems to always return null.

		if (!$lock) {

$lock is of type null, thus it always evaluated to false.

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

		// Main thing
		//
		$ret = 0;
		if ($input->getOption('all')) {
			if ($this->confirmate()) {
				$this->resetAll($user);
				$output->writeln('Reset successfully done');
			} else {
				$output->writeln('Aborted');
				$ret = 1;
			}
		}
		else if ($input->getOption('model')) {
			if ($this->confirmate()) {
				$this->resetModel($user);
				$output->writeln('Reset model successfully done');
			} else {
				$output->writeln('Aborted');
				$ret = 1;
			}
		}
		else if ($input->getOption('image-errors')) {
			if ($this->confirmate()) {
				$this->resetImageErrors($user);
				$output->writeln('Reset image errors done');
			} else {
				$output->writeln('Aborted');
				$ret = 1;
			}
		}
		else if ($input->getOption('clustering')) {
			if ($this->confirmate()) {
				$this->resetClusters($user);
				$output->writeln('Reset clustering done');
			} else {
				$output->writeln('Aborted');
				$ret = 1;
			}
		}
		else {
			$output->writeln('You must specify what you want to reset');
			$ret = 1;
		}

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

		return $ret;
	}

	private function confirmate() {
		$question = new ConfirmationQuestion('Warning: This command is not reversible. Do you want to continue? [y/N]', false);
		return $this->questionHelper->ask($this->input, $this->output, $question);
	}

	/**
	 * @param \OCP\IUser|null $user
	 */
	private function resetClusters(?\OCP\IUser $user): void {
		$this->faceManagementService->resetClusters($user);
	}

	/**
	 * @param \OCP\IUser|null $user
	 */
	private function resetImageErrors(?\OCP\IUser $user): void {
		$this->faceManagementService->resetImageErrors($user);
	}

	/**
	 * @param \OCP\IUser|null $user
	 */
	private function resetAll(?\OCP\IUser $user): void {
		$this->faceManagementService->resetAll($user);
	}

	/**
	 * @param \OCP\IUser|null $user
	 */
	private function resetModel(?\OCP\IUser $user): void {
		$this->faceManagementService->resetModel($user);
	}

}