developer.intra2net.com Git - bpdyndnsd/blob - src/config.cpp

   1 /** @file
   2  * @brief Config class implementation. This class represents the actual configuration.
   3  *
   4  *
   5  *
   6  * @copyright Intra2net AG
   7  * @license GPLv2
   8 */
   9
  10 #include "config.h"
  11
  12 #include "dhs.h"
  13 #include "ods.h"
  14
  15 #include <time.h>
  16 #include <iostream>
  17 #include <fstream>
  18
  19 #include <boost/foreach.hpp>
  20 #include <boost/filesystem.hpp>
  21 #include <boost/regex.hpp>
  22 #include <boost/algorithm/string.hpp>
  23
  24
  25
  26 namespace po = boost::program_options;
  27 namespace fs = boost::filesystem;
  28 namespace ba = boost::algorithm;
  29
  30 using namespace std;
  31
  32 /**
  33  * Default Constructor. Available command line and config file options with their default values are defined here.
  34  */
  35 Config::Config(Logger::Ptr _log, Serviceholder::Ptr _serviceholder)
  36     : DaemonMode(false)
  37     , Syslog(false)
  38     , EnableIPv6(false)
  39     , Loglevel(0)
  40     , ConfigPath("/etc/bpdyndnsd")
  41     , ExternalWarningLog("")
  42     , ExternalWarningLevel(0)
  43 {
  44     // initialize Logger
  45     Log = _log;
  46
  47     // initialize Serviceholder
  48     ServiceHolder = _serviceholder;
  49
  50     // Available service description config options
  51     po::options_description opt_desc_service("Service description options");
  52     opt_desc_service.add_options()
  53         ("protocol",po::value<string>(),"The service protocol.")
  54         ("host",po::value<string>(),"The hostname to update.")
  55         ("login",po::value<string>(),"Login name.")
  56         ("password",po::value<string>(),"Corresponding password.")
  57         ("update_interval",po::value<int>()->default_value(-1),"Update interval in minutes.")
  58         ("max_updates_within_interval",po::value<int>()->default_value(-1),"How many updates can be made in one interval.")
  59         ("dns_cache_ttl",po::value<int>()->default_value(-1),"How long a dns record is valid.")
  60     ;
  61
  62     // Available command line only options
  63     po::options_description opt_desc_cmd_only("Command line only options");
  64     opt_desc_cmd_only.add_options()
  65         ("help,?","Show help.")
  66         ("version,v","Show version.")
  67         ("config,c",po::value<string>()->default_value("/etc/bpdyndnsd"),"Set the config path.")
  68     ;
  69
  70      // Available generic options. Valid on cmd or in config file.
  71     po::options_description opt_desc_generic("Generic config options");
  72     opt_desc_generic.add_options()
  73         ("daemon_mode",po::value<bool>()->default_value(false),"Run as system daemon.")
  74         ("loglevel",po::value<int>()->default_value(0),"Loglevel.")
  75         ("syslog",po::value<bool>()->default_value(false),"Use syslog facility.")
  76         ("enable_ipv6",po::value<bool>()->default_value(false),"Try to use IPv6.")
  77         ("webcheck_url",po::value<string>()->default_value(""),"Use this URL to determine IP.")
  78         ("webcheck_url_alt",po::value<string>()->default_value(""),"Use this alternative URL to determine IP.")
  79         ("http_proxy",po::value<string>(),"Use this proxy for all http requests.")
  80         ("http_proxy_port",po::value<int>(),"Port of the proxy.")
  81         ("external_warning_log",po::value<string>()->default_value(""),"External programm to pass warning log messages to.")
  82         ("external_warning_level",po::value<int>()->default_value(0),"Warning messages of which loglevel should be passed to external programm.")
  83     ;
  84
  85     // Define valid command line parameters
  86     Options_descriptionPtr _opt_desc_cmd(new po::options_description("Command line options"));
  87     OptDescCmd = _opt_desc_cmd;
  88     _opt_desc_cmd.reset();
  89     OptDescCmd->add(opt_desc_cmd_only);
  90     OptDescCmd->add(opt_desc_generic);
  91     OptDescCmd->add(opt_desc_service);
  92
  93     // Define valid config file options
  94     Options_descriptionPtr _opt_desc_conf_main(new po::options_description("Config file options"));
  95     OptDescConfMain = _opt_desc_conf_main;
  96     _opt_desc_conf_main.reset();
  97     OptDescConfMain->add(opt_desc_generic);
  98
  99     // Define valid service file options
 100     Options_descriptionPtr _opt_desc_conf_service(new po::options_description("Service file options"));
 101     OptDescConfService = _opt_desc_conf_service;
 102     _opt_desc_conf_service.reset();
 103     OptDescConfService->add(opt_desc_service);
 104 }
 105
 106
 107 /**
 108  * Default Destructor
 109  */
 110 Config::~Config()
 111 {
 112 }
 113
 114
 115 /**
 116  * Parses the command line arguments and does the needed actions.
 117  * @param argc Command line argument number given to main.
 118  * @param argv[] Pointer to command line argument array given to main.
 119  * @return 0 if all is fine, -1 if not.
 120  */
 121 int Config::parse_cmd_line(int argc, char *argv[], HTTPHelper::Ptr http_help)
 122 {
 123     try
 124     {
 125         po::store(po::parse_command_line(argc, argv, *this->OptDescCmd), VariablesMap);
 126         po::notify(VariablesMap);
 127
 128         if ( VariablesMap.count("help") )
 129         {
 130             Log->print_usage(OptDescCmd);
 131             return -1;
 132         }
 133         else if ( VariablesMap.count("version") )
 134         {
 135             Log->print_version();
 136             return -1;
 137         }
 138
 139         // Create a service object if all needed options are set on the command line
 140         if ( VariablesMap.count("protocol") && VariablesMap.count("host") && VariablesMap.count("login") && VariablesMap.count("password") )
 141         {
 142             // Get the cmd parameter values for protocol host login and password
 143             string protocol = VariablesMap["protocol"].as<string>();
 144             string host = VariablesMap["host"].as<string>();
 145             string login = VariablesMap["login"].as<string>();
 146             string password = VariablesMap["password"].as<string>();
 147
 148             protocol = ba::to_lower_copy(protocol);
 149
 150             int update_interval = 0;
 151             if ( VariablesMap.count("update_interval") )
 152                 update_interval = VariablesMap["update_interval"].as<int>();
 153
 154             int max_updates_within_interval = 0;
 155             if ( VariablesMap.count("max_updates_within_interval") )
 156                 max_updates_within_interval = VariablesMap["max_updates_within_interval"].as<int>();
 157
 158             int dns_cache_ttl = 0;
 159             if ( VariablesMap.count("dns_cache_ttl") )
 160                 dns_cache_ttl = VariablesMap["dns_cache_ttl"].as<int>();
 161
 162             Service::Ptr service = create_service(protocol,host,login,password,update_interval,max_updates_within_interval,dns_cache_ttl,http_help);
 163             if ( service )
 164             {
 165                 ServiceHolder->add_service(service);
 166                 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_actual_ip(), service->get_last_updates());
 167             }
 168             else
 169                 return -1;
 170         }
 171         else if ( VariablesMap.count("protocol") || VariablesMap.count("host") || VariablesMap.count("login") || VariablesMap.count("password") )
 172         {
 173             Log->print_missing_cmd_service_option();
 174             Log->print_usage(OptDescCmd);
 175             return -1;
 176         }
 177
 178         if ( VariablesMap.count("config") )
 179         {
 180             fs::path full_config_path = fs::system_complete(fs::path(VariablesMap["config"].as<string>()));
 181             ConfigPath = full_config_path.string();
 182             if ( !fs::exists(full_config_path) ||  !fs::is_directory(full_config_path) )
 183             {
 184                 // Config path doesn't exist or is not a directory
 185                 Log->print_error_config_path(ConfigPath);
 186                 return -1;
 187             }
 188         }
 189
 190         if ( VariablesMap.count("daemon_mode") )
 191             DaemonMode = VariablesMap["daemon_mode"].as<bool>();
 192
 193         if ( VariablesMap.count("loglevel") )
 194             Loglevel = VariablesMap["loglevel"].as<int>();
 195
 196         if ( VariablesMap.count("syslog") )
 197             Syslog = VariablesMap["syslog"].as<bool>();
 198
 199         if ( VariablesMap.count("enable_ipv6") )
 200             EnableIPv6 = VariablesMap["enable_ipv6"].as<bool>();
 201
 202         if ( VariablesMap.count("webcheck_url") )
 203             WebcheckIpUrl = VariablesMap["webcheck_url"].as<string>();
 204
 205         if ( VariablesMap.count("webcheck_url_alt") )
 206             WebcheckIpUrlAlt = VariablesMap["webcheck_url_alt"].as<string>();
 207
 208         if ( VariablesMap.count("http_proxy") && VariablesMap.count("http_proxy_port") )
 209         {
 210             Proxy = VariablesMap["http_proxy"].as<string>();
 211             ProxyPort = VariablesMap["http_proxy_port"].as<int>();
 212         }
 213         else if ( VariablesMap.count("http_proxy") || VariablesMap.count("http_proxy_port") )
 214         {
 215             Log->print_missing_cmd_proxy_option();
 216             Log->print_usage(OptDescCmd);
 217             return -1;
 218         }
 219
 220         if ( VariablesMap.count("external_warning_log") )
 221             ExternalWarningLog = VariablesMap["external_warning_log"].as<string>();
 222
 223         if ( VariablesMap.count("external_warning_level") )
 224             ExternalWarningLevel = VariablesMap["external_warning_level"].as<int>();
 225
 226     }
 227     catch(po::unknown_option e)
 228     {
 229         Log->print_unknown_cmd_option(e.what());
 230         Log->print_usage(OptDescCmd);
 231         return -1;
 232     }
 233     catch(po::multiple_occurrences e)
 234     {
 235         Log->print_multiple_cmd_option(e.what());
 236         Log->print_usage(OptDescCmd);
 237         return -1;
 238     }
 239     return 0;
 240 }
 241
 242
 243 /**
 244  * Creates a Service object from the given parameters.
 245  * @param protocol Protocol to use.
 246  * @param host Hostname to update.
 247  * @param login Login.
 248  * @param password Password.
 249  * @return A pointer to the created Service object.
 250  */
 251 Service::Ptr Config::create_service(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 HTTPHelper::Ptr http_help)
 252 {
 253     if(protocol == "dhs")
 254     {
 255         Service::Ptr service_dhs(new DHS(protocol,hostname,login,password,Log,http_help,update_interval,max_updates_within_interval,dns_cache_ttl));
 256         return service_dhs;
 257     }
 258     else if(protocol == "ods")
 259     {
 260         Service::Ptr service_ods(new ODS(protocol,hostname,login,password,Log,update_interval,max_updates_within_interval,dns_cache_ttl));
 261         return service_ods;
 262     }
 263     else
 264     {
 265         Log->print_unknown_protocol(protocol);
 266         Service::Ptr service;
 267         return service;
 268     }
 269 }
 270
 271
 272 /**
 273  * Loads a service config file, invoked by load_config_from_files.
 274  * @param full_filename Filename of the service config file to load.
 275  * @return 0 if all is fine, -1 otherwise.
 276  */
 277 int Config::load_service_config_file(const string& full_filename, const HTTPHelper::Ptr http_help)
 278 {
 279     Log->print_load_service_conf(full_filename);
 280
 281     ifstream service_config_file(full_filename.c_str(),ifstream::in);
 282     if(service_config_file.is_open())
 283     {
 284         try
 285         {
 286             po::variables_map vm;
 287             po::parsed_options parsed_service_options = po::parse_config_file(service_config_file,*this->OptDescConfService,true);
 288             po::store(parsed_service_options,vm);
 289             po::notify(vm);
 290
 291             if(vm.count("protocol") && vm.count("host") && vm.count("login") && vm.count("password"))
 292             {
 293                 // create the corresponding service
 294                 string protocol = vm["protocol"].as<string>();
 295                 string host = vm["host"].as<string>();
 296                 string login = vm["login"].as<string>();
 297                 string password = vm["password"].as<string>();
 298
 299                 protocol = ba::to_lower_copy(protocol);
 300
 301                 int update_interval = 0;
 302                 if ( vm.count("update_interval") )
 303                     update_interval = VariablesMap["update_interval"].as<int>();
 304
 305                 int max_updates_within_interval = 0;
 306                 if ( vm.count("max_updates_within_interval") )
 307                     max_updates_within_interval = VariablesMap["max_updates_within_interval"].as<int>();
 308
 309                 int dns_cache_ttl = 0;
 310                 if ( vm.count("dns_cache_ttl") )
 311                     dns_cache_ttl = VariablesMap["dns_cache_ttl"].as<int>();
 312
 313                 Service::Ptr service = create_service(protocol,host,login,password,update_interval,max_updates_within_interval,dns_cache_ttl,http_help);
 314                 if ( service )
 315                 {
 316                     ServiceHolder->add_service(service);
 317                     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_actual_ip(), service->get_last_updates());
 318                 }
 319                 else
 320                     return -1;
 321             }
 322             else if ( vm.count("protocol") || vm.count("host") || vm.count("login") || vm.count("password") )
 323             {
 324                 service_config_file.close();
 325                 Log->print_missing_service_conf_option(full_filename);
 326                 return -1;
 327             }
 328         }
 329         catch ( po::unknown_option e )
 330         {
 331             // unknown option in config file detected
 332             service_config_file.close();
 333             Log->print_unknown_service_conf_option(full_filename,e.what());
 334             return -1;
 335         }
 336         catch(po::multiple_occurrences e)
 337         {
 338             service_config_file.close();
 339             Log->print_multiple_service_conf_option(full_filename,e.what());
 340             return -1;
 341         }
 342         service_config_file.close();
 343     }
 344     else
 345     {
 346         // error opening service config file for reading
 347         Log->print_error_opening_r(full_filename);
 348         return -1;
 349     }
 350     return 0;
 351 }
 352
 353
 354 /**
 355  * Loads the main config file, invoked by load_config_from_files
 356  * @param full_filename The full filename of the main config file to load
 357  * @return 0 if all is fine, -1 otherwise
 358  */
 359 int Config::load_main_config_file(const string& full_filename)
 360 {
 361     Log->print_load_main_conf(full_filename);
 362
 363     ifstream main_config_file(full_filename.c_str(),ifstream::in);
 364     if(main_config_file.is_open())
 365     {
 366         try
 367         {
 368             po::parsed_options parsed_main_options = po::parse_config_file(main_config_file,*this->OptDescConfMain,true);
 369             po::store(parsed_main_options,VariablesMap);
 370             po::notify(VariablesMap);
 371
 372             if ( VariablesMap.count("daemon_mode") )
 373                 DaemonMode = VariablesMap["daemon_mode"].as<bool>();
 374
 375             if ( VariablesMap.count("loglevel") )
 376                 Loglevel = VariablesMap["loglevel"].as<int>();
 377
 378             if ( VariablesMap.count("syslog") )
 379                 Syslog = VariablesMap["syslog"].as<bool>();
 380
 381             if ( VariablesMap.count("enable_ipv6") )
 382                 EnableIPv6 = VariablesMap["enable_ipv6"].as<bool>();
 383
 384             if ( VariablesMap.count("webcheck_url") )
 385                 WebcheckIpUrl = VariablesMap["webcheck_url"].as<string>();
 386
 387             if ( VariablesMap.count("webcheck_url_alt") )
 388                 WebcheckIpUrlAlt = VariablesMap["webcheck_url_alt"].as<string>();
 389
 390             if ( VariablesMap.count("http_proxy") && VariablesMap.count("http_proxy_port") )
 391             {
 392                 Proxy = VariablesMap["http_proxy"].as<string>();
 393                 ProxyPort = VariablesMap["http_proxy_port"].as<int>();
 394             }
 395             else if ( VariablesMap.count("http_proxy") || VariablesMap.count("http_proxy_port") )
 396             {
 397                 main_config_file.close();
 398                 Log->print_missing_conf_proxy_option(full_filename);
 399                 return -1;
 400             }
 401
 402             if ( VariablesMap.count("external_warning_log") )
 403                 ExternalWarningLog = VariablesMap["external_warning_log"].as<string>();
 404
 405             if ( VariablesMap.count("external_warning_level") )
 406                 ExternalWarningLevel = VariablesMap["external_warning_level"].as<int>();
 407
 408         }
 409         catch ( po::unknown_option e )      // at the moment 04-08-2009 this exception is never thrown :-(
 410         {
 411             // unknown option in main config file detected
 412             main_config_file.close();
 413             Log->print_unknown_main_conf_option(e.what());
 414             return -1;
 415         }
 416         catch(po::multiple_occurrences e)
 417         {
 418             main_config_file.close();
 419             Log->print_multiple_main_conf_option(full_filename,e.what());
 420             return -1;
 421         }
 422         main_config_file.close();
 423     }
 424     else
 425     {
 426         // error opening main config file for reading
 427         Log->print_error_opening_r(full_filename);
 428         return -1;
 429     }
 430     return 0;
 431 }
 432
 433
 434 /**
 435  * Loads the main and the service config file and does the needed action.
 436  * @param config_path The path to the config directory.
 437  * @return 0 if all is fine, -1 otherwise
 438  */
 439 int Config::load_config_from_files(const HTTPHelper::Ptr http_help)
 440 {
 441     fs::path full_config_path = fs::path(ConfigPath);
 442
 443     fs::directory_iterator end_iter;
 444     for ( fs::directory_iterator dir_itr(full_config_path) ; dir_itr != end_iter ; ++dir_itr )
 445     {
 446         if( fs::is_regular_file( dir_itr->status() ) )
 447         {
 448             string actual_file = dir_itr->path().filename();
 449             boost::regex expr(".*\\.conf?");
 450              // If it is the main config file do the following
 451             if ( actual_file == "bpdyndnsd.conf" )
 452             {
 453                 // Load the main config file
 454                 string full_filename = dir_itr->path().string();
 455                 if ( load_main_config_file(full_filename) != 0 )
 456                     return -1;
 457             }
 458             // If it is a service definition file *.conf, parse it and generate the corresponding service
 459             else if ( boost::regex_search( actual_file,expr ) )
 460             {
 461                 string full_filename = dir_itr->path().string();
 462                 if ( load_service_config_file(full_filename,http_help) != 0 )
 463                     return -1;
 464             }
 465         }
 466     }
 467     // Config file successfully loaded
 468     Log->print_conf_loaded(ConfigPath);
 469     return 0;
 470 }
 471
 472
 473 /**
 474  * Getter method for member OptDescCmd.
 475  * @return options_description*.
 476  */
 477 Config::Options_descriptionPtr Config::get_opt_desc_cmd() const
 478 {
 479     return OptDescCmd;
 480 }
 481
 482
 483 /**
 484  * Getter method for member OptDescConfMain.
 485  * @return options_description*.
 486  */
 487 Config::Options_descriptionPtr Config::get_opt_desc_conf_main() const
 488 {
 489     return OptDescConfMain;
 490 }
 491
 492
 493 /**
 494  * Getter method for member OptDescConfService.
 495  * @return options_description*.
 496  */
 497 Config::Options_descriptionPtr Config::get_opt_desc_conf_service() const
 498 {
 499     return OptDescConfService;
 500 }
 501
 502
 503 /**
 504  * Getter for member Loglevel.
 505  * @return Member Loglevel.
 506  */
 507 int Config::get_loglevel() const
 508 {
 509     return Loglevel;
 510 }
 511
 512
 513 /**
 514  * Getter for member DaemonMode.
 515  * @return TRUE if enabled, FALSE if disabled.
 516  */
 517 bool Config::get_daemon_mode() const
 518 {
 519     return DaemonMode;
 520 }
 521
 522
 523 /**
 524  * Deletes the map with the previously parsed options.
 525  * This is needed in case we reload the config and don't want the old cmd options to overwrite new config file options.
 526  */
 527 void Config::delete_variables_map()
 528 {
 529     VariablesMap.clear();
 530
 531     po::variables_map _variables_map;
 532     VariablesMap = _variables_map;
 533 }
 534
 535
 536 /**
 537  * Getter for member Syslog.
 538  * @return True if logging through syslog is enabled, false otherwise.
 539  */
 540 bool Config::get_syslog() const
 541 {
 542     return Syslog;
 543 }
 544
 545
 546 /**
 547  * Getter for member EnableIPv6
 548  * @return Wether IPv6 should be used or not.
 549  */
 550 bool Config::get_enable_ipv6() const
 551 {
 552     return EnableIPv6;
 553 }
 554
 555
 556 /**
 557  * Getter for member WebcheckIpUrl
 558  * @return The primary IP Webcheck URL
 559  */
 560 string Config::get_webcheck_ip_url() const
 561 {
 562     return WebcheckIpUrl;
 563 }
 564
 565
 566 /**
 567  * Getter for member WebcheckIpUrlAlt
 568  * @return The alternative IP Webcheck URL
 569  */
 570 string Config::get_webcheck_ip_url_alt() const
 571 {
 572     return WebcheckIpUrlAlt;
 573 }
 574
 575
 576 /**
 577  * Get member Proxy
 578  * @return Proxy
 579  */
 580 string Config::get_proxy() const
 581 {
 582     return Proxy;
 583 }
 584
 585
 586 /**
 587  * Get member ProxyPort
 588  * @return ProxyPort
 589  */
 590 int Config::get_proxy_port() const
 591 {
 592     return ProxyPort;
 593 }
 594
 595
 596 /**
 597  * Get member ExternalWarningLog
 598  * @return ExternalWarningLog
 599  */
 600 string Config::get_external_warning_log() const
 601 {
 602     return ExternalWarningLog;
 603 }
 604
 605
 606 /**
 607  * Get member ExternalWarningLevel
 608  * @return ExternalWaringLevel
 609  */
 610 int Config::get_external_warning_level() const
 611 {
 612     return ExternalWarningLevel;
 613 }
 614