SystemInformationToolbarItem.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\Backend\Backend\ToolbarItems;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\Backend\Event\SystemInformationToolbarCollectorEvent;
use ‪TYPO3\CMS\Backend\Toolbar\Enumeration\InformationStatus as DeprectaedInformationStatus;
use ‪TYPO3\CMS\Backend\Toolbar\InformationStatus;
use ‪TYPO3\CMS\Backend\Toolbar\RequestAwareToolbarItemInterface;
use ‪TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface;
use ‪TYPO3\CMS\Backend\View\BackendViewFactory;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Information\Typo3Version;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Utility\CommandUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪SystemInformationToolbarItem implements ‪ToolbarItemInterface, ‪RequestAwareToolbarItemInterface
{
    private ServerRequestInterface ‪$request;
    protected array ‪$systemInformation = [];
    protected ‪InformationStatus ‪$highestSeverity;
    protected string ‪$severityBadgeClass = '';
    protected array ‪$systemMessages = [];
    protected int ‪$systemMessageTotalCount = 0;
 
    public function ‪__construct(
        private readonly EventDispatcherInterface $eventDispatcher,
        private readonly ‪Typo3Version $typo3Version,
        private readonly ‪BackendViewFactory $backendViewFactory,
    ) {
        $this->highestSeverity = InformationStatus::INFO;
    }
 
    public function ‪setRequest(ServerRequestInterface ‪$request): void
    {
        $this->request = ‪$request;
    }
 
    public function ‪addSystemMessage($text, $status = InformationStatus::OK, $count = 0, $module = '', $params = ''): void
    {
        $this->systemMessageTotalCount += $count;
 
        if (is_string($status)) {
            trigger_error(
                'Using a string of the non-native enumeration ' . DeprectaedInformationStatus::class . ' for $status '
                . 'in SystemInformationToolbarItem->addSystemMessage() has been deprecated and will stop working in '
                . 'TYPO3 v14.0. Use the native ' . InformationStatus::class . ' instead.',
                E_USER_DEPRECATED
            );
            $messageSeverity = InformationStatus::tryFrom($status) ?? InformationStatus::OK;
        } elseif ($status instanceof ‪InformationStatus) {
            $messageSeverity = $status;
        } else {
            $messageSeverity = InformationStatus::OK;
        }
 
        // define the severity for the badge
        if ($messageSeverity->isGreaterThan($this->highestSeverity)) {
            $this->highestSeverity = $messageSeverity;
        }
 
        $this->systemMessages[] = [
            'module' => $module,
            'params' => $params,
            'count' => $count,
            'status' => $messageSeverity->value,
            'text' => $text,
        ];
    }
 
    public function ‪addSystemInformation($title, $value, $iconIdentifier, $status = InformationStatus::NOTICE): void
    {
        if (is_string($status)) {
            trigger_error(
                'Using a string of the non-native enumeration ' . DeprectaedInformationStatus::class . ' for $status '
                . 'in SystemInformationToolbarItem->addSystemInformation() has been deprecated and will stop working in '
                . 'TYPO3 v14.0. Use the native ' . InformationStatus::class . ' instead.',
                E_USER_DEPRECATED
            );
            $status = InformationStatus::tryFrom($status) ?? InformationStatus::NOTICE;
        } elseif (!$status instanceof ‪InformationStatus) {
            $status = InformationStatus::OK;
        }
 
        $this->systemInformation[] = [
            'title' => $title,
            'value' => $value,
            'iconIdentifier' => $iconIdentifier,
            'status' => $status->value,
        ];
    }
 
    public function ‪checkAccess(): bool
    {
        return $this->‪getBackendUserAuthentication()->isAdmin();
    }
 
    public function ‪getItem(): string
    {
        $view = $this->backendViewFactory->create($this->request);
        return $view->render('ToolbarItems/SystemInformationToolbarItem');
    }
 
    public function ‪getDropDown(): string
    {
        if (!$this->‪checkAccess()) {
            return '';
        }
        $this->‪collectInformation();
        $view = $this->backendViewFactory->create($this->request);
        $view->assignMultiple([
            'messages' => $this->systemMessages,
            'count' => $this->systemMessageTotalCount > 99 ? '99+' : $this->systemMessageTotalCount,
            'severityBadgeClass' => $this->severityBadgeClass,
            'systemInformation' => $this->systemInformation,
        ]);
        return $view->render('ToolbarItems/SystemInformationDropDown');
    }
 
    public function ‪getAdditionalAttributes(): array
    {
        return [];
    }
 
    public function ‪hasDropDown(): bool
    {
        return true;
    }
 
    public function ‪getIndex(): int
    {
        return 75;
    }
 
    protected function ‪collectInformation(): void
    {
        $this->‪addTypo3Version();
        $this->‪addWebServer();
        $this->‪addPhpVersion();
        $this->‪addDebugger();
        $this->‪addDatabase();
        $this->‪addApplicationContext();
        $this->‪addComposerMode();
        $this->‪addGitRevision();
        $this->‪addOperatingSystem();
        $this->eventDispatcher->dispatch(new ‪SystemInformationToolbarCollectorEvent($this));
        $this->severityBadgeClass = $this->highestSeverity !== InformationStatus::NOTICE ? 'badge-' . $this->highestSeverity->value : '';
    }
 
    protected function ‪addTypo3Version(): void
    {
        $this->systemInformation[] = [
            'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.typo3-version',
            'value' => $this->typo3Version->getVersion(),
            'iconIdentifier' => 'information-typo3-version',
        ];
    }
 
    protected function ‪addWebServer(): void
    {
        $this->systemInformation[] = [
            'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.webserver',
            'value' => ‪$_SERVER['SERVER_SOFTWARE'] ?? '',
            'iconIdentifier' => 'information-webserver',
        ];
    }
 
    protected function ‪addPhpVersion(): void
    {
        $this->systemInformation[] = [
            'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.phpversion',
            'value' => PHP_VERSION,
            'iconIdentifier' => 'information-php-version',
        ];
    }
 
    protected function ‪addDebugger(): void
    {
        $knownDebuggers = ['xdebug', 'Zend Debugger'];
        foreach ($knownDebuggers as $debugger) {
            if (extension_loaded($debugger)) {
                $debuggerVersion = phpversion($debugger) ?: '';
                $this->systemInformation[] = [
                    'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.debugger',
                    'value' => sprintf('%s %s', $debugger, $debuggerVersion),
                    'iconIdentifier' => 'information-debugger',
                ];
            }
        }
    }
 
    protected function ‪addDatabase(): void
    {
        foreach (GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionNames() as $connectionName) {
            $serverVersion = '[' . $this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.database.offline') . ']';
            $success = true;
            try {
                $serverVersion = GeneralUtility::makeInstance(ConnectionPool::class)
                    ->getConnectionByName($connectionName)
                    ->getPlatformServerVersion();
            } catch (\‪Exception $exception) {
                $success = false;
            }
            $this->systemInformation[] = [
                'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.database',
                'titleAddition' => $connectionName,
                'value' => $serverVersion,
                'status' => $success ?: InformationStatus::WARNING->value,
                'iconIdentifier' => 'information-database',
            ];
        }
    }
 
    protected function ‪addApplicationContext(): void
    {
        $applicationContext = ‪Environment::getContext();
        $this->systemInformation[] = [
            'title'  => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.applicationcontext',
            'value'  => (string)$applicationContext,
            'status' => $applicationContext->isProduction() ? InformationStatus::OK->value : InformationStatus::WARNING->value,
            'iconIdentifier' => 'information-application-context',
        ];
    }
 
    protected function ‪addComposerMode(): void
    {
        if (!‪Environment::isComposerMode()) {
            return;
        }
        $this->systemInformation[] = [
            'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.composerMode',
            'value' => $this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.enabled'),
            'iconIdentifier' => 'information-composer-mode',
        ];
    }
 
    protected function ‪addGitRevision(): void
    {
        if (!str_ends_with($this->typo3Version->getVersion(), '-dev') || $this->isFunctionDisabled('exec')) {
            return;
        }
        // check if git exists
        $returnCode = 0;
        ‪CommandUtility::exec('git --version', $_, $returnCode);
        if ($returnCode !== 0) {
            // git is not available
            return;
        }
 
        $revision = trim(‪CommandUtility::exec('git rev-parse --short HEAD'));
        $branch = trim(‪CommandUtility::exec('git rev-parse --abbrev-ref HEAD'));
        if (!empty($revision) && !empty($branch)) {
            $this->systemInformation[] = [
                'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.gitrevision',
                'value' => sprintf('%s [%s]', $revision, $branch),
                'iconIdentifier' => 'information-git',
            ];
        }
    }
 
    protected function ‪addOperatingSystem(): void
    {
        switch (PHP_OS_FAMILY) {
            case 'Linux':
                $icon = 'linux';
                break;
            case 'Darwin':
                $icon = 'apple';
                break;
            case 'Windows':
                $icon = 'windows';
                break;
            default:
                $icon = 'unknown';
        }
        $this->systemInformation[] = [
            'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.operatingsystem',
            'value' => PHP_OS . ' ' . php_uname('r'),
            'iconIdentifier' => 'information-os-' . $icon,
        ];
    }
 
    protected function ‪isFunctionDisabled(string $functionName): bool
    {
        $disabledFunctions = ‪GeneralUtility::trimExplode(',', (string)ini_get('disable_functions'));
        if (!empty($disabledFunctions)) {
            return in_array($functionName, $disabledFunctions, true);
        }
        return false;
    }
 
    protected function ‪getBackendUserAuthentication(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
}