]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/treesocket.h
Merge insp20
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treesocket.h
index 510052f3152082eee4c1b71f036fe39e7e0535cb..0a519041cac199e8ce3289a10159a3b26476ed8e 100644 (file)
@@ -1,27 +1,30 @@
-/*       +------------------------------------+
- *       | 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-2009 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/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 "commands/cmd_whois.h"
-#include "commands/cmd_stats.h"
-#include "socket.h"
+#pragma once
+
 #include "inspircd.h"
-#include "xline.h"
-#include "transport.h"
 
-#include "m_spanningtree/utils.h"
+#include "utils.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.
+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;
+       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 */
+       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. 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 in_buffer;                  /* Input buffer */
+       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 */
-       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? */
-       unsigned int keylength;                 /* Is this still used? */
-       std::string ModuleList;                 /* Module list of other server from CAPAB */
-       std::map<std::string,std::string> CapKeys;      /* CAPAB keys from other server */
-       Module* Hook;                           /* I/O hooking module that we're attached to for this socket */
-       std::string ourchallenge;               /* Challenge sent for challenge/response */
-       std::string theirchallenge;             /* Challenge recv for challenge/response */
-       std::string OutboundPass;               /* Outbound password */
-       bool sentcapab;                         /* Have sent CAPAB already */
+       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);
+
  public:
