1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 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 * ---------------------------------------------------
17 /* $ModDesc: Povides a spanning tree server link protocol */
25 #include "inspircd_config.h"
27 #include <ext/hash_map>
36 #include "helperfuncs.h"
38 #include "inspstring.h"
43 #include "cull_list.h"
47 #define nspace __gnu_cxx
53 * The server list in InspIRCd is maintained as two structures
54 * which hold the data in different ways. Most of the time, we
55 * want to very quicky obtain three pieces of information:
57 * (1) The information on a server
58 * (2) The information on the server we must send data through
59 * to actually REACH the server we're after
60 * (3) Potentially, the child/parent objects of this server
62 * The InspIRCd spanning protocol provides easy access to these
63 * by storing the data firstly in a recursive structure, where
64 * each item references its parent item, and a dynamic list
65 * of child items, and another structure which stores the items
66 * hashed, linearly. This means that if we want to find a server
67 * by name quickly, we can look it up in the hash, avoiding
68 * any O(n) lookups. If however, during a split or sync, we want
69 * to apply an operation to a server, and any of its child objects
70 * we can resort to recursion to walk the tree structure.
73 class ModuleSpanningTree;
74 static ModuleSpanningTree* TreeProtocolModule;
76 extern ServerConfig* Config;
78 extern std::vector<Module*> modules;
79 extern std::vector<ircd_module*> factory;
82 /* Any socket can have one of five states at any one time.
83 * The LISTENER state indicates a socket which is listening
84 * for connections. It cannot receive data itself, only incoming
86 * The CONNECTING state indicates an outbound socket which is
87 * waiting to be writeable.
88 * The WAIT_AUTH_1 state indicates the socket is outbound and
89 * has successfully connected, but has not yet sent and received
91 * The WAIT_AUTH_2 state indicates that the socket is inbound
92 * (allocated by a LISTENER) but has not yet sent and received
94 * The CONNECTED state represents a fully authorized, fully
97 enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
99 /* We need to import these from the core for use in netbursts */
100 extern user_hash clientlist;
101 extern chan_hash chanlist;
103 /* Foward declarations */
107 /* This variable represents the root of the server tree
108 * (for all intents and purposes, it's us)
110 TreeServer *TreeRoot;
114 /* This hash_map holds the hash equivalent of the server
115 * tree, used for rapid linear lookups.
117 typedef nspace::hash_map<std::string, TreeServer*> server_hash;
118 server_hash serverlist;
120 /* More forward declarations */
121 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> ¶ms, std::string target);
122 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> ¶ms, std::string omit);
123 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> ¶ms);
124 bool DoOneToAllButSenderRaw(std::string data, std::string omit, std::string prefix, std::string command, std::deque<std::string> ¶ms);
125 void ReadConfiguration(bool rebind);
127 /* Imported from xline.cpp for use during netburst */
128 extern std::vector<KLine> klines;
129 extern std::vector<GLine> glines;
130 extern std::vector<ZLine> zlines;
131 extern std::vector<QLine> qlines;
132 extern std::vector<ELine> elines;
133 extern std::vector<KLine> pklines;
134 extern std::vector<GLine> pglines;
135 extern std::vector<ZLine> pzlines;
136 extern std::vector<QLine> pqlines;
137 extern std::vector<ELine> pelines;
139 /* Each server in the tree is represented by one class of
140 * type TreeServer. A locally connected TreeServer can
141 * have a class of type TreeSocket associated with it, for
142 * remote servers, the TreeSocket entry will be NULL.
143 * Each server also maintains a pointer to its parent
144 * (NULL if this server is ours, at the top of the tree)
145 * and a pointer to its "Route" (see the comments in the
146 * constructors below), and also a dynamic list of pointers
147 * to its children which can be iterated recursively
148 * if required. Creating or deleting objects of type
149 * TreeServer automatically maintains the hash_map of
150 * TreeServer items, deleting and inserting them as they
151 * are created and destroyed.
156 TreeServer* Parent; /* Parent entry */
157 TreeServer* Route; /* Route entry */
158 std::vector<TreeServer*> Children; /* List of child objects */
159 std::string ServerName; /* Server's name */
160 std::string ServerDesc; /* Server's description */
161 std::string VersionString; /* Version string or empty string */
162 int UserCount; /* Not used in this version */
163 int OperCount; /* Not used in this version */
164 TreeSocket* Socket; /* For directly connected servers this points at the socket object */
165 time_t NextPing; /* After this time, the server should be PINGed*/
166 bool LastPingWasGood; /* True if the server responded to the last PING with a PONG */
170 /* We don't use this constructor. Its a dummy, and won't cause any insertion
171 * of the TreeServer into the hash_map. See below for the two we DO use.
179 UserCount = OperCount = 0;
180 VersionString = Srv->GetVersion();
183 /* We use this constructor only to create the 'root' item, TreeRoot, which
184 * represents our own server. Therefore, it has no route, no parent, and
185 * no socket associated with it. Its version string is our own local version.
187 TreeServer(std::string Name, std::string Desc) : ServerName(Name), ServerDesc(Desc)
191 UserCount = OperCount = 0;
192 VersionString = Srv->GetVersion();
194 Socket = NULL; /* Fix by brain */
198 /* When we create a new server, we call this constructor to initialize it.
199 * This constructor initializes the server's Route and Parent, and sets up
200 * its ping counters so that it will be pinged one minute from now.
202 TreeServer(std::string Name, std::string Desc, TreeServer* Above, TreeSocket* Sock) : Parent(Above), ServerName(Name), ServerDesc(Desc), Socket(Sock)
205 UserCount = OperCount = 0;
206 this->SetNextPingTime(time(NULL) + 120);
209 /* find the 'route' for this server (e.g. the one directly connected
210 * to the local server, which we can use to reach it)
212 * In the following example, consider we have just added a TreeServer
213 * class for server G on our network, of which we are server A.
214 * To route traffic to G (marked with a *) we must send the data to
215 * B (marked with a +) so this algorithm initializes the 'Route'
216 * value to point at whichever server traffic must be routed through
217 * to get here. If we were to try this algorithm with server B,
218 * the Route pointer would point at its own object ('this').
228 * We only run this algorithm when a server is created, as
229 * the routes remain constant while ever the server exists, and
230 * do not need to be re-calculated.
234 if (Route == TreeRoot)
240 while (this->Route->GetParent() != TreeRoot)
242 this->Route = Route->GetParent();
246 /* Because recursive code is slow and takes a lot of resources,
247 * we store two representations of the server tree. The first
248 * is a recursive structure where each server references its
249 * children and its parent, which is used for netbursts and
250 * netsplits to dump the whole dataset to the other server,
251 * and the second is used for very fast lookups when routing
252 * messages and is instead a hash_map, where each item can
253 * be referenced by its server name. The AddHashEntry()
254 * call below automatically inserts each TreeServer class
255 * into the hash_map as it is created. There is a similar
256 * maintainance call in the destructor to tidy up deleted
260 this->AddHashEntry();
263 /* This method is used to add the structure to the
264 * hash_map for linear searches. It is only called
265 * by the constructors.
269 server_hash::iterator iter;
270 iter = serverlist.find(this->ServerName);
271 if (iter == serverlist.end())
272 serverlist[this->ServerName] = this;
275 /* This method removes the reference to this object
276 * from the hash_map which is used for linear searches.
277 * It is only called by the default destructor.
281 server_hash::iterator iter;
282 iter = serverlist.find(this->ServerName);
283 if (iter != serverlist.end())
284 serverlist.erase(iter);
287 /* These accessors etc should be pretty self-
291 TreeServer* GetRoute()
296 std::string GetName()
301 std::string GetDesc()
306 std::string GetVersion()
308 return VersionString;
311 void SetNextPingTime(time_t t)
314 LastPingWasGood = false;
317 time_t NextPingTime()
322 bool AnsweredLastPing()
324 return LastPingWasGood;
329 LastPingWasGood = true;
352 TreeSocket* GetSocket()
357 TreeServer* GetParent()
362 void SetVersion(std::string Version)
364 VersionString = Version;
367 unsigned int ChildCount()
369 return Children.size();
372 TreeServer* GetChild(unsigned int n)
374 if (n < Children.size())
376 /* Make sure they cant request
377 * an out-of-range object. After
378 * all we know what these programmer
379 * types are like *grin*.
389 void AddChild(TreeServer* Child)
391 Children.push_back(Child);
394 bool DelChild(TreeServer* Child)
396 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
407 /* Removes child nodes of this node, and of that node, etc etc.
408 * This is used during netsplits to automatically tidy up the
409 * server tree. It is slow, we don't use it for much else.
413 bool stillchildren = true;
414 while (stillchildren)
416 stillchildren = false;
417 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
419 TreeServer* s = (TreeServer*)*a;
423 stillchildren = true;
432 /* We'd better tidy up after ourselves, eh? */
433 this->DelHashEntry();
437 /* The Link class might as well be a struct,
438 * but this is C++ and we don't believe in structs (!).
439 * It holds the entire information of one <link>
440 * tag from the main config file. We maintain a list
441 * of them, and populate the list on rehash/load.
450 std::string SendPass;
451 std::string RecvPass;
452 unsigned long AutoConnect;
453 time_t NextConnectTime;
454 std::string EncryptionKey;
455 bool HiddenFromStats;
458 /* The usual stuff for inspircd modules,
459 * plus the vector of Link classes which we
460 * use to store the <link> tags from the config
464 std::vector<Link> LinkBlocks;
466 /* Yay for fast searches!
467 * This is hundreds of times faster than recursion
468 * or even scanning a linked list, especially when
469 * there are more than a few servers to deal with.
472 TreeServer* FindServer(std::string ServerName)
474 server_hash::iterator iter;
475 iter = serverlist.find(ServerName);
476 if (iter != serverlist.end())
486 /* Returns the locally connected server we must route a
487 * message through to reach server 'ServerName'. This
488 * only applies to one-to-one and not one-to-many routing.
489 * See the comments for the constructor of TreeServer
492 TreeServer* BestRouteTo(std::string ServerName)
494 if (ServerName.c_str() == TreeRoot->GetName())
496 TreeServer* Found = FindServer(ServerName);
499 return Found->GetRoute();
507 /* Find the first server matching a given glob mask.
508 * Theres no find-using-glob method of hash_map [awwww :-(]
509 * so instead, we iterate over the list using an iterator
510 * and match each one until we get a hit. Yes its slow,
513 TreeServer* FindServerMask(std::string ServerName)
515 for (server_hash::iterator i = serverlist.begin(); i != serverlist.end(); i++)
517 if (Srv->MatchText(i->first,ServerName))
523 /* A convenient wrapper that returns true if a server exists */
524 bool IsServer(std::string ServerName)
526 return (FindServer(ServerName) != NULL);
529 /* Every SERVER connection inbound or outbound is represented by
530 * an object of type TreeSocket.
531 * TreeSockets, being inherited from InspSocket, can be tied into
532 * the core socket engine, and we cn therefore receive activity events
533 * for them, just like activex objects on speed. (yes really, that
534 * is a technical term!) Each of these which relates to a locally
535 * connected server is assocated with it, by hooking it onto a
536 * TreeSocket class using its constructor. In this way, we can
537 * maintain a list of servers, some of which are directly connected,
538 * some of which are not.
541 class TreeSocket : public InspSocket
544 std::string in_buffer;
545 ServerState LinkState;
546 std::string InboundServerName;
547 std::string InboundDescription;
549 int num_lost_servers;
551 bool LastPingWasGood;
555 unsigned int keylength;
559 /* Because most of the I/O gubbins are encapsulated within
560 * InspSocket, we just call the superclass constructor for
561 * most of the action, and append a few of our own values
564 TreeSocket(std::string host, int port, bool listening, unsigned long maxtime)
565 : InspSocket(host, port, listening, maxtime)
568 this->LinkState = LISTENER;
570 this->ctx_out = NULL;
573 TreeSocket(std::string host, int port, bool listening, unsigned long maxtime, std::string ServerName)
574 : InspSocket(host, port, listening, maxtime)
577 this->LinkState = CONNECTING;
579 this->ctx_out = NULL;
582 /* When a listening socket gives us a new file descriptor,
583 * we must associate it with a socket without creating a new
584 * connection. This constructor is used for this purpose.
586 TreeSocket(int newfd, char* ip)
587 : InspSocket(newfd, ip)
589 this->LinkState = WAIT_AUTH_1;
591 this->ctx_out = NULL;
592 this->SendCapabilities();
603 void InitAES(std::string key,std::string SName)
610 log(DEBUG,"Initialized AES key %s",key.c_str());
611 // key must be 16, 24, 32 etc bytes (multiple of 8)
612 keylength = key.length();
613 if (!(keylength == 16 || keylength == 24 || keylength == 32))
615 WriteOpers("*** \2ERROR\2: Key length for encryptionkey is not 16, 24 or 32 bytes in length!");
616 log(DEBUG,"Key length not 16, 24 or 32 characters!");
620 WriteOpers("*** \2AES\2: Initialized %d bit encryption to server %s",keylength*8,SName.c_str());
621 ctx_in->MakeKey(key.c_str(), "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\
622 \0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", keylength, keylength);
623 ctx_out->MakeKey(key.c_str(), "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\
624 \0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", keylength, keylength);
628 /* When an outbound connection finishes connecting, we receive
629 * this event, and must send our SERVER string to the other
630 * side. If the other side is happy, as outlined in the server
631 * to server docs on the inspircd.org site, the other side
632 * will then send back its own server string.
634 virtual bool OnConnected()
636 if (this->LinkState == CONNECTING)
638 /* we do not need to change state here. */
639 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
641 if (x->Name == this->myhost)
643 Srv->SendOpers("*** Connection to \2"+myhost+"\2["+(x->HiddenFromStats ? "<hidden>" : this->GetIP())+"] established.");
644 this->SendCapabilities();
645 if (x->EncryptionKey != "")
647 if (!(x->EncryptionKey.length() == 16 || x->EncryptionKey.length() == 24 || x->EncryptionKey.length() == 32))
649 WriteOpers("\2WARNING\2: Your encryption key is NOT 16, 24 or 32 characters in length, encryption will \2NOT\2 be enabled.");
653 this->WriteLine("AES "+Srv->GetServerName());
654 this->InitAES(x->EncryptionKey,x->Name);
657 /* found who we're supposed to be connecting to, send the neccessary gubbins. */
658 this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
663 /* There is a (remote) chance that between the /CONNECT and the connection
664 * being accepted, some muppet has removed the <link> block and rehashed.
665 * If that happens the connection hangs here until it's closed. Unlikely
666 * and rather harmless.
668 Srv->SendOpers("*** Connection to \2"+myhost+"\2 lost link tag(!)");
672 virtual void OnError(InspSocketError e)
674 /* We don't handle this method, because all our
675 * dirty work is done in OnClose() (see below)
676 * which is still called on error conditions too.
680 virtual int OnDisconnect()
682 /* For the same reason as above, we don't
683 * handle OnDisconnect()
688 /* Recursively send the server tree with distances as hops.
689 * This is used during network burst to inform the other server
690 * (and any of ITS servers too) of what servers we know about.
691 * If at any point any of these servers already exist on the other
692 * end, our connection may be terminated. The hopcounts given
693 * by this function are relative, this doesn't matter so long as
694 * they are all >1, as all the remote servers re-calculate them
695 * to be relative too, with themselves as hop 0.
697 void SendServers(TreeServer* Current, TreeServer* s, int hops)
700 for (unsigned int q = 0; q < Current->ChildCount(); q++)
702 TreeServer* recursive_server = Current->GetChild(q);
703 if (recursive_server != s)
705 snprintf(command,1024,":%s SERVER %s * %d :%s",Current->GetName().c_str(),recursive_server->GetName().c_str(),hops,recursive_server->GetDesc().c_str());
706 this->WriteLine(command);
707 this->WriteLine(":"+recursive_server->GetName()+" VERSION :"+recursive_server->GetVersion());
708 /* down to next level */
709 this->SendServers(recursive_server, s, hops+1);
714 std::string MyCapabilities()
716 ServerConfig* Config = Srv->GetConfig();
717 std::vector<std::string> modlist;
718 std::string capabilities = "";
720 for (int i = 0; i <= MODCOUNT; i++)
722 if ((modules[i]->GetVersion().Flags & VF_STATIC) || (modules[i]->GetVersion().Flags & VF_COMMON))
723 modlist.push_back(Config->module_names[i]);
725 sort(modlist.begin(),modlist.end());
726 for (unsigned int i = 0; i < modlist.size(); i++)
729 capabilities = capabilities + ",";
730 capabilities = capabilities + modlist[i];
735 void SendCapabilities()
737 this->WriteLine("CAPAB "+MyCapabilities());
740 bool Capab(std::deque<std::string> params)
742 if (params.size() != 1)
744 this->WriteLine("ERROR :Invalid number of parameters for CAPAB");
747 if (params[0] != this->MyCapabilities())
749 std::string quitserver = this->myhost;
750 if (this->InboundServerName != "")
752 quitserver = this->InboundServerName;
754 WriteOpers("*** \2ERROR\2: Server '%s' does not have the same set of modules loaded, cannot link!",quitserver.c_str());
755 WriteOpers("*** Our networked module set is: '%s'",this->MyCapabilities().c_str());
756 WriteOpers("*** Other server's networked module set is: '%s'",params[0].c_str());
757 WriteOpers("*** These lists must match exactly on both servers. Please correct these errors, and try again.");
758 this->WriteLine("ERROR :CAPAB mismatch; My capabilities: '"+this->MyCapabilities()+"'");
764 /* This function forces this server to quit, removing this server
765 * and any users on it (and servers and users below that, etc etc).
766 * It's very slow and pretty clunky, but luckily unless your network
767 * is having a REAL bad hair day, this function shouldnt be called
768 * too many times a month ;-)
770 void SquitServer(TreeServer* Current, CullList* Goners)
772 /* recursively squit the servers attached to 'Current'.
773 * We're going backwards so we don't remove users
774 * while we still need them ;)
776 for (unsigned int q = 0; q < Current->ChildCount(); q++)
778 TreeServer* recursive_server = Current->GetChild(q);
779 this->SquitServer(recursive_server,Goners);
781 /* Now we've whacked the kids, whack self */
783 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
785 if (!strcasecmp(u->second->server,Current->GetName().c_str()))
787 std::string qreason = Current->GetName()+" "+std::string(Srv->GetServerName());
788 Goners->AddItem(u->second,qreason);
794 /* This is a wrapper function for SquitServer above, which
795 * does some validation first and passes on the SQUIT to all
796 * other remaining servers.
798 void Squit(TreeServer* Current,std::string reason)
800 if ((Current) && (Current != TreeRoot))
802 std::deque<std::string> params;
803 params.push_back(Current->GetName());
804 params.push_back(":"+reason);
805 DoOneToAllButSender(Current->GetParent()->GetName(),"SQUIT",params,Current->GetName());
806 if (Current->GetParent() == TreeRoot)
808 Srv->SendOpers("Server \002"+Current->GetName()+"\002 split: "+reason);
812 Srv->SendOpers("Server \002"+Current->GetName()+"\002 split from server \002"+Current->GetParent()->GetName()+"\002 with reason: "+reason);
814 num_lost_servers = 0;
816 CullList* Goners = new CullList();
817 SquitServer(Current, Goners);
820 Current->GetParent()->DelChild(Current);
823 WriteOpers("Netsplit complete, lost \002%d\002 users on \002%d\002 servers.", num_lost_users, num_lost_servers);
827 log(DEFAULT,"Squit from unknown server");
832 bool ForceMode(std::string source, std::deque<std::string> params)
834 userrec* who = new userrec;
835 who->fd = FD_MAGIC_NUMBER;
836 if (params.size() < 2)
839 for (unsigned int q = 0; q < params.size(); q++)
841 modelist[q] = (char*)params[q].c_str();
843 Srv->SendMode(modelist,params.size(),who);
844 DoOneToAllButSender(source,"FMODE",params,source);
850 bool ForceTopic(std::string source, std::deque<std::string> params)
852 if (params.size() != 4)
854 std::string channel = params[0];
855 time_t ts = atoi(params[1].c_str());
856 std::string setby = params[2];
857 std::string topic = params[3];
858 std::string nsource = source;
860 chanrec* c = Srv->FindChannel(channel);
863 if ((ts >= c->topicset) || (!*c->topic))
865 std::string oldtopic = c->topic;
866 strlcpy(c->topic,topic.c_str(),MAXTOPIC);
867 strlcpy(c->setby,setby.c_str(),NICKMAX);
869 /* if the topic text is the same as the current topic,
870 * dont bother to send the TOPIC command out, just silently
871 * update the set time and set nick.
873 if (oldtopic != topic)
875 userrec* user = Srv->FindNick(source);
878 WriteChannelWithServ((char*)source.c_str(), c, "TOPIC %s :%s", c->name, c->topic);
882 WriteChannel(c, user, "TOPIC %s :%s", c->name, c->topic);
883 nsource = user->server;
890 /* all done, send it on its way */
891 params[3] = ":" + params[3];
892 DoOneToAllButSender(source,"FTOPIC",params,nsource);
897 /* FJOIN, similar to unreal SJOIN */
898 bool ForceJoin(std::string source, std::deque<std::string> params)
900 if (params.size() < 3)
904 char modestring[MAXBUF];
905 char* mode_users[127];
906 mode_users[0] = first;
907 mode_users[1] = modestring;
908 strcpy(mode_users[1],"+");
909 unsigned int modectr = 2;
912 std::string channel = params[0];
913 time_t TS = atoi(params[1].c_str());
916 chanrec* chan = Srv->FindChannel(channel);
921 strlcpy(mode_users[0],channel.c_str(),MAXBUF);
923 /* default is a high value, which if we dont have this
924 * channel will let the other side apply their modes.
926 time_t ourTS = time(NULL)+600;
927 chanrec* us = Srv->FindChannel(channel);
933 log(DEBUG,"FJOIN detected, our TS=%lu, their TS=%lu",ourTS,TS);
935 /* do this first, so our mode reversals are correctly received by other servers
936 * if there is a TS collision.
938 DoOneToAllButSender(source,"FJOIN",params,source);
940 for (unsigned int usernum = 2; usernum < params.size(); usernum++)
942 /* process one channel at a time, applying modes. */
943 char* usr = (char*)params[usernum].c_str();
944 /* Safety check just to make sure someones not sent us an FJOIN full of spaces
945 * (is this even possible?) */
948 char permissions = *usr;
953 mode_users[modectr++] = usr;
954 strlcat(modestring,"o",MAXBUF);
958 mode_users[modectr++] = usr;
959 strlcat(modestring,"h",MAXBUF);
963 mode_users[modectr++] = usr;
964 strlcat(modestring,"v",MAXBUF);
967 who = Srv->FindNick(usr);
970 Srv->JoinUserToChannel(who,channel,key);
971 if (modectr >= (MAXMODES-1))
973 /* theres a mode for this user. push them onto the mode queue, and flush it
974 * if there are more than MAXMODES to go.
976 if ((ourTS >= TS) || (Srv->IsUlined(who->server)))
978 /* We also always let u-lined clients win, no matter what the TS value */
979 log(DEBUG,"Our our channel newer than theirs, accepting their modes");
980 Srv->SendMode(mode_users,modectr,who);
984 log(DEBUG,"Their channel newer than ours, bouncing their modes");
986 std::deque<std::string> params;
987 /* modes are now being UNSET... */
988 *mode_users[1] = '-';
989 for (unsigned int x = 0; x < modectr; x++)
991 params.push_back(mode_users[x]);
993 // tell everyone to bounce the modes. bad modes, bad!
994 DoOneToMany(Srv->GetServerName(),"FMODE",params);
996 strcpy(mode_users[1],"+");
1002 /* there werent enough modes built up to flush it during FJOIN,
1003 * or, there are a number left over. flush them out.
1005 if ((modectr > 2) && (who))
1009 log(DEBUG,"Our our channel newer than theirs, accepting their modes");
1010 Srv->SendMode(mode_users,modectr,who);
1014 log(DEBUG,"Their channel newer than ours, bouncing their modes");
1015 std::deque<std::string> params;
1016 *mode_users[1] = '-';
1017 for (unsigned int x = 0; x < modectr; x++)
1019 params.push_back(mode_users[x]);
1021 DoOneToMany(Srv->GetServerName(),"FMODE",params);
1028 bool IntroduceClient(std::string source, std::deque<std::string> params)
1030 if (params.size() < 8)
1032 // NICK age nick host dhost ident +modes ip :gecos
1034 std::string nick = params[1];
1035 std::string host = params[2];
1036 std::string dhost = params[3];
1037 std::string ident = params[4];
1038 time_t age = atoi(params[0].c_str());
1039 std::string modes = params[5];
1040 while (*(modes.c_str()) == '+')
1042 char* m = (char*)modes.c_str();
1046 std::string ip = params[6];
1047 std::string gecos = params[7];
1048 char* tempnick = (char*)nick.c_str();
1049 log(DEBUG,"Introduce client %s!%s@%s",tempnick,ident.c_str(),host.c_str());
1051 user_hash::iterator iter;
1052 iter = clientlist.find(tempnick);
1053 if (iter != clientlist.end())
1056 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);
1057 this->WriteLine(":"+Srv->GetServerName()+" KILL "+tempnick+" :Nickname collision");
1061 clientlist[tempnick] = new userrec();
1062 clientlist[tempnick]->fd = FD_MAGIC_NUMBER;
1063 strlcpy(clientlist[tempnick]->nick, tempnick,NICKMAX);
1064 strlcpy(clientlist[tempnick]->host, host.c_str(),160);
1065 strlcpy(clientlist[tempnick]->dhost, dhost.c_str(),160);
1066 clientlist[tempnick]->server = (char*)FindServerNamePtr(source.c_str());
1067 strlcpy(clientlist[tempnick]->ident, ident.c_str(),IDENTMAX);
1068 strlcpy(clientlist[tempnick]->fullname, gecos.c_str(),MAXGECOS);
1069 clientlist[tempnick]->registered = 7;
1070 clientlist[tempnick]->signon = age;
1071 strlcpy(clientlist[tempnick]->modes, modes.c_str(),53);
1072 inet_aton(ip.c_str(),&clientlist[tempnick]->ip4);
1077 for (int i = 0; i < MAXCHANS; i++)
1078 clientlist[tempnick]->chans.push_back(a);
1080 if (!this->bursting)
1082 WriteOpers("*** Client connecting at %s: %s!%s@%s [%s]",clientlist[tempnick]->server,clientlist[tempnick]->nick,clientlist[tempnick]->ident,clientlist[tempnick]->host,(char*)inet_ntoa(clientlist[tempnick]->ip4));
1084 params[7] = ":" + params[7];
1085 DoOneToAllButSender(source,"NICK",params,source);
1087 // Increment the Source Servers User Count..
1088 TreeServer* SourceServer = FindServer(source);
1090 SourceServer->AddUserCount();
1096 /* Send one or more FJOINs for a channel of users.
1097 * If the length of a single line is more than 480-NICKMAX
1098 * in length, it is split over multiple lines.
1100 void SendFJoins(TreeServer* Current, chanrec* c)
1102 log(DEBUG,"Sending FJOINs to other server for %s",c->name);
1104 snprintf(list,MAXBUF,":%s FJOIN %s %lu",Srv->GetServerName().c_str(),c->name,(unsigned long)c->age);
1105 std::map<char*,char*> *ulist = c->GetUsers();
1106 for (std::map<char*,char*>::iterator i = ulist->begin(); i != ulist->end(); i++)
1108 char* o = i->second;
1109 userrec* otheruser = (userrec*)o;
1110 strlcat(list," ",MAXBUF);
1111 strlcat(list,cmode(otheruser,c),MAXBUF);
1112 strlcat(list,otheruser->nick,MAXBUF);
1113 if (strlen(list)>(480-NICKMAX))
1115 log(DEBUG,"FJOIN line wrapped");
1116 this->WriteLine(list);
1117 snprintf(list,MAXBUF,":%s FJOIN %s %lu",Srv->GetServerName().c_str(),c->name,(unsigned long)c->age);
1120 if (list[strlen(list)-1] != ':')
1122 log(DEBUG,"Final FJOIN line");
1123 this->WriteLine(list);
1127 /* Send G, Q, Z and E lines */
1128 void SendXLines(TreeServer* Current)
1131 /* Yes, these arent too nice looking, but they get the job done */
1132 for (std::vector<ZLine>::iterator i = zlines.begin(); i != zlines.end(); i++)
1134 snprintf(data,MAXBUF,":%s ADDLINE Z %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->ipaddr,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1135 this->WriteLine(data);
1137 for (std::vector<QLine>::iterator i = qlines.begin(); i != qlines.end(); i++)
1139 snprintf(data,MAXBUF,":%s ADDLINE Q %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->nick,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1140 this->WriteLine(data);
1142 for (std::vector<GLine>::iterator i = glines.begin(); i != glines.end(); i++)
1144 snprintf(data,MAXBUF,":%s ADDLINE G %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->hostmask,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1145 this->WriteLine(data);
1147 for (std::vector<ELine>::iterator i = elines.begin(); i != elines.end(); i++)
1149 snprintf(data,MAXBUF,":%s ADDLINE E %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->hostmask,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1150 this->WriteLine(data);
1152 for (std::vector<ZLine>::iterator i = pzlines.begin(); i != pzlines.end(); i++)
1154 snprintf(data,MAXBUF,":%s ADDLINE Z %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->ipaddr,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1155 this->WriteLine(data);
1157 for (std::vector<QLine>::iterator i = pqlines.begin(); i != pqlines.end(); i++)
1159 snprintf(data,MAXBUF,":%s ADDLINE Q %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->nick,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1160 this->WriteLine(data);
1162 for (std::vector<GLine>::iterator i = pglines.begin(); i != pglines.end(); i++)
1164 snprintf(data,MAXBUF,":%s ADDLINE G %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->hostmask,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1165 this->WriteLine(data);
1167 for (std::vector<ELine>::iterator i = pelines.begin(); i != pelines.end(); i++)
1169 snprintf(data,MAXBUF,":%s ADDLINE E %s %s %lu %lu :%s",Srv->GetServerName().c_str(),i->hostmask,i->source,(unsigned long)i->set_time,(unsigned long)i->duration,i->reason);
1170 this->WriteLine(data);
1174 /* Send channel modes and topics */
1175 void SendChannelModes(TreeServer* Current)
1178 std::deque<std::string> list;
1179 for (chan_hash::iterator c = chanlist.begin(); c != chanlist.end(); c++)
1181 SendFJoins(Current, c->second);
1182 snprintf(data,MAXBUF,":%s FMODE %s +%s",Srv->GetServerName().c_str(),c->second->name,chanmodes(c->second));
1183 this->WriteLine(data);
1184 if (*c->second->topic)
1186 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);
1187 this->WriteLine(data);
1189 for (BanList::iterator b = c->second->bans.begin(); b != c->second->bans.end(); b++)
1191 snprintf(data,MAXBUF,":%s FMODE %s +b %s",Srv->GetServerName().c_str(),c->second->name,b->data);
1192 this->WriteLine(data);
1194 FOREACH_MOD(I_OnSyncChannel,OnSyncChannel(c->second,(Module*)TreeProtocolModule,(void*)this));
1196 c->second->GetExtList(list);
1197 for (unsigned int j = 0; j < list.size(); j++)
1199 FOREACH_MOD(I_OnSyncChannelMetaData,OnSyncChannelMetaData(c->second,(Module*)TreeProtocolModule,(void*)this,list[j]));
1204 /* send all users and their oper state/modes */
1205 void SendUsers(TreeServer* Current)
1208 std::deque<std::string> list;
1209 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
1211 if (u->second->registered == 7)
1213 snprintf(data,MAXBUF,":%s NICK %lu %s %s %s %s +%s %s :%s",u->second->server,(unsigned long)u->second->age,u->second->nick,u->second->host,u->second->dhost,u->second->ident,u->second->modes,(char*)inet_ntoa(u->second->ip4),u->second->fullname);
1214 this->WriteLine(data);
1215 if (strchr(u->second->modes,'o'))
1217 this->WriteLine(":"+std::string(u->second->nick)+" OPERTYPE "+std::string(u->second->oper));
1219 FOREACH_MOD(I_OnSyncUser,OnSyncUser(u->second,(Module*)TreeProtocolModule,(void*)this));
1221 u->second->GetExtList(list);
1222 for (unsigned int j = 0; j < list.size(); j++)
1224 FOREACH_MOD(I_OnSyncUserMetaData,OnSyncUserMetaData(u->second,(Module*)TreeProtocolModule,(void*)this,list[j]));
1230 /* This function is called when we want to send a netburst to a local
1231 * server. There is a set order we must do this, because for example
1232 * users require their servers to exist, and channels require their
1233 * users to exist. You get the idea.
1235 void DoBurst(TreeServer* s)
1237 Srv->SendOpers("*** Bursting to \2"+s->GetName()+"\2.");
1238 this->WriteLine("BURST");
1239 /* send our version string */
1240 this->WriteLine(":"+Srv->GetServerName()+" VERSION :"+Srv->GetVersion());
1241 /* Send server tree */
1242 this->SendServers(TreeRoot,s,1);
1243 /* Send users and their oper status */
1245 /* Send everything else (channel modes, xlines etc) */
1246 this->SendChannelModes(s);
1247 this->SendXLines(s);
1248 FOREACH_MOD(I_OnSyncOtherMetaData,OnSyncOtherMetaData((Module*)TreeProtocolModule,(void*)this));
1249 this->WriteLine("ENDBURST");
1250 Srv->SendOpers("*** Finished bursting to \2"+s->GetName()+"\2.");
1253 /* This function is called when we receive data from a remote
1254 * server. We buffer the data in a std::string (it doesnt stay
1255 * there for long), reading using InspSocket::Read() which can
1256 * read up to 16 kilobytes in one operation.
1258 * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
1259 * THE SOCKET OBJECT FOR US.
1261 virtual bool OnDataReady()
1263 char* data = this->Read();
1264 /* Check that the data read is a valid pointer and it has some content */
1267 this->in_buffer += data;
1268 /* While there is at least one new line in the buffer,
1269 * do something useful (we hope!) with it.
1271 while (in_buffer.find("\n") != std::string::npos)
1273 char* line = (char*)in_buffer.c_str();
1274 std::string ret = "";
1275 while ((*line != '\n') && (strlen(line)))
1277 if ((*line != '\r') && (*line != '\n'))
1281 if ((*line == '\n') || (*line == '\r'))
1284 /* Process this one, abort if it
1285 * didnt return true.
1291 memset(result,0,1024);
1293 log(DEBUG,"Original string '%s'",ret.c_str());
1294 /* ERROR + CAPAB is still allowed unencryped */
1295 if ((ret.substr(0,7) != "ERROR :") && (ret.substr(0,6) != "CAPAB "))
1297 int nbytes = from64tobits(out, ret.c_str(), 1024);
1298 if ((nbytes > 0) && (nbytes < 1024))
1300 log(DEBUG,"m_spanningtree: decrypt %d bytes",nbytes);
1301 ctx_in->Decrypt(out, result, nbytes, 1);
1302 for (int t = 0; t < nbytes; t++)
1303 if (result[t] == '\7') result[t] = 0;
1308 if (!this->ProcessLine(ret))
1314 /* EAGAIN returns an empty but non-NULL string, so this
1315 * evaluates to TRUE for EAGAIN but to FALSE for EOF.
1317 return (data != NULL);
1320 int WriteLine(std::string line)
1322 log(DEBUG,"OUT: %s",line.c_str());
1325 log(DEBUG,"AES context");
1327 char result64[10240];
1328 if (this->keylength)
1330 while (line.length() % this->keylength != 0)
1332 // pad it to be a multiple of the key length
1336 unsigned int ll = line.length();
1337 log(DEBUG,"Plaintext line with padding = %d chars",ll);
1338 ctx_out->Encrypt(line.c_str(), result, ll, 1);
1339 log(DEBUG,"Encrypted.");
1340 to64frombits((unsigned char*)result64,(unsigned char*)result,ll);
1342 log(DEBUG,"Encrypted: %s",line.c_str());
1343 //int from64tobits(char *out, const char *in, int maxlen);
1345 return this->Write(line + "\r\n");
1348 /* Handle ERROR command */
1349 bool Error(std::deque<std::string> params)
1351 if (params.size() < 1)
1353 std::string Errmsg = params[0];
1354 std::string SName = myhost;
1355 if (InboundServerName != "")
1357 SName = InboundServerName;
1359 Srv->SendOpers("*** ERROR from "+SName+": "+Errmsg);
1360 /* we will return false to cause the socket to close.
1365 /* Because the core won't let users or even SERVERS set +o,
1366 * we use the OPERTYPE command to do this.
1368 bool OperType(std::string prefix, std::deque<std::string> ¶ms)
1370 if (params.size() != 1)
1372 std::string opertype = params[0];
1373 userrec* u = Srv->FindNick(prefix);
1376 strlcpy(u->oper,opertype.c_str(),NICKMAX);
1377 if (!strchr(u->modes,'o'))
1379 strcat(u->modes,"o");
1381 DoOneToAllButSender(u->nick,"OPERTYPE",params,u->server);
1386 /* Because Andy insists that services-compatible servers must
1387 * implement SVSNICK and SVSJOIN, that's exactly what we do :p
1389 bool ForceNick(std::string prefix, std::deque<std::string> ¶ms)
1391 if (params.size() < 3)
1393 userrec* u = Srv->FindNick(params[0]);
1396 Srv->ChangeUserNick(u,params[1]);
1397 u->age = atoi(params[2].c_str());
1398 DoOneToAllButSender(prefix,"SVSNICK",params,prefix);
1403 bool ServiceJoin(std::string prefix, std::deque<std::string> ¶ms)
1405 if (params.size() < 2)
1407 userrec* u = Srv->FindNick(params[0]);
1410 Srv->JoinUserToChannel(u,params[1],"");
1411 DoOneToAllButSender(prefix,"SVSJOIN",params,prefix);
1416 bool RemoteRehash(std::string prefix, std::deque<std::string> ¶ms)
1418 if (params.size() < 1)
1420 std::string servermask = params[0];
1421 if (Srv->MatchText(Srv->GetServerName(),servermask))
1423 Srv->SendOpers("*** Remote rehash initiated from server \002"+prefix+"\002.");
1424 Srv->RehashServer();
1425 ReadConfiguration(false);
1427 DoOneToAllButSender(prefix,"REHASH",params,prefix);
1431 bool RemoteKill(std::string prefix, std::deque<std::string> ¶ms)
1433 if (params.size() != 2)
1435 std::string nick = params[0];
1436 userrec* u = Srv->FindNick(prefix);
1437 userrec* who = Srv->FindNick(nick);
1440 /* Prepend kill source, if we don't have one */
1441 std::string sourceserv = prefix;
1444 sourceserv = u->server;
1446 if (*(params[1].c_str()) != '[')
1448 params[1] = "[" + sourceserv + "] Killed (" + params[1] +")";
1450 std::string reason = params[1];
1451 params[1] = ":" + params[1];
1452 DoOneToAllButSender(prefix,"KILL",params,sourceserv);
1453 Srv->QuitUser(who,reason);
1458 bool LocalPong(std::string prefix, std::deque<std::string> ¶ms)
1460 if (params.size() < 1)
1462 TreeServer* ServerSource = FindServer(prefix);
1465 ServerSource->SetPingFlag();
1470 bool MetaData(std::string prefix, std::deque<std::string> ¶ms)
1472 if (params.size() < 3)
1474 TreeServer* ServerSource = FindServer(prefix);
1477 if (params[0] == "*")
1479 FOREACH_MOD(I_OnDecodeMetaData,OnDecodeMetaData(TYPE_OTHER,NULL,params[1],params[2]));
1481 else if (*(params[0].c_str()) == '#')
1483 chanrec* c = Srv->FindChannel(params[0]);
1486 FOREACH_MOD(I_OnDecodeMetaData,OnDecodeMetaData(TYPE_CHANNEL,c,params[1],params[2]));
1489 else if (*(params[0].c_str()) != '#')
1491 userrec* u = Srv->FindNick(params[0]);
1494 FOREACH_MOD(I_OnDecodeMetaData,OnDecodeMetaData(TYPE_USER,u,params[1],params[2]));
1498 params[2] = ":" + params[2];
1499 DoOneToAllButSender(prefix,"METADATA",params,prefix);
1503 bool ServerVersion(std::string prefix, std::deque<std::string> ¶ms)
1505 if (params.size() < 1)
1507 TreeServer* ServerSource = FindServer(prefix);
1510 ServerSource->SetVersion(params[0]);
1512 params[0] = ":" + params[0];
1513 DoOneToAllButSender(prefix,"VERSION",params,prefix);
1517 bool ChangeHost(std::string prefix, std::deque<std::string> ¶ms)
1519 if (params.size() < 1)
1521 userrec* u = Srv->FindNick(prefix);
1524 Srv->ChangeHost(u,params[0]);
1525 DoOneToAllButSender(prefix,"FHOST",params,u->server);
1530 bool AddLine(std::string prefix, std::deque<std::string> ¶ms)
1532 if (params.size() < 6)
1534 std::string linetype = params[0]; /* Z, Q, E, G, K */
1535 std::string mask = params[1]; /* Line type dependent */
1536 std::string source = params[2]; /* may not be online or may be a server */
1537 std::string settime = params[3]; /* EPOCH time set */
1538 std::string duration = params[4]; /* Duration secs */
1539 std::string reason = params[5];
1541 switch (*(linetype.c_str()))
1544 add_zline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1545 zline_set_creation_time((char*)mask.c_str(), atoi(settime.c_str()));
1548 add_qline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1549 qline_set_creation_time((char*)mask.c_str(), atoi(settime.c_str()));
1552 add_eline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1553 eline_set_creation_time((char*)mask.c_str(), atoi(settime.c_str()));
1556 add_gline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1557 gline_set_creation_time((char*)mask.c_str(), atoi(settime.c_str()));
1560 add_kline(atoi(duration.c_str()), source.c_str(), reason.c_str(), mask.c_str());
1563 /* Just in case... */
1564 Srv->SendOpers("*** \2WARNING\2: Invalid xline type '"+linetype+"' sent by server "+prefix+", ignored!");
1567 /* Send it on its way */
1568 params[5] = ":" + params[5];
1569 DoOneToAllButSender(prefix,"ADDLINE",params,prefix);
1573 bool ChangeName(std::string prefix, std::deque<std::string> ¶ms)
1575 if (params.size() < 1)
1577 userrec* u = Srv->FindNick(prefix);
1580 Srv->ChangeGECOS(u,params[0]);
1581 params[0] = ":" + params[0];
1582 DoOneToAllButSender(prefix,"FNAME",params,u->server);
1587 bool Whois(std::string prefix, std::deque<std::string> ¶ms)
1589 if (params.size() < 1)
1591 log(DEBUG,"In IDLE command");
1592 userrec* u = Srv->FindNick(prefix);
1595 log(DEBUG,"USER EXISTS: %s",u->nick);
1596 // an incoming request
1597 if (params.size() == 1)
1599 userrec* x = Srv->FindNick(params[0]);
1600 if ((x) && (x->fd > -1))
1602 userrec* x = Srv->FindNick(params[0]);
1603 log(DEBUG,"Got IDLE");
1604 char signon[MAXBUF];
1606 log(DEBUG,"Sending back IDLE 3");
1607 snprintf(signon,MAXBUF,"%lu",(unsigned long)x->signon);
1608 snprintf(idle,MAXBUF,"%lu",(unsigned long)abs((x->idle_lastmsg)-time(NULL)));
1609 std::deque<std::string> par;
1610 par.push_back(prefix);
1611 par.push_back(signon);
1612 par.push_back(idle);
1613 // ours, we're done, pass it BACK
1614 DoOneToOne(params[0],"IDLE",par,u->server);
1618 // not ours pass it on
1619 DoOneToOne(prefix,"IDLE",params,x->server);
1622 else if (params.size() == 3)
1624 std::string who_did_the_whois = params[0];
1625 userrec* who_to_send_to = Srv->FindNick(who_did_the_whois);
1626 if ((who_to_send_to) && (who_to_send_to->fd > -1))
1628 log(DEBUG,"Got final IDLE");
1629 // an incoming reply to a whois we sent out
1630 std::string nick_whoised = prefix;
1631 unsigned long signon = atoi(params[1].c_str());
1632 unsigned long idle = atoi(params[2].c_str());
1633 if ((who_to_send_to) && (who_to_send_to->fd > -1))
1634 do_whois(who_to_send_to,u,signon,idle,(char*)nick_whoised.c_str());
1638 // not ours, pass it on
1639 DoOneToOne(prefix,"IDLE",params,who_to_send_to->server);
1646 bool LocalPing(std::string prefix, std::deque<std::string> ¶ms)
1648 if (params.size() < 1)
1650 std::string stufftobounce = params[0];
1651 this->WriteLine(":"+Srv->GetServerName()+" PONG "+stufftobounce);
1655 bool RemoteServer(std::string prefix, std::deque<std::string> ¶ms)
1657 if (params.size() < 4)
1659 std::string servername = params[0];
1660 std::string password = params[1];
1661 // hopcount is not used for a remote server, we calculate this ourselves
1662 std::string description = params[3];
1663 TreeServer* ParentOfThis = FindServer(prefix);
1666 this->WriteLine("ERROR :Protocol error - Introduced remote server from unknown server "+prefix);
1669 TreeServer* CheckDupe = FindServer(servername);
1672 this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1673 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, already exists on server "+CheckDupe->GetParent()->GetName());
1676 TreeServer* Node = new TreeServer(servername,description,ParentOfThis,NULL);
1677 ParentOfThis->AddChild(Node);
1678 params[3] = ":" + params[3];
1679 DoOneToAllButSender(prefix,"SERVER",params,prefix);
1680 Srv->SendOpers("*** Server \002"+prefix+"\002 introduced server \002"+servername+"\002 ("+description+")");
1684 bool Outbound_Reply_Server(std::deque<std::string> ¶ms)
1686 if (params.size() < 4)
1688 std::string servername = params[0];
1689 std::string password = params[1];
1690 int hops = atoi(params[2].c_str());
1693 this->WriteLine("ERROR :Server too far away for authentication");
1694 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, server is too far away for authentication");
1697 std::string description = params[3];
1698 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1700 if ((x->Name == servername) && (x->RecvPass == password))
1702 TreeServer* CheckDupe = FindServer(servername);
1705 this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1706 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, already exists on server "+CheckDupe->GetParent()->GetName());
1709 // Begin the sync here. this kickstarts the
1710 // other side, waiting in WAIT_AUTH_2 state,
1711 // into starting their burst, as it shows
1712 // that we're happy.
1713 this->LinkState = CONNECTED;
1714 // we should add the details of this server now
1715 // to the servers tree, as a child of the root
1717 TreeServer* Node = new TreeServer(servername,description,TreeRoot,this);
1718 TreeRoot->AddChild(Node);
1719 params[3] = ":" + params[3];
1720 DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,servername);
1721 this->bursting = true;
1722 this->DoBurst(Node);
1726 this->WriteLine("ERROR :Invalid credentials");
1727 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, invalid link credentials");
1731 bool Inbound_Server(std::deque<std::string> ¶ms)
1733 if (params.size() < 4)
1735 std::string servername = params[0];
1736 std::string password = params[1];
1737 int hops = atoi(params[2].c_str());
1740 this->WriteLine("ERROR :Server too far away for authentication");
1741 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, server is too far away for authentication");
1744 std::string description = params[3];
1745 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1747 if ((x->Name == servername) && (x->RecvPass == password))
1749 TreeServer* CheckDupe = FindServer(servername);
1752 this->WriteLine("ERROR :Server "+servername+" already exists on server "+CheckDupe->GetParent()->GetName()+"!");
1753 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, already exists on server "+CheckDupe->GetParent()->GetName());
1756 /* If the config says this link is encrypted, but the remote side
1757 * hasnt bothered to send the AES command before SERVER, then we
1758 * boot them off as we MUST have this connection encrypted.
1760 if ((x->EncryptionKey != "") && (!this->ctx_in))
1762 this->WriteLine("ERROR :This link requires AES encryption to be enabled. Plaintext connection refused.");
1763 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, remote server did not enable AES.");
1766 Srv->SendOpers("*** Verified incoming server connection from \002"+servername+"\002["+(x->HiddenFromStats ? "<hidden>" : this->GetIP())+"] ("+description+")");
1767 this->InboundServerName = servername;
1768 this->InboundDescription = description;
1769 // this is good. Send our details: Our server name and description and hopcount of 0,
1770 // along with the sendpass from this block.
1771 this->WriteLine("SERVER "+Srv->GetServerName()+" "+x->SendPass+" 0 :"+Srv->GetServerDescription());
1772 // move to the next state, we are now waiting for THEM.
1773 this->LinkState = WAIT_AUTH_2;
1777 this->WriteLine("ERROR :Invalid credentials");
1778 Srv->SendOpers("*** Server connection from \2"+servername+"\2 denied, invalid link credentials");
1782 void Split(std::string line, bool stripcolon, std::deque<std::string> &n)
1784 if (!strchr(line.c_str(),' '))
1789 std::stringstream s(line);
1790 std::string param = "";
1809 if ((param == ":") && (item > 0))
1832 bool ProcessLine(std::string line)
1834 char* l = (char*)line.c_str();
1835 while ((strlen(l)) && (l[strlen(l)-1] == '\r') || (l[strlen(l)-1] == '\n'))
1836 l[strlen(l)-1] = '\0';
1840 Srv->Log(DEBUG,"IN: "+line);
1842 std::deque<std::string> params;
1843 this->Split(line,true,params);
1844 std::string command = "";
1845 std::string prefix = "";
1846 if (((params[0].c_str())[0] == ':') && (params.size() > 1))
1849 command = params[1];
1850 char* pref = (char*)prefix.c_str();
1858 command = params[0];
1862 if ((!this->ctx_in) && (command == "AES"))
1864 std::string sserv = params[0];
1865 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
1867 if ((x->EncryptionKey != "") && (x->Name == sserv))
1869 this->InitAES(x->EncryptionKey,sserv);
1874 else if ((this->ctx_in) && (command == "AES"))
1876 WriteOpers("*** \2AES\2: Encryption already enabled on this connection yet %s is trying to enable it twice!",params[0].c_str());
1879 switch (this->LinkState)
1884 // Waiting for SERVER command from remote server. Server initiating
1885 // the connection sends the first SERVER command, listening server
1886 // replies with theirs if its happy, then if the initiator is happy,
1887 // it starts to send its net sync, which starts the merge, otherwise
1888 // it sends an ERROR.
1889 if (command == "PASS")
1891 /* Silently ignored */
1893 else if (command == "SERVER")
1895 return this->Inbound_Server(params);
1897 else if (command == "ERROR")
1899 return this->Error(params);
1901 else if (command == "USER")
1903 this->WriteLine("ERROR :Client connections to this port are prohibited.");
1906 else if (command == "CAPAB")
1908 return this->Capab(params);
1910 else if ((command == "U") || (command == "S"))
1912 this->WriteLine("ERROR :Cannot use the old-style mesh linking protocol with m_spanningtree.so!");
1917 this->WriteLine("ERROR :Invalid command in negotiation phase.");
1922 // Waiting for start of other side's netmerge to say they liked our
1924 if (command == "SERVER")
1926 // cant do this, they sent it to us in the WAIT_AUTH_1 state!
1930 else if ((command == "U") || (command == "S"))
1932 this->WriteLine("ERROR :Cannot use the old-style mesh linking protocol with m_spanningtree.so!");
1935 else if (command == "BURST")
1937 this->LinkState = CONNECTED;
1938 Node = new TreeServer(InboundServerName,InboundDescription,TreeRoot,this);
1939 TreeRoot->AddChild(Node);
1941 params.push_back(InboundServerName);
1942 params.push_back("*");
1943 params.push_back("1");
1944 params.push_back(":"+InboundDescription);
1945 DoOneToAllButSender(TreeRoot->GetName(),"SERVER",params,InboundServerName);
1946 this->bursting = true;
1947 this->DoBurst(Node);
1949 else if (command == "ERROR")
1951 return this->Error(params);
1953 else if (command == "CAPAB")
1955 return this->Capab(params);
1960 this->WriteLine("ERROR :Internal error -- listening socket accepted its own descriptor!!!");
1964 if (command == "SERVER")
1966 // another server we connected to, which was in WAIT_AUTH_1 state,
1967 // has just sent us their credentials. If we get this far, theyre
1968 // happy with OUR credentials, and they are now in WAIT_AUTH_2 state.
1969 // if we're happy with this, we should send our netburst which
1970 // kickstarts the merge.
1971 return this->Outbound_Reply_Server(params);
1973 else if (command == "ERROR")
1975 return this->Error(params);
1979 // This is the 'authenticated' state, when all passwords
1980 // have been exchanged and anything past this point is taken
1985 std::string direction = prefix;
1986 userrec* t = Srv->FindNick(prefix);
1989 direction = t->server;
1991 TreeServer* route_back_again = BestRouteTo(direction);
1992 if ((!route_back_again) || (route_back_again->GetSocket() != this))
1994 if (route_back_again)
1995 log(DEBUG,"Protocol violation: Fake direction in command '%s' from connection '%s'",line.c_str(),this->GetName().c_str());
2000 * When there is activity on the socket, reset the ping counter so
2001 * that we're not wasting bandwidth pinging an active server.
2003 route_back_again->SetNextPingTime(time(NULL) + 120);
2004 route_back_again->SetPingFlag();
2007 if (command == "SVSMODE")
2009 /* Services expects us to implement
2010 * SVSMODE. In inspircd its the same as
2015 std::string target = "";
2016 /* Yes, know, this is a mess. Its reasonably fast though as we're
2017 * working with std::string here.
2019 if ((command == "NICK") && (params.size() > 1))
2021 return this->IntroduceClient(prefix,params);
2023 else if (command == "FJOIN")
2025 return this->ForceJoin(prefix,params);
2027 else if (command == "SERVER")
2029 return this->RemoteServer(prefix,params);
2031 else if (command == "ERROR")
2033 return this->Error(params);
2035 else if (command == "OPERTYPE")
2037 return this->OperType(prefix,params);
2039 else if (command == "FMODE")
2041 return this->ForceMode(prefix,params);
2043 else if (command == "KILL")
2045 return this->RemoteKill(prefix,params);
2047 else if (command == "FTOPIC")
2049 return this->ForceTopic(prefix,params);
2051 else if (command == "REHASH")
2053 return this->RemoteRehash(prefix,params);
2055 else if (command == "METADATA")
2057 return this->MetaData(prefix,params);
2059 else if (command == "PING")
2061 return this->LocalPing(prefix,params);
2063 else if (command == "PONG")
2065 return this->LocalPong(prefix,params);
2067 else if (command == "VERSION")
2069 return this->ServerVersion(prefix,params);
2071 else if (command == "FHOST")
2073 return this->ChangeHost(prefix,params);
2075 else if (command == "FNAME")
2077 return this->ChangeName(prefix,params);
2079 else if (command == "ADDLINE")
2081 return this->AddLine(prefix,params);
2083 else if (command == "SVSNICK")
2087 prefix = this->GetName();
2089 return this->ForceNick(prefix,params);
2091 else if (command == "IDLE")
2093 return this->Whois(prefix,params);
2095 else if (command == "SVSJOIN")
2099 prefix = this->GetName();
2101 return this->ServiceJoin(prefix,params);
2103 else if (command == "SQUIT")
2105 if (params.size() == 2)
2107 this->Squit(FindServer(params[0]),params[1]);
2111 else if (command == "ENDBURST")
2113 this->bursting = false;
2118 // not a special inter-server command.
2119 // Emulate the actual user doing the command,
2120 // this saves us having a huge ugly parser.
2121 userrec* who = Srv->FindNick(prefix);
2122 std::string sourceserv = this->myhost;
2123 if (this->InboundServerName != "")
2125 sourceserv = this->InboundServerName;
2130 target = who->server;
2131 char* strparams[127];
2132 for (unsigned int q = 0; q < params.size(); q++)
2134 strparams[q] = (char*)params[q].c_str();
2136 Srv->CallCommandHandler(command, strparams, params.size(), who);
2140 // its not a user. Its either a server, or somethings screwed up.
2141 if (IsServer(prefix))
2143 target = Srv->GetServerName();
2147 log(DEBUG,"Command with unknown origin '%s'",prefix.c_str());
2151 return DoOneToAllButSenderRaw(line,sourceserv,prefix,command,params);
2160 virtual std::string GetName()
2162 std::string sourceserv = this->myhost;
2163 if (this->InboundServerName != "")
2165 sourceserv = this->InboundServerName;
2170 virtual void OnTimeout()
2172 if (this->LinkState == CONNECTING)
2174 Srv->SendOpers("*** CONNECT: Connection to \002"+myhost+"\002 timed out.");
2178 virtual void OnClose()
2180 // Connection closed.
2181 // If the connection is fully up (state CONNECTED)
2182 // then propogate a netsplit to all peers.
2183 std::string quitserver = this->myhost;
2184 if (this->InboundServerName != "")
2186 quitserver = this->InboundServerName;
2188 TreeServer* s = FindServer(quitserver);
2191 Squit(s,"Remote host closed the connection");
2193 WriteOpers("Server '\2%s\2' closed the connection.",quitserver.c_str());
2196 virtual int OnIncomingConnection(int newsock, char* ip)
2198 TreeSocket* s = new TreeSocket(newsock, ip);
2204 void AddThisServer(TreeServer* server, std::deque<TreeServer*> &list)
2206 for (unsigned int c = 0; c < list.size(); c++)
2208 if (list[c] == server)
2213 list.push_back(server);
2216 // returns a list of DIRECT servernames for a specific channel
2217 void GetListOfServersForChannel(chanrec* c, std::deque<TreeServer*> &list)
2219 std::map<char*,char*> *ulist = c->GetUsers();
2220 for (std::map<char*,char*>::iterator i = ulist->begin(); i != ulist->end(); i++)
2222 char* o = i->second;
2223 userrec* otheruser = (userrec*)o;
2224 if (otheruser->fd < 0)
2226 TreeServer* best = BestRouteTo(otheruser->server);
2228 AddThisServer(best,list);
2234 bool DoOneToAllButSenderRaw(std::string data, std::string omit, std::string prefix, std::string command, std::deque<std::string> ¶ms)
2236 TreeServer* omitroute = BestRouteTo(omit);
2237 if ((command == "NOTICE") || (command == "PRIVMSG"))
2239 if ((params.size() >= 2) && (*(params[0].c_str()) != '$'))
2241 if (*(params[0].c_str()) != '#')
2243 // special routing for private messages/notices
2244 userrec* d = Srv->FindNick(params[0]);
2247 std::deque<std::string> par;
2248 par.push_back(params[0]);
2249 par.push_back(":"+params[1]);
2250 DoOneToOne(prefix,command,par,d->server);
2256 log(DEBUG,"Channel privmsg going to chan %s",params[0].c_str());
2257 chanrec* c = Srv->FindChannel(params[0]);
2260 std::deque<TreeServer*> list;
2261 GetListOfServersForChannel(c,list);
2262 log(DEBUG,"Got a list of %d servers",list.size());
2263 unsigned int lsize = list.size();
2264 for (unsigned int i = 0; i < lsize; i++)
2266 TreeSocket* Sock = list[i]->GetSocket();
2267 if ((Sock) && (list[i]->GetName() != omit) && (omitroute != list[i]))
2269 log(DEBUG,"Writing privmsg to server %s",list[i]->GetName().c_str());
2270 Sock->WriteLine(data);
2278 unsigned int items = TreeRoot->ChildCount();
2279 for (unsigned int x = 0; x < items; x++)
2281 TreeServer* Route = TreeRoot->GetChild(x);
2282 if ((Route->GetSocket()) && (Route->GetName() != omit) && (omitroute != Route))
2284 TreeSocket* Sock = Route->GetSocket();
2285 Sock->WriteLine(data);
2291 bool DoOneToAllButSender(std::string prefix, std::string command, std::deque<std::string> ¶ms, std::string omit)
2293 TreeServer* omitroute = BestRouteTo(omit);
2294 std::string FullLine = ":" + prefix + " " + command;
2295 unsigned int words = params.size();
2296 for (unsigned int x = 0; x < words; x++)
2298 FullLine = FullLine + " " + params[x];
2300 unsigned int items = TreeRoot->ChildCount();
2301 for (unsigned int x = 0; x < items; x++)
2303 TreeServer* Route = TreeRoot->GetChild(x);
2304 // Send the line IF:
2305 // The route has a socket (its a direct connection)
2306 // The route isnt the one to be omitted
2307 // The route isnt the path to the one to be omitted
2308 if ((Route->GetSocket()) && (Route->GetName() != omit) && (omitroute != Route))
2310 TreeSocket* Sock = Route->GetSocket();
2311 Sock->WriteLine(FullLine);
2317 bool DoOneToMany(std::string prefix, std::string command, std::deque<std::string> ¶ms)
2319 std::string FullLine = ":" + prefix + " " + command;
2320 unsigned int words = params.size();
2321 for (unsigned int x = 0; x < words; x++)
2323 FullLine = FullLine + " " + params[x];
2325 unsigned int items = TreeRoot->ChildCount();
2326 for (unsigned int x = 0; x < items; x++)
2328 TreeServer* Route = TreeRoot->GetChild(x);
2329 if (Route->GetSocket())
2331 TreeSocket* Sock = Route->GetSocket();
2332 Sock->WriteLine(FullLine);
2338 bool DoOneToOne(std::string prefix, std::string command, std::deque<std::string> ¶ms, std::string target)
2340 TreeServer* Route = BestRouteTo(target);
2343 std::string FullLine = ":" + prefix + " " + command;
2344 unsigned int words = params.size();
2345 for (unsigned int x = 0; x < words; x++)
2347 FullLine = FullLine + " " + params[x];
2349 if (Route->GetSocket())
2351 TreeSocket* Sock = Route->GetSocket();
2352 Sock->WriteLine(FullLine);
2362 std::vector<TreeSocket*> Bindings;
2364 void ReadConfiguration(bool rebind)
2366 Conf = new ConfigReader;
2369 for (int j =0; j < Conf->Enumerate("bind"); j++)
2371 std::string Type = Conf->ReadValue("bind","type",j);
2372 std::string IP = Conf->ReadValue("bind","address",j);
2373 long Port = Conf->ReadInteger("bind","port",j,true);
2374 if (Type == "servers")
2380 TreeSocket* listener = new TreeSocket(IP.c_str(),Port,true,10);
2381 if (listener->GetState() == I_LISTENING)
2383 Srv->AddSocket(listener);
2384 Bindings.push_back(listener);
2388 log(DEFAULT,"m_spanningtree: Warning: Failed to bind server port %d",Port);
2396 for (int j =0; j < Conf->Enumerate("link"); j++)
2399 L.Name = Conf->ReadValue("link","name",j);
2400 L.IPAddr = Conf->ReadValue("link","ipaddr",j);
2401 L.Port = Conf->ReadInteger("link","port",j,true);
2402 L.SendPass = Conf->ReadValue("link","sendpass",j);
2403 L.RecvPass = Conf->ReadValue("link","recvpass",j);
2404 L.AutoConnect = Conf->ReadInteger("link","autoconnect",j,true);
2405 L.EncryptionKey = Conf->ReadValue("link","encryptionkey",j);
2406 L.HiddenFromStats = Conf->ReadFlag("link","hidden",j);
2407 L.NextConnectTime = time(NULL) + L.AutoConnect;
2408 /* Bugfix by brain, do not allow people to enter bad configurations */
2409 if ((L.RecvPass != "") && (L.SendPass != "") && (L.Name != "") && (L.Port))
2411 LinkBlocks.push_back(L);
2412 log(DEBUG,"m_spanningtree: Read server %s with host %s:%d",L.Name.c_str(),L.IPAddr.c_str(),L.Port);
2416 if (L.RecvPass == "")
2418 log(DEFAULT,"Invalid configuration for server '%s', recvpass not defined!",L.Name.c_str());
2420 else if (L.SendPass == "")
2422 log(DEFAULT,"Invalid configuration for server '%s', sendpass not defined!",L.Name.c_str());
2424 else if (L.Name == "")
2426 log(DEFAULT,"Invalid configuration, link tag without a name!");
2430 log(DEFAULT,"Invalid configuration for server '%s', no port specified!",L.Name.c_str());
2438 class ModuleSpanningTree : public Module
2440 std::vector<TreeSocket*> Bindings;
2446 ModuleSpanningTree(Server* Me)
2447 : Module::Module(Me)
2452 // Create the root of the tree
2453 TreeRoot = new TreeServer(Srv->GetServerName(),Srv->GetServerDescription());
2455 ReadConfiguration(true);
2458 void ShowLinks(TreeServer* Current, userrec* user, int hops)
2460 std::string Parent = TreeRoot->GetName();
2461 if (Current->GetParent())
2463 Parent = Current->GetParent()->GetName();
2465 for (unsigned int q = 0; q < Current->ChildCount(); q++)
2467 ShowLinks(Current->GetChild(q),user,hops+1);
2469 WriteServ(user->fd,"364 %s %s %s :%d %s",user->nick,Current->GetName().c_str(),Parent.c_str(),hops,Current->GetDesc().c_str());
2472 int CountLocalServs()
2474 return TreeRoot->ChildCount();
2479 return serverlist.size();
2482 void HandleLinks(char** parameters, int pcnt, userrec* user)
2484 ShowLinks(TreeRoot,user,0);
2485 WriteServ(user->fd,"365 %s * :End of /LINKS list.",user->nick);
2489 void HandleLusers(char** parameters, int pcnt, userrec* user)
2491 WriteServ(user->fd,"251 %s :There are %d users and %d invisible on %d servers",user->nick,usercnt()-usercount_invisible(),usercount_invisible(),this->CountServs());
2492 WriteServ(user->fd,"252 %s %d :operator(s) online",user->nick,usercount_opers());
2493 WriteServ(user->fd,"253 %s %d :unknown connections",user->nick,usercount_unknown());
2494 WriteServ(user->fd,"254 %s %d :channels formed",user->nick,chancount());
2495 WriteServ(user->fd,"254 %s :I have %d clients and %d servers",user->nick,local_count(),this->CountLocalServs());
2499 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
2501 void ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80])
2505 for (int t = 0; t < depth; t++)
2507 matrix[line][t] = ' ';
2510 // For Aligning, we need to work out exactly how deep this thing is, and produce
2511 // a 'Spacer' String to compensate.
2514 memset(spacer,' ',40);
2515 if ((40 - Current->GetName().length() - depth) > 1) {
2516 spacer[40 - Current->GetName().length() - depth] = '\0';
2525 if (clientlist.size() == 0) {
2526 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
2531 percent = ((float)Current->GetUserCount() / (float)clientlist.size()) * 100;
2533 snprintf(text, 80, "%s %s%5d [%5.2f%%]", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent);
2534 strlcpy(&matrix[line][depth],text,80);
2536 for (unsigned int q = 0; q < Current->ChildCount(); q++)
2538 ShowMap(Current->GetChild(q),user,depth+2,matrix);
2543 // Ok, prepare to be confused.
2544 // After much mulling over how to approach this, it struck me that
2545 // the 'usual' way of doing a /MAP isnt the best way. Instead of
2546 // keeping track of a ton of ascii characters, and line by line
2547 // under recursion working out where to place them using multiplications
2548 // and divisons, we instead render the map onto a backplane of characters
2549 // (a character matrix), then draw the branches as a series of "L" shapes
2550 // from the nodes. This is not only friendlier on CPU it uses less stack.
2552 void HandleMap(char** parameters, int pcnt, userrec* user)
2554 // This array represents a virtual screen which we will
2555 // "scratch" draw to, as the console device of an irc
2556 // client does not provide for a proper terminal.
2557 char matrix[128][80];
2558 for (unsigned int t = 0; t < 128; t++)
2560 matrix[t][0] = '\0';
2563 // The only recursive bit is called here.
2564 ShowMap(TreeRoot,user,0,matrix);
2565 // Process each line one by one. The algorithm has a limit of
2566 // 128 servers (which is far more than a spanning tree should have
2567 // anyway, so we're ok). This limit can be raised simply by making
2568 // the character matrix deeper, 128 rows taking 10k of memory.
2569 for (int l = 1; l < line; l++)
2571 // scan across the line looking for the start of the
2572 // servername (the recursive part of the algorithm has placed
2573 // the servers at indented positions depending on what they
2575 int first_nonspace = 0;
2576 while (matrix[l][first_nonspace] == ' ')
2581 // Draw the `- (corner) section: this may be overwritten by
2582 // another L shape passing along the same vertical pane, becoming
2583 // a |- (branch) section instead.
2584 matrix[l][first_nonspace] = '-';
2585 matrix[l][first_nonspace-1] = '`';
2587 // Draw upwards until we hit the parent server, causing possibly
2588 // other corners (`-) to become branches (|-)
2589 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
2591 matrix[l2][first_nonspace-1] = '|';
2595 // dump the whole lot to the user. This is the easy bit, honest.
2596 for (int t = 0; t < line; t++)
2598 WriteServ(user->fd,"006 %s :%s",user->nick,&matrix[t][0]);
2600 WriteServ(user->fd,"007 %s :End of /MAP",user->nick);
2604 int HandleSquit(char** parameters, int pcnt, userrec* user)
2606 TreeServer* s = FindServerMask(parameters[0]);
2611 WriteServ(user->fd,"NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
2614 TreeSocket* sock = s->GetSocket();
2617 log(DEBUG,"Splitting server %s",s->GetName().c_str());
2618 WriteOpers("*** SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
2619 sock->Squit(s,"Server quit by "+std::string(user->nick)+"!"+std::string(user->ident)+"@"+std::string(user->host));
2620 Srv->RemoveSocket(sock);
2624 WriteServ(user->fd,"NOTICE %s :*** SQUIT: The server \002%s\002 is not directly connected.",user->nick,parameters[0]);
2629 WriteServ(user->fd,"NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
2634 int HandleRemoteWhois(char** parameters, int pcnt, userrec* user)
2636 if ((user->fd > -1) && (pcnt > 1))
2638 userrec* remote = Srv->FindNick(parameters[1]);
2639 if ((remote) && (remote->fd < 0))
2641 std::deque<std::string> params;
2642 params.push_back(parameters[1]);
2643 DoOneToOne(user->nick,"IDLE",params,remote->server);
2648 WriteServ(user->fd,"401 %s %s :No such nick/channel",user->nick, parameters[1]);
2649 WriteServ(user->fd,"318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
2656 void DoPingChecks(time_t curtime)
2658 for (unsigned int j = 0; j < TreeRoot->ChildCount(); j++)
2660 TreeServer* serv = TreeRoot->GetChild(j);
2661 TreeSocket* sock = serv->GetSocket();
2664 if (curtime >= serv->NextPingTime())
2666 if (serv->AnsweredLastPing())
2668 sock->WriteLine(":"+Srv->GetServerName()+" PING "+serv->GetName());
2669 serv->SetNextPingTime(curtime + 120);
2673 // they didnt answer, boot them
2674 WriteOpers("*** Server \002%s\002 pinged out",serv->GetName().c_str());
2675 sock->Squit(serv,"Ping timeout");
2676 Srv->RemoveSocket(sock);
2685 void AutoConnectServers(time_t curtime)
2687 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
2689 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
2691 log(DEBUG,"Auto-Connecting %s",x->Name.c_str());
2692 x->NextConnectTime = curtime + x->AutoConnect;
2693 TreeServer* CheckDupe = FindServer(x->Name);
2696 // an autoconnected server is not connected. Check if its time to connect it
2697 WriteOpers("*** AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
2698 TreeSocket* newsocket = new TreeSocket(x->IPAddr,x->Port,false,10,x->Name);
2699 Srv->AddSocket(newsocket);
2705 int HandleVersion(char** parameters, int pcnt, userrec* user)
2707 // we've already checked if pcnt > 0, so this is safe
2708 TreeServer* found = FindServerMask(parameters[0]);
2711 std::string Version = found->GetVersion();
2712 WriteServ(user->fd,"351 %s :%s",user->nick,Version.c_str());
2713 if (found == TreeRoot)
2715 std::stringstream out(Config->data005);
2716 std::string token = "";
2717 std::string line5 = "";
2718 int token_counter = 0;
2722 line5 = line5 + token + " ";
2724 if ((token_counter >= 13) || (out.eof() == true))
2726 WriteServ(user->fd,"005 %s %s:are supported by this server",user->nick,line5.c_str());
2735 WriteServ(user->fd,"402 %s %s :No such server",user->nick,parameters[0]);
2740 int HandleConnect(char** parameters, int pcnt, userrec* user)
2742 for (std::vector<Link>::iterator x = LinkBlocks.begin(); x < LinkBlocks.end(); x++)
2744 if (Srv->MatchText(x->Name.c_str(),parameters[0]))
2746 TreeServer* CheckDupe = FindServer(x->Name);
2749 WriteServ(user->fd,"NOTICE %s :*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",user->nick,x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
2750 TreeSocket* newsocket = new TreeSocket(x->IPAddr,x->Port,false,10,x->Name);
2751 Srv->AddSocket(newsocket);
2756 WriteServ(user->fd,"NOTICE %s :*** CONNECT: Server \002%s\002 already exists on the network and is connected via \002%s\002",user->nick,x->Name.c_str(),CheckDupe->GetParent()->GetName().c_str());
2761 WriteServ(user->fd,"NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
2765 virtual int OnStats(char statschar, userrec* user)
2767 if (statschar == 'c')
2769 for (unsigned int i = 0; i < LinkBlocks.size(); i++)
2771 WriteServ(user->fd,"213 %s C *@%s * %s %d 0 %c%c%c",user->nick,(LinkBlocks[i].HiddenFromStats ? "<hidden>" : LinkBlocks[i].IPAddr).c_str(),LinkBlocks[i].Name.c_str(),LinkBlocks[i].Port,(LinkBlocks[i].EncryptionKey != "" ? 'e' : '-'),(LinkBlocks[i].AutoConnect ? 'a' : '-'),'s');
2772 WriteServ(user->fd,"244 %s H * * %s",user->nick,LinkBlocks[i].Name.c_str());
2774 WriteServ(user->fd,"219 %s %c :End of /STATS report",user->nick,statschar);
2775 WriteOpers("*** Notice: Stats '%c' requested by %s (%s@%s)",statschar,user->nick,user->ident,user->host);
2781 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated)
2783 /* If the command doesnt appear to be valid, we dont want to mess with it. */
2787 if (command == "CONNECT")
2789 return this->HandleConnect(parameters,pcnt,user);
2791 else if (command == "SQUIT")
2793 return this->HandleSquit(parameters,pcnt,user);
2795 else if (command == "MAP")
2797 this->HandleMap(parameters,pcnt,user);
2800 else if (command == "LUSERS")
2802 this->HandleLusers(parameters,pcnt,user);
2805 else if (command == "LINKS")
2807 this->HandleLinks(parameters,pcnt,user);
2810 else if (command == "WHOIS")
2815 return this->HandleRemoteWhois(parameters,pcnt,user);
2818 else if ((command == "VERSION") && (pcnt > 0))
2820 this->HandleVersion(parameters,pcnt,user);
2823 else if (Srv->IsValidModuleCommand(command, pcnt, user))
2825 // this bit of code cleverly routes all module commands
2826 // to all remote severs *automatically* so that modules
2827 // can just handle commands locally, without having
2828 // to have any special provision in place for remote
2829 // commands and linking protocols.
2830 std::deque<std::string> params;
2832 for (int j = 0; j < pcnt; j++)
2834 if (strchr(parameters[j],' '))
2836 params.push_back(":" + std::string(parameters[j]));
2840 params.push_back(std::string(parameters[j]));
2843 DoOneToMany(user->nick,command,params);
2848 virtual void OnGetServerDescription(std::string servername,std::string &description)
2850 TreeServer* s = FindServer(servername);
2853 description = s->GetDesc();
2857 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
2859 if (source->fd > -1)
2861 std::deque<std::string> params;
2862 params.push_back(dest->nick);
2863 params.push_back(channel->name);
2864 DoOneToMany(source->nick,"INVITE",params);
2868 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic)
2870 std::deque<std::string> params;
2871 params.push_back(chan->name);
2872 params.push_back(":"+topic);
2873 DoOneToMany(user->nick,"TOPIC",params);
2876 virtual void OnWallops(userrec* user, std::string text)
2880 std::deque<std::string> params;
2881 params.push_back(":"+text);
2882 DoOneToMany(user->nick,"WALLOPS",params);
2886 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text)
2888 if (target_type == TYPE_USER)
2890 userrec* d = (userrec*)dest;
2891 if ((d->fd < 0) && (user->fd > -1))
2893 std::deque<std::string> params;
2895 params.push_back(d->nick);
2896 params.push_back(":"+text);
2897 DoOneToOne(user->nick,"NOTICE",params,d->server);
2904 chanrec *c = (chanrec*)dest;
2905 std::deque<TreeServer*> list;
2906 GetListOfServersForChannel(c,list);
2907 unsigned int ucount = list.size();
2908 for (unsigned int i = 0; i < ucount; i++)
2910 TreeSocket* Sock = list[i]->GetSocket();
2912 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+std::string(c->name)+" :"+text);
2918 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text)
2920 if (target_type == TYPE_USER)
2922 // route private messages which are targetted at clients only to the server
2923 // which needs to receive them
2924 userrec* d = (userrec*)dest;
2925 if ((d->fd < 0) && (user->fd > -1))
2927 std::deque<std::string> params;
2929 params.push_back(d->nick);
2930 params.push_back(":"+text);
2931 DoOneToOne(user->nick,"PRIVMSG",params,d->server);
2938 chanrec *c = (chanrec*)dest;
2939 std::deque<TreeServer*> list;
2940 GetListOfServersForChannel(c,list);
2941 unsigned int ucount = list.size();
2942 for (unsigned int i = 0; i < ucount; i++)
2944 TreeSocket* Sock = list[i]->GetSocket();
2946 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+std::string(c->name)+" :"+text);
2952 virtual void OnBackgroundTimer(time_t curtime)
2954 AutoConnectServers(curtime);
2955 DoPingChecks(curtime);
2958 virtual void OnUserJoin(userrec* user, chanrec* channel)
2960 // Only do this for local users
2963 std::deque<std::string> params;
2965 params.push_back(channel->name);
2968 // if the channel has a key, force the join by emulating the key.
2969 params.push_back(channel->key);
2971 if (channel->GetUserCounter() > 1)
2973 // not the first in the channel
2974 DoOneToMany(user->nick,"JOIN",params);
2978 // first in the channel, set up their permissions
2979 // and the channel TS with FJOIN.
2981 snprintf(ts,24,"%lu",(unsigned long)channel->age);
2983 params.push_back(channel->name);
2984 params.push_back(ts);
2985 params.push_back("@"+std::string(user->nick));
2986 DoOneToMany(Srv->GetServerName(),"FJOIN",params);
2991 virtual void OnChangeHost(userrec* user, std::string newhost)
2993 // only occurs for local clients
2994 if (user->registered != 7)
2996 std::deque<std::string> params;
2997 params.push_back(newhost);
2998 DoOneToMany(user->nick,"FHOST",params);
3001 virtual void OnChangeName(userrec* user, std::string gecos)
3003 // only occurs for local clients
3004 if (user->registered != 7)
3006 std::deque<std::string> params;
3007 params.push_back(gecos);
3008 DoOneToMany(user->nick,"FNAME",params);
3011 virtual void OnUserPart(userrec* user, chanrec* channel, std::string partmessage)
3015 std::deque<std::string> params;
3016 params.push_back(channel->name);
3017 if (partmessage != "")
3018 params.push_back(":"+partmessage);
3019 DoOneToMany(user->nick,"PART",params);
3023 virtual void OnUserConnect(userrec* user)
3025 char agestr[MAXBUF];
3028 std::deque<std::string> params;
3029 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
3030 params.push_back(agestr);
3031 params.push_back(user->nick);
3032 params.push_back(user->host);
3033 params.push_back(user->dhost);
3034 params.push_back(user->ident);
3035 params.push_back("+"+std::string(user->modes));
3036 params.push_back((char*)inet_ntoa(user->ip4));
3037 params.push_back(":"+std::string(user->fullname));
3038 DoOneToMany(Srv->GetServerName(),"NICK",params);
3040 // User is Local, change needs to be reflected!
3041 TreeServer* SourceServer = FindServer(user->server);
3043 SourceServer->AddUserCount();
3049 virtual void OnUserQuit(userrec* user, std::string reason)
3051 if ((user->fd > -1) && (user->registered == 7))
3053 std::deque<std::string> params;
3054 params.push_back(":"+reason);
3055 DoOneToMany(user->nick,"QUIT",params);
3057 // Regardless, We need to modify the user Counts..
3058 TreeServer* SourceServer = FindServer(user->server);
3060 SourceServer->DelUserCount();
3065 virtual void OnUserPostNick(userrec* user, std::string oldnick)
3069 std::deque<std::string> params;
3070 params.push_back(user->nick);
3071 DoOneToMany(oldnick,"NICK",params);
3075 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason)
3077 if ((source) && (source->fd > -1))
3079 std::deque<std::string> params;
3080 params.push_back(chan->name);
3081 params.push_back(user->nick);
3082 params.push_back(":"+reason);
3083 DoOneToMany(source->nick,"KICK",params);
3087 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason)
3089 std::deque<std::string> params;
3090 params.push_back(dest->nick);
3091 params.push_back(":"+reason);
3092 DoOneToMany(source->nick,"KILL",params);
3095 virtual void OnRehash(std::string parameter)
3097 if (parameter != "")
3099 std::deque<std::string> params;
3100 params.push_back(parameter);
3101 DoOneToMany(Srv->GetServerName(),"REHASH",params);
3103 if (Srv->MatchText(Srv->GetServerName(),parameter))
3105 Srv->SendOpers("*** Remote rehash initiated from server \002"+Srv->GetServerName()+"\002.");
3106 Srv->RehashServer();
3109 ReadConfiguration(false);
3112 // note: the protocol does not allow direct umode +o except
3113 // via NICK with 8 params. sending OPERTYPE infers +o modechange
3115 virtual void OnOper(userrec* user, std::string opertype)
3119 std::deque<std::string> params;
3120 params.push_back(opertype);
3121 DoOneToMany(user->nick,"OPERTYPE",params);
3125 void OnLine(userrec* source, std::string host, bool adding, char linetype, long duration, std::string reason)
3127 if (source->fd > -1)
3130 snprintf(type,8,"%cLINE",linetype);
3131 std::string stype = type;
3134 char sduration[MAXBUF];
3135 snprintf(sduration,MAXBUF,"%ld",duration);
3136 std::deque<std::string> params;
3137 params.push_back(host);
3138 params.push_back(sduration);
3139 params.push_back(":"+reason);
3140 DoOneToMany(source->nick,stype,params);
3144 std::deque<std::string> params;
3145 params.push_back(host);
3146 DoOneToMany(source->nick,stype,params);
3151 virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask)
3153 OnLine(source,hostmask,true,'G',duration,reason);
3156 virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask)
3158 OnLine(source,ipmask,true,'Z',duration,reason);
3161 virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask)
3163 OnLine(source,nickmask,true,'Q',duration,reason);
3166 virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask)
3168 OnLine(source,hostmask,true,'E',duration,reason);
3171 virtual void OnDelGLine(userrec* source, std::string hostmask)
3173 OnLine(source,hostmask,false,'G',0,"");
3176 virtual void OnDelZLine(userrec* source, std::string ipmask)
3178 OnLine(source,ipmask,false,'Z',0,"");
3181 virtual void OnDelQLine(userrec* source, std::string nickmask)
3183 OnLine(source,nickmask,false,'Q',0,"");
3186 virtual void OnDelELine(userrec* source, std::string hostmask)
3188 OnLine(source,hostmask,false,'E',0,"");
3191 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text)
3193 if ((user->fd > -1) && (user->registered == 7))
3195 if (target_type == TYPE_USER)
3197 userrec* u = (userrec*)dest;
3198 std::deque<std::string> params;
3199 params.push_back(u->nick);
3200 params.push_back(text);
3201 DoOneToMany(user->nick,"MODE",params);
3205 chanrec* c = (chanrec*)dest;
3206 std::deque<std::string> params;
3207 params.push_back(c->name);
3208 params.push_back(text);
3209 DoOneToMany(user->nick,"MODE",params);
3214 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline)
3216 TreeSocket* s = (TreeSocket*)opaque;
3219 if (target_type == TYPE_USER)
3221 userrec* u = (userrec*)target;
3222 s->WriteLine(":"+Srv->GetServerName()+" FMODE "+u->nick+" "+modeline);
3226 chanrec* c = (chanrec*)target;
3227 s->WriteLine(":"+Srv->GetServerName()+" FMODE "+c->name+" "+modeline);
3232 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata)
3234 TreeSocket* s = (TreeSocket*)opaque;
3237 if (target_type == TYPE_USER)
3239 userrec* u = (userrec*)target;
3240 s->WriteLine(":"+Srv->GetServerName()+" METADATA "+u->nick+" "+extname+" :"+extdata);
3242 else if (target_type == TYPE_OTHER)
3244 s->WriteLine(":"+Srv->GetServerName()+" METADATA * "+extname+" :"+extdata);
3246 else if (target_type == TYPE_CHANNEL)
3248 chanrec* c = (chanrec*)target;
3249 s->WriteLine(":"+Srv->GetServerName()+" METADATA "+c->name+" "+extname+" :"+extdata);
3254 virtual void OnEvent(Event* event)
3256 if (event->GetEventID() == "send_metadata")
3258 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
3259 if (params->size() < 3)
3261 (*params)[2] = ":" + (*params)[2];
3262 DoOneToMany(Srv->GetServerName(),"METADATA ",*params);
3266 virtual ~ModuleSpanningTree()
3270 virtual Version GetVersion()
3272 return Version(1,0,0,0,VF_STATIC|VF_VENDOR);
3275 void Implements(char* List)
3277 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
3278 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
3279 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
3280 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
3281 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
3282 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
3283 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = 1;
3286 /* It is IMPORTANT that m_spanningtree is the last module in the chain
3287 * so that any activity it sees is FINAL, e.g. we arent going to send out
3288 * a NICK message before m_cloaking has finished putting the +x on the user,
3290 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
3291 * the module call queue.
3293 Priority Prioritize()
3295 return PRIORITY_LAST;
3300 class ModuleSpanningTreeFactory : public ModuleFactory
3303 ModuleSpanningTreeFactory()
3307 ~ModuleSpanningTreeFactory()
3311 virtual Module * CreateModule(Server* Me)
3313 TreeProtocolModule = new ModuleSpanningTree(Me);
3314 return TreeProtocolModule;
3320 extern "C" void * init_module( void )
3322 return new ModuleSpanningTreeFactory;