CommandRequestHandler.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Console;

/*
 * 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!
 */

use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\ConsoleOutput;
use TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication;
use TYPO3\CMS\Core\Core\Bootstrap;
use TYPO3\CMS\Core\Package\PackageManager;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class CommandRequestHandler implements RequestHandlerInterface
{
    protected $bootstrap;

    protected $application;

    public function __construct(Bootstrap $bootstrap)
    {
        $this->bootstrap = $bootstrap;
        $this->application = new Application('TYPO3 CMS', TYPO3_version);
    }

    public function handleRequest(InputInterface $input)
    {
        $output = new ConsoleOutput();

        $this->bootstrap
            ->loadBaseTca()
            ->loadExtTables()
            // create the BE_USER object (not logged in yet)
            ->initializeBackendUser(CommandLineUserAuthentication::class)
            ->initializeLanguageObject()
            // Make sure output is not buffered, so command-line output and interaction can take place
            ->endOutputBufferingAndCleanPreviousOutput();

        $this->populateAvailableCommands();

        // Check if the command to run needs a backend user to be loaded
        $command = $this->getCommandToRun($input);

        if (!$command) {
            // Using old "cliKeys" is marked as deprecated and will be removed in TYPO3 v9
            $cliKeys = array_keys($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['cliKeys']);

            $output->writeln('Using old "cliKeys" ($GLOBALS[TYPO3_CONF_VARS][SC_OPTIONS][GLOBAL][cliKeys]) is marked as deprecated and will be removed in TYPO3 v9:');
            $output->writeln('Old entrypoint keys available:');
            asort($cliKeys);
            foreach ($cliKeys as $key => $value) {
                $output->writeln('  ' . $value);
            }
            $output->writeln('');
            $output->writeln('TYPO3 Console Commands:');
        }

        $exitCode = $this->application->run($input, $output);
        exit($exitCode);
    }

    public function canHandleRequest(InputInterface $input)
    {
        return true;
    }

    public function getPriority()
    {
        return 50;
    }

    protected function getCommandToRun(InputInterface $input)
    {
        $firstArgument = $input->getFirstArgument();
        try {
            return $this->application->find($firstArgument);
        } catch (\InvalidArgumentException $e) {
            return false;
        }
    }

    protected function populateAvailableCommands()
    {
        $packageManager = Bootstrap::getInstance()->getEarlyInstance(PackageManager::class);

        foreach ($packageManager->getActivePackages() as $package) {
            $commandsOfExtension = $package->getPackagePath() . 'Configuration/Commands.php';
            if (@is_file($commandsOfExtension)) {
                $commands = require_once $commandsOfExtension;
                if (is_array($commands)) {
                    foreach ($commands as $commandName => $commandDescription) {
                        $cmd = GeneralUtility::makeInstance($commandDescription['class'], $commandName);
                        // Check if the command name is already in use
                        if ($this->application->has($commandName)) {
                            throw new CommandNameAlreadyInUseException('Command "' . $commandName . '" registered by "' . $package->getPackageKey() . '" is already in use', 1484486383);
                        }
                        $this->application->add($cmd);
                    }
                }
            }
        }
    }
}