src/modules/m_spanningtree.cpp

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