icinga2/lib/icinga/notification.cpp

/******************************************************************************
 * Icinga 2                                                                   *
 * Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/)        *
 *                                                                            *
 * This program is free software; you can redistribute it and/or              *
 * modify it under the terms of the GNU General Public License                *
 * as published by the Free Software Foundation; either version 2             *
 * of the License, or (at your option) any later version.                     *
 *                                                                            *
 * This program is distributed in the hope that it will be useful,            *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
 * GNU General Public License for more details.                               *
 *                                                                            *
 * You should have received a copy of the GNU General Public License          *
 * along with this program; if not, write to the Free Software Foundation     *
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
 ******************************************************************************/

#include "icinga/notification.h"
#include "icinga/macroprocessor.h"
#include "icinga/service.h"
#include "base/dynamictype.h"
#include "base/objectlock.h"
#include "base/logger_fwd.h"
#include <boost/tuple/tuple.hpp>
#include <boost/foreach.hpp>
#include <boost/exception/diagnostic_information.hpp>

using namespace icinga;

REGISTER_TYPE(Notification);

Notification::Notification(const Dictionary::Ptr& serializedUpdate)
	: DynamicObject(serializedUpdate)
{
	RegisterAttribute("notification_command", Attribute_Config, &m_NotificationCommand);
	RegisterAttribute("macros", Attribute_Config, &m_Macros);
	RegisterAttribute("users", Attribute_Config, &m_Users);
	RegisterAttribute("groups", Attribute_Config, &m_Groups);
	RegisterAttribute("host_name", Attribute_Config, &m_HostName);
	RegisterAttribute("service", Attribute_Config, &m_Service);
}

Notification::~Notification(void)
{
	Service::InvalidateNotificationsCache();
}

/**
 * @threadsafety Always.
 */
Notification::Ptr Notification::GetByName(const String& name)
{
	DynamicObject::Ptr configObject = DynamicObject::GetObject("Notification", name);

	return dynamic_pointer_cast<Notification>(configObject);
}

/**
 * @threadsafety Always.
 */
Service::Ptr Notification::GetService(void) const
{
	Host::Ptr host = Host::GetByName(m_HostName);

	if (!host)
		return Service::Ptr();

	if (m_Service.IsEmpty())
		return host->GetHostCheckService();
	else
		return host->GetServiceByShortName(m_Service);
}

/**
 * @threadsafety Always.
 */
Value Notification::GetNotificationCommand(void) const
{
	return m_NotificationCommand;
}

/**
 * @threadsafety Always.
 */
Dictionary::Ptr Notification::GetMacros(void) const
{
	return m_Macros;
}

/**
 * @threadsafety Always.
 */
std::set<User::Ptr> Notification::GetUsers(void) const
{
	std::set<User::Ptr> result;

	Array::Ptr users = m_Users;

	if (users) {
		ObjectLock olock(users);

		BOOST_FOREACH(const String& name, users) {
			User::Ptr user = User::GetByName(name);

			if (!user)
				continue;

			result.insert(user);
		}
	}

	return result;
}

/**
 * @threadsafety Always.
 */
std::set<UserGroup::Ptr> Notification::GetGroups(void) const
{
	std::set<UserGroup::Ptr> result;

	Array::Ptr groups = m_Groups;

	if (groups) {
		ObjectLock olock(groups);

		BOOST_FOREACH(const String& name, groups) {
			UserGroup::Ptr ug = UserGroup::GetByName(name);

			if (!ug)
				continue;

			result.insert(ug);
		}
	}

	return result;
}

/**
 * @threadsafety Always.
 */
String Notification::NotificationTypeToString(NotificationType type)
{
	switch (type) {
		case NotificationDowntimeStart:
			return "DOWNTIMESTART";
		case NotificationDowntimeEnd:
			return "DOWNTIMEEND";
		case NotificationDowntimeRemoved:
			return "DOWNTIMECANCELLED";
		case NotificationCustom:
			return "CUSTOM";
		case NotificationAcknowledgement:
			return "ACKNOWLEDGEMENT";
		case NotificationProblem:
			return "PROBLEM";
		case NotificationRecovery:
			return "RECOVERY";
		default:
			return "UNKNOWN_NOTIFICATION";
	}
}

/**
 * @threadsafety Always.
 */
void Notification::BeginExecuteNotification(NotificationType type, const Dictionary::Ptr& cr)
{
	ASSERT(!OwnsLock());

	Dictionary::Ptr macros = cr->Get("macros");

	std::set<User::Ptr> allUsers;

	std::set<User::Ptr> users = GetUsers();
	std::copy(users.begin(), users.end(), std::inserter(allUsers, allUsers.begin()));

	BOOST_FOREACH(const UserGroup::Ptr& ug, GetGroups()) {
		std::set<User::Ptr> members = ug->GetMembers();
		std::copy(members.begin(), members.end(), std::inserter(allUsers, allUsers.begin()));
	}

	BOOST_FOREACH(const User::Ptr& user, allUsers) {
		Log(LogDebug, "icinga", "Sending notification for user " + user->GetName());
		BeginExecuteNotificationHelper(macros, type, user);
	}

	if (allUsers.empty()) {
		/* Send a notification even if there are no users specified. */
		BeginExecuteNotificationHelper(macros, type, User::Ptr());
	}
}

/**
 * @threadsafety Always.
 */
void Notification::BeginExecuteNotificationHelper(const Dictionary::Ptr& notificationMacros, NotificationType type, const User::Ptr& user)
{
	ASSERT(!OwnsLock());

	std::vector<Dictionary::Ptr> macroDicts;

	if (user) {
		macroDicts.push_back(user->GetMacros());
		macroDicts.push_back(user->CalculateDynamicMacros());
	}

	macroDicts.push_back(notificationMacros);

	Dictionary::Ptr macros = MacroProcessor::MergeMacroDicts(macroDicts);

	Notification::Ptr self = GetSelf();

	std::vector<Value> arguments;
	arguments.push_back(self);
	arguments.push_back(macros);
	arguments.push_back(type);

	ScriptTask::Ptr task = MakeMethodTask("notify", arguments);

	if (!task) {
		Log(LogWarning, "icinga", "Notification object '" + GetName() + "' doesn't have a 'notify' method.");

		return;
	}

	{
		ObjectLock olock(this);

		/* We need to keep the task object alive until the completion handler is called. */
		m_Tasks.insert(task);
	}

	task->Start(boost::bind(&Notification::NotificationCompletedHandler, self, _1));
}

/**
 * @threadsafety Always.
 */
void Notification::NotificationCompletedHandler(const ScriptTask::Ptr& task)
{
	ASSERT(!OwnsLock());

	{
		ObjectLock olock(this);

		m_Tasks.erase(task);
	}

	try {
		task->GetResult();

		Log(LogInformation, "icinga", "Completed sending notification for service '" + GetService()->GetName() + "'");
	} catch (const std::exception& ex) {
		std::ostringstream msgbuf;
		msgbuf << "Exception occured during notification for service '"
		       << GetService()->GetName() << "': " << boost::diagnostic_information(ex);
		String message = msgbuf.str();

		Log(LogWarning, "icinga", message);
	}
}

/**
 * @threadsafety Always.
 */
void Notification::OnAttributeChanged(const String& name)
{
	ASSERT(!OwnsLock());

	if (name == "host_name" || name == "service")
		Service::InvalidateNotificationsCache();
}