AOE\Crawler\QueueExecutor

Complexity

Total Complexity

8

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

41.94%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	3
A	executeQueueItem()	0	33	4
A	generateCrawlerIdFromQueueItem()	0	4	1

<?php
declare(strict_types=1);
namespace AOE\Crawler;

/*
 * This file is part of the TYPO3 Crawler Extension.
 *
 * 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 AOE\Crawler\CrawlStrategy\CallbackExecutionStrategy;
use AOE\Crawler\CrawlStrategy\GuzzleExecutionStrategy;
use AOE\Crawler\CrawlStrategy\SubProcessExecutionStrategy;
use AOE\Crawler\Configuration\ExtensionConfigurationProvider;
use AOE\Crawler\Controller\CrawlerController;
use AOE\Crawler\Event\EventDispatcher;
use TYPO3\CMS\Core\Http\Uri;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Fetches a URL based on the selected strategy or via a callback.
 */
class QueueExecutor implements SingletonInterface
{
    /**
     * @var GuzzleExecutionStrategy|SubProcessExecutionStrategy
     */
    protected $selectedStrategy;

    /**
     * @var array
     */
    protected $extensionSettings;

    public function __construct(ExtensionConfigurationProvider $configurationProvider = null)
    {
        $configurationProvider = $configurationProvider ?? GeneralUtility::makeInstance(ExtensionConfigurationProvider::class);
        $settings = $configurationProvider->getExtensionConfiguration();
        $this->extensionSettings = is_array($settings) ? $settings : [];
        if ($this->extensionSettings['makeDirectRequests']) {
            $this->selectedStrategy = GeneralUtility::makeInstance(SubProcessExecutionStrategy::class);
        } else {
            $this->selectedStrategy = GeneralUtility::makeInstance(GuzzleExecutionStrategy::class);
        }
    }

    /**
     * Takes a queue record and fetches the contents of the URL.
     * In the future, updating the queue item & additional signal/slot/events should also happen in here.
     *
     * @param array $queueItem
     * @param CrawlerController $crawlerController
     * @return array|bool|mixed|string
     */
    public function executeQueueItem(array $queueItem, CrawlerController $crawlerController)
    {
        // Decode parameters:
        $parameters = unserialize($queueItem['parameters'] ?? '');
        $result = 'ERROR';

$result is not used, you could remove the assignment.

        if (!is_array($parameters)) {
            return 'ERROR';
        }
        if ($parameters['_CALLBACKOBJ']) {
            $className = $parameters['_CALLBACKOBJ'];
            unset($parameters['_CALLBACKOBJ']);
            $result = GeneralUtility::makeInstance(CallbackExecutionStrategy::class)
                ->fetchByCallback($className, $parameters, $crawlerController);
            $result = ['content' => serialize($result)];
        } else {
            // Regular FE request
            $crawlerId = $this->generateCrawlerIdFromQueueItem($queueItem);

            // Get result:
            $url = new Uri($parameters['url']);
            $result = $this->selectedStrategy->fetchUrlContents($url, $crawlerId);
            if ($result !== false) {
                $result = ['content' => serialize($result)];
            }

            EventDispatcher::getInstance()->post(
                'urlCrawled',
                $queueItem['set_id'],
                ['url' => $parameters['url'], 'result' => $result]
            );
        }
        return $result;
    }

    protected function generateCrawlerIdFromQueueItem(array $queueItem): string
    {
        return $queueItem['qid'] . ':' . md5($queueItem['qid'] . '|' . $queueItem['set_id'] . '|' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
    }
}