2 * @brief Config class implementation. This class represents the actual configuration.
6 * @copyright Intra2net AG
12 #include "service_dhs.h"
13 #include "service_ods.h"
14 #include "service_dyndns.h"
15 #include "service_dyns.h"
16 #include "service_easydns.h"
17 #include "service_tzo.h"
18 #include "service_zoneedit.h"
19 #include "service_gnudip.h"
25 #include <boost/foreach.hpp>
26 #include <boost/filesystem.hpp>
27 #include <boost/regex.hpp>
28 #include <boost/algorithm/string.hpp>
31 namespace po = boost::program_options;
32 namespace fs = boost::filesystem;
33 namespace ba = boost::algorithm;
35 typedef boost::shared_ptr<boost::program_options::options_description> Options_descriptionPtr;
41 * Default Constructor. Available command line and config file options with their default values are defined here.
45 , ServiceHolder(new Serviceholder)
50 , ConfigPath("/etc/bpdyndnsd")
53 , ExternalWarningLog("")
54 , ExternalWarningLevel(0)
57 // Available service description config options
58 po::options_description opt_desc_service("Service description options");
59 opt_desc_service.add_options()
60 ("protocol",po::value<string>(),"The service protocol.")
61 ("server",po::value<string>(),"Servername needed for gnudip protocol.")
62 ("host",po::value<string>(),"The hostname to update.")
63 ("login",po::value<string>(),"Login name.")
64 ("password",po::value<string>(),"Corresponding password.")
65 ("update_interval",po::value<int>()->default_value(-1),"Update interval in minutes.")
66 ("max_updates_within_interval",po::value<int>()->default_value(-1),"How many updates can be made in one interval.")
67 ("dns_cache_ttl",po::value<int>()->default_value(-1),"How long a dns record is valid.")
70 // Available command line only options
71 po::options_description opt_desc_cmd_only("Command line only options");
72 opt_desc_cmd_only.add_options()
73 ("help,?","Show help.")
74 ("version,v","Show version.")
75 ("config,c",po::value<string>()->default_value("/etc/bpdyndnsd"),"Set the config path.")
78 // Available generic options. Valid on cmd or in config file.
79 po::options_description opt_desc_generic("Generic config options");
80 opt_desc_generic.add_options()
81 ("daemon_mode",po::value<bool>()->default_value(false),"Run as system daemon.")
82 ("loglevel",po::value<int>()->default_value(0),"Loglevel.")
83 ("syslog",po::value<bool>()->default_value(false),"Use syslog facility.")
84 ("enable_ipv6",po::value<bool>()->default_value(false),"Try to use IPv6.")
85 ("webcheck_url",po::value<string>()->default_value(""),"Use this URL to determine IP.")
86 ("webcheck_url_alt",po::value<string>()->default_value(""),"Use this alternative URL to determine IP.")
87 ("webcheck_interval",po::value<int>()->default_value(10),"The webcheck interval in minutes.")
88 ("http_proxy",po::value<string>(),"Use this proxy for all http requests.")
89 ("http_proxy_port",po::value<int>(),"Port of the proxy.")
90 ("external_warning_log",po::value<string>()->default_value(""),"External programm to pass warning log messages to.")
91 ("external_warning_level",po::value<int>()->default_value(0),"Warning messages of which loglevel should be passed to external programm.")
92 ("start_offline",po::value<bool>()->default_value(false),"Start in offline mode.")
95 // Define valid command line parameters
96 OptDescCmd = Options_descriptionPtr(new po::options_description("Command line options"));
97 OptDescCmd->add(opt_desc_cmd_only);
98 OptDescCmd->add(opt_desc_generic);
99 OptDescCmd->add(opt_desc_service);
101 // Define valid config file options
102 OptDescConfMain = Options_descriptionPtr(new po::options_description("Config file options"));
103 OptDescConfMain->add(opt_desc_generic);
105 // Define valid service file options
106 OptDescConfService = Options_descriptionPtr(new po::options_description("Service file options"));
107 OptDescConfService->add(opt_desc_service);
112 * Constructor with Logger and Serviceholder objects. Available command line and config file options with their default values are defined here.
114 Config::Config(Logger::Ptr _log, Serviceholder::Ptr _serviceholder)
116 , ServiceHolder(_serviceholder)
121 , ConfigPath("/etc/bpdyndnsd")
122 , WebcheckInterval(0)
124 , ExternalWarningLog("")
125 , ExternalWarningLevel(0)
126 , StartOffline(false)
128 // Available service description config options
129 po::options_description opt_desc_service("Service description options");
130 opt_desc_service.add_options()
131 ("protocol",po::value<string>(),"The service protocol.")
132 ("server",po::value<string>(),"Servername needed for gnudip protocol.")
133 ("host",po::value<string>(),"The hostname to update.")
134 ("login",po::value<string>(),"Login name.")
135 ("password",po::value<string>(),"Corresponding password.")
136 ("update_interval",po::value<int>()->default_value(-1),"Update interval in minutes.")
137 ("max_updates_within_interval",po::value<int>()->default_value(-1),"How many updates can be made in one interval.")
138 ("dns_cache_ttl",po::value<int>()->default_value(-1),"How long a dns record is valid.")
141 // Available command line only options
142 po::options_description opt_desc_cmd_only("Command line only options");
143 opt_desc_cmd_only.add_options()
144 ("help,?","Show help.")
145 ("version,v","Show version.")
146 ("config,c",po::value<string>()->default_value("/etc/bpdyndnsd"),"Set the config path.")
149 // Available generic options. Valid on cmd or in config file.
150 po::options_description opt_desc_generic("Generic config options");
151 opt_desc_generic.add_options()
152 ("daemon_mode",po::value<bool>()->default_value(false),"Run as system daemon.")
153 ("loglevel",po::value<int>()->default_value(0),"Loglevel.")
154 ("syslog",po::value<bool>()->default_value(false),"Use syslog facility.")
155 ("enable_ipv6",po::value<bool>()->default_value(false),"Try to use IPv6.")
156 ("webcheck_url",po::value<string>()->default_value(""),"Use this URL to determine IP.")
157 ("webcheck_url_alt",po::value<string>()->default_value(""),"Use this alternative URL to determine IP.")
158 ("webcheck_interval",po::value<int>()->default_value(10),"The webcheck interval in minutes.")
159 ("http_proxy",po::value<string>(),"Use this proxy for all http requests.")
160 ("http_proxy_port",po::value<int>(),"Port of the proxy.")
161 ("external_warning_log",po::value<string>()->default_value(""),"External programm to pass warning log messages to.")
162 ("external_warning_level",po::value<int>()->default_value(0),"Warning messages of which loglevel should be passed to external programm.")
163 ("start_offline",po::value<bool>()->default_value(false),"Start in offline mode.")
166 // Define valid command line parameters
167 OptDescCmd = Options_descriptionPtr(new po::options_description("Command line options"));
168 OptDescCmd->add(opt_desc_cmd_only);
169 OptDescCmd->add(opt_desc_generic);
170 OptDescCmd->add(opt_desc_service);
172 // Define valid config file options
173 OptDescConfMain = Options_descriptionPtr(new po::options_description("Config file options"));
174 OptDescConfMain->add(opt_desc_generic);
176 // Define valid service file options
177 OptDescConfService = Options_descriptionPtr(new po::options_description("Service file options"));
178 OptDescConfService->add(opt_desc_service);
191 * Parses the command line arguments and does the needed actions.
192 * @param argc Command line argument number given to main.
193 * @param argv[] Pointer to command line argument array given to main.
194 * @return 0 if all is fine, -1 if not.
196 int Config::parse_cmd_line(int argc, char *argv[])
200 po::store(po::parse_command_line(argc, argv, *this->OptDescCmd), VariablesMap);
201 po::notify(VariablesMap);
203 if ( VariablesMap.count("help") )
205 Log->print_usage(OptDescCmd);
208 else if ( VariablesMap.count("version") )
210 Log->print_version();
214 // Create a service object if all needed options are set on the command line
215 if ( VariablesMap.count("protocol") && VariablesMap.count("host") && VariablesMap.count("login") && VariablesMap.count("password") )
217 // Get the cmd parameter values for protocol host login and password
218 string protocol = VariablesMap["protocol"].as<string>();
219 string host = VariablesMap["host"].as<string>();
220 string login = VariablesMap["login"].as<string>();
221 string password = VariablesMap["password"].as<string>();
223 protocol = ba::to_lower_copy(protocol);
226 if ( VariablesMap.count("server") )
227 server = VariablesMap["server"].as<string>();
229 int update_interval = 0;
230 if ( VariablesMap.count("update_interval") )
231 update_interval = VariablesMap["update_interval"].as<int>();
233 int max_updates_within_interval = 0;
234 if ( VariablesMap.count("max_updates_within_interval") )
235 max_updates_within_interval = VariablesMap["max_updates_within_interval"].as<int>();
237 int dns_cache_ttl = 0;
238 if ( VariablesMap.count("dns_cache_ttl") )
239 dns_cache_ttl = VariablesMap["dns_cache_ttl"].as<int>();
241 Service::Ptr service = create_service(protocol,server,host,login,password,update_interval,max_updates_within_interval,dns_cache_ttl);
244 ServiceHolder->add_service(service);
245 Log->print_service_object("New Service object from command line options:", service->get_protocol(), service->get_hostname(), service->get_login() ,service->get_password(), service->get_update_interval(), service->get_max_updates_within_interval(), service->get_dns_cache_ttl() , service->get_actual_ip(), service->get_last_updates());
250 else if ( VariablesMap.count("protocol") || VariablesMap.count("host") || VariablesMap.count("login") || VariablesMap.count("password") )
252 Log->print_missing_cmd_service_option();
253 Log->print_usage(OptDescCmd);
257 if ( VariablesMap.count("config") )
259 fs::path full_config_path = fs::system_complete(fs::path(VariablesMap["config"].as<string>()));
260 ConfigPath = full_config_path.string();
261 if ( !fs::exists(full_config_path) || !fs::is_directory(full_config_path) )
263 // Config path doesn't exist or is not a directory
264 Log->print_error_config_path(ConfigPath);
269 if ( VariablesMap.count("daemon_mode") )
270 DaemonMode = VariablesMap["daemon_mode"].as<bool>();
272 if ( VariablesMap.count("loglevel") )
273 Loglevel = VariablesMap["loglevel"].as<int>();
275 if ( VariablesMap.count("syslog") )
276 Syslog = VariablesMap["syslog"].as<bool>();
278 if ( VariablesMap.count("enable_ipv6") )
279 EnableIPv6 = VariablesMap["enable_ipv6"].as<bool>();
281 if ( VariablesMap.count("webcheck_url") )
282 WebcheckIpUrl = VariablesMap["webcheck_url"].as<string>();
284 if ( VariablesMap.count("webcheck_url_alt") )
285 WebcheckIpUrlAlt = VariablesMap["webcheck_url_alt"].as<string>();
287 if ( VariablesMap.count("webcheck_interval") )
288 WebcheckInterval = VariablesMap["webcheck_interval"].as<int>();
290 if ( VariablesMap.count("http_proxy") && VariablesMap.count("http_proxy_port") )
292 Proxy = VariablesMap["http_proxy"].as<string>();
293 ProxyPort = VariablesMap["http_proxy_port"].as<int>();
295 else if ( VariablesMap.count("http_proxy") || VariablesMap.count("http_proxy_port") )
297 Log->print_missing_cmd_proxy_option();
298 Log->print_usage(OptDescCmd);
302 if ( VariablesMap.count("external_warning_log") )
303 ExternalWarningLog = VariablesMap["external_warning_log"].as<string>();
305 if ( VariablesMap.count("external_warning_level") )
306 ExternalWarningLevel = VariablesMap["external_warning_level"].as<int>();
308 if ( VariablesMap.count("start_offline") )
309 StartOffline = VariablesMap["start_offline"].as<bool>();
312 catch( const po::unknown_option& e )
314 Log->print_unknown_cmd_option(e.what());
315 Log->print_usage(OptDescCmd);
318 catch( const po::multiple_occurrences& e )
320 Log->print_multiple_cmd_option(e.what());
321 Log->print_usage(OptDescCmd);
324 catch( const po::error& e )
326 Log->print_error_parsing_cmd(e.what());
327 Log->print_usage(OptDescCmd);
335 * Creates a Service object from the given parameters.
336 * @param protocol Protocol to use.
337 * @param host Hostname to update.
338 * @param login Login.
339 * @param password Password.
340 * @return A pointer to the created Service object.
342 Service::Ptr Config::create_service(const string &protocol, const string& server, const string& hostname, const string& login, const string& password, const int update_interval, const int max_updates_within_interval, const int dns_cache_ttl)
344 // Test for valid hostname. Must contain 3 parts minimum.
345 list<string> fqhn_parts;
346 ba::split(fqhn_parts,hostname,boost::is_any_of("."));
347 if ( fqhn_parts.size() < 3 )
349 Log->print_invalid_hostname(protocol);
350 Service::Ptr service;
354 if(protocol == "dhs")
356 Service::Ptr service_dhs(new ServiceDhs(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
359 else if(protocol == "ods")
361 Service::Ptr service_ods(new ServiceOds(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl));
364 else if(protocol == "dyndns")
366 Service::Ptr service_dyndns(new ServiceDyndns(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
367 return service_dyndns;
369 else if(protocol == "dyns")
371 Service::Ptr service_dyns(new ServiceDyns(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
374 else if(protocol == "easydns")
376 Service::Ptr service_easydns(new ServiceEasydns(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
377 return service_easydns;
379 else if(protocol == "tzo")
381 Service::Ptr service_tzo(new ServiceTzo(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
384 else if(protocol == "zoneedit")
386 Service::Ptr service_zoneedit(new ServiceZoneedit(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
387 return service_zoneedit;
389 else if(protocol == "gnudip")
391 cout << "Server: " << server << endl;
392 if ( !server.empty() )
394 Service::Ptr service_gnudip(new ServiceGnudip(protocol,server,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
395 return service_gnudip;
399 Log->print_gnudip_requires_servername();
400 Service::Ptr service;
406 Log->print_unknown_protocol(protocol);
407 Service::Ptr service;
414 * Loads a service config file, invoked by load_config_from_files.
415 * @param full_filename Filename of the service config file to load.
416 * @return 0 if all is fine, -1 otherwise.
418 int Config::load_service_config_file(const string& full_filename)
420 Log->print_load_service_conf(full_filename);
422 ifstream service_config_file(full_filename.c_str(),ifstream::in);
423 if(service_config_file.is_open())
427 po::variables_map vm;
428 po::parsed_options parsed_service_options = po::parse_config_file(service_config_file,*this->OptDescConfService,true);
429 po::store(parsed_service_options,vm);
432 if(vm.count("protocol") && vm.count("host") && vm.count("login") && vm.count("password"))
434 // create the corresponding service
435 string protocol = vm["protocol"].as<string>();
436 string host = vm["host"].as<string>();
437 string login = vm["login"].as<string>();
438 string password = vm["password"].as<string>();
440 protocol = ba::to_lower_copy(protocol);
443 if ( vm.count("server") )
444 server = vm["server"].as<string>();
446 int update_interval = 0;
447 if ( vm.count("update_interval") )
448 update_interval = vm["update_interval"].as<int>();
450 int max_updates_within_interval = 0;
451 if ( vm.count("max_updates_within_interval") )
452 max_updates_within_interval = vm["max_updates_within_interval"].as<int>();
454 int dns_cache_ttl = 0;
455 if ( vm.count("dns_cache_ttl") )
456 dns_cache_ttl = vm["dns_cache_ttl"].as<int>();
458 Service::Ptr service = create_service(protocol,server,host,login,password,update_interval,max_updates_within_interval,dns_cache_ttl);
461 ServiceHolder->add_service(service);
462 Log->print_service_object("New Service object from config:", service->get_protocol(), service->get_hostname(), service->get_login() ,service->get_password(), service->get_update_interval(), service->get_max_updates_within_interval(), service->get_dns_cache_ttl() , service->get_actual_ip(), service->get_last_updates());
467 else if ( vm.count("protocol") || vm.count("host") || vm.count("login") || vm.count("password") )
469 service_config_file.close();
470 Log->print_missing_service_conf_option(full_filename);
474 catch( const po::unknown_option& e )
476 // unknown option in config file detected
477 service_config_file.close();
478 Log->print_unknown_service_conf_option(full_filename,e.what());
481 catch( const po::multiple_occurrences& e )
483 service_config_file.close();
484 Log->print_multiple_service_conf_option(full_filename,e.what());
487 catch( const po::error& e )
489 service_config_file.close();
490 Log->print_error_parsing_config_file(full_filename,e.what());
493 service_config_file.close();
497 // error opening service config file for reading
498 Log->print_error_opening_r(full_filename);
506 * Loads the main config file, invoked by load_config_from_files
507 * @param full_filename The full filename of the main config file to load
508 * @return 0 if all is fine, -1 otherwise
510 int Config::load_main_config_file(const string& full_filename)
512 Log->print_load_main_conf(full_filename);
514 ifstream main_config_file(full_filename.c_str(),ifstream::in);
515 if(main_config_file.is_open())
519 po::parsed_options parsed_main_options = po::parse_config_file(main_config_file,*this->OptDescConfMain,true);
520 po::store(parsed_main_options,VariablesMap);
521 po::notify(VariablesMap);
523 if ( VariablesMap.count("daemon_mode") )
524 DaemonMode = VariablesMap["daemon_mode"].as<bool>();
526 if ( VariablesMap.count("loglevel") )
527 Loglevel = VariablesMap["loglevel"].as<int>();
529 if ( VariablesMap.count("syslog") )
530 Syslog = VariablesMap["syslog"].as<bool>();
532 if ( VariablesMap.count("enable_ipv6") )
533 EnableIPv6 = VariablesMap["enable_ipv6"].as<bool>();
535 if ( VariablesMap.count("webcheck_url") )
536 WebcheckIpUrl = VariablesMap["webcheck_url"].as<string>();
538 if ( VariablesMap.count("webcheck_url_alt") )
539 WebcheckIpUrlAlt = VariablesMap["webcheck_url_alt"].as<string>();
541 if ( VariablesMap.count("webcheck_interval") )
542 WebcheckInterval = VariablesMap["webcheck_interval"].as<int>();
544 if ( VariablesMap.count("http_proxy") && VariablesMap.count("http_proxy_port") )
546 Proxy = VariablesMap["http_proxy"].as<string>();
547 ProxyPort = VariablesMap["http_proxy_port"].as<int>();
549 else if ( VariablesMap.count("http_proxy") || VariablesMap.count("http_proxy_port") )
551 main_config_file.close();
552 Log->print_missing_conf_proxy_option(full_filename);
556 if ( VariablesMap.count("external_warning_log") )
557 ExternalWarningLog = VariablesMap["external_warning_log"].as<string>();
559 if ( VariablesMap.count("external_warning_level") )
560 ExternalWarningLevel = VariablesMap["external_warning_level"].as<int>();
562 if ( VariablesMap.count("start_offline") )
563 StartOffline = VariablesMap["start_offline"].as<bool>();
566 catch( const po::unknown_option& e ) // at the moment 04-08-2009 this exception is never thrown :-(
568 // unknown option in main config file detected
569 main_config_file.close();
570 Log->print_unknown_main_conf_option(e.what());
573 catch( const po::multiple_occurrences& e )
575 main_config_file.close();
576 Log->print_multiple_main_conf_option(full_filename,e.what());
579 main_config_file.close();
583 // error opening main config file for reading
584 Log->print_error_opening_r(full_filename);
592 * Loads the main and the service config file and does the needed action.
593 * @param config_path The path to the config directory.
594 * @return 0 if all is fine, -1 otherwise
596 int Config::load_config_from_files()
598 fs::path full_config_path = fs::path(ConfigPath);
600 fs::directory_iterator end_iter;
601 for ( fs::directory_iterator dir_itr(full_config_path) ; dir_itr != end_iter ; ++dir_itr )
603 if( fs::is_regular_file( dir_itr->status() ) )
605 string actual_file = dir_itr->path().filename();
606 boost::regex expr(".*\\.conf?");
607 // If it is the main config file do the following
608 if ( actual_file == "bpdyndnsd.conf" )
610 // Load the main config file
611 string full_filename = dir_itr->path().string();
612 if ( load_main_config_file(full_filename) != 0 )
615 // If it is a service definition file *.conf, parse it and generate the corresponding service
616 else if ( boost::regex_search( actual_file,expr ) )
618 string full_filename = dir_itr->path().string();
619 if ( load_service_config_file(full_filename) != 0 )
624 // Config file successfully loaded
625 Log->print_conf_loaded(ConfigPath);
631 * Getter method for member OptDescCmd.
632 * @return options_description*.
634 Options_descriptionPtr Config::get_opt_desc_cmd() const
641 * Getter method for member OptDescConfMain.
642 * @return options_description*.
644 Options_descriptionPtr Config::get_opt_desc_conf_main() const
646 return OptDescConfMain;
651 * Getter method for member OptDescConfService.
652 * @return options_description*.
654 Options_descriptionPtr Config::get_opt_desc_conf_service() const
656 return OptDescConfService;
661 * Getter for member Loglevel.
662 * @return Member Loglevel.
664 int Config::get_loglevel() const
671 * Getter for member DaemonMode.
672 * @return TRUE if enabled, FALSE if disabled.
674 bool Config::get_daemon_mode() const
681 * Deletes the map with the previously parsed options.
682 * This is needed in case we reload the config and don't want the old cmd options to overwrite new config file options.
684 void Config::delete_variables_map()
686 VariablesMap.clear();
688 po::variables_map _variables_map;
689 VariablesMap = _variables_map;
694 * Getter for member Syslog.
695 * @return True if logging through syslog is enabled, false otherwise.
697 bool Config::get_syslog() const
704 * Getter for member EnableIPv6
705 * @return Wether IPv6 should be used or not.
707 bool Config::get_enable_ipv6() const
714 * Getter for member WebcheckIpUrl
715 * @return The primary IP Webcheck URL
717 string Config::get_webcheck_ip_url() const
719 return WebcheckIpUrl;
724 * Getter for member WebcheckIpUrlAlt
725 * @return The alternative IP Webcheck URL
727 string Config::get_webcheck_ip_url_alt() const
729 return WebcheckIpUrlAlt;
734 * Get member WebcheckInterval
735 * @return WebcheckInterval
737 int Config::get_webcheck_interval() const
739 return WebcheckInterval;
747 string Config::get_proxy() const
754 * Get member ProxyPort
757 int Config::get_proxy_port() const
764 * Get member ExternalWarningLog
765 * @return ExternalWarningLog
767 string Config::get_external_warning_log() const
769 return ExternalWarningLog;
774 * Get member ExternalWarningLevel
775 * @return ExternalWaringLevel
777 int Config::get_external_warning_level() const
779 return ExternalWarningLevel;
784 * Get member StartOffline
785 * @return StartOffline
787 bool Config::get_start_offline() const