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 /* $ModDesc: Provides a spanning tree server link protocol */
  25
  26 #include "inspircd.h"
  27 #include "socket.h"
  28 #include "xline.h"
  29
  30 #include "cachetimer.h"
  31 #include "resolvers.h"
  32 #include "main.h"
  33 #include "utils.h"
  34 #include "treeserver.h"
  35 #include "link.h"
  36 #include "treesocket.h"
  37 #include "commands.h"
  38 #include "protocolinterface.h"
  39
  40 ModuleSpanningTree::ModuleSpanningTree()
  41 {
  42         Utils = new SpanningTreeUtilities(this);
  43         commands = new SpanningTreeCommands(this);
  44         RefreshTimer = NULL;
  45 }
  46
  47 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
  48         : rconnect(module, module->Utils), rsquit(module, module->Utils),
  49         svsjoin(module), svspart(module), svsnick(module), metadata(module),
  50         uid(module), opertype(module), fjoin(module), fmode(module), ftopic(module),
  51         fhost(module), fident(module), fname(module)
  52 {
  53 }
  54
  55 void ModuleSpanningTree::init()
  56 {
  57         ServerInstance->Modules->AddService(commands->rconnect);
  58         ServerInstance->Modules->AddService(commands->rsquit);
  59         ServerInstance->Modules->AddService(commands->svsjoin);
  60         ServerInstance->Modules->AddService(commands->svspart);
  61         ServerInstance->Modules->AddService(commands->svsnick);
  62         ServerInstance->Modules->AddService(commands->metadata);
  63         ServerInstance->Modules->AddService(commands->uid);
  64         ServerInstance->Modules->AddService(commands->opertype);
  65         ServerInstance->Modules->AddService(commands->fjoin);
  66         ServerInstance->Modules->AddService(commands->fmode);
  67         ServerInstance->Modules->AddService(commands->ftopic);
  68         ServerInstance->Modules->AddService(commands->fhost);
  69         ServerInstance->Modules->AddService(commands->fident);
  70         ServerInstance->Modules->AddService(commands->fname);
  71         RefreshTimer = new CacheRefreshTimer(Utils);
  72         ServerInstance->Timers->AddTimer(RefreshTimer);
  73
  74         Implementation eventlist[] =
  75         {
  76                 I_OnPreCommand, I_OnGetServerDescription, I_OnUserInvite, I_OnPostTopicChange,
  77                 I_OnWallops, I_OnUserNotice, I_OnUserMessage, I_OnBackgroundTimer, I_OnUserJoin,
  78                 I_OnChangeHost, I_OnChangeName, I_OnChangeIdent, I_OnUserPart, I_OnUnloadModule,
  79                 I_OnUserQuit, I_OnUserPostNick, I_OnUserKick, I_OnRemoteKill, I_OnRehash, I_OnPreRehash,
  80                 I_OnOper, I_OnAddLine, I_OnDelLine, I_OnMode, I_OnLoadModule, I_OnStats,
  81                 I_OnSetAway, I_OnPostCommand, I_OnUserConnect, I_OnAcceptConnection
  82         };
  83         ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
  84
  85         delete ServerInstance->PI;
  86         ServerInstance->PI = new SpanningTreeProtocolInterface(this, Utils);
  87         loopCall = false;
  88
  89         // update our local user count
  90         Utils->TreeRoot->SetUserCount(ServerInstance->Users->local_users.size());
  91 }
  92
  93 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
  94 {
  95         std::string Parent = Utils->TreeRoot->GetName();
  96         if (Current->GetParent())
  97         {
  98                 Parent = Current->GetParent()->GetName();
  99         }
 100         for (unsigned int q = 0; q < Current->ChildCount(); q++)
 101         {
 102                 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName()))))
 103                 {
 104                         if (IS_OPER(user))
 105                         {
 106                                  ShowLinks(Current->GetChild(q),user,hops+1);
 107                         }
 108                 }
 109                 else
 110                 {
 111                         ShowLinks(Current->GetChild(q),user,hops+1);
 112                 }
 113         }
 114         /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
 115         if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName())) && (!IS_OPER(user)))
 116                 return;
 117         /* Or if the server is hidden and they're not an oper */
 118         else if ((Current->Hidden) && (!IS_OPER(user)))
 119                 return;
 120
 121         std::string servername = Current->GetName();
 122         user->WriteNumeric(364, "%s %s %s :%d %s",      user->nick.c_str(), servername.c_str(),
 123                         (Utils->FlatLinks && (!IS_OPER(user))) ? ServerInstance->Config->ServerName.c_str() : Parent.c_str(),
 124                         (Utils->FlatLinks && (!IS_OPER(user))) ? 0 : hops,
 125                         Current->GetDesc().c_str());
 126 }
 127
 128 int ModuleSpanningTree::CountServs()
 129 {
 130         return Utils->serverlist.size();
 131 }
 132
 133 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
 134 {
 135         ShowLinks(Utils->TreeRoot,user,0);
 136         user->WriteNumeric(365, "%s * :End of /LINKS list.",user->nick.c_str());
 137         return;
 138 }
 139
 140 std::string ModuleSpanningTree::TimeToStr(time_t secs)
 141 {
 142         time_t mins_up = secs / 60;
 143         time_t hours_up = mins_up / 60;
 144         time_t days_up = hours_up / 24;
 145         secs = secs % 60;
 146         mins_up = mins_up % 60;
 147         hours_up = hours_up % 24;
 148         return ((days_up ? (ConvToStr(days_up) + "d") : "")
 149                         + (hours_up ? (ConvToStr(hours_up) + "h") : "")
 150                         + (mins_up ? (ConvToStr(mins_up) + "m") : "")
 151                         + ConvToStr(secs) + "s");
 152 }
 153
 154 void ModuleSpanningTree::DoPingChecks(time_t curtime)
 155 {
 156         /*
 157          * Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
 158          * This prevents lost REMOTECONNECT notices
 159          */
 160         long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
 161
 162 restart:
 163         for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
 164         {
 165                 TreeServer *s = i->second;
 166
 167                 if (s->GetSocket() && s->GetSocket()->GetLinkState() == DYING)
 168                 {
 169                         s->GetSocket()->Close();
 170                         goto restart;
 171                 }
 172
 173                 // Fix for bug #792, do not ping servers that are not connected yet!
 174                 // Remote servers have Socket == NULL and local connected servers have
 175                 // Socket->LinkState == CONNECTED
 176                 if (s->GetSocket() && s->GetSocket()->GetLinkState() != CONNECTED)
 177                         continue;
 178
 179                 // Now do PING checks on all servers
 180                 TreeServer *mts = Utils->BestRouteTo(s->GetID());
 181
 182                 if (mts)
 183                 {
 184                         // Only ping if this server needs one
 185                         if (curtime >= s->NextPingTime())
 186                         {
 187                                 // And if they answered the last
 188                                 if (s->AnsweredLastPing())
 189                                 {
 190                                         // They did, send a ping to them
 191                                         s->SetNextPingTime(curtime + Utils->PingFreq);
 192                                         TreeSocket *tsock = mts->GetSocket();
 193
 194                                         // ... if we can find a proper route to them
 195                                         if (tsock)
 196                                         {
 197                                                 tsock->WriteLine(":" + ServerInstance->Config->GetSID() + " PING " +
 198                                                                 ServerInstance->Config->GetSID() + " " + s->GetID());
 199                                                 s->LastPingMsec = ts;
 200                                         }
 201                                 }
 202                                 else
 203                                 {
 204                                         // They didn't answer the last ping, if they are locally connected, get rid of them.
 205                                         TreeSocket *sock = s->GetSocket();
 206                                         if (sock)
 207                                         {
 208                                                 sock->SendError("Ping timeout");
 209                                                 sock->Close();
 210                                                 goto restart;
 211                                         }
 212                                 }
 213                         }
 214
 215                         // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
 216                         if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
 217                         {
 218                                 /* The server hasnt responded, send a warning to opers */
 219                                 std::string servername = s->GetName();
 220                                 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", servername.c_str(), Utils->PingWarnTime);
 221                                 s->Warned = true;
 222                         }
 223                 }
 224         }
 225 }
 226
 227 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
 228 {
 229         if (!a)
 230                 return;
 231         for(unsigned int j=0; j < a->servers.size(); j++)
 232         {
 233                 if (Utils->FindServer(a->servers[j]))
 234                 {
 235                         // found something in this block. Should the server fail,
 236                         // we want to start at the start of the list, not in the
 237                         // middle where we left off
 238                         a->position = -1;
 239                         return;
 240                 }
 241         }
 242         if (on_timer && a->position >= 0)
 243                 return;
 244         if (!on_timer && a->position < 0)
 245                 return;
 246
 247         a->position++;
 248         while (a->position < (int)a->servers.size())
 249         {
 250                 Link* x = Utils->FindLink(a->servers[a->position]);
 251                 if (x)
 252                 {
 253                         ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
 254                         ConnectServer(x, a);
 255                         return;
 256                 }
 257                 a->position++;
 258         }
 259         // Autoconnect chain has been fully iterated; start at the beginning on the
 260         // next AutoConnectServers run
 261         a->position = -1;
 262 }
 263
 264 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
 265 {
 266         bool ipvalid = true;
 267
 268         if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name)))
 269         {
 270                 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
 271                 return;
 272         }
 273
 274         QueryType start_type = DNS_QUERY_A;
 275         start_type = DNS_QUERY_AAAA;
 276         if (strchr(x->IPAddr.c_str(),':'))
 277         {
 278                 in6_addr n;
 279                 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
 280                         ipvalid = false;
 281         }
 282         else
 283         {
 284                 in_addr n;
 285                 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
 286                         ipvalid = false;
 287         }
 288
 289         /* Do we already have an IP? If so, no need to resolve it. */
 290         if (ipvalid)
 291         {
 292                 /* Gave a hook, but it wasnt one we know */
 293                 TreeSocket* newsocket = new TreeSocket(Utils, x, y, x->IPAddr);
 294                 if (newsocket->GetFd() > -1)
 295                 {
 296                         /* Handled automatically on success */
 297                 }
 298                 else
 299                 {
 300                         ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
 301                                 x->Name.c_str(), newsocket->getError().c_str());
 302                         ServerInstance->GlobalCulls.AddItem(newsocket);
 303                 }
 304         }
 305         else
 306         {
 307                 try
 308                 {
 309                         bool cached = false;
 310                         ServernameResolver* snr = new ServernameResolver(Utils, x->IPAddr, x, cached, start_type, y);
 311                         ServerInstance->AddResolver(snr, cached);
 312                 }
 313                 catch (ModuleException& e)
 314                 {
 315                         ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
 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                 std::string Version = found->GetVersion();
 364                 user->WriteNumeric(351, "%s :%s",user->nick.c_str(),Version.c_str());
 365                 if (found == Utils->TreeRoot)
 366                 {
 367                         ServerInstance->Config->Send005(user);
 368                 }
 369         }
 370         else
 371         {
 372                 user->WriteNumeric(402, "%s %s :No such server",user->nick.c_str(),parameters[0].c_str());
 373         }
 374         return MOD_RES_DENY;
 375 }
 376
 377 /* This method will attempt to get a message to a remote user.
 378  */
 379 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
 380 {
 381         char text[MAXBUF];
 382         va_list argsPtr;
 383
 384         va_start(argsPtr, format);
 385         vsnprintf(text, MAXBUF, format, argsPtr);
 386         va_end(argsPtr);
 387
 388         if (IS_LOCAL(user))
 389                 user->WriteServ("NOTICE %s :%s", user->nick.c_str(), text);
 390         else
 391                 ServerInstance->PI->SendUserNotice(user, text);
 392 }
 393
 394 ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
 395 {
 396         for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
 397         {
 398                 Link* x = *i;
 399                 if (InspIRCd::Match(x->Name.c_str(),parameters[0]))
 400                 {
 401                         if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name)))
 402                         {
 403                                 RemoteMessage(user, "*** CONNECT: Server \002%s\002 is ME, not connecting.",x->Name.c_str());
 404                                 return MOD_RES_DENY;
 405                         }
 406
 407                         TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
 408                         if (!CheckDupe)
 409                         {
 410                                 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
 411                                 ConnectServer(x);
 412                                 return MOD_RES_DENY;
 413                         }
 414                         else
 415                         {
 416                                 std::string servername = CheckDupe->GetParent()->GetName();
 417                                 RemoteMessage(user, "*** CONNECT: Server \002%s\002 already exists on the network and is connected via \002%s\002", x->Name.c_str(), servername.c_str());
 418                                 return MOD_RES_DENY;
 419                         }
 420                 }
 421         }
 422         RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0].c_str());
 423         return MOD_RES_DENY;
 424 }
 425
 426 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
 427 {
 428         TreeServer* s = Utils->FindServer(servername);
 429         if (s)
 430         {
 431                 description = s->GetDesc();
 432         }
 433 }
 434
 435 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel, time_t expiry)
 436 {
 437         if (IS_LOCAL(source))
 438         {
 439                 parameterlist params;
 440                 params.push_back(dest->uuid);
 441                 params.push_back(channel->name);
 442                 params.push_back(ConvToStr(expiry));
 443                 Utils->DoOneToMany(source->uuid,"INVITE",params);
 444         }
 445 }
 446
 447 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
 448 {
 449         // Drop remote events on the floor.
 450         if (!IS_LOCAL(user))
 451                 return;
 452
 453         parameterlist params;
 454         params.push_back(chan->name);
 455         params.push_back(":"+topic);
 456         Utils->DoOneToMany(user->uuid,"TOPIC",params);
 457 }
 458
 459 void ModuleSpanningTree::OnWallops(User* user, const std::string &text)
 460 {
 461         if (IS_LOCAL(user))
 462         {
 463                 parameterlist params;
 464                 params.push_back(":"+text);
 465                 Utils->DoOneToMany(user->uuid,"WALLOPS",params);
 466         }
 467 }
 468
 469 void ModuleSpanningTree::OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
 470 {
 471         /* Server origin */
 472         if (user == NULL)
 473                 return;
 474
 475         if (target_type == TYPE_USER)
 476         {
 477                 User* d = (User*)dest;
 478                 if (!IS_LOCAL(d) && IS_LOCAL(user))
 479                 {
 480                         parameterlist params;
 481                         params.push_back(d->uuid);
 482                         params.push_back(":"+text);
 483                         Utils->DoOneToOne(user->uuid,"NOTICE",params,d->server);
 484                 }
 485         }
 486         else if (target_type == TYPE_CHANNEL)
 487         {
 488                 if (IS_LOCAL(user))
 489                 {
 490                         Channel *c = (Channel*)dest;
 491                         if (c)
 492                         {
 493                                 std::string cname = c->name;
 494                                 if (status)
 495                                         cname = status + cname;
 496                                 TreeServerList list;
 497                                 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
 498                                 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
 499                                 {
 500                                         TreeSocket* Sock = i->second->GetSocket();
 501                                         if (Sock)
 502                                                 Sock->WriteLine(":"+std::string(user->uuid)+" NOTICE "+cname+" :"+text);
 503                                 }
 504                         }
 505                 }
 506         }
 507         else if (target_type == TYPE_SERVER)
 508         {
 509                 if (IS_LOCAL(user))
 510                 {
 511                         char* target = (char*)dest;
 512                         parameterlist par;
 513                         par.push_back(target);
 514                         par.push_back(":"+text);
 515                         Utils->DoOneToMany(user->uuid,"NOTICE",par);
 516                 }
 517         }
 518 }
 519
 520 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
 521 {
 522         /* Server origin */
 523         if (user == NULL)
 524                 return;
 525
 526         if (target_type == TYPE_USER)
 527         {
 528                 // route private messages which are targetted at clients only to the server
 529                 // which needs to receive them
 530                 User* d = (User*)dest;
 531                 if (!IS_LOCAL(d) && (IS_LOCAL(user)))
 532                 {
 533                         parameterlist params;
 534                         params.push_back(d->uuid);
 535                         params.push_back(":"+text);
 536                         Utils->DoOneToOne(user->uuid,"PRIVMSG",params,d->server);
 537                 }
 538         }
 539         else if (target_type == TYPE_CHANNEL)
 540         {
 541                 if (IS_LOCAL(user))
 542                 {
 543                         Channel *c = (Channel*)dest;
 544                         if (c)
 545                         {
 546                                 std::string cname = c->name;
 547                                 if (status)
 548                                         cname = status + cname;
 549                                 TreeServerList list;
 550                                 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
 551                                 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
 552                                 {
 553                                         TreeSocket* Sock = i->second->GetSocket();
 554                                         if (Sock)
 555                                                 Sock->WriteLine(":"+std::string(user->uuid)+" PRIVMSG "+cname+" :"+text);
 556                                 }
 557                         }
 558                 }
 559         }
 560         else if (target_type == TYPE_SERVER)
 561         {
 562                 if (IS_LOCAL(user))
 563                 {
 564                         char* target = (char*)dest;
 565                         parameterlist par;
 566                         par.push_back(target);
 567                         par.push_back(":"+text);
 568                         Utils->DoOneToMany(user->uuid,"PRIVMSG",par);
 569                 }
 570         }
 571 }
 572
 573 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
 574 {
 575         AutoConnectServers(curtime);
 576         DoPingChecks(curtime);
 577         DoConnectTimeout(curtime);
 578 }
 579
 580 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
 581 {
 582         if (user->quitting)
 583                 return;
 584
 585         parameterlist params;
 586         params.push_back(user->uuid);
 587         params.push_back(ConvToStr(user->age));
 588         params.push_back(user->nick);
 589         params.push_back(user->host);
 590         params.push_back(user->dhost);
 591         params.push_back(user->ident);
 592         params.push_back(user->GetIPString());
 593         params.push_back(ConvToStr(user->signon));
 594         params.push_back("+"+std::string(user->FormatModes(true)));
 595         params.push_back(":"+user->fullname);
 596         Utils->DoOneToMany(ServerInstance->Config->GetSID(), "UID", params);
 597
 598         if (IS_OPER(user))
 599         {
 600                 params.clear();
 601                 params.push_back(user->oper->name);
 602                 Utils->DoOneToMany(user->uuid,"OPERTYPE",params);
 603         }
 604
 605         for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
 606         {
 607                 ExtensionItem* item = i->first;
 608                 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
 609                 if (!value.empty())
 610                         ServerInstance->PI->SendMetaData(user, item->name, value);
 611         }
 612
 613         Utils->TreeRoot->SetUserCount(1); // increment by 1
 614 }
 615
 616 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts)
 617 {
 618         // Only do this for local users
 619         if (IS_LOCAL(memb->user))
 620         {
 621                 parameterlist params;
 622                 // set up their permissions and the channel TS with FJOIN.
 623                 // All users are FJOINed now, because a module may specify
 624                 // new joining permissions for the user.
 625                 params.push_back(memb->chan->name);
 626                 params.push_back(ConvToStr(memb->chan->age));
 627                 params.push_back(std::string("+") + memb->chan->ChanModes(true));
 628                 params.push_back(memb->modes+","+memb->user->uuid);
 629                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"FJOIN",params);
 630         }
 631 }
 632
 633 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
 634 {
 635         if (user->registered != REG_ALL || !IS_LOCAL(user))
 636                 return;
 637
 638         parameterlist params;
 639         params.push_back(newhost);
 640         Utils->DoOneToMany(user->uuid,"FHOST",params);
 641 }
 642
 643 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
 644 {
 645         if (user->registered != REG_ALL || !IS_LOCAL(user))
 646                 return;
 647
 648         parameterlist params;
 649         params.push_back(gecos);
 650         Utils->DoOneToMany(user->uuid,"FNAME",params);
 651 }
 652
 653 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
 654 {
 655         // only occurs for local clients
 656         if (user->registered != REG_ALL)
 657                 return;
 658
 659         parameterlist params;
 660         params.push_back(ident);
 661         Utils->DoOneToMany(user->uuid,"FIDENT",params);
 662 }
 663
 664 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
 665 {
 666         if (IS_LOCAL(memb->user))
 667         {
 668                 parameterlist params;
 669                 params.push_back(memb->chan->name);
 670                 if (!partmessage.empty())
 671                         params.push_back(":"+partmessage);
 672                 Utils->DoOneToMany(memb->user->uuid,"PART",params);
 673         }
 674 }
 675
 676 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 677 {
 678         if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
 679         {
 680                 parameterlist params;
 681
 682                 if (oper_message != reason)
 683                 {
 684                         params.push_back(":"+oper_message);
 685                         Utils->DoOneToMany(user->uuid,"OPERQUIT",params);
 686                 }
 687                 params.clear();
 688                 params.push_back(":"+reason);
 689                 Utils->DoOneToMany(user->uuid,"QUIT",params);
 690         }
 691
 692         // Regardless, We need to modify the user Counts..
 693         TreeServer* SourceServer = Utils->FindServer(user->server);
 694         if (SourceServer)
 695         {
 696                 SourceServer->SetUserCount(-1); // decrement by 1
 697         }
 698 }
 699
 700 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
 701 {
 702         if (IS_LOCAL(user))
 703         {
 704                 parameterlist params;
 705                 params.push_back(user->nick);
 706
 707                 /** IMPORTANT: We don't update the TS if the oldnick is just a case change of the newnick!
 708                  */
 709                 if (irc::string(user->nick.c_str()) != assign(oldnick))
 710                         user->age = ServerInstance->Time();
 711
 712                 params.push_back(ConvToStr(user->age));
 713                 Utils->DoOneToMany(user->uuid,"NICK",params);
 714         }
 715         else if (!loopCall && user->nick == user->uuid)
 716         {
 717                 parameterlist params;
 718                 params.push_back(user->uuid);
 719                 params.push_back(ConvToStr(user->age));
 720                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"SAVE",params);
 721         }
 722 }
 723
 724 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
 725 {
 726         parameterlist params;
 727         params.push_back(memb->chan->name);
 728         params.push_back(memb->user->uuid);
 729         params.push_back(":"+reason);
 730         if (IS_LOCAL(source))
 731         {
 732                 Utils->DoOneToMany(source->uuid,"KICK",params);
 733         }
 734         else if (source == ServerInstance->FakeClient)
 735         {
 736                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"KICK",params);
 737         }
 738 }
 739
 740 void ModuleSpanningTree::OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason)
 741 {
 742         if (!IS_LOCAL(source))
 743                 return; // Only start routing if we're origin.
 744
 745         ServerInstance->OperQuit.set(dest, operreason);
 746         parameterlist params;
 747         params.push_back(":"+operreason);
 748         Utils->DoOneToMany(dest->uuid,"OPERQUIT",params);
 749         params.clear();
 750         params.push_back(dest->uuid);
 751         params.push_back(":"+reason);
 752         Utils->DoOneToMany(source->uuid,"KILL",params);
 753 }
 754
 755 void ModuleSpanningTree::OnPreRehash(User* user, const std::string &parameter)
 756 {
 757         if (loopCall)
 758                 return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
 759
 760         ServerInstance->Logs->Log("remoterehash", DEBUG, "called with param %s", parameter.c_str());
 761
 762         // Send out to other servers
 763         if (!parameter.empty() && parameter[0] != '-')
 764         {
 765                 parameterlist params;
 766                 params.push_back(parameter);
 767                 Utils->DoOneToAllButSender(user ? user->uuid : ServerInstance->Config->GetSID(), "REHASH", params, user ? user->server : ServerInstance->Config->ServerName);
 768         }
 769 }
 770
 771 void ModuleSpanningTree::OnRehash(User* user)
 772 {
 773         // Re-read config stuff
 774         try
 775         {
 776                 Utils->ReadConfiguration();
 777         }
 778         catch (ModuleException& e)
 779         {
 780                 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
 781                 Utils->RefreshIPCache();
 782                 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
 783                 std::string msg = "Error in configuration: ";
 784                 msg.append(e.GetReason());
 785                 ServerInstance->SNO->WriteToSnoMask('l', msg);
 786                 if (!IS_LOCAL(user))
 787                         ServerInstance->PI->SendSNONotice("L", msg);
 788         }
 789 }
 790
 791 void ModuleSpanningTree::OnLoadModule(Module* mod)
 792 {
 793         std::string data;
 794         data.push_back('+');
 795         data.append(mod->ModuleSourceFile);
 796         Version v = mod->GetVersion();
 797         if (!v.link_data.empty())
 798         {
 799                 data.push_back('=');
 800                 data.append(v.link_data);
 801         }
 802         ServerInstance->PI->SendMetaData(NULL, "modules", data);
 803 }
 804
 805 void ModuleSpanningTree::OnUnloadModule(Module* mod)
 806 {
 807         ServerInstance->PI->SendMetaData(NULL, "modules", "-" + mod->ModuleSourceFile);
 808
 809         unsigned int items = Utils->TreeRoot->ChildCount();
 810         for(unsigned int x = 0; x < items; x++)
 811         {
 812                 TreeServer* srv = Utils->TreeRoot->GetChild(x);
 813                 TreeSocket* sock = srv->GetSocket();
 814                 if (sock && sock->GetIOHook() == mod)
 815                 {
 816                         sock->SendError("SSL module unloaded");
 817                         sock->Close();
 818                 }
 819         }
 820 }
 821
 822 // note: the protocol does not allow direct umode +o except
 823 // via NICK with 8 params. sending OPERTYPE infers +o modechange
 824 // locally.
 825 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
 826 {
 827         if (user->registered != REG_ALL || !IS_LOCAL(user))
 828                 return;
 829         parameterlist params;
 830         params.push_back(opertype);
 831         Utils->DoOneToMany(user->uuid,"OPERTYPE",params);
 832 }
 833
 834 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
 835 {
 836         if (!x->IsBurstable() || loopCall)
 837                 return;
 838
 839         parameterlist params;
 840         params.push_back(x->type);
 841         params.push_back(x->Displayable());
 842         params.push_back(ServerInstance->Config->ServerName);
 843         params.push_back(ConvToStr(x->set_time));
 844         params.push_back(ConvToStr(x->duration));
 845         params.push_back(":" + x->reason);
 846
 847         if (!user)
 848         {
 849                 /* Server-set lines */
 850                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "ADDLINE", params);
 851         }
 852         else if (IS_LOCAL(user))
 853         {
 854                 /* User-set lines */
 855                 Utils->DoOneToMany(user->uuid, "ADDLINE", params);
 856         }
 857 }
 858
 859 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
 860 {
 861         if (!x->IsBurstable() || loopCall)
 862                 return;
 863
 864         parameterlist params;
 865         params.push_back(x->type);
 866         params.push_back(x->Displayable());
 867
 868         if (!user)
 869         {
 870                 /* Server-unset lines */
 871                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "DELLINE", params);
 872         }
 873         else if (IS_LOCAL(user))
 874         {
 875                 /* User-unset lines */
 876                 Utils->DoOneToMany(user->uuid, "DELLINE", params);
 877         }
 878 }
 879
 880 void ModuleSpanningTree::OnMode(User* user, void* dest, int target_type, const parameterlist &text, const std::vector<TranslateType> &translate)
 881 {
 882         if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
 883         {
 884                 parameterlist params;
 885                 std::string output_text;
 886
 887                 ServerInstance->Parser->TranslateUIDs(translate, text, output_text);
 888
 889                 if (target_type == TYPE_USER)
 890                 {
 891                         User* u = (User*)dest;
 892                         params.push_back(u->uuid);
 893                         params.push_back(output_text);
 894                         Utils->DoOneToMany(user->uuid, "MODE", params);
 895                 }
 896                 else
 897                 {
 898                         Channel* c = (Channel*)dest;
 899                         params.push_back(c->name);
 900                         params.push_back(ConvToStr(c->age));
 901                         params.push_back(output_text);
 902                         Utils->DoOneToMany(user->uuid, "FMODE", params);
 903                 }
 904         }
 905 }
 906
 907 ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
 908 {
 909         if (IS_LOCAL(user))
 910         {
 911                 parameterlist params;
 912                 if (!awaymsg.empty())
 913                 {
 914                         params.push_back(ConvToStr(user->awaytime));
 915                         params.push_back(":" + awaymsg);
 916                 }
 917                 Utils->DoOneToMany(user->uuid, "AWAY", params);
 918         }
 919
 920         return MOD_RES_PASSTHRU;
 921 }
 922
 923 void ModuleSpanningTree::ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const parameterlist &modeline, const std::vector<TranslateType> &translate)
 924 {
 925         TreeSocket* s = (TreeSocket*)opaque;
 926         std::string output_text;
 927
 928         ServerInstance->Parser->TranslateUIDs(translate, modeline, output_text);
 929
 930         if (target)
 931         {
 932                 if (target_type == TYPE_USER)
 933                 {
 934                         User* u = (User*)target;
 935                         s->WriteLine(":"+ServerInstance->Config->GetSID()+" MODE "+u->uuid+" "+output_text);
 936                 }
 937                 else if (target_type == TYPE_CHANNEL)
 938                 {
 939                         Channel* c = (Channel*)target;
 940                         s->WriteLine(":"+ServerInstance->Config->GetSID()+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+output_text);
 941                 }
 942         }
 943 }
 944
 945 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata)
 946 {
 947         TreeSocket* s = static_cast<TreeSocket*>(opaque);
 948         User* u = dynamic_cast<User*>(target);
 949         Channel* c = dynamic_cast<Channel*>(target);
 950         if (u)
 951                 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA "+u->uuid+" "+extname+" :"+extdata);
 952         else if (c)
 953                 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA "+c->name+" "+extname+" :"+extdata);
 954         else if (!target)
 955                 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA * "+extname+" :"+extdata);
 956 }
 957
 958 CullResult ModuleSpanningTree::cull()
 959 {
 960         Utils->cull();
 961         ServerInstance->Timers->DelTimer(RefreshTimer);
 962         return this->Module::cull();
 963 }
 964
 965 ModuleSpanningTree::~ModuleSpanningTree()
 966 {
 967         delete ServerInstance->PI;
 968         ServerInstance->PI = new ProtocolInterface;
 969
 970         /* This will also free the listeners */
 971         delete Utils;
 972
 973         delete commands;
 974 }
 975
 976 Version ModuleSpanningTree::GetVersion()
 977 {
 978         return Version("Allows servers to be linked", VF_VENDOR);
 979 }
 980
 981 /* It is IMPORTANT that m_spanningtree is the last module in the chain
 982  * so that any activity it sees is FINAL, e.g. we arent going to send out
 983  * a NICK message before m_cloaking has finished putting the +x on the user,
 984  * etc etc.
 985  * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
 986  * the module call queue.
 987  */
 988 void ModuleSpanningTree::Prioritize()
 989 {
 990         ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
 991 }
 992
 993 MODULE_INIT(ModuleSpanningTree)