CommandApplication.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\Core\Console;
 
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Output\ConsoleOutput;
use ‪TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Context\DateTimeAspect;
use ‪TYPO3\CMS\Core\Context\UserAspect;
use ‪TYPO3\CMS\Core\Context\VisibilityAspect;
use ‪TYPO3\CMS\Core\Context\WorkspaceAspect;
use ‪TYPO3\CMS\Core\Core\ApplicationInterface;
use ‪TYPO3\CMS\Core\Core\Bootstrap;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Information\Typo3Version;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
 
class ‪CommandApplication implements ‪ApplicationInterface
{
    protected ‪$context;
 
    protected ‪$commandRegistry;
 
    protected ‪$application;
 
    public function ‪__construct(‪Context ‪$context, ‪CommandRegistry ‪$commandRegistry)
    {
        $this->context = ‪$context;
        $this->commandRegistry = ‪$commandRegistry;
        $this->‪checkEnvironmentOrDie();
        $this->application = new Application('TYPO3 CMS', sprintf(
            '%s (Application Context: <comment>%s</comment>)',
            (new ‪Typo3Version())->getVersion(),
            ‪Environment::getContext()
        ));
        $this->application->setAutoExit(false);
        $this->application->setCommandLoader(‪$commandRegistry);
    }
 
    public function ‪run(callable $execute = null)
    {
        $this->‪initializeContext();
 
        $input = new ArgvInput();
        ‪$output = new ConsoleOutput();
 
        ‪Bootstrap::loadExtTables();
        // create the BE_USER object (not logged in yet)
        ‪Bootstrap::initializeBackendUser(CommandLineUserAuthentication::class);
        ‪$GLOBALS['LANG'] = ‪LanguageService::createFromUserPreferences(‪$GLOBALS['BE_USER']);
        // Make sure output is not buffered, so command-line output and interaction can take place
        ob_clean();
 
        $this->‪populateAvailableCommands();
 
        $exitCode = $this->application->run($input, ‪$output);
 
        if ($execute !== null) {
            call_user_func($execute);
        }
 
        exit($exitCode);
    }
 
    protected function ‪checkEnvironmentOrDie(): void
    {
        if (PHP_SAPI !== 'cli') {
            die('Not called from a command line interface (e.g. a shell or scheduler).' . LF);
        }
    }
 
    protected function ‪initializeContext(): void
    {
        $this->context->setAspect('date', new ‪DateTimeAspect(new \DateTimeImmutable('@' . ‪$GLOBALS['EXEC_TIME'])));
        $this->context->setAspect('visibility', new ‪VisibilityAspect(true, true));
        $this->context->setAspect('workspace', new ‪WorkspaceAspect(0));
        $this->context->setAspect('backend.user', new ‪UserAspect(null));
    }
 
    protected function ‪populateAvailableCommands(): void
    {
        foreach ($this->commandRegistry->getLegacyCommands() as $commandName => $command) {
            $this->application->add($command);
        }
    }
}