]> granicus.if.org Git - icinga2/commitdiff
CLI: Add feature command (list, enable, disable)
authorMichael Friedrich <michael.friedrich@netways.de>
Mon, 13 Oct 2014 16:09:58 +0000 (18:09 +0200)
committerMichael Friedrich <michael.friedrich@netways.de>
Tue, 14 Oct 2014 11:27:30 +0000 (13:27 +0200)
fixes #7250

lib/cli/CMakeLists.txt
lib/cli/featuredisablecommand.cpp [new file with mode: 0644]
lib/cli/featuredisablecommand.hpp [new file with mode: 0644]
lib/cli/featureenablecommand.cpp [new file with mode: 0644]
lib/cli/featureenablecommand.hpp [new file with mode: 0644]
lib/cli/featurelistcommand.cpp [new file with mode: 0644]
lib/cli/featurelistcommand.hpp [new file with mode: 0644]

index d51b0a35290175310c9e453734da8d78eed13100..606964a656cd10f7d1a1a9c85334bcb08a64eeed 100644 (file)
@@ -16,7 +16,9 @@
 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 
 set(cli_SOURCES
-  pkinewcacommand.cpp pkinewcertcommand.cpp daemoncommand.cpp
+  featureenablecommand.cpp featuredisablecommand.cpp featurelistcommand.cpp
+  pkinewcacommand.cpp pkinewcertcommand.cpp
+  daemoncommand.cpp
 )
 
 if(ICINGA2_UNITY_BUILD)
@@ -38,5 +40,3 @@ install(
   RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR}
   LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/icinga2
 )
