src/modules/m_spanningtree/treesocket1.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24 #include "iohook.h"
  25
  26 #include "main.h"
  27 #include "modules/spanningtree.h"
  28 #include "utils.h"
  29 #include "treeserver.h"
  30 #include "link.h"
  31 #include "treesocket.h"
  32 #include "commands.h"
  33
  34 /** Because most of the I/O gubbins are encapsulated within
  35  * BufferedSocket, we just call the superclass constructor for
  36  * most of the action, and append a few of our own values
  37  * to it.
  38  */
  39 TreeSocket::TreeSocket(Link* link, Autoconnect* myac, const std::string& ipaddr)
  40         : linkID(assign(link->Name)), LinkState(CONNECTING), MyRoot(NULL), proto_version(0), ConnectionFailureShown(false)
  41         , age(ServerInstance->Time())
  42 {
  43         capab = new CapabData;
  44         capab->link = link;
  45         capab->ac = myac;
  46         capab->capab_phase = 0;
  47
  48         DoConnect(ipaddr, link->Port, link->Timeout, link->Bind);
  49         Utils->timeoutlist[this] = std::pair<std::string, int>(linkID, link->Timeout);
  50         SendCapabilities(1);
  51 }
  52
  53 /** When a listening socket gives us a new file descriptor,
  54  * we must associate it with a socket without creating a new
  55  * connection. This constructor is used for this purpose.
  56  */
  57 TreeSocket::TreeSocket(int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
  58         : BufferedSocket(newfd)
  59         , linkID("inbound from " + client->addr()), LinkState(WAIT_AUTH_1), MyRoot(NULL), proto_version(0)
  60         , ConnectionFailureShown(false), age(ServerInstance->Time())
  61 {
  62         capab = new CapabData;
  63         capab->capab_phase = 0;
  64
  65         if (via->iohookprov)
  66                 via->iohookprov->OnAccept(this, client, server);
  67         SendCapabilities(1);
  68
  69         Utils->timeoutlist[this] = std::pair<std::string, int>(linkID, 30);
  70 }
  71
  72 ServerState TreeSocket::GetLinkState()
  73 {
  74         return this->LinkState;
  75 }
  76
  77 void TreeSocket::CleanNegotiationInfo()
  78 {
  79         // connect is good, reset the autoconnect block (if used)
  80         if (capab->ac)
  81                 capab->ac->position = -1;
  82         delete capab;
  83         capab = NULL;
  84 }
  85
  86 CullResult TreeSocket::cull()
  87 {
  88         Utils->timeoutlist.erase(this);
  89         if (capab && capab->ac)
  90                 Utils->Creator->ConnectServer(capab->ac, false);
  91         return this->BufferedSocket::cull();
  92 }
  93
  94 TreeSocket::~TreeSocket()
  95 {
  96         delete capab;
  97 }
  98
  99 /** When an outbound connection finishes connecting, we receive
 100  * this event, and must send our SERVER string to the other
 101  * side. If the other side is happy, as outlined in the server
 102  * to server docs on the inspircd.org site, the other side
 103  * will then send back its own server string.
 104  */
 105 void TreeSocket::OnConnected()
 106 {
 107         if (this->LinkState == CONNECTING)
 108         {
 109                 if (!capab->link->Hook.empty())
 110                 {
 111                         ServiceProvider* prov = ServerInstance->Modules->FindService(SERVICE_IOHOOK, capab->link->Hook);
 112                         if (!prov)
 113                         {
 114                                 SetError("Could not find hook '" + capab->link->Hook + "' for connection to " + linkID);
 115                                 return;
 116                         }
 117                         static_cast<IOHookProvider*>(prov)->OnConnect(this);
 118                 }
 119
 120                 ServerInstance->SNO->WriteGlobalSno('l', "Connection to \2%s\2[%s] started.", linkID.c_str(),
 121                         (capab->link->HiddenFromStats ? "<hidden>" : capab->link->IPAddr.c_str()));
 122                 this->SendCapabilities(1);
 123         }
 124 }
 125
 126 void TreeSocket::OnError(BufferedSocketError e)
 127 {
 128         ServerInstance->SNO->WriteGlobalSno('l', "Connection to '\002%s\002' failed with error: %s",
 129                 linkID.c_str(), getError().c_str());
 130         LinkState = DYING;
 131 }
 132
 133 void TreeSocket::SendError(const std::string &errormessage)
 134 {
 135         WriteLine("ERROR :"+errormessage);
 136         DoWrite();
 137         LinkState = DYING;
 138         SetError(errormessage);
 139 }
 140
 141 /** This function forces this server to quit, removing this server
 142  * and any users on it (and servers and users below that, etc etc).
 143  * It's very slow and pretty clunky, but luckily unless your network
 144  * is having a REAL bad hair day, this function shouldnt be called
 145  * too many times a month ;-)
 146  */
 147 void TreeSocket::SquitServer(std::string &from, TreeServer* Current, int& num_lost_servers, int& num_lost_users)
 148 {
 149         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "SquitServer for %s from %s", Current->GetName().c_str(), from.c_str());
 150         /* recursively squit the servers attached to 'Current'.
 151          * We're going backwards so we don't remove users
 152          * while we still need them ;)
 153          */
 154         const TreeServer::ChildServers& children = Current->GetChildren();
 155         for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
 156         {
 157                 TreeServer* recursive_server = *i;
 158                 this->SquitServer(from,recursive_server, num_lost_servers, num_lost_users);
 159         }
 160         /* Now we've whacked the kids, whack self */
 161         num_lost_servers++;
 162         num_lost_users += Current->QuitUsers(from);
 163 }
 164
 165 /** This is a wrapper function for SquitServer above, which
 166  * does some validation first and passes on the SQUIT to all
 167  * other remaining servers.
 168  */
 169 void TreeSocket::Squit(TreeServer* Current, const std::string &reason)
 170 {
 171         bool LocalSquit = false;
 172
 173         if (!Current->IsRoot())
 174         {
 175                 DelServerEvent(Utils->Creator, Current->GetName());
 176
 177                 if (Current->IsLocal())
 178                 {
 179                         ServerInstance->SNO->WriteGlobalSno('l', "Server \002"+Current->GetName()+"\002 split: "+reason);
 180                         LocalSquit = true;
 181                         if (Current->GetSocket()->Introduced())
 182                         {
 183                                 CmdBuilder params("SQUIT");
 184                                 params.push_back(Current->GetID());
 185                                 params.push_last(reason);
 186                                 params.Broadcast();
 187                         }
 188                 }
 189                 else
 190                 {
 191                         ServerInstance->SNO->WriteGlobalSno('L', "Server \002"+Current->GetName()+"\002 split from server \002"+Current->GetParent()->GetName()+"\002 with reason: "+reason);
 192                 }
 193                 int num_lost_servers = 0;
 194                 int num_lost_users = 0;
 195                 std::string from = Current->GetParent()->GetName()+" "+Current->GetName();
 196
 197                 ModuleSpanningTree* st = Utils->Creator;
 198                 st->SplitInProgress = true;
 199                 SquitServer(from, Current, num_lost_servers, num_lost_users);
 200                 st->SplitInProgress = false;
 201
 202                 ServerInstance->SNO->WriteToSnoMask(LocalSquit ? 'l' : 'L', "Netsplit complete, lost \002%d\002 user%s on \002%d\002 server%s.",
 203                         num_lost_users, num_lost_users != 1 ? "s" : "", num_lost_servers, num_lost_servers != 1 ? "s" : "");
 204                 Current->Tidy();
 205                 Current->GetParent()->DelChild(Current);
 206                 Current->cull();
 207                 delete Current;
 208                 if (Current == MyRoot)
 209                 {
 210                         MyRoot = NULL;
 211                         Close();
 212                 }
 213         }
 214 }
 215
 216 CmdResult CommandSQuit::HandleServer(TreeServer* server, std::vector<std::string>& params)
 217 {
 218         TreeServer* quitting = Utils->FindServer(params[0]);
 219         if (!quitting)
 220         {
 221                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Squit from unknown server");
 222                 return CMD_FAILURE;
 223         }
 224
 225         TreeSocket* sock = server->GetSocket();
 226         sock->Squit(quitting, params[1]);
 227
 228         // XXX: Return CMD_FAILURE when servers SQUIT themselves (i.e. :00S SQUIT 00S :Shutting down)
 229         // to avoid RouteCommand() being called. RouteCommand() requires a valid command source but we
 230         // do not have one because the server user is deleted when its TreeServer is destructed.
 231         // We generate a SQUIT in TreeSocket::Squit(), with our sid as the source and send it to the
 232         // remaining servers.
 233         return ((quitting == server) ? CMD_FAILURE : CMD_SUCCESS);
 234 }
 235
 236 /** This function is called when we receive data from a remote
 237  * server.
 238  */
 239 void TreeSocket::OnDataReady()
 240 {
 241         Utils->Creator->loopCall = true;
 242         std::string line;
 243         while (GetNextLine(line))
 244         {
 245                 std::string::size_type rline = line.find('\r');
 246                 if (rline != std::string::npos)
 247                         line = line.substr(0,rline);
 248                 if (line.find('\0') != std::string::npos)
 249                 {
 250                         SendError("Read null character from socket");
 251                         break;
 252                 }
 253                 ProcessLine(line);
 254                 if (!getError().empty())
 255                         break;
 256         }
 257         if (LinkState != CONNECTED && recvq.length() > 4096)
 258                 SendError("RecvQ overrun (line too long)");
 259         Utils->Creator->loopCall = false;
 260 }
 261
 262 bool TreeSocket::Introduced()
 263 {
 264         return (capab == NULL);
 265 }