]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Remove an utterly insane comment .. based on changed by based on originally by change...
[user/henk/code/inspircd.git] / include / inspircd.h
index 98b8e0c1d07f4accd8f6e41f0be7ecbc51a6e59a..dbbc0375e732bc8a6be105eb96b446ff28405f93 100644 (file)
@@ -20,6 +20,7 @@
 #define printf_c printf
 #else
 #include "inspircd_win32wrapper.h"
+/** Windows defines these already */
 #undef DELETE
 #undef ERROR
 #endif
@@ -28,6 +29,7 @@
 #include <string>
 #include <sstream>
 #include "inspircd_config.h"
+#include "uid.h"
 #include "users.h"
 #include "channels.h"
 #include "socket.h"
 #include "command_parse.h"
 #include "snomasks.h"
 #include "cull_list.h"
+#include "filelogger.h"
+#include "caller.h"
+
+/**
+ * Used to define the maximum number of parameters a command may have.
+ */
+#define MAXPARAMETERS 127
 
 /** Returned by some functions to indicate failure.
  */
  */
 #define ETIREDHAMSTERS EAGAIN
 
-/** Debug levels for use with InspIRCd::Log()
- */
-enum DebugLevel
-{
-       DEBUG           =       10,
-       VERBOSE         =       20,
-       DEFAULT         =       30,
-       SPARSE          =       40,
-       NONE            =       50,
-};
-
-/**
- * This define is used in place of strcmp when we
- * want to check if a char* string contains only one
- * letter. Pretty fast, its just two compares and an
- * addition.
- */
-#define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
-
 /** Delete a pointer, and NULL its value
  */
 template<typename T> inline void DELETE(T* x)
@@ -73,7 +63,7 @@ template<typename T> inline void DELETE(T* x)
        x = NULL;
 }
 
-/** Template functions to convert any input type to std::string
+/** Template function to convert any input type to std::string
  */
 template<typename T> inline std::string ConvNumeric(const T &in)
 {
@@ -93,36 +83,50 @@ template<typename T> inline std::string ConvNumeric(const T &in)
        return res;
 }
 
+/** 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 unsigned 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;
@@ -130,6 +134,9 @@ template <class T> inline std::string ConvToStr(const T &in)
        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;
@@ -139,6 +146,9 @@ template<typename T> inline long ConvToInt(const T &in)
 
 /** Template function to convert integer to char, storing result in *res and
  * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
+ * @param T input value
+ * @param V result value
+ * @param R base to convert to
  */
 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
 {
@@ -212,73 +222,21 @@ class serverstats : public classbase
        }
 };
 
-class InspIRCd;
-
-/** This class implements a nonblocking log-writer.
- * Most people writing an ircd give little thought to their disk
- * i/o. On a congested system, disk writes can block for long
- * periods of time (e.g. if the system is busy and/or swapping
- * a lot). If we just use a blocking fprintf() call, this could
- * block for undesirable amounts of time (half of a second through
- * to whole seconds). We DO NOT want this, so we make our logfile
- * nonblocking and hook it into the SocketEngine.
- * NB: If the operating system does not support nonblocking file
- * I/O (linux seems to, as does freebsd) this will default to
- * blocking behaviour.
- */
-class CoreExport FileLogger : public EventHandler
-{
- protected:
-       /** The creator/owner of this object
-        */
-       InspIRCd* ServerInstance;
-       /** The log file (fd is inside this somewhere,
-        * we get it out with fileno())
-        */
-       FILE* log;
-       /** Buffer of pending log lines to be written
-        */
-       std::string buffer;
-       /** Number of write operations that have occured
-        */
-       int writeops;
- public:
-       /** The constructor takes an already opened logfile.
-        */
-       FileLogger(InspIRCd* Instance, FILE* logfile);
-       /** This returns false, logfiles are writeable.
-        */
-       virtual bool Readable();
-       /** Handle pending write events.
-        * This will flush any waiting data to disk.
-        * If any data remains after the fprintf call,
-        * another write event is scheduled to write
-        * the rest of the data when possible.
-        */
-       virtual void HandleEvent(EventType et, int errornum = 0);
-       /** Write one or more preformatted log lines.
-        * If the data cannot be written immediately,
-        * this class will insert itself into the
-        * SocketEngine, and register a write event,
-        * and when the write event occurs it will
-        * attempt again to write the data.
-        */
-       void WriteLogLine(const std::string &line);
-       /** Close the log file and cancel any events.
-        */
-       virtual void Close();
-       /** Close the log file and cancel any events.
-        * (indirectly call Close()
-        */
-       virtual ~FileLogger();
-};
-
 /** A list of failed port bindings, used for informational purposes on startup */
 typedef std::vector<std::pair<std::string, long> > FailedPortList;
 
 /** A list of ip addresses cross referenced against clone counts */
 typedef std::map<irc::string, unsigned int> clonemap;
 
