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 using namespace std;
  18
  19 #include <stdio.h>
  20 #include <vector>
  21 #include <deque>
  22 #include "globals.h"
  23 #include "inspircd_config.h"
  24 #ifdef GCC3
  25 #include <ext/hash_map>
  26 #else
  27 #include <hash_map>
  28 #endif
  29 #include "users.h"
  30 #include "channels.h"
  31 #include "modules.h"
  32 #include "socket.h"
  33 #include "helperfuncs.h"
  34 #include "inspircd.h"
  35 #include "inspstring.h"
  36 #include "hashcomp.h"
  37 #include "message.h"
  38
  39 #ifdef GCC3
  40 #define nspace __gnu_cxx
  41 #else
  42 #define nspace std
  43 #endif
  44
  45 enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
  46
  47 typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, irc::StrHashComp> user_hash;
  48 extern user_hash clientlist;
  49
  50 class TreeServer;
  51 class TreeSocket;
  52
  53 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> params, std::string target);
  54 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> params, std::string omit);
  55 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> params);
  56
  57 class TreeServer
  58 {
  59         TreeServer* Parent;
  60         std::vector<TreeServer*> Children;
  61         std::string ServerName;
  62         std::string ServerDesc;
  63         std::string VersionString;
  64         int UserCount;
  65         int OperCount;
  66         TreeSocket* Socket;     // for directly connected servers this points at the socket object
  67
  68  public:
  69
  70         TreeServer()
  71         {
  72                 Parent = NULL;
  73                 ServerName = "";
  74                 ServerDesc = "";
  75                 VersionString = "";
  76                 UserCount = OperCount = 0;
  77         }
  78
  79         TreeServer(std::string Name, std::string Desc) : ServerName(Name), ServerDesc(Desc)
  80         {
  81                 Parent = NULL;
  82                 VersionString = "";
  83                 UserCount = OperCount = 0;
  84         }
  85
  86         TreeServer(std::string Name, std::string Desc, TreeServer* Above, TreeSocket* Sock) : Parent(Above), ServerName(Name), ServerDesc(Desc), Socket(Sock)
  87         {
  88                 VersionString = "";
  89                 UserCount = OperCount = 0;
  90         }
  91
  92         std::string GetName()
  93         {
  94                 return this->ServerName;
  95         }
  96
  97         std::string GetDesc()
  98         {
  99                 return this->ServerDesc;
 100         }
 101
 102         std::string GetVersion()
 103         {
 104                 return this->VersionString;
 105         }
 106
 107         int GetUserCount()
 108         {
 109                 return this->UserCount;
 110         }
 111
 112         int GetOperCount()
 113         {
 114                 return this->OperCount;
 115         }
 116
 117         TreeSocket* GetSocket()
 118         {
 119                 return this->Socket;
 120         }
 121
 122         TreeServer* GetParent()
 123         {
 124                 return this->Parent;
 125         }
 126
 127         unsigned int ChildCount()
 128         {
 129                 return Children.size();
 130         }
 131
 132         TreeServer* GetChild(unsigned int n)
 133         {
 134                 if (n < Children.size())
 135                 {
 136                         return Children[n];
 137                 }
 138                 else
 139                 {
 140                         return NULL;
 141                 }
 142         }
 143
 144         void AddChild(TreeServer* Child)
 145         {
 146                 Children.push_back(Child);
 147         }
 148
 149         bool DelChild(TreeServer* Child)
 150         {
 151                 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
 152                 {
 153                         if (*a == Child)
 154                         {
 155                                 Children.erase(a);
 156                                 return true;
 157                         }
 158                 }
 159                 return false;
 160         }
 161
 162         // removes child nodes of this node, and of that node, etc etc
 163         bool Tidy()
 164         {
 165                 bool stillchildren = true;
 166                 while (stillchildren)
 167                 {
 168                         stillchildren = false;
 169                         for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
 170                         {
 171                                 TreeServer* s = (TreeServer*)*a;
 172                                 s->Tidy();
 173                                 Children.erase(a);
 174                                 delete s;
 175                                 stillchildren = true;
 176                                 break;
 177                         }
 178                 }
 179                 return true;
 180         }
 181 };
 182
 183 class Link
 184 {
 185  public:
 186          std::string Name;
 187          std::string IPAddr;
 188          int Port;
 189          std::string SendPass;
 190          std::string RecvPass;
 191 };
 192
 193 /* $ModDesc: Povides a spanning tree server link protocol */
 194
 195 Server *Srv;
 196 ConfigReader *Conf;
 197 TreeServer *TreeRoot;
 198 std::vector<Link> LinkBlocks;
 199
 200 TreeServer* RouteEnumerate(TreeServer* Current, std::string ServerName)
 201 {
 202         if (Current->GetName() == ServerName)
 203                 return Current;
 204         for (unsigned int q = 0; q < Current->ChildCount(); q++)
 205         {
 206                 TreeServer* found = RouteEnumerate(Current->GetChild(q),ServerName);
 207                 if (found)
 208                 {
 209                         return found;
 210                 }
 211         }
 212         return NULL;
 213 }
 214
 215 // Returns the locally connected server we must route a
 216 // message through to reach server 'ServerName'. This
 217 // only applies to one-to-one and not one-to-many routing.
 218 TreeServer* BestRouteTo(std::string ServerName)
 219 {
 220         log(DEBUG,"Finding best route to %s",ServerName.c_str());
 221         // first, find the server by recursively walking the tree
 222         TreeServer* Found = RouteEnumerate(TreeRoot,ServerName);
 223         // did we find it? If not, they did something wrong, abort.
 224         if (!Found)
 225         {
 226                 log(DEBUG,"Failed to find %s by walking tree!",ServerName.c_str());
 227                 return NULL;
 228         }
 229         else
 230         {
 231                 // The server exists, follow its parent nodes until
 232                 // the parent of the current is 'TreeRoot', we know
 233                 // then that this is a directly-connected server.
 234                 while ((Found) && (Found->GetParent() != TreeRoot))
 235                 {
 236                         Found = Found->GetParent();
 237                 }
 238                 log(DEBUG,"Route to %s is via %s",ServerName.c_str(),Found->GetName().c_str());
 239                 return Found;
 240         }
 241 }
 242
 243 bool LookForServer(TreeServer* Current, std::string ServerName)
 244 {
 245         if (ServerName == Current->GetName())
 246                 return true;
 247         for (unsigned int q = 0; q < Current->ChildCount(); q++)
 248         {
 249                 if (LookForServer(Current->GetChild(q),ServerName))
 250                         return true;
 251         }
 252         return false;
 253 }
 254
 255 TreeServer* Found;
 256
 257 void RFindServer(TreeServer* Current, std::string ServerName)
 258 {
 259         if ((ServerName == Current->GetName()) && (!Found))
 260         {
 261                 Found = Current;
 262                 log(DEBUG,"Found server %s desc %s",Current->GetName().c_str(),Current->GetDesc().c_str());
 263                 return;
 264         }
 265         if (!Found)
 266         {
 267                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
 268                 {
 269                         if (!Found)
 270                                 RFindServer(Current->GetChild(q),ServerName);
 271                 }
 272         }
 273         return;
 274 }
 275
 276 TreeServer* FindServer(std::string ServerName)
 277 {
 278         Found = NULL;
 279         RFindServer(TreeRoot,ServerName);
 280         return Found;
 281 }
 282
 283 bool IsServer(std::string ServerName)
 284 {
 285         return LookForServer(TreeRoot,ServerName);
 286 }
 287
 288 class TreeSocket : public InspSocket
 289 {
 290         std::string myhost;
 291         std::string in_buffer;
 292         ServerState LinkState;
 293         std::string InboundServerName;
 294         std::string InboundDescription;
 295         int num_lost_users;
 296         int num_lost_servers;
 297
 298  public:
 299
 300         TreeSocket(std::string host, int port, bool listening, unsigned long maxtime)
 301                 : InspSocket(host, port, listening, maxtime)
 302         {
 303                 Srv->Log(DEBUG,"Create new listening");
 304                 myhost = host;
 305                 this->LinkState = LISTENER;
 306         }
 307
 308         TreeSocket(std::string host, int port, bool listening, unsigned long maxtime, std::string ServerName)
 309                 : InspSocket(host, port, listening, maxtime)
 310         {
 311                 Srv->Log(DEBUG,"Create new outbound");
 312                 myhost = ServerName;
 313                 this->LinkState = CONNECTING;
 314         }
 315
 316         TreeSocket(int newfd, char* ip)
 317                 : InspSocket(newfd, ip)
 318         {
 319                 Srv->Log(DEBUG,"Associate new inbound");
 320                 this->LinkState = WAIT_AUTH_1;
 321         }
 322
 323         virtual bool OnConnected()
 324         {
 325                 if (this->LinkState == CONNECTING)
 326                 {
 327                         Srv->SendOpers("*** Connection to "+myhost+"["+this->GetIP()+"] established.");
 328                         // we should send our details here.
 329                         // if the other side is satisfied, they send theirs.
 330                         // we do not need to change state here.
 331                         for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
 332                         {
 333                                 if (x->Name == this->myhost)
 334                                 {
 335                                         // found who we're supposed to be connecting to, send the neccessary gubbins.
 336                                         this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
 337                                         return true;
 338                                 }
 339                         }
 340                 }
 341                 log(DEBUG,"Outbound connection ERROR: Could not find the right link block!");
 342                 return true;
 343         }
 344
 345         virtual void OnError(InspSocketError e)
 346         {
 347         }
 348
 349         virtual int OnDisconnect()
 350         {
 351                 return true;
 352         }
 353
 354         // recursively send the server tree with distances as hops
 355         void SendServers(TreeServer* Current, TreeServer* s, int hops)
 356         {
 357                 char command[1024];
 358                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
 359                 {
 360                         TreeServer* recursive_server = Current->GetChild(q);
 361                         if (recursive_server != s)
 362                         {
 363                                 // :source.server SERVER server.name hops :Description
 364                                 snprintf(command,1024,":%s SERVER %s * %d :%s",Current->GetName().c_str(),recursive_server->GetName().c_str(),hops,recursive_server->GetDesc().c_str());
 365                                 this->WriteLine(command);
 366                                 // down to next level
 367                                 this->SendServers(recursive_server, s, hops+1);
 368                         }
 369                 }
 370         }
 371
 372         void SquitServer(TreeServer* Current)
 373         {
 374                 // recursively squit the servers attached to 'Current'
 375                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
 376                 {
 377                         TreeServer* recursive_server = Current->GetChild(q);
 378                         this->SquitServer(recursive_server);
 379                 }
 380                 // Now we've whacked the kids, whack self
 381                 log(DEBUG,"Deleted %s",Current->GetName().c_str());
 382                 num_lost_servers++;
 383                 bool quittingpeople = true;
 384                 while (quittingpeople)
 385                 {
 386                         quittingpeople = false;
 387                         for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
 388                         {
 389                                 if (!strcasecmp(u->second->server,Current->GetName().c_str()))
 390                                 {
 391                                         log(DEBUG,"Quitting user %s of server %s",u->second->nick,u->second->server);
 392                                         Srv->QuitUser(u->second,Current->GetName()+" "+std::string(Srv->GetServerName()));
 393                                         num_lost_users++;
 394                                         quittingpeople = true;
 395                                         break;
 396                                 }
 397                         }
 398                 }
 399         }
 400
 401         void Squit(TreeServer* Current,std::string reason)
 402         {
 403                 if (Current)
 404                 {
 405                         std::deque<std::string> params;
 406                         params.push_back(Current->GetName());
 407                         params.push_back(":"+reason);
 408                         DoOneToAllButSender(Current->GetParent()->GetName(),"SQUIT",params,Current->GetName());
 409                         if (Current->GetParent() == TreeRoot)
 410                         {
 411                                 Srv->SendOpers("Server \002"+Current->GetName()+"\002 split: "+reason);
 412                         }
 413                         else
 414                         {
 415                                 Srv->SendOpers("Server \002"+Current->GetName()+"\002 split from server \002"+Current->GetParent()->GetName()+"\002 with reason: "+reason);
 416                         }
 417                         num_lost_servers = 0;
 418                         num_lost_users = 0;
 419                         SquitServer(Current);
 420                         Current->Tidy();
 421                         Current->GetParent()->DelChild(Current);
 422                         delete Current;
 423                         WriteOpers("Netsplit complete, lost \002%d\002 users on \002%d\002 servers.", num_lost_users, num_lost_servers);
 424                 }
 425                 else
 426                 {
 427                         log(DEBUG,"Squit from unknown server");
 428                 }
 429         }
 430
 431         bool ForceJoin(std::string source, std::deque<std::string> params)
 432         {
 433                 if (params.size() < 1)
 434                         return true;
 435                 for (unsigned int channelnum = 0; channelnum < params.size(); channelnum++)
 436                 {
 437                         // process one channel at a time, applying modes.
 438                         char* channel = (char*)params[channelnum].c_str();
 439                         char permissions = *channel;
 440                         char* mode = NULL;
 441                         switch (permissions)
 442                         {
 443                                 case '@':
 444                                         channel++;
 445                                         mode = "+o";
 446                                 break;
 447                                 case '%':
 448                                         channel++;
 449                                         mode = "+h";
 450                                 break;
 451                                 case '+':
 452                                         channel++;
 453                                         mode = "+v";
 454                                 break;
 455                         }
 456                         userrec* who = Srv->FindNick(source);
 457                         if (who)
 458                         {
 459                                 char* key = "";
 460                                 chanrec* chan = Srv->FindChannel(channel);
 461                                 if ((chan) && (*chan->key))
 462                                 {
 463                                         key = chan->key;
 464                                 }
 465                                 Srv->JoinUserToChannel(who,channel,key);
 466                                 if (mode)
 467                                 {
 468                                         char* modelist[3];
 469                                         modelist[0] = channel;
 470                                         modelist[1] = mode;
 471                                         modelist[2] = who->nick;
 472                                         Srv->SendMode(modelist,3,who);
 473                                 }
 474                                 DoOneToAllButSender(source,"FJOIN",params,who->server);
 475                         }
 476                 }
 477                 return true;
 478         }
 479
 480         bool IntroduceClient(std::string source, std::deque<std::string> params)
 481         {
 482                 if (params.size() < 8)
 483                         return true;
 484                 // NICK age nick host dhost ident +modes ip :gecos
 485                 //       0   1    2    3      4     5    6   7
 486                 std::string nick = params[1];
 487                 std::string host = params[2];
 488                 std::string dhost = params[3];
 489                 std::string ident = params[4];
 490                 time_t age = atoi(params[0].c_str());
 491                 std::string modes = params[5];
 492                 std::string ip = params[6];
 493                 std::string gecos = params[7];
 494                 char* tempnick = (char*)nick.c_str();
 495                 log(DEBUG,"Introduce client %s!%s@%s",tempnick,ident.c_str(),host.c_str());
 496
 497                 user_hash::iterator iter;
 498                 iter = clientlist.find(tempnick);
 499                 if (iter != clientlist.end())
 500                 {
 501                         // nick collision
 502                         log(DEBUG,"Nick collision on %s!%s@%s",tempnick,ident.c_str(),host.c_str());
 503                         return true;
 504                 }
 505
 506                 clientlist[tempnick] = new userrec();
 507                 clientlist[tempnick]->fd = FD_MAGIC_NUMBER;
 508                 strlcpy(clientlist[tempnick]->nick, tempnick,NICKMAX);
 509                 strlcpy(clientlist[tempnick]->host, host.c_str(),160);
 510                 strlcpy(clientlist[tempnick]->dhost, dhost.c_str(),160);
 511                 clientlist[tempnick]->server = (char*)FindServerNamePtr(source.c_str());
 512                 strlcpy(clientlist[tempnick]->ident, ident.c_str(),IDENTMAX);
 513                 strlcpy(clientlist[tempnick]->fullname, gecos.c_str(),MAXGECOS);
 514                 clientlist[tempnick]->registered = 7;
 515                 clientlist[tempnick]->signon = age;
 516                 strlcpy(clientlist[tempnick]->ip,ip.c_str(),16);
 517                 for (int i = 0; i < MAXCHANS; i++)
 518                 {
 519                         clientlist[tempnick]->chans[i].channel = NULL;
 520                         clientlist[tempnick]->chans[i].uc_modes = 0;
 521                 }
 522                 DoOneToAllButSender(source,"NICK",params,source);
 523                 return true;
 524         }
 525
 526         // send all users and their channels
 527         void SendUsers(TreeServer* Current)
 528         {
 529                 char data[MAXBUF];
 530                 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
 531                 {
 532                         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);
 533                         this->WriteLine(data);
 534                         if (strchr(u->second->modes,'o'))
 535                         {
 536                                 this->WriteLine(":"+std::string(u->second->nick)+" OPERTYPE "+std::string(u->second->oper));
 537                         }
 538                         char* chl = chlist(u->second,u->second);
 539                         if (*chl)
 540                         {
 541                                 this->WriteLine(":"+std::string(u->second->nick)+" FJOIN "+std::string(chl));
 542                         }
 543                 }
 544         }
 545
 546         void DoBurst(TreeServer* s)
 547         {
 548                 log(DEBUG,"Beginning network burst");
 549                 Srv->SendOpers("*** Bursting to "+s->GetName()+".");
 550                 this->WriteLine("BURST");
 551                 // Send server tree
 552                 this->SendServers(TreeRoot,s,1);
 553                 // Send users and their channels
 554                 this->SendUsers(s);
 555                 // TODO: Send everything else (channel modes etc)
 556                 this->WriteLine("ENDBURST");
 557         }
 558
 559         virtual bool OnDataReady()
 560         {
 561                 char* data = this->Read();
 562                 if (data)
 563                 {
 564                         this->in_buffer += data;
 565                         while (in_buffer.find("\n") != std::string::npos)
 566                         {
 567                                 char* line = (char*)in_buffer.c_str();
 568                                 std::string ret = "";
 569                                 while ((*line != '\n') && (strlen(line)))
 570                                 {
 571                                         ret = ret + *line;
 572                                         line++;
 573                                 }
 574                                 if ((*line == '\n') || (*line == '\r'))
 575                                         line++;
 576                                 in_buffer = line;
 577                                 if (!this->ProcessLine(ret))
 578                                 {
 579                                         return false;
 580                                 }
 581                         }
 582                 }
 583                 return (data != NULL);
 584         }
 585
 586         int WriteLine(std::string line)
 587         {
 588                 return this->Write(line + "\r\n");
 589         }
 590
 591         bool Error(std::deque<std::string> params)
 592         {
 593                 if (params.size() < 1)
 594                         return false;
 595                 std::string Errmsg = params[0];
 596                 std::string SName = myhost;
 597                 if (InboundServerName != "")
 598                 {
 599                         SName = InboundServerName;
 600                 }
 601                 Srv->SendOpers("*** ERROR from "+SName+": "+Errmsg);
 602                 // we will return false to cause the socket to close.
 603                 return false;
 604         }
 605
 606         bool RemoteServer(std::string prefix, std::deque<std::string> params)
 607         {
 608                 if (params.size() < 4)
 609                         return false;
 610                 std::string servername = params[0];
 611                 std::string password = params[1];
 612                 int hops = atoi(params[2].c_str());
 613                 std::string description = params[3];
 614                 if (!hops)
 615                 {
 616                         this->WriteLine("ERROR :Protocol error - Introduced remote server with incorrect hopcount!");
 617                         return false;
 618                 }
 619                 TreeServer* ParentOfThis = FindServer(prefix);
 620                 if (!ParentOfThis)
 621                 {
 622                         this->WriteLine("ERROR :Protocol error - Introduced remote server from unknown server "+prefix);
 623                         return false;
 624                 }
 625                 TreeServer* Node = new TreeServer(servername,description,ParentOfThis,NULL);
 626                 ParentOfThis->AddChild(Node);
 627                 DoOneToAllButSender(prefix,"SERVER",params,prefix);
 628                 Srv->SendOpers("*** Server \002"+prefix+"\002 introduced server \002"+servername+"\002 ("+description+")");
 629                 return true;
 630         }
 631
 632         bool Outbound_Reply_Server(std::deque<std::string> params)
 633         {
 634                 if (params.size() < 4)
 635                         return false;
 636                 std::string servername = params[0];
 637                 std::string password = params[1];
 638                 int hops = atoi(params[2].c_str());
 639                 if (hops)
 640                 {
 641                         this->WriteLine("ERROR :Server too far away for authentication");
 642                         return false;
 643                 }
 644                 std::string description = params[3];
 645                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
 646                 {
 647                         if ((x->Name == servername) && (x->RecvPass == password))
 648                         {
 649                                 // Begin the sync here. this kickstarts the
 650                                 // other side, waiting in WAIT_AUTH_2 state,
 651                                 // into starting their burst, as it shows
 652                                 // that we're happy.
 653                                 this->LinkState = CONNECTED;
 654                                 // we should add the details of this server now
 655                                 // to the servers tree, as a child of the root
 656                                 // node.
 657                                 TreeServer* Node = new TreeServer(servername,description,TreeRoot,this);
 658                                 TreeRoot->AddChild(Node);
 659                                 DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,servername);
 660                                 this->DoBurst(Node);
 661                                 return true;
 662                         }
 663                 }
 664                 this->WriteLine("ERROR :Invalid credentials");
 665                 return false;
 666         }
 667
 668         bool Inbound_Server(std::deque<std::string> params)
 669         {
 670                 if (params.size() < 4)
 671                         return false;
 672                 std::string servername = params[0];
 673                 std::string password = params[1];
 674                 int hops = atoi(params[2].c_str());
 675                 if (hops)
 676                 {
 677                         this->WriteLine("ERROR :Server too far away for authentication");
 678                         return false;
 679                 }
 680                 std::string description = params[3];
 681                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
 682                 {
 683                         if ((x->Name == servername) && (x->RecvPass == password))
 684                         {
 685                                 Srv->SendOpers("*** Verified incoming server connection from \002"+servername+"\002["+this->GetIP()+"] ("+description+")");
 686                                 this->InboundServerName = servername;
 687                                 this->InboundDescription = description;
 688                                 // this is good. Send our details: Our server name and description and hopcount of 0,
 689                                 // along with the sendpass from this block.
 690                                 this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
 691                                 // move to the next state, we are now waiting for THEM.
 692                                 this->LinkState = WAIT_AUTH_2;
 693                                 return true;
 694                         }
 695                 }
 696                 this->WriteLine("ERROR :Invalid credentials");
 697                 return false;
 698         }
 699
 700         std::deque<std::string> Split(std::string line, bool stripcolon)
 701         {
 702                 std::deque<std::string> n;
 703                 std::stringstream s(line);
 704                 std::string param = "";
 705                 n.clear();
 706                 int item = 0;
 707                 while (!s.eof())
 708                 {
 709                         s >> param;
 710                         if ((param.c_str()[0] == ':') && (item))
 711                         {
 712                                 char* str = (char*)param.c_str();
 713                                 str++;
 714                                 param = str;
 715                                 std::string append;
 716                                 while (!s.eof())
 717                                 {
 718                                         append = "";
 719                                         s >> append;
 720                                         if (append != "")
 721                                         {
 722                                                 param = param + " " + append;
 723                                         }
 724                                 }
 725                         }
 726                         item++;
 727                         if ((strchr(param.c_str(),' ')) && (!stripcolon))
 728                         {
 729                                 param = ":"+param;
 730                         }
 731                         n.push_back(param);
 732                 }
 733                 return n;
 734         }
 735
 736         bool ProcessLine(std::string line)
 737         {
 738                 Srv->Log(DEBUG,"inbound-line: '"+line+"'");
 739
 740                 std::deque<std::string> rawparams = this->Split(line,false);
 741                 std::deque<std::string> params = this->Split(line,true);
 742                 std::string command = "";
 743                 std::string prefix = "";
 744                 if (((params[0].c_str())[0] == ':') && (params.size() > 1))
 745                 {
 746                         prefix = params[0];
 747                         command = params[1];
 748                         char* pref = (char*)prefix.c_str();
 749                         prefix = ++pref;
 750                         params.pop_front();
 751                         params.pop_front();
 752                 }
 753                 else
 754                 {
 755                         prefix = "";
 756                         command = params[0];
 757                         params.pop_front();
 758                 }
 759
 760                 switch (this->LinkState)
 761                 {
 762                         TreeServer* Node;
 763
 764                         case WAIT_AUTH_1:
 765                                 // Waiting for SERVER command from remote server. Server initiating
 766                                 // the connection sends the first SERVER command, listening server
 767                                 // replies with theirs if its happy, then if the initiator is happy,
 768                                 // it starts to send its net sync, which starts the merge, otherwise
 769                                 // it sends an ERROR.
 770                                 if (command == "SERVER")
 771                                 {
 772                                         return this->Inbound_Server(params);
 773                                 }
 774                                 else if (command == "ERROR")
 775                                 {
 776                                         return this->Error(params);
 777                                 }
 778                         break;
 779                         case WAIT_AUTH_2:
 780                                 // Waiting for start of other side's netmerge to say they liked our
 781                                 // password.
 782                                 if (command == "SERVER")
 783                                 {
 784                                         // cant do this, they sent it to us in the WAIT_AUTH_1 state!
 785                                         // silently ignore.
 786                                         return true;
 787                                 }
 788                                 else if (command == "BURST")
 789                                 {
 790                                         this->LinkState = CONNECTED;
 791                                         Node = new TreeServer(InboundServerName,InboundDescription,TreeRoot,this);
 792                                         TreeRoot->AddChild(Node);
 793                                         params.clear();
 794                                         params.push_back(InboundServerName);
 795                                         params.push_back("*");
 796                                         params.push_back("1");
 797                                         params.push_back(":"+InboundDescription);
 798                                         DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,InboundServerName);
 799                                         this->DoBurst(Node);
 800                                 }
 801                                 else if (command == "ERROR")
 802                                 {
 803                                         return this->Error(params);
 804                                 }
 805
 806                         break;
 807                         case LISTENER:
 808                                 this->WriteLine("ERROR :Internal error -- listening socket accepted its own descriptor!!!");
 809                                 return false;
 810                         break;
 811                         case CONNECTING:
 812                                 if (command == "SERVER")
 813                                 {
 814                                         // another server we connected to, which was in WAIT_AUTH_1 state,
 815                                         // has just sent us their credentials. If we get this far, theyre
 816                                         // happy with OUR credentials, and they are now in WAIT_AUTH_2 state.
 817                                         // if we're happy with this, we should send our netburst which
 818                                         // kickstarts the merge.
 819                                         return this->Outbound_Reply_Server(params);
 820                                 }
 821                         break;
 822                         case CONNECTED:
 823                                 // This is the 'authenticated' state, when all passwords
 824                                 // have been exchanged and anything past this point is taken
 825                                 // as gospel.
 826                                 std::string target = "";
 827                                 if ((command == "NICK") && (params.size() > 1))
 828                                 {
 829                                         return this->IntroduceClient(prefix,params);
 830                                 }
 831                                 else if (command == "FJOIN")
 832                                 {
 833                                         return this->ForceJoin(prefix,params);
 834                                 }
 835                                 else if (command == "SERVER")
 836                                 {
 837                                         return this->RemoteServer(prefix,params);
 838                                 }
 839                                 else if (command == "SQUIT")
 840                                 {
 841                                         if (params.size() == 2)
 842                                         {
 843                                                 this->Squit(FindServer(params[0]),params[1]);
 844                                         }
 845                                         return true;
 846                                 }
 847                                 else
 848                                 {
 849                                         // not a special inter-server command.
 850                                         // Emulate the actual user doing the command,
 851                                         // this saves us having a huge ugly parser.
 852                                         userrec* who = Srv->FindNick(prefix);
 853                                         std::string sourceserv = this->myhost;
 854                                         if (this->InboundServerName != "")
 855                                         {
 856                                                 sourceserv = this->InboundServerName;
 857                                         }
 858                                         if (who)
 859                                         {
 860                                                 // its a user
 861                                                 target = who->server;
 862                                                 char* strparams[127];
 863                                                 for (unsigned int q = 0; q < params.size(); q++)
 864                                                 {
 865                                                         strparams[q] = (char*)params[q].c_str();
 866                                                 }
 867                                                 log(DEBUG,"*** CALL COMMAND HANDLER FOR %s, SOURCE: '%s'",command.c_str(),who->nick);
 868                                                 Srv->CallCommandHandler(command, strparams, params.size(), who);
 869                                         }
 870                                         else
 871                                         {
 872                                                 // its not a user. Its either a server, or somethings screwed up.
 873                                                 if (IsServer(prefix))
 874                                                 {
 875                                                         target = Srv->GetServerName();
 876                                                 }
 877                                                 else
 878                                                 {
 879                                                         log(DEBUG,"Command with unknown origin '%s'",prefix.c_str());
 880                                                         return true;
 881                                                 }
 882                                         }
 883                                         return DoOneToAllButSender(prefix,command,rawparams,sourceserv);
 884
 885                                 }
 886                                 return true;
 887                         break;
 888                 }
 889                 return true;
 890         }
 891
 892         virtual void OnTimeout()
 893         {
 894                 if (this->LinkState == CONNECTING)
 895                 {
 896                         Srv->SendOpers("*** CONNECT: Connection to \002"+myhost+"\002 timed out.");
 897                 }
 898         }
 899
 900         virtual void OnClose()
 901         {
 902                 // Connection closed.
 903                 // If the connection is fully up (state CONNECTED)
 904                 // then propogate a netsplit to all peers.
 905                 std::string quitserver = this->myhost;
 906                 if (this->InboundServerName != "")
 907                 {
 908                         quitserver = this->InboundServerName;
 909                 }
 910                 TreeServer* s = FindServer(quitserver);
 911                 if (s)
 912                 {
 913                         std::deque<std::string> params;
 914                         params.push_back(quitserver);
 915                         params.push_back(":Remote host closed the connection");
 916                         DoOneToAllButSender(Srv->GetServerName(),"SQUIT",params,quitserver);
 917                         Squit(s,"Remote host closed the connection");
 918                 }
 919         }
 920
 921         virtual int OnIncomingConnection(int newsock, char* ip)
 922         {
 923                 TreeSocket* s = new TreeSocket(newsock, ip);
 924                 Srv->AddSocket(s);
 925                 return true;
 926         }
 927 };
 928
 929 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> params, std::string omit)
 930 {
 931         log(DEBUG,"ALLBUTONE: Comes from %s SHOULD NOT go back to %s",prefix.c_str(),omit.c_str());
 932         // TODO: Special stuff with privmsg and notice
 933         std::string FullLine = ":" + prefix + " " + command;
 934         for (unsigned int x = 0; x < params.size(); x++)
 935         {
 936                 FullLine = FullLine + " " + params[x];
 937         }
 938         for (unsigned int x = 0; x < TreeRoot->ChildCount(); x++)
 939         {
 940                 TreeServer* Route = TreeRoot->GetChild(x);
 941                 // Send the line IF:
 942                 // The route has a socket (its a direct connection)
 943                 // The route isnt the one to be omitted
 944                 // The route isnt the path to the one to be omitted
 945                 if ((Route->GetSocket()) && (Route->GetName() != omit) && (BestRouteTo(omit) != Route))
 946                 {
 947                         TreeSocket* Sock = Route->GetSocket();
 948                         log(DEBUG,"Sending to %s",Route->GetName().c_str());
 949                         Sock->WriteLine(FullLine);
 950                 }
 951         }
 952         return true;
 953 }
 954
 955 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> params)
 956 {
 957         std::string FullLine = ":" + prefix + " " + command;
 958         for (unsigned int x = 0; x < params.size(); x++)
 959         {
 960                 FullLine = FullLine + " " + params[x];
 961         }
 962         for (unsigned int x = 0; x < TreeRoot->ChildCount(); x++)
 963         {
 964                 TreeServer* Route = TreeRoot->GetChild(x);
 965                 if (Route->GetSocket())
 966                 {
 967                         TreeSocket* Sock = Route->GetSocket();
 968                         Sock->WriteLine(FullLine);
 969                 }
 970         }
 971         return true;
 972 }
 973
 974 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> params, std::string target)
 975 {
 976         TreeServer* Route = BestRouteTo(target);
 977         if (Route)
 978         {
 979                 std::string FullLine = ":" + prefix + " " + command;
 980                 for (unsigned int x = 0; x < params.size(); x++)
 981                 {
 982                         FullLine = FullLine + " " + params[x];
 983                 }
 984                 if (Route->GetSocket())
 985                 {
 986                         TreeSocket* Sock = Route->GetSocket();
 987                         Sock->WriteLine(FullLine);
 988                 }
 989                 return true;
 990         }
 991         else
 992         {
 993                 log(DEBUG,"Could not route message with target %s: %s",target.c_str(),command.c_str());
 994                 return true;
 995         }
 996 }
 997
 998
 999 class ModuleSpanningTree : public Module
