-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
+ * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ * Copyright (C) 2013, 2015-2016 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012-2013, 2017-2019 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006, 2010 Craig Edwards <brain@inspircd.org>
+ * Copyright (C) 2006 Oliver Lupton <om@inspircd.org>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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 <http://www.gnu.org/licenses/>.
*/
-#ifndef __INSP_SOCKET_H__
-#define __INSP_SOCKET_H__
+
+#pragma once
#include "timer.h"
+class IOHook;
+
/**
* States which a socket may be in
*/
*/
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_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
+ I_ERR_NOMOREFDS,
+ /** Some other error */
+ I_ERR_OTHER
};
/* Required forward declarations */
class BufferedSocket;
-class InspIRCd;
/** Used to time out socket connections
*/
*/
BufferedSocket* 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 BufferedSocket
- * @pram Instance server instance to attach to
* @param thesock BufferedSocket to attach to
* @param secs_from_now Seconds from now to time out
- * @param now The current time
*/
- SocketTimeout(int fd, InspIRCd* Instance, BufferedSocket* thesock, long secs_from_now, time_t now) : Timer(secs_from_now, now), sock(thesock), ServerInstance(Instance), sfd(fd) { };
+ SocketTimeout(int fd, BufferedSocket* thesock, unsigned int secs_from_now)
+ : Timer(secs_from_now)
+ , sock(thesock)
+ , sfd(fd)
+ {
+ }
/** Handle tick event
*/
- virtual void Tick(time_t now);
+ bool Tick(time_t now) CXX11_OVERRIDE;
};
/**
- * 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.
+ * StreamSocket is a class that wraps a TCP socket and handles send
+ * and receive queues, including passing them to IO hooks
*/
-class CoreExport BufferedSocket : public EventHandler
+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<Element> 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
+ };
- /** Bind IP
- */
- std::string cbindip;
+ private:
+ /** Whether this socket should close once its sendq is empty */
+ bool closeonempty;
- /** Instance we were created by
- */
- InspIRCd* ServerInstance;
+ /** Whether the socket is currently closing or not, used to avoid repeatedly closing a closed socket */
+ bool closing;
- /** Timeout class or NULL
- */
- SocketTimeout* Timeout;
+ /** The IOHook that handles raw I/O for this socket, or NULL */
+ IOHook* iohook;
- /** Socket output buffer (binary safe)
+ /** Send queue of the socket
*/
- std::deque<std::string> outbuffer;
+ SendQueue sendq;
- /** The hostname connected to
- */
- char host[MAXBUF];
+ /** Error - if nonempty, the socket is dead, and this is the reason. */
+ std::string error;
- /** The port connected to
+ /** Check if the socket has an error set, if yes, call OnError
+ * @param err Error to pass to OnError()
*/
- int port;
+ void CheckError(BufferedSocketError err);
- /**
- * The state for this socket, either
- * listening, connecting, connected
- * or error.
+ /** Read data from the socket into the recvq, if successful call OnDataReady()
*/
- BufferedSocketState state;
+ void DoRead();
- /**
- * The IP address being connected
- * to stored in string form for
- * easy retrieval by accessors.
+ /** 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
*/
- char IP[MAXBUF];
+ void FlushSendQ(SendQueue& sq);
- /**
- * Used by accept() to indicate the
- * sizes of the sockaddr_in structures
+ /** 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
*/
- socklen_t length;
+ int ReadToRecvQ(std::string& rq);
- /** Flushes the write buffer
- * @returns true if the writing failed, false if it was successful
+ /** 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
*/
- bool FlushWriteBuffer();
+ int HookChainRead(IOHook* hook, std::string& rq);
- /** 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();
+ protected:
+ /** The data which has been received from the socket. */
+ std::string recvq;
- /** 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.
+ /** Swaps the internals of this StreamSocket with another one.
+ * @param other A StreamSocket to swap internals with.
*/
- bool ClosePending;
+ void SwapInternals(StreamSocket& other);
- /**
- * Bind to an address
- * @param ip IP to bind to
- * @return True is the binding succeeded
- */
- bool BindAddr(const std::string &ip);
+ 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();
- /**
- * The default constructor does nothing
- * and should not be used.
+ /** Flush the send queue
*/
- BufferedSocket(InspIRCd* SI);
+ void DoWrite();
- /**
- * 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 set with the given IP address
- * and placed in CONNECTED state.
+ /** Called by the socket engine on a read event
*/
- BufferedSocket(InspIRCd* SI, int newfd, const char* ip);
+ void OnEventHandlerRead() CXX11_OVERRIDE;
- /**
- * This constructor is used to create a new 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 BufferedSocket. 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
- * @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.
+ /** Called by the socket engine on a write event
*/
- BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, unsigned long maxtime, const std::string &connectbindip = "");
+ void OnEventHandlerWrite() CXX11_OVERRIDE;
- /**
- * This method is called when an outbound
- * connection on your socket is completed.
- * @return false to abort the connection, true to continue
+ /** Called by the socket engine on error
+ * @param errcode Error
*/
- virtual bool OnConnected();
+ void OnEventHandlerError(int errcode) CXX11_OVERRIDE;
- /**
- * 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(BufferedSocketError e);
+ /** Sets the error message for this socket. Once set, the socket is dead. */
+ void SetError(const std::string& err) { if (error.empty()) error = err; }
- /**
- * When an established connection is terminated,
- * the OnDisconnect method is triggered.
- */
- virtual int OnDisconnect();
+ /** Gets the error message for this socket. */
+ const std::string& getError() const { return error; }
- /**
- * 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 BufferedSocket::Close() and deletes it.
- * @return false to close the socket
- */
- virtual bool OnDataReady();
+ /** 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;
- /**
- * 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 SocketEngine::WantWrite().
- *
- * The default behaviour of this method is to
- * flush the write buffer, respecting the IO
- * hooking modules.
- *
- * XXX: this used to be virtual, ask us if you need it to be so.
- * @return false to close the socket
+ /** 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
*/
- bool OnWriteReady();
+ virtual bool OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote);
- /**
- * 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.
+ /** Send the given data out the socket, either now or when writes unblock
*/
- 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().
+ 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
*/
- virtual void OnClose();
+ bool GetNextLine(std::string& line, char delim = '\n');
+ /** Useful for implementing sendq exceeded */
+ size_t getSendQSize() const;
+
+ SendQueue& GetSendQ() { return sendq; }
/**
- * Reads all pending bytes from the socket
- * into a char* array which can be up to
- * 16 kilobytes in length.
+ * Close the socket, remove from socket engine, etc
*/
- virtual const char* Read();
+ virtual void Close();
- /**
- * Returns the IP address associated with
- * this connection, or an empty string if
- * no IP address exists.
+ /** 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
*/
- std::string GetIP();
+ IOHook* GetModHook(Module* mod) const;
- /**
- * Writes a std::string to the socket. No carriage
- * returns or linefeeds are appended to the string.
- * @param data The data to send
+ /** Get the last IOHook attached to this socket
+ * @return The last IOHook attached to this socket or NULL if no IOHooks are attached
*/
- virtual void Write(const std::string &data);
+ 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;
/**
- * Changes the socket's state. The core uses this
- * to change socket states, and you should not call
- * it directly.
+ * The state for this socket, either
+ * listening, connecting, connected
+ * or error.
*/
- void SetState(BufferedSocketState s);
+ BufferedSocketState state;
+ BufferedSocket();
/**
- * Returns the current socket state.
+ * 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.
*/
- BufferedSocketState GetState();
+ BufferedSocket(int newfd);
- /** Mark a socket as being connected and call appropriate events.
+ /** 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
*/
- bool InternalMarkConnected();
+ void DoConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned int maxtime);
- /**
- * This method causes the socket to close, and may
- * also be triggered by other methods such as OnTimeout
- * and OnError.
+ /** This method is called when an outbound connection on your socket is
+ * completed.
*/
- virtual void Close();
+ virtual void OnConnected();
- /**
- * The destructor may implicitly call OnClose(), and
- * will close() and shutdown() the file descriptor
- * used for this socket.
+ /** When there is data waiting to be read on a socket, the OnDataReady()
+ * method is called.
*/
- virtual ~BufferedSocket();
+ void OnDataReady() CXX11_OVERRIDE = 0;
/**
- * This method attempts to connect to a hostname.
- * This method is asyncronous.
- * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
- */
- virtual bool DoConnect(unsigned long maxtime);
-
- /** Handle event from EventHandler parent class
+ * 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.
*/
- void HandleEvent(EventType et, int errornum = 0);
+ virtual void OnTimeout();
- /** Returns true if this socket is readable
- */
- bool Readable();
+ virtual ~BufferedSocket();
+ protected:
+ void OnEventHandlerWrite() CXX11_OVERRIDE;
+ BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned int timeout);
};
-#endif
-
+inline IOHook* StreamSocket::GetIOHook() const { return iohook; }
+inline void StreamSocket::DelIOHook() { iohook = NULL; }
projects / user / henk / code / inspircd.git / blobdiff