]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/dns.h
Remove unneeded ProtocolInterface::Introduce
[user/henk/code/inspircd.git] / include / dns.h
index adb9fdab853d02ab2f5eb5b5f1e1a23d95b3e780..a780505d072fff09b0f551af84b9bbe43b0e11d4 100644 (file)
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
@@ -32,21 +32,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 #ifndef _DNS_H
 #define _DNS_H
 
-#include <string>
-#include "inspircd_config.h"
-#include "base.h"
-#include "socketengine.h"
 #include "socket.h"
-#include "hash_map.h"
 #include "hashcomp.h"
 
-using namespace std;
-using irc::sockets::insp_aton;
-using irc::sockets::insp_ntoa;
-using irc::sockets::insp_sockaddr;
-using irc::sockets::insp_inaddr;
-
-class InspIRCd;
 class Module;
 
 /**
@@ -84,7 +72,7 @@ typedef std::pair<unsigned char*, std::string> DNSInfo;
 
 /** Cached item stored in the query cache.
  */
-class CoreExport CachedQuery
+class CoreExport CachedQuery : public classbase
 {
  public:
        /** The cached result data, an IP or hostname
@@ -115,10 +103,10 @@ class CoreExport CachedQuery
 
 /** DNS cache information. Holds IPs mapped to hostnames, and hostnames mapped to IPs.
  */
-#ifndef WIN32
-typedef nspace::hash_map<irc::string, CachedQuery, nspace::hash<irc::string> > dnscache;
-#else
+#if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED)
 typedef nspace::hash_map<irc::string, CachedQuery, nspace::hash_compare<irc::string> > dnscache;
+#else
+typedef nspace::hash_map<irc::string, CachedQuery, nspace::hash<irc::string> > dnscache;
 #endif
 
 /**
@@ -129,10 +117,9 @@ enum ResolverError
        RESOLVER_NOERROR        =       0,
        RESOLVER_NSDOWN         =       1,
        RESOLVER_NXDOMAIN       =       2,
-       RESOLVER_NOTREADY       =       3,
-       RESOLVER_BADIP          =       4,
-       RESOLVER_TIMEOUT        =       5,
-       RESLOVER_FORCEUNLOAD    =       6
+       RESOLVER_BADIP          =       3,
+       RESOLVER_TIMEOUT        =       4,
+       RESOLVER_FORCEUNLOAD    =       5
 };
 
 /**
@@ -155,30 +142,33 @@ struct ResourceRecord;
  */
 enum QueryType
 {
-       DNS_QUERY_NONE  = 0,            /* Uninitialized Query */
-       DNS_QUERY_A     = 1,            /* 'A' record: an ipv4 address */
-       DNS_QUERY_CNAME = 5,            /* 'CNAME' record: An alias */
-       DNS_QUERY_PTR   = 12,           /* 'PTR' record: a hostname */
-       DNS_QUERY_AAAA  = 28,           /* 'AAAA' record: an ipv6 address */
-
-       DNS_QUERY_PTR4  = 0xFFFD,       /* Force 'PTR' to use IPV4 scemantics */
-       DNS_QUERY_PTR6  = 0xFFFE        /* Force 'PTR' to use IPV6 scemantics */
+       /** Uninitialized Query */
+       DNS_QUERY_NONE  = 0,
+       /** 'A' record: an ipv4 address */
+       DNS_QUERY_A     = 1,
+       /** 'CNAME' record: An alias */
+       DNS_QUERY_CNAME = 5,
+       /** 'PTR' record: a hostname */
+       DNS_QUERY_PTR   = 12,
+       /** 'AAAA' record: an ipv6 address */
+       DNS_QUERY_AAAA  = 28,
+
+       /** Force 'PTR' to use IPV4 scemantics */
+       DNS_QUERY_PTR4  = 0xFFFD,
+       /** Force 'PTR' to use IPV6 scemantics */
+       DNS_QUERY_PTR6  = 0xFFFE
 };
 
-#ifdef IPV6
-const QueryType DNS_QUERY_FORWARD = DNS_QUERY_AAAA;
-#else
-const QueryType DNS_QUERY_FORWARD = DNS_QUERY_A;
-#endif
-const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 /**
  * Used internally to force PTR lookups to use a certain protocol scemantics,
  * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6.
  */
 enum ForceProtocol
 {
-       PROTOCOL_IPV4 = 0,      /* Forced to use ipv4 */
-       PROTOCOL_IPV6 = 1       /* Forced to use ipv6 */
+       /** Forced to use ipv4 */
+       PROTOCOL_IPV4 = 0,
+       /** Forced to use ipv6 */
+       PROTOCOL_IPV6 = 1
 };
 
 /**
@@ -231,6 +221,7 @@ class CoreExport Resolver : public Extensible
         * Time left before cache expiry
         */
        int time_left;
+
  public:
        /**
         * Initiate DNS lookup. Your class should not attempt to delete or free these
@@ -240,21 +231,12 @@ class CoreExport Resolver : public Extensible
         * the object to go 'out of scope' and cause a segfault in the core if the result
         * arrives at a later time.
         * @param source The IP or hostname to resolve
-        * @param qt The query type to perform. If you just want to perform a forward
-        * or reverse lookup, and you don't care wether you get ipv4 or ipv6, then use
-        * the constants DNS_QUERY_FORWARD and DNS_QUERY_REVERSE, which automatically
-        * select from 'A' record or 'AAAA' record lookups. However, if you want to resolve
-        * a specific record type, resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records
+        * @param qt The query type to perform. Resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records
         * is supported. Use one of the QueryType enum values to initiate this type of
         * lookup. Resolution of 'AAAA' ipv6 records is always supported, regardless of
         * wether InspIRCd is built with ipv6 support.
-        * If you attempt to resolve a 'PTR' record using DNS_QUERY_PTR, and InspIRCd is
-        * built with ipv6 support, the 'PTR' record will be formatted to ipv6 specs,
-        * e.g. x.x.x.x.x....ip6.arpa. otherwise it will be formatted to ipv4 specs,
-        * e.g. x.x.x.x.in-addr.arpa. This translation is automatic.
-        * To get around this automatic behaviour, you must use one of the values
-        * DNS_QUERY_PTR4 or DNS_QUERY_PTR6 to force ipv4 or ipv6 behaviour on the lookup,
-        * irrespective of what protocol InspIRCd has been built for.
+        * To look up reverse records, specify one of DNS_QUERY_PTR4 or DNS_QUERY_PTR6 depending
+        * on the type of address you are looking up.
         * @param cached The constructor will set this boolean to true or false depending
         * on whether the DNS lookup you are attempting is cached (and not expired) or not.
         * If the value is cached, upon return this will be set to true, otherwise it will
@@ -279,6 +261,7 @@ class CoreExport Resolver : public Extensible
         * The default destructor does nothing.
         */
        virtual ~Resolver();
+
        /**
         * When your lookup completes, this method will be called.
         * @param result The resulting DNS lookup, either an IP address or a hostname.
@@ -286,10 +269,9 @@ class CoreExport Resolver : public Extensible
         * result, this is the number of seconds remaining before refresh/expiry.
         * @param cached True if the result is a cached result, false if it was requested
         * from the DNS server.
-        * @param resultnum Result number, for records with multiple matching results.
-        * Normally, you will only want to act on this when the result is 0.
         */
-       virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0) = 0;
+       virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached) = 0;
+
        /**
         * If an error occurs (such as NXDOMAIN, no domain name found) then this method
         * will be called.
@@ -297,6 +279,7 @@ class CoreExport Resolver : public Extensible
         * @param errormessage The error text of the error that occured.
         */
        virtual void OnError(ResolverError e, const std::string &errormessage);
