]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/modules/m_spanningtree/main.cpp
b38929ad00b2b6a935aa5f80c36964cf7c0fdf0e
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / main.cpp
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
6  * See: http://wiki.inspircd.org/Credits
7  *
8  * This program is free but copyrighted software; see
9  *          the file COPYING for details.
10  *
11  * ---------------------------------------------------
12  */
13
14 /* $ModDesc: Provides a spanning tree server link protocol */
15
16 #include "inspircd.h"
17 #include "commands/cmd_whois.h"
18 #include "commands/cmd_stats.h"
19 #include "socket.h"
20 #include "xline.h"
21 #include "transport.h"
22
23 #include "m_spanningtree/cachetimer.h"
24 #include "m_spanningtree/resolvers.h"
25 #include "m_spanningtree/main.h"
26 #include "m_spanningtree/utils.h"
27 #include "m_spanningtree/treeserver.h"
28 #include "m_spanningtree/link.h"
29 #include "m_spanningtree/treesocket.h"
30 #include "m_spanningtree/rconnect.h"
31 #include "m_spanningtree/rsquit.h"
32 #include "m_spanningtree/protocolinterface.h"
33
34 /* $ModDep: m_spanningtree/cachetimer.h m_spanningtree/resolvers.h m_spanningtree/main.h m_spanningtree/utils.h m_spanningtree/treeserver.h m_spanningtree/link.h m_spanningtree/treesocket.h m_spanningtree/rconnect.h m_spanningtree/rsquit.h m_spanningtree/protocolinterface.h */
35
36 ModuleSpanningTree::ModuleSpanningTree(InspIRCd* Me)
37         : Module(Me), max_local(0), max_global(0)
38 {
39         ServerInstance->Modules->UseInterface("BufferedSocketHook");
40         Utils = new SpanningTreeUtilities(ServerInstance, this);
41         command_rconnect = new CommandRConnect(ServerInstance, this, Utils);
42         ServerInstance->AddCommand(command_rconnect);
43         command_rsquit = new CommandRSQuit(ServerInstance, this, Utils);
44         ServerInstance->AddCommand(command_rsquit);
45         RefreshTimer = new CacheRefreshTimer(ServerInstance, Utils);
46         ServerInstance->Timers->AddTimer(RefreshTimer);
47
48         Implementation eventlist[] =
49         {
50                 I_OnPreCommand, I_OnGetServerDescription, I_OnUserInvite, I_OnPostLocalTopicChange,
51                 I_OnWallops, I_OnUserNotice, I_OnUserMessage, I_OnBackgroundTimer,
52                 I_OnUserJoin, I_OnChangeLocalUserHost, I_OnChangeName, I_OnUserPart, I_OnUnloadModule,
53                 I_OnUserQuit, I_OnUserPostNick, I_OnUserKick, I_OnRemoteKill, I_OnRehash,
54                 I_OnOper, I_OnAddLine, I_OnDelLine, I_ProtoSendMode, I_OnMode, I_OnLoadModule,
55                 I_OnStats, I_ProtoSendMetaData, I_OnEvent, I_OnSetAway, I_OnPostCommand
56         };
57         ServerInstance->Modules->Attach(eventlist, this, 29);
58
59         delete ServerInstance->PI;
60         ServerInstance->PI = new SpanningTreeProtocolInterface(this, Utils, ServerInstance);
61         loopCall = false;
62
63         for (std::vector<User*>::const_iterator i = ServerInstance->Users->local_users.begin(); i != ServerInstance->Users->local_users.end(); i++)
64         {
65                 ServerInstance->PI->Introduce(*i);
66         }
67 }
68
69 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
70 {
71         std::string Parent = Utils->TreeRoot->GetName();
72         if (Current->GetParent())
73         {
74                 Parent = Current->GetParent()->GetName();
75         }
76         for (unsigned int q = 0; q < Current->ChildCount(); q++)
77         {
78                 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
79                 {
80                         if (IS_OPER(user))
81                         {
82                                  ShowLinks(Current->GetChild(q),user,hops+1);
83                         }
84                 }
85                 else
86                 {
87                         ShowLinks(Current->GetChild(q),user,hops+1);
88                 }
89         }
90         /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
91         if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName().c_str())) && (!IS_OPER(user)))
92                 return;
93         /* Or if the server is hidden and they're not an oper */
94         else if ((Current->Hidden) && (!IS_OPER(user)))
95                 return;
96
97         user->WriteNumeric(364, "%s %s %s :%d %s",      user->nick.c_str(),Current->GetName().c_str(),
98                         (Utils->FlatLinks && (!IS_OPER(user))) ? ServerInstance->Config->ServerName : Parent.c_str(),
99                         (Utils->FlatLinks && (!IS_OPER(user))) ? 0 : hops,
100                         Current->GetDesc().c_str());
101 }
102
103 int ModuleSpanningTree::CountLocalServs()
104 {
105         return Utils->TreeRoot->ChildCount();
106 }
107
108 int ModuleSpanningTree::CountServs()
109 {
110         return Utils->serverlist.size();
111 }
112
113 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
114 {
115         ShowLinks(Utils->TreeRoot,user,0);
116         user->WriteNumeric(365, "%s * :End of /LINKS list.",user->nick.c_str());
117         return;
118 }
119
120 void ModuleSpanningTree::HandleLusers(const std::vector<std::string>& parameters, User* user)
121 {
122         unsigned int n_users = ServerInstance->Users->UserCount();
123
124         /* Only update these when someone wants to see them, more efficient */
125         if ((unsigned int)ServerInstance->Users->LocalUserCount() > max_local)
126                 max_local = ServerInstance->Users->LocalUserCount();
127         if (n_users > max_global)
128                 max_global = n_users;
129
130         unsigned int ulined_count = 0;
131         unsigned int ulined_local_count = 0;
132
133         /* If ulined are hidden and we're not an oper, count the number of ulined servers hidden,
134          * locally and globally (locally means directly connected to us)
135          */
136         if ((Utils->HideULines) && (!IS_OPER(user)))
137         {
138                 for (server_hash::iterator q = Utils->serverlist.begin(); q != Utils->serverlist.end(); q++)
139                 {
140                         if (ServerInstance->ULine(q->second->GetName().c_str()))
141                         {
142                                 ulined_count++;
143                                 if (q->second->GetParent() == Utils->TreeRoot)
144                                         ulined_local_count++;
145                         }
146                 }
147         }
148         user->WriteNumeric(251, "%s :There are %d users and %d invisible on %d servers",user->nick.c_str(),
149                         n_users-ServerInstance->Users->ModeCount('i'),
150                         ServerInstance->Users->ModeCount('i'),
151                         ulined_count ? this->CountServs() - ulined_count : this->CountServs());
152
153         if (ServerInstance->Users->OperCount())
154                 user->WriteNumeric(252, "%s %d :operator(s) online",user->nick.c_str(),ServerInstance->Users->OperCount());
155
156         if (ServerInstance->Users->UnregisteredUserCount())
157                 user->WriteNumeric(253, "%s %d :unknown connections",user->nick.c_str(),ServerInstance->Users->UnregisteredUserCount());
158
159         if (ServerInstance->ChannelCount())
160                 user->WriteNumeric(254, "%s %ld :channels formed",user->nick.c_str(),ServerInstance->ChannelCount());
161
162         user->WriteNumeric(255, "%s :I have %d clients and %d servers",user->nick.c_str(),ServerInstance->Users->LocalUserCount(),ulined_local_count ? this->CountLocalServs() - ulined_local_count : this->CountLocalServs());
163         user->WriteNumeric(265, "%s :Current Local Users: %d  Max: %d",user->nick.c_str(),ServerInstance->Users->LocalUserCount(),max_local);
164         user->WriteNumeric(266, "%s :Current Global Users: %d  Max: %d",user->nick.c_str(),n_users,max_global);
165         return;
166 }
167
168 std::string ModuleSpanningTree::TimeToStr(time_t secs)
169 {
170         time_t mins_up = secs / 60;
171         time_t hours_up = mins_up / 60;
172         time_t days_up = hours_up / 24;
173         secs = secs % 60;
174         mins_up = mins_up % 60;
175         hours_up = hours_up % 24;
176         return ((days_up ? (ConvToStr(days_up) + "d") : std::string(""))
177                         + (hours_up ? (ConvToStr(hours_up) + "h") : std::string(""))
178                         + (mins_up ? (ConvToStr(mins_up) + "m") : std::string(""))
179                         + ConvToStr(secs) + "s");
180 }
181
182 void ModuleSpanningTree::DoPingChecks(time_t curtime)
183 {
184         /*
185          * Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
186          * This prevents lost REMOTECONNECT notices
187          */
188         timeval t;
189         gettimeofday(&t, NULL);
190         long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
191
192         for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
193         {
194                 TreeServer *s = i->second;
195
196                 // Fix for bug #792, do not ping servers that are not connected yet!
197                 // Remote servers have Socket == NULL and local connected servers have
198                 // Socket->LinkState == CONNECTED
199                 if (s->GetSocket() && s->GetSocket()->GetLinkState() != CONNECTED)
200                         continue;
201
202                 // Now do PING checks on all servers
203                 TreeServer *mts = Utils->BestRouteTo(s->GetID());
204
205                 if (mts)
206                 {
207                         // Only ping if this server needs one
208                         if (curtime >= s->NextPingTime())
209                         {
210                                 // And if they answered the last
211                                 if (s->AnsweredLastPing())
212                                 {
213                                         // They did, send a ping to them
214                                         s->SetNextPingTime(curtime + Utils->PingFreq);
215                                         TreeSocket *tsock = mts->GetSocket();
216
217                                         // ... if we can find a proper route to them
218                                         if (tsock)
219                                         {
220                                                 tsock->WriteLine(std::string(":") + ServerInstance->Config->GetSID() + " PING " +
221                                                                 ServerInstance->Config->GetSID() + " " + s->GetID());
222                                                 s->LastPingMsec = ts;
223                                         }
224                                 }
225                                 else
226                                 {
227                                         // They didn't answer the last ping, if they are locally connected, get rid of them.
228                                         TreeSocket *sock = s->GetSocket();
229                                         if (sock)
230                                         {
231                                                 sock->SendError("Ping timeout");
232                                                 sock->Squit(s,"Ping timeout");
233                                                 ServerInstance->SE->DelFd(sock);
234                                                 sock->Close();
235                                                 return;
236                                         }
237                                 }
238                         }
239
240                         // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
241                         if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
242                         {
243                                 /* The server hasnt responded, send a warning to opers */
244                                 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", s->GetName().c_str(), Utils->PingWarnTime);
245                                 s->Warned = true;
246                         }
247                 }
248         }
249 }
250
251 void ModuleSpanningTree::ConnectServer(Link* x)
252 {
253         bool ipvalid = true;
254
255         if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name)))
256         {
257                 this->ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
258                 return;
259         }
260
261         QueryType start_type = DNS_QUERY_A;
262 #ifdef IPV6
263         start_type = DNS_QUERY_AAAA;
264         if (strchr(x->IPAddr.c_str(),':'))
265         {
266                 in6_addr n;
267                 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
268                         ipvalid = false;
269         }
270         else
271 #endif
272         {
273                 in_addr n;
274                 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
275                         ipvalid = false;
276         }
277
278         /* Do we already have an IP? If so, no need to resolve it. */
279         if (ipvalid)
280         {
281                 /* Gave a hook, but it wasnt one we know */
282                 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
283                         return;
284                 TreeSocket* newsocket = new TreeSocket(Utils, ServerInstance, x->IPAddr,x->Port, x->Timeout ? x->Timeout : 10,x->Name.c_str(), x->Bind, x->Hook.empty() ? NULL : Utils->hooks[x->Hook.c_str()]);
285                 if (newsocket->GetFd() > -1)
286                 {
287                         /* Handled automatically on success */
288                 }
289                 else
290                 {
291                         this->ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
292                         if (ServerInstance->SocketCull.find(newsocket) == ServerInstance->SocketCull.end())
293                                 ServerInstance->SocketCull[newsocket] = newsocket;
294                         Utils->DoFailOver(x);
295                 }
296         }
297         else
298         {
299                 try
300                 {
301                         bool cached;
302                         ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
303                         ServerInstance->AddResolver(snr, cached);
304                 }
305                 catch (ModuleException& e)
306                 {
307                         this->ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
308                         Utils->DoFailOver(x);
309                 }
310         }
311 }
312
313 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
314 {
315         for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
316         {
317                 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
318                 {
319                         x->NextConnectTime = curtime + x->AutoConnect;
320                         TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
321                         if (x->FailOver.length())
322                         {
323                                 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
324                                 if (CheckFailOver)
325                                 {
326                                         /* The failover for this server is currently a member of the network.
327                                          * The failover probably succeeded, where the main link did not.
328                                          * Don't try the main link until the failover is gone again.
329                                          */
330                                         continue;
331                                 }
332                         }
333                         if (!CheckDupe)
334                         {
335                                 // an autoconnected server is not connected. Check if its time to connect it
336                                 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
337                                 this->ConnectServer(&(*x));
338                         }
339                 }
340         }
341 }
342
343 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
344 {
345         std::vector<Link*> failovers;
346         for (std::map<TreeSocket*, std::pair<std::string, int> >::iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); i++)
347         {
348                 TreeSocket* s = i->first;
349                 std::pair<std::string, int> p = i->second;
350                 if (curtime > s->age + p.second)
351                 {
352                         ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %d seconds)",p.first.c_str(),p.second);
353                         ServerInstance->SE->DelFd(s);
354                         s->Close();
355                         Link* MyLink = Utils->FindLink(p.first);
356                         if (MyLink)
357                                 failovers.push_back(MyLink);
358                 }
359         }
360         /* Trigger failover for each timed out socket */
361         for (std::vector<Link*>::const_iterator n = failovers.begin(); n != failovers.end(); ++n)
362         {
363                 Utils->DoFailOver(*n);
364         }
365 }
366
367 int ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
368 {
369         // we've already checked if pcnt > 0, so this is safe
370         TreeServer* found = Utils->FindServerMask(parameters[0]);
371         if (found)
372         {
373                 std::string Version = found->GetVersion();
374                 user->WriteNumeric(351, "%s :%s",user->nick.c_str(),Version.c_str());
375                 if (found == Utils->TreeRoot)
376                 {
377                         ServerInstance->Config->Send005(user);
378                 }
379         }
380         else
381         {
382                 user->WriteNumeric(402, "%s %s :No such server",user->nick.c_str(),parameters[0].c_str());
383         }
384         return 1;
385 }
386
387 /* This method will attempt to get a message to a remote user.
388  */
389 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
390 {
391         char text[MAXBUF];
392         va_list argsPtr;
393
394         va_start(argsPtr, format);
395         vsnprintf(text, MAXBUF, format, argsPtr);
396         va_end(argsPtr);
397
398         if (IS_LOCAL(user))
399                 user->WriteServ("NOTICE %s :%s", user->nick.c_str(), text);
400         else
401                 ServerInstance->PI->SendUserNotice(user, text);
402 }
403
404 int ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
405 {
406         for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
407         {
408                 if (InspIRCd::Match(x->Name.c_str(),parameters[0]))
409                 {
410                         if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name)))
411                         {
412                                 RemoteMessage(user, "*** CONNECT: Server \002%s\002 is ME, not connecting.",x->Name.c_str());
413                                 return 1;
414                         }
415
416                         TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
417                         if (!CheckDupe)
418                         {
419                                 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
420                                 ConnectServer(&(*x));
421                                 return 1;
422                         }
423                         else
424                         {
425                                 RemoteMessage(user, "*** CONNECT: Server \002%s\002 already exists on the network and is connected via \002%s\002",x->Name.c_str(),CheckDupe->GetParent()->GetName().c_str());
426                                 return 1;
427                         }
428                 }
429         }
430         RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0].c_str());
431         return 1;
432 }
433
434 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
435 {
436         TreeServer* s = Utils->FindServer(servername);
437         if (s)
438         {
439                 description = s->GetDesc();
440         }
441 }
442
443 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel, time_t expiry)
444 {
445         if (IS_LOCAL(source))
446         {
447                 std::deque<std::string> params;
448                 params.push_back(dest->uuid);
449                 params.push_back(channel->name);
450                 params.push_back(ConvToStr(expiry));
451                 Utils->DoOneToMany(source->uuid,"INVITE",params);
452         }
453 }
454
455 void ModuleSpanningTree::OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic)
456 {
457         std::deque<std::string> params;
458         params.push_back(chan->name);
459         params.push_back(":"+topic);
460         Utils->DoOneToMany(user->uuid,"TOPIC",params);
461 }
462
463 void ModuleSpanningTree::OnWallops(User* user, const std::string &text)
464 {
465         if (IS_LOCAL(user))
466         {
467                 std::deque<std::string> params;
468                 params.push_back(":"+text);
469                 Utils->DoOneToMany(user->uuid,"WALLOPS",params);
470         }
471 }
472
473 void ModuleSpanningTree::OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
474 {
475         /* Server origin */
476         if (user == NULL)
477                 return;
478
479         if (target_type == TYPE_USER)
480         {
481                 User* d = (User*)dest;
482                 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
483                 {
484                         std::deque<std::string> params;
485                         params.clear();
486                         params.push_back(d->uuid);
487                         params.push_back(":"+text);
488                         Utils->DoOneToOne(user->uuid,"NOTICE",params,d->server);
489                 }
490         }
491         else if (target_type == TYPE_CHANNEL)
492         {
493                 if (IS_LOCAL(user))
494                 {
495                         Channel *c = (Channel*)dest;
496                         if (c)
497                         {
498                                 std::string cname = c->name;
499                                 if (status)
500                                         cname = status + cname;
501                                 TreeServerList list;
502                                 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
503                                 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
504                                 {
505                                         TreeSocket* Sock = i->second->GetSocket();
506                                         if (Sock)
507                                                 Sock->WriteLine(":"+std::string(user->uuid)+" NOTICE "+cname+" :"+text);
508                                 }
509                         }
510                 }
511         }
512         else if (target_type == TYPE_SERVER)
513         {
514                 if (IS_LOCAL(user))
515                 {
516                         char* target = (char*)dest;
517                         std::deque<std::string> par;
518                         par.push_back(target);
519                         par.push_back(":"+text);
520                         Utils->DoOneToMany(user->uuid,"NOTICE",par);
521                 }
522         }
523 }
524
525 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
526 {
527         /* Server origin */
528         if (user == NULL)
529                 return;
530
531         if (target_type == TYPE_USER)
532         {
533                 // route private messages which are targetted at clients only to the server
534                 // which needs to receive them
535                 User* d = (User*)dest;
536                 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
537                 {
538                         std::deque<std::string> params;
539                         params.clear();
540                         params.push_back(d->uuid);
541                         params.push_back(":"+text);
542                         Utils->DoOneToOne(user->uuid,"PRIVMSG",params,d->server);
543                 }
544         }
545         else if (target_type == TYPE_CHANNEL)
546         {
547                 if (IS_LOCAL(user))
548                 {
549                         Channel *c = (Channel*)dest;
550                         if (c)
551                         {
552                                 std::string cname = c->name;
553                                 if (status)
554                                         cname = status + cname;
555                                 TreeServerList list;
556                                 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
557                                 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
558                                 {
559                                         TreeSocket* Sock = i->second->GetSocket();
560                                         if (Sock)
561                                                 Sock->WriteLine(":"+std::string(user->uuid)+" PRIVMSG "+cname+" :"+text);
562                                 }
563                         }
564                 }
565         }
566         else if (target_type == TYPE_SERVER)
567         {
568                 if (IS_LOCAL(user))
569                 {
570                         char* target = (char*)dest;
571                         std::deque<std::string> par;
572                         par.push_back(target);
573                         par.push_back(":"+text);
574                         Utils->DoOneToMany(user->uuid,"PRIVMSG",par);
575                 }
576         }
577 }
578
579 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
580 {
581         AutoConnectServers(curtime);
582         DoPingChecks(curtime);
583         DoConnectTimeout(curtime);
584 }
585
586 void ModuleSpanningTree::OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
587 {
588         // Only do this for local users
589         if (IS_LOCAL(user))
590         {
591                 std::deque<std::string> params;
592                 // set up their permissions and the channel TS with FJOIN.
593                 // All users are FJOINed now, because a module may specify
594                 // new joining permissions for the user.
595                 params.push_back(channel->name);
596                 params.push_back(ConvToStr(channel->age));
597                 params.push_back(std::string("+") + channel->ChanModes(true));
598                 params.push_back(ServerInstance->Modes->ModeString(user, channel, false)+","+std::string(user->uuid));
599                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"FJOIN",params);
600         }
601 }
602
603 int ModuleSpanningTree::OnChangeLocalUserHost(User* user, const std::string &newhost)
604 {
605         if (user->registered != REG_ALL)
606                 return 0;
607
608         std::deque<std::string> params;
609         params.push_back(newhost);
610         Utils->DoOneToMany(user->uuid,"FHOST",params);
611         return 0;
612 }
613
614 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
615 {
616         // only occurs for local clients
617         if (user->registered != REG_ALL)
618                 return;
619
620         std::deque<std::string> params;
621         params.push_back(gecos);
622         Utils->DoOneToMany(user->uuid,"FNAME",params);
623 }
624
625 void ModuleSpanningTree::OnUserPart(User* user, Channel* channel,  std::string &partmessage, bool &silent)
626 {
627         if (IS_LOCAL(user))
628         {
629                 std::deque<std::string> params;
630                 params.push_back(channel->name);
631                 if (!partmessage.empty())
632                         params.push_back(":"+partmessage);
633                 Utils->DoOneToMany(user->uuid,"PART",params);
634         }
635 }
636
637 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
638 {
639         if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
640         {
641                 std::deque<std::string> params;
642
643                 if (oper_message != reason)
644                 {
645                         params.push_back(":"+oper_message);
646                         Utils->DoOneToMany(user->uuid,"OPERQUIT",params);
647                 }
648                 params.clear();
649                 params.push_back(":"+reason);
650                 Utils->DoOneToMany(user->uuid,"QUIT",params);
651         }
652
653         // Regardless, We need to modify the user Counts..
654         TreeServer* SourceServer = Utils->FindServer(user->server);
655         if (SourceServer)
656         {
657                 SourceServer->SetUserCount(-1); // decrement by 1
658         }
659 }
660
661 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
662 {
663         if (IS_LOCAL(user))
664         {
665                 std::deque<std::string> params;
666                 params.push_back(user->nick);
667
668                 /** IMPORTANT: We don't update the TS if the oldnick is just a case change of the newnick!
669                  */
670                 if (irc::string(user->nick.c_str()) != assign(oldnick))
671                         user->age = ServerInstance->Time();
672
673                 params.push_back(ConvToStr(user->age));
674                 Utils->DoOneToMany(user->uuid,"NICK",params);
675         }
676 }
677
678 void ModuleSpanningTree::OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
679 {
680         if (loopCall)
681                 return;
682         if ((source) && (IS_LOCAL(source)))
683         {
684                 std::deque<std::string> params;
685                 params.push_back(chan->name);
686                 params.push_back(user->uuid);
687                 params.push_back(":"+reason);
688                 Utils->DoOneToMany(source->uuid,"KICK",params);
689         }
690         else if (!source)
691         {
692                 std::deque<std::string> params;
693                 params.push_back(chan->name);
694                 params.push_back(user->uuid);
695                 params.push_back(":"+reason);
696                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"KICK",params);
697         }
698 }
699
700 void ModuleSpanningTree::OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason)
701 {
702         if (!IS_LOCAL(source))
703                 return; // Only start routing if we're origin.
704
705         std::deque<std::string> params;
706         params.push_back(":"+reason);
707         Utils->DoOneToMany(dest->uuid,"OPERQUIT",params);
708         params.clear();
709         params.push_back(dest->uuid);
710         params.push_back(":"+reason);
711         dest->SetOperQuit(operreason);
712         Utils->DoOneToMany(source->uuid,"KILL",params);
713 }
714
715 void ModuleSpanningTree::OnRehash(User* user, const std::string &parameter)
716 {
717         ServerInstance->Logs->Log("remoterehash", DEBUG, "called with param %s", parameter.c_str());
718
719         // Send out to other servers
720         if (!parameter.empty() && parameter[0] != '-')
721         {
722                 ServerInstance->Logs->Log("remoterehash", DEBUG, "sending out lol");
723                 std::deque<std::string> params;
724                 params.push_back(parameter);
725                 Utils->DoOneToAllButSender(user ? user->uuid : ServerInstance->Config->GetSID(), "REHASH", params, user ? user->server : ServerInstance->Config->ServerName);
726         }
727
728         // Re-read config stuff
729         Utils->ReadConfiguration(true);
730 }
731
732 void ModuleSpanningTree::OnLoadModule(Module* mod, const std::string &name)
733 {
734         this->RedoConfig(mod, name);
735 }
736
737 void ModuleSpanningTree::OnUnloadModule(Module* mod, const std::string &name)
738 {
739         this->RedoConfig(mod, name);
740 }
741
742 void ModuleSpanningTree::RedoConfig(Module* mod, const std::string &name)
743 {
744         /* If m_sha256.so is loaded (we use this for HMAC) or any module implementing a BufferedSocket interface is loaded,
745          * then we need to re-read our config again taking this into account.
746          */
747         modulelist* ml = ServerInstance->Modules->FindInterface("BufferedSocketHook");
748         bool IsBufferSocketModule = false;
749
750         /* Did we find any modules? */
751         if (ml && std::find(ml->begin(), ml->end(), mod) != ml->end())
752                 IsBufferSocketModule = true;
753
754         if (name == "m_sha256.so" || IsBufferSocketModule)
755         {
756                 Utils->ReadConfiguration(true);
757         }
758 }
759
760 // note: the protocol does not allow direct umode +o except
761 // via NICK with 8 params. sending OPERTYPE infers +o modechange
762 // locally.
763 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
764 {
765         if (IS_LOCAL(user))
766         {
767                 std::deque<std::string> params;
768                 params.push_back(opertype);
769                 Utils->DoOneToMany(user->uuid,"OPERTYPE",params);
770         }
771 }
772
773 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
774 {
775         if (!x->IsBurstable() || loopCall)
776                 return;
777
778         char data[MAXBUF];
779         snprintf(data,MAXBUF,"%s %s %s %lu %lu :%s", x->type.c_str(), x->Displayable(),
780         ServerInstance->Config->ServerName, (unsigned long)x->set_time, (unsigned long)x->duration, x->reason);
781         std::deque<std::string> params;
782         params.push_back(data);
783
784         if (!user)
785         {
786                 /* Server-set lines */
787                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "ADDLINE", params);
788         }
789         else if (IS_LOCAL(user))
790         {
791                 /* User-set lines */
792                 Utils->DoOneToMany(user->uuid, "ADDLINE", params);
793         }
794 }
795
796 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
797 {
798         if (x->type == "K")
799                 return;
800
801         char data[MAXBUF];
802         snprintf(data,MAXBUF,"%s %s", x->type.c_str(), x->Displayable());
803         std::deque<std::string> params;
804         params.push_back(data);
805
806         if (!user)
807         {
808                 /* Server-unset lines */
809                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "DELLINE", params);
810         }
811         else if (IS_LOCAL(user))
812         {
813                 /* User-unset lines */
814                 Utils->DoOneToMany(user->uuid, "DELLINE", params);
815         }
816 }
817
818 void ModuleSpanningTree::OnMode(User* user, void* dest, int target_type, const std::deque<std::string> &text, const std::deque<TranslateType> &translate)
819 {
820         if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
821         {
822                 std::deque<std::string> params;
823                 std::string command;
824                 std::string output_text;
825
826                 ServerInstance->Parser->TranslateUIDs(translate, text, output_text);
827
828                 if (target_type == TYPE_USER)
829                 {
830                         User* u = (User*)dest;
831                         params.push_back(u->uuid);
832                         params.push_back(output_text);
833                         command = "MODE";
834                 }
835                 else
836                 {
837                         Channel* c = (Channel*)dest;
838                         params.push_back(c->name);
839                         params.push_back(ConvToStr(c->age));
840                         params.push_back(output_text);
841                         command = "FMODE";
842                 }
843
844                 Utils->DoOneToMany(user->uuid, command, params);
845         }
846 }
847
848 int ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
849 {
850         if (IS_LOCAL(user))
851         {
852                 if (awaymsg.empty())
853                 {
854                         std::deque<std::string> params;
855                         params.clear();
856                         Utils->DoOneToMany(user->uuid,"AWAY",params);
857                 }
858                 else
859                 {
860                         std::deque<std::string> params;
861                         params.push_back(":" + awaymsg);
862                         Utils->DoOneToMany(user->uuid,"AWAY",params);
863                 }
864         }
865
866         return 0;
867 }
868
869 void ModuleSpanningTree::ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::deque<std::string> &modeline, const std::deque<TranslateType> &translate)
870 {
871         TreeSocket* s = (TreeSocket*)opaque;
872         std::string output_text;
873
874         ServerInstance->Parser->TranslateUIDs(translate, modeline, output_text);
875
876         if (target)
877         {
878                 if (target_type == TYPE_USER)
879                 {
880                         User* u = (User*)target;
881                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" MODE "+u->uuid+" "+output_text);
882                 }
883                 else if (target_type == TYPE_CHANNEL)
884                 {
885                         Channel* c = (Channel*)target;
886                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+output_text);
887                 }
888         }
889 }
890
891 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata)
892 {
893         TreeSocket* s = (TreeSocket*)opaque;
894         if (target)
895         {
896                 if (target_type == TYPE_USER)
897                 {
898                         User* u = (User*)target;
899                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA "+u->uuid+" "+extname+" :"+extdata);
900                 }
901                 else if (target_type == TYPE_CHANNEL)
902                 {
903                         Channel* c = (Channel*)target;
904                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA "+c->name+" "+extname+" :"+extdata);
905                 }
906         }
907         if (target_type == TYPE_OTHER)
908         {
909                 s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA * "+extname+" :"+extdata);
910         }
911 }
912
913 void ModuleSpanningTree::OnEvent(Event* event)
914 {
915         if ((event->GetEventID() == "send_encap") || (event->GetEventID() == "send_metadata") || (event->GetEventID() == "send_topic") || (event->GetEventID() == "send_mode") || (event->GetEventID() == "send_mode_explicit") || (event->GetEventID() == "send_opers")
916                 || (event->GetEventID() == "send_modeset") || (event->GetEventID() == "send_snoset") || (event->GetEventID() == "send_push"))
917         {
918                 ServerInstance->Logs->Log("m_spanningtree", DEBUG, "WARNING: Deprecated use of old 1.1 style m_spanningtree event ignored, type '"+event->GetEventID()+"'!");
919         }
920 }
921
922 ModuleSpanningTree::~ModuleSpanningTree()
923 {
924         delete ServerInstance->PI;
925         ServerInstance->PI = new ProtocolInterface(ServerInstance);
926
927         /* This will also free the listeners */
928         delete Utils;
929
930         ServerInstance->Timers->DelTimer(RefreshTimer);
931
932         ServerInstance->Modules->DoneWithInterface("BufferedSocketHook");
933 }
934
935 Version ModuleSpanningTree::GetVersion()
936 {
937         return Version("$Id$", VF_VENDOR, API_VERSION);
938 }
939
940 /* It is IMPORTANT that m_spanningtree is the last module in the chain
941  * so that any activity it sees is FINAL, e.g. we arent going to send out
942  * a NICK message before m_cloaking has finished putting the +x on the user,
943  * etc etc.
944  * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
945  * the module call queue.
946  */
947 void ModuleSpanningTree::Prioritize()
948 {
949         ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
950 }
951
952 MODULE_INIT(ModuleSpanningTree)