1000 {
1001         std::vector<TreeSocket*> Bindings;
1002         int line;
1003
1004  public:
1005
1006         void ReadConfiguration(bool rebind)
1007         {
1008                 if (rebind)
1009                 {
1010                         for (int j =0; j < Conf->Enumerate("bind"); j++)
1011                         {
1012                                 std::string Type = Conf->ReadValue("bind","type",j);
1013                                 std::string IP = Conf->ReadValue("bind","address",j);
1014                                 long Port = Conf->ReadInteger("bind","port",j,true);
1015                                 if (Type == "servers")
1016                                 {
1017                                         if (IP == "*")
1018                                         {
1019                                                 IP = "";
1020                                         }
1021                                         TreeSocket* listener = new TreeSocket(IP.c_str(),Port,true,10);
1022                                         if (listener->GetState() == I_LISTENING)
1023                                         {
1024                                                 Srv->AddSocket(listener);
1025                                                 Bindings.push_back(listener);
1026                                         }
1027                                         else
1028                                         {
1029                                                 log(DEFAULT,"m_spanningtree: Warning: Failed to bind server port %d",Port);
1030                                                 listener->Close();
1031                                                 delete listener;
1032                                         }
1033                                 }
1034                         }
1035                 }
1036                 LinkBlocks.clear();
1037                 for (int j =0; j < Conf->Enumerate("link"); j++)
1038                 {
1039                         Link L;
1040                         L.Name = Conf->ReadValue("link","name",j);
1041                         L.IPAddr = Conf->ReadValue("link","ipaddr",j);
1042                         L.Port = Conf->ReadInteger("link","port",j,true);
1043                         L.SendPass = Conf->ReadValue("link","sendpass",j);
1044                         L.RecvPass = Conf->ReadValue("link","recvpass",j);
1045                         LinkBlocks.push_back(L);
1046                         log(DEBUG,"m_spanningtree: Read server %s with host %s:%d",L.Name.c_str(),L.IPAddr.c_str(),L.Port);
1047                 }
1048         }
1049
1050         ModuleSpanningTree()
1051         {
1052                 Srv = new Server;
1053                 Conf = new ConfigReader;
1054                 Bindings.clear();
1055
1056                 // Create the root of the tree
1057                 TreeRoot = new TreeServer(Srv->GetServerName(),Srv->GetServerDescription());
1058
1059                 ReadConfiguration(true);
1060         }
1061
1062         void ShowLinks(TreeServer* Current, userrec* user, int hops)
1063         {
1064                 std::string Parent = TreeRoot->GetName();
1065                 if (Current->GetParent())
1066                 {
1067                         Parent = Current->GetParent()->GetName();
1068                 }
1069                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
1070                 {
1071                         ShowLinks(Current->GetChild(q),user,hops+1);
1072                 }
1073                 WriteServ(user->fd,"364 %s %s %s :%d %s",user->nick,Current->GetName().c_str(),Parent.c_str(),hops,Current->GetDesc().c_str());
1074         }
1075
1076         void HandleLinks(char** parameters, int pcnt, userrec* user)
1077         {
1078                 ShowLinks(TreeRoot,user,0);
1079                 WriteServ(user->fd,"365 %s * :End of /LINKS list.",user->nick);
1080                 return;
1081         }
1082
1083         void HandleLusers(char** parameters, int pcnt, userrec* user)
1084         {
1085                 return;
1086         }
1087
1088         // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
1089
1090         void ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80])
1091         {
1092                 if (line < 128)
1093                 {
1094                         for (int t = 0; t < depth; t++)
1095                         {
1096                                 matrix[line][t] = ' ';
1097                         }
1098                         strlcpy(&matrix[line][depth],Current->GetName().c_str(),80);
1099                         line++;
1100                         for (unsigned int q = 0; q < Current->ChildCount(); q++)
1101                         {
1102                                 ShowMap(Current->GetChild(q),user,depth+2,matrix);
1103                         }
1104                 }
1105         }
1106
1107         // Ok, prepare to be confused.
1108         // After much mulling over how to approach this, it struck me that
1109         // the 'usual' way of doing a /MAP isnt the best way. Instead of
1110         // keeping track of a ton of ascii characters, and line by line
1111         // under recursion working out where to place them using multiplications
1112         // and divisons, we instead render the map onto a backplane of characters
1113         // (a character matrix), then draw the branches as a series of "L" shapes
1114         // from the nodes. This is not only friendlier on CPU it uses less stack.
1115
1116         void HandleMap(char** parameters, int pcnt, userrec* user)
1117         {
1118                 // This array represents a virtual screen which we will
1119                 // "scratch" draw to, as the console device of an irc
1120                 // client does not provide for a proper terminal.
1121                 char matrix[128][80];
1122                 for (unsigned int t = 0; t < 128; t++)
1123                 {
1124                         matrix[t][0] = '\0';
1125                 }
1126                 line = 0;
1127                 // The only recursive bit is called here.
1128                 ShowMap(TreeRoot,user,0,matrix);
1129                 // Process each line one by one. The algorithm has a limit of
1130                 // 128 servers (which is far more than a spanning tree should have
1131                 // anyway, so we're ok). This limit can be raised simply by making
1132                 // the character matrix deeper, 128 rows taking 10k of memory.
1133                 for (int l = 1; l < line; l++)
1134                 {
1135                         // scan across the line looking for the start of the
1136                         // servername (the recursive part of the algorithm has placed
1137                         // the servers at indented positions depending on what they
1138                         // are related to)
1139                         int first_nonspace = 0;
1140                         while (matrix[l][first_nonspace] == ' ')
1141                         {
1142                                 first_nonspace++;
1143                         }
1144                         first_nonspace--;
1145                         // Draw the `- (corner) section: this may be overwritten by
1146                         // another L shape passing along the same vertical pane, becoming
1147                         // a |- (branch) section instead.
1148                         matrix[l][first_nonspace] = '-';
1149                         matrix[l][first_nonspace-1] = '`';
1150                         int l2 = l - 1;
1151                         // Draw upwards until we hit the parent server, causing possibly
1152                         // other corners (`-) to become branches (|-)
1153                         while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
1154                         {
1155                                 matrix[l2][first_nonspace-1] = '|';
1156                                 l2--;
1157                         }
1158                 }
1159                 // dump the whole lot to the user. This is the easy bit, honest.
1160                 for (int t = 0; t < line; t++)
1161                 {
1162                         WriteServ(user->fd,"006 %s :%s",user->nick,&matrix[t][0]);
1163                 }
1164                 WriteServ(user->fd,"007 %s :End of /MAP",user->nick);
1165                 return;
1166         }
1167
1168         int HandleSquit(char** parameters, int pcnt, userrec* user)
1169         {
1170                 return 1;
1171         }
1172
1173         int HandleConnect(char** parameters, int pcnt, userrec* user)
1174         {
1175                 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1176                 {
1177                         if (Srv->MatchText(x->Name.c_str(),parameters[0]))
1178                         {
1179                                 WriteServ(user->fd,"NOTICE %s :*** CONNECT: Connecting to server: %s (%s:%d)",user->nick,x->Name.c_str(),x->IPAddr.c_str(),x->Port);
1180                                 TreeSocket* newsocket = new TreeSocket(x->IPAddr,x->Port,false,10,x->Name);
1181                                 Srv->AddSocket(newsocket);
1182                                 return 1;
1183                         }
1184                 }
1185                 WriteServ(user->fd,"NOTICE %s :*** CONNECT: No matching server could be found in the config file.",user->nick);
1186                 return 1;
1187         }
1188
1189         virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user)
1190         {
1191                 if (command == "CONNECT")
1192                 {
1193                         return this->HandleConnect(parameters,pcnt,user);
1194                 }
1195                 else if (command == "SQUIT")
1196                 {
1197                         return this->HandleSquit(parameters,pcnt,user);
1198                 }
1199                 else if (command == "MAP")
1200                 {
1201                         this->HandleMap(parameters,pcnt,user);
1202                         return 1;
1203                 }
1204                 else if (command == "LUSERS")
1205                 {
1206                         this->HandleLusers(parameters,pcnt,user);
1207                         return 1;
1208                 }
1209                 else if (command == "LINKS")
1210                 {
1211                         this->HandleLinks(parameters,pcnt,user);
1212                         return 1;
1213                 }
1214                 return 0;
1215         }
1216
1217         virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text)
1218         {
1219                 if (target_type == TYPE_USER)
1220                 {
1221                         // route private messages which are targetted at clients only to the server
1222                         // which needs to receive them
1223                         userrec* d = (userrec*)dest;
1224                         if ((std::string(d->server) != Srv->GetServerName()) && (std::string(user->server) == Srv->GetServerName()))
1225                         {
1226                                 std::deque<std::string> params;
1227                                 params.clear();
1228                                 params.push_back(d->nick);
1229                                 params.push_back(":"+text);
1230                                 DoOneToOne(user->nick,"PRIVMSG",params,d->server);
1231                         }
1232                 }
1233                 else
1234                 {
1235                         if (std::string(user->server) == Srv->GetServerName())
1236                         {
1237                                 chanrec *c = (chanrec*)dest;
1238                                 std::deque<std::string> params;
1239                                 params.push_back(c->name);
1240                                 params.push_back(":"+text);
1241                                 DoOneToMany(user->nick,"PRIVMSG",params);
1242                         }
1243                 }
1244         }
1245
1246         virtual void OnUserJoin(userrec* user, chanrec* channel)
1247         {
1248                 // Only do this for local users
1249                 if (std::string(user->server) == Srv->GetServerName())
1250                 {
1251                         log(DEBUG,"**** User on %s JOINS %s",user->server,channel->name);
1252                         std::deque<std::string> params;
1253                         params.clear();
1254                         params.push_back(channel->name);
1255                         if (*channel->key)
1256                         {
1257                                 log(DEBUG,"**** With key %s",channel->key);
1258                                 // if the channel has a key, force the join by emulating the key.
1259                                 params.push_back(channel->key);
1260                         }
1261                         DoOneToMany(user->nick,"JOIN",params);
1262                 }
1263         }
1264
1265         virtual void OnUserPart(userrec* user, chanrec* channel)
1266         {
1267                 if (std::string(user->server) == Srv->GetServerName())
1268                 {
1269                         log(DEBUG,"**** User on %s PARTS %s",user->server,channel->name);
1270                         std::deque<std::string> params;
1271                         params.clear();
1272                         params.push_back(channel->name);
1273                         DoOneToMany(user->nick,"PART",params);
1274                 }
1275         }
1276
1277         virtual ~ModuleSpanningTree()
1278         {
1279                 delete Srv;
1280         }
1281
1282         virtual Version GetVersion()
1283         {
1284                 return Version(1,0,0,0,VF_STATIC|VF_VENDOR);
1285         }
1286 };
1287
1288
1289 class ModuleSpanningTreeFactory : public ModuleFactory
1290 {
1291  public:
1292         ModuleSpanningTreeFactory()
1293         {
1294         }
1295
1296         ~ModuleSpanningTreeFactory()
1297         {
1298         }
1299
1300         virtual Module * CreateModule()
1301         {
1302                 return new ModuleSpanningTree;
1303         }
1304
1305 };
1306
1307
1308 extern "C" void * init_module( void )
1309 {
1310         return new ModuleSpanningTreeFactory;
1311 }
1312