-
-
diff --git a/lib/cli/featuredisablecommand.cpp b/lib/cli/featuredisablecommand.cpp
new file mode 100644 (file)
index 0000000..bf20fac
--- /dev/null
@@ -0,0 +1,104 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org)    *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
+#include "cli/featuredisablecommand.hpp"
+#include "base/logger_fwd.hpp"
+#include "base/clicommand.hpp"
+#include "base/application.hpp"
+#include "base/convert.hpp"
+#include <boost/foreach.hpp>
+#include <boost/algorithm/string/join.hpp>
+#include <fstream>
+#include <vector>
+#include <string>
+#include <unistd.h>
+
+using namespace icinga;
+namespace po = boost::program_options;
+
+REGISTER_CLICOMMAND("feature/disable", FeatureDisableCommand);
+
+String FeatureDisableCommand::GetDescription(void) const
+{
+       return "Disables specified Icinga 2 feature.";
+}
+
+String FeatureDisableCommand::GetShortDescription(void) const
+{
+       return "disables specified feature";
+}
+
+void FeatureDisableCommand::InitParameters(boost::program_options::options_description& visibleDesc,
+    boost::program_options::options_description& hiddenDesc) const
+{
+        /* Command doesn't support any parameters. */
+}
+
+/**
+ * The entry point for the "feature disable" CLI command.
+ *
+ * @returns An exit status.
+ */
+int FeatureDisableCommand::Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const
+{
+#ifdef _WIN32
+       //TODO: Add Windows support
+        Log(LogInformation, "cli", "This command is not available on Windows.");
+#else
+        String features_enabled_dir = Application::GetSysconfDir() + "/icinga2/features-enabled";
+
+        if (ap.empty()) {
+                Log(LogCritical, "cli", "Cannot disable feature(s). Name(s) are missing!");
+                return 0;
+        }
+
+        if (!Utility::PathExists(features_enabled_dir) ) {
+                Log(LogCritical, "cli", "Cannot disable features. Path '" + features_enabled_dir + "' does not exist.");
+                return 0;
+        }
+
+        std::vector<std::string> errors;
+
+        BOOST_FOREACH(const String& feature, ap) {
+                String target = features_enabled_dir + "/" + feature + ".conf";
+
+                if (!Utility::PathExists(target) ) {
+                        Log(LogCritical, "cli", "Cannot disable feature '" + feature + "'. Target file '" + target + "' does not exist.");
+                        errors.push_back(feature);
+                        continue;
+                }
+
+                if (unlink(target.CStr()) < 0) {
+                       Log(LogCritical, "cli", "Cannot disable feature '" + feature + "'. Unlinking target file '" + target +
+                           "' failed with error code " + Convert::ToString(errno) + ", \"" + Utility::FormatErrorNumber(errno) + "\".");
+               }
+
+                Log(LogInformation, "cli", "Disabling feature " + feature + " in '" + features_enabled_dir + "'.");
+        }
+
+        if (!errors.empty()) {
+                Log(LogCritical, "cli", "Cannot disable feature(s): " + boost::algorithm::join(errors, " "));
+               errors.clear();
+                return 1;
+        }
+
+#endif /* _WIN32 */
+
+       return 0;
+}
diff --git a/lib/cli/featuredisablecommand.hpp b/lib/cli/featuredisablecommand.hpp
new file mode 100644 (file)
index 0000000..fcb6f78
--- /dev/null
@@ -0,0 +1,49 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org)    *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
+#ifndef FEATUREDISABLECOMMAND_H
+#define FEATUREDISABLECOMMAND_H
+
+#include "base/qstring.hpp"
+#include "base/clicommand.hpp"
+
+namespace icinga
+{
+
+/**
+ * The "pki new-ca" command.
+ *
+ * @ingroup cli
+ */
+class FeatureDisableCommand : public CLICommand
+{
+public:
+       DECLARE_PTR_TYPEDEFS(FeatureDisableCommand);
+
+       virtual String GetDescription(void) const;
+       virtual String GetShortDescription(void) const;
+       virtual void InitParameters(boost::program_options::options_description& visibleDesc,
+           boost::program_options::options_description& hiddenDesc) const;
+       virtual int Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const;
+
+};
+
+}
+
+#endif /* FEATUREDISABLECOMMAND_H */
diff --git a/lib/cli/featureenablecommand.cpp b/lib/cli/featureenablecommand.cpp
new file mode 100644 (file)
index 0000000..4e7774a
--- /dev/null
@@ -0,0 +1,117 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org)    *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
+#include "cli/featureenablecommand.hpp"
+#include "base/logger_fwd.hpp"
+#include "base/clicommand.hpp"
+#include "base/application.hpp"
+#include "base/convert.hpp"
+#include <boost/foreach.hpp>
+#include <boost/algorithm/string/join.hpp>
+#include <fstream>
+#include <vector>
+#include <string>
+#include <unistd.h>
+
+using namespace icinga;
+namespace po = boost::program_options;
+
+REGISTER_CLICOMMAND("feature/enable", FeatureEnableCommand);
+
+String FeatureEnableCommand::GetDescription(void) const
+{
+       return "Enables specified Icinga 2 feature.";
+}
+
+String FeatureEnableCommand::GetShortDescription(void) const
+{
+       return "enables specified feature";
+}
+
+void FeatureEnableCommand::InitParameters(boost::program_options::options_description& visibleDesc,
+    boost::program_options::options_description& hiddenDesc) const
+{
+        /* Command doesn't support any parameters. */
+}
+
+/**
+ * The entry point for the "feature enable" CLI command.
+ *
+ * @returns An exit status.
+ */
+int FeatureEnableCommand::Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const
+{
+#ifdef _WIN32
+       //TODO: Add Windows support
+        Log(LogInformation, "cli", "This command is not available on Windows.");
+#else
+       String features_available_dir = Application::GetSysconfDir() + "/icinga2/features-available";
+        String features_enabled_dir = Application::GetSysconfDir() + "/icinga2/features-enabled";
+
+        if (ap.empty()) {
+                Log(LogCritical, "cli", "Cannot enable feature(s). Name(s) are missing!");
+                return 0;
+        }
+
+        if (!Utility::PathExists(features_available_dir) ) {
+                Log(LogCritical, "cli", "Cannot parse available features. Path '" + features_available_dir + "' does not exist.");
+                return 0;
+        }
+
+        if (!Utility::PathExists(features_enabled_dir) ) {
+                Log(LogCritical, "cli", "Cannot enable features. Path '" + features_enabled_dir + "' does not exist.");
+                return 0;
+        }
+
+        std::vector<std::string> errors;
+
+        BOOST_FOREACH(const String& feature, ap) {
+                String source = features_available_dir + "/" + feature + ".conf";
+
+                if (!Utility::PathExists(source) ) {
+                        Log(LogCritical, "cli", "Cannot enable feature '" + feature + "'. Source file '" + source + "' does not exist.");
+                        errors.push_back(feature);
+                        continue;
+                }
+
+                String target = features_enabled_dir + "/" + feature + ".conf";
+
+                if (Utility::PathExists(target) ) {
+                        Log(LogWarning, "cli", "Feature '" + feature + "' already enabled.");
+                        continue;
+                }
+
+                if (symlink(source.CStr(), target.CStr()) < 0) {
+                       Log(LogCritical, "cli", "Cannot enable feature '" + feature + "'. Linking source '" + source + "' to target file '" + target +
+                           "' failed with error code " + Convert::ToString(errno) + ", \"" + Utility::FormatErrorNumber(errno) + "\".");
+               }
+
+                Log(LogInformation, "cli", "Enabling feature '" + feature + "' in '" + features_enabled_dir + "'.");
+        }
+
+        if (!errors.empty()) {
+                Log(LogCritical, "cli", "Cannot enable feature(s): " + boost::algorithm::join(errors, " "));
+               errors.clear();
+                return 1;
+        }
+
+#endif /* _WIN32 */
+
+       return 0;
+}
diff --git a/lib/cli/featureenablecommand.hpp b/lib/cli/featureenablecommand.hpp
new file mode 100644 (file)
index 0000000..982e9ce
--- /dev/null
@@ -0,0 +1,49 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org)    *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
+#ifndef FEATUREENABLECOMMAND_H
+#define FEATUREENABLECOMMAND_H
+
+#include "base/qstring.hpp"
+#include "base/clicommand.hpp"
+
+namespace icinga
+{
+
+/**
+ * The "pki new-ca" command.
+ *
+ * @ingroup cli
+ */
+class FeatureEnableCommand : public CLICommand
+{
+public:
+       DECLARE_PTR_TYPEDEFS(FeatureEnableCommand);
+
+       virtual String GetDescription(void) const;
+       virtual String GetShortDescription(void) const;
+       virtual void InitParameters(boost::program_options::options_description& visibleDesc,
+           boost::program_options::options_description& hiddenDesc) const;
+       virtual int Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const;
+
+};
+
+}
+
+#endif /* FEATUREENABLECOMMAND_H */
diff --git a/lib/cli/featurelistcommand.cpp b/lib/cli/featurelistcommand.cpp
new file mode 100644 (file)
index 0000000..9e2f59c
--- /dev/null
@@ -0,0 +1,96 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org)    *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
+#include "cli/featurelistcommand.hpp"
+#include "base/logger_fwd.hpp"
+#include "base/clicommand.hpp"
+#include "base/application.hpp"
+#include <boost/foreach.hpp>
+#include <boost/algorithm/string/join.hpp>
+#include <boost/algorithm/string/replace.hpp>
+#include <fstream>
+#include <vector>
+#include <string>
+#include <unistd.h>
+
+using namespace icinga;
+namespace po = boost::program_options;
+
+REGISTER_CLICOMMAND("feature/list", FeatureListCommand);
+
+String FeatureListCommand::GetDescription(void) const
+{
+       return "Lists all enabled Icinga 2 features.";
+}
+
+String FeatureListCommand::GetShortDescription(void) const
+{
+       return "lists all enabled features";
+}
+
+void FeatureListCommand::InitParameters(boost::program_options::options_description& visibleDesc,
+    boost::program_options::options_description& hiddenDesc) const
+{
+        /* Command doesn't support any parameters. */
+}
+
+/**
+ * The entry point for the "feature list" CLI command.
+ *
+ * @returns An exit status.
+ */
+int FeatureListCommand::Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const
+{
+        if (!ap.empty()) {
+                Log(LogWarning, "cli", "Ignoring parameters: " + boost::algorithm::join(ap, " "));
+        }
+
+#ifdef _WIN32
+       //TODO: Add Windows support
+        Log(LogInformation, "cli", "This command is not available on Windows.");
+#else
+       std::vector<String> enabled_features;
+       std::vector<String> available_features;
+
+       if (!Utility::Glob(Application::GetSysconfDir() + "/icinga2/features-enabled/*.conf",
+           boost::bind(&FeatureListCommand::CollectFeatures, _1, boost::ref(enabled_features)), GlobFile)) {
+               Log(LogCritical, "cli", "Cannot access path '" + Application::GetSysconfDir() + "/icinga2/features-enabled/'.");
+       }
+
+       if (!Utility::Glob(Application::GetSysconfDir() + "/icinga2/features-available/*.conf",
+           boost::bind(&FeatureListCommand::CollectFeatures, _1, boost::ref(available_features)), GlobFile)) {
+               Log(LogCritical, "cli", "Cannot access path '" + Application::GetSysconfDir() + "/icinga2/available-available/'.");
+       }
+
+       Log(LogInformation, "cli", "Available features: " + boost::algorithm::join(available_features, " "));
+       Log(LogInformation, "cli", "---");
+       Log(LogInformation, "cli", "Enabled features: " + boost::algorithm::join(enabled_features, " "));
+#endif /* _WIN32 */
+
+       return 0;
+}
+
+void FeatureListCommand::CollectFeatures(const String& feature_file, std::vector<String>& features)
+{
+       String feature = Utility::BaseName(feature_file);
+       boost::algorithm::replace_all(feature, ".conf", "");
+
+       Log(LogDebug, "cli", "Adding feature: " + feature);
+       features.push_back(feature);
+}
diff --git a/lib/cli/featurelistcommand.hpp b/lib/cli/featurelistcommand.hpp
new file mode 100644 (file)
index 0000000..5ebdedc
--- /dev/null
@@ -0,0 +1,52 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org)    *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
+#ifndef FEATURELISTCOMMAND_H
+#define FEATURELISTCOMMAND_H
+
+#include "base/qstring.hpp"
+#include "base/clicommand.hpp"
+
+namespace icinga
+{
+
+/**
+ * The "pki new-ca" command.
+ *
+ * @ingroup cli
+ */
+class FeatureListCommand : public CLICommand
+{
+public:
+       DECLARE_PTR_TYPEDEFS(FeatureListCommand);
+
+       virtual String GetDescription(void) const;
+       virtual String GetShortDescription(void) const;
+       virtual void InitParameters(boost::program_options::options_description& visibleDesc,
+           boost::program_options::options_description& hiddenDesc) const;
+       virtual int Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const;
+
+private:
+        static void CollectFeatures(const String& feature_file, std::vector<String>& features);
+
+};
+
+}
+
+#endif /* FEATURELISTCOMMAND_H */