2 * @brief The abstract service class. This class represents all services.
6 * @copyright Intra2net AG
10 #include "service.hpp"
11 #include <boost/foreach.hpp>
15 /// Number of update errors until a service will be blocked
16 const int MaxErrorCount = 3;
17 /// Number of seconds a service will be blocked if MaxErrorCount is reached
18 const int ErrorBlockServiceSeconds = 15 * 60;
24 : Login("NOT SERIALIZED")
25 , Password("NOT SERIALIZED")
28 , MaxUpdatesWithinInterval(3)
29 , MaxEqualUpdatesInSuccession(2)
32 , ErrorServiceBlockedUntil(0)
39 * Default Destructor needed for deserialization.
47 * Setter for member Protocol.
48 * @param _protocol Value to set Protocol to.
50 void Service::set_protocol(const string& _protocol)
57 * Getter for memeber Protocol.
58 * @return Value of member Protocol.
60 string Service::get_protocol() const
67 * Setter for member Hostname.
68 * @param _hostname Value to set Hostname to.
70 void Service::set_hostname(const string& _hostname)
77 * Getter for member Hostname.
78 * @return Value of member Hostname.
80 string Service::get_hostname() const
87 * Setter for member Login.
88 * @param _login Value to set Login to.
90 void Service::set_login(const string& _login)
97 * Getter for member Login.
98 * @return Value of member Login.
100 string Service::get_login() const
107 * Setter for member Password.
108 * @param _password Value to set Password to.
110 void Service::set_password(const string& _password)
112 Password = _password;
117 * Getter for member Password.
118 * @return Value of member Password.
120 string Service::get_password() const
127 void Service::set_logger(const Logger::Ptr& _log)
134 * Getter for member Log.
135 * @return Shared pointer to Logger object.
137 Logger::Ptr Service::get_logger() const
144 * Setter for member LastUpdates.
145 * @param _last_updates Value to set LastUpdates to.
147 void Service::set_last_updates(std::map<time_t,std::string> _last_updates)
150 for ( std::map<time_t,std::string>::iterator iter = _last_updates.begin(); iter != _last_updates.end(); iter++ )
152 LastUpdates.insert(make_pair(iter->first,iter->second));
158 * Getter for member LastUpdates.
159 * @return Value of member LastUpdates.
161 const std::map<time_t,std::string> Service::get_last_updates() const
168 * Setter for member ActualIP.
169 * @param _actual_ip Value to set ActualIP to.
171 void Service::set_actual_ip(const std::string& _actual_ip)
173 ActualIP = _actual_ip;
178 * Getter for member ActualIP.
179 * @return Value of member ActualIP.
181 std::string Service::get_actual_ip() const
188 * Overloading of comparison operator.
189 * @param other Reference to other Service object.
190 * @return True if they equal, false if not.
192 bool Service::operator== (const Service& other) const
194 if ( ( this->Protocol == other.Protocol ) && ( this->Hostname == other.Hostname ) )
201 * Overloading of disparate operator.
202 * @param other Reference to other Service object.
203 * @return True if they differ, false if they are equal.
205 bool Service::operator!= (const Service& other) const
207 return !(*this == other);
212 * Checks if update will exceed max update interval.
213 * @param current_time Current time.
214 * @param changed_to_online True if we just changed to online, false if we were already online
215 * @return True if update is allowed, false if update would exceed max update interval.
217 bool Service::update_allowed(const time_t current_time, bool changed_to_online)
220 for ( std::map<time_t,std::string>::reverse_iterator r_iter = LastUpdates.rbegin(); (r_iter != LastUpdates.rend()) && ( i < MaxUpdatesWithinInterval ); r_iter++)
222 if ( (i == (MaxUpdatesWithinInterval-1)) && ( (r_iter->first + ((time_t)UpdateInterval*60)) >= current_time ) )
224 Log->print_update_not_allowed(changed_to_online,current_time,r_iter->first,MaxUpdatesWithinInterval,get_service_name());
234 * Service update method, common to each service.
235 * @param ip The new ip to set for the hostname.
236 * @param current_time Current time
237 * @param changed_to_online True if we just changed to online, false if we were already online
239 void Service::update(const string& ip, const time_t current_time, bool changed_to_online)
241 const std::string service_name = get_service_name();
243 // Check if service is blocked for a short period of time (because of update errors)
244 if (ErrorServiceBlockedUntil && current_time < ErrorServiceBlockedUntil)
246 Log->print_update_service_is_blocked(service_name, ErrorServiceBlockedUntil - current_time);
250 // test if update is permitted by UpdateInterval Status
251 if ( update_allowed(current_time, changed_to_online) )
253 Log->print_update_service(service_name);
255 if ( perform_update(ip) == 0 )
257 // if update was successful, we need to set the Lastupdated and ActualIP base member.
258 set_last_update(current_time,ip);
260 Log->print_update_service_successful(service_name);
263 ErrorServiceBlockedUntil = 0;
267 // problem while trying to update service
268 Log->print_update_service_failure(service_name);
271 if (ErrorCount >= MaxErrorCount)
273 Log->print_block_service(service_name, ErrorBlockServiceSeconds);
275 ErrorServiceBlockedUntil = time(NULL) + ErrorBlockServiceSeconds;
284 * Sets the given time into the LastUpdates member and deletes expired entries.
285 * @param _timeout Value to set into LastUpdates.
287 void Service::set_last_update(const time_t current_time, const string& ip)
289 // Insert value into the list.
290 LastUpdates.insert(make_pair(current_time,ip));
292 // Get the maximum of MaxUpdatesWithinInterval and MaxEqualUpdatesInSuccession
293 int maximum = max(MaxUpdatesWithinInterval,MaxEqualUpdatesInSuccession);
295 // Check for expired entries:
297 // MaxUpdatesWithinInterval given in service config, then use this to check for expired entries.
300 // Delete the oldest entry if there are more than max(MaxUpdatesWithinInterval,MaxEqualUpdatesInSuccession)+1 entries in the list.
301 if ( LastUpdates.size() > (size_t)(maximum+1) )
302 LastUpdates.erase(LastUpdates.upper_bound(0));
305 // UpdateInterval given in service config, then use this to check for expired entries.
306 else if ( UpdateInterval > 0 )
308 // Delete the oldest entry if it's older than current_time - UpdateInterval(minutes) + 1.
309 if ( (current_time - ((time_t)UpdateInterval*60) + 1) > LastUpdates.upper_bound(0)->first )
310 LastUpdates.erase(LastUpdates.upper_bound(0));
313 // Neither MaxUpdatesWithinInterval nor UpdateInterval are given, so keep fix number of 10 entries.
316 if ( LastUpdates.size() > 10 )
317 LastUpdates.erase(LastUpdates.upper_bound(0));
324 * Getter the last updated time.
325 * @return Value of the last update as time_t.
327 time_t Service::get_last_update_time( )
329 std::map<time_t,std::string>::reverse_iterator r_iter = LastUpdates.rbegin();
330 return r_iter->first;
335 * Setter for member Timeout.
336 * @param _timeout Value to set Timeout to.
338 void Service::set_update_interval(const int _update_interval)
340 UpdateInterval = _update_interval;
345 * Getter for member Timeout.
346 * @return Value of Timeout.
348 int Service::get_update_interval() const
350 return UpdateInterval;
355 * Setter for member Max_updates_per_timeout.
356 * @param _max_updates_per_timeout Value to set Max_updates_per_timeout to.
358 void Service::set_max_updates_within_interval(const int _max_updates_within_interval)
360 MaxUpdatesWithinInterval = _max_updates_within_interval;
365 * Getter for member Max_updates_per_timeout.
366 * @return Value of Max_updates_per_timeout.
368 int Service::get_max_updates_within_interval() const
370 return MaxUpdatesWithinInterval;
375 * Setter for member MaxEqualUpdatesInSuccession.
376 * @param _max_equal_updates_in_succession Value to set MaxEqualUpdatesInSuccession to.
378 void Service::set_max_equal_updates_in_succession(const int _max_equal_updates_in_succession)
380 MaxEqualUpdatesInSuccession = _max_equal_updates_in_succession;
385 * Getter for member MaxEqualUpdatesInSuccession.
386 * @return Value of MaxEqualUpdatesInSuccession.
388 int Service::get_max_equal_updates_in_succession() const
390 return MaxEqualUpdatesInSuccession;
395 * Get a unique service identify string
396 * @return A unique service identify string
398 string Service::get_service_name() const
402 service_name.append(Protocol);
403 service_name.append(" ");
404 service_name.append(Hostname);
411 * Get member DNSCacheTTL
412 * @return DNSCacheTTL
414 int Service::get_dns_cache_ttl() const
421 * Set member DNSCacheTTL
422 * @param _dns_cache_ttl DNSCacheTTL
424 void Service::set_dns_cache_ttl(const int _dns_cache_ttl)
426 DNSCacheTTL = _dns_cache_ttl;