X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Finspsocket.h;h=af93baa56f409fec74bcaa6e50ffa3ce9593b0e2;hb=b4a174ee9c32d62ea6bf010e837e8c5b1c3d36a3;hp=98fbc018f95a445cc4eae2e7ce31581c44dca948;hpb=bab14f0dd2345c9d7dcbc47c918563709e1ac094;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspsocket.h b/include/inspsocket.h index 98fbc018f..45fa46a5b 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -1 +1,447 @@ -/* +------------------------------------+ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * * InspIRCd: (C) 2002-2007 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ #ifndef __INSP_SOCKET_H__ #define __INSP_SOCKET_H__ #include #include #include #include "dns.h" #include "inspircd_config.h" #include "socket.h" #include "inspsocket.h" #include "timer.h" /** * States which a socket may be in */ enum InspSocketState { /** Socket disconnected */ I_DISCONNECTED, /** Socket connecting */ I_CONNECTING, /** Socket fully connected */ I_CONNECTED, /** Socket listening for connections */ I_LISTENING, /** Socket has an error */ I_ERROR }; /** * Error types which a socket may exhibit */ enum InspSocketError { /** Socket connect timed out */ I_ERR_TIMEOUT, /** Socket could not be created */ I_ERR_SOCKET, /** Socket could not connect (refused) */ I_ERR_CONNECT, /** Socket could not bind to local port/ip */ I_ERR_BIND, /** Socket could not reslve host (depreciated) */ I_ERR_RESOLVE, /** Socket could not write data */ I_ERR_WRITE, /** No more file descriptors left to create socket! */ I_ERR_NOMOREFDS }; /* Required forward declarations */ class InspSocket; class InspIRCd; using irc::sockets::insp_sockaddr; using irc::sockets::insp_inaddr; using irc::sockets::insp_ntoa; using irc::sockets::insp_aton; /** Used to time out socket connections */ class CoreExport SocketTimeout : public InspTimer { private: /** InspSocket the class is attached to */ InspSocket* sock; /** Server instance creating the timeout class */ InspIRCd* ServerInstance; /** File descriptor of class this is attached to */ int sfd; public: /** Create a socket timeout class * @param fd File descriptor of InspSocket * @pram Instance server instance to attach to * @param thesock InspSocket to attach to * @param secs_from_now Seconds from now to time out * @param now The current time */ SocketTimeout(int fd, InspIRCd* Instance, InspSocket* thesock, long secs_from_now, time_t now) : InspTimer(secs_from_now, now), sock(thesock), ServerInstance(Instance), sfd(fd) { }; /** Handle tick event */ virtual void Tick(time_t now); }; /** * InspSocket is an extendable socket class which modules * can use for TCP socket support. It is fully integrated * into InspIRCds socket loop and attaches its sockets to * the core's instance of the SocketEngine class, meaning * that any sockets you create have the same power and * abilities as a socket created by the core itself. * To use InspSocket, you must inherit a class from it, * and use the InspSocket constructors to establish connections * and bindings. */ class CoreExport InspSocket : public EventHandler { public: /** * Bind IP */ std::string cbindip; /** * Is hooked by a module for low level IO */ bool IsIOHooked; /** * Instance we were created by */ InspIRCd* Instance; /** * Timeout class or NULL */ SocketTimeout* Timeout; /** * Timeout length */ unsigned long timeout_val; /** * Socket output buffer (binary safe) */ std::deque outbuffer; /** * The hostname connected to */ char host[MAXBUF]; /** * The port connected to, or the port * this socket is listening on */ int port; /** * The state for this socket, either * listening, connecting, connected * or error. */ InspSocketState state; /** * This value is true if the * socket has timed out. */ bool timeout; /** * Socket input buffer, used by read(). The class which * extends InspSocket is expected to implement an extendable * buffer which can grow much larger than 64k, * this buffer is just designed to be temporary storage. * space. */ char ibuf[65535]; /** * The IP address being connected * to stored in string form for * easy retrieval by accessors. */ char IP[MAXBUF]; /** * Used by accept() to indicate the * sizes of the sockaddr_in structures */ socklen_t length; /** Flushes the write buffer */ bool FlushWriteBuffer(); /** Set the queue sizes * This private method sets the operating system queue * sizes for this socket to 65535 so that it can queue * more information without application-level queueing * which was required in older software. */ void SetQueues(int nfd); /** When the socket has been marked as closing, this flag * will be set to true, then the next time the socket is * examined, the socket is deleted and closed. */ bool ClosePending; /** Set to true when we're waiting for a write event. * If this is true and a write event comes in, we * call the write instead of the read method. */ bool WaitingForWriteEvent; /** * Bind to an address * @param ip IP to bind to * @return True is the binding succeeded */ bool BindAddr(const std::string &ip); /** * The default constructor does nothing * and should not be used. */ InspSocket(InspIRCd* SI); /** * This constructor is used to associate * an existing connecting with an InspSocket * class. The given file descriptor must be * valid, and when initialized, the InspSocket * will be set with the given IP address * and placed in CONNECTED state. */ InspSocket(InspIRCd* SI, int newfd, const char* ip); /** * This constructor is used to create a new * socket, either listening for connections, or an outbound connection to another host. * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not * connect. You must resolve your hostnames before passing them to InspSocket. To do so, * you should use the nonblocking class 'Resolver'. * @param ipaddr The IP to connect to, or bind to * @param port The port number to connect to, or bind to * @param listening true to listen on the given host:port pair, or false to connect to them * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound. * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error. */ InspSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = ""); /** * This method is called when an outbound * connection on your socket is completed. * @return false to abort the connection, true to continue */ virtual bool OnConnected(); /** * This method is called when an error occurs. * A closed socket in itself is not an error, * however errors also generate close events. * @param e The error type which occured */ virtual void OnError(InspSocketError e); /** * When an established connection is terminated, * the OnDisconnect method is triggered. */ virtual int OnDisconnect(); /** * When there is data waiting to be read on a * socket, the OnDataReady() method is called. * Within this method, you *MUST* call the Read() * method to read any pending data. At its lowest * level, this event is signalled by the core via * the socket engine. If you return false from this * function, the core removes your socket from its * list and erases it from the socket engine, then * calls InspSocket::Close() and deletes it. * @return false to close the socket */ virtual bool OnDataReady(); /** * When it is ok to write to the socket, and a * write event was requested, this method is * triggered. Within this method you should call * write() or send() etc, to send data to the * other end of the socket. Further write events * will not be triggered unless you call WantWrite(). * @return false to close the socket */ virtual bool OnWriteReady(); /** * When an outbound connection fails, and the * attempt times out, you will receive this event. * The method will trigger once maxtime seconds are * reached (as given in the constructor) just * before the socket's descriptor is closed. * A failed DNS lookup may cause this event if * the DNS server is not responding, as well as * a failed connect() call, because DNS lookups are * nonblocking as implemented by this class. */ virtual void OnTimeout(); /** * Whenever close() is called, OnClose() will be * called first. Please note that this means * OnClose will be called alongside OnError(), * OnTimeout(), and Close(), and also when * cancelling a listening socket by calling * the destructor indirectly. */ virtual void OnClose(); /** * Reads all pending bytes from the socket * into a char* array which can be up to * 16 kilobytes in length. */ virtual char* Read(); /** * Returns the IP address associated with * this connection, or an empty string if * no IP address exists. */ std::string GetIP(); /** * Writes a std::string to the socket. No carriage * returns or linefeeds are appended to the string. * @param data The data to send */ virtual int Write(const std::string &data); /** * If your socket is a listening socket, when a new * connection comes in on the socket this method will * be called. Given the new file descriptor in the * parameters, and the IP, it is recommended you copy * them to a new instance of your socket class, * e.g.: * * MySocket* newsocket = new MySocket(newfd,ip); * * Once you have done this, you can then associate the * new socket with the core using Server::AddSocket(). */ virtual int OnIncomingConnection(int newfd, char* ip); /** * Changes the socket's state. The core uses this * to change socket states, and you should not call * it directly. */ void SetState(InspSocketState s); /** * Call this to receive the next write event * that comes along for this fd to the OnWriteReady * method. */ void WantWrite(); /** * Returns the current socket state. */ InspSocketState GetState(); /** * Only the core should call this function. * When called, it is assumed the socket is ready * to read data, and the method call routes the * event to the various methods of InspSocket * for you to handle. This can also cause the * socket's state to change. */ bool Poll(); /** * This method returns the socket's file descriptor * as assigned by the operating system, or -1 * if no descriptor has been assigned. */ int GetFd(); /** * This method causes the socket to close, and may * also be triggered by other methods such as OnTimeout * and OnError. */ virtual void Close(); /** * The destructor may implicitly call OnClose(), and * will close() and shutdown() the file descriptor * used for this socket. */ virtual ~InspSocket(); /** * This method attempts to connect to a hostname. * This only occurs on a non-listening socket. This * method is asyncronous. */ virtual bool DoConnect(); /** * This method marks the socket closed. * The next time the core examines a socket marked * as closed, the socket will be closed and the * memory reclaimed. * * NOTE: This method is DEPRECIATED and will be * ignored if called! */ void MarkAsClosed(); /** Handle event from EventHandler parent class */ void HandleEvent(EventType et, int errornum = 0); /** Returns true if this socket is readable */ bool Readable(); }; #endif \ No newline at end of file +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2020 Matt Schatz + * Copyright (C) 2019 linuxdaemon + * Copyright (C) 2013, 2015-2016 Attila Molnar + * Copyright (C) 2012-2013, 2017-2019 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007-2009 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006, 2010 Craig Edwards + * Copyright (C) 2006 Oliver Lupton + * + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + + +#pragma once + +#include "timer.h" + +class IOHook; + +/** + * States which a socket may be in + */ +enum BufferedSocketState +{ + /** Socket disconnected */ + I_DISCONNECTED, + /** Socket connecting */ + I_CONNECTING, + /** Socket fully connected */ + I_CONNECTED, + /** Socket has an error */ + I_ERROR +}; + +/** + * Error types which a socket may exhibit + */ +enum BufferedSocketError +{ + /** No error */ + I_ERR_NONE, + /** Socket was closed by peer */ + I_ERR_DISCONNECT, + /** Socket connect timed out */ + I_ERR_TIMEOUT, + /** Socket could not be created */ + I_ERR_SOCKET, + /** Socket could not connect (refused) */ + I_ERR_CONNECT, + /** Socket could not bind to local port/ip */ + I_ERR_BIND, + /** Socket could not write data */ + I_ERR_WRITE, + /** No more file descriptors left to create socket! */ + I_ERR_NOMOREFDS, + /** Some other error */ + I_ERR_OTHER +}; + +/* Required forward declarations */ +class BufferedSocket; + +/** Used to time out socket connections + */ +class CoreExport SocketTimeout : public Timer +{ + private: + /** BufferedSocket the class is attached to + */ + BufferedSocket* sock; + + /** File descriptor of class this is attached to + */ + int sfd; + + public: + /** Create a socket timeout class + * @param fd File descriptor of BufferedSocket + * @param thesock BufferedSocket to attach to + * @param secs_from_now Seconds from now to time out + */ + SocketTimeout(int fd, BufferedSocket* thesock, unsigned int secs_from_now) + : Timer(secs_from_now) + , sock(thesock) + , sfd(fd) + { + } + + /** Handle tick event + */ + bool Tick(time_t now) CXX11_OVERRIDE; +}; + +/** + * StreamSocket is a class that wraps a TCP socket and handles send + * and receive queues, including passing them to IO hooks + */ +class CoreExport StreamSocket : public EventHandler +{ + public: + /** Socket send queue + */ + class SendQueue + { + public: + /** One element of the queue, a continuous buffer + */ + typedef std::string Element; + + /** Sequence container of buffers in the queue + */ + typedef std::deque Container; + + /** Container iterator + */ + typedef Container::const_iterator const_iterator; + + SendQueue() : nbytes(0) { } + + /** Return whether the queue is empty + * @return True if the queue is empty, false otherwise + */ + bool empty() const { return (nbytes == 0); } + + /** Get the number of individual buffers in the queue + * @return Number of individual buffers in the queue + */ + Container::size_type size() const { return data.size(); } + + /** Get the number of queued bytes + * @return Size in bytes of the data in the queue + */ + size_t bytes() const { return nbytes; } + + /** Get the first buffer of the queue + * @return A reference to the first buffer in the queue + */ + const Element& front() const { return data.front(); } + + /** Get an iterator to the first buffer in the queue. + * The returned iterator cannot be used to make modifications to the queue, + * for that purpose the member functions push_*(), pop_front(), erase_front() and clear() can be used. + * @return Iterator referring to the first buffer in the queue, or end() if there are no elements. + */ + const_iterator begin() const { return data.begin(); } + + /** Get an iterator to the (theoretical) buffer one past the end of the queue. + * @return Iterator referring to one element past the end of the container + */ + const_iterator end() const { return data.end(); } + + /** Remove the first buffer in the queue + */ + void pop_front() + { + nbytes -= data.front().length(); + data.pop_front(); + } + + /** Remove bytes from the beginning of the first buffer + * @param n Number of bytes to remove + */ + void erase_front(Element::size_type n) + { + nbytes -= n; + data.front().erase(0, n); + } + + /** Insert a new buffer at the beginning of the queue + * @param newdata Data to add + */ + void push_front(const Element& newdata) + { + data.push_front(newdata); + nbytes += newdata.length(); + } + + /** Insert a new buffer at the end of the queue + * @param newdata Data to add + */ + void push_back(const Element& newdata) + { + data.push_back(newdata); + nbytes += newdata.length(); + } + + /** Clear the queue + */ + void clear() + { + data.clear(); + nbytes = 0; + } + + void moveall(SendQueue& other) + { + nbytes += other.bytes(); + data.insert(data.end(), other.data.begin(), other.data.end()); + other.clear(); + } + + private: + /** Private send queue. Note that individual strings may be shared. + */ + Container data; + + /** Length, in bytes, of the sendq + */ + size_t nbytes; + }; + + /** The type of socket this IOHook represents. */ + enum Type + { + SS_UNKNOWN, + SS_USER + }; + + private: + /** Whether this socket should close once its sendq is empty */ + bool closeonempty; + + /** Whether the socket is currently closing or not, used to avoid repeatedly closing a closed socket */ + bool closing; + + /** The IOHook that handles raw I/O for this socket, or NULL */ + IOHook* iohook; + + /** Send queue of the socket + */ + SendQueue sendq; + + /** Error - if nonempty, the socket is dead, and this is the reason. */ + std::string error; + + /** Check if the socket has an error set, if yes, call OnError + * @param err Error to pass to OnError() + */ + void CheckError(BufferedSocketError err); + + /** Read data from the socket into the recvq, if successful call OnDataReady() + */ + void DoRead(); + + /** Send as much data contained in a SendQueue object as possible. + * All data which successfully sent will be removed from the SendQueue. + * @param sq SendQueue to flush + */ + void FlushSendQ(SendQueue& sq); + + /** Read incoming data into a receive queue. + * @param rq Receive queue to put incoming data into + * @return < 0 on error or close, 0 if no new data is ready (but the socket is still connected), > 0 if data was read from the socket and put into the recvq + */ + int ReadToRecvQ(std::string& rq); + + /** Read data from a hook chain recursively, starting at 'hook'. + * If 'hook' is NULL, the recvq is filled with data from SocketEngine::Recv(), otherwise it is filled with data from the + * next hook in the chain. + * @param hook Next IOHook in the chain, can be NULL + * @param rq Receive queue to put incoming data into + * @return < 0 on error or close, 0 if no new data is ready (but the socket is still connected), > 0 if data was read from + * the socket and put into the recvq + */ + int HookChainRead(IOHook* hook, std::string& rq); + + protected: + /** The data which has been received from the socket. */ + std::string recvq; + + /** Swaps the internals of this StreamSocket with another one. + * @param other A StreamSocket to swap internals with. + */ + void SwapInternals(StreamSocket& other); + + public: + const Type type; + StreamSocket(Type sstype = SS_UNKNOWN) + : closeonempty(false) + , closing(false) + , iohook(NULL) + , type(sstype) + { + } + IOHook* GetIOHook() const; + void AddIOHook(IOHook* hook); + void DelIOHook(); + + /** Flush the send queue + */ + void DoWrite(); + + /** Called by the socket engine on a read event + */ + void OnEventHandlerRead() CXX11_OVERRIDE; + + /** Called by the socket engine on a write event + */ + void OnEventHandlerWrite() CXX11_OVERRIDE; + + /** Called by the socket engine on error + * @param errcode Error + */ + void OnEventHandlerError(int errcode) CXX11_OVERRIDE; + + /** Sets the error message for this socket. Once set, the socket is dead. */ + void SetError(const std::string& err) { if (error.empty()) error = err; } + + /** Gets the error message for this socket. */ + const std::string& getError() const { return error; } + + /** Called when new data is present in recvq */ + virtual void OnDataReady() = 0; + /** Called when the socket gets an error from socket engine or IO hook */ + virtual void OnError(BufferedSocketError e) = 0; + + /** Called when the endpoint addresses are changed. + * @param local The new local endpoint. + * @param remote The new remote endpoint. + * @return true if the connection is still open, false if it has been closed + */ + virtual bool OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote); + + /** Send the given data out the socket, either now or when writes unblock + */ + void WriteData(const std::string& data); + /** Convenience function: read a line from the socket + * @param line The line read + * @param delim The line delimiter + * @return true if a line was read + */ + bool GetNextLine(std::string& line, char delim = '\n'); + /** Useful for implementing sendq exceeded */ + size_t getSendQSize() const; + + SendQueue& GetSendQ() { return sendq; } + + /** + * Close the socket, remove from socket engine, etc + */ + virtual void Close(); + + /** If writeblock is true then only close the socket if all data has been sent. Otherwise, close immediately. */ + void Close(bool writeblock); + + /** This ensures that close is called prior to destructor */ + CullResult cull() CXX11_OVERRIDE; + + /** Get the IOHook of a module attached to this socket + * @param mod Module whose IOHook to return + * @return IOHook belonging to the module or NULL if the module haven't attached an IOHook to this socket + */ + IOHook* GetModHook(Module* mod) const; + + /** Get the last IOHook attached to this socket + * @return The last IOHook attached to this socket or NULL if no IOHooks are attached + */ + IOHook* GetLastHook() const; +}; +/** + * BufferedSocket is an extendable socket class which modules + * can use for TCP socket support. It is fully integrated + * into InspIRCds socket loop and attaches its sockets to + * the core's instance of the SocketEngine class, meaning + * that all use is fully asynchronous. + * + * To use BufferedSocket, you must inherit a class from it. + */ +class CoreExport BufferedSocket : public StreamSocket +{ + public: + /** Timeout object or NULL + */ + SocketTimeout* Timeout; + + /** + * The state for this socket, either + * listening, connecting, connected + * or error. + */ + BufferedSocketState state; + + BufferedSocket(); + /** + * This constructor is used to associate + * an existing connecting with an BufferedSocket + * class. The given file descriptor must be + * valid, and when initialized, the BufferedSocket + * will be placed in CONNECTED state. + */ + BufferedSocket(int newfd); + + /** Begin connection to the given address + * This will create a socket, register with socket engine, and start the asynchronous + * connection process. If an error is detected at this point (such as out of file descriptors), + * OnError will be called; otherwise, the state will become CONNECTING. + * @param dest Remote endpoint to connect to. + * @param bind Local endpoint to connect from. + * @param maxtime Time to wait for connection + */ + void DoConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned int maxtime); + + /** This method is called when an outbound connection on your socket is + * completed. + */ + virtual void OnConnected(); + + /** When there is data waiting to be read on a socket, the OnDataReady() + * method is called. + */ + void OnDataReady() CXX11_OVERRIDE = 0; + + /** + * When an outbound connection fails, and the attempt times out, you + * will receive this event. The method will trigger once maxtime + * seconds are reached (as given in the constructor) just before the + * socket's descriptor is closed. A failed DNS lookup may cause this + * event if the DNS server is not responding, as well as a failed + * connect() call, because DNS lookups are nonblocking as implemented by + * this class. + */ + virtual void OnTimeout(); + + virtual ~BufferedSocket(); + protected: + void OnEventHandlerWrite() CXX11_OVERRIDE; + BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned int timeout); +}; + +inline IOHook* StreamSocket::GetIOHook() const { return iohook; } +inline void StreamSocket::DelIOHook() { iohook = NULL; }