]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/treesocket.h
m_spanningtree Netburst: Refactor SendChannelModes()
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treesocket.h
index 1bd02762d5db2eb2bef1f05a7c86e40b19d04e98..ae54bc6aab3c5ef0aa8a0fdf9cee8203d480bccb 100644 (file)
@@ -1,18 +1,26 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
  *
- *  InspIRCd: (C) 2002-2010 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/>.
  */
 
-#ifndef __TREESOCKET_H__
-#define __TREESOCKET_H__
+
+#pragma once
 
 #include "socket.h"
 #include "inspircd.h"
  * 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 };
+enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED, DYING };
 
 struct CapabData
 {
+       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;
@@ -63,40 +74,27 @@ struct CapabData
        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.
- * 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.
+/** 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 myhost;                     /* Canonical hostname */
+       std::string linkID;                     /* Description for this link */
        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 */
-       std::string IP;
-       CapabData* capab;
-       int num_lost_users;                     /* Users lost in split */
-       int num_lost_servers;                   /* Servers lost in split */
+       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 */
+       bool ConnectionFailureShown; /* Set to true if a connection failure message was shown */
  public:
-       reference<Autoconnect> myautoconnect;           /* Autoconnect used to cause this connection, if any */
        time_t age;
 
        /** Because most of the I/O gubbins are encapsulated within
@@ -104,7 +102,7 @@ class TreeSocket : public BufferedSocket
         * most of the action, and append a few of our own values
         * to it.
         */
-       TreeSocket(SpanningTreeUtilities* Util, const std::string& host, int port, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Autoconnect* myac, const std::string& Hook);
+       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
@@ -145,10 +143,6 @@ class TreeSocket : public BufferedSocket
         */
        ~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
         */
@@ -191,9 +185,6 @@ class TreeSocket : public BufferedSocket
         */
        void SendCapabilities(int phase);
 
-       /** Add modules to VF_COMMON list for backwards compatability */
-       void CompatAddModules(std::vector<std::string>& modlist);
-
        /* 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);
@@ -206,7 +197,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
@@ -221,16 +212,16 @@ class TreeSocket : public BufferedSocket
         * If the length of a single line is more than 480-NICKMAX
         * in length, it is split over multiple lines.
         */
-       void SendFJoins(TreeServer* Current, Channel* c);
+       void SendFJoins(Channel* c);
 
        /** Send G, Q, Z and E lines */
-       void SendXLines(TreeServer* Current);
+       void SendXLines();
 
-       /** Send channel modes and topics */
-       void SendChannelModes(TreeServer* Current);
+       /** Send all known information about a channel */
+       void SyncChannel(Channel* chan);
 
        /** send all users and their oper state/modes */
-       void SendUsers(TreeServer* Current);
+       void SendUsers();
 
        /** This function is called when we want to send a netburst to a local
         * server. There is a set order we must do this, because for example
@@ -265,10 +256,6 @@ class TreeSocket : public BufferedSocket
         */
        bool OperQuit(const std::string &prefix, parameterlist &params);
 
-       /** KILL
-        */
-       bool RemoteKill(const std::string &prefix, parameterlist &params);
-
        /** PONG
         */
        bool LocalPong(const std::string &prefix, parameterlist &params);
@@ -319,33 +306,14 @@ 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();
        /** Handle server quit on close
         */
        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;
+       /** Returns true if this server was introduced to the rest of the network
+        */
+       bool Introduced();
 };
-
-#endif
-