Log burnt IP only once
[bpdyndnsd] / src / service.hpp
1 /** @file
2  * @brief The abstract service class. This class represents all services.
3  *
4  *
5  *
6  * @copyright Intra2net AG
7  * @license GPLv2
8 */
9
10 #ifndef SERVICE_H
11 #define SERVICE_H
12
13 #include "logger.hpp"
14
15 #include <boost/archive/text_oarchive.hpp>
16 #include <boost/archive/text_iarchive.hpp>
17
18 #include <boost/shared_ptr.hpp>
19 #include <string>
20 #include <list>
21
22
23 class Service
24 {
25
26 private:
27
28     std::string Protocol;
29     std::string Hostname;
30
31     std::string Login;
32     std::string Password;
33
34     std::string ActualIP;
35     bool ActualIPIsBurnt;
36
37     int UpdateInterval;
38     int MaxUpdatesWithinInterval;
39     int MaxEqualUpdatesInSuccession;
40     int DNSCacheTTL;
41
42     std::map<time_t,std::string> LastUpdates;
43
44     int ErrorCount;
45     time_t ErrorServiceBlockedUntil;
46
47     friend class boost::serialization::access;
48     template<class Archive>
49     void serialize(Archive & ar, const unsigned int version)
50     {
51         // protocol and hostname are the unique identifier for each service.
52         ar & Protocol;
53         ar & Hostname;
54         // lastupdated and actual_ip must also be serialized, cause these are essential infos of each service.
55         ar & LastUpdates;
56         ar & ActualIP;
57         ar & UpdateInterval;
58         ar & MaxUpdatesWithinInterval;
59         ar & MaxEqualUpdatesInSuccession;
60         ar & DNSCacheTTL;
61     }
62
63     Logger::Ptr Log;
64
65 protected:
66
67     enum UpdateErrorCode { UpdateOk=0, GenericError=1, NoChange=2, Blocked=3 };
68     virtual UpdateErrorCode perform_update(const std::string& ip) = 0;
69
70 public:
71
72     typedef boost::shared_ptr<Service> Ptr;
73
74     Service();
75
76     virtual ~Service();
77
78     void update(const std::string& ip, const time_t current_time, bool changed_to_online);
79
80     bool update_allowed(const time_t current_time, bool changed_to_online, const std::string& ip_host);
81
82     void set_last_update(const time_t current_time, const std::string& ip);
83
84     time_t get_last_update_time();
85
86     int get_update_interval()const;
87     void set_update_interval(const int _update_interval);
88
89     int get_max_updates_within_interval() const;
90     void set_max_updates_within_interval(const int _max_updates_within_interval);
91
92     int get_max_equal_updates_in_succession() const;
93     void set_max_equal_updates_in_succession(const int _max_equal_updates_in_succession);
94
95     int get_dns_cache_ttl() const;
96     void set_dns_cache_ttl(const int _dns_cache_ttl);
97
98     void set_protocol(const std::string& _protocol);
99     std::string get_protocol() const;
100
101     void set_hostname(const std::string& _hostname);
102     std::string get_hostname() const;
103
104     void set_login(const std::string& _login);
105     std::string get_login() const;
106
107     void set_password(const std::string& _password);
108     std::string get_password() const;
109
110     void set_last_updates(std::map<time_t,std::string> _last_updates);
111     const std::map<time_t,std::string> get_last_updates() const;
112
113     void set_actual_ip(const std::string& _actual_ip);
114     std::string get_actual_ip() const;
115
116     void set_logger(const Logger::Ptr& _log);
117     Logger::Ptr get_logger() const;
118
119     std::string get_service_name() const;
120
121     bool operator== (const Service& other) const;
122     bool operator!= (const Service& other) const;
123 };
124
125 #endif