TYPO3\CMS\Install\Service\EnableFileService Class Reference

Static Public Member Functions
static	isFirstInstallAllowed ()
static	createInstallToolEnableFile ()
static	removeInstallToolEnableFile ()
static	removeFirstInstallFile ()
static	installToolEnableFileExists ()
static	checkInstallToolEnableFile ()
static	isInstallToolEnableFilePermanent ()
static	installToolEnableFileLifetimeExpired ()
static	getStaticLocationForInstallToolEnableFileDirectory ()
static	getBestLocationForInstallToolEnableFile ()

Public Attributes
const	INSTALL_TOOL_ENABLE_FILE_PATH = 'ENABLE_INSTALL_TOOL'
const	FIRST_INSTALL_FILE_PATH = 'FIRST_INSTALL'
const	INSTALL_TOOL_ENABLE_FILE_LIFETIME = 3600

Static Protected Member Functions
static	extendInstallToolEnableFileLifetime ()
static	getInstallToolEnableFilePath ()
static	getFirstInstallFilePaths ()

Detailed Description

Basic Service to check and create install tool files

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

Definition at line 25 of file EnableFileService.php.

Member Function Documentation

checkInstallToolEnableFile()

static TYPO3\CMS\Install\Service\EnableFileService::checkInstallToolEnableFile ( )

static

Checks if the install tool file exists

Definition at line 103 of file EnableFileService.php.

References TYPO3\CMS\Install\Service\EnableFileService\extendInstallToolEnableFileLifetime(), and TYPO3\CMS\Install\Service\EnableFileService\removeInstallToolEnableFile().

Referenced by TYPO3\CMS\Install\Middleware\Maintenance\checkEnableInstallToolFile().

createInstallToolEnableFile()

static TYPO3\CMS\Install\Service\EnableFileService::createInstallToolEnableFile ( )

static

Creates the INSTALL_TOOL_ENABLE file

Definition at line 54 of file EnableFileService.php.

References TYPO3\CMS\Install\Service\EnableFileService\extendInstallToolEnableFileLifetime(), TYPO3\CMS\Core\Utility\GeneralUtility\fixPermissions(), and TYPO3\CMS\Install\Service\EnableFileService\getInstallToolEnableFilePath().

Referenced by TYPO3\CMS\Install\Service\EnableFileService\extendInstallToolEnableFileLifetime().

extendInstallToolEnableFileLifetime()

static TYPO3\CMS\Install\Service\EnableFileService::extendInstallToolEnableFileLifetime ( )

staticprotected

Updates the last modification of the ENABLE_INSTALL_TOOL file

Definition at line 146 of file EnableFileService.php.

References TYPO3\CMS\Install\Service\EnableFileService\createInstallToolEnableFile(), and TYPO3\CMS\Install\Service\EnableFileService\getInstallToolEnableFilePath().

Referenced by TYPO3\CMS\Install\Service\EnableFileService\checkInstallToolEnableFile(), and TYPO3\CMS\Install\Service\EnableFileService\createInstallToolEnableFile().

getBestLocationForInstallToolEnableFile()

static TYPO3\CMS\Install\Service\EnableFileService::getBestLocationForInstallToolEnableFile ( )

static

Definition at line 170 of file EnableFileService.php.

References TYPO3\CMS\Core\Core\Environment\getConfigPath(), TYPO3\CMS\Core\Core\Environment\getVarPath(), TYPO3\CMS\Install\Service\EnableFileService\INSTALL_TOOL_ENABLE_FILE_PATH, and TYPO3\CMS\Core\Core\Environment\isComposerMode().

Referenced by TYPO3\CMS\Install\Service\EnableFileService\getInstallToolEnableFilePath(), and TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus().

getFirstInstallFilePaths()

static TYPO3\CMS\Install\Service\EnableFileService::getFirstInstallFilePaths ( )

staticprotected

Returns the paths to the FIRST_INSTALL files

Definition at line 200 of file EnableFileService.php.

References TYPO3\CMS\Core\Core\Environment\getPublicPath().

Referenced by TYPO3\CMS\Install\Service\EnableFileService\isFirstInstallAllowed(), and TYPO3\CMS\Install\Service\EnableFileService\removeFirstInstallFile().

getInstallToolEnableFilePath()

static TYPO3\CMS\Install\Service\EnableFileService::getInstallToolEnableFilePath ( )

staticprotected

Returns the absolute path to the INSTALL_TOOL_ENABLE file

Definition at line 182 of file EnableFileService.php.

References TYPO3\CMS\Install\Service\EnableFileService\getBestLocationForInstallToolEnableFile(), TYPO3\CMS\Core\Core\Environment\getConfigPath(), TYPO3\CMS\Core\Core\Environment\getLegacyConfigPath(), TYPO3\CMS\Core\Core\Environment\getVarPath(), and TYPO3\CMS\Install\Service\EnableFileService\INSTALL_TOOL_ENABLE_FILE_PATH.

