Added doxygen comments and changed member names.

[bpdyndnsd] / src / config.cpp

/** @file
 * @brief Config class implementation. This class represents the actual configuration.
 *
 *
 *
 * @copyright Intra2net AG
 * @license GPLv2
*/

#include "config.h"

/**
 * Default Constructor. Available command line arguments with their default values are defined here.
 */
Config::Config()
    : Daemon_mode(true)
    , Loglevel(0)
    , Syslog(true)
{
    // Define valid command line parameters
    Opt_desc_cmd = new po::options_description("Command line options");
    Opt_desc_cmd->add_options()
        ("help,?","Show help.")
        ("version,v","Show version.")
        ("protocol,q",po::value<string>(),"Set the service protocol type.")
        ("host,h",po::value<string>(),"Set the hostname to update.")
        ("login,l",po::value<string>(),"Set the login.")
        ("password,p",po::value<string>(),"Set the password.")
    ;

    // Define valid config file main section parameters
    Opt_desc_conf_main = new po::options_description("Config file main section options");
    Opt_desc_conf_main->add_options()
        ("main.daemon_mode",po::value<bool>()->default_value(false),"Run as system daemon.")
        ("main.logfile",po::value<string>()->default_value("/var/log/bpdyndns.log"),"Where to log.")
        ("main.loglevel",po::value<int>()->default_value(0),"Loglevel.")
        ("main.syslog",po::value<bool>()->default_value(false),"Use syslog facility.")
    ;

    // Define valid config file main section parameters
    Opt_desc_conf_service = new po::options_description("Config file service section options");
    Opt_desc_conf_service->add_options()
        ("service.protocol",po::value<string>(),"The service protocol.")
        ("service.host",po::value<string>(),"The hostname to update.")
        ("service.login",po::value<string>(),"Login name.")
        ("service.password",po::value<string>(),"Corresponding password.")
    ;
}


/**
 * Default Destructor
 */
Config::~Config()
{
    delete Opt_desc_cmd;
    delete Opt_desc_conf_main;
    delete Opt_desc_conf_service;
}


/**
 * Parses the command line arguments and does the needed actions.
 * @param argc Command line argument number given to main.
 * @param argv[] Pointer to command line argument array given to main.
 * @return 0 if all is fine,
 */
int Config::parse_cmd_line(int argc, char *argv[])
{
    try
    {
        po::variables_map vm;
        po::store(po::parse_command_line(argc, argv, *this->Opt_desc_cmd), vm);
        po::notify(vm);

        if(vm.count("help"))
            return 1;
        else if(vm.count("version"))
            return 2;

        // Are all needed options set to create a Service Object
        if(vm.count("protocol") && vm.count("host") && vm.count("login") && vm.count("password"))
        {
            // Get the cmd parameter values for protocol host login and password
            string protocol = vm["protocol"].as<string>();
            string host = vm["host"].as<string>();
            string login = vm["login"].as<string>();
            string password = vm["password"].as<string>();

            //TODO: convert protocol option to lowercase

            // Create corresponding Service object TODO: swap to extra method
            if(protocol == "dhs")
            {
                Service * service = new DHS(host,login,password);
                this->services.push_back(service);
            }
            else if(protocol == "ods")
            {
                Service * service = new ODS(host,login,password);
                this->services.push_back(service);
            }
        }
        else
        {
            cout << "Not all needed options set!\n" << endl;
            return 1;
        }
    }
    catch(po::unknown_option e)
    {
        cout << "Unknown option set." << endl;
        return 1;
    }
    return 0;
}


/**
 * Loads the main and the service config file and does the needed action.
 * @param config_path The path to the config directory.
 * @return 0 if all is fine.
 */
int Config::load_config_from_files(string config_path)
{
    fs::path full_config_path = fs::system_complete(fs::path(config_path));

    if( fs::exists(full_config_path) && fs::is_directory(full_config_path))
    {
        fs::directory_iterator end_iter;
        for(fs::directory_iterator dir_itr(full_config_path); dir_itr != end_iter; ++dir_itr)
        {
            if( fs::is_regular_file(dir_itr->status()))
            {
                string filename = dir_itr->path().filename();
                if(filename == "bpdyndnsd.conf")
                {
                    cout << filename << endl;
                }
            }
        }

    }
    else
    {
        cout << "Path doesn't exist or is not a directory" << endl;
        return 4;
    }






/*

    // first load the main config file bpdyndnsd.conf
    string main_conf_file = config_path.append("/bpdyndnsd.conf");
    ifstream config_file (main_conf_file.c_str(),ifstream::in);
    if(config_file.is_open())
    {
        try
        {
            // parse the config file
            po::variables_map vm;
            po::parsed_options parsed = po::parse_config_file(config_file,*this->opt_desc_conf_main,true);
            po::store(parsed,vm);
            po::notify(vm);

            if(vm.count("daemon_mode") && vm.count("logfile") && vm.count("loglevel") && vm.count("syslog"))
            {
                // Get the options from main section
                this->daemon_mode = vm["main.daemon_mode"].as<bool>();
                this->logfile = vm["main.logfile"].as<string>();
                this->loglevel = vm["main.loglevel"].as<int>();
                this->syslog = vm["main.syslog"].as<bool>();
            }
        }
        catch(po::unknown_option e)
        {
            // unknown option in config file detected
            config_file.close();
            cout << "Unknown option in config file detected!" << endl;
            return 3;
        }
        config_file.close();
    }
    else
    {
        cout << "Can't open main config file for reading: " << main_conf_file << endl;
        return 4;
    }
*/
    // then load all service definition files in config path

    // TODO: code to load service definition files in config path
    return -1;
}


/**
 * Getter method for Service list member.
 * @return Pointer to a list of Service's.
 */
list<Service*> Config::get_services()
{
    return this->Services;
}


/**
 * Prints out the usage to the command line.
 */
void Config::print_usage()
{
    cout << "Usage: bpdyndnsd [Command line options]" << "\n" << endl;
    cout << *Opt_desc_cmd << endl;
}


/**
 * Prints out the programm name and the given version string on stdout.
 * @param version Version string.
 */
void Config::print_version(string version)
{
    cout << "Bullet proof dynamic dns daemon.\nbpdyndnsd " << version << endl;
}