CommandController.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Mvc\Controller;

use TYPO3\CMS\Core\Authentication\AbstractUserAuthentication;

class CommandController implements \TYPO3\CMS\Extbase\Mvc\Controller\CommandControllerInterface {

    const MAXIMUM_LINE_LENGTH = 79;

    protected $request;

    protected $response;

    protected $arguments;

    protected $commandMethodName = '';

    protected $requestAdminPermissions = FALSE;

    protected $userAuthentication;

    protected $reflectionService;

    protected $objectManager;

    public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager) {
        $this->objectManager = $objectManager;
        $this->arguments = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Controller\\Arguments');
        $this->userAuthentication = isset($GLOBALS['BE_USER']) ? $GLOBALS['BE_USER'] : NULL;
    }

    public function canProcessRequest(\TYPO3\CMS\Extbase\Mvc\RequestInterface $request) {
        return $request instanceof \TYPO3\CMS\Extbase\Mvc\Cli\Request;
    }

    public function processRequest(\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response) {
        if (!$this->canProcessRequest($request)) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\UnsupportedRequestTypeException(get_class($this) . ' does not support requests of type "' . get_class($request) . '".', 1300787096);
        }
        $this->request = $request;
        $this->request->setDispatched(TRUE);
        $this->response = $response;
        $this->commandMethodName = $this->resolveCommandMethodName();
        $this->initializeCommandMethodArguments();
        $this->mapRequestArgumentsToControllerArguments();
        $this->callCommandMethod();
    }

    protected function resolveCommandMethodName() {
        $commandMethodName = $this->request->getControllerCommandName() . 'Command';
        if (!is_callable(array($this, $commandMethodName))) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\NoSuchCommandException('A command method "' . $commandMethodName . '()" does not exist in controller "' . get_class($this) . '".', 1300902143);
        }
        return $commandMethodName;
    }

    protected function initializeCommandMethodArguments() {
        $methodParameters = $this->reflectionService->getMethodParameters(get_class($this), $this->commandMethodName);
        foreach ($methodParameters as $parameterName => $parameterInfo) {
            $dataType = NULL;
            if (isset($parameterInfo['type'])) {
                $dataType = $parameterInfo['type'];
            } elseif ($parameterInfo['array']) {
                $dataType = 'array';
            }
            if ($dataType === NULL) {
                throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidArgumentTypeException('The argument type for parameter $' . $parameterName . ' of method ' . get_class($this) . '->' . $this->commandMethodName . '() could not be detected.', 1306755296);
            }
            $defaultValue = isset($parameterInfo['defaultValue']) ? $parameterInfo['defaultValue'] : NULL;
            $this->arguments->addNewArgument($parameterName, $dataType, $parameterInfo['optional'] === FALSE, $defaultValue);
        }
    }

    protected function mapRequestArgumentsToControllerArguments() {
        foreach ($this->arguments as $argument) {
            $argumentName = $argument->getName();
            if ($this->request->hasArgument($argumentName)) {
                $argument->setValue($this->request->getArgument($argumentName));
            } elseif ($argument->isRequired()) {
                $commandArgumentDefinition = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Cli\\CommandArgumentDefinition', $argumentName, TRUE, NULL);
                $exception = new \TYPO3\CMS\Extbase\Mvc\Exception\CommandException('Required argument "' . $commandArgumentDefinition->getDashedName() . '" is not set.', 1306755520);
                $this->forward('error', 'TYPO3\\CMS\\Extbase\\Command\\HelpCommandController', array('exception' => $exception));
            }
        }
    }

    protected function forward($commandName, $controllerObjectName = NULL, array $arguments = array()) {
        $this->request->setDispatched(FALSE);
        $this->request->setControllerCommandName($commandName);
        if ($controllerObjectName !== NULL) {
            $this->request->setControllerObjectName($controllerObjectName);
        }
        $this->request->setArguments($arguments);
        $this->arguments->removeAll();
        throw new \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException();
    }

    protected function callCommandMethod() {
        $preparedArguments = array();
        foreach ($this->arguments as $argument) {
            $preparedArguments[] = $argument->getValue();
        }
        $originalRole = $this->ensureAdminRoleIfRequested();
        $commandResult = call_user_func_array(array($this, $this->commandMethodName), $preparedArguments);
        $this->restoreUserRole($originalRole);
        if (is_string($commandResult) && strlen($commandResult) > 0) {
            $this->response->appendContent($commandResult);
        } elseif (is_object($commandResult) && method_exists($commandResult, '__toString')) {
            $this->response->appendContent((string) $commandResult);
        }
    }

    protected function ensureAdminRoleIfRequested() {
        if (!$this->requestAdminPermissions || !$this->userAuthentication || !isset($this->userAuthentication->user['admin'])) {
            return NULL;
        }
        $originalRole = $this->userAuthentication->user['admin'];
        $this->userAuthentication->user['admin'] = 1;
        return $originalRole;
    }

    protected function restoreUserRole($originalRole) {
        if ($originalRole !== NULL) {
            $this->userAuthentication->user['admin'] = $originalRole;
        }
    }

    protected function output($text, array $arguments = array()) {
        if ($arguments !== array()) {
            $text = vsprintf($text, $arguments);
        }
        $this->response->appendContent($text);
    }

    protected function outputLine($text = '', array $arguments = array()) {
        return $this->output($text . PHP_EOL, $arguments);
    }

    protected function quit($exitCode = 0) {
        $this->response->setExitCode($exitCode);
        throw new \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException();
    }

    protected function sendAndExit($exitCode = 0) {
        $this->response->send();
        die($exitCode);
    }
}