Autocompletion for the BASH

Implemented in a dedicated Icinga Web CLI command, bash config snippet
is therefore pretty compact.

fixes #5520

application/clicommands/AutocompleteCommand.php

@@ -0,0 +1,126 @@
+<?php
+
+namespace Icinga\Clicommands;
+
+use Icinga\Cli\Command;
+use Icinga\Cli\Loader;
+use Icinga\Cli\Documentation;
+
+/**
+ * Autocomplete for modules, commands and actions
+ *
+ * The autocomplete command shows help for a given command, module and also for a
+ * given module's command or a specific command's action.
+ *
+ * Usage: icingaweb autocomplete [<module>] [<command> [<action>]]
+ */
+class AutocompleteCommand extends Command
+{
+    protected $defaultActionName = 'complete';
+
+    protected function suggest($suggestions)
+    {
+        if ($suggestions) {
+            $key = array_search('autocomplete', $suggestions);
+            if ($key !== false){
+                unset($suggestions[$key]);
+            }
+            echo implode("\n", $suggestions)
+           // . serialize($GLOBALS['argv'])
+            . "\n";
+        }
+    }
+
+    /**
+     * Show help for modules, commands and actions [default]
+     *
+     * The help command shows help for a given command, module and also for a
+     * given module's command or a specific command's action.
+     *
+     * Usage: icingaweb autocomplete [<module>] [<command> [<action>]]
+     */
+    public function completeAction()
+    {
+        // TODO: 
+        $module  = null;
+        $command = null;
+        $action  = null;
+
+        $loader = new Loader($this->app);
+        $params = $this->params;
+        $bare_params = $GLOBALS['argv'];
+        $cword = (int) $params->shift('autoindex');
+
+        $search_word = $bare_params[$cword];
+        if ($search_word === '--') {
+            // TODO: Unfinished, completion missing
+            return $this->suggest(array(
+                '--verbose',
+                '--help',
+                '--debug'
+            ));
+        }
+
+        $search = $params->shift();
+        // TODO: 
+        if (! $search) {
+            return $this->suggest(
+                array_merge($loader->listCommands(), $loader->listModules())
+            );
+        }
+        $found = $loader->resolveName($search);
+        if ($found) {
+            // Do not return suggestions if we are already on the next word:
+            if ($bare_params[$cword] === $search) {
+                return $this->suggest(array($found));
+            }
+        } else {
+            return $this->suggest($loader->getLastSuggestions());
+        }
+
+        $obj = null;
+        if ($loader->hasCommand($found)) {
+            $command = $found;
+            $obj = $loader->getCommandInstance($command);
+        } elseif ($loader->hasModule($found)) {
+            $module = $found;
+            $search = $params->shift();
+            if (! $search) {
+                return $this->suggest(
+                    $loader->listModuleCommands($module)
+                );
+            }
+            $command = $loader->resolveModuleCommandName($found, $search);
+            if ($command) {
+                // Do not return suggestions if we are already on the next word:
+                if ($bare_params[$cword] === $search) {
+                    return $this->suggest(array($command));
+                }
+                $obj = $loader->getModuleCommandInstance(
+                    $module,
+                    $command
+                );
+            } else {
+                return $this->suggest($loader->getLastSuggestions());
+            }
+        }
+
+        if ($obj !== null) {
+            $search = $params->shift();
+            if (! $search) {
+                return $this->suggest($obj->listActions());
+            }
+            $action = $loader->resolveObjectActionName(
+                $obj,
+                $search
+            );
+            if ($action) {
+                if ($bare_params[$cword] === $search) {
+                    return $this->suggest(array($action));
+                }
+            } else {
+                return $this->suggest($loader->getLastSuggestions());
+            }
+        }
+    }
+}

etc/bash_completion.d/icingaweb

@@ -0,0 +1,13 @@
+
+_icingaweb_completion()
+{
+  local cur opts
+  opts="${COMP_WORDS[*]}"
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  COMPREPLY=($($opts --autocomplete --autoindex $COMP_CWORD))
+  return 0
+}
+
+complete -F _icingaweb_completion icingaweb
+
+

library/Icinga/Application/Cli.php

@@ -127,6 +127,9 @@ class Cli extends ApplicationBootstrap
         if ($this->params->shift('help')) {
             $this->params->unshift('help');
         }
+        if ($this->params->shift('autocomplete')) {
+            $this->params->unshift('autocomplete');
+        }
         $watch = $this->params->shift('watch');
         if ($watch === true) {
             $watch = 5;

library/Icinga/Cli/Loader.php

@@ -152,6 +152,11 @@ class Loader
         return $this->moduleInstances[$module][$command];
     }
 
+    public function getLastSuggestions()
+    {
+        return $this->lastSuggestions;
+    }
+
     public function showLastSuggestions()
     {
         if (! empty($this->lastSuggestions)) {