Referenced by TYPO3\CMS\Install\Service\EnableFileService\createInstallToolEnableFile(), and TYPO3\CMS\Install\Service\EnableFileService\extendInstallToolEnableFileLifetime().

getStaticLocationForInstallToolEnableFileDirectory()

static TYPO3\CMS\Install\Service\EnableFileService::getStaticLocationForInstallToolEnableFileDirectory ( )

static

Returns a static directory path that is suitable to be presented to unauthenticated visitors, in order to circumvent "Full Path Disclosure" issues.

Definition at line 165 of file EnableFileService.php.

References TYPO3\CMS\Core\Core\Environment\isComposerMode().

Referenced by TYPO3\CMS\Install\Controller\LoginController\showEnableInstallToolFileAction().

installToolEnableFileExists()

static TYPO3\CMS\Install\Service\EnableFileService::installToolEnableFileExists ( )

static

Checks if the install tool file exists

Definition at line 95 of file EnableFileService.php.

Referenced by TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus(), and TYPO3\CMS\Install\Middleware\Maintenance\process().

installToolEnableFileLifetimeExpired()

static TYPO3\CMS\Install\Service\EnableFileService::installToolEnableFileLifetimeExpired ( )

static

Checks if the lifetime of the install tool file is expired

Definition at line 135 of file EnableFileService.php.

Referenced by TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus().

isFirstInstallAllowed()

static TYPO3\CMS\Install\Service\EnableFileService::isFirstInstallAllowed ( )

static

Definition at line 42 of file EnableFileService.php.

References TYPO3\CMS\Install\Service\EnableFileService\getFirstInstallFilePaths().

Referenced by TYPO3\CMS\Install\Middleware\Installer\canHandleRequest(), TYPO3\CMS\Install\Middleware\Maintenance\canHandleRequest(), and TYPO3\CMS\Install\Middleware\Installer\isInstallerAvailable().

isInstallToolEnableFilePermanent()

static TYPO3\CMS\Install\Service\EnableFileService::isInstallToolEnableFilePermanent ( )

static

Checks if the install tool file should be kept

Definition at line 121 of file EnableFileService.php.

Referenced by TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus(), TYPO3\CMS\Install\Middleware\Maintenance\process(), and TYPO3\CMS\Install\Controller\LoginController\showLoginAction().

removeFirstInstallFile()

static TYPO3\CMS\Install\Service\EnableFileService::removeFirstInstallFile ( )

static

Removes the FIRST_INSTALL file

Definition at line 82 of file EnableFileService.php.

References TYPO3\CMS\Install\Service\EnableFileService\getFirstInstallFilePaths(), and TYPO3\CMS\Core\Core\Environment\getPublicPath().

Referenced by TYPO3\CMS\Install\Controller\InstallerController\executeDefaultConfigurationAction().

removeInstallToolEnableFile()

static TYPO3\CMS\Install\Service\EnableFileService::removeInstallToolEnableFile ( )

static

Removes the INSTALL_TOOL_ENABLE file from all locations

Definition at line 70 of file EnableFileService.php.

Referenced by TYPO3\CMS\Install\Service\EnableFileService\checkInstallToolEnableFile(), TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus(), TYPO3\CMS\Install\Middleware\Maintenance\process(), and TYPO3\CMS\Install\Report\SecurityStatusReport\removeInstallToolEnableFilesIfRequested().

Member Data Documentation

FIRST_INSTALL_FILE_PATH

const TYPO3\CMS\Install\Service\EnableFileService::FIRST_INSTALL_FILE_PATH = 'FIRST_INSTALL'

Definition at line 35 of file EnableFileService.php.

INSTALL_TOOL_ENABLE_FILE_LIFETIME

const TYPO3\CMS\Install\Service\EnableFileService::INSTALL_TOOL_ENABLE_FILE_LIFETIME = 3600

Definition at line 40 of file EnableFileService.php.

Referenced by TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus().

INSTALL_TOOL_ENABLE_FILE_PATH

const TYPO3\CMS\Install\Service\EnableFileService::INSTALL_TOOL_ENABLE_FILE_PATH = 'ENABLE_INSTALL_TOOL'

Definition at line 30 of file EnableFileService.php.

Referenced by TYPO3\CMS\Install\Service\EnableFileService\getBestLocationForInstallToolEnableFile(), TYPO3\CMS\Core\Tests\Acceptance\Application\InstallTool\AbstractCest\getEnableInstallToolFilePath(), TYPO3\CMS\Install\Service\EnableFileService\getInstallToolEnableFilePath(), and TYPO3\CMS\Install\Tests\Functional\Service\EnableFileServiceTest\removeInstallToolEnableFileRemovesAllAvailableFiles().