src/modules/m_spanningtree/main.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2009 Craig Edwards <craigedwards@brainbox.cc>
   6  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   7  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   8  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #include "inspircd.h"
  25 #include "socket.h"
  26 #include "xline.h"
  27 #include "iohook.h"
  28 #include "modules/spanningtree.h"
  29
  30 #include "resolvers.h"
  31 #include "main.h"
  32 #include "utils.h"
  33 #include "treeserver.h"
  34 #include "link.h"
  35 #include "treesocket.h"
  36 #include "commands.h"
  37 #include "translate.h"
  38
  39 ModuleSpanningTree::ModuleSpanningTree()
  40         : rconnect(this), rsquit(this), map(this)
  41         , commands(this)
  42         , currmembid(0)
  43         , eventprov(this, "event/spanningtree")
  44         , DNS(this, "DNS")
  45         , loopCall(false)
  46 {
  47 }
  48
  49 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
  50         : svsjoin(module), svspart(module), svsnick(module), metadata(module),
  51         uid(module), opertype(module), fjoin(module), ijoin(module), resync(module),
  52         fmode(module), ftopic(module), fhost(module), fident(module), fname(module),
  53         away(module), addline(module), delline(module), encap(module), idle(module),
  54         nick(module), ping(module), pong(module), save(module),
  55         server(module), squit(module), snonotice(module),
  56         endburst(module), sinfo(module), num(module)
  57 {
  58 }
  59
  60 namespace
  61 {
  62         void SetLocalUsersServer(Server* newserver)
  63         {
  64                 // Does not change the server of quitting users because those are not in the list
  65
  66                 ServerInstance->FakeClient->server = newserver;
  67                 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
  68                 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
  69                         (*i)->server = newserver;
  70         }
  71
  72         void ResetMembershipIds()
  73         {
  74                 // Set all membership ids to 0
  75                 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
  76                 for (UserManager::LocalList::iterator i = list.begin(); i != list.end(); ++i)
  77                 {
  78                         LocalUser* user = *i;
  79                         for (User::ChanList::iterator j = user->chans.begin(); j != user->chans.end(); ++j)
  80                                 (*j)->id = 0;
  81                 }
  82         }
  83 }
  84
  85 void ModuleSpanningTree::init()
  86 {
  87         ServerInstance->SNO->EnableSnomask('l', "LINK");
  88
  89         ResetMembershipIds();
  90
  91         Utils = new SpanningTreeUtilities(this);
  92         Utils->TreeRoot = new TreeServer;
  93
  94         ServerInstance->PI = &protocolinterface;
  95
  96         delete ServerInstance->FakeClient->server;
  97         SetLocalUsersServer(Utils->TreeRoot);
  98 }
  99
 100 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
 101 {
 102         std::string Parent = Utils->TreeRoot->GetName();
 103         if (Current->GetParent())
 104         {
 105                 Parent = Current->GetParent()->GetName();
 106         }
 107
 108         const TreeServer::ChildServers& children = Current->GetChildren();
 109         for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
 110         {
 111                 TreeServer* server = *i;
 112                 if ((server->Hidden) || ((Utils->HideULines) && (server->IsULine())))
 113                 {
 114                         if (user->IsOper())
 115                         {
 116                                  ShowLinks(server, user, hops+1);
 117                         }
 118                 }
 119                 else
 120                 {
 121                         ShowLinks(server, user, hops+1);
 122                 }
 123         }
 124         /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
 125         if ((Utils->HideULines) && (Current->IsULine()) && (!user->IsOper()))
 126                 return;
 127         /* Or if the server is hidden and they're not an oper */
 128         else if ((Current->Hidden) && (!user->IsOper()))
 129                 return;
 130
 131         user->WriteNumeric(RPL_LINKS, Current->GetName(),
 132                         (((Utils->FlatLinks) && (!user->IsOper())) ? ServerInstance->Config->ServerName : Parent),
 133                         InspIRCd::Format("%d %s", (((Utils->FlatLinks) && (!user->IsOper())) ? 0 : hops), Current->GetDesc().c_str()));
 134 }
 135
 136 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
 137 {
 138         ShowLinks(Utils->TreeRoot,user,0);
 139         user->WriteNumeric(RPL_ENDOFLINKS, '*', "End of /LINKS list.");
 140 }
 141
 142 std::string ModuleSpanningTree::TimeToStr(time_t secs)
 143 {
 144         time_t mins_up = secs / 60;
 145         time_t hours_up = mins_up / 60;
 146         time_t days_up = hours_up / 24;
 147         secs = secs % 60;
 148         mins_up = mins_up % 60;
 149         hours_up = hours_up % 24;
 150         return ((days_up ? (ConvToStr(days_up) + "d") : "")
 151                         + (hours_up ? (ConvToStr(hours_up) + "h") : "")
 152                         + (mins_up ? (ConvToStr(mins_up) + "m") : "")
 153                         + ConvToStr(secs) + "s");
 154 }
 155
 156 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
 157 {
 158         if (!a)
 159                 return;
 160         for(unsigned int j=0; j < a->servers.size(); j++)
 161         {
 162                 if (Utils->FindServer(a->servers[j]))
 163                 {
 164                         // found something in this block. Should the server fail,
 165                         // we want to start at the start of the list, not in the
 166                         // middle where we left off
 167                         a->position = -1;
 168                         return;
 169                 }
 170         }
 171         if (on_timer && a->position >= 0)
 172                 return;
 173         if (!on_timer && a->position < 0)
 174                 return;
 175
 176         a->position++;
 177         while (a->position < (int)a->servers.size())
 178         {
 179                 Link* x = Utils->FindLink(a->servers[a->position]);
 180                 if (x)
 181                 {
 182                         ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
 183                         ConnectServer(x, a);
 184                         return;
 185                 }
 186                 a->position++;
 187         }
 188         // Autoconnect chain has been fully iterated; start at the beginning on the
 189         // next AutoConnectServers run
 190         a->position = -1;
 191 }
 192
 193 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
 194 {
 195         bool ipvalid = true;
 196
 197         if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name), rfc_case_insensitive_map))
 198         {
 199                 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
 200                 return;
 201         }
 202
 203         DNS::QueryType start_type = DNS::QUERY_AAAA;
 204         if (strchr(x->IPAddr.c_str(),':'))
 205         {
 206                 in6_addr n;
 207                 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
 208                         ipvalid = false;
 209         }
 210         else
 211         {
 212                 in_addr n;
 213                 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
 214                         ipvalid = false;
 215         }
 216
 217         /* Do we already have an IP? If so, no need to resolve it. */
 218         if (ipvalid)
 219         {
 220                 // Create a TreeServer object that will start connecting immediately in the background
 221                 TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
 222                 if (newsocket->GetFd() > -1)
 223                 {
 224                         /* Handled automatically on success */
 225                 }
 226                 else
 227                 {
 228                         ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
 229                                 x->Name.c_str(), newsocket->getError().c_str());
 230                         ServerInstance->GlobalCulls.AddItem(newsocket);
 231                 }
 232         }
 233         else if (!DNS)
 234         {
 235                 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: Hostname given and m_dns.so is not loaded, unable to resolve.", x->Name.c_str());
 236         }
 237         else
 238         {
 239                 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
 240                 try
 241                 {
 242                         DNS->Process(snr);
 243                 }
 244                 catch (DNS::Exception& e)
 245                 {
 246                         delete snr;
 247                         ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason().c_str());
 248                         ConnectServer(y, false);
 249                 }
 250         }
 251 }
 252
 253 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
 254 {
 255         for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
 256         {
 257                 Autoconnect* x = *i;
 258                 if (curtime >= x->NextConnectTime)
 259                 {
 260                         x->NextConnectTime = curtime + x->Period;
 261                         ConnectServer(x, true);
 262                 }
 263         }
 264 }
 265
 266 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
 267 {
 268         std::map<TreeSocket*, std::pair<std::string, int> >::iterator i = Utils->timeoutlist.begin();
 269         while (i != Utils->timeoutlist.end())
 270         {
 271                 TreeSocket* s = i->first;
 272                 std::pair<std::string, int> p = i->second;
 273                 std::map<TreeSocket*, std::pair<std::string, int> >::iterator me = i;
 274                 i++;
 275                 if (s->GetLinkState() == DYING)
 276                 {
 277                         Utils->timeoutlist.erase(me);
 278                         s->Close();
 279                 }
 280                 else if (curtime > s->age + p.second)
 281                 {
 282                         ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %d seconds)",p.first.c_str(),p.second);
 283                         Utils->timeoutlist.erase(me);
 284                         s->Close();
 285                 }
 286         }
 287 }
 288
 289 ModResult ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
 290 {
 291         // We've already confirmed that !parameters.empty(), so this is safe
 292         TreeServer* found = Utils->FindServerMask(parameters[0]);
 293         if (found)
 294         {
 295                 if (found == Utils->TreeRoot)
 296                 {
 297                         // Pass to default VERSION handler.
 298                         return MOD_RES_PASSTHRU;
 299                 }
 300
 301                 // If an oper wants to see the version then show the full version string instead of the normal,
 302                 // but only if it is non-empty.
 303                 // If it's empty it might be that the server is still syncing (full version hasn't arrived yet)
 304                 // or the server is a 2.0 server and does not send a full version.
 305                 bool showfull = ((user->IsOper()) && (!found->GetFullVersion().empty()));
 306                 const std::string& Version = (showfull ? found->GetFullVersion() : found->GetVersion());
 307                 user->WriteNumeric(RPL_VERSION, Version);
 308         }
 309         else
 310         {
 311                 user->WriteNumeric(ERR_NOSUCHSERVER, parameters[0], "No such server");
 312         }
 313         return MOD_RES_DENY;
 314 }
 315
 316 ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
 317 {
 318         for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
 319         {
 320                 Link* x = *i;
 321                 if (InspIRCd::Match(x->Name.c_str(),parameters[0], rfc_case_insensitive_map))
 322                 {
 323                         if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name), rfc_case_insensitive_map))
 324                         {
 325                                 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: Server \002%s\002 is ME, not connecting.", x->Name.c_str()));
 326                                 return MOD_RES_DENY;
 327                         }
 328
 329                         TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
 330                         if (!CheckDupe)
 331                         {
 332                                 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: Connecting to server: \002%s\002 (%s:%d)", x->Name.c_str(), (x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()), x->Port));
 333                                 ConnectServer(x);
 334                                 return MOD_RES_DENY;
 335                         }
 336                         else
 337                         {
 338                                 user->WriteRemoteNotice(InspIRCd::Format("*** 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()));
 339                                 return MOD_RES_DENY;
 340                         }
 341                 }
 342         }
 343         user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: No server matching \002%s\002 could be found in the config file.", parameters[0].c_str()));
 344         return MOD_RES_DENY;
 345 }
 346
 347 void ModuleSpanningTree::OnUserInvite(User* source, User* dest, Channel* channel, time_t expiry, unsigned int notifyrank, CUList& notifyexcepts)
 348 {
 349         if (IS_LOCAL(source))
 350         {
 351                 CmdBuilder params(source, "INVITE");
 352                 params.push_back(dest->uuid);
 353                 params.push_back(channel->name);
 354                 params.push_int(channel->age);
 355                 params.push_back(ConvToStr(expiry));
 356                 params.Broadcast();
 357         }
 358 }
 359
 360 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
 361 {
 362         // Drop remote events on the floor.
 363         if (!IS_LOCAL(user))
 364                 return;
 365
 366         CommandFTopic::Builder(user, chan).Broadcast();
 367 }
 368
 369 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype)
 370 {
 371         if (!IS_LOCAL(user))
 372                 return;
 373
 374         const char* message_type = (msgtype == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
 375         if (target_type == TYPE_USER)
 376         {
 377                 User* d = (User*) dest;
 378                 if (!IS_LOCAL(d))
 379                 {
 380                         CmdBuilder params(user, message_type);
 381                         params.push_back(d->uuid);
 382                         params.push_last(text);
 383                         params.Unicast(d);
 384                 }
 385         }
 386         else if (target_type == TYPE_CHANNEL)
 387         {
 388                 Utils->SendChannelMessage(user->uuid, (Channel*)dest, text, status, exempt_list, message_type);
 389         }
 390         else if (target_type == TYPE_SERVER)
 391         {
 392                 char* target = (char*) dest;
 393                 CmdBuilder par(user, message_type);
 394                 par.push_back(target);
 395                 par.push_last(text);
 396                 par.Broadcast();
 397         }
 398 }
 399
 400 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
 401 {
 402         AutoConnectServers(curtime);
 403         DoConnectTimeout(curtime);
 404 }
 405
 406 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
 407 {
 408         if (user->quitting)
 409                 return;
 410
 411         CommandUID::Builder(user).Broadcast();
 412
 413         if (user->IsOper())
 414                 CommandOpertype::Builder(user).Broadcast();
 415
 416         for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
 417         {
 418                 ExtensionItem* item = i->first;
 419                 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
 420                 if (!value.empty())
 421                         ServerInstance->PI->SendMetaData(user, item->name, value);
 422         }
 423
 424         Utils->TreeRoot->UserCount++;
 425 }
 426
 427 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
 428 {
 429         // Only do this for local users
 430         if (!IS_LOCAL(memb->user))
 431                 return;
 432
 433         // Assign the current membership id to the new Membership and increase it
 434         memb->id = currmembid++;
 435
 436         if (created_by_local)
 437         {
 438                 CommandFJoin::Builder params(memb->chan);
 439                 params.add(memb);
 440                 params.finalize();
 441                 params.Broadcast();
 442         }
 443         else
 444         {
 445                 CmdBuilder params(memb->user, "IJOIN");
 446                 params.push_back(memb->chan->name);
 447                 params.push_int(memb->id);
 448                 if (!memb->modes.empty())
 449                 {
 450                         params.push_back(ConvToStr(memb->chan->age));
 451                         params.push_back(memb->modes);
 452                 }
 453                 params.Broadcast();
 454         }
 455 }
 456
 457 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
 458 {
 459         if (user->registered != REG_ALL || !IS_LOCAL(user))
 460                 return;
 461
 462         CmdBuilder(user, "FHOST").push(newhost).Broadcast();
 463 }
 464
 465 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
 466 {
 467         if (user->registered != REG_ALL || !IS_LOCAL(user))
 468                 return;
 469
 470         CmdBuilder(user, "FNAME").push_last(gecos).Broadcast();
 471 }
 472
 473 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
 474 {
 475         if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
 476                 return;
 477
 478         CmdBuilder(user, "FIDENT").push(ident).Broadcast();
 479 }
 480
 481 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
 482 {
 483         if (IS_LOCAL(memb->user))
 484         {
 485                 CmdBuilder params(memb->user, "PART");
 486                 params.push_back(memb->chan->name);
 487                 if (!partmessage.empty())
 488                         params.push_last(partmessage);
 489                 params.Broadcast();
 490         }
 491 }
 492
 493 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 494 {
 495         if (IS_LOCAL(user))
 496         {
 497                 if (oper_message != reason)
 498                         ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
 499
 500                 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
 501         }
 502         else
 503         {
 504                 // Hide the message if one of the following is true:
 505                 // - User is being quit due to a netsplit and quietbursts is on
 506                 // - Server is a silent uline
 507                 TreeServer* server = TreeServer::Get(user);
 508                 bool hide = (((server->IsDead()) && (Utils->quiet_bursts)) || (server->IsSilentULine()));
 509                 if (!hide)
 510                 {
 511                         ServerInstance->SNO->WriteToSnoMask('Q', "Client exiting on server %s: %s (%s) [%s]",
 512                                 user->server->GetName().c_str(), user->GetFullRealHost().c_str(), user->GetIPString().c_str(), oper_message.c_str());
 513                 }
 514         }
 515
 516         // Regardless, update the UserCount
 517         TreeServer::Get(user)->UserCount--;
 518 }
 519
 520 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
 521 {
 522         if (IS_LOCAL(user))
 523         {
 524                 // The nick TS is updated by the core, we don't do it
 525                 CmdBuilder params(user, "NICK");
 526                 params.push_back(user->nick);
 527                 params.push_back(ConvToStr(user->age));
 528                 params.Broadcast();
 529         }
 530         else if (!loopCall)
 531         {
 532                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WARNING: Changed nick of remote user %s from %s to %s TS %lu by ourselves!", user->uuid.c_str(), oldnick.c_str(), user->nick.c_str(), (unsigned long) user->age);
 533         }
 534 }
 535
 536 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
 537 {
 538         if ((!IS_LOCAL(source)) && (source != ServerInstance->FakeClient))
 539                 return;
 540
 541         CmdBuilder params(source, "KICK");
 542         params.push_back(memb->chan->name);
 543         params.push_back(memb->user->uuid);
 544         // If a remote user is being kicked by us then send the membership id in the kick too
 545         if (!IS_LOCAL(memb->user))
 546                 params.push_int(memb->id);
 547         params.push_last(reason);
 548         params.Broadcast();
 549 }
 550
 551 void ModuleSpanningTree::OnPreRehash(User* user, const std::string &parameter)
 552 {
 553         if (loopCall)
 554                 return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
 555
 556         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
 557
 558         // Send out to other servers
 559         if (!parameter.empty() && parameter[0] != '-')
 560         {
 561                 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
 562                 params.push_back(parameter);
 563                 params.Forward(user ? TreeServer::Get(user)->GetRoute() : NULL);
 564         }
 565 }
 566
 567 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
 568 {
 569         // Did this rehash change the description of this server?
 570         const std::string& newdesc = ServerInstance->Config->ServerDesc;
 571         if (newdesc != Utils->TreeRoot->GetDesc())
 572         {
 573                 // Broadcast a SINFO desc message to let the network know about the new description. This is the description
 574                 // string that is sent in the SERVER message initially and shown for example in WHOIS.
 575                 // We don't need to update the field itself in the Server object - the core does that.
 576                 CommandSInfo::Builder(Utils->TreeRoot, "desc", newdesc).Broadcast();
 577         }
 578
 579         // Re-read config stuff
 580         try
 581         {
 582                 Utils->ReadConfiguration();
 583         }
 584         catch (ModuleException& e)
 585         {
 586                 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
 587                 Utils->RefreshIPCache();
 588                 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
 589                 std::string msg = "Error in configuration: ";
 590                 msg.append(e.GetReason());
 591                 ServerInstance->SNO->WriteToSnoMask('l', msg);
 592                 if (status.srcuser && !IS_LOCAL(status.srcuser))
 593                         ServerInstance->PI->SendSNONotice('L', msg);
 594         }
 595 }
 596
 597 void ModuleSpanningTree::OnLoadModule(Module* mod)
 598 {
 599         std::string data;
 600         data.push_back('+');
 601         data.append(mod->ModuleSourceFile);
 602         Version v = mod->GetVersion();
 603         if (!v.link_data.empty())
 604         {
 605                 data.push_back('=');
 606                 data.append(v.link_data);
 607         }
 608         ServerInstance->PI->SendMetaData("modules", data);
 609 }
 610
 611 void ModuleSpanningTree::OnUnloadModule(Module* mod)
 612 {
 613         if (!Utils)
 614                 return;
 615         ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
 616
 617         if (mod == this)
 618         {
 619                 // We are being unloaded, inform modules about all servers splitting which cannot be done later when the servers are actually disconnected
 620                 const server_hash& servers = Utils->serverlist;
 621                 for (server_hash::const_iterator i = servers.begin(); i != servers.end(); ++i)
 622                 {
 623                         TreeServer* server = i->second;
 624                         if (!server->IsRoot())
 625                                 FOREACH_MOD_CUSTOM(GetEventProvider(), SpanningTreeEventListener, OnServerSplit, (server));
 626                 }
 627                 return;
 628         }
 629
 630         // Some other module is being unloaded. If it provides an IOHook we use, we must close that server connection now.
 631
 632 restart:
 633         // Close all connections which use an IO hook provided by this module
 634         const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
 635         for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
 636         {
 637                 TreeSocket* sock = (*i)->GetSocket();
 638                 if (sock->GetIOHook() && sock->GetIOHook()->prov->creator == mod)
 639                 {
 640                         sock->SendError("SSL module unloaded");
 641                         sock->Close();
 642                         // XXX: The list we're iterating is modified by TreeServer::SQuit() which is called by Close()
 643                         goto restart;
 644                 }
 645         }
 646
 647         for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
 648         {
 649                 TreeSocket* sock = i->first;
 650                 if (sock->GetIOHook() && sock->GetIOHook()->prov->creator == mod)
 651                         sock->Close();
 652         }
 653 }
 654
 655 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
 656 {
 657         if (user->registered != REG_ALL || !IS_LOCAL(user))
 658                 return;
 659
 660         // Note: The protocol does not allow direct umode +o;
 661         // sending OPERTYPE infers +o modechange locally.
 662         CommandOpertype::Builder(user).Broadcast();
 663 }
 664
 665 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
 666 {
 667         if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
 668                 return;
 669
 670         if (!user)
 671                 user = ServerInstance->FakeClient;
 672
 673         CommandAddLine::Builder(x, user).Broadcast();
 674 }
 675
 676 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
 677 {
 678         if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
 679                 return;
 680
 681         if (!user)
 682                 user = ServerInstance->FakeClient;
 683
 684         CmdBuilder params(user, "DELLINE");
 685         params.push_back(x->type);
 686         params.push_back(x->Displayable());
 687         params.Broadcast();
 688 }
 689
 690 ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
 691 {
 692         if (IS_LOCAL(user))
 693                 CommandAway::Builder(user, awaymsg).Broadcast();
 694
 695         return MOD_RES_PASSTHRU;
 696 }
 697
 698 void ModuleSpanningTree::OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags, const std::string& output_mode)
 699 {
 700         if (processflags & ModeParser::MODE_LOCALONLY)
 701                 return;
 702
 703         if (u)
 704         {
 705                 if (u->registered != REG_ALL)
 706                         return;
 707
 708                 CmdBuilder params(source, "MODE");
 709                 params.push(u->uuid);
 710                 params.push(output_mode);
 711                 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
 712                 params.Broadcast();
 713         }
 714         else
 715         {
 716                 CmdBuilder params(source, "FMODE");
 717                 params.push(c->name);
 718                 params.push_int(c->age);
 719                 params.push(output_mode);
 720                 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
 721                 params.Broadcast();
 722         }
 723 }
 724
 725 CullResult ModuleSpanningTree::cull()
 726 {
 727         if (Utils)
 728                 Utils->cull();
 729         return this->Module::cull();
 730 }
 731
 732 ModuleSpanningTree::~ModuleSpanningTree()
 733 {
 734         ServerInstance->PI = &ServerInstance->DefaultProtocolInterface;
 735
 736         Server* newsrv = new Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc);
 737         SetLocalUsersServer(newsrv);
 738
 739         delete Utils;
 740 }
 741
 742 Version ModuleSpanningTree::GetVersion()
 743 {
 744         return Version("Allows servers to be linked", VF_VENDOR);
 745 }
 746
 747 /* It is IMPORTANT that m_spanningtree is the last module in the chain
 748  * so that any activity it sees is FINAL, e.g. we arent going to send out
 749  * a NICK message before m_cloaking has finished putting the +x on the user,
 750  * etc etc.
 751  * Therefore, we set our priority to PRIORITY_LAST to make sure we end up at the END of
 752  * the module call queue.
 753  */
 754 void ModuleSpanningTree::Prioritize()
 755 {
 756         ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
 757 }
 758
 759 MODULE_INIT(ModuleSpanningTree)