]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/modules/m_spanningtree.cpp
Added RemoveSocket as a test fix for merwins bug
[user/henk/code/inspircd.git] / src / modules / m_spanningtree.cpp
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  Inspire is copyright (C) 2002-2005 ChatSpike-Dev.
6  *                       E-mail:
7  *                <brain@chatspike.net>
8  *                <Craig@chatspike.net>
9  *     
10  * Written by Craig Edwards, Craig McLure, and others.
11  * This program is free but copyrighted software; see
12  *            the file COPYING for details.
13  *
14  * ---------------------------------------------------
15  */
16
17 /* $ModDesc: Povides a spanning tree server link protocol */
18
19 using namespace std;
20
21 #include <stdio.h>
22 #include <vector>
23 #include <deque>
24 #include "globals.h"
25 #include "inspircd_config.h"
26 #ifdef GCC3
27 #include <ext/hash_map>
28 #else
29 #include <hash_map>
30 #endif
31 #include "users.h"
32 #include "channels.h"
33 #include "modules.h"
34 #include "commands.h"
35 #include "socket.h"
36 #include "helperfuncs.h"
37 #include "inspircd.h"
38 #include "inspstring.h"
39 #include "hashcomp.h"
40 #include "message.h"
41 #include "xline.h"
42 #include "typedefs.h"
43 #include "cull_list.h"
44 #include "aes.h"
45
46 #ifdef GCC3
47 #define nspace __gnu_cxx
48 #else
49 #define nspace std
50 #endif
51
52 /*
53  * The server list in InspIRCd is maintained as two structures
54  * which hold the data in different ways. Most of the time, we
55  * want to very quicky obtain three pieces of information:
56  *
57  * (1) The information on a server
58  * (2) The information on the server we must send data through
59  *     to actually REACH the server we're after
60  * (3) Potentially, the child/parent objects of this server
61  *
62  * The InspIRCd spanning protocol provides easy access to these
63  * by storing the data firstly in a recursive structure, where
64  * each item references its parent item, and a dynamic list
65  * of child items, and another structure which stores the items
66  * hashed, linearly. This means that if we want to find a server
67  * by name quickly, we can look it up in the hash, avoiding
68  * any O(n) lookups. If however, during a split or sync, we want
69  * to apply an operation to a server, and any of its child objects
70  * we can resort to recursion to walk the tree structure.
71  */
72
73 class ModuleSpanningTree;
74 static ModuleSpanningTree* TreeProtocolModule;
75
76 extern ServerConfig* Config;
77
78 extern std::vector<Module*> modules;
79 extern std::vector<ircd_module*> factory;
80 extern int MODCOUNT;
81
82 /* Any socket can have one of five states at any one time.
83  * The LISTENER state indicates a socket which is listening
84  * for connections. It cannot receive data itself, only incoming
85  * sockets.
86  * The CONNECTING state indicates an outbound socket which is
87  * waiting to be writeable.
88  * The WAIT_AUTH_1 state indicates the socket is outbound and
89  * has successfully connected, but has not yet sent and received
90  * SERVER strings.
91  * The WAIT_AUTH_2 state indicates that the socket is inbound
92  * (allocated by a LISTENER) but has not yet sent and received
93  * SERVER strings.
94  * The CONNECTED state represents a fully authorized, fully
95  * connected server.
96  */
97 enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
98
99 /* We need to import these from the core for use in netbursts */
100 extern user_hash clientlist;
101 extern chan_hash chanlist;
102
103 /* Foward declarations */
104 class TreeServer;
105 class TreeSocket;
106
107 /* This variable represents the root of the server tree
108  * (for all intents and purposes, it's us)
109  */
110 TreeServer *TreeRoot;
111
112 Server* Srv;
113
114 /* This hash_map holds the hash equivalent of the server
115  * tree, used for rapid linear lookups.
116  */
117 typedef nspace::hash_map<std::string, TreeServer*> server_hash;
118 server_hash serverlist;
119
120 /* More forward declarations */
121 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> &params, std::string target);
122 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> &params, std::string omit);
123 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> &params);
124 bool DoOneToAllButSenderRaw(std::string data, std::string omit, std::string prefix, std::string command, std::deque<std::string> &params);
125 void ReadConfiguration(bool rebind);
126
127 /* Imported from xline.cpp for use during netburst */
128 extern std::vector<KLine> klines;
129 extern std::vector<GLine> glines;
130 extern std::vector<ZLine> zlines;
131 extern std::vector<QLine> qlines;
132 extern std::vector<ELine> elines;
133 extern std::vector<KLine> pklines;
134 extern std::vector<GLine> pglines;
135 extern std::vector<ZLine> pzlines;
136 extern std::vector<QLine> pqlines;
137 extern std::vector<ELine> pelines;
138
139 /* Each server in the tree is represented by one class of
140  * type TreeServer. A locally connected TreeServer can
141  * have a class of type TreeSocket associated with it, for
142  * remote servers, the TreeSocket entry will be NULL.
143  * Each server also maintains a pointer to its parent
144  * (NULL if this server is ours, at the top of the tree)
145  * and a pointer to its "Route" (see the comments in the
146  * constructors below), and also a dynamic list of pointers
147  * to its children which can be iterated recursively
148  * if required. Creating or deleting objects of type
149  * TreeServer automatically maintains the hash_map of
150  * TreeServer items, deleting and inserting them as they
151  * are created and destroyed.
152  */
153
154 class TreeServer
155 {
156         TreeServer* Parent;                     /* Parent entry */
157         TreeServer* Route;                      /* Route entry */
158         std::vector<TreeServer*> Children;      /* List of child objects */
159         std::string ServerName;                 /* Server's name */
160         std::string ServerDesc;                 /* Server's description */
161         std::string VersionString;              /* Version string or empty string */
162         int UserCount;                          /* Not used in this version */
163         int OperCount;                          /* Not used in this version */
164         TreeSocket* Socket;                     /* For directly connected servers this points at the socket object */
165         time_t NextPing;                        /* After this time, the server should be PINGed*/
166         bool LastPingWasGood;                   /* True if the server responded to the last PING with a PONG */
167         
168  public:
169
170         /* We don't use this constructor. Its a dummy, and won't cause any insertion
171          * of the TreeServer into the hash_map. See below for the two we DO use.
172          */
173         TreeServer()
174         {
175                 Parent = NULL;
176                 ServerName = "";
177                 ServerDesc = "";
178                 VersionString = "";
179                 UserCount = OperCount = 0;
180                 VersionString = Srv->GetVersion();
181         }
182
183         /* We use this constructor only to create the 'root' item, TreeRoot, which
184          * represents our own server. Therefore, it has no route, no parent, and
185          * no socket associated with it. Its version string is our own local version.
186          */
187         TreeServer(std::string Name, std::string Desc) : ServerName(Name), ServerDesc(Desc)
188         {
189                 Parent = NULL;
190                 VersionString = "";
191                 UserCount = OperCount = 0;
192                 VersionString = Srv->GetVersion();
193                 Route = NULL;
194                 Socket = NULL; /* Fix by brain */
195                 AddHashEntry();
196         }
197
198         /* When we create a new server, we call this constructor to initialize it.
199          * This constructor initializes the server's Route and Parent, and sets up
200          * its ping counters so that it will be pinged one minute from now.
201          */
202         TreeServer(std::string Name, std::string Desc, TreeServer* Above, TreeSocket* Sock) : Parent(Above), ServerName(Name), ServerDesc(Desc), Socket(Sock)
203         {
204                 VersionString = "";
205                 UserCount = OperCount = 0;
206                 this->SetNextPingTime(time(NULL) + 120);
207                 this->SetPingFlag();
208
209                 /* find the 'route' for this server (e.g. the one directly connected
210                  * to the local server, which we can use to reach it)
211                  *
212                  * In the following example, consider we have just added a TreeServer
213                  * class for server G on our network, of which we are server A.
214                  * To route traffic to G (marked with a *) we must send the data to
215                  * B (marked with a +) so this algorithm initializes the 'Route'
216                  * value to point at whichever server traffic must be routed through
217                  * to get here. If we were to try this algorithm with server B,
218                  * the Route pointer would point at its own object ('this').
219                  *
220                  *              A
221                  *             / \
222                  *          + B   C
223                  *           / \   \
224                  *          D   E   F
225                  *         /         \
226                  *      * G           H
227                  *
228                  * We only run this algorithm when a server is created, as
229                  * the routes remain constant while ever the server exists, and
230                  * do not need to be re-calculated.
231                  */
232
233                 Route = Above;
234                 if (Route == TreeRoot)
235                 {
236                         Route = this;
237                 }
238                 else
239                 {
240                         while (this->Route->GetParent() != TreeRoot)
241                         {
242                                 this->Route = Route->GetParent();
243                         }
244                 }
245
246                 /* Because recursive code is slow and takes a lot of resources,
247                  * we store two representations of the server tree. The first
248                  * is a recursive structure where each server references its
249                  * children and its parent, which is used for netbursts and
250                  * netsplits to dump the whole dataset to the other server,
251                  * and the second is used for very fast lookups when routing
252                  * messages and is instead a hash_map, where each item can
253                  * be referenced by its server name. The AddHashEntry()
254                  * call below automatically inserts each TreeServer class
255                  * into the hash_map as it is created. There is a similar
256                  * maintainance call in the destructor to tidy up deleted
257                  * servers.
258                  */
259
260                 this->AddHashEntry();
261         }
262
263         /* This method is used to add the structure to the
264          * hash_map for linear searches. It is only called
265          * by the constructors.
266          */
267         void AddHashEntry()
268         {
269                 server_hash::iterator iter;
270                 iter = serverlist.find(this->ServerName);
271                 if (iter == serverlist.end())
272                         serverlist[this->ServerName] = this;
273         }
274
275         /* This method removes the reference to this object
276          * from the hash_map which is used for linear searches.
277          * It is only called by the default destructor.
278          */
279         void DelHashEntry()
280         {
281                 server_hash::iterator iter;
282                 iter = serverlist.find(this->ServerName);
283                 if (iter != serverlist.end())
284                         serverlist.erase(iter);
285         }
286
287         /* These accessors etc should be pretty self-
288          * explanitory.
289          */
290
291         TreeServer* GetRoute()
292         {
293                 return Route;
294         }
295
296         std::string GetName()
297         {
298                 return ServerName;
299         }
300
301         std::string GetDesc()
302         {
303                 return ServerDesc;
304         }
305
306         std::string GetVersion()
307         {
308                 return VersionString;
309         }
310
311         void SetNextPingTime(time_t t)
312         {
313                 this->NextPing = t;
314                 LastPingWasGood = false;
315         }
316
317         time_t NextPingTime()
318         {
319                 return NextPing;
320         }
321
322         bool AnsweredLastPing()
323         {
324                 return LastPingWasGood;
325         }
326
327         void SetPingFlag()
328         {
329                 LastPingWasGood = true;
330         }
331
332         int GetUserCount()
333         {
334                 return UserCount;
335         }
336
337         void AddUserCount()
338         {
339                 UserCount++;
340         }
341
342         void DelUserCount()
343         {
344                 UserCount--;
345         }
346
347         int GetOperCount()
348         {
349                 return OperCount;
350         }
351
352         TreeSocket* GetSocket()
353         {
354                 return Socket;
355         }
356
357         TreeServer* GetParent()
358         {
359                 return Parent;
360         }
361
362         void SetVersion(std::string Version)
363         {
364                 VersionString = Version;
365         }
366
367         unsigned int ChildCount()
368         {
369                 return Children.size();
370         }
371
372         TreeServer* GetChild(unsigned int n)
373         {
374                 if (n < Children.size())
375                 {
376                         /* Make sure they  cant request
377                          * an out-of-range object. After
378                          * all we know what these programmer
379                          * types are like *grin*.
380                          */
381                         return Children[n];
382                 }
383                 else
384                 {
385                         return NULL;
386                 }
387         }
388
389         void AddChild(TreeServer* Child)
390         {
391                 Children.push_back(Child);
392         }
393
394         bool DelChild(TreeServer* Child)
395         {
396                 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
397                 {
398                         if (*a == Child)
399                         {
400                                 Children.erase(a);
401                                 return true;
402                         }
403                 }
404                 return false;
405         }
406
407         /* Removes child nodes of this node, and of that node, etc etc.
408          * This is used during netsplits to automatically tidy up the
409          * server tree. It is slow, we don't use it for much else.
410          */
411         bool Tidy()
412         {
413                 bool stillchildren = true;
414                 while (stillchildren)
415                 {
416                         stillchildren = false;
417                         for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
418                         {
419                                 TreeServer* s = (TreeServer*)*a;
420                                 s->Tidy();
421                                 Children.erase(a);
422                                 delete s;
423                                 stillchildren = true;
424                                 break;
425                         }
426                 }
427                 return true;
428         }
429
430         ~TreeServer()
431         {
432                 /* We'd better tidy up after ourselves, eh? */
433                 this->DelHashEntry();
434         }
435 };
436
437 /* The Link class might as well be a struct,
438  * but this is C++ and we don't believe in structs (!).
439  * It holds the entire information of one <link>
440  * tag from the main config file. We maintain a list
441  * of them, and populate the list on rehash/load.
442  */
443
444 class Link
445 {
446  public:
447          std::string Name;
448          std::string IPAddr;
449          int Port;
450          std::string SendPass;
451          std::string RecvPass;
452          unsigned long AutoConnect;
453          time_t NextConnectTime;
454          std::string EncryptionKey;
455 };
456
457 /* The usual stuff for inspircd modules,
458  * plus the vector of Link classes which we
459  * use to store the <link> tags from the config
460  * file.
461  */
462 ConfigReader *Conf;
463 std::vector<Link> LinkBlocks;
464
465 /* Yay for fast searches!
466  * This is hundreds of times faster than recursion
467  * or even scanning a linked list, especially when
468  * there are more than a few servers to deal with.
469  * (read as: lots).
470  */
471 TreeServer* FindServer(std::string ServerName)
472 {
473         server_hash::iterator iter;
474         iter = serverlist.find(ServerName);
475         if (iter != serverlist.end())
476         {
477                 return iter->second;
478         }
479         else
480         {
481                 return NULL;
482         }
483 }
484
485 /* Returns the locally connected server we must route a
486  * message through to reach server 'ServerName'. This
487  * only applies to one-to-one and not one-to-many routing.
488  * See the comments for the constructor of TreeServer
489  * for more details.
490  */
491 TreeServer* BestRouteTo(std::string ServerName)
492 {
493         if (ServerName.c_str() == TreeRoot->GetName())
494                 return NULL;
495         TreeServer* Found = FindServer(ServerName);
496         if (Found)
497         {
498                 return Found->GetRoute();
499         }
500         else
501         {
502                 return NULL;
503         }
504 }
505
506 /* Find the first server matching a given glob mask.
507  * Theres no find-using-glob method of hash_map [awwww :-(]
508  * so instead, we iterate over the list using an iterator
509  * and match each one until we get a hit. Yes its slow,
510  * deal with it.
511  */
512 TreeServer* FindServerMask(std::string ServerName)
513 {
514         for (server_hash::iterator i = serverlist.begin(); i != serverlist.end(); i++)
515         {
516                 if (Srv->MatchText(i->first,ServerName))
517                         return i->second;
518         }
519         return NULL;
520 }
521
522 /* A convenient wrapper that returns true if a server exists */
523 bool IsServer(std::string ServerName)
524 {
525         return (FindServer(ServerName) != NULL);
526 }
527
528 /* Every SERVER connection inbound or outbound is represented by
529  * an object of type TreeSocket.
530  * TreeSockets, being inherited from InspSocket, can be tied into
531  * the core socket engine, and we cn therefore receive activity events
532  * for them, just like activex objects on speed. (yes really, that
533  * is a technical term!) Each of these which relates to a locally
534  * connected server is assocated with it, by hooking it onto a
535  * TreeSocket class using its constructor. In this way, we can
536  * maintain a list of servers, some of which are directly connected,
537  * some of which are not.
538  */
539
540 class TreeSocket : public InspSocket
541 {
542         std::string myhost;
543         std::string in_buffer;
544         ServerState LinkState;
545         std::string InboundServerName;
546         std::string InboundDescription;
547         int num_lost_users;
548         int num_lost_servers;
549         time_t NextPing;
550         bool LastPingWasGood;
551         bool bursting;
552         AES* ctx_in;
553         AES* ctx_out;
554         unsigned int keylength;
555         
556  public:
557
558         /* Because most of the I/O gubbins are encapsulated within
559          * InspSocket, we just call the superclass constructor for
560          * most of the action, and append a few of our own values
561          * to it.
562          */
563         TreeSocket(std::string host, int port, bool listening, unsigned long maxtime)
564                 : InspSocket(host, port, listening, maxtime)
565         {
566                 myhost = host;
567                 this->LinkState = LISTENER;
568                 this->ctx_in = NULL;
569                 this->ctx_out = NULL;
570         }
571
572         TreeSocket(std::string host, int port, bool listening, unsigned long maxtime, std::string ServerName)
573                 : InspSocket(host, port, listening, maxtime)
574         {
575                 myhost = ServerName;
576                 this->LinkState = CONNECTING;
577                 this->ctx_in = NULL;
578                 this->ctx_out = NULL;
579         }
580
581         /* When a listening socket gives us a new file descriptor,
582          * we must associate it with a socket without creating a new
583          * connection. This constructor is used for this purpose.
584          */
585         TreeSocket(int newfd, char* ip)
586                 : InspSocket(newfd, ip)
587         {
588                 this->LinkState = WAIT_AUTH_1;
589                 this->ctx_in = NULL;
590                 this->ctx_out = NULL;
591                 this->SendCapabilities();
592         }
593
594         ~TreeSocket()
595         {
596                 if (ctx_in)
597                         delete ctx_in;
598                 if (ctx_out)
599                         delete ctx_out;
600         }
601
602         void InitAES(std::string key,std::string SName)
603         {
604                 if (key == "")
605                         return;
606
607                 ctx_in = new AES();
608                 ctx_out = new AES();
609                 log(DEBUG,"Initialized AES key %s",key.c_str());
610                 // key must be 16, 24, 32 etc bytes (multiple of 8)
611                 keylength = key.length();
612                 if (!(keylength == 16 || keylength == 24 || keylength == 32))
613                 {
614                         WriteOpers("*** \2ERROR\2: Key length for encryptionkey is not 16, 24 or 32 bytes in length!");
615                         log(DEBUG,"Key length not 16, 24 or 32 characters!");
616                 }
617                 else
618                 {
619                         WriteOpers("*** \2AES\2: Initialized %d bit encryption to server %s",keylength*8,SName.c_str());
620                         ctx_in->MakeKey(key.c_str(), "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\
621                                 \0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", keylength, keylength);
622                         ctx_out->MakeKey(key.c_str(), "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\
623                                 \0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", keylength, keylength);
624                 }
625         }
626         
627         /* When an outbound connection finishes connecting, we receive
628          * this event, and must send our SERVER string to the other
629          * side. If the other side is happy, as outlined in the server
630          * to server docs on the inspircd.org site, the other side
631          * will then send back its own server string.
632          */
633         virtual bool OnConnected()
634         {
635                 if (this->LinkState == CONNECTING)
636                 {
637                         Srv->SendOpers("*** Connection to "+myhost+"["+this->GetIP()+"] established.");
638                         /* we do not need to change state here. */
639                         for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
640                         {
641                                 if (x->Name == this->myhost)
642                                 {
643                                         this->SendCapabilities();
644                                         if (x->EncryptionKey != "")
645                                         {
646                                                 if (!(x->EncryptionKey.length() == 16 || x->EncryptionKey.length() == 24 || x->EncryptionKey.length() == 32))
647                                                 {
648                                                         WriteOpers("\2WARNING\2: Your encryption key is NOT 16, 24 or 32 characters in length, encryption will \2NOT\2 be enabled.");
649                                                 }
650                                                 else
651                                                 {
652                                                         this->WriteLine("AES "+Srv->GetServerName());
653                                                         this->InitAES(x->EncryptionKey,x->Name);
654                                                 }
655                                         }
656                                         /* found who we're supposed to be connecting to, send the neccessary gubbins. */
657                                         this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
658                                         return true;
659                                 }
660                         }
661                 }
662                 /* There is a (remote) chance that between the /CONNECT and the connection
663                  * being accepted, some muppet has removed the <link> block and rehashed.
664                  * If that happens the connection hangs here until it's closed. Unlikely
665                  * and rather harmless.
666                  */
667                 return true;
668         }
669         
670         virtual void OnError(InspSocketError e)
671         {
672                 /* We don't handle this method, because all our
673                  * dirty work is done in OnClose() (see below)
674                  * which is still called on error conditions too.
675                  */
676         }
677
678         virtual int OnDisconnect()
679         {
680                 /* For the same reason as above, we don't
681                  * handle OnDisconnect()
682                  */
683                 return true;
684         }
685
686         /* Recursively send the server tree with distances as hops.
687          * This is used during network burst to inform the other server
688          * (and any of ITS servers too) of what servers we know about.
689          * If at any point any of these servers already exist on the other
690          * end, our connection may be terminated. The hopcounts given
691          * by this function are relative, this doesn't matter so long as
692          * they are all >1, as all the remote servers re-calculate them
693          * to be relative too, with themselves as hop 0.
694          */
695         void SendServers(TreeServer* Current, TreeServer* s, int hops)
696         {
697                 char command[1024];
698                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
699                 {
700                         TreeServer* recursive_server = Current->GetChild(q);
701                         if (recursive_server != s)
702                         {
703                                 snprintf(command,1024,":%s SERVER %s * %d :%s",Current->GetName().c_str(),recursive_server->GetName().c_str(),hops,recursive_server->GetDesc().c_str());
704                                 this->WriteLine(command);
705                                 this->WriteLine(":"+recursive_server->GetName()+" VERSION :"+recursive_server->GetVersion());
706                                 /* down to next level */
707                                 this->SendServers(recursive_server, s, hops+1);
708                         }
709                 }
710         }
711
712         std::string MyCapabilities()
713         {
714                 ServerConfig* Config = Srv->GetConfig();
715                 std::vector<std::string> modlist;
716                 std::string capabilities = "";
717
718                 for (int i = 0; i <= MODCOUNT; i++)
719                 {
720                         if ((modules[i]->GetVersion().Flags & VF_STATIC) || (modules[i]->GetVersion().Flags & VF_COMMON))
721                                 modlist.push_back(Config->module_names[i]);
722                 }
723                 sort(modlist.begin(),modlist.end());
724                 for (unsigned int i = 0; i < modlist.size(); i++)
725                 {
726                         if (i)
727                                 capabilities = capabilities + ",";
728                         capabilities = capabilities + modlist[i];
729                 }
730                 return capabilities;
731         }
732         
733         void SendCapabilities()
734         {
735                 this->WriteLine("CAPAB "+MyCapabilities());
736         }
737
738         bool Capab(std::deque<std::string> params)
739         {
740                 if (params.size() != 1)
741                 {
742                         this->WriteLine("ERROR :Invalid number of parameters for CAPAB");
743                         return false;
744                 }
745                 if (params[0] != this->MyCapabilities())
746                 {
747                         std::string quitserver = this->myhost;
748                         if (this->InboundServerName != "")
749                         {
750                                 quitserver = this->InboundServerName;
751                         }
752                         WriteOpers("*** \2ERROR\2: Server '%s' does not have the same set of modules loaded, cannot link!",quitserver.c_str());
753                         WriteOpers("*** Our networked module set is: '%s'",this->MyCapabilities().c_str());
754                         WriteOpers("*** Other server's networked module set is: '%s'",params[0].c_str());
755                         WriteOpers("*** These lists must match exactly on both servers. Please correct these errors, and try again.");
756                         this->WriteLine("ERROR :CAPAB mismatch; My capabilities: '"+this->MyCapabilities()+"'");
757                         return false;
758                 }
759                 return true;
760         }
761
762         /* This function forces this server to quit, removing this server
763          * and any users on it (and servers and users below that, etc etc).
764          * It's very slow and pretty clunky, but luckily unless your network
765          * is having a REAL bad hair day, this function shouldnt be called
766          * too many times a month ;-)
767          */
768         void SquitServer(TreeServer* Current, CullList* Goners)
769         {
770                 /* recursively squit the servers attached to 'Current'.
771                  * We're going backwards so we don't remove users
772                  * while we still need them ;)
773                  */
774                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
775                 {
776                         TreeServer* recursive_server = Current->GetChild(q);
777                         this->SquitServer(recursive_server,Goners);
778                 }
779                 /* Now we've whacked the kids, whack self */
780                 num_lost_servers++;
781                 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
782                 {
783                         if (!strcasecmp(u->second->server,Current->GetName().c_str()))
784                         {
785                                 std::string qreason = Current->GetName()+" "+std::string(Srv->GetServerName());
786                                 Goners->AddItem(u->second,qreason);
787                                 num_lost_users++;
788                         }
789                 }
790         }
791
792         /* This is a wrapper function for SquitServer above, which
793          * does some validation first and passes on the SQUIT to all
794          * other remaining servers.
795          */
796         void Squit(TreeServer* Current,std::string reason)
797         {
798                 if ((Current) && (Current != TreeRoot))
799                 {
800                         std::deque<std::string> params;
801                         params.push_back(Current->GetName());
802                         params.push_back(":"+reason);
803                         DoOneToAllButSender(Current->GetParent()->GetName(),"SQUIT",params,Current->GetName());
804                         if (Current->GetParent() == TreeRoot)
805                         {
806                                 Srv->SendOpers("Server \002"+Current->GetName()+"\002 split: "+reason);
807                         }
808                         else
809                         {
810                                 Srv->SendOpers("Server \002"+Current->GetName()+"\002 split from server \002"+Current->GetParent()->GetName()+"\002 with reason: "+reason);
811                         }
812                         num_lost_servers = 0;
813                         num_lost_users = 0;
814                         CullList* Goners = new CullList();
815                         SquitServer(Current, Goners);
816                         Goners->Apply();
817                         Current->Tidy();
818                         Current->GetParent()->DelChild(Current);
819                         delete Current;
820                         delete Goners;
821                         WriteOpers("Netsplit complete, lost \002%d\002 users on \002%d\002 servers.", num_lost_users, num_lost_servers);
822                 }
823                 else
824                 {
825                         log(DEFAULT,"Squit from unknown server");
826                 }
827         }
828
829         /* FMODE command */
830         bool ForceMode(std::string source, std::deque<std::string> params)
831         {
832                 userrec* who = new userrec;
833                 who->fd = FD_MAGIC_NUMBER;
834                 if (params.size() < 2)
835                         return true;
836                 char* modelist[255];
837                 for (unsigned int q = 0; q < params.size(); q++)
838                 {
839                         modelist[q] = (char*)params[q].c_str();
840                 }
841                 Srv->SendMode(modelist,params.size(),who);
842                 DoOneToAllButSender(source,"FMODE",params,source);
843                 delete who;
844                 return true;
845         }
846
847         /* FTOPIC command */
848         bool ForceTopic(std::string source, std::deque<std::string> params)
849         {
850                 if (params.size() != 4)
851                         return true;
852                 std::string channel = params[0];
853                 time_t ts = atoi(params[1].c_str());
854                 std::string setby = params[2];
855                 std::string topic = params[3];
856
857                 chanrec* c = Srv->FindChannel(channel);
858                 if (c)
859                 {
860                         if ((ts >= c->topicset) || (!*c->topic))
861                         {
862                                 std::string oldtopic = c->topic;
863                                 strlcpy(c->topic,topic.c_str(),MAXTOPIC);
864                                 strlcpy(c->setby,setby.c_str(),NICKMAX);
865                                 c->topicset = ts;
866                                 /* if the topic text is the same as the current topic,
867                                  * dont bother to send the TOPIC command out, just silently
868                                  * update the set time and set nick.
869                                  */
870                                 if (oldtopic != topic)
871                                         WriteChannelWithServ((char*)source.c_str(), c, "TOPIC %s :%s", c->name, c->topic);
872                         }
873                         
874                 }
875                 
876                 /* all done, send it on its way */
877                 params[3] = ":" + params[3];
878                 DoOneToAllButSender(source,"FTOPIC",params,source);
879
880                 return true;
881         }
882
883         /* FJOIN, similar to unreal SJOIN */
884         bool ForceJoin(std::string source, std::deque<std::string> params)
885         {
886                 if (params.size() < 3)
887                         return true;
888
889                 char first[MAXBUF];
890                 char modestring[MAXBUF];
891                 char* mode_users[127];
892                 mode_users[0] = first;
893                 mode_users[1] = modestring;
894                 strcpy(mode_users[1],"+");
895                 unsigned int modectr = 2;
896                 
897                 userrec* who = NULL;
898                 std::string channel = params[0];
899                 time_t TS = atoi(params[1].c_str());
900                 char* key = "";
901                 
902                 chanrec* chan = Srv->FindChannel(channel);
903                 if (chan)
904                 {
905                         key = chan->key;
906                 }
907                 strlcpy(mode_users[0],channel.c_str(),MAXBUF);
908
909                 /* default is a high value, which if we dont have this
910                  * channel will let the other side apply their modes.
911                  */
912                 time_t ourTS = time(NULL)+600;
913                 chanrec* us = Srv->FindChannel(channel);
914                 if (us)
915                 {
916                         ourTS = us->age;
917                 }
918
919                 log(DEBUG,"FJOIN detected, our TS=%lu, their TS=%lu",ourTS,TS);
920
921                 /* do this first, so our mode reversals are correctly received by other servers
922                  * if there is a TS collision.
923                  */
924                 DoOneToAllButSender(source,"FJOIN",params,source);
925                 
926                 for (unsigned int usernum = 2; usernum < params.size(); usernum++)
927                 {
928                         /* process one channel at a time, applying modes. */
929                         char* usr = (char*)params[usernum].c_str();
930                         /* Safety check just to make sure someones not sent us an FJOIN full of spaces
931                          * (is this even possible?) */
932                         if (usr && *usr)
933                         {
934                                 char permissions = *usr;
935                                 switch (permissions)
936                                 {
937                                         case '@':
938                                                 usr++;
939                                                 mode_users[modectr++] = usr;
940                                                 strlcat(modestring,"o",MAXBUF);
941                                         break;
942                                         case '%':
943                                                 usr++;
944                                                 mode_users[modectr++] = usr;
945                                                 strlcat(modestring,"h",MAXBUF);
946                                         break;
947                                         case '+':
948                                                 usr++;
949                                                 mode_users[modectr++] = usr;
950                                                 strlcat(modestring,"v",MAXBUF);
951                                         break;
952                                 }
953                                 who = Srv->FindNick(usr);
954                                 if (who)
955                                 {
956                                         Srv->JoinUserToChannel(who,channel,key);
957                                         if (modectr >= (MAXMODES-1))
958                                         {
959                                                 /* theres a mode for this user. push them onto the mode queue, and flush it
960                                                  * if there are more than MAXMODES to go.
961                                                  */
962                                                 if ((ourTS >= TS) || (Srv->IsUlined(who->server)))
963                                                 {
964                                                         /* We also always let u-lined clients win, no matter what the TS value */
965                                                         log(DEBUG,"Our our channel newer than theirs, accepting their modes");
966                                                         Srv->SendMode(mode_users,modectr,who);
967                                                 }
968                                                 else
969                                                 {
970                                                         log(DEBUG,"Their channel newer than ours, bouncing their modes");
971                                                         /* bouncy bouncy! */
972                                                         std::deque<std::string> params;
973                                                         /* modes are now being UNSET... */
974                                                         *mode_users[1] = '-';
975                                                         for (unsigned int x = 0; x < modectr; x++)
976                                                         {
977                                                                 params.push_back(mode_users[x]);
978                                                         }
979                                                         // tell everyone to bounce the modes. bad modes, bad!
980                                                         DoOneToMany(Srv->GetServerName(),"FMODE",params);
981                                                 }
982                                                 strcpy(mode_users[1],"+");
983                                                 modectr = 2;
984                                         }
985                                 }
986                         }
987                 }
988                 /* there werent enough modes built up to flush it during FJOIN,
989                  * or, there are a number left over. flush them out.
990                  */
991                 if ((modectr > 2) && (who))
992                 {
993                         if (ourTS >= TS)
994                         {
995                                 log(DEBUG,"Our our channel newer than theirs, accepting their modes");
996                                 Srv->SendMode(mode_users,modectr,who);
997                         }
998                         else
999                         {
1000                                 log(DEBUG,"Their channel newer than ours, bouncing their modes");
1001                                 std::deque<std::string> params;
1002                                 *mode_users[1] = '-';
1003                                 for (unsigned int x = 0; x < modectr; x++)
1004                                 {
1005                                         params.push_back(mode_users[x]);
1006                                 }
1007                                 DoOneToMany(Srv->GetServerName(),"FMODE",params);
1008                         }
1009                 }
1010                 return true;
1011         }
1012
1013         /* NICK command */
1014         bool IntroduceClient(std::string source, std::deque<std::string> params)
1015         {
1016                 if (params.size() < 8)
1017                         return true;
1018                 // NICK age nick host dhost ident +modes ip :gecos
1019                 //       0   1    2    3      4     5    6   7
1020                 std::string nick = params[1];
1021                 std::string host = params[2];
1022                 std::string dhost = params[3];
1023                 std::string ident = params[4];
1024                 time_t age = atoi(params[0].c_str());
1025                 std::string modes = params[5];
1026                 while (*(modes.c_str()) == '+')
1027                 {
1028                         char* m = (char*)modes.c_str();
1029                         m++;
1030                         modes = m;
1031                 }
1032                 std::string ip = params[6];
1033                 std::string gecos = params[7];
1034                 char* tempnick = (char*)nick.c_str();
1035                 log(DEBUG,"Introduce client %s!%s@%s",tempnick,ident.c_str(),host.c_str());
1036                 
1037                 user_hash::iterator iter;
1038                 iter = clientlist.find(tempnick);
1039                 if (iter != clientlist.end())
1040                 {
1041                         // nick collision
1042                         log(DEBUG,"Nick collision on %s!%s@%s: %lu %lu",tempnick,ident.c_str(),host.c_str(),(unsigned long)age,(unsigned long)iter->second->age);
1043                         this->WriteLine(":"+Srv->GetServerName()+" KILL "+tempnick+" :Nickname collision");
1044                         return true;
1045                 }
1046
1047                 clientlist[tempnick] = new userrec();
1048                 clientlist[tempnick]->fd = FD_MAGIC_NUMBER;
1049                 strlcpy(clientlist[tempnick]->nick, tempnick,NICKMAX);
1050                 strlcpy(clientlist[tempnick]->host, host.c_str(),160);
1051                 strlcpy(clientlist[tempnick]->dhost, dhost.c_str(),160);
1052                 clientlist[tempnick]->server = (char*)FindServerNamePtr(source.c_str());
1053                 strlcpy(clientlist[tempnick]->ident, ident.c_str(),IDENTMAX);
1054                 strlcpy(clientlist[tempnick]->fullname, gecos.c_str(),MAXGECOS);
1055                 clientlist[tempnick]->registered = 7;
1056                 clientlist[tempnick]->signon = age;
1057                 strlcpy(clientlist[tempnick]->modes, modes.c_str(),53);
1058                 strlcpy(clientlist[tempnick]->ip,ip.c_str(),16);
1059
1060                 ucrec a;
1061                 a.channel = NULL;
1062                 a.uc_modes = 0;
1063                 for (int i = 0; i < MAXCHANS; i++)
1064                         clientlist[tempnick]->chans.push_back(a);
1065
1066                 if (!this->bursting)
1067                 {
1068                         WriteOpers("*** Client connecting at %s: %s!%s@%s [%s]",clientlist[tempnick]->server,clientlist[tempnick]->nick,clientlist[tempnick]->ident,clientlist[tempnick]->host,clientlist[tempnick]->ip);
1069                 }
1070                 params[7] = ":" + params[7];
1071                 DoOneToAllButSender(source,"NICK",params,source);
1072
1073                 // Increment the Source Servers User Count..
1074                 TreeServer* SourceServer = FindServer(source);
1075                 if (SourceServer) {
1076                         SourceServer->AddUserCount();
1077                 }
1078
1079                 return true;
1080         }
1081
1082         /* Send one or more FJOINs for a channel of users.
1083          * If the length of a single line is more than 480-NICKMAX
1084          * in length, it is split over multiple lines.
1085          */
1086         void SendFJoins(TreeServer* Current, chanrec* c)
1087         {
1088                 log(DEBUG,"Sending FJOINs to other server for %s",c->name);
1089                 char list[MAXBUF];
1090                 snprintf(list,MAXBUF,":%s FJOIN %s %lu",Srv->GetServerName().c_str(),c->name,(unsigned long)c->age);
1091                 std::map<char*,char*> *ulist = c->GetUsers();
1092                 for (std::map<char*,char*>::iterator i = ulist->begin(); i != ulist->end(); i++)
1093                 {
1094                         char* o = i->second;
1095                         userrec* otheruser = (userrec*)o;
1096                         strlcat(list," ",MAXBUF);
1097                         strlcat(list,cmode(otheruser,c),MAXBUF);
1098                         strlcat(list,otheruser->nick,MAXBUF);
1099                         if (strlen(list)>(480-NICKMAX))
1100                         {
1101                                 log(DEBUG,"FJOIN line wrapped");
1102                                 this->WriteLine(list);
1103                                 snprintf(list,MAXBUF,":%s FJOIN %s %lu",Srv->GetServerName().c_str(),c->name,(unsigned long)c->age);
1104                         }
1105                 }
1106                 if (list[strlen(list)-1] != ':')
1107                 {
1108                         log(DEBUG,"Final FJOIN line");
1109                         this->WriteLine(list);
1110                 }
1111         }
1112
1113         /* Send G, Q, Z and E lines */
1114         void SendXLines(TreeServer* Current)
1115         {
1116                 char data[MAXBUF];
1117                 /* Yes, these arent too nice looking, but they get the job done */
1118                 for (std::vector<ZLine>::iterator i = zlines.begin(); i != zlines.end(); i++)
1119                 {
1120                         snprintf(data,MAXBUF,":%s ADDLINE Z %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->ipaddr,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1121                         this->WriteLine(data);
1122                 }
1123                 for (std::vector<QLine>::iterator i = qlines.begin(); i != qlines.end(); i++)
1124                 {
1125                         snprintf(data,MAXBUF,":%s ADDLINE Q %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->nick,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1126                         this->WriteLine(data);
1127                 }
1128                 for (std::vector<GLine>::iterator i = glines.begin(); i != glines.end(); i++)
1129                 {
1130                         snprintf(data,MAXBUF,":%s ADDLINE G %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->hostmask,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1131                         this->WriteLine(data);
1132                 }
1133                 for (std::vector<ELine>::iterator i = elines.begin(); i != elines.end(); i++)
1134                 {
1135                         snprintf(data,MAXBUF,":%s ADDLINE E %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->hostmask,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1136                         this->WriteLine(data);
1137                 }
1138                 for (std::vector<ZLine>::iterator i = pzlines.begin(); i != pzlines.end(); i++)
1139                 {
1140                         snprintf(data,MAXBUF,":%s ADDLINE Z %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->ipaddr,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1141                         this->WriteLine(data);
1142                 }
1143                 for (std::vector<QLine>::iterator i = pqlines.begin(); i != pqlines.end(); i++)
1144                 {
1145                         snprintf(data,MAXBUF,":%s ADDLINE Q %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->nick,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1146                         this->WriteLine(data);
1147                 }
1148                 for (std::vector<GLine>::iterator i = pglines.begin(); i != pglines.end(); i++)
1149                 {
1150                         snprintf(data,MAXBUF,":%s ADDLINE G %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->hostmask,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1151                         this->WriteLine(data);
1152                 }
1153                 for (std::vector<ELine>::iterator i = pelines.begin(); i != pelines.end(); i++)
1154                 {
1155                         snprintf(data,MAXBUF,":%s ADDLINE E %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->hostmask,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1156                         this->WriteLine(data);
1157                 }
1158         }
1159
1160         /* Send channel modes and topics */
1161         void SendChannelModes(TreeServer* Current)
1162         {
1163                 char data[MAXBUF];
1164                 std::deque<std::string> list;
1165                 for (chan_hash::iterator c = chanlist.begin(); c != chanlist.end(); c++)
1166                 {
1167                         SendFJoins(Current, c->second);
1168                         snprintf(data,MAXBUF,":%s FMODE %s +%s",Srv->GetServerName().c_str(),c->second->name,chanmodes(c->second));
1169                         this->WriteLine(data);
1170                         if (*c->second->topic)
1171                         {
1172                                 snprintf(data,MAXBUF,":%s FTOPIC %s %lu %s :%s",Srv->GetServerName().c_str(),c->second->name,(unsigned long)c->second->topicset,c->second->setby,c->second->topic);
1173                                 this->WriteLine(data);
1174                         }
1175                         for (BanList::iterator b = c->second->bans.begin(); b != c->second->bans.end(); b++)
1176                         {
1177                                 snprintf(data,MAXBUF,":%s FMODE %s +b %s",Srv->GetServerName().c_str(),c->second->name,b->data);
1178                                 this->WriteLine(data);
1179                         }
1180                         FOREACH_MOD(I_OnSyncChannel,OnSyncChannel(c->second,(Module*)TreeProtocolModule,(void*)this));
1181                         list.clear();
1182                         c->second->GetExtList(list);
1183                         for (unsigned int j = 0; j < list.size(); j++)
1184                         {
1185                                 FOREACH_MOD(I_OnSyncChannelMetaData,OnSyncChannelMetaData(c->second,(Module*)TreeProtocolModule,(void*)this,list[j]));
1186                         }
1187                 }
1188         }
1189
1190         /* send all users and their oper state/modes */
1191         void SendUsers(TreeServer* Current)
1192         {
1193                 char data[MAXBUF];
1194                 std::deque<std::string> list;
1195                 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
1196                 {
1197                         if (u->second->registered == 7)
1198                         {
1199                                 snprintf(data,MAXBUF,":%s NICK %lu %s %s %s %s +%s %s :%s",u->second->server,(unsigned long)u->second->age,u->second->nick,u->second->host,u->second->dhost,u->second->ident,u->second->modes,u->second->ip,u->second->fullname);
1200                                 this->WriteLine(data);
1201                                 if (strchr(u->second->modes,'o'))
1202                                 {
1203                                         this->WriteLine(":"+std::string(u->second->nick)+" OPERTYPE "+std::string(u->second->oper));
1204                                 }
1205                                 FOREACH_MOD(I_OnSyncUser,OnSyncUser(u->second,(Module*)TreeProtocolModule,(void*)this));
1206                                 list.clear();
1207                                 u->second->GetExtList(list);
1208                                 for (unsigned int j = 0; j < list.size(); j++)
1209                                 {
1210                                         FOREACH_MOD(I_OnSyncUserMetaData,OnSyncUserMetaData(u->second,(Module*)TreeProtocolModule,(void*)this,list[j]));
1211                                 }
1212                         }
1213                 }
1214         }
1215
1216         /* This function is called when we want to send a netburst to a local
1217          * server. There is a set order we must do this, because for example
1218          * users require their servers to exist, and channels require their
1219          * users to exist. You get the idea.
1220          */
1221         void DoBurst(TreeServer* s)
1222         {
1223                 Srv->SendOpers("*** Bursting to \2"+s->GetName()+"\2.");
1224                 this->WriteLine("BURST");
1225                 /* send our version string */
1226                 this->WriteLine(":"+Srv->GetServerName()+" VERSION :"+Srv->GetVersion());
1227                 /* Send server tree */
1228                 this->SendServers(TreeRoot,s,1);
1229                 /* Send users and their oper status */
1230                 this->SendUsers(s);
1231                 /* Send everything else (channel modes, xlines etc) */
1232                 this->SendChannelModes(s);
1233                 this->SendXLines(s);
1234                 this->WriteLine("ENDBURST");
1235                 Srv->SendOpers("*** Finished bursting to \2"+s->GetName()+"\2.");
1236         }
1237
1238         /* This function is called when we receive data from a remote
1239          * server. We buffer the data in a std::string (it doesnt stay
1240          * there for long), reading using InspSocket::Read() which can
1241          * read up to 16 kilobytes in one operation.
1242          *
1243          * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
1244          * THE SOCKET OBJECT FOR US.
1245          */
1246         virtual bool OnDataReady()
1247         {
1248                 char* data = this->Read();
1249                 if (data)
1250                 {
1251                         this->in_buffer += data;
1252                         /* While there is at least one new line in the buffer,
1253                          * do something useful (we hope!) with it.
1254                          */
1255                         while (in_buffer.find("\n") != std::string::npos)
1256                         {
1257                                 char* line = (char*)in_buffer.c_str();
1258                                 std::string ret = "";
1259                                 while ((*line != '\n') && (strlen(line)))
1260                                 {
1261                                         if ((*line != '\r') && (*line != '\n'))
1262                                                 ret = ret + *line;
1263                                         line++;
1264                                 }
1265                                 if ((*line == '\n') || (*line == '\r'))
1266                                         line++;
1267                                 in_buffer = line;
1268                                 /* Process this one, abort if it
1269                                  * didnt return true.
1270                                  */
1271                                 if (this->ctx_in)
1272                                 {
1273                                         char out[1024];
1274                                         char result[1024];
1275                                         memset(result,0,1024);
1276                                         memset(out,0,1024);
1277                                         log(DEBUG,"Original string '%s'",ret.c_str());
1278                                         /* ERROR + CAPAB is still allowed unencryped */
1279                                         if ((ret.substr(0,7) != "ERROR :") && (ret.substr(0,6) != "CAPAB "))
1280                                         {
1281                                                 int nbytes = from64tobits(out, ret.c_str(), 1024);
1282                                                 if ((nbytes > 0) && (nbytes < 1024))
1283                                                 {
1284                                                         log(DEBUG,"m_spanningtree: decrypt %d bytes",nbytes);
1285                                                         ctx_in->Decrypt(out, result, nbytes, 1);
1286                                                         for (int t = 0; t < nbytes; t++)
1287                                                                 if (result[t] == '\7') result[t] = 0;
1288                                                         ret = result;
1289                                                 }
1290                                         }
1291                                 }
1292                                 if (!this->ProcessLine(ret))
1293                                 {
1294                                         return false;
1295                                 }
1296                         }
1297                 }
1298                 return (data != NULL);
1299         }
1300
1301         int WriteLine(std::string line)
1302         {
1303                 log(DEBUG,"OUT: %s",line.c_str());
1304                 if (this->ctx_out)
1305                 {
1306                         log(DEBUG,"AES context");
1307                         char result[10240];
1308                         char result64[10240];
1309                         if (this->keylength)
1310                         {
1311                                 while (line.length() % this->keylength != 0)
1312                                 {
1313                                         // pad it to be a multiple of the key length
1314                                         line = line + "\7";
1315                                 }
1316                         }
1317                         unsigned int ll = line.length();
1318                         log(DEBUG,"Plaintext line with padding = %d chars",ll);
1319                         ctx_out->Encrypt(line.c_str(), result, ll, 1);
1320                         log(DEBUG,"Encrypted.");
1321                         to64frombits((unsigned char*)result64,(unsigned char*)result,ll);
1322                         line = result64;
1323                         log(DEBUG,"Encrypted: %s",line.c_str());
1324                         //int from64tobits(char *out, const char *in, int maxlen);
1325                 }
1326                 return this->Write(line + "\r\n");
1327         }
1328
1329         /* Handle ERROR command */
1330         bool Error(std::deque<std::string> params)
1331         {
1332                 if (params.size() < 1)
1333                         return false;
1334                 std::string Errmsg = params[0];
1335                 std::string SName = myhost;
1336                 if (InboundServerName != "")
1337                 {
1338                         SName = InboundServerName;
1339                 }
1340                 Srv->SendOpers("*** ERROR from "+SName+": "+Errmsg);
1341                 /* we will return false to cause the socket to close.
1342                  */
1343                 return false;
1344         }
1345
1346         /* Because the core won't let users or even SERVERS set +o,
1347          * we use the OPERTYPE command to do this.
1348          */
1349         bool OperType(std::string prefix, std::deque<std::string> &params)
1350         {
1351                 if (params.size() != 1)
1352                         return true;
1353                 std::string opertype = params[0];
1354                 userrec* u = Srv->FindNick(prefix);
1355                 if (u)
1356                 {
1357                         strlcpy(u->oper,opertype.c_str(),NICKMAX);
1358                         if (!strchr(u->modes,'o'))
1359                         {
1360                                 strcat(u->modes,"o");
1361                         }
1362                         DoOneToAllButSender(u->nick,"OPERTYPE",params,u->server);
1363                 }
1364                 return true;
1365         }
1366
1367         /* Because Andy insists that services-compatible servers must
1368          * implement SVSNICK and SVSJOIN, that's exactly what we do :p
1369          */
1370         bool ForceNick(std::string prefix, std::deque<std::string> &params)
1371         {
1372                 if (params.size() < 3)
1373                         return true;
1374                 userrec* u = Srv->FindNick(params[0]);
1375                 if (u)
1376                 {
1377                         Srv->ChangeUserNick(u,params[1]);
1378                         u->age = atoi(params[2].c_str());
1379                         DoOneToAllButSender(prefix,"SVSNICK",params,prefix);
1380                 }
1381                 return true;
1382         }
1383
1384         bool ServiceJoin(std::string prefix, std::deque<std::string> &params)
1385         {
1386                 if (params.size() < 2)
1387                         return true;
1388                 userrec* u = Srv->FindNick(params[0]);
1389                 if (u)
1390                 {
1391                         Srv->JoinUserToChannel(u,params[1],"");
1392                         DoOneToAllButSender(prefix,"SVSJOIN",params,prefix);
1393                 }
1394                 return true;
1395         }
1396
1397         bool RemoteRehash(std::string prefix, std::deque<std::string> &params)
1398         {
1399                 if (params.size() < 1)
1400                         return false;
1401                 std::string servermask = params[0];
1402                 if (Srv->MatchText(Srv->GetServerName(),servermask))
1403                 {
1404                         Srv->SendOpers("*** Remote rehash initiated from server \002"+prefix+"\002.");
1405                         Srv->RehashServer();
1406                         ReadConfiguration(false);
1407                 }
1408                 DoOneToAllButSender(prefix,"REHASH",params,prefix);
1409                 return true;
1410         }
1411
1412         bool RemoteKill(std::string prefix, std::deque<std::string> &params)
1413         {
1414                 if (params.size() != 2)
1415                         return true;
1416                 std::string nick = params[0];
1417                 userrec* u = Srv->FindNick(prefix);
1418                 userrec* who = Srv->FindNick(nick);
1419                 if (who)
1420                 {
1421                         /* Prepend kill source, if we don't have one */
1422                         std::string sourceserv = prefix;
1423                         if (u)
1424                         {
1425                                 sourceserv = u->server;
1426                         }
1427                         if (*(params[1].c_str()) != '[')
1428                         {
1429                                 params[1] = "[" + sourceserv + "] Killed (" + params[1] +")";
1430                         }
1431                         std::string reason = params[1];
1432                         params[1] = ":" + params[1];
1433                         DoOneToAllButSender(prefix,"KILL",params,sourceserv);
1434                         Srv->QuitUser(who,reason);
1435                 }
1436                 return true;
1437         }
1438
1439         bool LocalPong(std::string prefix, std::deque<std::string> &params)
1440         {
1441                 if (params.size() < 1)
1442                         return true;
1443                 TreeServer* ServerSource = FindServer(prefix);
1444                 if (ServerSource)
1445                 {
1446                         ServerSource->SetPingFlag();
1447                 }
1448                 return true;
1449         }
1450         
1451         bool MetaData(std::string prefix, std::deque<std::string> &params)
1452         {
1453                 if (params.size() < 3)
1454                         return true;
1455                 TreeServer* ServerSource = FindServer(prefix);
1456                 if (ServerSource)
1457                 {
1458                         if (*(params[0].c_str()) == '#')
1459                         {
1460                                 chanrec* c = Srv->FindChannel(params[0]);
1461                                 if (c)
1462                                 {
1463                                         FOREACH_MOD(I_OnDecodeMetaData,OnDecodeMetaData(TYPE_CHANNEL,c,params[1],params[2]));
1464                                 }
1465                         }
1466                         else
1467                         {
1468                                 userrec* u = Srv->FindNick(params[0]);
1469                                 if (u)
1470                                 {
1471                                         FOREACH_MOD(I_OnDecodeMetaData,OnDecodeMetaData(TYPE_USER,u,params[1],params[2]));
1472                                 }
1473                         }
1474                 }
1475                 params[2] = ":" + params[2];
1476                 DoOneToAllButSender(prefix,"METADATA",params,prefix);
1477                 return true;
1478         }
1479
1480         bool ServerVersion(std::string prefix, std::deque<std::string> &params)
1481         {
1482                 if (params.size() < 1)
1483                         return true;
1484                 TreeServer* ServerSource = FindServer(prefix);
1485                 if (ServerSource)
1486                 {
1487                         ServerSource->SetVersion(params[0]);
1488                 }
1489                 params[0] = ":" + params[0];
1490                 DoOneToAllButSender(prefix,"VERSION",params,prefix);
1491                 return true;
1492         }
1493
1494         bool ChangeHost(std::string prefix, std::deque<std::string> &params)
1495         {
1496                 if (params.size() < 1)
1497                         return true;
1498                 userrec* u = Srv->FindNick(prefix);
1499                 if (u)
1500                 {
1501                         Srv->ChangeHost(u,params[0]);
1502                         DoOneToAllButSender(prefix,"FHOST",params,u->server);
1503                 }
1504                 return true;
1505         }
1506
1507         bool AddLine(std::string prefix, std::deque<std::string> &params)
1508         {
1509                 if (params.size() < 6)
1510                         return true;
1511                 std::string linetype = params[0]; /* Z, Q, E, G, K */
1512                 std::string mask = params[1]; /* Line type dependent */
1513                 std::string source = params[2]; /* may not be online or may be a server */
1514                 std::string settime = params[3]; /* EPOCH time set */
1515                 std::string duration = params[4]; /* Duration secs */
1516                 std::string reason = params[5];
1517
1518                 switch (*(linetype.c_str()))
1519                 {
1520                         case 'Z':
1521                                 add_zline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1522                                 zline_set_creation_time((char*)mask.c_str(), atoi(settime.c_str()));
1523                         break;
1524                         case 'Q':
1525                                 add_qline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1526                                 qline_set_creation_time((char*)mask.c_str(), atoi(settime.c_str()));
1527                         break;
1528                         case 'E':
1529                                 add_eline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1530                                 eline_set_creation_time((char*)mask.c_str(), atoi(settime.c_str()));
1531                         break;
1532                         case 'G':
1533                                 add_gline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1534                                 gline_set_creation_time((char*)mask.c_str(), atoi(settime.c_str()));
1535                         break;
1536                         case 'K':
1537                                 add_kline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1538                         break;
1539                         default:
1540                                 /* Just in case... */
1541                                 Srv->SendOpers("*** \2WARNING\2: Invalid xline type '"+linetype+"' sent by server "+prefix+", ignored!");
1542                         break;
1543                 }
1544                 /* Send it on its way */
1545                 params[5] = ":" + params[5];
1546                 DoOneToAllButSender(prefix,"ADDLINE",params,prefix);
1547                 return true;
1548         }
1549
1550         bool ChangeName(std::string prefix, std::deque<std::string> &params)
1551         {
1552                 if (params.size() < 1)
1553                         return true;
1554                 userrec* u = Srv->FindNick(prefix);
1555                 if (u)
1556                 {
1557                         Srv->ChangeGECOS(u,params[0]);
1558                         params[0] = ":" + params[0];
1559                         DoOneToAllButSender(prefix,"FNAME",params,u->server);
1560                 }
1561                 return true;
1562         }
1563
1564         bool Whois(std::string prefix, std::deque<std::string> &params)
1565         {
1566                 if (params.size() < 1)
1567                         return true;
1568                 log(DEBUG,"In IDLE command");
1569                 userrec* u = Srv->FindNick(prefix);
1570                 if (u)
1571                 {
1572                         log(DEBUG,"USER EXISTS: %s",u->nick);
1573                         // an incoming request
1574                         if (params.size() == 1)
1575                         {
1576                                 userrec* x = Srv->FindNick(params[0]);
1577                                 if ((x) && (x->fd > -1))
1578                                 {
1579                                         userrec* x = Srv->FindNick(params[0]);
1580                                         log(DEBUG,"Got IDLE");
1581                                         char signon[MAXBUF];
1582                                         char idle[MAXBUF];
1583                                         log(DEBUG,"Sending back IDLE 3");
1584                                         snprintf(signon,MAXBUF,"%lu",(unsigned long)x->signon);
1585                                         snprintf(idle,MAXBUF,"%lu",(unsigned long)abs((x->idle_lastmsg)-time(NULL)));
1586                                         std::deque<std::string> par;
1587                                         par.push_back(prefix);
1588                                         par.push_back(signon);
1589                                         par.push_back(idle);
1590                                         // ours, we're done, pass it BACK
1591                                         DoOneToOne(params[0],"IDLE",par,u->server);
1592                                 }
1593                                 else
1594                                 {
1595                                         // not ours pass it on
1596                                         DoOneToOne(prefix,"IDLE",params,x->server);
1597                                 }
1598                         }
1599                         else if (params.size() == 3)
1600                         {
1601                                 std::string who_did_the_whois = params[0];
1602                                 userrec* who_to_send_to = Srv->FindNick(who_did_the_whois);
1603                                 if ((who_to_send_to) && (who_to_send_to->fd > -1))
1604                                 {
1605                                         log(DEBUG,"Got final IDLE");
1606                                         // an incoming reply to a whois we sent out
1607                                         std::string nick_whoised = prefix;
1608                                         unsigned long signon = atoi(params[1].c_str());
1609                                         unsigned long idle = atoi(params[2].c_str());
1610                                         if ((who_to_send_to) && (who_to_send_to->fd > -1))
1611                                                 do_whois(who_to_send_to,u,signon,idle,(char*)nick_whoised.c_str());
1612                                 }
1613                                 else
1614                                 {
1615                                         // not ours, pass it on
1616                                         DoOneToOne(prefix,"IDLE",params,who_to_send_to->server);
1617                                 }
1618                         }
1619                 }
1620                 return true;
1621         }
1622         
1623         bool LocalPing(std::string prefix, std::deque<std::string> &params)
1624         {
1625                 if (params.size() < 1)
1626                         return true;
1627                 std::string stufftobounce = params[0];
1628                 this->WriteLine(":"+Srv->GetServerName()+" PONG "+stufftobounce);
1629                 return true;
1630         }
1631
1632         bool RemoteServer(std::string prefix, std::deque<std::string> &params)
1633         {
1634                 if (params.size() < 4)
1635                         return false;
1636                 std::string servername = params[0];
1637                 std::string password = params[1];
1638                 // hopcount is not used for a remote server, we calculate this ourselves
1639                 std::string description = params[3];
1640                 TreeServer* ParentOfThis = FindServer(prefix);
1641                 if (!ParentOfThis)
1642                 {
1643                         this->WriteLine("ERROR :Protocol error - Introduced remote server from unknown server "+prefix);
1644                         return false;
1645                 }
1646                 TreeServer* CheckDupe = FindServer(servername);
1647                 if (CheckDupe)
1648                 {
1649                         this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1650                         Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, already exists on server "+CheckDupe->GetParent()->GetName());
1651                         return false;
1652                 }
1653                 TreeServer* Node = new TreeServer(servername,description,ParentOfThis,NULL);
1654                 ParentOfThis->AddChild(Node);
1655                 params[3] = ":" + params[3];
1656                 DoOneToAllButSender(prefix,"SERVER",params,prefix);
1657                 Srv->SendOpers("*** Server \002"+prefix+"\002 introduced server \002"+servername+"\002 ("+description+")");
1658                 return true;
1659         }
1660
1661         bool Outbound_Reply_Server(std::deque<std::string> &params)
1662         {
1663                 if (params.size() < 4)
1664                         return false;
1665                 std::string servername = params[0];
1666                 std::string password = params[1];
1667                 int hops = atoi(params[2].c_str());
1668                 if (hops)
1669                 {
1670                         this->WriteLine("ERROR :Server too far away for authentication");
1671                         Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, server is too far away for authentication");
1672                         return false;
1673                 }
1674                 std::string description = params[3];
1675                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1676                 {
1677                         if ((x->Name == servername) && (x->RecvPass == password))
1678                         {
1679                                 TreeServer* CheckDupe = FindServer(servername);
1680                                 if (CheckDupe)
1681                                 {
1682                                         this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1683                                         Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, already exists on server "+CheckDupe->GetParent()->GetName());
1684                                         return false;
1685                                 }
1686                                 // Begin the sync here. this kickstarts the
1687                                 // other side, waiting in WAIT_AUTH_2 state,
1688                                 // into starting their burst, as it shows
1689                                 // that we're happy.
1690                                 this->LinkState = CONNECTED;
1691                                 // we should add the details of this server now
1692                                 // to the servers tree, as a child of the root
1693                                 // node.
1694                                 TreeServer* Node = new TreeServer(servername,description,TreeRoot,this);
1695                                 TreeRoot->AddChild(Node);
1696                                 params[3] = ":" + params[3];
1697                                 DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,servername);
1698                                 this->bursting = true;
1699                                 this->DoBurst(Node);
1700                                 return true;
1701                         }
1702                 }
1703                 this->WriteLine("ERROR :Invalid credentials");
1704                 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, invalid link credentials");
1705                 return false;
1706         }
1707
1708         bool Inbound_Server(std::deque<std::string> &params)
1709         {
1710                 if (params.size() < 4)
1711                         return false;
1712                 std::string servername = params[0];
1713                 std::string password = params[1];
1714                 int hops = atoi(params[2].c_str());
1715                 if (hops)
1716                 {
1717                         this->WriteLine("ERROR :Server too far away for authentication");
1718                         Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, server is too far away for authentication");
1719                         return false;
1720                 }
1721                 std::string description = params[3];
1722                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1723                 {
1724                         if ((x->Name == servername) && (x->RecvPass == password))
1725                         {
1726                                 TreeServer* CheckDupe = FindServer(servername);
1727                                 if (CheckDupe)
1728                                 {
1729                                         this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1730                                         Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, already exists on server "+CheckDupe->GetParent()->GetName());
1731                                         return false;
1732                                 }
1733                                 /* If the config says this link is encrypted, but the remote side
1734                                  * hasnt bothered to send the AES command before SERVER, then we
1735                                  * boot them off as we MUST have this connection encrypted.
1736                                  */
1737                                 if ((x->EncryptionKey != "") && (!this->ctx_in))
1738                                 {
1739                                         this->WriteLine("ERROR :This link requires AES encryption to be enabled. Plaintext connection refused.");
1740                                         Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, remote server did not enable AES.");
1741                                         return false;
1742                                 }
1743                                 Srv->SendOpers("*** Verified incoming server connection from \002"+servername+"\002["+this->GetIP()+"] ("+description+")");
1744                                 this->InboundServerName = servername;
1745                                 this->InboundDescription = description;
1746                                 // this is good. Send our details: Our server name and description and hopcount of 0,
1747                                 // along with the sendpass from this block.
1748                                 this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
1749                                 // move to the next state, we are now waiting for THEM.
1750                                 this->LinkState = WAIT_AUTH_2;
1751                                 return true;
1752                         }
1753                 }
1754                 this->WriteLine("ERROR :Invalid credentials");
1755                 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, invalid link credentials");
1756                 return false;
1757         }
1758
1759         void Split(std::string line, bool stripcolon, std::deque<std::string> &n)
1760         {
1761                 if (!strchr(line.c_str(),' '))
1762                 {
1763                         n.push_back(line);
1764                         return;
1765                 }
1766                 std::stringstream s(line);
1767                 std::string param = "";
1768                 n.clear();
1769                 int item = 0;
1770                 while (!s.eof())
1771                 {
1772                         char c;
1773                         s.get(c);
1774                         if (c == ' ')
1775                         {
1776                                 n.push_back(param);
1777                                 param = "";
1778                                 item++;
1779                         }
1780                         else
1781                         {
1782                                 if (!s.eof())
1783                                 {
1784                                         param = param + c;
1785                                 }
1786                                 if ((param == ":") && (item > 0))
1787                                 {
1788                                         param = "";
1789                                         while (!s.eof())
1790                                         {
1791                                                 s.get(c);
1792                                                 if (!s.eof())
1793                                                 {
1794                                                         param = param + c;
1795                                                 }
1796                                         }
1797                                         n.push_back(param);
1798                                         param = "";
1799                                 }
1800                         }
1801                 }
1802                 if (param != "")
1803                 {
1804                         n.push_back(param);
1805                 }
1806                 return;
1807         }
1808
1809         bool ProcessLine(std::string line)
1810         {
1811                 char* l = (char*)line.c_str();
1812                 while ((strlen(l)) && (l[strlen(l)-1] == '\r') || (l[strlen(l)-1] == '\n'))
1813                         l[strlen(l)-1] = '\0';
1814                 line = l;
1815                 if (line == "")
1816                         return true;
1817                 Srv->Log(DEBUG,"IN: "+line);
1818                 
1819                 std::deque<std::string> params;
1820                 this->Split(line,true,params);
1821                 std::string command = "";
1822                 std::string prefix = "";
1823                 if (((params[0].c_str())[0] == ':') && (params.size() > 1))
1824                 {
1825                         prefix = params[0];
1826                         command = params[1];
1827                         char* pref = (char*)prefix.c_str();
1828                         prefix = ++pref;
1829                         params.pop_front();
1830                         params.pop_front();
1831                 }
1832                 else
1833                 {
1834                         prefix = "";
1835                         command = params[0];
1836                         params.pop_front();
1837                 }
1838
1839                 if ((!this->ctx_in) && (command == "AES"))
1840                 {
1841                         std::string sserv = params[0];
1842                         for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1843                         {
1844                                 if ((x->EncryptionKey != "") && (x->Name == sserv))
1845                                 {
1846                                         this->InitAES(x->EncryptionKey,sserv);
1847                                 }
1848                         }
1849                         return true;
1850                 }
1851                 else if ((this->ctx_in) && (command == "AES"))
1852                 {
1853                         WriteOpers("*** \2AES\2: Encryption already enabled on this connection yet %s is trying to enable it twice!",params[0].c_str());
1854                 }
1855
1856                 switch (this->LinkState)
1857                 {
1858                         TreeServer* Node;
1859                         
1860                         case WAIT_AUTH_1:
1861                                 // Waiting for SERVER command from remote server. Server initiating
1862                                 // the connection sends the first SERVER command, listening server
1863                                 // replies with theirs if its happy, then if the initiator is happy,
1864                                 // it starts to send its net sync, which starts the merge, otherwise
1865                                 // it sends an ERROR.
1866                                 if (command == "PASS")
1867                                 {
1868                                         /* Silently ignored */
1869                                 }
1870                                 else if (command == "SERVER")
1871                                 {
1872                                         return this->Inbound_Server(params);
1873                                 }
1874                                 else if (command == "ERROR")
1875                                 {
1876                                         return this->Error(params);
1877                                 }
1878                                 else if (command == "USER")
1879                                 {
1880                                         this->WriteLine("ERROR :Client connections to this port are prohibited.");
1881                                         return false;
1882                                 }
1883                                 else if (command == "CAPAB")
1884                                 {
1885                                         return this->Capab(params);
1886                                 }
1887                                 else if ((command == "U") || (command == "S"))
1888                                 {
1889                                         this->WriteLine("ERROR :Cannot use the old-style mesh linking protocol with m_spanningtree.so!");
1890                                         return false;
1891                                 }
1892                                 else
1893                                 {
1894                                         this->WriteLine("ERROR :Invalid command in negotiation phase.");
1895                                         return false;
1896                                 }
1897                         break;
1898                         case WAIT_AUTH_2:
1899                                 // Waiting for start of other side's netmerge to say they liked our
1900                                 // password.
1901                                 if (command == "SERVER")
1902                                 {
1903                                         // cant do this, they sent it to us in the WAIT_AUTH_1 state!
1904                                         // silently ignore.
1905                                         return true;
1906                                 }
1907                                 else if ((command == "U") || (command == "S"))
1908                                 {
1909                                         this->WriteLine("ERROR :Cannot use the old-style mesh linking protocol with m_spanningtree.so!");
1910                                         return false;
1911                                 }
1912                                 else if (command == "BURST")
1913                                 {
1914                                         this->LinkState = CONNECTED;
1915                                         Node = new TreeServer(InboundServerName,InboundDescription,TreeRoot,this);
1916                                         TreeRoot->AddChild(Node);
1917                                         params.clear();
1918                                         params.push_back(InboundServerName);
1919                                         params.push_back("*");
1920                                         params.push_back("1");
1921                                         params.push_back(":"+InboundDescription);
1922                                         DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,InboundServerName);
1923                                         this->bursting = true;
1924                                         this->DoBurst(Node);
1925                                 }
1926                                 else if (command == "ERROR")
1927                                 {
1928                                         return this->Error(params);
1929                                 }
1930                                 else if (command == "CAPAB")
1931                                 {
1932                                         return this->Capab(params);
1933                                 }
1934                                 
1935                         break;
1936                         case LISTENER:
1937                                 this->WriteLine("ERROR :Internal error -- listening socket accepted its own descriptor!!!");
1938                                 return false;
1939                         break;
1940                         case CONNECTING:
1941                                 if (command == "SERVER")
1942                                 {
1943                                         // another server we connected to, which was in WAIT_AUTH_1 state,
1944                                         // has just sent us their credentials. If we get this far, theyre
1945                                         // happy with OUR credentials, and they are now in WAIT_AUTH_2 state.
1946                                         // if we're happy with this, we should send our netburst which
1947                                         // kickstarts the merge.
1948                                         return this->Outbound_Reply_Server(params);
1949                                 }
1950                                 else if (command == "ERROR")
1951                                 {
1952                                         return this->Error(params);
1953                                 }
1954                         break;
1955                         case CONNECTED:
1956                                 // This is the 'authenticated' state, when all passwords
1957                                 // have been exchanged and anything past this point is taken
1958                                 // as gospel.
1959                                 
1960                                 if (prefix != "")
1961                                 {
1962                                         std::string direction = prefix;
1963                                         userrec* t = Srv->FindNick(prefix);
1964                                         if (t)
1965                                         {
1966                                                 direction = t->server;
1967                                         }
1968                                         TreeServer* route_back_again = BestRouteTo(direction);
1969                                         if ((!route_back_again) || (route_back_again->GetSocket() != this))
1970                                         {
1971                                                 if (route_back_again)
1972                                                         log(DEBUG,"Protocol violation: Fake direction in command '%s' from connection '%s'",line.c_str(),this->GetName().c_str());
1973                                                 return true;
1974                                         }
1975
1976                                         /* Fix by brain:
1977                                          * When there is activity on the socket, reset the ping counter so
1978                                          * that we're not wasting bandwidth pinging an active server.
1979                                          */                     
1980                                         route_back_again->SetNextPingTime(time(NULL) + 120);
1981                                         route_back_again->SetPingFlag();
1982                                 }
1983                                 
1984                                 if (command == "SVSMODE")
1985                                 {
1986                                         /* Services expects us to implement
1987                                          * SVSMODE. In inspircd its the same as
1988                                          * MODE anyway.
1989                                          */
1990                                         command = "MODE";
1991                                 }
1992                                 std::string target = "";
1993                                 /* Yes, know, this is a mess. Its reasonably fast though as we're
1994                                  * working with std::string here.
1995                                  */
1996                                 if ((command == "NICK") && (params.size() > 1))
1997                                 {
1998                                         return this->IntroduceClient(prefix,params);
1999                                 }
2000                                 else if (command == "FJOIN")
2001                                 {
2002                                         return this->ForceJoin(prefix,params);
2003                                 }
2004                                 else if (command == "SERVER")
2005                                 {
2006                                         return this->RemoteServer(prefix,params);
2007                                 }
2008                                 else if (command == "ERROR")
2009                                 {
2010                                         return this->Error(params);
2011                                 }
2012                                 else if (command == "OPERTYPE")
2013                                 {
2014                                         return this->OperType(prefix,params);
2015                                 }
2016                                 else if (command == "FMODE")
2017                                 {
2018                                         return this->ForceMode(prefix,params);
2019                                 }
2020                                 else if (command == "KILL")
2021                                 {
2022                                         return this->RemoteKill(prefix,params);
2023                                 }
2024                                 else if (command == "FTOPIC")
2025                                 {
2026                                         return this->ForceTopic(prefix,params);
2027                                 }
2028                                 else if (command == "REHASH")
2029                                 {
2030                                         return this->RemoteRehash(prefix,params);
2031                                 }
2032                                 else if (command == "METADATA")
2033                                 {
2034                                         return this->MetaData(prefix,params);
2035                                 }
2036                                 else if (command == "PING")
2037                                 {
2038                                         return this->LocalPing(prefix,params);
2039                                 }
2040                                 else if (command == "PONG")
2041                                 {
2042                                         return this->LocalPong(prefix,params);
2043                                 }
2044                                 else if (command == "VERSION")
2045                                 {
2046                                         return this->ServerVersion(prefix,params);
2047                                 }
2048                                 else if (command == "FHOST")
2049                                 {
2050                                         return this->ChangeHost(prefix,params);
2051                                 }
2052                                 else if (command == "FNAME")
2053                                 {
2054                                         return this->ChangeName(prefix,params);
2055                                 }
2056                                 else if (command == "ADDLINE")
2057                                 {
2058                                         return this->AddLine(prefix,params);
2059                                 }
2060                                 else if (command == "SVSNICK")
2061                                 {
2062                                         if (prefix == "")
2063                                         {
2064                                                 prefix = this->GetName();
2065                                         }
2066                                         return this->ForceNick(prefix,params);
2067                                 }
2068                                 else if (command == "IDLE")
2069                                 {
2070                                         return this->Whois(prefix,params);
2071                                 }
2072                                 else if (command == "SVSJOIN")
2073                                 {
2074                                         if (prefix == "")
2075                                         {
2076                                                 prefix = this->GetName();
2077                                         }
2078                                         return this->ServiceJoin(prefix,params);
2079                                 }
2080                                 else if (command == "SQUIT")
2081                                 {
2082                                         if (params.size() == 2)
2083                                         {
2084                                                 this->Squit(FindServer(params[0]),params[1]);
2085                                         }
2086                                         return true;
2087                                 }
2088                                 else if (command == "ENDBURST")
2089                                 {
2090                                         this->bursting = false;
2091                                         return true;
2092                                 }
2093                                 else
2094                                 {
2095                                         // not a special inter-server command.
2096                                         // Emulate the actual user doing the command,
2097                                         // this saves us having a huge ugly parser.
2098                                         userrec* who = Srv->FindNick(prefix);
2099                                         std::string sourceserv = this->myhost;
2100                                         if (this->InboundServerName != "")
2101                                         {
2102                                                 sourceserv = this->InboundServerName;
2103                                         }
2104                                         if (who)
2105                                         {
2106                                                 // its a user
2107                                                 target = who->server;
2108                                                 char* strparams[127];
2109                                                 for (unsigned int q = 0; q < params.size(); q++)
2110                                                 {
2111                                                         strparams[q] = (char*)params[q].c_str();
2112                                                 }
2113                                                 Srv->CallCommandHandler(command, strparams, params.size(), who);
2114                                         }
2115                                         else
2116                                         {
2117                                                 // its not a user. Its either a server, or somethings screwed up.
2118                                                 if (IsServer(prefix))
2119                                                 {
2120                                                         target = Srv->GetServerName();
2121                                                 }
2122                                                 else
2123                                                 {
2124                                                         log(DEBUG,"Command with unknown origin '%s'",prefix.c_str());
2125                                                         return true;
2126                                                 }
2127                                         }
2128                                         return DoOneToAllButSenderRaw(line,sourceserv,prefix,command,params);
2129
2130                                 }
2131                                 return true;
2132                         break;
2133                 }
2134                 return true;
2135         }
2136
2137         virtual std::string GetName()
2138         {
2139                 std::string sourceserv = this->myhost;
2140                 if (this->InboundServerName != "")
2141                 {
2142                         sourceserv = this->InboundServerName;
2143                 }
2144                 return sourceserv;
2145         }
2146
2147         virtual void OnTimeout()
2148         {
2149                 if (this->LinkState == CONNECTING)
2150                 {
2151                         Srv->SendOpers("*** CONNECT: Connection to \002"+myhost+"\002 timed out.");
2152                 }
2153         }
2154
2155         virtual void OnClose()
2156         {
2157                 // Connection closed.
2158                 // If the connection is fully up (state CONNECTED)
2159                 // then propogate a netsplit to all peers.
2160                 std::string quitserver = this->myhost;
2161                 if (this->InboundServerName != "")
2162                 {
2163                         quitserver = this->InboundServerName;
2164                 }
2165                 TreeServer* s = FindServer(quitserver);
2166                 if (s)
2167                 {
2168                         Squit(s,"Remote host closed the connection");
2169                 }
2170                 WriteOpers("Server '\2%s\2[%s]' closed the connection.",quitserver.c_str(),this->GetIP().c_str());
2171         }
2172
2173         virtual int OnIncomingConnection(int newsock, char* ip)
2174         {
2175                 TreeSocket* s = new TreeSocket(newsock, ip);
2176                 Srv->AddSocket(s);
2177                 return true;
2178         }
2179 };
2180
2181 void AddThisServer(TreeServer* server, std::deque<TreeServer*> &list)
2182 {
2183         for (unsigned int c = 0; c < list.size(); c++)
2184         {
2185                 if (list[c] == server)
2186                 {
2187                         return;
2188                 }
2189         }
2190         list.push_back(server);
2191 }
2192
2193 // returns a list of DIRECT servernames for a specific channel
2194 void GetListOfServersForChannel(chanrec* c, std::deque<TreeServer*> &list)
2195 {
2196         std::map<char*,char*> *ulist = c->GetUsers();
2197         for (std::map<char*,char*>::iterator i = ulist->begin(); i != ulist->end(); i++)
2198         {
2199                 char* o = i->second;
2200                 userrec* otheruser = (userrec*)o;
2201                 if (otheruser->fd < 0)
2202                 {
2203                         TreeServer* best = BestRouteTo(otheruser->server);
2204                         if (best)
2205                                 AddThisServer(best,list);
2206                 }
2207         }
2208         return;
2209 }
2210
2211 bool DoOneToAllButSenderRaw(std::string data, std::string omit, std::string prefix, std::string command, std::deque<std::string> &params)
2212 {
2213         TreeServer* omitroute = BestRouteTo(omit);
2214         if ((command == "NOTICE") || (command == "PRIVMSG"))
2215         {
2216                 if ((params.size() >= 2) && (*(params[0].c_str()) != '$'))
2217                 {
2218                         if (*(params[0].c_str()) != '#')
2219                         {
2220                                 // special routing for private messages/notices
2221                                 userrec* d = Srv->FindNick(params[0]);
2222                                 if (d)
2223                                 {
2224                                         std::deque<std::string> par;
2225                                         par.push_back(params[0]);
2226                                         par.push_back(":"+params[1]);
2227                                         DoOneToOne(prefix,command,par,d->server);
2228                                         return true;
2229                                 }
2230                         }
2231                         else
2232                         {
2233                                 log(DEBUG,"Channel privmsg going to chan %s",params[0].c_str());
2234                                 chanrec* c = Srv->FindChannel(params[0]);
2235                                 if (c)
2236                                 {
2237                                         std::deque<TreeServer*> list;
2238                                         GetListOfServersForChannel(c,list);
2239                                         log(DEBUG,"Got a list of %d servers",list.size());
2240                                         unsigned int lsize = list.size();
2241                                         for (unsigned int i = 0; i < lsize; i++)
2242                                         {
2243                                                 TreeSocket* Sock = list[i]->GetSocket();
2244                                                 if ((Sock) && (list[i]->GetName() != omit) && (omitroute != list[i]))
2245                                                 {
2246                                                         log(DEBUG,"Writing privmsg to server %s",list[i]->GetName().c_str());
2247                                                         Sock->WriteLine(data);
2248                                                 }
2249                                         }
2250                                         return true;
2251                                 }
2252                         }
2253                 }
2254         }
2255         unsigned int items = TreeRoot->ChildCount();
2256         for (unsigned int x = 0; x < items; x++)
2257         {
2258                 TreeServer* Route = TreeRoot->GetChild(x);
2259                 if ((Route->GetSocket()) && (Route->GetName() != omit) && (omitroute != Route))
2260                 {
2261                         TreeSocket* Sock = Route->GetSocket();
2262                         Sock->WriteLine(data);
2263                 }
2264         }
2265         return true;
2266 }
2267
2268 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> &params, std::string omit)
2269 {
2270         TreeServer* omitroute = BestRouteTo(omit);
2271         std::string FullLine = ":" + prefix + " " + command;
2272         unsigned int words = params.size();
2273         for (unsigned int x = 0; x < words; x++)
2274         {
2275                 FullLine = FullLine + " " + params[x];
2276         }
2277         unsigned int items = TreeRoot->ChildCount();
2278         for (unsigned int x = 0; x < items; x++)
2279         {
2280                 TreeServer* Route = TreeRoot->GetChild(x);
2281                 // Send the line IF:
2282                 // The route has a socket (its a direct connection)
2283                 // The route isnt the one to be omitted
2284                 // The route isnt the path to the one to be omitted
2285                 if ((Route->GetSocket()) && (Route->GetName() != omit) && (omitroute != Route))
2286                 {
2287                         TreeSocket* Sock = Route->GetSocket();
2288                         Sock->WriteLine(FullLine);
2289                 }
2290         }
2291         return true;
2292 }
2293
2294 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> &params)
2295 {
2296         std::string FullLine = ":" + prefix + " " + command;
2297         unsigned int words = params.size();
2298         for (unsigned int x = 0; x < words; x++)
2299         {
2300                 FullLine = FullLine + " " + params[x];
2301         }
2302         unsigned int items = TreeRoot->ChildCount();
2303         for (unsigned int x = 0; x < items; x++)
2304         {
2305                 TreeServer* Route = TreeRoot->GetChild(x);
2306                 if (Route->GetSocket())
2307                 {
2308                         TreeSocket* Sock = Route->GetSocket();
2309                         Sock->WriteLine(FullLine);
2310                 }
2311         }
2312         return true;
2313 }
2314
2315 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> &params, std::string target)
2316 {
2317         TreeServer* Route = BestRouteTo(target);
2318         if (Route)
2319         {
2320                 std::string FullLine = ":" + prefix + " " + command;
2321                 unsigned int words = params.size();
2322                 for (unsigned int x = 0; x < words; x++)
2323                 {
2324                         FullLine = FullLine + " " + params[x];
2325                 }
2326                 if (Route->GetSocket())
2327                 {
2328                         TreeSocket* Sock = Route->GetSocket();
2329                         Sock->WriteLine(FullLine);
2330                 }
2331                 return true;
2332         }
2333         else
2334         {
2335                 return true;
2336         }
2337 }
2338
2339 std::vector<TreeSocket*> Bindings;
2340
2341 void ReadConfiguration(bool rebind)
2342 {
2343         Conf = new ConfigReader;
2344         if (rebind)
2345         {
2346                 for (int j =0; j < Conf->Enumerate("bind"); j++)
2347                 {
2348                         std::string Type = Conf->ReadValue("bind","type",j);
2349                         std::string IP = Conf->ReadValue("bind","address",j);
2350                         long Port = Conf->ReadInteger("bind","port",j,true);
2351                         if (Type == "servers")
2352                         {
2353                                 if (IP == "*")
2354                                 {
2355                                         IP = "";
2356                                 }
2357                                 TreeSocket* listener = new TreeSocket(IP.c_str(),Port,true,10);
2358                                 if (listener->GetState() == I_LISTENING)
2359                                 {
2360                                         Srv->AddSocket(listener);
2361                                         Bindings.push_back(listener);
2362                                 }
2363                                 else
2364                                 {
2365                                         log(DEFAULT,"m_spanningtree: Warning: Failed to bind server port %d",Port);
2366                                         listener->Close();
2367                                         delete listener;
2368                                 }
2369                         }
2370                 }
2371         }
2372         LinkBlocks.clear();
2373         for (int j =0; j < Conf->Enumerate("link"); j++)
2374         {
2375                 Link L;
2376                 L.Name = Conf->ReadValue("link","name",j);
2377                 L.IPAddr = Conf->ReadValue("link","ipaddr",j);
2378                 L.Port = Conf->ReadInteger("link","port",j,true);
2379                 L.SendPass = Conf->ReadValue("link","sendpass",j);
2380                 L.RecvPass = Conf->ReadValue("link","recvpass",j);
2381                 L.AutoConnect = Conf->ReadInteger("link","autoconnect",j,true);
2382                 L.EncryptionKey =  Conf->ReadValue("link","encryptionkey",j);
2383                 L.NextConnectTime = time(NULL) + L.AutoConnect;
2384                 /* Bugfix by brain, do not allow people to enter bad configurations */
2385                 if ((L.RecvPass != "") && (L.SendPass != "") && (L.Name != "") && (L.Port))
2386                 {
2387                         LinkBlocks.push_back(L);
2388                         log(DEBUG,"m_spanningtree: Read server %s with host %s:%d",L.Name.c_str(),L.IPAddr.c_str(),L.Port);
2389                 }
2390                 else
2391                 {
2392                         if (L.RecvPass == "")
2393                         {
2394                                 log(DEFAULT,"Invalid configuration for server '%s', recvpass not defined!",L.Name.c_str());
2395                         }
2396                         else if (L.SendPass == "")
2397                         {
2398                                 log(DEFAULT,"Invalid configuration for server '%s', sendpass not defined!",L.Name.c_str());
2399                         }
2400                         else if (L.Name == "")
2401                         {
2402                                 log(DEFAULT,"Invalid configuration, link tag without a name!");
2403                         }
2404                         else if (!L.Port)
2405                         {
2406                                 log(DEFAULT,"Invalid configuration for server '%s', no port specified!",L.Name.c_str());
2407                         }
2408                 }
2409         }
2410         delete Conf;
2411 }
2412
2413
2414 class ModuleSpanningTree : public Module
2415 {
2416         std::vector<TreeSocket*> Bindings;
2417         int line;
2418         int NumServers;
2419
2420  public:
2421
2422         ModuleSpanningTree(Server* Me)
2423                 : Module::Module(Me)
2424         {
2425                 Srv = Me;
2426                 Bindings.clear();
2427
2428                 // Create the root of the tree
2429                 TreeRoot = new TreeServer(Srv->GetServerName(),Srv->GetServerDescription());
2430
2431                 ReadConfiguration(true);
2432         }
2433
2434         void ShowLinks(TreeServer* Current, userrec* user, int hops)
2435         {
2436                 std::string Parent = TreeRoot->GetName();
2437                 if (Current->GetParent())
2438                 {
2439                         Parent = Current->GetParent()->GetName();
2440                 }
2441                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
2442                 {
2443                         ShowLinks(Current->GetChild(q),user,hops+1);
2444                 }
2445                 WriteServ(user->fd,"364 %s %s %s :%d %s",user->nick,Current->GetName().c_str(),Parent.c_str(),hops,Current->GetDesc().c_str());
2446         }
2447
2448         int CountLocalServs()
2449         {
2450                 return TreeRoot->ChildCount();
2451         }
2452
2453         int CountServs()
2454         {
2455                 return serverlist.size();
2456         }
2457
2458         void HandleLinks(char** parameters, int pcnt, userrec* user)
2459         {
2460                 ShowLinks(TreeRoot,user,0);
2461                 WriteServ(user->fd,"365 %s * :End of /LINKS list.",user->nick);
2462                 return;
2463         }
2464
2465         void HandleLusers(char** parameters, int pcnt, userrec* user)
2466         {
2467                 WriteServ(user->fd,"251 %s :There are %d users and %d invisible on %d servers",user->nick,usercnt()-usercount_invisible(),usercount_invisible(),this->CountServs());
2468                 WriteServ(user->fd,"252 %s %d :operator(s) online",user->nick,usercount_opers());
2469                 WriteServ(user->fd,"253 %s %d :unknown connections",user->nick,usercount_unknown());
2470                 WriteServ(user->fd,"254 %s %d :channels formed",user->nick,chancount());
2471                 WriteServ(user->fd,"254 %s :I have %d clients and %d servers",user->nick,local_count(),this->CountLocalServs());
2472                 return;
2473         }
2474
2475         // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
2476
2477         void ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80])
2478         {
2479                 if (line < 128)
2480                 {
2481                         for (int t = 0; t < depth; t++)
2482                         {
2483                                 matrix[line][t] = ' ';
2484                         }
2485
2486                         // For Aligning, we need to work out exactly how deep this thing is, and produce
2487                         // a 'Spacer' String to compensate.
2488                         char spacer[40];
2489
2490                         memset(spacer,' ',40);
2491                         if ((40 - Current->GetName().length() - depth) > 1) {
2492                                 spacer[40 - Current->GetName().length() - depth] = '\0';
2493                         }
2494                         else
2495                         {
2496                                 spacer[5] = '\0';
2497                         }
2498
2499                         float percent;
2500                         char text[80];
2501                         if (clientlist.size() == 0) {
2502                                 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
2503                                 percent = 0;
2504                         }
2505                         else
2506                         {
2507                                 percent = ((float)Current->GetUserCount() / (float)clientlist.size()) * 100;
2508                         }
2509                         snprintf(text, 80, "%s %s%5d [%5.2f%%]", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent);
2510                         strlcpy(&matrix[line][depth],text,80);
2511                         line++;
2512                         for (unsigned int q = 0; q < Current->ChildCount(); q++)
2513                         {
2514                                 ShowMap(Current->GetChild(q),user,depth+2,matrix);
2515                         }
2516                 }
2517         }
2518
2519         // Ok, prepare to be confused.
2520         // After much mulling over how to approach this, it struck me that
2521         // the 'usual' way of doing a /MAP isnt the best way. Instead of
2522         // keeping track of a ton of ascii characters, and line by line
2523         // under recursion working out where to place them using multiplications
2524         // and divisons, we instead render the map onto a backplane of characters
2525         // (a character matrix), then draw the branches as a series of "L" shapes
2526         // from the nodes. This is not only friendlier on CPU it uses less stack.
2527
2528         void HandleMap(char** parameters, int pcnt, userrec* user)
2529         {
2530                 // This array represents a virtual screen which we will
2531                 // "scratch" draw to, as the console device of an irc
2532                 // client does not provide for a proper terminal.
2533                 char matrix[128][80];
2534                 for (unsigned int t = 0; t < 128; t++)
2535                 {
2536                         matrix[t][0] = '\0';
2537                 }
2538                 line = 0;
2539                 // The only recursive bit is called here.
2540                 ShowMap(TreeRoot,user,0,matrix);
2541                 // Process each line one by one. The algorithm has a limit of
2542                 // 128 servers (which is far more than a spanning tree should have
2543                 // anyway, so we're ok). This limit can be raised simply by making
2544                 // the character matrix deeper, 128 rows taking 10k of memory.
2545                 for (int l = 1; l < line; l++)
2546                 {
2547                         // scan across the line looking for the start of the
2548                         // servername (the recursive part of the algorithm has placed
2549                         // the servers at indented positions depending on what they
2550                         // are related to)
2551                         int first_nonspace = 0;
2552                         while (matrix[l][first_nonspace] == ' ')
2553                         {
2554                                 first_nonspace++;
2555                         }
2556                         first_nonspace--;
2557                         // Draw the `- (corner) section: this may be overwritten by
2558                         // another L shape passing along the same vertical pane, becoming
2559                         // a |- (branch) section instead.
2560                         matrix[l][first_nonspace] = '-';
2561                         matrix[l][first_nonspace-1] = '`';
2562                         int l2 = l - 1;
2563                         // Draw upwards until we hit the parent server, causing possibly
2564                         // other corners (`-) to become branches (|-)
2565                         while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
2566                         {
2567                                 matrix[l2][first_nonspace-1] = '|';
2568                                 l2--;
2569                         }
2570                 }
2571                 // dump the whole lot to the user. This is the easy bit, honest.
2572                 for (int t = 0; t < line; t++)
2573                 {
2574                         WriteServ(user->fd,"006 %s :%s",user->nick,&matrix[t][0]);
2575                 }
2576                 WriteServ(user->fd,"007 %s :End of /MAP",user->nick);
2577                 return;
2578         }
2579
2580         int HandleSquit(char** parameters, int pcnt, userrec* user)
2581         {
2582                 TreeServer* s = FindServerMask(parameters[0]);
2583                 if (s)
2584                 {
2585                         if (s == TreeRoot)
2586                         {
2587                                  WriteServ(user->fd,"NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
2588                                 return 1;
2589                         }
2590                         TreeSocket* sock = s->GetSocket();
2591                         if (sock)
2592                         {
2593                                 log(DEBUG,"Splitting server %s",s->GetName().c_str());
2594                                 WriteOpers("*** SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
2595                                 sock->Squit(s,"Server quit by "+std::string(user->nick)+"!"+std::string(user->ident)+"@"+std::string(user->host));
2596                                 sock->Close();
2597                                 Srv->RemoveSocket(sock);
2598                         }
2599                         else
2600                         {
2601                                 WriteServ(user->fd,"NOTICE %s :*** SQUIT: The server \002%s\002 is not directly connected.",user->nick,parameters[0]);
2602                         }
2603                 }
2604                 else
2605                 {
2606                          WriteServ(user->fd,"NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
2607                 }
2608                 return 1;
2609         }
2610
2611         int HandleRemoteWhois(char** parameters, int pcnt, userrec* user)
2612         {
2613                 if ((user->fd > -1) && (pcnt > 1))
2614                 {
2615                         userrec* remote = Srv->FindNick(parameters[1]);
2616                         if ((remote) && (remote->fd < 0))
2617                         {
2618                                 std::deque<std::string> params;
2619                                 params.push_back(parameters[1]);
2620                                 DoOneToOne(user->nick,"IDLE",params,remote->server);
2621                                 return 1;
2622                         }
2623                         else if (!remote)
2624                         {
2625                                 WriteServ(user->fd,"401 %s %s :No such nick/channel",user->nick, parameters[1]);
2626                                 WriteServ(user->fd,"318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
2627                                 return 1;
2628                         }
2629                 }
2630                 return 0;
2631         }
2632
2633         void DoPingChecks(time_t curtime)
2634         {
2635                 for (unsigned int j = 0; j < TreeRoot->ChildCount(); j++)
2636                 {
2637                         TreeServer* serv = TreeRoot->GetChild(j);
2638                         TreeSocket* sock = serv->GetSocket();
2639                         if (sock)
2640                         {
2641                                 if (curtime >= serv->NextPingTime())
2642                                 {               
2643                                         if (serv->AnsweredLastPing())
2644                                         {               
2645                                                 sock->WriteLine(":"+Srv->GetServerName()+" PING "+serv->GetName());
2646                                                 serv->SetNextPingTime(curtime + 120);
2647                                         }                       
2648                                         else            
2649                                         {       
2650                                                 // they didnt answer, boot them
2651                                                 WriteOpers("*** Server \002%s\002 pinged out",serv->GetName().c_str());
2652                                                 sock->Squit(serv,"Ping timeout");
2653                                                 sock->Close();
2654                                                 Srv->RemoveSocket(sock);
2655                                                 return;
2656                                         }
2657                                 }
2658
2659                         }
2660                 }
2661         }
2662
2663         void AutoConnectServers(time_t curtime)
2664         {
2665                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
2666                 {
2667                         if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
2668                         {
2669                                 log(DEBUG,"Auto-Connecting %s",x->Name.c_str());
2670                                 x->NextConnectTime = curtime + x->AutoConnect;
2671                                 TreeServer* CheckDupe = FindServer(x->Name);
2672                                 if (!CheckDupe)
2673                                 {
2674                                         // an autoconnected server is not connected. Check if its time to connect it
2675                                         WriteOpers("*** AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
2676                                         TreeSocket* newsocket = new TreeSocket(x->IPAddr,x->Port,false,10,x->Name);
2677                                         Srv->AddSocket(newsocket);
2678                                 }
2679                         }
2680                 }
2681         }
2682
2683         int HandleVersion(char** parameters, int pcnt, userrec* user)
2684         {
2685                 // we've already checked if pcnt > 0, so this is safe
2686                 TreeServer* found = FindServerMask(parameters[0]);
2687                 if (found)
2688                 {
2689                         std::string Version = found->GetVersion();
2690                         WriteServ(user->fd,"351 %s :%s",user->nick,Version.c_str());
2691                         if (found == TreeRoot)
2692                         {
2693                                 std::stringstream out(Config->data005);
2694                                 std::string token = "";
2695                                 std::string line5 = "";
2696                                 int token_counter = 0;
2697                                 while (!out.eof())
2698                                 {
2699                                         out >> token;
2700                                         line5 = line5 + token + " ";   
2701                                         token_counter++;
2702                                         if ((token_counter >= 13) || (out.eof() == true))
2703                                         {
2704                                                 WriteServ(user->fd,"005 %s %s:are supported by this server",user->nick,line5.c_str());
2705                                                 line5 = "";
2706                                                 token_counter = 0;
2707                                         }
2708                                 }
2709                         }
2710                 }
2711                 else
2712                 {
2713                         WriteServ(user->fd,"402 %s %s :No such server",user->nick,parameters[0]);
2714                 }
2715                 return 1;
2716         }
2717         
2718         int HandleConnect(char** parameters, int pcnt, userrec* user)
2719         {
2720                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
2721                 {
2722                         if (Srv->MatchText(x->Name.c_str(),parameters[0]))
2723                         {
2724                                 TreeServer* CheckDupe = FindServer(x->Name);
2725                                 if (!CheckDupe)
2726                                 {
2727                                         WriteServ(user->fd,"NOTICE %s :*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",user->nick,x->Name.c_str(),x->IPAddr.c_str(),x->Port);
2728                                         TreeSocket* newsocket = new TreeSocket(x->IPAddr,x->Port,false,10,x->Name);
2729                                         Srv->AddSocket(newsocket);
2730                                         return 1;
2731                                 }
2732                                 else
2733                                 {
2734                                         WriteServ(user->fd,"NOTICE %s :*** CONNECT: Server \002%s\002 already exists on the network and is connected via \002%s\002",user->nick,x->Name.c_str(),CheckDupe->GetParent()->GetName().c_str());
2735                                         return 1;
2736                                 }
2737                         }
2738                 }
2739                 WriteServ(user->fd,"NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
2740                 return 1;
2741         }
2742
2743         virtual int OnStats(char statschar, userrec* user)
2744         {
2745                 if (statschar == 'c')
2746                 {
2747                         for (unsigned int i = 0; i < LinkBlocks.size(); i++)
2748                         {
2749                                 WriteServ(user->fd,"213 %s C *@%s * %s %d 0 %c%c%c",user->nick,LinkBlocks[i].IPAddr.c_str(),LinkBlocks[i].Name.c_str(),LinkBlocks[i].Port,(LinkBlocks[i].EncryptionKey != "" ? 'e' : '-'),(LinkBlocks[i].AutoConnect ? 'a' : '-'),'s');
2750                                 WriteServ(user->fd,"244 %s H * * %s",user->nick,LinkBlocks[i].Name.c_str());
2751                         }
2752                         WriteServ(user->fd,"219 %s %c :End of /STATS report",user->nick,statschar);
2753                         WriteOpers("*** Notice: Stats '%c' requested by %s (%s@%s)",statschar,user->nick,user->ident,user->host);
2754                         return 1;
2755                 }
2756                 return 0;
2757         }
2758
2759         virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated)
2760         {
2761                 /* If the command doesnt appear to be valid, we dont want to mess with it. */
2762                 if (!validated)
2763                         return 0;
2764
2765                 if (command == "CONNECT")
2766                 {
2767                         return this->HandleConnect(parameters,pcnt,user);
2768                 }
2769                 else if (command == "SQUIT")
2770                 {
2771                         return this->HandleSquit(parameters,pcnt,user);
2772                 }
2773                 else if (command == "MAP")
2774                 {
2775                         this->HandleMap(parameters,pcnt,user);
2776                         return 1;
2777                 }
2778                 else if (command == "LUSERS")
2779                 {
2780                         this->HandleLusers(parameters,pcnt,user);
2781                         return 1;
2782                 }
2783                 else if (command == "LINKS")
2784                 {
2785                         this->HandleLinks(parameters,pcnt,user);
2786                         return 1;
2787                 }
2788                 else if (command == "WHOIS")
2789                 {
2790                         if (pcnt > 1)
2791                         {
2792                                 // remote whois
2793                                 return this->HandleRemoteWhois(parameters,pcnt,user);
2794                         }
2795                 }
2796                 else if ((command == "VERSION") && (pcnt > 0))
2797                 {
2798                         this->HandleVersion(parameters,pcnt,user);
2799                         return 1;
2800                 }
2801                 else if (Srv->IsValidModuleCommand(command, pcnt, user))
2802                 {
2803                         // this bit of code cleverly routes all module commands
2804                         // to all remote severs *automatically* so that modules
2805                         // can just handle commands locally, without having
2806                         // to have any special provision in place for remote
2807                         // commands and linking protocols.
2808                         std::deque<std::string> params;
2809                         params.clear();
2810                         for (int j = 0; j < pcnt; j++)
2811                         {
2812                                 if (strchr(parameters[j],' '))
2813                                 {
2814                                         params.push_back(":" + std::string(parameters[j]));
2815                                 }
2816                                 else
2817                                 {
2818                                         params.push_back(std::string(parameters[j]));
2819                                 }
2820                         }
2821                         DoOneToMany(user->nick,command,params);
2822                 }
2823                 return 0;
2824         }
2825
2826         virtual void OnGetServerDescription(std::string servername,std::string &description)
2827         {
2828                 TreeServer* s = FindServer(servername);
2829                 if (s)
2830                 {
2831                         description = s->GetDesc();
2832                 }
2833         }
2834
2835         virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
2836         {
2837                 if (source->fd > -1)
2838                 {
2839                         std::deque<std::string> params;
2840                         params.push_back(dest->nick);
2841                         params.push_back(channel->name);
2842                         DoOneToMany(source->nick,"INVITE",params);
2843                 }
2844         }
2845
2846         virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic)
2847         {
2848                 std::deque<std::string> params;
2849                 params.push_back(chan->name);
2850                 params.push_back(":"+topic);
2851                 DoOneToMany(user->nick,"TOPIC",params);
2852         }
2853
2854         virtual void OnWallops(userrec* user, std::string text)
2855         {
2856                 if (user->fd > -1)
2857                 {
2858                         std::deque<std::string> params;
2859                         params.push_back(":"+text);
2860                         DoOneToMany(user->nick,"WALLOPS",params);
2861                 }
2862         }
2863
2864         virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text)
2865         {
2866                 if (target_type == TYPE_USER)
2867                 {
2868                         userrec* d = (userrec*)dest;
2869                         if ((d->fd < 0) && (user->fd > -1))
2870                         {
2871                                 std::deque<std::string> params;
2872                                 params.clear();
2873                                 params.push_back(d->nick);
2874                                 params.push_back(":"+text);
2875                                 DoOneToOne(user->nick,"NOTICE",params,d->server);
2876                         }
2877                 }
2878                 else
2879                 {
2880                         if (user->fd > -1)
2881                         {
2882                                 chanrec *c = (chanrec*)dest;
2883                                 std::deque<TreeServer*> list;
2884                                 GetListOfServersForChannel(c,list);
2885                                 unsigned int ucount = list.size();
2886                                 for (unsigned int i = 0; i < ucount; i++)
2887                                 {
2888                                         TreeSocket* Sock = list[i]->GetSocket();
2889                                         if (Sock)
2890                                                 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+std::string(c->name)+" :"+text);
2891                                 }
2892                         }
2893                 }
2894         }
2895
2896         virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text)
2897         {
2898                 if (target_type == TYPE_USER)
2899                 {
2900                         // route private messages which are targetted at clients only to the server
2901                         // which needs to receive them
2902                         userrec* d = (userrec*)dest;
2903                         if ((d->fd < 0) && (user->fd > -1))
2904                         {
2905                                 std::deque<std::string> params;
2906                                 params.clear();
2907                                 params.push_back(d->nick);
2908                                 params.push_back(":"+text);
2909                                 DoOneToOne(user->nick,"PRIVMSG",params,d->server);
2910                         }
2911                 }
2912                 else
2913                 {
2914                         if (user->fd > -1)
2915                         {
2916                                 chanrec *c = (chanrec*)dest;
2917                                 std::deque<TreeServer*> list;
2918                                 GetListOfServersForChannel(c,list);
2919                                 unsigned int ucount = list.size();
2920                                 for (unsigned int i = 0; i < ucount; i++)
2921                                 {
2922                                         TreeSocket* Sock = list[i]->GetSocket();
2923                                         if (Sock)
2924                                                 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+std::string(c->name)+" :"+text);
2925                                 }
2926                         }
2927                 }
2928         }
2929
2930         virtual void OnBackgroundTimer(time_t curtime)
2931         {
2932                 AutoConnectServers(curtime);
2933                 DoPingChecks(curtime);
2934         }
2935
2936         virtual void OnUserJoin(userrec* user, chanrec* channel)
2937         {
2938                 // Only do this for local users
2939                 if (user->fd > -1)
2940                 {
2941                         std::deque<std::string> params;
2942                         params.clear();
2943                         params.push_back(channel->name);
2944                         if (*channel->key)
2945                         {
2946                                 // if the channel has a key, force the join by emulating the key.
2947                                 params.push_back(channel->key);
2948                         }
2949                         if (channel->GetUserCounter() > 1)
2950                         {
2951                                 // not the first in the channel
2952                                 DoOneToMany(user->nick,"JOIN",params);
2953                         }
2954                         else
2955                         {
2956                                 // first in the channel, set up their permissions
2957                                 // and the channel TS with FJOIN.
2958                                 char ts[24];
2959                                 snprintf(ts,24,"%lu",(unsigned long)channel->age);
2960                                 params.clear();
2961                                 params.push_back(channel->name);
2962                                 params.push_back(ts);
2963                                 params.push_back("@"+std::string(user->nick));
2964                                 DoOneToMany(Srv->GetServerName(),"FJOIN",params);
2965                         }
2966                 }
2967         }
2968
2969         virtual void OnChangeHost(userrec* user, std::string newhost)
2970         {
2971                 // only occurs for local clients
2972                 if (user->registered != 7)
2973                         return;
2974                 std::deque<std::string> params;
2975                 params.push_back(newhost);
2976                 DoOneToMany(user->nick,"FHOST",params);
2977         }
2978
2979         virtual void OnChangeName(userrec* user, std::string gecos)
2980         {
2981                 // only occurs for local clients
2982                 if (user->registered != 7)
2983                         return;
2984                 std::deque<std::string> params;
2985                 params.push_back(gecos);
2986                 DoOneToMany(user->nick,"FNAME",params);
2987         }
2988
2989         virtual void OnUserPart(userrec* user, chanrec* channel)
2990         {
2991                 if (user->fd > -1)
2992                 {
2993                         std::deque<std::string> params;
2994                         params.push_back(channel->name);
2995                         DoOneToMany(user->nick,"PART",params);
2996                 }
2997         }
2998
2999         virtual void OnUserConnect(userrec* user)
3000         {
3001                 char agestr[MAXBUF];
3002                 if (user->fd > -1)
3003                 {
3004                         std::deque<std::string> params;
3005                         snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
3006                         params.push_back(agestr);
3007                         params.push_back(user->nick);
3008                         params.push_back(user->host);
3009                         params.push_back(user->dhost);
3010                         params.push_back(user->ident);
3011                         params.push_back("+"+std::string(user->modes));
3012                         params.push_back(user->ip);
3013                         params.push_back(":"+std::string(user->fullname));
3014                         DoOneToMany(Srv->GetServerName(),"NICK",params);
3015
3016                         // User is Local, change needs to be reflected!
3017                         TreeServer* SourceServer = FindServer(user->server);
3018                         if (SourceServer) {
3019                                 SourceServer->AddUserCount();
3020                         }
3021
3022                 }
3023         }
3024
3025         virtual void OnUserQuit(userrec* user, std::string reason)
3026         {
3027                 if ((user->fd > -1) && (user->registered == 7))
3028                 {
3029                         std::deque<std::string> params;
3030                         params.push_back(":"+reason);
3031                         DoOneToMany(user->nick,"QUIT",params);
3032                 }
3033                 // Regardless, We need to modify the user Counts..
3034                 TreeServer* SourceServer = FindServer(user->server);
3035                 if (SourceServer) {
3036                         SourceServer->DelUserCount();
3037                 }
3038
3039         }
3040
3041         virtual void OnUserPostNick(userrec* user, std::string oldnick)
3042         {
3043                 if (user->fd > -1)
3044                 {
3045                         std::deque<std::string> params;
3046                         params.push_back(user->nick);
3047                         DoOneToMany(oldnick,"NICK",params);
3048                 }
3049         }
3050
3051         virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason)
3052         {
3053                 if (source->fd > -1)
3054                 {
3055                         std::deque<std::string> params;
3056                         params.push_back(chan->name);
3057                         params.push_back(user->nick);
3058                         params.push_back(":"+reason);
3059                         DoOneToMany(source->nick,"KICK",params);
3060                 }
3061         }
3062
3063         virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason)
3064         {
3065                 std::deque<std::string> params;
3066                 params.push_back(dest->nick);
3067                 params.push_back(":"+reason);
3068                 DoOneToMany(source->nick,"KILL",params);
3069         }
3070
3071         virtual void OnRehash(std::string parameter)
3072         {
3073                 if (parameter != "")
3074                 {
3075                         std::deque<std::string> params;
3076                         params.push_back(parameter);
3077                         DoOneToMany(Srv->GetServerName(),"REHASH",params);
3078                         // check for self
3079                         if (Srv->MatchText(Srv->GetServerName(),parameter))
3080                         {
3081                                 Srv->SendOpers("*** Remote rehash initiated from server \002"+Srv->GetServerName()+"\002.");
3082                                 Srv->RehashServer();
3083                         }
3084                 }
3085                 ReadConfiguration(false);
3086         }
3087
3088         // note: the protocol does not allow direct umode +o except
3089         // via NICK with 8 params. sending OPERTYPE infers +o modechange
3090         // locally.
3091         virtual void OnOper(userrec* user, std::string opertype)
3092         {
3093                 if (user->fd > -1)
3094                 {
3095                         std::deque<std::string> params;
3096                         params.push_back(opertype);
3097                         DoOneToMany(user->nick,"OPERTYPE",params);
3098                 }
3099         }
3100
3101         void OnLine(userrec* source, std::string host, bool adding, char linetype, long duration, std::string reason)
3102         {
3103                 if (source->fd > -1)
3104                 {
3105                         char type[8];
3106                         snprintf(type,8,"%cLINE",linetype);
3107                         std::string stype = type;
3108                         if (adding)
3109                         {
3110                                 char sduration[MAXBUF];
3111                                 snprintf(sduration,MAXBUF,"%ld",duration);
3112                                 std::deque<std::string> params;
3113                                 params.push_back(host);
3114                                 params.push_back(sduration);
3115                                 params.push_back(":"+reason);
3116                                 DoOneToMany(source->nick,stype,params);
3117                         }
3118                         else
3119                         {
3120                                 std::deque<std::string> params;
3121                                 params.push_back(host);
3122                                 DoOneToMany(source->nick,stype,params);
3123                         }
3124                 }
3125         }
3126
3127         virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask)
3128         {
3129                 OnLine(source,hostmask,true,'G',duration,reason);
3130         }
3131         
3132         virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask)
3133         {
3134                 OnLine(source,ipmask,true,'Z',duration,reason);
3135         }
3136
3137         virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask)
3138         {
3139                 OnLine(source,nickmask,true,'Q',duration,reason);
3140         }
3141
3142         virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask)
3143         {
3144                 OnLine(source,hostmask,true,'E',duration,reason);
3145         }
3146
3147         virtual void OnDelGLine(userrec* source, std::string hostmask)
3148         {
3149                 OnLine(source,hostmask,false,'G',0,"");
3150         }
3151
3152         virtual void OnDelZLine(userrec* source, std::string ipmask)
3153         {
3154                 OnLine(source,ipmask,false,'Z',0,"");
3155         }
3156
3157         virtual void OnDelQLine(userrec* source, std::string nickmask)
3158         {
3159                 OnLine(source,nickmask,false,'Q',0,"");
3160         }
3161
3162         virtual void OnDelELine(userrec* source, std::string hostmask)
3163         {
3164                 OnLine(source,hostmask,false,'E',0,"");
3165         }
3166
3167         virtual void OnMode(userrec* user, void* dest, int target_type, std::string text)
3168         {
3169                 if ((user->fd > -1) && (user->registered == 7))
3170                 {
3171                         if (target_type == TYPE_USER)
3172                         {
3173                                 userrec* u = (userrec*)dest;
3174                                 std::deque<std::string> params;
3175                                 params.push_back(u->nick);
3176                                 params.push_back(text);
3177                                 DoOneToMany(user->nick,"MODE",params);
3178                         }
3179                         else
3180                         {
3181                                 chanrec* c = (chanrec*)dest;
3182                                 std::deque<std::string> params;
3183                                 params.push_back(c->name);
3184                                 params.push_back(text);
3185                                 DoOneToMany(user->nick,"MODE",params);
3186                         }
3187                 }
3188         }
3189
3190         virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline)
3191         {
3192                 TreeSocket* s = (TreeSocket*)opaque;
3193                 if (target)
3194                 {
3195                         if (target_type == TYPE_USER)
3196                         {
3197                                 userrec* u = (userrec*)target;
3198                                 s->WriteLine(":"+Srv->GetServerName()+" FMODE "+u->nick+" "+modeline);
3199                         }
3200                         else
3201                         {
3202                                 chanrec* c = (chanrec*)target;
3203                                 s->WriteLine(":"+Srv->GetServerName()+" FMODE "+c->name+" "+modeline);
3204                         }
3205                 }
3206         }
3207
3208         virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata)
3209         {
3210                 TreeSocket* s = (TreeSocket*)opaque;
3211                 if (target)
3212                 {
3213                         if (target_type == TYPE_USER)
3214                         {
3215                                 userrec* u = (userrec*)target;
3216                                 s->WriteLine(":"+Srv->GetServerName()+" METADATA "+u->nick+" "+extname+" :"+extdata);
3217                         }
3218                         else
3219                         {
3220                                 chanrec* c = (chanrec*)target;
3221                                 s->WriteLine(":"+Srv->GetServerName()+" METADATA "+c->name+" "+extname+" :"+extdata);
3222                         }
3223                 }
3224         }
3225
3226         virtual ~ModuleSpanningTree()
3227         {
3228         }
3229
3230         virtual Version GetVersion()
3231         {
3232                 return Version(1,0,0,0,VF_STATIC|VF_VENDOR);
3233         }
3234
3235         void Implements(char* List)
3236         {
3237                 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
3238                 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
3239                 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
3240                 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
3241                 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
3242                 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
3243                 List[I_OnStats] = List[I_ProtoSendMetaData] = 1;
3244         }
3245
3246         /* It is IMPORTANT that m_spanningtree is the last module in the chain
3247          * so that any activity it sees is FINAL, e.g. we arent going to send out
3248          * a NICK message before m_cloaking has finished putting the +x on the user,
3249          * etc etc.
3250          * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
3251          * the module call queue.
3252          */
3253         Priority Prioritize()
3254         {
3255                 return PRIORITY_LAST;
3256         }
3257 };
3258
3259
3260 class ModuleSpanningTreeFactory : public ModuleFactory
3261 {
3262  public:
3263         ModuleSpanningTreeFactory()
3264         {
3265         }
3266         
3267         ~ModuleSpanningTreeFactory()
3268         {
3269         }
3270         
3271         virtual Module * CreateModule(Server* Me)
3272         {
3273                 TreeProtocolModule = new ModuleSpanningTree(Me);
3274                 return TreeProtocolModule;
3275         }
3276         
3277 };
3278
3279
3280 extern "C" void * init_module( void )
3281 {
3282         return new ModuleSpanningTreeFactory;
3283 }