]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Make rehash generate a new ServerInstance->Config object
[user/henk/code/inspircd.git] / include / inspircd.h
index 05e33cf0c0f2d59d210abe1f883bed1e84519351..ef6c86f285d52d49001e3194a588e0750a41f059 100644 (file)
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *         the file COPYING for details.
 #ifndef __INSPIRCD_H__
 #define __INSPIRCD_H__
 
+#define _FILE_OFFSET_BITS 64
+#ifndef _LARGEFILE_SOURCE
+#define _LARGEFILE_SOURCE
+#endif
+
 #ifndef WIN32
-#define DllExport 
-#define CoreExport 
+#define DllExport
+#define CoreExport
 #define printf_c printf
 #else
 #include "inspircd_win32wrapper.h"
 #endif
 
 // Required system headers.
-#include <time.h>
-#include <stdarg.h>
+#include <ctime>
+#include <cstdarg>
+#include <algorithm>
+#include <cmath>
+#include <cstring>
+#include <climits>
+#include <cstdio>
+
+#include <sstream>
+#include <string>
+#include <vector>
+#include <list>
+#include <deque>
+#include <map>
+#include <bitset>
+#include <set>
+
+/** A list of failed port bindings, used for informational purposes on startup */
+typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
+
+/** A cached text file stored with its contents as lines
+ */
+typedef std::deque< std::string > file_cache;
+
+/** A configuration key and value pair
+ */
+typedef std::pair< std::string, std::string > KeyVal;
+
+/** A list of related configuration keys and values
+ */
+typedef std::vector< KeyVal > KeyValList;
+
+/** An entire config file, built up of KeyValLists
+ */
+typedef std::multimap< std::string, KeyValList > ConfigDataHash;
 
 #include "inspircd_config.h"
+#include "numerics.h"
 #include "uid.h"
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
 #include "configreader.h"
 #include "inspstring.h"
+#include "protocol.h"
+#include "threadengine.h"
+#include "fakeuser.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.
@@ -223,28 +270,32 @@ class serverstats : public classbase
        }
 };
 
-/** A list of failed port bindings, used for informational purposes on startup */
-typedef std::vector<std::pair<std::string, long> > FailedPortList;
-
 class InspIRCd;
 
 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
-DEFINE_HANDLER1(IsNickHandler, bool, const char*);
+DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
-DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
 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&);
 
 /* Forward declaration - required */
 class XLineManager;
 class BanCacheManager;
 
+/** The background thread for config reading, so that reading from executable includes
+ * does not block.
+ */
 class CoreExport ConfigReaderThread : public Thread
 {
        InspIRCd* ServerInstance;
-       bool do_bail;
-       User* TheUser;
+       ServerConfig* Config;
+       bool done;
  public:
-       ConfigReaderThread(InspIRCd* Instance, bool bail, User* user) : Thread(), ServerInstance(Instance), do_bail(bail), TheUser(user)
+       std::string TheUserUID;
+       ConfigReaderThread(InspIRCd* Instance, const std::string &useruid)
+               : Thread(), ServerInstance(Instance), done(false), TheUserUID(useruid)
        {
        }
 
@@ -253,6 +304,9 @@ class CoreExport ConfigReaderThread : public Thread
        }
 
        void Run();
