]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/main.cpp
Clean up the protocol interface
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / main.cpp
index 4934c3d610f0d9d0bee777a0863ebe0267c3a173..57fe2090cb8340e95383f7cb9ddd74f6f55c7d9f 100644 (file)
  */
 
 
-/* $ModDesc: Provides a spanning tree server link protocol */
-
 #include "inspircd.h"
 #include "socket.h"
 #include "xline.h"
+#include "iohook.h"
 
 #include "resolvers.h"
 #include "main.h"
 #include "protocolinterface.h"
 
 ModuleSpanningTree::ModuleSpanningTree()
-       : commands(NULL), DNS(this, "DNS"), Utils(NULL)
+       : commands(NULL), DNS(this, "DNS")
 {
 }
 
 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
-       : rconnect(module, module->Utils), rsquit(module, module->Utils),
+       : rconnect(module), rsquit(module), map(module),
        svsjoin(module), svspart(module), svsnick(module), metadata(module),
        uid(module), opertype(module), fjoin(module), ijoin(module), resync(module),
-       fmode(module), ftopic(module), fhost(module), fident(module), fname(module)
+       fmode(module), ftopic(module), fhost(module), fident(module), fname(module),
+       away(module), addline(module), delline(module), encap(module), idle(module),
+       nick(module), ping(module), pong(module), push(module), save(module),
+       server(module), squit(module), snonotice(module), version(module),
+       burst(module), endburst(module)
 {
 }
 
 void ModuleSpanningTree::init()
 {
+       ServerInstance->SNO->EnableSnomask('l', "LINK");
+
        Utils = new SpanningTreeUtilities(this);
+       Utils->TreeRoot = new TreeServer;
        commands = new SpanningTreeCommands(this);
        ServerInstance->Modules->AddService(commands->rconnect);
        ServerInstance->Modules->AddService(commands->rsquit);
-       ServerInstance->Modules->AddService(commands->svsjoin);
-       ServerInstance->Modules->AddService(commands->svspart);
-       ServerInstance->Modules->AddService(commands->svsnick);
-       ServerInstance->Modules->AddService(commands->metadata);
-       ServerInstance->Modules->AddService(commands->uid);
-       ServerInstance->Modules->AddService(commands->opertype);
-       ServerInstance->Modules->AddService(commands->fjoin);
-       ServerInstance->Modules->AddService(commands->ijoin);
-       ServerInstance->Modules->AddService(commands->resync);
-       ServerInstance->Modules->AddService(commands->fmode);
-       ServerInstance->Modules->AddService(commands->ftopic);
-       ServerInstance->Modules->AddService(commands->fhost);
-       ServerInstance->Modules->AddService(commands->fident);
-       ServerInstance->Modules->AddService(commands->fname);
-
-       Implementation eventlist[] =
-       {
-               I_OnPreCommand, I_OnGetServerDescription, I_OnUserInvite, I_OnPostTopicChange,
-               I_OnWallops, I_OnUserMessage, I_OnBackgroundTimer, I_OnUserJoin,
-               I_OnChangeHost, I_OnChangeName, I_OnChangeIdent, I_OnUserPart, I_OnUnloadModule,
-               I_OnUserQuit, I_OnUserPostNick, I_OnUserKick, I_OnRemoteKill, I_OnRehash, I_OnPreRehash,
-               I_OnOper, I_OnAddLine, I_OnDelLine, I_OnMode, I_OnLoadModule, I_OnStats,
-               I_OnSetAway, I_OnPostCommand, I_OnUserConnect, I_OnAcceptConnection
-       };
-       ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
+       ServerInstance->Modules->AddService(commands->map);
 
        delete ServerInstance->PI;
-       ServerInstance->PI = new SpanningTreeProtocolInterface(Utils);
+       ServerInstance->PI = new SpanningTreeProtocolInterface;
        loopCall = false;
 
        // update our local user count
@@ -96,18 +78,21 @@ void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
        {
                Parent = Current->GetParent()->GetName();
        }
-       for (unsigned int q = 0; q < Current->ChildCount(); q++)
+
+       const TreeServer::ChildServers& children = Current->GetChildren();
+       for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
        {
-               if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName()))))
+               TreeServer* server = *i;
+               if ((server->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(server->GetName()))))
                {
                        if (user->IsOper())
                        {
-                                ShowLinks(Current->GetChild(q),user,hops+1);
+                                ShowLinks(server, user, hops+1);
                        }
                }
                else
                {
-                       ShowLinks(Current->GetChild(q),user,hops+1);
+                       ShowLinks(server, user, hops+1);
                }
        }
        /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
