diff options
Diffstat (limited to 'src/modules/m_spanningtree/treesocket.cpp')
-rw-r--r-- | src/modules/m_spanningtree/treesocket.cpp | 2878 |
1 files changed, 2878 insertions, 0 deletions
diff --git a/src/modules/m_spanningtree/treesocket.cpp b/src/modules/m_spanningtree/treesocket.cpp new file mode 100644 index 000000000..8d2027ab2 --- /dev/null +++ b/src/modules/m_spanningtree/treesocket.cpp @@ -0,0 +1,2878 @@ +#include "configreader.h" +#include "users.h" +#include "channels.h" +#include "modules.h" +#include "commands/cmd_whois.h" +#include "commands/cmd_stats.h" +#include "socket.h" +#include "inspircd.h" +#include "wildcard.h" +#include "xline.h" +#include "transport.h" +#include "socketengine.h" + +#include "m_spanningtree/main.h" +#include "m_spanningtree/utils.h" +#include "m_spanningtree/treeserver.h" +#include "m_spanningtree/link.h" +#include "m_spanningtree/treesocket.h" +#include "m_spanningtree/resolvers.h" +#include "m_spanningtree/handshaketimer.h" + +/** Because most of the I/O gubbins are encapsulated within + * InspSocket, we just call the superclass constructor for + * most of the action, and append a few of our own values + * to it. + */ +TreeSocket::TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, Module* HookMod) + : InspSocket(SI, host, port, listening, maxtime), Utils(Util), Hook(HookMod) +{ + myhost = host; + this->LinkState = LISTENER; + if (listening && Hook) + InspSocketHookRequest(this, (Module*)Utils->Creator, Hook).Send(); +} + +TreeSocket::TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, std::string ServerName, Module* HookMod) + : InspSocket(SI, host, port, listening, maxtime), Utils(Util), Hook(HookMod) +{ + myhost = ServerName; + this->LinkState = CONNECTING; + if (Hook) + InspSocketHookRequest(this, (Module*)Utils->Creator, Hook).Send(); +} + +/** When a listening socket gives us a new file descriptor, + * we must associate it with a socket without creating a new + * connection. This constructor is used for this purpose. + */ +TreeSocket::TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, int newfd, char* ip, Module* HookMod) + : InspSocket(SI, newfd, ip), Utils(Util), Hook(HookMod) +{ + this->LinkState = WAIT_AUTH_1; + /* If we have a transport module hooked to the parent, hook the same module to this + * socket, and set a timer waiting for handshake before we send CAPAB etc. + */ + if (Hook) + { + InspSocketHookRequest(this, (Module*)Utils->Creator, Hook).Send(); + Instance->Timers->AddTimer(new HandshakeTimer(Instance, this, &(Utils->LinkBlocks[0]), this->Utils)); + } + else + { + /* Otherwise, theres no lower layer transport in plain TCP/IP, + * so just send the capabilities right now. + */ + this->SendCapabilities(); + } +} + +ServerState TreeSocket::GetLinkState() +{ + return this->LinkState; +} + +Module* TreeSocket::GetHook() +{ + return this->Hook; +} + +TreeSocket::~TreeSocket() +{ + if (Hook) + InspSocketUnhookRequest(this, (Module*)Utils->Creator, Hook).Send(); +} + +/** When an outbound connection finishes connecting, we receive + * this event, and must send our SERVER string to the other + * side. If the other side is happy, as outlined in the server + * to server docs on the inspircd.org site, the other side + * will then send back its own server string. + */ +bool TreeSocket::OnConnected() +{ + if (this->LinkState == CONNECTING) + { + /* we do not need to change state here. */ + for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++) + { + if (x->Name == this->myhost) + { + this->Instance->SNO->WriteToSnoMask('l',"Connection to \2"+myhost+"\2["+(x->HiddenFromStats ? "<hidden>" : this->GetIP())+"] started."); + if (Hook) + { + InspSocketHookRequest(this, (Module*)Utils->Creator, Hook).Send(); + this->Instance->SNO->WriteToSnoMask('l',"Connection to \2"+myhost+"\2["+(x->HiddenFromStats ? "<hidden>" : this->GetIP())+"] using transport \2"+x->Hook+"\2"); + } + else + this->SendCapabilities(); + /* found who we're supposed to be connecting to, send the neccessary gubbins. */ + if (Hook) + Instance->Timers->AddTimer(new HandshakeTimer(Instance, this, &(*x), this->Utils)); + else + this->WriteLine(std::string("SERVER ")+this->Instance->Config->ServerName+" "+x->SendPass+" 0 :"+this->Instance->Config->ServerDesc); + return true; + } + } + } + /* There is a (remote) chance that between the /CONNECT and the connection + * being accepted, some muppet has removed the <link> block and rehashed. + * If that happens the connection hangs here until it's closed. Unlikely + * and rather harmless. + */ + this->Instance->SNO->WriteToSnoMask('l',"Connection to \2"+myhost+"\2 lost link tag(!)"); + return true; +} + +void TreeSocket::OnError(InspSocketError e) +{ + /* We don't handle this method, because all our + * dirty work is done in OnClose() (see below) + * which is still called on error conditions too. + */ + if (e == I_ERR_CONNECT) + { + this->Instance->SNO->WriteToSnoMask('l',"Connection failed: Connection to \002"+myhost+"\002 refused"); + Link* MyLink = Utils->FindLink(myhost); + if (MyLink) + Utils->DoFailOver(MyLink); + } +} + +int TreeSocket::OnDisconnect() +{ + /* For the same reason as above, we don't + * handle OnDisconnect() + */ + return true; +} + +/** Recursively send the server tree with distances as hops. + * This is used during network burst to inform the other server + * (and any of ITS servers too) of what servers we know about. + * If at any point any of these servers already exist on the other + * end, our connection may be terminated. The hopcounts given + * by this function are relative, this doesn't matter so long as + * they are all >1, as all the remote servers re-calculate them + * to be relative too, with themselves as hop 0. + */ +void TreeSocket::SendServers(TreeServer* Current, TreeServer* s, int hops) +{ + char command[1024]; + for (unsigned int q = 0; q < Current->ChildCount(); q++) + { + TreeServer* recursive_server = Current->GetChild(q); + if (recursive_server != s) + { + snprintf(command,1024,":%s SERVER %s * %d :%s",Current->GetName().c_str(),recursive_server->GetName().c_str(),hops,recursive_server->GetDesc().c_str()); + this->WriteLine(command); + this->WriteLine(":"+recursive_server->GetName()+" VERSION :"+recursive_server->GetVersion()); + /* down to next level */ + this->SendServers(recursive_server, s, hops+1); + } + } +} + +std::string TreeSocket::MyCapabilities() +{ + std::vector<std::string> modlist; + std::string capabilities = ""; + for (int i = 0; i <= this->Instance->GetModuleCount(); i++) + { + if (this->Instance->modules[i]->GetVersion().Flags & VF_COMMON) + modlist.push_back(this->Instance->Config->module_names[i]); + } + sort(modlist.begin(),modlist.end()); + for (unsigned int i = 0; i < modlist.size(); i++) + { + if (i) + capabilities = capabilities + ","; + capabilities = capabilities + modlist[i]; + } + return capabilities; +} + +void TreeSocket::SendCapabilities() +{ + irc::commasepstream modulelist(MyCapabilities()); + this->WriteLine("CAPAB START"); + + /* Send module names, split at 509 length */ + std::string item = "*"; + std::string line = "CAPAB MODULES "; + while ((item = modulelist.GetToken()) != "") + { + if (line.length() + item.length() + 1 > 509) + { + this->WriteLine(line); + line = "CAPAB MODULES "; + } + + if (line != "CAPAB MODULES ") + line.append(","); + + line.append(item); + } + if (line != "CAPAB MODULES ") + this->WriteLine(line); + + int ip6 = 0; + int ip6support = 0; +#ifdef IPV6 + ip6 = 1; +#endif +#ifdef SUPPORT_IP6LINKS + ip6support = 1; +#endif + this->WriteLine("CAPAB CAPABILITIES :NICKMAX="+ConvToStr(NICKMAX)+" HALFOP="+ConvToStr(this->Instance->Config->AllowHalfop)+" CHANMAX="+ConvToStr(CHANMAX)+" MAXMODES="+ConvToStr(MAXMODES)+" IDENTMAX="+ConvToStr(IDENTMAX)+" MAXQUIT="+ConvToStr(MAXQUIT)+" MAXTOPIC="+ConvToStr(MAXTOPIC)+" MAXKICK="+ConvToStr(MAXKICK)+" MAXGECOS="+ConvToStr(MAXGECOS)+" MAXAWAY="+ConvToStr(MAXAWAY)+" IP6NATIVE="+ConvToStr(ip6)+" IP6SUPPORT="+ConvToStr(ip6support)+" PROTOCOL="+ConvToStr(ProtocolVersion)); + + this->WriteLine("CAPAB END"); +} + +/* Check a comma seperated list for an item */ +bool TreeSocket::HasItem(const std::string &list, const std::string &item) +{ + irc::commasepstream seplist(list); + std::string item2 = "*"; + while ((item2 = seplist.GetToken()) != "") + { + if (item2 == item) + return true; + } + return false; +} + +/* Isolate and return the elements that are different between two comma seperated lists */ +std::string TreeSocket::ListDifference(const std::string &one, const std::string &two) +{ + irc::commasepstream list_one(one); + std::string item = "*"; + std::string result = ""; + while ((item = list_one.GetToken()) != "") + { + if (!HasItem(two, item)) + { + result.append(" "); + result.append(item); + } + } + return result; +} + +bool TreeSocket::Capab(const std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + { + this->WriteLine("ERROR :Invalid number of parameters for CAPAB - Mismatched version"); + return false; + } + if (params[0] == "START") + { + this->ModuleList = ""; + this->CapKeys.clear(); + } + else if (params[0] == "END") + { + std::string reason = ""; + int ip6support = 0; +#ifdef SUPPORT_IP6LINKS + ip6support = 1; +#endif + /* Compare ModuleList and check CapKeys... + * Maybe this could be tidier? -- Brain + */ + if ((this->ModuleList != this->MyCapabilities()) && (this->ModuleList.length())) + { + std::string diff = ListDifference(this->ModuleList, this->MyCapabilities()); + if (!diff.length()) + { + diff = "your server:" + ListDifference(this->MyCapabilities(), this->ModuleList); + } + else + { + diff = "this server:" + diff; + } + if (diff.length() == 12) + reason = "Module list in CAPAB is not alphabetically ordered, cannot compare lists."; + else + reason = "Modules loaded on these servers are not correctly matched, these modules are not loaded on " + diff; + } + if (((this->CapKeys.find("IP6SUPPORT") == this->CapKeys.end()) && (ip6support)) || ((this->CapKeys.find("IP6SUPPORT") != this->CapKeys.end()) && (this->CapKeys.find("IP6SUPPORT")->second != ConvToStr(ip6support)))) + reason = "We don't both support linking to IPV6 servers"; + if (((this->CapKeys.find("IP6NATIVE") != this->CapKeys.end()) && (this->CapKeys.find("IP6NATIVE")->second == "1")) && (!ip6support)) + reason = "The remote server is IPV6 native, and we don't support linking to IPV6 servers"; + if (((this->CapKeys.find("NICKMAX") == this->CapKeys.end()) || ((this->CapKeys.find("NICKMAX") != this->CapKeys.end()) && (this->CapKeys.find("NICKMAX")->second != ConvToStr(NICKMAX))))) + reason = "Maximum nickname lengths differ or remote nickname length not specified"; + if (((this->CapKeys.find("PROTOCOL") == this->CapKeys.end()) || ((this->CapKeys.find("PROTOCOL") != this->CapKeys.end()) && (this->CapKeys.find("PROTOCOL")->second != ConvToStr(ProtocolVersion))))) + { + if (this->CapKeys.find("PROTOCOL") != this->CapKeys.end()) + { + reason = "Mismatched protocol versions "+this->CapKeys.find("PROTOCOL")->second+" and "+ConvToStr(ProtocolVersion); + } + else + { + reason = "Protocol version not specified"; + } + } + if (((this->CapKeys.find("HALFOP") == this->CapKeys.end()) && (Instance->Config->AllowHalfop)) || ((this->CapKeys.find("HALFOP") != this->CapKeys.end()) && (this->CapKeys.find("HALFOP")->second != ConvToStr(Instance->Config->AllowHalfop)))) + reason = "We don't both have halfop support enabled/disabled identically"; + if (((this->CapKeys.find("IDENTMAX") == this->CapKeys.end()) || ((this->CapKeys.find("IDENTMAX") != this->CapKeys.end()) && (this->CapKeys.find("IDENTMAX")->second != ConvToStr(IDENTMAX))))) + reason = "Maximum ident lengths differ or remote ident length not specified"; + if (((this->CapKeys.find("CHANMAX") == this->CapKeys.end()) || ((this->CapKeys.find("CHANMAX") != this->CapKeys.end()) && (this->CapKeys.find("CHANMAX")->second != ConvToStr(CHANMAX))))) + reason = "Maximum channel lengths differ or remote channel length not specified"; + if (((this->CapKeys.find("MAXMODES") == this->CapKeys.end()) || ((this->CapKeys.find("MAXMODES") != this->CapKeys.end()) && (this->CapKeys.find("MAXMODES")->second != ConvToStr(MAXMODES))))) + reason = "Maximum modes per line differ or remote modes per line not specified"; + if (((this->CapKeys.find("MAXQUIT") == this->CapKeys.end()) || ((this->CapKeys.find("MAXQUIT") != this->CapKeys.end()) && (this->CapKeys.find("MAXQUIT")->second != ConvToStr(MAXQUIT))))) + reason = "Maximum quit lengths differ or remote quit length not specified"; + if (((this->CapKeys.find("MAXTOPIC") == this->CapKeys.end()) || ((this->CapKeys.find("MAXTOPIC") != this->CapKeys.end()) && (this->CapKeys.find("MAXTOPIC")->second != ConvToStr(MAXTOPIC))))) + reason = "Maximum topic lengths differ or remote topic length not specified"; + if (((this->CapKeys.find("MAXKICK") == this->CapKeys.end()) || ((this->CapKeys.find("MAXKICK") != this->CapKeys.end()) && (this->CapKeys.find("MAXKICK")->second != ConvToStr(MAXKICK))))) + reason = "Maximum kick lengths differ or remote kick length not specified"; + if (((this->CapKeys.find("MAXGECOS") == this->CapKeys.end()) || ((this->CapKeys.find("MAXGECOS") != this->CapKeys.end()) && (this->CapKeys.find("MAXGECOS")->second != ConvToStr(MAXGECOS))))) + reason = "Maximum GECOS (fullname) lengths differ or remote GECOS length not specified"; + if (((this->CapKeys.find("MAXAWAY") == this->CapKeys.end()) || ((this->CapKeys.find("MAXAWAY") != this->CapKeys.end()) && (this->CapKeys.find("MAXAWAY")->second != ConvToStr(MAXAWAY))))) + reason = "Maximum awaymessage lengths differ or remote awaymessage length not specified"; + if (reason.length()) + { + this->WriteLine("ERROR :CAPAB negotiation failed: "+reason); + return false; + } + } + else if ((params[0] == "MODULES") && (params.size() == 2)) + { + if (!this->ModuleList.length()) + { + this->ModuleList.append(params[1]); + } + else + { + this->ModuleList.append(","); + this->ModuleList.append(params[1]); + } + } + + else if ((params[0] == "CAPABILITIES") && (params.size() == 2)) + { + irc::tokenstream capabs(params[1]); + std::string item = "*"; + while ((item = capabs.GetToken()) != "") + { + /* Process each key/value pair */ + std::string::size_type equals = item.rfind('='); + if (equals != std::string::npos) + { + std::string var = item.substr(0, equals); + std::string value = item.substr(equals+1, item.length()); + CapKeys[var] = value; + } + } + } + return true; +} + +/** This function forces this server to quit, removing this server + * and any users on it (and servers and users below that, etc etc). + * It's very slow and pretty clunky, but luckily unless your network + * is having a REAL bad hair day, this function shouldnt be called + * too many times a month ;-) + */ +void TreeSocket::SquitServer(std::string &from, TreeServer* Current) +{ + /* recursively squit the servers attached to 'Current'. + * We're going backwards so we don't remove users + * while we still need them ;) + */ + for (unsigned int q = 0; q < Current->ChildCount(); q++) + { + TreeServer* recursive_server = Current->GetChild(q); + this->SquitServer(from,recursive_server); + } + /* Now we've whacked the kids, whack self */ + num_lost_servers++; + num_lost_users += Current->QuitUsers(from); +} + +/** This is a wrapper function for SquitServer above, which + * does some validation first and passes on the SQUIT to all + * other remaining servers. + */ +void TreeSocket::Squit(TreeServer* Current, const std::string &reason) +{ + if ((Current) && (Current != Utils->TreeRoot)) + { + Event rmode((char*)Current->GetName().c_str(), (Module*)Utils->Creator, "lost_server"); + rmode.Send(Instance); + + std::deque<std::string> params; + params.push_back(Current->GetName()); + params.push_back(":"+reason); + Utils->DoOneToAllButSender(Current->GetParent()->GetName(),"SQUIT",params,Current->GetName()); + if (Current->GetParent() == Utils->TreeRoot) + { + this->Instance->WriteOpers("Server \002"+Current->GetName()+"\002 split: "+reason); + } + else + { + this->Instance->WriteOpers("Server \002"+Current->GetName()+"\002 split from server \002"+Current->GetParent()->GetName()+"\002 with reason: "+reason); + } + num_lost_servers = 0; + num_lost_users = 0; + std::string from = Current->GetParent()->GetName()+" "+Current->GetName(); + SquitServer(from, Current); + Current->Tidy(); + Current->GetParent()->DelChild(Current); + DELETE(Current); + this->Instance->WriteOpers("Netsplit complete, lost \002%d\002 users on \002%d\002 servers.", num_lost_users, num_lost_servers); + } + else + { + Instance->Log(DEFAULT,"Squit from unknown server"); + } +} + +/** FMODE command - server mode with timestamp checks */ +bool TreeSocket::ForceMode(const std::string &source, std::deque<std::string> ¶ms) +{ + /* Chances are this is a 1.0 FMODE without TS */ + if (params.size() < 3) + { + /* No modes were in the command, probably a channel with no modes set on it */ + return true; + } + + bool smode = false; + std::string sourceserv; + /* Are we dealing with an FMODE from a user, or from a server? */ + userrec* who = this->Instance->FindNick(source); + if (who) + { + /* FMODE from a user, set sourceserv to the users server name */ + sourceserv = who->server; + } + else + { + /* FMODE from a server, create a fake user to receive mode feedback */ + who = new userrec(this->Instance); + who->SetFd(FD_MAGIC_NUMBER); + smode = true; /* Setting this flag tells us we should free the userrec later */ + sourceserv = source; /* Set sourceserv to the actual source string */ + } + const char* modelist[64]; + time_t TS = 0; + int n = 0; + memset(&modelist,0,sizeof(modelist)); + for (unsigned int q = 0; (q < params.size()) && (q < 64); q++) + { + if (q == 1) + { + /* The timestamp is in this position. + * We don't want to pass that up to the + * server->client protocol! + */ + TS = atoi(params[q].c_str()); + } + else + { + /* Everything else is fine to append to the modelist */ + modelist[n++] = params[q].c_str(); + } + + } + /* Extract the TS value of the object, either userrec or chanrec */ + userrec* dst = this->Instance->FindNick(params[0]); + chanrec* chan = NULL; + time_t ourTS = 0; + if (dst) + { + ourTS = dst->age; + } + else + { + chan = this->Instance->FindChan(params[0]); + if (chan) + { + ourTS = chan->age; + } + else + /* Oops, channel doesnt exist! */ + return true; + } + + /* TS is equal: Merge the mode changes, use voooodoooooo on modes + * with parameters. + */ + if (TS == ourTS) + { + ModeHandler* mh = NULL; + unsigned long paramptr = 3; + std::string to_bounce = ""; + std::string to_keep = ""; + std::vector<std::string> params_to_keep; + std::string params_to_bounce = ""; + bool adding = true; + char cur_change = 1; + char old_change = 0; + char old_bounce_change = 0; + /* Merge modes, basically do special stuff to mode with params */ + for (std::string::iterator x = params[2].begin(); x != params[2].end(); x++) + { + switch (*x) + { + case '-': + adding = false; + break; + case '+': + adding = true; + break; + default: + if (adding) + { + /* We only care about whats being set, + * not whats being unset + */ + mh = this->Instance->Modes->FindMode(*x, chan ? MODETYPE_CHANNEL : MODETYPE_USER); + if ((mh) && (mh->GetNumParams(adding) > 0) && (!mh->IsListMode())) + { + /* We only want to do special things to + * modes with parameters, we are going to rewrite + * those parameters + */ + ModePair ret; + adding ? cur_change = '+' : cur_change = '-'; + ret = mh->ModeSet(smode ? NULL : who, dst, chan, params[paramptr]); + /* The mode is set here, check which we should keep */ + if (ret.first) + { + bool which_to_keep = mh->CheckTimeStamp(TS, ourTS, params[paramptr], ret.second, chan); + if (which_to_keep == true) + { + /* Keep ours, bounce theirs: + * Send back ours to them and + * drop their mode changs + */ + adding ? cur_change = '+' : cur_change = '-'; + if (cur_change != old_bounce_change) + to_bounce += cur_change; + to_bounce += *x; + old_bounce_change = cur_change; + if ((mh->GetNumParams(adding) > 0) && (paramptr < params.size())) + params_to_bounce.append(" ").append(ret.second); + } + else + { + /* Keep theirs: Accept their mode change, + * do nothing else + */ + adding ? cur_change = '+' : cur_change = '-'; + if (cur_change != old_change) + to_keep += cur_change; + to_keep += *x; + old_change = cur_change; + if ((mh->GetNumParams(adding) > 0) && (paramptr < params.size())) + params_to_keep.push_back(params[paramptr]); + } + } + else + { + /* Mode isnt set here, we want it */ + adding ? cur_change = '+' : cur_change = '-'; + if (cur_change != old_change) + to_keep += cur_change; + to_keep += *x; + old_change = cur_change; + if ((mh->GetNumParams(adding) > 0) && (paramptr < params.size())) + params_to_keep.push_back(params[paramptr]); + } + paramptr++; + } + else + { + mh = this->Instance->Modes->FindMode(*x, chan ? MODETYPE_CHANNEL : MODETYPE_USER); + if (mh) + { + adding ? cur_change = '+' : cur_change = '-'; + + /* Just keep this, safe to merge with no checks + * it has no parameters + */ + + if (cur_change != old_change) + to_keep += cur_change; + to_keep += *x; + old_change = cur_change; + + if ((mh->GetNumParams(adding) > 0) && (paramptr < params.size())) + { + params_to_keep.push_back(params[paramptr++]); + } + } + } + } + else + { + mh = this->Instance->Modes->FindMode(*x, chan ? MODETYPE_CHANNEL : MODETYPE_USER); + if (mh) + { + /* Taking a mode away */ + adding ? cur_change = '+' : cur_change = '-'; + if (cur_change != old_change) + to_keep += cur_change; + to_keep += *x; + old_change = cur_change; + if ((mh->GetNumParams(adding) > 0) && (paramptr < params.size())) + params_to_keep.push_back(params[paramptr++]); + } + } + break; + } + } + if (to_bounce.length()) + { + std::deque<std::string> newparams; + newparams.push_back(params[0]); + newparams.push_back(ConvToStr(ourTS)); + newparams.push_back(to_bounce+params_to_bounce); + Utils->DoOneToOne(this->Instance->Config->ServerName,"FMODE",newparams,sourceserv); + } + if (to_keep.length()) + { + unsigned int n = 2; + unsigned int q = 0; + modelist[0] = params[0].c_str(); + modelist[1] = to_keep.c_str(); + if (params_to_keep.size() > 0) + { + for (q = 0; (q < params_to_keep.size()) && (q < 64); q++) + { + modelist[n++] = params_to_keep[q].c_str(); + } + } + if (smode) + { + this->Instance->SendMode(modelist, n, who); + } + else + { + this->Instance->CallCommandHandler("MODE", modelist, n, who); + } + /* HOT POTATO! PASS IT ON! */ + Utils->DoOneToAllButSender(source,"FMODE",params,sourceserv); + } + } + else + /* U-lined servers always win regardless of their TS */ + if ((TS > ourTS) && (!this->Instance->ULine(source.c_str()))) + { + /* Bounce the mode back to its sender.* We use our lower TS, so the other end + * SHOULD accept it, if its clock is right. + * + * NOTE: We should check that we arent bouncing anything thats already set at this end. + * If we are, bounce +ourmode to 'reinforce' it. This prevents desyncs. + * e.g. They send +l 50, we have +l 10 set. rather than bounce -l 50, we bounce +l 10. + * + * Thanks to jilles for pointing out this one-hell-of-an-issue before i even finished + * writing the code. It took me a while to come up with this solution. + * + * XXX: BE SURE YOU UNDERSTAND THIS CODE FULLY BEFORE YOU MESS WITH IT. + */ + std::deque<std::string> newparams; /* New parameter list we send back */ + newparams.push_back(params[0]); /* Target, user or channel */ + newparams.push_back(ConvToStr(ourTS)); /* Timestamp value of the target */ + newparams.push_back(""); /* This contains the mode string. For now + * it's empty, we fill it below. + */ + /* Intelligent mode bouncing. Don't just invert, reinforce any modes which are already + * set to avoid a desync here. + */ + std::string modebounce = ""; + bool adding = true; + unsigned int t = 3; + ModeHandler* mh = NULL; + char cur_change = 1; + char old_change = 0; + for (std::string::iterator x = params[2].begin(); x != params[2].end(); x++) + { + /* Iterate over all mode chars in the sent set */ + switch (*x) + { + /* Adding or subtracting modes? */ + case '-': + adding = false; + break; + case '+': + adding = true; + break; + default: + /* Find the mode handler for this mode */ + mh = this->Instance->Modes->FindMode(*x, chan ? MODETYPE_CHANNEL : MODETYPE_USER); + /* Got a mode handler? + * This also prevents us bouncing modes we have no handler for. + */ + if (mh) + { + ModePair ret; + std::string p = ""; + /* Does the mode require a parameter right now? + * If it does, fetch it if we can + */ + if ((mh->GetNumParams(adding) > 0) && (t < params.size())) + p = params[t++]; + /* Call the ModeSet method to determine if its set with the + * given parameter here or not. + */ + ret = mh->ModeSet(smode ? NULL : who, dst, chan, p); + /* XXX: Really. Dont ask. + * Determine from if its set combined with what the current + * 'state' is (adding or not) as to wether we should 'invert' + * or 'reinforce' the mode change + */ + (!ret.first ? (adding ? cur_change = '-' : cur_change = '+') : (!adding ? cur_change = '-' : cur_change = '+')); + /* Quickly determine if we have 'flipped' from + to -, + * or - to +, to prevent unneccessary +/- chars in the + * output string that waste bandwidth + */ + if (cur_change != old_change) + modebounce += cur_change; + old_change = cur_change; + /* Add the mode character to the output string */ + modebounce += mh->GetModeChar(); + /* We got a parameter back from ModeHandler::ModeSet, + * are we supposed to be sending one out right now? + */ + if (ret.second.length()) + { + if (mh->GetNumParams(cur_change == '+') > 0) + /* Yes we're supposed to be sending out + * the parameter. Make sure it goes + */ + newparams.push_back(ret.second); + } + } + break; + } + } + + /* Update the parameters for FMODE with the new 'bounced' string */ + newparams[2] = modebounce; + /* Only send it back the way it came, no need to send it anywhere else */ + Utils->DoOneToOne(this->Instance->Config->ServerName,"FMODE",newparams,sourceserv); + } + else + { + /* The server was ulined, but something iffy is up with the TS. + * Sound the alarm bells! + */ + if ((this->Instance->ULine(sourceserv.c_str())) && (TS > ourTS)) + { + this->Instance->WriteOpers("\2WARNING!\2 U-Lined server '%s' has bad TS for '%s' (accepted change): \2SYNC YOUR CLOCKS\2 to avoid this notice",sourceserv.c_str(),params[0].c_str()); + } + /* Allow the mode, route it to either server or user command handling */ + if (smode) + this->Instance->SendMode(modelist,n,who); + else + this->Instance->CallCommandHandler("MODE", modelist, n, who); + /* HOT POTATO! PASS IT ON! */ + Utils->DoOneToAllButSender(source,"FMODE",params,sourceserv); + } + /* Are we supposed to free the userrec? */ + if (smode) + DELETE(who); + + return true; +} + +/** FTOPIC command */ +bool TreeSocket::ForceTopic(const std::string &source, std::deque<std::string> ¶ms) +{ + if (params.size() != 4) + return true; + time_t ts = atoi(params[1].c_str()); + std::string nsource = source; + chanrec* c = this->Instance->FindChan(params[0]); + if (c) + { + if ((ts >= c->topicset) || (!*c->topic)) + { + std::string oldtopic = c->topic; + strlcpy(c->topic,params[3].c_str(),MAXTOPIC); + strlcpy(c->setby,params[2].c_str(),NICKMAX-1); + c->topicset = ts; + /* if the topic text is the same as the current topic, + * dont bother to send the TOPIC command out, just silently + * update the set time and set nick. + */ + if (oldtopic != params[3]) + { + userrec* user = this->Instance->FindNick(source); + if (!user) + { + c->WriteChannelWithServ(source.c_str(), "TOPIC %s :%s", c->name, c->topic); + } + else + { + c->WriteChannel(user, "TOPIC %s :%s", c->name, c->topic); + nsource = user->server; + } + /* all done, send it on its way */ + params[3] = ":" + params[3]; + Utils->DoOneToAllButSender(source,"FTOPIC",params,nsource); + } + } + + } + return true; +} + +/** FJOIN, similar to TS6 SJOIN, but not quite. */ +bool TreeSocket::ForceJoin(const std::string &source, std::deque<std::string> ¶ms) +{ + /* 1.1 FJOIN works as follows: + * + * Each FJOIN is sent along with a timestamp, and the side with the lowest + * timestamp 'wins'. From this point on we will refer to this side as the + * winner. The side with the higher timestamp loses, from this point on we + * will call this side the loser or losing side. This should be familiar to + * anyone who's dealt with dreamforge or TS6 before. + * + * When two sides of a split heal and this occurs, the following things + * will happen: + * + * If the timestamps are exactly equal, both sides merge their privilages + * and users, as in InspIRCd 1.0 and ircd2.8. The channels have not been + * re-created during a split, this is safe to do. + * + * + * If the timestamps are NOT equal, the losing side removes all privilage + * modes from all of its users that currently exist in the channel, before + * introducing new users into the channel which are listed in the FJOIN + * command's parameters. This means, all modes +ohv, and privilages added + * by modules, such as +qa. The losing side then LOWERS its timestamp value + * of the channel to match that of the winning side, and the modes of the + * users of the winning side are merged in with the losing side. The loser + * then sends out a set of FMODE commands which 'confirm' that it just + * removed all privilage modes from its existing users, which allows for + * services packages to still work correctly without needing to know the + * timestamping rules which InspIRCd follows. In TS6 servers this is always + * a problem, and services packages must contain code which explicitly + * behaves as TS6 does, removing ops from the losing side of a split where + * neccessary within its internal records, as this state information is + * not explicitly echoed out in that protocol. + * + * The winning side on the other hand will ignore all user modes from the + * losing side, so only its own modes get applied. Life is simple for those + * who succeed at internets. :-) + * + * NOTE: Unlike TS6 and dreamforge and other protocols which have SJOIN, + * FJOIN does not contain the simple-modes such as +iklmnsp. Why not, + * you ask? Well, quite simply because we don't need to. They'll be sent + * after the FJOIN by FMODE, and FMODE is timestamped, so in the event + * the losing side sends any modes for the channel which shouldnt win, + * they wont as their timestamp will be too high :-) + */ + + if (params.size() < 3) + return true; + + char first[MAXBUF]; /* The first parameter of the mode command */ + char modestring[MAXBUF]; /* The mode sequence (2nd parameter) of the mode command */ + char* mode_users[127]; /* The values used by the mode command */ + memset(&mode_users,0,sizeof(mode_users)); /* Initialize mode parameters */ + mode_users[0] = first; /* Set this up to be our on-stack value */ + mode_users[1] = modestring; /* Same here as above */ + strcpy(modestring,"+"); /* Initialize the mode sequence to just '+' */ + unsigned int modectr = 2; /* Pointer to the third mode parameter (e.g. the one after the +-sequence) */ + + userrec* who = NULL; /* User we are currently checking */ + std::string channel = params[0]; /* Channel name, as a string */ + time_t TS = atoi(params[1].c_str()); /* Timestamp given to us for remote side */ + bool created = false; + + /* Try and find the channel */ + chanrec* chan = this->Instance->FindChan(channel); + + /* Initialize channel name in the mode parameters */ + strlcpy(mode_users[0],channel.c_str(),MAXBUF); + + /* default TS is a high value, which if we dont have this + * channel will let the other side apply their modes. + */ + time_t ourTS = Instance->Time(true)+600; + /* Does this channel exist? if it does, get its REAL timestamp */ + if (chan) + ourTS = chan->age; + else + created = true; /* don't perform deops, and set TS to correct time after processing. */ + /* In 1.1, if they have the newer channel, we immediately clear + * all status modes from our users. We then accept their modes. + * If WE have the newer channel its the other side's job to do this. + * Note that this causes the losing server to send out confirming + * FMODE lines. + */ + if (ourTS > TS) + { + std::deque<std::string> param_list; + /* Lower the TS here */ + if (Utils->AnnounceTSChange && chan) + chan->WriteChannelWithServ(Instance->Config->ServerName, + "NOTICE %s :TS for %s changed from %lu to %lu", chan->name, chan->name, ourTS, TS); + ourTS = TS; + /* Zap all the privilage modes on our side, if the channel exists here */ + if (!created) + { + param_list.push_back(channel); + /* Do this first! */ + chan->age = TS; + this->RemoveStatus(Instance->Config->ServerName, param_list); + } + } + /* Put the final parameter of the FJOIN into a tokenstream ready to split it */ + irc::tokenstream users(params[2]); + std::string item = "*"; + /* do this first, so our mode reversals are correctly received by other servers + * if there is a TS collision. + */ + params[2] = ":" + params[2]; + Utils->DoOneToAllButSender(source,"FJOIN",params,source); + /* Now, process every 'prefixes,nick' pair */ + while (item != "") + { + /* Find next user */ + item = users.GetToken(); + const char* usr = item.c_str(); + /* Safety check just to make sure someones not sent us an FJOIN full of spaces + * (is this even possible?) */ + if (usr && *usr) + { + const char* permissions = usr; + int ntimes = 0; + char* nm = new char[MAXBUF]; + char* tnm = nm; + /* Iterate through all the prefix values, convert them from prefixes + * to mode letters, and append them to the mode sequence + */ + while ((*permissions) && (*permissions != ',') && (ntimes < MAXBUF)) + { + ModeHandler* mh = Instance->Modes->FindPrefix(*permissions); + if (mh) + { + /* This is a valid prefix */ + ntimes++; + *tnm++ = mh->GetModeChar(); + } + else + { + /* Not a valid prefix... + * danger bill bobbertson! (that's will robinsons older brother ;-) ...) + */ + this->Instance->WriteOpers("ERROR: We received a user with an unknown prefix '%c'. Closed connection to avoid a desync.",*permissions); + this->WriteLine(std::string("ERROR :Invalid prefix '")+(*permissions)+"' in FJOIN"); + return false; + } + usr++; + permissions++; + } + /* Null terminate modes */ + *tnm = 0; + /* Advance past the comma, to the nick */ + usr++; + /* Check the user actually exists */ + who = this->Instance->FindNick(usr); + if (who) + { + /* Did they get any modes? How many times? */ + strlcat(modestring, nm, MAXBUF); + for (int k = 0; k < ntimes; k++) + mode_users[modectr++] = strdup(usr); + /* Free temporary buffer used for mode sequence */ + delete[] nm; + /* Check that the user's 'direction' is correct + * based on the server sending the FJOIN. We must + * check each nickname in turn, because the origin of + * the FJOIN may be different to the origin of the nicks + * in the command itself. + */ + TreeServer* route_back_again = Utils->BestRouteTo(who->server); + if ((!route_back_again) || (route_back_again->GetSocket() != this)) + { + /* Oh dear oh dear. */ + continue; + } + /* Finally, we can actually place the user into the channel. + * We're sure its right. Final answer, phone a friend. + */ + chanrec::JoinUser(this->Instance, who, channel.c_str(), true, ""); + /* Have we already queued up MAXMODES modes with parameters + * (+qaohv) ready to be sent to the server? + */ + if (modectr >= (MAXMODES-1)) + { + /* Only actually give the users any status if we lost + * the FJOIN or drew (equal timestamps). + * It isn't actually possible for ourTS to be > TS here, + * only possible to actually have ourTS == TS, or + * ourTS < TS, because if we lost, we already lowered + * our TS above before we entered this loop. We only + * check >= as a safety measure, in case someone stuffed + * up. If someone DID stuff up, it was most likely me. + * Note: I do not like baseball bats in the face... + */ + if (ourTS >= TS) + { + this->Instance->SendMode((const char**)mode_users,modectr,who); + + /* Something stuffed up, and for some reason, the timestamp is + * NOT lowered right now and should be. Lower it. Usually this + * code won't be executed, doubtless someone will remove it some + * day soon. + */ + if (ourTS > TS) + { + Instance->Log(DEFAULT,"Channel TS for %s changed from %lu to %lu",chan->name,ourTS,TS); + chan->age = TS; + ourTS = TS; + } + } + + /* Reset all this back to defaults, and + * free any ram we have left allocated. + */ + strcpy(mode_users[1],"+"); + for (unsigned int f = 2; f < modectr; f++) + free(mode_users[f]); + modectr = 2; + } + } + else + { + /* Remember to free this */ + delete[] nm; + /* If we got here, there's a nick in FJOIN which doesnt exist on this server. + * We don't try to process the nickname here (that WOULD cause a segfault because + * we'd be playing with null pointers) however, we DO pass the nickname on, just + * in case somehow we're desynched, so that other users which might be able to see + * the nickname get their fair chance to process it. + */ + Instance->Log(SPARSE,"Warning! Invalid user in FJOIN to channel %s IGNORED", channel.c_str()); + continue; + } + } + } + + /* there werent enough modes built up to flush it during FJOIN, + * or, there are a number left over. flush them out. + */ + if ((modectr > 2) && (who) && (chan)) + { + if (ourTS >= TS) + { + /* Our channel is newer than theirs. Evil deeds must be afoot. */ + this->Instance->SendMode((const char**)mode_users,modectr,who); + /* Yet again, we can't actually get a true value here, if everything else + * is working as it should. + */ + if (ourTS > TS) + { + Instance->Log(DEFAULT,"Channel TS for %s changed from %lu to %lu",chan->name,ourTS,TS); + chan->age = TS; + ourTS = TS; + } + } + + /* Free anything we have left to free */ + for (unsigned int f = 2; f < modectr; f++) + free(mode_users[f]); + } + /* if we newly created the channel, set it's TS properly. */ + if (created) + { + /* find created channel .. */ + chan = this->Instance->FindChan(channel); + if (chan) + /* w00t said this shouldnt be needed but it is. + * This isnt strictly true, as chan can be NULL + * if a nick collision has occured and therefore + * the channel was never created. + */ + chan->age = TS; + } + /* All done. That wasnt so bad was it, you can wipe + * the sweat from your forehead now. :-) + */ + return true; +} + +/** NICK command */ +bool TreeSocket::IntroduceClient(const std::string &source, std::deque<std::string> ¶ms) +{ + if (params.size() < 8) + return true; + if (params.size() > 8) + { + this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+params[1]+" :Invalid client introduction ("+params[1]+"?)"); + return true; + } + // NICK age nick host dhost ident +modes ip :gecos + // 0 1 2 3 4 5 6 7 + time_t age = atoi(params[0].c_str()); + + const char* tempnick = params[1].c_str(); + Instance->Log(DEBUG,"New remote client %s",tempnick); + + user_hash::iterator iter = this->Instance->clientlist->find(tempnick); + + if (iter != this->Instance->clientlist->end()) + { + // nick collision + this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+tempnick+" :Nickname collision"); + userrec::QuitUser(this->Instance, iter->second, "Nickname collision"); + return true; + } + + userrec* _new = new userrec(this->Instance); + (*(this->Instance->clientlist))[tempnick] = _new; + _new->SetFd(FD_MAGIC_NUMBER); + strlcpy(_new->nick, tempnick,NICKMAX-1); + strlcpy(_new->host, params[2].c_str(),63); + strlcpy(_new->dhost, params[3].c_str(),63); + _new->server = this->Instance->FindServerNamePtr(source.c_str()); + strlcpy(_new->ident, params[4].c_str(),IDENTMAX); + strlcpy(_new->fullname, params[7].c_str(),MAXGECOS); + _new->registered = REG_ALL; + _new->signon = age; + + /* + * we need to remove the + from the modestring, so we can do our stuff + */ + std::string::size_type pos_after_plus = params[5].find_first_not_of('+'); + if (pos_after_plus != std::string::npos) + params[5] = params[5].substr(pos_after_plus); + + for (std::string::iterator v = params[5].begin(); v != params[5].end(); v++) + { + _new->modes[(*v)-65] = 1; + /* For each mode thats set, increase counter */ + ModeHandler* mh = Instance->Modes->FindMode(*v, MODETYPE_USER); + if (mh) + mh->ChangeCount(1); + } + + /* now we've done with modes processing, put the + back for remote servers */ + params[5] = "+" + params[5]; + +#ifdef SUPPORT_IP6LINKS + if (params[6].find_first_of(":") != std::string::npos) + _new->SetSockAddr(AF_INET6, params[6].c_str(), 0); + else +#endif + _new->SetSockAddr(AF_INET, params[6].c_str(), 0); + + Instance->AddGlobalClone(_new); + this->Instance->SNO->WriteToSnoMask('C',"Client connecting at %s: %s!%s@%s [%s]",_new->server,_new->nick,_new->ident,_new->host, _new->GetIPString()); + + params[7] = ":" + params[7]; + Utils->DoOneToAllButSender(source,"NICK", params, source); + + // Increment the Source Servers User Count.. + TreeServer* SourceServer = Utils->FindServer(source); + if (SourceServer) + { + SourceServer->AddUserCount(); + } + + FOREACH_MOD_I(Instance,I_OnPostConnect,OnPostConnect(_new)); + + return true; +} + +/** Send one or more FJOINs for a channel of users. + * If the length of a single line is more than 480-NICKMAX + * in length, it is split over multiple lines. + */ +void TreeSocket::SendFJoins(TreeServer* Current, chanrec* c) +{ + std::string buffer; + char list[MAXBUF]; + std::string individual_halfops = std::string(":")+this->Instance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age); + + size_t dlen, curlen; + dlen = curlen = snprintf(list,MAXBUF,":%s FJOIN %s %lu",this->Instance->Config->ServerName,c->name,(unsigned long)c->age); + int numusers = 0; + char* ptr = list + dlen; + + CUList *ulist = c->GetUsers(); + std::string modes = ""; + std::string params = ""; + + for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++) + { + // The first parameter gets a : before it + size_t ptrlen = snprintf(ptr, MAXBUF, " %s%s,%s", !numusers ? ":" : "", c->GetAllPrefixChars(i->second), i->second->nick); + + curlen += ptrlen; + ptr += ptrlen; + + numusers++; + + if (curlen > (480-NICKMAX)) + { + buffer.append(list).append("\r\n"); + dlen = curlen = snprintf(list,MAXBUF,":%s FJOIN %s %lu",this->Instance->Config->ServerName,c->name,(unsigned long)c->age); + ptr = list + dlen; + ptrlen = 0; + numusers = 0; + } + } + + if (numusers) + buffer.append(list).append("\r\n"); + + /* Sorry for the hax. Because newly created channels assume +nt, + * if this channel doesnt have +nt, explicitly send -n and -t for the missing modes. + */ + bool inverted = false; + if (!c->IsModeSet('n')) + { + modes.append("-n"); + inverted = true; + } + if (!c->IsModeSet('t')) + { + modes.append("-t"); + inverted = true; + } + if (inverted) + { + modes.append("+"); + } + + for (BanList::iterator b = c->bans.begin(); b != c->bans.end(); b++) + { + modes.append("b"); + params.append(" ").append(b->data); + if (params.length() >= MAXMODES) + { + /* Wrap at MAXMODES */ + buffer.append(":").append(this->Instance->Config->ServerName).append(" FMODE ").append(c->name).append(" ").append(ConvToStr(c->age)).append(" +").append(modes).append(params).append("\r\n"); + modes = ""; + params = ""; + } + } + buffer.append(":").append(this->Instance->Config->ServerName).append(" FMODE ").append(c->name).append(" ").append(ConvToStr(c->age)).append(" +").append(c->ChanModes(true)); + + /* Only send these if there are any */ + if (!modes.empty()) + buffer.append("\r\n").append(":").append(this->Instance->Config->ServerName).append(" FMODE ").append(c->name).append(" ").append(ConvToStr(c->age)).append(" +").append(modes).append(params); + + this->WriteLine(buffer); +} + +/** Send G, Q, Z and E lines */ +void TreeSocket::SendXLines(TreeServer* Current) +{ + char data[MAXBUF]; + std::string buffer; + std::string n = this->Instance->Config->ServerName; + const char* sn = n.c_str(); + /* Yes, these arent too nice looking, but they get the job done */ + for (std::vector<ZLine*>::iterator i = Instance->XLines->zlines.begin(); i != Instance->XLines->zlines.end(); i++) + { + snprintf(data,MAXBUF,":%s ADDLINE Z %s %s %lu %lu :%s\r\n",sn,(*i)->ipaddr,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason); + buffer.append(data); + } + for (std::vector<QLine*>::iterator i = Instance->XLines->qlines.begin(); i != Instance->XLines->qlines.end(); i++) + { + snprintf(data,MAXBUF,":%s ADDLINE Q %s %s %lu %lu :%s\r\n",sn,(*i)->nick,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason); + buffer.append(data); + } + for (std::vector<GLine*>::iterator i = Instance->XLines->glines.begin(); i != Instance->XLines->glines.end(); i++) + { + snprintf(data,MAXBUF,":%s ADDLINE G %s@%s %s %lu %lu :%s\r\n",sn,(*i)->identmask,(*i)->hostmask,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason); + buffer.append(data); + } + for (std::vector<ELine*>::iterator i = Instance->XLines->elines.begin(); i != Instance->XLines->elines.end(); i++) + { + snprintf(data,MAXBUF,":%s ADDLINE E %s@%s %s %lu %lu :%s\r\n",sn,(*i)->identmask,(*i)->hostmask,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason); + buffer.append(data); + } + for (std::vector<ZLine*>::iterator i = Instance->XLines->pzlines.begin(); i != Instance->XLines->pzlines.end(); i++) + { + snprintf(data,MAXBUF,":%s ADDLINE Z %s %s %lu %lu :%s\r\n",sn,(*i)->ipaddr,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason); + buffer.append(data); + } + for (std::vector<QLine*>::iterator i = Instance->XLines->pqlines.begin(); i != Instance->XLines->pqlines.end(); i++) + { + snprintf(data,MAXBUF,":%s ADDLINE Q %s %s %lu %lu :%s\r\n",sn,(*i)->nick,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason); + buffer.append(data); + } + for (std::vector<GLine*>::iterator i = Instance->XLines->pglines.begin(); i != Instance->XLines->pglines.end(); i++) + { + snprintf(data,MAXBUF,":%s ADDLINE G %s@%s %s %lu %lu :%s\r\n",sn,(*i)->identmask,(*i)->hostmask,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason); + buffer.append(data); + } + for (std::vector<ELine*>::iterator i = Instance->XLines->pelines.begin(); i != Instance->XLines->pelines.end(); i++) + { + snprintf(data,MAXBUF,":%s ADDLINE E %s@%s %s %lu %lu :%s\r\n",sn,(*i)->identmask,(*i)->hostmask,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason); + buffer.append(data); + } + + if (!buffer.empty()) + this->WriteLine(buffer); +} + +/** Send channel modes and topics */ +void TreeSocket::SendChannelModes(TreeServer* Current) +{ + char data[MAXBUF]; + std::deque<std::string> list; + std::string n = this->Instance->Config->ServerName; + const char* sn = n.c_str(); + for (chan_hash::iterator c = this->Instance->chanlist->begin(); c != this->Instance->chanlist->end(); c++) + { + SendFJoins(Current, c->second); + if (*c->second->topic) + { + snprintf(data,MAXBUF,":%s FTOPIC %s %lu %s :%s",sn,c->second->name,(unsigned long)c->second->topicset,c->second->setby,c->second->topic); + this->WriteLine(data); + } + FOREACH_MOD_I(this->Instance,I_OnSyncChannel,OnSyncChannel(c->second,(Module*)Utils->Creator,(void*)this)); + list.clear(); + c->second->GetExtList(list); + for (unsigned int j = 0; j < list.size(); j++) + { + FOREACH_MOD_I(this->Instance,I_OnSyncChannelMetaData,OnSyncChannelMetaData(c->second,(Module*)Utils->Creator,(void*)this,list[j])); + } + } +} + +/** send all users and their oper state/modes */ +void TreeSocket::SendUsers(TreeServer* Current) +{ + char data[MAXBUF]; + std::deque<std::string> list; + std::string dataline; + for (user_hash::iterator u = this->Instance->clientlist->begin(); u != this->Instance->clientlist->end(); u++) + { + if (u->second->registered == REG_ALL) + { + snprintf(data,MAXBUF,":%s NICK %lu %s %s %s %s +%s %s :%s",u->second->server,(unsigned long)u->second->age,u->second->nick,u->second->host,u->second->dhost,u->second->ident,u->second->FormatModes(),u->second->GetIPString(),u->second->fullname); + this->WriteLine(data); + if (*u->second->oper) + { + snprintf(data,MAXBUF,":%s OPERTYPE %s", u->second->nick, u->second->oper); + this->WriteLine(data); + } + if (*u->second->awaymsg) + { + snprintf(data,MAXBUF,":%s AWAY :%s", u->second->nick, u->second->awaymsg); + this->WriteLine(data); + } + FOREACH_MOD_I(this->Instance,I_OnSyncUser,OnSyncUser(u->second,(Module*)Utils->Creator,(void*)this)); + list.clear(); + u->second->GetExtList(list); + + for (unsigned int j = 0; j < list.size(); j++) + { + FOREACH_MOD_I(this->Instance,I_OnSyncUserMetaData,OnSyncUserMetaData(u->second,(Module*)Utils->Creator,(void*)this,list[j])); + } + } + } +} + +/** This function is called when we want to send a netburst to a local + * server. There is a set order we must do this, because for example + * users require their servers to exist, and channels require their + * users to exist. You get the idea. + */ +void TreeSocket::DoBurst(TreeServer* s) +{ + std::string burst = "BURST "+ConvToStr(Instance->Time(true)); + std::string endburst = "ENDBURST"; + // Because by the end of the netburst, it could be gone! + std::string name = s->GetName(); + this->Instance->SNO->WriteToSnoMask('l',"Bursting to \2"+name+"\2."); + this->WriteLine(burst); + /* send our version string */ + this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" VERSION :"+this->Instance->GetVersionString()); + /* Send server tree */ + this->SendServers(Utils->TreeRoot,s,1); + /* Send users and their oper status */ + this->SendUsers(s); + /* Send everything else (channel modes, xlines etc) */ + this->SendChannelModes(s); + this->SendXLines(s); + FOREACH_MOD_I(this->Instance,I_OnSyncOtherMetaData,OnSyncOtherMetaData((Module*)Utils->Creator,(void*)this)); + this->WriteLine(endburst); + this->Instance->SNO->WriteToSnoMask('l',"Finished bursting to \2"+name+"\2."); +} + +/** This function is called when we receive data from a remote + * server. We buffer the data in a std::string (it doesnt stay + * there for long), reading using InspSocket::Read() which can + * read up to 16 kilobytes in one operation. + * + * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES + * THE SOCKET OBJECT FOR US. + */ +bool TreeSocket::OnDataReady() +{ + char* data = this->Read(); + /* Check that the data read is a valid pointer and it has some content */ + if (data && *data) + { + this->in_buffer.append(data); + /* While there is at least one new line in the buffer, + * do something useful (we hope!) with it. + */ + while (in_buffer.find("\n") != std::string::npos) + { + std::string ret = in_buffer.substr(0,in_buffer.find("\n")-1); + in_buffer = in_buffer.substr(in_buffer.find("\n")+1,in_buffer.length()-in_buffer.find("\n")); + /* Use rfind here not find, as theres more + * chance of the \r being near the end of the + * string, not the start. + */ + if (ret.find("\r") != std::string::npos) + ret = in_buffer.substr(0,in_buffer.find("\r")-1); + /* Process this one, abort if it + * didnt return true. + */ + if (!this->ProcessLine(ret)) + { + return false; + } + } + return true; + } + /* EAGAIN returns an empty but non-NULL string, so this + * evaluates to TRUE for EAGAIN but to FALSE for EOF. + */ + return (data && !*data); +} + +int TreeSocket::WriteLine(std::string line) +{ + Instance->Log(DEBUG, "-> %s", line.c_str()); + line.append("\r\n"); + return this->Write(line); +} + +/* Handle ERROR command */ +bool TreeSocket::Error(std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return false; + this->Instance->SNO->WriteToSnoMask('l',"ERROR from %s: %s",(InboundServerName != "" ? InboundServerName.c_str() : myhost.c_str()),params[0].c_str()); + /* we will return false to cause the socket to close. */ + return false; +} + +/** remote MOTD. leet, huh? */ +bool TreeSocket::Motd(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() > 0) + { + if (this->Instance->MatchText(this->Instance->Config->ServerName, params[0])) + { + /* It's for our server */ + string_list results; + userrec* source = this->Instance->FindNick(prefix); + + if (source) + { + std::deque<std::string> par; + par.push_back(prefix); + par.push_back(""); + + if (!Instance->Config->MOTD.size()) + { + par[1] = std::string("::")+Instance->Config->ServerName+" 422 "+source->nick+" :Message of the day file is missing."; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + return true; + } + + par[1] = std::string("::")+Instance->Config->ServerName+" 375 "+source->nick+" :"+Instance->Config->ServerName+" message of the day"; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + + for (unsigned int i = 0; i < Instance->Config->MOTD.size(); i++) + { + par[1] = std::string("::")+Instance->Config->ServerName+" 372 "+source->nick+" :- "+Instance->Config->MOTD[i]; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + } + + par[1] = std::string("::")+Instance->Config->ServerName+" 376 "+source->nick+" End of message of the day."; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + } + } + else + { + /* Pass it on */ + userrec* source = this->Instance->FindNick(prefix); + if (source) + Utils->DoOneToOne(prefix, "MOTD", params, params[0]); + } + } + return true; +} + +/** remote ADMIN. leet, huh? */ +bool TreeSocket::Admin(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() > 0) + { + if (this->Instance->MatchText(this->Instance->Config->ServerName, params[0])) + { + /* It's for our server */ + string_list results; + userrec* source = this->Instance->FindNick(prefix); + if (source) + { + std::deque<std::string> par; + par.push_back(prefix); + par.push_back(""); + par[1] = std::string("::")+Instance->Config->ServerName+" 256 "+source->nick+" :Administrative info for "+Instance->Config->ServerName; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + par[1] = std::string("::")+Instance->Config->ServerName+" 257 "+source->nick+" :Name - "+Instance->Config->AdminName; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + par[1] = std::string("::")+Instance->Config->ServerName+" 258 "+source->nick+" :Nickname - "+Instance->Config->AdminNick; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + par[1] = std::string("::")+Instance->Config->ServerName+" 258 "+source->nick+" :E-Mail - "+Instance->Config->AdminEmail; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + } + } + else + { + /* Pass it on */ + userrec* source = this->Instance->FindNick(prefix); + if (source) + Utils->DoOneToOne(prefix, "ADMIN", params, params[0]); + } + } + return true; +} + +bool TreeSocket::Stats(const std::string &prefix, std::deque<std::string> ¶ms) +{ + /* Get the reply to a STATS query if it matches this servername, + * and send it back as a load of PUSH queries + */ + if (params.size() > 1) + { + if (this->Instance->MatchText(this->Instance->Config->ServerName, params[1])) + { + /* It's for our server */ + string_list results; + userrec* source = this->Instance->FindNick(prefix); + if (source) + { + std::deque<std::string> par; + par.push_back(prefix); + par.push_back(""); + DoStats(this->Instance, *(params[0].c_str()), source, results); + for (size_t i = 0; i < results.size(); i++) + { + par[1] = "::" + results[i]; + Utils->DoOneToOne(this->Instance->Config->ServerName, "PUSH",par, source->server); + } + } + } + else + { + /* Pass it on */ + userrec* source = this->Instance->FindNick(prefix); + if (source) + Utils->DoOneToOne(prefix, "STATS", params, params[1]); + } + } + return true; +} + + +/** Because the core won't let users or even SERVERS set +o, + * we use the OPERTYPE command to do this. + */ +bool TreeSocket::OperType(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() != 1) + return true; + std::string opertype = params[0]; + userrec* u = this->Instance->FindNick(prefix); + if (u) + { + u->modes[UM_OPERATOR] = 1; + this->Instance->all_opers.push_back(u); + strlcpy(u->oper,opertype.c_str(),NICKMAX-1); + Utils->DoOneToAllButSender(u->nick,"OPERTYPE",params,u->server); + this->Instance->SNO->WriteToSnoMask('o',"From %s: User %s (%s@%s) is now an IRC operator of type %s",u->server, u->nick,u->ident,u->host,irc::Spacify(opertype.c_str())); + } + return true; +} + +/** Because Andy insists that services-compatible servers must + * implement SVSNICK and SVSJOIN, that's exactly what we do :p + */ +bool TreeSocket::ForceNick(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 3) + return true; + + userrec* u = this->Instance->FindNick(params[0]); + + if (u) + { + Utils->DoOneToAllButSender(prefix,"SVSNICK",params,prefix); + if (IS_LOCAL(u)) + { + std::deque<std::string> par; + par.push_back(params[1]); + if (!u->ForceNickChange(params[1].c_str())) + { + userrec::QuitUser(this->Instance, u, "Nickname collision"); + return true; + } + u->age = atoi(params[2].c_str()); + } + } + return true; +} + +/* + * Remote SQUIT (RSQUIT). Routing works similar to SVSNICK: Route it to the server that the target is connected to locally, + * then let that server do the dirty work (squit it!). Example: + * A -> B -> C -> D: oper on A squits D, A routes to B, B routes to C, C notices D connected locally, kills it. -- w00t + */ +bool TreeSocket::RemoteSquit(const std::string &prefix, std::deque<std::string> ¶ms) +{ + /* ok.. :w00t RSQUIT jupe.barafranca.com :reason here */ + if (params.size() < 2) + return true; + + TreeServer* s = Utils->FindServerMask(params[0]); + + if (s) + { + if (s == Utils->TreeRoot) + { + this->Instance->SNO->WriteToSnoMask('l',"What the fuck, I recieved a remote SQUIT for myself? :< (from %s", prefix.c_str()); + return true; + } + + TreeSocket* sock = s->GetSocket(); + + if (sock) + { + /* it's locally connected, KILL IT! */ + Instance->SNO->WriteToSnoMask('l',"RSQUIT: Server \002%s\002 removed from network by %s: %s", params[0].c_str(), prefix.c_str(), params[1].c_str()); + sock->Squit(s,"Server quit by " + prefix + ": " + params[1]); + Instance->SE->DelFd(sock); + sock->Close(); + delete sock; + } + else + { + /* route the rsquit */ + params[1] = ":" + params[1]; + Utils->DoOneToOne(prefix, "RSQUIT", params, params[0]); + } + } + else + { + /* mother fucker! it doesn't exist */ + } + + return true; +} + +bool TreeSocket::ServiceJoin(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 2) + return true; + + userrec* u = this->Instance->FindNick(params[0]); + + if (u) + { + /* only join if it's local, otherwise just pass it on! */ + if (IS_LOCAL(u)) + chanrec::JoinUser(this->Instance, u, params[1].c_str(), false); + Utils->DoOneToAllButSender(prefix,"SVSJOIN",params,prefix); + } + return true; +} + +bool TreeSocket::RemoteRehash(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return false; + + std::string servermask = params[0]; + + if (this->Instance->MatchText(this->Instance->Config->ServerName,servermask)) + { + this->Instance->SNO->WriteToSnoMask('l',"Remote rehash initiated by \002"+prefix+"\002."); + this->Instance->RehashServer(); + Utils->ReadConfiguration(false); + InitializeDisabledCommands(Instance->Config->DisabledCommands, Instance); + } + Utils->DoOneToAllButSender(prefix,"REHASH",params,prefix); + return true; +} + +bool TreeSocket::RemoteKill(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() != 2) + return true; + + std::string nick = params[0]; + userrec* u = this->Instance->FindNick(prefix); + userrec* who = this->Instance->FindNick(nick); + + if (who) + { + /* Prepend kill source, if we don't have one */ + std::string sourceserv = prefix; + if (u) + { + sourceserv = u->server; + } + if (*(params[1].c_str()) != '[') + { + params[1] = "[" + sourceserv + "] Killed (" + params[1] +")"; + } + std::string reason = params[1]; + params[1] = ":" + params[1]; + Utils->DoOneToAllButSender(prefix,"KILL",params,sourceserv); + who->Write(":%s KILL %s :%s (%s)", sourceserv.c_str(), who->nick, sourceserv.c_str(), reason.c_str()); + userrec::QuitUser(this->Instance,who,reason); + } + return true; +} + +bool TreeSocket::LocalPong(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return true; + + if (params.size() == 1) + { + TreeServer* ServerSource = Utils->FindServer(prefix); + if (ServerSource) + { + ServerSource->SetPingFlag(); + } + } + else + { + std::string forwardto = params[1]; + if (forwardto == this->Instance->Config->ServerName) + { + /* + * this is a PONG for us + * if the prefix is a user, check theyre local, and if they are, + * dump the PONG reply back to their fd. If its a server, do nowt. + * Services might want to send these s->s, but we dont need to yet. + */ + userrec* u = this->Instance->FindNick(prefix); + if (u) + { + u->WriteServ("PONG %s %s",params[0].c_str(),params[1].c_str()); + } + } + else + { + // not for us, pass it on :) + Utils->DoOneToOne(prefix,"PONG",params,forwardto); + } + } + + return true; +} + +bool TreeSocket::MetaData(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 3) + return true; + TreeServer* ServerSource = Utils->FindServer(prefix); + if (ServerSource) + { + if (params[0] == "*") + { + FOREACH_MOD_I(this->Instance,I_OnDecodeMetaData,OnDecodeMetaData(TYPE_OTHER,NULL,params[1],params[2])); + } + else if (*(params[0].c_str()) == '#') + { + chanrec* c = this->Instance->FindChan(params[0]); + if (c) + { + FOREACH_MOD_I(this->Instance,I_OnDecodeMetaData,OnDecodeMetaData(TYPE_CHANNEL,c,params[1],params[2])); + } + } + else if (*(params[0].c_str()) != '#') + { + userrec* u = this->Instance->FindNick(params[0]); + if (u) + { + FOREACH_MOD_I(this->Instance,I_OnDecodeMetaData,OnDecodeMetaData(TYPE_USER,u,params[1],params[2])); + } + } + } + + params[2] = ":" + params[2]; + Utils->DoOneToAllButSender(prefix,"METADATA",params,prefix); + return true; +} + +bool TreeSocket::ServerVersion(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return true; + + TreeServer* ServerSource = Utils->FindServer(prefix); + + if (ServerSource) + { + ServerSource->SetVersion(params[0]); + } + params[0] = ":" + params[0]; + Utils->DoOneToAllButSender(prefix,"VERSION",params,prefix); + return true; +} + +bool TreeSocket::ChangeHost(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return true; + userrec* u = this->Instance->FindNick(prefix); + + if (u) + { + u->ChangeDisplayedHost(params[0].c_str()); + Utils->DoOneToAllButSender(prefix,"FHOST",params,u->server); + } + return true; +} + +bool TreeSocket::AddLine(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 6) + return true; + bool propogate = false; + if (!this->bursting) + Utils->lines_to_apply = 0; + switch (*(params[0].c_str())) + { + case 'Z': + propogate = Instance->XLines->add_zline(atoi(params[4].c_str()), params[2].c_str(), params[5].c_str(), params[1].c_str()); + Instance->XLines->zline_set_creation_time(params[1].c_str(), atoi(params[3].c_str())); + if (propogate) + Utils->lines_to_apply |= APPLY_ZLINES; + break; + case 'Q': + propogate = Instance->XLines->add_qline(atoi(params[4].c_str()), params[2].c_str(), params[5].c_str(), params[1].c_str()); + Instance->XLines->qline_set_creation_time(params[1].c_str(), atoi(params[3].c_str())); + if (propogate) + Utils->lines_to_apply |= APPLY_QLINES; + break; + case 'E': + propogate = Instance->XLines->add_eline(atoi(params[4].c_str()), params[2].c_str(), params[5].c_str(), params[1].c_str()); + Instance->XLines->eline_set_creation_time(params[1].c_str(), atoi(params[3].c_str())); + break; + case 'G': + propogate = Instance->XLines->add_gline(atoi(params[4].c_str()), params[2].c_str(), params[5].c_str(), params[1].c_str()); + Instance->XLines->gline_set_creation_time(params[1].c_str(), atoi(params[3].c_str())); + if (propogate) + Utils->lines_to_apply |= APPLY_GLINES; + break; + case 'K': + propogate = Instance->XLines->add_kline(atoi(params[4].c_str()), params[2].c_str(), params[5].c_str(), params[1].c_str()); + if (propogate) + Utils->lines_to_apply |= APPLY_KLINES; + break; + default: + /* Just in case... */ + this->Instance->SNO->WriteToSnoMask('x',"\2WARNING\2: Invalid xline type '"+params[0]+"' sent by server "+prefix+", ignored!"); + propogate = false; + break; + } + /* Send it on its way */ + if (propogate) + { + if (atoi(params[4].c_str())) + { + this->Instance->SNO->WriteToSnoMask('x',"%s Added %cLINE on %s to expire in %lu seconds (%s).",prefix.c_str(),*(params[0].c_str()),params[1].c_str(),atoi(params[4].c_str()),params[5].c_str()); + } + else + { + this->Instance->SNO->WriteToSnoMask('x',"%s Added permenant %cLINE on %s (%s).",prefix.c_str(),*(params[0].c_str()),params[1].c_str(),params[5].c_str()); + } + params[5] = ":" + params[5]; + Utils->DoOneToAllButSender(prefix,"ADDLINE",params,prefix); + } + if (!this->bursting) + { + Instance->XLines->apply_lines(Utils->lines_to_apply); + Utils->lines_to_apply = 0; + } + return true; +} + +bool TreeSocket::ChangeName(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return true; + userrec* u = this->Instance->FindNick(prefix); + if (u) + { + u->ChangeName(params[0].c_str()); + params[0] = ":" + params[0]; + Utils->DoOneToAllButSender(prefix,"FNAME",params,u->server); + } + return true; +} + +bool TreeSocket::Whois(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return true; + userrec* u = this->Instance->FindNick(prefix); + if (u) + { + // an incoming request + if (params.size() == 1) + { + userrec* x = this->Instance->FindNick(params[0]); + if ((x) && (IS_LOCAL(x))) + { + userrec* x = this->Instance->FindNick(params[0]); + char signon[MAXBUF]; + char idle[MAXBUF]; + snprintf(signon,MAXBUF,"%lu",(unsigned long)x->signon); + snprintf(idle,MAXBUF,"%lu",(unsigned long)abs((x->idle_lastmsg)-Instance->Time(true))); + std::deque<std::string> par; + par.push_back(prefix); + par.push_back(signon); + par.push_back(idle); + // ours, we're done, pass it BACK + Utils->DoOneToOne(params[0],"IDLE",par,u->server); + } + else + { + // not ours pass it on + Utils->DoOneToOne(prefix,"IDLE",params,x->server); + } + } + else if (params.size() == 3) + { + std::string who_did_the_whois = params[0]; + userrec* who_to_send_to = this->Instance->FindNick(who_did_the_whois); + if ((who_to_send_to) && (IS_LOCAL(who_to_send_to))) + { + // an incoming reply to a whois we sent out + std::string nick_whoised = prefix; + unsigned long signon = atoi(params[1].c_str()); + unsigned long idle = atoi(params[2].c_str()); + if ((who_to_send_to) && (IS_LOCAL(who_to_send_to))) + do_whois(this->Instance,who_to_send_to,u,signon,idle,nick_whoised.c_str()); + } + else + { + // not ours, pass it on + Utils->DoOneToOne(prefix,"IDLE",params,who_to_send_to->server); + } + } + } + return true; +} + +bool TreeSocket::Push(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 2) + return true; + userrec* u = this->Instance->FindNick(params[0]); + if (!u) + return true; + if (IS_LOCAL(u)) + { + u->Write(params[1]); + } + else + { + // continue the raw onwards + params[1] = ":" + params[1]; + Utils->DoOneToOne(prefix,"PUSH",params,u->server); + } + return true; +} + +bool TreeSocket::HandleSetTime(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (!params.size() || !Utils->EnableTimeSync) + return true; + + bool force = false; + + if ((params.size() == 2) && (params[1] == "FORCE")) + force = true; + + time_t rts = atoi(params[0].c_str()); + time_t us = Instance->Time(true); + + if (rts == us) + { + Utils->DoOneToAllButSender(prefix, "TIMESET", params, prefix); + } + else if (force || (rts < us)) + { + int old = Instance->SetTimeDelta(rts - us); + Instance->Log(DEBUG, "%s TS (diff %d) from %s applied (old delta was %d)", (force) ? "Forced" : "Lower", rts - us, prefix.c_str(), old); + + Utils->DoOneToAllButSender(prefix, "TIMESET", params, prefix); + } + else + { + Instance->Log(DEBUG, "Higher TS (diff %d) from %s overridden", us - rts, prefix.c_str()); + + std::deque<std::string> oparams; + oparams.push_back(ConvToStr(us)); + + Utils->DoOneToMany(prefix, "TIMESET", oparams); + } + + return true; +} + +bool TreeSocket::Time(const std::string &prefix, std::deque<std::string> ¶ms) +{ + // :source.server TIME remote.server sendernick + // :remote.server TIME source.server sendernick TS + if (params.size() == 2) + { + // someone querying our time? + if (this->Instance->Config->ServerName == params[0]) + { + userrec* u = this->Instance->FindNick(params[1]); + if (u) + { + params.push_back(ConvToStr(Instance->Time(false))); + params[0] = prefix; + Utils->DoOneToOne(this->Instance->Config->ServerName,"TIME",params,params[0]); + } + } + else + { + // not us, pass it on + userrec* u = this->Instance->FindNick(params[1]); + if (u) + Utils->DoOneToOne(prefix,"TIME",params,params[0]); + } + } + else if (params.size() == 3) + { + // a response to a previous TIME + userrec* u = this->Instance->FindNick(params[1]); + if ((u) && (IS_LOCAL(u))) + { + time_t rawtime = atol(params[2].c_str()); + struct tm * timeinfo; + timeinfo = localtime(&rawtime); + char tms[26]; + snprintf(tms,26,"%s",asctime(timeinfo)); + tms[24] = 0; + u->WriteServ("391 %s %s :%s",u->nick,prefix.c_str(),tms); + } + else + { + if (u) + Utils->DoOneToOne(prefix,"TIME",params,u->server); + } + } + return true; +} + +bool TreeSocket::LocalPing(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return true; + if (params.size() == 1) + { + std::string stufftobounce = params[0]; + this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" PONG "+stufftobounce); + return true; + } + else + { + std::string forwardto = params[1]; + if (forwardto == this->Instance->Config->ServerName) + { + // this is a ping for us, send back PONG to the requesting server + params[1] = params[0]; + params[0] = forwardto; + Utils->DoOneToOne(forwardto,"PONG",params,params[1]); + } + else + { + // not for us, pass it on :) + Utils->DoOneToOne(prefix,"PING",params,forwardto); + } + return true; + } +} + +bool TreeSocket::RemoveStatus(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 1) + return true; + chanrec* c = Instance->FindChan(params[0]); + if (c) + { + irc::modestacker modestack(false); + CUList *ulist = c->GetUsers(); + const char* y[127]; + std::deque<std::string> stackresult; + std::string x; + for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++) + { + std::string modesequence = Instance->Modes->ModeString(i->second, c); + if (modesequence.length()) + { + irc::spacesepstream sep(modesequence); + std::string modeletters = sep.GetToken(); + while (!modeletters.empty()) + { + char mletter = *(modeletters.begin()); + modestack.Push(mletter,sep.GetToken()); + modeletters.erase(modeletters.begin()); + } + } + } + + while (modestack.GetStackedLine(stackresult)) + { + stackresult.push_front(ConvToStr(c->age)); + stackresult.push_front(c->name); + Utils->DoOneToMany(Instance->Config->ServerName, "FMODE", stackresult); + stackresult.erase(stackresult.begin() + 1); + for (size_t z = 0; z < stackresult.size(); z++) + { + y[z] = stackresult[z].c_str(); + } + userrec* n = new userrec(Instance); + n->SetFd(FD_MAGIC_NUMBER); + Instance->SendMode(y, stackresult.size(), n); + delete n; + } + } + return true; +} + +bool TreeSocket::RemoteServer(const std::string &prefix, std::deque<std::string> ¶ms) +{ + if (params.size() < 4) + return false; + std::string servername = params[0]; + std::string password = params[1]; + // hopcount is not used for a remote server, we calculate this ourselves + std::string description = params[3]; + TreeServer* ParentOfThis = Utils->FindServer(prefix); + if (!ParentOfThis) + { + this->WriteLine("ERROR :Protocol error - Introduced remote server from unknown server "+prefix); + return false; + } + TreeServer* CheckDupe = Utils->FindServer(servername); + if (CheckDupe) + { + this->WriteLine("ERROR :Server "+servername+" already exists!"); + this->Instance->SNO->WriteToSnoMask('l',"Server connection from \2"+servername+"\2 denied, already exists"); + return false; + } + TreeServer* Node = new TreeServer(this->Utils,this->Instance,servername,description,ParentOfThis,NULL); + ParentOfThis->AddChild(Node); + params[3] = ":" + params[3]; + Utils->DoOneToAllButSender(prefix,"SERVER",params,prefix); + this->Instance->SNO->WriteToSnoMask('l',"Server \002"+prefix+"\002 introduced server \002"+servername+"\002 ("+description+")"); + return true; +} + +bool TreeSocket::Outbound_Reply_Server(std::deque<std::string> ¶ms) +{ + if (params.size() < 4) + return false; + + irc::string servername = params[0].c_str(); + std::string sname = params[0]; + std::string password = params[1]; + int hops = atoi(params[2].c_str()); + + if (hops) + { + this->WriteLine("ERROR :Server too far away for authentication"); + this->Instance->SNO->WriteToSnoMask('l',"Server connection from \2"+sname+"\2 denied, server is too far away for authentication"); + return false; + } + std::string description = params[3]; + for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++) + { + if ((x->Name == servername) && (x->RecvPass == password)) + { + TreeServer* CheckDupe = Utils->FindServer(sname); + if (CheckDupe) + { + this->WriteLine("ERROR :Server "+sname+" already exists on server "+CheckDupe->GetParent()->GetName()+"!"); + this->Instance->SNO->WriteToSnoMask('l',"Server connection from \2"+sname+"\2 denied, already exists on server "+CheckDupe->GetParent()->GetName()); + return false; + } + // Begin the sync here. this kickstarts the + // other side, waiting in WAIT_AUTH_2 state, + // into starting their burst, as it shows + // that we're happy. + this->LinkState = CONNECTED; + // we should add the details of this server now + // to the servers tree, as a child of the root + // node. + TreeServer* Node = new TreeServer(this->Utils,this->Instance,sname,description,Utils->TreeRoot,this); + Utils->TreeRoot->AddChild(Node); + params[3] = ":" + params[3]; + Utils->DoOneToAllButSender(Utils->TreeRoot->GetName(),"SERVER",params,sname); + this->bursting = true; + this->DoBurst(Node); + return true; + } + } + this->WriteLine("ERROR :Invalid credentials"); + this->Instance->SNO->WriteToSnoMask('l',"Server connection from \2"+sname+"\2 denied, invalid link credentials"); + return false; +} + +bool TreeSocket::Inbound_Server(std::deque<std::string> ¶ms) +{ + if (params.size() < 4) + return false; + irc::string servername = params[0].c_str(); + std::string sname = params[0]; + std::string password = params[1]; + int hops = atoi(params[2].c_str()); + + if (hops) + { + this->WriteLine("ERROR :Server too far away for authentication"); + this->Instance->SNO->WriteToSnoMask('l',"Server connection from \2"+sname+"\2 denied, server is too far away for authentication"); + return false; + } + std::string description = params[3]; + for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++) + { + if ((x->Name == servername) && (x->RecvPass == password)) + { + TreeServer* CheckDupe = Utils->FindServer(sname); + if (CheckDupe) + { + this->WriteLine("ERROR :Server "+sname+" already exists on server "+CheckDupe->GetParent()->GetName()+"!"); + this->Instance->SNO->WriteToSnoMask('l',"Server connection from \2"+sname+"\2 denied, already exists on server "+CheckDupe->GetParent()->GetName()); + return false; + } + this->Instance->SNO->WriteToSnoMask('l',"Verified incoming server connection from \002"+sname+"\002["+(x->HiddenFromStats ? "<hidden>" : this->GetIP())+"] ("+description+")"); + if (this->Hook) + { + std::string name = InspSocketNameRequest((Module*)Utils->Creator, this->Hook).Send(); + this->Instance->SNO->WriteToSnoMask('l',"Connection from \2"+sname+"\2["+(x->HiddenFromStats ? "<hidden>" : this->GetIP())+"] using transport \2"+name+"\2"); + } + + this->InboundServerName = sname; + this->InboundDescription = description; + // this is good. Send our details: Our server name and description and hopcount of 0, + // along with the sendpass from this block. + this->WriteLine(std::string("SERVER ")+this->Instance->Config->ServerName+" "+x->SendPass+" 0 :"+this->Instance->Config->ServerDesc); + // move to the next state, we are now waiting for THEM. + this->LinkState = WAIT_AUTH_2; + return true; + } + } + this->WriteLine("ERROR :Invalid credentials"); + this->Instance->SNO->WriteToSnoMask('l',"Server connection from \2"+sname+"\2 denied, invalid link credentials"); + return false; +} + +void TreeSocket::Split(const std::string &line, std::deque<std::string> &n) +{ + n.clear(); + irc::tokenstream tokens(line); + std::string param; + while ((param = tokens.GetToken()) != "") + n.push_back(param); + return; +} + +bool TreeSocket::ProcessLine(std::string &line) +{ + std::deque<std::string> params; + irc::string command; + std::string prefix; + + line = line.substr(0, line.find_first_of("\r\n")); + + if (line.empty()) + return true; + + Instance->Log(DEBUG, "<- %s", line.c_str()); + + this->Split(line.c_str(),params); + + if ((params[0][0] == ':') && (params.size() > 1)) + { + prefix = params[0].substr(1); + params.pop_front(); + } + command = params[0].c_str(); + params.pop_front(); + switch (this->LinkState) + { + TreeServer* Node; + + case WAIT_AUTH_1: + // Waiting for SERVER command from remote server. Server initiating + // the connection sends the first SERVER command, listening server + // replies with theirs if its happy, then if the initiator is happy, + // it starts to send its net sync, which starts the merge, otherwise + // it sends an ERROR. + if (command == "PASS") + { + /* Silently ignored */ + } + else if (command == "SERVER") + { + return this->Inbound_Server(params); + } + else if (command == "ERROR") + { + return this->Error(params); + } + else if (command == "USER") + { + this->WriteLine("ERROR :Client connections to this port are prohibited."); + return false; + } + else if (command == "CAPAB") + { + return this->Capab(params); + } + else if ((command == "U") || (command == "S")) + { + this->WriteLine("ERROR :Cannot use the old-style mesh linking protocol with m_spanningtree.so!"); + return false; + } + else + { + std::string error("ERROR :Invalid command in negotiation phase: "); + error.append(command.c_str()); + this->WriteLine(error); + return false; + } + break; + case WAIT_AUTH_2: + // Waiting for start of other side's netmerge to say they liked our + // password. + if (command == "SERVER") + { + // cant do this, they sent it to us in the WAIT_AUTH_1 state! + // silently ignore. + return true; + } + else if ((command == "U") || (command == "S")) + { + this->WriteLine("ERROR :Cannot use the old-style mesh linking protocol with m_spanningtree.so!"); + return false; + } + else if (command == "BURST") + { + if (params.size() && Utils->EnableTimeSync) + { + /* If a time stamp is provided, apply synchronization */ + bool force = false; + time_t them = atoi(params[0].c_str()); + time_t us = Instance->Time(true); + int delta = them - us; + if ((params.size() == 2) && (params[1] == "FORCE")) + force = true; + if ((delta < -600) || (delta > 600)) + { + this->Instance->SNO->WriteToSnoMask('l',"\2ERROR\2: Your clocks are out by %d seconds (this is more than ten minutes). Link aborted, \2PLEASE SYNC YOUR CLOCKS!\2",abs(delta)); + this->WriteLine("ERROR :Your clocks are out by "+ConvToStr(abs(delta))+" seconds (this is more than ten minutes). Link aborted, PLEASE SYNC YOUR CLOCKS!"); + return false; + } + + if (force || (us > them)) + { + this->Instance->SetTimeDelta(them - us); + // Send this new timestamp to any other servers + Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params); + } + else + { + // Override the timestamp + this->WriteLine(":" + Utils->TreeRoot->GetName() + " TIMESET " + ConvToStr(us)); + } + } + this->LinkState = CONNECTED; + Node = new TreeServer(this->Utils,this->Instance,InboundServerName,InboundDescription,Utils->TreeRoot,this); + Utils->TreeRoot->AddChild(Node); + params.clear(); + params.push_back(InboundServerName); + params.push_back("*"); + params.push_back("1"); + params.push_back(":"+InboundDescription); + Utils->DoOneToAllButSender(Utils->TreeRoot->GetName(),"SERVER",params,InboundServerName); + this->bursting = true; + this->DoBurst(Node); + } + else if (command == "ERROR") + { + return this->Error(params); + } + else if (command == "CAPAB") + { + return this->Capab(params); + } + + break; + case LISTENER: + this->WriteLine("ERROR :Internal error -- listening socket accepted its own descriptor!!!"); + return false; + break; + case CONNECTING: + if (command == "SERVER") + { + // another server we connected to, which was in WAIT_AUTH_1 state, + // has just sent us their credentials. If we get this far, theyre + // happy with OUR credentials, and they are now in WAIT_AUTH_2 state. + // if we're happy with this, we should send our netburst which + // kickstarts the merge. + return this->Outbound_Reply_Server(params); + } + else if (command == "ERROR") + { + return this->Error(params); + } + break; + case CONNECTED: + // This is the 'authenticated' state, when all passwords + // have been exchanged and anything past this point is taken + // as gospel. + + if (prefix != "") + { + std::string direction = prefix; + userrec* t = this->Instance->FindNick(prefix); + if (t) + { + direction = t->server; + } + TreeServer* route_back_again = Utils->BestRouteTo(direction); + if ((!route_back_again) || (route_back_again->GetSocket() != this)) + { + if (route_back_again) + Instance->Log(DEBUG,"Protocol violation: Fake direction in command '%s' from connection '%s'",line.c_str(),this->GetName().c_str()); + return true; + } + /* Fix by brain: + * When there is activity on the socket, reset the ping counter so + * that we're not wasting bandwidth pinging an active server. + */ + route_back_again->SetNextPingTime(time(NULL) + 60); + route_back_again->SetPingFlag(); + } + + if (command == "SVSMODE") + { + /* Services expects us to implement + * SVSMODE. In inspircd its the same as + * MODE anyway. + */ + command = "MODE"; + } + std::string target = ""; + /* Yes, know, this is a mess. Its reasonably fast though as we're + * working with std::string here. + */ + if ((command == "NICK") && (params.size() > 1)) + { + return this->IntroduceClient(prefix,params); + } + else if (command == "FJOIN") + { + return this->ForceJoin(prefix,params); + } + else if (command == "STATS") + { + return this->Stats(prefix, params); + } + else if (command == "MOTD") + { + return this->Motd(prefix, params); + } + else if (command == "ADMIN") + { + return this->Admin(prefix, params); + } + else if (command == "SERVER") + { + return this->RemoteServer(prefix,params); + } + else if (command == "ERROR") + { + return this->Error(params); + } + else if (command == "OPERTYPE") + { + return this->OperType(prefix,params); + } + else if (command == "FMODE") + { + return this->ForceMode(prefix,params); + } + else if (command == "KILL") + { + return this->RemoteKill(prefix,params); + } + else if (command == "FTOPIC") + { + return this->ForceTopic(prefix,params); + } + else if (command == "REHASH") + { + return this->RemoteRehash(prefix,params); + } + else if (command == "METADATA") + { + return this->MetaData(prefix,params); + } + else if (command == "REMSTATUS") + { + return this->RemoveStatus(prefix,params); + } + else if (command == "PING") + { + /* + * We just got a ping from a server that's bursting. + * This can't be right, so set them to not bursting, and + * apply their lines. + */ + if (this->bursting) + { + this->bursting = false; + Instance->XLines->apply_lines(Utils->lines_to_apply); + Utils->lines_to_apply = 0; + } + if (prefix == "") + { + prefix = this->GetName(); + } + return this->LocalPing(prefix,params); + } + else if (command == "PONG") + { + /* + * We just got a pong from a server that's bursting. + * This can't be right, so set them to not bursting, and + * apply their lines. + */ + if (this->bursting) + { + this->bursting = false; + Instance->XLines->apply_lines(Utils->lines_to_apply); + Utils->lines_to_apply = 0; + } + if (prefix == "") + { + prefix = this->GetName(); + } + return this->LocalPong(prefix,params); + } + else if (command == "VERSION") + { + return this->ServerVersion(prefix,params); + } + else if (command == "FHOST") + { + return this->ChangeHost(prefix,params); + } + else if (command == "FNAME") + { + return this->ChangeName(prefix,params); + } + else if (command == "ADDLINE") + { + return this->AddLine(prefix,params); + } + else if (command == "SVSNICK") + { + if (prefix == "") + { + prefix = this->GetName(); + } + return this->ForceNick(prefix,params); + } + else if (command == "RSQUIT") + { + return this->RemoteSquit(prefix, params); + } + else if (command == "IDLE") + { + return this->Whois(prefix,params); + } + else if (command == "PUSH") + { + return this->Push(prefix,params); + } + else if (command == "TIMESET") + { + return this->HandleSetTime(prefix, params); + } + else if (command == "TIME") + { + return this->Time(prefix,params); + } + else if ((command == "KICK") && (Utils->IsServer(prefix))) + { + std::string sourceserv = this->myhost; + if (params.size() == 3) + { + userrec* user = this->Instance->FindNick(params[1]); + chanrec* chan = this->Instance->FindChan(params[0]); + if (user && chan) + { + if (!chan->ServerKickUser(user, params[2].c_str(), false)) + /* Yikes, the channels gone! */ + delete chan; + } + } + if (this->InboundServerName != "") + { + sourceserv = this->InboundServerName; + } + return Utils->DoOneToAllButSenderRaw(line,sourceserv,prefix,command,params); + } + else if (command == "SVSJOIN") + { + if (prefix == "") + { + prefix = this->GetName(); + } + return this->ServiceJoin(prefix,params); + } + else if (command == "SQUIT") + { + if (params.size() == 2) + { + this->Squit(Utils->FindServer(params[0]),params[1]); + } + return true; + } + else if (command == "OPERNOTICE") + { + std::string sourceserv = this->myhost; + if (this->InboundServerName != "") + sourceserv = this->InboundServerName; + if (params.size() >= 1) + Instance->WriteOpers("*** From " + sourceserv + ": " + params[0]); + return Utils->DoOneToAllButSenderRaw(line, sourceserv, prefix, command, params); + } + else if (command == "MODENOTICE") + { + std::string sourceserv = this->myhost; + if (this->InboundServerName != "") + sourceserv = this->InboundServerName; + if (params.size() >= 2) + { + Instance->WriteMode(params[0].c_str(), WM_AND, "*** From %s: %s", sourceserv.c_str(), params[1].c_str()); + } + return Utils->DoOneToAllButSenderRaw(line, sourceserv, prefix, command, params); + } + else if (command == "SNONOTICE") + { + std::string sourceserv = this->myhost; + if (this->InboundServerName != "") + sourceserv = this->InboundServerName; + if (params.size() >= 2) + { + Instance->SNO->WriteToSnoMask(*(params[0].c_str()), "From " + sourceserv + ": "+ params[1]); + } + return Utils->DoOneToAllButSenderRaw(line, sourceserv, prefix, command, params); + } + else if (command == "ENDBURST") + { + this->bursting = false; + Instance->XLines->apply_lines(Utils->lines_to_apply); + Utils->lines_to_apply = 0; + std::string sourceserv = this->myhost; + if (this->InboundServerName != "") + { + sourceserv = this->InboundServerName; + } + this->Instance->SNO->WriteToSnoMask('l',"Received end of netburst from \2%s\2",sourceserv.c_str()); + + Event rmode((char*)sourceserv.c_str(), (Module*)Utils->Creator, "new_server"); + rmode.Send(Instance); + + return true; + } + else + { + // not a special inter-server command. + // Emulate the actual user doing the command, + // this saves us having a huge ugly parser. + userrec* who = this->Instance->FindNick(prefix); + std::string sourceserv = this->myhost; + if (this->InboundServerName != "") + { + sourceserv = this->InboundServerName; + } + if ((!who) && (command == "MODE")) + { + if (Utils->IsServer(prefix)) + { + const char* modelist[127]; + for (size_t i = 0; i < params.size(); i++) + modelist[i] = params[i].c_str(); + userrec* fake = new userrec(Instance); + fake->SetFd(FD_MAGIC_NUMBER); + this->Instance->SendMode(modelist, params.size(), fake); + + delete fake; + /* Hot potato! pass it on! */ + return Utils->DoOneToAllButSenderRaw(line,sourceserv,prefix,command,params); + } + } + if (who) + { + if ((command == "NICK") && (params.size() > 0)) + { + /* On nick messages, check that the nick doesnt + * already exist here. If it does, kill their copy, + * and our copy. + */ + userrec* x = this->Instance->FindNick(params[0]); + if ((x) && (x != who)) + { + std::deque<std::string> p; + p.push_back(params[0]); + p.push_back("Nickname collision ("+prefix+" -> "+params[0]+")"); + Utils->DoOneToMany(this->Instance->Config->ServerName,"KILL",p); + p.clear(); + p.push_back(prefix); + p.push_back("Nickname collision"); + Utils->DoOneToMany(this->Instance->Config->ServerName,"KILL",p); + userrec::QuitUser(this->Instance,x,"Nickname collision ("+prefix+" -> "+params[0]+")"); + userrec* y = this->Instance->FindNick(prefix); + if (y) + { + userrec::QuitUser(this->Instance,y,"Nickname collision"); + } + return Utils->DoOneToAllButSenderRaw(line,sourceserv,prefix,command,params); + } + } + // its a user + target = who->server; + const char* strparams[127]; + for (unsigned int q = 0; q < params.size(); q++) + { + strparams[q] = params[q].c_str(); + } + switch (this->Instance->CallCommandHandler(command.c_str(), strparams, params.size(), who)) + { + case CMD_INVALID: + this->WriteLine("ERROR :Unrecognised command '"+std::string(command.c_str())+"' -- possibly loaded mismatched modules"); + return false; + break; + case CMD_FAILURE: + return true; + break; + default: + /* CMD_SUCCESS and CMD_USER_DELETED fall through here */ + break; + } + } + else + { + // its not a user. Its either a server, or somethings screwed up. + if (Utils->IsServer(prefix)) + target = this->Instance->Config->ServerName; + else + return true; + } + return Utils->DoOneToAllButSenderRaw(line,sourceserv,prefix,command,params); + + } + return true; + break; + } + return true; +} + +std::string TreeSocket::GetName() +{ + std::string sourceserv = this->myhost; + if (this->InboundServerName != "") + { + sourceserv = this->InboundServerName; + } + return sourceserv; +} + +void TreeSocket::OnTimeout() +{ + if (this->LinkState == CONNECTING) + { + this->Instance->SNO->WriteToSnoMask('l',"CONNECT: Connection to \002"+myhost+"\002 timed out."); + Link* MyLink = Utils->FindLink(myhost); + if (MyLink) + Utils->DoFailOver(MyLink); + } +} + +void TreeSocket::OnClose() +{ + // Connection closed. + // If the connection is fully up (state CONNECTED) + // then propogate a netsplit to all peers. + std::string quitserver = this->myhost; + if (this->InboundServerName != "") + { + quitserver = this->InboundServerName; + } + TreeServer* s = Utils->FindServer(quitserver); + if (s) + { + Squit(s,"Remote host closed the connection"); + } + + if (quitserver != "") + this->Instance->SNO->WriteToSnoMask('l',"Connection to '\2%s\2' failed.",quitserver.c_str()); +} + +int TreeSocket::OnIncomingConnection(int newsock, char* ip) +{ + /* To prevent anyone from attempting to flood opers/DDoS by connecting to the server port, + * or discovering if this port is the server port, we don't allow connections from any + * IPs for which we don't have a link block. + */ + bool found = false; + + found = (std::find(Utils->ValidIPs.begin(), Utils->ValidIPs.end(), ip) != Utils->ValidIPs.end()); + if (!found) + { + for (vector<std::string>::iterator i = Utils->ValidIPs.begin(); i != Utils->ValidIPs.end(); i++) + if (irc::sockets::MatchCIDR(ip, (*i).c_str())) + found = true; + + if (!found) + { + this->Instance->SNO->WriteToSnoMask('l',"Server connection from %s denied (no link blocks with that IP address)", ip); + close(newsock); + return false; + } + } + + TreeSocket* s = new TreeSocket(this->Utils, this->Instance, newsock, ip, this->Hook); + s = s; /* Whinge whinge whinge, thats all GCC ever does. */ + return true; +} |