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