@@ -117,23 +102,16 @@ void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
        else if ((Current->Hidden) && (!user->IsOper()))
                return;
 
-       std::string servername = Current->GetName();
-       user->WriteNumeric(364, "%s %s %s :%d %s",      user->nick.c_str(), servername.c_str(),
+       user->WriteNumeric(364, "%s %s %s :%d %s",      user->nick.c_str(), Current->GetName().c_str(),
                        (Utils->FlatLinks && (!user->IsOper())) ? ServerInstance->Config->ServerName.c_str() : Parent.c_str(),
                        (Utils->FlatLinks && (!user->IsOper())) ? 0 : hops,
                        Current->GetDesc().c_str());
 }
 
-int ModuleSpanningTree::CountServs()
-{
-       return Utils->serverlist.size();
-}
-
 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
 {
        ShowLinks(Utils->TreeRoot,user,0);
        user->WriteNumeric(365, "%s * :End of /LINKS list.",user->nick.c_str());
-       return;
 }
 
 std::string ModuleSpanningTree::TimeToStr(time_t secs)
@@ -163,61 +141,53 @@ restart:
        {
                TreeServer *s = i->second;
 
-               if (s->GetSocket() && s->GetSocket()->GetLinkState() == DYING)
+               // Skip myself
+               if (s->IsRoot())
+                       continue;
+
+               if (s->GetSocket()->GetLinkState() == DYING)
                {
                        s->GetSocket()->Close();
                        goto restart;
                }
 
-               // Fix for bug #792, do not ping servers that are not connected yet!
-               // Remote servers have Socket == NULL and local connected servers have
-               // Socket->LinkState == CONNECTED
-               if (s->GetSocket() && s->GetSocket()->GetLinkState() != CONNECTED)
+               // Do not ping servers that are not fully connected yet!
+               // Servers which are connected to us have IsLocal() == true and if they're fully connected
+               // then Socket->LinkState == CONNECTED. Servers that are linked to another server are always fully connected.
+               if (s->IsLocal() && s->GetSocket()->GetLinkState() != CONNECTED)
                        continue;
 
                // Now do PING checks on all servers
-               TreeServer *mts = Utils->BestRouteTo(s->GetID());
-
-               if (mts)
+               // Only ping if this server needs one
+               if (curtime >= s->NextPingTime())
                {
-                       // Only ping if this server needs one
-                       if (curtime >= s->NextPingTime())
+                       // And if they answered the last
+                       if (s->AnsweredLastPing())
                        {
-                               // And if they answered the last
-                               if (s->AnsweredLastPing())
-                               {
-                                       // They did, send a ping to them
-                                       s->SetNextPingTime(curtime + Utils->PingFreq);
-                                       TreeSocket *tsock = mts->GetSocket();
-
-                                       // ... if we can find a proper route to them
-                                       if (tsock)
-                                       {
-                                               tsock->WriteLine(":" + ServerInstance->Config->GetSID() + " PING " + s->GetID());
-                                               s->LastPingMsec = ts;
-                                       }
-                               }
-                               else
+                               // They did, send a ping to them
+                               s->SetNextPingTime(curtime + Utils->PingFreq);
+                               s->GetSocket()->WriteLine(":" + ServerInstance->Config->GetSID() + " PING " + s->GetID());
+                               s->LastPingMsec = ts;
+                       }
+                       else
+                       {
+                               // They didn't answer the last ping, if they are locally connected, get rid of them.
+                               if (s->IsLocal())
                                {
-                                       // They didn't answer the last ping, if they are locally connected, get rid of them.
-                                       TreeSocket *sock = s->GetSocket();
-                                       if (sock)
-                                       {
-                                               sock->SendError("Ping timeout");
-                                               sock->Close();
-                                               goto restart;
-                                       }
+                                       TreeSocket* sock = s->GetSocket();
+                                       sock->SendError("Ping timeout");
+                                       sock->Close();
+                                       goto restart;
                                }
                        }
+               }
 
-                       // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
-                       if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
-                       {
-                               /* The server hasnt responded, send a warning to opers */
-                               std::string servername = s->GetName();
-                               ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", servername.c_str(), Utils->PingWarnTime);
-                               s->Warned = true;
-                       }
+               // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
+               if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
+               {
+                       /* The server hasnt responded, send a warning to opers */
+                       ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", s->GetName().c_str(), Utils->PingWarnTime);
+                       s->Warned = true;
                }
        }
 }