+
        /**
         * Returns the id value of this class. This is primarily used by the core
         * to determine where in various tables to place a pointer to your class, but it
@@ -306,10 +289,12 @@ class CoreExport Resolver : public Extensible
         * this method will return -1.
         */
        int GetId();
+
        /**
         * Returns the creator module, or NULL
         */
        Module* GetCreator();
+
        /**
         * If the result is a cached result, this triggers the objects
         * OnLookupComplete. This is done because it is not safe to call
@@ -372,9 +357,15 @@ class CoreExport DNS : public EventHandler
         * Server address being used currently
         */
        int socketfamily;
-#ifdef IPV6
+
+       /**
+        * IPV6 server address
+        */
        in6_addr myserver6;
-#endif
+
+       /**
+        * IPV4 server address
+        */
        in_addr myserver4;
 
        /**
@@ -413,14 +404,6 @@ class CoreExport DNS : public EventHandler
         */
        int GetIP(const char* name);
 
-       /**
-        * Start the lookup of a hostname from an ip,
-        * always using the protocol inspircd is built for,
-        * e.g. use ipv6 reverse lookup when built for ipv6,
-        * or ipv4 lookup when built for ipv4.
-        */
-       int GetName(const insp_inaddr* ip);
-
        /**
         * Start lookup of a hostname from an ip, but
         * force a specific protocol to be used for the lookup
@@ -441,9 +424,8 @@ class CoreExport DNS : public EventHandler
        /**
         * Fetch the result string (an ip or host)
         * and/or an error message to go with it.
-        * @param resultnum Result number to fetch
         */
-       DNSResult GetResult(int resultnum);
+       DNSResult GetResult();
 
        /**
         * Handle a SocketEngine read event