LockBackendCommand.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\Backend\Command;
 
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
#[AsCommand('backend:lock', 'Lock the TYPO3 Backend')]
class ‪LockBackendCommand extends Command
{
    protected function ‪configure()
    {
        $this
            ->addArgument(
                'redirect',
                InputArgument::OPTIONAL,
                'If set, then the TYPO3 Backend will redirect to the locking state (only used when locking the TYPO3 Backend'
            );
    }
 
    protected function ‪execute(InputInterface $input, OutputInterface ‪$output): int
    {
        $io = new SymfonyStyle($input, ‪$output);
        $io->title($this->getDescription());
        $lockFile = $this->‪getLockFileName();
        if (@is_file($lockFile)) {
            $io->note('A lock file already exists. Overwriting it.');
        }
        ‪$output = 'Wrote lock file to "' . $lockFile . '"';
        if ($input->getArgument('redirect')) {
            $lockFileContent = $input->getArgument('redirect');
            $lockFileContent = is_string($lockFileContent) ? $lockFileContent : '';
            ‪$output .= LF . 'with content "' . $lockFileContent . '".';
        } else {
            $lockFileContent = '';
            ‪$output .= '.';
        }
        ‪GeneralUtility::writeFile($lockFile, $lockFileContent);
        $io->success(‪$output);
        return Command::SUCCESS;
    }
 
    protected function ‪getLockFileName()
    {
        return ‪Environment::getLegacyConfigPath() . '/LOCK_BACKEND';
    }
}