]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/modules/m_spanningtree.cpp
fd3673ccbf0d5789eaf436061c205fe8dbb5601b
[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                 params[7] = ":" + params[7];
940                 DoOneToAllButSender(source,"NICK",params,source);
941                 return true;
942         }
943
944         /* Send one or more FJOINs for a channel of users.
945          * If the length of a single line is more than 480-NICKMAX
946          * in length, it is split over multiple lines.
947          */
948         void SendFJoins(TreeServer* Current, chanrec* c)
949         {
950                 char list[MAXBUF];
951                 snprintf(list,MAXBUF,":%s FJOIN %s %lu",Srv->GetServerName().c_str(),c->name,(unsigned long)c->age);
952                 std::vector<char*> *ulist = c->GetUsers();
953                 for (unsigned int i = 0; i < ulist->size(); i++)
954                 {
955                         char* o = (*ulist)[i];
956                         userrec* otheruser = (userrec*)o;
957                         strlcat(list," ",MAXBUF);
958                         strlcat(list,cmode(otheruser,c),MAXBUF);
959                         strlcat(list,otheruser->nick,MAXBUF);
960                         if (strlen(list)>(480-NICKMAX))
961                         {
962                                 this->WriteLine(list);
963                                 snprintf(list,MAXBUF,":%s FJOIN %s %lu",Srv->GetServerName().c_str(),c->name,(unsigned long)c->age);
964                         }
965                 }
966                 if (list[strlen(list)-1] != ':')
967                 {
968                         this->WriteLine(list);
969                 }
970         }
971
972         /* Send G, Q, Z and E lines */
973         void SendXLines(TreeServer* Current)
974         {
975                 char data[MAXBUF];
976                 /* Yes, these arent too nice looking, but they get the job done */
977                 for (std::vector<ZLine>::iterator i = zlines.begin(); i != zlines.end(); i++)
978                 {
979                         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);
980                         this->WriteLine(data);
981                 }
982                 for (std::vector<QLine>::iterator i = qlines.begin(); i != qlines.end(); i++)
983                 {
984                         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);
985                         this->WriteLine(data);
986                 }
987                 for (std::vector<GLine>::iterator i = glines.begin(); i != glines.end(); i++)
988                 {
989                         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);
990                         this->WriteLine(data);
991                 }
992                 for (std::vector<ELine>::iterator i = elines.begin(); i != elines.end(); i++)
993                 {
994                         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);
995                         this->WriteLine(data);
996                 }
997         }
998
999         /* Send channel modes and topics */
1000         void SendChannelModes(TreeServer* Current)
1001         {
1002                 char data[MAXBUF];
1003                 for (chan_hash::iterator c = chanlist.begin(); c != chanlist.end(); c++)
1004                 {
1005                         SendFJoins(Current, c->second);
1006                         snprintf(data,MAXBUF,":%s FMODE %s +%s",Srv->GetServerName().c_str(),c->second->name,chanmodes(c->second));
1007                         this->WriteLine(data);
1008                         if (*c->second->topic)
1009                         {
1010                                 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);
1011                                 this->WriteLine(data);
1012                         }
1013                         for (BanList::iterator b = c->second->bans.begin(); b != c->second->bans.end(); b++)
1014                         {
1015                                 snprintf(data,MAXBUF,":%s FMODE %s +b %s",Srv->GetServerName().c_str(),c->second->name,b->data);
1016                                 this->WriteLine(data);
1017                         }
1018                         FOREACH_MOD OnSyncChannel(c->second,(Module*)TreeProtocolModule,(void*)this);
1019                 }
1020         }
1021
1022         /* send all users and their oper state/modes */
1023         void SendUsers(TreeServer* Current)
1024         {
1025                 char data[MAXBUF];
1026                 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
1027                 {
1028                         if (u->second->registered == 7)
1029                         {
1030                                 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);
1031                                 this->WriteLine(data);
1032                                 if (strchr(u->second->modes,'o'))
1033                                 {
1034                                         this->WriteLine(":"+std::string(u->second->nick)+" OPERTYPE "+std::string(u->second->oper));
1035                                 }
1036                                 //char* chl = chlist(u->second,u->second);
1037                                 //if (*chl)
1038                                 //{
1039                                 //      this->WriteLine(":"+std::string(u->second->nick)+" FJOIN "+std::string(chl));
1040                                 //}
1041                                 FOREACH_MOD OnSyncUser(u->second,(Module*)TreeProtocolModule,(void*)this);
1042                         }
1043                 }
1044         }
1045
1046         /* This function is called when we want to send a netburst to a local
1047          * server. There is a set order we must do this, because for example
1048          * users require their servers to exist, and channels require their
1049          * users to exist. You get the idea.
1050          */
1051         void DoBurst(TreeServer* s)
1052         {
1053                 Srv->SendOpers("*** Bursting to \2"+s->GetName()+"\2.");
1054                 this->WriteLine("BURST");
1055                 /* send our version string */
1056                 this->WriteLine(":"+Srv->GetServerName()+" VERSION :"+GetVersionString());
1057                 /* Send server tree */
1058                 this->SendServers(TreeRoot,s,1);
1059                 /* Send users and their oper status */
1060                 this->SendUsers(s);
1061                 /* Send everything else (channel modes, xlines etc) */
1062                 this->SendChannelModes(s);
1063                 this->SendXLines(s);
1064                 this->WriteLine("ENDBURST");
1065                 Srv->SendOpers("*** Finished bursting to \2"+s->GetName()+"\2.");
1066         }
1067
1068         /* This function is called when we receive data from a remote
1069          * server. We buffer the data in a std::string (it doesnt stay
1070          * there for long), reading using InspSocket::Read() which can
1071          * read up to 16 kilobytes in one operation.
1072          *
1073          * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
1074          * THE SOCKET OBJECT FOR US.
1075          */
1076         virtual bool OnDataReady()
1077         {
1078                 char* data = this->Read();
1079                 if (data)
1080                 {
1081                         this->in_buffer += data;
1082                         /* While there is at least one new line in the buffer,
1083                          * do something useful (we hope!) with it.
1084                          */
1085                         while (in_buffer.find("\n") != std::string::npos)
1086                         {
1087                                 char* line = (char*)in_buffer.c_str();
1088                                 std::string ret = "";
1089                                 while ((*line != '\n') && (strlen(line)))
1090                                 {
1091                                         ret = ret + *line;
1092                                         line++;
1093                                 }
1094                                 if ((*line == '\n') || (*line == '\r'))
1095                                         line++;
1096                                 in_buffer = line;
1097                                 /* Process this one, abort if it
1098                                  * didnt return true.
1099                                  */
1100                                 if (!this->ProcessLine(ret))
1101                                 {
1102                                         return false;
1103                                 }
1104                         }
1105                 }
1106                 return (data != NULL);
1107         }
1108
1109         int WriteLine(std::string line)
1110         {
1111                 return this->Write(line + "\r\n");
1112         }
1113
1114         /* Handle ERROR command */
1115         bool Error(std::deque<std::string> params)
1116         {
1117                 if (params.size() < 1)
1118                         return false;
1119                 std::string Errmsg = params[0];
1120                 std::string SName = myhost;
1121                 if (InboundServerName != "")
1122                 {
1123                         SName = InboundServerName;
1124                 }
1125                 Srv->SendOpers("*** ERROR from "+SName+": "+Errmsg);
1126                 /* we will return false to cause the socket to close.
1127                  */
1128                 return false;
1129         }
1130
1131         /* Because the core won't let users or even SERVERS set +o,
1132          * we use the OPERTYPE command to do this.
1133          */
1134         bool OperType(std::string prefix, std::deque<std::string> params)
1135         {
1136                 if (params.size() != 1)
1137                         return true;
1138                 std::string opertype = params[0];
1139                 userrec* u = Srv->FindNick(prefix);
1140                 if (u)
1141                 {
1142                         strlcpy(u->oper,opertype.c_str(),NICKMAX);
1143                         if (!strchr(u->modes,'o'))
1144                         {
1145                                 strcat(u->modes,"o");
1146                         }
1147                         DoOneToAllButSender(u->nick,"OPERTYPE",params,u->server);
1148                 }
1149                 return true;
1150         }
1151
1152         /* Because Andy insists that services-compatible servers must
1153          * implement SVSNICK and SVSJOIN, that's exactly what we do :p
1154          */
1155         bool ForceNick(std::string prefix, std::deque<std::string> params)
1156         {
1157                 if (params.size() < 3)
1158                         return true;
1159                 userrec* u = Srv->FindNick(params[0]);
1160                 if (u)
1161                 {
1162                         Srv->ChangeUserNick(u,params[1]);
1163                         u->age = atoi(params[2].c_str());
1164                         DoOneToAllButSender(prefix,"SVSNICK",params,prefix);
1165                 }
1166                 return true;
1167         }
1168
1169         bool ServiceJoin(std::string prefix, std::deque<std::string> params)
1170         {
1171                 if (params.size() < 2)
1172                         return true;
1173                 userrec* u = Srv->FindNick(params[0]);
1174                 if (u)
1175                 {
1176                         Srv->JoinUserToChannel(u,params[1],"");
1177                         DoOneToAllButSender(prefix,"SVSJOIN",params,prefix);
1178                 }
1179                 return true;
1180         }
1181
1182         bool RemoteRehash(std::string prefix, std::deque<std::string> params)
1183         {
1184                 if (params.size() < 1)
1185                         return true;
1186                 std::string servermask = params[0];
1187                 if (Srv->MatchText(Srv->GetServerName(),servermask))
1188                 {
1189                         Srv->SendOpers("*** Remote rehash initiated from server \002"+prefix+"\002.");
1190                         Srv->RehashServer();
1191                         ReadConfiguration(false);
1192                 }
1193                 DoOneToAllButSender(prefix,"REHASH",params,prefix);
1194                 return true;
1195         }
1196
1197         bool RemoteKill(std::string prefix, std::deque<std::string> params)
1198         {
1199                 if (params.size() != 2)
1200                         return true;
1201                 std::string nick = params[0];
1202                 std::string reason = params[1];
1203                 userrec* u = Srv->FindNick(prefix);
1204                 userrec* who = Srv->FindNick(nick);
1205                 if (who)
1206                 {
1207                         /* Append kill source, if we don't have one */
1208                         if (*(params[1].c_str()) != '[')
1209                         {
1210                                 params[1] = "[" + std::string(u->server) + "] Killed (" + params[1] +")";
1211                         }
1212                         std::string sourceserv = prefix;
1213                         if (u)
1214                         {
1215                                 sourceserv = u->server;
1216                         }
1217                         params[1] = ":" + params[1];
1218                         DoOneToAllButSender(prefix,"KILL",params,sourceserv);
1219                         Srv->QuitUser(who,reason);
1220                 }
1221                 return true;
1222         }
1223
1224         bool LocalPong(std::string prefix, std::deque<std::string> params)
1225         {
1226                 if (params.size() < 1)
1227                         return true;
1228                 TreeServer* ServerSource = FindServer(prefix);
1229                 if (ServerSource)
1230                 {
1231                         ServerSource->SetPingFlag();
1232                 }
1233                 return true;
1234         }
1235
1236         bool ServerVersion(std::string prefix, std::deque<std::string> params)
1237         {
1238                 if (params.size() < 1)
1239                         return true;
1240                 TreeServer* ServerSource = FindServer(prefix);
1241                 if (ServerSource)
1242                 {
1243                         ServerSource->SetVersion(params[0]);
1244                 }
1245                 params[0] = ":" + params[0];
1246                 DoOneToAllButSender(prefix,"VERSION",params,prefix);
1247                 return true;
1248         }
1249
1250         bool ChangeHost(std::string prefix, std::deque<std::string> params)
1251         {
1252                 if (params.size() < 1)
1253                         return true;
1254                 userrec* u = Srv->FindNick(prefix);
1255                 if (u)
1256                 {
1257                         Srv->ChangeHost(u,params[0]);
1258                         DoOneToAllButSender(prefix,"FHOST",params,u->server);
1259                 }
1260                 return true;
1261         }
1262
1263         bool AddLine(std::string prefix, std::deque<std::string> params)
1264         {
1265                 if (params.size() < 6)
1266                         return true;
1267                 std::string linetype = params[0]; /* Z, Q, E, G, K */
1268                 std::string mask = params[1]; /* Line type dependent */
1269                 std::string source = params[2]; /* may not be online or may be a server */
1270                 std::string settime = params[3]; /* EPOCH time set */
1271                 std::string duration = params[4]; /* Duration secs */
1272                 std::string reason = params[5];
1273
1274                 switch (*(linetype.c_str()))
1275                 {
1276                         case 'Z':
1277                                 add_zline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1278                         break;
1279                         case 'Q':
1280                                 add_qline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1281                         break;
1282                         case 'E':
1283                                 add_eline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1284                         break;
1285                         case 'G':
1286                                 add_gline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1287                         break;
1288                         case 'K':
1289                                 add_kline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1290                         break;
1291                         default:
1292                                 /* Just in case... */
1293                                 Srv->SendOpers("*** \2WARNING\2: Invalid xline type '"+linetype+"' sent by server "+prefix+", ignored!");
1294                         break;
1295                 }
1296                 /* Send it on its way */
1297                 params[5] = ":" + params[5];
1298                 DoOneToAllButSender(prefix,"ADDLINE",params,prefix);
1299                 return true;
1300         }
1301
1302         bool ChangeName(std::string prefix, std::deque<std::string> params)
1303         {
1304                 if (params.size() < 1)
1305                         return true;
1306                 userrec* u = Srv->FindNick(prefix);
1307                 if (u)
1308                 {
1309                         Srv->ChangeGECOS(u,params[0]);
1310                         params[0] = ":" + params[0];
1311                         DoOneToAllButSender(prefix,"FNAME",params,u->server);
1312                 }
1313                 return true;
1314         }
1315         
1316         bool LocalPing(std::string prefix, std::deque<std::string> params)
1317         {
1318                 if (params.size() < 1)
1319                         return true;
1320                 std::string stufftobounce = params[0];
1321                 this->WriteLine(":"+Srv->GetServerName()+" PONG "+stufftobounce);
1322                 return true;
1323         }
1324
1325         bool RemoteServer(std::string prefix, std::deque<std::string> params)
1326         {
1327                 if (params.size() < 4)
1328                         return false;
1329                 std::string servername = params[0];
1330                 std::string password = params[1];
1331                 // hopcount is not used for a remote server, we calculate this ourselves
1332                 std::string description = params[3];
1333                 TreeServer* ParentOfThis = FindServer(prefix);
1334                 if (!ParentOfThis)
1335                 {
1336                         this->WriteLine("ERROR :Protocol error - Introduced remote server from unknown server "+prefix);
1337                         return false;
1338                 }
1339                 TreeServer* CheckDupe = FindServer(servername);
1340                 if (CheckDupe)
1341                 {
1342                         this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1343                         return false;
1344                 }
1345                 TreeServer* Node = new TreeServer(servername,description,ParentOfThis,NULL);
1346                 ParentOfThis->AddChild(Node);
1347                 params[3] = ":" + params[3];
1348                 DoOneToAllButSender(prefix,"SERVER",params,prefix);
1349                 Srv->SendOpers("*** Server \002"+prefix+"\002 introduced server \002"+servername+"\002 ("+description+")");
1350                 return true;
1351         }
1352
1353         bool Outbound_Reply_Server(std::deque<std::string> params)
1354         {
1355                 if (params.size() < 4)
1356                         return false;
1357                 std::string servername = params[0];
1358                 std::string password = params[1];
1359                 int hops = atoi(params[2].c_str());
1360                 if (hops)
1361                 {
1362                         this->WriteLine("ERROR :Server too far away for authentication");
1363                         return false;
1364                 }
1365                 std::string description = params[3];
1366                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1367                 {
1368                         if ((x->Name == servername) && (x->RecvPass == password))
1369                         {
1370                                 TreeServer* CheckDupe = FindServer(servername);
1371                                 if (CheckDupe)
1372                                 {
1373                                         this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1374                                         return false;
1375                                 }
1376                                 // Begin the sync here. this kickstarts the
1377                                 // other side, waiting in WAIT_AUTH_2 state,
1378                                 // into starting their burst, as it shows
1379                                 // that we're happy.
1380                                 this->LinkState = CONNECTED;
1381                                 // we should add the details of this server now
1382                                 // to the servers tree, as a child of the root
1383                                 // node.
1384                                 TreeServer* Node = new TreeServer(servername,description,TreeRoot,this);
1385                                 TreeRoot->AddChild(Node);
1386                                 params[3] = ":" + params[3];
1387                                 DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,servername);
1388                                 this->DoBurst(Node);
1389                                 return true;
1390                         }
1391                 }
1392                 this->WriteLine("ERROR :Invalid credentials");
1393                 return false;
1394         }
1395
1396         bool Inbound_Server(std::deque<std::string> params)
1397         {
1398                 if (params.size() < 4)
1399                         return false;
1400                 std::string servername = params[0];
1401                 std::string password = params[1];
1402                 int hops = atoi(params[2].c_str());
1403                 if (hops)
1404                 {
1405                         this->WriteLine("ERROR :Server too far away for authentication");
1406                         return false;
1407                 }
1408                 std::string description = params[3];
1409                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1410                 {
1411                         if ((x->Name == servername) && (x->RecvPass == password))
1412                         {
1413                                 TreeServer* CheckDupe = FindServer(servername);
1414                                 if (CheckDupe)
1415                                 {
1416                                         this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1417                                         return false;
1418                                 }
1419                                 Srv->SendOpers("*** Verified incoming server connection from \002"+servername+"\002["+this->GetIP()+"] ("+description+")");
1420                                 this->InboundServerName = servername;
1421                                 this->InboundDescription = description;
1422                                 // this is good. Send our details: Our server name and description and hopcount of 0,
1423                                 // along with the sendpass from this block.
1424                                 this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
1425                                 // move to the next state, we are now waiting for THEM.
1426                                 this->LinkState = WAIT_AUTH_2;
1427                                 return true;
1428                         }
1429                 }
1430                 this->WriteLine("ERROR :Invalid credentials");
1431                 return false;
1432         }
1433
1434         std::deque<std::string> Split(std::string line, bool stripcolon)
1435         {
1436                 std::deque<std::string> n;
1437                 if (!strchr(line.c_str(),' '))
1438                 {
1439                         n.push_back(line);
1440                         return n;
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 n;
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 = this->Split(line,true);
1495                 std::string command = "";
1496                 std::string prefix = "";
1497                 if (((params[0].c_str())[0] == ':') && (params.size() > 1))
1498                 {
1499                         prefix = params[0];
1500                         command = params[1];
1501                         char* pref = (char*)prefix.c_str();
1502                         prefix = ++pref;
1503                         params.pop_front();
1504                         params.pop_front();
1505                 }
1506                 else
1507                 {
1508                         prefix = "";
1509                         command = params[0];
1510                         params.pop_front();
1511                 }
1512                 
1513                 switch (this->LinkState)
1514                 {
1515                         TreeServer* Node;
1516                         
1517                         case WAIT_AUTH_1:
1518                                 // Waiting for SERVER command from remote server. Server initiating
1519                                 // the connection sends the first SERVER command, listening server
1520                                 // replies with theirs if its happy, then if the initiator is happy,
1521                                 // it starts to send its net sync, which starts the merge, otherwise
1522                                 // it sends an ERROR.
1523                                 if (command == "SERVER")
1524                                 {
1525                                         return this->Inbound_Server(params);
1526                                 }
1527                                 else if (command == "ERROR")
1528                                 {
1529                                         return this->Error(params);
1530                                 }
1531                         break;
1532                         case WAIT_AUTH_2:
1533                                 // Waiting for start of other side's netmerge to say they liked our
1534                                 // password.
1535                                 if (command == "SERVER")
1536                                 {
1537                                         // cant do this, they sent it to us in the WAIT_AUTH_1 state!
1538                                         // silently ignore.
1539                                         return true;
1540                                 }
1541                                 else if (command == "BURST")
1542                                 {
1543                                         this->LinkState = CONNECTED;
1544                                         Node = new TreeServer(InboundServerName,InboundDescription,TreeRoot,this);
1545                                         TreeRoot->AddChild(Node);
1546                                         params.clear();
1547                                         params.push_back(InboundServerName);
1548                                         params.push_back("*");
1549                                         params.push_back("1");
1550                                         params.push_back(":"+InboundDescription);
1551                                         DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,InboundServerName);
1552                                         this->DoBurst(Node);
1553                                 }
1554                                 else if (command == "ERROR")
1555                                 {
1556                                         return this->Error(params);
1557                                 }
1558                                 
1559                         break;
1560                         case LISTENER:
1561                                 this->WriteLine("ERROR :Internal error -- listening socket accepted its own descriptor!!!");
1562                                 return false;
1563                         break;
1564                         case CONNECTING:
1565                                 if (command == "SERVER")
1566                                 {
1567                                         // another server we connected to, which was in WAIT_AUTH_1 state,
1568                                         // has just sent us their credentials. If we get this far, theyre
1569                                         // happy with OUR credentials, and they are now in WAIT_AUTH_2 state.
1570                                         // if we're happy with this, we should send our netburst which
1571                                         // kickstarts the merge.
1572                                         return this->Outbound_Reply_Server(params);
1573                                 }
1574                                 else if (command == "ERROR")
1575                                 {
1576                                         return this->Error(params);
1577                                 }
1578                         break;
1579                         case CONNECTED:
1580                                 // This is the 'authenticated' state, when all passwords
1581                                 // have been exchanged and anything past this point is taken
1582                                 // as gospel.
1583                                 if (command == "SVSMODE")
1584                                 {
1585                                         /* Services expects us to implement
1586                                          * SVSMODE. In inspircd its the same as
1587                                          * MODE anyway.
1588                                          */
1589                                         command = "MODE";
1590                                 }
1591                                 std::string target = "";
1592                                 /* Yes, know, this is a mess. Its reasonably fast though as we're
1593                                  * working with std::string here.
1594                                  */
1595                                 if ((command == "NICK") && (params.size() > 1))
1596                                 {
1597                                         return this->IntroduceClient(prefix,params);
1598                                 }
1599                                 else if (command == "FJOIN")
1600                                 {
1601                                         return this->ForceJoin(prefix,params);
1602                                 }
1603                                 else if (command == "SERVER")
1604                                 {
1605                                         return this->RemoteServer(prefix,params);
1606                                 }
1607                                 else if (command == "ERROR")
1608                                 {
1609                                         return this->Error(params);
1610                                 }
1611                                 else if (command == "OPERTYPE")
1612                                 {
1613                                         return this->OperType(prefix,params);
1614                                 }
1615                                 else if (command == "FMODE")
1616                                 {
1617                                         return this->ForceMode(prefix,params);
1618                                 }
1619                                 else if (command == "KILL")
1620                                 {
1621                                         return this->RemoteKill(prefix,params);
1622                                 }
1623                                 else if (command == "FTOPIC")
1624                                 {
1625                                         return this->ForceTopic(prefix,params);
1626                                 }
1627                                 else if (command == "REHASH")
1628                                 {
1629                                         return this->RemoteRehash(prefix,params);
1630                                 }
1631                                 else if (command == "PING")
1632                                 {
1633                                         return this->LocalPing(prefix,params);
1634                                 }
1635                                 else if (command == "PONG")
1636                                 {
1637                                         return this->LocalPong(prefix,params);
1638                                 }
1639                                 else if (command == "VERSION")
1640                                 {
1641                                         return this->ServerVersion(prefix,params);
1642                                 }
1643                                 else if (command == "FHOST")
1644                                 {
1645                                         return this->ChangeHost(prefix,params);
1646                                 }
1647                                 else if (command == "FNAME")
1648                                 {
1649                                         return this->ChangeName(prefix,params);
1650                                 }
1651                                 else if (command == "ADDLINE")
1652                                 {
1653                                         return this->AddLine(prefix,params);
1654                                 }
1655                                 else if (command == "SVSNICK")
1656                                 {
1657                                         if (prefix == "")
1658                                         {
1659                                                 prefix = this->GetName();
1660                                         }
1661                                         return this->ForceNick(prefix,params);
1662                                 }
1663                                 else if (command == "SVSJOIN")
1664                                 {
1665                                         if (prefix == "")
1666                                         {
1667                                                 prefix = this->GetName();
1668                                         }
1669                                         return this->ServiceJoin(prefix,params);
1670                                 }
1671                                 else if (command == "SQUIT")
1672                                 {
1673                                         if (params.size() == 2)
1674                                         {
1675                                                 this->Squit(FindServer(params[0]),params[1]);
1676                                         }
1677                                         return true;
1678                                 }
1679                                 else
1680                                 {
1681                                         // not a special inter-server command.
1682                                         // Emulate the actual user doing the command,
1683                                         // this saves us having a huge ugly parser.
1684                                         userrec* who = Srv->FindNick(prefix);
1685                                         std::string sourceserv = this->myhost;
1686                                         if (this->InboundServerName != "")
1687                                         {
1688                                                 sourceserv = this->InboundServerName;
1689                                         }
1690                                         if (who)
1691                                         {
1692                                                 // its a user
1693                                                 target = who->server;
1694                                                 char* strparams[127];
1695                                                 for (unsigned int q = 0; q < params.size(); q++)
1696                                                 {
1697                                                         strparams[q] = (char*)params[q].c_str();
1698                                                 }
1699                                                 Srv->CallCommandHandler(command, strparams, params.size(), who);
1700                                         }
1701                                         else
1702                                         {
1703                                                 // its not a user. Its either a server, or somethings screwed up.
1704                                                 if (IsServer(prefix))
1705                                                 {
1706                                                         target = Srv->GetServerName();
1707                                                 }
1708                                                 else
1709                                                 {
1710                                                         log(DEBUG,"Command with unknown origin '%s'",prefix.c_str());
1711                                                         return true;
1712                                                 }
1713                                         }
1714                                         return DoOneToAllButSenderRaw(line,sourceserv,prefix,command,params);
1715
1716                                 }
1717                                 return true;
1718                         break;
1719                 }
1720                 return true;
1721         }
1722
1723         virtual std::string GetName()
1724         {
1725                 std::string sourceserv = this->myhost;
1726                 if (this->InboundServerName != "")
1727                 {
1728                         sourceserv = this->InboundServerName;
1729                 }
1730                 return sourceserv;
1731         }
1732
1733         virtual void OnTimeout()
1734         {
1735                 if (this->LinkState == CONNECTING)
1736                 {
1737                         Srv->SendOpers("*** CONNECT: Connection to \002"+myhost+"\002 timed out.");
1738                 }
1739         }
1740
1741         virtual void OnClose()
1742         {
1743                 // Connection closed.
1744                 // If the connection is fully up (state CONNECTED)
1745                 // then propogate a netsplit to all peers.
1746                 std::string quitserver = this->myhost;
1747                 if (this->InboundServerName != "")
1748                 {
1749                         quitserver = this->InboundServerName;
1750                 }
1751                 TreeServer* s = FindServer(quitserver);
1752                 if (s)
1753                 {
1754                         Squit(s,"Remote host closed the connection");
1755                 }
1756         }
1757
1758         virtual int OnIncomingConnection(int newsock, char* ip)
1759         {
1760                 TreeSocket* s = new TreeSocket(newsock, ip);
1761                 Srv->AddSocket(s);
1762                 return true;
1763         }
1764 };
1765
1766 void AddThisServer(TreeServer* server, std::deque<TreeServer*> &list)
1767 {
1768         for (unsigned int c = 0; c < list.size(); c++)
1769         {
1770                 if (list[c] == server)
1771                 {
1772                         return;
1773                 }
1774         }
1775         list.push_back(server);
1776 }
1777
1778 // returns a list of DIRECT servernames for a specific channel
1779 void GetListOfServersForChannel(chanrec* c, std::deque<TreeServer*> &list)
1780 {
1781         std::vector<char*> *ulist = c->GetUsers();
1782         unsigned int ucount = ulist->size();
1783         for (unsigned int i = 0; i < ucount; i++)
1784         {
1785                 char* o = (*ulist)[i];
1786                 userrec* otheruser = (userrec*)o;
1787                 if (std::string(otheruser->server) != Srv->GetServerName())
1788                 {
1789                         TreeServer* best = BestRouteTo(otheruser->server);
1790                         if (best)
1791                                 AddThisServer(best,list);
1792                 }
1793         }
1794         return;
1795 }
1796
1797 bool DoOneToAllButSenderRaw(std::string data,std::string omit,std::string prefix,std::string command,std::deque<std::string> params)
1798 {
1799         TreeServer* omitroute = BestRouteTo(omit);
1800         if ((command == "NOTICE") || (command == "PRIVMSG"))
1801         {
1802                 if ((params.size() >= 2) && (*(params[0].c_str()) != '$'))
1803                 {
1804                         if (*(params[0].c_str()) != '#')
1805                         {
1806                                 // special routing for private messages/notices
1807                                 userrec* d = Srv->FindNick(params[0]);
1808                                 if (d)
1809                                 {
1810                                         std::deque<std::string> par;
1811                                         par.push_back(params[0]);
1812                                         par.push_back(":"+params[1]);
1813                                         DoOneToOne(prefix,command,par,d->server);
1814                                         return true;
1815                                 }
1816                         }
1817                         else
1818                         {
1819                                 log(DEBUG,"Channel privmsg going to chan %s",params[0].c_str());
1820                                 chanrec* c = Srv->FindChannel(params[0]);
1821                                 if (c)
1822                                 {
1823                                         std::deque<TreeServer*> list;
1824                                         GetListOfServersForChannel(c,list);
1825                                         log(DEBUG,"Got a list of %d servers",list.size());
1826                                         unsigned int lsize = list.size();
1827                                         for (unsigned int i = 0; i < lsize; i++)
1828                                         {
1829                                                 TreeSocket* Sock = list[i]->GetSocket();
1830                                                 if ((Sock) && (list[i]->GetName() != omit) && (omitroute != list[i]))
1831                                                 {
1832                                                         log(DEBUG,"Writing privmsg to server %s",list[i]->GetName().c_str());
1833                                                         Sock->WriteLine(data);
1834                                                 }
1835                                         }
1836                                         return true;
1837                                 }
1838                         }
1839                 }
1840         }
1841         unsigned int items = TreeRoot->ChildCount();
1842         for (unsigned int x = 0; x < items; x++)
1843         {
1844                 TreeServer* Route = TreeRoot->GetChild(x);
1845                 if ((Route->GetSocket()) && (Route->GetName() != omit) && (omitroute != Route))
1846                 {
1847                         TreeSocket* Sock = Route->GetSocket();
1848                         Sock->WriteLine(data);
1849                 }
1850         }
1851         return true;
1852 }
1853
1854 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> params, std::string omit)
1855 {
1856         TreeServer* omitroute = BestRouteTo(omit);
1857         std::string FullLine = ":" + prefix + " " + command;
1858         unsigned int words = params.size();
1859         for (unsigned int x = 0; x < words; x++)
1860         {
1861                 FullLine = FullLine + " " + params[x];
1862         }
1863         unsigned int items = TreeRoot->ChildCount();
1864         for (unsigned int x = 0; x < items; x++)
1865         {
1866                 TreeServer* Route = TreeRoot->GetChild(x);
1867                 // Send the line IF:
1868                 // The route has a socket (its a direct connection)
1869                 // The route isnt the one to be omitted
1870                 // The route isnt the path to the one to be omitted
1871                 if ((Route->GetSocket()) && (Route->GetName() != omit) && (omitroute != Route))
1872                 {
1873                         TreeSocket* Sock = Route->GetSocket();
1874                         Sock->WriteLine(FullLine);
1875                 }
1876         }
1877         return true;
1878 }
1879
1880 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> params)
1881 {
1882         std::string FullLine = ":" + prefix + " " + command;
1883         unsigned int words = params.size();
1884         for (unsigned int x = 0; x < words; x++)
1885         {
1886                 FullLine = FullLine + " " + params[x];
1887         }
1888         unsigned int items = TreeRoot->ChildCount();
1889         for (unsigned int x = 0; x < items; x++)
1890         {
1891                 TreeServer* Route = TreeRoot->GetChild(x);
1892                 if (Route->GetSocket())
1893                 {
1894                         TreeSocket* Sock = Route->GetSocket();
1895                         Sock->WriteLine(FullLine);
1896                 }
1897         }
1898         return true;
1899 }
1900
1901 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> params, std::string target)
1902 {
1903         TreeServer* Route = BestRouteTo(target);
1904         if (Route)
1905         {
1906                 std::string FullLine = ":" + prefix + " " + command;
1907                 unsigned int words = params.size();
1908                 for (unsigned int x = 0; x < words; x++)
1909                 {
1910                         FullLine = FullLine + " " + params[x];
1911                 }
1912                 if (Route->GetSocket())
1913                 {
1914                         TreeSocket* Sock = Route->GetSocket();
1915                         Sock->WriteLine(FullLine);
1916                 }
1917                 return true;
1918         }
1919         else
1920         {
1921                 return true;
1922         }
1923 }
1924
1925 std::vector<TreeSocket*> Bindings;
1926
1927 void ReadConfiguration(bool rebind)
1928 {
1929         if (rebind)
1930         {
1931                 for (int j =0; j < Conf->Enumerate("bind"); j++)
1932                 {
1933                         std::string Type = Conf->ReadValue("bind","type",j);
1934                         std::string IP = Conf->ReadValue("bind","address",j);
1935                         long Port = Conf->ReadInteger("bind","port",j,true);
1936                         if (Type == "servers")
1937                         {
1938                                 if (IP == "*")
1939                                 {
1940                                         IP = "";
1941                                 }
1942                                 TreeSocket* listener = new TreeSocket(IP.c_str(),Port,true,10);
1943                                 if (listener->GetState() == I_LISTENING)
1944                                 {
1945                                         Srv->AddSocket(listener);
1946                                         Bindings.push_back(listener);
1947                                 }
1948                                 else
1949                                 {
1950                                         log(DEFAULT,"m_spanningtree: Warning: Failed to bind server port %d",Port);
1951                                         listener->Close();
1952                                         delete listener;
1953                                 }
1954                         }
1955                 }
1956         }
1957         LinkBlocks.clear();
1958         for (int j =0; j < Conf->Enumerate("link"); j++)
1959         {
1960                 Link L;
1961                 L.Name = Conf->ReadValue("link","name",j);
1962                 L.IPAddr = Conf->ReadValue("link","ipaddr",j);
1963                 L.Port = Conf->ReadInteger("link","port",j,true);
1964                 L.SendPass = Conf->ReadValue("link","sendpass",j);
1965                 L.RecvPass = Conf->ReadValue("link","recvpass",j);
1966                 L.AutoConnect = Conf->ReadInteger("link","autoconnect",j,true);
1967                 L.NextConnectTime = time(NULL) + L.AutoConnect;
1968                 LinkBlocks.push_back(L);
1969                 log(DEBUG,"m_spanningtree: Read server %s with host %s:%d",L.Name.c_str(),L.IPAddr.c_str(),L.Port);
1970         }
1971 }
1972
1973
1974 class ModuleSpanningTree : public Module
1975 {
1976         std::vector<TreeSocket*> Bindings;
1977         int line;
1978         int NumServers;
1979
1980  public:
1981
1982         ModuleSpanningTree()
1983         {
1984                 Srv = new Server;
1985                 Conf = new ConfigReader;
1986                 Bindings.clear();
1987
1988                 // Create the root of the tree
1989                 TreeRoot = new TreeServer(Srv->GetServerName(),Srv->GetServerDescription());
1990
1991                 ReadConfiguration(true);
1992         }
1993
1994         void ShowLinks(TreeServer* Current, userrec* user, int hops)
1995         {
1996                 std::string Parent = TreeRoot->GetName();
1997                 if (Current->GetParent())
1998                 {
1999                         Parent = Current->GetParent()->GetName();
2000                 }
2001                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
2002                 {
2003                         ShowLinks(Current->GetChild(q),user,hops+1);
2004                 }
2005                 WriteServ(user->fd,"364 %s %s %s :%d %s",user->nick,Current->GetName().c_str(),Parent.c_str(),hops,Current->GetDesc().c_str());
2006         }
2007
2008         int CountLocalServs()
2009         {
2010                 return TreeRoot->ChildCount();
2011         }
2012
2013         void CountServsRecursive(TreeServer* Current)
2014         {
2015                 NumServers++;
2016                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
2017                 {
2018                         CountServsRecursive(Current->GetChild(q));
2019                 }
2020         }
2021         
2022         int CountServs()
2023         {
2024                 NumServers = 0;
2025                 CountServsRecursive(TreeRoot);
2026                 return NumServers;
2027         }
2028
2029         void HandleLinks(char** parameters, int pcnt, userrec* user)
2030         {
2031                 ShowLinks(TreeRoot,user,0);
2032                 WriteServ(user->fd,"365 %s * :End of /LINKS list.",user->nick);
2033                 return;
2034         }
2035
2036         void HandleLusers(char** parameters, int pcnt, userrec* user)
2037         {
2038                 WriteServ(user->fd,"251 %s :There are %d users and %d invisible on %d servers",user->nick,usercnt()-usercount_invisible(),usercount_invisible(),this->CountServs());
2039                 WriteServ(user->fd,"252 %s %d :operator(s) online",user->nick,usercount_opers());
2040                 WriteServ(user->fd,"253 %s %d :unknown connections",user->nick,usercount_unknown());
2041                 WriteServ(user->fd,"254 %s %d :channels formed",user->nick,chancount());
2042                 WriteServ(user->fd,"254 %s :I have %d clients and %d servers",user->nick,local_count(),this->CountLocalServs());
2043                 return;
2044         }
2045
2046         // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
2047
2048         void ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80])
2049         {
2050                 if (line < 128)
2051                 {
2052                         for (int t = 0; t < depth; t++)
2053                         {
2054                                 matrix[line][t] = ' ';
2055                         }
2056                         strlcpy(&matrix[line][depth],Current->GetName().c_str(),80);
2057                         line++;
2058                         for (unsigned int q = 0; q < Current->ChildCount(); q++)
2059                         {
2060                                 ShowMap(Current->GetChild(q),user,depth+2,matrix);
2061                         }
2062                 }
2063         }
2064
2065         // Ok, prepare to be confused.
2066         // After much mulling over how to approach this, it struck me that
2067         // the 'usual' way of doing a /MAP isnt the best way. Instead of
2068         // keeping track of a ton of ascii characters, and line by line
2069         // under recursion working out where to place them using multiplications
2070         // and divisons, we instead render the map onto a backplane of characters
2071         // (a character matrix), then draw the branches as a series of "L" shapes
2072         // from the nodes. This is not only friendlier on CPU it uses less stack.
2073
2074         void HandleMap(char** parameters, int pcnt, userrec* user)
2075         {
2076                 // This array represents a virtual screen which we will
2077                 // "scratch" draw to, as the console device of an irc
2078                 // client does not provide for a proper terminal.
2079                 char matrix[128][80];
2080                 for (unsigned int t = 0; t < 128; t++)
2081                 {
2082                         matrix[t][0] = '\0';
2083                 }
2084                 line = 0;
2085                 // The only recursive bit is called here.
2086                 ShowMap(TreeRoot,user,0,matrix);
2087                 // Process each line one by one. The algorithm has a limit of
2088                 // 128 servers (which is far more than a spanning tree should have
2089                 // anyway, so we're ok). This limit can be raised simply by making
2090                 // the character matrix deeper, 128 rows taking 10k of memory.
2091                 for (int l = 1; l < line; l++)
2092                 {
2093                         // scan across the line looking for the start of the
2094                         // servername (the recursive part of the algorithm has placed
2095                         // the servers at indented positions depending on what they
2096                         // are related to)
2097                         int first_nonspace = 0;
2098                         while (matrix[l][first_nonspace] == ' ')
2099                         {
2100                                 first_nonspace++;
2101                         }
2102                         first_nonspace--;
2103                         // Draw the `- (corner) section: this may be overwritten by
2104                         // another L shape passing along the same vertical pane, becoming
2105                         // a |- (branch) section instead.
2106                         matrix[l][first_nonspace] = '-';
2107                         matrix[l][first_nonspace-1] = '`';
2108                         int l2 = l - 1;
2109                         // Draw upwards until we hit the parent server, causing possibly
2110                         // other corners (`-) to become branches (|-)
2111                         while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
2112                         {
2113                                 matrix[l2][first_nonspace-1] = '|';
2114                                 l2--;
2115                         }
2116                 }
2117                 // dump the whole lot to the user. This is the easy bit, honest.
2118                 for (int t = 0; t < line; t++)
2119                 {
2120                         WriteServ(user->fd,"006 %s :%s",user->nick,&matrix[t][0]);
2121                 }
2122                 WriteServ(user->fd,"007 %s :End of /MAP",user->nick);
2123                 return;
2124         }
2125
2126         int HandleSquit(char** parameters, int pcnt, userrec* user)
2127         {
2128                 TreeServer* s = FindServerMask(parameters[0]);
2129                 if (s)
2130                 {
2131                         TreeSocket* sock = s->GetSocket();
2132                         if (sock)
2133                         {
2134                                 WriteOpers("*** SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
2135                                 sock->Squit(s,"Server quit by "+std::string(user->nick)+"!"+std::string(user->ident)+"@"+std::string(user->host));
2136                                 sock->Close();
2137                         }
2138                         else
2139                         {
2140                                 WriteServ(user->fd,"NOTICE %s :*** SQUIT: The server \002%s\002 is not directly connected.",user->nick,parameters[0]);
2141                         }
2142                 }
2143                 else
2144                 {
2145                          WriteServ(user->fd,"NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
2146                 }
2147                 return 1;
2148         }
2149
2150         void DoPingChecks(time_t curtime)
2151         {
2152                 for (unsigned int j = 0; j < TreeRoot->ChildCount(); j++)
2153                 {
2154                         TreeServer* serv = TreeRoot->GetChild(j);
2155                         TreeSocket* sock = serv->GetSocket();
2156                         if (sock)
2157                         {
2158                                 if (curtime >= serv->NextPingTime())
2159                                 {
2160                                         if (serv->AnsweredLastPing())
2161                                         {
2162                                                 sock->WriteLine(":"+Srv->GetServerName()+" PING "+serv->GetName());
2163                                                 serv->SetNextPingTime(curtime + 60);
2164                                         }
2165                                         else
2166                                         {
2167                                                 // they didnt answer, boot them
2168                                                 WriteOpers("*** Server \002%s\002 pinged out",serv->GetName().c_str());
2169                                                 sock->Squit(serv,"Ping timeout");
2170                                                 sock->Close();
2171                                                 return;
2172                                         }
2173                                 }
2174                         }
2175                 }
2176         }
2177
2178         void AutoConnectServers(time_t curtime)
2179         {
2180                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
2181                 {
2182                         if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
2183                         {
2184                                 log(DEBUG,"Auto-Connecting %s",x->Name.c_str());
2185                                 x->NextConnectTime = curtime + x->AutoConnect;
2186                                 TreeServer* CheckDupe = FindServer(x->Name);
2187                                 if (!CheckDupe)
2188                                 {
2189                                         // an autoconnected server is not connected. Check if its time to connect it
2190                                         WriteOpers("*** AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
2191                                         TreeSocket* newsocket = new TreeSocket(x->IPAddr,x->Port,false,10,x->Name);
2192                                         Srv->AddSocket(newsocket);
2193                                 }
2194                         }
2195                 }
2196         }
2197
2198         int HandleVersion(char** parameters, int pcnt, userrec* user)
2199         {
2200                 // we've already checked if pcnt > 0, so this is safe
2201                 TreeServer* found = FindServerMask(parameters[0]);
2202                 if (found)
2203                 {
2204                         std::string Version = found->GetVersion();
2205                         WriteServ(user->fd,"351 %s :%s",user->nick,Version.c_str());
2206                 }
2207                 else
2208                 {
2209                         WriteServ(user->fd,"402 %s %s :No such server",user->nick,parameters[0]);
2210                 }
2211                 return 1;
2212         }
2213         
2214         int HandleConnect(char** parameters, int pcnt, userrec* user)
2215         {
2216                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
2217                 {
2218                         if (Srv->MatchText(x->Name.c_str(),parameters[0]))
2219                         {
2220                                 TreeServer* CheckDupe = FindServer(x->Name);
2221                                 if (!CheckDupe)
2222                                 {
2223                                         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);
2224                                         TreeSocket* newsocket = new TreeSocket(x->IPAddr,x->Port,false,10,x->Name);
2225                                         Srv->AddSocket(newsocket);
2226                                         return 1;
2227                                 }
2228                                 else
2229                                 {
2230                                         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());
2231                                         return 1;
2232                                 }
2233                         }
2234                 }
2235                 WriteServ(user->fd,"NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
2236                 return 1;
2237         }
2238
2239         virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user)
2240         {
2241                 if (command == "CONNECT")
2242                 {
2243                         return this->HandleConnect(parameters,pcnt,user);
2244                 }
2245                 else if (command == "SQUIT")
2246                 {
2247                         return this->HandleSquit(parameters,pcnt,user);
2248                 }
2249                 else if (command == "MAP")
2250                 {
2251                         this->HandleMap(parameters,pcnt,user);
2252                         return 1;
2253                 }
2254                 else if (command == "LUSERS")
2255                 {
2256                         this->HandleLusers(parameters,pcnt,user);
2257                         return 1;
2258                 }
2259                 else if (command == "LINKS")
2260                 {
2261                         this->HandleLinks(parameters,pcnt,user);
2262                         return 1;
2263                 }
2264                 else if ((command == "VERSION") && (pcnt > 0))
2265                 {
2266                         this->HandleVersion(parameters,pcnt,user);
2267                         return 1;
2268                 }
2269                 else if (Srv->IsValidModuleCommand(command, pcnt, user))
2270                 {
2271                         // this bit of code cleverly routes all module commands
2272                         // to all remote severs *automatically* so that modules
2273                         // can just handle commands locally, without having
2274                         // to have any special provision in place for remote
2275                         // commands and linking protocols.
2276                         std::deque<std::string> params;
2277                         params.clear();
2278                         for (int j = 0; j < pcnt; j++)
2279                         {
2280                                 if (strchr(parameters[j],' '))
2281                                 {
2282                                         params.push_back(":" + std::string(parameters[j]));
2283                                 }
2284                                 else
2285                                 {
2286                                         params.push_back(std::string(parameters[j]));
2287                                 }
2288                         }
2289                         DoOneToMany(user->nick,command,params);
2290                 }
2291                 return 0;
2292         }
2293
2294         virtual void OnGetServerDescription(std::string servername,std::string &description)
2295         {
2296                 TreeServer* s = FindServer(servername);
2297                 if (s)
2298                 {
2299                         description = s->GetDesc();
2300                 }
2301         }
2302
2303         virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
2304         {
2305                 if (std::string(source->server) == Srv->GetServerName())
2306                 {
2307                         std::deque<std::string> params;
2308                         params.push_back(dest->nick);
2309                         params.push_back(channel->name);
2310                         DoOneToMany(source->nick,"INVITE",params);
2311                 }
2312         }
2313
2314         virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic)
2315         {
2316                 std::deque<std::string> params;
2317                 params.push_back(chan->name);
2318                 params.push_back(":"+topic);
2319                 DoOneToMany(user->nick,"TOPIC",params);
2320         }
2321
2322         virtual void OnWallops(userrec* user, std::string text)
2323         {
2324                 if (std::string(user->server) == Srv->GetServerName())
2325                 {
2326                         std::deque<std::string> params;
2327                         params.push_back(":"+text);
2328                         DoOneToMany(user->nick,"WALLOPS",params);
2329                 }
2330         }
2331
2332         virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text)
2333         {
2334                 if (target_type == TYPE_USER)
2335                 {
2336                         userrec* d = (userrec*)dest;
2337                         if ((std::string(d->server) != Srv->GetServerName()) && (std::string(user->server) == Srv->GetServerName()))
2338                         {
2339                                 std::deque<std::string> params;
2340                                 params.clear();
2341                                 params.push_back(d->nick);
2342                                 params.push_back(":"+text);
2343                                 DoOneToOne(user->nick,"NOTICE",params,d->server);
2344                         }
2345                 }
2346                 else
2347                 {
2348                         if (std::string(user->server) == Srv->GetServerName())
2349                         {
2350                                 chanrec *c = (chanrec*)dest;
2351                                 std::deque<TreeServer*> list;
2352                                 GetListOfServersForChannel(c,list);
2353                                 unsigned int ucount = list.size();
2354                                 for (unsigned int i = 0; i < ucount; i++)
2355                                 {
2356                                         TreeSocket* Sock = list[i]->GetSocket();
2357                                         if (Sock)
2358                                                 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+std::string(c->name)+" :"+text);
2359                                 }
2360                         }
2361                 }
2362         }
2363
2364         virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text)
2365         {
2366                 if (target_type == TYPE_USER)
2367                 {
2368                         // route private messages which are targetted at clients only to the server
2369                         // which needs to receive them
2370                         userrec* d = (userrec*)dest;
2371                         if ((std::string(d->server) != Srv->GetServerName()) && (std::string(user->server) == Srv->GetServerName()))
2372                         {
2373                                 std::deque<std::string> params;
2374                                 params.clear();
2375                                 params.push_back(d->nick);
2376                                 params.push_back(":"+text);
2377                                 DoOneToOne(user->nick,"PRIVMSG",params,d->server);
2378                         }
2379                 }
2380                 else
2381                 {
2382                         if (std::string(user->server) == Srv->GetServerName())
2383                         {
2384                                 chanrec *c = (chanrec*)dest;
2385                                 std::deque<TreeServer*> list;
2386                                 GetListOfServersForChannel(c,list);
2387                                 unsigned int ucount = list.size();
2388                                 for (unsigned int i = 0; i < ucount; i++)
2389                                 {
2390                                         TreeSocket* Sock = list[i]->GetSocket();
2391                                         if (Sock)
2392                                                 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+std::string(c->name)+" :"+text);
2393                                 }
2394                         }
2395                 }
2396         }
2397
2398         virtual void OnBackgroundTimer(time_t curtime)
2399         {
2400                 AutoConnectServers(curtime);
2401                 DoPingChecks(curtime);
2402         }
2403
2404         virtual void OnUserJoin(userrec* user, chanrec* channel)
2405         {
2406                 // Only do this for local users
2407                 if (std::string(user->server) == Srv->GetServerName())
2408                 {
2409                         std::deque<std::string> params;
2410                         params.clear();
2411                         params.push_back(channel->name);
2412                         if (*channel->key)
2413                         {
2414                                 // if the channel has a key, force the join by emulating the key.
2415                                 params.push_back(channel->key);
2416                         }
2417                         if (channel->GetUserCounter() > 1)
2418                         {
2419                                 // not the first in the channel
2420                                 DoOneToMany(user->nick,"JOIN",params);
2421                         }
2422                         else
2423                         {
2424                                 // first in the channel, set up their permissions
2425                                 // and the channel TS with FJOIN.
2426                                 char ts[24];
2427                                 snprintf(ts,24,"%lu",(unsigned long)channel->age);
2428                                 params.clear();
2429                                 params.push_back(channel->name);
2430                                 params.push_back(ts);
2431                                 params.push_back("@"+std::string(user->nick));
2432                                 DoOneToMany(Srv->GetServerName(),"FJOIN",params);
2433                         }
2434                 }
2435         }
2436
2437         virtual void OnChangeHost(userrec* user, std::string newhost)
2438         {
2439                 // only occurs for local clients
2440                 std::deque<std::string> params;
2441                 params.push_back(newhost);
2442                 DoOneToMany(user->nick,"FHOST",params);
2443         }
2444
2445         virtual void OnChangeName(userrec* user, std::string gecos)
2446         {
2447                 // only occurs for local clients
2448                 std::deque<std::string> params;
2449                 params.push_back(gecos);
2450                 DoOneToMany(user->nick,"FNAME",params);
2451         }
2452
2453         virtual void OnUserPart(userrec* user, chanrec* channel)
2454         {
2455                 if (std::string(user->server) == Srv->GetServerName())
2456                 {
2457                         std::deque<std::string> params;
2458                         params.push_back(channel->name);
2459                         DoOneToMany(user->nick,"PART",params);
2460                 }
2461         }
2462
2463         virtual void OnUserConnect(userrec* user)
2464         {
2465                 char agestr[MAXBUF];
2466                 if (std::string(user->server) == Srv->GetServerName())
2467                 {
2468                         std::deque<std::string> params;
2469                         snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
2470                         params.push_back(agestr);
2471                         params.push_back(user->nick);
2472                         params.push_back(user->host);
2473                         params.push_back(user->dhost);
2474                         params.push_back(user->ident);
2475                         params.push_back("+"+std::string(user->modes));
2476                         params.push_back(user->ip);
2477                         params.push_back(":"+std::string(user->fullname));
2478                         DoOneToMany(Srv->GetServerName(),"NICK",params);
2479                 }
2480         }
2481
2482         virtual void OnUserQuit(userrec* user, std::string reason)
2483         {
2484                 if (std::string(user->server) == Srv->GetServerName())
2485                 {
2486                         std::deque<std::string> params;
2487                         params.push_back(":"+reason);
2488                         DoOneToMany(user->nick,"QUIT",params);
2489                 }
2490         }
2491
2492         virtual void OnUserPostNick(userrec* user, std::string oldnick)
2493         {
2494                 if (std::string(user->server) == Srv->GetServerName())
2495                 {
2496                         std::deque<std::string> params;
2497                         params.push_back(user->nick);
2498                         DoOneToMany(oldnick,"NICK",params);
2499                 }
2500         }
2501
2502         virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason)
2503         {
2504                 if (std::string(source->server) == Srv->GetServerName())
2505                 {
2506                         std::deque<std::string> params;
2507                         params.push_back(chan->name);
2508                         params.push_back(user->nick);
2509                         params.push_back(":"+reason);
2510                         DoOneToMany(source->nick,"KICK",params);
2511                 }
2512         }
2513
2514         virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason)
2515         {
2516                 std::deque<std::string> params;
2517                 params.push_back(dest->nick);
2518                 params.push_back(":"+reason);
2519                 DoOneToMany(source->nick,"KILL",params);
2520         }
2521
2522         virtual void OnRehash(std::string parameter)
2523         {
2524                 if (parameter != "")
2525                 {
2526                         std::deque<std::string> params;
2527                         params.push_back(parameter);
2528                         DoOneToMany(Srv->GetServerName(),"REHASH",params);
2529                         // check for self
2530                         if (Srv->MatchText(Srv->GetServerName(),parameter))
2531                         {
2532                                 Srv->SendOpers("*** Remote rehash initiated from server \002"+Srv->GetServerName()+"\002.");
2533                                 Srv->RehashServer();
2534                         }
2535                 }
2536                 ReadConfiguration(false);
2537         }
2538
2539         // note: the protocol does not allow direct umode +o except
2540         // via NICK with 8 params. sending OPERTYPE infers +o modechange
2541         // locally.
2542         virtual void OnOper(userrec* user, std::string opertype)
2543         {
2544                 if (std::string(user->server) == Srv->GetServerName())
2545                 {
2546                         std::deque<std::string> params;
2547                         params.push_back(opertype);
2548                         DoOneToMany(user->nick,"OPERTYPE",params);
2549                 }
2550         }
2551
2552         void OnLine(userrec* source, std::string host, bool adding, char linetype, long duration, std::string reason)
2553         {
2554                 if (std::string(source->server) == Srv->GetServerName())
2555                 {
2556                         char type[8];
2557                         snprintf(type,8,"%cLINE",linetype);
2558                         std::string stype = type;
2559                         if (adding)
2560                         {
2561                                 char sduration[MAXBUF];
2562                                 snprintf(sduration,MAXBUF,"%ld",duration);
2563                                 std::deque<std::string> params;
2564                                 params.push_back(host);
2565                                 params.push_back(sduration);
2566                                 params.push_back(":"+reason);
2567                                 DoOneToMany(source->nick,stype,params);
2568                         }
2569                         else
2570                         {
2571                                 std::deque<std::string> params;
2572                                 params.push_back(host);
2573                                 DoOneToMany(source->nick,stype,params);
2574                         }
2575                 }
2576         }
2577
2578         virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask)
2579         {
2580                 OnLine(source,hostmask,true,'G',duration,reason);
2581         }
2582         
2583         virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask)
2584         {
2585                 OnLine(source,ipmask,true,'Z',duration,reason);
2586         }
2587
2588         virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask)
2589         {
2590                 OnLine(source,nickmask,true,'Q',duration,reason);
2591         }
2592
2593         virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask)
2594         {
2595                 OnLine(source,hostmask,true,'E',duration,reason);
2596         }
2597
2598         virtual void OnDelGLine(userrec* source, std::string hostmask)
2599         {
2600                 OnLine(source,hostmask,false,'G',0,"");
2601         }
2602
2603         virtual void OnDelZLine(userrec* source, std::string ipmask)
2604         {
2605                 OnLine(source,ipmask,false,'Z',0,"");
2606         }
2607
2608         virtual void OnDelQLine(userrec* source, std::string nickmask)
2609         {
2610                 OnLine(source,nickmask,false,'Q',0,"");
2611         }
2612
2613         virtual void OnDelELine(userrec* source, std::string hostmask)
2614         {
2615                 OnLine(source,hostmask,false,'E',0,"");
2616         }
2617
2618         virtual void OnMode(userrec* user, void* dest, int target_type, std::string text)
2619         {
2620                 if (std::string(user->server) == Srv->GetServerName())
2621                 {
2622                         if (target_type == TYPE_USER)
2623                         {
2624                                 userrec* u = (userrec*)dest;
2625                                 std::deque<std::string> params;
2626                                 params.push_back(u->nick);
2627                                 params.push_back(text);
2628                                 DoOneToMany(user->nick,"MODE",params);
2629                         }
2630                         else
2631                         {
2632                                 chanrec* c = (chanrec*)dest;
2633                                 std::deque<std::string> params;
2634                                 params.push_back(c->name);
2635                                 params.push_back(text);
2636                                 DoOneToMany(user->nick,"MODE",params);
2637                         }
2638                 }
2639         }
2640
2641         virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline)
2642         {
2643                 TreeSocket* s = (TreeSocket*)opaque;
2644                 if (target)
2645                 {
2646                         if (target_type == TYPE_USER)
2647                         {
2648                                 userrec* u = (userrec*)target;
2649                                 s->WriteLine(":"+Srv->GetServerName()+" FMODE "+u->nick+" "+modeline);
2650                         }
2651                         else
2652                         {
2653                                 chanrec* c = (chanrec*)target;
2654                                 s->WriteLine(":"+Srv->GetServerName()+" FMODE "+c->name+" "+modeline);
2655                         }
2656                 }
2657         }
2658
2659         virtual ~ModuleSpanningTree()
2660         {
2661                 delete Srv;
2662         }
2663
2664         virtual Version GetVersion()
2665         {
2666                 return Version(1,0,0,0,VF_STATIC|VF_VENDOR);
2667         }
2668 };
2669
2670
2671 class ModuleSpanningTreeFactory : public ModuleFactory
2672 {
2673  public:
2674         ModuleSpanningTreeFactory()
2675         {
2676         }
2677         
2678         ~ModuleSpanningTreeFactory()
2679         {
2680         }
2681         
2682         virtual Module * CreateModule()
2683         {
2684                 TreeProtocolModule = new ModuleSpanningTree;
2685                 return TreeProtocolModule;
2686         }
2687         
2688 };
2689
2690
2691 extern "C" void * init_module( void )
2692 {
2693         return new ModuleSpanningTreeFactory;
2694 }