OCA\FullTextSearch\Command\Live

Complexity

Total Complexity

76

Size/Duplication

Total Lines	732
Duplicated Lines	40.57 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	1
A	configure()	0	13	1
C	execute()	0	72	11
A	liveCycle()	15	34	4
F	onKeyPressed()	50	50	16
A	onNewIndexError()	0	4	1
A	onNewIndexResult()	0	4	1
B	generatePanels()	8	113	3
A	generateIndexErrors()	16	16	3
A	displayResult()	54	54	4
A	displayError()	47	47	4
B	getNavigationResult()	31	31	9
B	getNavigationError()	31	31	9
B	deleteError()	44	44	7
A	abort()	0	8	2

<?php
declare(strict_types=1);


/**
 * FullTextSearch - Full text search framework for Nextcloud
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <maxence@artificial-owl.com>
 * @copyright 2018
 * @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\FullTextSearch\Command;


use daita\MySmallPhpTools\Traits\TArrayTools;
use Exception;
use OC\Core\Command\InterruptedException;
use OCA\FullTextSearch\ACommandBase;
use OCA\FullTextSearch\Exceptions\TickDoesNotExistException;
use OCA\FullTextSearch\Model\Index as ModelIndex;
use OCA\FullTextSearch\Model\Runner;
use OCA\FullTextSearch\Service\CliService;
use OCA\FullTextSearch\Service\ConfigService;
use OCA\FullTextSearch\Service\IndexService;
use OCA\FullTextSearch\Service\MiscService;
use OCA\FullTextSearch\Service\PlatformService;
use OCA\FullTextSearch\Service\ProviderService;
use OCA\FullTextSearch\Service\RunningService;
use OCP\IUserManager;
use OutOfBoundsException;
use Symfony\Component\Console\Formatter\OutputFormatterStyle;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Terminal;
use Throwable;


/**
 * Class Live
 *
 * @package OCA\FullTextSearch\Command
 */
class Live extends ACommandBase {


	use TArrayTools;


	const INDEX_OPTION_NO_READLINE = '_no-readline';

	const CYCLE_DELAY = 300000;

	const PANEL_RUN = 'run';
	const PANEL_RUN_LINE_MEMORY = 'Memory: %_memory%';

	const PANEL_INDEX = 'indexing';
	const PANEL_INDEX_LINE_HEADER = '┌─ Indexing %_paused% ────';
	const PANEL_INDEX_LINE_ACCOUNT = '│ Provider: <info>%providerName:-20s%</info> Account: <info>%userId%</info>';
	const PANEL_INDEX_LINE_ACTION = '│ Action: <info>%action%</info>';
	const PANEL_INDEX_LINE_DOCUMENT = '│ Document: <info>%documentId%</info>';
	const PANEL_INDEX_LINE_INFO = '│ Info: <info>%info%</info>';
	const PANEL_INDEX_LINE_TITLE = '│ Title: <info>%title%</info>';
	const PANEL_INDEX_LINE_CONTENT = '│ Content size: <info>%content%</info>';
	const PANEL_INDEX_LINE_FOOTER = '└──';

	const PANEL_RESULT = 'result';
	const PANEL_RESULT_LINE_HEADER = '┌─ Results ────';
	const PANEL_RESULT_LINE_RESULT = '│ Result: <info>%resultCurrent:6s%</info>/<info>%resultTotal%</info>';
	const PANEL_RESULT_LINE_INDEX = '│ Index: <info>%resultIndex%</info>';
	const PANEL_RESULT_LINE_STATUS = '│ Status: %resultStatusColored%';
	const PANEL_RESULT_LINE_MESSAGE1 = '│ Message: <info>%resultMessageA%</info>';
	const PANEL_RESULT_LINE_MESSAGE2 = '│ <info>%resultMessageB%</info>';
	const PANEL_RESULT_LINE_MESSAGE3 = '│ <info>%resultMessageC%</info>';
	const PANEL_RESULT_LINE_FOOTER = '└──';