+class InspIRCd;
+
+DEFINE_HANDLER1(ProcessUserHandler, void, userrec*);
+DEFINE_HANDLER1(IsNickHandler, bool, const char*);
+DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
+DEFINE_HANDLER1(FindDescriptorHandler, userrec*, int);
+DEFINE_HANDLER1(FloodQuitUserHandler, void, userrec*);
+
+/* Forward declaration - required */
 class XLineManager;
 
 /** The main class of the irc server.
@@ -297,6 +255,10 @@ class XLineManager;
 class CoreExport InspIRCd : public classbase
 {
  private:
+       /** Holds the current UID. Used to generate the next one.
+        */
+       char current_uid[UUID_LENGTH];
+
        /** Holds a string describing the last module error to occur
         */
        char MODERR[MAXBUF];
@@ -317,10 +279,6 @@ class CoreExport InspIRCd : public classbase
         */
        void MoveTo(std::string modulename,int slot);
 
-       /** Display the startup banner
-        */
-       void Start();
-
        /** Set up the signal handlers
         */
        void SetSignals();
@@ -396,26 +354,6 @@ class CoreExport InspIRCd : public classbase
         */
        char ReadBuffer[65535];
 
-       /** Number of seconds in a minute
-        */
-       const long duration_m;
-
-       /** Number of seconds in an hour
-        */
-       const long duration_h;
-
-       /** Number of seconds in a day
-        */
-       const long duration_d;
-
-       /** Number of seconds in a week
-        */
-       const long duration_w;
-
-       /** Number of seconds in a year
-        */
-       const long duration_y;
-
        /** Used when connecting clients
         */
        insp_sockaddr client, server;
@@ -433,10 +371,50 @@ class CoreExport InspIRCd : public classbase
         */
        int time_delta;
 
+#ifdef WIN32
+       IPC* WindowsIPC;
+#endif
+
  public:
 
+       /** Global cull list, will be processed on next iteration
+        */
+       CullList GlobalCulls;
+
+
+       /**** Functors ****/
+
+       ProcessUserHandler HandleProcessUser;
+       IsNickHandler HandleIsNick;
+       IsIdentHandler HandleIsIdent;
+       FindDescriptorHandler HandleFindDescriptor;
+       FloodQuitUserHandler HandleFloodQuitUser;
+
+       /** InspSocket classes pending deletion after being closed.
+        * We don't delete these immediately as this may cause a segmentation fault.
+        */
        std::map<InspSocket*,InspSocket*> SocketCull;
 
+       /** 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
+        */
+       userrec *FakeClient;
+
+       /** Returns the next available UID for this server.
+        */
+       std::string GetUID();
+
+       /** 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
+        */
+       userrec *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
+        */
+       userrec *FindUUID(const char *);
+
        /** Build the ISUPPORT string by triggering all modules On005Numeric events
         */
        void BuildISupport();
@@ -487,6 +465,11 @@ class CoreExport InspIRCd : public classbase
         */
        user_hash* clientlist;
 
+       /** Client list stored by UUID. Contains all clients, and is updated
+        * automatically by the constructor and destructor of userrec.
+        */
+       user_hash* uuidlist;
+
        /** Channel list, a hash_map containing all channels
         */
        chan_hash* chanlist;
@@ -499,8 +482,12 @@ class CoreExport InspIRCd : public classbase
         */
        std::vector<userrec*> all_opers;
 
+       /** Map of local ip addresses for clone counting
+        */
        clonemap local_clones;
 
+       /** Map of global ip addresses for clone counting
+        */
        clonemap global_clones;
 
        /** DNS class, provides resolver facilities to the core and modules
@@ -531,9 +518,9 @@ class CoreExport InspIRCd : public classbase
         */
        time_t next_call;
 
-       /** Global cull list, will be processed on next iteration
+       /** Set to the current signal recieved
         */
-       CullList GlobalCulls;
+       int s_signal;
 
        /** Get the current time
         * Because this only calls time() once every time around the mainloop,
@@ -551,8 +538,14 @@ class CoreExport InspIRCd : public classbase
         */
        int SetTimeDelta(int delta);
 
+       /** Add a user to the local clone map
+        * @param user The user to add
+        */
        void AddLocalClone(userrec* user);
 
