]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Change all socketengine methods to be static
[user/henk/code/inspircd.git] / include / inspircd.h
index df2ad1095c1bc1074dfa419b8dba31d14458d207..930514169a74f22e2af6be0dcaf3854870954943 100644 (file)
  */
 
 
-#ifndef INSPIRCD_H
-#define INSPIRCD_H
+#pragma once
 
-#define _FILE_OFFSET_BITS 64
-#ifndef _LARGEFILE_SOURCE
-#define _LARGEFILE_SOURCE
-#endif
-
-#ifndef _WIN32
-#define DllExport
-#define CoreExport
-#else
-#include "inspircd_win32wrapper.h"
-/** Windows defines these already */
-#undef ERROR
-#endif
-
-#ifdef __GNUC__
-#define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
-#else
-#define CUSTOM_PRINTF(STRING, FIRST)
-#endif
-
-#if defined __clang__ || defined __GNUC__
-# define DEPRECATED_METHOD(function) function __attribute__((deprecated))
-#elif defined _MSC_VER
-# define DEPRECATED_METHOD(function) __declspec(deprecated) function
-#else
-# pragma message ("Warning! DEPRECATED_METHOD() does not work on your compiler!")
-# define DEPRECATED_METHOD(function) function
-#endif
-
-// Required system headers.
-#include <ctime>
-#include <cstdarg>
-#include <algorithm>
-#include <cmath>
-#include <cstring>
 #include <climits>
+#include <cmath>
+#include <csignal>
+#include <cstdarg>
 #include <cstdio>
-#ifndef _WIN32
-#include <unistd.h>
-#endif
+#include <cstring>
+#include <ctime>
 
-#ifdef _WIN32
-# include <unordered_map>
-#else
-# include <tr1/unordered_map>
-#endif
-#include <sstream>
-#include <string>
-#include <vector>
-#include <list>
+#include <algorithm>
+#include <bitset>
 #include <deque>
+#include <list>
 #include <map>
-#include <bitset>
 #include <set>
-#include <time.h>
-#include "config.h"
+#include <sstream>
+#include <string>
+#include <vector>
+
+#include "intrusive_list.h"
+#include "compat.h"
 #include "typedefs.h"
-#include "consolecolors.h"
 
 CoreExport extern InspIRCd* ServerInstance;
 
+#include "config.h"
+#include "dynref.h"
+#include "consolecolors.h"
 #include "caller.h"
 #include "cull_list.h"
 #include "extensible.h"
+#include "fileutils.h"
 #include "numerics.h"
 #include "uid.h"
+#include "server.h"
 #include "users.h"
 #include "channels.h"
 #include "timer.h"
@@ -111,16 +78,6 @@ CoreExport extern InspIRCd* ServerInstance;
 #include "inspstring.h"
 #include "protocol.h"
 
-#ifndef PATH_MAX
-#warning Potentially broken system, PATH_MAX undefined
-#define PATH_MAX 4096
-#endif
-
-/**
- * Used to define the maximum number of parameters a command may have.
- */
-#define MAXPARAMETERS 127
-
 /** Returned by some functions to indicate failure.
  */
 #define ERROR -1
