meilisearch/Classes/Domain/Index/Queue/QueueInitializationService.php
2021-04-17 21:20:54 +02:00

163 lines
7.0 KiB
PHP

<?php declare(strict_types = 1);
namespace WapplerSystems\Meilisearch\Domain\Index\Queue;
/***************************************************************
* Copyright notice
*
* (c) 2010-2017 dkd Internet Service GmbH <meilisearch-support@dkd.de>
* All rights reserved
*
* This script is part of the TYPO3 project. The TYPO3 project is
* free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This script 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 General Public License for more details.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
use WapplerSystems\Meilisearch\IndexQueue\InitializationPostProcessor;
use WapplerSystems\Meilisearch\IndexQueue\Queue;
use WapplerSystems\Meilisearch\Domain\Site\Site;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* The queue initialization service is responsible to run the initialization of the index queue for a combination of sites
* and index queue configurations.
*
* @author Timo Hund <timo.hund@dkd.de>
* @author Ingo Renner <ingo.renner@dkd.de>
*/
class QueueInitializationService {
/**
* @var Queue
*/
protected $queue;
/**
* QueueInitializationService constructor.
*/
public function __construct(Queue $queue)
{
$this->queue = $queue;
}
/**
* Truncate and rebuild the tx_meilisearch_indexqueue_item table. This is the most
* complete way to force reindexing, or to build the Index Queue for the
* first time. The Index Queue initialization is site-specific.
*
* @param Site $site The site to initialize
* @param string $indexingConfigurationName Name of a specific indexing configuration, when * is passed any is used
* @return array An array of booleans, each representing whether the
* initialization for an indexing configuration was successful
*/
public function initializeBySiteAndIndexConfiguration(Site $site, $indexingConfigurationName = '*'): array
{
return $this->initializeBySiteAndIndexConfigurations($site, [$indexingConfigurationName]);
}
/**
* Truncates and rebuilds the tx_meilisearch_indexqueue_item table for a set of sites and a set of index configurations.
*
* @param array $sites The array of sites to initialize
* @param array $indexingConfigurationNames the array of index configurations to initialize.
* @return array
*/
public function initializeBySitesAndConfigurations(array $sites, array $indexingConfigurationNames = ['*']): array
{
$initializationStatesBySiteId = [];
foreach($sites as $site) {
/** @var Site $site */
$initializationResult = $this->initializeBySiteAndIndexConfigurations($site, $indexingConfigurationNames);
$initializationStatesBySiteId[$site->getRootPageId()] = $initializationResult;
}
return $initializationStatesBySiteId;
}
/**
* Initializes a set index configurations for a given site.
*
* @param Site $site
* @param array $indexingConfigurationNames if one of the names is a * (wildcard) all configurations are used,
* @return array
*/
public function initializeBySiteAndIndexConfigurations(Site $site, array $indexingConfigurationNames): array
{
$initializationStatus = [];
$hasWildcardConfiguration = in_array('*', $indexingConfigurationNames);
$indexingConfigurationNames = $hasWildcardConfiguration ? $site->getMeilisearchConfiguration()->getEnabledIndexQueueConfigurationNames() : $indexingConfigurationNames;
foreach ($indexingConfigurationNames as $indexingConfigurationName) {
$initializationStatus[$indexingConfigurationName] = $this->applyInitialization($site, (string)$indexingConfigurationName);
}
if (!is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['meilisearch']['postProcessIndexQueueInitialization'])) {
return $initializationStatus;
}
foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['meilisearch']['postProcessIndexQueueInitialization'] as $classReference) {
$indexQueueInitializationPostProcessor = GeneralUtility::makeInstance($classReference);
if ($indexQueueInitializationPostProcessor instanceof InitializationPostProcessor) {
$indexQueueInitializationPostProcessor->postProcessIndexQueueInitialization($site, $indexingConfigurationNames, $initializationStatus);
} else {
throw new \UnexpectedValueException(get_class($indexQueueInitializationPostProcessor) . ' must implement interface ' . InitializationPostProcessor::class, 1345815561);
}
}
return $initializationStatus;
}
/**
* Initializes the Index Queue for a specific indexing configuration.
*
* @param Site $site The site to initialize
* @param string $indexingConfigurationName name of a specific
* indexing configuration
* @return bool TRUE if the initialization was successful, FALSE otherwise
*/
protected function applyInitialization(Site $site, $indexingConfigurationName): bool
{
// clear queue
$this->queue->deleteItemsBySite($site, $indexingConfigurationName);
$meilisearchConfiguration = $site->getMeilisearchConfiguration();
$tableToIndex = $meilisearchConfiguration->getIndexQueueTableNameOrFallbackToConfigurationName($indexingConfigurationName);
$initializerClass = $meilisearchConfiguration->getIndexQueueInitializerClassByConfigurationName($indexingConfigurationName);
$indexConfiguration = $meilisearchConfiguration->getIndexQueueConfigurationByName($indexingConfigurationName);
return $this->executeInitializer($site, $indexingConfigurationName, $initializerClass, $tableToIndex, $indexConfiguration);
}
/**
* @param Site $site
* @param string $indexingConfigurationName
* @param string $initializerClass
* @param string $tableToIndex
* @param array $indexConfiguration
* @return bool
*/
protected function executeInitializer(Site $site, $indexingConfigurationName, $initializerClass, $tableToIndex, $indexConfiguration): bool
{
$initializer = GeneralUtility::makeInstance($initializerClass);
/** @var $initializer \WapplerSystems\Meilisearch\IndexQueue\Initializer\AbstractInitializer */
$initializer->setSite($site);
$initializer->setType($tableToIndex);
$initializer->setIndexingConfigurationName($indexingConfigurationName);
$initializer->setIndexingConfiguration($indexConfiguration);
return $initializer->initialize();
}
}