]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/treesocket.h
Make classbase and refcountbase uncopyable; expand comments on their indended uses
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treesocket.h
index 2fd18b35a6c270b10563a81524fff6c8e1e5e7ea..b5f97c30f55b49ea84737a7ec75ae466392ed2bc 100644 (file)
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
 #ifndef __TREESOCKET_H__
 #define __TREESOCKET_H__
 
-#include "configreader.h"
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "commands/cmd_whois.h"
-#include "commands/cmd_stats.h"
 #include "socket.h"
 #include "inspircd.h"
-#include "wildcard.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
  * to apply an operation to a server, and any of its child objects
  * we can resort to recursion to walk the tree structure.
  * Any socket can have one of five states at any one time.
- * The LISTENER state indicates a socket which is listening
- * for connections. It cannot receive data itself, only incoming
- * sockets.
- * The CONNECTING state indicates an outbound socket which is
- * waiting to be writeable.
- * The WAIT_AUTH_1 state indicates the socket is outbound and
- * has successfully connected, but has not yet sent and received
- * SERVER strings.
- * The WAIT_AUTH_2 state indicates that the socket is inbound
- * (allocated by a LISTENER) but has not yet sent and received
- * SERVER strings.
- * The CONNECTED state represents a fully authorized, fully
- * connected server.
+ *
+ * CONNECTING: indicates an outbound socket which is
+ *                                                     waiting to be writeable.
+ * WAIT_AUTH_1:        indicates the socket is outbound and
+ *                                                     has successfully connected, but has not
+ *                                                     yet sent and received SERVER strings.
+ * 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 server.
  */
-enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
+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 InspSocket, can be tied into
+ * 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
@@ -75,47 +65,45 @@ enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
  * maintain a list of servers, some of which are directly connected,
  * some of which are not.
  */
-class TreeSocket : public InspSocket
+class TreeSocket : public BufferedSocket
 {
        SpanningTreeUtilities* Utils;           /* Utility class */
        std::string myhost;                     /* Canonical hostname */
-       std::string in_buffer;                  /* Input buffer */
        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? */
-       bool bursting;                          /* True if not finished bursting yet */
-       unsigned int keylength;                 /* Is this still used? */
-       std::string ModuleList;                 /* Module list of other server from CAPAB */
+       std::string IP;
+       std::string ModuleList;                 /* Required module list of other server from CAPAB */
+       std::string OptModuleList;              /* Optional 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 */
+       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 */
+       int proto_version;                      /* Remote protocol version */
  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
-        * InspSocket, 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, bool listening, unsigned long maxtime, Module* HookMod = NULL);
-
-       /** Because most of the I/O gubbins are encapsulated within
-        * InspSocket, we just call the superclass constructor for
+        * 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, bool listening, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Module* HookMod = NULL);
+       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);
 
        /** 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, ListenSocketBase* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 
        /** Get link state
         */
@@ -137,10 +125,15 @@ class TreeSocket : public InspSocket
         */
        void SetTheirChallenge(const std::string &c);
 
-       /** Return the module which we are hooking to for I/O encapsulation
+       /** Compare two passwords based on authentication scheme
         */
-       Module* GetHook();
+       bool ComparePass(const Link& link, const std::string &theirs);
 
+       /** Clean up information used only during server negotiation
+        */
+       void CleanNegotiationInfo();
+
+       CullResult cull();
        /** Destructor
         */
        ~TreeSocket();
@@ -149,21 +142,27 @@ class TreeSocket : public InspSocket
         */
        std::string RandString(unsigned int length);
 
+       /** Construct a password, optionally hashed with the other side's
+        * challenge string
+        */
+       std::string MakePass(const std::string &password, const std::string &challenge);
+
        /** When an outbound connection finishes connecting, we receive
         * this event, and must send our SERVER string to the other
         * side. If the other side is happy, as outlined in the server
         * 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
         */
-       virtual void OnError(InspSocketError e);
+       virtual void OnError(BufferedSocketError e);
 
-       /** Handle socket disconnect event
+       /** Sends an error to the remote server, and displays it locally to show
+        * that it was sent.
         */
-       virtual int OnDisconnect();
+       void SendError(const std::string &errormessage);
 
        /** Recursively send the server tree with distances as hops.
         * This is used during network burst to inform the other server
@@ -176,13 +175,17 @@ class TreeSocket : public InspSocket
         */
        void SendServers(TreeServer* Current, TreeServer* s, int hops);
 
-       /** 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();
+       void SendCapabilities(int phase);
+
+       /** 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);
@@ -190,7 +193,7 @@ class TreeSocket : public InspSocket
        /* Isolate and return the elements that are different between two comma seperated lists */
        std::string ListDifference(const std::string &one, const std::string &two);
 
-       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).
@@ -207,22 +210,25 @@ class TreeSocket : public InspSocket
        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);
+       bool ForceMode(const std::string &source, parameterlist &params);
 
        /** FTOPIC command */
