Adding upstream version 2.12.1.upstream/2.12.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 216 insertions, 0 deletions

diff --git a/library/Icinga/Cli/Command.php b/library/Icinga/Cli/Command.php
new file mode 100644
index 0000000..7fd5f87
--- /dev/null
+++ b/library/Icinga/Cli/Command.php
@@ -0,0 +1,216 @@
+<?php
+/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Cli;
+
+use Icinga\Application\ApplicationBootstrap as App;
+use Icinga\Application\Config;
+use Icinga\Application\Logger;
+use Icinga\Exception\IcingaException;
+use Icinga\Exception\NotReadableError;
+use ipl\I18n\Translation;
+
+abstract class Command
+{
+    use Translation;
+
+    protected $app;
+    protected $docs;
+
+    /**
+     * @var Params
+     */
+    protected $params;
+    protected $screen;
+
+    /**
+     * Whether the --verbose switch is given and thus the set log level INFO is
+     *
+     * @var bool
+     */
+    protected $isVerbose;
+
+    /**
+     * Whether the --debug switch is given and thus the set log level DEBUG is
+     *
+     * @var bool
+     */
+    protected $isDebugging;
+
+    protected $moduleName;
+    protected $commandName;
+    protected $actionName;
+
+    protected $config;
+
+    protected $configs;
+
+    protected $defaultActionName = 'default';
+
+    /** @var bool Whether to automatically load enabled modules */
+    protected $loadEnabledModules = true;
+
+    /** @var bool Whether to enable trace for the CLI commands */
+    protected $trace = false;
+
+    public function __construct(App $app, $moduleName, $commandName, $actionName, $initialize = true)
+    {
+        $this->app = $app;
+        $this->moduleName   = $moduleName;
+        $this->commandName  = $commandName;
+        $this->actionName   = $actionName;
+        $this->params       = $app->getParams();
+        $this->screen       = Screen::instance();
+        $this->trace        = $this->params->shift('trace', false);
+        $this->isVerbose    = $this->params->shift('verbose', false);
+        $this->isDebugging  = $this->params->shift('debug', false);
+        $this->configs      = [];
+
+        $this->translationDomain = $moduleName ?: 'icinga';
+
+        if ($this->loadEnabledModules) {
+            try {
+                $app->getModuleManager()->loadEnabledModules();
+            } catch (NotReadableError $e) {
+                Logger::error(new IcingaException('Cannot load enabled modules. An exception was thrown:', $e));
+            }
+        }
+
+        if ($initialize) {
+            $this->init();
+        }
+    }
+
+    public function Config($file = null)
+    {
+        if ($this->isModule()) {
+            return $this->getModuleConfig($file);
+        } else {
+            return $this->getMainConfig($file);
+        }
+    }
+
+    private function getModuleConfig($file = null)
+    {
+        if ($file === null) {
+            if ($this->config === null) {
+                $this->config = Config::module($this->moduleName);
+            }
+            return $this->config;
+        } else {
+            if (! array_key_exists($file, $this->configs)) {
+                $this->configs[$file] = Config::module($this->moduleName, $file);
+            }
+            return $this->configs[$file];
+        }
+    }
+
+    private function getMainConfig($file = null)
+    {
+        if ($file === null) {
+            if ($this->config === null) {
+                $this->config = Config::app();
+            }
+            return $this->config;
+        } else {
+            if (! array_key_exists($file, $this->configs)) {
+                $this->configs[$file] = Config::app($file);
+            }
+            return $this->configs[$file];
+        }
+        return $this->config;
+    }
+
+    public function isModule()
+    {
+        return substr(get_class($this), 0, 14) === 'Icinga\\Module\\';
+    }
+
+    public function setParams(Params $params)
+    {
+        $this->params = $params;
+    }
+
+    public function hasRemainingParams()
+    {
+        return $this->params->count() > 0;
+    }
+
+    public function showTrace()
+    {
+        return $this->trace;
+    }
+
+    /**
+     * @param $msg
+     *
+     * @throws IcingaException
+     */
+    public function fail($msg)
+    {
+        throw new IcingaException('%s', $msg);
+    }
+
+    public function getDefaultActionName()
+    {
+        return $this->defaultActionName;
+    }
+
+    /**
+     * Get {@link moduleName}
+     *
+     * @return string
+     */
+    public function getModuleName()
+    {
+        return $this->moduleName;
+    }
+
+    public function hasDefaultActionName()
+    {
+        return $this->hasActionName($this->defaultActionName);
+    }
+
+    public function hasActionName($name)
+    {
+        $actions = $this->listActions();
+        return in_array($name, $actions);
+    }
+
+    public function listActions()
+    {
+        $actions = array();
+        foreach (get_class_methods($this) as $method) {
+            if (preg_match('~^([A-Za-z0-9]+)Action$~', $method, $m)) {
+                $actions[] = $m[1];
+            }
+        }
+        sort($actions);
+        return $actions;
+    }
+
+    public function docs()
+    {
+        if ($this->docs === null) {
+            $this->docs = new Documentation($this->app);
+        }
+        return $this->docs;
+    }
+
+    public function showUsage($action = null)
+    {
+        if ($action === null) {
+            $action = $this->actionName;
+        }
+        echo $this->docs()->usage(
+            $this->moduleName,
+            $this->commandName,
+            $action
+        );
+        return false;
+    }
+
+    public function init()
+    {
+    }
+}