]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Merge insp20
[user/henk/code/inspircd.git] / include / inspircd.h
index d045b347b6ddf59539a22a17d66b9cf0a989f5e8..303d24745664ef2936e7c145e4ad17b1cf24a809 100644 (file)
@@ -32,6 +32,7 @@
 #include <cstdio>
 #include <cstring>
 #include <ctime>
+#include <stdint.h>
 
 #include <algorithm>
 #include <bitset>
 #include <string>
 #include <vector>
 
+#include "intrusive_list.h"
+#include "flat_map.h"
 #include "compat.h"
+#include "aligned_storage.h"
 #include "typedefs.h"
+#include "stdalgo.h"
 
 CoreExport extern InspIRCd* ServerInstance;
 
+/** Base class for manager classes that are still accessed using -> but are no longer pointers
+ */
+template <typename T>
+struct fakederef
+{
+       T* operator->()
+       {
+               return static_cast<T*>(this);
+       }
+};
+
 #include "config.h"
+#include "convto.h"
 #include "dynref.h"
 #include "consolecolors.h"
 #include "caller.h"
@@ -56,7 +73,9 @@ CoreExport extern InspIRCd* ServerInstance;
 #include "extensible.h"
 #include "fileutils.h"
 #include "numerics.h"
+#include "numeric.h"
 #include "uid.h"
+#include "server.h"
 #include "users.h"
 #include "channels.h"
 #include "timer.h"
@@ -75,83 +94,8 @@ CoreExport extern InspIRCd* ServerInstance;
 #include "configreader.h"
 #include "inspstring.h"
 #include "protocol.h"
-
-/** Returned by some functions to indicate failure.
- */
-#define ERROR -1
-
-/** Template function to convert any input type to std::string
- */
-template<typename T> inline std::string ConvNumeric(const T &in)
-{
-       if (in == 0)
-               return "0";
-       T quotient = in;
-       std::string out;
-       while (quotient)
-       {
-               out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
-               quotient /= 10;
-       }
-       if (in < 0)
-               out += '-';
-       std::reverse(out.begin(), out.end());
-       return out;
-}
-
-/** Template function to convert any input type to std::string
- */
-inline std::string ConvToStr(const int in)
-{
-       return ConvNumeric(in);
-}
-
-/** Template function to convert any input type to std::string
- */
-inline std::string ConvToStr(const long in)
-{
-       return ConvNumeric(in);
-}
-
-/** Template function to convert any input type to std::string
- */
-inline std::string ConvToStr(const char* in)
-{
-       return in;
-}
-
-/** Template function to convert any input type to std::string
- */
-inline std::string ConvToStr(const bool in)
-{
-       return (in ? "1" : "0");
-}
-
-/** Template function to convert any input type to std::string
- */
-inline std::string ConvToStr(char in)
-{
-       return std::string(in,1);
-}
-
-/** Template function to convert any input type to std::string
- */
-template <class T> inline std::string ConvToStr(const T &in)
-{
-       std::stringstream tmp;
-       if (!(tmp << in)) return std::string();
-       return tmp.str();
-}
-
-/** Template function to convert any input type to any other type
- * (usually an integer or numeric type)
- */
-template<typename T> inline long ConvToInt(const T &in)
-{
-       std::stringstream tmp;
-       if (!(tmp << in)) return 0;
-       return atol(tmp.str().c_str());
-}
+#include "bancache.h"
+#include "isupportmanager.h"
 
 /** This class contains various STATS counters
  * It is used by the InspIRCd class, which internally
@@ -162,38 +106,38 @@ class serverstats
   public:
        /** Number of accepted connections
         */
-       unsigned long statsAccept;
+       unsigned long Accept;
        /** Number of failed accepts
         */
-       unsigned long statsRefused;
+       unsigned long Refused;
        /** Number of unknown commands seen
         */
-       unsigned long statsUnknown;
+       unsigned long Unknown;
        /** Number of nickname collisions handled
         */
-       unsigned long statsCollisions;
+       unsigned long Collisions;
        /** Number of DNS queries sent out
         */
-       unsigned long statsDns;
+       unsigned long Dns;
        /** Number of good DNS replies received
         * NOTE: This may not tally to the number sent out,
         * due to timeouts and other latency issues.
         */
-       unsigned long statsDnsGood;
+       unsigned long DnsGood;
        /** Number of bad (negative) DNS replies received
         * NOTE: This may not tally to the number sent out,
         * due to timeouts and other latency issues.
         */
-       unsigned long statsDnsBad;
+       unsigned long DnsBad;
        /** Number of inbound connections seen
         */
-       unsigned long statsConnects;
+       unsigned long Connects;
        /** Total bytes of data transmitted
         */
-       unsigned long statsSent;
+       unsigned long Sent;
        /** Total bytes of data received
         */
-       unsigned long statsRecv;
+       unsigned long Recv;
 #ifdef _WIN32
        /** Cpu usage at last sample
        */