	const PANEL_ERRORS = 'errors';
	const PANEL_ERRORS_LINE_HEADER = '┌─ Errors ────';
	const PANEL_ERRORS_LINE_ERRORS = '│ Error: <comment>%errorCurrent:6s%</comment>/<comment>%errorTotal%</comment>';
	const PANEL_ERRORS_LINE_ERROR_INDEX = '│ Index: <comment>%errorIndex%</comment>';
	const PANEL_ERRORS_LINE_ERROR_EXCEPTION = '│ Exception: <comment>%errorException%</comment>';
	const PANEL_ERRORS_LINE_ERROR_MESSAGE1 = '│ Message: <comment>%errorMessageA%</comment>';
	const PANEL_ERRORS_LINE_ERROR_MESSAGE2 = '│ <comment>%errorMessageB%</comment>';
	const PANEL_ERRORS_LINE_ERROR_MESSAGE3 = '│ <comment>%errorMessageC%</comment>';
	const PANEL_ERRORS_LINE_FOOTER = '└──';

	const PANEL_COMMANDS_ROOT = 'root';
	const PANEL_COMMANDS_ROOT_LINE = '## <char>q</char>:quit ## <char>p</char>:pause ';
	const PANEL_COMMANDS_PAUSED = 'paused';
	const PANEL_COMMANDS_PAUSED_LINE = '## <char>q</char>:quit ## <char>u</char>:unpause ## <char>n</char>:next step';
	const PANEL_COMMANDS_DONE = 'done';
	const PANEL_COMMANDS_DONE_LINE = '## <char>q</char>:quit';
	const PANEL_COMMANDS_NAVIGATION = 'navigation';
	const PANEL_COMMANDS_ERRORS_LINE = '## <char>f</char>:first error ## <char>h</char>/<char>j</char>:prec/next error ## <char>d</char>:delete error ## <char>l</char>:last error';
	const PANEL_COMMANDS_RESULTS_LINE = '## <char>x</char>:first result ## <char>c</char>/<char>v</char>:prec/next result ## <char>b</char>:last result';


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

	/** @var ConfigService */
	private $configService;

	/** @var CliService */
	private $cliService;

	/** @var RunningService */
	private $runningService;

	/** @var IndexService */
	private $indexService;

	/** @var PlatformService */
	private $platformService;

	/** @var ProviderService */
	private $providerService;

	/** @var MiscService */
	private $miscService;


	/** @var Runner */
	private $runner;

	/** @var Terminal */
	private $terminal;

	/** @var array */
	private $errors = [];

	/** @var bool */
	private $navigateLastError = true;

	/** @var array */
	private $results = [];

	/** @var bool */
	private $navigateLastResult = true;

	/**
	 * Live constructor.
	 *
	 * @param IUserManager $userManager
	 * @param RunningService $runningService
	 * @param ConfigService $configService
	 * @param CliService $cliService
	 * @param IndexService $indexService
	 * @param PlatformService $platformService
	 * @param ProviderService $providerService
	 * @param MiscService $miscService
	 */
	public function __construct(
		IUserManager $userManager, RunningService $runningService, ConfigService $configService,
		CliService $cliService, IndexService $indexService, PlatformService $platformService,
		ProviderService $providerService, MiscService $miscService
	) {
		parent::__construct();
		$this->userManager = $userManager;

		$this->runner = new Runner($runningService, 'commandLive');
		$this->configService = $configService;
		$this->cliService = $cliService;
		$this->runningService = $runningService;
		$this->indexService = $indexService;
		$this->platformService = $platformService;
		$this->providerService = $providerService;
		$this->miscService = $miscService;
	}


	/**
	 *
	 */
	protected function configure() {
		parent::configure();
		$this->setName('fulltextsearch:live')
			 ->setDescription('Index files')
			 ->addOption(
				 'no-readline', 'r', InputOption::VALUE_NONE,
				 'disable readline - non interactive mode'
			 )
			 ->addOption(
				 'service', 's', InputOption::VALUE_NONE,
				 'disable interface'
			 );
	}


