1 /* +------------------------------------+
\r * | Inspire Internet Relay Chat Daemon |
\r * +------------------------------------+
\r *
\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team
\r * See: http://www.inspircd.org/wiki/index.php/Credits
\r *
\r * This program is free but copyrighted software; see
\r * the file COPYING for details.
\r *
\r * ---------------------------------------------------
\r */
\r\r#ifndef __TREESOCKET_H__
\r#define __TREESOCKET_H__
\r\r#include "configreader.h"
\r#include "users.h"
\r#include "channels.h"
\r#include "modules.h"
\r#include "commands/cmd_whois.h"
\r#include "commands/cmd_stats.h"
\r#include "socket.h"
\r#include "inspircd.h"
\r#include "wildcard.h"
\r#include "xline.h"
\r#include "transport.h"
\r\r#include "m_spanningtree/utils.h"
\r\r/*
\r * The server list in InspIRCd is maintained as two structures
\r * which hold the data in different ways. Most of the time, we
\r * want to very quicky obtain three pieces of information:
\r *
\r * (1) The information on a server
\r * (2) The information on the server we must send data through
\r * to actually REACH the server we're after
\r * (3) Potentially, the child/parent objects of this server
\r *
\r * The InspIRCd spanning protocol provides easy access to these
\r * by storing the data firstly in a recursive structure, where
\r * each item references its parent item, and a dynamic list
\r * of child items, and another structure which stores the items
\r * hashed, linearly. This means that if we want to find a server
\r * by name quickly, we can look it up in the hash, avoiding
\r * any O(n) lookups. If however, during a split or sync, we want
\r * to apply an operation to a server, and any of its child objects
\r * we can resort to recursion to walk the tree structure.
\r * Any socket can have one of five states at any one time.
\r * The LISTENER state indicates a socket which is listening
\r * for connections. It cannot receive data itself, only incoming
\r * sockets.
\r * The CONNECTING state indicates an outbound socket which is
\r * waiting to be writeable.
\r * The WAIT_AUTH_1 state indicates the socket is outbound and
\r * has successfully connected, but has not yet sent and received
\r * SERVER strings.
\r * The WAIT_AUTH_2 state indicates that the socket is inbound
\r * (allocated by a LISTENER) but has not yet sent and received
\r * SERVER strings.
\r * The CONNECTED state represents a fully authorized, fully
\r * connected server.
\r */
\renum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
\r\r/** Every SERVER connection inbound or outbound is represented by
\r * an object of type TreeSocket.
\r * TreeSockets, being inherited from InspSocket, can be tied into
\r * the core socket engine, and we cn therefore receive activity events
\r * for them, just like activex objects on speed. (yes really, that
\r * is a technical term!) Each of these which relates to a locally
\r * connected server is assocated with it, by hooking it onto a
\r * TreeSocket class using its constructor. In this way, we can
\r * maintain a list of servers, some of which are directly connected,
\r * some of which are not.
\r */
\rclass TreeSocket : public InspSocket
\r{
\r SpanningTreeUtilities* Utils; /* Utility class */
\r std::string myhost; /* Canonical hostname */
\r std::string in_buffer; /* Input buffer */
\r ServerState LinkState; /* Link state */
\r std::string InboundServerName; /* Server name sent to us by other side */
\r std::string InboundDescription; /* Server description (GECOS) sent to us by the other side */
\r int num_lost_users; /* Users lost in split */
\r int num_lost_servers; /* Servers lost in split */
\r time_t NextPing; /* Time when we are due to ping this server */
\r bool LastPingWasGood; /* Responded to last ping we sent? */
\r bool bursting; /* True if not finished bursting yet */
\r unsigned int keylength; /* Is this still used? */
\r std::string ModuleList; /* Module list of other server from CAPAB */
\r std::map<std::string,std::string> CapKeys; /* CAPAB keys from other server */
\r Module* Hook; /* I/O hooking module that we're attached to for this socket */
\r std::string ourchallenge; /* Challenge sent for challenge/response */
\r std::string theirchallenge; /* Challenge recv for challenge/response */
\r std::string OutboundPass; /* Outbound password */
\r bool sentcapab; /* Have sent CAPAB already */
\r public:
\r\r /** Because most of the I/O gubbins are encapsulated within
\r * InspSocket, we just call the superclass constructor for
\r * most of the action, and append a few of our own values
\r * to it.
\r */
\r TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, Module* HookMod = NULL);
\r\r /** Because most of the I/O gubbins are encapsulated within
\r * InspSocket, we just call the superclass constructor for
\r * most of the action, and append a few of our own values
\r * to it.
\r */
\r TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Module* HookMod = NULL);
\r\r /** When a listening socket gives us a new file descriptor,
\r * we must associate it with a socket without creating a new
\r * connection. This constructor is used for this purpose.
\r */
\r TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, int newfd, char* ip, Module* HookMod = NULL);
\r\r /** Get link state
\r */
\r ServerState GetLinkState();
\r\r /** Get challenge set in our CAPAB for challenge/response
\r */
\r const std::string& GetOurChallenge();
\r\r /** Get challenge set in our CAPAB for challenge/response
\r */
\r void SetOurChallenge(const std::string &c);
\r\r /** Get challenge set in their CAPAB for challenge/response
\r */
\r const std::string& GetTheirChallenge();
\r\r /** Get challenge set in their CAPAB for challenge/response
\r */
\r void SetTheirChallenge(const std::string &c);
\r\r /** Compare two passwords based on authentication scheme
\r */
\r bool ComparePass(const std::string &ours, const std::string &theirs);
\r\r /** Return the module which we are hooking to for I/O encapsulation
\r */
\r Module* GetHook();
\r\r /** Destructor
\r */
\r ~TreeSocket();
\r\r /** Generate random string used for challenge-response auth
\r */
\r std::string RandString(unsigned int length);
\r\r /** Construct a password, optionally hashed with the other side's
\r * challenge string
\r */
\r std::string MakePass(const std::string &password, const std::string &challenge);
\r\r /** When an outbound connection finishes connecting, we receive
\r * this event, and must send our SERVER string to the other
\r * side. If the other side is happy, as outlined in the server
\r * to server docs on the inspircd.org site, the other side
\r * will then send back its own server string.
\r */
\r virtual bool OnConnected();
\r\r /** Handle socket error event
\r */
\r virtual void OnError(InspSocketError e);
\r\r /** Sends an error to the remote server, and displays it locally to show
\r * that it was sent.
\r */
\r void SendError(const std::string &errormessage);
\r\r /** Handle socket disconnect event
\r */
\r virtual int OnDisconnect();
\r\r /** Recursively send the server tree with distances as hops.
\r * This is used during network burst to inform the other server
\r * (and any of ITS servers too) of what servers we know about.
\r * If at any point any of these servers already exist on the other
\r * end, our connection may be terminated. The hopcounts given
\r * by this function are relative, this doesn't matter so long as
\r * they are all >1, as all the remote servers re-calculate them
\r * to be relative too, with themselves as hop 0.
\r */
\r void SendServers(TreeServer* Current, TreeServer* s, int hops);
\r\r /** Returns my capabilities as a string
\r */
\r std::string MyCapabilities();
\r\r /** Send my capabilities to the remote side
\r */
\r void SendCapabilities();
\r\r /* Check a comma seperated list for an item */
\r bool HasItem(const std::string &list, const std::string &item);
\r\r /* Isolate and return the elements that are different between two comma seperated lists */
\r std::string ListDifference(const std::string &one, const std::string &two);
\r\r bool Capab(const std::deque<std::string> ¶ms);
\r\r /** This function forces this server to quit, removing this server
\r * and any users on it (and servers and users below that, etc etc).
\r * It's very slow and pretty clunky, but luckily unless your network
\r * is having a REAL bad hair day, this function shouldnt be called
\r * too many times a month ;-)
\r */
\r void SquitServer(std::string &from, TreeServer* Current);
\r\r /** This is a wrapper function for SquitServer above, which
\r * does some validation first and passes on the SQUIT to all
\r * other remaining servers.
\r */
\r void Squit(TreeServer* Current, const std::string &reason);
\r\r /** FMODE command - server mode with timestamp checks */
\r bool ForceMode(const std::string &source, std::deque<std::string> ¶ms);
\r\r /** FTOPIC command */
\r bool ForceTopic(const std::string &source, std::deque<std::string> ¶ms);
\r\r /** FJOIN, similar to TS6 SJOIN, but not quite. */
\r bool ForceJoin(const std::string &source, std::deque<std::string> ¶ms);
\r\r /** NICK command */
\r bool IntroduceClient(const std::string &source, std::deque<std::string> ¶ms);
\r\r /** Send one or more FJOINs for a channel of users.
\r * If the length of a single line is more than 480-NICKMAX
\r * in length, it is split over multiple lines.
\r */
\r void SendFJoins(TreeServer* Current, chanrec* c);
\r\r /** Send G, Q, Z and E lines */
\r void SendXLines(TreeServer* Current);
\r\r /** Send channel modes and topics */
\r void SendChannelModes(TreeServer* Current);
\r\r /** send all users and their oper state/modes */
\r void SendUsers(TreeServer* Current);
\r\r /** This function is called when we want to send a netburst to a local
\r * server. There is a set order we must do this, because for example
\r * users require their servers to exist, and channels require their
\r * users to exist. You get the idea.
\r */
\r void DoBurst(TreeServer* s);
\r\r /** This function is called when we receive data from a remote
\r * server. We buffer the data in a std::string (it doesnt stay
\r * there for long), reading using InspSocket::Read() which can
\r * read up to 16 kilobytes in one operation.
\r *
\r * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
\r * THE SOCKET OBJECT FOR US.
\r */
\r virtual bool OnDataReady();
\r\r /** Send one or more complete lines down the socket
\r */
\r int WriteLine(std::string line);
\r\r /** Handle ERROR command */
\r bool Error(std::deque<std::string> ¶ms);
\r\r /** remote MOTD. leet, huh? */
\r bool Motd(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** remote ADMIN. leet, huh? */
\r bool Admin(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** Remote MODULES */
\r bool Modules(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r bool Stats(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** Because the core won't let users or even SERVERS set +o,
\r * we use the OPERTYPE command to do this.
\r */
\r bool OperType(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** Because Andy insists that services-compatible servers must
\r * implement SVSNICK and SVSJOIN, that's exactly what we do :p
\r */
\r bool ForceNick(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r bool OperQuit(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** SVSJOIN
\r */
\r bool ServiceJoin(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** REHASH
\r */
\r bool RemoteRehash(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** KILL
\r */
\r bool RemoteKill(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** PONG
\r */
\r bool LocalPong(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** METADATA
\r */
\r bool MetaData(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** VERSION
\r */
\r bool ServerVersion(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** CHGHOST
\r */
\r bool ChangeHost(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** ADDLINE
\r */
\r bool AddLine(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** CHGNAME
\r */
\r bool ChangeName(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** WHOIS
\r */
\r bool Whois(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** PUSH
\r */
\r bool Push(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** SETTIME
\r */
\r bool HandleSetTime(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** TIME
\r */
\r bool Time(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** PING
\r */
\r bool LocalPing(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
\r * This does not update the timestamp of the target channel, this must be done seperately.
\r */
\r bool RemoveStatus(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** <- (remote) <- SERVER
\r */
\r bool RemoteServer(const std::string &prefix, std::deque<std::string> ¶ms);
\r\r /** (local) -> SERVER
\r */
\r bool Outbound_Reply_Server(std::deque<std::string> ¶ms);
\r\r /** (local) <- SERVER
\r */
\r bool Inbound_Server(std::deque<std::string> ¶ms);
\r\r /** Handle netsplit
\r */
\r void Split(const std::string &line, std::deque<std::string> &n);
\r\r /** Process complete line from buffer
\r */
\r bool ProcessLine(std::string &line);
\r\r /** Get this server's name
\r */
\r virtual std::string GetName();
\r\r /** Handle socket timeout from connect()
\r */
\r virtual void OnTimeout();
\r\r /** Handle socket close event
\r */
\r virtual void OnClose();
\r\r /** Handle incoming connection event
\r */
\r virtual int OnIncomingConnection(int newsock, char* ip);
\r};
\r\r/* Used to validate the value lengths of multiple parameters for a command */
\rstruct cmd_validation
\r{
\r const char* item;
\r size_t param;
\r size_t length;
\r};
\r\r/* Used to validate the length values in CAPAB CAPABILITIES */
\rstruct cap_validation
\r{
\r const char* reason;
\r const char* key;
\r size_t size;
\r};
\r\r#endif
\r\r