IndexQueueModuleController::initializeIndexQueueAction() - Code Metrics - Inspection of "[TASK:BP:11.2] Disable sql handler" - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — release-11.2.x (#3604)

by Markus

created 2023-04-14 12:51 UTC

initializeIndexQueueAction() A

↳ Parent: IndexQueueModuleController

Complexity

Conditions	5
Paths	8

Size

Total Lines	34
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes

Metric	Value
eloc	23
c	0
b	0
f	0
dl	0
loc	34
ccs	0
cts	23
cp	0
rs	9.2408
cc	5
nc	8
nop	0
crap	30

<?php

namespace ApacheSolrForTypo3\Solr\Controller\Backend\Search;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2013-2015 Ingo Renner <[email protected]>
 *  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 ApacheSolrForTypo3\Solr\Backend\IndexingConfigurationSelectorField;
use ApacheSolrForTypo3\Solr\Domain\Index\IndexService;
use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
use TYPO3\CMS\Backend\View\BackendTemplateView;
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;

/**
 * Index Queue Module
 *
 * @author Ingo Renner <[email protected]>
 * @property BackendTemplateView $view
 */
class IndexQueueModuleController extends AbstractModuleController
filter:
    dependency_paths: ["lib/*"]
{

    /**
     * Module name, used to identify a module f.e. in URL parameters.
     *
     * @var string
     */
    protected $moduleName = 'IndexQueue';

    /**
     * Module title, shows up in the module menu.
     *
     * @var string
     */
    protected $moduleTitle = 'Index Queue';

    /**
     * @var Queue
     */
    protected $indexQueue;

    /**
     * Initializes the controller before invoking an action method.
     */
    protected function initializeAction()
    {
        parent::initializeAction();
        $this->indexQueue = GeneralUtility::makeInstance(Queue::class);
    }

    /**
     * @param Queue $indexQueue
     */
    public function setIndexQueue(Queue $indexQueue)
    {
        $this->indexQueue = $indexQueue;
    }

    /**
     * Set up the doc header properly here
     *
     * @param ViewInterface $view
     */
    protected function initializeView(ViewInterface $view)
    {
        parent::initializeView($view);
    }

    /**
     * Lists the available indexing configurations
     */
    public function indexAction()
    {
        if (!$this->canQueueSelectedSite()) {
            $this->view->assign('can_not_proceed', true);
            return;
        }

        $statistics = $this->indexQueue->getStatisticsBySite($this->selectedSite);
        $this->view->assign('indexQueueInitializationSelector', $this->getIndexQueueInitializationSelector());
        $this->view->assign('indexqueue_statistics', $statistics);
        $this->view->assign('indexqueue_errors', $this->indexQueue->getErrorsBySite($this->selectedSite));
    }

    /**
     * Checks if selected site can be queued.
     *
     * @return bool
     */
    protected function canQueueSelectedSite()
    {
        if ($this->selectedSite === null || empty($this->solrConnectionManager->getConnectionsBySite($this->selectedSite))) {
            return false;
        }
        $enabledIndexQueueConfigurationNames = $this->selectedSite->getSolrConfiguration()->getEnabledIndexQueueConfigurationNames();
        if (empty($enabledIndexQueueConfigurationNames)) {
            return false;
        }
        return true;
    }

    /**
     * Renders a field to select which indexing configurations to initialize.
     *
     * Uses TCEforms.
     *
     * @return string Markup for the select field
     */
    protected function getIndexQueueInitializationSelector()
    {
        $selector = GeneralUtility::makeInstance(IndexingConfigurationSelectorField::class, /** @scrutinizer ignore-type */ $this->selectedSite);
        $selector->setFormElementName('tx_solr-index-queue-initialization');

        return $selector->render();
    }

    /**
     * Initializes the Index Queue for selected indexing configurations
     */
    public function initializeIndexQueueAction()
    {
        $initializedIndexingConfigurations = [];

        $indexingConfigurationsToInitialize = GeneralUtility::_POST('tx_solr-index-queue-initialization');
        if ((!empty($indexingConfigurationsToInitialize)) && (is_array($indexingConfigurationsToInitialize))) {

            // initialize selected indexing configuration
            $initializedIndexingConfigurations = $this->indexQueue->getInitializationService()->initializeBySiteAndIndexConfigurations($this->selectedSite, $indexingConfigurationsToInitialize);
        } else {
            $messageLabel = 'solr.backend.index_queue_module.flashmessage.initialize.no_selection';
            $titleLabel = 'solr.backend.index_queue_module.flashmessage.not_initialized.title';
            $this->addFlashMessage(
                LocalizationUtility::translate($messageLabel, 'Solr'),
                LocalizationUtility::translate($titleLabel, 'Solr'),
                FlashMessage::WARNING
            );
        }
        $messagesForConfigurations = [];
        foreach (array_keys($initializedIndexingConfigurations) as $indexingConfigurationName) {
            $itemCount = $this->indexQueue->getStatisticsBySite($this->selectedSite, $indexingConfigurationName)->getTotalCount();
            $messagesForConfigurations[] = $indexingConfigurationName . ' (' . $itemCount . ' records)';
        }

        if (!empty($initializedIndexingConfigurations)) {
            $messageLabel = 'solr.backend.index_queue_module.flashmessage.initialize.success';
            $titleLabel = 'solr.backend.index_queue_module.flashmessage.initialize.title';
            $this->addFlashMessage(
                LocalizationUtility::translate($messageLabel, 'Solr', [implode(', ', $messagesForConfigurations)]),
                LocalizationUtility::translate($titleLabel, 'Solr'),
                FlashMessage::OK
            );
        }

        $this->redirect('index');
    }

    /**
     * Removes all errors in the index queue list. So that the items can be indexed again.
     */
    public function resetLogErrorsAction()
    {
        $resetResult = $this->indexQueue->resetAllErrors();

        $label = 'solr.backend.index_queue_module.flashmessage.success.reset_errors';
        $severity = FlashMessage::OK;
        if (!$resetResult) {
            $label = 'solr.backend.index_queue_module.flashmessage.error.reset_errors';
            $severity = FlashMessage::ERROR;
        }

        $this->addIndexQueueFlashMessage($label, $severity);

        $this->redirect('index');
    }

    /**
     * ReQueues a single item in the indexQueue.
     *
     * @param string $type
     * @param int $uid
     */
    public function requeueDocumentAction(string $type, int $uid)
    {
        $label = 'solr.backend.index_queue_module.flashmessage.error.single_item_not_requeued';
        $severity = FlashMessage::ERROR;

        $updateCount = $this->indexQueue->updateItem($type, $uid, time());
        if ($updateCount > 0) {
            $label = 'solr.backend.index_queue_module.flashmessage.success.single_item_was_requeued';
            $severity = FlashMessage::OK;
        }

        $this->addIndexQueueFlashMessage($label, $severity);

        $this->redirect('index');
    }

    /**
     * Shows the error message for one queue item.
     *
     * @param int $indexQueueItemId
     */
    public function showErrorAction(int $indexQueueItemId)
    {
        if (is_null($indexQueueItemId)) {

            // add a flash message and quit
            $label = 'solr.backend.index_queue_module.flashmessage.error.no_queue_item_for_queue_error';
            $severity = FlashMessage::ERROR;
            $this->addIndexQueueFlashMessage($label, $severity);

            return;
        }

        $item = $this->indexQueue->getItem($indexQueueItemId);
        $this->view->assign('indexQueueItem', $item);
    }

    /**
     * Indexes a few documents with the index service.
     * @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
     * @throws \TYPO3\CMS\Extbase\Mvc\Exception\UnsupportedRequestTypeException
     */
    public function doIndexingRunAction()
    {
        /** @var $indexService \ApacheSolrForTypo3\Solr\Domain\Index\IndexService */
        $indexService = GeneralUtility::makeInstance(IndexService::class, /** @scrutinizer ignore-type */ $this->selectedSite);
        $indexWithoutErrors = $indexService->indexItems(10);

        $label = 'solr.backend.index_queue_module.flashmessage.success.index_manual';
        $severity = FlashMessage::OK;
        if (!$indexWithoutErrors) {
            $label = 'solr.backend.index_queue_module.flashmessage.error.index_manual';
            $severity = FlashMessage::ERROR;
        }

        $this->addFlashMessage(
            LocalizationUtility::translate($label, 'Solr'),
            LocalizationUtility::translate('solr.backend.index_queue_module.flashmessage.index_manual', 'Solr'),
            $severity
        );

        $this->redirect('index');
    }

    /**
     * Adds a flash message for the index queue module.
     *
     * @param string $label
     * @param int $severity
     */
    protected function addIndexQueueFlashMessage($label, $severity)
    {
        $this->addFlashMessage(LocalizationUtility::translate($label, 'Solr'), LocalizationUtility::translate('solr.backend.index_queue_module.flashmessage.title', 'Solr'), $severity);
    }
}


1		<?php
2
3		namespace ApacheSolrForTypo3\Solr\Controller\Backend\Search;
4
5		/***************************************************************
6		* Copyright notice
7		*
8		* (c) 2013-2015 Ingo Renner <[email protected]>
9		* All rights reserved
10		*
11		* This script is part of the TYPO3 project. The TYPO3 project is
12		* free software; you can redistribute it and/or modify
13		* it under the terms of the GNU General Public License as published by
14		* the Free Software Foundation; either version 3 of the License, or
15		* (at your option) any later version.
16		*
17		* The GNU General Public License can be found at
18		* http://www.gnu.org/copyleft/gpl.html.
19		*
20		* This script is distributed in the hope that it will be useful,
21		* but WITHOUT ANY WARRANTY; without even the implied warranty of
22		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23		* GNU General Public License for more details.
24		*
25		* This copyright notice MUST APPEAR in all copies of the script!
26		***************************************************************/
27
28		use ApacheSolrForTypo3\Solr\Backend\IndexingConfigurationSelectorField;
29		use ApacheSolrForTypo3\Solr\Domain\Index\IndexService;
30		use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
31		use TYPO3\CMS\Backend\View\BackendTemplateView;
32		use TYPO3\CMS\Core\Messaging\FlashMessage;
33		use TYPO3\CMS\Core\Utility\GeneralUtility;
34		use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
35		use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
36
37		/**
38		* Index Queue Module
39		*
40		* @author Ingo Renner <[email protected]>
41		* @property BackendTemplateView $view
42		*/
43		class IndexQueueModuleController extends AbstractModuleController
		0 ignored issues – show Bug introduced 2018-02-07 08:29 UTC by Report Bug Copy Issue Report The type `ApacheSolrForTypo3\Solr\...bstractModuleController` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
44		{
45
46		/**
47		* Module name, used to identify a module f.e. in URL parameters.
48		*
49		* @var string
50		*/
51		protected $moduleName = 'IndexQueue';
52
53		/**
54		* Module title, shows up in the module menu.
55		*
56		* @var string
57		*/
58		protected $moduleTitle = 'Index Queue';
59
60		/**
61		* @var Queue
62		*/
63		protected $indexQueue;
64
65		/**
66		* Initializes the controller before invoking an action method.
67		*/
68		protected function initializeAction()
69		{
70		parent::initializeAction();
71		$this->indexQueue = GeneralUtility::makeInstance(Queue::class);
72		}
73
74		/**
75		* @param Queue $indexQueue
76		*/
77	2	public function setIndexQueue(Queue $indexQueue)
78		{
79	2	$this->indexQueue = $indexQueue;
80	2	}
81
82		/**
83		* Set up the doc header properly here
84		*
85		* @param ViewInterface $view
86		*/
87		protected function initializeView(ViewInterface $view)
88		{
89		parent::initializeView($view);
90		}
91
92		/**
93		* Lists the available indexing configurations
94		*/
95		public function indexAction()
96		{
97		if (!$this->canQueueSelectedSite()) {
98		$this->view->assign('can_not_proceed', true);
99		return;
100		}
101
102		$statistics = $this->indexQueue->getStatisticsBySite($this->selectedSite);
103		$this->view->assign('indexQueueInitializationSelector', $this->getIndexQueueInitializationSelector());
104		$this->view->assign('indexqueue_statistics', $statistics);
105		$this->view->assign('indexqueue_errors', $this->indexQueue->getErrorsBySite($this->selectedSite));
106		}
107
108		/**
109		* Checks if selected site can be queued.
110		*
111		* @return bool
112		*/
113		protected function canQueueSelectedSite()
114		{
115		if ($this->selectedSite === null \|\| empty($this->solrConnectionManager->getConnectionsBySite($this->selectedSite))) {
116		return false;
117		}
118		$enabledIndexQueueConfigurationNames = $this->selectedSite->getSolrConfiguration()->getEnabledIndexQueueConfigurationNames();
119		if (empty($enabledIndexQueueConfigurationNames)) {
120		return false;
121		}
122		return true;
123		}
124
125		/**
126		* Renders a field to select which indexing configurations to initialize.
127		*
128		* Uses TCEforms.
129		*
130		* @return string Markup for the select field
131		*/
132		protected function getIndexQueueInitializationSelector()
133		{
134		$selector = GeneralUtility::makeInstance(IndexingConfigurationSelectorField::class, /** @scrutinizer ignore-type */ $this->selectedSite);
135		$selector->setFormElementName('tx_solr-index-queue-initialization');
136
137		return $selector->render();
138		}
139
140		/**
141		* Initializes the Index Queue for selected indexing configurations
142		*/
143		public function initializeIndexQueueAction()
144		{
145		$initializedIndexingConfigurations = [];
146
147		$indexingConfigurationsToInitialize = GeneralUtility::_POST('tx_solr-index-queue-initialization');
148		if ((!empty($indexingConfigurationsToInitialize)) && (is_array($indexingConfigurationsToInitialize))) {
		0 ignored issues – show introduced 2018-10-26 16:55 UTC by Report Bug Copy Issue Report The condition `is_array($indexingConfigurationsToInitialize)` is always `false`. Loading history...
149		// initialize selected indexing configuration
150		$initializedIndexingConfigurations = $this->indexQueue->getInitializationService()->initializeBySiteAndIndexConfigurations($this->selectedSite, $indexingConfigurationsToInitialize);
151		} else {
152		$messageLabel = 'solr.backend.index_queue_module.flashmessage.initialize.no_selection';
153		$titleLabel = 'solr.backend.index_queue_module.flashmessage.not_initialized.title';
154		$this->addFlashMessage(
155		LocalizationUtility::translate($messageLabel, 'Solr'),
156		LocalizationUtility::translate($titleLabel, 'Solr'),
157		FlashMessage::WARNING
158		);
159		}
160		$messagesForConfigurations = [];
161		foreach (array_keys($initializedIndexingConfigurations) as $indexingConfigurationName) {
162		$itemCount = $this->indexQueue->getStatisticsBySite($this->selectedSite, $indexingConfigurationName)->getTotalCount();
163		$messagesForConfigurations[] = $indexingConfigurationName . ' (' . $itemCount . ' records)';
164		}
165
166		if (!empty($initializedIndexingConfigurations)) {
167		$messageLabel = 'solr.backend.index_queue_module.flashmessage.initialize.success';
168		$titleLabel = 'solr.backend.index_queue_module.flashmessage.initialize.title';
169		$this->addFlashMessage(
170		LocalizationUtility::translate($messageLabel, 'Solr', [implode(', ', $messagesForConfigurations)]),
171		LocalizationUtility::translate($titleLabel, 'Solr'),
172		FlashMessage::OK
173		);
174		}
175
176		$this->redirect('index');
177		}
178
179		/**
180		* Removes all errors in the index queue list. So that the items can be indexed again.
181		*/
182		public function resetLogErrorsAction()
183		{
184		$resetResult = $this->indexQueue->resetAllErrors();
185
186		$label = 'solr.backend.index_queue_module.flashmessage.success.reset_errors';
187		$severity = FlashMessage::OK;
188		if (!$resetResult) {
189		$label = 'solr.backend.index_queue_module.flashmessage.error.reset_errors';
190		$severity = FlashMessage::ERROR;
191		}
192
193		$this->addIndexQueueFlashMessage($label, $severity);
194
195		$this->redirect('index');
196		}
197
198		/**
199		* ReQueues a single item in the indexQueue.
200		*
201		* @param string $type
202		* @param int $uid
203		*/
204	2	public function requeueDocumentAction(string $type, int $uid)
205		{
206	2	$label = 'solr.backend.index_queue_module.flashmessage.error.single_item_not_requeued';
207	2	$severity = FlashMessage::ERROR;
208
209	2	$updateCount = $this->indexQueue->updateItem($type, $uid, time());
210	2	if ($updateCount > 0) {
211	1	$label = 'solr.backend.index_queue_module.flashmessage.success.single_item_was_requeued';
212	1	$severity = FlashMessage::OK;
213		}
214
215	2	$this->addIndexQueueFlashMessage($label, $severity);
216
217	2	$this->redirect('index');
218	2	}
219
220		/**
221		* Shows the error message for one queue item.
222		*
223		* @param int $indexQueueItemId
224		*/
225		public function showErrorAction(int $indexQueueItemId)
226		{
227		if (is_null($indexQueueItemId)) {
		0 ignored issues – show introduced 2018-10-26 16:55 UTC by Report Bug Copy Issue Report The condition `is_null($indexQueueItemId)` is always `false`. Loading history...
228		// add a flash message and quit
229		$label = 'solr.backend.index_queue_module.flashmessage.error.no_queue_item_for_queue_error';
230		$severity = FlashMessage::ERROR;
231		$this->addIndexQueueFlashMessage($label, $severity);
232
233		return;
234		}
235
236		$item = $this->indexQueue->getItem($indexQueueItemId);
237		$this->view->assign('indexQueueItem', $item);
238		}
239
240		/**
241		* Indexes a few documents with the index service.
242		* @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
243		* @throws \TYPO3\CMS\Extbase\Mvc\Exception\UnsupportedRequestTypeException
244		*/
245		public function doIndexingRunAction()
246		{
247		/** @var $indexService \ApacheSolrForTypo3\Solr\Domain\Index\IndexService */
248		$indexService = GeneralUtility::makeInstance(IndexService::class, /** @scrutinizer ignore-type */ $this->selectedSite);
249		$indexWithoutErrors = $indexService->indexItems(10);
250
251		$label = 'solr.backend.index_queue_module.flashmessage.success.index_manual';
252		$severity = FlashMessage::OK;
253		if (!$indexWithoutErrors) {
254		$label = 'solr.backend.index_queue_module.flashmessage.error.index_manual';
255		$severity = FlashMessage::ERROR;
256		}
257
258		$this->addFlashMessage(
259		LocalizationUtility::translate($label, 'Solr'),
260		LocalizationUtility::translate('solr.backend.index_queue_module.flashmessage.index_manual', 'Solr'),
261		$severity
262		);
263
264		$this->redirect('index');
265		}
266
267		/**
268		* Adds a flash message for the index queue module.
269		*
270		* @param string $label
271		* @param int $severity
272		*/
273		protected function addIndexQueueFlashMessage($label, $severity)
274		{
275		$this->addFlashMessage(LocalizationUtility::translate($label, 'Solr'), LocalizationUtility::translate('solr.backend.index_queue_module.flashmessage.title', 'Solr'), $severity);
276		}
277		}
278

TYPO3-Solr / ext-solr

Pull Request — release-11.2.x (#3604)

initializeIndexQueueAction() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like