@@ -215,33 +159,12 @@ class serverstats
        /** The constructor initializes all the counts to zero
         */
        serverstats()
-               : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
-               statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
+               : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
+               DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
        {
        }
 };
 
-/** This class manages the generation and transmission of ISUPPORT. */
-class CoreExport ISupportManager
-{
-private:
-       /** The generated lines which are sent to clients. */
-       std::vector<std::string> Lines;
-
-public:
-       /** (Re)build the ISUPPORT vector. */
-       void Build();
-
-       /** Returns the std::vector of ISUPPORT lines. */
-       const std::vector<std::string>& GetLines()
-       {
-               return this->Lines;
-       }
-
-       /** Send the 005 numerics (ISUPPORT) to a user. */
-       void SendTo(LocalUser* user);
-};
-
 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
@@ -326,19 +249,15 @@ class CoreExport InspIRCd
 
        /** Mode handler, handles mode setting and removal
         */
-       ModeParser* Modes;
+       ModeParser Modes;
 
        /** Command parser, handles client to server commands
         */
-       CommandParser* Parser;
-
-       /** Socket engine, handles socket activity events
-        */
-       SocketEngine* SE;
+       CommandParser Parser;
 
        /** Thread engine, Handles threading where required
         */
-       ThreadEngine* Threads;
+       ThreadEngine Threads;
 
        /** The thread/class used to read config files in REHASH and on startup
         */
@@ -346,21 +265,21 @@ class CoreExport InspIRCd
 
        /** LogManager handles logging.
         */
-       LogManager *Logs;
+       LogManager Logs;
 
        /** ModuleManager contains everything related to loading/unloading
         * modules.
         */
-       ModuleManager* Modules;
+       ModuleManager Modules;
 
        /** BanCacheManager is used to speed up checking of restrictions on connection
         * to the IRCd.
         */
-       BanCacheManager *BanCache;
+       BanCacheManager BanCache;
 
        /** Stats class, holds miscellaneous stats counters
         */
-       serverstats* stats;
+       serverstats stats;
 
        /**  Server Config class, holds configuration file data
         */
@@ -369,11 +288,11 @@ class CoreExport InspIRCd
        /** Snomask manager - handles routing of snomask messages
         * to opers.
         */
-       SnomaskManager* SNO;
+       SnomaskManager SNO;
 
        /** Timer manager class, triggers Timer timer events
         */
-       TimerManager* Timers;
+       TimerManager Timers;
 
        /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
         */
@@ -381,11 +300,11 @@ class CoreExport InspIRCd
 
        /** User manager. Various methods and data associated with users.
         */
-       UserManager *Users;
+       UserManager Users;
 
        /** Channel list, a hash_map containing all channels XXX move to channel manager class
         */
-       chan_hash* chanlist;
+       chan_hash chanlist;
 
        /** List of the open ports
         */
@@ -399,6 +318,10 @@ class CoreExport InspIRCd
         */
        ProtocolInterface* PI;
 
+       /** Default implementation of the ProtocolInterface, does nothing
+        */
+       ProtocolInterface DefaultProtocolInterface;
+
        /** Holds extensible for user operquit
         */
        StringExtItem OperQuit;
@@ -436,24 +359,6 @@ class CoreExport InspIRCd
         */
        int BindPorts(FailedPortList &failed_ports);
 
-       /** Binds a socket on an already open file descriptor
-        * @param sockfd A valid file descriptor of an open socket
-        * @param port The port number to bind to
-        * @param addr The address to bind to (IP only)
-        * @param dolisten Should this port be listened on?
-        * @return True if the port was bound successfully
-        */
-       bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
-
-       /** Gets the GECOS (description) field of the given server.
-        * If the servername is not that of the local server, the name
-        * is passed to handling modules which will attempt to determine
-        * the GECOS that bleongs to the given servername.
-        * @param servername The servername to find the description of
-        * @return The description of this server, or of the local server
-        */
-       std::string GetServerDescription(const std::string& servername);
-
        /** Find a user in the nick hash.
         * If the user cant be found in the nick hash check the uuid hash
         * @param nick The nickname to find
@@ -471,6 +376,11 @@ class CoreExport InspIRCd
         */
        Channel* FindChan(const std::string &chan);
 
+       /** Get a hash map containing all channels, keyed by their name
+        * @return A hash map mapping channel names to Channel pointers
+        */
+       chan_hash& GetChans() { return chanlist; }
+
        /** Return true if a channel name is valid
         * @param chname A channel name to verify
         * @return True if the name is valid
@@ -513,16 +423,6 @@ class CoreExport InspIRCd
        static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
        static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
 
-       /** Return a count of channels on the network
-        * @return The number of channels
-        */
-       long ChannelCount() const { return chanlist->size(); }
-
-       /** Send an error notice to all local users, opered and unopered
-        * @param s The error string to send
-        */
-       void SendError(const std::string &s);
-
        /** Return true if a nickname is valid
         * @param n A nickname to verify
         * @return True if the nick is valid
@@ -567,7 +467,7 @@ class CoreExport InspIRCd
         */
        static bool IsValidMask(const std::string& mask);
 
