]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Migrate u_listmode.h into the core, change +b to use it
[user/henk/code/inspircd.git] / include / inspircd.h
index 44e6abe57791ca41cea8da10be8abc08d5101519..fa00902a49a3dab07904f08ab72243345b147ede 100644 (file)
@@ -1,28 +1,39 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 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 */
 #define CUSTOM_PRINTF(STRING, FIRST)
 #endif
 
+#if defined __clang__ || defined __GNUC__
+# define DEPRECATED_METHOD(function) function __attribute__((deprecated))
+#elif defined _MSC_VER
+# define DEPRECATED_METHOD(function) __declspec(deprecated) function
+#else
+# pragma message ("Warning! DEPRECATED_METHOD() does not work on your compiler!")
+# define DEPRECATED_METHOD(function) function
+#endif
+
 // Required system headers.
 #include <ctime>
 #include <cstdarg>
 #include <cstring>
 #include <climits>
 #include <cstdio>
+#ifndef _WIN32
+#include <unistd.h>
+#endif
 
+#ifdef _WIN32
+# include <unordered_map>
+#else
+# include <tr1/unordered_map>
+#endif
 #include <sstream>
 #include <string>
 #include <vector>
@@ -53,9 +81,9 @@
 #include <bitset>
 #include <set>
 #include <time.h>
-#include "inspircd_config.h"
-#include "inspircd_version.h"
+#include "config.h"
 #include "typedefs.h"
+#include "consolecolors.h"
 
 CoreExport extern InspIRCd* ServerInstance;
 
@@ -77,7 +105,6 @@ 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"
@@ -98,11 +125,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,31 +236,45 @@ 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
         */
        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_HANDLER2(IsNickHandler, bool, const std::string&, size_t);
+DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
+DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
+DEFINE_HANDLER2(IsChannelHandler, bool, const std::string&, size_t);
 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
+DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
+
+class TestSuite;
 
 /** The main class of the irc server.
  * This class contains instances of all the other classes in this software.
@@ -290,10 +326,6 @@ class CoreExport InspIRCd
         */
        char ReadBuffer[65535];
 
-#ifdef WIN32
-       IPC* WindowsIPC;
-#endif
-
  public:
 
        /** Global cull list, will be processed on next iteration
@@ -306,10 +338,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:
@@ -325,17 +357,19 @@ class CoreExport InspIRCd
         */
        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
         */
@@ -449,6 +483,20 @@ class CoreExport InspIRCd
        /** 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
         */
@@ -458,6 +506,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);
@@ -521,12 +570,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;
+       caller2<bool, const std::string&, size_t> 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
         */
@@ -545,7 +594,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);
@@ -569,13 +618,13 @@ class CoreExport InspIRCd
         * @param n A nickname to verify
         * @return True if the nick is valid
         */
-       caller2<bool, const char*, size_t> IsNick;
+       caller2<bool, const std::string&, size_t> 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;
+       caller1<bool, const std::string&> IsIdent;
 
        /** Add a dns Resolver class to this server's active set
         * @param r The resolver to add
@@ -612,10 +661,19 @@ 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);
@@ -625,33 +683,27 @@ class CoreExport InspIRCd
         * 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);
 
-       /** 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 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);
-
        /** Return true if the given parameter is a valid nick!user\@host mask
         * @param mask A nick!user\@host masak to match against
         * @return True i the mask is valid
         */
        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();
@@ -682,7 +734,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
@@ -710,7 +762,7 @@ class CoreExport InspIRCd
        /** 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
@@ -744,19 +796,16 @@ class CoreExport InspIRCd
         */
        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
+       /** 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
         */
-       caller1<void, User*> FloodQuitUser;
+       caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 
        /** Restart the server.
         * This function will not return. If an error occurs,
@@ -772,17 +821,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);
@@ -802,6 +840,8 @@ class CoreExport InspIRCd
        {
                return this->ReadBuffer;
        }
+
+       friend class TestSuite;
 };
 
 ENTRYPOINT;
@@ -827,3 +867,4 @@ class CommandModule : public Module
 };
 
 #endif
+