2 The software in this package is distributed under the GNU General
3 Public License version 2 (with a special exception described below).
5 A copy of GNU General Public License (GPL) is included in this distribution,
6 in the file COPYING.GPL.
8 As a special exception, if other files instantiate templates or use macros
9 or inline functions from this file, or you compile this file and link it
10 with other works to produce a work based on this file, this file
11 does not by itself cause the resulting work to be covered
12 by the GNU General Public License.
14 However the source code for this file must still be made available
15 in accordance with section (3) of the GNU General Public License.
17 This exception does not invalidate any other reasons why a work based
18 on this file might be covered by the GNU General Public License.
20 Christian Herdtweck, Intra2net AG 2015
28 #include <boost/shared_ptr.hpp>
29 #include <boost/asio/deadline_timer.hpp>
30 #include <boost/system/error_code.hpp>
31 #include <boost/archive/xml_oarchive.hpp>
32 #include <boost/archive/xml_iarchive.hpp>
33 #include <boost/date_time/posix_time/posix_time.hpp>
35 #include "host/pinger.h" // for IoserviceItem
36 #include "dns/dnsipprotocol.h"
37 #include "dns/hostaddress.h"
38 #include "dns/cname.h"
40 typedef std::vector<HostAddress> HostAddressVec;
41 typedef std::pair<std::string, DnsIpProtocol> ip_map_key_type;
42 typedef std::map<ip_map_key_type, HostAddressVec> ip_map_type;
43 typedef std::string cname_map_key_type;
44 typedef std::map<cname_map_key_type, Cname> cname_map_type;
46 // -----------------------------------------------------------------------------
48 // -----------------------------------------------------------------------------
53 /// constant to give as cache_file arg to DnsCache constructor
54 /// indicating that no cache file should be used
55 static const std::string DoNotUseCacheFile;
57 DnsCache( const IoServiceItem &io_serv,
58 const std::string &cache_file,
59 const uint32_t min_time_between_resolves );
62 // accessed from ResolverBase subclasses
63 void update(const std::string &hostname,
64 const DnsIpProtocol &protocol,
65 const HostAddressVec &new_ips);
66 void update(const std::string &hostname,
70 HostAddressVec get_ips(const std::string &hostname,
71 const DnsIpProtocol &protocol,
72 const bool check_up_to_date=false);
73 Cname get_cname(const std::string &hostname,
74 const bool check_up_to_date=false);
75 HostAddressVec get_ips_recursive(const std::string &hostname,
76 const DnsIpProtocol &protocol,
77 const bool check_up_to_date=false);
78 std::string get_first_outdated_cname(const std::string &hostname,
79 const uint32_t ttl_thresh);
80 std::string get_cname_chain_str(const std::string &hostname);
85 cname_map_type CnameCache;
86 boost::asio::deadline_timer SaveTimer;
87 std::string CacheFile;
89 uint32_t MinTimeBetweenResolves;
93 void schedule_save(const boost::system::error_code &error);
94 void save_to_cachefile();
95 void load_from_cachefile();
96 ip_map_key_type key_for_ips(const std::string &hostname,
97 const DnsIpProtocol &protocol) const;
98 cname_map_key_type key_for_cname(const std::string &hostname) const;
99 bool check_timestamps(const boost::posix_time::ptime &cache_save_time);
103 typedef boost::shared_ptr<DnsCache> DnsCacheItem;