-/* +------------------------------------+
- * | 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__
+
+#pragma once
#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
#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>
#include <map>
#include <bitset>
#include <set>
+#include <time.h>
+#include "config.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;
-
-/** An entire config file, built up of KeyValLists
- */
-typedef std::multimap< std::string, KeyValList > ConfigDataHash;
-
-class InspIRCd;
CoreExport extern InspIRCd* ServerInstance;
-#include "inspircd_config.h"
-#include "inspircd_version.h"
#include "caller.h"
#include "cull_list.h"
#include "extensible.h"
#include "channels.h"
#include "timer.h"
#include "hashcomp.h"
-#include "typedefs.h"
#include "logger.h"
#include "usermanager.h"
#include "socket.h"
#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"
-#include "fakeuser.h"
#ifndef PATH_MAX
#warning Potentially broken system, PATH_MAX undefined
*/
#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)
{
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
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_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&);
-
-/* 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
+/** This class manages the generation and transmission of ISUPPORT. */
+class CoreExport ISupportManager
{
- ServerConfig* Config;
- bool done;
- public:
- std::string TheUserUID;
- ConfigReaderThread(const std::string &useruid)
- : Thread(), done(false), TheUserUID(useruid)
- {
- }
+private:
+ /** The generated lines which are sent to clients. */
+ std::vector<std::string> Lines;
- virtual ~ConfigReaderThread()
+public:
+ /** (Re)build the ISUPPORT vector. */
+ void Build();
+
+ /** Returns the std::vector of ISUPPORT lines. */
+ const std::vector<std::string>& GetLines()
{
+ 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_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, 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.
* @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];
-#ifdef WIN32
- IPC* WindowsIPC;
-#endif
-
public:
/** Global cull list, will be processed on next iteration
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:
*/
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 *);
-
- /** Build the ISUPPORT string by triggering all modules On005Numeric events
- */
- void BuildISupport();
+ User* FindUUID(const char *uid);
/** Time this ircd was booted
*/
/** List of the open ports
*/
- std::vector<ListenSocketBase *> ports;
+ std::vector<ListenSocket*> ports;
/** Set to the current signal recieved
*/
*/
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
* @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);
* @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
*/
/** 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);
* @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
* @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
*/
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);
* 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);
- /** 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);
- /** 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
+ /** Parses color codes from string values to actual color codes
+ * @param input The data to process
*/
- void DumpText(User* user, const std::string &LinePrefix, std::stringstream &TextStream);
+ static void ProcessColors(file_cache& input);
- /** 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
+ /** Rehash the local server
*/
- void DumpText(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
+ void RehashServer();
/** Check if the given nickmask matches too many users, send errors to the given user
* @param nick A nickmask to match against
* (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
*/
bool SilentULine(const std::string& server);
- /** Returns the subversion revision ID of this ircd
- * @return The revision ID or an empty string
- */
- std::string GetRevision();
-
/** 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
*/
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,
*/
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);
*/
int Run();
- /** Adds an extban char to the 005 token.
- */
- void AddExtBanChar(char c);
-
char* GetReadBuffer()
{
return this->ReadBuffer;
}
+
+ friend class TestSuite;
};
ENTRYPOINT;
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