RequireJsController.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Core\Controller;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * 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 TYPO3\CMS\Core\Http\Response;
use TYPO3\CMS\Core\Page\PageRenderer;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class RequireJsController
{
    protected $pageRenderer;

    public function __construct()
    {
        $this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
    }

    public function retrieveConfiguration(ServerRequestInterface $request): ResponseInterface
    {
        $name = $request->getQueryParams()['name'] ?? null;
        if (empty($name) || !is_string($name)) {
            return $this->createJsonResponse(null, 404);
        }
        $configuration = $this->findConfiguration($name);
        return $this->createJsonResponse($configuration, !empty($configuration) ? 200 : 404);
    }

    protected function findConfiguration(string $name): array
    {
        $relevantConfiguration = [];
        $this->pageRenderer->loadRequireJs();
        $configuration = $this->pageRenderer->getRequireJsConfig(PageRenderer::REQUIREJS_SCOPE_RESOLVE);

        $shim = $configuration['shim'] ?? [];
        foreach ($shim as $baseModuleName => $baseModuleConfiguration) {
            if (strpos($name . '/', $baseModuleName . '/') === 0) {
                $relevantConfiguration['shim'][$baseModuleName] = $baseModuleConfiguration;
            }
        }

        $paths = $configuration['paths'] ?? [];
        foreach ($paths as $baseModuleName => $baseModulePath) {
            if (strpos($name . '/', $baseModuleName . '/') === 0) {
                $relevantConfiguration['paths'][$baseModuleName] = $baseModulePath;
            }
        }

        $packages = $configuration['packages'] ?? [];
        foreach ($packages as $package) {
            if (!empty($package['name'])
                && strpos($name . '/', $package['name'] . '/') === 0
            ) {
                $relevantConfiguration['packages'][] = $package;
            }
        }

        return $relevantConfiguration;
    }

    protected function createJsonResponse($configuration, int $statusCode): Response
    {
        $response = (new Response())
            ->withStatus($statusCode)
            ->withHeader('Content-Type', 'application/json; charset=utf-8');

        if (!empty($configuration)) {
            $options = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES;
            $response->getBody()->write(json_encode($configuration ?: null, $options));
            $response->getBody()->rewind();
        }

        return $response;
    }
}