diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 11:32:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 11:32:39 +0000 |
commit | 56ae875861ab260b80a030f50c4aff9f9dc8fff0 (patch) | |
tree | 531412110fc901a5918c7f7442202804a83cada9 /lib/icinga/macroprocessor.hpp | |
parent | Initial commit. (diff) | |
download | icinga2-56ae875861ab260b80a030f50c4aff9f9dc8fff0.tar.xz icinga2-56ae875861ab260b80a030f50c4aff9f9dc8fff0.zip |
Adding upstream version 2.14.2.upstream/2.14.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'lib/icinga/macroprocessor.hpp')
-rw-r--r-- | lib/icinga/macroprocessor.hpp | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/lib/icinga/macroprocessor.hpp b/lib/icinga/macroprocessor.hpp new file mode 100644 index 0000000..7e74821 --- /dev/null +++ b/lib/icinga/macroprocessor.hpp @@ -0,0 +1,75 @@ +/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */ + +#ifndef MACROPROCESSOR_H +#define MACROPROCESSOR_H + +#include "icinga/i2-icinga.hpp" +#include "icinga/checkable.hpp" +#include "base/value.hpp" +#include <vector> +#include <utility> + +namespace icinga +{ + +/** + * Resolves macros. + * + * @ingroup icinga + */ +class MacroProcessor +{ +public: + struct ResolverSpec + { + String Name; + Object::Ptr Obj; + + // Whether to resolve not only e.g. $host.address$, but also just $address$ + bool ResolveShortMacros; + + inline ResolverSpec(String name, Object::Ptr obj, bool resolveShortMacros = true) + : Name(std::move(name)), Obj(std::move(obj)), ResolveShortMacros(resolveShortMacros) + { + } + }; + + typedef std::function<Value (const Value&)> EscapeCallback; + typedef std::vector<ResolverSpec> ResolverList; + + static Value ResolveMacros(const Value& str, const ResolverList& resolvers, + const CheckResult::Ptr& cr = nullptr, String *missingMacro = nullptr, + const EscapeCallback& escapeFn = EscapeCallback(), + const Dictionary::Ptr& resolvedMacros = nullptr, + bool useResolvedMacros = false, int recursionLevel = 0); + + static Value ResolveArguments(const Value& command, const Dictionary::Ptr& arguments, + const MacroProcessor::ResolverList& resolvers, const CheckResult::Ptr& cr, + const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int recursionLevel = 0); + + static bool ValidateMacroString(const String& macro); + static void ValidateCustomVars(const ConfigObject::Ptr& object, const Dictionary::Ptr& value); + +private: + MacroProcessor(); + + static bool ResolveMacro(const String& macro, const ResolverList& resolvers, + const CheckResult::Ptr& cr, Value *result, bool *recursive_macro); + static Value InternalResolveMacros(const String& str, + const ResolverList& resolvers, const CheckResult::Ptr& cr, + String *missingMacro, const EscapeCallback& escapeFn, + const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, + int recursionLevel = 0); + static Value EvaluateFunction(const Function::Ptr& func, const ResolverList& resolvers, + const CheckResult::Ptr& cr, const MacroProcessor::EscapeCallback& escapeFn, + const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int recursionLevel); + + static void AddArgumentHelper(const Array::Ptr& args, const String& key, const String& value, + bool add_key, bool add_value, const Value& separator); + static Value EscapeMacroShellArg(const Value& value); + +}; + +} + +#endif /* MACROPROCESSOR_H */ |