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