IndexService::emitSignal() - Code Metrics - Inspection of "[TASK] add a Flag in Site Configuration to disable..." - timohund/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 30aafa...437b56 )

by Timo

created 2019-09-12 08:06 UTC

IndexService::emitSignal() A

↳ Parent: IndexService

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
ccs	0
cts	0
cp	0
cc	1
nc	1
nop	2
crap	2

<?php

namespace ApacheSolrForTypo3\Solr\Domain\Index;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2015-2016 Timo Hund <[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\ConnectionManager;
use ApacheSolrForTypo3\Solr\IndexQueue\Indexer;
use ApacheSolrForTypo3\Solr\IndexQueue\Item;
use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
use ApacheSolrForTypo3\Solr\Domain\Site\Site;
use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
use ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask;
use Solarium\Exception\HttpException;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;

/**
 * Service to perform indexing operations
 *
 * @author Timo Hund <[email protected]>
 */
class IndexService
{
    /**
     * @var TypoScriptConfiguration
     */
    protected $configuration;

    /**
     * @var Site
     */
    protected $site;

    /**
     * @var IndexQueueWorkerTask
     */
    protected $contextTask;

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

    /**
     * @var Dispatcher
     */
    protected $signalSlotDispatcher;

    /**
     * @var \ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager
     */
    protected $logger = null;

    /**
     * IndexService constructor.
     * @param Site $site
     * @param Queue|null $queue
     * @param Dispatcher|null $dispatcher
     * @param SolrLogManager|null $solrLogManager
     */
    public function __construct(Site $site, Queue $queue = null, Dispatcher $dispatcher = null, SolrLogManager $solrLogManager = null)
    {
        $this->site = $site;
        $this->indexQueue = $queue ?? GeneralUtility::makeInstance(Queue::class);
        $this->signalSlotDispatcher = $dispatcher ?? GeneralUtility::makeInstance(Dispatcher::class);
        $this->logger = $solrLogManager ?? GeneralUtility::makeInstance(SolrLogManager::class, /** @scrutinizer ignore-type */ __CLASS__);
        define('EXT_SOLR_INDEXING_CONTEXT', true);
    }

    /**
     * @param \ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask $contextTask
     */
    public function setContextTask($contextTask)
    {
        $this->contextTask = $contextTask;
    }

    /**
     * @return \ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask
     */
    public function getContextTask()
    {
        return $this->contextTask;
    }

    /**
     * Indexes items from the Index Queue.
     *
     * @param int $limit
     * @return bool
     */
    public function indexItems($limit)
    {
        $errors     = 0;
        $indexRunId = uniqid();
        $configurationToUse = $this->site->getSolrConfiguration();
        $enableCommitsSetting = $configurationToUse->getEnableCommits();

        // get items to index
        $itemsToIndex = $this->indexQueue->getItemsToIndex($this->site, $limit);

        $this->emitSignal('beforeIndexItems', [$itemsToIndex, $this->getContextTask(), $indexRunId]);

        foreach ($itemsToIndex as $itemToIndex) {
            try {
                // try indexing
                $this->emitSignal('beforeIndexItem', [$itemToIndex, $this->getContextTask(), $indexRunId]);
                $this->indexItem($itemToIndex, $configurationToUse);
                $this->emitSignal('afterIndexItem', [$itemToIndex, $this->getContextTask(), $indexRunId]);
            } catch (\Exception $e) {
                $errors++;
                $this->indexQueue->markItemAsFailed($itemToIndex, $e->getCode() . ': ' . $e->__toString());
                $this->generateIndexingErrorLog($itemToIndex, $e);
            }
        }

        $this->emitSignal('afterIndexItems', [$itemsToIndex, $this->getContextTask(), $indexRunId]);

        if ($enableCommitsSetting && count($itemsToIndex) > 0) {
            $solrServers = GeneralUtility::makeInstance(ConnectionManager::class)->getConnectionsBySite($this->site);
            foreach ($solrServers as $solrServer) {
                try {
                    $solrServer->getWriteService()->commit(false, false, false);
                } catch (HttpException $e) {
                    $errors++;
                }
            }
        }

        return ($errors === 0);
    }

    /**
     * Generates a message in the error log when an error occured.
     *
     * @param Item $itemToIndex
     * @param \Exception  $e
     */
    protected function generateIndexingErrorLog(Item $itemToIndex, \Exception $e)
    {
        $message = 'Failed indexing Index Queue item ' . $itemToIndex->getIndexQueueUid();
        $data = ['code' => $e->getCode(), 'message' => $e->getMessage(), 'trace' => $e->getTraceAsString(), 'item' => (array)$itemToIndex];

        $this->logger->log(
            SolrLogManager::ERROR,
            $message,
            $data
        );
    }

    /**
     * Builds an emits a singal for the IndexService.
     *
     * @param string $name
     * @param array $arguments
     * @return mixed
     */
    protected function emitSignal($name, $arguments)
    {
        return $this->signalSlotDispatcher->dispatch(__CLASS__, $name, $arguments);
    }

    /**
     * Indexes an item from the Index Queue.
     *
     * @param Item $item An index queue item to index
     * @param TypoScriptConfiguration $configuration
     * @return bool TRUE if the item was successfully indexed, FALSE otherwise
     */
    protected function indexItem(Item $item, TypoScriptConfiguration $configuration)
    {
        $indexer = $this->getIndexerByItem($item->getIndexingConfigurationName(), $configuration);

        // Remember original http host value
        $originalHttpHost = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : null;

        $itemChangedDate = $item->getChanged();
        $itemChangedDateAfterIndex = 0;

        try {
            $this->initializeHttpServerEnvironment($item);
            $itemIndexed = $indexer->index($item);

            // update IQ item so that the IQ can determine what's been indexed already
            if ($itemIndexed) {
                $this->indexQueue->updateIndexTimeByItem($item);
                $itemChangedDateAfterIndex = $item->getChanged();
            }

            if ($itemChangedDateAfterIndex > $itemChangedDate && $itemChangedDateAfterIndex > time()) {
                $this->indexQueue->setForcedChangeTimeByItem($item, $itemChangedDateAfterIndex);
            }
        } catch (\Exception $e) {
            $this->restoreOriginalHttpHost($originalHttpHost);
            throw $e;
        }

        $this->restoreOriginalHttpHost($originalHttpHost);

        return $itemIndexed;
    }

    /**
     * A factory method to get an indexer depending on an item's configuration.
     *
     * By default all items are indexed using the default indexer
     * (ApacheSolrForTypo3\Solr\IndexQueue\Indexer) coming with EXT:solr. Pages by default are
     * configured to be indexed through a dedicated indexer
     * (ApacheSolrForTypo3\Solr\IndexQueue\PageIndexer). In all other cases a dedicated indexer
     * can be specified through TypoScript if needed.
     *
     * @param string $indexingConfigurationName Indexing configuration name.
     * @param TypoScriptConfiguration $configuration
     * @return Indexer
     */
    protected function getIndexerByItem($indexingConfigurationName, TypoScriptConfiguration $configuration)
    {
        $indexerClass = $configuration->getIndexQueueIndexerByConfigurationName($indexingConfigurationName);
        $indexerConfiguration = $configuration->getIndexQueueIndexerConfigurationByConfigurationName($indexingConfigurationName);

        $indexer = GeneralUtility::makeInstance($indexerClass, /** @scrutinizer ignore-type */ $indexerConfiguration);
        if (!($indexer instanceof Indexer)) {
            throw new \RuntimeException(
                'The indexer class "' . $indexerClass . '" for indexing configuration "' . $indexingConfigurationName . '" is not a valid indexer. Must be a subclass of ApacheSolrForTypo3\Solr\IndexQueue\Indexer.',
                1260463206
            );
        }

        return $indexer;
    }

    /**
     * Gets the indexing progress.
     *
     * @return float Indexing progress as a two decimal precision float. f.e. 44.87
     */
    public function getProgress()
    {
        return $this->indexQueue->getStatisticsBySite($this->site)->getSuccessPercentage();
    }

    /**
     * Returns the amount of failed queue items for the current site.
     *
     * @return int
     */
    public function getFailCount()
    {
        return $this->indexQueue->getStatisticsBySite($this->site)->getFailedCount();
    }

    /**
     * Initializes the $_SERVER['HTTP_HOST'] environment variable in CLI
     * environments dependent on the Index Queue item's root page.
     *
     * When the Index Queue Worker task is executed by a cron job there is no
     * HTTP_HOST since we are in a CLI environment. RealURL needs the host
     * information to generate a proper URL though. Using the Index Queue item's
     * root page information we can determine the correct host although being
     * in a CLI environment.
     *
     * @param Item $item Index Queue item to use to determine the host.
     * @param
     */
    protected function initializeHttpServerEnvironment(Item $item)
    {
        static $hosts = [];
        $rootpageId = $item->getRootPageUid();
        $hostFound = !empty($hosts[$rootpageId]);

        if (!$hostFound) {
            $hosts[$rootpageId] = $item->getSite()->getDomain();
        }

        $_SERVER['HTTP_HOST'] = $hosts[$rootpageId];

        // needed since TYPO3 7.5
        GeneralUtility::flushInternalRuntimeCaches();
    }

    /**
     * @param string|null $originalHttpHost
     */
    protected function restoreOriginalHttpHost($originalHttpHost)
    {
        if (!is_null($originalHttpHost)) {
            $_SERVER['HTTP_HOST'] = $originalHttpHost;
        } else {
            unset($_SERVER['HTTP_HOST']);
        }

        // needed since TYPO3 7.5
        GeneralUtility::flushInternalRuntimeCaches();
    }
}


1		<?php
2
3		namespace ApacheSolrForTypo3\Solr\Domain\Index;
4
5		/***************************************************************
6		* Copyright notice
7		*
8		* (c) 2015-2016 Timo Hund <[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\ConnectionManager;
29		use ApacheSolrForTypo3\Solr\IndexQueue\Indexer;
30		use ApacheSolrForTypo3\Solr\IndexQueue\Item;
31		use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
32		use ApacheSolrForTypo3\Solr\Domain\Site\Site;
33		use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
34		use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
35		use ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask;
36		use Solarium\Exception\HttpException;
37		use TYPO3\CMS\Backend\Utility\BackendUtility;
38		use TYPO3\CMS\Core\Utility\GeneralUtility;
39		use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
40
41		/**
42		* Service to perform indexing operations
43		*
44		* @author Timo Hund <[email protected]>
45		*/
46		class IndexService
47		{
48		/**
49		* @var TypoScriptConfiguration
50		*/
51		protected $configuration;
52
53		/**
54		* @var Site
55		*/
56		protected $site;
57
58		/**
59		* @var IndexQueueWorkerTask
60		*/
61		protected $contextTask;
62
63		/**
64		* @var Queue
65		*/
66		protected $indexQueue;
67
68		/**
69		* @var Dispatcher
70		*/
71		protected $signalSlotDispatcher;
72
73		/**
74		* @var \ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager
75		*/
76		protected $logger = null;
77
78		/**
79		* IndexService constructor.
80		* @param Site $site
81		* @param Queue\|null $queue
82		* @param Dispatcher\|null $dispatcher
83		* @param SolrLogManager\|null $solrLogManager
84	7	*/
85		public function __construct(Site $site, Queue $queue = null, Dispatcher $dispatcher = null, SolrLogManager $solrLogManager = null)
86	7	{
87	7	$this->site = $site;
88	7	$this->indexQueue = $queue ?? GeneralUtility::makeInstance(Queue::class);
89	7	$this->signalSlotDispatcher = $dispatcher ?? GeneralUtility::makeInstance(Dispatcher::class);
90	7	$this->logger = $solrLogManager ?? GeneralUtility::makeInstance(SolrLogManager::class, /** @scrutinizer ignore-type */ __CLASS__);
91	7	define('EXT_SOLR_INDEXING_CONTEXT', true);
92		}
93
94		/**
95		* @param \ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask $contextTask
96	1	*/
97		public function setContextTask($contextTask)
98	1	{
99	1	$this->contextTask = $contextTask;
100		}
101
102		/**
103		* @return \ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask
104	5	*/
105		public function getContextTask()
106	5	{
107		return $this->contextTask;
108		}
109
110		/**
111		* Indexes items from the Index Queue.
112		*
113		* @param int $limit
114		* @return bool
115	5	*/
116		public function indexItems($limit)
117	5	{
118	5	$errors = 0;
119	5	$indexRunId = uniqid();
120	5	$configurationToUse = $this->site->getSolrConfiguration();
121		$enableCommitsSetting = $configurationToUse->getEnableCommits();
122
123	5	// get items to index
124		$itemsToIndex = $this->indexQueue->getItemsToIndex($this->site, $limit);
125	5
126		$this->emitSignal('beforeIndexItems', [$itemsToIndex, $this->getContextTask(), $indexRunId]);
127	5
128		foreach ($itemsToIndex as $itemToIndex) {
129		try {
130	5	// try indexing
131	5	$this->emitSignal('beforeIndexItem', [$itemToIndex, $this->getContextTask(), $indexRunId]);
132	5	$this->indexItem($itemToIndex, $configurationToUse);
133		$this->emitSignal('afterIndexItem', [$itemToIndex, $this->getContextTask(), $indexRunId]);
134		} catch (\Exception $e) {
135		$errors++;
136	5	$this->indexQueue->markItemAsFailed($itemToIndex, $e->getCode() . ': ' . $e->__toString());
137		$this->generateIndexingErrorLog($itemToIndex, $e);
138		}
139		}
140	5
141		$this->emitSignal('afterIndexItems', [$itemsToIndex, $this->getContextTask(), $indexRunId]);
142	5
143	4	if ($enableCommitsSetting && count($itemsToIndex) > 0) {
144	4	$solrServers = GeneralUtility::makeInstance(ConnectionManager::class)->getConnectionsBySite($this->site);
145	4	foreach ($solrServers as $solrServer) {
146		try {
147		$solrServer->getWriteService()->commit(false, false, false);
148		} catch (HttpException $e) {
149	5	$errors++;
150		}
151		}
152		}
153
154		return ($errors === 0);
155		}
156
157		/**
158		* Generates a message in the error log when an error occured.
159		*
160		* @param Item $itemToIndex
161		* @param \Exception $e
162		*/
163		protected function generateIndexingErrorLog(Item $itemToIndex, \Exception $e)
164		{
165		$message = 'Failed indexing Index Queue item ' . $itemToIndex->getIndexQueueUid();
166		$data = ['code' => $e->getCode(), 'message' => $e->getMessage(), 'trace' => $e->getTraceAsString(), 'item' => (array)$itemToIndex];
167
168		$this->logger->log(
169		SolrLogManager::ERROR,
170		$message,
171		$data
172		);
173		}
174
175		/**
176		* Builds an emits a singal for the IndexService.
177	5	*
178		* @param string $name
179	5	* @param array $arguments
180		* @return mixed
181		*/
182		protected function emitSignal($name, $arguments)
183		{
184		return $this->signalSlotDispatcher->dispatch(__CLASS__, $name, $arguments);
185		}
186
187		/**
188		* Indexes an item from the Index Queue.
189	4	*
190		* @param Item $item An index queue item to index
191	4	* @param TypoScriptConfiguration $configuration
192		* @return bool TRUE if the item was successfully indexed, FALSE otherwise
193		*/
194	4	protected function indexItem(Item $item, TypoScriptConfiguration $configuration)
195		{
196	4	$indexer = $this->getIndexerByItem($item->getIndexingConfigurationName(), $configuration);
197	4
198		// Remember original http host value
199	4	$originalHttpHost = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : null;
200	4
201		$itemChangedDate = $item->getChanged();
202		$itemChangedDateAfterIndex = 0;
203	4
204	4	try {
205	4	$this->initializeHttpServerEnvironment($item);
206		$itemIndexed = $indexer->index($item);
207
208	4	// update IQ item so that the IQ can determine what's been indexed already
209		if ($itemIndexed) {
210		$this->indexQueue->updateIndexTimeByItem($item);
211		$itemChangedDateAfterIndex = $item->getChanged();
212	4	}
213
214		if ($itemChangedDateAfterIndex > $itemChangedDate && $itemChangedDateAfterIndex > time()) {
215	4	$this->indexQueue->setForcedChangeTimeByItem($item, $itemChangedDateAfterIndex);
216		}
217		} catch (\Exception $e) {
218		$this->restoreOriginalHttpHost($originalHttpHost);
219	4	throw $e;
220		}
221	4
222		$this->restoreOriginalHttpHost($originalHttpHost);
223
224		return $itemIndexed;
225		}
226
227		/**
228		* A factory method to get an indexer depending on an item's configuration.
229		*
230		* By default all items are indexed using the default indexer
231		* (ApacheSolrForTypo3\Solr\IndexQueue\Indexer) coming with EXT:solr. Pages by default are
232		* configured to be indexed through a dedicated indexer
233		* (ApacheSolrForTypo3\Solr\IndexQueue\PageIndexer). In all other cases a dedicated indexer
234		* can be specified through TypoScript if needed.
235		*
236		* @param string $indexingConfigurationName Indexing configuration name.
237	4	* @param TypoScriptConfiguration $configuration
238		* @return Indexer
239	4	*/
240	4	protected function getIndexerByItem($indexingConfigurationName, TypoScriptConfiguration $configuration)
241		{
242	4	$indexerClass = $configuration->getIndexQueueIndexerByConfigurationName($indexingConfigurationName);
243	4	$indexerConfiguration = $configuration->getIndexQueueIndexerConfigurationByConfigurationName($indexingConfigurationName);
244
245		$indexer = GeneralUtility::makeInstance($indexerClass, /** @scrutinizer ignore-type */ $indexerConfiguration);
246		if (!($indexer instanceof Indexer)) {
247		throw new \RuntimeException(
248		'The indexer class "' . $indexerClass . '" for indexing configuration "' . $indexingConfigurationName . '" is not a valid indexer. Must be a subclass of ApacheSolrForTypo3\Solr\IndexQueue\Indexer.',
249		1260463206
250	4	);
251		}
252
253		return $indexer;
254		}
255
256		/**
257		* Gets the indexing progress.
258	1	*
259		* @return float Indexing progress as a two decimal precision float. f.e. 44.87
260	1	*/
261		public function getProgress()
262		{
263		return $this->indexQueue->getStatisticsBySite($this->site)->getSuccessPercentage();
264		}
265
266		/**
267		* Returns the amount of failed queue items for the current site.
268	1	*
269		* @return int
270	1	*/
271		public function getFailCount()
272		{
273		return $this->indexQueue->getStatisticsBySite($this->site)->getFailedCount();
274		}
275
276		/**
277		* Initializes the $_SERVER['HTTP_HOST'] environment variable in CLI
278		* environments dependent on the Index Queue item's root page.
279		*
280		* When the Index Queue Worker task is executed by a cron job there is no
281		* HTTP_HOST since we are in a CLI environment. RealURL needs the host
282		* information to generate a proper URL though. Using the Index Queue item's
283		* root page information we can determine the correct host although being
284		* in a CLI environment.
285		*
286	4	* @param Item $item Index Queue item to use to determine the host.
287		* @param
288	4	*/
289	4	protected function initializeHttpServerEnvironment(Item $item)
290	4	{
291		static $hosts = [];
292	4	$rootpageId = $item->getRootPageUid();
293	4	$hostFound = !empty($hosts[$rootpageId]);
294	4
295	4	if (!$hostFound) {
296		$hosts[$rootpageId] = $item->getSite()->getDomain();
297		}
298	4
299		$_SERVER['HTTP_HOST'] = $hosts[$rootpageId];
300
301	4	// needed since TYPO3 7.5
302	4	GeneralUtility::flushInternalRuntimeCaches();
303		}
304
305		/**
306		* @param string\|null $originalHttpHost
307		*/
308		protected function restoreOriginalHttpHost($originalHttpHost)
309		{
310		if (!is_null($originalHttpHost)) {
311		$_SERVER['HTTP_HOST'] = $originalHttpHost;
312		} else {
313		unset($_SERVER['HTTP_HOST']);
314		}
315
316		// needed since TYPO3 7.5
317		GeneralUtility::flushInternalRuntimeCaches();
318		}
319		}
320

timohund / ext-solr

Push — master ( 30aafa...437b56 )

IndexService::emitSignal() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like