]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Remove InspIRCd* parameters and fields
[user/henk/code/inspircd.git] / include / inspircd.h
index 18bb1c28f2e78f64ac1aa903c6371395ccedfd2a..a5e40102a45e3ad62f276ef805d2830c402eaffc 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
 #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;
+
+class InspIRCd;
+extern InspIRCd* ServerInstance;
 
 #include "inspircd_config.h"
+#include "inspircd_version.h"
+#include "extensible.h"
+#include "numerics.h"
 #include "uid.h"
 #include "users.h"
 #include "channels.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.
@@ -149,18 +197,6 @@ template<typename T> inline long ConvToInt(const T &in)
        return atoi(tmp.str().c_str());
 }
 
-template<typename CharT, typename TraitsT, std::size_t N>
-static inline bool operator == (std::basic_string<CharT, TraitsT> const &lhs, char const (&rhs)[N])
-{
-       return lhs.length() == N - 1 && !std::memcmp(lhs.data(), rhs, N - 1);
-}
-
-template<typename CharT, typename TraitsT, std::size_t N>
-static inline bool operator != (std::basic_string<CharT, TraitsT> const &lhs, char const (&rhs)[N])
-{
-       return !(lhs == rhs);
-}
-
 /** 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
@@ -239,15 +275,10 @@ 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_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&);
@@ -257,13 +288,17 @@ DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 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(const std::string &useruid)
+               : Thread(), done(false), TheUserUID(useruid)
        {
        }
 
@@ -272,6 +307,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.
@@ -280,12 +318,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
 {
@@ -334,18 +367,11 @@ 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];
 
-       /** Used when connecting clients
-        */
-       irc::sockets::insp_sockaddr client, server;
-
-       /** Used when connecting clients
-        */
-       socklen_t length;
-
 #ifdef WIN32
        IPC* WindowsIPC;
 #endif
@@ -358,20 +384,13 @@ class CoreExport InspIRCd : public classbase
 
        /**** Functors ****/
 
-       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.
-        */
-       std::map<BufferedSocket*,BufferedSocket*> 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
         * Reason for it:
         * kludge alert!
@@ -380,7 +399,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.
         */
@@ -390,13 +409,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
         */
@@ -412,7 +431,7 @@ class CoreExport InspIRCd : public classbase
 
        /** Config file pathname specified on the commandline or via ./configure
         */
-       char ConfigFileName[MAXBUF];
+       std::string ConfigFileName;
 
        /** Mode handler, handles mode setting and removal
         */
@@ -481,6 +500,10 @@ 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;
@@ -496,19 +519,10 @@ class CoreExport InspIRCd : public classbase
         */
        time_t Time();
 
-       /** 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
-        * marked for deletion in the global CullList.
-        */
-       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
@@ -579,11 +593,6 @@ class CoreExport InspIRCd : public classbase
         */
        Channel* FindChan(const char* chan);
 
-       /** Check for a 'die' tag in the config file, and abort if found
-        * @return Depending on the configuration, this function may never return
-        */
-       void CheckDie();
-
        /** Check we aren't running as root, and exit if we are
         * @return Depending on the configuration, this function may never return
         */
@@ -656,13 +665,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
@@ -691,19 +693,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 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.
+        */
+       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.
         */
-       bool MatchText(const std::string &sliteral, const std::string &spattern);
+       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
@@ -743,7 +752,19 @@ class CoreExport InspIRCd : public classbase
         * @param LinePrefix text to prefix each complete line with
         * @param TextStream the text to send to the user
         */
-       void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
+       void DumpText(User* user, const std::string &LinePrefix, std::stringstream &TextStream);
+
+       /** Dump text to a user target (local or remote)
+        * @param user the user to dump the text to
+        * @param text the full line of text
+        */
+       void DumpText(User* user, const std::string &text);
+
+       /** Dump text to a user target (local or remote)
+        * @param user the user to dump the text to
+        * @param format the printf format string for the text to send
+        */
+       void DumpText(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
 
        /** Check if the given nickmask matches too many users, send errors to the given user
         * @param nick A nickmask to match against
@@ -838,6 +859,14 @@ class CoreExport InspIRCd : public classbase
         */
        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
@@ -880,10 +909,9 @@ class CoreExport InspIRCd : public classbase
         */
        int Run();
 
-       /** Force all BufferedSockets to be removed which are due to
-        * be culled.
+       /** Adds an extban char to the 005 token.
         */
-       void BufferedSocketCull();
+       void AddExtBanChar(char c);
 
        char* GetReadBuffer()
        {
@@ -891,4 +919,22 @@ class CoreExport InspIRCd : public classbase
        }
 };
 
+ENTRYPOINT;
+
+template<class Cmd>
+class CommandModule : public Module
+{
+       Cmd cmd;
+ public:
+       CommandModule() : cmd(this)
+       {
+               ServerInstance->AddCommand(&cmd);
+       }
+
+       Version GetVersion()
+       {
+               return Version(cmd.command, VF_VENDOR);
+       }
+};
+
 #endif