	/**
	 * @param InputInterface $input
	 * @param OutputInterface $output
	 *
	 * @return int|null|void
	 * @throws Exception
	 */
	protected function execute(InputInterface $input, OutputInterface $output) {

		if ($this->configService->getCloudVersion() < 14) {
			throw new Exception('This feature is only available on Nextcloud 14 or newer');
		}


		if (!$input->getOption('service') && !$input->getOption('no-readline')) {
			try {
				/** do not get stuck while waiting interactive input */
				readline_callback_handler_install(
					'', function() {
				}
				);
			} catch (Throwable $t) {

The class Throwable does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

				throw new Exception('Please install php-readline, or use --no-readline');
			}
		}
		stream_set_blocking(STDIN, false);

		$this->terminal = new Terminal();

		$outputStyle = new OutputFormatterStyle('white', 'black', ['bold']);
		$output->getFormatter()
			   ->setStyle('char', $outputStyle);

		$this->runner = new Runner($this->runningService, 'commandIndex', ['nextStep' => 'n']);

		if (!$input->getOption('service')) {
			$this->runner->onKeyPress([$this, 'onKeyPressed']);
			$this->runner->onNewIndexError([$this, 'onNewIndexError']);
			$this->runner->onNewIndexResult([$this, 'onNewIndexResult']);
			$this->runner->sourceIsCommandLine($this, $output);

			$this->generatePanels(!$input->getOption('no-readline'));
		}

		$this->indexService->setRunner($this->runner);
		$this->cliService->setRunner($this->runner);

		while (true) {
			try {
				$this->runner->start();

				if (!$input->getOption('service')) {
					$this->cliService->runDisplay($output);
					$this->generateIndexErrors();
					$this->displayError();
					$this->displayResult();
				}

				$this->liveCycle();

			} catch (Exception $e) {
				$this->miscService->log(
					'Exception while live index: ' . get_class($e) . ' - ' . $e->getMessage()
				);

				if (!$input->getOption('service')) {
					throw $e;
				}
			}

			if (!$input->getOption('service')) {
				break;
			}

			sleep(120);
		}

		$this->runner->stop();
	}


	/**
	 * @throws Exception
	 * @throws TickDoesNotExistException
	 */
	private function liveCycle() {

		$wrapper = $this->platformService->getPlatform();
		$platform = $wrapper->getPlatform();
		$platform->setRunner($this->runner);

		while (true) {

			$indexes = $this->indexService->getQueuedIndexes();

			foreach ($indexes as $index) {

This code seems to be duplicated across your project.

				$this->runner->updateAction('indexing');

				try {
					$providerWrapper = $this->providerService->getProvider($index->getProviderId());
					$provider = $providerWrapper->getProvider();

					$provider->setRunner($this->runner);
					$this->indexService->updateDocument($platform, $provider, $index);
				} catch (Exception $e) {
					$this->runner->exception($e->getMessage(), false);

The method OCA\FullTextSearch\Model\Runner::exception() has been deprecated with message: - verifier l'interet !?

					// TODO - upgrade error number - after too many errors, delete index
					// TODO - do not count error if elasticsearch is down.
				}
			}

			$this->runner->updateAction('waiting', true);

			usleep(self::CYCLE_DELAY);
		}

		$this->runner->stop();

	}