+       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, InspIRCd* SI, std::string host, int port, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, 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, InspIRCd* SI, int newfd, char* ip, Module* HookMod = NULL);
+       TreeSocket(SpanningTreeUtilities* Util, int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 
        /** Get link state
         */
@@ -126,20 +141,17 @@ class TreeSocket : public BufferedSocket
 
        /** Compare two passwords based on authentication scheme
         */
-       bool ComparePass(const std::string &ours, const std::string &theirs);
+       bool ComparePass(const Link& link, const std::string &theirs);
 
-       /** Return the module which we are hooking to for I/O encapsulation
+       /** Clean up information used only during server negotiation
         */
-       Module* GetHook();
+       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
         */
@@ -151,7 +163,7 @@ class TreeSocket : public BufferedSocket
         * to server docs on the inspircd.org site, the other side
         * will then send back its own server string.
         */
-       virtual bool OnConnected();
+       virtual void OnConnected();
 
        /** Handle socket error event
         */
@@ -162,36 +174,26 @@ class TreeSocket : public BufferedSocket
         */
        void SendError(const std::string &errormessage);
 
-       /** Handle socket disconnect event
-        */
-       virtual int OnDisconnect();
-
        /** 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 my capabilities as a string
+       /** Returns module list as a string, filtered by filter
+        * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
         */
-       std::string MyCapabilities();
+       std::string MyModules(int filter);
 
        /** Send my capabilities to the remote side
         */
-       void SendCapabilities();
-
-       /* Check a comma seperated list for an item */
-       bool HasItem(const std::string &list, const std::string &item);
+       void SendCapabilities(int phase);
 
-       /* 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 std::deque<std::string> &params);
+       bool Capab(const parameterlist &params);
 
        /** This function forces this server to quit, removing this server
         * and any users on it (and servers and users below that, etc etc).
@@ -199,7 +201,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
@@ -207,35 +209,23 @@ 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, std::deque<std::string> &params);
-
-       /** FTOPIC command */
-       bool ForceTopic(const std::string &source, std::deque<std::string> &params);
-
-       /** FJOIN, similar to TS6 SJOIN, but not quite. */
-       bool ForceJoin(const std::string &source, std::deque<std::string> &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, std::deque<std::string> &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.
         */
-       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
@@ -245,164 +235,93 @@ class TreeSocket : public BufferedSocket
        void DoBurst(TreeServer* s);
 
        /** This function is called when we receive data from a remote
-        * server. We buffer the data in a std::string (it doesnt stay
-        * there for long), reading using BufferedSocket::Read() which can
-        * read up to 16 kilobytes in one operation.
-        *
-        * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
-        * THE SOCKET OBJECT FOR US.
+        * server.
         */
-       virtual bool OnDataReady();
+       void OnDataReady();
 
        /** Send one or more complete lines down the socket
         */
        void WriteLine(std::string line);
 
        /** Handle ERROR command */
-       bool Error(std::deque<std::string> &params);
-
-       /** remote MOTD. leet, huh? */
-       bool Motd(const std::string &prefix, std::deque<std::string> &params);
-
-       /** remote ADMIN. leet, huh? */
-       bool Admin(const std::string &prefix, std::deque<std::string> &params);
+       void Error(parameterlist &params);
 
-       /** Remote MODULES */
-       bool Modules(const std::string &prefix, std::deque<std::string> &params);
+       /** Remote AWAY */
+       bool Away(const std::string &prefix, parameterlist &params);
 
-       bool Stats(const std::string &prefix, std::deque<std::string> &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, std::deque<std::string> &params);
-
-       /** Because Andy insists that services-compatible servers must
-        * implement SVSNICK and SVSJOIN, that's exactly what we do :p
-        */
-       bool ForceNick(const std::string &prefix, std::deque<std::string> &params);
-
-       /** PRIVMSG or NOTICE with server origin ONLY
-        */
-       bool ServerMessage(const std::string &messagetype, const std::string &prefix, std::deque<std::string> &params, const std::string &sourceserv);
+       /** SAVE to resolve nick collisions without killing */
+       bool ForceNick(const std::string &prefix, parameterlist &params);
 
        /** ENCAP command
         */
-       bool Encap(const std::string &prefix, std::deque<std::string> &params);
+       void Encap(User* who, parameterlist &params);
 
        /** OPERQUIT command
         */
-       bool OperQuit(const std::string &prefix, std::deque<std::string> &params);
-
-       /** SVSJOIN
-        */
-       bool ServiceJoin(const std::string &prefix, std::deque<std::string> &params);
-
-       /** SVSPART
-        */
-       bool ServicePart(const std::string &prefix, std::deque<std::string> &params);
-
-       /** KILL
-        */
-       bool RemoteKill(const std::string &prefix, std::deque<std::string> &params);
+       bool OperQuit(const std::string &prefix, parameterlist &params);
 
        /** PONG
         */
-       bool LocalPong(const std::string &prefix, std::deque<std::string> &params);
-
-       /** METADATA
-        */
-       bool MetaData(const std::string &prefix, std::deque<std::string> &params);
+       bool LocalPong(const std::string &prefix, parameterlist &params);
 
        /** VERSION
         */
-       bool ServerVersion(const std::string &prefix, std::deque<std::string> &params);
-
-       /** CHGHOST
-        */
-       bool ChangeHost(const std::string &prefix, std::deque<std::string> &params);
+       bool ServerVersion(const std::string &prefix, parameterlist &params);
 
        /** ADDLINE
         */
-       bool AddLine(const std::string &prefix, std::deque<std::string> &params);
+       bool AddLine(const std::string &prefix, parameterlist &params);
 
        /** DELLINE
         */
-       bool DelLine(const std::string &prefix, std::deque<std::string> &params);
-
-       /** CHGNAME
-        */
-       bool ChangeName(const std::string &prefix, std::deque<std::string> &params);
+       bool DelLine(const std::string &prefix, parameterlist &params);
 
        /** WHOIS
         */
-       bool Whois(const std::string &prefix, std::deque<std::string> &params);
+       bool Whois(const std::string &prefix, parameterlist &params);
 
        /** PUSH
         */
-       bool Push(const std::string &prefix, std::deque<std::string> &params);
-
-       /** TIME
-        */
-       bool Time(const std::string &prefix, std::deque<std::string> &params);
+       bool Push(const std::string &prefix, parameterlist &params);
 
        /** PING
         */
-       bool LocalPing(const std::string &prefix, std::deque<std::string> &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, std::deque<std::string> &params);
+       bool LocalPing(const std::string &prefix, parameterlist &params);
 
        /** <- (remote) <- SERVER
         */
-       bool RemoteServer(const std::string &prefix, std::deque<std::string> &params);
+       bool RemoteServer(const std::string &prefix, parameterlist &params);
 
        /** (local) -> SERVER
         */
-       bool Outbound_Reply_Server(std::deque<std::string> &params);
+       bool Outbound_Reply_Server(parameterlist &params);
 
        /** (local) <- SERVER
         */
-       bool Inbound_Server(std::deque<std::string> &params);
+       bool Inbound_Server(parameterlist &params);
 
-       /** Handle netsplit
+       /** Handle IRC line split
         */
-       void Split(const std::string &line, std::deque<std::string> &n);
+       void Split(const std::string &line, std::string& prefix, std::string& command, parameterlist &params);
 
        /** Process complete line from buffer
         */
-       bool ProcessLine(std::string &line);
+       void ProcessLine(std::string &line);
 
-       /** Get this server's name
-        */
-       virtual std::string GetName();
+       void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
 
        /** Handle socket timeout from connect()
         */
        virtual void OnTimeout();
-
-       /** Handle socket close event
+       /** Handle server quit on close
         */
-       virtual void OnClose();
-};
+       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;
-};
+       /** 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
-