icinga2/lib/config/applyrule.cpp

// SPDX-FileCopyrightText: 2012 Icinga GmbH <https://icinga.com>
// SPDX-License-Identifier: GPL-2.0-or-later

#include "config/applyrule.hpp"
#include "base/logger.hpp"
#include <set>
#include <unordered_set>

using namespace icinga;

ApplyRule::RuleMap ApplyRule::m_Rules;
ApplyRule::TypeMap ApplyRule::m_Types;

ApplyRule::ApplyRule(String name, Expression::Ptr expression,
	Expression::Ptr filter, String package, String fkvar, String fvvar, Expression::Ptr fterm,
	bool ignoreOnError, DebugInfo di, Dictionary::Ptr scope)
	: m_Name(std::move(name)), m_Expression(std::move(expression)), m_Filter(std::move(filter)), m_Package(std::move(package)), m_FKVar(std::move(fkvar)),
	m_FVVar(std::move(fvvar)), m_FTerm(std::move(fterm)), m_IgnoreOnError(ignoreOnError), m_DebugInfo(std::move(di)), m_Scope(std::move(scope)), m_HasMatches(false)
{ }

String ApplyRule::GetName() const
{
	return m_Name;
}

Expression::Ptr ApplyRule::GetExpression() const
{
	return m_Expression;
}

Expression::Ptr ApplyRule::GetFilter() const
{
	return m_Filter;
}

String ApplyRule::GetPackage() const
{
	return m_Package;
}

Expression::Ptr ApplyRule::GetFTerm() const
{
	return m_FTerm;
}

bool ApplyRule::GetIgnoreOnError() const
{
	return m_IgnoreOnError;
}

const DebugInfo& ApplyRule::GetDebugInfo() const
{
	return m_DebugInfo;
}

Dictionary::Ptr ApplyRule::GetScope() const
{
	return m_Scope;
}

void ApplyRule::AddRule(const String& sourceType, const String& targetType, const String& name,
	const Expression::Ptr& expression, const Expression::Ptr& filter, const String& package, const String& fkvar,
	const String& fvvar, const Expression::Ptr& fterm, bool ignoreOnError, const DebugInfo& di, const Dictionary::Ptr& scope)
{
	auto actualTargetType (&targetType);

	if (*actualTargetType == "") {
		auto& targetTypes (GetTargetTypes(sourceType));

		if (targetTypes.size() == 1u) {
			actualTargetType = &targetTypes[0];
		}
	}

	ApplyRule::Ptr rule = new ApplyRule(name, expression, filter, package, fkvar, fvvar, fterm, ignoreOnError, di, scope);
	auto& rules (m_Rules[Type::GetByName(sourceType).get()]);

	if (!AddTargetedRule(rule, *actualTargetType, rules)) {
		rules.Regular[Type::GetByName(*actualTargetType).get()].emplace_back(std::move(rule));
	}
}

bool ApplyRule::EvaluateFilter(ScriptFrame& frame) const
{
	return Convert::ToBool(m_Filter->Evaluate(frame));
}

void ApplyRule::RegisterType(const String& sourceType, const std::vector<String>& targetTypes)
{
	m_Types[sourceType] = targetTypes;
}

bool ApplyRule::IsValidSourceType(const String& sourceType)
{
	return m_Types.find(sourceType) != m_Types.end();
}

bool ApplyRule::IsValidTargetType(const String& sourceType, const String& targetType)
{
	auto it = m_Types.find(sourceType);

	if (it == m_Types.end())
		return false;

	if (it->second.size() == 1 && targetType == "")
		return true;

	for (const String& type : it->second) {
		if (type == targetType)
			return true;
	}

	return false;
}

const std::vector<String>& ApplyRule::GetTargetTypes(const String& sourceType)
{
	auto it = m_Types.find(sourceType);

	if (it == m_Types.end()) {
		static const std::vector<String> noTypes;
		return noTypes;
	}

	return it->second;
}

void ApplyRule::AddMatch()
{
	m_HasMatches.store(true, std::memory_order_relaxed);
}

bool ApplyRule::HasMatches() const
{
	return m_HasMatches.load(std::memory_order_relaxed);
}

const std::vector<ApplyRule::Ptr>& ApplyRule::GetRules(const Type::Ptr& sourceType, const Type::Ptr& targetType)
{
	auto perSourceType (m_Rules.find(sourceType.get()));

	if (perSourceType != m_Rules.end()) {
		auto perTargetType (perSourceType->second.Regular.find(targetType.get()));

		if (perTargetType != perSourceType->second.Regular.end()) {
			return perTargetType->second;
		}
	}

	static const std::vector<ApplyRule::Ptr> noRules;
	return noRules;
}

void ApplyRule::CheckMatches(bool silent)
{
	for (auto& perSourceType : m_Rules) {
		for (auto& perTargetType : perSourceType.second.Regular) {
			for (auto& rule : perTargetType.second) {
				CheckMatches(rule, perSourceType.first, silent);
			}
		}

		std::unordered_set<ApplyRule*> targeted;

		for (auto& perHost : perSourceType.second.Targeted) {
			for (auto& rule : perHost.second.ForHost) {
				targeted.emplace(rule.get());
			}

			for (auto& perService : perHost.second.ForServices) {
				for (auto& rule : perService.second) {
					targeted.emplace(rule.get());
				}
			}
		}

		for (auto rule : targeted) {
			CheckMatches(rule, perSourceType.first, silent);
		}
	}
}

void ApplyRule::CheckMatches(const ApplyRule::Ptr& rule, Type* sourceType, bool silent)
{
	if (!rule->HasMatches() && !silent) {
		Log(LogWarning, "ApplyRule")
			<< "Apply rule '" << rule->GetName() << "' (" << rule->GetDebugInfo() << ") for type '"
			<< sourceType->GetName() << "' does not match anywhere!";
	}
}