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 std::vector<std::string>& parameters, 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 std::vector<std::string>& parameters, 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         /*
 185          * Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
 186          * This prevents lost REMOTECONNECT notices
 187          */
 188         timeval t;
 189         gettimeofday(&t, NULL);
 190         long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
 191
 192         for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
 193         {
 194                 TreeServer *s = i->second;
 195
 196                 if (s->bursting)
 197                 {
 198                         unsigned long bursttime = ts - s->StartBurst;
 199                         if (bursttime > 60000) // A minute
 200                         {
 201                                 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not finished burst, forcing end of burst.", s->GetName().c_str());
 202                                 s->FinishBurst();
 203                         }
 204                 }
 205
 206                 // Now do PING checks on all servers
 207                 TreeServer *mts = Utils->BestRouteTo(s->GetID());
 208
 209                 if (mts)
 210                 {
 211                         // Only ping if this server needs one
 212                         if (curtime >= s->NextPingTime())
 213                         {
 214                                 // And if they answered the last
 215                                 if (s->AnsweredLastPing())
 216                                 {
 217                                         // They did, send a ping to them
 218                                         s->SetNextPingTime(curtime + Utils->PingFreq);
 219                                         TreeSocket *tsock = mts->GetSocket();
 220
 221                                         // ... if we can find a proper route to them
 222                                         if (tsock)
 223                                         {
 224                                                 tsock->WriteLine(std::string(":") + ServerInstance->Config->GetSID() + " PING " +
 225                                                                 ServerInstance->Config->GetSID() + " " + s->GetID());
 226                                                 s->LastPingMsec = ts;
 227                                         }
 228                                 }
 229                                 else
 230                                 {
 231                                         // They didn't answer the last ping, if they are locally connected, get rid of them.
 232                                         TreeSocket *sock = s->GetSocket();
 233                                         if (sock)
 234                                         {
 235                                                 sock->SendError("Ping timeout");
 236                                                 sock->Squit(s,"Ping timeout");
 237                                                 ServerInstance->SE->DelFd(sock);
 238                                                 sock->Close();
 239                                                 return;
 240                                         }
 241                                 }
 242                         }
 243
 244                         // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
 245                         if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
 246                         {
 247                                 /* The server hasnt responded, send a warning to opers */
 248                                 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", s->GetName().c_str(), Utils->PingWarnTime);
 249                                 s->Warned = true;
 250                         }
 251                 }
 252         }
 253 }
 254
 255 void ModuleSpanningTree::ConnectServer(Link* x)
 256 {
 257         bool ipvalid = true;
 258         QueryType start_type = DNS_QUERY_A;
 259 #ifdef IPV6
 260         start_type = DNS_QUERY_AAAA;
 261         if (strchr(x->IPAddr.c_str(),':'))
 262         {
 263                 in6_addr n;
 264                 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
 265                         ipvalid = false;
 266         }
 267         else
 268 #endif
 269         {
 270                 in_addr n;
 271                 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
 272                         ipvalid = false;
 273         }
 274
 275         /* Do we already have an IP? If so, no need to resolve it. */
 276         if (ipvalid)
 277         {
 278                 /* Gave a hook, but it wasnt one we know */
 279                 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
 280                         return;
 281                 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()]);
 282                 if (newsocket->GetFd() > -1)
 283                 {
 284                         /* Handled automatically on success */
 285                 }
 286                 else
 287                 {
 288                         RemoteMessage(NULL, "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
 289                         if (ServerInstance->SocketCull.find(newsocket) == ServerInstance->SocketCull.end())
 290                                 ServerInstance->SocketCull[newsocket] = newsocket;
 291                         Utils->DoFailOver(x);
 292                 }
 293         }
 294         else
 295         {
 296                 try
 297                 {
 298                         bool cached;
 299                         ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
 300                         ServerInstance->AddResolver(snr, cached);
 301                 }
 302                 catch (ModuleException& e)
 303                 {
 304                         RemoteMessage(NULL, "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
 305                         Utils->DoFailOver(x);
 306                 }
 307         }
 308 }
 309
 310 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
 311 {
 312         for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
 313         {
 314                 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
 315                 {
 316                         x->NextConnectTime = curtime + x->AutoConnect;
 317                         TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
 318                         if (x->FailOver.length())
 319                         {
 320                                 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
 321                                 if (CheckFailOver)
 322                                 {
 323                                         /* The failover for this server is currently a member of the network.
 324                                          * The failover probably succeeded, where the main link did not.
 325                                          * Don't try the main link until the failover is gone again.
 326                                          */
 327                                         continue;
 328                                 }
 329                         }
 330                         if (!CheckDupe)
 331                         {
 332                                 // an autoconnected server is not connected. Check if its time to connect it
 333                                 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
 334                                 this->ConnectServer(&(*x));
 335                         }
 336                 }
 337         }
 338 }
 339
 340 int ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
 341 {
 342         // we've already checked if pcnt > 0, so this is safe
 343         TreeServer* found = Utils->FindServerMask(parameters[0]);
 344         if (found)
 345         {
 346                 std::string Version = found->GetVersion();
 347                 user->WriteNumeric(351, "%s :%s",user->nick,Version.c_str());
 348                 if (found == Utils->TreeRoot)
 349                 {
 350                         ServerInstance->Config->Send005(user);
 351                 }
 352         }
 353         else
 354         {
 355                 user->WriteNumeric(402, "%s %s :No such server",user->nick,parameters[0].c_str());
 356         }
 357         return 1;
 358 }
 359
 360 /* This method will attempt to get a link message out to as many people as is required.
 361  * If a user is provided, and that user is local, then the user is sent the message using
 362  * WriteServ (they are the local initiator of that message). If the user is remote, they are
 363  * sent that message remotely via PUSH.
 364  * If the user is NULL, then the notice is sent locally via WriteToSnoMask with snomask 'l',
 365  * and remotely via SNONOTICE with mask 'l'.
 366  */
 367 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
 368 {
 369         /* This could cause an infinite loop, because DoOneToMany() will, on error,
 370          * call TreeSocket::OnError(), which in turn will call this function to
 371          * notify everyone of the error. So, drop any messages that are generated
 372          * during the sending of another message. -Special */
 373         static bool SendingRemoteMessage = false;
 374         if (SendingRemoteMessage)
 375                 return;
 376         SendingRemoteMessage = true;
 377
 378         char text[MAXBUF];
 379         va_list argsPtr;
 380
 381         va_start(argsPtr, format);
 382         vsnprintf(text, MAXBUF, format, argsPtr);
 383         va_end(argsPtr);
 384
 385         if (!user)
 386         {
 387                 /* No user, target it generically at everyone */
 388                 ServerInstance->SNO->WriteToSnoMask('l', "%s", text);
 389         }
 390         else
 391         {
 392                 if (IS_LOCAL(user))
 393                         user->WriteServ("NOTICE %s :%s", user->nick, text);
 394                 else
 395                         ServerInstance->PI->SendUserNotice(user, text);
 396         }
 397
 398         SendingRemoteMessage = false;
 399 }
 400
 401 int ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
 402 {
 403         for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
 404         {
 405                 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
 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 1;
 413                         }
 414                         else
 415                         {
 416                                 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());
 417                                 return 1;
 418                         }
 419                 }
 420         }
 421         RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0].c_str());
 422         return 1;
 423 }
 424
 425 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
 426 {
 427         TreeServer* s = Utils->FindServer(servername);
 428         if (s)
 429         {
 430                 description = s->GetDesc();
 431         }
 432 }
 433
 434 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel, time_t expiry)
 435 {
 436         if (IS_LOCAL(source))
 437         {
 438                 std::deque<std::string> params;
 439                 params.push_back(dest->uuid);
 440                 params.push_back(channel->name);
 441                 params.push_back(ConvToStr(expiry));
 442                 Utils->DoOneToMany(source->uuid,"INVITE",params);
 443         }
 444 }
 445
 446 void ModuleSpanningTree::OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic)
 447 {
 448         std::deque<std::string> params;
 449         params.push_back(chan->name);
 450         params.push_back(":"+topic);
 451         Utils->DoOneToMany(user->uuid,"TOPIC",params);
 452 }
 453
 454 void ModuleSpanningTree::OnWallops(User* user, const std::string &text)
 455 {
 456         if (IS_LOCAL(user))
 457         {
 458                 std::deque<std::string> params;
 459                 params.push_back(":"+text);
 460                 Utils->DoOneToMany(user->uuid,"WALLOPS",params);
 461         }
 462 }
 463
 464 void ModuleSpanningTree::OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
 465 {
 466         /* Server origin */
 467         if (user == NULL)
 468                 return;
 469
 470         if (target_type == TYPE_USER)
 471         {
 472                 User* d = (User*)dest;
 473                 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
 474                 {
 475                         std::deque<std::string> params;
 476                         params.clear();
 477                         params.push_back(d->uuid);
 478                         params.push_back(":"+text);
 479                         Utils->DoOneToOne(user->uuid,"NOTICE",params,d->server);
 480                 }
 481         }
 482         else if (target_type == TYPE_CHANNEL)
 483         {
 484                 if (IS_LOCAL(user))
 485                 {
 486                         Channel *c = (Channel*)dest;
 487                         if (c)
 488                         {
 489                                 std::string cname = c->name;
 490                                 if (status)
 491                                         cname = status + cname;
 492                                 TreeServerList list;
 493                                 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
 494                                 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
 495                                 {
 496                                         TreeSocket* Sock = i->second->GetSocket();
 497                                         if (Sock)
 498                                                 Sock->WriteLine(":"+std::string(user->uuid)+" NOTICE "+cname+" :"+text);
 499                                 }
 500                         }
 501                 }
 502         }
 503         else if (target_type == TYPE_SERVER)
 504         {
 505                 if (IS_LOCAL(user))
 506                 {
 507                         char* target = (char*)dest;
 508                         std::deque<std::string> par;
 509                         par.push_back(target);
 510                         par.push_back(":"+text);
 511                         Utils->DoOneToMany(user->uuid,"NOTICE",par);
 512                 }
 513         }
 514 }
 515
 516 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
 517 {
 518         /* Server origin */
 519         if (user == NULL)
 520                 return;
 521
 522         if (target_type == TYPE_USER)
 523         {
 524                 // route private messages which are targetted at clients only to the server
 525                 // which needs to receive them
 526                 User* d = (User*)dest;
 527                 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
 528                 {
 529                         std::deque<std::string> params;
 530                         params.clear();
 531                         params.push_back(d->uuid);
 532                         params.push_back(":"+text);
 533                         Utils->DoOneToOne(user->uuid,"PRIVMSG",params,d->server);
 534                 }
 535         }
 536         else if (target_type == TYPE_CHANNEL)
 537         {
 538                 if (IS_LOCAL(user))
 539                 {
 540                         Channel *c = (Channel*)dest;
 541                         if (c)
 542                         {
 543                                 std::string cname = c->name;
 544                                 if (status)
 545                                         cname = status + cname;
 546                                 TreeServerList list;
 547                                 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
 548                                 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
 549                                 {
 550                                         TreeSocket* Sock = i->second->GetSocket();
 551                                         if (Sock)
 552                                                 Sock->WriteLine(":"+std::string(user->uuid)+" PRIVMSG "+cname+" :"+text);
 553                                 }
 554                         }
 555                 }
 556         }
 557         else if (target_type == TYPE_SERVER)
 558         {
 559                 if (IS_LOCAL(user))
 560                 {
 561                         char* target = (char*)dest;
 562                         std::deque<std::string> par;
 563                         par.push_back(target);
 564                         par.push_back(":"+text);
 565                         Utils->DoOneToMany(user->uuid,"PRIVMSG",par);
 566                 }
 567         }
 568 }
 569
 570 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
 571 {
 572         AutoConnectServers(curtime);
 573         DoPingChecks(curtime);
 574 }
 575
 576 void ModuleSpanningTree::OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
 577 {
 578         // Only do this for local users
 579         if (IS_LOCAL(user))
 580         {
 581                 if (channel->GetUserCounter() == 1)
 582                 {
 583                         std::deque<std::string> params;
 584                         // set up their permissions and the channel TS with FJOIN.
 585                         // All users are FJOINed now, because a module may specify
 586                         // new joining permissions for the user.
 587                         params.push_back(channel->name);
 588                         params.push_back(ConvToStr(channel->age));
 589                         params.push_back(std::string("+") + channel->ChanModes(true));
 590                         params.push_back(ServerInstance->Modes->ModeString(user, channel, false)+","+std::string(user->uuid));
 591                         Utils->DoOneToMany(ServerInstance->Config->GetSID(),"FJOIN",params);
 592                 }
 593                 else
 594                 {
 595                         std::deque<std::string> params;
 596                         params.push_back(channel->name);
 597                         params.push_back(ConvToStr(channel->age));
 598                         Utils->DoOneToMany(user->uuid,"JOIN",params);
 599                 }
 600         }
 601 }
 602
 603 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
 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(newhost);
 610         Utils->DoOneToMany(user->uuid,"FHOST",params);
 611 }
 612
 613 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
 614 {
 615         // only occurs for local clients
 616         if (user->registered != REG_ALL)
 617                 return;
 618         std::deque<std::string> params;
 619         params.push_back(gecos);
 620         Utils->DoOneToMany(user->uuid,"FNAME",params);
 621 }
 622
 623 void ModuleSpanningTree::OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent)
 624 {
 625         if (IS_LOCAL(user))
 626         {
 627                 std::deque<std::string> params;
 628                 params.push_back(channel->name);
 629                 if (!partmessage.empty())
 630                         params.push_back(":"+partmessage);
 631                 Utils->DoOneToMany(user->uuid,"PART",params);
 632         }
 633 }
 634
 635 void ModuleSpanningTree::OnPostConnect(User* user)
 636 {
 637         if (IS_LOCAL(user))
 638         {
 639                 std::deque<std::string> params;
 640                 params.push_back(user->uuid);
 641                 params.push_back(ConvToStr(user->age));
 642                 params.push_back(user->nick);
 643                 params.push_back(user->host);
 644                 params.push_back(user->dhost);
 645                 params.push_back(user->ident);
 646                 params.push_back("+"+std::string(user->FormatModes()));
 647                 params.push_back(user->GetIPString());
 648                 params.push_back(ConvToStr(user->signon));
 649                 params.push_back(":"+std::string(user->fullname));
 650                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "UID", params);
 651         }
 652
 653         TreeServer* SourceServer = Utils->FindServer(user->server);
 654         if (SourceServer)
 655         {
 656                 SourceServer->SetUserCount(1); // increment by 1
 657         }
 658 }
 659
 660 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 661 {
 662         if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
 663         {
 664                 std::deque<std::string> params;
 665
 666                 if (oper_message != reason)
 667                 {
 668                         params.push_back(":"+oper_message);
 669                         Utils->DoOneToMany(user->uuid,"OPERQUIT",params);
 670                 }
 671                 params.clear();
 672                 params.push_back(":"+reason);
 673                 Utils->DoOneToMany(user->uuid,"QUIT",params);
 674         }
 675
 676         // Regardless, We need to modify the user Counts..
 677         TreeServer* SourceServer = Utils->FindServer(user->server);
 678         if (SourceServer)
 679         {
 680                 SourceServer->SetUserCount(-1); // decrement by 1
 681         }
 682 }
 683
 684 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
 685 {
 686         if (IS_LOCAL(user))
 687         {
 688                 std::deque<std::string> params;
 689                 params.push_back(user->nick);
 690
 691                 /** IMPORTANT: We don't update the TS if the oldnick is just a case change of the newnick!
 692                  */
 693                 if (irc::string(user->nick) != assign(oldnick))
 694                         user->age = ServerInstance->Time();
 695
 696                 params.push_back(ConvToStr(user->age));
 697                 Utils->DoOneToMany(user->uuid,"NICK",params);
 698         }
 699 }
 700
 701 void ModuleSpanningTree::OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
 702 {
 703         if ((source) && (IS_LOCAL(source)))
 704         {
 705                 std::deque<std::string> params;
 706                 params.push_back(chan->name);
 707                 params.push_back(user->uuid);
 708                 params.push_back(":"+reason);
 709                 Utils->DoOneToMany(source->uuid,"KICK",params);
 710         }
 711         else if (!source)
 712         {
 713                 std::deque<std::string> params;
 714                 params.push_back(chan->name);
 715                 params.push_back(user->uuid);
 716                 params.push_back(":"+reason);
 717                 Utils->DoOneToMany(ServerInstance->Config->GetSID(),"KICK",params);
 718         }
 719 }
 720
 721 void ModuleSpanningTree::OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason)
 722 {
 723         std::deque<std::string> params;
 724         params.push_back(":"+reason);
 725         Utils->DoOneToMany(dest->uuid,"OPERQUIT",params);
 726         params.clear();
 727         params.push_back(dest->uuid);
 728         params.push_back(":"+reason);
 729         dest->SetOperQuit(operreason);
 730         Utils->DoOneToMany(source->uuid,"KILL",params);
 731 }
 732
 733 void ModuleSpanningTree::OnRehash(User* user, const std::string &parameter)
 734 {
 735         ServerInstance->Logs->Log("remoterehash", DEBUG, "called with param %s", parameter.c_str());
 736
 737         // Send out to other servers
 738         if (!parameter.empty() && parameter[0] != '-')
 739         {
 740                 ServerInstance->Logs->Log("remoterehash", DEBUG, "sending out lol");
 741                 std::deque<std::string> params;
 742                 params.push_back(parameter);
 743                 Utils->DoOneToAllButSender(user ? user->uuid : ServerInstance->Config->GetSID(), "REHASH", params, user ? user->server : ServerInstance->Config->GetSID()); /// Can this take SID?
 744         }
 745
 746         // Re-read config stuff
 747         Utils->ReadConfiguration(true);
 748 }
 749
 750 // note: the protocol does not allow direct umode +o except
 751 // via NICK with 8 params. sending OPERTYPE infers +o modechange
 752 // locally.
 753 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
 754 {
 755         if (IS_LOCAL(user))
 756         {
 757                 std::deque<std::string> params;
 758                 params.push_back(opertype);
 759                 Utils->DoOneToMany(user->uuid,"OPERTYPE",params);
 760         }
 761 }
 762
 763 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
 764 {
 765         if (!x->IsBurstable())
 766                 return;
 767
 768         char data[MAXBUF];
 769         snprintf(data,MAXBUF,"%s %s %s %lu %lu :%s", x->type.c_str(), x->Displayable(),
 770         ServerInstance->Config->ServerName, (unsigned long)x->set_time, (unsigned long)x->duration, x->reason);
 771         std::deque<std::string> params;
 772         params.push_back(data);
 773
 774         if (!user)
 775         {
 776                 /* Server-set lines */
 777                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "ADDLINE", params);
 778         }
 779         else if (IS_LOCAL(user))
 780         {
 781                 /* User-set lines */
 782                 Utils->DoOneToMany(user->uuid, "ADDLINE", params);
 783         }
 784 }
 785
 786 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
 787 {
 788         if (x->type == "K")
 789                 return;
 790
 791         char data[MAXBUF];
 792         snprintf(data,MAXBUF,"%s %s", x->type.c_str(), x->Displayable());
 793         std::deque<std::string> params;
 794         params.push_back(data);
 795
 796         if (!user)
 797         {
 798                 /* Server-unset lines */
 799                 Utils->DoOneToMany(ServerInstance->Config->GetSID(), "DELLINE", params);
 800         }
 801         else if (IS_LOCAL(user))
 802         {
 803                 /* User-unset lines */
 804                 Utils->DoOneToMany(user->uuid, "DELLINE", params);
 805         }
 806 }
 807
 808 void ModuleSpanningTree::OnMode(User* user, void* dest, int target_type, const std::string &text)
 809 {
 810         if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
 811         {
 812                 std::deque<std::string> params;
 813                 std::string command;
 814                 std::string output_text;
 815
 816                 ServerInstance->Parser->TranslateUIDs(TR_SPACENICKLIST, text, output_text);
 817
 818                 if (target_type == TYPE_USER)
 819                 {
 820                         User* u = (User*)dest;
 821                         params.push_back(u->uuid);
 822                         params.push_back(output_text);
 823                         command = "MODE";
 824                 }
 825                 else
 826                 {
 827                         Channel* c = (Channel*)dest;
 828                         params.push_back(c->name);
 829                         params.push_back(ConvToStr(c->age));
 830                         params.push_back(output_text);
 831                         command = "FMODE";
 832                 }
 833
 834                 Utils->DoOneToMany(user->uuid, command, params);
 835         }
 836 }
 837
 838 int ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
 839 {
 840         if (IS_LOCAL(user))
 841         {
 842                 if (awaymsg.empty())
 843                 {
 844                         std::deque<std::string> params;
 845                         params.clear();
 846                         Utils->DoOneToMany(user->uuid,"AWAY",params);
 847                 }
 848                 else
 849                 {
 850                         std::deque<std::string> params;
 851                         params.push_back(":" + awaymsg);
 852                         Utils->DoOneToMany(user->uuid,"AWAY",params);
 853                 }
 854         }
 855
 856         return 0;
 857 }
 858
 859 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
 860 {
 861         TreeSocket* s = (TreeSocket*)opaque;
 862         std::string output_text;
 863
 864         ServerInstance->Parser->TranslateUIDs(TR_SPACENICKLIST, modeline, output_text);
 865
 866         if (target)
 867         {
 868                 if (target_type == TYPE_USER)
 869                 {
 870                         User* u = (User*)target;
 871                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" FMODE "+u->uuid+" "+ConvToStr(u->age)+" "+output_text);
 872                 }
 873                 else
 874                 {
 875                         Channel* c = (Channel*)target;
 876                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+output_text);
 877                 }
 878         }
 879 }
 880
 881 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
 882 {
 883         TreeSocket* s = (TreeSocket*)opaque;
 884         if (target)
 885         {
 886                 if (target_type == TYPE_USER)
 887                 {
 888                         User* u = (User*)target;
 889                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA "+u->uuid+" "+extname+" :"+extdata);
 890                 }
 891                 else if (target_type == TYPE_CHANNEL)
 892                 {
 893                         Channel* c = (Channel*)target;
 894                         s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA "+c->name+" "+extname+" :"+extdata);
 895                 }
 896         }
 897         if (target_type == TYPE_OTHER)
 898         {
 899                 s->WriteLine(std::string(":")+ServerInstance->Config->GetSID()+" METADATA * "+extname+" :"+extdata);
 900         }
 901 }
 902
 903 void ModuleSpanningTree::OnEvent(Event* event)
 904 {
 905         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")
 906                 || (event->GetEventID() == "send_modeset") || (event->GetEventID() == "send_snoset") || (event->GetEventID() == "send_push"))
 907         {
 908                 ServerInstance->Logs->Log("m_spanningtree", DEBUG, "WARNING: Deprecated use of old 1.1 style m_spanningtree event ignored, type '"+event->GetEventID()+"'!");
 909         }
 910 }
 911
 912 ModuleSpanningTree::~ModuleSpanningTree()
 913 {
 914         /* This will also free the listeners */
 915         delete ServerInstance->PI;
 916         ServerInstance->PI = new ProtocolInterface(ServerInstance);
 917
 918         delete Utils;
 919
 920         ServerInstance->Timers->DelTimer(RefreshTimer);
 921
 922         ServerInstance->Modules->DoneWithInterface("BufferedSocketHook");
 923 }
 924
 925 Version ModuleSpanningTree::GetVersion()
 926 {
 927         return Version(1,2,0,2,VF_VENDOR,API_VERSION);
 928 }
 929
 930 /* It is IMPORTANT that m_spanningtree is the last module in the chain
 931  * so that any activity it sees is FINAL, e.g. we arent going to send out
 932  * a NICK message before m_cloaking has finished putting the +x on the user,
 933  * etc etc.
 934  * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
 935  * the module call queue.
 936  */
 937 void ModuleSpanningTree::Prioritize()
 938 {
 939         ServerInstance->Modules->SetPriority(this, PRIO_LAST);
 940 }
 941
 942 MODULE_INIT(ModuleSpanningTree)