OptimizeIndexTaskAdditionalFieldProvider::validateAdditionalFields() - Code Metrics - Inspection of "[FEATURE] Add scheduler task to optimize solr core..." - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#2666)

by Rafael
created 2021-06-25 13:01 UTC
validateAdditionalFields() A

↳ Parent: OptimizeIndexTaskAdditionalFieldProvider
Complexity

Conditions	4
Paths	4
Size

Total Lines	23
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	20
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	11
c	1
b	0
f	0
dl	0
loc	23
ccs	0
cts	20
cp	0
rs	9.9
cc	4
nc	4
nop	2
crap	20
<?php

namespace ApacheSolrForTypo3\Solr\Task;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use ApacheSolrForTypo3\Solr\Backend\CoreSelectorField;
use ApacheSolrForTypo3\Solr\Backend\SiteSelectorField;
use ApacheSolrForTypo3\Solr\Domain\Site\Site;
use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
use ApacheSolrForTypo3\Solr\NoSolrConnectionFoundException;
use Exception;
use LogicException;
use TYPO3\CMS\Backend\Form\Exception as BackendFormException;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Page\PageRenderer;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider;
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
use TYPO3\CMS\Scheduler\Task\AbstractTask;
use TYPO3\CMS\Scheduler\Task\Enumeration\Action;

/**
 * Adds an additional field to specify the Solr server to initialize the index queue for
 *
 * @author Jens Jacobsen <[email protected]>
 */
class OptimizeIndexTaskAdditionalFieldProvider extends AbstractAdditionalFieldProvider
{
    /**
     * Default language file of the extension link validator
     *
     * @var string
     */
    protected $languageFile = 'LLL:EXT:solr/Resources/Private/Language/locallang.xlf';

    /**
     * Task information
     *
     * @var array
     */
    protected $taskInformation;

    /**
     * Scheduler task
     *
     * @var AbstractTask|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);
    }

    /**
     * Initializes this instance and the necessary objects.
     *
     * @param SchedulerModuleController $schedulerModule
     * @param AbstractTask|null $task
     * @param array $taskInfo
     */
    protected function initialize(
        SchedulerModuleController $schedulerModule,
        AbstractTask $task = null,
        array $taskInfo = []
    )
    {
        /** @var $task ReIndexTask */
        $this->task = $task;
        $this->schedulerModule = $schedulerModule;
        $this->taskInformation = $taskInfo;

        $currentAction = $schedulerModule->getCurrentAction();

        if ($currentAction->equals(Action::EDIT)) {
            $this->site = $this->siteRepository->getSiteByRootPageId($task->getRootPageId());
        }
    }

    /**
     * Used to define fields to provide the Solr server address when adding
     * 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:
     * @throws BackendFormException
     * @throws NoSolrConnectionFoundException
     * @noinspection PhpParameterByRefIsNotUsedAsReferenceInspection
     * @noinspection PhpMissingReturnTypeInspection
     */
    public function getAdditionalFields(
        array &$taskInfo,
        $task,
        SchedulerModuleController $schedulerModule
    )
    {
        $additionalFields = [];

        if (!$this->isTaskInstanceofOptimizeIndexTask($task)) {
            return $additionalFields;
        }

        $this->initialize($schedulerModule, $task, $taskInfo);
        $siteSelectorField = GeneralUtility::makeInstance(SiteSelectorField::class);

        $additionalFields['site'] = [
            'code' => $siteSelectorField->getAvailableSitesSelector('tx_scheduler[site]', $this->site),
            'label' => $this->languageFile . ':field_site',
            'cshKey' => '',
            'cshLabel' => ''
        ];

        $additionalFields['cores'] = [
            'code' => $this->getCoreSelectorMarkup(),
            'label' => $this->languageFile . ':field_cores',
            'cshKey' => '',
            'cshLabel' => ''
        ];

        return $additionalFields;
    }

    /**
     * Returns the selector HTML element with available cores.
     *
     * @throws BackendFormException
     * @throws NoSolrConnectionFoundException
     */
    protected function getCoreSelectorMarkup(): string
    {
        $selectorMarkup = $this->getLanguageService()->sL($this->languageFile . ':tasks.validate.selectSiteFirst');

        if (is_null($this->site)) {
            return $selectorMarkup;
        }

        /* @var CoreSelectorField $selectorField */
        $selectorField = GeneralUtility::makeInstance(CoreSelectorField::class, /** @scrutinizer ignore-type */ $this->site);
        $selectorField->setFormElementName('tx_scheduler[cores]');
        /* @noinspection PhpPossiblePolymorphicInvocationInspection */
        $selectorField->setSelectedValues($this->task->getCoresToOptimizeIndex());
        $selectorField->setSelectedValues($this->task->/** @scrutinizer ignore-call */ getCoresToOptimizeIndex());
        return $selectorField->render();
    }

    /**
     * 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
     * @throws Exception
     * @noinspection PhpParameterByRefIsNotUsedAsReferenceInspection
     * @noinspection PhpMissingReturnTypeInspection
     */
    public function validateAdditionalFields(
        array &$submittedData,
        SchedulerModuleController $schedulerModule
    )
    {
        $result = true;
        // validate site
        $sites = $this->siteRepository->getAvailableSites();
        if (!array_key_exists($submittedData['site'], $sites)) {
            $result = false;
        }

        // validate core selection
        if (array_key_exists('cores', $submittedData)
            && !is_array($submittedData['cores'])
        ) {
            $this->addMessage(
                $this->getLanguageService()->sL($this->languageFile . ':tasks.validate.invalidCores'),
                FlashMessage::ERROR
            );
            $result = false;
        }
        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 OptimizeIndexTask */
        if (!$this->isTaskInstanceofOptimizeIndexTask($task)) {
            return;
        }

        $task->setRootPageId($submittedData['site']);
               setRootPageId($submittedData['site']);

        $cores = [];
        if (!empty($submittedData['cores'])) {
            $cores = $submittedData['cores'];
        }
        $task->setCoresToOptimizeIndex($cores);
    }

    /**
     * @return PageRenderer
     */
    protected function getPageRenderer(): ?PageRenderer
    {
        if (!isset($this->pageRenderer)) {
            $this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
        }
        return $this->pageRenderer;
    }

    /**
     * Check that a task is an instance of ReIndexTask
     *
     * @param AbstractTask|null $task
     * @return boolean
     */
    protected function isTaskInstanceofOptimizeIndexTask(?AbstractTask $task): bool
    {
        if ((!is_null($task)) && (!($task instanceof OptimizeIndexTask))) {
            throw new LogicException(
                '$task must be an instance of OptimizeIndexTask, '
                .'other instances are not supported.', 1624620844
            );
        }
        return true;
    }

    /**
     * @return LanguageService
     */
    protected function getLanguageService(): LanguageService
    {
        return $GLOBALS['LANG'];
    }
}

TYPO3-Solr / ext-solr

Pull Request — master (#2666)

validateAdditionalFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
