AbstractServiceProvider.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Core\Package;
 
use Psr\Container\ContainerInterface;
use Psr\Log\LoggerAwareInterface;
use Symfony\Component\Finder\Finder;
use ‪TYPO3\CMS\Core\DependencyInjection\ServiceProviderInterface;
use ‪TYPO3\CMS\Core\Log\LogManager;
use ‪TYPO3\CMS\Core\Security\ContentSecurityPolicy\MutationCollection;
use ‪TYPO3\CMS\Core\Security\ContentSecurityPolicy\MutationOrigin;
use ‪TYPO3\CMS\Core\Security\ContentSecurityPolicy\MutationOriginType;
use ‪TYPO3\CMS\Core\Security\ContentSecurityPolicy\Scope;
use ‪TYPO3\CMS\Core\Site\Set\SetCollector;
use ‪TYPO3\CMS\Core\Site\Set\YamlSetDefinitionProvider;
use ‪TYPO3\CMS\Core\Type\Map;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractServiceProvider implements ‪ServiceProviderInterface
{
    abstract protected static function ‪getPackagePath(): string;
 
    abstract protected static function ‪getPackageName(): string;
 
    abstract public function ‪getFactories(): array;
 
    public function ‪getExtensions(): array
    {
        return [
            'middlewares' => [ static::class, 'configureMiddlewares' ],
            'backend.routes' => [ static::class, 'configureBackendRoutes' ],
            'backend.modules' => [ static::class, 'configureBackendModules' ],
            'content.security.policies' => [ static::class, 'configureContentSecurityPolicies' ],
            'icons' => [ static::class, 'configureIcons' ],
            SetCollector::class => [ static::class, 'configureSetCollector' ],
        ];
    }
 
    public static function ‪configureMiddlewares(ContainerInterface $container, \ArrayObject $middlewares, string $path = null): \ArrayObject
    {
        $packageConfiguration = ($path ?? static::getPackagePath()) . 'Configuration/RequestMiddlewares.php';
        if (file_exists($packageConfiguration)) {
            $middlewaresInPackage = require $packageConfiguration;
            if (is_array($middlewaresInPackage)) {
                $middlewares->exchangeArray(array_replace_recursive($middlewares->getArrayCopy(), $middlewaresInPackage));
            }
        }
 
        return $middlewares;
    }
 
    public static function ‪configureBackendRoutes(ContainerInterface $container, \ArrayObject $routes, string $path = null, string $packageName = null): \ArrayObject
    {
        $path = $path ?? static::getPackagePath();
        $packageName = $packageName ?? static::getPackageName();
        $routesFileNameForPackage = $path . 'Configuration/Backend/Routes.php';
        if (file_exists($routesFileNameForPackage)) {
            $definedRoutesInPackage = require $routesFileNameForPackage;
            if (is_array($definedRoutesInPackage)) {
                array_walk($definedRoutesInPackage, static function (array &$options) use ($packageName, $path): void {
                    // Add packageName and absolutePackagePath to all routes
                    $options['packageName'] = $packageName;
                    $options['absolutePackagePath'] = $path;
                });
                $routes->exchangeArray(array_merge($routes->getArrayCopy(), $definedRoutesInPackage));
            }
        }
        $routesFileNameForPackage = $path . 'Configuration/Backend/AjaxRoutes.php';
        if (file_exists($routesFileNameForPackage)) {
            $definedRoutesInPackage = require $routesFileNameForPackage;
            if (is_array($definedRoutesInPackage)) {
                foreach ($definedRoutesInPackage as $routeIdentifier => $routeOptions) {
                    // prefix the route with "ajax_" as "namespace"
                    $routeOptions['path'] = '/ajax' . $routeOptions['path'];
                    $routeOptions['packageName'] = $packageName;
                    $routeOptions['absolutePackagePath'] = $path;
                    $routes['ajax_' . $routeIdentifier] = $routeOptions;
                    $routes['ajax_' . $routeIdentifier]['ajax'] = true;
                }
            }
        }
 
        return $routes;
    }
 
    public static function ‪configureBackendModules(ContainerInterface $container, \ArrayObject $modules, string $path = null, string $packageName = null): \ArrayObject
    {
        $path = $path ?? static::getPackagePath();
        $packageName = $packageName ?? static::getPackageName();
        $modulesFileNameForPackage = $path . 'Configuration/Backend/Modules.php';
        if (file_exists($modulesFileNameForPackage)) {
            $definedModulesInPackage = require $modulesFileNameForPackage;
            if (is_array($definedModulesInPackage)) {
                array_walk($definedModulesInPackage, static function (array &$module) use ($packageName, $path): void {
                    // Add packageName and absolutePackagePath to all modules
                    $module['packageName'] = $packageName;
                    $module['absolutePackagePath'] = $path;
                });
                $modules->exchangeArray(array_merge($modules->getArrayCopy(), $definedModulesInPackage));
            }
        }
        return $modules;
    }
 
    public static function configureContentSecurityPolicies(ContainerInterface $container, ‪Map $mutations, string $path = null, string $packageName = null): ‪Map
    {
        $path = $path ?? static::getPackagePath();
        $packageName = $packageName ?? static::getPackageName();
        $fileName = $path . 'Configuration/ContentSecurityPolicies.php';
        if (file_exists($fileName)) {
            $mutationsInPackage = require $fileName;
            foreach ($mutationsInPackage as $scope => $mutation) {
                if (!isset($mutations[$scope])) {
                    $mutations[$scope] = new ‪Map();
                }
                $origin = new MutationOrigin(MutationOriginType::package, $packageName);
                $mutations[$scope][$origin] = $mutation;
            }
        }
        return $mutations;
    }
 
    public static function configureIcons(ContainerInterface $container, \ArrayObject ‪$icons, string $path = null): \ArrayObject
    {
        $path = $path ?? static::getPackagePath();
        $iconsFileNameForPackage = $path . 'Configuration/Icons.php';
        if (file_exists($iconsFileNameForPackage)) {
            $definedIconsInPackage = require $iconsFileNameForPackage;
            if (is_array($definedIconsInPackage)) {
                ‪$icons->exchangeArray(array_merge(‪$icons->getArrayCopy(), $definedIconsInPackage));
            }
        }
        return ‪$icons;
    }
 
    public static function ‪configureSetCollector(ContainerInterface $container, ‪SetCollector $setCollector, string $path = null): ‪SetCollector
    {
        $path = $path ?? static::getPackagePath();
        $setPath = $path . 'Configuration/Sets';
 
        try {
            ‪$finder = Finder::create()
                ->files()
                ->sortByName()
                ->depth(1)
                ->name('config.yaml')
                ->in($setPath);
        } catch (\InvalidArgumentException) {
            // No such directory in this package
            return $setCollector;
        }
 
        $setProvider = new ‪YamlSetDefinitionProvider();
        foreach (‪$finder as $fileInfo) {
            try {
                $setCollector->‪add($setProvider->get($fileInfo));
            } catch (\RuntimeException $e) {
                $logger = $container->get(LogManager::class)->getLogger(self::class);
                $logger->error('Invalid set in {file}: {reason}', [
                    'file' => $fileInfo->getPathname(),
                    'reason' => $e->getMessage(),
                ]);
            }
        }
 
        return $setCollector;
    }
 
    protected static function new(ContainerInterface $container, string $className, array $constructorArguments = [])
    {
        // Support $GLOBALS['TYPO3_CONF_VARS']['SYS']['Objects'] (xclasses) and class alias maps
        $instance = GeneralUtility::makeInstanceForDi($className, ...$constructorArguments);
 
        if ($instance instanceof LoggerAwareInterface) {
            $instance->setLogger($container->get(LogManager::class)->getLogger($className));
        }
        return $instance;
    }
}