X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=e2eaf82927171fd7b8cec3bb9bc23cb3987caa7b;hb=e6601069038c35c546fd3f3dce95024b0d13f1b4;hp=eef05116b9fe3eb2738398ac2aa979329a52a333;hpb=8691870bf726a898b11cc4173e42db5b6f597cf3;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index eef05116b..e2eaf8292 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -1,46 +1,108 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2008 Pippijn van Steenhoven + * Copyright (C) 2003-2008 Craig Edwards + * Copyright (C) 2006-2007 Oliver Lupton + * Copyright (C) 2007 Dennis Friis + * 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 . */ -#ifndef __INSPIRCD_H__ -#define __INSPIRCD_H__ -#ifndef WIN32 -#define DllExport -#define CoreExport -#define printf_c printf +#ifndef INSPIRCD_H +#define INSPIRCD_H + +#define _FILE_OFFSET_BITS 64 +#ifndef _LARGEFILE_SOURCE +#define _LARGEFILE_SOURCE +#endif + +#ifndef _WIN32 +#define DllExport +#define CoreExport #else #include "inspircd_win32wrapper.h" /** Windows defines these already */ -#undef DELETE #undef ERROR #endif -#include -#include +#ifdef __GNUC__ +#define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST))) +#else +#define CUSTOM_PRINTF(STRING, FIRST) +#endif + +// Required system headers. +#include +#include +#include +#include +#include +#include +#include +#include +#ifndef _WIN32 +#include +#endif + #include +#include +#include #include +#include +#include +#include +#include +#include #include "inspircd_config.h" +#include "inspircd_version.h" +#include "typedefs.h" +#include "consolecolors.h" + +CoreExport extern InspIRCd* ServerInstance; + +#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 "logger.h" +#include "usermanager.h" #include "socket.h" +#include "ctables.h" +#include "command_parse.h" #include "mode.h" #include "socketengine.h" -#include "command_parse.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" + +#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. @@ -56,14 +118,6 @@ */ #define ETIREDHAMSTERS EAGAIN -/** Delete a pointer, and NULL its value - */ -template inline void DELETE(T* x) -{ - delete x; - x = NULL; -} - /** Template function to convert any input type to std::string */ template inline std::string ConvNumeric(const T &in) @@ -77,7 +131,7 @@ template inline std::string ConvNumeric(const T &in) ++out; quotient /= 10; } - if ( in < 0) + if (in < 0) *out++ = '-'; *out = 0; std::reverse(res,out); @@ -98,13 +152,6 @@ inline std::string ConvToStr(const long in) return ConvNumeric(in); } -/** Template function to convert any input type to std::string - */ -inline std::string ConvToStr(const unsigned long in) -{ - return ConvNumeric(in); -} - /** Template function to convert any input type to std::string */ inline std::string ConvToStr(const char* in) @@ -123,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 @@ -142,36 +189,14 @@ template 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 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 @@ -204,56 +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) { } }; -/** A list of failed port bindings, used for informational purposes on startup */ -typedef std::vector > FailedPortList; - -/** A list of ip addresses cross referenced against clone counts */ -typedef std::map clonemap; - -class InspIRCd; - -DEFINE_HANDLER1(ProcessUserHandler, void, User*); -DEFINE_HANDLER1(IsNickHandler, bool, const char*); +DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t); +DEFINE_HANDLER2(GenRandomHandler, void, 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&); +DEFINE_HANDLER1(RehashHandler, void, const std::string&); +DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&); -/* Forward declaration - required */ -class XLineManager; +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. 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!) + * 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. @@ -274,9 +298,9 @@ class CoreExport InspIRCd : public classbase */ void DoSocketTimeouts(time_t TIME); - /** Sets up UID subsystem + /** Increments the current UID by one. */ - void InitialiseUID(); + void IncrementUID(int pos); /** Perform background user events such as PING checks */ @@ -286,63 +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 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 - */ - insp_sockaddr client, server; - - /** Used when connecting clients - */ - socklen_t length; - - /** Nonblocking file writer - */ - FileLogger* Logger; - - /** Time offset in seconds - * This offset is added to all calls to Time(). Use SetTimeDelta() to update - */ - int time_delta; - -#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; - FindDescriptorHandler HandleFindDescriptor; FloodQuitUserHandler HandleFloodQuitUser; - - /** BufferedSocket classes pending deletion after being closed. - * We don't delete these immediately as this may cause a segmentation fault. - */ - std::map SocketCull; + 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: @@ -352,44 +348,39 @@ 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. */ 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(); - /** Number of unregistered users online right now. - * (Unregistered means before USER/NICK/dns) - */ - int unregistered_count; - - /** 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 */ @@ -402,12 +393,29 @@ class CoreExport InspIRCd : public classbase /** Socket engine, handles socket activity events */ SocketEngine* SE; - + + /** Thread engine, Handles threading where required + */ + ThreadEngine* Threads; + + /** The thread/class used to read config files in REHASH and on startup + */ + ConfigReaderThread* ConfigThread; + + /** LogManager handles logging. + */ + LogManager *Logs; + /** ModuleManager contains everything related to loading/unloading * modules. */ ModuleManager* Modules; + /** BanCacheManager is used to speed up checking of restrictions on connection + * to the IRCd. + */ + BanCacheManager *BanCache; + /** Stats class, holds miscellaneous stats counters */ serverstats* stats; @@ -421,125 +429,84 @@ class CoreExport InspIRCd : public classbase */ SnomaskManager* SNO; - /** Client list, a hash_map containing all clients, local and remote - */ - user_hash* clientlist; - - /** Client list stored by UUID. Contains all clients, and is updated - * automatically by the constructor and destructor of User. + /** DNS class, provides resolver facilities to the core and modules */ - user_hash* uuidlist; + DNS* Res; - /** Channel list, a hash_map containing all channels + /** Timer manager class, triggers Timer timer events */ - chan_hash* chanlist; + TimerManager* Timers; - /** Local client list, a vector containing only local clients + /** X-Line manager. Handles G/K/Q/E line setting, removal and matching */ - std::vector local_users; + XLineManager* XLines; - /** Oper list, a vector containing all local and remote opered users + /** User manager. Various methods and data associated with users. */ - std::list all_opers; + UserManager *Users; - /** Map of local ip addresses for clone counting + /** Channel list, a hash_map containing all channels XXX move to channel manager class */ - clonemap local_clones; + chan_hash* chanlist; - /** Map of global ip addresses for clone counting + /** List of the open ports */ - clonemap global_clones; + std::vector ports; - /** DNS class, provides resolver facilities to the core and modules + /** Set to the current signal recieved */ - DNS* Res; + static sig_atomic_t s_signal; - /** Timer manager class, triggers Timer timer events + /** Protocol interface, overridden by server protocol modules */ - TimerManager* Timers; + ProtocolInterface* PI; - /** X-Line manager. Handles G/K/Q/E line setting, removal and matching + /** Holds extensible for user nickforced */ - XLineManager* XLines; + LocalIntExt NICKForced; - /** Set to the current signal recieved + /** Holds extensible for user operquit */ - int s_signal; + 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. - * @param delta True to use the delta as an offset, false otherwise * @return The current time as an epoch value (time_t) */ - time_t Time(bool delta = false); - - /** Set the time offset in seconds - * This offset is added to Time() to offset the system time by the specified - * number of seconds. - * @param delta The number of seconds to offset - * @return The old time delta - */ - int SetTimeDelta(int delta); - - /** Add a user to the local clone map - * @param user The user to add - */ - void AddLocalClone(User* user); + 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(); - /** Add a user to the global clone map - * @param user The user to add + /** 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) */ - void AddGlobalClone(User* user); - - /** Number of users with a certain mode set on them + std::string GenRandomStr(int length, bool printable = true); + /** Generate a random integer. + * This is generally more secure than rand() */ - int ModeCount(const char mode); + unsigned long GenRandomInt(unsigned long max); - /** Get the time offset in seconds - * @return The current time delta (in seconds) - */ - int GetTimeDelta(); - - /** 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 ProcessUser; + /** Fill a buffer with random bits */ + caller2 GenRandom; /** 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 * @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, 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); + bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true); /** Gets the GECOS (description) field of the given server. * If the servername is not that of the local server, the name @@ -548,18 +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); - - /** Write text to all opers connected to this server - * @param text The text format string - * @param ... Format args - */ - void WriteOpers(const char* text, ...); - - /** Write text to all opers connected to this server - * @param text The text to send - */ - void WriteOpers(const std::string &text); + 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 @@ -595,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 */ @@ -612,48 +563,27 @@ class CoreExport InspIRCd : public classbase */ bool OpenLog(char** argv, int argc); - /** Close the currently open log file - */ - void CloseLog(); - - /** Send a server notice to all local users - * @param text The text format string to send - * @param ... The format arguments - */ - void ServerNoticeAll(char* text, ...); - - /** Send a server message (PRIVMSG) to all local users - * @param text The text format string to send - * @param ... The format arguments - */ - void ServerPrivmsgAll(char* text, ...); - - /** Send text to all users with a specific set of modes - * @param modes The modes to check against, without a +, e.g. 'og' - * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the - * mode characters in the first parameter causes receipt of the message, and - * if you specify WM_OR, all the modes must be present. - * @param text The text format string to send - * @param ... The format arguments - */ - void WriteMode(const char* modes, int flags, const char* text, ...); - /** Return true if a channel name is valid * @param chname A channel name to verify * @return True if the name is valid */ - bool IsChannel(const char *chname); + caller2 IsChannel; + + /** Return true if str looks like a server ID + * @param string to check against + */ + caller1 IsSID; /** Rehash the local server */ - void Rehash(); + caller1 Rehash; /** Handles incoming signals after being set * @param signal the signal recieved */ void SignalHandler(int signal); - /** Sets the signal recieved + /** Sets the signal recieved * @param signal the signal recieved */ static void SetSignal(int signal); @@ -661,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); @@ -671,36 +601,11 @@ class CoreExport InspIRCd : public classbase */ static void QuickExit(int status); - /** Return a count of users, unknown and known connections - * @return The number of users - */ - int UserCount(); - - /** Return a count of fully registered connections only - * @return The number of registered users - */ - int RegisteredUserCount(); - - /** Return a count of opered (umode +o) users only - * @return The number of opers - */ - int OperCount(); - - /** Return a count of unregistered (before NICK/USER) users only - * @return The number of unregistered (unknown) connections - */ - int UnregisteredUserCount(); - /** Return a count of channels on the network * @return The number of channels */ long ChannelCount(); - /** Return a count of local users on this server only - * @return The number of local users - */ - long LocalUserCount(); - /** Send an error notice to all local users, opered and unopered * @param s The error string to send */ @@ -710,7 +615,7 @@ class CoreExport InspIRCd : public classbase * @param n A nickname to verify * @return True if the nick is valid */ - caller1 IsNick; + caller2 IsNick; /** Return true if an ident is valid * @param An ident to verify @@ -718,32 +623,6 @@ class CoreExport InspIRCd : public classbase */ caller1 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 FindDescriptor; - - /** Add a new mode to this server's mode parser - * @param mh The modehandler to add - * @param modechar The mode character this modehandler handles - * @return True if the mode handler was added - */ - bool AddMode(ModeHandler* mh, const unsigned char modechar); - - /** Add a new mode watcher to this server's mode parser - * @param mw The modewatcher to add - * @return True if the modewatcher was added - */ - bool AddModeWatcher(ModeWatcher* mw); - - /** Delete a mode watcher from this server's mode parser - * @param mw The modewatcher to delete - * @return True if the modewatcher was deleted - */ - bool DelModeWatcher(ModeWatcher* mw); - /** 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 @@ -766,135 +645,81 @@ 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 * 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 char **parameters, int pcnt, User *user); + void SendMode(const std::vector& 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& 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. + * @param map The character map to use when matching. */ - bool MatchText(const std::string &sliteral, const std::string &spattern); + 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. + * @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 char** parameters, int pcnt, User* user); + CmdResult CallCommandHandler(const std::string &commandname, const std::vector& 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 */ bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user); - /** Add a gline and apply it - * @param duration How long the line should last - * @param source Who set the line - * @param reason The reason for the line - * @param hostmask The hostmask to set the line against - */ - void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); - - /** Add a qline and apply it - * @param duration How long the line should last - * @param source Who set the line - * @param reason The reason for the line - * @param nickname The nickmask to set the line against - */ - void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname); - - /** Add a zline and apply it - * @param duration How long the line should last - * @param source Who set the line - * @param reason The reason for the line - * @param ipaddr The ip-mask to set the line against - */ - void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr); - - /** Add a kline and apply it - * @param duration How long the line should last - * @param source Who set the line - * @param reason The reason for the line - * @param hostmask The hostmask to set the line against - */ - void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); - - /** Add an eline - * @param duration How long the line should last - * @param source Who set the line - * @param reason The reason for the line - * @param hostmask The hostmask to set the line against - */ - void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); - - /** Delete a gline - * @param hostmask The gline to delete - * @return True if the item was removed - */ - bool DelGLine(const std::string &hostmask); - - /** Delete a qline - * @param nickname The qline to delete - * @return True if the item was removed - */ - bool DelQLine(const std::string &nickname); - - /** Delete a zline - * @param ipaddr The zline to delete - * @return True if the item was removed - */ - bool DelZLine(const std::string &ipaddr); - - /** Delete a kline - * @param hostmask The kline to delete - * @return True if the item was removed - */ - bool DelKLine(const std::string &hostmask); - - /** Delete an eline - * @param hostmask The kline to delete - * @return True if the item was removed - */ - bool DelELine(const std::string &hostmask); - /** 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); - /** 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, 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 @@ -924,37 +749,33 @@ class CoreExport InspIRCd : public classbase */ long Duration(const std::string &str); - /** Attempt to compare an oper password to a string from the config file. + /** Attempt to compare a password to a string from the config file. * This will be passed to handling modules which will compare the data * against possible hashed equivalents in the input string. + * @param ex The object (user, server, whatever) causing the comparison. * @param data The data from the config file * @param input The data input by the oper - * @param tagnum the tag number of the oper's tag in the config file + * @param hashtype The hash from the config file * @return 0 if the strings match, 1 or -1 if they do not */ - int OperPassCompare(const char* data,const char* input, int tagnum); + int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype); /** Check if a given server is a uline. * An empty string returns true, this is by design. * @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 @@ -971,23 +792,6 @@ class CoreExport InspIRCd : public classbase */ InspIRCd(int argc, char** argv); - /** Output a log message to the ircd.log file - * The text will only be output if the current loglevel - * is less than or equal to the level you provide - * @param level A log level from the DebugLevel enum - * @param text Format string of to write to the log - * @param ... Format arguments of text to write to the log - */ - void Log(int level, const char* text, ...); - - /** Output a log message to the ircd.log file - * The text will only be output if the current loglevel - * is less than or equal to the level you provide - * @param level A log level from the DebugLevel enum - * @param text Text to write to the log - */ - void Log(int level, const std::string &text); - /** Send a line of WHOIS data to a user. * @param user user to send the line to * @param dest user being WHOISed @@ -1003,7 +807,11 @@ class CoreExport InspIRCd : public classbase * @param format Format string for the numeric * @param ... Parameters for the format string */ - void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...); + 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. @@ -1011,6 +819,13 @@ class CoreExport InspIRCd : public classbase */ caller1 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 OnCheckExemption; + /** Restart the server. * This function will not return. If an error occurs, * it will throw an instance of CoreException. @@ -1047,15 +862,38 @@ 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() { return this->ReadBuffer; } + + friend class TestSuite; +}; + +ENTRYPOINT; + +template +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