]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/socket.h
As we have an enum for type, why not ..use it?
[user/henk/code/inspircd.git] / include / socket.h
index 458cbe69045dd3f06ad507f9fbe1dd7cea3a0d07..e1050201ae20b13b4b36d48f4ee17c00fa317d53 100644 (file)
@@ -1 +1,226 @@
-/*       +------------------------------------+\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 INSPIRCD_SOCKET_H\r#define INSPIRCD_SOCKET_H\r\r#ifndef WIN32\r\r#include <arpa/inet.h>\r#include <sys/time.h>\r#include <sys/resource.h>\r#include <sys/types.h>\r#include <sys/socket.h>\r#include <sys/stat.h>\r#include <netinet/in.h>\r#include <unistd.h>\r#include <fcntl.h>\r#include <netdb.h>\r\r#else\r\r#include "inspircd_win32wrapper.h"\r\r#endif\r\r#include <errno.h>\r#include "inspircd_config.h"\r#include "socketengine.h"\r\r/* Accept Define */\r#ifdef CONFIG_USE_IOCP\r/* IOCP wrapper for accept() */\r#define _accept(s, addr, addrlen) __accept_socket(s, addr, addrlen, m_acceptEvent)\r/* IOCP wrapper for getsockname() */\r#define _getsockname(fd, sockptr, socklen) __getsockname(fd, sockptr, socklen, m_acceptEvent)\r/* IOCP wrapper for recvfrom() */\r#define _recvfrom(s, buf, len, flags, from, fromlen) __recvfrom(s, buf, len, flags, from, fromlen, ((IOCPEngine*)ServerInstance->SE)->udp_ov)\r#else\r/* No wrapper for recvfrom() */\r#define _recvfrom recvfrom\r/* No wrapper for accept() */\r#define _accept accept\r/* No wrapper for getsockname() */\r#define _getsockname getsockname\r#endif\r\r/* Contains irc-specific definitions */\rnamespace irc\r{\r       /** This namespace contains various protocol-independent helper classes.\r        * It also contains some types which are often used by the core and modules\r     * in place of inet_* functions and types.\r      */\r    namespace sockets\r      {\r\r     /* macros to the relevant system address description structs */\r#ifdef IPV6\r            /** insp_sockaddr for ipv6\r              */\r            typedef struct sockaddr_in6 insp_sockaddr;\r             /** insp_inaddr for ipv6\r                */\r            typedef struct in6_addr     insp_inaddr;\r#define AF_FAMILY AF_INET6\r#define PF_PROTOCOL PF_INET6\r\r#else\r                /** insp_sockaddr for ipv4\r              */\r            typedef struct sockaddr_in  insp_sockaddr;\r             /** insp_inaddr for ipv4\r                */\r            typedef struct in_addr      insp_inaddr;\r#define AF_FAMILY AF_INET\r#define PF_PROTOCOL PF_INET\r\r#endif\r         /** Match raw binary data using CIDR rules.\r             * \r             * This function will use binary comparison to compare the\r              * two bit sequences, address and mask, up to mask_bits\r                 * bits in size. If they match, it will return true.\r            * @param address The whole address, of 4 or 16 bytes in length\r                 * @param mask The mask, from 1 to 16 bytes in length, anything\r                 * from 1 to 128 bits of which is significant\r           * @param mask_Bits How many bits of the mask parameter are significant\r                 * for this comparison.\r                 * @returns True if the first mask_bits of address matches the first\r            * mask_bits of mask.\r           */\r            CoreExport bool MatchCIDRBits(unsigned char* address, unsigned char* mask, unsigned int mask_bits);\r\r           /** Match CIDR, without matching username/nickname parts.\r               *\r              * This function will compare a human-readable address against a human-\r                 * readable CIDR mask, for example 1.2.3.4 against 1.2.0.0/16. This\r             * method supports both IPV4 and IPV6 addresses.\r                * @param address The human readable address, e.g. 1.2.3.4\r              * @param cidr_mask The human readable mask, e.g. 1.2.0.0/16\r            * @return True if the mask matches the address\r                 */\r            CoreExport bool MatchCIDR(const char* address, const char* cidr_mask);\r\r                /** Match CIDR, including an optional username/nickname part.\r           *\r              * This function will compare a human-readable address (plus\r            * optional username and nickname) against a human-readable\r             * CIDR mask, for example joe!bloggs\@1.2.3.4 against\r           * *!bloggs\@1.2.0.0/16. This method supports both IPV4 and\r             * IPV6 addresses.\r              * @param address The human readable address, e.g. fred\@1.2.3.4\r                * @param cidr_mask The human readable mask, e.g. *\@1.2.0.0/16\r                 * @return True if the mask matches the address\r                 */\r            CoreExport bool MatchCIDR(const char* address, const char* cidr_mask, bool match_with_username);\r\r              /** Convert an insp_inaddr into human readable form.\r            * \r             * @param n An insp_inaddr (IP address) structure\r               * @return A human-readable address. IPV6 addresses\r             * will be shortened to remove fields which are 0.\r              */\r            CoreExport const char* insp_ntoa(insp_inaddr n);\r\r              /** Convert a human-readable address into an insp_inaddr.\r               * \r             * @param a A human-readable address\r            * @param n An insp_inaddr struct which the result\r              * will be copied into on success.\r              * @return This method will return a negative value if address\r          * does not contain a valid address family. 0 if the address is\r                 * does not contain a valid string representing a valid network\r                 * address. A positive value is returned if the network address\r                 * was successfully converted.\r\r                 * or any other number upon failure.\r            */\r            CoreExport int insp_aton(const char* a, insp_inaddr* n);\r\r              /** Make a socket file descriptor a blocking socket\r             * @param s A valid file descriptor\r             */\r            CoreExport void Blocking(int s);\r\r              /** Make a socket file descriptor into a nonblocking socket\r             * @param s A valid file descriptor\r             */\r            CoreExport void NonBlocking(int s);\r\r           /** Create a new valid file descriptor using socket()\r           * @return On return this function will return a value >= 0 for success,\r                * or a negative value upon failure (negative values are invalid file\r           * descriptors)\r                 */\r            CoreExport int OpenTCPSocket(char* addr, int socktype = SOCK_STREAM);\r  }\r}\r\r/** This class handles incoming connections on client ports.\r * It will create a new userrec for every valid connection\r * and assign it a file descriptor.\r */\rclass CoreExport ListenSocket : public EventHandler\r{\r protected:\r /** The creator/owner of this object\r    */\r    InspIRCd* ServerInstance;\r      /** Socket description (shown in stats p) */\r   std::string desc;\r      /** Socket address family */\r   int family;\r    /** Address socket is bound to */\r      std::string bind_addr;\r /** Port socket is bound to */\r int bind_port;\r public:\r        /** Create a new listening socket\r       */\r    ListenSocket(InspIRCd* Instance, int port, char* addr);\r        /** Handle an I/O event\r         */\r    void HandleEvent(EventType et, int errornum = 0);\r      /** Close the socket\r    */\r    ~ListenSocket();\r       /** Set descriptive text\r        */\r    void SetDescription(const std::string &description)\r    {\r              desc = description;\r    }\r      /** Get description for socket\r  */\r    const std::string& GetDescription()\r    {\r              return desc;\r   }\r      /** Get port number for socket\r  */\r    int GetPort()\r  {\r              return bind_port;\r      }\r      /** Get IP address socket is bound to\r   */\r    std::string &GetIP()\r   {\r              return bind_addr;\r      }\r};\r\r#endif\r\r
\ No newline at end of file
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2008 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 INSPIRCD_SOCKET_H
+#define INSPIRCD_SOCKET_H
+
+#ifndef WIN32
+
+#include <arpa/inet.h>
+#include <sys/time.h>
+#include <sys/resource.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/stat.h>
+#include <netinet/in.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <netdb.h>
+
+#else
+
+#include "inspircd_win32wrapper.h"
+
+#endif
+
+#include <cerrno>
+#include "socketengine.h"
+
+/* Contains irc-specific definitions */
+namespace irc
+{
+       /** This namespace contains various protocol-independent helper classes.
+        * It also contains some types which are often used by the core and modules
+        * in place of inet_* functions and types.
+        */
+       namespace sockets
+       {
+
+       /* macros to the relevant system address description structs */
+#ifdef IPV6
+               /** insp_sockaddr for ipv6
+                */
+               typedef struct sockaddr_in6 insp_sockaddr;
+               /** insp_inaddr for ipv6
+                */
+               typedef struct in6_addr     insp_inaddr;
+#define AF_FAMILY AF_INET6
+#define PF_PROTOCOL PF_INET6
+
+#else
+               /** insp_sockaddr for ipv4
+                */
+               typedef struct sockaddr_in  insp_sockaddr;
+               /** insp_inaddr for ipv4
+                */
+               typedef struct in_addr      insp_inaddr;
+#define AF_FAMILY AF_INET
+#define PF_PROTOCOL PF_INET
+
+#endif
+               /** Match raw binary data using CIDR rules.
+                *
+                * This function will use binary comparison to compare the
+                * two bit sequences, address and mask, up to mask_bits
+                * bits in size. If they match, it will return true.
+                * @param address The whole address, of 4 or 16 bytes in length
+                * @param mask The mask, from 1 to 16 bytes in length, anything
+                * from 1 to 128 bits of which is significant
+                * @param mask_Bits How many bits of the mask parameter are significant
+                * for this comparison.
+                * @returns True if the first mask_bits of address matches the first
+                * mask_bits of mask.
+                */
+               CoreExport bool MatchCIDRBits(const unsigned char* address, const unsigned char* mask, unsigned int mask_bits);
+
+               /** Match CIDR, without matching username/nickname parts.
+                *
+                * This function will compare a human-readable address against a human-
+                * readable CIDR mask, for example 1.2.3.4 against 1.2.0.0/16. This
+                * method supports both IPV4 and IPV6 addresses.
+                * @param address The human readable address, e.g. 1.2.3.4
+                * @param cidr_mask The human readable mask, e.g. 1.2.0.0/16
+                * @return True if the mask matches the address
+                */
+               CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask);
+
+               /** Match CIDR, including an optional username/nickname part.
+                *
+                * This function will compare a human-readable address (plus
+                * optional username and nickname) against a human-readable
+                * CIDR mask, for example joe!bloggs\@1.2.3.4 against
+                * *!bloggs\@1.2.0.0/16. This method supports both IPV4 and
+                * IPV6 addresses.
+                * @param address The human readable address, e.g. fred\@1.2.3.4
+                * @param cidr_mask The human readable mask, e.g. *\@1.2.0.0/16
+                * @return True if the mask matches the address
+                */
+               CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask, bool match_with_username);
+
+               /** Convert an insp_inaddr into human readable form.
+                *
+                * @param n An insp_inaddr (IP address) structure
+                * @return A human-readable address. IPV6 addresses
+                * will be shortened to remove fields which are 0.
+                */
+               CoreExport const char* insp_ntoa(insp_inaddr n);
+
+               /** Convert a human-readable address into an insp_inaddr.
+                *
+                * @param a A human-readable address
+                * @param n An insp_inaddr struct which the result
+                * will be copied into on success.
+                * @return This method will return a negative value if address
+                * does not contain a valid address family. 0 if the address is
+                * does not contain a valid string representing a valid network
+                * address. A positive value is returned if the network address
+                * was successfully converted.
+
+                * or any other number upon failure.
+                */
+               CoreExport int insp_aton(const char* a, insp_inaddr* n);
+
+               /** Create a new valid file descriptor using socket()
+                * @return On return this function will return a value >= 0 for success,
+                * or a negative value upon failure (negative values are invalid file
+                * descriptors)
+                */
+               CoreExport int OpenTCPSocket(const char* addr, int socktype = SOCK_STREAM);
+       }
+}
+
+
+
+/** This class handles incoming connections on client ports.
+ * It will create a new User for every valid connection
+ * and assign it a file descriptor.
+ */
+class CoreExport ListenSocketBase : public EventHandler
+{
+ protected:
+       /** The creator/owner of this object
+        */
+       InspIRCd* ServerInstance;
+       /** Socket description (shown in stats p) */
+       std::string desc;
+       /** Socket address family */
+       int family;
+       /** Address socket is bound to */
+       std::string bind_addr;
+       /** Port socket is bound to */
+       int bind_port;
+
+       static sockaddr *sock_us;
+
+       static sockaddr *client;
+
+       static sockaddr *raddr;
+
+       static unsigned int socketcount;
+
+ public:
+       /** Create a new listening socket
+        */
+       ListenSocketBase(InspIRCd* Instance, int port, const std::string &addr);
+       /** Handle an I/O event
+        */
+       void HandleEvent(EventType et, int errornum = 0);
+       /** Close the socket
+        */
+       ~ListenSocketBase();
+       /** Set descriptive text
+        */
+       void SetDescription(const std::string &description)
+       {
+               desc = description;
+       }
+       /** Get description for socket
+        */
+       const std::string& GetDescription()
+       {
+               return desc;
+       }
+       /** Get port number for socket
+        */
+       int GetPort()
+       {
+               return bind_port;
+       }
+       /** Get IP address socket is bound to
+        */
+       std::string &GetIP()
+       {
+               return bind_addr;
+       }
+
+       /** Handles sockets internals crap of a connection, convenience wrapper really
+        */
+       void AcceptInternal();
+
+       /** Called when a new connection has successfully been accepted on this listener.
+        * @param ipconnectedto The IP address the connection arrived on
+        * @param fd The file descriptor of the new connection
+        * @param incomingip The IP from which the connection was made
+        */
+       virtual void OnAcceptReady(const std::string &ipconnectedto, int fd, const std::string &incomingip) = 0;
+};
+
+class CoreExport ClientListenSocket : public ListenSocketBase
+{
+       virtual void OnAcceptReady(const std::string &ipconnectedto, int fd, const std::string &incomingip);
+ public:
+       ClientListenSocket(InspIRCd* Instance, int port, const std::string &addr) : ListenSocketBase(Instance, port, addr) { }
+};
+
+#endif
+