]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/treesocket.h
Fix some of the include guard names (requested by SaberUK)
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treesocket.h
index 3744de96bd59be61840395ffc9ff64eac2602b74..80f9e0798e1c2895e5b9063950e9d8344ea94490 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
  * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  * ---------------------------------------------------
  */
 
-#ifndef __TREESOCKET_H__
-#define __TREESOCKET_H__
+#ifndef M_SPANNINGTREE_TREESOCKET_H
+#define M_SPANNINGTREE_TREESOCKET_H
 
 #include "socket.h"
 #include "inspircd.h"
 #include "xline.h"
-#include "../transport.h"
 
 #include "utils.h"
-#include "handshaketimer.h"
 
 /*
  * The server list in InspIRCd is maintained as two structures
  * WAIT_AUTH_2:        indicates that the socket is inbound
  *                                                     but has not yet sent and received
  *                                                     SERVER strings.
- * CONNECTED:          represents a fully authorized, fully
+ * CONNECTED:   represents a fully authorized, fully
  *                                                     connected server.
+ * DYING:       represents a server that has had an error.
  */
-enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
-
-/** Every SERVER connection inbound or outbound is represented by
- * an object of type TreeSocket.
- * TreeSockets, being inherited from BufferedSocket, can be tied into
- * the core socket engine, and we cn therefore receive activity events
- * for them, just like activex objects on speed. (yes really, that
- * is a technical term!) Each of these which relates to a locally
- * connected server is assocated with it, by hooking it onto a
- * TreeSocket class using its constructor. In this way, we can
- * maintain a list of servers, some of which are directly connected,
- * some of which are not.
- */
-class TreeSocket : public BufferedSocket
+enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED, DYING };
+
+struct CapabData
 {
-       SpanningTreeUtilities* Utils;           /* Utility class */
-       std::string myhost;                     /* Canonical hostname */
-       ServerState LinkState;                  /* Link state */
-       std::string InboundServerName;          /* Server name sent to us by other side */
-       std::string InboundDescription;         /* Server description (GECOS) sent to us by the other side */
-       std::string InboundSID;                 /* Server ID sent to us by the other side */
-       int num_lost_users;                     /* Users lost in split */
-       int num_lost_servers;                   /* Servers lost in split */
-       time_t NextPing;                        /* Time when we are due to ping this server */
-       bool LastPingWasGood;                   /* Responded to last ping we sent? */
-       std::string IP;
+       reference<Link> link;                   /* Link block used for this connection */
+       reference<Autoconnect> ac;              /* Autoconnect used to cause this connection, if any */
        std::string ModuleList;                 /* Required module list of other server from CAPAB */
        std::string OptModuleList;              /* Optional module list of other server from CAPAB */
+       std::string ChanModes;
+       std::string UserModes;
        std::map<std::string,std::string> CapKeys;      /* CAPAB keys from other server */
        std::string ourchallenge;               /* Challenge sent for challenge/response */
        std::string theirchallenge;             /* Challenge recv for challenge/response */
-       std::string OutboundPass;               /* Outbound password */
        int capab_phase;                        /* Have sent CAPAB already */
        bool auth_fingerprint;                  /* Did we auth using SSL fingerprint */
        bool auth_challenge;                    /* Did we auth using challenge/response */
+};
+
+/** Every SERVER connection inbound or outbound is represented by an object of
+ * type TreeSocket. During setup, the object can be found in Utils->timeoutlist;
+ * after setup, MyRoot will have been created as a child of Utils->TreeRoot
+ */
+class TreeSocket : public BufferedSocket
+{
+       SpanningTreeUtilities* Utils;           /* Utility class */
+       std::string linkID;                     /* Description for this link */
+       ServerState LinkState;                  /* Link state */
+       CapabData* capab;                       /* Link setup data (held until burst is sent) */
+       TreeServer* MyRoot;                     /* The server we are talking to */
+       time_t NextPing;                        /* Time when we are due to ping this server */
+       bool LastPingWasGood;                   /* Responded to last ping we sent? */
        int proto_version;                      /* Remote protocol version */
  public:
-       HandshakeTimer* hstimer;                /* Handshake timer, needed to work around I/O hook buffering */
-       reference<Autoconnect> myautoconnect;           /* Autoconnect used to cause this connection, if any */
        time_t age;
 
        /** Because most of the I/O gubbins are encapsulated within
@@ -100,13 +93,13 @@ class TreeSocket : public BufferedSocket
         * most of the action, and append a few of our own values
         * to it.
         */
-       TreeSocket(SpanningTreeUtilities* Util, std::string host, int port, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Autoconnect* myac, Module* HookMod = NULL);
+       TreeSocket(SpanningTreeUtilities* Util, Link* link, Autoconnect* myac, const std::string& ipaddr);
 
        /** When a listening socket gives us a new file descriptor,
         * we must associate it with a socket without creating a new
         * connection. This constructor is used for this purpose.
         */
-       TreeSocket(SpanningTreeUtilities* Util, int newfd, char* ip, Autoconnect* myac, Module* HookMod = NULL);
+       TreeSocket(SpanningTreeUtilities* Util, int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 
        /** Get link state
         */
@@ -136,14 +129,11 @@ class TreeSocket : public BufferedSocket
         */
        void CleanNegotiationInfo();
 
+       CullResult cull();
        /** Destructor
         */
        ~TreeSocket();
 
-       /** Generate random string used for challenge-response auth
-        */
-       std::string RandString(unsigned int length);
-
        /** Construct a password, optionally hashed with the other side's
         * challenge string
         */
@@ -189,11 +179,9 @@ class TreeSocket : public BufferedSocket
        /** Add modules to VF_COMMON list for backwards compatability */
        void CompatAddModules(std::vector<std::string>& modlist);
 
-       /* Check a comma seperated list for an item */
-       bool HasItem(const std::string &list, const std::string &item);
-
-       /* Isolate and return the elements that are different between two comma seperated lists */
-       std::string ListDifference(const std::string &one, const std::string &two);
+       /* Isolate and return the elements that are different between two lists */
+       void ListDifference(const std::string &one, const std::string &two, char sep,
+               std::string& mleft, std::string& mright);
 
        bool Capab(const parameterlist &params);
 
@@ -203,7 +191,7 @@ class TreeSocket : public BufferedSocket
         * is having a REAL bad hair day, this function shouldnt be called
         * too many times a month ;-)
         */
-       void SquitServer(std::string &from, TreeServer* Current);
+       void SquitServer(std::string &from, TreeServer* Current, int& num_lost_servers, int& num_lost_users);
 
        /** This is a wrapper function for SquitServer above, which
         * does some validation first and passes on the SQUIT to all
@@ -211,21 +199,9 @@ class TreeSocket : public BufferedSocket
         */
        void Squit(TreeServer* Current, const std::string &reason);
 
-       /** FMODE command - server mode with timestamp checks */
-       bool ForceMode(const std::string &source, parameterlist &params);
-
-       /** FTOPIC command */
-       bool ForceTopic(const std::string &source, parameterlist &params);
-
-       /** FJOIN, similar to TS6 SJOIN, but not quite. */
-       bool ForceJoin(const std::string &source, parameterlist &params);
-
        /* Used on nick collision ... XXX ugly function HACK */
        int DoCollision(User *u, time_t remotets, const std::string &remoteident, const std::string &remoteip, const std::string &remoteuid);
 
-       /** UID command */
-       bool ParseUID(const std::string &source, parameterlist &params);
-
        /** Send one or more FJOINs for a channel of users.
         * If the length of a single line is more than 480-NICKMAX
         * in length, it is split over multiple lines.
@@ -258,68 +234,30 @@ class TreeSocket : public BufferedSocket
        void WriteLine(std::string line);
 
        /** Handle ERROR command */
-       bool Error(parameterlist &params);
-
-       /** remote MOTD. */
-       bool Motd(const std::string &prefix, parameterlist &params);
-
-       /** remote ADMIN. */
-       bool Admin(const std::string &prefix, parameterlist &params);
-
-       bool Stats(const std::string &prefix, parameterlist &params);
-
-       /** Because the core won't let users or even SERVERS set +o,
-        * we use the OPERTYPE command to do this.
-        */
-       bool OperType(const std::string &prefix, parameterlist &params);
+       void Error(parameterlist &params);
 
        /** Remote AWAY */
        bool Away(const std::string &prefix, parameterlist &params);
 
-       /** Because Andy insists that services-compatible servers must
-        * implement SVSNICK and SVSJOIN, that's exactly what we do :p
-        */
-       bool SVSNick(const std::string &prefix, parameterlist &params);
-
        /** SAVE to resolve nick collisions without killing */
        bool ForceNick(const std::string &prefix, parameterlist &params);
 
        /** ENCAP command
         */
-       bool Encap(const std::string &prefix, parameterlist &params);
+       void Encap(User* who, parameterlist &params);
 
        /** OPERQUIT command
         */
        bool OperQuit(const std::string &prefix, parameterlist &params);
 
-       /** SVSJOIN
-        */
-       bool ServiceJoin(const std::string &prefix, parameterlist &params);
-
-       /** SVSPART
-        */
-       bool ServicePart(const std::string &prefix, parameterlist &params);
-
-       /** KILL
-        */
-       bool RemoteKill(const std::string &prefix, parameterlist &params);
-
        /** PONG
         */
        bool LocalPong(const std::string &prefix, parameterlist &params);
 
-       /** METADATA
-        */
-       bool MetaData(const std::string &prefix, parameterlist &params);
-
        /** VERSION
         */
        bool ServerVersion(const std::string &prefix, parameterlist &params);
 
-       /** CHGHOST
-        */
-       bool ChangeHost(const std::string &prefix, parameterlist &params);
-
        /** ADDLINE
         */
        bool AddLine(const std::string &prefix, parameterlist &params);
@@ -328,13 +266,6 @@ class TreeSocket : public BufferedSocket
         */
        bool DelLine(const std::string &prefix, parameterlist &params);
 
-       /** CHGNAME
-        */
-       bool ChangeName(const std::string &prefix, parameterlist &params);
-
-       /** FIDENT */
-       bool ChangeIdent(const std::string &prefix, parameterlist &params);
-
        /** WHOIS
         */
        bool Whois(const std::string &prefix, parameterlist &params);
@@ -343,19 +274,10 @@ class TreeSocket : public BufferedSocket
         */
        bool Push(const std::string &prefix, parameterlist &params);
 
-       /** TIME
-        */
-       bool Time(const std::string &prefix, parameterlist &params);
-
        /** PING
         */
        bool LocalPing(const std::string &prefix, parameterlist &params);
 
-       /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
-        * This does not update the timestamp of the target channel, this must be done seperately.
-        */
-       bool RemoveStatus(const std::string &prefix, parameterlist &params);
-
        /** <- (remote) <- SERVER
         */
        bool RemoteServer(const std::string &prefix, parameterlist &params);
@@ -378,10 +300,6 @@ class TreeSocket : public BufferedSocket
 
        void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
 
-       /** Get this server's name
-        */
-       virtual std::string GetName();
-
        /** Handle socket timeout from connect()
         */
        virtual void OnTimeout();
@@ -390,21 +308,5 @@ class TreeSocket : public BufferedSocket
        virtual void Close();
 };
 
-/* Used to validate the value lengths of multiple parameters for a command */
-struct cmd_validation
-{
-       const char* item;
-       size_t param;
-       size_t length;
-};
-
-/* Used to validate the length values in CAPAB CAPABILITIES */
-struct cap_validation
-{
-       const char* reason;
-       const char* key;
-       size_t size;
-};
-
 #endif