]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Merge pull request #1050 from Aviator45003/insp20
[user/henk/code/inspircd.git] / include / inspircd.h
index ef6c86f285d52d49001e3194a588e0750a41f059..e2eaf82927171fd7b8cec3bb9bc23cb3987caa7b 100644 (file)
@@ -1,32 +1,42 @@
-/*       +------------------------------------+
- *       | 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__
+
+#ifndef INSPIRCD_H
+#define INSPIRCD_H
 
 #define _FILE_OFFSET_BITS 64
 #ifndef _LARGEFILE_SOURCE
 #define _LARGEFILE_SOURCE
 #endif
 
-#ifndef WIN32
+#ifndef _WIN32
 #define DllExport
 #define CoreExport
-#define printf_c printf
 #else
 #include "inspircd_win32wrapper.h"
 /** Windows defines these already */
-#undef DELETE
 #undef ERROR
 #endif
 
@@ -37,6 +47,7 @@
 #endif
 
 // Required system headers.
+#include <csignal>
 #include <ctime>
 #include <cstdarg>
 #include <algorithm>
@@ -44,6 +55,9 @@
 #include <cstring>
 #include <climits>
 #include <cstdio>
+#ifndef _WIN32
+#include <unistd.h>
+#endif
 
 #include <sstream>
 #include <string>
 #include <map>
 #include <bitset>
 #include <set>
+#include <time.h>
+#include "inspircd_config.h"
+#include "inspircd_version.h"
+#include "typedefs.h"
+#include "consolecolors.h"
 
-/** 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;
+CoreExport extern InspIRCd* ServerInstance;
 
-/** An entire config file, built up of KeyValLists
- */
-typedef std::multimap< std::string, KeyValList > ConfigDataHash;
-
-#include "inspircd_config.h"
+#include "caller.h"
+#include "cull_list.h"
+#include "extensible.h"
 #include "numerics.h"
 #include "uid.h"
 #include "users.h"
 #include "channels.h"
 #include "timer.h"
 #include "hashcomp.h"
-#include "typedefs.h"
 #include "logger.h"
 #include "usermanager.h"
 #include "socket.h"
@@ -89,15 +92,12 @@ typedef std::multimap< std::string, KeyValList > ConfigDataHash;
 #include "mode.h"
 #include "socketengine.h"
 #include "snomasks.h"
-#include "cull_list.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"
-#include "fakeuser.h"
 
 #ifndef PATH_MAX
 #warning Potentially broken system, PATH_MAX undefined
@@ -170,7 +170,7 @@ inline std::string ConvToStr(const bool in)
  */
 inline std::string ConvToStr(char in)
 {
-       return std::string(in,1);
+       return std::string(1, in);
 }
 
 /** Template function to convert any input type to std::string
@@ -189,36 +189,14 @@ template<typename T> inline long ConvToInt(const T &in)
 {
        std::stringstream tmp;
        if (!(tmp << in)) return 0;
-       return atoi(tmp.str().c_str());
-}
-
-/** 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
- * @param V result value
- * @param R base to convert to
- */
-template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
-{
-       if (base < 2 || base > 16) { *res = 0; return res; }
-       char* out = res;
-       int quotient = in;
-       while (quotient) {
-               *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
-               ++out;
-               quotient /= base;
-       }
-       if ( in < 0 && base == 10) *out++ = '-';
-       std::reverse( res, out );
-       *out = 0;
-       return res;
+       return atol(tmp.str().c_str());
 }
 
 /** This class contains various STATS counters
  * It is used by the InspIRCd class, which internally
  * has an instance of it.
  */
-class serverstats : public classbase
+class serverstats
 {
   public:
        /** Number of accepted connections
@@ -251,73 +229,55 @@ class serverstats : public classbase
        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)
        {
        }
 };
 
-class InspIRCd;
-
-DEFINE_HANDLER1(ProcessUserHandler, void, User*);
 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
+DEFINE_HANDLER2(GenRandomHandler, void, 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&);
+DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, 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;
-       ServerConfig* Config;
-       bool done;
- public:
-       std::string TheUserUID;
-       ConfigReaderThread(InspIRCd* Instance, const std::string &useruid)
-               : Thread(), ServerInstance(Instance), done(false), TheUserUID(useruid)
-       {
-       }
-
-       virtual ~ConfigReaderThread()
-       {
-       }
-
-       void Run();
-       /** Run in the main thread to apply the configuration */
-       void Finish();
-       bool IsDone() { return done; }
-};
+class TestSuite;
 
 /** 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,
- * 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.
+ * This class contains instances of all the other classes in this software.
+ * 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.
  */
-class CoreExport InspIRCd : public classbase
+class CoreExport InspIRCd
 {
  private:
        /** Holds the current UID. Used to generate the next one.
@@ -350,57 +310,35 @@ class CoreExport InspIRCd : public classbase
         * @param user The user to verify
         * @return True if all modules have finished checking this user
         */
-       bool AllModulesReportReady(User* user);
-
-       /** Logfile pathname specified on the commandline, or empty string
-        */
-       char LogFileName[MAXBUF];
+       bool AllModulesReportReady(LocalUser* user);
 
        /** 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];
 
-       /** Used when connecting clients
-        */
-       irc::sockets::insp_sockaddr client, server;
-
-       /** Used when connecting clients
-        */
-       socklen_t length;
-
-#ifdef WIN32
-       IPC* WindowsIPC;
-#endif
-
  public:
 
        /** Global cull list, will be processed on next iteration
         */
        CullList GlobalCulls;
+       /** Actions that must happen outside of the current call stack */
+       ActionList AtomicActions;
 
        /**** Functors ****/
 
-       ProcessUserHandler HandleProcessUser;
        IsNickHandler HandleIsNick;
        IsIdentHandler HandleIsIdent;
        FloodQuitUserHandler HandleFloodQuitUser;
+       OnCheckExemptionHandler HandleOnCheckExemption;
        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;
+       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:
@@ -416,33 +354,33 @@ class CoreExport InspIRCd : public classbase
         */
        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 &);
