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

   1 /* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
   2
   3 #ifndef NOTIFICATION_H
   4 #define NOTIFICATION_H
   5
   6 #include "icinga/i2-icinga.hpp"
   7 #include "icinga/notification-ti.hpp"
   8 #include "icinga/checkable-ti.hpp"
   9 #include "icinga/user.hpp"
  10 #include "icinga/usergroup.hpp"
  11 #include "icinga/timeperiod.hpp"
  12 #include "icinga/checkresult.hpp"
  13 #include "icinga/notificationresult.hpp"
  14 #include "remote/endpoint.hpp"
  15 #include "remote/messageorigin.hpp"
  16 #include "base/array.hpp"
  17
  18 namespace icinga
  19 {
  20
  21 /**
  22  * @ingroup icinga
  23  */
  24 enum NotificationFilter
  25 {
  26         StateFilterOK = 1,
  27         StateFilterWarning = 2,
  28         StateFilterCritical = 4,
  29         StateFilterUnknown = 8,
  30
  31         StateFilterUp = 16,
  32         StateFilterDown = 32
  33 };
  34
  35 /**
  36  * The notification type.
  37  *
  38  * @ingroup icinga
  39  */
  40 enum NotificationType
  41 {
  42         NotificationDowntimeStart = 1,
  43         NotificationDowntimeEnd = 2,
  44         NotificationDowntimeRemoved = 4,
  45         NotificationCustom = 8,
  46         NotificationAcknowledgement = 16,
  47         NotificationProblem = 32,
  48         NotificationRecovery = 64,
  49         NotificationFlappingStart = 128,
  50         NotificationFlappingEnd = 256
  51 };
  52
  53 class NotificationCommand;
  54 class ApplyRule;
  55 struct ScriptFrame;
  56 class Host;
  57 class Service;
  58
  59 /**
  60  * An Icinga notification specification.
  61  *
  62  * @ingroup icinga
  63  */
  64 class Notification final : public ObjectImpl<Notification>
  65 {
  66 public:
  67         DECLARE_OBJECT(Notification);
  68         DECLARE_OBJECTNAME(Notification);
  69
  70         static void StaticInitialize();
  71
  72         intrusive_ptr<Checkable> GetCheckable() const;
  73         intrusive_ptr<NotificationCommand> GetCommand() const;
  74         TimePeriod::Ptr GetPeriod() const;
  75         std::set<User::Ptr> GetUsers() const;
  76         std::set<UserGroup::Ptr> GetUserGroups() const;
  77
  78         void UpdateNotificationNumber();
  79         void ResetNotificationNumber();
  80
  81         void BeginExecuteNotification(NotificationType type, const CheckResult::Ptr& cr, bool force,
  82                 bool reminder = false, const String& author = "", const String& text = "");
  83
  84         Endpoint::Ptr GetCommandEndpoint() const;
  85
  86         void ProcessNotificationResult(const NotificationResult::Ptr& nr, const MessageOrigin::Ptr& origin = nullptr);
  87
  88         // Logging, etc.
  89         static String NotificationTypeToString(NotificationType type);
  90         // Compat, used for notifications, etc.
  91         static String NotificationTypeToStringCompat(NotificationType type);
  92         static String NotificationFilterToString(int filter, const std::map<String, int>& filterMap);
  93
  94         static String NotificationServiceStateToString(ServiceState state);
  95         static String NotificationHostStateToString(HostState state);
  96
  97         static boost::signals2::signal<void (const Notification::Ptr&, const MessageOrigin::Ptr&)> OnNextNotificationChanged;
  98         static boost::signals2::signal<void (const Notification::Ptr&, const NotificationResult::Ptr&, const MessageOrigin::Ptr&)> OnNewNotificationResult;
  99
 100         void Validate(int types, const ValidationUtils& utils) override;
 101
 102         void ValidateStates(const Lazy<Array::Ptr>& lvalue, const ValidationUtils& utils) override;
 103         void ValidateTypes(const Lazy<Array::Ptr>& lvalue, const ValidationUtils& utils) override;
 104         void ValidateTimes(const Lazy<Dictionary::Ptr>& lvalue, const ValidationUtils& utils) override;
 105
 106         static void EvaluateApplyRules(const intrusive_ptr<Host>& host);
 107         static void EvaluateApplyRules(const intrusive_ptr<Service>& service);
 108
 109         static const std::map<String, int>& GetStateFilterMap();
 110         static const std::map<String, int>& GetTypeFilterMap();
 111
 112 protected:
 113         void OnConfigLoaded() override;
 114         void OnAllConfigLoaded() override;
 115         void Start(bool runtimeCreated) override;
 116         void Stop(bool runtimeRemoved) override;
 117
 118 private:
 119         ObjectImpl<Checkable>::Ptr m_Checkable;
 120
 121         bool CheckNotificationUserFilters(NotificationType type, const User::Ptr& user, bool force, bool reminder);
 122
 123         void ExecuteNotificationHelper(NotificationType type, const User::Ptr& user, const CheckResult::Ptr& cr, bool force, const String& author = "", const String& text = "");
 124
 125         static bool EvaluateApplyRuleInstance(const intrusive_ptr<Checkable>& checkable, const String& name, ScriptFrame& frame, const ApplyRule& rule);
 126         static bool EvaluateApplyRule(const intrusive_ptr<Checkable>& checkable, const ApplyRule& rule);
 127
 128         static std::map<String, int> m_StateFilterMap;
 129         static std::map<String, int> m_TypeFilterMap;
 130 };
 131
 132 int ServiceStateToFilter(ServiceState state);
 133 int HostStateToFilter(HostState state);
 134
 135 }
 136
 137 #endif /* NOTIFICATION_H */