SetupCheck.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Install\SystemEnvironment;
 
/*
 * 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 ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Messaging\FlashMessage;
use ‪TYPO3\CMS\Core\Messaging\FlashMessageQueue;
use ‪TYPO3\CMS\Core\Service\OpcodeCacheService;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪SetupCheck implements ‪CheckInterface
{
    protected ‪$messageQueue;
 
    public function ‪getStatus(): ‪FlashMessageQueue
    {
        $this->messageQueue = new ‪FlashMessageQueue('install');
 
        $this->‪checkTrustedHostPattern();
        $this->‪checkDownloadsPossible();
        $this->‪checkSystemLocale();
        $this->‪checkLocaleWithUTF8filesystem();
        $this->‪checkSomePhpOpcodeCacheIsLoaded();
        $this->‪isTrueTypeFontWorking();
        $this->‪checkLibXmlBug();
 
        return ‪$this->messageQueue;
    }
 
    protected function ‪checkTrustedHostPattern()
    {
        if (‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['trustedHostsPattern'] === ‪GeneralUtility::ENV_TRUSTED_HOSTS_PATTERN_ALLOW_ALL) {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                'Trusted hosts pattern is configured to allow all header values. Check the pattern defined in Admin'
                    . ' Tools -> Settings -> Configure Installation-Wide Options -> System -> trustedHostsPattern'
                    . ' and adapt it to expected host value(s).',
                'Trusted hosts pattern is insecure',
                ‪FlashMessage::WARNING
            ));
        } else {
            if (GeneralUtility::hostHeaderValueMatchesTrustedHostsPattern($_SERVER['HTTP_HOST'])) {
                $this->messageQueue->enqueue(new ‪FlashMessage(
                    '',
                    'Trusted hosts pattern is configured to allow current host value.'
                ));
            } else {
                $defaultPort = GeneralUtility::getIndpEnv('TYPO3_SSL') ? '443' : '80';
                $this->messageQueue->enqueue(new ‪FlashMessage(
                    'The trusted hosts pattern will be configured to allow all header values. This is because your $SERVER_NAME:[defaultPort]'
                        . ' is "' . $_SERVER['SERVER_NAME'] . ':' . $defaultPort . '" while your HTTP_HOST:SERVER_PORT is "'
                        . $_SERVER['HTTP_HOST'] . ':' . $_SERVER['SERVER_PORT'] . '". Check the pattern defined in Admin'
                        . ' Tools -> Settings -> Configure Installation-Wide Options -> System -> trustedHostsPattern'
                        . ' and adapt it to expected host value(s).',
                    'Trusted hosts pattern mismatch',
                    ‪FlashMessage::ERROR
                ));
            }
        }
    }
 
    protected function ‪checkDownloadsPossible()
    {
        $allowUrlFopen = (bool)ini_get('allow_url_fopen');
        $curlEnabled = function_exists('curl_version');
        if ($allowUrlFopen || $curlEnabled) {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                '',
                'Fetching external URLs is allowed'
            ));
        } else {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                'Either enable PHP runtime setting "allow_url_fopen"' . LF . 'or compile curl into your PHP with --with-curl.',
                'Fetching external URLs is not allowed',
                ‪FlashMessage::WARNING
            ));
        }
    }
 
    protected function ‪checkSystemLocale()
    {
        $currentLocale = setlocale(LC_CTYPE, 0);
 
        // On Windows an empty locale value uses the regional settings from the Control Panel
        if (‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['systemLocale'] === '' && !‪Environment::isWindows()) {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                '$GLOBALS[TYPO3_CONF_VARS][SYS][systemLocale] is not set. This is fine as long as no UTF-8 file system is used.',
                'Empty systemLocale setting',
                ‪FlashMessage::INFO
            ));
        } elseif (setlocale(LC_CTYPE, ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['systemLocale']) === false) {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                'Current value of the $GLOBALS[TYPO3_CONF_VARS][SYS][systemLocale] is incorrect. A locale with'
                    . ' this name doesn\'t exist in the operating system.',
                'Incorrect systemLocale setting',
                ‪FlashMessage::ERROR
            ));
            setlocale(LC_CTYPE, $currentLocale);
        } else {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                '',
                'System locale is correct'
            ));
        }
    }
 
    protected function ‪checkLocaleWithUTF8filesystem()
    {
        if (‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['UTF8filesystem']) {
            // On Windows an empty local value uses the regional settings from the Control Panel
            if (‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['systemLocale'] === '' && !‪Environment::isWindows()) {
                $this->messageQueue->enqueue(new ‪FlashMessage(
                    '$GLOBALS[TYPO3_CONF_VARS][SYS][UTF8filesystem] is set, but $GLOBALS[TYPO3_CONF_VARS][SYS][systemLocale]'
                        . ' is empty. Make sure a valid locale which supports UTF-8 is set.',
                    'System locale not set on UTF-8 file system',
                    ‪FlashMessage::ERROR
                ));
            } else {
                $testString = 'ÖöĄĆŻĘĆćążąęó.jpg';
                $currentLocale = setlocale(LC_CTYPE, 0);
                $quote = ‪Environment::isWindows() ? '"' : '\'';
                setlocale(LC_CTYPE, ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['systemLocale']);
                if (escapeshellarg($testString) === $quote . $testString . $quote) {
                    $this->messageQueue->enqueue(new ‪FlashMessage(
                        '',
                        'File names with UTF-8 characters can be used.'
                    ));
                } else {
                    $this->messageQueue->enqueue(new ‪FlashMessage(
                        'Please check your $GLOBALS[TYPO3_CONF_VARS][SYS][systemLocale] setting.',
                        'System locale setting doesn\'t support UTF-8 file names.',
                        ‪FlashMessage::ERROR
                    ));
                }
                setlocale(LC_CTYPE, $currentLocale);
            }
        } else {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                '',
                'Skipping test, as UTF8filesystem is not enabled.'
            ));
        }
    }
 
    protected function ‪checkSomePhpOpcodeCacheIsLoaded()
    {
        // Link to our documentation page, so we can update opcode cache issue information independent of TYPO3 CMS releases.
        $documentationLink = 'For more information take a look in our documentation ' . TYPO3_URL_WIKI_OPCODECACHE . '.';
        $opcodeCaches = GeneralUtility::makeInstance(OpcodeCacheService::class)->getAllActive();
        if (empty($opcodeCaches)) {
            // Set status to notice. It needs to be notice so email won't be triggered.
            $this->messageQueue->enqueue(new ‪FlashMessage(
                'PHP opcode caches hold a compiled version of executed PHP scripts in'
                    . ' memory and do not require to recompile a script each time it is accessed.'
                    . ' This can be a massive performance improvement and can reduce the load on a'
                    . ' server in general. A parse time reduction by factor three for fully cached'
                    . ' pages can be achieved easily if using an opcode cache.'
                    . LF . $documentationLink,
                'No PHP opcode cache loaded',
                ‪FlashMessage::NOTICE
            ));
        } else {
            $status = ‪FlashMessage::OK;
            $message = '';
            foreach ($opcodeCaches as $opcodeCache => $properties) {
                $message .= 'Name: ' . $opcodeCache . ' Version: ' . $properties['version'];
                $message .= LF;
                if ($properties['error']) {
                    $status = ‪FlashMessage::ERROR;
                    $message .= ' This opcode cache is marked as malfunctioning by the TYPO3 CMS Team.';
                } elseif ($properties['canInvalidate']) {
                    $message .= ' This opcode cache should work correctly and has good performance.';
                } else {
                    // Set status to notice if not already error set. It needs to be notice so email won't be triggered.
                    if ($status !== ‪FlashMessage::ERROR) {
                        $status = ‪FlashMessage::NOTICE;
                    }
                    $message .= ' This opcode cache may work correctly but has medium performance.';
                }
                $message .= LF;
            }
            $message .= $documentationLink;
            // Set title of status depending on serverity
            switch ($status) {
                case ‪FlashMessage::ERROR:
                    $title = 'A possibly malfunctioning PHP opcode cache is loaded';
                    break;
                case ‪FlashMessage::OK:
                default:
                    $title = 'A PHP opcode cache is loaded';
                    break;
            }
            $this->messageQueue->enqueue(new ‪FlashMessage(
                $message,
                $title,
                $status
            ));
        }
    }
 
    protected function ‪isTrueTypeFontWorking()
    {
        if (function_exists('imageftbbox')) {
            // 20 Pixels at 96 DPI
            $fontSize = (20 / 96 * 72);
            $textDimensions = @imageftbbox(
                $fontSize,
                0,
                __DIR__ . '/../../Resources/Private/Font/vera.ttf',
                'Testing true type support'
            );
            $fontBoxWidth = $textDimensions[2] - $textDimensions[0];
            if ($fontBoxWidth < 300 && $fontBoxWidth > 200) {
                $this->messageQueue->enqueue(new ‪FlashMessage(
                    'Fonts are rendered by FreeType library. '
                        . 'We need to ensure that the final dimensions are as expected. '
                        . 'This server renderes fonts based on 96 DPI correctly',
                    'FreeType True Type Font DPI'
                ));
            } else {
                $this->messageQueue->enqueue(new ‪FlashMessage(
                    'Fonts are rendered by FreeType library. '
                        . 'This server does not render fonts as expected. '
                        . 'Please check your FreeType 2 module.',
                    'FreeType True Type Font DPI',
                    ‪FlashMessage::NOTICE
                ));
            }
        } else {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                'The core relies on GD library compiled into PHP with freetype2'
                    . ' support. This is missing on your system. Please install it.',
                'PHP GD library freetype2 support missing',
                ‪FlashMessage::ERROR
            ));
        }
    }
 
    protected function ‪checkLibXmlBug()
    {
        $sampleArray = ['Test>><<Data'];
        $xmlContent = '<numIndex index="0">Test&gt;&gt;&lt;&lt;Data</numIndex>' . LF;
        $xml = GeneralUtility::array2xml($sampleArray, '', -1);
        if ($xmlContent !== $xml) {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                'Some hosts have problems saving ">><<" in a flexform.'
                    . ' To fix this, enable [BE][flexformForceCDATA] in'
                    . ' All Configuration.',
                'PHP libxml bug present',
                ‪FlashMessage::ERROR
            ));
        } else {
            $this->messageQueue->enqueue(new ‪FlashMessage(
                '',
                'PHP libxml bug not present'
            ));
        }
    }
}