+       User* FindUUID(const std::string &uid);
 
        /** 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 char *);
+       User* FindUUID(const char *uid);
 
        /** Build the ISUPPORT string by triggering all modules On005Numeric events
         */
        void BuildISupport();
 
-       /** List of server names we've seen.
-        */
-       servernamelist servernames;
-
        /** Time this ircd was booted
         */
        time_t startup_time;
 
        /** Config file pathname specified on the commandline or via ./configure
         */
-       char ConfigFileName[MAXBUF];
+       std::string ConfigFileName;
+
+       ExtensionManager Extensions;
 
        /** Mode handler, handles mode setting and removal
         */
@@ -513,29 +451,48 @@ class CoreExport InspIRCd : public classbase
 
        /** List of the open ports
         */
-       std::vector<ListenSocketBase *> ports;
+       std::vector<ListenSocket*> ports;
 
        /** 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;
+
        /** 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();
 
-       /** 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.
+       /** 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)
         */
-       caller1<void, User*> ProcessUser;
+       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
@@ -546,28 +503,11 @@ class CoreExport InspIRCd : public classbase
         * @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);
 
-       /** Adds a server name to the list of servers we've seen
-        * @param The servername to add
-        */
-       void AddServerName(const std::string &servername);
-
-       /** Finds a cached char* pointer of a server name,
-        * This is used to optimize User by storing only the pointer to the name
-        * @param The servername to find
-        * @return A pointer to this name, gauranteed to never become invalid
-        */
-       const char* FindServerNamePtr(const std::string &servername);
-
-       /** Returns true if we've seen the given server name before
-        * @param The servername to find
-        * @return True if we've seen this server name before
-        */
-       bool FindServerName(const std::string &servername);
-
        /** Gets the GECOS (description) field of the given server.
         * If the servername is not that of the local server, the name
         * is passed to handling modules which will attempt to determine
@@ -575,7 +515,7 @@ class CoreExport InspIRCd : public classbase
         * @param servername The servername to find the description of
         * @return The description of this server, or of the local server
         */
-       std::string GetServerDescription(const char* servername);
+       std::string GetServerDescription(const std::string& servername);
 
        /** Find a user in the nick hash.
         * If the user cant be found in the nick hash check the uuid hash
@@ -611,11 +551,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,7 +591,7 @@ class CoreExport InspIRCd : public classbase
        /** 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);
@@ -710,7 +645,10 @@ class CoreExport InspIRCd : public classbase
         * @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
@@ -720,10 +658,19 @@ class CoreExport InspIRCd : public classbase
         */
        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);
@@ -733,6 +680,7 @@ class CoreExport InspIRCd : public classbase
         * 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);
@@ -740,15 +688,14 @@ class CoreExport InspIRCd : public classbase
        /** 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
         */
        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 commandname The command name to check
+        * @param pcnt The parameter count
         * @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
         */
@@ -760,22 +707,19 @@ class CoreExport InspIRCd : public classbase
         */
        bool IsValidMask(const std::string &mask);
 
-       /** Rehash the local server
+       /** Strips all color codes from the given string
+        * @param sentence The string to strip from
         */
-       void RehashServer();
+       static void StripColor(std::string &sentence);
 
-       /** 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()
+       /** Parses color codes from string values to actual color codes
+        * @param input The data to process
         */
-       Channel* GetChannelIndex(long index);
+       static void ProcessColors(file_cache& input);
 
-       /** 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
+       /** Rehash the local server
         */
-       void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
+       void RehashServer();
 
        /** Check if the given nickmask matches too many users, send errors to the given user
         * @param nick A nickmask to match against
@@ -821,22 +765,17 @@ class CoreExport InspIRCd : public classbase
         * @param server The server to check for uline status
         * @return True if the server is a uline OR the string is empty
         */
-       bool ULine(const char* server);
+       bool ULine(const std::string& 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
-        */
-       std::string GetRevision();
+       bool SilentULine(const std::string& server);
 
        /** Returns the full version string of this ircd
         * @return The version string
         */
-       std::string GetVersionString();
+       std::string GetVersionString(bool rawversion = false);
 
        /** Attempt to write the process id to a given file
         * @param filename The PID file to attempt to write to
@@ -870,12 +809,23 @@ class CoreExport InspIRCd : public classbase
         */
        void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 
+       /** 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;
 
+       /** 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
+        */
+       caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
+
        /** Restart the server.
         * This function will not return. If an error occurs,
         * it will throw an instance of CoreException.
@@ -912,11 +862,6 @@ class CoreExport InspIRCd : public classbase
         */
        int Run();
 
-       /** Force all BufferedSockets to be removed which are due to
-        * be culled.
-        */
-       void BufferedSocketCull();
-
        /** Adds an extban char to the 005 token.
         */
        void AddExtBanChar(char c);
@@ -925,8 +870,30 @@ class CoreExport InspIRCd : public classbase
        {
                return this->ReadBuffer;
        }
+
+       friend class TestSuite;
 };
 
 ENTRYPOINT;
 
+template<class Cmd>
+class CommandModule : public Module
+{
+       Cmd cmd;
+ public:
+       CommandModule() : cmd(this)
+       {
+       }
+
+       void init()
+       {
+               ServerInstance->Modules->AddService(cmd);
+       }
+
+       Version GetVersion()
+       {
+               return Version(cmd.name, VF_VENDOR|VF_CORE);
+       }
+};
+
 #endif