+       /** Add a user to the global clone map
+        * @param user The user to add
+        */
        void AddGlobalClone(userrec* user);
 
        /** Number of users with a certain mode set on them
@@ -566,9 +559,10 @@ class CoreExport InspIRCd : public classbase
 
        /** Process a user whos socket has been flagged as active
         * @param cu The user to process
-        * @return There is no actual return value, however upon exit, the user 'cu' may have been deleted
+        * @return There is no actual return value, however upon exit, the user 'cu' may have been
+        * marked for deletion in the global CullList.
         */
-       void ProcessUser(userrec* cu);
+       caller1<void, userrec*> ProcessUser;
 
        /** Get the total number of currently loaded modules
         * @return The number of loaded modules
@@ -635,18 +629,28 @@ class CoreExport InspIRCd : public classbase
         */
        void WriteOpers(const std::string &text);
 
-       /** Find a nickname in the nick hash
+       /** 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
         */
        userrec* FindNick(const std::string &nick);
 
-       /** Find a nickname in the nick hash
+       /** 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
         */
        userrec* FindNick(const char* nick);
 
+       /** Find a user in the nick hash ONLY
+        */
+       userrec* FindNickOnly(const char* nick);
+
+       /** Find a user in the nick hash ONLY
+        */
+       userrec* FindNickOnly(const std::string &nick);
+
        /** 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
@@ -676,9 +680,12 @@ class CoreExport InspIRCd : public classbase
        /** 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
         */
-       void OpenLog(char** argv, int argc);
+       bool OpenLog(char** argv, int argc);
 
+       /** Close the currently open log file
+        */
        void CloseLog();
 
        /** Send a server notice to all local users
@@ -710,9 +717,18 @@ class CoreExport InspIRCd : public classbase
        bool IsChannel(const char *chname);
 
        /** Rehash the local server
-        * @param status This value is unused, and required for signal handler functions
         */
-       static void Rehash(int status);
+       void Rehash();
+
+       /** Handles incoming signals after being set
+        * @param signal the signal recieved
+        */
+       void SignalHandler(int signal);
+
+       /** Sets the signal recieved    
+        * @param signal the signal recieved
+        */
+       static void SetSignal(int signal);
 
        /** Causes the server to exit after unloading modules and
         * closing all open file descriptors.
@@ -720,7 +736,7 @@ class CoreExport InspIRCd : public classbase
         * @param The exit code to give to the operating system
         * (See the ExitStatus enum for valid values)
         */
-       static void Exit(int status);
+       void Exit(int status);
 
        /** Causes the server to exit immediately with exit code 0.
         * The status code is required for signal handlers, and ignored.
@@ -894,20 +910,20 @@ class CoreExport InspIRCd : public classbase
         * @param n A nickname to verify
         * @return True if the nick is valid
         */
-       bool IsNick(const char* n);
+       caller1<bool, const char*> IsNick;
 
        /** Return true if an ident is valid
         * @param An ident to verify
         * @return True if the ident is valid
         */
-       bool IsIdent(const char* n);
+       caller1<bool, const char*> IsIdent;
 
        /** Find a username by their file descriptor.
         * It is preferred to use this over directly accessing the fd_ref_table array.
         * @param socket The file descriptor of a user
         * @return A pointer to the user if the user exists locally on this descriptor
         */
-       userrec* FindDescriptor(int socket);
+       caller1<userrec*, int> FindDescriptor;
 
        /** Add a new mode to this server's mode parser
         * @param mh The modehandler to add
@@ -1106,7 +1122,7 @@ class CoreExport InspIRCd : public classbase
         * (one year, two weeks, three days, four hours, six minutes and five seconds)
         * @return The total number of seconds
         */
-       long Duration(const char* str);
+       long Duration(const std::string &str);
 
        /** Attempt to compare an oper password to a string from the config file.
         * This will be passed to handling modules which will compare the data
@@ -1195,10 +1211,29 @@ class CoreExport InspIRCd : public classbase
         */
        void Log(int level, 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 text Text of the numeric
+        */
        void SendWhoisLine(userrec* user, userrec* 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(userrec* user, userrec* dest, int numeric, const char* format, ...);
 
+       /** 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, userrec*> FloodQuitUser;
+
        /** Restart the server.
         * This function will not return. If an error occurs,
         * it will throw an instance of CoreException.
@@ -1235,6 +1270,16 @@ class CoreExport InspIRCd : public classbase
         * @return The return value for this function is undefined.
         */
        int Run();
+
+       /** Force all InspSockets to be removed which are due to
+        * be culled.
+        */
+       void InspSocketCull();
+
+       char* GetReadBuffer()
+       {
+               return this->ReadBuffer;
+       }
 };
 
 #endif