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)
56 // Available service description config options
57 po::options_description opt_desc_service("Service description options");
58 opt_desc_service.add_options()
59 ("protocol",po::value<string>(),"The service protocol.")
60 ("server",po::value<string>(),"Servername needed for gnudip protocol.")
61 ("host",po::value<string>(),"The hostname to update.")
62 ("login",po::value<string>(),"Login name.")
63 ("password",po::value<string>(),"Corresponding password.")
64 ("update_interval",po::value<int>()->default_value(-1),"Update interval in minutes.")
65 ("max_updates_within_interval",po::value<int>()->default_value(-1),"How many updates can be made in one interval.")
66 ("dns_cache_ttl",po::value<int>()->default_value(-1),"How long a dns record is valid.")
69 // Available command line only options
70 po::options_description opt_desc_cmd_only("Command line only options");
71 opt_desc_cmd_only.add_options()
72 ("help,?","Show help.")
73 ("version,v","Show version.")
74 ("config,c",po::value<string>()->default_value("/etc/bpdyndnsd"),"Set the config path.")
77 // Available generic options. Valid on cmd or in config file.
78 po::options_description opt_desc_generic("Generic config options");
79 opt_desc_generic.add_options()
80 ("daemon_mode",po::value<bool>()->default_value(false),"Run as system daemon.")
81 ("loglevel",po::value<int>()->default_value(0),"Loglevel.")
82 ("syslog",po::value<bool>()->default_value(false),"Use syslog facility.")
83 ("enable_ipv6",po::value<bool>()->default_value(false),"Try to use IPv6.")
84 ("webcheck_url",po::value<string>()->default_value(""),"Use this URL to determine IP.")
85 ("webcheck_url_alt",po::value<string>()->default_value(""),"Use this alternative URL to determine IP.")
86 ("webcheck_interval",po::value<int>()->default_value(10),"The webcheck interval in minutes.")
87 ("http_proxy",po::value<string>(),"Use this proxy for all http requests.")
88 ("http_proxy_port",po::value<int>(),"Port of the proxy.")
89 ("external_warning_log",po::value<string>()->default_value(""),"External programm to pass warning log messages to.")
90 ("external_warning_level",po::value<int>()->default_value(0),"Warning messages of which loglevel should be passed to external programm.")
93 // Define valid command line parameters
94 OptDescCmd = Options_descriptionPtr(new po::options_description("Command line options"));
95 OptDescCmd->add(opt_desc_cmd_only);
96 OptDescCmd->add(opt_desc_generic);
97 OptDescCmd->add(opt_desc_service);
99 // Define valid config file options
100 OptDescConfMain = Options_descriptionPtr(new po::options_description("Config file options"));
101 OptDescConfMain->add(opt_desc_generic);
103 // Define valid service file options
104 OptDescConfService = Options_descriptionPtr(new po::options_description("Service file options"));
105 OptDescConfService->add(opt_desc_service);
110 * Constructor with Logger and Serviceholder objects. Available command line and config file options with their default values are defined here.
112 Config::Config(Logger::Ptr _log, Serviceholder::Ptr _serviceholder)
114 , ServiceHolder(_serviceholder)
119 , ConfigPath("/etc/bpdyndnsd")
120 , WebcheckInterval(0)
122 , ExternalWarningLog("")
123 , ExternalWarningLevel(0)
125 // Available service description config options
126 po::options_description opt_desc_service("Service description options");
127 opt_desc_service.add_options()
128 ("protocol",po::value<string>(),"The service protocol.")
129 ("server",po::value<string>(),"Servername needed for gnudip protocol.")
130 ("host",po::value<string>(),"The hostname to update.")
131 ("login",po::value<string>(),"Login name.")
132 ("password",po::value<string>(),"Corresponding password.")
133 ("update_interval",po::value<int>()->default_value(-1),"Update interval in minutes.")
134 ("max_updates_within_interval",po::value<int>()->default_value(-1),"How many updates can be made in one interval.")
135 ("dns_cache_ttl",po::value<int>()->default_value(-1),"How long a dns record is valid.")
138 // Available command line only options
139 po::options_description opt_desc_cmd_only("Command line only options");
140 opt_desc_cmd_only.add_options()
141 ("help,?","Show help.")
142 ("version,v","Show version.")
143 ("config,c",po::value<string>()->default_value("/etc/bpdyndnsd"),"Set the config path.")
146 // Available generic options. Valid on cmd or in config file.
147 po::options_description opt_desc_generic("Generic config options");
148 opt_desc_generic.add_options()
149 ("daemon_mode",po::value<bool>()->default_value(false),"Run as system daemon.")
150 ("loglevel",po::value<int>()->default_value(0),"Loglevel.")
151 ("syslog",po::value<bool>()->default_value(false),"Use syslog facility.")
152 ("enable_ipv6",po::value<bool>()->default_value(false),"Try to use IPv6.")
153 ("webcheck_url",po::value<string>()->default_value(""),"Use this URL to determine IP.")
154 ("webcheck_url_alt",po::value<string>()->default_value(""),"Use this alternative URL to determine IP.")
155 ("webcheck_interval",po::value<int>()->default_value(10),"The webcheck interval in minutes.")
156 ("http_proxy",po::value<string>(),"Use this proxy for all http requests.")
157 ("http_proxy_port",po::value<int>(),"Port of the proxy.")
158 ("external_warning_log",po::value<string>()->default_value(""),"External programm to pass warning log messages to.")
159 ("external_warning_level",po::value<int>()->default_value(0),"Warning messages of which loglevel should be passed to external programm.")
162 // Define valid command line parameters
163 OptDescCmd = Options_descriptionPtr(new po::options_description("Command line options"));
164 OptDescCmd->add(opt_desc_cmd_only);
165 OptDescCmd->add(opt_desc_generic);
166 OptDescCmd->add(opt_desc_service);
168 // Define valid config file options
169 OptDescConfMain = Options_descriptionPtr(new po::options_description("Config file options"));
170 OptDescConfMain->add(opt_desc_generic);
172 // Define valid service file options
173 OptDescConfService = Options_descriptionPtr(new po::options_description("Service file options"));
174 OptDescConfService->add(opt_desc_service);
187 * Parses the command line arguments and does the needed actions.
188 * @param argc Command line argument number given to main.
189 * @param argv[] Pointer to command line argument array given to main.
190 * @return 0 if all is fine, -1 if not.
192 int Config::parse_cmd_line(int argc, char *argv[])
196 po::store(po::parse_command_line(argc, argv, *this->OptDescCmd), VariablesMap);
197 po::notify(VariablesMap);
199 if ( VariablesMap.count("help") )
201 Log->print_usage(OptDescCmd);
204 else if ( VariablesMap.count("version") )
206 Log->print_version();
210 // Create a service object if all needed options are set on the command line
211 if ( VariablesMap.count("protocol") && VariablesMap.count("host") && VariablesMap.count("login") && VariablesMap.count("password") )
213 // Get the cmd parameter values for protocol host login and password
214 string protocol = VariablesMap["protocol"].as<string>();
215 string host = VariablesMap["host"].as<string>();
216 string login = VariablesMap["login"].as<string>();
217 string password = VariablesMap["password"].as<string>();
219 protocol = ba::to_lower_copy(protocol);
222 if ( VariablesMap.count("server") )
223 server = VariablesMap["server"].as<string>();
225 int update_interval = 0;
226 if ( VariablesMap.count("update_interval") )
227 update_interval = VariablesMap["update_interval"].as<int>();
229 int max_updates_within_interval = 0;
230 if ( VariablesMap.count("max_updates_within_interval") )
231 max_updates_within_interval = VariablesMap["max_updates_within_interval"].as<int>();
233 int dns_cache_ttl = 0;
234 if ( VariablesMap.count("dns_cache_ttl") )
235 dns_cache_ttl = VariablesMap["dns_cache_ttl"].as<int>();
237 Service::Ptr service = create_service(protocol,server,host,login,password,update_interval,max_updates_within_interval,dns_cache_ttl);
240 ServiceHolder->add_service(service);
241 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());
246 else if ( VariablesMap.count("protocol") || VariablesMap.count("host") || VariablesMap.count("login") || VariablesMap.count("password") )
248 Log->print_missing_cmd_service_option();
249 Log->print_usage(OptDescCmd);
253 if ( VariablesMap.count("config") )
255 fs::path full_config_path = fs::system_complete(fs::path(VariablesMap["config"].as<string>()));
256 ConfigPath = full_config_path.string();
257 if ( !fs::exists(full_config_path) || !fs::is_directory(full_config_path) )
259 // Config path doesn't exist or is not a directory
260 Log->print_error_config_path(ConfigPath);
265 if ( VariablesMap.count("daemon_mode") )
266 DaemonMode = VariablesMap["daemon_mode"].as<bool>();
268 if ( VariablesMap.count("loglevel") )
269 Loglevel = VariablesMap["loglevel"].as<int>();
271 if ( VariablesMap.count("syslog") )
272 Syslog = VariablesMap["syslog"].as<bool>();
274 if ( VariablesMap.count("enable_ipv6") )
275 EnableIPv6 = VariablesMap["enable_ipv6"].as<bool>();
277 if ( VariablesMap.count("webcheck_url") )
278 WebcheckIpUrl = VariablesMap["webcheck_url"].as<string>();
280 if ( VariablesMap.count("webcheck_url_alt") )
281 WebcheckIpUrlAlt = VariablesMap["webcheck_url_alt"].as<string>();
283 if ( VariablesMap.count("webcheck_interval") )
284 WebcheckInterval = VariablesMap["webcheck_interval"].as<int>();
286 if ( VariablesMap.count("http_proxy") && VariablesMap.count("http_proxy_port") )
288 Proxy = VariablesMap["http_proxy"].as<string>();
289 ProxyPort = VariablesMap["http_proxy_port"].as<int>();
291 else if ( VariablesMap.count("http_proxy") || VariablesMap.count("http_proxy_port") )
293 Log->print_missing_cmd_proxy_option();
294 Log->print_usage(OptDescCmd);
298 if ( VariablesMap.count("external_warning_log") )
299 ExternalWarningLog = VariablesMap["external_warning_log"].as<string>();
301 if ( VariablesMap.count("external_warning_level") )
302 ExternalWarningLevel = VariablesMap["external_warning_level"].as<int>();
305 catch( po::unknown_option& e )
307 Log->print_unknown_cmd_option(e.what());
308 Log->print_usage(OptDescCmd);
311 catch( po::multiple_occurrences& e )
313 Log->print_multiple_cmd_option(e.what());
314 Log->print_usage(OptDescCmd);
317 catch( po::error& e )
319 Log->print_error_parsing_cmd(e.what());
320 Log->print_usage(OptDescCmd);
328 * Creates a Service object from the given parameters.
329 * @param protocol Protocol to use.
330 * @param host Hostname to update.
331 * @param login Login.
332 * @param password Password.
333 * @return A pointer to the created Service object.
335 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)
337 // Test for valid hostname. Must contain 3 parts minimum.
338 list<string> fqhn_parts;
339 ba::split(fqhn_parts,hostname,boost::is_any_of("."));
340 if ( fqhn_parts.size() < 3 )
342 Log->print_invalid_hostname(protocol);
343 Service::Ptr service;
347 if(protocol == "dhs")
349 Service::Ptr service_dhs(new ServiceDhs(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
352 else if(protocol == "ods")
354 Service::Ptr service_ods(new ServiceOds(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl));
357 else if(protocol == "dyndns")
359 Service::Ptr service_dyndns(new ServiceDyndns(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
360 return service_dyndns;
362 else if(protocol == "dyns")
364 Service::Ptr service_dyns(new ServiceDyns(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
367 else if(protocol == "easydns")
369 Service::Ptr service_easydns(new ServiceEasydns(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
370 return service_easydns;
372 else if(protocol == "tzo")
374 Service::Ptr service_tzo(new ServiceTzo(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
377 else if(protocol == "zoneedit")
379 Service::Ptr service_zoneedit(new ServiceZoneedit(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
380 return service_zoneedit;
382 else if(protocol == "gnudip")
384 cout << "Server: " << server << endl;
385 if ( !server.empty() )
387 Service::Ptr service_gnudip(new ServiceGnudip(protocol,server,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl,Proxy,ProxyPort));
388 return service_gnudip;
392 Log->print_gnudip_requires_servername();
393 Service::Ptr service;
399 Log->print_unknown_protocol(protocol);
400 Service::Ptr service;
407 * Loads a service config file, invoked by load_config_from_files.
408 * @param full_filename Filename of the service config file to load.
409 * @return 0 if all is fine, -1 otherwise.
411 int Config::load_service_config_file(const string& full_filename)
413 Log->print_load_service_conf(full_filename);
415 ifstream service_config_file(full_filename.c_str(),ifstream::in);
416 if(service_config_file.is_open())
420 po::variables_map vm;
421 po::parsed_options parsed_service_options = po::parse_config_file(service_config_file,*this->OptDescConfService,true);
422 po::store(parsed_service_options,vm);
425 if(vm.count("protocol") && vm.count("host") && vm.count("login") && vm.count("password"))
427 // create the corresponding service
428 string protocol = vm["protocol"].as<string>();
429 string host = vm["host"].as<string>();
430 string login = vm["login"].as<string>();
431 string password = vm["password"].as<string>();
433 protocol = ba::to_lower_copy(protocol);
436 if ( vm.count("server") )
437 server = vm["server"].as<string>();
439 int update_interval = 0;
440 if ( vm.count("update_interval") )
441 update_interval = vm["update_interval"].as<int>();
443 int max_updates_within_interval = 0;
444 if ( vm.count("max_updates_within_interval") )
445 max_updates_within_interval = vm["max_updates_within_interval"].as<int>();
447 int dns_cache_ttl = 0;
448 if ( vm.count("dns_cache_ttl") )
449 dns_cache_ttl = vm["dns_cache_ttl"].as<int>();
451 Service::Ptr service = create_service(protocol,server,host,login,password,update_interval,max_updates_within_interval,dns_cache_ttl);
454 ServiceHolder->add_service(service);
455 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());
460 else if ( vm.count("protocol") || vm.count("host") || vm.count("login") || vm.count("password") )
462 service_config_file.close();
463 Log->print_missing_service_conf_option(full_filename);
467 catch ( po::unknown_option& e )
469 // unknown option in config file detected
470 service_config_file.close();
471 Log->print_unknown_service_conf_option(full_filename,e.what());
474 catch( po::multiple_occurrences& e )
476 service_config_file.close();
477 Log->print_multiple_service_conf_option(full_filename,e.what());
480 catch( po::error& e )
482 service_config_file.close();
483 Log->print_error_parsing_config_file(full_filename,e.what());
486 service_config_file.close();
490 // error opening service config file for reading
491 Log->print_error_opening_r(full_filename);
499 * Loads the main config file, invoked by load_config_from_files
500 * @param full_filename The full filename of the main config file to load
501 * @return 0 if all is fine, -1 otherwise
503 int Config::load_main_config_file(const string& full_filename)
505 Log->print_load_main_conf(full_filename);
507 ifstream main_config_file(full_filename.c_str(),ifstream::in);
508 if(main_config_file.is_open())
512 po::parsed_options parsed_main_options = po::parse_config_file(main_config_file,*this->OptDescConfMain,true);
513 po::store(parsed_main_options,VariablesMap);
514 po::notify(VariablesMap);
516 if ( VariablesMap.count("daemon_mode") )
517 DaemonMode = VariablesMap["daemon_mode"].as<bool>();
519 if ( VariablesMap.count("loglevel") )
520 Loglevel = VariablesMap["loglevel"].as<int>();
522 if ( VariablesMap.count("syslog") )
523 Syslog = VariablesMap["syslog"].as<bool>();
525 if ( VariablesMap.count("enable_ipv6") )
526 EnableIPv6 = VariablesMap["enable_ipv6"].as<bool>();
528 if ( VariablesMap.count("webcheck_url") )
529 WebcheckIpUrl = VariablesMap["webcheck_url"].as<string>();
531 if ( VariablesMap.count("webcheck_url_alt") )
532 WebcheckIpUrlAlt = VariablesMap["webcheck_url_alt"].as<string>();
534 if ( VariablesMap.count("webcheck_interval") )
535 WebcheckInterval = VariablesMap["webcheck_interval"].as<int>();
537 if ( VariablesMap.count("http_proxy") && VariablesMap.count("http_proxy_port") )
539 Proxy = VariablesMap["http_proxy"].as<string>();
540 ProxyPort = VariablesMap["http_proxy_port"].as<int>();
542 else if ( VariablesMap.count("http_proxy") || VariablesMap.count("http_proxy_port") )
544 main_config_file.close();
545 Log->print_missing_conf_proxy_option(full_filename);
549 if ( VariablesMap.count("external_warning_log") )
550 ExternalWarningLog = VariablesMap["external_warning_log"].as<string>();
552 if ( VariablesMap.count("external_warning_level") )
553 ExternalWarningLevel = VariablesMap["external_warning_level"].as<int>();
556 catch ( po::unknown_option& e ) // at the moment 04-08-2009 this exception is never thrown :-(
558 // unknown option in main config file detected
559 main_config_file.close();
560 Log->print_unknown_main_conf_option(e.what());
563 catch(po::multiple_occurrences& e)
565 main_config_file.close();
566 Log->print_multiple_main_conf_option(full_filename,e.what());
569 main_config_file.close();
573 // error opening main config file for reading
574 Log->print_error_opening_r(full_filename);
582 * Loads the main and the service config file and does the needed action.
583 * @param config_path The path to the config directory.
584 * @return 0 if all is fine, -1 otherwise
586 int Config::load_config_from_files()
588 fs::path full_config_path = fs::path(ConfigPath);
590 fs::directory_iterator end_iter;
591 for ( fs::directory_iterator dir_itr(full_config_path) ; dir_itr != end_iter ; ++dir_itr )
593 if( fs::is_regular_file( dir_itr->status() ) )
595 string actual_file = dir_itr->path().filename();
596 boost::regex expr(".*\\.conf?");
597 // If it is the main config file do the following
598 if ( actual_file == "bpdyndnsd.conf" )
600 // Load the main config file
601 string full_filename = dir_itr->path().string();
602 if ( load_main_config_file(full_filename) != 0 )
605 // If it is a service definition file *.conf, parse it and generate the corresponding service
606 else if ( boost::regex_search( actual_file,expr ) )
608 string full_filename = dir_itr->path().string();
609 if ( load_service_config_file(full_filename) != 0 )
614 // Config file successfully loaded
615 Log->print_conf_loaded(ConfigPath);
621 * Getter method for member OptDescCmd.
622 * @return options_description*.
624 Options_descriptionPtr Config::get_opt_desc_cmd() const
631 * Getter method for member OptDescConfMain.
632 * @return options_description*.
634 Options_descriptionPtr Config::get_opt_desc_conf_main() const
636 return OptDescConfMain;
641 * Getter method for member OptDescConfService.
642 * @return options_description*.
644 Options_descriptionPtr Config::get_opt_desc_conf_service() const
646 return OptDescConfService;
651 * Getter for member Loglevel.
652 * @return Member Loglevel.
654 int Config::get_loglevel() const
661 * Getter for member DaemonMode.
662 * @return TRUE if enabled, FALSE if disabled.
664 bool Config::get_daemon_mode() const
671 * Deletes the map with the previously parsed options.
672 * This is needed in case we reload the config and don't want the old cmd options to overwrite new config file options.
674 void Config::delete_variables_map()
676 VariablesMap.clear();
678 po::variables_map _variables_map;
679 VariablesMap = _variables_map;
684 * Getter for member Syslog.
685 * @return True if logging through syslog is enabled, false otherwise.
687 bool Config::get_syslog() const
694 * Getter for member EnableIPv6
695 * @return Wether IPv6 should be used or not.
697 bool Config::get_enable_ipv6() const
704 * Getter for member WebcheckIpUrl
705 * @return The primary IP Webcheck URL
707 string Config::get_webcheck_ip_url() const
709 return WebcheckIpUrl;
714 * Getter for member WebcheckIpUrlAlt
715 * @return The alternative IP Webcheck URL
717 string Config::get_webcheck_ip_url_alt() const
719 return WebcheckIpUrlAlt;
724 * Get member WebcheckInterval
725 * @return WebcheckInterval
727 int Config::get_webcheck_interval() const
729 return WebcheckInterval;
737 string Config::get_proxy() const
744 * Get member ProxyPort
747 int Config::get_proxy_port() const
754 * Get member ExternalWarningLog
755 * @return ExternalWarningLog
757 string Config::get_external_warning_log() const
759 return ExternalWarningLog;
764 * Get member ExternalWarningLevel
765 * @return ExternalWaringLevel
767 int Config::get_external_warning_level() const
769 return ExternalWarningLevel;