2 * @brief Logger class implementation. This class implements the Logging facility.
6 * @copyright Intra2net AG
17 #include <boost/foreach.hpp>
23 namespace po = boost::program_options;
25 typedef boost::shared_ptr<boost::program_options::options_description> Options_descriptionPtr;
35 , ExternalWarningLevel(0)
36 , ExternalLogOnlyOnce(false)
38 set_log_facility(Loglevel,Syslog,ExternalWarningLog,ExternalWarningLevel,ExternalLogOnlyOnce);
51 * Decides if a external log message can be send.
52 * @param msg The message to log.
54 bool Logger::is_allowed_to_send( const string& msg ) const
56 if ( (ExternalLogOnlyOnce) && (ExternalSendMessages.find(msg) != ExternalSendMessages.end()) )
63 * Clears the external send messages set.
65 void Logger::clear_external_send_messages()
67 ExternalSendMessages.clear();
72 * Decides if Logging through syslog if enabled or through std.
73 * @param msg The message to log.
75 void Logger::log_notice(const string& msg) const
78 syslog(LOG_NOTICE,msg.c_str());
85 * Escape shell arguments.
86 * @param input The input to escape.
87 * @return The escaped string ready to use for the shell.
89 string Logger::escape_shellarg(const string &input)
92 string::const_iterator it, it_end = input.end();
93 for (it = input.begin(); it != it_end; it++)
107 * Decides if Logging through syslog if enabled or through std.
108 * @param msg The message to log.
110 void Logger::log_warning(const string& msg, int level)
113 syslog(LOG_WARNING,msg.c_str());
117 if ( (level <= ExternalWarningLevel) && (!ExternalWarningLog.empty()) && (is_allowed_to_send(msg)) )
119 string message = msg;
120 // Remove endline from msg.
121 if (!message.empty() && message[message.length()-1] == '\n')
122 message.erase(message.length()-1); /*lint !e534 */
124 message = escape_shellarg(message);
126 string external = ExternalWarningLog;
127 external.append(" ");
128 external.append(message);
129 if ( system(external.c_str()) != 0 )
130 print_error_external_logging(external);
132 ExternalSendMessages.insert(msg); /*lint !e534 */
138 * Decides if Logging through syslog if enabled or through std.
139 * @param msg The message to log.
141 void Logger::log_error(const string& msg) const
144 syslog(LOG_ERR,msg.c_str());
151 * Setter for member Loglevel.
152 * @param _loglevel Value to set Loglevel to.
154 void Logger::set_external_log_only_once( const bool _external_log_only_once )
156 ExternalLogOnlyOnce = _external_log_only_once;
161 * Setter for member Loglevel.
162 * @param _loglevel Value to set Loglevel to.
164 void Logger::set_loglevel(const int _loglevel)
166 Loglevel = _loglevel;
171 * Getter for member Loglevel.
174 int Logger::get_loglevel() const
181 * Setter for member Syslog.
182 * @param _syslog Wether to log through syslog or not.
184 void Logger::set_syslog(const bool _syslog)
191 * Getter for member Syslog.
192 * @return True if logging through syslog is enabled, false otherwise.
194 bool Logger::get_syslog() const
201 * Initialize the logging facility.
203 void Logger::set_log_facility(const int _loglevel, const bool _syslog, const string& _external_error_log, const int _external_error_level, const bool _external_log_only_once )
205 Loglevel = _loglevel;
207 ExternalWarningLog = _external_error_log;
208 ExternalWarningLevel = _external_error_level;
209 ExternalLogOnlyOnce = _external_log_only_once;
212 openlog("bpdyndnsd",LOG_PID,LOG_DAEMON);
217 * Prints out the usage to the command line.
219 void Logger::print_usage(const Options_descriptionPtr opt_desc) const
222 if ( level <= Loglevel )
225 msg << "Usage: bpdyndnsd [Command line options]" << "\n" << endl;
226 msg << *opt_desc << endl;
227 log_notice(msg.str());
233 * Prints out the programm name and the given version string on stdout.
234 * @param version Version string.
236 void Logger::print_version() const
239 if ( level <= Loglevel )
242 msg << "Bullet proof dynamic dns daemon.\nbpdyndnsd " << VERSION << "." << REVISION << "." << RELEASE << endl;
243 log_notice(msg.str());
249 * Prints out the successful parsing of the command line options.
251 void Logger::print_cmd_parsed() const
254 if ( level <= Loglevel )
256 log_notice("Command line options successfully parsed.");
261 void Logger::print_conf_files_parsed() const
264 if ( level <= Loglevel )
266 log_notice("Config files successfully parsed.");
272 * Prints out the successful parsing of the config files.
273 * @param config_path The specified config path.
275 void Logger::print_conf_loaded(const string& config_path) const
278 if ( level <= Loglevel )
281 msg << "Config files successfully loaded in: " << config_path << endl;
282 log_notice(msg.str());
288 * Prints out the unsuccessful parsing of the config files.
289 * @param config_path The specified config path.
291 void Logger::print_conf_not_loaded(const string& config_path) const
294 if ( level <= Loglevel )
297 msg << "Config files couldn't be loaded in: " << config_path << endl;
298 log_error(msg.str());
304 * Prints out the unsuccessful parsing of the config files.
306 void Logger::print_conf_reload_failed_exit() const
309 if ( level <= Loglevel )
310 log_error("Config files couldn't be reloaded. Exiting.");
315 * A file could not be opened for reading.
316 * @param filename The filename.
318 void Logger::print_error_opening_r(const string& filename) const
321 if ( level <= Loglevel )
324 msg << "Error opening file for reading: " << filename << endl;
325 log_error(msg.str());
331 * A file could not be opened for writing.
332 * @param filename The filename.
334 void Logger::print_error_opening_rw(const string& filename) const
337 if ( level <= Loglevel )
340 msg << "Error opening file for writing: " << filename << endl;
341 log_error(msg.str());
347 * Desctructor of specified class was called.
348 * @param _class Name of the class.
350 void Logger::print_destructor_call(const string& _class) const
353 if ( level <= Loglevel )
356 msg << "Destructor call: " << _class << endl;
357 log_notice(msg.str());
363 * Constructor of specified class was called.
364 * @param _class Name of the class.
366 void Logger::print_constructor_call(const string& _class) const
369 if ( level <= Loglevel )
372 msg << "Constructor call: " << _class << endl;
373 log_notice(msg.str());
379 * Update method for specified service was called.
380 * @param service The service for which is the update running.
382 void Logger::print_update_service(const string& service) const
385 if ( level <= Loglevel )
388 msg << "Running update for service: " << service << endl;
389 log_notice(msg.str());
395 * An unknown option on the command line was detected.
396 * @param unknown_option The unknown option.
398 void Logger::print_unknown_cmd_option(const string& unknown_option) const
401 if ( level <= Loglevel )
404 msg << "Unknown option on command line detected: " << unknown_option << endl;
405 log_error(msg.str());
411 * An unknown protocol was specified.
412 * @param protocol The unknown protocol.
414 void Logger::print_unknown_protocol(const string& protocol) const
417 if ( level <= Loglevel )
420 msg << "Unknown protocol defined: " << protocol << endl;
421 log_error(msg.str());
427 * Loading a service config file.
428 * @param filename The service config file.
430 void Logger::print_load_service_conf(const string& filename) const
433 if ( level <= Loglevel )
436 msg << "Loading service config file: " << filename << endl;
437 log_notice(msg.str());
443 * Loading the main config file.
444 * @param filename The main config file.
446 void Logger::print_load_main_conf(const string& filename) const
449 if ( level <= Loglevel )
452 msg << "Loading main config file: " << filename << endl;
453 log_notice(msg.str());
459 * There is an unknown option in a service config file.
460 * @param unknown_option The unknown option.
462 void Logger::print_unknown_service_conf_option(const string& service_conf_file, const string& unknown_option) const
465 if ( level <= Loglevel )
468 msg << "Unknown option in service config file detected: " << service_conf_file << " Unknown option: " << unknown_option << endl;
469 log_error(msg.str());
475 * There is an unknown option in the main config file.
476 * @param unknown_option The unknown option.
478 void Logger::print_unknown_main_conf_option(const string& unknown_option) const
481 if ( level <= Loglevel )
484 msg << "Unknown option in main config file detected: " << unknown_option << endl;
485 log_error(msg.str());
491 * The defined config path doesn't exist or is not a directory.
492 * @param config_path The defined config path.
494 void Logger::print_error_config_path(const string& config_path) const
497 if ( level <= Loglevel )
500 msg << "Config path doesn't exists or is not a diretory: " << config_path << endl;
501 log_error(msg.str());
507 * There is a missing command line option to initialize a service object.
509 void Logger::print_missing_cmd_service_option() const
512 if ( level <= Loglevel )
514 log_error("Missing option to initialize service. Protocol, host, login and password must be specified.");
520 * Missing option in service config file.
521 * @param service_conf_file Service config file
523 void Logger::print_missing_service_conf_option(const string& service_conf_file) const
526 if ( level <= Loglevel )
529 msg << "Missing option in service config file " << service_conf_file << " to initialize service. Protocol, host, login and password must be specified." << endl;
530 log_error(msg.str());
536 * Process running as daemon.
537 * @param pid The pid of the daemon.
539 void Logger::print_runnig_as_daemon(const int pid) const
542 if ( level <= Loglevel )
545 msg << "Running as daemon: " << pid << endl;
546 log_notice(msg.str());
552 * Prints out the daemon mode.
553 * @param daemon_mode The daemon mode.
555 void Logger::print_daemon_mode(const bool daemon_mode) const
558 if ( level <= Loglevel )
560 string mode = "disabled";
561 if (daemon_mode == true)
564 msg << "Daemon mode is " << mode << "." << endl;
565 log_notice(msg.str());
571 * There was an error while trying to fork.
573 void Logger::print_error_fork() const
576 if ( level <= Loglevel )
578 log_error("Error while trying to fork.");
584 * A pid in the pidfile was found.
585 * @param pid The pid found in the pidfile.
587 void Logger::print_pid_found(const int pid) const
590 if ( level <= Loglevel )
593 msg << "Pidfile found: " << pid << ". Checking if process is still runnig..." << endl;
594 log_notice(msg.str());
600 * Another process is already running.
601 * @param pid The pid of the other process.
603 void Logger::print_process_already_running(const int pid) const
606 if ( level <= Loglevel )
609 msg << "Another bpdyndnsd process with PID " << pid << " is already running!" << endl;
610 log_error(msg.str());
618 void Logger::print_caught_sigterm() const
621 if ( level <= Loglevel )
623 log_notice("Caught SIGTERM. Exiting...");
631 void Logger::print_caught_siguser1() const
634 if ( level <= Loglevel )
636 log_notice("Caught SIGUSR1. Switching to offline mode...");
644 void Logger::print_caught_sighup() const
647 if ( level <= Loglevel )
649 log_notice("Caught SIGHUP. Reloading config...");
657 void Logger::print_caught_siguser2() const
660 if ( level <= Loglevel )
662 log_notice("Caught SIGUSR2. Switching to online mode...");
670 void Logger::print_caught_sigrtmin() const
673 if ( level <= Loglevel )
675 log_notice("Caught SIGRTMIN. Switching to online mode with webcheck enabled...");
681 * Error while setting signal handler.
683 void Logger::print_error_setting_signal(const string& signal) const
686 if ( level <= Loglevel )
689 msg << "Error while setting signal handler for: " << signal << endl;
690 log_error(msg.str());
696 * Error while setting signal handler.
698 void Logger::print_init_log_facility() const
701 if ( level <= Loglevel )
704 msg << "Initialized logging facility." << " Loglevel: " << Loglevel << " Syslog: " << Syslog << " ExternalLogOnlyOnce: " << ExternalLogOnlyOnce << endl;
705 log_notice(msg.str());
711 * Be verbose. Currently we are in offline mode.
713 void Logger::print_offline_mode() const
716 if ( level <= Loglevel )
718 log_notice("Offline mode...");
724 * Objects successfully serialized.
726 void Logger::print_serialized_objects_success() const
729 if ( level <= Loglevel )
731 log_notice("Serialized objects successfully.");
737 * Objects successfully de-serialized.
739 void Logger::print_deserialized_objects_success() const
742 if ( level <= Loglevel )
744 log_notice("De-serialized objects successfully.");
750 * Prints out the content of a service object.
751 * @param message Message to be added on output first.
752 * @param protocol Service's protocol.
753 * @param hostname Service's hostname.
754 * @param login Service's login.
755 * @param password Service's password.
756 * @param actual_ip Service's actual_ip.
757 * @param lastupdated Service's lastupdated.
759 void Logger::print_service_object(const string& message, const string& protocol, const string& hostname, const string& login, const string& password, const int update_interval, const int max_updates_within_interval, const int dns_cache_ttl , const string& actual_ip, list<time_t> lastupdated) const
762 if ( level <= Loglevel )
765 msg << message << endl;
766 msg << "\t" << "Protocol: " << protocol << endl;
767 msg << "\t" << "Hostname: " << hostname << endl;
768 msg << "\t" << "Login: " << login << endl;
769 msg << "\t" << "Password: " << password << endl;
770 msg << "\t" << "Update Interval: " << update_interval << endl;
771 msg << "\t" << "Max Updates: " << max_updates_within_interval << endl;
772 msg << "\t" << "DNS Cache TTL: " << dns_cache_ttl << endl;
773 msg << "\t" << "Actual_IP: " << actual_ip << endl;
774 BOOST_FOREACH( time_t update_time, lastupdated)
776 msg << "\t" << "Lastupdated: " << update_time << endl;
778 log_notice(msg.str());
784 * Caught exception while serialize.
785 * @param exception Exception message.
787 void Logger::print_exception_serialize(const string& errMsg) const
790 if ( level <= Loglevel )
793 msg << "Error while trying to serialize Serviceholder object: " << errMsg << endl;
794 log_error(msg.str());
800 * Caught exception while de-serialize.
801 * @param exception Exception message.
803 void Logger::print_exception_deserialize(const string& errMsg) const
806 if ( level <= Loglevel )
809 msg << "Error while trying to de-serialize Serviceholder object: " << errMsg << endl;
810 log_error(msg.str());
816 * Child couldn't be killed by parent.
817 * @param pid Pid of the child.
819 void Logger::print_error_kill_child(const int pid) const
822 if ( level <= Loglevel )
825 msg << "Could not kill child process with PID: " << pid << endl;
826 log_error(msg.str());
832 * Child was killed by parent because of error.
833 * @param pid The pid (child) killed.
835 void Logger::print_child_killed(const int pid) const
838 if ( level <= Loglevel )
841 msg << "Killed child process with PID: " << pid << endl;
842 log_notice(msg.str());
848 * There is no object file.
849 * @param object_file The object file.
851 void Logger::print_no_object_file(const string& object_file)
854 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
857 msg << "There is no object file: " << object_file << ". Continue without recovering state from old services!" << endl;
858 log_warning(msg.str(),level);
864 * Prints out the given hostname
865 * @param hostname Hostname as string.
867 void Logger::print_hostname(const string& hostname) const
870 if ( level <= Loglevel )
873 msg << "Detected following hostname of localhost: " << hostname << endl;
874 log_notice(msg.str());
880 * Prints out the detected own ipv4 address
881 * @param ip_addr String representation of the detected ip.
883 void Logger::print_own_ipv4(const string& ip_addr_v4, const string& hostname) const
886 if ( level <= Loglevel )
889 msg << "Detected following IPv4-Address of host: " << hostname << " : " << ip_addr_v4 << endl;
890 log_notice(msg.str());
896 * Prints out the detected own ipv5 address
897 * @param ip_addr String representation of the detected ip.
899 void Logger::print_own_ipv6(const string& ip_addr_v6, const string& hostname) const
902 if ( level <= Loglevel )
905 msg << "Detected following IPv6-Address of host: " << hostname << " : " << ip_addr_v6 << endl;
906 log_notice(msg.str());
912 * Exception while trying to resolve hostname to ip.
913 * @param exception The exception caught.
914 * @param hostname The hostname.
916 void Logger::print_error_hostname_to_ip(const string& errMsg, const string& hostname) const
919 if ( level <= Loglevel )
922 msg << "Could not resolve the hostname: " << hostname << " to an IP-Address: " << errMsg << endl;
923 log_error(msg.str());
929 * The update of the given service was successful.
930 * @param service The service.
932 void Logger::print_update_service_successful(const string& service) const
935 if ( level <= Loglevel )
938 msg << "Updated service successful: " << service << endl;
939 log_notice(msg.str());
945 * No ip could be determined through webcheck
947 void Logger::print_webcheck_no_ip()
950 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
952 log_warning("IP-Address of this host could not be determined through any configured webcheck url.",level);
958 * Connection problem while trying to get ip through webcheck url
959 * @param curl_err_buff Curl error message
962 void Logger::print_webcheck_url_connection_problem(const char * curl_err_buff, const string& url)
965 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
968 msg << "There was a problem while trying to connect to following URL: " << url << " CURL error: " << curl_err_buff << endl;
969 log_warning(msg.str(),level);
975 * Prints out curl error.
976 * @param curl_err_buff Curl error message.
979 void Logger::print_webcheck_error(const char * curl_err_buff, const string& url) const
982 if ( level <= Loglevel )
985 msg << "There was an error while trying to connect to following URL: " << url << " CURL error: " << curl_err_buff << endl;
986 log_error(msg.str());
992 * Prints out the received data through curl.
993 * @param curl_data Data string
995 void Logger::print_received_curl_data(const string& curl_data) const
998 if ( level <= Loglevel )
1001 msg << "Received CURL data: " << curl_data << endl;
1002 log_notice(msg.str());
1008 * IP was foudn through regex
1009 * @param ip The IP found.
1011 void Logger::print_regex_found_ip(const string& ip) const
1014 if ( level <= Loglevel )
1017 msg << "Found IP-Address via regex: " << ip << endl;
1018 log_notice(msg.str());
1024 * No IP was found through regex.
1025 * @param data The data string which should contain a valid IP.s
1027 void Logger::print_regex_ip_not_found(const string& data)
1030 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
1033 msg << "Could not extract an IP-Address via regex from following data:\n" << data << endl;
1034 log_warning(msg.str(),level);
1040 * Detected multiple occurrences of the same option.
1041 * @param message Error message.
1043 void Logger::print_multiple_cmd_option(const string& message) const
1046 if ( level <= Loglevel )
1049 msg << "The same option is only allowed once: " << message << endl;
1050 log_error(msg.str());
1056 * An update would exceed the update interval. Prints out a warning message.
1057 * @param current_time Current time.
1058 * @param old_time Time of update #MaxUpdatesWithinInterval ago.
1059 * @param MaxUpdatesWithinInterval Number of allowed updates in one update interval.
1060 * @param service The service which exceeds update interval.
1062 void Logger::print_update_not_allowed(const time_t current_time, const time_t old_time, const int MaxUpdatesWithinInterval, const string& service)
1065 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
1068 msg << "Update not allowed for service: " << service << ". Too many updates within max update interval. Current time: " << current_time << ". Update time before " << MaxUpdatesWithinInterval << " updates: " << old_time << endl;
1069 log_warning(msg.str(),level);
1075 * Failure while running update for service.
1076 * @param service Services' name.
1078 void Logger::print_update_service_failure(const string& service)
1081 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
1084 msg << "Could not update service: " << service << endl;
1085 log_warning(msg.str(),level);
1093 void Logger::print_starting_shutdown() const
1096 if ( level <= Loglevel )
1098 log_notice("Shutting down ...");
1106 void Logger::print_shutdown_succeeded() const
1109 if ( level <= Loglevel )
1111 log_notice("Shutting down complete ...");
1117 * Shutdown parent succeeded
1119 void Logger::print_shutdown_parent_succeeded() const
1122 if ( level <= Loglevel )
1124 log_notice("Shutting down parent process completed ...");
1130 * Starting shutdown parent
1132 void Logger::print_starting_shutdown_parent() const
1135 if ( level <= Loglevel )
1137 log_notice("Shutting down parent process ...");
1143 * DNS cache record timeout
1144 * @param hostname Hostname
1145 * @param lastupdated Lastupdated
1146 * @param dns_cache_ttl DNS cache TTL
1147 * @param current_time Current time
1149 void Logger::print_recheck_dns_entry(const string& hostname, const int lastupdated, const int dns_cache_ttl, const int current_time) const
1152 if ( level <= Loglevel )
1155 msg << "DNS cache record for host <" << hostname << "> expired or host will be updated for the first time: Lastupdated: " << lastupdated << " DNS cache ttl: " << dns_cache_ttl << " Current time: " << current_time << " Checking current DNS cache status." << endl;
1156 log_notice(msg.str());
1162 * Missing proxy option on command line.
1164 void Logger::print_missing_cmd_proxy_option() const
1167 if ( level <= Loglevel )
1169 log_error("Missing option to initialize proxy. http_proxy and http_proxy_port must be specified.");
1175 * Multiple option in service config file.
1176 * @param service_conf_file Service config file
1177 * @param message Multiple option text
1179 void Logger::print_multiple_service_conf_option(const string& service_conf_file, const string& message) const
1182 if ( level <= Loglevel )
1185 msg << "Multiple occurrences of the same option in service config file detected: " << service_conf_file << " " << message << endl;
1186 log_error(msg.str());
1192 * Multiple option in main config file.
1193 * @param service_conf_file Service config file
1194 * @param message Multiple option text
1196 void Logger::print_multiple_main_conf_option(const string& main_conf_file, const string& message) const
1199 if ( level <= Loglevel )
1202 msg << "Multiple occurrences of the same option in main config file detected: " << main_conf_file << " " << message << endl;
1203 log_error(msg.str());
1209 * Missing proxy option in main config file.
1210 * @param main_conf_filename The concerning config file.
1212 void Logger::print_missing_conf_proxy_option(const string& main_conf_filename) const
1215 if ( level <= Loglevel )
1218 msg << "Missing option to initialize proxy in main config file: " << main_conf_filename << " http_proxy and http_proxy_port must be specified." << endl;
1219 log_error(msg.str());
1225 * There is no domain part in the given hostname
1226 * @param hostname The hostname with no domain part in it.
1228 void Logger::print_no_domain_part(const string& hostname) const
1231 if ( level <= Loglevel )
1234 msg << "There is no domain part in the given hostname: " << hostname << endl;
1235 log_notice(msg.str());
1241 * Service is not initialized properly.
1242 * @param service The service.
1244 void Logger::print_httphelper_not_initialized() const
1247 if ( level <= Loglevel )
1249 log_error("HTTP-Helper is not initialized properly.");
1255 * An curl error occured.
1256 * @param msg The error message
1257 * @param curl_err_code The resulting curl error code
1259 void Logger::print_curl_error_init(const std::string& err_msg, const CURLcode curl_err_code) const
1261 string curl_err = "";
1263 if ( curl_err_code == CURLE_FAILED_INIT )
1264 curl_err = "CURLE_FAILED_INIT";
1266 curl_err = "UNKNOWN";
1269 if ( (level <= Loglevel) )
1272 msg << "Curl error: " << err_msg << " Curl error code: " << curl_err_code << " " << curl_err << endl; /*lint !e641 */
1273 log_error(msg.str());
1279 * An curl error occured.
1280 * @param url The url requested by the curl operation
1281 * @param curl_err_code The resulting curl error code
1283 void Logger::print_curl_error(const string& url, const CURLcode curl_err_code) const
1285 string curl_err = "";
1287 if ( curl_err_code == CURLE_URL_MALFORMAT )
1288 curl_err = "CURLE_URL_MALFORMAT";
1289 else if ( curl_err_code == CURLE_COULDNT_RESOLVE_HOST )
1290 curl_err = "CURLE_COULDNT_RESOLVE_HOST";
1291 else if ( curl_err_code == CURLE_COULDNT_CONNECT )
1292 curl_err = "CURLE_COULDNT_CONNECT";
1294 curl_err = "UNKNOWN";
1297 if ( (level <= Loglevel) )
1300 msg << "Curl error while requesting following url: " << url << " Curl error code: " << curl_err_code << " " << curl_err << endl; /*lint !e641 */
1301 log_error(msg.str());
1307 * An curl error occured.
1308 * @param url The url requested by the curl operation
1309 * @param curl_err_code The resulting curl error code
1310 * @param curl_err_buff The curl error buffer
1312 void Logger::print_curl_error(const string& url, const CURLcode curl_err_code, const char * curl_err_buff) const
1314 string curl_err = "";
1316 if ( curl_err_code == CURLE_URL_MALFORMAT )
1317 curl_err = "CURLE_URL_MALFORMAT";
1318 else if ( curl_err_code == CURLE_COULDNT_RESOLVE_HOST )
1319 curl_err = "CURLE_COULDNT_RESOLVE_HOST";
1320 else if ( curl_err_code == CURLE_COULDNT_CONNECT )
1321 curl_err = "CURLE_COULDNT_CONNECT";
1323 curl_err = "UNKNOWN";
1326 if ( (level <= Loglevel) )
1329 msg << "Curl error while requesting following url: " << url << " Curl error code: " << curl_err_code << " " << curl_err << " " << curl_err_buff << endl; /*lint !e641 */
1330 log_error(msg.str());
1336 * Prints out the data received by curl operation
1337 * @param CurlWritedataBuff
1339 void Logger::print_curl_data(const string& curl_writedata_buff) const
1342 if ( level <= Loglevel )
1345 msg << "Data received by curl: " << curl_writedata_buff << endl;
1346 log_notice(msg.str());
1352 * Not authorized to perform requested update operation
1353 * @param service The requested service.
1354 * @param username Username
1355 * @param password Password
1357 void Logger::print_service_not_authorized(const string& service, const string& username, const string& password) const
1360 if ( level <= Loglevel )
1363 msg << "Not authorized to perform update operation on service: " << service << " Please check username and password: " << username << ":" << password << endl;
1364 log_notice(msg.str());
1370 * Prints out the http status code
1372 * @param output HTTP status code
1374 void Logger::print_http_status_code(const string& url, const long http_code) const
1377 if ( level <= Loglevel )
1380 msg << "Requested URL: " << url << " Received HTTP status code: " << http_code << endl;
1381 log_notice(msg.str());
1387 * Generic failure while trying to update service
1388 * @param url The requested URL
1389 * @param curl_data The received curl_data from the server
1391 void Logger::print_update_failure(const string& url, const string& curl_data) const
1394 if ( (level <= Loglevel) )
1397 msg << "Problem while trying to updating service. Requested URL: " << url << " Error Code from Server: " << curl_data << endl;
1398 log_error(msg.str());
1404 * Generic failure while trying to update service
1405 * @param url The requested URL
1406 * @param http_status_code The received http status code
1408 void Logger::print_update_failure(const string& url, const long http_status_code) const
1411 if ( level <= Loglevel )
1414 msg << "Problem while trying to updating service. Requested URL: " << url << " Error Code from Server: " << http_status_code << endl;
1415 log_error(msg.str());
1420 * Hostname is invalid, contains no or only one domain part.
1421 * @param hostname The full qualified host name.
1423 void Logger::print_invalid_hostname(const string& hostname)
1426 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
1429 msg << "The configured hostname: " << hostname << " is invalid. Please add the corresponding domain part." << endl;
1430 log_warning(msg.str(),level);
1436 * An IP in a private range was detected
1437 * @param ip The private IP
1439 void Logger::print_ip_is_local(const string& ip)
1442 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
1445 msg << "The detected IP is within a private IP range: " << ip << endl;
1446 log_warning(msg.str(),level);
1452 * Regex is matching in string
1453 * @param regex The regex pattern
1454 * @param matching_string The string
1456 void Logger::print_regex_match(const string& regex, const string& matching_string) const
1459 if ( level <= Loglevel )
1462 msg << "Regex: " << regex << " is matching in: " << matching_string << endl;
1463 log_notice(msg.str());
1469 * Regex is not matching
1470 * @param regex Regex
1471 * @param not_matching_string String
1473 void Logger::print_no_regex_match(const string& regex, const string& not_matching_string)
1476 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
1479 msg << "Regex: " << regex << " is not matching in: " << not_matching_string << endl;
1480 log_warning(msg.str(),level);
1486 * Could not parse gnudip initial reply.
1487 * @param curl_data The data received from gnudip server which should contain salt, time and sign.
1489 void Logger::print_could_not_parse_received_data(const string& curl_data) const
1492 if ( (level <= Loglevel) )
1495 msg << "Could not parse salt, time and sign from initial gnudip server reply: " << curl_data << endl;
1496 log_error(msg.str());
1502 * Gnudip salt, time and sign could not be got from map
1504 void Logger::print_could_not_get_initial_gnudip_data() const
1507 if ( (level <= Loglevel) )
1509 log_error("Could not get salt, time and sign from map.");
1516 * Gnudip protocol requires explicit declaration of a servername.
1518 void Logger::print_gnudip_requires_servername()
1521 if ( (level <= Loglevel) || ((level <= ExternalWarningLevel) && (!ExternalWarningLog.empty())) )
1523 log_warning("Gnudip requires explicit definition of servername via config!",level);
1529 * An exception occured while computing the md5 sum.
1530 * @param what The exception occured.
1532 void Logger::print_exception_md5_sum(const string& what) const
1535 if ( level <= Loglevel )
1538 msg << "An exception occured while computing a md5 sum: " << what << endl;
1539 log_error(msg.str());
1545 * An network exception occured.
1546 * @param what The exception occured.
1548 void Logger::print_network_error(const string& what) const
1551 if ( level <= Loglevel )
1554 msg << "An netowrk exception occured: " << what << endl;
1555 log_error(msg.str());
1561 * An undefined protocol error occured.
1562 * @param protocol The protocol
1563 * @param error The error
1565 void Logger::print_undefined_protocol_error(const string& protocol, const string& error) const
1568 if ( level <= Loglevel )
1571 msg << "An undefined protocol error occured. Protocol: " << protocol << " Error: " << error << endl;
1572 log_error(msg.str());
1577 * Error while trying to log through external program.
1578 * @param external_prog The external program called.
1580 void Logger::print_error_external_logging(const string& external_prog) const
1583 if ( level <= Loglevel )
1586 msg << "Error while trying to log through external program: " << external_prog << endl;
1587 log_notice(msg.str());
1593 * Error while parsing config file.
1594 * @param error Error occured.
1595 * @param config_file Config file.
1597 void Logger::print_error_parsing_config_file(const string& filename, const string& error) const
1600 if ( level <= Loglevel )
1603 msg << "Error while parsing config file: " << filename << " Error: " << error << endl;
1604 log_notice(msg.str());
1610 * Error while parsing cmd option
1611 * @param error Error
1613 void Logger::print_error_parsing_cmd(const string& error) const
1616 if ( level <= Loglevel )
1619 msg << "Error while parsing cmd options: " << error << endl;
1620 log_error(msg.str());
1626 * The webcheck interval was exceeded, so webcheck not allowed.
1627 * @param last_webcheck Time of last webcheck.
1628 * @param webcheck_interval Webcheck interval time.
1629 * @param current_time Current system time.
1631 void Logger::print_webcheck_exceed_interval( const time_t last_webcheck, const int webcheck_interval, const time_t current_time ) const
1634 if ( level <= Loglevel )
1637 msg << "Exceeding webcheck interval: LastWebcheck " << last_webcheck << " + WebcheckInterval(sec) " << webcheck_interval << " >= CurrentTime " << current_time << endl;
1638 log_notice(msg.str());
1644 * Checking if hosts needs update.
1645 * @param hostname Hostname
1646 * @param current_time Current time
1647 * @param lastupdated Last updated
1649 void Logger::print_check_service_update(const string& hostname, const time_t current_time, const time_t lastupdated) const
1652 if ( level <= Loglevel )
1655 msg << "Checking if host: " << hostname << " needs update. Current time: " << current_time << " Last updated: " << lastupdated << endl;
1656 log_notice(msg.str());
1663 * @param hostname Hostname
1664 * @param ip_dns_recheck DNS recheck IP
1665 * @param ip_last_update IP set in last update
1666 * @param ip_host Hosts' IP
1668 void Logger::print_cached_dns_entry(const string& hostname, const string& ip_dns_recheck, const string& ip_last_update, const string& ip_host) const
1671 if ( level <= Loglevel )
1674 msg << "Cached DNS record for host <" << hostname << "> : " << ip_dns_recheck << " Last updated IP: " << ip_last_update << " Hosts IP: " << ip_host << endl;
1675 log_notice(msg.str());
1682 * @param hostname Hostname
1683 * @param ip_dns_recheck Cached DNS entry
1684 * @param ip_last_update IP set in last update
1685 * @param ip_host Hosts IP
1686 * @param lastupdated Lastupdated
1688 void Logger::print_update_service(const string& hostname, const string& ip_dns_recheck, const string& ip_last_update, const string& ip_host, const time_t lastupdated) const{
1690 if ( level <= Loglevel )
1693 msg << "Updating service. Hostname: " << hostname << " DNS-Record: " << ip_dns_recheck << " IP set in last update: " << ip_last_update << " Lastupdated: " << lastupdated << " Hosts IP: " << ip_host << endl;
1694 log_notice(msg.str());
1701 * @param hostname Hostname
1702 * @param ip_dns_recheck Cached DNS entry
1703 * @param ip_last_update IP set in last update
1704 * @param ip_host Hosts IP
1705 * @param lastupdated Last updated
1706 * @param dns_cache_ttl DNS cache ttl
1707 * @param current_time Current time
1709 void Logger::print_update_service_ttl_expired(const string& hostname, const string& ip_dns_recheck, const string& ip_last_update, const string& ip_host, const time_t lastupdated, const int dns_cache_ttl, const time_t current_time) const
1712 if ( level <= Loglevel )
1715 msg << "TTL for service expired and still pointing to old IP. Hostname: " << hostname << " DNS-Record: " << ip_dns_recheck << " IP set in last update: " << ip_last_update << " Lastupdated: " << lastupdated << "DNS Cache TTL: " << dns_cache_ttl << " Current Time: " << current_time << " Hosts IP: " << ip_host << endl;
1716 log_notice(msg.str());
1723 * @param override_log_level Override log level with zero if true
1724 * @param hostname Hostname
1725 * @param ip_dns_recheck Cached DNS entry
1726 * @param ip_last_update IP set in last update
1727 * @param ip_host Hosts IP
1728 * @param lastupdated Last updated
1729 * @param dns_cache_ttl DNS cache ttl
1730 * @param current_time Current time
1732 void Logger::print_update_service_ttl_not_expired(bool override_log_level, const string& hostname, const string& ip_dns_recheck, const string& ip_last_update, const string& ip_host, const time_t lastupdated, const int dns_cache_ttl, const time_t current_time) const
1736 if (override_log_level)
1739 if ( level <= Loglevel )
1742 msg << "Waiting for DNS cache TTL to expire. Hostname: " << hostname << " DNS-Record: " << ip_dns_recheck << " IP set in last update: " << ip_last_update << " Lastupdated: " << lastupdated << "DNS Cache TTL: " << dns_cache_ttl << " Current Time: " << current_time << " Hosts IP: " << ip_host << endl;
1743 log_notice(msg.str());
1750 * @param override_log_level Override log level with zero if true
1751 * @param hostname Hostname
1752 * @param ip_dns_recheck Cached DNS entry
1753 * @param ip_last_update IP set in last update
1754 * @param ip_host Hosts IP
1755 * @param lastupdated Last updated
1757 void Logger::print_no_update_needed(bool override_log_level, const string& hostname, const string& ip_dns_recheck, const string& ip_last_update, const string& ip_host, const time_t lastupdated) const
1761 if (override_log_level)
1764 if ( level <= Loglevel )
1767 msg << "No update needed for host: " << hostname << " Cached DNS record: " << ip_dns_recheck << " IP set in last update: " << ip_last_update << " Hosts IP: " << ip_host << " Last updated: " << lastupdated << endl;
1768 log_notice(msg.str());
1774 * Error while trying to get local wan interface IP address through getifaddrs.
1775 * @param error The system call which raised the error.
1776 * @param error The error set by getifaddrs.
1778 void Logger::print_error_getting_local_wan_ip(const std::string& system_call, const std::string& error) const
1781 if ( level <= Loglevel )
1784 msg << "Error while trying to get local wan interface IP address through '" << system_call << "': " << error << endl;
1785 log_error(msg.str());
1791 * Could not get IP address of local wan interface.
1792 * @param override_log_level Override log level with zero if true
1794 void Logger::print_no_wan_ip(bool override_log_level) const
1798 if (override_log_level)
1801 if ( level <= Loglevel )
1804 msg << "Could not get IP address of local wan interface. Will retry later." << endl;
1805 log_error(msg.str());
1810 * Print extenral WAN IP
1811 * @param override_log_level Override log level with zero if true
1812 * @param ip External WAN IP
1814 void Logger::print_external_wan_ip(bool override_log_level, const std::string &ip) const
1818 if (override_log_level)
1821 if ( level <= Loglevel )
1824 msg << "Determined WAN interface IP: " << ip << endl;
1825 log_error(msg.str());
1830 * Could not resolve current IP for DNS name
1831 * @param override_log_level Override log level with zero if true
1833 void Logger::print_dns_lookup_failed(bool override_log_level, const std::string &hostname) const
1837 if (override_log_level)
1840 if ( level <= Loglevel )
1843 msg << "Could not resolve IP address for host " << hostname << ". Will retry later." << endl;
1844 log_error(msg.str());
1850 * Invalid service config was detected.
1852 void Logger::print_invalid_service_config() const
1855 if ( level <= Loglevel )
1857 log_error("Ignoring invalid service. Please check.\n");
1863 * Print simple message.
1865 void Logger::print_msg( const string& msg ) const
1868 if ( level <= Loglevel )