]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/treesocket.h
Pass an interface to the OnSync hooks
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treesocket.h
index 4438b473d3298a316bfb146eb89b7816cfdd6679..097f60fbb95a0c9ca93fedfaa9280a834a52be24 100644 (file)
@@ -1,22 +1,28 @@
-/*       +------------------------------------+
- *       | 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__
 
-#include "socket.h"
+#pragma once
+
 #include "inspircd.h"
-#include "xline.h"
 
 #include "utils.h"
 
@@ -57,6 +63,8 @@ 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;
@@ -64,54 +72,63 @@ 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 */
+
+       // Data saved from incoming SERVER command, for later use when our credentials have been accepted by the other party
+       std::string description;
+       std::string sid;
+       std::string name;
+       bool hidden;
 };
 
-/** 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 */
+       class BurstState;
+
+       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 */
+
+       /** Checks if the given servername and sid are both free
+        */
+       bool CheckDuplicate(const std::string& servername, const std::string& sid);
+
+       /** Send all ListModeBase modes set on the channel
+        */
+       void SendListModes(Channel* chan);
+
+       /** Send all known information about a channel */
+       void SyncChannel(Channel* chan, BurstState& bs);
+
+       /** Send all users and their oper state, away state and metadata */
+       void SendUsers(BurstState& bs);
+
  public:
-       reference<Autoconnect> myautoconnect;           /* Autoconnect used to cause this connection, if any */
-       time_t age;
+       const time_t age;
 
        /** Because most of the I/O gubbins are encapsulated within
         * BufferedSocket, we just call the superclass constructor for
         * 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(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, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
+       TreeSocket(int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 
        /** Get link state
         */
@@ -146,10 +163,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
         */
@@ -161,11 +174,11 @@ class TreeSocket : public BufferedSocket
         * to server docs on the inspircd.org site, the other side
         * will then send back its own server string.
         */
-       virtual void OnConnected();
+       void OnConnected();
 
        /** Handle socket error event
         */
-       virtual void OnError(BufferedSocketError e);
+       void OnError(BufferedSocketError e) CXX11_OVERRIDE;
 
        /** Sends an error to the remote server, and displays it locally to show
         * that it was sent.
@@ -175,13 +188,8 @@ class TreeSocket : public BufferedSocket
        /** Recursively send the server tree with distances as hops.
         * This is used during network burst to inform the other server
         * (and any of ITS servers too) of what servers we know about.
-        * If at any point any of these servers already exist on the other
-        * end, our connection may be terminated. The hopcounts given
-        * by this function are relative, this doesn't matter so long as
-        * they are all >1, as all the remote servers re-calculate them
-        * to be relative too, with themselves as hop 0.
         */
-       void SendServers(TreeServer* Current, TreeServer* s, int hops);
+       void SendServers(TreeServer* Current, TreeServer* s);
 
        /** Returns module list as a string, filtered by filter
         * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
@@ -192,9 +200,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);
@@ -207,7 +212,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
@@ -215,23 +220,17 @@ class TreeSocket : public BufferedSocket
         */
        void Squit(TreeServer* Current, const std::string &reason);
 
-       /* 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);
-
        /** 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.
         */
-       void SendFJoins(TreeServer* Current, Channel* c);
+       void SendFJoins(Channel* c);
 
        /** Send G, Q, Z and E lines */
-       void SendXLines(TreeServer* Current);
-
-       /** Send channel modes and topics */
-       void SendChannelModes(TreeServer* Current);
+       void SendXLines();
 
-       /** send all users and their oper state/modes */
-       void SendUsers(TreeServer* Current);
+       /** Send all known information about a channel */
+       void SyncChannel(Channel* chan);
 
        /** 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
@@ -247,61 +246,11 @@ class TreeSocket : public BufferedSocket
 
        /** Send one or more complete lines down the socket
         */
-       void WriteLine(std::string line);
+       void WriteLine(const std::string& line);
 
        /** Handle ERROR command */
        void Error(parameterlist &params);
 
-       /** Remote AWAY */
-       bool Away(const std::string &prefix, parameterlist &params);
-
-       /** SAVE to resolve nick collisions without killing */
-       bool ForceNick(const std::string &prefix, parameterlist &params);
-
-       /** ENCAP command
-        */
-       void Encap(User* who, parameterlist &params);
-
-       /** OPERQUIT command
-        */
-       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);
-
-       /** VERSION
-        */
-       bool ServerVersion(const std::string &prefix, parameterlist &params);
-
-       /** ADDLINE
-        */
-       bool AddLine(const std::string &prefix, parameterlist &params);
-
-       /** DELLINE
-        */
-       bool DelLine(const std::string &prefix, parameterlist &params);
-
-       /** WHOIS
-        */
-       bool Whois(const std::string &prefix, parameterlist &params);
-
-       /** PUSH
-        */
-       bool Push(const std::string &prefix, parameterlist &params);
-
-       /** PING
-        */
-       bool LocalPing(const std::string &prefix, parameterlist &params);
-
-       /** <- (remote) <- SERVER
-        */
-       bool RemoteServer(const std::string &prefix, parameterlist &params);
-
        /** (local) -> SERVER
         */
        bool Outbound_Reply_Server(parameterlist &params);
@@ -320,33 +269,18 @@ 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();
+       void OnTimeout();
        /** Handle server quit on close
         */
-       virtual void Close();
-};
+       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;
-};
+       /** Returns true if this server was introduced to the rest of the network
+        */
+       bool Introduced();
 
-/* Used to validate the length values in CAPAB CAPABILITIES */
-struct cap_validation
-{
-       const char* reason;
-       const char* key;
-       size_t size;
+       /** Fixes messages coming from old servers so the new command handlers understand them
+        */
+       bool PreProcessOldProtocolMessage(User*& who, std::string& cmd, std::vector<std::string>& params);
 };
-
-#endif
-