-       /** Strips all color codes from the given string
+       /** Strips all color and control codes except 001 from the given string
         * @param sentence The string to strip from
         */
        static void StripColor(std::string &sentence);
@@ -582,27 +482,6 @@ class CoreExport InspIRCd
         */
        void Rehash(const std::string& uuid = "");
 
-       /** Check if the given nickmask matches too many users, send errors to the given user
-        * @param nick A nickmask to match against
-        * @param user A user to send error text to
-        * @return True if the nick matches too many users
-        */
-       bool NickMatchesEveryone(const std::string &nick, User* user);
-
-       /** Check if the given IP mask matches too many users, send errors to the given user
-        * @param ip An ipmask to match against
-        * @param user A user to send error text to
-        * @return True if the ip matches too many users
-        */
-       bool IPMatchesEveryone(const std::string &ip, User* user);
-
-       /** Check if the given hostmask matches too many users, send errors to the given user
-        * @param mask A hostmask to match against
-        * @param user A user to send error text to
-        * @return True if the host matches too many users
-        */
-       bool HostMatchesEveryone(const std::string &mask, User* user);
-
        /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
         * @param str A string containing a time in the form 1y2w3d4h6m5s
         * (one year, two weeks, three days, four hours, six minutes and five seconds)
@@ -617,21 +496,9 @@ class CoreExport InspIRCd
         * @param data The data from the config file
         * @param input The data input by the oper
         * @param hashtype The hash from the config file
-        * @return 0 if the strings match, 1 or -1 if they do not
-        */
-       int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
-
-       /** Check if a given server is a uline.
-        * An empty string returns true, this is by design.
-        * @param server The server to check for uline status
-        * @return True if the server is a uline OR the string is empty
-        */
-       bool ULine(const std::string& server);
-
-       /** Returns true if the uline is 'silent' (doesnt generate
-        * remote connect notices etc).
+        * @return True if the strings match, false if they do not
         */
-       bool SilentULine(const std::string& server);
+       bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
 
        /** Returns the full version string of this ircd
         * @return The version string
@@ -640,9 +507,10 @@ class CoreExport InspIRCd
 
        /** Attempt to write the process id to a given file
         * @param filename The PID file to attempt to write to
+        * @param exitonfail If true and the PID fail cannot be written log to stdout and exit, otherwise only log on failure
         * @return This function may bail if the file cannot be written
         */
-       void WritePID(const std::string &filename);
+       void WritePID(const std::string& filename, bool exitonfail = true);
 
        /** This constructor initialises all the subsystems and reads the config file.
         * @param argc The argument count passed to main()
@@ -653,23 +521,6 @@ class CoreExport InspIRCd
         */
        InspIRCd(int argc, char** argv);
 
-       /** Send a line of WHOIS data to a user.
-        * @param user user to send the line to
-        * @param dest user being WHOISed
-        * @param numeric Numeric to send
-        * @param text Text of the numeric
-        */
-       void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
-
-       /** Send a line of WHOIS data to a user.
-        * @param user user to send the line to
-        * @param dest user being WHOISed
-        * @param numeric Numeric to send
-        * @param format Format string for the numeric
-        * @param ... Parameters for the format string
-        */
-       void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
-
        /** Called to check whether a channel restriction mode applies to a user
         * @param User that is attempting some action
         * @param Channel that the action is being performed on
@@ -684,8 +535,21 @@ class CoreExport InspIRCd
        void Cleanup();
 
        /** Return a time_t as a human-readable string.
+        * @param format The format to retrieve the date/time in. See `man 3 strftime`
+        * for more information. If NULL, "%a %b %d %T %Y" is assumed.
+        * @param utc True to convert the time to string as-is, false to convert it to local time first.
+        * @return A string representing the given date/time.
+        */
+       static std::string TimeString(time_t curtime, const char* format = NULL, bool utc = false);
+
+       /** Compare two strings in a timing-safe way. If the lengths of the strings differ, the function
+        * returns false immediately (leaking information about the length), otherwise it compares each
+        * character and only returns after all characters have been compared.
+        * @param one First string
+        * @param two Second string
+        * @return True if the strings match, false if they don't
         */
-       static std::string TimeString(time_t curtime);
+       static bool TimingSafeCompare(const std::string& one, const std::string& two);
 
        /** Begin execution of the server.
         * NOTE: this function NEVER returns. Internally,
@@ -715,3 +579,13 @@ class CommandModule : public Module
                return Version(cmd.name, VF_VENDOR|VF_CORE);
        }
 };
+
+inline void stdalgo::culldeleter::operator()(classbase* item)
+{
+       if (item)
+               ServerInstance->GlobalCulls.AddItem(item);
+}
+
+#include "numericbuilder.h"
+#include "modules/whois.h"
+#include "modules/stats.h"