]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Space indents must die.
[user/henk/code/inspircd.git] / include / inspircd.h
index 006e8092ed29021dd0199338b58120dfbe8d69ed..29493d32243cd0f28a58394a3bd3949734484b4c 100644 (file)
@@ -6,7 +6,7 @@
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *         the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 #ifndef __INSPIRCD_H__
 #define __INSPIRCD_H__
 
+#ifndef WIN32
+#define DllExport 
+#define CoreExport 
+#define printf_c printf
+#else
+#include "inspircd_win32wrapper.h"
+#undef DELETE
+#undef ERROR
+#endif
+
 #include <time.h>
 #include <string>
 #include <sstream>
 #include "socketengine.h"
 #include "command_parse.h"
 #include "snomasks.h"
+#include "cull_list.h"
 
 /** Returned by some functions to indicate failure.
  */
 #define ERROR -1
 
-/** Crucial defines
+/** Support for librodent -
+ * see http://www.chatspike.net/index.php?z=64
  */
-#define ETIREDGERBILS EAGAIN
+#define ETIREDHAMSTERS EAGAIN
 
 /** Debug levels for use with InspIRCd::Log()
  */
@@ -46,7 +58,7 @@ enum DebugLevel
 };
 
 /**
- * This define is used in place of strcmp when we 
+ * 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.
@@ -61,9 +73,57 @@ template<typename T> inline void DELETE(T* x)
        x = NULL;
 }
 
-/** Template function to convert any input type to std::string
+/** Template functions to convert any input type to std::string
  */
