Your IP : 216.73.217.13
<?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\Dashboard;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Page\JavaScriptModuleInstruction;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\PathUtility;
use TYPO3\CMS\Dashboard\Widgets\AdditionalCssInterface;
use TYPO3\CMS\Dashboard\Widgets\AdditionalJavaScriptInterface;
use TYPO3\CMS\Dashboard\Widgets\JavaScriptInterface;
use TYPO3\CMS\Dashboard\Widgets\RequireJsModuleInterface;
use TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface;
/**
* @internal
*/
class DashboardInitializationService
{
protected const MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER = 'dashboard/current_dashboard/';
private Dashboard $currentDashboard;
private BackendUserAuthentication $user;
/**
* @var list<JavaScriptModuleInstruction>
*/
protected $javaScriptModuleInstructions = [];
/**
* @var list<string|array{0:string, 1:string}>
* @deprecated will be removed in TYPO3 v13.0
*/
private array $requireJsModules = [];
private array $jsFiles = [];
private array $cssFiles = [];
public function __construct(
private readonly DashboardRepository $dashboardRepository,
private readonly DashboardPresetRegistry $dashboardPresetRegistry
) {}
public function initializeDashboards(ServerRequestInterface $request, BackendUserAuthentication $user): void
{
$this->user = $user;
$this->currentDashboard = $this->defineCurrentDashboard();
$this->currentDashboard->initializeWidgets($request);
$this->defineResourcesOfWidgets($this->currentDashboard->getWidgets());
}
public function getCurrentDashboard(): Dashboard
{
return $this->currentDashboard;
}
protected function defineCurrentDashboard(): Dashboard
{
$currentDashboard = $this->dashboardRepository->getDashboardByIdentifier($this->loadCurrentDashboard($this->user));
if ($currentDashboard === null) {
$dashboards = $this->getDashboardsForUser();
/** @var Dashboard $currentDashboard */
$currentDashboard = reset($dashboards);
$this->saveCurrentDashboard($this->user, $currentDashboard->getIdentifier());
}
return $currentDashboard;
}
protected function createDefaultDashboards(): array
{
$dashboardsForUser = [];
$userConfig = $this->user->getTSConfig();
$dashboardsToCreate = GeneralUtility::trimExplode(
',',
$userConfig['options.']['dashboard.']['dashboardPresetsForNewUsers'] ?? 'default'
);
foreach ($this->dashboardPresetRegistry->getDashboardPresets() as $dashboardPreset) {
if (in_array($dashboardPreset->getIdentifier(), $dashboardsToCreate, true)) {
$dashboard = $this->dashboardRepository->create(
$dashboardPreset,
(int)$this->user->user['uid']
);
if ($dashboard === null) {
continue;
}
$dashboardsForUser[$dashboard->getIdentifier()] = $dashboard;
}
}
return $dashboardsForUser;
}
/**
* @return Dashboard[]
*/
public function getDashboardsForUser(): array
{
$dashboards = [];
foreach ($this->dashboardRepository->getDashboardsForUser((int)$this->user->user['uid']) as $dashboard) {
$dashboards[$dashboard->getIdentifier()] = $dashboard;
}
if ($dashboards === []) {
$dashboards = $this->createDefaultDashboards();
}
return $dashboards;
}
/**
* @param array<string,WidgetConfigurationInterface> $widgets
*/
protected function defineResourcesOfWidgets(array $widgets): void
{
foreach ($widgets as $widget) {
$concreteInstance = GeneralUtility::makeInstance($widget->getServiceName());
if ($concreteInstance instanceof JavaScriptInterface) {
$this->defineJavaScriptInstructions($concreteInstance);
}
if ($concreteInstance instanceof RequireJsModuleInterface) {
trigger_error('Using RequireJsModuleInterface is deprecated and will be removed in TYPO3 v13.0.', E_USER_DEPRECATED);
$this->defineRequireJsModules($concreteInstance);
}
if ($concreteInstance instanceof AdditionalCssInterface) {
$this->defineCssFiles($concreteInstance);
}
if ($concreteInstance instanceof AdditionalJavaScriptInterface) {
$this->defineJsFiles($concreteInstance);
}
}
}
protected function defineJavaScriptInstructions(JavaScriptInterface $widgetInstance): void
{
foreach ($widgetInstance->getJavaScriptModuleInstructions() as $instruction) {
$this->javaScriptModuleInstructions[] = $instruction;
}
}
/**
* Add the RequireJS modules needed by some widgets
*
* @deprecated will be removed in TYPO3 v13.0
*/
protected function defineRequireJsModules(RequireJsModuleInterface $widgetInstance): void
{
foreach ($widgetInstance->getRequireJsModules() as $moduleNameOrIndex => $callbackOrModuleName) {
if (is_string($moduleNameOrIndex)) {
$this->requireJsModules[] = [$moduleNameOrIndex, $callbackOrModuleName];
} else {
$this->requireJsModules[] = $callbackOrModuleName;
}
}
}
/**
* Define the correct path of the JS files of a widget and add them to the list of JS files that needs to be
* included
*/
protected function defineJsFiles(AdditionalJavaScriptInterface $widgetInstance): void
{
foreach ($widgetInstance->getJsFiles() as $jsFile) {
if (PathUtility::isExtensionPath($jsFile)) {
$jsFile = PathUtility::getPublicResourceWebPath($jsFile);
}
$this->jsFiles[$jsFile] = $jsFile;
}
}
/**
* Define the correct path of the CSS files of a widget and add them to the list of CSS files that needs to be
* included
*/
protected function defineCssFiles(AdditionalCssInterface $widgetInstance): void
{
foreach ($widgetInstance->getCssFiles() as $cssFile) {
if (PathUtility::isExtensionPath($cssFile)) {
$cssFile = PathUtility::getPublicResourceWebPath($cssFile);
}
$this->cssFiles[$cssFile] = $cssFile;
}
}
protected function loadCurrentDashboard(BackendUserAuthentication $user): string
{
return $user->getModuleData(self::MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER) ?? '';
}
protected function saveCurrentDashboard(BackendUserAuthentication $user, string $identifier): void
{
$user->pushModuleData(self::MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER, $identifier);
}
/**
* @return list<JavaScriptModuleInstruction>
*/
public function getJavaScriptModuleInstructions(): array
{
return $this->javaScriptModuleInstructions;
}
/**
* @return list<string|array{0:string, 1:string}>
* @deprecated will be removed in TYPO3 v13.0
*/
public function getRequireJsModules(): array
{
return $this->requireJsModules;
}
public function getJsFiles(): array
{
return $this->jsFiles;
}
public function getCssFiles(): array
{
return $this->cssFiles;
}
}