611 lines
22 KiB
PHP
611 lines
22 KiB
PHP
|
<?php
|
||
|
|
namespace WapplerSystems\Meilisearch\IndexQueue;
|
||
|
|
|
||
|
|
/***************************************************************
|
||
|
|
* Copyright notice
|
||
|
|
*
|
||
|
|
* (c) 2009-2015 Ingo Renner <ingo@typo3.org>
|
||
|
|
* 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\Domain\Index\Queue\QueueInitializationService;
|
||
|
|
use WapplerSystems\Meilisearch\Domain\Index\Queue\QueueItemRepository;
|
||
|
|
use WapplerSystems\Meilisearch\Domain\Index\Queue\RecordMonitor\Helper\ConfigurationAwareRecordService;
|
||
|
|
use WapplerSystems\Meilisearch\Domain\Index\Queue\RecordMonitor\Helper\RootPageResolver;
|
||
|
|
use WapplerSystems\Meilisearch\Domain\Index\Queue\Statistic\QueueStatistic;
|
||
|
|
use WapplerSystems\Meilisearch\Domain\Index\Queue\Statistic\QueueStatisticsRepository;
|
||
|
|
use WapplerSystems\Meilisearch\Domain\Site\Site;
|
||
|
|
use WapplerSystems\Meilisearch\FrontendEnvironment;
|
||
|
|
use WapplerSystems\Meilisearch\System\Cache\TwoLevelCache;
|
||
|
|
use WapplerSystems\Meilisearch\System\Logging\SolrLogManager;
|
||
|
|
use TYPO3\CMS\Backend\Utility\BackendUtility;
|
||
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The Indexing Queue. It allows us to decouple from frontend indexing and
|
||
|
|
* reacting to changes faster.
|
||
|
|
*
|
||
|
|
* @author Ingo Renner <ingo@typo3.org>
|
||
|
|
*/
|
||
|
|
class Queue
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* @var RootPageResolver
|
||
|
|
*/
|
||
|
|
protected $rootPageResolver;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var ConfigurationAwareRecordService
|
||
|
|
*/
|
||
|
|
protected $recordService;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var \WapplerSystems\Meilisearch\System\Logging\SolrLogManager
|
||
|
|
*/
|
||
|
|
protected $logger = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var QueueItemRepository
|
||
|
|
*/
|
||
|
|
protected $queueItemRepository;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var QueueStatisticsRepository
|
||
|
|
*/
|
||
|
|
protected $queueStatisticsRepository;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var QueueInitializationService
|
||
|
|
*/
|
||
|
|
protected $queueInitializationService;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var FrontendEnvironment
|
||
|
|
*/
|
||
|
|
protected $frontendEnvironment = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Queue constructor.
|
||
|
|
* @param RootPageResolver|null $rootPageResolver
|
||
|
|
* @param ConfigurationAwareRecordService|null $recordService
|
||
|
|
* @param QueueItemRepository|null $queueItemRepository
|
||
|
|
* @param QueueStatisticsRepository|null $queueStatisticsRepository
|
||
|
|
* @param QueueInitializationService|null $queueInitializationService
|
||
|
|
*/
|
||
|
|
public function __construct(
|
||
|
|
RootPageResolver $rootPageResolver = null,
|
||
|
|
ConfigurationAwareRecordService $recordService = null,
|
||
|
|
QueueItemRepository $queueItemRepository = null,
|
||
|
|
QueueStatisticsRepository $queueStatisticsRepository = null,
|
||
|
|
QueueInitializationService $queueInitializationService = null,
|
||
|
|
FrontendEnvironment $frontendEnvironment = null
|
||
|
|
)
|
||
|
|
{
|
||
|
|
$this->logger = GeneralUtility::makeInstance(SolrLogManager::class, /** @scrutinizer ignore-type */ __CLASS__);
|
||
|
|
$this->rootPageResolver = $rootPageResolver ?? GeneralUtility::makeInstance(RootPageResolver::class);
|
||
|
|
$this->recordService = $recordService ?? GeneralUtility::makeInstance(ConfigurationAwareRecordService::class);
|
||
|
|
$this->queueItemRepository = $queueItemRepository ?? GeneralUtility::makeInstance(QueueItemRepository::class);
|
||
|
|
$this->queueStatisticsRepository = $queueStatisticsRepository ?? GeneralUtility::makeInstance(QueueStatisticsRepository::class);
|
||
|
|
$this->queueInitializationService = $queueInitializationService ?? GeneralUtility::makeInstance(QueueInitializationService::class, /** @scrutinizer ignore-type */ $this);
|
||
|
|
$this->frontendEnvironment = $frontendEnvironment ?? GeneralUtility::makeInstance(FrontendEnvironment::class);
|
||
|
|
}
|
||
|
|
|
||
|
|
// FIXME some of the methods should be renamed to plural forms
|
||
|
|
// FIXME singular form methods should deal with exactly one item only
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the timestamp of the last indexing run.
|
||
|
|
*
|
||
|
|
* @param int $rootPageId The root page uid for which to get
|
||
|
|
* the last indexed item id
|
||
|
|
* @return int Timestamp of last index run.
|
||
|
|
*/
|
||
|
|
public function getLastIndexTime($rootPageId)
|
||
|
|
{
|
||
|
|
$lastIndexTime = 0;
|
||
|
|
|
||
|
|
$lastIndexedRow = $this->queueItemRepository->findLastIndexedRow($rootPageId);
|
||
|
|
|
||
|
|
if ($lastIndexedRow[0]['indexed']) {
|
||
|
|
$lastIndexTime = $lastIndexedRow[0]['indexed'];
|
||
|
|
}
|
||
|
|
|
||
|
|
return $lastIndexTime;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the uid of the last indexed item in the queue
|
||
|
|
*
|
||
|
|
* @param int $rootPageId The root page uid for which to get
|
||
|
|
* the last indexed item id
|
||
|
|
* @return int The last indexed item's ID.
|
||
|
|
*/
|
||
|
|
public function getLastIndexedItemId($rootPageId)
|
||
|
|
{
|
||
|
|
$lastIndexedItemId = 0;
|
||
|
|
|
||
|
|
$lastIndexedItemRow = $this->queueItemRepository->findLastIndexedRow($rootPageId);
|
||
|
|
if ($lastIndexedItemRow[0]['uid']) {
|
||
|
|
$lastIndexedItemId = $lastIndexedItemRow[0]['uid'];
|
||
|
|
}
|
||
|
|
|
||
|
|
return $lastIndexedItemId;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return QueueInitializationService
|
||
|
|
*/
|
||
|
|
public function getInitializationService()
|
||
|
|
{
|
||
|
|
return $this->queueInitializationService;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Marks an item as needing (re)indexing.
|
||
|
|
*
|
||
|
|
* Like with Solr itself, there's no add method, just a simple update method
|
||
|
|
* that handles the adds, too.
|
||
|
|
*
|
||
|
|
* The method creates or updates the index queue items for all related rootPageIds.
|
||
|
|
*
|
||
|
|
* @param string $itemType The item's type, usually a table name.
|
||
|
|
* @param string $itemUid The item's uid, usually an integer uid, could be a different value for non-database-record types.
|
||
|
|
* @param int $forcedChangeTime The change time for the item if set, otherwise value from getItemChangedTime() is used.
|
||
|
|
* @return int Number of updated/created items
|
||
|
|
*/
|
||
|
|
public function updateItem($itemType, $itemUid, $forcedChangeTime = 0)
|
||
|
|
{
|
||
|
|
$updateCount = $this->updateOrAddItemForAllRelatedRootPages($itemType, $itemUid, $forcedChangeTime);
|
||
|
|
$updateCount = $this->postProcessIndexQueueUpdateItem($itemType, $itemUid, $updateCount, $forcedChangeTime);
|
||
|
|
|
||
|
|
return $updateCount;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Updates or add's the item for all relevant root pages.
|
||
|
|
*
|
||
|
|
* @param string $itemType The item's type, usually a table name.
|
||
|
|
* @param string $itemUid The item's uid, usually an integer uid, could be a different value for non-database-record types.
|
||
|
|
* @param int $forcedChangeTime The change time for the item if set, otherwise value from getItemChangedTime() is used.
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
protected function updateOrAddItemForAllRelatedRootPages($itemType, $itemUid, $forcedChangeTime): int
|
||
|
|
{
|
||
|
|
$updateCount = 0;
|
||
|
|
$rootPageIds = $this->rootPageResolver->getResponsibleRootPageIds($itemType, $itemUid);
|
||
|
|
foreach ($rootPageIds as $rootPageId) {
|
||
|
|
$skipInvalidRootPage = $rootPageId === 0;
|
||
|
|
if ($skipInvalidRootPage) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$solrConfiguration = $this->frontendEnvironment->getSolrConfigurationFromPageId($rootPageId);
|
||
|
|
$indexingConfiguration = $this->recordService->getIndexingConfigurationName($itemType, $itemUid, $solrConfiguration);
|
||
|
|
if ($indexingConfiguration === null) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
$itemInQueueForRootPage = $this->containsItemWithRootPageId($itemType, $itemUid, $rootPageId);
|
||
|
|
if ($itemInQueueForRootPage) {
|
||
|
|
// update changed time if that item is in the queue already
|
||
|
|
$changedTime = ($forcedChangeTime > 0) ? $forcedChangeTime : $this->getItemChangedTime($itemType, $itemUid);
|
||
|
|
$updatedRows = $this->queueItemRepository->updateExistingItemByItemTypeAndItemUidAndRootPageId($itemType, $itemUid, $rootPageId, $changedTime, $indexingConfiguration);
|
||
|
|
} else {
|
||
|
|
// add the item since it's not in the queue yet
|
||
|
|
$updatedRows = $this->addNewItem($itemType, $itemUid, $indexingConfiguration, $rootPageId);
|
||
|
|
}
|
||
|
|
|
||
|
|
$updateCount += $updatedRows;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $updateCount;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Executes the updateItem post processing hook.
|
||
|
|
*
|
||
|
|
* @param string $itemType
|
||
|
|
* @param int $itemUid
|
||
|
|
* @param int $updateCount
|
||
|
|
* @param int $forcedChangeTime
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
protected function postProcessIndexQueueUpdateItem($itemType, $itemUid, $updateCount, $forcedChangeTime = 0)
|
||
|
|
{
|
||
|
|
if (!is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['postProcessIndexQueueUpdateItem'])) {
|
||
|
|
return $updateCount;
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['postProcessIndexQueueUpdateItem'] as $classReference) {
|
||
|
|
$updateHandler = $this->getHookImplementation($classReference);
|
||
|
|
$updateCount = $updateHandler->postProcessIndexQueueUpdateItem($itemType, $itemUid, $updateCount, $forcedChangeTime);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $updateCount;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $classReference
|
||
|
|
* @return object
|
||
|
|
*/
|
||
|
|
protected function getHookImplementation($classReference)
|
||
|
|
{
|
||
|
|
return GeneralUtility::makeInstance($classReference);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Finds indexing errors for the current site
|
||
|
|
*
|
||
|
|
* @param Site $site
|
||
|
|
* @return array Error items for the current site's Index Queue
|
||
|
|
*/
|
||
|
|
public function getErrorsBySite(Site $site)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->findErrorsBySite($site);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Resets all the errors for all index queue items.
|
||
|
|
*
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function resetAllErrors()
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->flushAllErrors();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Resets the errors in the index queue for a specific site
|
||
|
|
*
|
||
|
|
* @param Site $site
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function resetErrorsBySite(Site $site)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->flushErrorsBySite($site);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Resets the error in the index queue for a specific item
|
||
|
|
*
|
||
|
|
* @param Item $item
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function resetErrorByItem(Item $item)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->flushErrorByItem($item);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Adds an item to the index queue.
|
||
|
|
*
|
||
|
|
* Not meant for public use.
|
||
|
|
*
|
||
|
|
* @param string $itemType The item's type, usually a table name.
|
||
|
|
* @param string $itemUid The item's uid, usually an integer uid, could be a
|
||
|
|
* different value for non-database-record types.
|
||
|
|
* @param string $indexingConfiguration The item's indexing configuration to use.
|
||
|
|
* Optional, overwrites existing / determined configuration.
|
||
|
|
* @param $rootPageId
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
private function addNewItem($itemType, $itemUid, $indexingConfiguration, $rootPageId)
|
||
|
|
{
|
||
|
|
$additionalRecordFields = '';
|
||
|
|
if ($itemType === 'pages') {
|
||
|
|
$additionalRecordFields = ', doktype, uid';
|
||
|
|
}
|
||
|
|
|
||
|
|
$record = $this->getRecordCached($itemType, $itemUid, $additionalRecordFields);
|
||
|
|
|
||
|
|
if (empty($record) || ($itemType === 'pages' && !$this->frontendEnvironment->isAllowedPageType($record, $indexingConfiguration))) {
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
$changedTime = $this->getItemChangedTime($itemType, $itemUid);
|
||
|
|
|
||
|
|
return $this->queueItemRepository->add($itemType, $itemUid, $rootPageId, $changedTime, $indexingConfiguration);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get record to be added in addNewItem
|
||
|
|
*
|
||
|
|
* @param string $itemType The item's type, usually a table name.
|
||
|
|
* @param string $itemUid The item's uid, usually an integer uid, could be a
|
||
|
|
* different value for non-database-record types.
|
||
|
|
* @param string $additionalRecordFields for sql-query
|
||
|
|
*
|
||
|
|
* @return array|NULL
|
||
|
|
*/
|
||
|
|
protected function getRecordCached($itemType, $itemUid, $additionalRecordFields)
|
||
|
|
{
|
||
|
|
$cache = GeneralUtility::makeInstance(TwoLevelCache::class, /** @scrutinizer ignore-type */ 'cache_runtime');
|
||
|
|
$cacheId = md5('Queue' . ':' . 'getRecordCached' . ':' . $itemType . ':' . $itemUid . ':' . 'pid' . $additionalRecordFields);
|
||
|
|
|
||
|
|
$record = $cache->get($cacheId);
|
||
|
|
if (empty($record)) {
|
||
|
|
$record = BackendUtility::getRecord($itemType, $itemUid, 'pid' . $additionalRecordFields);
|
||
|
|
$cache->set($cacheId, $record);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $record;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Determines the time for when an item should be indexed. This timestamp
|
||
|
|
* is then stored in the changed column in the Index Queue.
|
||
|
|
*
|
||
|
|
* The changed timestamp usually is now - time(). For records which are set
|
||
|
|
* to published at a later time, this timestamp is the start time. So if a
|
||
|
|
* future start time has been set, that will be used to delay indexing
|
||
|
|
* of an item.
|
||
|
|
*
|
||
|
|
* @param string $itemType The item's table name.
|
||
|
|
* @param string $itemUid The item's uid, usually an integer uid, could be a
|
||
|
|
* different value for non-database-record types.
|
||
|
|
* @return int Timestamp of the item's changed time or future start time
|
||
|
|
*/
|
||
|
|
protected function getItemChangedTime($itemType, $itemUid)
|
||
|
|
{
|
||
|
|
$itemTypeHasStartTimeColumn = false;
|
||
|
|
$changedTimeColumns = $GLOBALS['TCA'][$itemType]['ctrl']['tstamp'];
|
||
|
|
$startTime = 0;
|
||
|
|
$pageChangedTime = 0;
|
||
|
|
|
||
|
|
if (!empty($GLOBALS['TCA'][$itemType]['ctrl']['enablecolumns']['starttime'])) {
|
||
|
|
$itemTypeHasStartTimeColumn = true;
|
||
|
|
$changedTimeColumns .= ', ' . $GLOBALS['TCA'][$itemType]['ctrl']['enablecolumns']['starttime'];
|
||
|
|
}
|
||
|
|
if ($itemType === 'pages') {
|
||
|
|
// does not carry time information directly, but needed to support
|
||
|
|
// canonical pages
|
||
|
|
$changedTimeColumns .= ', content_from_pid';
|
||
|
|
}
|
||
|
|
|
||
|
|
$record = BackendUtility::getRecord($itemType, $itemUid, $changedTimeColumns);
|
||
|
|
$itemChangedTime = $record[$GLOBALS['TCA'][$itemType]['ctrl']['tstamp']];
|
||
|
|
|
||
|
|
if ($itemTypeHasStartTimeColumn) {
|
||
|
|
$startTime = $record[$GLOBALS['TCA'][$itemType]['ctrl']['enablecolumns']['starttime']];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($itemType === 'pages') {
|
||
|
|
$record['uid'] = $itemUid;
|
||
|
|
// overrule the page's last changed time with the most recent
|
||
|
|
//content element change
|
||
|
|
$pageChangedTime = $this->getPageItemChangedTime($record);
|
||
|
|
}
|
||
|
|
|
||
|
|
$localizationsChangedTime = $this->queueItemRepository->getLocalizableItemChangedTime($itemType, (int)$itemUid);
|
||
|
|
|
||
|
|
// if start time exists and start time is higher than last changed timestamp
|
||
|
|
// then set changed to the future start time to make the item
|
||
|
|
// indexed at a later time
|
||
|
|
$changedTime = max(
|
||
|
|
$itemChangedTime,
|
||
|
|
$pageChangedTime,
|
||
|
|
$localizationsChangedTime,
|
||
|
|
$startTime
|
||
|
|
);
|
||
|
|
|
||
|
|
return $changedTime;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the most recent changed time of a page's content elements
|
||
|
|
*
|
||
|
|
* @param array $page Partial page record
|
||
|
|
* @return int Timestamp of the most recent content element change
|
||
|
|
*/
|
||
|
|
protected function getPageItemChangedTime(array $page)
|
||
|
|
{
|
||
|
|
if (!empty($page['content_from_pid'])) {
|
||
|
|
// canonical page, get the original page's last changed time
|
||
|
|
return $this->queueItemRepository->getPageItemChangedTimeByPageUid((int)$page['content_from_pid']);
|
||
|
|
}
|
||
|
|
return $this->queueItemRepository->getPageItemChangedTimeByPageUid((int)$page['uid']);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether the Index Queue contains a specific item.
|
||
|
|
*
|
||
|
|
* @param string $itemType The item's type, usually a table name.
|
||
|
|
* @param string $itemUid The item's uid, usually an integer uid, could be a
|
||
|
|
* different value for non-database-record types.
|
||
|
|
* @return bool TRUE if the item is found in the queue, FALSE otherwise
|
||
|
|
*/
|
||
|
|
public function containsItem($itemType, $itemUid)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->containsItem($itemType, (int)$itemUid);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether the Index Queue contains a specific item.
|
||
|
|
*
|
||
|
|
* @param string $itemType The item's type, usually a table name.
|
||
|
|
* @param string $itemUid The item's uid, usually an integer uid, could be a
|
||
|
|
* different value for non-database-record types.
|
||
|
|
* @param integer $rootPageId
|
||
|
|
* @return bool TRUE if the item is found in the queue, FALSE otherwise
|
||
|
|
*/
|
||
|
|
public function containsItemWithRootPageId($itemType, $itemUid, $rootPageId)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->containsItemWithRootPageId($itemType, (int)$itemUid, (int)$rootPageId);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether the Index Queue contains a specific item that has been
|
||
|
|
* marked as indexed.
|
||
|
|
*
|
||
|
|
* @param string $itemType The item's type, usually a table name.
|
||
|
|
* @param string $itemUid The item's uid, usually an integer uid, could be a
|
||
|
|
* different value for non-database-record types.
|
||
|
|
* @return bool TRUE if the item is found in the queue and marked as
|
||
|
|
* indexed, FALSE otherwise
|
||
|
|
*/
|
||
|
|
public function containsIndexedItem($itemType, $itemUid)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->containsIndexedItem($itemType, (int)$itemUid);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes an item from the Index Queue.
|
||
|
|
*
|
||
|
|
* @param string $itemType The type of the item to remove, usually a table name.
|
||
|
|
* @param int $itemUid The uid of the item to remove
|
||
|
|
*/
|
||
|
|
public function deleteItem($itemType, $itemUid)
|
||
|
|
{
|
||
|
|
$this->queueItemRepository->deleteItem($itemType, (int)$itemUid);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes all items of a certain type from the Index Queue.
|
||
|
|
*
|
||
|
|
* @param string $itemType The type of items to remove, usually a table name.
|
||
|
|
*/
|
||
|
|
public function deleteItemsByType($itemType)
|
||
|
|
{
|
||
|
|
$this->queueItemRepository->deleteItemsByType($itemType);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes all items of a certain site from the Index Queue. Accepts an
|
||
|
|
* optional parameter to limit the deleted items by indexing configuration.
|
||
|
|
*
|
||
|
|
* @param Site $site The site to remove items for.
|
||
|
|
* @param string $indexingConfigurationName Name of a specific indexing
|
||
|
|
* configuration
|
||
|
|
*/
|
||
|
|
public function deleteItemsBySite(Site $site, $indexingConfigurationName = '')
|
||
|
|
{
|
||
|
|
$this->queueItemRepository->deleteItemsBySite($site, $indexingConfigurationName);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes all items from the Index Queue.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
public function deleteAllItems()
|
||
|
|
{
|
||
|
|
$this->queueItemRepository->deleteAllItems();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets a single Index Queue item by its uid.
|
||
|
|
*
|
||
|
|
* @param int $itemId Index Queue item uid
|
||
|
|
* @return Item The request Index Queue item or NULL if no item with $itemId was found
|
||
|
|
*/
|
||
|
|
public function getItem($itemId)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->findItemByUid($itemId);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets Index Queue items by type and uid.
|
||
|
|
*
|
||
|
|
* @param string $itemType item type, usually the table name
|
||
|
|
* @param int $itemUid item uid
|
||
|
|
* @return Item[] An array of items matching $itemType and $itemUid
|
||
|
|
*/
|
||
|
|
public function getItems($itemType, $itemUid)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->findItemsByItemTypeAndItemUid($itemType, (int)$itemUid);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns all items in the queue.
|
||
|
|
*
|
||
|
|
* @return Item[] An array of items
|
||
|
|
*/
|
||
|
|
public function getAllItems()
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->findAll();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the number of items for all queues.
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getAllItemsCount()
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->count();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Extracts the number of pending, indexed and erroneous items from the
|
||
|
|
* Index Queue.
|
||
|
|
*
|
||
|
|
* @param Site $site
|
||
|
|
* @param string $indexingConfigurationName
|
||
|
|
*
|
||
|
|
* @return QueueStatistic
|
||
|
|
*/
|
||
|
|
public function getStatisticsBySite(Site $site, $indexingConfigurationName = '')
|
||
|
|
{
|
||
|
|
return $this->queueStatisticsRepository->findOneByRootPidAndOptionalIndexingConfigurationName($site->getRootPageId(), $indexingConfigurationName);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets $limit number of items to index for a particular $site.
|
||
|
|
*
|
||
|
|
* @param Site $site TYPO3 site
|
||
|
|
* @param int $limit Number of items to get from the queue
|
||
|
|
* @return Item[] Items to index to the given solr server
|
||
|
|
*/
|
||
|
|
public function getItemsToIndex(Site $site, $limit = 50)
|
||
|
|
{
|
||
|
|
return $this->queueItemRepository->findItemsToIndex($site, $limit);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Marks an item as failed and causes the indexer to skip the item in the
|
||
|
|
* next run.
|
||
|
|
*
|
||
|
|
* @param int|Item $item Either the item's Index Queue uid or the complete item
|
||
|
|
* @param string $errorMessage Error message
|
||
|
|
*/
|
||
|
|
public function markItemAsFailed($item, $errorMessage = '')
|
||
|
|
{
|
||
|
|
$this->queueItemRepository->markItemAsFailed($item, $errorMessage);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the timestamp of when an item last has been indexed.
|
||
|
|
*
|
||
|
|
* @param Item $item
|
||
|
|
*/
|
||
|
|
public function updateIndexTimeByItem(Item $item)
|
||
|
|
{
|
||
|
|
$this->queueItemRepository->updateIndexTimeByItem($item);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the change timestamp of an item.
|
||
|
|
*
|
||
|
|
* @param Item $item
|
||
|
|
* @param int $forcedChangeTime The change time for the item
|
||
|
|
*/
|
||
|
|
public function setForcedChangeTimeByItem(Item $item, $forcedChangeTime)
|
||
|
|
{
|
||
|
|
$this->queueItemRepository->updateChangedTimeByItem($item, $forcedChangeTime);
|
||
|
|
}
|
||
|
|
}
|