1 /******************************************************************************
3 * Copyright (C) 2012-2018 Icinga Development Team (https://www.icinga.com/) *
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. *
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. *
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 ******************************************************************************/
20 #include "icinga/macroprocessor.hpp"
21 #include "icinga/macroresolver.hpp"
22 #include "icinga/customvarobject.hpp"
23 #include "base/array.hpp"
24 #include "base/objectlock.hpp"
25 #include "base/logger.hpp"
26 #include "base/context.hpp"
27 #include "base/configobject.hpp"
28 #include "base/scriptframe.hpp"
29 #include "base/convert.hpp"
30 #include "base/exception.hpp"
31 #include <boost/algorithm/string/join.hpp>
33 using namespace icinga;
35 Value MacroProcessor::ResolveMacros(const Value& str, const ResolverList& resolvers,
36 const CheckResult::Ptr& cr, String *missingMacro,
37 const MacroProcessor::EscapeCallback& escapeFn, const Dictionary::Ptr& resolvedMacros,
38 bool useResolvedMacros, int recursionLevel)
46 result = InternalResolveMacros(str, resolvers, cr, missingMacro, escapeFn,
47 resolvedMacros, useResolvedMacros, recursionLevel + 1);
48 } else if (str.IsObjectType<Array>()) {
52 ObjectLock olock(arr);
54 for (const Value& arg : arr) {
55 /* Note: don't escape macros here. */
56 Value value = InternalResolveMacros(arg, resolvers, cr, missingMacro,
57 EscapeCallback(), resolvedMacros, useResolvedMacros, recursionLevel + 1);
59 if (value.IsObjectType<Array>())
60 resultArr.push_back(Utility::Join(value, ';'));
62 resultArr.push_back(value);
65 result = new Array(std::move(resultArr));
66 } else if (str.IsObjectType<Dictionary>()) {
67 Dictionary::Ptr resultDict = new Dictionary();
68 Dictionary::Ptr dict = str;
70 ObjectLock olock(dict);
72 for (const Dictionary::Pair& kv : dict) {
73 /* Note: don't escape macros here. */
74 resultDict->Set(kv.first, InternalResolveMacros(kv.second, resolvers, cr, missingMacro,
75 EscapeCallback(), resolvedMacros, useResolvedMacros, recursionLevel + 1));
79 } else if (str.IsObjectType<Function>()) {
80 result = EvaluateFunction(str, resolvers, cr, escapeFn, resolvedMacros, useResolvedMacros, 0);
82 BOOST_THROW_EXCEPTION(std::invalid_argument("Macro is not a string or array."));
88 bool MacroProcessor::ResolveMacro(const String& macro, const ResolverList& resolvers,
89 const CheckResult::Ptr& cr, Value *result, bool *recursive_macro)
91 CONTEXT("Resolving macro '" + macro + "'");
93 *recursive_macro = false;
95 std::vector<String> tokens = macro.Split(".");
98 if (tokens.size() > 1) {
100 tokens.erase(tokens.begin());
103 for (const ResolverSpec& resolver : resolvers) {
104 if (!objName.IsEmpty() && objName != resolver.first)
107 if (objName.IsEmpty()) {
108 CustomVarObject::Ptr dobj = dynamic_pointer_cast<CustomVarObject>(resolver.second);
111 Dictionary::Ptr vars = dobj->GetVars();
113 if (vars && vars->Contains(macro)) {
114 *result = vars->Get(macro);
115 *recursive_macro = true;
121 auto *mresolver = dynamic_cast<MacroResolver *>(resolver.second.get());
123 if (mresolver && mresolver->ResolveMacro(boost::algorithm::join(tokens, "."), cr, result))
126 Value ref = resolver.second;
129 for (const String& token : tokens) {
130 if (ref.IsObjectType<Dictionary>()) {
131 Dictionary::Ptr dict = ref;
132 if (dict->Contains(token)) {
133 ref = dict->Get(token);
139 } else if (ref.IsObject()) {
140 Object::Ptr object = ref;
142 Type::Ptr type = object->GetReflectionType();
149 int field = type->GetFieldId(token);
156 ref = object->GetField(field);
158 Field fieldInfo = type->GetFieldInfo(field);
160 if (strcmp(fieldInfo.TypeName, "Timestamp") == 0)
161 ref = static_cast<long>(ref);
166 if (tokens[0] == "vars" ||
167 tokens[0] == "action_url" ||
168 tokens[0] == "notes_url" ||
169 tokens[0] == "notes")
170 *recursive_macro = true;
180 Value MacroProcessor::EvaluateFunction(const Function::Ptr& func, const ResolverList& resolvers,
181 const CheckResult::Ptr& cr, const MacroProcessor::EscapeCallback& escapeFn,
182 const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int recursionLevel)
184 Dictionary::Ptr resolvers_this = new Dictionary();
186 for (const ResolverSpec& resolver : resolvers) {
187 resolvers_this->Set(resolver.first, resolver.second);
190 auto internalResolveMacrosShim = [resolvers, cr, resolvedMacros, useResolvedMacros, recursionLevel](const std::vector<Value>& args) {
192 BOOST_THROW_EXCEPTION(std::invalid_argument("Too few arguments for function"));
196 return MacroProcessor::InternalResolveMacros(args[0], resolvers, cr, &missingMacro, MacroProcessor::EscapeCallback(),
197 resolvedMacros, useResolvedMacros, recursionLevel);
200 resolvers_this->Set("macro", new Function("macro (temporary)", internalResolveMacrosShim, { "str" }));
202 auto internalResolveArgumentsShim = [resolvers, cr, resolvedMacros, useResolvedMacros, recursionLevel](const std::vector<Value>& args) {
204 BOOST_THROW_EXCEPTION(std::invalid_argument("Too few arguments for function"));
206 return MacroProcessor::ResolveArguments(args[0], args[1], resolvers, cr,
207 resolvedMacros, useResolvedMacros, recursionLevel + 1);
210 resolvers_this->Set("resolve_arguments", new Function("resolve_arguments (temporary)", internalResolveArgumentsShim, { "command", "args" }));
212 return func->InvokeThis(resolvers_this);
215 Value MacroProcessor::InternalResolveMacros(const String& str, const ResolverList& resolvers,
216 const CheckResult::Ptr& cr, String *missingMacro,
217 const MacroProcessor::EscapeCallback& escapeFn, const Dictionary::Ptr& resolvedMacros,
218 bool useResolvedMacros, int recursionLevel)
220 CONTEXT("Resolving macros for string '" + str + "'");
222 if (recursionLevel > 15)
223 BOOST_THROW_EXCEPTION(std::runtime_error("Infinite recursion detected while resolving macros"));
225 size_t offset, pos_first, pos_second;
228 Dictionary::Ptr resolvers_this;
231 while ((pos_first = result.FindFirstOf("$", offset)) != String::NPos) {
232 pos_second = result.FindFirstOf("$", pos_first + 1);
234 if (pos_second == String::NPos)
235 BOOST_THROW_EXCEPTION(std::runtime_error("Closing $ not found in macro format string."));
237 String name = result.SubStr(pos_first + 1, pos_second - pos_first - 1);
239 Value resolved_macro;
240 bool recursive_macro;
243 if (useResolvedMacros) {
244 recursive_macro = false;
245 found = resolvedMacros->Contains(name);
248 resolved_macro = resolvedMacros->Get(name);
250 found = ResolveMacro(name, resolvers, cr, &resolved_macro, &recursive_macro);
252 /* $$ is an escape sequence for $. */
253 if (name.IsEmpty()) {
254 resolved_macro = "$";
258 if (resolved_macro.IsObjectType<Function>()) {
259 resolved_macro = EvaluateFunction(resolved_macro, resolvers, cr, escapeFn,
260 resolvedMacros, useResolvedMacros, recursionLevel + 1);
265 Log(LogWarning, "MacroProcessor")
266 << "Macro '" << name << "' is not defined.";
268 *missingMacro = name;
271 /* recursively resolve macros in the macro if it was a user macro */
272 if (recursive_macro) {
273 if (resolved_macro.IsObjectType<Array>()) {
274 Array::Ptr arr = resolved_macro;
275 ArrayData resolved_arr;
277 ObjectLock olock(arr);
278 for (const Value& value : arr) {
279 if (value.IsScalar()) {
280 resolved_arr.push_back(InternalResolveMacros(value,
281 resolvers, cr, missingMacro, EscapeCallback(), nullptr,
282 false, recursionLevel + 1));
284 resolved_arr.push_back(value);
287 resolved_macro = new Array(std::move(resolved_arr));
288 } else if (resolved_macro.IsString()) {
289 resolved_macro = InternalResolveMacros(resolved_macro,
290 resolvers, cr, missingMacro, EscapeCallback(), nullptr,
291 false, recursionLevel + 1);
295 if (!useResolvedMacros && found && resolvedMacros)
296 resolvedMacros->Set(name, resolved_macro);
299 resolved_macro = escapeFn(resolved_macro);
301 /* we're done if this is the only macro and there are no other non-macro parts in the string */
302 if (pos_first == 0 && pos_second == str.GetLength() - 1)
303 return resolved_macro;
304 else if (resolved_macro.IsObjectType<Array>())
305 BOOST_THROW_EXCEPTION(std::invalid_argument("Mixing both strings and non-strings in macros is not allowed."));
307 if (resolved_macro.IsObjectType<Array>()) {
308 /* don't allow mixing strings and arrays in macro strings */
309 if (pos_first != 0 || pos_second != str.GetLength() - 1)
310 BOOST_THROW_EXCEPTION(std::invalid_argument("Mixing both strings and non-strings in macros is not allowed."));
312 return resolved_macro;
315 String resolved_macro_str = resolved_macro;
317 result.Replace(pos_first, pos_second - pos_first + 1, resolved_macro_str);
318 offset = pos_first + resolved_macro_str.GetLength();
325 bool MacroProcessor::ValidateMacroString(const String& macro)
330 size_t pos_first, pos_second, offset;
333 while ((pos_first = macro.FindFirstOf("$", offset)) != String::NPos) {
334 pos_second = macro.FindFirstOf("$", pos_first + 1);
336 if (pos_second == String::NPos)
339 offset = pos_second + 1;
345 void MacroProcessor::ValidateCustomVars(const ConfigObject::Ptr& object, const Dictionary::Ptr& value)
350 /* string, array, dictionary */
351 ObjectLock olock(value);
352 for (const Dictionary::Pair& kv : value) {
353 const Value& varval = kv.second;
355 if (varval.IsObjectType<Dictionary>()) {
356 /* only one dictonary level */
357 Dictionary::Ptr varval_dict = varval;
359 ObjectLock xlock(varval_dict);
360 for (const Dictionary::Pair& kv_var : varval_dict) {
361 if (!kv_var.second.IsString())
364 if (!ValidateMacroString(kv_var.second))
365 BOOST_THROW_EXCEPTION(ValidationError(object.get(), { "vars", kv.first, kv_var.first }, "Closing $ not found in macro format string '" + kv_var.second + "'."));
367 } else if (varval.IsObjectType<Array>()) {
368 /* check all array entries */
369 Array::Ptr varval_arr = varval;
371 ObjectLock ylock (varval_arr);
372 for (const Value& arrval : varval_arr) {
373 if (!arrval.IsString())
376 if (!ValidateMacroString(arrval)) {
377 BOOST_THROW_EXCEPTION(ValidationError(object.get(), { "vars", kv.first }, "Closing $ not found in macro format string '" + arrval + "'."));
381 if (!varval.IsString())
384 if (!ValidateMacroString(varval))
385 BOOST_THROW_EXCEPTION(ValidationError(object.get(), { "vars", kv.first }, "Closing $ not found in macro format string '" + varval + "'."));
390 void MacroProcessor::AddArgumentHelper(const Array::Ptr& args, const String& key, const String& value,
391 bool add_key, bool add_value)
400 Value MacroProcessor::EscapeMacroShellArg(const Value& value)
404 if (value.IsObjectType<Array>()) {
405 Array::Ptr arr = value;
407 ObjectLock olock(arr);
408 for (const Value& arg : arr) {
409 if (result.GetLength() > 0)
412 result += Utility::EscapeShellArg(arg);
415 result = Utility::EscapeShellArg(value);
420 struct CommandArgument
424 bool RepeatKey{true};
425 bool SkipValue{false};
429 bool operator<(const CommandArgument& rhs) const
431 return Order < rhs.Order;
435 Value MacroProcessor::ResolveArguments(const Value& command, const Dictionary::Ptr& arguments,
436 const MacroProcessor::ResolverList& resolvers, const CheckResult::Ptr& cr,
437 const Dictionary::Ptr& resolvedMacros, bool useResolvedMacros, int recursionLevel)
439 Value resolvedCommand;
440 if (!arguments || command.IsObjectType<Array>() || command.IsObjectType<Function>())
441 resolvedCommand = MacroProcessor::ResolveMacros(command, resolvers, cr, nullptr,
442 EscapeMacroShellArg, resolvedMacros, useResolvedMacros, recursionLevel + 1);
444 resolvedCommand = new Array({ command });
448 std::vector<CommandArgument> args;
450 ObjectLock olock(arguments);
451 for (const Dictionary::Pair& kv : arguments) {
452 const Value& arginfo = kv.second;
457 bool required = false;
460 if (arginfo.IsObjectType<Dictionary>()) {
461 Dictionary::Ptr argdict = arginfo;
462 if (argdict->Contains("key"))
463 arg.Key = argdict->Get("key");
464 argval = argdict->Get("value");
465 if (argdict->Contains("required"))
466 required = argdict->Get("required");
467 arg.SkipKey = argdict->Get("skip_key");
468 if (argdict->Contains("repeat_key"))
469 arg.RepeatKey = argdict->Get("repeat_key");
470 arg.Order = argdict->Get("order");
472 Value set_if = argdict->Get("set_if");
474 if (!set_if.IsEmpty()) {
476 Value set_if_resolved = MacroProcessor::ResolveMacros(set_if, resolvers,
477 cr, &missingMacro, MacroProcessor::EscapeCallback(), resolvedMacros,
478 useResolvedMacros, recursionLevel + 1);
480 if (!missingMacro.IsEmpty())
485 if (set_if_resolved == "true")
487 else if (set_if_resolved == "false")
491 value = Convert::ToLong(set_if_resolved);
492 } catch (const std::exception& ex) {
493 /* tried to convert a string */
494 Log(LogWarning, "PluginUtility")
495 << "Error evaluating set_if value '" << set_if_resolved
496 << "' used in argument '" << arg.Key << "': " << ex.what();
508 if (argval.IsEmpty())
509 arg.SkipValue = true;
512 arg.AValue = MacroProcessor::ResolveMacros(argval, resolvers,
513 cr, &missingMacro, MacroProcessor::EscapeCallback(), resolvedMacros,
514 useResolvedMacros, recursionLevel + 1);
516 if (!missingMacro.IsEmpty()) {
518 BOOST_THROW_EXCEPTION(ScriptError("Non-optional macro '" + missingMacro + "' used in argument '" +
519 arg.Key + "' is missing."));
525 args.emplace_back(std::move(arg));
528 std::sort(args.begin(), args.end());
530 Array::Ptr command_arr = resolvedCommand;
531 for (const CommandArgument& arg : args) {
533 if (arg.AValue.IsObjectType<Dictionary>()) {
534 Log(LogWarning, "PluginUtility")
535 << "Tried to use dictionary in argument '" << arg.Key << "'.";
537 } else if (arg.AValue.IsObjectType<Array>()) {
539 Array::Ptr arr = static_cast<Array::Ptr>(arg.AValue);
541 ObjectLock olock(arr);
542 for (const Value& value : arr) {
547 add_key = !arg.SkipKey;
549 add_key = !arg.SkipKey && arg.RepeatKey;
551 AddArgumentHelper(command_arr, arg.Key, value, add_key, !arg.SkipValue);
554 AddArgumentHelper(command_arr, arg.Key, arg.AValue, !arg.SkipKey, !arg.SkipValue);
558 return resolvedCommand;