]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/dns.h
Switch <stdint.h> test to use a test file too.
[user/henk/code/inspircd.git] / include / dns.h
index fa42952965afae652a4c33bd7b241885f165bc94..de4bcf4223fb713273b3edc2a4a1243f67b35490 100644 (file)
@@ -1,16 +1,24 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
  *
- * ---------------------------------------------------
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
 /*
 dns.h - dns library very very loosely based on
 firedns, Copyright (C) 2002 Ian Gulliver
@@ -29,18 +37,38 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-#ifndef _DNS_H
-#define _DNS_H
+#ifndef DNS_H
+#define DNS_H
 
 #include "socket.h"
 #include "hashcomp.h"
 
-class Module;
+/**
+ * Query and resource record types
+ */
+enum QueryType
+{
+       /** 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
+};
 
 /**
  * Result status, used internally
  */
-class CoreExport DNSResult : public classbase
+class CoreExport DNSResult
 {
  public:
        /** Result ID
@@ -55,14 +83,18 @@ class CoreExport DNSResult : public classbase
        /** The original request, a hostname or IP address
         */
        std::string original;
+       /** The type of the request
+        */
+       QueryType type;
 
        /** Build a DNS result.
         * @param i The request ID
         * @param res The request result, a hostname or IP
         * @param timetolive The request time-to-live
         * @param orig The original request, a hostname or IP
+        * @param qt The type of DNS query this result represents.
         */
-       DNSResult(int i, const std::string &res, unsigned long timetolive, const std::string &orig) : id(i), result(res), ttl(timetolive), original(orig) { }
+       DNSResult(int i, const std::string &res, unsigned long timetolive, const std::string &orig, QueryType qt = DNS_QUERY_NONE) : id(i), result(res), ttl(timetolive), original(orig), type(qt) { }
 };
 
 /**
@@ -72,42 +104,35 @@ typedef std::pair<unsigned char*, std::string> DNSInfo;
 
 /** Cached item stored in the query cache.
  */
-class CoreExport CachedQuery : public classbase
+class CoreExport CachedQuery
 {
  public:
        /** The cached result data, an IP or hostname
         */
        std::string data;
+       /** The type of result this is
+        */
+       QueryType type;
        /** The time when the item is due to expire
         */
        time_t expires;
 
        /** Build a cached query
         * @param res The result data, an IP or hostname
+        * @param qt The type of DNS query this instance represents.
         * @param ttl The time-to-live value of the query result
         */
-       CachedQuery(const std::string &res, unsigned int ttl) : data(res)
-       {
-               expires = time(NULL) + ttl;
-       }
+       CachedQuery(const std::string &res, QueryType qt, unsigned int ttl);
 
        /** Returns the number of seconds remaining before this
         * cache item has expired and should be removed.
         */
-       int CalcTTLRemaining()
-       {
-               int n = (int)expires - (int)time(NULL);
-               return (n < 0 ? 0 : n);
-       }
+       int CalcTTLRemaining();
 };
 
 /** DNS cache information. Holds IPs mapped to hostnames, and hostnames mapped to IPs.
  */
-#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
+typedef nspace::hash_map<irc::string, CachedQuery, irc::hash> dnscache;
 
 /**
  * Error types that class Resolver can emit to its error method.
@@ -122,49 +147,6 @@ enum ResolverError
        RESOLVER_FORCEUNLOAD    =       5
 };
 
-/**
- * A DNS request
- */
-class DNSRequest;
-
-/**
- * A DNS packet header
- */
-class DNSHeader;
-
-/**
- * A DNS Resource Record (rr)
- */
-struct ResourceRecord;
-
-/**
- * Query and resource record types
- */
-enum QueryType
-{
-       /** 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.
@@ -187,17 +169,13 @@ enum ForceProtocol
  * can occur by calling virtual methods, one is a success situation, and the other
  * an error situation.
  */
-class CoreExport Resolver : public Extensible
+class CoreExport Resolver
 {
  protected:
-       /**
-        * Pointer to creator
-        */
-       InspIRCd* ServerInstance;
        /**
         * Pointer to creator module (if any, or NULL)
         */
-       Module* Creator;
+       ModuleRef Creator;
        /**
         * The input data, either a host or an IP address
         */
@@ -237,21 +215,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
@@ -270,7 +239,7 @@ class CoreExport Resolver : public Extensible
         * whilst lookups are in progress, they can be safely removed and your module will not
         * crash the server.
         */
-       Resolver(InspIRCd* Instance, const std::string &source, QueryType qt, bool &cached, Module* creator = NULL);
+       Resolver(const std::string &source, QueryType qt, bool &cached, Module* creator);
 
        /**
         * The default destructor does nothing.
@@ -327,30 +296,12 @@ class CoreExport DNS : public EventHandler
 {
  private:
 
-       /**
-        * Creator/Owner object
-        */
-       InspIRCd* ServerInstance;
-
        /**
         * The maximum value of a dns request id,
         * 16 bits wide, 0xFFFF.
         */
        static const int MAX_REQUEST_ID = 0xFFFF;
 
-       /**
-        * A counter used to form part of the pseudo-random id
-        */
-       int currid;
-
-       /**
-        * We have to turn off a few checks on received packets
-        * when people are using 4in6 (e.g. ::ffff:xxxx). This is
-        * a temporary kludge, Please let me know if you know how
-        * to fix it.
-        */
-       bool ip6munge;
-
        /**
         * Currently cached items
         */
@@ -368,21 +319,7 @@ class CoreExport DNS : public EventHandler
 
  public:
 
-       /**
-        * Server address being used currently
-        */
-       int socketfamily;
-
-#ifdef IPV6
-       /**
-        * IPV6 server address
-        */
-       in6_addr myserver6;
-#endif
-       /**
-        * IPV4 server address
-        */
-       in_addr myserver4;
+       irc::sockets::sockaddrs myserver;
 
        /**
         * Currently active Resolver classes
@@ -420,14 +357,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 irc::sockets::insp_inaddr* ip);
-
        /**
         * Start lookup of a hostname from an ip, but
         * force a specific protocol to be used for the lookup
@@ -471,7 +400,7 @@ class CoreExport DNS : public EventHandler
         * The constructor initialises the dns socket,
         * and clears the request lists.
         */
-       DNS(InspIRCd* Instance);
+       DNS();
 
        /**
         * Re-initialize the DNS subsystem.
@@ -483,13 +412,6 @@ class CoreExport DNS : public EventHandler
         */
        ~DNS();
 
-       /** Portable random number generator, generates
-        * its random number from the ircd stats counters,
-        * effective user id, time of day and the rollover
-        * counter (currid)
-        */
-       unsigned long PRNG();
-
        /**
         * Turn an in6_addr into a .ip6.arpa domain
         */