@@ -129,20 +86,19 @@ CoreExport extern InspIRCd* ServerInstance;
  */
 template<typename T> inline std::string ConvNumeric(const T &in)
 {
-       if (in == 0) return "0";
-       char res[MAXBUF];
-       char* out = res;
+       if (in == 0)
+               return "0";
        T quotient = in;
-       while (quotient) {
-               *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
-               ++out;
+       std::string out;
+       while (quotient)
+       {
+               out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
                quotient /= 10;
        }
        if (in < 0)
-               *out++ = '-';
-       *out = 0;
-       std::reverse(res,out);
-       return res;
+               out += '-';
+       std::reverse(out.begin(), out.end());
+       return out;
 }
 
 /** Template function to convert any input type to std::string
@@ -177,7 +133,7 @@ inline std::string ConvToStr(const bool in)
  */
 inline std::string ConvToStr(char in)
 {
-       return std::string(in,1);
+       return std::string(1, in);
 }
 
 /** Template function to convert any input type to std::string
@@ -267,15 +223,33 @@ class serverstats
        }
 };
 
-DEFINE_HANDLER2(IsNickHandler, bool, const std::string&, size_t);
+/** 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&);
-DEFINE_HANDLER2(IsChannelHandler, bool, const std::string&, size_t);
-DEFINE_HANDLER1(RehashHandler, void, const std::string&);
+DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 
-class TestSuite;
-
 /** The main class of the irc server.
  * This class contains instances of all the other classes in this software.
  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
@@ -285,10 +259,6 @@ class TestSuite;
 class CoreExport InspIRCd
 {
  private:
-       /** Holds the current UID. Used to generate the next one.
-        */
-       char current_uid[UUID_LENGTH];
-
        /** Set up the signal handlers
         */
        void SetSignals();
@@ -298,25 +268,6 @@ class CoreExport InspIRCd
         */
        bool DaemonSeed();
 
-       /** Iterate the list of BufferedSocket objects, removing ones which have timed out
-        * @param TIME the current time
-        */
-       void DoSocketTimeouts(time_t TIME);
-
-       /** Increments the current UID by one.
-        */
-       void IncrementUID(int pos);
-
-       /** Perform background user events such as PING checks
-        */
-       void DoBackgroundUserStuff();
-
-       /** Returns true when all modules have done pre-registration checks on a user
-        * @param user The user to verify
-        * @return True if all modules have finished checking this user
-        */
-       bool AllModulesReportReady(LocalUser* user);
-
        /** The current time, updated in the mainloop
         */
        struct timespec TIME;
@@ -326,8 +277,15 @@ class CoreExport InspIRCd
         */
        char ReadBuffer[65535];
 
+       /** Check we aren't running as root, and exit if we are
+        * with exit code EXIT_STATUS_ROOT.
+        */
+       void CheckRoot();
+
  public:
 
+       UIDGenerator UIDGen;
+
        /** Global cull list, will be processed on next iteration
         */
        CullList GlobalCulls;
@@ -340,7 +298,6 @@ class CoreExport InspIRCd
        IsIdentHandler HandleIsIdent;
        OnCheckExemptionHandler HandleOnCheckExemption;
        IsChannelHandler HandleIsChannel;
-       RehashHandler HandleRehash;
        GenRandomHandler HandleGenRandom;
 
        /** Globally accessible fake user record. This is used to force mode changes etc across s2s, etc.. bit ugly, but.. better than how this was done in 1.1
@@ -353,28 +310,12 @@ class CoreExport InspIRCd
         */
        FakeUser* FakeClient;
 
-       /** Returns the next available UID for this server.
-        */
-       std::string GetUID();
-
-       static const char LogHeader[];
-
        /** Find a user in the UUID hash
         * @param uid The UUID to find
         * @return A pointer to the user, or NULL if the user does not exist
         */
        User* FindUUID(const std::string &uid);
 
-       /** Find a user in the UUID hash
-        * @param uid The UUID to find
-        * @return A pointer to the user, or NULL if the user does not exist
-        */
-       User* FindUUID(const char *uid);
-
-       /** Build the ISUPPORT string by triggering all modules On005Numeric events
-        */
-       void BuildISupport();
-
        /** Time this ircd was booted
         */
        time_t startup_time;
@@ -393,10 +334,6 @@ class CoreExport InspIRCd
         */
        CommandParser* Parser;
 
-       /** Socket engine, handles socket activity events
-        */
-       SocketEngine* SE;
-
        /** Thread engine, Handles threading where required
         */
        ThreadEngine* Threads;
@@ -432,10 +369,6 @@ class CoreExport InspIRCd
         */
        SnomaskManager* SNO;
 
-       /** DNS class, provides resolver facilities to the core and modules
-        */
-       DNS* Res;
-
        /** Timer manager class, triggers Timer timer events
         */
        TimerManager* Timers;
@@ -458,19 +391,18 @@ class CoreExport InspIRCd
 
        /** Set to the current signal recieved
         */
-       int s_signal;
+       static sig_atomic_t s_signal;
 
        /** Protocol interface, overridden by server protocol modules
         */
        ProtocolInterface* PI;
 
-       /** Holds extensible for user nickforced
-        */
-       LocalIntExt NICKForced;
-
        /** Holds extensible for user operquit
         */
-       LocalStringExt OperQuit;
+       StringExtItem OperQuit;
+
+       /** Manages the generation and transmission of ISUPPORT. */
+       ISupportManager ISupport;
 
        /** Get the current time
         * Because this only calls time() once every time around the mainloop,
@@ -511,15 +443,6 @@ class CoreExport InspIRCd
         */
        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
@@ -527,17 +450,6 @@ class CoreExport InspIRCd
         */
        User* FindNick(const std::string &nick);
 
-       /** 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
-        * @return A pointer to the user, or NULL if the user does not exist
-        */
-       User* FindNick(const char* nick);
-
-       /** Find a user in the nick hash ONLY
-        */
-       User* FindNickOnly(const char* nick);
-
        /** Find a user in the nick hash ONLY
         */
        User* FindNickOnly(const std::string &nick);
@@ -548,39 +460,17 @@ class CoreExport InspIRCd
         */
        Channel* FindChan(const std::string &chan);
 
-       /** Find a channel in the channels hash
-        * @param chan The channel to find
-        * @return A pointer to the channel, or NULL if the channel does not exist
-        */
-       Channel* FindChan(const char* chan);
-
-       /** Check we aren't running as root, and exit if we are
-        * @return Depending on the configuration, this function may never return
-        */
-       void CheckRoot();
-
-       /** Determine the right path for, and open, the logfile
-        * @param argv The argv passed to main() initially, used to calculate program path
-        * @param argc The argc passed to main() initially, used to calculate program path
-        * @return True if the log could be opened, false if otherwise
-        */
-       bool OpenLog(char** argv, int argc);
-
        /** Return true if a channel name is valid
         * @param chname A channel name to verify
         * @return True if the name is valid
         */
-       caller2<bool, const std::string&, size_t> IsChannel;
+       caller1<bool, const std::string&> IsChannel;
 
        /** Return true if str looks like a server ID
-        * @param string to check against
+        * @param sid string to check against
         */
        static bool IsSID(const std::string& sid);
 
-       /** Rehash the local server
-        */
-       caller1<void, const std::string&> Rehash;
-
        /** Handles incoming signals after being set
         * @param signal the signal recieved
         */
@@ -604,10 +494,18 @@ class CoreExport InspIRCd
         */
        static void QuickExit(int status);
 
+       /** Formats the input string with the specified arguments.
+       * @param formatString The string to format
+       * @param ... A variable number of format arguments.
+       * @return The formatted string
+       */
+       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();
+       long ChannelCount() const { return chanlist->size(); }
 
        /** Send an error notice to all local users, opered and unopered
         * @param s The error string to send
@@ -618,7 +516,7 @@ class CoreExport InspIRCd
         * @param n A nickname to verify
         * @return True if the nick is valid
         */
-       caller2<bool, const std::string&, size_t> IsNick;
+       caller1<bool, const std::string&> IsNick;
 
        /** Return true if an ident is valid
         * @param An ident to verify
@@ -626,57 +524,14 @@ class CoreExport InspIRCd
         */
        caller1<bool, const std::string&> IsIdent;
 
-       /** Add a dns Resolver class to this server's active set
-        * @param r The resolver to add
-        * @param cached If this value is true, then the cache will
-        * be searched for the DNS result, immediately. If the value is
-        * false, then a request will be sent to the nameserver, and the
-        * result will not be immediately available. You should usually
-        * use the boolean value which you passed to the Resolver
-        * constructor, which Resolver will set appropriately depending
-        * on if cached results are available and haven't expired. It is
-        * however safe to force this value to false, forcing a remote DNS
-        * lookup, but not an update of the cache.
-        * @return True if the operation completed successfully. Note that
-        * if this method returns true, you should not attempt to access
-        * the resolver class you pass it after this call, as depending upon
-        * the request given, the object may be deleted!
-        */
-       bool AddResolver(Resolver* r, bool cached);
-
-       /** Add a command to this server's command parser
-        * @param f A Command command handler object to add
-        * @throw ModuleException Will throw ModuleExcption if the command already exists
-        */
-       inline void AddCommand(Command *f)
-       {
-               Modules->AddService(*f);
-       }
-
-       /** Send a modechange.
-        * The parameters provided are identical to that sent to the
-        * handler for class cmd_mode.
-        * @param parameters The mode parameters
-        * @param user The user to send error messages to
-        */
-       void SendMode(const std::vector<std::string>& parameters, User *user);
-
-       /** Send a modechange and route it to the network.
-        * The parameters provided are identical to that sent to the
-        * handler for class cmd_mode.
-        * @param parameters The mode parameters
-        * @param user The user to send error messages to
-        */
-       void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
-
        /** Match two strings using pattern matching, optionally, with a map
         * to check case against (may be NULL). If map is null, match will be case insensitive.
         * @param str The literal string to match against
         * @param mask The glob pattern to match against.
         * @param map The character map to use when matching.
         */
-       static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
-       static bool Match(const  char *str, const char *mask, unsigned const char *map = NULL);
+       static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
+       static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
 
        /** Match two strings using pattern matching, optionally, with a map
         * to check case against (may be NULL). If map is null, match will be case insensitive.
@@ -685,14 +540,21 @@ class CoreExport InspIRCd
         * @param mask The glob or CIDR pattern to match against.
         * @param map The character map to use when matching.
         */
-       static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
-       static bool MatchCIDR(const  char *str, const char *mask, unsigned const char *map = NULL);
+       static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
+       static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
+
+       /** Matches a hostname and IP against a space delimited list of hostmasks.
+        * @param masks The space delimited masks to match against.
+        * @param hostname The hostname to try and match.
+        * @param ipaddr The IP address to try and match.
+        */
+       static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
 
        /** Return true if the given parameter is a valid nick!user\@host mask
         * @param mask A nick!user\@host masak to match against
         * @return True i the mask is valid
         */
-       bool IsValidMask(const std::string &mask);
+       static bool IsValidMask(const std::string& mask);
 
        /** Strips all color codes from the given string
         * @param sentence The string to strip from
@@ -705,8 +567,9 @@ class CoreExport InspIRCd
        static void ProcessColors(file_cache& input);
 
        /** Rehash the local server
+        * @param uuid The uuid of the user who started the rehash, can be empty
         */
-       void RehashServer();
+       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
@@ -743,26 +606,14 @@ 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
+        * @return True if the strings match, false 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).
-        */
-       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
         */
