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