-       bool ForceTopic(const std::string &source, std::deque<std::string> &params);
+       bool ForceTopic(const std::string &source, parameterlist &params);
 
        /** FJOIN, similar to TS6 SJOIN, but not quite. */
-       bool ForceJoin(const std::string &source, std::deque<std::string> &params);
+       bool ForceJoin(const std::string &source, parameterlist &params);
 
-       /** NICK command */
-       bool IntroduceClient(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, 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.
         */
-       void SendFJoins(TreeServer* Current, chanrec* c);
+       void SendFJoins(TreeServer* Current, Channel* c);
 
        /** Send G, Q, Z and E lines */
        void SendXLines(TreeServer* Current);
@@ -241,131 +247,134 @@ class TreeSocket : public InspSocket
        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 InspSocket::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
         */
-       int WriteLine(std::string line);
+       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);
+       bool Error(parameterlist &params);
 
-       /** remote ADMIN. leet, huh? */
-       bool Admin(const std::string &prefix, std::deque<std::string> &params);
+       /** remote MOTD. */
+       bool Motd(const std::string &prefix, parameterlist &params);
 
-       /** Remote MODULES */
-       bool Modules(const std::string &prefix, std::deque<std::string> &params);
+       /** remote ADMIN. */
+       bool Admin(const std::string &prefix, parameterlist &params);
 
-       bool Stats(const std::string &prefix, std::deque<std::string> &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, std::deque<std::string> &params);
+       bool OperType(const std::string &prefix, 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 ForceNick(const std::string &prefix, std::deque<std::string> &params);
+       bool SVSNick(const std::string &prefix, parameterlist &params);
 
-       bool OperQuit(const std::string &prefix, std::deque<std::string> &params);
+       /** SAVE to resolve nick collisions without killing */
+       bool ForceNick(const std::string &prefix, parameterlist &params);
 
-       /** Remote SQUIT (RSQUIT). Routing works similar to SVSNICK: Route it to the server that the target is connected to locally,
-        * then let that server do the dirty work (squit it!). Example:
-        * A -> B -> C -> D: oper on A squits D, A routes to B, B routes to C, C notices D connected locally, kills it. -- w00t
+       /** ENCAP command
         */
-       bool RemoteSquit(const std::string &prefix, std::deque<std::string> &params);
+       bool Encap(const std::string &prefix, parameterlist &params);
+
+       /** OPERQUIT command
+        */
+       bool OperQuit(const std::string &prefix, parameterlist &params);
 
        /** SVSJOIN
         */
-       bool ServiceJoin(const std::string &prefix, std::deque<std::string> &params);
+       bool ServiceJoin(const std::string &prefix, parameterlist &params);
 
-       /** REHASH
+       /** SVSPART
         */
-       bool RemoteRehash(const std::string &prefix, std::deque<std::string> &params);
+       bool ServicePart(const std::string &prefix, parameterlist &params);
 
        /** KILL
         */
-       bool RemoteKill(const std::string &prefix, std::deque<std::string> &params);
+       bool RemoteKill(const std::string &prefix, parameterlist &params);
 
        /** PONG
         */
-       bool LocalPong(const std::string &prefix, std::deque<std::string> &params);
+       bool LocalPong(const std::string &prefix, parameterlist &params);
 
        /** METADATA
         */
-       bool MetaData(const std::string &prefix, std::deque<std::string> &params);
+       bool MetaData(const std::string &prefix, parameterlist &params);
 
        /** VERSION
         */
-       bool ServerVersion(const std::string &prefix, std::deque<std::string> &params);
+       bool ServerVersion(const std::string &prefix, parameterlist &params);
 
        /** CHGHOST
         */
-       bool ChangeHost(const std::string &prefix, std::deque<std::string> &params);
+       bool ChangeHost(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, parameterlist &params);
 
        /** CHGNAME
         */
-       bool ChangeName(const std::string &prefix, std::deque<std::string> &params);
+       bool ChangeName(const std::string &prefix, parameterlist &params);
+
+       /** FIDENT */
+       bool ChangeIdent(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);
-
-       /** SETTIME
-        */
-       bool HandleSetTime(const std::string &prefix, std::deque<std::string> &params);
+       bool Push(const std::string &prefix, parameterlist &params);
 
        /** TIME
         */
-       bool Time(const std::string &prefix, std::deque<std::string> &params);
+       bool Time(const std::string &prefix, parameterlist &params);
 
        /** PING
         */
-       bool LocalPing(const std::string &prefix, std::deque<std::string> &params);
+       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, std::deque<std::string> &params);
+       bool RemoveStatus(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);
+
+       void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
 
        /** Get this server's name
         */
@@ -374,14 +383,25 @@ class TreeSocket : public InspSocket
        /** Handle socket timeout from connect()
         */
        virtual void OnTimeout();
-
-       /** Handle socket close event
+       /** Handle server quit on close
         */
-       virtual void OnClose();
+       virtual void Close();
+};
 
-       /** Handle incoming connection event
-        */
-       virtual int OnIncomingConnection(int newsock, char* ip);
+/* 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