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

   1 /******************************************************************************
   2  * Icinga 2                                                                   *
   3  * Copyright (C) 2012-2018 Icinga Development Team (https://www.icinga.com/)  *
   4  *                                                                            *
   5  * This program is free software; you can redistribute it and/or              *
   6  * modify it under the terms of the GNU General Public License                *
   7  * as published by the Free Software Foundation; either version 2             *
   8  * of the License, or (at your option) any later version.                     *
   9  *                                                                            *
  10  * This program is distributed in the hope that it will be useful,            *
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
  13  * GNU General Public License for more details.                               *
  14  *                                                                            *
  15  * You should have received a copy of the GNU General Public License          *
  16  * along with this program; if not, write to the Free Software Foundation     *
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
  18  ******************************************************************************/
  19
  20 #ifndef MACROPROCESSOR_H
  21 #define MACROPROCESSOR_H
  22
  23 #include "icinga/i2-icinga.hpp"
  24 #include "icinga/checkable.hpp"
  25 #include "base/value.hpp"
  26 #include <vector>
  27
  28 namespace icinga
  29 {
  30
  31 /**
  32  * Resolves macros.
  33  *
  34  * @ingroup icinga
  35  */
  36 class MacroProcessor
  37 {
  38 public:
  39         typedef std::function<Value (const Value&)> EscapeCallback;
  40         typedef std::pair<String, Object::Ptr> ResolverSpec;
  41         typedef std::vector<ResolverSpec> ResolverList;
  42
  43         static Value ResolveMacros(const Value& str, const ResolverList& resolvers,
  44                 const CheckResult::Ptr& cr = nullptr, String *missingMacro = nullptr,
  45                 const EscapeCallback& escapeFn = EscapeCallback(),
  46                 const Dictionary::Ptr& resolvedMacros = nullptr,
  47                 bool useResolvedMacros = false, int recursionLevel = 0);
  48
  49         static Value ResolveArguments(const Value& command, const Dictionary::Ptr& arguments,
  50                 const MacroProcessor::ResolverList& resolvers, const CheckResult::Ptr& cr,
  51                 const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int recursionLevel = 0);
  52
  53         static bool ValidateMacroString(const String& macro);
  54         static void ValidateCustomVars(const ConfigObject::Ptr& object, const Dictionary::Ptr& value);
  55
  56 private:
  57         MacroProcessor();
  58
  59         static bool ResolveMacro(const String& macro, const ResolverList& resolvers,
  60                 const CheckResult::Ptr& cr, Value *result, bool *recursive_macro);
  61         static Value InternalResolveMacros(const String& str,
  62                 const ResolverList& resolvers, const CheckResult::Ptr& cr,
  63                 String *missingMacro, const EscapeCallback& escapeFn,
  64                 const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros,
  65                 int recursionLevel = 0);
  66         static Value EvaluateFunction(const Function::Ptr& func, const ResolverList& resolvers,
  67                 const CheckResult::Ptr& cr, const MacroProcessor::EscapeCallback& escapeFn,
  68                 const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int recursionLevel);
  69
  70         static void AddArgumentHelper(const Array::Ptr& args, const String& key, const String& value,
  71                 bool add_key, bool add_value);
  72         static Value EscapeMacroShellArg(const Value& value);
  73
  74 };
  75
  76 }
  77
  78 #endif /* MACROPROCESSOR_H */