granicus.if.org Git - icinga2/blob - lib/icinga/macroprocessor.hpp

   1 /* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
   2
   3 #ifndef MACROPROCESSOR_H
   4 #define MACROPROCESSOR_H
   5
   6 #include "icinga/i2-icinga.hpp"
   7 #include "icinga/checkable.hpp"
   8 #include "base/value.hpp"
   9 #include <vector>
  10
  11 namespace icinga
  12 {
  13
  14 /**
  15  * Resolves macros.
  16  *
  17  * @ingroup icinga
  18  */
  19 class MacroProcessor
  20 {
  21 public:
  22         typedef std::function<Value (const Value&)> EscapeCallback;
  23         typedef std::pair<String, Object::Ptr> ResolverSpec;
  24         typedef std::vector<ResolverSpec> ResolverList;
  25
  26         static Value ResolveMacros(const Value& str, const ResolverList& resolvers,
  27                 const CheckResult::Ptr& cr = nullptr, String *missingMacro = nullptr,
  28                 const EscapeCallback& escapeFn = EscapeCallback(),
  29                 const Dictionary::Ptr& resolvedMacros = nullptr,
  30                 bool useResolvedMacros = false, int recursionLevel = 0);
  31
  32         static Value ResolveArguments(const Value& command, const Dictionary::Ptr& arguments,
  33                 const MacroProcessor::ResolverList& resolvers, const CheckResult::Ptr& cr,
  34                 const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int recursionLevel = 0);
  35
  36         static bool ValidateMacroString(const String& macro);
  37         static void ValidateCustomVars(const ConfigObject::Ptr& object, const Dictionary::Ptr& value);
  38
  39 private:
  40         MacroProcessor();
  41
  42         static bool ResolveMacro(const String& macro, const ResolverList& resolvers,
  43                 const CheckResult::Ptr& cr, Value *result, bool *recursive_macro);
  44         static Value InternalResolveMacros(const String& str,
  45                 const ResolverList& resolvers, const CheckResult::Ptr& cr,
  46                 String *missingMacro, const EscapeCallback& escapeFn,
  47                 const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros,
  48                 int recursionLevel = 0);
  49         static Value EvaluateFunction(const Function::Ptr& func, const ResolverList& resolvers,
  50                 const CheckResult::Ptr& cr, const MacroProcessor::EscapeCallback& escapeFn,
  51                 const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int recursionLevel);
  52
  53         static void AddArgumentHelper(const Array::Ptr& args, const String& key, const String& value,
  54                 bool add_key, bool add_value);
  55         static Value EscapeMacroShellArg(const Value& value);
  56
  57 };
  58
  59 }
  60
  61 #endif /* MACROPROCESSOR_H */