1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2005 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
23 #include "inspircd_config.h"
25 #include <ext/hash_map>
33 #include "helperfuncs.h"
35 #include "inspstring.h"
40 #define nspace __gnu_cxx
45 class ModuleSpanningTree;
46 static ModuleSpanningTree* TreeProtocolModule;
48 extern std::vector<Module*> modules;
49 extern std::vector<ircd_module*> factory;
52 enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
54 typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, irc::StrHashComp> user_hash;
55 typedef nspace::hash_map<std::string, chanrec*, nspace::hash<string>, irc::StrHashComp> chan_hash;
57 extern user_hash clientlist;
58 extern chan_hash chanlist;
63 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> params, std::string target);
64 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> params, std::string omit);
65 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> params);
66 bool DoOneToAllButSenderRaw(std::string data,std::string omit);
67 void ReadConfiguration(bool rebind);
72 std::vector<TreeServer*> Children;
73 std::string ServerName;
74 std::string ServerDesc;
75 std::string VersionString;
78 TreeSocket* Socket; // for directly connected servers this points at the socket object
88 UserCount = OperCount = 0;
91 TreeServer(std::string Name, std::string Desc) : ServerName(Name), ServerDesc(Desc)
95 UserCount = OperCount = 0;
98 TreeServer(std::string Name, std::string Desc, TreeServer* Above, TreeSocket* Sock) : Parent(Above), ServerName(Name), ServerDesc(Desc), Socket(Sock)
101 UserCount = OperCount = 0;
104 std::string GetName()
106 return this->ServerName;
109 std::string GetDesc()
111 return this->ServerDesc;
114 std::string GetVersion()
116 return this->VersionString;
121 return this->UserCount;
126 return this->OperCount;
129 TreeSocket* GetSocket()
134 TreeServer* GetParent()
139 unsigned int ChildCount()
141 return Children.size();
144 TreeServer* GetChild(unsigned int n)
146 if (n < Children.size())
156 void AddChild(TreeServer* Child)
158 Children.push_back(Child);
161 bool DelChild(TreeServer* Child)
163 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
174 // removes child nodes of this node, and of that node, etc etc
177 bool stillchildren = true;
178 while (stillchildren)
180 stillchildren = false;
181 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
183 TreeServer* s = (TreeServer*)*a;
187 stillchildren = true;
201 std::string SendPass;
202 std::string RecvPass;
205 /* $ModDesc: Povides a spanning tree server link protocol */
209 TreeServer *TreeRoot;
210 std::vector<Link> LinkBlocks;
212 TreeServer* RouteEnumerate(TreeServer* Current, std::string ServerName)
214 if (Current->GetName() == ServerName)
216 for (unsigned int q = 0; q < Current->ChildCount(); q++)
218 TreeServer* found = RouteEnumerate(Current->GetChild(q),ServerName);
227 // Returns the locally connected server we must route a
228 // message through to reach server 'ServerName'. This
229 // only applies to one-to-one and not one-to-many routing.
230 TreeServer* BestRouteTo(std::string ServerName)
232 log(DEBUG,"Finding best route to %s",ServerName.c_str());
233 if (ServerName.c_str() == TreeRoot->GetName())
235 log(DEBUG,"Cant route to myself!!!");
238 // first, find the server by recursively walking the tree
239 TreeServer* Found = RouteEnumerate(TreeRoot,ServerName);
240 // did we find it? If not, they did something wrong, abort.
243 log(DEBUG,"Failed to find %s by walking tree!",ServerName.c_str());
248 // The server exists, follow its parent nodes until
249 // the parent of the current is 'TreeRoot', we know
250 // then that this is a directly-connected server.
251 while ((Found) && (Found->GetParent() != TreeRoot))
253 Found = Found->GetParent();
255 log(DEBUG,"Route to %s is via %s",ServerName.c_str(),Found->GetName().c_str());
260 bool LookForServer(TreeServer* Current, std::string ServerName)
262 if (ServerName == Current->GetName())
264 for (unsigned int q = 0; q < Current->ChildCount(); q++)
266 if (LookForServer(Current->GetChild(q),ServerName))
274 void RFindServer(TreeServer* Current, std::string ServerName)
276 if ((ServerName == Current->GetName()) && (!Found))
279 log(DEBUG,"Found server %s desc %s",Current->GetName().c_str(),Current->GetDesc().c_str());
284 for (unsigned int q = 0; q < Current->ChildCount(); q++)
287 RFindServer(Current->GetChild(q),ServerName);
293 TreeServer* FindServer(std::string ServerName)
296 RFindServer(TreeRoot,ServerName);
300 bool IsServer(std::string ServerName)
302 return LookForServer(TreeRoot,ServerName);
305 class TreeSocket : public InspSocket
308 std::string in_buffer;
309 ServerState LinkState;
310 std::string InboundServerName;
311 std::string InboundDescription;
313 int num_lost_servers;
317 TreeSocket(std::string host, int port, bool listening, unsigned long maxtime)
318 : InspSocket(host, port, listening, maxtime)
320 Srv->Log(DEBUG,"Create new listening");
322 this->LinkState = LISTENER;
325 TreeSocket(std::string host, int port, bool listening, unsigned long maxtime, std::string ServerName)
326 : InspSocket(host, port, listening, maxtime)
328 Srv->Log(DEBUG,"Create new outbound");
330 this->LinkState = CONNECTING;
333 TreeSocket(int newfd, char* ip)
334 : InspSocket(newfd, ip)
336 Srv->Log(DEBUG,"Associate new inbound");
337 this->LinkState = WAIT_AUTH_1;
340 virtual bool OnConnected()
342 if (this->LinkState == CONNECTING)
344 Srv->SendOpers("*** Connection to "+myhost+"["+this->GetIP()+"] established.");
345 // we should send our details here.
346 // if the other side is satisfied, they send theirs.
347 // we do not need to change state here.
348 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
350 if (x->Name == this->myhost)
352 // found who we're supposed to be connecting to, send the neccessary gubbins.
353 this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
358 log(DEBUG,"Outbound connection ERROR: Could not find the right link block!");
362 virtual void OnError(InspSocketError e)
366 virtual int OnDisconnect()
371 // recursively send the server tree with distances as hops
372 void SendServers(TreeServer* Current, TreeServer* s, int hops)
375 for (unsigned int q = 0; q < Current->ChildCount(); q++)
377 TreeServer* recursive_server = Current->GetChild(q);
378 if (recursive_server != s)
380 // :source.server SERVER server.name hops :Description
381 snprintf(command,1024,":%s SERVER %s * %d :%s",Current->GetName().c_str(),recursive_server->GetName().c_str(),hops,recursive_server->GetDesc().c_str());
382 this->WriteLine(command);
383 // down to next level
384 this->SendServers(recursive_server, s, hops+1);
389 void SquitServer(TreeServer* Current)
391 // recursively squit the servers attached to 'Current'
392 for (unsigned int q = 0; q < Current->ChildCount(); q++)
394 TreeServer* recursive_server = Current->GetChild(q);
395 this->SquitServer(recursive_server);
397 // Now we've whacked the kids, whack self
398 log(DEBUG,"Deleted %s",Current->GetName().c_str());
400 bool quittingpeople = true;
401 while (quittingpeople)
403 quittingpeople = false;
404 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
406 if (!strcasecmp(u->second->server,Current->GetName().c_str()))
408 log(DEBUG,"Quitting user %s of server %s",u->second->nick,u->second->server);
409 Srv->QuitUser(u->second,Current->GetName()+" "+std::string(Srv->GetServerName()));
411 quittingpeople = true;
418 void Squit(TreeServer* Current,std::string reason)
422 std::deque<std::string> params;
423 params.push_back(Current->GetName());
424 params.push_back(":"+reason);
425 DoOneToAllButSender(Current->GetParent()->GetName(),"SQUIT",params,Current->GetName());
426 if (Current->GetParent() == TreeRoot)
428 Srv->SendOpers("Server \002"+Current->GetName()+"\002 split: "+reason);
432 Srv->SendOpers("Server \002"+Current->GetName()+"\002 split from server \002"+Current->GetParent()->GetName()+"\002 with reason: "+reason);
434 num_lost_servers = 0;
436 SquitServer(Current);
438 Current->GetParent()->DelChild(Current);
440 WriteOpers("Netsplit complete, lost \002%d\002 users on \002%d\002 servers.", num_lost_users, num_lost_servers);
444 log(DEBUG,"Squit from unknown server");
448 bool ForceMode(std::string source, std::deque<std::string> params)
450 userrec* who = new userrec;
451 who->fd = FD_MAGIC_NUMBER;
452 if (params.size() < 2)
455 for (unsigned int q = 0; q < params.size(); q++)
457 modelist[q] = (char*)params[q].c_str();
459 Srv->SendMode(modelist,params.size(),who);
460 DoOneToAllButSender(source,"FMODE",params,source);
465 bool ForceTopic(std::string source, std::deque<std::string> params)
467 // FTOPIC %s %lu %s :%s
468 if (params.size() != 4)
470 std::string channel = params[0];
471 time_t ts = atoi(params[1].c_str());
472 std::string setby = params[2];
473 std::string topic = params[3];
475 chanrec* c = Srv->FindChannel(channel);
478 if ((ts >= c->topicset) || (!*c->topic))
480 strlcpy(c->topic,topic.c_str(),MAXTOPIC);
481 strlcpy(c->setby,setby.c_str(),NICKMAX);
483 WriteChannelWithServ((char*)source.c_str(), c, "TOPIC %s :%s", c->name, c->topic);
488 // all done, send it on its way
489 params[3] = ":" + params[3];
490 DoOneToAllButSender(source,"FTOPIC",params,source);
495 bool ForceJoin(std::string source, std::deque<std::string> params)
497 if (params.size() < 2)
502 char* mode_users[127];
503 mode_users[0] = first;
504 mode_users[1] = second;
505 strcpy(mode_users[1],"+");
506 unsigned int modectr = 2;
508 std::string channel = params[0];
510 chanrec* chan = Srv->FindChannel(channel);
515 strlcpy(mode_users[0],channel.c_str(),MAXBUF);
516 for (unsigned int usernum = 1; usernum < params.size(); usernum++)
518 // process one channel at a time, applying modes.
519 char* usr = (char*)params[usernum].c_str();
520 char permissions = *usr;
522 userrec* who = Srv->FindNick(usr);
529 mode_users[modectr++] = usr;
530 strlcat(modestring,"o",MAXBUF);
534 mode_users[modectr++] = usr;
535 strlcat(modestring,"h",MAXBUF);
539 mode_users[modectr++] = usr;
540 strlcat(modestring,"v",MAXBUF);
543 Srv->JoinUserToChannel(who,channel,key);
544 if (modectr >= (MAXMODES-1))
546 // theres a mode for this user. push them onto the mode queue, and flush it
547 // if there are more than MAXMODES to go.
548 Srv->SendMode(mode_users,modectr,who);
549 strcpy(mode_users[1],"+");
554 // there werent enough modes built up to flush it during FJOIN,
555 // or, there are a number left over. flush them out.
558 Srv->SendMode(mode_users,modectr,who);
560 DoOneToAllButSender(source,"FJOIN",params,who->server);
564 bool IntroduceClient(std::string source, std::deque<std::string> params)
566 if (params.size() < 8)
568 // NICK age nick host dhost ident +modes ip :gecos
570 std::string nick = params[1];
571 std::string host = params[2];
572 std::string dhost = params[3];
573 std::string ident = params[4];
574 time_t age = atoi(params[0].c_str());
575 std::string modes = params[5];
576 if (*(modes.c_str()) == '+')
578 char* m = (char*)modes.c_str();
582 std::string ip = params[6];
583 std::string gecos = params[7];
584 char* tempnick = (char*)nick.c_str();
585 log(DEBUG,"Introduce client %s!%s@%s",tempnick,ident.c_str(),host.c_str());
587 user_hash::iterator iter;
588 iter = clientlist.find(tempnick);
589 if (iter != clientlist.end())
592 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);
593 this->WriteLine(":"+Srv->GetServerName()+" KILL "+tempnick+" :Nickname collision");
597 clientlist[tempnick] = new userrec();
598 clientlist[tempnick]->fd = FD_MAGIC_NUMBER;
599 strlcpy(clientlist[tempnick]->nick, tempnick,NICKMAX);
600 strlcpy(clientlist[tempnick]->host, host.c_str(),160);
601 strlcpy(clientlist[tempnick]->dhost, dhost.c_str(),160);
602 clientlist[tempnick]->server = (char*)FindServerNamePtr(source.c_str());
603 strlcpy(clientlist[tempnick]->ident, ident.c_str(),IDENTMAX);
604 strlcpy(clientlist[tempnick]->fullname, gecos.c_str(),MAXGECOS);
605 clientlist[tempnick]->registered = 7;
606 clientlist[tempnick]->signon = age;
607 strlcpy(clientlist[tempnick]->ip,ip.c_str(),16);
608 for (int i = 0; i < MAXCHANS; i++)
610 clientlist[tempnick]->chans[i].channel = NULL;
611 clientlist[tempnick]->chans[i].uc_modes = 0;
613 params[7] = ":" + params[7];
614 DoOneToAllButSender(source,"NICK",params,source);
618 void SendFJoins(TreeServer* Current, chanrec* c)
621 snprintf(list,MAXBUF,":%s FJOIN %s ",Srv->GetServerName(),c->name);
622 std::vector<char*> *ulist = c->GetUsers();
623 for (unsigned int i = 0; i < ulist->size(); i++)
625 char* o = (*ulist)[i];
626 userrec* otheruser = (userrec*)o;
627 strlcat(list,cmode(otheruser,c),MAXBUF);
628 strlcat(list,otheruser->nick,MAXBUF);
629 strlcat(list," ",MAXBUF);
630 if (strlen(list)>(480-NICKMAX))
632 this->WriteLine(list);
633 snprintf(list,MAXBUF,":%s FJOIN %s ",Srv->GetServerName(),c->name);
636 if (list[strlen(list)-1] != ':')
638 this->WriteLine(list);
642 void SendChannelModes(TreeServer* Current)
645 for (chan_hash::iterator c = chanlist.begin(); c != chanlist.end(); c++)
647 SendFJoins(Current, c->second);
648 snprintf(data,MAXBUF,":%s FMODE %s +%s",Srv->GetServerName().c_str(),c->second->name,chanmodes(c->second));
649 this->WriteLine(data);
650 if (*c->second->topic)
652 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);
653 this->WriteLine(data);
655 for (BanList::iterator b = c->second->bans.begin(); b != c->second->bans.end(); b++)
657 snprintf(data,MAXBUF,":%s FMODE %s +b %s",Srv->GetServerName().c_str(),c->second->name,b->data);
658 this->WriteLine(data);
660 FOREACH_MOD OnSyncChannel(c->second,(Module*)TreeProtocolModule,(void*)this);
664 // send all users and their channels
665 void SendUsers(TreeServer* Current)
668 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
670 if (u->second->registered == 7)
672 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);
673 this->WriteLine(data);
674 if (strchr(u->second->modes,'o'))
676 this->WriteLine(":"+std::string(u->second->nick)+" OPERTYPE "+std::string(u->second->oper));
678 //char* chl = chlist(u->second,u->second);
681 // this->WriteLine(":"+std::string(u->second->nick)+" FJOIN "+std::string(chl));
683 FOREACH_MOD OnSyncUser(u->second,(Module*)TreeProtocolModule,(void*)this);
688 void DoBurst(TreeServer* s)
690 log(DEBUG,"Beginning network burst");
691 Srv->SendOpers("*** Bursting to "+s->GetName()+".");
692 this->WriteLine("BURST");
694 this->SendServers(TreeRoot,s,1);
695 // Send users and their channels
697 // TODO: Send everything else (channel modes etc)
698 this->SendChannelModes(s);
699 this->WriteLine("ENDBURST");
702 virtual bool OnDataReady()
704 char* data = this->Read();
707 this->in_buffer += data;
708 while (in_buffer.find("\n") != std::string::npos)
710 char* line = (char*)in_buffer.c_str();
711 std::string ret = "";
712 while ((*line != '\n') && (strlen(line)))
717 if ((*line == '\n') || (*line == '\r'))
720 if (!this->ProcessLine(ret))
726 return (data != NULL);
729 int WriteLine(std::string line)
731 return this->Write(line + "\r\n");
734 bool Error(std::deque<std::string> params)
736 if (params.size() < 1)
738 std::string Errmsg = params[0];
739 std::string SName = myhost;
740 if (InboundServerName != "")
742 SName = InboundServerName;
744 Srv->SendOpers("*** ERROR from "+SName+": "+Errmsg);
745 // we will return false to cause the socket to close.
749 bool OperType(std::string prefix, std::deque<std::string> params)
751 if (params.size() != 1)
753 std::string opertype = params[0];
754 userrec* u = Srv->FindNick(prefix);
757 strlcpy(u->oper,opertype.c_str(),NICKMAX);
758 if (!strchr(u->modes,'o'))
760 strcat(u->modes,"o");
762 DoOneToAllButSender(u->server,"OPERTYPE",params,u->server);
767 bool RemoteRehash(std::string prefix, std::deque<std::string> params)
769 if (params.size() < 1)
771 std::string servermask = params[0];
772 if (Srv->MatchText(Srv->GetServerName(),servermask))
774 Srv->SendOpers("*** Remote rehash initiated from server \002"+prefix+"\002.");
776 ReadConfiguration(false);
778 DoOneToAllButSender(prefix,"REHASH",params,prefix);
782 bool RemoteKill(std::string prefix, std::deque<std::string> params)
784 if (params.size() != 2)
786 std::string nick = params[0];
787 std::string reason = params[1];
788 userrec* u = Srv->FindNick(prefix);
789 userrec* who = Srv->FindNick(nick);
792 std::string sourceserv = prefix;
795 sourceserv = u->server;
797 params[1] = ":" + params[1];
798 DoOneToAllButSender(prefix,"KILL",params,sourceserv);
799 Srv->QuitUser(who,reason);
804 bool RemoteServer(std::string prefix, std::deque<std::string> params)
806 if (params.size() < 4)
808 std::string servername = params[0];
809 std::string password = params[1];
810 // hopcount is not used for a remote server, we calculate this ourselves
811 std::string description = params[3];
812 TreeServer* ParentOfThis = FindServer(prefix);
815 this->WriteLine("ERROR :Protocol error - Introduced remote server from unknown server "+prefix);
818 TreeServer* Node = new TreeServer(servername,description,ParentOfThis,NULL);
819 ParentOfThis->AddChild(Node);
820 params[3] = ":" + params[3];
821 DoOneToAllButSender(prefix,"SERVER",params,prefix);
822 Srv->SendOpers("*** Server \002"+prefix+"\002 introduced server \002"+servername+"\002 ("+description+")");
826 bool Outbound_Reply_Server(std::deque<std::string> params)
828 if (params.size() < 4)
830 std::string servername = params[0];
831 std::string password = params[1];
832 int hops = atoi(params[2].c_str());
835 this->WriteLine("ERROR :Server too far away for authentication");
838 std::string description = params[3];
839 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
841 if ((x->Name == servername) && (x->RecvPass == password))
843 // Begin the sync here. this kickstarts the
844 // other side, waiting in WAIT_AUTH_2 state,
845 // into starting their burst, as it shows
847 this->LinkState = CONNECTED;
848 // we should add the details of this server now
849 // to the servers tree, as a child of the root
851 TreeServer* Node = new TreeServer(servername,description,TreeRoot,this);
852 TreeRoot->AddChild(Node);
853 params[3] = ":" + params[3];
854 DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,servername);
859 this->WriteLine("ERROR :Invalid credentials");
863 bool Inbound_Server(std::deque<std::string> params)
865 if (params.size() < 4)
867 std::string servername = params[0];
868 std::string password = params[1];
869 int hops = atoi(params[2].c_str());
872 this->WriteLine("ERROR :Server too far away for authentication");
875 std::string description = params[3];
876 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
878 if ((x->Name == servername) && (x->RecvPass == password))
880 Srv->SendOpers("*** Verified incoming server connection from \002"+servername+"\002["+this->GetIP()+"] ("+description+")");
881 this->InboundServerName = servername;
882 this->InboundDescription = description;
883 // this is good. Send our details: Our server name and description and hopcount of 0,
884 // along with the sendpass from this block.
885 this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
886 // move to the next state, we are now waiting for THEM.
887 this->LinkState = WAIT_AUTH_2;
891 this->WriteLine("ERROR :Invalid credentials");
895 std::deque<std::string> Split(std::string line, bool stripcolon)
897 std::deque<std::string> n;
898 std::stringstream s(line);
899 std::string param = "";
905 //if ((param != "") && (param != "\n"))
907 if ((param.c_str()[0] == ':') && (item))
909 char* str = (char*)param.c_str();
919 param = param + " " + append;
930 bool ProcessLine(std::string line)
932 char* l = (char*)line.c_str();
933 while ((strlen(l)) && (l[strlen(l)-1] == '\r') || (l[strlen(l)-1] == '\n'))
934 l[strlen(l)-1] = '\0';
938 Srv->Log(DEBUG,"inbound-line: '"+line+"'");
939 std::deque<std::string> params = this->Split(line,true);
940 std::string command = "";
941 std::string prefix = "";
942 if (((params[0].c_str())[0] == ':') && (params.size() > 1))
946 char* pref = (char*)prefix.c_str();
958 switch (this->LinkState)
963 // Waiting for SERVER command from remote server. Server initiating
964 // the connection sends the first SERVER command, listening server
965 // replies with theirs if its happy, then if the initiator is happy,
966 // it starts to send its net sync, which starts the merge, otherwise
967 // it sends an ERROR.
968 if (command == "SERVER")
970 return this->Inbound_Server(params);
972 else if (command == "ERROR")
974 return this->Error(params);
978 // Waiting for start of other side's netmerge to say they liked our
980 if (command == "SERVER")
982 // cant do this, they sent it to us in the WAIT_AUTH_1 state!
986 else if (command == "BURST")
988 this->LinkState = CONNECTED;
989 Node = new TreeServer(InboundServerName,InboundDescription,TreeRoot,this);
990 TreeRoot->AddChild(Node);
992 params.push_back(InboundServerName);
993 params.push_back("*");
994 params.push_back("1");
995 params.push_back(":"+InboundDescription);
996 DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,InboundServerName);
999 else if (command == "ERROR")
1001 return this->Error(params);
1006 this->WriteLine("ERROR :Internal error -- listening socket accepted its own descriptor!!!");
1010 if (command == "SERVER")
1012 // another server we connected to, which was in WAIT_AUTH_1 state,
1013 // has just sent us their credentials. If we get this far, theyre
1014 // happy with OUR credentials, and they are now in WAIT_AUTH_2 state.
1015 // if we're happy with this, we should send our netburst which
1016 // kickstarts the merge.
1017 return this->Outbound_Reply_Server(params);
1019 else if (command == "ERROR")
1021 return this->Error(params);
1025 // This is the 'authenticated' state, when all passwords
1026 // have been exchanged and anything past this point is taken
1028 std::string target = "";
1029 if ((command == "NICK") && (params.size() > 1))
1031 return this->IntroduceClient(prefix,params);
1033 else if (command == "FJOIN")
1035 return this->ForceJoin(prefix,params);
1037 else if (command == "SERVER")
1039 return this->RemoteServer(prefix,params);
1041 else if (command == "ERROR")
1043 return this->Error(params);
1045 else if (command == "OPERTYPE")
1047 return this->OperType(prefix,params);
1049 else if (command == "FMODE")
1051 return this->ForceMode(prefix,params);
1053 else if (command == "KILL")
1055 return this->RemoteKill(prefix,params);
1057 else if (command == "FTOPIC")
1059 return this->ForceTopic(prefix,params);
1061 else if (command == "REHASH")
1063 return this->RemoteRehash(prefix,params);
1065 else if (command == "SQUIT")
1067 if (params.size() == 2)
1069 this->Squit(FindServer(params[0]),params[1]);
1075 // not a special inter-server command.
1076 // Emulate the actual user doing the command,
1077 // this saves us having a huge ugly parser.
1078 userrec* who = Srv->FindNick(prefix);
1079 std::string sourceserv = this->myhost;
1080 if (this->InboundServerName != "")
1082 sourceserv = this->InboundServerName;
1087 target = who->server;
1088 char* strparams[127];
1089 for (unsigned int q = 0; q < params.size(); q++)
1091 strparams[q] = (char*)params[q].c_str();
1093 log(DEBUG,"*** CALL COMMAND HANDLER FOR %s, SOURCE: '%s'",command.c_str(),who->nick);
1094 Srv->CallCommandHandler(command, strparams, params.size(), who);
1098 // its not a user. Its either a server, or somethings screwed up.
1099 if (IsServer(prefix))
1101 target = Srv->GetServerName();
1105 log(DEBUG,"Command with unknown origin '%s'",prefix.c_str());
1109 return DoOneToAllButSenderRaw(line,sourceserv);
1118 virtual std::string GetName()
1120 std::string sourceserv = this->myhost;
1121 if (this->InboundServerName != "")
1123 sourceserv = this->InboundServerName;
1128 virtual void OnTimeout()
1130 if (this->LinkState == CONNECTING)
1132 Srv->SendOpers("*** CONNECT: Connection to \002"+myhost+"\002 timed out.");
1136 virtual void OnClose()
1138 // Connection closed.
1139 // If the connection is fully up (state CONNECTED)
1140 // then propogate a netsplit to all peers.
1141 std::string quitserver = this->myhost;
1142 if (this->InboundServerName != "")
1144 quitserver = this->InboundServerName;
1146 TreeServer* s = FindServer(quitserver);
1149 Squit(s,"Remote host closed the connection");
1153 virtual int OnIncomingConnection(int newsock, char* ip)
1155 TreeSocket* s = new TreeSocket(newsock, ip);
1161 bool DoOneToAllButSenderRaw(std::string data,std::string omit)
1163 TreeServer* omitroute = BestRouteTo(omit);
1164 for (unsigned int x = 0; x < TreeRoot->ChildCount(); x++)
1166 TreeServer* Route = TreeRoot->GetChild(x);
1167 if ((Route->GetSocket()) && (Route->GetName() != omit) && (omitroute != Route))
1169 TreeSocket* Sock = Route->GetSocket();
1170 log(DEBUG,"Sending RAW to %s",Route->GetName().c_str());
1171 Sock->WriteLine(data);
1177 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> params, std::string omit)
1179 log(DEBUG,"ALLBUTONE: Comes from %s SHOULD NOT go back to %s",prefix.c_str(),omit.c_str());
1180 TreeServer* omitroute = BestRouteTo(omit);
1181 // TODO: Special stuff with privmsg and notice
1182 std::string FullLine = ":" + prefix + " " + command;
1183 for (unsigned int x = 0; x < params.size(); x++)
1185 FullLine = FullLine + " " + params[x];
1187 for (unsigned int x = 0; x < TreeRoot->ChildCount(); x++)
1189 TreeServer* Route = TreeRoot->GetChild(x);
1190 // Send the line IF:
1191 // The route has a socket (its a direct connection)
1192 // The route isnt the one to be omitted
1193 // The route isnt the path to the one to be omitted
1194 if ((Route->GetSocket()) && (Route->GetName() != omit) && (omitroute != Route))
1196 TreeSocket* Sock = Route->GetSocket();
1197 log(DEBUG,"Sending to %s",Route->GetName().c_str());
1198 Sock->WriteLine(FullLine);
1204 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> params)
1206 Srv->Log(DEBUG,"ONETOMANY: "+command);
1207 std::string FullLine = ":" + prefix + " " + command;
1208 for (unsigned int x = 0; x < params.size(); x++)
1210 FullLine = FullLine + " " + params[x];
1212 for (unsigned int x = 0; x < TreeRoot->ChildCount(); x++)
1214 TreeServer* Route = TreeRoot->GetChild(x);
1215 if (Route->GetSocket())
1217 TreeSocket* Sock = Route->GetSocket();
1218 Sock->WriteLine(FullLine);
1224 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> params, std::string target)
1226 TreeServer* Route = BestRouteTo(target);
1229 std::string FullLine = ":" + prefix + " " + command;
1230 for (unsigned int x = 0; x < params.size(); x++)
1232 FullLine = FullLine + " " + params[x];
1234 if (Route->GetSocket())
1236 TreeSocket* Sock = Route->GetSocket();
1237 Sock->WriteLine(FullLine);
1243 log(DEBUG,"Could not route message with target %s: %s",target.c_str(),command.c_str());
1248 std::vector<TreeSocket*> Bindings;
1250 void ReadConfiguration(bool rebind)
1254 for (int j =0; j < Conf->Enumerate("bind"); j++)
1256 std::string Type = Conf->ReadValue("bind","type",j);
1257 std::string IP = Conf->ReadValue("bind","address",j);
1258 long Port = Conf->ReadInteger("bind","port",j,true);
1259 if (Type == "servers")
1265 TreeSocket* listener = new TreeSocket(IP.c_str(),Port,true,10);
1266 if (listener->GetState() == I_LISTENING)
1268 Srv->AddSocket(listener);
1269 Bindings.push_back(listener);
1273 log(DEFAULT,"m_spanningtree: Warning: Failed to bind server port %d",Port);
1281 for (int j =0; j < Conf->Enumerate("link"); j++)
1284 L.Name = Conf->ReadValue("link","name",j);
1285 L.IPAddr = Conf->ReadValue("link","ipaddr",j);
1286 L.Port = Conf->ReadInteger("link","port",j,true);
1287 L.SendPass = Conf->ReadValue("link","sendpass",j);
1288 L.RecvPass = Conf->ReadValue("link","recvpass",j);
1289 LinkBlocks.push_back(L);
1290 log(DEBUG,"m_spanningtree: Read server %s with host %s:%d",L.Name.c_str(),L.IPAddr.c_str(),L.Port);
1295 class ModuleSpanningTree : public Module
1297 std::vector<TreeSocket*> Bindings;
1302 ModuleSpanningTree()
1305 Conf = new ConfigReader;
1308 // Create the root of the tree
1309 TreeRoot = new TreeServer(Srv->GetServerName(),Srv->GetServerDescription());
1311 ReadConfiguration(true);
1314 void ShowLinks(TreeServer* Current, userrec* user, int hops)
1316 std::string Parent = TreeRoot->GetName();
1317 if (Current->GetParent())
1319 Parent = Current->GetParent()->GetName();
1321 for (unsigned int q = 0; q < Current->ChildCount(); q++)
1323 ShowLinks(Current->GetChild(q),user,hops+1);
1325 WriteServ(user->fd,"364 %s %s %s :%d %s",user->nick,Current->GetName().c_str(),Parent.c_str(),hops,Current->GetDesc().c_str());
1328 void HandleLinks(char** parameters, int pcnt, userrec* user)
1330 ShowLinks(TreeRoot,user,0);
1331 WriteServ(user->fd,"365 %s * :End of /LINKS list.",user->nick);
1335 void HandleLusers(char** parameters, int pcnt, userrec* user)
1340 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
1342 void ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80])
1346 for (int t = 0; t < depth; t++)
1348 matrix[line][t] = ' ';
1350 strlcpy(&matrix[line][depth],Current->GetName().c_str(),80);
1352 for (unsigned int q = 0; q < Current->ChildCount(); q++)
1354 ShowMap(Current->GetChild(q),user,depth+2,matrix);
1359 // Ok, prepare to be confused.
1360 // After much mulling over how to approach this, it struck me that
1361 // the 'usual' way of doing a /MAP isnt the best way. Instead of
1362 // keeping track of a ton of ascii characters, and line by line
1363 // under recursion working out where to place them using multiplications
1364 // and divisons, we instead render the map onto a backplane of characters
1365 // (a character matrix), then draw the branches as a series of "L" shapes
1366 // from the nodes. This is not only friendlier on CPU it uses less stack.
1368 void HandleMap(char** parameters, int pcnt, userrec* user)
1370 // This array represents a virtual screen which we will
1371 // "scratch" draw to, as the console device of an irc
1372 // client does not provide for a proper terminal.
1373 char matrix[128][80];
1374 for (unsigned int t = 0; t < 128; t++)
1376 matrix[t][0] = '\0';
1379 // The only recursive bit is called here.
1380 ShowMap(TreeRoot,user,0,matrix);
1381 // Process each line one by one. The algorithm has a limit of
1382 // 128 servers (which is far more than a spanning tree should have
1383 // anyway, so we're ok). This limit can be raised simply by making
1384 // the character matrix deeper, 128 rows taking 10k of memory.
1385 for (int l = 1; l < line; l++)
1387 // scan across the line looking for the start of the
1388 // servername (the recursive part of the algorithm has placed
1389 // the servers at indented positions depending on what they
1391 int first_nonspace = 0;
1392 while (matrix[l][first_nonspace] == ' ')
1397 // Draw the `- (corner) section: this may be overwritten by
1398 // another L shape passing along the same vertical pane, becoming
1399 // a |- (branch) section instead.
1400 matrix[l][first_nonspace] = '-';
1401 matrix[l][first_nonspace-1] = '`';
1403 // Draw upwards until we hit the parent server, causing possibly
1404 // other corners (`-) to become branches (|-)
1405 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
1407 matrix[l2][first_nonspace-1] = '|';
1411 // dump the whole lot to the user. This is the easy bit, honest.
1412 for (int t = 0; t < line; t++)
1414 WriteServ(user->fd,"006 %s :%s",user->nick,&matrix[t][0]);
1416 WriteServ(user->fd,"007 %s :End of /MAP",user->nick);
1420 int HandleSquit(char** parameters, int pcnt, userrec* user)
1425 int HandleConnect(char** parameters, int pcnt, userrec* user)
1427 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1429 if (Srv->MatchText(x->Name.c_str(),parameters[0]))
1431 WriteServ(user->fd,"NOTICE %s :*** CONNECT: Connecting to server: %s (%s:%d)",user->nick,x->Name.c_str(),x->IPAddr.c_str(),x->Port);
1432 TreeSocket* newsocket = new TreeSocket(x->IPAddr,x->Port,false,10,x->Name);
1433 Srv->AddSocket(newsocket);
1437 WriteServ(user->fd,"NOTICE %s :*** CONNECT: No matching server could be found in the config file.",user->nick);
1441 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user)
1443 if (command == "CONNECT")
1445 return this->HandleConnect(parameters,pcnt,user);
1447 else if (command == "SQUIT")
1449 return this->HandleSquit(parameters,pcnt,user);
1451 else if (command == "MAP")
1453 this->HandleMap(parameters,pcnt,user);
1456 else if (command == "LUSERS")
1458 this->HandleLusers(parameters,pcnt,user);
1461 else if (command == "LINKS")
1463 this->HandleLinks(parameters,pcnt,user);
1466 else if (Srv->IsValidModuleCommand(command, pcnt, user))
1468 // this bit of code cleverly routes all module commands
1469 // to all remote severs *automatically* so that modules
1470 // can just handle commands locally, without having
1471 // to have any special provision in place for remote
1472 // commands and linking protocols.
1473 std::deque<std::string> params;
1475 for (int j = 0; j < pcnt; j++)
1477 if (strchr(parameters[j],' '))
1479 params.push_back(":" + std::string(parameters[j]));
1483 params.push_back(std::string(parameters[j]));
1486 DoOneToMany(user->nick,command,params);
1491 virtual void OnGetServerDescription(std::string servername,std::string &description)
1493 TreeServer* s = FindServer(servername);
1496 description = s->GetDesc();
1500 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
1502 if (std::string(source->server) == Srv->GetServerName())
1504 std::deque<std::string> params;
1505 params.push_back(dest->nick);
1506 params.push_back(channel->name);
1507 DoOneToMany(source->nick,"INVITE",params);
1511 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic)
1513 std::deque<std::string> params;
1514 params.push_back(chan->name);
1515 params.push_back(":"+topic);
1516 DoOneToMany(user->nick,"TOPIC",params);
1519 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text)
1521 if (target_type == TYPE_USER)
1523 userrec* d = (userrec*)dest;
1524 if ((std::string(d->server) != Srv->GetServerName()) && (std::string(user->server) == Srv->GetServerName()))
1526 std::deque<std::string> params;
1528 params.push_back(d->nick);
1529 params.push_back(":"+text);
1530 DoOneToOne(user->nick,"NOTICE",params,d->server);
1535 if (std::string(user->server) == Srv->GetServerName())
1537 chanrec *c = (chanrec*)dest;
1538 std::deque<std::string> params;
1539 params.push_back(c->name);
1540 params.push_back(":"+text);
1541 DoOneToMany(user->nick,"NOTICE",params);
1546 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text)
1548 if (target_type == TYPE_USER)
1550 // route private messages which are targetted at clients only to the server
1551 // which needs to receive them
1552 userrec* d = (userrec*)dest;
1553 if ((std::string(d->server) != Srv->GetServerName()) && (std::string(user->server) == Srv->GetServerName()))
1555 std::deque<std::string> params;
1557 params.push_back(d->nick);
1558 params.push_back(":"+text);
1559 DoOneToOne(user->nick,"PRIVMSG",params,d->server);
1564 if (std::string(user->server) == Srv->GetServerName())
1566 chanrec *c = (chanrec*)dest;
1567 std::deque<std::string> params;
1568 params.push_back(c->name);
1569 params.push_back(":"+text);
1570 DoOneToMany(user->nick,"PRIVMSG",params);
1575 virtual void OnUserJoin(userrec* user, chanrec* channel)
1577 // Only do this for local users
1578 if (std::string(user->server) == Srv->GetServerName())
1580 log(DEBUG,"**** User on %s JOINS %s",user->server,channel->name);
1581 std::deque<std::string> params;
1583 params.push_back(channel->name);
1586 log(DEBUG,"**** With key %s",channel->key);
1587 // if the channel has a key, force the join by emulating the key.
1588 params.push_back(channel->key);
1590 DoOneToMany(user->nick,"JOIN",params);
1594 virtual void OnUserPart(userrec* user, chanrec* channel)
1596 if (std::string(user->server) == Srv->GetServerName())
1598 log(DEBUG,"**** User on %s PARTS %s",user->server,channel->name);
1599 std::deque<std::string> params;
1601 params.push_back(channel->name);
1602 DoOneToMany(user->nick,"PART",params);
1606 virtual void OnUserConnect(userrec* user)
1608 char agestr[MAXBUF];
1609 if (std::string(user->server) == Srv->GetServerName())
1611 log(DEBUG,"**** User on %s CONNECTS: %s",user->server,user->nick);
1612 std::deque<std::string> params;
1613 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
1615 params.push_back(agestr);
1616 params.push_back(user->nick);
1617 params.push_back(user->host);
1618 params.push_back(user->dhost);
1619 params.push_back(user->ident);
1620 params.push_back("+"+std::string(user->modes));
1621 params.push_back(user->ip);
1622 params.push_back(":"+std::string(user->fullname));
1623 DoOneToMany(Srv->GetServerName(),"NICK",params);
1627 virtual void OnUserQuit(userrec* user, std::string reason)
1629 if (std::string(user->server) == Srv->GetServerName())
1631 log(DEBUG,"**** User on %s QUITS: %s",user->server,user->nick);
1632 std::deque<std::string> params;
1633 params.push_back(":"+reason);
1634 DoOneToMany(user->nick,"QUIT",params);
1638 virtual void OnUserPostNick(userrec* user, std::string oldnick)
1640 if (std::string(user->server) == Srv->GetServerName())
1642 log(DEBUG,"**** User on %s changes NICK: %s",user->server,user->nick);
1643 std::deque<std::string> params;
1644 params.push_back(user->nick);
1645 DoOneToMany(oldnick,"NICK",params);
1649 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason)
1651 if (std::string(source->server) == Srv->GetServerName())
1653 log(DEBUG,"**** User on %s KICKs: %s %s",source->server,source->nick,user->nick);
1654 std::deque<std::string> params;
1655 params.push_back(chan->name);
1656 params.push_back(user->nick);
1657 params.push_back(":"+reason);
1658 DoOneToMany(source->nick,"KICK",params);
1662 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason)
1664 std::deque<std::string> params;
1665 params.push_back(dest->nick);
1666 params.push_back(":"+reason);
1667 DoOneToMany(source->nick,"KILL",params);
1670 virtual void OnRehash(std::string parameter)
1672 if (parameter != "")
1674 std::deque<std::string> params;
1675 params.push_back(parameter);
1676 DoOneToMany(Srv->GetServerName(),"REHASH",params);
1678 if (Srv->MatchText(Srv->GetServerName(),parameter))
1680 Srv->SendOpers("*** Remote rehash initiated from server \002"+Srv->GetServerName()+"\002.");
1681 Srv->RehashServer();
1684 ReadConfiguration(false);
1687 // note: the protocol does not allow direct umode +o except
1688 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1690 virtual void OnOper(userrec* user, std::string opertype)
1692 if (std::string(user->server) == Srv->GetServerName())
1694 std::deque<std::string> params;
1695 params.push_back(opertype);
1696 DoOneToMany(user->nick,"OPERTYPE",params);
1700 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text)
1702 log(DEBUG,"*** ONMODE TRIGGER");
1703 if (std::string(user->server) == Srv->GetServerName())
1705 log(DEBUG,"*** LOCAL");
1706 if (target_type == TYPE_USER)
1708 userrec* u = (userrec*)dest;
1709 std::deque<std::string> params;
1710 params.push_back(u->nick);
1711 params.push_back(text);
1712 DoOneToMany(user->nick,"MODE",params);
1716 chanrec* c = (chanrec*)dest;
1717 std::deque<std::string> params;
1718 params.push_back(c->name);
1719 params.push_back(text);
1720 DoOneToMany(user->nick,"MODE",params);
1725 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline)
1727 TreeSocket* s = (TreeSocket*)opaque;
1730 if (target_type == TYPE_USER)
1732 userrec* u = (userrec*)target;
1733 s->WriteLine(":"+Srv->GetServerName()+" FMODE "+u->nick+" "+modeline);
1737 chanrec* c = (chanrec*)target;
1738 s->WriteLine(":"+Srv->GetServerName()+" FMODE "+c->name+" "+modeline);
1743 virtual ~ModuleSpanningTree()
1748 virtual Version GetVersion()
1750 return Version(1,0,0,0,VF_STATIC|VF_VENDOR);
1755 class ModuleSpanningTreeFactory : public ModuleFactory
1758 ModuleSpanningTreeFactory()
1762 ~ModuleSpanningTreeFactory()
1766 virtual Module * CreateModule()
1768 TreeProtocolModule = new ModuleSpanningTree;
1769 return TreeProtocolModule;
1775 extern "C" void * init_module( void )
1777 return new ModuleSpanningTreeFactory;