]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Reduce size of max number of bytes in a bitfield from a 4 or 8 byte field to a 1...
[user/henk/code/inspircd.git] / include / inspircd.h
index 209edf65a4e0b771c82e6253bde48c11e528c241..7fecf22ae9fd7f5dae85ca533f01d814d2433cae 100644 (file)
@@ -25,9 +25,9 @@
 #include "channels.h"
 #include "socket.h"
 #include "mode.h"
-
 #include "socketengine.h"
 #include "command_parse.h"
+#include "snomasks.h"
 
 /** Returned by some functions to indicate failure,
  * and the exit code of the program if it terminates.
@@ -59,7 +59,11 @@ enum DebugLevel
 
 /** Delete a pointer, and NULL its value
  */
-#define DELETE(x) {if (x) { delete x; x = NULL; }}
+template<typename T> inline void DELETE(T* x)
+{
+       delete x;
+       x = NULL;
+}
 
 /** Template function to convert any input type to std::string
  */
@@ -156,30 +160,42 @@ class FileLogger : public EventHandler
         */
        int writeops;
  public:
-       /** The constructor takes an already opened logfile
+       /** The constructor takes an already opened logfile.
         */
        FileLogger(InspIRCd* Instance, FILE* logfile);
-       /** This returns false, logfiles are writeable
-        */
-       bool Readable();
-       /** Handle pending write events
-        */
-       void HandleEvent(EventType et);
-       /** Write one or more preformatted log lines
+       /** 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.
         */
-       void Close();
+       virtual void Close();
        /** Close the log file and cancel any events.
         * (indirectly call Close()
         */
-       ~FileLogger();
+       virtual ~FileLogger();
 };
 
+/** A list of failed port bindings, used for informational purposes on startup */
+typedef std::vector<std::pair<std::string, long> > FailedPortList;
+
 class XLineManager;
 
-/** The main singleton class of the irc server.
+/** The main class of the irc server.
  * This class contains instances of all the other classes
  * in this software, with the exception of the base class,
  * classbase. Amongst other things, it contains a ModeParser,
@@ -198,14 +214,6 @@ class InspIRCd : public classbase
        /** Holds a string describing the last module error to occur
         */
        char MODERR[MAXBUF];
-
-       /** This is an internal flag used by the mainloop
-        */
-       bool expire_run;
-
-       /** List of server names we've seen.
-        */
-       servernamelist servernames;
  
        /** Remove a ModuleFactory pointer
         * @param j Index number of the ModuleFactory to remove
@@ -232,9 +240,8 @@ class InspIRCd : public classbase
        void Start();
 
        /** Set up the signal handlers
-        * @param SEGVHandler create a handler for segfaults (deprecated)
         */
-       void SetSignals(bool SEGVHandler);
+       void SetSignals();
 
        /** Daemonize the ircd and close standard input/output streams
         * @return True if the program daemonized succesfully
@@ -335,7 +342,16 @@ class InspIRCd : public classbase
         */
        FileLogger* Logger;
 
+       /** Time offset in seconds
+        * This offset is added to all calls to Time(). Use SetTimeDelta() to update
+        */
+       int time_delta;
+
  public:
+        /** List of server names we've seen.
+        */
+       servernamelist servernames;
+
        /** Time this ircd was booted
         */
        time_t startup_time;
@@ -360,9 +376,10 @@ class InspIRCd : public classbase
         */
        ServerConfig* Config;
 
-       /** Module sockets list, holds the active set of InspSocket classes
+       /** Snomask manager - handles routing of snomask messages
+        * to opers.
         */
-       std::vector<InspSocket*> module_sockets;
+       SnomaskManager* SNO;
 
        /** Client list, a hash_map containing all clients, local and remote
         */
@@ -384,6 +401,10 @@ class InspIRCd : public classbase
         */
        irc::whowas::whowas_users whowas;
 
+       /** Whowas container, contains a map of time_t to users tracked by WHOWAS
+        */
+       irc::whowas::whowas_users_fifo whowas_fifo;
+
        /** DNS class, provides resolver facilities to the core and modules
         */
        DNS* Res;
@@ -408,12 +429,25 @@ class InspIRCd : public classbase
         */
        FactoryList factory;
 
+       /** The time we next call our ping timeout and reg timeout checks
+        */
+       time_t next_call;
+
        /** Get the current time
         * Because this only calls time() once every time around the mainloop,
         * it is much faster than calling time() directly.
+        * @param delta True to use the delta as an offset, false otherwise
         * @return The current time as an epoch value (time_t)
         */
-       time_t Time();
+       time_t Time(bool delta = false);
+
+       /** Set the time offset in seconds
+        * This offset is added to Time() to offset the system time by the specified
+        * number of seconds.
+        * @param delta The number of seconds to offset
+        * @return The old time delta
+        */
+       int SetTimeDelta(int delta);
 
        /** Process a user whos socket has been flagged as active
         * @param cu The user to process
@@ -435,9 +469,10 @@ class InspIRCd : public classbase
 
        /** Bind all ports specified in the configuration file.
         * @param bail True if the function should bail back to the shell on failure
+        * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
         * @return The number of ports actually bound without error
         */
-       int BindPorts(bool bail);
+       int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
 
        /** Returns true if this server has the given port bound to the given address
         * @param port The port number
@@ -855,21 +890,6 @@ class InspIRCd : public classbase
         */
         bool IsValidMask(const std::string &mask);
 
-       /** Add an InspSocket class to the active set
-        * @param sock A socket to add to the active set
-        */
-        void AddSocket(InspSocket* sock);
-
-       /** Remove an InspSocket class from the active set at next time around the loop
-        * @param sock A socket to remove from the active set
-        */
-        void RemoveSocket(InspSocket* sock);
-
-       /** Delete a socket immediately without waiting for the next iteration of the mainloop
-        * @param sock A socket to delete from the active set
-        */
-        void DelSocket(InspSocket* sock);
-
        /** Rehash the local server
         */
         void RehashServer();
@@ -996,6 +1016,10 @@ class InspIRCd : public classbase
         */
        void Log(int level, const std::string &text);
 
+       void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text);
+
+       void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...);
+
        /** Begin execution of the server.
         * NOTE: this function NEVER returns. Internally,
         * after performing some initialisation routines,