src/modules/m_spanningtree/main.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 /* $ModDesc: Provides a spanning tree server link protocol */
  15
  16 #include "inspircd.h"
  17 #include "commands/cmd_whois.h"
  18 #include "commands/cmd_stats.h"
  19 #include "socket.h"
  20 #include "wildcard.h"
  21 #include "xline.h"
  22 #include "transport.h"
  23
  24 #include "m_spanningtree/timesynctimer.h"
  25 #include "m_spanningtree/resolvers.h"
  26 #include "m_spanningtree/main.h"
  27 #include "m_spanningtree/utils.h"
  28 #include "m_spanningtree/treeserver.h"
  29 #include "m_spanningtree/link.h"
  30 #include "m_spanningtree/treesocket.h"
  31 #include "m_spanningtree/rconnect.h"
  32 #include "m_spanningtree/rsquit.h"
  33
  34 /* $ModDep: m_spanningtree/timesynctimer.h m_spanningtree/resolvers.h m_spanningtree/main.h m_spanningtree/utils.h m_spanningtree/treeserver.h m_spanningtree/link.h m_spanningtree/treesocket.h m_spanningtree/rconnect.h m_spanningtree/rsquit.h */
  35
  36 ModuleSpanningTree::ModuleSpanningTree(InspIRCd* Me)
  37         : Module(Me), max_local(0), max_global(0)
  38 {
  39         ServerInstance->Modules->UseInterface("BufferedSocketHook");
  40         Utils = new SpanningTreeUtilities(Me, this);
  41         command_rconnect = new cmd_rconnect(ServerInstance, this, Utils);
  42         ServerInstance->AddCommand(command_rconnect);
  43         command_rsquit = new cmd_rsquit(ServerInstance, this, Utils);
  44         ServerInstance->AddCommand(command_rsquit);
  45         if (Utils->EnableTimeSync)
  46         {
  47                 SyncTimer = new TimeSyncTimer(ServerInstance, this);
  48                 ServerInstance->Timers->AddTimer(SyncTimer);
  49         }
  50         else
  51                 SyncTimer = NULL;
  52
  53         RefreshTimer = new CacheRefreshTimer(ServerInstance, Utils);
  54         ServerInstance->Timers->AddTimer(RefreshTimer);
  55
  56         Implementation eventlist[] =
  57         {
  58                 I_OnPreCommand, I_OnGetServerDescription, I_OnUserInvite, I_OnPostLocalTopicChange,
  59                 I_OnWallops, I_OnUserNotice, I_OnUserMessage, I_OnBackgroundTimer,
  60                 I_OnUserJoin, I_OnChangeHost, I_OnChangeName, I_OnUserPart, I_OnPostConnect,
  61                 I_OnUserQuit, I_OnUserPostNick, I_OnUserKick, I_OnRemoteKill, I_OnRehash,
  62                 I_OnOper, I_OnAddLine, I_OnDelLine, I_ProtoSendMode, I_OnMode,
  63                 I_OnStats, I_ProtoSendMetaData, I_OnEvent, I_OnSetAway, I_OnCancelAway, I_OnPostCommand
  64         };
  65         ServerInstance->Modules->Attach(eventlist, this, 29);
  66
  67         for (std::vector<User*>::const_iterator i = ServerInstance->Users->local_users.begin(); i != ServerInstance->Users->local_users.end(); i++)
  68         {
  69                 this->OnPostConnect((*i));
  70         }
  71 }
  72
  73 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
  74 {
  75         std::string Parent = Utils->TreeRoot->GetName();
  76         if (Current->GetParent())
  77         {
  78                 Parent = Current->GetParent()->GetName();
  79         }
  80         for (unsigned int q = 0; q < Current->ChildCount(); q++)
  81         {
  82                 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
  83                 {
  84                         if (*user->oper)
  85                         {
  86                                  ShowLinks(Current->GetChild(q),user,hops+1);
  87                         }
  88                 }
  89                 else
  90                 {
  91                         ShowLinks(Current->GetChild(q),user,hops+1);
  92                 }
  93         }
  94         /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
  95         if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName().c_str())) && (!IS_OPER(user)))
  96                 return;
  97         /* Or if the server is hidden and they're not an oper */
  98         else if ((Current->Hidden) && (!IS_OPER(user)))
  99                 return;
 100
 101         user->WriteServ("364 %s %s %s :%d %s",  user->nick,Current->GetName().c_str(),
 102                         (Utils->FlatLinks && (!IS_OPER(user))) ? ServerInstance->Config->ServerName : Parent.c_str(),
 103                         (Utils->FlatLinks && (!IS_OPER(user))) ? 0 : hops,
 104                         Current->GetDesc().c_str());
 105 }
 106
 107 int ModuleSpanningTree::CountLocalServs()
 108 {
 109         return Utils->TreeRoot->ChildCount();
 110 }
 111
 112 int ModuleSpanningTree::CountServs()
 113 {
 114         return Utils->serverlist.size();
 115 }
 116
 117 void ModuleSpanningTree::HandleLinks(const char** parameters, int pcnt, User* user)
 118 {
 119         ShowLinks(Utils->TreeRoot,user,0);
 120         user->WriteServ("365 %s * :End of /LINKS list.",user->nick);
 121         return;
 122 }
 123
 124 void ModuleSpanningTree::HandleLusers(const char** parameters, int pcnt, User* user)
 125 {
 126         unsigned int n_users = ServerInstance->Users->UserCount();
 127
 128         /* Only update these when someone wants to see them, more efficient */
 129         if ((unsigned int)ServerInstance->Users->LocalUserCount() > max_local)
 130                 max_local = ServerInstance->Users->LocalUserCount();
 131         if (n_users > max_global)
 132                 max_global = n_users;
 133
 134         unsigned int ulined_count = 0;
 135         unsigned int ulined_local_count = 0;
 136
 137         /* If ulined are hidden and we're not an oper, count the number of ulined servers hidden,
 138          * locally and globally (locally means directly connected to us)
 139          */
 140         if ((Utils->HideULines) && (!*user->oper))
 141         {
 142                 for (server_hash::iterator q = Utils->serverlist.begin(); q != Utils->serverlist.end(); q++)
 143                 {
 144                         if (ServerInstance->ULine(q->second->GetName().c_str()))
 145                         {
 146                                 ulined_count++;
 147                                 if (q->second->GetParent() == Utils->TreeRoot)
 148                                         ulined_local_count++;
 149                         }
 150                 }
 151         }
 152         user->WriteServ("251 %s :There are %d users and %d invisible on %d servers",user->nick,
 153                         n_users-ServerInstance->Users->ModeCount('i'),
 154                         ServerInstance->Users->ModeCount('i'),
 155                         ulined_count ? this->CountServs() - ulined_count : this->CountServs());
 156
 157         if (ServerInstance->Users->OperCount())
 158                 user->WriteServ("252 %s %d :operator(s) online",user->nick,ServerInstance->Users->OperCount());
 159
 160         if (ServerInstance->Users->UnregisteredUserCount())
 161                 user->WriteServ("253 %s %d :unknown connections",user->nick,ServerInstance->Users->UnregisteredUserCount());
 162
 163         if (ServerInstance->ChannelCount())
 164                 user->WriteServ("254 %s %d :channels formed",user->nick,ServerInstance->ChannelCount());
 165
 166         user->WriteServ("255 %s :I have %d clients and %d servers",user->nick,ServerInstance->Users->LocalUserCount(),ulined_local_count ? this->CountLocalServs() - ulined_local_count : this->CountLocalServs());
 167         user->WriteServ("265 %s :Current Local Users: %d  Max: %d",user->nick,ServerInstance->Users->LocalUserCount(),max_local);
 168         user->WriteServ("266 %s :Current Global Users: %d  Max: %d",user->nick,n_users,max_global);
 169         return;
 170 }
 171
 172 std::string ModuleSpanningTree::TimeToStr(time_t secs)
 173 {
 174         time_t mins_up = secs / 60;
 175         time_t hours_up = mins_up / 60;
 176         time_t days_up = hours_up / 24;
 177         secs = secs % 60;
 178         mins_up = mins_up % 60;
 179         hours_up = hours_up % 24;
 180         return ((days_up ? (ConvToStr(days_up) + "d") : std::string(""))
 181                         + (hours_up ? (ConvToStr(hours_up) + "h") : std::string(""))
 182                         + (mins_up ? (ConvToStr(mins_up) + "m") : std::string(""))
 183                         + ConvToStr(secs) + "s");
 184 }
 185
 186 void ModuleSpanningTree::DoPingChecks(time_t curtime)
 187 {
 188         for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
 189         {
 190                 TreeServer* serv = Utils->TreeRoot->GetChild(j);
 191                 TreeSocket* sock = serv->GetSocket();
 192                 if (sock)
 193                 {
 194                         if (curtime >= serv->NextPingTime())
 195                         {
 196                                 if (serv->AnsweredLastPing())
 197                                 {
 198                                         sock->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" PING "+serv->GetID());
 199                                         serv->SetNextPingTime(curtime + Utils->PingFreq);
 200                                         timeval t;
 201                                         gettimeofday(&t, NULL);
 202                                         long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
 203                                         serv->LastPingMsec = ts;
 204                                         serv->Warned = false;
 205                                 }
 206                                 else
 207                                 {
 208                                         /* they didnt answer, boot them */
 209                                         sock->SendError("Ping timeout");
 210                                         sock->Squit(serv,"Ping timeout");
 211                                         ServerInstance->SE->DelFd(sock);
 212                                         sock->Close();
 213                                         return;
 214                                 }
 215                         }
 216                         else if ((Utils->PingWarnTime) && (!serv->Warned) && (curtime >= serv->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!serv->AnsweredLastPing()))
 217                         {
 218                                 /* The server hasnt responded, send a warning to opers */
 219                                 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", serv->GetName().c_str(), Utils->PingWarnTime);
 220                                 serv->Warned = true;
 221                         }
 222                 }
 223         }
 224
 225         /* Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
 226          * This prevents lost REMOTECONNECT notices
 227          */
 228         for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
 229                 Utils->SetRemoteBursting(i->second, false);
 230 }
 231
 232 void ModuleSpanningTree::ConnectServer(Link* x)
 233 {
 234         bool ipvalid = true;
 235         QueryType start_type = DNS_QUERY_A;
 236 #ifdef IPV6
 237         start_type = DNS_QUERY_AAAA;
 238         if (strchr(x->IPAddr.c_str(),':'))
 239         {
 240                 in6_addr n;
 241                 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
 242                         ipvalid = false;
 243         }
 244         else
 245 #endif
 246         {
 247                 in_addr n;
 248                 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
 249                         ipvalid = false;
 250         }
 251
 252         /* Do we already have an IP? If so, no need to resolve it. */
 253         if (ipvalid)
 254         {
 255                 /* Gave a hook, but it wasnt one we know */
 256                 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
 257                         return;
 258                 TreeSocket* newsocket = new TreeSocket(Utils, ServerInstance, x->IPAddr,x->Port,false,x->Timeout ? x->Timeout : 10,x->Name.c_str(), x->Bind, x->Hook.empty() ? NULL : Utils->hooks[x->Hook.c_str()]);
 259                 if (newsocket->GetFd() > -1)
 260                 {
 261                         /* Handled automatically on success */
 262                 }
 263                 else
 264                 {
 265                         RemoteMessage(NULL, "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
 266                         if (ServerInstance->SocketCull.find(newsocket) == ServerInstance->SocketCull.end())
 267                                 ServerInstance->SocketCull[newsocket] = newsocket;
 268                         Utils->DoFailOver(x);
 269                 }
 270         }
 271         else
 272         {
 273                 try
 274                 {
 275                         bool cached;
 276                         ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
 277                         ServerInstance->AddResolver(snr, cached);
 278                 }
 279                 catch (ModuleException& e)
 280                 {
 281                         RemoteMessage(NULL, "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
 282                         Utils->DoFailOver(x);
 283                 }
 284         }
 285 }
 286
 287 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
 288 {
 289         for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
 290         {
 291                 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
 292                 {
 293                         x->NextConnectTime = curtime + x->AutoConnect;
 294                         TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
 295                         if (x->FailOver.length())
 296                         {
 297                                 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
 298                                 if (CheckFailOver)
 299                                 {
 300                                         /* The failover for this server is currently a member of the network.
 301                                          * The failover probably succeeded, where the main link did not.
 302                                          * Don't try the main link until the failover is gone again.
 303                                          */
 304                                         continue;
 305                                 }
 306                         }
 307                         if (!CheckDupe)
 308                         {
 309                                 // an autoconnected server is not connected. Check if its time to connect it
 310                                 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
 311                                 this->ConnectServer(&(*x));
 312                         }
 313                 }
 314         }
 315 }
 316
 317 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, User* user)
 318 {
 319         // we've already checked if pcnt > 0, so this is safe
 320         TreeServer* found = Utils->FindServerMask(parameters[0]);
 321         if (found)
 322         {
 323                 std::string Version = found->GetVersion();
 324                 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
 325                 if (found == Utils->TreeRoot)
 326                 {
 327                         ServerInstance->Config->Send005(user);
 328                 }
 329         }
 330         else
 331         {
 332                 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
 333         }
 334         return 1;
 335 }
 336
 337 /* This method will attempt to get a link message out to as many people as is required.
 338  * If a user is provided, and that user is local, then the user is sent the message using
 339  * WriteServ (they are the local initiator of that message). If the user is remote, they are
 340  * sent that message remotely via PUSH.
 341  * If the user is NULL, then the notice is sent locally via WriteToSnoMask with snomask 'l',
 342  * and remotely via SNONOTICE with mask 'l'.
 343  */
 344 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
 345 {
 346         /* This could cause an infinite loop, because DoOneToMany() will, on error,
 347          * call TreeSocket::OnError(), which in turn will call this function to
 348          * notify everyone of the error. So, drop any messages that are generated
 349          * during the sending of another message. -Special */
 350         static bool SendingRemoteMessage = false;
 351         if (SendingRemoteMessage)
 352                 return;
 353         SendingRemoteMessage = true;
 354
 355         std::deque<std::string> params;
 356         char text[MAXBUF];
 357         va_list argsPtr;
 358
 359         va_start(argsPtr, format);
 360         vsnprintf(text, MAXBUF, format, argsPtr);
 361         va_end(argsPtr);
 362
 363         if (!user)
 364         {
 365                 /* No user, target it generically at everyone */
 366                 ServerInstance->SNO->WriteToSnoMask('l', "%s", text);
 367                 params.push_back("l");
 368                 params.push_back(std::string(":") + text);
 369                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "SNONOTICE", params);
 370         }
 371         else
 372         {
 373                 if (IS_LOCAL(user))
 374                         user->WriteServ("NOTICE %s :%s", user->nick, text);
 375                 else
 376                 {
 377                         params.push_back(user->uuid);
 378                         params.push_back(std::string("::") + ServerInstance->Config->ServerName + " NOTICE " + user->nick + " :*** From " +
 379                                         ServerInstance->Config->ServerName+ ": " + text);
 380                         Utils->DoOneToMany(ServerInstance->Config->GetSID(), "PUSH", params);
 381                 }
 382         }
 383
 384         SendingRemoteMessage = false;
 385 }
 386
 387 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, User* user)
 388 {
 389         for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
 390         {
 391                 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
 392                 {
 393                         TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
 394                         if (!CheckDupe)
 395                         {
 396                                 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
 397                                 ConnectServer(&(*x));
 398                                 return 1;
 399                         }
 400                         else
 401                         {
 402                                 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());
 403                                 return 1;
 404                         }
 405                 }
 406         }
 407         RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0]);
 408         return 1;
 409 }
 410
 411 void ModuleSpanningTree::BroadcastTimeSync()
 412 {
 413         if (Utils->MasterTime)
 414         {
 415                 std::deque<std::string> params;
 416                 params.push_back(ConvToStr(ServerInstance->Time(false)));
 417                 params.push_back("FORCE");
 418                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "TIMESET", params);
 419         }
 420 }
 421
 422 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
 423 {
 424         TreeServer* s = Utils->FindServer(servername);
 425         if (s)
 426         {
 427                 description = s->GetDesc();
 428         }
 429 }
 430
 431 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel)
 432 {
 433         if (IS_LOCAL(source))
 434         {
 435                 std::deque<std::string> params;
 436                 params.push_back(dest->uuid);
 437                 params.push_back(channel->name);
 438                 Utils->DoOneToMany(source->uuid,"INVITE",params);
 439         }
 440 }
 441
 442 void ModuleSpanningTree::OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic)
 443 {
 444         std::deque<std::string> params;
 445         params.push_back(chan->name);
 446         params.push_back(":"+topic);
 447         Utils->DoOneToMany(user->uuid,"TOPIC",params);
 448 }
 449
 450 void ModuleSpanningTree::OnWallops(User* user, const std::string &text)
 451 {
 452         if (IS_LOCAL(user))
 453         {
 454                 std::deque<std::string> params;
 455                 params.push_back(":"+text);
 456                 Utils->DoOneToMany(user->uuid,"WALLOPS",params);
 457         }
 458 }
 459
 460 void ModuleSpanningTree::OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
 461 {
 462         if (target_type == TYPE_USER)
 463         {
 464                 User* d = (User*)dest;
 465                 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
 466                 {
 467                         std::deque<std::string> params;
 468                         params.clear();
 469                         params.push_back(d->uuid);
 470                         params.push_back(":"+text);
 471                         Utils->DoOneToOne(user->uuid,"NOTICE",params,d->server);
 472                 }
 473         }
 474         else if (target_type == TYPE_CHANNEL)
 475         {
 476                 if (IS_LOCAL(user))
 477                 {
 478                         Channel *c = (Channel*)dest;
 479                         if (c)
 480                         {
 481                                 std::string cname = c->name;
 482                                 if (status)
 483                                         cname = status + cname;
 484                                 TreeServerList list;
 485                                 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
 486                                 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
 487                                 {
 488                                         TreeSocket* Sock = i->second->GetSocket();
 489                                         if (Sock)
 490                                                 Sock->WriteLine(":"+std::string(user->uuid)+" NOTICE "+cname+" :"+text);
 491                                 }
 492                         }
 493                 }
 494         }
 495         else if (target_type == TYPE_SERVER)
 496         {
 497                 if (IS_LOCAL(user))
 498                 {
 499                         char* target = (char*)dest;
 500                         std::deque<std::string> par;
 501                         par.push_back(target);
 502                         par.push_back(":"+text);
 503                         Utils->DoOneToMany(user->uuid,"NOTICE",par);
 504                 }
 505         }
 506 }
 507
 508 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
 509 {
 510         if (target_type == TYPE_USER)
 511         {
 512                 // route private messages which are targetted at clients only to the server
 513                 // which needs to receive them
 514                 User* d = (User*)dest;
 515                 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
 516                 {
 517                         std::deque<std::string> params;
 518                         params.clear();
 519                         params.push_back(d->uuid);
 520                         params.push_back(":"+text);
 521                         Utils->DoOneToOne(user->uuid,"PRIVMSG",params,d->server);
 522                 }
 523         }
 524         else if (target_type == TYPE_CHANNEL)
 525         {
 526                 if (IS_LOCAL(user))
 527                 {
 528                         Channel *c = (Channel*)dest;
 529                         if (c)
 530                         {
 531                                 std::string cname = c->name;
 532                                 if (status)
 533                                         cname = status + cname;
 534                                 TreeServerList list;
 535                                 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
 536                                 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
 537                                 {
 538                                         TreeSocket* Sock = i->second->GetSocket();
 539                                         if (Sock)
 540                                                 Sock->WriteLine(":"+std::string(user->uuid)+" PRIVMSG "+cname+" :"+text);
 541                                 }
 542                         }
 543                 }
 544         }
 545         else if (target_type == TYPE_SERVER)
 546         {
 547                 if (IS_LOCAL(user))
 548                 {
 549                         char* target = (char*)dest;
 550                         std::deque<std::string> par;
 551                         par.push_back(target);
 552                         par.push_back(":"+text);
 553                         Utils->DoOneToMany(user->uuid,"PRIVMSG",par);
 554                 }
 555         }
 556 }
 557
 558 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
 559 {
 560         AutoConnectServers(curtime);
 561         DoPingChecks(curtime);
 562 }
 563
 564 void ModuleSpanningTree::OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
 565 {
 566         // Only do this for local users
 567         if (IS_LOCAL(user))
 568         {
 569                 if (channel->GetUserCounter() == 1)
 570                 {
 571                         std::deque<std::string> params;
 572                         // set up their permissions and the channel TS with FJOIN.
 573                         // All users are FJOINed now, because a module may specify
 574                         // new joining permissions for the user.
 575                         params.push_back(channel->name);
 576                         params.push_back(ConvToStr(channel->age));
 577                         params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->uuid));
 578                         Utils->DoOneToMany(ServerInstance->Config->GetSID(),"FJOIN",params);
 579                         /* First user in, sync the modes for the channel */
 580                         params.pop_back();
 581                         params.push_back(std::string("+") + channel->ChanModes(true));
 582                         Utils->DoOneToMany(ServerInstance->Config->GetSID(),"FMODE",params);
 583                 }
 584                 else
 585                 {
 586                         std::deque<std::string> params;
 587                         params.push_back(channel->name);
 588                         params.push_back(ConvToStr(channel->age));
 589                         Utils->DoOneToMany(user->uuid,"JOIN",params);
 590                 }
 591         }
 592 }
 593
 594 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
 595 {
 596         // only occurs for local clients
 597         if (user->registered != REG_ALL)
 598                 return;
 599         std::deque<std::string> params;
 600         params.push_back(newhost);
 601         Utils->DoOneToMany(user->uuid,"FHOST",params);
 602 }
 603
 604 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
 605 {
 606         // only occurs for local clients
 607         if (user->registered != REG_ALL)
 608                 return;
 609         std::deque<std::string> params;
 610         params.push_back(gecos);
 611         Utils->DoOneToMany(user->uuid,"FNAME",params);
 612 }
 613
 614 void ModuleSpanningTree::OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent)
 615 {
 616         if (IS_LOCAL(user))
 617         {
 618                 std::deque<std::string> params;
 619                 params.push_back(channel->name);
 620                 if (!partmessage.empty())
 621                         params.push_back(":"+partmessage);
 622                 Utils->DoOneToMany(user->uuid,"PART",params);
 623         }
 624 }
 625
 626 void ModuleSpanningTree::OnPostConnect(User* user)
 627 {
 628         if (IS_LOCAL(user))
 629         {
 630                 std::deque<std::string> params;
 631                 params.push_back(user->uuid);
 632                 params.push_back(ConvToStr(user->age));
 633                 params.push_back(user->nick);
 634                 params.push_back(user->host);
 635                 params.push_back(user->dhost);
 636                 params.push_back(user->ident);
 637                 params.push_back("+"+std::string(user->FormatModes()));
 638                 params.push_back(user->GetIPString());
 639                 params.push_back(ConvToStr(user->signon));
 640                 params.push_back(":"+std::string(user->fullname));
 641                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "UID", params);
 642         }
 643
 644         TreeServer* SourceServer = Utils->FindServer(user->server);
 645         if (SourceServer)
 646         {
 647                 SourceServer->SetUserCount(1); // increment by 1
 648         }
 649 }
 650
 651 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 652 {
 653         if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
 654         {
 655                 std::deque<std::string> params;
 656
 657                 if (oper_message != reason)
 658                 {
 659                         params.push_back(":"+oper_message);
 660                         Utils->DoOneToMany(user->uuid,"OPERQUIT",params);
 661                 }
 662                 params.clear();
 663                 params.push_back(":"+reason);
 664                 Utils->DoOneToMany(user->uuid,"QUIT",params);
 665         }
 666
 667         // Regardless, We need to modify the user Counts..
 668         TreeServer* SourceServer = Utils->FindServer(user->server);
 669         if (SourceServer)
 670         {
 671                 SourceServer->SetUserCount(-1); // decrement by 1
 672         }
 673 }
 674
 675 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
 676 {
 677         if (IS_LOCAL(user))
 678         {
 679                 std::deque<std::string> params;
 680                 params.push_back(user->nick);
 681
 682                 /** IMPORTANT: We don't update the TS if the oldnick is just a case change of the newnick!
 683                  */
 684                 if (irc::string(user->nick) != assign(oldnick))
 685                         user->age = ServerInstance->Time(true);
 686
 687                 params.push_back(ConvToStr(user->age));
 688                 Utils->DoOneToMany(user->uuid,"NICK",params);
 689         }
 690 }
 691
 692 void ModuleSpanningTree::OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
 693 {
 694         if ((source) && (IS_LOCAL(source)))
 695         {
 696                 std::deque<std::string> params;
 697                 params.push_back(chan->name);
 698                 params.push_back(user->uuid);
 699                 params.push_back(":"+reason);
 700                 Utils->DoOneToMany(source->uuid,"KICK",params);
 701         }
 702         else if (!source)
 703         {
 704                 std::deque<std::string> params;
 705                 params.push_back(chan->name);
 706                 params.push_back(user->uuid);
 707                 params.push_back(":"+reason);
 708                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"KICK",params);
 709         }
 710 }
 711
 712 void ModuleSpanningTree::OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason)
 713 {
 714         std::deque<std::string> params;
 715         params.push_back(":"+reason);
 716         Utils->DoOneToMany(dest->uuid,"OPERQUIT",params);
 717         params.clear();
 718         params.push_back(dest->uuid);
 719         params.push_back(":"+reason);
 720         dest->SetOperQuit(operreason);
 721         Utils->DoOneToMany(source->uuid,"KILL",params);
 722 }
 723
 724 void ModuleSpanningTree::OnRehash(User* user, const std::string &parameter)
 725 {
 726         if (!parameter.empty())
 727         {
 728                 std::deque<std::string> params;
 729                 params.push_back(parameter);
 730                 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->GetSID(), "REHASH", params);
 731                 // check for self
 732                 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
 733                 {
 734                         ServerInstance->SNO->WriteToSnoMask('A', "Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
 735                         ServerInstance->RehashServer();
 736                 }
 737         }
 738         Utils->ReadConfiguration(true);
 739         InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
 740 }
 741
 742 // note: the protocol does not allow direct umode +o except
 743 // via NICK with 8 params. sending OPERTYPE infers +o modechange
 744 // locally.
 745 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
 746 {
 747         if (IS_LOCAL(user))
 748         {
 749                 std::deque<std::string> params;
 750                 params.push_back(opertype);
 751                 Utils->DoOneToMany(user->uuid,"OPERTYPE",params);
 752         }
 753 }
 754
 755 void ModuleSpanningTree::OnAddLine(XLine* line, User* user)
 756 {
 757         if (line->type == "K")
 758                 return;
 759
 760         char data[MAXBUF];
 761         snprintf(data,MAXBUF,"%s %s %s %lu %lu :%s", line->type.c_str(), line->Displayable(), ServerInstance->Config->ServerName, line->set_time,
 762                         line->duration, line->reason);
 763         std::deque<std::string> params;
 764         params.push_back(data);
 765
 766         if (!user)
 767         {
 768                 /* Server-set lines */
 769                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "ADDLINE", params);
 770         }
 771         else if (IS_LOCAL(user))
 772         {
 773                 /* User-set lines */
 774                 Utils->DoOneToMany(user->uuid, "ADDLINE", params);
 775         }
 776 }
 777
 778 void ModuleSpanningTree::OnDelLine(XLine* line, User* user)
 779 {
 780         if (line->type == "K")
 781                 return;
 782
 783         char data[MAXBUF];
 784         snprintf(data,MAXBUF,"%s %s", line->type.c_str(), line->Displayable());
 785         std::deque<std::string> params;
 786         params.push_back(data);
 787
 788         if (!user)
 789         {
 790                 /* Server-unset lines */
 791                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "DELLINE", params);
 792         }
 793         else if (IS_LOCAL(user))
 794         {
 795                 /* User-unset lines */
 796                 Utils->DoOneToMany(user->uuid, "DELLINE", params);
 797         }
 798 }
 799
 800 void ModuleSpanningTree::OnMode(User* user, void* dest, int target_type, const std::string &text)
 801 {
 802         if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
 803         {
 804                 std::deque<std::string> params;
 805                 std::string command;
 806                 std::string output_text;
 807
 808                 ServerInstance->Parser->TranslateUIDs(TR_SPACENICKLIST, text, output_text);
 809
 810                 if (target_type == TYPE_USER)
 811                 {
 812                         User* u = (User*)dest;
 813                         params.push_back(u->uuid);
 814                         params.push_back(output_text);
 815                         command = "MODE";
 816                 }
 817                 else
 818                 {
 819                         Channel* c = (Channel*)dest;
 820                         params.push_back(c->name);
 821                         params.push_back(ConvToStr(c->age));
 822                         params.push_back(output_text);
 823                         command = "FMODE";
 824                 }
 825
 826                 Utils->DoOneToMany(user->uuid, command, params);
 827         }
 828 }
 829
 830 void ModuleSpanningTree::OnSetAway(User* user)
 831 {
 832         if (IS_LOCAL(user))
 833         {
 834                 std::deque<std::string> params;
 835                 params.push_back(":"+std::string(user->awaymsg));
 836                 Utils->DoOneToMany(user->uuid,"AWAY",params);
 837         }
 838 }
 839
 840 void ModuleSpanningTree::OnCancelAway(User* user)
 841 {
 842         if (IS_LOCAL(user))
 843         {
 844                 std::deque<std::string> params;
 845                 params.clear();
 846                 Utils->DoOneToMany(user->uuid,"AWAY",params);
 847         }
 848 }
 849
 850 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
 851 {
 852         TreeSocket* s = (TreeSocket*)opaque;
 853         std::string output_text;
 854
 855         ServerInstance->Parser->TranslateUIDs(TR_SPACENICKLIST, modeline, output_text);
 856
 857         if (target)
 858         {
 859                 if (target_type == TYPE_USER)
 860                 {
 861                         User* u = (User*)target;
 862                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" FMODE "+u->uuid+" "+ConvToStr(u->age)+" "+output_text);
 863                 }
 864                 else
 865                 {
 866                         Channel* c = (Channel*)target;
 867                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+output_text);
 868                 }
 869         }
 870 }
 871
 872 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
 873 {
 874         TreeSocket* s = (TreeSocket*)opaque;
 875         if (target)
 876         {
 877                 if (target_type == TYPE_USER)
 878                 {
 879                         User* u = (User*)target;
 880                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA "+u->uuid+" "+extname+" :"+extdata);
 881                 }
 882                 else if (target_type == TYPE_CHANNEL)
 883                 {
 884                         Channel* c = (Channel*)target;
 885                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA "+c->name+" "+extname+" :"+extdata);
 886                 }
 887         }
 888         if (target_type == TYPE_OTHER)
 889         {
 890                 s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA * "+extname+" :"+extdata);
 891         }
 892 }
 893
 894 void ModuleSpanningTree::OnEvent(Event* event)
 895 {
 896         std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
 897         if (event->GetEventID() == "send_metadata")
 898         {
 899                 if (params->size() < 3)
 900                         return;
 901                 (*params)[2] = ":" + (*params)[2];
 902                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"METADATA",*params);
 903         }
 904         else if (event->GetEventID() == "send_topic")
 905         {
 906                 if (params->size() < 2)
 907                         return;
 908                 (*params)[1] = ":" + (*params)[1];
 909                 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
 910                 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
 911                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"FTOPIC",*params);
 912         }
 913         else if (event->GetEventID() == "send_mode")
 914         {
 915                 if (params->size() < 2)
 916                         return;
 917                 // Insert the TS value of the object, either User or Channel
 918                 time_t ourTS = 0;
 919                 std::string output_text;
 920
 921                 /* Warning: in-place translation is only safe for type TR_NICK */
 922                 for (size_t n = 0; n < params->size(); n++)
 923                         ServerInstance->Parser->TranslateUIDs(TR_NICK, (*params)[n], (*params)[n]);
 924
 925                 User* a = ServerInstance->FindNick((*params)[0]);
 926                 if (a)
 927                 {
 928                         ourTS = a->age;
 929                         Utils->DoOneToMany(ServerInstance->Config->GetSID(),"MODE",*params);
 930                         return;
 931                 }
 932                 else
 933                 {
 934                         Channel* a = ServerInstance->FindChan((*params)[0]);
 935                         if (a)
 936                         {
 937                                 ourTS = a->age;
 938                                 params->insert(params->begin() + 1,ConvToStr(ourTS));
 939                                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"FMODE",*params);
 940                         }
 941                 }
 942         }
 943         else if (event->GetEventID() == "send_mode_explicit")
 944         {
 945                 if (params->size() < 2)
 946                         return;
 947                 std::string output_text;
 948
 949                 /* Warning: in-place translation is only safe for type TR_NICK */
 950                 for (size_t n = 0; n < params->size(); n++)
 951                         ServerInstance->Parser->TranslateUIDs(TR_NICK, (*params)[n], (*params)[n]);
 952
 953                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"MODE",*params);
 954         }
 955         else if (event->GetEventID() == "send_opers")
 956         {
 957                 if (params->size() < 1)
 958                         return;
 959                 (*params)[0] = ":" + (*params)[0];
 960                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"OPERNOTICE",*params);
 961         }
 962         else if (event->GetEventID() == "send_modeset")
 963         {
 964                 if (params->size() < 2)
 965                         return;
 966                 (*params)[1] = ":" + (*params)[1];
 967                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"MODENOTICE",*params);
 968         }
 969         else if (event->GetEventID() == "send_snoset")
 970         {
 971                 if (params->size() < 2)
 972                         return;
 973                 (*params)[1] = ":" + (*params)[1];
 974                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"SNONOTICE",*params);
 975         }
 976         else if (event->GetEventID() == "send_push")
 977         {
 978                 if (params->size() < 2)
 979                         return;
 980
 981                 User *a = ServerInstance->FindNick((*params)[0]);
 982
 983                 if (!a)
 984                         return;
 985
 986                 (*params)[0] = a->uuid;
 987                 (*params)[1] = ":" + (*params)[1];
 988                 Utils->DoOneToOne(ServerInstance->Config->GetSID(), "PUSH", *params, a->server);
 989         }
 990 }
 991
 992 ModuleSpanningTree::~ModuleSpanningTree()
 993 {
 994         /* This will also free the listeners */
 995         delete Utils;
 996         if (SyncTimer)
 997                 ServerInstance->Timers->DelTimer(SyncTimer);
 998
 999         ServerInstance->Timers->DelTimer(RefreshTimer);
1000
1001         ServerInstance->Modules->DoneWithInterface("BufferedSocketHook");
1002 }
1003
1004 Version ModuleSpanningTree::GetVersion()
1005 {
1006         return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1007 }
1008
1009 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1010  * so that any activity it sees is FINAL, e.g. we arent going to send out
1011  * a NICK message before m_cloaking has finished putting the +x on the user,
1012  * etc etc.
1013  * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1014  * the module call queue.
1015  */
1016 void ModuleSpanningTree::Prioritize()
1017 {
1018         ServerInstance->Modules->SetPriority(this, PRIO_LAST);
1019 }
1020
1021 MODULE_INIT(ModuleSpanningTree)