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)
149 std::map<time_t,std::string> temp = _last_updates;
150 LastUpdates.swap(temp);
155 * Getter for member LastUpdates.
156 * @return Value of member LastUpdates.
158 const std::map<time_t,std::string> Service::get_last_updates() const
165 * Setter for member ActualIP.
166 * @param _actual_ip Value to set ActualIP to.
168 void Service::set_actual_ip(const std::string& _actual_ip)
170 ActualIP = _actual_ip;
175 * Getter for member ActualIP.
176 * @return Value of member ActualIP.
178 std::string Service::get_actual_ip() const
185 * Overloading of comparison operator.
186 * @param other Reference to other Service object.
187 * @return True if they equal, false if not.
189 bool Service::operator== (const Service& other) const
191 if ( ( this->Protocol == other.Protocol ) && ( this->Hostname == other.Hostname ) )
198 * Overloading of disparate operator.
199 * @param other Reference to other Service object.
200 * @return True if they differ, false if they are equal.
202 bool Service::operator!= (const Service& other) const
204 return !(*this == other);
209 * Checks if update will exceed max update interval or if the IP address is burnt.
210 * @param current_time Current time.
211 * @param changed_to_online True if we just changed to online, false if we were already online
212 * @return True if update is allowed, false if update would exceed max update interval.
214 bool Service::update_allowed(const time_t current_time, bool changed_to_online, const std::string& ip_host)
216 Log->print_last_updates(ip_host,current_time,UpdateInterval,MaxUpdatesWithinInterval,MaxEqualUpdatesInSuccession,LastUpdates,get_service_name());
218 // Check for update interval overstepping.
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());
230 // Check for burnt IP.
231 // Only check for burnt IP address if there are at least max_equal_updates_in_succession entries in the last_updates map.
232 if ( (MaxEqualUpdatesInSuccession != 0) && ((int)LastUpdates.size() >= MaxEqualUpdatesInSuccession) )
234 bool ip_burnt = true;
236 // Reverse iterate "last_updates" list so the latest update
237 // will be the first entry (map key is the unix timestamp)
238 for ( std::map<time_t,std::string>::reverse_iterator r_iter = LastUpdates.rbegin();
239 ( r_iter != LastUpdates.rend() ) && ( i < MaxEqualUpdatesInSuccession ); r_iter++ )
241 if ( ip_host != r_iter->second )
251 // IP Address is burnt. Too many updates in succession with the same IP.
252 Log->print_ip_burnt(ip_host,get_service_name());
262 * Service update method, common to each service.
263 * @param ip The new ip to set for the hostname.
264 * @param current_time Current time
265 * @param changed_to_online True if we just changed to online, false if we were already online
267 void Service::update(const string& ip, const time_t current_time, bool changed_to_online)
269 const std::string service_name = get_service_name();
271 // Check if service is blocked for a short period of time (because of update errors)
272 if (ErrorServiceBlockedUntil && current_time < ErrorServiceBlockedUntil)
274 Log->print_update_service_is_blocked(service_name, ErrorServiceBlockedUntil - current_time);
278 // test if update is permitted by UpdateInterval Status
279 if ( update_allowed(current_time, changed_to_online, ip) )
281 Log->print_update_service(service_name);
283 UpdateErrorCode update_res = perform_update(ip);
285 if (update_res == UpdateOk)
287 // if update was successful, we need to set the Lastupdated and ActualIP base member.
288 set_last_update(current_time,ip);
290 Log->print_update_service_successful(service_name);
293 ErrorServiceBlockedUntil = 0;
297 if (update_res == NoChange || update_res == Blocked)
299 // Log update for burnt IP logic and update "ActualIP" of this service
300 set_last_update(current_time,ip);
304 // problem while trying to update service
305 Log->print_update_service_failure(service_name);
308 if (ErrorCount >= MaxErrorCount)
310 Log->print_block_service(service_name, ErrorBlockServiceSeconds);
312 ErrorServiceBlockedUntil = time(NULL) + ErrorBlockServiceSeconds;
321 * Sets the given time into the LastUpdates member and deletes expired entries.
322 * @param _timeout Value to set into LastUpdates.
324 void Service::set_last_update(const time_t current_time, const string& ip)
326 // Insert value into the list.
327 LastUpdates.insert(make_pair(current_time,ip));
329 // Get the maximum of MaxUpdatesWithinInterval and MaxEqualUpdatesInSuccession
330 int maximum = max(MaxUpdatesWithinInterval,MaxEqualUpdatesInSuccession);
332 // Check for expired entries:
334 // MaxUpdatesWithinInterval given in service config, then use this to check for expired entries.
337 // Delete the oldest entry if there are more than max(MaxUpdatesWithinInterval,MaxEqualUpdatesInSuccession)+1 entries in the list.
338 if ( LastUpdates.size() > (size_t)(maximum+1) )
339 LastUpdates.erase(LastUpdates.begin());
342 // UpdateInterval given in service config, then use this to check for expired entries.
343 else if ( UpdateInterval > 0 )
345 // Delete the oldest entry if it's older than current_time - UpdateInterval(minutes) + 1.
346 if ( (current_time - ((time_t)UpdateInterval*60) + 1) > LastUpdates.begin()->first )
347 LastUpdates.erase(LastUpdates.begin());
350 // Neither MaxUpdatesWithinInterval nor UpdateInterval are given, so keep fix number of 10 entries.
353 if ( LastUpdates.size() > 10 )
354 LastUpdates.erase(LastUpdates.begin());
361 * Getter the last updated time.
362 * @return Value of the last update as time_t.
364 time_t Service::get_last_update_time( )
366 time_t last_update = 0;
367 if ( !LastUpdates.empty() )
369 std::map<time_t,std::string>::reverse_iterator r_iter = LastUpdates.rbegin();
370 if ( r_iter != LastUpdates.rend() )
371 last_update = r_iter->first;
378 * Setter for member Timeout.
379 * @param _timeout Value to set Timeout to.
381 void Service::set_update_interval(const int _update_interval)
383 UpdateInterval = _update_interval;
388 * Getter for member Timeout.
389 * @return Value of Timeout.
391 int Service::get_update_interval() const
393 return UpdateInterval;
398 * Setter for member Max_updates_per_timeout.
399 * @param _max_updates_per_timeout Value to set Max_updates_per_timeout to.
401 void Service::set_max_updates_within_interval(const int _max_updates_within_interval)
403 MaxUpdatesWithinInterval = _max_updates_within_interval;
408 * Getter for member Max_updates_per_timeout.
409 * @return Value of Max_updates_per_timeout.
411 int Service::get_max_updates_within_interval() const
413 return MaxUpdatesWithinInterval;
418 * Setter for member MaxEqualUpdatesInSuccession.
419 * @param _max_equal_updates_in_succession Value to set MaxEqualUpdatesInSuccession to.
421 void Service::set_max_equal_updates_in_succession(const int _max_equal_updates_in_succession)
423 MaxEqualUpdatesInSuccession = _max_equal_updates_in_succession;
428 * Getter for member MaxEqualUpdatesInSuccession.
429 * @return Value of MaxEqualUpdatesInSuccession.
431 int Service::get_max_equal_updates_in_succession() const
433 return MaxEqualUpdatesInSuccession;
438 * Get a unique service identify string
439 * @return A unique service identify string
441 string Service::get_service_name() const
445 service_name.append(Protocol);
446 service_name.append(" ");
447 service_name.append(Hostname);
454 * Get member DNSCacheTTL
455 * @return DNSCacheTTL
457 int Service::get_dns_cache_ttl() const
464 * Set member DNSCacheTTL
465 * @param _dns_cache_ttl DNSCacheTTL
467 void Service::set_dns_cache_ttl(const int _dns_cache_ttl)
469 DNSCacheTTL = _dns_cache_ttl;