	/**
	 * @param string $key
	 */
	public function onKeyPressed(string $key) {

This method seems to be duplicated in your project.

		$key = strtolower($key);
		if ($key === 'q') {
			try {
				$this->runner->stop();
			} catch (TickDoesNotExistException $e) {
				/** we do nohtin' */
			}
			exit();
		}

		$current = $this->cliService->currentPanel('commands');
		if ($current === self::PANEL_COMMANDS_ROOT && $key === 'p') {
			$this->cliService->switchPanel('commands', self::PANEL_COMMANDS_PAUSED);
			$this->runner->pause(true);
		}
		if ($current === self::PANEL_COMMANDS_PAUSED && $key === 'u') {
			$this->cliService->switchPanel('commands', self::PANEL_COMMANDS_ROOT);
			$this->runner->pause(false);
		}

		if ($key === 'x') {
			$this->displayResult(-99);
		}
		if ($key === 'c') {
			$this->displayResult(-1);
		}
		if ($key === 'v') {
			$this->displayResult(1);
		}
		if ($key === 'b') {
			$this->displayResult(99);
		}

		if ($key === 'f') {
			$this->displayError(-99);
		}
		if ($key === 'h') {
			$this->displayError(-1);
		}
		if ($key === 'j') {
			$this->displayError(1);
		}
		if ($key === 'l') {
			$this->displayError(99);
		}
		if ($key === 'd') {
			$this->deleteError();
		}
	}


	/**
	 * @param array $error
	 */
	public function onNewIndexError(array $error) {
		$this->errors[] = $error;
		$this->displayError();
	}

	/**
	 * @param array $result
	 */
	public function onNewIndexResult(array $result) {
		$this->results[] = $result;
		$this->displayResult();
	}


	/**
	 * @param bool $commands
	 */
	private function generatePanels(bool $commands) {

		$this->cliService->createPanel(
			self::PANEL_RUN,
			[
				self::PANEL_RUN_LINE_MEMORY
			]
		);

		$this->cliService->createPanel(
			self::PANEL_INDEX, [
								 self::PANEL_INDEX_LINE_HEADER,
								 self::PANEL_INDEX_LINE_ACTION,
								 self::PANEL_INDEX_LINE_ACCOUNT,
								 self::PANEL_INDEX_LINE_DOCUMENT,
								 self::PANEL_INDEX_LINE_INFO,
								 self::PANEL_INDEX_LINE_TITLE,
								 self::PANEL_INDEX_LINE_CONTENT,
								 self::PANEL_INDEX_LINE_FOOTER,
							 ]
		);

		$this->cliService->createPanel(
			self::PANEL_RESULT, [
								  self::PANEL_RESULT_LINE_HEADER,
								  self::PANEL_RESULT_LINE_RESULT,
								  self::PANEL_RESULT_LINE_INDEX,
								  self::PANEL_RESULT_LINE_STATUS,
								  self::PANEL_RESULT_LINE_MESSAGE1,
								  self::PANEL_RESULT_LINE_MESSAGE2,
								  self::PANEL_RESULT_LINE_MESSAGE3,
								  self::PANEL_RESULT_LINE_FOOTER,
							  ]
		);

		$this->cliService->createPanel(
			self::PANEL_ERRORS, [
								  self::PANEL_ERRORS_LINE_HEADER,
								  self::PANEL_ERRORS_LINE_ERRORS,
								  self::PANEL_ERRORS_LINE_ERROR_INDEX,
								  self::PANEL_ERRORS_LINE_ERROR_EXCEPTION,
								  self::PANEL_ERRORS_LINE_ERROR_MESSAGE1,
								  self::PANEL_ERRORS_LINE_ERROR_MESSAGE2,
								  self::PANEL_ERRORS_LINE_ERROR_MESSAGE3,
								  self::PANEL_ERRORS_LINE_FOOTER,
							  ]
		);

		$this->cliService->createPanel(
			self::PANEL_COMMANDS_ROOT, [
										 self::PANEL_COMMANDS_ROOT_LINE
									 ]
		);

		$this->cliService->createPanel(
			self::PANEL_COMMANDS_PAUSED, [
										   self::PANEL_COMMANDS_PAUSED_LINE
									   ]
		);

		$this->cliService->createPanel(
			self::PANEL_COMMANDS_NAVIGATION, [
											   self::PANEL_COMMANDS_RESULTS_LINE,
											   self::PANEL_COMMANDS_ERRORS_LINE
										   ]
		);

		$this->cliService->initDisplay();
		$this->cliService->displayPanel('run', self::PANEL_RUN);
		$this->cliService->displayPanel('indexPanel', self::PANEL_INDEX);
		$this->cliService->displayPanel('resultsPanel', self::PANEL_RESULT);
		$this->cliService->displayPanel('errorsPanel', self::PANEL_ERRORS);

		if ($commands) {

This code seems to be duplicated across your project.

			$this->cliService->displayPanel('navigation', self::PANEL_COMMANDS_NAVIGATION);
			if ($this->runner->isPaused()) {
				$this->cliService->displayPanel('commands', self::PANEL_COMMANDS_PAUSED);
			} else {
				$this->cliService->displayPanel('commands', self::PANEL_COMMANDS_ROOT);
			}
		}

		$this->runner->setInfoArray(
			[
				'userId'              => '',
				'providerName'        => '',
				'_memory'             => '',
				'documentId'          => '',
				'action'              => '',
				'info'                => '',
				'title'               => '',
				'_paused'             => '',
				'resultIndex'         => '',
				'resultCurrent'       => '',
				'resultTotal'         => '',
				'resultMessageA'      => '',
				'resultMessageB'      => '',
				'resultMessageC'      => '',
				'resultStatus'        => '',
				'resultStatusColored' => '',
				'content'             => '',
				'statusColored'       => '',
				'progressStatus'      => '',
				'errorCurrent'        => '0',
				'errorTotal'          => '0',
				'errorMessageA'       => '',
				'errorMessageB'       => '',
				'errorMessageC'       => '',
				'errorException'      => '',
				'errorIndex'          => ''
			]
		);
	}


