developer.intra2net.com Git - bpdyndnsd/blob - src/logger.hpp

   1 /** @file
   2  * @brief Logger class header. This class represents the Logging facility.
   3  *
   4  *
   5  *
   6  * @copyright Intra2net AG
   7  * @license GPLv2
   8 */
   9
  10 #ifndef LOGGER_H
  11 #define LOGGER_H
  12
  13 #include <string>
  14 #include <list>
  15
  16 #include <boost/program_options.hpp>
  17 #include <boost/shared_ptr.hpp>
  18
  19 #include <curl/curl.h>
  20
  21 class Logger
  22 {
  23
  24 private:
  25
  26     int Loglevel;
  27     bool Syslog;
  28     std::string ExternalWarningLog;
  29     int ExternalWarningLevel;
  30     std::set<std::string> ExternalSendMessages;
  31     bool ExternalLogOnlyOnce;
  32
  33 public:
  34
  35     typedef boost::shared_ptr<Logger> Ptr;
  36
  37     Logger();
  38
  39     ~Logger();
  40
  41     void set_external_log_only_once( const bool _external_log_only_once );
  42
  43     void clear_external_send_messages();
  44
  45     std::string escape_shellarg(const std::string &input);
  46
  47     void log_notice(const std::string& msg) const;
  48
  49     void log_warning(const std::string& msg, int loglevel);
  50
  51     void log_error(const std::string& msg) const;
  52
  53     void set_loglevel(const int _loglevel);
  54
  55     int get_loglevel() const;
  56
  57     void set_syslog(const bool _syslog);
  58
  59     bool get_syslog() const;
  60
  61     void set_log_facility(const int _loglevel, const bool _syslog, const std::string& _external_error_log, const int _external_error_level, const bool _external_log_only_once );
  62
  63     bool is_allowed_to_send( const std::string& msg ) const;
  64
  65     // Start log messages.
  66
  67     void print_usage(const boost::shared_ptr<boost::program_options::options_description> opt_desc) const;
  68
  69     void print_version() const;
  70
  71     void print_started() const;
  72
  73     void print_cmd_parsed() const;
  74
  75     void print_conf_files_parsed() const;
  76
  77     void print_destructor_call(const std::string& _class) const;
  78
  79     void print_constructor_call(const std::string& _class) const;
  80
  81     void print_update_service(const std::string& service) const;
  82
  83     void print_update_service_is_blocked(const std::string& service, int remaining_seconds) const;
  84
  85     void print_block_service(const std::string& service, int block_seconds) const;
  86
  87     void print_unknown_cmd_option(const std::string& unknown_option) const;
  88
  89     void print_unknown_protocol(const std::string& protocol) const;
  90
  91     void print_load_service_conf(const std::string& filename) const;
  92
  93     void print_load_main_conf(const std::string& filename) const;
  94
  95     void print_unknown_service_conf_option(const std::string& service_conf_file, const std::string& unknown_option) const;
  96
  97     void print_unknown_main_conf_option(const std::string& unknown_option) const;
  98
  99     void print_error_opening_r(const std::string& filename) const;
 100
 101     void print_error_opening_rw(const std::string& filename) const;
 102
 103     void print_error_config_path(const std::string& config_path) const;
 104
 105     void print_conf_loaded(const std::string& config_path) const;
 106
 107     void print_conf_not_loaded(const std::string& config_path) const;
 108
 109     void print_conf_reload_failed_exit() const;
 110
 111     void print_missing_cmd_service_option() const;
 112
 113     void print_missing_service_conf_option(const std::string& service_conf_file) const;
 114
 115     void print_runnig_as_daemon(const int pid) const;
 116
 117     void print_daemon_mode(const bool daemon_mode) const;
 118
 119     void print_error_fork() const;
 120
 121     void print_pid_found(const int pid) const;
 122
 123     void print_process_already_running(const int pid) const;
 124
 125     void print_caught_sigterm() const;
 126
 127     void print_caught_siguser1() const;
 128
 129     void print_caught_sighup() const;
 130
 131     void print_caught_siguser2() const;
 132
 133     void print_caught_sigrtmin() const;
 134
 135     void print_caught_sigrtmax(int new_loglevel) const;
 136
 137     void print_error_setting_signal(const std::string& signal) const;
 138
 139     void print_init_log_facility() const;
 140
 141     void print_offline_mode() const;
 142
 143     void print_sleep_dialup_mode(time_t sleep_until) const;
 144
 145     void print_serialized_objects_success() const;
 146
 147     void print_deserialized_objects_success() const;
 148
 149     void print_service_object(const std::string& message, const std::string& protocol, const std::string& hostname, const std::string& login, const std::string& password, const int update_interval, const int max_updates_within_interval, const int max_equal_updates_in_succession, const int dns_cache_ttl , const std::string& actual_ip, std::map<time_t,std::string> lastupdates, const bool activated) const;
 150
 151     void print_exception_serialize(const std::string& errMsg) const;
 152
 153     void print_exception_deserialize(const std::string& errMsg) const;
 154
 155     void print_error_kill_child(const int pid) const;
 156
 157     void print_child_killed(const int pid) const;
 158
 159     void print_no_object_file(const std::string& object_file);
 160
 161     void print_hostname(const std::string& hostname) const;
 162
 163     void print_own_ipv4(const std::string& ip_addr_v4, const std::string& hostname) const;
 164
 165     void print_own_ipv6(const std::string& ip_addr_v6, const std::string& hostname) const;
 166
 167     void print_error_hostname_to_ip(const std::string& errMsg, const std::string& hostname) const;
 168
 169     void print_update_service_successful(const std::string& service, const std::string& ip_addr) const;
 170
 171     void print_webcheck_no_ip();
 172
 173     void print_no_wan_ip(bool override_log_level) const;
 174
 175     void print_external_wan_ip(bool override_log_level, const std::string &wan_ip) const;
 176
 177     void print_dns_lookup_failed(bool override_log_level, const std::string &hostname) const;
 178
 179     void print_webcheck_url_connection_problem(const char * curl_err_buff, const std::string& url);
 180
 181     void print_webcheck_error(const char * curl_err_buff, const std::string& url) const;
 182
 183     void print_received_curl_data(const std::string& curl_data) const;
 184
 185     void print_regex_found_ip(const std::string& ip) const;
 186
 187     void print_regex_ip_not_found(const std::string& data);
 188
 189     void print_multiple_cmd_option(const std::string& message) const;
 190
 191     void print_multiple_service_conf_option(const std::string& service_conf_file, const std::string& message) const;
 192
 193     void print_multiple_main_conf_option(const std::string& main_conf_file, const std::string& message) const;
 194
 195     void print_update_not_allowed(bool override_log_level, const time_t current_time, const time_t old_time, const int MaxUpdatesWithinInterval, const std::string& service);
 196
 197     void print_update_service_failure(const std::string& service);
 198
 199     void print_starting_shutdown() const;
 200
 201     void print_shutdown_succeeded() const;
 202
 203     void print_shutdown_parent_succeeded() const;
 204
 205     void print_starting_shutdown_parent() const;
 206
 207     void print_recheck_dns_entry(const std::string& hostname, const int lastupdated, const int dns_cache_ttl, const int current_time) const;
 208
 209     void print_missing_cmd_proxy_option() const;
 210
 211     void print_missing_conf_proxy_option(const std::string& main_conf_filename) const;
 212
 213     void print_no_domain_part(const std::string& hostname) const;
 214
 215     void print_curl_error_init(const std::string& err_msg, const CURLcode curl_err_code) const;
 216
 217     void print_curl_error(const std::string& url, const CURLcode curl_err_code) const;
 218
 219     void print_curl_error(const std::string& url, const CURLcode curl_err_code, const char * curl_err_buff) const;
 220
 221     void print_curl_data(const std::string& curl_writedata_buff) const;
 222
 223     void print_service_not_authorized(const std::string& service, const std::string& username, const std::string& password) const;
 224
 225     void print_httphelper_not_initialized() const;
 226
 227     void print_http_status_code(const std::string& url, const long http_code) const;
 228
 229     void print_update_failure(const std::string& url, const std::string& curl_data) const;
 230
 231     void print_update_failure(const std::string& url, const long http_status_code) const;
 232
 233     void print_invalid_hostname(const std::string& hostname);
 234
 235     void print_ip_is_local(const std::string& ip);
 236
 237     void print_regex_match(const std::string& regex, const std::string& matching_string) const;
 238
 239     void print_no_regex_match(const std::string& regex, const std::string& not_matching_string);
 240
 241     void print_could_not_parse_received_data(const std::string& curl_data) const;
 242
 243     void print_could_not_get_initial_gnudip_data() const;
 244
 245     void print_gnudip_requires_servername();
 246
 247     void print_exception_md5_sum(const std::string& what) const;
 248
 249     void print_network_error(const std::string& what) const;
 250
 251     void print_undefined_protocol_error(const std::string& protocol, const std::string& error) const;
 252
 253     void print_error_external_logging(const std::string& external_prog) const;
 254
 255     void print_error_parsing_config_file(const std::string& filename, const std::string& error) const;
 256
 257     void print_error_parsing_cmd(const std::string& error) const;
 258
 259     void print_webcheck_exceed_interval( const time_t last_webcheck, const int webcheck_interval, const time_t current_time ) const;
 260
 261     void print_check_service_update(const std::string& hostname, const time_t current_time, const time_t lastupdated) const;
 262
 263     void print_cached_dns_entry(const std::string& hostname, const std::string& ip_dns_recheck, const std::string& ip_last_update, const std::string& ip_host) const;
 264
 265     void print_update_service(const std::string& hostname, const std::string& ip_dns_recheck, const std::string& ip_last_update, const std::string& ip_host, const time_t lastupdated) const;
 266
 267     void print_update_service_ttl_expired(const std::string& hostname, const std::string& ip_dns_recheck, const std::string& ip_last_update, const std::string& ip_host, const time_t lastupdated, const int dns_cache_ttl, const time_t current_time) const;
 268
 269     void print_update_service_ttl_not_expired(bool override_log_level, const std::string& hostname, const std::string& ip_dns_recheck, const std::string& ip_last_update, const std::string& ip_host, const time_t lastupdated, const int dns_cache_ttl, const time_t current_time) const;
 270
 271     void print_no_update_needed(bool override_log_level, const std::string& hostname, const std::string& ip_dns_recheck, const std::string& ip_last_update, const std::string& ip_host, const time_t lastupdated) const;
 272
 273     void print_error_getting_local_wan_ip(const std::string& system_call, const std::string& error) const;
 274
 275     void print_invalid_service_config() const;
 276
 277     void print_msg( const std::string& msg ) const;
 278
 279     void print_last_updates( const std::string& ip_host, const time_t current_time, const int update_interval, const int max_updates_within_interval, const int max_equal_updates_in_succession, const std::map<time_t,std::string>& last_updates, const std::string& servicename ) const;
 280
 281     void print_ip_burnt( const std::string& ip_host, const std::string& hostname ) const;
 282 };
 283
 284 #endif