Next steps in fine tuning code.

[bpdyndnsd] / src / updater.cpp

/** @file
 * @brief The updater class implementation. This class implements the updater logic.
 *
 *
 *
 * @copyright Intra2net AG
 * @license GPLv2
*/

#include "updater.h"

#include "serviceholder.h"


#include <boost/foreach.hpp>
#include <boost/serialization/export.hpp>


using namespace std;


/**
 * Default constructor which initializes the member Conf.
 */
Updater::Updater()
    : IPAddrHelp(new IPAddrHelper)
{
    // Initialize program wide Logger, at this point we don't know where to log and with which loglevel.
    Logger::Ptr _log(new Logger);
    Log.swap(_log);

    // initialize Serviceholder
    Serviceholder::Ptr _serviceholder(new Serviceholder(Log));
    ServiceHolder.swap(_serviceholder);

    // initialize Config
    Config::Ptr _config(new Config(Log,ServiceHolder));
    Conf.swap(_config);
}


/**
 * Default destructor.
 */
Updater::~Updater()
{
}



/**
 * Load config and initialize helper classes.
 * @param argc Number of arguments in array
 * @param argv Array with cmd options
 */
int Updater::load_config(int argc, char *argv[])
{
    // load the cmd options
    if ( init_config_from_cmd(argc,argv) != 0 )
        return -1;

    // load the config and service files
    if ( init_config_from_files() != 0 )
        return -1;

    // init all helper classes
    if ( init_helper_classes() != 0 )
        return -1;

    return 0;
}


/**
 * Reloading the config. Delete all Service objects and then init new Service objects from config files.
 */
int Updater::reload_config()
{
    // serialize all service objects
    if ( ServiceHolder->serialize_services() != 0 )
        return -1;

    // delete all service objects
    ServiceHolder->delete_services();

    // delete the actual Variables_map, perhaps with old cmd options which would overwrite new config file options.
    Conf->delete_variables_map();

    // load only config files
    if ( init_config_from_files() != 0 )
        return -1;

    // init all helper classes
    if ( init_helper_classes() != 0 )
        return -1;

    return 0;
}


/**
 * Parse the command line arguments and initialize corresponding options.
 * @param argc Number command line arguments.
 * @param argv[] Array with arguments.
 * @return 0 if cmd options successfully parsed, 1 if usage or version.
 */
int Updater::init_config_from_cmd(int argc, char *argv[])
{
    // Load the command line parameters
    if( Conf->parse_cmd_line( argc, argv) != 0)
        return -1;

    // If we have loaded the cmd options we need to init the log facility immediately in case debugging is enabled from cmd.
    init_log_facility();

    // successful parsed
    Log->print_cmd_parsed();
    return 0;
}


/**
 * Load the main config and the service definition files in config path.
 * @return 0 if all is fine, 
 */
int Updater::init_config_from_files()
{
    // Load the main and service config files in config path
    if ( Conf->load_config_from_files() != 0 )
        return -1;

    // Re-init log facility, perhaps new config file options for logger are set.
    // These config file options will only overwrite the cmd options if the SIGHUP (reload config) is caught.
    init_log_facility();

    // Here we are. All Service Objects should be initialized, so it is time to deserialize the old service objects and compare them.
    if ( ServiceHolder->deserialize_services() != 0 )
        return -1;

    // successful loaded
    Log->print_conf_files_parsed();
    return 0;
}


/**
 * Init all Helper classes
 * @return 
 */
int Updater::init_helper_classes()
{
    // Initialize IPHelper
    if ( init_ip_helper() != 0 )
        return -1;

    return 0;
}


/**
 * Init the IPHelp member with needed values.
 * @return 0 if all is fine, -1 otherwise.
 */
