EnableFileService.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Install\Service;

class EnableFileService {

    const INSTALL_TOOL_ENABLE_FILE_PATH = 'typo3conf/ENABLE_INSTALL_TOOL';

    const FIRST_INSTALL_FILE_PATH = 'FIRST_INSTALL';

    const INSTALL_TOOL_ENABLE_FILE_LIFETIME = 3600;

    static public function isFirstInstallAllowed() {
        if (!is_dir(PATH_typo3conf) && is_file(self::getFirstInstallFilePath())) {
            return TRUE;
        }
        return FALSE;
    }

    static public function createInstallToolEnableFile() {
        $installEnableFilePath = self::getInstallToolEnableFilePath();
        if (!is_file($installEnableFilePath)) {
            $result = touch($installEnableFilePath);
        } else {
            $result = TRUE;
            self::extendInstallToolEnableFileLifetime();
        }
        \TYPO3\CMS\Core\Utility\GeneralUtility::fixPermissions($installEnableFilePath);
        return $result;
    }

    static public function removeInstallToolEnableFile() {
        return unlink(self::getInstallToolEnableFilePath());
    }

    static public function removeFirstInstallFile() {
        return unlink(self::getFirstInstallFilePath());
    }

    static public function installToolEnableFileExists() {
        return @is_file(self::getInstallToolEnableFilePath());
    }

    static public function checkInstallToolEnableFile() {
        if (!self::installToolEnableFileExists()) {
            return FALSE;
        }
        if (!self::isInstallToolEnableFilePermanent()) {
            if (self::installToolEnableFileLifetimeExpired()) {
                self::removeInstallToolEnableFile();
                return FALSE;
            }
            self::extendInstallToolEnableFileLifetime();
        }
        return TRUE;
    }

    static public function isInstallToolEnableFilePermanent() {
        if (self::installToolEnableFileExists()) {
            $content = @file_get_contents(self::getInstallToolEnableFilePath());
            if (strpos($content, 'KEEP_FILE') !== FALSE) {
                return TRUE;
            }
        }
        return FALSE;
    }


    static public function installToolEnableFileLifetimeExpired() {
        if (time() - @filemtime(self::getInstallToolEnableFilePath()) > self::INSTALL_TOOL_ENABLE_FILE_LIFETIME) {
            return TRUE;
        } else {
            return FALSE;
        }
    }

    static protected 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();
                }
            }
        }
    }

    static protected function getInstallToolEnableFilePath() {
        return PATH_site . self::INSTALL_TOOL_ENABLE_FILE_PATH;
    }

    static protected function getFirstInstallFilePath() {
        return PATH_site . self::FIRST_INSTALL_FILE_PATH;
    }
}