+       /** Run in the main thread to apply the configuration */
+       void Finish();
+       bool IsDone() { return done; }
 };
 
 /** The main class of the irc server.
@@ -261,12 +315,7 @@ class CoreExport ConfigReaderThread : public Thread
  * classbase. Amongst other things, it contains a ModeParser,
  * a DNS object, a CommandParser object, and a list of active
  * Module objects, and facilities for Module objects to
- * interact with the core system it implements. You should
- * NEVER attempt to instantiate a class of type InspIRCd
- * yourself. If you do, this is equivalent to spawning a second
- * IRC server, and could have catastrophic consequences for the
- * program in terms of ram usage (basically, you could create
- * an obese forkbomb built from recursively spawning irc servers!)
+ * interact with the core system it implements.
  */
 class CoreExport InspIRCd : public classbase
 {
@@ -315,7 +364,8 @@ class CoreExport InspIRCd : public classbase
         */
        time_t OLDTIME;
 
-       /** A 64k buffer used to read client lines into
+       /** A 64k buffer used to read socket data into
+        * NOTE: update ValidateNetBufferSize if you change this
         */
        char ReadBuffer[65535];
 
@@ -342,8 +392,10 @@ class CoreExport InspIRCd : public classbase
        ProcessUserHandler HandleProcessUser;
        IsNickHandler HandleIsNick;
        IsIdentHandler HandleIsIdent;
-       FindDescriptorHandler HandleFindDescriptor;
        FloodQuitUserHandler HandleFloodQuitUser;
+       IsChannelHandler HandleIsChannel;
+       IsSIDHandler HandleIsSID;
+       RehashHandler HandleRehash;
 
        /** BufferedSocket classes pending deletion after being closed.
         * We don't delete these immediately as this may cause a segmentation fault.
@@ -358,7 +410,7 @@ class CoreExport InspIRCd : public classbase
         * hash and set its descriptor to FD_MAGIC_NUMBER so the data
         * falls into the abyss :p
         */
-       User *FakeClient;
+       FakeUser* FakeClient;
 
        /** Returns the next available UID for this server.
         */
@@ -368,13 +420,13 @@ class CoreExport InspIRCd : public classbase
         * @param nick The nickname to find
         * @return A pointer to the user, or NULL if the user does not exist
         */
-       User *FindUUID(const std::string &);
+       UserFindUUID(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 *);
+       UserFindUUID(const char *);
 
        /** Build the ISUPPORT string by triggering all modules On005Numeric events
         */
@@ -415,7 +467,7 @@ class CoreExport InspIRCd : public classbase
        /** LogManager handles logging.
         */
        LogManager *Logs;
-       
+
        /** ModuleManager contains everything related to loading/unloading
         * modules.
         */
@@ -459,10 +511,18 @@ class CoreExport InspIRCd : public classbase
         */
        chan_hash* chanlist;
 
+       /** List of the open ports
+        */
+       std::vector<ListenSocketBase *> ports;
+
        /** Set to the current signal recieved
         */
        int s_signal;
 
+       /** Protocol interface, overridden by server protocol modules
+        */
+       ProtocolInterface* PI;
+
        /** Get the current time
         * Because this only calls time() once every time around the mainloop,
         * it is much faster than calling time() directly.
@@ -478,11 +538,9 @@ class CoreExport InspIRCd : public classbase
        caller1<void, User*> ProcessUser;
 
        /** 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
+        * @return The number of ports bound without error
         */
-       int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
+       int BindPorts(FailedPortList &failed_ports);
 
        /** Binds a socket on an already open file descriptor
         * @param sockfd A valid file descriptor of an open socket
@@ -574,23 +632,23 @@ class CoreExport InspIRCd : public classbase
         * @param chname A channel name to verify
         * @return True if the name is valid
         */
-       bool IsChannel(const char *chname);
+       caller2<bool, const char*, size_t> IsChannel;
 
        /** Return true if str looks like a server ID
         * @param string to check against
         */
-       bool IsSID(const std::string &str);
+       caller1<bool, const std::string&> IsSID;
 
        /** Rehash the local server
         */
-       void Rehash();
+       caller1<void, const std::string&> Rehash;
 
        /** Handles incoming signals after being set
         * @param signal the signal recieved
         */
        void SignalHandler(int signal);
 
-       /** Sets the signal recieved    
+       /** Sets the signal recieved
         * @param signal the signal recieved
         */
        static void SetSignal(int signal);
@@ -622,7 +680,7 @@ class CoreExport InspIRCd : public classbase
         * @param n A nickname to verify
         * @return True if the nick is valid
         */
-       caller1<bool, const char*> IsNick;
+       caller2<bool, const char*, size_t> IsNick;
 
        /** Return true if an ident is valid
         * @param An ident to verify
@@ -630,13 +688,6 @@ class CoreExport InspIRCd : public classbase
         */
        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
-        */
-       caller1<User*, int> FindDescriptor;
-
        /** 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
@@ -665,19 +716,26 @@ class CoreExport InspIRCd : public classbase
         * The parameters provided are identical to that sent to the
         * handler for class cmd_mode.
         * @param parameters The mode parameters
-        * @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* const* parameters, int pcnt, User *user);
+       void SendMode(const std::vector<std::string>& parameters, User *user);
 
-       /** Match two strings using pattern matching.
-        * This operates identically to the global function match(),
-        * except for that it takes std::string arguments rather than
-        * const char* ones.
-        * @param sliteral The literal string to match against
-        * @param spattern The pattern to match against. CIDR and globs are supported.
+       /** 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.
         */
-       bool MatchText(const std::string &sliteral, const std::string &spattern);
+       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.
+        */
+       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
@@ -686,7 +744,7 @@ class CoreExport InspIRCd : public classbase
         * @param user The user to execute the command as
         * @return True if the command handler was called successfully
         */
-       CmdResult CallCommandHandler(const std::string &commandname, const char* const* parameters, int pcnt, User* user);
+       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
@@ -756,7 +814,7 @@ class CoreExport InspIRCd : public classbase
         * @param hashtype The hash from the config file
         * @return 0 if the strings match, 1 or -1 if they do not
         */
-       int PassCompare(Extensible* ex, const char* data,const char* input, const char* hashtype);
+       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.
@@ -795,23 +853,6 @@ class CoreExport InspIRCd : public classbase
         */
        InspIRCd(int argc, char** argv);
 
-       /** Output a log message to the ircd.log file
-        * The text will only be output if the current loglevel
-        * is less than or equal to the level you provide
-        * @param level A log level from the DebugLevel enum
-        * @param text Format string of to write to the log
-        * @param ... Format arguments of text to write to the log
-        */
-       void Log(int level, const char* text, ...) CUSTOM_PRINTF(3, 4);
-
-       /** Output a log message to the ircd.log file
-        * The text will only be output if the current loglevel
-        * is less than or equal to the level you provide
-        * @param level A log level from the DebugLevel enum
-        * @param text Text to write to the log
-        */
-       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
@@ -876,10 +917,16 @@ class CoreExport InspIRCd : public classbase
         */
        void BufferedSocketCull();
 
+       /** Adds an extban char to the 005 token.
+        */
+       void AddExtBanChar(char c);
+
        char* GetReadBuffer()
        {
                return this->ReadBuffer;
        }
 };
 
+ENTRYPOINT;
+
 #endif