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