-template<typename T> inline std::string ConvToStr(const T &in)
+template<typename T> inline std::string ConvNumeric(const T &in)
+{
+       if (in == 0) return "0";
+       char res[MAXBUF];
+       char* out = res;
+       T quotient = in;
+       while (quotient) {
+               *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
+               ++out;
+               quotient /= 10;
+       }
+       if ( in < 0)
+               *out++ = '-';
+       *out = 0;
+       std::reverse(res,out);
+       return res;
+}
+
+inline std::string ConvToStr(const int in)
+{
+       return ConvNumeric(in);
+}
+
+inline std::string ConvToStr(const long in)
+{
+       return ConvNumeric(in);
+}
+
+inline std::string ConvToStr(const unsigned long in)
+{
+       return ConvNumeric(in);
+}
+
+inline std::string ConvToStr(const char* in)
+{
+       return in;
+}
+
+inline std::string ConvToStr(const bool in)
+{
+       return (in ? "1" : "0");
+}
+
+inline std::string ConvToStr(char in)
+{
+       return std::string(in,1);
+}
+
+template <class T> inline std::string ConvToStr(const T &in)
 {
        std::stringstream tmp;
        if (!(tmp << in)) return std::string();
@@ -137,24 +197,17 @@ class serverstats : public classbase
        /** Total bytes of data received
         */
        double statsRecv;
-       /** Number of bound listening ports
-        */
-       unsigned long BoundPortCount;
-
        /** Cpu usage at last sample
         */
        timeval LastCPU;
-
        /** Time last sample was read
         */
        timeval LastSampled;
-
        /** 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.0), statsRecv(0.0),
-               BoundPortCount(0)
+               statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
        {
        }
 };
@@ -173,7 +226,7 @@ class InspIRCd;
  * I/O (linux seems to, as does freebsd) this will default to
  * blocking behaviour.
  */
-class FileLogger : public EventHandler
+class CoreExport FileLogger : public EventHandler
 {
  protected:
        /** The creator/owner of this object
@@ -241,13 +294,13 @@ class XLineManager;
  * program in terms of ram usage (basically, you could create
  * an obese forkbomb built from recursively spawning irc servers!)
  */
-class InspIRCd : public classbase
+class CoreExport InspIRCd : public classbase
 {
  private:
        /** Holds a string describing the last module error to occur
         */
        char MODERR[MAXBUF];
+
        /** Remove a ModuleFactory pointer
         * @param j Index number of the ModuleFactory to remove
         */
@@ -258,10 +311,6 @@ class InspIRCd : public classbase
         */
        void EraseModule(int j);
 
-       /** Build the ISUPPORT string by triggering all modules On005Numeric events
-        */
-       void BuildISupport();
-
        /** Move a given module to a specific slot in the list
         * @param modulename The module name to relocate
         * @param slot The slot to move the module into
@@ -385,7 +434,19 @@ class InspIRCd : public classbase
        int time_delta;
 
  public:
-        /** List of server names we've seen.
+
+       std::map<InspSocket*,InspSocket*> SocketCull;
+
+       /** Build the ISUPPORT string by triggering all modules On005Numeric events
+        */
+       void BuildISupport();
+
+       /** Number of unregistered users online right now.
+        * (Unregistered means before USER/NICK/dns)
+        */
+       int unregistered_count;
+
+       /** List of server names we've seen.
         */
        servernamelist servernames;
 
@@ -393,6 +454,10 @@ class InspIRCd : public classbase
         */
        time_t startup_time;
 
+       /** Config file pathname specified on the commandline or via ./configure
+        */
+       char ConfigFileName[MAXBUF];
+
        /** Mode handler, handles mode setting and removal
         */
        ModeParser* Modes;
@@ -438,14 +503,6 @@ class InspIRCd : public classbase
 
        clonemap global_clones;
 
-       /** Whowas container, contains a map of vectors of users tracked by WHOWAS
-        */
-       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;
@@ -474,6 +531,10 @@ class InspIRCd : public classbase
         */
        time_t next_call;
 
+       /** Global cull list, will be processed on next iteration
+        */
+       CullList GlobalCulls;
+
        /** Get the current time
         * Because this only calls time() once every time around the mainloop,
         * it is much faster than calling time() directly.
@@ -528,22 +589,13 @@ class InspIRCd : public classbase
         */
        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
-        * @param addr The address
-        * @return True if we have a port listening on this address
-        */
-       bool HasPort(int port, char* addr);
-
        /** Binds a socket on an already open file descriptor
         * @param sockfd A valid file descriptor of an open socket
-        * @param client A sockaddr to use as temporary storage
-        * @param server A sockaddr to use as temporary storage
         * @param port The port number to bind to
         * @param addr The address to bind to (IP only)
         * @return True if the port was bound successfully
         */
-       bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr);
+       bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true);
 
        /** Adds a server name to the list of servers we've seen
         * @param The servername to add
@@ -582,7 +634,7 @@ class InspIRCd : public classbase
         * @param text The text to send
         */
        void WriteOpers(const std::string &text);
-       
+
        /** Find a nickname in the nick hash
         * @param nick The nickname to find
         * @return A pointer to the user, or NULL if the user does not exist
@@ -629,21 +681,6 @@ class InspIRCd : public classbase
 
        void CloseLog();
 
-       /** Convert a user to a pseudoclient, disconnecting the real user
-        * @param user The user to convert
-        * @param message The quit message to display when exiting the user
-        * @return True if the operation succeeded
-        */
-       bool UserToPseudo(userrec* user, const std::string &message);
-
-       /** Convert a pseudoclient to a real user, discarding the pseudoclient
-        * @param alive A live client
-        * @param zombie A pseudoclient
-        * @param message The message to display when quitting the pseudoclient
-        * @return True if the operation succeeded
-        */
-       bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
-
        /** Send a server notice to all local users
         * @param text The text format string to send
         * @param ... The format arguments
@@ -658,7 +695,7 @@ class InspIRCd : public classbase
 
        /** Send text to all users with a specific set of modes
         * @param modes The modes to check against, without a +, e.g. 'og'
-        * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the 
+        * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
         * mode characters in the first parameter causes receipt of the message, and
         * if you specify WM_OR, all the modes must be present.
         * @param text The text format string to send
@@ -677,12 +714,19 @@ class InspIRCd : public classbase
         */
        static void Rehash(int status);
 
-       /** Causes the server to exit immediately
+       /** Causes the server to exit after unloading modules and
+        * closing all open file descriptors.
+        *
         * @param The exit code to give to the operating system
         * (See the ExitStatus enum for valid values)
         */
        static void Exit(int status);
 
+       /** Causes the server to exit immediately with exit code 0.
+        * The status code is required for signal handlers, and ignored.
+        */
+       static void QuickExit(int status);
+
        /** Return a count of users, unknown and known connections
         * @return The number of users
         */
@@ -863,38 +907,50 @@ class InspIRCd : public classbase
         * @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);
+       userrec* FindDescriptor(int socket);
 
        /** Add a new mode to this server's mode parser
         * @param mh The modehandler to add
         * @param modechar The mode character this modehandler handles
         * @return True if the mode handler was added
         */
-        bool AddMode(ModeHandler* mh, const unsigned char modechar);
+       bool AddMode(ModeHandler* mh, const unsigned char modechar);
 
        /** Add a new mode watcher to this server's mode parser
         * @param mw The modewatcher to add
         * @return True if the modewatcher was added
         */
-        bool AddModeWatcher(ModeWatcher* mw);
+       bool AddModeWatcher(ModeWatcher* mw);
 
        /** Delete a mode watcher from this server's mode parser
         * @param mw The modewatcher to delete
         * @return True if the modewatcher was deleted
         */
-        bool DelModeWatcher(ModeWatcher* mw);
+       bool DelModeWatcher(ModeWatcher* mw);
 
        /** Add a dns Resolver class to this server's active set
         * @param r The resolver to add
-        * @return True if the resolver was added
-        */
-        bool AddResolver(Resolver* r);
+        * @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_t command handler object to add
         * @throw ModuleException Will throw ModuleExcption if the command already exists
         */
-        void AddCommand(command_t *f);
+       void AddCommand(command_t *f);
 
        /** Send a modechange.
         * The parameters provided are identical to that sent to the
@@ -903,7 +959,7 @@ class InspIRCd : public classbase
         * @param pcnt The number of items you have given in the first parameter
         * @param user The user to send error messages to
         */