	/**
	 *
	 */
	private function generateIndexErrors() {

This method seems to be duplicated in your project.

		$indexes = $this->indexService->getErrorIndexes();

		foreach ($indexes as $index) {
			foreach ($index->getErrors() as $error) {
				$this->errors[] = [
					'index'     => $index,
					'message'   => $error['message'],
					'exception' => $error['exception'],
					'severity'  => $error['severity']
				];
			}

		}

	}


	/**
	 * @param int $pos
	 */
	private function displayResult(int $pos = 0) {

This method seems to be duplicated in your project.

		$total = sizeof($this->results);

		if ($total === 0) {
			$this->runner->setInfoArray(
				[
					'resultCurrent' => 0,
					'resultTotal'   => 0,
				]
			);

			return;
		}

		try {
			$current = key($this->results) + 1;
			$result = $this->getNavigationResult($pos, ($current === 1), ($current === $total));
			$current = key($this->results) + 1;
		} catch (OutOfBoundsException $e) {
			return;
		}

		/** @var ModelIndex $index */
		$index = $result['index'];
		$resultIndex = '';
		if ($index !== null) {
			$resultIndex = $index->getProviderId() . ':' . $index->getDocumentId();
		}


		$width = $this->terminal->getWidth() - 13;
		$message = $this->get('message', $result, '');
		$msg1 = (string)substr($message, 0, $width);
		$msg2 = (string)substr($message, $width, $width + 10);
		$msg3 = (string)substr($message, $width + $width + 10, $width + 10);


		$status = $this->get('status', $result, '');
		$type = $this->getInt('type', $result, 0);


		$this->runner->setInfoArray(
			[
				'resultCurrent'  => $current,
				'resultTotal'    => $total,
				'resultMessageA' => trim($msg1),
				'resultMessageB' => trim($msg2),
				'resultMessageC' => trim($msg3),
				'resultStatus'   => $status,
				'resultIndex'    => $resultIndex
			]
		);
		$this->runner->setInfoColored('resultStatus', $type);
	}

