]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Move stuff around a bit:
[user/henk/code/inspircd.git] / include / inspircd.h
index cabb24aa03868f9fbb91e8c7b308a20b0820c814..e02a5deb54b52a277493736ad8ecc7ac75b6cd6c 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
-#define printf_c printf
-#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
-
-// 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>
 
-#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 "inspircd_config.h"
-#include "inspircd_version.h"
+#include <sstream>
+#include <string>
+#include <vector>
+
+#include "compat.h"
 #include "typedefs.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 "users.h"
@@ -98,43 +76,27 @@ 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
 
-/** Support for librodent -
- * see http://www.chatspike.net/index.php?z=64
- */
-#define ETIREDHAMSTERS EAGAIN
-
 /** 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";
-       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
@@ -232,12 +194,24 @@ class serverstats
        /** Total bytes of data received
         */
        unsigned long statsRecv;
+#ifdef _WIN32
+       /** Cpu usage at last sample
+       */
+       FILETIME LastCPU;
+       /** Time QP sample was read
+       */
+       LARGE_INTEGER LastSampled;
+       /** QP frequency
+       */
+       LARGE_INTEGER QPFrequency;
+#else
        /** Cpu usage at last sample
         */
        timeval LastCPU;
        /** Time last sample was read
         */
        timespec LastSampled;
+#endif
        /** The constructor initializes all the counts to zero
         */
        serverstats()
@@ -247,13 +221,31 @@ class serverstats
        }
 };
 
-DEFINE_HANDLER2(IsNickHandler, bool, const char*, 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 char*);
-DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
-DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
-DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
-DEFINE_HANDLER1(RehashHandler, void, const std::string&);
+DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
+DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 
 /** The main class of the irc server.
@@ -265,10 +257,6 @@ DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::
 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();
@@ -278,25 +266,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;
@@ -306,12 +275,15 @@ class CoreExport InspIRCd
         */
        char ReadBuffer[65535];
 
-#ifdef WIN32
-       IPC* WindowsIPC;
-#endif
+       /** 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;
@@ -322,11 +294,8 @@ class CoreExport InspIRCd
 
        IsNickHandler HandleIsNick;
        IsIdentHandler HandleIsIdent;
-       FloodQuitUserHandler HandleFloodQuitUser;
        OnCheckExemptionHandler HandleOnCheckExemption;
        IsChannelHandler HandleIsChannel;
-       IsSIDHandler HandleIsSID;
-       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
@@ -339,27 +308,11 @@ 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 nick The nickname to find
+        * @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 &);
-
-       /** Find a user in the UUID hash
-        * @param nick The nickname to find
-        * @return A pointer to the user, or NULL if the user does not exist
-        */
-       User* FindUUID(const char *);
-
-       /** Build the ISUPPORT string by triggering all modules On005Numeric events
-        */
-       void BuildISupport();
+       User* FindUUID(const std::string &uid);
 
        /** Time this ircd was booted
         */
@@ -418,10 +371,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;
@@ -444,23 +393,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;
 
-       /** Holds whether the MOTD has been parsed for color codes
-       */
-       bool ProcessedMotdEscapes;
+       /** Manages the generation and transmission of ISUPPORT. */
+       ISupportManager ISupport;
 
        /** Get the current time
         * Because this only calls time() once every time around the mainloop,
@@ -496,6 +440,7 @@ class CoreExport InspIRCd
         * @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);
@@ -516,17 +461,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);
@@ -537,38 +471,16 @@ 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 char*, 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
         */
-       caller1<bool, const std::string&> IsSID;
-
-       /** Rehash the local server
-        */
-       caller1<void, const std::string&> Rehash;
+       static bool IsSID(const std::string& sid);
 
        /** Handles incoming signals after being set
         * @param signal the signal recieved
@@ -583,7 +495,7 @@ class CoreExport InspIRCd
        /** Causes the server to exit after unloading modules and
         * closing all open file descriptors.
         *
-        * @param The exit code to give to the operating system
+        * @param status The exit code to give to the operating system
         * (See the ExitStatus enum for valid values)
         */
        void Exit(int status);
@@ -593,10 +505,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
@@ -607,90 +527,39 @@ class CoreExport InspIRCd
         * @param n A nickname to verify
         * @return True if the nick is valid
         */
-       caller2<bool, const char*, size_t> IsNick;
+       caller1<bool, const std::string&> IsNick;
 
        /** Return true if an ident is valid
         * @param An ident to verify
         * @return True if the ident is valid
         */
-       caller1<bool, const char*> 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);
+       caller1<bool, const std::string&> IsIdent;
 
        /** 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.
         * Supports CIDR patterns as well as globs.
         * @param str The literal string to match against
         * @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);
 
-       /** Call the handler for a given command.
-        * @param commandname The command whos handler you wish to call
-        * @param parameters The mode parameters
-        * @param pcnt The number of items you have given in the first parameter
-        * @param user The user to execute the command as
-        * @return True if the command handler was called successfully
+       /** 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.
         */
-       CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
-
-       /** Return true if the command is a module-implemented command and the given parameters are valid for it
-        * @param parameters The mode parameters
-        * @param pcnt The number of items you have given in the first parameter
-        * @param user The user to test-execute the command as
-        * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
-        */
-       bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
+       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
@@ -698,9 +567,20 @@ class CoreExport InspIRCd
         */
        bool IsValidMask(const std::string &mask);
 
+       /** Strips all color codes from the given string
+        * @param sentence The string to strip from
+        */
+       static void StripColor(std::string &sentence);
+
+       /** Parses color codes from string values to actual color codes
+        * @param input The data to process
+        */
+       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
@@ -728,7 +608,7 @@ class CoreExport InspIRCd
         * (one year, two weeks, three days, four hours, six minutes and five seconds)
         * @return The total number of seconds
         */
-       long Duration(const std::string &str);
+       static unsigned long Duration(const std::string& str);
 
        /** Attempt to compare a password to a string from the config file.
         * This will be passed to handling modules which will compare the data
@@ -756,7 +636,7 @@ class CoreExport InspIRCd
        /** 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
@@ -790,20 +670,6 @@ class CoreExport InspIRCd
         */
        void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 
-       /** Handle /STATS
-        */
-       void DoStats(char statschar, User* user, string_list &results);
-
-       /** Handle /WHOIS
-        */
-       void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
-
-       /** Quit a user for excess flood, and if they are not
-        * fully registered yet, temporarily zline their IP.
-        * @param current user to quit
-        */
-       caller1<void, User*> FloodQuitUser;
-
        /** 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
@@ -811,31 +677,12 @@ 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.
         */
        void Cleanup();
 
-       /** This copies the user and channel hash_maps into new hash maps.
-        * This frees memory used by the hash_map allocator (which it neglects
-        * to free, most of the time, using tons of ram)
-        */
-       void RehashUsersAndChans();
-
-       /** Resets the cached max bans value on all channels.
-        * Called by rehash.
-        */
-       void ResetMaxBans();
-
        /** Return a time_t as a human-readable string.
         */
        std::string TimeString(time_t curtime);
@@ -843,13 +690,8 @@ class CoreExport InspIRCd
        /** 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()
        {
@@ -868,15 +710,8 @@ class CommandModule : public Module
        {
        }
 
-       void init()
-       {
-               ServerInstance->Modules->AddService(cmd);
-       }
-
        Version GetVersion()
        {
                return Version(cmd.name, VF_VENDOR|VF_CORE);
        }
 };
-
-#endif