25115320819

Committed 29 Apr 2026 02:37PM UTC coverage: 69.59% (+0.8%) from 68.791%

Build # 25115320819

Build Type

Pull #1158

github

Committed by

web-flow

Commit Message

Merge 22b70774f into 5371aaae1

Pull Request Pull Request #1158: !!! [TASK] Replace deprecated applicationData with request attributes

Coverage Stats

15 of 18 new or added lines in 2 files covered. (83.33%)

1920 of 2759 relevant lines covered (69.59%)

3.18 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.19

/Classes/Middleware/CrawlerInitialization.php

<?php

declare(strict_types=1);

namespace AOE\Crawler\Middleware;

/*
 * (c) 2022 Tomas Norre Mikkelsen <tomasnorre@gmail.com>
 *
 * 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 Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;
use TYPO3\CMS\Core\Error\Http\ServiceUnavailableException;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Evaluates HTTP headers and checks if Crawler should register itself.
 * Needs to be run after TSFE initialization AND Frontend User Authentication.
 *
 * Once done, the queue is fetched, and then the frontend request runs through.
 *
 * Finally, at the very end, if the crawler is still running, output the data and replace the response.
 *
 * @internal since v12.0.0
 */
class CrawlerInitialization implements MiddlewareInterface
{
    protected Context $context;

    public function __construct(?Context $context = null)
    {
        $this->context = $context ?? GeneralUtility::makeInstance(Context::class);
    }

    /**
     * @throws AspectNotFoundException
     * @throws ServiceUnavailableException
     */
    #[\Override]
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $queueParameters = $request->getAttribute('tx_crawler');
        if ($queueParameters === null) {
            return $handler->handle($request);
        }

        $request = $request->withAttribute('tx_crawler', [
            'forceIndexing' => true,
            'running' => true,
            'parameters' => $queueParameters,
            'log' => ['User Groups: ' . ($queueParameters['feUserGroupList'] ?? '')],
        ]);

        // Execute the frontend request as is
        $response = $handler->handle($request);
        $noCache = !$request->getAttribute('frontend.cache.instruction')->isCachingAllowed();

        $crawlerData = $request->getAttribute('tx_crawler', []);
        $crawlerData['vars'] = [
            'id' => $GLOBALS['TSFE']->id,
            'gr_list' => implode(',', $this->context->getAspect('frontend.user')->getGroupIds()),
            'no_cache' => $noCache,
        ];

        $this->runPollSuccessHooks($crawlerData);

        // Send log data for crawler (serialized content)
        return $response->withHeader('X-T3Crawler-Meta', serialize($crawlerData));
    }

    /**
     * Required because some extensions (staticpub) might never be requested to run due to some Core side effects
     * and since this is considered as error the crawler should handle it properly
     */
    private function runPollSuccessHooks(array &$crawlerData): void
    {
        $procInstructions = $crawlerData['content']['parameters']['procInstructions'] ?? null;
        if (!is_array($procInstructions)) {
            return;
        }

        foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['pollSuccess'] ?? [] as $pollable) {
            if (in_array($pollable, $procInstructions, true)) {
                if (empty($crawlerData['success'][$pollable])) {
                    $crawlerData['errorlog'][] = 'Error: Pollable extension (' . $pollable . ') did not complete successfully.';
                }
            }
        }
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	namespace AOE\Crawler\Middleware;
6
7	/*
8	* (c) 2022 Tomas Norre Mikkelsen <tomasnorre@gmail.com>
9	*
10	* This file is part of the TYPO3 Crawler Extension.
11	*
12	* It is free software; you can redistribute it and/or modify it under
13	* the terms of the GNU General Public License, either version 2
14	* of the License, or any later version.
15	*
16	* For the full copyright and license information, please read the
17	* LICENSE.txt file that was distributed with this source code.
18	*
19	* The TYPO3 project - inspiring people to share!
20	*/
21
22	use Psr\Http\Message\ResponseInterface;
23	use Psr\Http\Message\ServerRequestInterface;
24	use Psr\Http\Server\MiddlewareInterface;
25	use Psr\Http\Server\RequestHandlerInterface;
26	use TYPO3\CMS\Core\Context\Context;
27	use TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;
28	use TYPO3\CMS\Core\Error\Http\ServiceUnavailableException;
29	use TYPO3\CMS\Core\Utility\GeneralUtility;
30
31	/**
32	* Evaluates HTTP headers and checks if Crawler should register itself.
33	* Needs to be run after TSFE initialization AND Frontend User Authentication.
34	*
35	* Once done, the queue is fetched, and then the frontend request runs through.
36	*
37	* Finally, at the very end, if the crawler is still running, output the data and replace the response.
38	*
39	* @internal since v12.0.0
40	*/
41	class CrawlerInitialization implements MiddlewareInterface
42	{
43	protected Context $context;
44
45	public function __construct(?Context $context = null)
46	{
47	$this->context = $context ?? GeneralUtility::makeInstance(Context::class);	2✔
48	}
49
50	/**
51	* @throws AspectNotFoundException
52	* @throws ServiceUnavailableException
53	*/
54	#[\Override]
55	public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
56	{
57	$queueParameters = $request->getAttribute('tx_crawler');	3✔
58	if ($queueParameters === null) {	3✔
59	return $handler->handle($request);	1✔
60	}
61
62	$request = $request->withAttribute('tx_crawler', [	2✔
63	'forceIndexing' => true,	2✔
64	'running' => true,	2✔
65	'parameters' => $queueParameters,	2✔
66	'log' => ['User Groups: ' . ($queueParameters['feUserGroupList'] ?? '')],	2✔
67	]);	2✔
68
69	// Execute the frontend request as is
70	$response = $handler->handle($request);	2✔
71	$noCache = !$request->getAttribute('frontend.cache.instruction')->isCachingAllowed();	2✔
72
73	$crawlerData = $request->getAttribute('tx_crawler', []);	2✔
74	$crawlerData['vars'] = [	2✔
75	'id' => $GLOBALS['TSFE']->id,	2✔
76	'gr_list' => implode(',', $this->context->getAspect('frontend.user')->getGroupIds()),	2✔
77	'no_cache' => $noCache,	2✔
78	];	2✔
79
80	$this->runPollSuccessHooks($crawlerData);	2✔
81
82	// Send log data for crawler (serialized content)
83	return $response->withHeader('X-T3Crawler-Meta', serialize($crawlerData));	2✔
84	}
85
86	/**
87	* Required because some extensions (staticpub) might never be requested to run due to some Core side effects
88	* and since this is considered as error the crawler should handle it properly
89	*/
90	private function runPollSuccessHooks(array &$crawlerData): void
91	{
92	$procInstructions = $crawlerData['content']['parameters']['procInstructions'] ?? null;	2✔
93	if (!is_array($procInstructions)) {	2✔
94	return;	2✔
95	}
96
97	foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['pollSuccess'] ?? [] as $pollable) {	×
NEW 98	if (in_array($pollable, $procInstructions, true)) {	×
NEW 99	if (empty($crawlerData['success'][$pollable])) {	×
NEW 100	$crawlerData['errorlog'][] = 'Error: Pollable extension (' . $pollable . ') did not complete successfully.';	×
101	}
102	}
103	}
104	}
105	}

tomasnorre / crawler / 25115320819

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous