]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Added macro to allow simpler logic in functions with the need to vsnprintf
[user/henk/code/inspircd.git] / include / inspircd.h
index a183e1dedf7e3a3892404523d5d0389aa838c2e4..de574b6f41e2c0b7557e38a077c75d41adc099a0 100644 (file)
@@ -1,64 +1,55 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ *   Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2003 randomdan <???@???>
  *
- * This program is free but copyrighted software; see
- *         the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#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 printf_c printf
-#else
-#include "inspircd_win32wrapper.h"
-/** Windows defines these already */
-#undef DELETE
-#undef ERROR
-#endif
 
-#ifdef __GNUC__
-#define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
-#else
-#define CUSTOM_PRINTF(STRING, FIRST)
-#endif
+#pragma once
 
-// Required system headers.
-#include <ctime>
-#include <cstdarg>
-#include <algorithm>
-#include <cmath>
-#include <cstring>
 #include <climits>
+#include <cmath>
+#include <csignal>
+#include <cstdarg>
 #include <cstdio>
+#include <cstring>
+#include <ctime>
 
-#include <sstream>
-#include <string>
-#include <vector>
-#include <list>
+#include <algorithm>
+#include <bitset>
 #include <deque>
+#include <list>
 #include <map>
-#include <bitset>
 #include <set>
-#include "inspircd_config.h"
-#include "inspircd_version.h"
+#include <sstream>
+#include <string>
+#include <vector>
+
+#include "compat.h"
 #include "typedefs.h"
 
 CoreExport extern InspIRCd* ServerInstance;
 
+#include "config.h"
+#include "consolecolors.h"
 #include "caller.h"
 #include "cull_list.h"
 #include "extensible.h"
@@ -77,17 +68,11 @@ CoreExport extern InspIRCd* ServerInstance;
 #include "socketengine.h"
 #include "snomasks.h"
 #include "filelogger.h"
-#include "caller.h"
 #include "modules.h"
+#include "threadengine.h"
 #include "configreader.h"
 #include "inspstring.h"
 #include "protocol.h"
-#include "threadengine.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.
@@ -98,11 +83,6 @@ CoreExport extern InspIRCd* ServerInstance;
  */
 #define ERROR -1
 
-/** Support for librodent -
- * see http://www.chatspike.net/index.php?z=64
- */
-#define ETIREDHAMSTERS EAGAIN
-
 /** Template function to convert any input type to std::string
  */
 template<typename T> inline std::string ConvNumeric(const T &in)
@@ -214,57 +194,65 @@ class serverstats
        unsigned long statsConnects;
        /** Total bytes of data transmitted
         */
-       double statsSent;
+       unsigned long statsSent;
        /** Total bytes of data received
         */
-       double statsRecv;
+       unsigned long statsRecv;
+#ifdef _WIN32
+       /** Cpu usage at last sample
+       */
+       FILETIME LastCPU;
+       /** Time QP sample was read
+       */
+       LARGE_INTEGER LastSampled;
+       /** QP frequency
+       */
+       LARGE_INTEGER QPFrequency;
+#else
        /** Cpu usage at last sample
         */
        timeval LastCPU;
        /** Time last sample was read
         */
-       timeval LastSampled;
+       timespec LastSampled;
+#endif
        /** 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)
+               statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
        {
        }
 };
 
-DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
-DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
-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&);
-
-/** The background thread for config reading, so that reading from executable includes
- * does not block.
- */
-class CoreExport ConfigReaderThread : public Thread
+/** This class manages the generation and transmission of ISUPPORT. */
+class CoreExport ISupportManager
 {
-       ServerConfig* Config;
-       volatile bool done;
- public:
-       const std::string TheUserUID;
-       ConfigReaderThread(const std::string &useruid)
-               : Config(new ServerConfig), done(false), TheUserUID(useruid)
-       {
-       }
+private:
+       /** The generated lines which are sent to clients. */
+       std::vector<std::string> Lines;
+
+public:
+       /** (Re)build the ISUPPORT vector. */
+       void Build();
 
-       virtual ~ConfigReaderThread()
+       /** Returns the std::vector of ISUPPORT lines. */
+       const std::vector<std::string>& GetLines()
        {
-               delete Config;
+               return this->Lines;
        }
 
-       void Run();
-       /** Run in the main thread to apply the configuration */
-       void Finish();
-       bool IsDone() { return done; }
+       /** Send the 005 numerics (ISUPPORT) to a user. */
+       void SendTo(LocalUser* user);
 };
 
+DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
+DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
+DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
+DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
+DEFINE_HANDLER1(RehashHandler, void, const std::string&);
+DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
+
 /** The main class of the irc server.
  * This class contains instances of all the other classes in this software.
  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
@@ -274,10 +262,6 @@ class CoreExport ConfigReaderThread : public Thread
 class CoreExport InspIRCd
 {
  private:
-       /** Holds the current UID. Used to generate the next one.
-        */
-       char current_uid[UUID_LENGTH];
-
        /** Set up the signal handlers
         */
        void SetSignals();
@@ -292,10 +276,6 @@ class CoreExport InspIRCd
         */
        void DoSocketTimeouts(time_t TIME);
 
-       /** Increments the current UID by one.
-        */
-       void IncrementUID(int pos);
-
        /** Perform background user events such as PING checks
         */
        void DoBackgroundUserStuff();
@@ -308,23 +288,17 @@ class CoreExport InspIRCd
 
        /** The current time, updated in the mainloop
         */
-       time_t TIME;
-
-       /** The time that was recorded last time around the mainloop
-        */
-       time_t OLDTIME;
+       struct timespec TIME;
 
        /** A 64k buffer used to read socket data into
         * NOTE: update ValidateNetBufferSize if you change this
         */
        char ReadBuffer[65535];
 
-#ifdef WIN32
-       IPC* WindowsIPC;
-#endif
-
  public:
 
+       UIDGenerator UIDGen;
+
        /** Global cull list, will be processed on next iteration
         */
        CullList GlobalCulls;
@@ -335,10 +309,10 @@ class CoreExport InspIRCd
 
        IsNickHandler HandleIsNick;
        IsIdentHandler HandleIsIdent;
-       FloodQuitUserHandler HandleFloodQuitUser;
+       OnCheckExemptionHandler HandleOnCheckExemption;
        IsChannelHandler HandleIsChannel;
-       IsSIDHandler HandleIsSID;
        RehashHandler HandleRehash;
+       GenRandomHandler HandleGenRandom;
 
        /** 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:
@@ -350,25 +324,13 @@ class CoreExport InspIRCd
         */
        FakeUser* FakeClient;
 
-       /** Returns the next available UID for this server.
-        */
-       std::string GetUID();
+       static const char LogHeader[];
 
        /** Find a user in the UUID hash
-        * @param nick The nickname to find
+        * @param uid The UUID to find
         * @return A pointer to the user, or NULL if the user does not exist
         */
-       User* 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
-        */
-       User* FindUUID(const char *);
-
-       /** Build the ISUPPORT string by triggering all modules On005Numeric events
-        */
-       void BuildISupport();
+       User* FindUUID(const std::string &uid);
 
        /** Time this ircd was booted
         */
@@ -427,10 +389,6 @@ class CoreExport InspIRCd
         */
        SnomaskManager* SNO;
 
-       /** DNS class, provides resolver facilities to the core and modules
-        */
-       DNS* Res;
-
        /** Timer manager class, triggers Timer timer events
         */
        TimerManager* Timers;
@@ -453,26 +411,43 @@ class CoreExport InspIRCd
 
        /** Set to the current signal recieved
         */
-       int s_signal;
+       static sig_atomic_t s_signal;
 
        /** Protocol interface, overridden by server protocol modules
         */
        ProtocolInterface* PI;
 
-       /** Holds extensible for user nickforced
-        */
-       LocalIntExt NICKForced;
-
        /** Holds extensible for user operquit
         */
        LocalStringExt OperQuit;
 
+       /** Manages the generation and transmission of ISUPPORT. */
+       ISupportManager ISupport;
+
        /** Get the current time
         * Because this only calls time() once every time around the mainloop,
         * it is much faster than calling time() directly.
         * @return The current time as an epoch value (time_t)
         */
-       time_t Time();
+       inline time_t Time() { return TIME.tv_sec; }
+       /** The fractional time at the start of this mainloop iteration (nanoseconds) */
+       inline long Time_ns() { return TIME.tv_nsec; }
+       /** Update the current time. Don't call this unless you have reason to do so. */
+       void UpdateTime();
+
+       /** Generate a random string with the given length
+        * @param length The length in bytes
+        * @param printable if false, the string will use characters 0-255; otherwise,
+        * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
+        */
+       std::string GenRandomStr(int length, bool printable = true);
+       /** Generate a random integer.
+        * This is generally more secure than rand()
+        */
+       unsigned long GenRandomInt(unsigned long max);
+
+       /** Fill a buffer with random bits */
+       caller2<void, char*, size_t> GenRandom;
 
        /** Bind all ports specified in the configuration file.
         * @return The number of ports bound without error
@@ -483,6 +458,7 @@ class CoreExport InspIRCd
         * @param sockfd A valid file descriptor of an open socket
         * @param port The port number to bind to
         * @param addr The address to bind to (IP only)
+        * @param dolisten Should this port be listened on?
         * @return True if the port was bound successfully
         */
        bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
@@ -503,17 +479,6 @@ class CoreExport InspIRCd
         */
        User* FindNick(const std::string &nick);
 
-       /** 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
-        */
-       User* FindNick(const char* nick);
-
-       /** Find a user in the nick hash ONLY
-        */
-       User* FindNickOnly(const char* nick);
-
        /** Find a user in the nick hash ONLY
         */
        User* FindNickOnly(const std::string &nick);
@@ -524,12 +489,6 @@ class CoreExport InspIRCd
         */
        Channel* FindChan(const std::string &chan);
 
-       /** 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
-        */
-       Channel* FindChan(const char* chan);
-
        /** Check we aren't running as root, and exit if we are
         * @return Depending on the configuration, this function may never return
         */
@@ -546,12 +505,12 @@ class CoreExport InspIRCd
         * @param chname A channel name to verify
         * @return True if the name is valid
         */
-       caller2<bool, const char*, size_t> IsChannel;
+       caller1<bool, const std::string&> IsChannel;
 
        /** Return true if str looks like a server ID
         * @param string to check against
         */
-       caller1<bool, const std::string&> IsSID;
+       static bool IsSID(const std::string& sid);
 
        /** Rehash the local server
         */
@@ -570,7 +529,7 @@ class CoreExport InspIRCd
        /** Causes the server to exit after unloading modules and
         * closing all open file descriptors.
         *
-        * @param The exit code to give to the operating system
+        * @param status The exit code to give to the operating system
         * (See the ExitStatus enum for valid values)
         */
        void Exit(int status);
@@ -578,6 +537,15 @@ class CoreExport InspIRCd
        /** Causes the server to exit immediately with exit code 0.
         * The status code is required for signal handlers, and ignored.
         */
+
+       /** Printf-wrapper.
+       * @param How you want it formatted
+       * @param ...
+       * @return The formatted string
+       */
+       static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
+       static const char* Format(const va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
+
        static void QuickExit(int status);
 
        /** Return a count of channels on the network
@@ -594,37 +562,22 @@ class CoreExport InspIRCd
         * @param n A nickname to verify
         * @return True if the nick is valid
         */
-       caller2<bool, const char*, size_t> IsNick;
+       caller1<bool, const std::string&> IsNick;
 
        /** Return true if an ident is valid
         * @param An ident to verify
         * @return True if the ident is valid
         */
-       caller1<bool, const char*> IsIdent;
-
-       /** 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
-        * 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);
+       caller1<bool, const std::string&> IsIdent;
 
        /** Add a command to this server's command parser
         * @param f A Command command handler object to add
         * @throw ModuleException Will throw ModuleExcption if the command already exists
         */
-       void AddCommand(Command *f);
+       inline void AddCommand(Command *f)
+       {
+               Modules->AddService(*f);
+       }
 
        /** Send a modechange.
         * The parameters provided are identical to that sent to the
@@ -634,39 +587,39 @@ class CoreExport InspIRCd
         */
        void SendMode(const std::vector<std::string>& parameters, User *user);
 
+       /** Send a modechange and route it to the network.
+        * The parameters provided are identical to that sent to the
+        * handler for class cmd_mode.
+        * @param parameters The mode parameters
+        * @param user The user to send error messages to
+        */
+       void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
+
        /** 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.
+        * @param map The character map to use when matching.
         */
        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);
+       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.
+        * @param map The character map to use when matching.
         */
        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);
+       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
-        * @param parameters The mode parameters
-        * @param pcnt The number of items you have given in the first parameter
-        * @param user The user to execute the command as
-        * @return True if the command handler was called successfully
+       /** Matches a hostname and IP against a space delimited list of hostmasks.
+        * @param masks The space delimited masks to match against.
+        * @param hostname The hostname to try and match.
+        * @param ipaddr The IP address to try and match.
         */
-       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
-        * @param pcnt The number of items you have given in the first parameter
-        * @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, User* user);
+       static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
 
        /** Return true if the given parameter is a valid nick!user\@host mask
         * @param mask A nick!user\@host masak to match against
@@ -674,6 +627,16 @@ class CoreExport InspIRCd
         */
        bool IsValidMask(const std::string &mask);
 
+       /** Strips all color codes from the given string
+        * @param sentence The string to strip from
+        */
+       static void StripColor(std::string &sentence);
+
+       /** Parses color codes from string values to actual color codes
+        * @param input The data to process
+        */
+       static void ProcessColors(file_cache& input);
+
        /** Rehash the local server
         */
        void RehashServer();
@@ -704,7 +667,7 @@ class CoreExport InspIRCd
         * (one year, two weeks, three days, four hours, six minutes and five seconds)
         * @return The total number of seconds
         */
-       long Duration(const std::string &str);
+       static unsigned long Duration(const std::string& str);
 
        /** Attempt to compare a password to a string from the config file.
         * This will be passed to handling modules which will compare the data
@@ -732,7 +695,7 @@ class CoreExport InspIRCd
        /** Returns the full version string of this ircd
         * @return The version string
         */
-       std::string GetVersionString();
+       std::string GetVersionString(bool getFullVersion = false);
 
        /** Attempt to write the process id to a given file
         * @param filename The PID file to attempt to write to
@@ -766,19 +729,12 @@ class CoreExport InspIRCd
         */
        void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 
-       /** Handle /STATS
+       /** Called to check whether a channel restriction mode applies to a user
+        * @param User that is attempting some action
+        * @param Channel that the action is being performed on
+        * @param Action name
         */
-       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
-        */
-       caller1<void, User*> FloodQuitUser;
+       caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 
        /** Restart the server.
         * This function will not return. If an error occurs,
@@ -794,17 +750,6 @@ class CoreExport InspIRCd
         */
        void Cleanup();
 
-       /** This copies the user and channel hash_maps into new hash maps.
-        * This frees memory used by the hash_map allocator (which it neglects
-        * to free, most of the time, using tons of ram)
-        */
-       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);
@@ -816,10 +761,6 @@ class CoreExport InspIRCd
         */
        int Run();
 
-       /** Adds an extban char to the 005 token.
-        */
-       void AddExtBanChar(char c);
-
        char* GetReadBuffer()
        {
                return this->ReadBuffer;
@@ -835,13 +776,15 @@ class CommandModule : public Module
  public:
        CommandModule() : cmd(this)
        {
-               ServerInstance->AddCommand(&cmd);
+       }
+
+       void init()
+       {
+               ServerInstance->Modules->AddService(cmd);
        }
 
        Version GetVersion()
        {
-               return Version(cmd.command, VF_VENDOR|VF_CORE);
+               return Version(cmd.name, VF_VENDOR|VF_CORE);
        }
 };
-
-#endif