Chris@0: <?php
Chris@0: namespace Consolidation\AnnotatedCommand;
Chris@0: 
Chris@0: use Consolidation\AnnotatedCommand\Hooks\Dispatchers\ReplaceCommandHookDispatcher;
Chris@0: use Psr\Log\LoggerAwareInterface;
Chris@0: use Psr\Log\LoggerAwareTrait;
Chris@0: use Symfony\Component\Console\Input\InputInterface;
Chris@0: use Symfony\Component\Console\Output\OutputInterface;
Chris@0: use Symfony\Component\Console\Output\ConsoleOutputInterface;
Chris@0: 
Chris@0: use Consolidation\OutputFormatters\FormatterManager;
Chris@0: use Consolidation\OutputFormatters\Options\FormatterOptions;
Chris@0: use Consolidation\AnnotatedCommand\Hooks\HookManager;
Chris@0: use Consolidation\AnnotatedCommand\Options\PrepareFormatter;
Chris@0: 
Chris@0: use Consolidation\AnnotatedCommand\Hooks\Dispatchers\InitializeHookDispatcher;
Chris@0: use Consolidation\AnnotatedCommand\Hooks\Dispatchers\OptionsHookDispatcher;
Chris@0: use Consolidation\AnnotatedCommand\Hooks\Dispatchers\InteractHookDispatcher;
Chris@0: use Consolidation\AnnotatedCommand\Hooks\Dispatchers\ValidateHookDispatcher;
Chris@0: use Consolidation\AnnotatedCommand\Hooks\Dispatchers\ProcessResultHookDispatcher;
Chris@0: use Consolidation\AnnotatedCommand\Hooks\Dispatchers\StatusDeterminerHookDispatcher;
Chris@0: use Consolidation\AnnotatedCommand\Hooks\Dispatchers\ExtracterHookDispatcher;
Chris@0: 
Chris@0: /**
Chris@0:  * Process a command, including hooks and other callbacks.
Chris@0:  * There should only be one command processor per application.
Chris@0:  * Provide your command processor to the AnnotatedCommandFactory
Chris@0:  * via AnnotatedCommandFactory::setCommandProcessor().
Chris@0:  */
Chris@0: class CommandProcessor implements LoggerAwareInterface
Chris@0: {
Chris@0:     use LoggerAwareTrait;
Chris@0: 
Chris@17:     /** @var HookManager */
Chris@0:     protected $hookManager;
Chris@17:     /** @var FormatterManager */
Chris@0:     protected $formatterManager;
Chris@17:     /** @var PrepareFormatterOptions[] */
Chris@0:     protected $prepareOptionsList = [];
Chris@17:     /** @var boolean */
Chris@0:     protected $passExceptions;
Chris@17:     /** @var ResultWriter */
Chris@17:     protected $resultWriter;
Chris@17:     /** @var ParameterInjection */
Chris@17:     protected $parameterInjection;
Chris@0: 
Chris@0:     public function __construct(HookManager $hookManager)
Chris@0:     {
Chris@0:         $this->hookManager = $hookManager;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Return the hook manager
Chris@0:      * @return HookManager
Chris@0:      */
Chris@0:     public function hookManager()
Chris@0:     {
Chris@0:         return $this->hookManager;
Chris@0:     }
Chris@0: 
Chris@17:     public function resultWriter()
Chris@17:     {
Chris@17:         if (!$this->resultWriter) {
Chris@17:             $this->setResultWriter(new ResultWriter());
Chris@17:         }
Chris@17:         return $this->resultWriter;
Chris@17:     }
Chris@17: 
Chris@17:     public function setResultWriter($resultWriter)
Chris@17:     {
Chris@17:         $this->resultWriter = $resultWriter;
Chris@17:     }
Chris@17: 
Chris@17:     public function parameterInjection()
Chris@17:     {
Chris@17:         if (!$this->parameterInjection) {
Chris@17:             $this->setParameterInjection(new ParameterInjection());
Chris@17:         }
Chris@17:         return $this->parameterInjection;
Chris@17:     }
Chris@17: 
Chris@17:     public function setParameterInjection($parameterInjection)
Chris@17:     {
Chris@17:         $this->parameterInjection = $parameterInjection;
Chris@17:     }
Chris@17: 
Chris@0:     public function addPrepareFormatter(PrepareFormatter $preparer)
Chris@0:     {
Chris@0:         $this->prepareOptionsList[] = $preparer;
Chris@0:     }
Chris@0: 
Chris@0:     public function setFormatterManager(FormatterManager $formatterManager)
Chris@0:     {
Chris@0:         $this->formatterManager = $formatterManager;
Chris@17:         $this->resultWriter()->setFormatterManager($formatterManager);
Chris@0:         return $this;
Chris@0:     }
Chris@0: 
Chris@0:     public function setDisplayErrorFunction(callable $fn)
Chris@0:     {
Chris@17:         $this->resultWriter()->setDisplayErrorFunction($fn);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set a mode to make the annotated command library re-throw
Chris@0:      * any exception that it catches while processing a command.
Chris@0:      *
Chris@0:      * The default behavior in the current (2.x) branch is to catch
Chris@0:      * the exception and replace it with a CommandError object that
Chris@0:      * may be processed by the normal output processing passthrough.
Chris@0:      *
Chris@0:      * In the 3.x branch, exceptions will never be caught; they will
Chris@0:      * be passed through, as if setPassExceptions(true) were called.
Chris@0:      * This is the recommended behavior.
Chris@0:      */
Chris@0:     public function setPassExceptions($passExceptions)
Chris@0:     {
Chris@0:         $this->passExceptions = $passExceptions;
Chris@0:         return $this;
Chris@0:     }
Chris@0: 
Chris@0:     public function commandErrorForException(\Exception $e)
Chris@0:     {
Chris@0:         if ($this->passExceptions) {
Chris@0:             throw $e;
Chris@0:         }
Chris@0:         return new CommandError($e->getMessage(), $e->getCode());
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Return the formatter manager
Chris@0:      * @return FormatterManager
Chris@0:      */
Chris@0:     public function formatterManager()
Chris@0:     {
Chris@0:         return $this->formatterManager;
Chris@0:     }
Chris@0: 
Chris@0:     public function initializeHook(
Chris@0:         InputInterface $input,
Chris@0:         $names,
Chris@0:         AnnotationData $annotationData
Chris@0:     ) {
Chris@0:         $initializeDispatcher = new InitializeHookDispatcher($this->hookManager(), $names);
Chris@0:         return $initializeDispatcher->initialize($input, $annotationData);
Chris@0:     }
Chris@0: 
Chris@0:     public function optionsHook(
Chris@0:         AnnotatedCommand $command,
Chris@0:         $names,
Chris@0:         AnnotationData $annotationData
Chris@0:     ) {
Chris@0:         $optionsDispatcher = new OptionsHookDispatcher($this->hookManager(), $names);
Chris@0:         $optionsDispatcher->getOptions($command, $annotationData);
Chris@0:     }
Chris@0: 
Chris@0:     public function interact(
Chris@0:         InputInterface $input,
Chris@0:         OutputInterface $output,
Chris@0:         $names,
Chris@0:         AnnotationData $annotationData
Chris@0:     ) {
Chris@0:         $interactDispatcher = new InteractHookDispatcher($this->hookManager(), $names);
Chris@0:         return $interactDispatcher->interact($input, $output, $annotationData);
Chris@0:     }
Chris@0: 
Chris@0:     public function process(
Chris@0:         OutputInterface $output,
Chris@0:         $names,
Chris@0:         $commandCallback,
Chris@0:         CommandData $commandData
Chris@0:     ) {
Chris@0:         $result = [];
Chris@0:         try {
Chris@0:             $result = $this->validateRunAndAlter(
Chris@0:                 $names,
Chris@0:                 $commandCallback,
Chris@0:                 $commandData
Chris@0:             );
Chris@0:             return $this->handleResults($output, $names, $result, $commandData);
Chris@0:         } catch (\Exception $e) {
Chris@0:             $result = $this->commandErrorForException($e);
Chris@0:             return $this->handleResults($output, $names, $result, $commandData);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     public function validateRunAndAlter(
Chris@0:         $names,
Chris@0:         $commandCallback,
Chris@0:         CommandData $commandData
Chris@0:     ) {
Chris@0:         // Validators return any object to signal a validation error;
Chris@0:         // if the return an array, it replaces the arguments.
Chris@0:         $validateDispatcher = new ValidateHookDispatcher($this->hookManager(), $names);
Chris@0:         $validated = $validateDispatcher->validate($commandData);
Chris@0:         if (is_object($validated)) {
Chris@0:             return $validated;
Chris@0:         }
Chris@0: 
Chris@17:         // Once we have validated the optins, create the formatter options.
Chris@17:         $this->createFormatterOptions($commandData);
Chris@17: 
Chris@0:         $replaceDispatcher = new ReplaceCommandHookDispatcher($this->hookManager(), $names);
Chris@0:         if ($this->logger) {
Chris@0:             $replaceDispatcher->setLogger($this->logger);
Chris@0:         }
Chris@0:         if ($replaceDispatcher->hasReplaceCommandHook()) {
Chris@0:             $commandCallback = $replaceDispatcher->getReplacementCommand($commandData);
Chris@0:         }
Chris@0: 
Chris@0:         // Run the command, alter the results, and then handle output and status
Chris@0:         $result = $this->runCommandCallback($commandCallback, $commandData);
Chris@0:         return $this->processResults($names, $result, $commandData);
Chris@0:     }
Chris@0: 
Chris@0:     public function processResults($names, $result, CommandData $commandData)
Chris@0:     {
Chris@0:         $processDispatcher = new ProcessResultHookDispatcher($this->hookManager(), $names);
Chris@0:         return $processDispatcher->process($result, $commandData);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Create a FormatterOptions object for use in writing the formatted output.
Chris@0:      * @param CommandData $commandData
Chris@0:      * @return FormatterOptions
Chris@0:      */
Chris@0:     protected function createFormatterOptions($commandData)
Chris@0:     {
Chris@0:         $options = $commandData->input()->getOptions();
Chris@0:         $formatterOptions = new FormatterOptions($commandData->annotationData()->getArrayCopy(), $options);
Chris@0:         foreach ($this->prepareOptionsList as $preparer) {
Chris@0:             $preparer->prepare($commandData, $formatterOptions);
Chris@0:         }
Chris@17:         $commandData->setFormatterOptions($formatterOptions);
Chris@0:         return $formatterOptions;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@17:      * Handle the result output and status code calculation.
Chris@0:      */
Chris@17:     public function handleResults(OutputInterface $output, $names, $result, CommandData $commandData)
Chris@0:     {
Chris@17:         $statusCodeDispatcher = new StatusDeterminerHookDispatcher($this->hookManager(), $names);
Chris@17:         $extractDispatcher = new ExtracterHookDispatcher($this->hookManager(), $names);
Chris@17: 
Chris@17:         return $this->resultWriter()->handle($output, $result, $commandData, $statusCodeDispatcher, $extractDispatcher);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@17:      * Run the main command callback
Chris@0:      */
Chris@17:     protected function runCommandCallback($commandCallback, CommandData $commandData)
Chris@17:     {
Chris@17:         $result = false;
Chris@17:         try {
Chris@17:             $args = $this->parameterInjection()->args($commandData);
Chris@17:             $result = call_user_func_array($commandCallback, $args);
Chris@17:         } catch (\Exception $e) {
Chris@17:             $result = $this->commandErrorForException($e);
Chris@0:         }
Chris@17:         return $result;
Chris@0:     }
Chris@0: 
Chris@17:     public function injectIntoCommandData($commandData, $injectedClasses)
Chris@0:     {
Chris@17:         $this->parameterInjection()->injectIntoCommandData($commandData, $injectedClasses);
Chris@0:     }
Chris@0: }