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