From f94abac18f6f8e7495719675b004925a69c818d2 Mon Sep 17 00:00:00 2001 From: Michael Friedrich Date: Tue, 14 Oct 2014 16:53:40 +0200 Subject: [PATCH] CLI: Add object command (list) fixes #7251 --- lib/cli/CMakeLists.txt | 1 + lib/cli/featureenablecommand.hpp | 2 +- lib/cli/objectlistcommand.cpp | 239 +++++++++++++++++++++++++++++++ lib/cli/objectlistcommand.hpp | 60 ++++++++ 4 files changed, 301 insertions(+), 1 deletion(-) create mode 100644 lib/cli/objectlistcommand.cpp create mode 100644 lib/cli/objectlistcommand.hpp diff --git a/lib/cli/CMakeLists.txt b/lib/cli/CMakeLists.txt index 606964a65..a4c0a145f 100644 --- a/lib/cli/CMakeLists.txt +++ b/lib/cli/CMakeLists.txt @@ -17,6 +17,7 @@ set(cli_SOURCES featureenablecommand.cpp featuredisablecommand.cpp featurelistcommand.cpp + objectlistcommand.cpp pkinewcacommand.cpp pkinewcertcommand.cpp daemoncommand.cpp ) diff --git a/lib/cli/featureenablecommand.hpp b/lib/cli/featureenablecommand.hpp index 41f066660..529afba60 100644 --- a/lib/cli/featureenablecommand.hpp +++ b/lib/cli/featureenablecommand.hpp @@ -27,7 +27,7 @@ namespace icinga { /** - * The "pki new-ca" command. + * The "feature enable" command. * * @ingroup cli */ diff --git a/lib/cli/objectlistcommand.cpp b/lib/cli/objectlistcommand.cpp new file mode 100644 index 000000000..0f83cf316 --- /dev/null +++ b/lib/cli/objectlistcommand.cpp @@ -0,0 +1,239 @@ +/****************************************************************************** + * 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/objectlistcommand.hpp" +#include "base/logger_fwd.hpp" +#include "base/clicommand.hpp" +#include "base/application.hpp" +#include "base/convert.hpp" +#include "base/dynamicobject.hpp" +#include "base/dynamictype.hpp" +#include "base/serializer.hpp" +#include "base/netstring.hpp" +#include "base/stdiostream.hpp" +#include "base/debug.hpp" +#include "base/objectlock.hpp" +#include +#include +#include +#include +#include +#include +#include + +using namespace icinga; +namespace po = boost::program_options; + +REGISTER_CLICOMMAND("object/list", ObjectListCommand); + +String ObjectListCommand::GetDescription(void) const +{ + return "Lists all Icinga 2 objects."; +} + +String ObjectListCommand::GetShortDescription(void) const +{ + return "lists all objects"; +} + +void ObjectListCommand::InitParameters(boost::program_options::options_description& visibleDesc, + boost::program_options::options_description& hiddenDesc, + ArgumentCompletionDescription& argCompletionDesc) const +{ + /* Command doesn't support any parameters. */ + //TODO Add filter regex #7199 +} + +/** + * The entry point for the "object list" CLI command. + * + * @returns An exit status. + */ +int ObjectListCommand::Run(const boost::program_options::variables_map& vm, const std::vector& ap) const +{ + if (!ap.empty()) { + Log(LogWarning, "cli", "Ignoring parameters: " + boost::algorithm::join(ap, " ")); + } + + String objectfile = Application::GetObjectsPath(); + + if (!Utility::PathExists(objectfile)) { + Log(LogCritical, "cli", "Cannot parse objects file '" + Application::GetObjectsPath() + "'."); + Log(LogCritical, "cli", "Run 'icinga2 daemon -C' to validate config and generate the cache file."); + return 1; + } + + std::fstream fp; + fp.open(objectfile.CStr(), std::ios_base::in); + + StdioStream::Ptr sfp = make_shared(&fp, false); + unsigned long objects_count = 0; + std::map type_count; + + String message; + while (NetString::ReadStringFromStream(sfp, &message)) { + ReadObject(message, type_count); + objects_count++; + } + + sfp->Close(); + fp.close(); + + std::cout << FormatTypeCounts(type_count) << std::endl; + + Log(LogInformation, "cli", "Found " + Convert::ToString(objects_count) + " objects."); + + return 0; +} + +void ObjectListCommand::ReadObject(const String& message, std::map& type_count) +{ + Dictionary::Ptr object = JsonDeserialize(message); + + String type = object->Get("type"); + + type_count[type]++; + + String name = object->Get("name"); + bool abstract = object->Get("abstract"); + Dictionary::Ptr properties = object->Get("properties"); + Dictionary::Ptr debug_hints = object->Get("debug_hints"); + + std::ostringstream msgbuf; + + if (abstract) + msgbuf << "Template '"; + else + msgbuf << "Object '"; + + msgbuf << "\x1b[1;37m" << name << "\x1b[0m" << "'"; //light gray + msgbuf << " of type '" << "\x1b[1;34m" << type << "\x1b[0m" << "':\n"; //blue + + msgbuf << FormatProperties(properties, debug_hints, 2); + + std::cout << msgbuf.str() << "\n"; + +} + +String ObjectListCommand::FormatProperties(const Dictionary::Ptr& props, const Dictionary::Ptr& debug_hints, int indent) +{ + std::ostringstream msgbuf; + + /* get debug hint props */ + Dictionary::Ptr debug_hint_props; + if (debug_hints) + debug_hint_props = debug_hints->Get("properties"); + + int offset = 2; + + BOOST_FOREACH(const Dictionary::Pair& kv, props) { + Value key = kv.first; + Value val = kv.second; + + /* key & value */ + msgbuf << std::setw(indent) << " " << "* " << "\x1b[1;32m" << key << "\x1b[0m"; //green + + /* extract debug hints for key */ + Dictionary::Ptr debug_hints_fwd; + if (debug_hint_props) + debug_hints_fwd = debug_hint_props->Get(key); + + /* print dicts recursively */ + if (val.IsObjectType()) { + msgbuf << "\n"; + msgbuf << FormatHints(debug_hints_fwd, indent + offset); + msgbuf << FormatProperties(val, debug_hints_fwd, indent + offset); + } else { + msgbuf << " = " << FormatValue(val) << "\n"; + msgbuf << FormatHints(debug_hints_fwd, indent + offset); + } + } + + return msgbuf.str(); +} + +String ObjectListCommand::FormatHints(const Dictionary::Ptr& debug_hints, int indent) +{ + if (!debug_hints) + return String(); + + Array::Ptr messages = debug_hints->Get("messages"); + String hints; + + BOOST_FOREACH(const Value& msg, messages) { + hints += FormatHint(msg, indent); + } + + return hints; +} + +String ObjectListCommand::FormatHint(const Array::Ptr& msg, int indent) +{ + std::ostringstream msgbuf; + msgbuf << std::setw(indent) << " " << "\x1b[1;36m" "% " << msg->Get(0) << " modified in '" << msg->Get(1) << "', lines " + << msg->Get(2) << ":" << msg->Get(3) << "-" << msg->Get(4) << ":" << msg->Get(5) << "\x1b[0m" "\n"; //cyan + + return msgbuf.str(); +} + + +String ObjectListCommand::FormatTypeCounts(std::map type_count) +{ + std::ostringstream msgbuf; + + typedef std::map::value_type TypeCount; + + BOOST_FOREACH(TypeCount kv, type_count) { + msgbuf << "Found " << kv.second << " " << kv.first << " objects.\n"; + } + + return msgbuf.str(); +} + +String ObjectListCommand::FormatValue(const Value& val) +{ + if (val.IsObjectType()) + return "[ " + FormatArray(val) + " ]"; + + if (val.IsString()) + return "'" + Convert::ToString(val) + "'"; + + return Convert::ToString(val); +} + + +String ObjectListCommand::FormatArray(const Array::Ptr& arr) +{ + bool first = true; + String str; + + if (arr) { + ObjectLock olock(arr); + BOOST_FOREACH(const Value& value, arr) { + if (first) + first = false; + else + str += ", "; + + str += "'" + Convert::ToString(value) + "'"; + } + } + + return str; +} diff --git a/lib/cli/objectlistcommand.hpp b/lib/cli/objectlistcommand.hpp new file mode 100644 index 000000000..1de9ae304 --- /dev/null +++ b/lib/cli/objectlistcommand.hpp @@ -0,0 +1,60 @@ +/****************************************************************************** + * 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 OBJECTLISTCOMMAND_H +#define OBJECTLISTCOMMAND_H + +#include "base/qstring.hpp" +#include "base/dictionary.hpp" +#include "base/array.hpp" +#include "base/clicommand.hpp" + +namespace icinga +{ + +/** + * The "object list" command. + * + * @ingroup cli + */ +class ObjectListCommand : public CLICommand +{ +public: + DECLARE_PTR_TYPEDEFS(ObjectListCommand); + + 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, + ArgumentCompletionDescription& argCompletionDesc) const; + virtual int Run(const boost::program_options::variables_map& vm, const std::vector& ap) const; + +private: + static void ReadObject(const String& message, std::map& type_count); + static String FormatProperties(const Dictionary::Ptr& props, const Dictionary::Ptr& debug_hints, int indent = 0); + static String FormatHints(const Dictionary::Ptr& hints, int indent = 0); + static String FormatHint(const Array::Ptr& msg, int indent = 0); + static String FormatTypeCounts(std::map type_count); + static String FormatValue(const Value& val); + static String FormatArray(const Array::Ptr& arr); +}; + +} + +#endif /* OBJECTLISTCOMMAND_H */ -- 2.40.0