int Updater::init_ip_helper()
{
    // Try to get deserialized IPAddrHelper from ServiceHolder
    IPAddrHelper::Ptr _ip_addr_help = ServiceHolder->get_ip_addr_helper();
    if ( _ip_addr_help.use_count() != 0 )
    {
        // Initialize IPHelper
        IPAddrHelper::Ptr ip_addr_help( new IPAddrHelper( Log, Conf->get_webcheck_ip_url(), Conf->get_webcheck_ip_url_alt(), Conf->get_webcheck_interval(), _ip_addr_help->get_last_webcheck(), Conf->get_enable_ipv6(), Conf->get_proxy(), Conf->get_proxy_port() ) );
        IPAddrHelp.swap(ip_addr_help);
    }
    else
    {
        // IPAddrHelper from ServiceHolder was not declared, so init oen with LastWebcheck 0
        IPAddrHelper::Ptr ip_addr_help( new IPAddrHelper( Log, Conf->get_webcheck_ip_url(), Conf->get_webcheck_ip_url_alt(), Conf->get_webcheck_interval(), 0, Conf->get_enable_ipv6(), Conf->get_proxy(), Conf->get_proxy_port() ) );
        IPAddrHelp.swap(ip_addr_help);
    }

    // Put the IPAddrHelper into ServiceHolder, so the LastWebcheck state will be serialized too.
    ServiceHolder->set_ip_addr_helper(IPAddrHelp);

    return 0;
}


/**
 * Getter for member Config.
 * @return Member Config.
 */
Config::Ptr Updater::get_config() const
{
    return Conf;
}


/**
 * Getter for member Logger.
 * @return Member Logger.
 */
Logger::Ptr Updater::get_logger() const
{
    return Log;
}


/**
 * Initialize the logging facility with loglevel and syslog.
 */
void Updater::init_log_facility()
{
    Log->set_log_facility(Conf->get_loglevel(),Conf->get_syslog(),Conf->get_external_warning_log(),Conf->get_external_warning_level());
    Log->print_init_log_facility();
}


/**
 * Update all configured services.
 */
void Updater::update_services()
{
    // Get all services from the ServiceHolder.
    list<Service::Ptr> services = ServiceHolder->get_services();

    // Get the actual IP of this host.
    string ip_host = IPAddrHelp->get_actual_ip();

    if ( !ip_host.empty() )
    {
        BOOST_FOREACH(Service::Ptr &service, services )
        {
            string ip_last_update = service->get_actual_ip();
            string hostname = service->get_hostname();
            int lastupdated = 0;
            int current_time = time(NULL);

            // Try to get the lastupdated time of the actual service if there is one.
            if ( service->get_last_updates().size() > 0 )
                lastupdated = service->get_last_updates().front();

            Log->print_check_service_update(hostname, current_time, lastupdated);

            // Do a DNS Query for the dynamic hostname.
            string ip_dns_recheck = IPAddrHelp->dns_query(hostname);

            Log->print_cached_dns_entry(hostname, ip_dns_recheck, ip_last_update, ip_host);

            // Test if the DNS-Record could not be found.
            if ( ip_dns_recheck.empty() )
            {
                // Next in BOOST_FOREACH
            }
            // Test if the actual DNS-Record differs from the host's IP.
            else if ( ip_host != ip_dns_recheck )
            {
                // Check if the service will be updated for the first time.
                if ( lastupdated == 0 )
                {
                    // Update for the firt time.
                    Log->print_update_service_firttime(hostname, ip_dns_recheck, ip_host);
                    service->update(ip_host,current_time);
                }
                else
                {
                    // We already have updated, check if the IP set in last update differs from the actual host's ip.
                    if ( ip_last_update != ip_host )
                    {
                        // Update
                        Log->print_update_service(hostname, ip_dns_recheck, ip_last_update, ip_host, lastupdated);
                        service->update(ip_host,current_time);
                    }
                    else
                    {
                        int dns_cache_ttl = service->get_dns_cache_ttl();
                        // Check if DNS Cache TTL is expired, if so, then update the same IP again.
                        if ( (lastupdated + dns_cache_ttl) < current_time )
                        {
                            // Update
                            Log->print_update_service_ttl_expired(hostname, ip_dns_recheck, ip_last_update, ip_host, lastupdated, dns_cache_ttl, current_time);
                            service->update(ip_host,current_time);
                        }
                        else
                        {
                            // DNS cache TTL isn't expired
                            Log->print_update_service_ttl_not_expired(hostname, ip_dns_recheck, ip_last_update, ip_host, lastupdated, dns_cache_ttl, current_time);
                        }
                    }
                }
            }
            else
            {
                Log->print_no_update_needed(hostname, ip_dns_recheck, ip_last_update, ip_host, lastupdated);
            }
        }
    }
    else
    {
        Log->print_no_wan_ip();
    }
}


/**
 * Getter for member ServiceHolder.
 * @return ServiceHolder
 */
Serviceholder::Ptr Updater::get_service_holder() const
{
    return ServiceHolder;
}