[Console] do not leak hidden commands

m-vo · m-vo · commit 2bb40fe6dfa8 · 2019-09-01T21:12:40.000+02:00
Hidden commands...
  - should only be accepted if their names match exactly.
  - should not appear in suggestion lists.
  - should not interfere with abbreviating other commands (that would
    otherwise not be distinct).
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -529,6 +529,10 @@ public function getNamespaces()
     {
         $namespaces = [];
         foreach ($this->all() as $command) {
+            if ($command->isHidden()) {
+                continue;
+            }
+
             $namespaces = array_merge($namespaces, $this->extractAllNamespaces($command->getName()));
 
             foreach ($command->getAliases() as $alias) {
@@ -612,6 +616,12 @@ public function find($name)
             $commands = preg_grep('{^'.$expr.'}i', $allCommands);
         }
 
+        // hidden commands can only be matched exactly and shall not appear otherwise
+        $hiddenCommands = $this->removeHiddenCommands($commands);
+        if (isset($hiddenCommands[$name])) {
+            return $hiddenCommands[$name];
+        }
+
         // if no commands matched or we just matched namespaces
         if (empty($commands) || \count(preg_grep('{^'.$expr.'$}i', $commands)) < 1) {
             if (false !== $pos = strrpos($name, ':')) {
@@ -622,6 +632,8 @@ public function find($name)
             $message = sprintf('Command "%s" is not defined.', $name);
 
             if ($alternatives = $this->findAlternatives($name, $allCommands)) {
+                $this->removeHiddenCommands($alternatives);
+
                 if (1 == \count($alternatives)) {
                     $message .= "\n\nDid you mean this?\n    ";
                 } else {
@@ -1155,6 +1167,38 @@ private function findAlternatives($name, $collection)
         return array_keys($alternatives);
     }
 
+    /**
+     * Removes hidden commands commands from a given array of command names and
+     * returns them as Command instances.
+     *
+     * @param string[] $commandNames The command names to filter
+     *
+     * @return Command[] An associative array of removed commands with
+     *                   command names and command aliases being the keys
+     *
+     * @internal
+     */
+    private function removeHiddenCommands(array &$commandNames)
+    {
+        $hiddenCommands = [];
+        foreach ($commandNames as $key => $commandName) {
+            $command = $this->has($commandName) ? $this->commands[$commandName] : $this->commandLoader->get($commandName);
+
+            if (!$command->isHidden()) {
+                continue;
+            }
+
+            $hiddenCommands[$commandName] = $command;
+            foreach ($command->getAliases() as $alias) {
+                $hiddenCommands[$alias] = $command;
+            }
+
+            unset($commandNames[$key]);
+        }
+
+        return $hiddenCommands;
+    }
+
     /**
      * Sets the default Command name.
      *
