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