EnableFileService.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Install\Service;
 
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪EnableFileService
{
    public const ‪INSTALL_TOOL_ENABLE_FILE_PATH = 'ENABLE_INSTALL_TOOL';
 
    public const ‪FIRST_INSTALL_FILE_PATH = 'FIRST_INSTALL';
 
    public const ‪INSTALL_TOOL_ENABLE_FILE_LIFETIME = 3600;
 
    public static function ‪isFirstInstallAllowed(): bool
    {
        $files = ‪self::getFirstInstallFilePaths();
        if (!empty($files)) {
            return true;
        }
        return false;
    }
 
    public static function ‪createInstallToolEnableFile(): bool
    {
        $installEnableFilePath = ‪self::getInstallToolEnableFilePath();
        if (!is_file($installEnableFilePath)) {
            $result = touch($installEnableFilePath);
        } else {
            $result = true;
            ‪self::extendInstallToolEnableFileLifetime();
        }
        ‪GeneralUtility::fixPermissions($installEnableFilePath);
        return $result;
    }
 
    public static function ‪removeInstallToolEnableFile(): bool
    {
        $result = false;
        while (is_file(self::getInstallToolEnableFilePath())) {
            $result = unlink(self::getInstallToolEnableFilePath());
        }
        return $result;
    }
 
    public static function ‪removeFirstInstallFile(): bool
    {
        $result = true;
        $files = ‪self::getFirstInstallFilePaths();
        foreach ($files as $file) {
            $result = unlink(‪Environment::getPublicPath() . '/' . $file) && $result;
        }
        return $result;
    }
 
    public static function ‪installToolEnableFileExists(): bool
    {
        return @is_file(self::getInstallToolEnableFilePath());
    }
 
    public static function ‪checkInstallToolEnableFile(): bool
    {
        if (!self::installToolEnableFileExists()) {
            return false;
        }
        if (!self::isInstallToolEnableFilePermanent()) {
            if (self::installToolEnableFileLifetimeExpired()) {
                ‪self::removeInstallToolEnableFile();
                return false;
            }
            ‪self::extendInstallToolEnableFileLifetime();
        }
        return true;
    }
 
    public static function ‪isInstallToolEnableFilePermanent(): bool
    {
        if (self::installToolEnableFileExists()) {
            $content = (string)@file_get_contents(self::getInstallToolEnableFilePath());
            if (str_contains($content, 'KEEP_FILE')) {
                return true;
            }
        }
        return false;
    }
 
    public static function ‪installToolEnableFileLifetimeExpired(): bool
    {
        if (time() - @filemtime(self::getInstallToolEnableFilePath()) > self::INSTALL_TOOL_ENABLE_FILE_LIFETIME) {
            return true;
        }
        return false;
    }
 
    protected static function ‪extendInstallToolEnableFileLifetime()
    {
        $enableFile = ‪self::getInstallToolEnableFilePath();
        // Extend the age of the ENABLE_INSTALL_TOOL file by one hour
        if (is_file($enableFile)) {
            $couldTouch = @touch($enableFile);
            if (!$couldTouch) {
                // If we can't remove the creation method will call us again.
                if (self::removeInstallToolEnableFile()) {
                    ‪self::createInstallToolEnableFile();
                }
            }
        }
    }
 
    public static function ‪getStaticLocationForInstallToolEnableFileDirectory(): string
    {
        return ‪Environment::isComposerMode() ? 'var/transient/' : 'typo3conf/';
    }
 
    public static function ‪getBestLocationForInstallToolEnableFile(): string
    {
        $possibleLocations = [
            'default' => ‪Environment::getVarPath() . '/transient/' . ‪self::INSTALL_TOOL_ENABLE_FILE_PATH,
            'permanent' => ‪Environment::getConfigPath() . '/' . ‪self::INSTALL_TOOL_ENABLE_FILE_PATH,
        ];
        return ‪Environment::isComposerMode() ? $possibleLocations['default'] : $possibleLocations['permanent'];
    }
 
    protected static function ‪getInstallToolEnableFilePath(): string
    {
        $possibleLocations = [
            'default' => ‪Environment::getVarPath() . '/transient/' . ‪self::INSTALL_TOOL_ENABLE_FILE_PATH,
            'permanent' => ‪Environment::getConfigPath() . '/' . ‪self::INSTALL_TOOL_ENABLE_FILE_PATH,
            'legacy' => ‪Environment::getLegacyConfigPath() . ‪self::INSTALL_TOOL_ENABLE_FILE_PATH,
        ];
        foreach ($possibleLocations as $location) {
            if (@is_file($location)) {
                return $location;
            }
        }
        return ‪self::getBestLocationForInstallToolEnableFile();
    }
 
    protected static function ‪getFirstInstallFilePaths(): array
    {
        $files = scandir(‪Environment::getPublicPath() . '/');
        $files = is_array($files) ? $files : [];
        $files = array_filter($files, static function ($file) {
            return @is_file(‪Environment::getPublicPath() . '/' . $file) && preg_match('~^' . self::FIRST_INSTALL_FILE_PATH . '.*~i', $file);
        });
        return $files;
    }
}