meilisearch/Classes/Task/ReIndexTaskAdditionalFieldProvider.php

256 lines
8.3 KiB
PHP
Raw Normal View History

2021-04-17 00:26:33 +02:00
<?php
namespace WapplerSystems\Meilisearch\Task;
/***************************************************************
* Copyright notice
*
* (c) 2011-2015 Christoph Moeller <support@network-publishing.de>
* (c) 2012-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\Backend\IndexingConfigurationSelectorField;
use WapplerSystems\Meilisearch\Backend\SiteSelectorField;
use WapplerSystems\Meilisearch\Domain\Site\SiteRepository;
use WapplerSystems\Meilisearch\Domain\Site\Site;
use TYPO3\CMS\Core\Page\PageRenderer;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
use TYPO3\CMS\Scheduler\Task\AbstractTask;
use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
/**
2021-04-17 21:20:54 +02:00
* Adds an additional field to specify the Meilisearch server to initialize the index queue for
2021-04-17 00:26:33 +02:00
*
* @author Christoph Moeller <support@network-publishing.de>
*/
class ReIndexTaskAdditionalFieldProvider implements AdditionalFieldProviderInterface
{
/**
* Task information
*
* @var array
*/
protected $taskInformation;
/**
* Scheduler task
*
* @var AbstractTask|ReIndexTask|NULL
*/
protected $task = null;
/**
* Scheduler Module
*
* @var SchedulerModuleController
*/
protected $schedulerModule;
/**
* Selected site
*
* @var Site
*/
protected $site = null;
/**
* SiteRepository
*
* @var SiteRepository
*/
protected $siteRepository;
/**
* @var PageRenderer
*/
protected $pageRenderer = null;
/**
* ReIndexTaskAdditionalFieldProvider constructor.
*/
public function __construct()
{
$this->siteRepository = GeneralUtility::makeInstance(SiteRepository::class);
}
/**
* @param array $taskInfo
* @param \TYPO3\CMS\Scheduler\Task\AbstractTask|NULL $task
* @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule
*/
protected function initialize(
array $taskInfo = [],
AbstractTask $task = null,
SchedulerModuleController $schedulerModule
) {
/** @var $task ReIndexTask */
$this->taskInformation = $taskInfo;
$this->task = $task;
$this->schedulerModule = $schedulerModule;
$currentAction = $schedulerModule->getCurrentAction();
if ($currentAction->equals(Action::EDIT)) {
$this->site = $this->siteRepository->getSiteByRootPageId($task->getRootPageId());
}
}
/**
2021-04-17 21:20:54 +02:00
* Used to define fields to provide the Meilisearch server address when adding
2021-04-17 00:26:33 +02:00
* or editing a task.
*
* @param array $taskInfo reference to the array containing the info used in the add/edit form
* @param AbstractTask $task when editing, reference to the current task object. Null when adding.
* @param SchedulerModuleController $schedulerModule reference to the calling object (Scheduler's BE module)
* @return array Array containing all the information pertaining to the additional fields
* The array is multidimensional, keyed to the task class name and each field's id
* For each field it provides an associative sub-array with the following:
*/
public function getAdditionalFields(
array &$taskInfo,
$task,
SchedulerModuleController $schedulerModule
) {
$additionalFields = [];
if (!$this->isTaskInstanceofReIndexTask($task)) {
return $additionalFields;
}
$this->initialize($taskInfo, $task, $schedulerModule);
$siteSelectorField = GeneralUtility::makeInstance(SiteSelectorField::class);
$additionalFields['site'] = [
'code' => $siteSelectorField->getAvailableSitesSelector('tx_scheduler[site]',
$this->site),
'label' => 'LLL:EXT:meilisearch/Resources/Private/Language/locallang.xlf:field_site',
'cshKey' => '',
'cshLabel' => ''
];
$additionalFields['indexingConfigurations'] = [
'code' => $this->getIndexingConfigurationSelector(),
'label' => 'Index Queue configurations to re-index',
'cshKey' => '',
'cshLabel' => ''
];
return $additionalFields;
}
protected function getIndexingConfigurationSelector()
{
$selectorMarkup = 'Please select a site first.';
2021-04-17 21:20:54 +02:00
$this->getPageRenderer()->addCssFile('../typo3conf/ext/meilisearch/Resources/Css/Backend/indexingconfigurationselectorfield.css');
2021-04-17 00:26:33 +02:00
if (is_null($this->site)) {
return $selectorMarkup;
}
$selectorField = GeneralUtility::makeInstance(IndexingConfigurationSelectorField::class, /** @scrutinizer ignore-type */ $this->site);
$selectorField->setFormElementName('tx_scheduler[indexingConfigurations]');
$selectorField->setSelectedValues($this->task->getIndexingConfigurationsToReIndex());
$selectorMarkup = $selectorField->render();
return $selectorMarkup;
}
/**
* Checks any additional data that is relevant to this task. If the task
* class is not relevant, the method is expected to return TRUE
*
* @param array $submittedData reference to the array containing the data submitted by the user
* @param SchedulerModuleController $schedulerModule reference to the calling object (Scheduler's BE module)
* @return bool True if validation was ok (or selected class is not relevant), FALSE otherwise
*/
public function validateAdditionalFields(
array &$submittedData,
SchedulerModuleController $schedulerModule
) {
$result = false;
// validate site
$sites = $this->siteRepository->getAvailableSites();
if (array_key_exists($submittedData['site'], $sites)) {
$result = true;
}
return $result;
}
/**
* Saves any additional input into the current task object if the task
* class matches.
*
* @param array $submittedData array containing the data submitted by the user
* @param AbstractTask $task reference to the current task object
*/
public function saveAdditionalFields(
array $submittedData,
AbstractTask $task
) {
/** @var $task ReIndexTask */
if (!$this->isTaskInstanceofReIndexTask($task)) {
return;
}
$task->setRootPageId($submittedData['site']);
$indexingConfigurations = [];
if (!empty($submittedData['indexingConfigurations'])) {
$indexingConfigurations = $submittedData['indexingConfigurations'];
}
$task->setIndexingConfigurationsToReIndex($indexingConfigurations);
}
/**
* @return PageRenderer
*/
protected function getPageRenderer()
{
if (!isset($this->pageRenderer)) {
$this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
}
return $this->pageRenderer;
}
/**
* Check that a task is an instance of ReIndexTask
*
* @param AbstractTask $task
* @return boolean
* @throws \LogicException
*/
protected function isTaskInstanceofReIndexTask($task)
{
if ((!is_null($task)) && (!($task instanceof ReIndexTask))) {
throw new \LogicException(
'$task must be an instance of ReIndexTask, '
. 'other instances are not supported.', 1487500366
);
}
return true;
}
}