15384842948

Committed 02 Jun 2025 05:49AM UTC coverage: 90.629% (+0.1%) from 90.534%

Build # 15384842948

Build Type

Pull #866

github

Committed by

eliashaeussler

Commit Message

[FEATURE] Inject all available crawling strategies into extension configuration modal

Pull Request Pull Request #866: [FEATURE] Inject all available crawling strategies into extension configuration modal

Run Details

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

2 existing lines in 1 file now uncovered.

1354 of 1494 relevant lines covered (90.63%)

9.9 hits per line

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

93.1

/Classes/Middleware/InjectExtensionConfigurationScriptMiddleware.php

<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS extension "warming".
 *
 * Copyright (C) 2021-2025 Elias Häußler <elias@haeussler.dev>
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace EliasHaeussler\Typo3Warming\Middleware;

use EliasHaeussler\CacheWarmup;
use Psr\Http\Message;
use Psr\Http\Server;
use TYPO3\CMS\Backend;
use TYPO3\CMS\Core;

/**
 * InjectExtensionConfigurationScriptMiddleware
 *
 * @author Elias Häußler <elias@haeussler.dev>
 * @license GPL-2.0-or-later
 */
final readonly class InjectExtensionConfigurationScriptMiddleware implements Server\MiddlewareInterface
{
    public function __construct(
        private CacheWarmup\Crawler\Strategy\CrawlingStrategyFactory $crawlingStrategyFactory,
    ) {}

    public function process(
        Message\ServerRequestInterface $request,
        Server\RequestHandlerInterface $handler,
    ): Message\ResponseInterface {
        $response = $handler->handle($request);
        /** @var Backend\Routing\Route|null $route */
        $route = $request->getAttribute('route');
        /** @var Core\Authentication\BackendUserAuthentication|null $backedUser */
        $backedUser = $GLOBALS['BE_USER'] ?? null;

        // Early return if we're not on main route
        if ($route?->getPath() !== '/main') {
            return $response;
        }

        // Early return on TYPO3 v12 (uses jQuery and thus doesn't need a workaround for <script> tags in modals)
        // @todo Remove once support for TYPO3 v12 is dropped
        if ((new Core\Information\Typo3Version())->getMajorVersion() === 12) {
            return $response;
        }

        // Early return if response is invalid
        if ($response->getStatusCode() !== 200) {
            return $response;
        }

        // Early return on insufficient privileges (only system maintainers can access settings module)
        if (!($backedUser?->isSystemMaintainer() ?? false)) {
            return $response;
        }

        // Inject scripts into <head>
        $body = $response->getBody();
        $contents = (string)$body;
        $body->rewind();
        $body->write(
            str_replace('</head>', $this->renderScriptTag($request) . '</head>', $contents),
        );

        return $response;
    }

    private function renderScriptTag(Message\ServerRequestInterface $request): string
    {
        /** @var Core\Security\ContentSecurityPolicy\ConsumableNonce $nonce */
        $nonce = $request->getAttribute('nonce');
        $nonceValue = $nonce->consume();
        $strategies = json_encode($this->crawlingStrategyFactory->getAll());

        return <<<JS
<script async nonce="{$nonceValue}" id="tx-warming-script-inject">
import('@eliashaeussler/typo3-warming/backend/extension-configuration.js').then(({default: extensionConfiguration}) => {
    extensionConfiguration.initializeModalListener('{$nonceValue}', {$strategies});
});
</script>
JS;
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of the TYPO3 CMS extension "warming".
7	*
8	* Copyright (C) 2021-2025 Elias Häußler <elias@haeussler.dev>
9	*
10	* This program is free software: you can redistribute it and/or modify
11	* it under the terms of the GNU General Public License as published by
12	* the Free Software Foundation, either version 2 of the License, or
13	* (at your option) any later version.
14	*
15	* This program is distributed in the hope that it will be useful,
16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	* GNU General Public License for more details.
19	*
20	* You should have received a copy of the GNU General Public License
21	* along with this program. If not, see <https://www.gnu.org/licenses/>.
22	*/
23
24	namespace EliasHaeussler\Typo3Warming\Middleware;
25
26	use EliasHaeussler\CacheWarmup;
27	use Psr\Http\Message;
28	use Psr\Http\Server;
29	use TYPO3\CMS\Backend;
30	use TYPO3\CMS\Core;
31
32	/**
33	* InjectExtensionConfigurationScriptMiddleware
34	*
35	* @author Elias Häußler <elias@haeussler.dev>
36	* @license GPL-2.0-or-later
37	*/
38	final readonly class InjectExtensionConfigurationScriptMiddleware implements Server\MiddlewareInterface
39	{
40	public function __construct(	29✔
41	private CacheWarmup\Crawler\Strategy\CrawlingStrategyFactory $crawlingStrategyFactory,
42	) {}	29✔
43
44	public function process(	29✔
45	Message\ServerRequestInterface $request,
46	Server\RequestHandlerInterface $handler,
47	): Message\ResponseInterface {
48	$response = $handler->handle($request);	29✔
49	/** @var Backend\Routing\Route\|null $route */
50	$route = $request->getAttribute('route');	29✔
51	/** @var Core\Authentication\BackendUserAuthentication\|null $backedUser */
52	$backedUser = $GLOBALS['BE_USER'] ?? null;	29✔
53
54	// Early return if we're not on main route
55	if ($route?->getPath() !== '/main') {	29✔
56	return $response;	29✔
57	}
58
59	// Early return on TYPO3 v12 (uses jQuery and thus doesn't need a workaround for <script> tags in modals)
60	// @todo Remove once support for TYPO3 v12 is dropped
61	if ((new Core\Information\Typo3Version())->getMajorVersion() === 12) {	29✔
UNCOV 62	return $response;	×
63	}
64
65	// Early return if response is invalid
66	if ($response->getStatusCode() !== 200) {	29✔
UNCOV 67	return $response;	×
68	}
69
70	// Early return on insufficient privileges (only system maintainers can access settings module)
71	if (!($backedUser?->isSystemMaintainer() ?? false)) {	29✔
72	return $response;	8✔
73	}
74
75	// Inject scripts into <head>
76	$body = $response->getBody();	21✔
77	$contents = (string)$body;	21✔
78	$body->rewind();	21✔
79	$body->write(	21✔
80	str_replace('</head>', $this->renderScriptTag($request) . '</head>', $contents),	21✔
81	);	21✔
82
83	return $response;	21✔
84	}
85
86	private function renderScriptTag(Message\ServerRequestInterface $request): string	21✔
87	{
88	/** @var Core\Security\ContentSecurityPolicy\ConsumableNonce $nonce */
89	$nonce = $request->getAttribute('nonce');	21✔
90	$nonceValue = $nonce->consume();	21✔
91	$strategies = json_encode($this->crawlingStrategyFactory->getAll());	21✔
92
93	return <<<JS	21✔
94	<script async nonce="{$nonceValue}" id="tx-warming-script-inject">	21✔
95	import('@eliashaeussler/typo3-warming/backend/extension-configuration.js').then(({default: extensionConfiguration}) => {
96	extensionConfiguration.initializeModalListener('{$nonceValue}', {$strategies});	21✔
97	});
98	</script>
99	JS;	21✔
100	}
101	}

eliashaeussler / typo3-warming / 15384842948

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