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