1 /******************************************************************************
3 * Copyright (C) 2012-2016 Icinga Development Team (https://www.icinga.org/) *
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 #ifndef NOTIFICATION_H
21 #define NOTIFICATION_H
23 #include "icinga/i2-icinga.hpp"
24 #include "icinga/notification.thpp"
25 #include "icinga/checkable.thpp"
26 #include "icinga/user.hpp"
27 #include "icinga/usergroup.hpp"
28 #include "icinga/timeperiod.hpp"
29 #include "icinga/checkresult.hpp"
30 #include "remote/endpoint.hpp"
31 #include "remote/messageorigin.hpp"
32 #include "base/array.hpp"
40 enum NotificationFilter
43 StateFilterWarning = 2,
44 StateFilterCritical = 4,
45 StateFilterUnknown = 8,
52 * The notification type.
58 NotificationDowntimeStart = 1,
59 NotificationDowntimeEnd = 2,
60 NotificationDowntimeRemoved = 4,
61 NotificationCustom = 8,
62 NotificationAcknowledgement = 16,
63 NotificationProblem = 32,
64 NotificationRecovery = 64,
65 NotificationFlappingStart = 128,
66 NotificationFlappingEnd = 256
69 class NotificationCommand;
76 * An Icinga notification specification.
80 class I2_ICINGA_API Notification : public ObjectImpl<Notification>
83 DECLARE_OBJECT(Notification);
84 DECLARE_OBJECTNAME(Notification);
86 static void StaticInitialize(void);
88 intrusive_ptr<Checkable> GetCheckable(void) const;
89 intrusive_ptr<NotificationCommand> GetCommand(void) const;
90 TimePeriod::Ptr GetPeriod(void) const;
91 std::set<User::Ptr> GetUsers(void) const;
92 std::set<UserGroup::Ptr> GetUserGroups(void) const;
94 void UpdateNotificationNumber(void);
95 void ResetNotificationNumber(void);
97 void BeginExecuteNotification(NotificationType type, const CheckResult::Ptr& cr, bool force,
98 bool reminder = false, const String& author = "", const String& text = "");
100 Endpoint::Ptr GetCommandEndpoint(void) const;
102 static String NotificationTypeToString(NotificationType type);
103 static String NotificationFilterToString(int filter, const std::map<String, int>& filterMap);
105 static boost::signals2::signal<void (const Notification::Ptr&, const MessageOrigin::Ptr&)> OnNextNotificationChanged;
107 virtual void Validate(int types, const ValidationUtils& utils) override;
109 virtual void ValidateStates(const Array::Ptr& value, const ValidationUtils& utils) override;
110 virtual void ValidateTypes(const Array::Ptr& value, const ValidationUtils& utils) override;
112 static void EvaluateApplyRules(const intrusive_ptr<Host>& host);
113 static void EvaluateApplyRules(const intrusive_ptr<Service>& service);
115 static const std::map<String, int>& GetStateFilterMap(void);
116 static const std::map<String, int>& GetTypeFilterMap(void);
119 virtual void OnConfigLoaded(void) override;
120 virtual void OnAllConfigLoaded(void) override;
121 virtual void Start(bool runtimeCreated) override;
122 virtual void Stop(bool runtimeRemoved) override;
125 ObjectImpl<Checkable>::Ptr m_Checkable;
127 bool CheckNotificationUserFilters(NotificationType type, const User::Ptr& user, bool force, bool reminder);
129 void ExecuteNotificationHelper(NotificationType type, const User::Ptr& user, const CheckResult::Ptr& cr, bool force, const String& author = "", const String& text = "");
131 static bool EvaluateApplyRuleInstance(const intrusive_ptr<Checkable>& checkable, const String& name, ScriptFrame& frame, const ApplyRule& rule);
132 static bool EvaluateApplyRule(const intrusive_ptr<Checkable>& checkable, const ApplyRule& rule);
134 static String NotificationTypeToStringInternal(NotificationType type);
135 static String NotificationServiceStateToString(ServiceState state);
136 static String NotificationHostStateToString(HostState state);
138 static std::map<String, int> m_StateFilterMap;
139 static std::map<String, int> m_TypeFilterMap;
142 I2_ICINGA_API int ServiceStateToFilter(ServiceState state);
143 I2_ICINGA_API int HostStateToFilter(HostState state);
147 #endif /* NOTIFICATION_H */