1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __TREESOCKET_H__
15 #define __TREESOCKET_H__
17 #include "configreader.h"
21 #include "commands/cmd_whois.h"
22 #include "commands/cmd_stats.h"
27 #include "transport.h"
29 #include "m_spanningtree/utils.h"
32 * The server list in InspIRCd is maintained as two structures
33 * which hold the data in different ways. Most of the time, we
34 * want to very quicky obtain three pieces of information:
36 * (1) The information on a server
37 * (2) The information on the server we must send data through
38 * to actually REACH the server we're after
39 * (3) Potentially, the child/parent objects of this server
41 * The InspIRCd spanning protocol provides easy access to these
42 * by storing the data firstly in a recursive structure, where
43 * each item references its parent item, and a dynamic list
44 * of child items, and another structure which stores the items
45 * hashed, linearly. This means that if we want to find a server
46 * by name quickly, we can look it up in the hash, avoiding
47 * any O(n) lookups. If however, during a split or sync, we want
48 * to apply an operation to a server, and any of its child objects
49 * we can resort to recursion to walk the tree structure.
50 * Any socket can have one of five states at any one time.
51 * The LISTENER state indicates a socket which is listening
52 * for connections. It cannot receive data itself, only incoming
54 * The CONNECTING state indicates an outbound socket which is
55 * waiting to be writeable.
56 * The WAIT_AUTH_1 state indicates the socket is outbound and
57 * has successfully connected, but has not yet sent and received
59 * The WAIT_AUTH_2 state indicates that the socket is inbound
60 * (allocated by a LISTENER) but has not yet sent and received
62 * The CONNECTED state represents a fully authorized, fully
65 enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
67 /** Every SERVER connection inbound or outbound is represented by
68 * an object of type TreeSocket.
69 * TreeSockets, being inherited from InspSocket, can be tied into
70 * the core socket engine, and we cn therefore receive activity events
71 * for them, just like activex objects on speed. (yes really, that
72 * is a technical term!) Each of these which relates to a locally
73 * connected server is assocated with it, by hooking it onto a
74 * TreeSocket class using its constructor. In this way, we can
75 * maintain a list of servers, some of which are directly connected,
76 * some of which are not.
78 class TreeSocket : public InspSocket
80 SpanningTreeUtilities* Utils; /* Utility class */
81 std::string myhost; /* Canonical hostname */
82 std::string in_buffer; /* Input buffer */
83 ServerState LinkState; /* Link state */
84 std::string InboundServerName; /* Server name sent to us by other side */
85 std::string InboundDescription; /* Server description (GECOS) sent to us by the other side */
86 std::string InboundSID; /* Server ID sent to us by the other side */
87 int num_lost_users; /* Users lost in split */
88 int num_lost_servers; /* Servers lost in split */
89 time_t NextPing; /* Time when we are due to ping this server */
90 bool LastPingWasGood; /* Responded to last ping we sent? */
91 bool bursting; /* True if not finished bursting yet */
92 unsigned int keylength; /* Is this still used? */
93 std::string ModuleList; /* Module list of other server from CAPAB */
94 std::map<std::string,std::string> CapKeys; /* CAPAB keys from other server */
95 Module* Hook; /* I/O hooking module that we're attached to for this socket */
96 std::string ourchallenge; /* Challenge sent for challenge/response */
97 std::string theirchallenge; /* Challenge recv for challenge/response */
98 std::string OutboundPass; /* Outbound password */
99 bool sentcapab; /* Have sent CAPAB already */
102 /** Because most of the I/O gubbins are encapsulated within
103 * InspSocket, we just call the superclass constructor for
104 * most of the action, and append a few of our own values
107 TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, Module* HookMod = NULL);
109 /** Because most of the I/O gubbins are encapsulated within
110 * InspSocket, we just call the superclass constructor for
111 * most of the action, and append a few of our own values
114 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);
116 /** When a listening socket gives us a new file descriptor,
117 * we must associate it with a socket without creating a new
118 * connection. This constructor is used for this purpose.
120 TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, int newfd, char* ip, Module* HookMod = NULL);
124 ServerState GetLinkState();
126 /** Get challenge set in our CAPAB for challenge/response
128 const std::string& GetOurChallenge();
130 /** Get challenge set in our CAPAB for challenge/response
132 void SetOurChallenge(const std::string &c);
134 /** Get challenge set in their CAPAB for challenge/response
136 const std::string& GetTheirChallenge();
138 /** Get challenge set in their CAPAB for challenge/response
140 void SetTheirChallenge(const std::string &c);
142 /** Compare two passwords based on authentication scheme
144 bool ComparePass(const std::string &ours, const std::string &theirs);
146 /** Return the module which we are hooking to for I/O encapsulation
154 /** Generate random string used for challenge-response auth
156 std::string RandString(unsigned int length);
158 /** Construct a password, optionally hashed with the other side's
161 std::string MakePass(const std::string &password, const std::string &challenge);
163 /** When an outbound connection finishes connecting, we receive
164 * this event, and must send our SERVER string to the other
165 * side. If the other side is happy, as outlined in the server
166 * to server docs on the inspircd.org site, the other side
167 * will then send back its own server string.
169 virtual bool OnConnected();
171 /** Handle socket error event
173 virtual void OnError(InspSocketError e);
175 /** Sends an error to the remote server, and displays it locally to show
178 void SendError(const std::string &errormessage);
180 /** Handle socket disconnect event
182 virtual int OnDisconnect();
184 /** Recursively send the server tree with distances as hops.
185 * This is used during network burst to inform the other server
186 * (and any of ITS servers too) of what servers we know about.
187 * If at any point any of these servers already exist on the other
188 * end, our connection may be terminated. The hopcounts given
189 * by this function are relative, this doesn't matter so long as
190 * they are all >1, as all the remote servers re-calculate them
191 * to be relative too, with themselves as hop 0.
193 void SendServers(TreeServer* Current, TreeServer* s, int hops);
195 /** Returns my capabilities as a string
197 std::string MyCapabilities();
199 /** Send my capabilities to the remote side
201 void SendCapabilities();
203 /* Check a comma seperated list for an item */
204 bool HasItem(const std::string &list, const std::string &item);
206 /* Isolate and return the elements that are different between two comma seperated lists */
207 std::string ListDifference(const std::string &one, const std::string &two);
209 bool Capab(const std::deque<std::string> ¶ms);
211 /** This function forces this server to quit, removing this server
212 * and any users on it (and servers and users below that, etc etc).
213 * It's very slow and pretty clunky, but luckily unless your network
214 * is having a REAL bad hair day, this function shouldnt be called
215 * too many times a month ;-)
217 void SquitServer(std::string &from, TreeServer* Current);
219 /** This is a wrapper function for SquitServer above, which
220 * does some validation first and passes on the SQUIT to all
221 * other remaining servers.
223 void Squit(TreeServer* Current, const std::string &reason);
225 /** FMODE command - server mode with timestamp checks */
226 bool ForceMode(const std::string &source, std::deque<std::string> ¶ms);
228 /** FTOPIC command */
229 bool ForceTopic(const std::string &source, std::deque<std::string> ¶ms);
231 /** FJOIN, similar to TS6 SJOIN, but not quite. */
232 bool ForceJoin(const std::string &source, std::deque<std::string> ¶ms);
235 bool ParseUID(const std::string &source, std::deque<std::string> ¶ms);
237 /** Send one or more FJOINs for a channel of users.
238 * If the length of a single line is more than 480-NICKMAX
239 * in length, it is split over multiple lines.
241 void SendFJoins(TreeServer* Current, chanrec* c);
243 /** Send G, Q, Z and E lines */
244 void SendXLines(TreeServer* Current);
246 /** Send channel modes and topics */
247 void SendChannelModes(TreeServer* Current);
249 /** send all users and their oper state/modes */
250 void SendUsers(TreeServer* Current);
252 /** This function is called when we want to send a netburst to a local
253 * server. There is a set order we must do this, because for example
254 * users require their servers to exist, and channels require their
255 * users to exist. You get the idea.
257 void DoBurst(TreeServer* s);
259 /** This function is called when we receive data from a remote
260 * server. We buffer the data in a std::string (it doesnt stay
261 * there for long), reading using InspSocket::Read() which can
262 * read up to 16 kilobytes in one operation.
264 * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
265 * THE SOCKET OBJECT FOR US.
267 virtual bool OnDataReady();
269 /** Send one or more complete lines down the socket
271 int WriteLine(std::string line);
273 /** Handle ERROR command */
274 bool Error(std::deque<std::string> ¶ms);
276 /** remote MOTD. leet, huh? */
277 bool Motd(const std::string &prefix, std::deque<std::string> ¶ms);
279 /** remote ADMIN. leet, huh? */
280 bool Admin(const std::string &prefix, std::deque<std::string> ¶ms);
282 /** Remote MODULES */
283 bool Modules(const std::string &prefix, std::deque<std::string> ¶ms);
285 bool Stats(const std::string &prefix, std::deque<std::string> ¶ms);
287 /** Because the core won't let users or even SERVERS set +o,
288 * we use the OPERTYPE command to do this.
290 bool OperType(const std::string &prefix, std::deque<std::string> ¶ms);
292 /** Because Andy insists that services-compatible servers must
293 * implement SVSNICK and SVSJOIN, that's exactly what we do :p
295 bool ForceNick(const std::string &prefix, std::deque<std::string> ¶ms);
297 bool OperQuit(const std::string &prefix, std::deque<std::string> ¶ms);
301 bool ServiceJoin(const std::string &prefix, std::deque<std::string> ¶ms);
305 bool RemoteRehash(const std::string &prefix, std::deque<std::string> ¶ms);
309 bool RemoteKill(const std::string &prefix, std::deque<std::string> ¶ms);
313 bool LocalPong(const std::string &prefix, std::deque<std::string> ¶ms);
317 bool MetaData(const std::string &prefix, std::deque<std::string> ¶ms);
321 bool ServerVersion(const std::string &prefix, std::deque<std::string> ¶ms);
325 bool ChangeHost(const std::string &prefix, std::deque<std::string> ¶ms);
329 bool AddLine(const std::string &prefix, std::deque<std::string> ¶ms);
333 bool ChangeName(const std::string &prefix, std::deque<std::string> ¶ms);
337 bool Whois(const std::string &prefix, std::deque<std::string> ¶ms);
341 bool Push(const std::string &prefix, std::deque<std::string> ¶ms);
345 bool HandleSetTime(const std::string &prefix, std::deque<std::string> ¶ms);
349 bool Time(const std::string &prefix, std::deque<std::string> ¶ms);
353 bool LocalPing(const std::string &prefix, std::deque<std::string> ¶ms);
355 /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
356 * This does not update the timestamp of the target channel, this must be done seperately.
358 bool RemoveStatus(const std::string &prefix, std::deque<std::string> ¶ms);
360 /** <- (remote) <- SERVER
362 bool RemoteServer(const std::string &prefix, std::deque<std::string> ¶ms);
364 /** (local) -> SERVER
366 bool Outbound_Reply_Server(std::deque<std::string> ¶ms);
368 /** (local) <- SERVER
370 bool Inbound_Server(std::deque<std::string> ¶ms);
374 void Split(const std::string &line, std::deque<std::string> &n);
376 /** Process complete line from buffer
378 bool ProcessLine(std::string &line);
380 /** Get this server's name
382 virtual std::string GetName();
384 /** Handle socket timeout from connect()
386 virtual void OnTimeout();
388 /** Handle socket close event
390 virtual void OnClose();
392 /** Handle incoming connection event
394 virtual int OnIncomingConnection(int newsock, char* ip);
397 /* Used to validate the value lengths of multiple parameters for a command */
398 struct cmd_validation
405 /* Used to validate the length values in CAPAB CAPABILITIES */
406 struct cap_validation