-       std::string GetVersionString(bool rawversion = false);
+       std::string GetVersionString(bool getFullVersion = false);
 
        /** Attempt to write the process id to a given file
         * @param filename The PID file to attempt to write to
@@ -803,14 +654,6 @@ class CoreExport InspIRCd
         */
        caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 
-       /** Restart the server.
-        * This function will not return. If an error occurs,
-        * it will throw an instance of CoreException.
-        * @param reason The restart reason to show to all clients
-        * @throw CoreException An instance of CoreException indicating the error from execv().
-        */
-       void Restart(const std::string &reason);
-
        /** Prepare the ircd for restart or shutdown.
         * This function unloads all modules which can be unloaded,
         * closes all open sockets, and closes the logfile.
@@ -819,25 +662,18 @@ class CoreExport InspIRCd
 
        /** Return a time_t as a human-readable string.
         */
-       std::string TimeString(time_t curtime);
+       static std::string TimeString(time_t curtime);
 
        /** Begin execution of the server.
         * NOTE: this function NEVER returns. Internally,
         * it will repeatedly loop.
-        * @return The return value for this function is undefined.
         */
-       int Run();
-
-       /** Adds an extban char to the 005 token.
-        */
-       void AddExtBanChar(char c);
+       void Run();
 
        char* GetReadBuffer()
        {
                return this->ReadBuffer;
        }
-
-       friend class TestSuite;
 };
 
 ENTRYPOINT;
@@ -851,16 +687,8 @@ class CommandModule : public Module
        {
        }
 
-       void init()
-       {
-               ServerInstance->Modules->AddService(cmd);
-       }
-
        Version GetVersion()
        {
                return Version(cmd.name, VF_VENDOR|VF_CORE);
        }
 };
-
-#endif
-