@@ -287,7 +257,7 @@ void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
        if (ipvalid)
        {
                /* Gave a hook, but it wasnt one we know */
-               TreeSocket* newsocket = new TreeSocket(Utils, x, y, x->IPAddr);
+               TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
                if (newsocket->GetFd() > -1)
                {
                        /* Handled automatically on success */
@@ -305,7 +275,7 @@ void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
        }
        else
        {
-               ServernameResolver* snr = new ServernameResolver(Utils, *DNS, x->IPAddr, x, start_type, y);
+               ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
                try
                {
                        DNS->Process(snr);
@@ -411,8 +381,7 @@ ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& para
                        }
                        else
                        {
-                               std::string servername = CheckDupe->GetParent()->GetName();
-                               RemoteMessage(user, "*** CONNECT: Server \002%s\002 already exists on the network and is connected via \002%s\002", x->Name.c_str(), servername.c_str());
+                               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());
                                return MOD_RES_DENY;
                        }
                }
@@ -421,6 +390,11 @@ ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& para
        return MOD_RES_DENY;
 }
 
+void ModuleSpanningTree::On005Numeric(std::map<std::string, std::string>& tokens)
+{
+       tokens["MAP"];
+}
+
 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
 {
        TreeServer* s = Utils->FindServer(servername);
@@ -454,22 +428,12 @@ void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std:
        Utils->DoOneToMany(user->uuid,"TOPIC",params);
 }
 