	/**
	 * @param int $pos
	 */
	private function displayError(int $pos = 0) {

This method seems to be duplicated in your project.

		$total = sizeof($this->errors);

		if ($total === 0) {
			$this->runner->setInfoArray(
				[
					'errorCurrent' => 0,
					'errorTotal'   => 0,
				]
			);

			return;
		}

		try {
			$current = key($this->errors) + 1;
			$error = $this->getNavigationError($pos, ($current === 1), ($current === $total));
			$current = key($this->errors) + 1;
		} catch (OutOfBoundsException $e) {
			return;
		}

		/** @var ModelIndex $index */
		$index = $error['index'];
		$errorIndex = '';
		if ($index !== null) {
			$errorIndex = $index->getProviderId() . ':' . $index->getDocumentId();
		}

		$width = $this->terminal->getWidth() - 13;
		$message = $this->get('message', $error, '');
		$err1 = (string)substr($message, 0, $width);
		$err2 = (string)substr($message, $width, $width + 10);
		$err3 = (string)substr($message, $width + $width + 10, $width + 10);

		$this->runner->setInfoArray(
			[
				'errorCurrent'   => $current,
				'errorTotal'     => $total,
				'errorMessageA'  => trim($err1),
				'errorMessageB'  => trim($err2),
				'errorMessageC'  => trim($err3),
				'errorException' => $this->get('exception', $error, ''),
				'errorIndex'     => $errorIndex
			]
		);
	}


	/**
	 * @param int $pos
	 * @param bool $isFirst
	 * @param bool $isLast
	 *
	 * @return array
	 * @throws OutOfBoundsException
	 */
	private function getNavigationResult(int $pos, bool $isFirst, bool $isLast): array {

This method seems to be duplicated in your project.

		if ($pos === 0) {
			if ($this->navigateLastResult === true) {
				return end($this->results);
			} else {
				return current($this->results);
			}
		}

		$this->navigateLastResult = false;
		if ($pos === -99) {
			return reset($this->results);
		}

		if ($pos === -1 && !$isFirst) {
			return prev($this->results);
		}

		if ($pos === 1 && !$isLast) {
			return next($this->results);
		}

		if ($pos === 99) {
			$this->navigateLastResult = true;

			return end($this->results);
		}

		throw new OutOfBoundsException();
	}


	/**
	 * @param int $pos
	 * @param bool $isFirst
	 * @param bool $isLast
	 *
	 * @return array
	 */
	private function getNavigationError(int $pos, bool $isFirst, bool $isLast): array {

This method seems to be duplicated in your project.

		if ($pos === 0) {
			if ($this->navigateLastError === true) {
				return end($this->errors);
			} else {
				return current($this->errors);
			}
		}

		$this->navigateLastError = false;
		if ($pos === -99) {
			return reset($this->errors);
		}

		if ($pos === -1 && !$isFirst) {
			return prev($this->errors);
		}

		if ($pos === 1 && !$isLast) {
			return next($this->errors);
		}

		if ($pos === 99) {
			$this->navigateLastError = true;

			return end($this->errors);
		}

		throw new OutOfBoundsException();
	}


	/**
	 *
	 */
	private function deleteError() {

This method seems to be duplicated in your project.

		$current = current($this->errors);
		if ($current === false) {
			return;
		}

		$this->runner->setInfoArray(
			[
				'errorMessageA'  => '',
				'errorMessageB'  => '',
				'errorMessageC'  => '',
				'errorException' => '',
				'errorIndex'     => ''
			]
		);

		$pos = key($this->errors);

		/** @var ModelIndex $index */
		$index = $current['index'];
		$this->indexService->resetErrorFromIndex($index);

		$errors = [];
		foreach ($this->errors as $error) {
			/** @var ModelIndex $errorIndex */
			$errorIndex = $error['index'];
			if ($index->getProviderId() === $errorIndex->getProviderId()
				&& $index->getDocumentId() === $errorIndex->getDocumentId()) {
				continue;
			}

			$errors[] = $error;
		}

		$this->errors = $errors;
		while (key($this->errors) < $pos) {
			if (next($this->errors) === false) {
				end($this->errors);
				break;
			}
		}

		$this->displayError();
	}


	/**
	 * @throws TickDoesNotExistException
	 */
	public function abort() {
		try {
			$this->abortIfInterrupted();
		} catch (InterruptedException $e) {

The class OC\Core\Command\InterruptedException does not exist. Did you forget a USE statement, or did you not list all dependencies?

			$this->runner->stop();
			exit();
		}
	}


}