merged PingRotate into PingScheduler; fixed save/load of cache to/from file; started...

[pingcheck] / src / dns / dnscache.h

/*
 The software in this package is distributed under the GNU General
 Public License version 2 (with a special exception described below).

 A copy of GNU General Public License (GPL) is included in this distribution,
 in the file COPYING.GPL.

 As a special exception, if other files instantiate templates or use macros
 or inline functions from this file, or you compile this file and link it
 with other works to produce a work based on this file, this file
 does not by itself cause the resulting work to be covered
 by the GNU General Public License.

 However the source code for this file must still be made available
 in accordance with section (3) of the GNU General Public License.

 This exception does not invalidate any other reasons why a work based
 on this file might be covered by the GNU General Public License.

 Christian Herdtweck, Intra2net AG 2015
 */

#ifndef DNS_CACHE_H
#define DNS_CACHE_H

#include <map>

#include <boost/shared_ptr.hpp>
#include <boost/asio/deadline_timer.hpp>
#include <boost/system/error_code.hpp>
#include <boost/archive/xml_oarchive.hpp>
#include <boost/archive/xml_iarchive.hpp>
#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/split_member.hpp>
#include <boost/serialization/string.hpp>

#include "host/pinger.h"    // for IoserviceItem
#include "dns/hostaddress.h"
#include "dns/timetolive.h"

typedef std::vector<HostAddress> HostAddressVec;
typedef std::map<std::string, HostAddressVec> ip_map_type;

// -----------------------------------------------------------------------------
// CNAME
// -----------------------------------------------------------------------------

struct Cname
{   // all public:
    std::string Host;
    TimeToLive Ttl;

    Cname();
    Cname(const std::string &host, const uint32_t ttl);
    Cname(const std::string &host, const TimeToLive &ttl);

    // serialization
    friend class boost::serialization::access;
    template<class Archive>
    void save(Archive & ar, const unsigned int version) const
    {
        ar & BOOST_SERIALIZATION_NVP(Host);
        ar & BOOST_SERIALIZATION_NVP(Ttl);
    }
    template<class Archive>
    void load(Archive & ar, const unsigned int version)
    {
        ar & BOOST_SERIALIZATION_NVP(Host);
        ar & BOOST_SERIALIZATION_NVP(Ttl);
    }
    BOOST_SERIALIZATION_SPLIT_MEMBER()
};
typedef std::map<std::string, Cname> cname_map_type;

/// constant to give as cache_file arg to DnsCache constructor
/// indicating that no cache file should be used
const std::string DO_NOT_USE_CACHE_FILE = "do not use cache file!";


// -----------------------------------------------------------------------------
// DnsCache
// -----------------------------------------------------------------------------

class DnsCache
{
public:
    DnsCache( const IoServiceItem &io_serv,
              const std::string &cache_file );
    ~DnsCache();

    // accessed from ResolverBase subclasses
    void update(const std::string &hostname, const HostAddressVec &new_ips);
    void update(const std::string &hostname, const Cname &cname);

    // retrieval
    HostAddressVec get_ips(const std::string &hostname,
                           const bool check_up_to_date=false);
    Cname get_cname(const std::string &hostname,
                     const bool check_up_to_date=false);
    HostAddressVec get_ips_recursive(const std::string &hostname,
                                     const bool check_up_to_date=false);
    std::string get_first_outdated_cname(const std::string &hostname,
                                         const uint32_t ttl_thresh);

// variables
private:
    ip_map_type IpCache;
    cname_map_type CnameCache;
    boost::asio::deadline_timer SaveTimer;
    std::string CacheFile;
    bool HasChanged;

// internal functions
private:
    void schedule_save(const boost::system::error_code &error);
    void save_to_cachefile();
    void load_from_cachefile();
    std::string key_for_hostname(const std::string &hostname) const;

};

typedef boost::shared_ptr<DnsCache> DnsCacheItem;

#endif

// (created using vim -- the world's best text editor)