-void ModuleSpanningTree::OnWallops(User* user, const std::string &text)
-{
-       if (IS_LOCAL(user))
-       {
-               parameterlist params;
-               params.push_back(":"+text);
-               Utils->DoOneToMany(user->uuid,"WALLOPS",params);
-       }
-}
-
-void ModuleSpanningTree::LocalMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, const char* message_type)
+void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype)
 {
-       /* Server or remote origin, dest should always be non-null */
-       if ((!user) || (!IS_LOCAL(user)) || (!dest))
+       if (!IS_LOCAL(user))
                return;
 
+       const char* message_type = (msgtype == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
        if (target_type == TYPE_USER)
        {
                User* d = (User*) dest;
@@ -495,11 +459,6 @@ void ModuleSpanningTree::LocalMessage(User* user, void* dest, int target_type, c
        }
 }
 
-void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype)
-{
-       LocalMessage(user, dest, target_type, text, status, exempt_list, (msgtype == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE"));
-}
-
 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
 {
        AutoConnectServers(curtime);
@@ -592,8 +551,7 @@ void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
 
 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
 {
-       // only occurs for local clients
-       if (user->registered != REG_ALL)
+       if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
                return;
 
        parameterlist params;
@@ -620,11 +578,8 @@ void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const
                parameterlist params;
 
                if (oper_message != reason)
-               {
-                       params.push_back(":"+oper_message);
-                       Utils->DoOneToMany(user->uuid,"OPERQUIT",params);
-               }
-               params.clear();
+                       ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
+
                params.push_back(":"+reason);
                Utils->DoOneToMany(user->uuid,"QUIT",params);
        }
@@ -677,34 +632,19 @@ void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::s
        }
 }
 
-void ModuleSpanningTree::OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason)
-{
-       if (!IS_LOCAL(source))
-               return; // Only start routing if we're origin.
-
-       ServerInstance->OperQuit.set(dest, operreason);
-       parameterlist params;
-       params.push_back(":"+operreason);
-       Utils->DoOneToMany(dest->uuid,"OPERQUIT",params);
-       params.clear();
-       params.push_back(dest->uuid);
-       params.push_back(":"+reason);
-       Utils->DoOneToMany(source->uuid,"KILL",params);
-}
-
 void ModuleSpanningTree::OnPreRehash(User* user, const std::string &parameter)
 {
        if (loopCall)
                return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
 
-       ServerInstance->Logs->Log("remoterehash", LOG_DEBUG, "called with param %s", parameter.c_str());
+       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
 
        // Send out to other servers
        if (!parameter.empty() && parameter[0] != '-')
        {
                parameterlist params;
                params.push_back(parameter);
-               Utils->DoOneToAllButSender(user ? user->uuid : ServerInstance->Config->GetSID(), "REHASH", params, user ? user->server : ServerInstance->Config->ServerName);
+               Utils->DoOneToAllButSender(user ? user->uuid : ServerInstance->Config->GetSID(), "REHASH", params, user ? Utils->BestRouteTo(user->server) : NULL);
        }
 }
 
@@ -744,14 +684,16 @@ void ModuleSpanningTree::OnLoadModule(Module* mod)
 
 void ModuleSpanningTree::OnUnloadModule(Module* mod)
 {
+       if (!Utils)
+               return;
        ServerInstance->PI->SendMetaData(NULL, "modules", "-" + mod->ModuleSourceFile);
 
-       unsigned int items = Utils->TreeRoot->ChildCount();
-       for(unsigned int x = 0; x < items; x++)
+       // Close all connections which use an IO hook provided by this module
+       const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
+       for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
        {
-               TreeServer* srv = Utils->TreeRoot->GetChild(x);
-               TreeSocket* sock = srv->GetSocket();
-               if (sock && sock->GetIOHook() == mod)
+               TreeSocket* sock = (*i)->GetSocket();
+               if (sock && sock->GetIOHook() && sock->GetIOHook()->creator == mod)
                {
                        sock->SendError("SSL module unloaded");
                        sock->Close();
@@ -818,33 +760,6 @@ void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
        }
 }
 
-void ModuleSpanningTree::OnMode(User* user, void* dest, int target_type, const parameterlist &text, const std::vector<TranslateType> &translate)
-{
-       if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
-       {
-               parameterlist params;
-               std::string output_text;
-
-               ServerInstance->Parser->TranslateUIDs(translate, text, output_text);
-
-               if (target_type == TYPE_USER)
-               {
-                       User* u = (User*)dest;
-                       params.push_back(u->uuid);
-                       params.push_back(output_text);
-                       Utils->DoOneToMany(user->uuid, "MODE", params);
-               }
-               else
-               {
-                       Channel* c = (Channel*)dest;
-                       params.push_back(c->name);
-                       params.push_back(ConvToStr(c->age));
-                       params.push_back(output_text);
-                       Utils->DoOneToMany(user->uuid, "FMODE", params);
-               }
-       }
-}
-
 ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
 {
        if (IS_LOCAL(user))
@@ -864,9 +779,7 @@ ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
 void ModuleSpanningTree::ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const parameterlist &modeline, const std::vector<TranslateType> &translate)
 {
        TreeSocket* s = (TreeSocket*)opaque;
-       std::string output_text;
-
-       ServerInstance->Parser->TranslateUIDs(translate, modeline, output_text);
+       std::string output_text = CommandParser::TranslateUIDs(translate, modeline);
 
        if (target)
        {
@@ -898,7 +811,8 @@ void ModuleSpanningTree::ProtoSendMetaData(void* opaque, Extensible* target, con
 
 CullResult ModuleSpanningTree::cull()
 {
-       Utils->cull();
+       if (Utils)
+               Utils->cull();
        return this->Module::cull();
 }