-        void SendMode(const char **parameters, int pcnt, userrec *user);
+       void SendMode(const char **parameters, int pcnt, userrec *user);
 
        /** Match two strings using pattern matching.
         * This operates identically to the global function match(),
@@ -912,7 +968,7 @@ class InspIRCd : public classbase
         * @param sliteral The literal string to match against
         * @param spattern The pattern to match against. CIDR and globs are supported.
         */
-        bool MatchText(const std::string &sliteral, const std::string &spattern);
+       bool MatchText(const std::string &sliteral, const std::string &spattern);
 
        /** Call the handler for a given command.
         * @param commandname The command whos handler you wish to call
@@ -921,7 +977,7 @@ class InspIRCd : public classbase
         * @param user The user to execute the command as
         * @return True if the command handler was called successfully
         */
-        bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
+       bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
 
        /** Return true if the command is a module-implemented command and the given parameters are valid for it
         * @param parameters The mode parameters
@@ -929,7 +985,7 @@ class InspIRCd : public classbase
         * @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, userrec* user);
+       bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
 
        /** Add a gline and apply it
         * @param duration How long the line should last
@@ -937,7 +993,7 @@ class InspIRCd : public classbase
         * @param reason The reason for the line
         * @param hostmask The hostmask to set the line against
         */
-        void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
+       void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
 
        /** Add a qline and apply it
         * @param duration How long the line should last
@@ -945,7 +1001,7 @@ class InspIRCd : public classbase
         * @param reason The reason for the line
         * @param nickname The nickmask to set the line against
         */
-        void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
+       void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
 
        /** Add a zline and apply it
         * @param duration How long the line should last
@@ -953,7 +1009,7 @@ class InspIRCd : public classbase
         * @param reason The reason for the line
         * @param ipaddr The ip-mask to set the line against
         */
-        void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
+       void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
 
        /** Add a kline and apply it
         * @param duration How long the line should last
@@ -961,7 +1017,7 @@ class InspIRCd : public classbase
         * @param reason The reason for the line
         * @param hostmask The hostmask to set the line against
         */
-        void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
+       void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
 
        /** Add an eline
         * @param duration How long the line should last
@@ -969,60 +1025,60 @@ class InspIRCd : public classbase
         * @param reason The reason for the line
         * @param hostmask The hostmask to set the line against
         */
-        void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
+       void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
 
        /** Delete a gline
         * @param hostmask The gline to delete
         * @return True if the item was removed
         */
-        bool DelGLine(const std::string &hostmask);
+       bool DelGLine(const std::string &hostmask);
 
        /** Delete a qline
         * @param nickname The qline to delete
         * @return True if the item was removed
         */
-        bool DelQLine(const std::string &nickname);
+       bool DelQLine(const std::string &nickname);
 
        /** Delete a zline
         * @param ipaddr The zline to delete
         * @return True if the item was removed
         */
-        bool DelZLine(const std::string &ipaddr);
+       bool DelZLine(const std::string &ipaddr);
 
        /** Delete a kline
         * @param hostmask The kline to delete
         * @return True if the item was removed
         */
-        bool DelKLine(const std::string &hostmask);
+       bool DelKLine(const std::string &hostmask);
 
        /** Delete an eline
         * @param hostmask The kline to delete
         * @return True if the item was removed
         */
-        bool DelELine(const std::string &hostmask);
+       bool DelELine(const std::string &hostmask);
 
        /** Return true if the given parameter is a valid nick!user\@host mask
-        * @param mask A nick!user\@host masak to match against 
+        * @param mask A nick!user\@host masak to match against
         * @return True i the mask is valid
         */
-        bool IsValidMask(const std::string &mask);
+       bool IsValidMask(const std::string &mask);
 
        /** Rehash the local server
         */
-        void RehashServer();
+       void RehashServer();
 
        /** Return the channel whos index number matches that provided
         * @param The index number of the channel to fetch
         * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
         */
-        chanrec* GetChannelIndex(long index);
+       chanrec* GetChannelIndex(long index);
 
        /** Dump text to a user target, splitting it appropriately to fit
         * @param User the user to dump the text to
         * @param LinePrefix text to prefix each complete line with
         * @param TextStream the text to send to the user
         */
-        void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
+       void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
 
        /** Check if the given nickmask matches too many users, send errors to the given user
         * @param nick A nickmask to match against
@@ -1069,6 +1125,11 @@ class InspIRCd : public classbase
         */
        bool ULine(const char* server);
 
+       /** Returns true if the uline is 'silent' (doesnt generate
+        * remote connect notices etc).
+        */
+       bool SilentULine(const char* server);
+
        /** Returns the subversion revision ID of this ircd
         * @return The revision ID or an empty string
         */
@@ -1158,6 +1219,15 @@ class InspIRCd : public classbase
         */
        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);
+
        /** Begin execution of the server.
         * NOTE: this function NEVER returns. Internally,
         * after performing some initialisation routines,