* @copyright 2017 Akeneo SAS (http://www.akeneo.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/
class ResetIndexesCommand extends Command
{
protected static $defaultName = 'akeneo:elasticsearch:reset-indexes';
/**
* @var ClientRegistry
*/
private $clientRegistry;
public function __construct(ClientRegistry $clientRegistry)
{
parent::__construct();
$this->clientRegistry = $clientRegistry;
}
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
->addOption(
'reset-indexes',
null,
InputOption::VALUE_NONE,
'Resets registered ES indexes prior to reindex'
)
->addOption('index', 'i', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'ES index name to reset')
->setDescription('Resets all registered ES indexes');
}
/**
* {@inheritdoc}
*/
protected function execute(InputInterface $input, OutputInterface $output): int
{
if (!$this->userConfirmation($input, $output)) {
return Command::FAILURE;
}
$esClients = $this->getFilteredEsClients($input);
$this->resetIndexes($output, $esClients);
if (!$this->areIndexesExisting($output, $esClients)) {
return Command::FAILURE;
}
$this->showSuccessMessages($output);
return Command::SUCCESS;
}
/**
* @param InputInterface $input
* @param OutputInterface $output
*
* @return bool
*/
private function userConfirmation(InputInterface $input, OutputInterface $output): bool
{
$esClients = $this->getFilteredEsClients($input);
if (empty($esClients)) {
$output->writeln('There is not any index to reset. Maybe you provided an index to reset that does not exist.');
}
$output->writeln('This action will entirely reset the following indexes in the PIM:');
foreach ($esClients as $esClient) {
$output->writeln(sprintf('%s', $esClient->getIndexName()));
}
$question = new ConfirmationQuestion(
'Are you sure you want to proceed ? (Y/n)',
true
);
$question->setMaxAttempts(2);
$helper = $this->getHelper('question');
if (!$helper->ask($input, $output, $question)) {
$output->writeln('Operation aborted. Nothing has been done.');
return false;
}
return true;
}
/**
* Gets the clients to reset filtered by those provided in the arguments of the function.
*
* @return Client[]
*/
private function getFilteredEsClients(InputInterface $input): array
{
$esClients = $this->getEsClients();
$selectedIndexes = $input->getOption('index');
if (empty($selectedIndexes)) {
return $esClients;
}
$filteredEsClients = array_filter($esClients, function (Client $client) use ($selectedIndexes) {
return in_array($client->getIndexName(), $selectedIndexes);
});
return $filteredEsClients;
}
/**
* Gets the clients from the registry.
*
* @return Client[]
*/
private function getEsClients(): array
{
return $this->clientRegistry->getClients();
}
/**
* Checks wether the indexes exists.
*
* @param OutputInterface $output
* @param Client[] $esClients
*
* @return bool
*/
private function areIndexesExisting(OutputInterface $output, array $esClients): bool
{
$errorMessages = [];
$errorMessage = '- The index "%s" does not exist in Elasticsearch.';
foreach ($esClients as $esClient) {
if (!$esClient->hasIndex()) {
$errorMessages[] = sprintf(
$errorMessage,
$esClient->getIndexName()
);
}
}
if (!empty($errorMessages)) {
$output->writeln('Something wrong happened to those indexes:');
$output->writeln(implode('\n', $errorMessages));
$output->writeln('');
$output->writeln('Please check that the Elasticsearch server is up and accessible and try running the operation again.');
return false;
}
return true;
}
/**
* Reset all the indexes in the registry.
*
* @param Client[] $esClients
*/
private function resetIndexes(OutputInterface $output, array $esClients): void
{
foreach ($esClients as $esClient) {
$output->writeln(sprintf('Resetting the index: %s', $esClient->getIndexName()));
$esClient->resetIndex();
}
}
/**
* @param OutputInterface $output
*/
protected function showSuccessMessages(OutputInterface $output): void
{
$output->writeln('');
$output->writeln('All the indexes have been successfully reset!');
$output->writeln('');
$output->writeln(
sprintf(
'You can now use the command %s and %s to start re-indexing your product and product models.',
IndexProductCommand::getDefaultName(),
IndexProductModelCommand::getDefaultName()
)
);
}
}