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