X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=a7eed47ff53b1ffcac09a9e4ea7a0f450ebc1df6;hb=6d57bbe05c31c79eaad02fe81cfb9c1ed6b79c58;hp=73cdc930782cc46fb8e8be5f305c427330c0ada9;hpb=be8d8147373c9d934703868aa047a6c66f10cb42;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index 73cdc9307..a7eed47ff 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -2,12 +2,9 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * @@ -17,59 +14,208 @@ #ifndef __INSPIRCD_H__ #define __INSPIRCD_H__ -#include -#include +#define _FILE_OFFSET_BITS 64 +#ifndef _LARGEFILE_SOURCE +#define _LARGEFILE_SOURCE +#endif + +#ifndef WIN32 +#define DllExport +#define CoreExport +#define printf_c printf +#else +#include "inspircd_win32wrapper.h" +/** Windows defines these already */ +#undef DELETE +#undef ERROR +#endif + +#ifdef __GNUC__ +#define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST))) +#else +#define CUSTOM_PRINTF(STRING, FIRST) +#endif + +// Required system headers. +#include +#include +#include +#include +#include +#include +#include + #include +#include +#include +#include +#include +#include +#include +#include + +/** A list of failed port bindings, used for informational purposes on startup */ +typedef std::vector > 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; + #include "inspircd_config.h" +#include "inspircd_version.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" +#include "ctables.h" +#include "command_parse.h" #include "mode.h" -#include "helperfuncs.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 "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 PATH_MAX 4096 +#endif -/** Returned by some functions to indicate failure, - * and the exit code of the program if it terminates. +/** + * Used to define the maximum number of parameters a command may have. + */ +#define MAXPARAMETERS 127 + +/** Returned by some functions to indicate failure. */ #define ERROR -1 -/** Crucial defines +/** Support for librodent - + * see http://www.chatspike.net/index.php?z=64 */ -#define ETIREDGERBILS EAGAIN +#define ETIREDHAMSTERS EAGAIN -/** Debug levels for use with InspIRCd::Log() +/** Template function to convert any input type to std::string */ -enum DebugLevel +template inline std::string ConvNumeric(const T &in) { - DEBUG = 10, - VERBOSE = 20, - DEFAULT = 30, - SPARSE = 40, - NONE = 50, -}; + if (in == 0) return "0"; + char res[MAXBUF]; + char* out = res; + T quotient = in; + while (quotient) { + *out = "0123456789"[ std::abs( (long)quotient % 10 ) ]; + ++out; + quotient /= 10; + } + if (in < 0) + *out++ = '-'; + *out = 0; + std::reverse(res,out); + return res; +} -/** - * This define is used in place of strcmp when we - * want to check if a char* string contains only one - * letter. Pretty fast, its just two compares and an - * addition. +/** Template function to convert any input type to std::string + */ +inline std::string ConvToStr(const int in) +{ + return ConvNumeric(in); +} + +/** Template function to convert any input type to std::string + */ +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 char* in) +{ + return in; +} + +/** Template function to convert any input type to std::string */ -#define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) ) +inline std::string ConvToStr(const bool in) +{ + return (in ? "1" : "0"); +} -/** Delete a pointer, and NULL its value +/** Template function to convert any input type to std::string */ -#define DELETE(x) {if (x) { delete x; x = NULL; }} +inline std::string ConvToStr(char in) +{ + return std::string(in,1); +} /** Template function to convert any input type to std::string */ -template inline std::string ConvToStr(const T &in) +template inline std::string ConvToStr(const T &in) { std::stringstream tmp; if (!(tmp << in)) return std::string(); return tmp.str(); } +/** Template function to convert any input type to any other type + * (usually an integer or numeric type) + */ +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; +} + /** This class contains various STATS counters * It is used by the InspIRCd class, which internally * has an instance of it. @@ -111,163 +257,187 @@ class serverstats : public classbase /** Total bytes of data received */ double statsRecv; - /** Number of bound listening ports + /** Cpu usage at last sample */ - unsigned long BoundPortCount; - + timeval LastCPU; + /** Time last sample was read + */ + timeval LastSampled; /** 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), - BoundPortCount(0) + statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0) { } }; +class InspIRCd; + +DEFINE_HANDLER1(ProcessUserHandler, void, User*); +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 +{ + InspIRCd* ServerInstance; + ServerConfig* Config; + bool done; + public: + std::string TheUserUID; + ConfigReaderThread(InspIRCd* Instance, const std::string &useruid) + : Thread(), ServerInstance(Instance), done(false), TheUserUID(useruid) + { + } -/** The main singleton class of the irc server. + virtual ~ConfigReaderThread() + { + } + + void Run(); + /** Run in the main thread to apply the configuration */ + void Finish(); + bool IsDone() { return done; } +}; + +/** 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!) + * interact with the core system it implements. */ -class InspIRCd : public classbase +class CoreExport InspIRCd : public classbase { private: - /** Holds a string describing the last module error to occur - */ - char MODERR[MAXBUF]; - - /** This is an internal flag used by the mainloop - */ - bool expire_run; - - /** List of server names we've seen. - */ - servernamelist servernames; - - /** Remove a ModuleFactory pointer + /** Holds the current UID. Used to generate the next one. */ - void EraseFactory(int j); - - /** Remove a Module pointer - */ - void EraseModule(int j); - - /** Build the ISUPPORT string by triggering all modules On005Numeric events - */ - void BuildISupport(); - - /** Move a given module to a specific slot in the list - */ - void MoveTo(std::string modulename,int slot); - - /** Display the startup banner - */ - void Start(); + char current_uid[UUID_LENGTH]; /** Set up the signal handlers */ - void SetSignals(bool SEGVHandler); + void SetSignals(); /** Daemonize the ircd and close standard input/output streams + * @return True if the program daemonized succesfully */ bool DaemonSeed(); - /** Build the upper/lowercase comparison table + /** Iterate the list of BufferedSocket objects, removing ones which have timed out + * @param TIME the current time */ - void MakeLowerMap(); + void DoSocketTimeouts(time_t TIME); - /** Moves the given module to the last slot in the list + /** Increments the current UID by one. */ - void MoveToLast(std::string modulename); + void IncrementUID(int pos); - /** Moves the given module to the first slot in the list + /** Perform background user events such as PING checks */ - void MoveToFirst(std::string modulename); + void DoBackgroundUserStuff(); - /** Moves one module to be placed after another in the list + /** Returns true when all modules have done pre-registration checks on a user + * @param user The user to verify + * @return True if all modules have finished checking this user */ - void MoveAfter(std::string modulename, std::string after); + bool AllModulesReportReady(User* user); - /** Moves one module to be placed before another in the list + /** Logfile pathname specified on the commandline, or empty string */ - void MoveBefore(std::string modulename, std::string before); + char LogFileName[MAXBUF]; - /** Process a user whos socket has been flagged as active + /** The current time, updated in the mainloop */ - void ProcessUser(userrec* cu); + time_t TIME; - /** Iterate the list of InspSocket objects, removing ones which have timed out + /** The time that was recorded last time around the mainloop */ - void DoSocketTimeouts(time_t TIME); + time_t OLDTIME; - /** Perform background user events such as PING checks + /** A 64k buffer used to read socket data into + * NOTE: update ValidateNetBufferSize if you change this */ - void DoBackgroundUserStuff(time_t TIME); + char ReadBuffer[65535]; - /** Returns true when all modules have done pre-registration checks on a user - */ - bool AllModulesReportReady(userrec* user); +#ifdef WIN32 + IPC* WindowsIPC; +#endif - /** Total number of modules loaded into the ircd, minus one - */ - int ModCount; + public: - /** Logfile pathname specified on the commandline, or empty string + /** Global cull list, will be processed on next iteration */ - char LogFileName[MAXBUF]; + CullList GlobalCulls; - /** The feature names published by various modules - */ - featurelist Features; + /**** Functors ****/ - /** The current time, updated in the mainloop - */ - time_t TIME; + ProcessUserHandler HandleProcessUser; + IsNickHandler HandleIsNick; + IsIdentHandler HandleIsIdent; + FloodQuitUserHandler HandleFloodQuitUser; + IsChannelHandler HandleIsChannel; + IsSIDHandler HandleIsSID; + RehashHandler HandleRehash; - /** The time that was recorded last time around the mainloop + /** BufferedSocket classes pending deletion after being closed. + * We don't delete these immediately as this may cause a segmentation fault. */ - time_t OLDTIME; + std::map SocketCull; - /** A 64k buffer used to read client lines into + /** 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: + * kludge alert! + * SendMode expects a User* to send the numeric replies + * back to, so we create it a fake user that isnt in the user + * hash and set its descriptor to FD_MAGIC_NUMBER so the data + * falls into the abyss :p */ - char ReadBuffer[65535]; + FakeUser* FakeClient; - /** Number of seconds in a minute + /** Returns the next available UID for this server. */ - const long duration_m; + std::string GetUID(); - /** Number of seconds in an hour + /** Find a user in the UUID hash + * @param nick The nickname to find + * @return A pointer to the user, or NULL if the user does not exist */ - const long duration_h; + User* FindUUID(const std::string &); - /** Number of seconds in a day + /** Find a user in the UUID hash + * @param nick The nickname to find + * @return A pointer to the user, or NULL if the user does not exist */ - const long duration_d; + User* FindUUID(const char *); - /** Number of seconds in a week + /** Build the ISUPPORT string by triggering all modules On005Numeric events */ - const long duration_w; + void BuildISupport(); - /** Number of seconds in a year + /** List of server names we've seen. */ - const long duration_y; + servernamelist servernames; - public: /** Time this ircd was booted */ time_t startup_time; + /** Config file pathname specified on the commandline or via ./configure + */ + char ConfigFileName[MAXBUF]; + /** Mode handler, handles mode setting and removal */ ModeParser* Modes; @@ -280,113 +450,115 @@ class InspIRCd : public classbase */ SocketEngine* SE; - /** Stats class, holds miscellaneous stats counters + /** Thread engine, Handles threading where required */ - serverstats* stats; + ThreadEngine* Threads; - /** Server Config class, holds configuration file data + /** The thread/class used to read config files in REHASH and on startup */ - ServerConfig* Config; + ConfigReaderThread* ConfigThread; - /** Module sockets list, holds the active set of InspSocket classes + /** LogManager handles logging. */ - std::vector module_sockets; + LogManager *Logs; - /** Socket reference table, provides fast lookup of fd to InspSocket* + /** ModuleManager contains everything related to loading/unloading + * modules. */ - InspSocket* socket_ref[MAX_DESCRIPTORS]; + ModuleManager* Modules; - /** user reference table, provides fast lookup of fd to userrec* + /** BanCacheManager is used to speed up checking of restrictions on connection + * to the IRCd. */ - userrec* fd_ref_table[MAX_DESCRIPTORS]; + BanCacheManager *BanCache; - /** Client list, a hash_map containing all clients, local and remote + /** Stats class, holds miscellaneous stats counters */ - user_hash clientlist; + serverstats* stats; - /** Channel list, a hash_map containing all channels + /** Server Config class, holds configuration file data */ - chan_hash chanlist; + ServerConfig* Config; - /** Local client list, a vector containing only local clients + /** Snomask manager - handles routing of snomask messages + * to opers. */ - std::vector local_users; + SnomaskManager* SNO; - /** Oper list, a vector containing all local and remote opered users + /** DNS class, provides resolver facilities to the core and modules */ - std::vector all_opers; + DNS* Res; - /** Whowas container, contains a map of vectors of users tracked by WHOWAS + /** Timer manager class, triggers Timer timer events */ - irc::whowas::whowas_users whowas; + TimerManager* Timers; - /** DNS class, provides resolver facilities to the core and modules + /** X-Line manager. Handles G/K/Q/E line setting, removal and matching */ - DNS* Res; + XLineManager* XLines; - /** Timer manager class, triggers InspTimer timer events + /** User manager. Various methods and data associated with users. */ - TimerManager* Timers; + UserManager *Users; - /** Command list, a hash_map of command names to command_t* + /** Channel list, a hash_map containing all channels XXX move to channel manager class */ - command_table cmdlist; + chan_hash* chanlist; - /** X-Line manager. Handles G/K/Q/E line setting, removal and matching + /** List of the open ports */ - XLineManager* XLines; + std::vector ports; - /** A list of Module* module classes - * Note that this list is always exactly 255 in size. - * The actual number of loaded modules is available from GetModuleCount() + /** Set to the current signal recieved */ - ModuleList modules; + int s_signal; - /** A list of ModuleFactory* module factories - * Note that this list is always exactly 255 in size. - * The actual number of loaded modules is available from GetModuleCount() + /** Protocol interface, overridden by server protocol modules */ - FactoryList factory; + ProtocolInterface* PI; /** 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(); - /** Get the total number of currently loaded modules - */ - int GetModuleCount(); - - /** Find a module by name, and return a Module* to it. - * This is preferred over iterating the module lists yourself. - * @param name The module name to look up + /** 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. */ - Module* FindModule(const std::string &name); + caller1 ProcessUser; /** Bind all ports specified in the configuration file. - * @param bail True if the function should bail back to the shell on failure + * @return The number of ports bound without error */ - int BindPorts(bool bail); - - /** Returns true if this server has the given port bound to the given address - */ - bool HasPort(int port, char* addr); + 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) + * @return True if the port was bound successfully */ - bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr); + 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 userrec by storing only the pointer to the 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); @@ -394,371 +566,392 @@ class InspIRCd : public classbase * If the servername is not that of the local server, the name * is passed to handling modules which will attempt to determine * the GECOS that bleongs to the given servername. + * @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 + /** Find a user in the nick hash. + * If the user cant be found in the nick hash check the uuid hash + * @param nick The nickname to find + * @return A pointer to the user, or NULL if the user does not exist */ - void WriteOpers(const char* text, ...); + User* FindNick(const std::string &nick); - /** Write text to all opers connected to this server - */ - void WriteOpers(const std::string &text); - - /** Find a nickname in the nick hash + /** Find a user in the nick hash. + * If the user cant be found in the nick hash check the uuid hash + * @param nick The nickname to find + * @return A pointer to the user, or NULL if the user does not exist */ - userrec* FindNick(const std::string &nick); + User* FindNick(const char* nick); - /** Find a nickname in the nick hash + /** Find a user in the nick hash ONLY */ - userrec* FindNick(const char* nick); + User* FindNickOnly(const char* nick); - /** Find a channel in the channels hash + /** Find a user in the nick hash ONLY */ - chanrec* FindChan(const std::string &chan); + User* FindNickOnly(const std::string &nick); /** Find a channel in the channels hash + * @param chan The channel to find + * @return A pointer to the channel, or NULL if the channel does not exist */ - chanrec* FindChan(const char* chan); - - /** Called by the constructor to load all modules from the config file. - */ - void LoadAllModules(); + Channel* FindChan(const std::string &chan); - /** Check for a 'die' tag in the config file, and abort if found + /** Find a channel in the channels hash + * @param chan The channel to find + * @return A pointer to the channel, or NULL if the channel does not exist */ - void CheckDie(); + Channel* FindChan(const char* chan); /** Check we aren't running as root, and exit if we are + * @return Depending on the configuration, this function may never return */ void CheckRoot(); /** Determine the right path for, and open, the logfile + * @param argv The argv passed to main() initially, used to calculate program path + * @param argc The argc passed to main() initially, used to calculate program path + * @return True if the log could be opened, false if otherwise */ - void OpenLog(char** argv, int argc); - - /** Convert a user to a pseudoclient, disconnecting the real user - */ - bool UserToPseudo(userrec* user, const std::string &message); - - /** Convert a pseudoclient to a real user, discarding the pseudoclient - */ - bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message); - - /** Send a server notice to all local users - */ - void ServerNoticeAll(char* text, ...); - - /** Send a server message (PRIVMSG) to all local users - */ - void ServerPrivmsgAll(char* text, ...); - - /** Send text to all users with a specific set of modes - */ - void WriteMode(const char* modes, int flags, const char* text, ...); + bool OpenLog(char** argv, int argc); /** 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); - - /** Rehash the local server - */ - static void Rehash(int status); + caller2 IsChannel; - /** Causes the server to exit immediately + /** Return true if str looks like a server ID + * @param string to check against */ - static void Exit(int status); + caller1 IsSID; - /** Return a count of users, unknown and known connections + /** Rehash the local server */ - int UserCount(); + caller1 Rehash; - /** Return a count of fully registered connections only + /** Handles incoming signals after being set + * @param signal the signal recieved */ - int RegisteredUserCount(); + void SignalHandler(int signal); - /** Return a count of invisible (umode +i) users only + /** Sets the signal recieved + * @param signal the signal recieved */ - int InvisibleUserCount(); + static void SetSignal(int signal); - /** Return a count of opered (umode +o) users only + /** Causes the server to exit after unloading modules and + * closing all open file descriptors. + * + * @param The exit code to give to the operating system + * (See the ExitStatus enum for valid values) */ - int OperCount(); + void Exit(int status); - /** Return a count of unregistered (before NICK/USER) users only + /** Causes the server to exit immediately with exit code 0. + * The status code is required for signal handlers, and ignored. */ - int UnregisteredUserCount(); + static void QuickExit(int status); /** 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 - */ - long LocalUserCount(); - /** Send an error notice to all local users, opered and unopered + * @param s The error string to send */ - void SendError(const char *s); - - /** For use with Module::Prioritize(). - * When the return value of this function is returned from - * Module::Prioritize(), this specifies that the module wishes - * to be ordered exactly BEFORE 'modulename'. For more information - * please see Module::Prioritize(). - * @param modulename The module your module wants to be before in the call list - * @returns a priority ID which the core uses to relocate the module in the list - */ - long PriorityBefore(const std::string &modulename); - - /** For use with Module::Prioritize(). - * When the return value of this function is returned from - * Module::Prioritize(), this specifies that the module wishes - * to be ordered exactly AFTER 'modulename'. For more information please - * see Module::Prioritize(). - * @param modulename The module your module wants to be after in the call list - * @returns a priority ID which the core uses to relocate the module in the list - */ - long PriorityAfter(const std::string &modulename); - - /** Publish a 'feature'. - * There are two ways for a module to find another module it depends on. - * Either by name, using InspIRCd::FindModule, or by feature, using this - * function. A feature is an arbitary string which identifies something this - * module can do. For example, if your module provides SSL support, but other - * modules provide SSL support too, all the modules supporting SSL should - * publish an identical 'SSL' feature. This way, any module requiring use - * of SSL functions can just look up the 'SSL' feature using FindFeature, - * then use the module pointer they are given. - * @param FeatureName The case sensitive feature name to make available - * @param Mod a pointer to your module class - * @returns True on success, false if the feature is already published by - * another module. - */ - bool PublishFeature(const std::string &FeatureName, Module* Mod); - - /** Unpublish a 'feature'. - * When your module exits, it must call this method for every feature it - * is providing so that the feature table is cleaned up. - * @param FeatureName the feature to remove - */ - bool UnpublishFeature(const std::string &FeatureName); - - /** Find a 'feature'. - * There are two ways for a module to find another module it depends on. - * Either by name, using InspIRCd::FindModule, or by feature, using the - * InspIRCd::PublishFeature method. A feature is an arbitary string which - * identifies something this module can do. For example, if your module - * provides SSL support, but other modules provide SSL support too, all - * the modules supporting SSL should publish an identical 'SSL' feature. - * To find a module capable of providing the feature you want, simply - * call this method with the feature name you are looking for. - * @param FeatureName The feature name you wish to obtain the module for - * @returns A pointer to a valid module class on success, NULL on failure. - */ - Module* FindFeature(const std::string &FeatureName); - - /** Given a pointer to a Module, return its filename - */ - const std::string& GetModuleName(Module* m); + void SendError(const std::string &s); /** Return true if a nickname is valid + * @param n A nickname to verify + * @return True if the nick is valid */ - bool IsNick(const char* n); + caller2 IsNick; /** Return true if an ident is valid + * @param An ident to verify + * @return True if the ident is valid */ - bool IsIdent(const char* n); - - /** Find a username by their file descriptor. - * It is preferred to use this over directly accessing the fd_ref_table array. - */ - userrec* FindDescriptor(int socket); - - /** Add a new mode to this server's mode parser - */ - bool AddMode(ModeHandler* mh, const unsigned char modechar); - - /** Add a new mode watcher to this server's mode parser - */ - bool AddModeWatcher(ModeWatcher* mw); - - /** Delete a mode watcher from this server's mode parser - */ - bool DelModeWatcher(ModeWatcher* mw); + caller1 IsIdent; /** Add a dns Resolver class to this server's active set - */ - bool AddResolver(Resolver* r); + * @param r The resolver to add + * @param cached If this value is true, then the cache will + * be searched for the DNS result, immediately. If the value is + * false, then a request will be sent to the nameserver, and the + * result will not be immediately available. You should usually + * use the boolean value which you passed to the Resolver + * constructor, which Resolver will set appropriately depending + * on if cached results are available and haven't expired. It is + * however safe to force this value to false, forcing a remote DNS + * lookup, but not an update of the cache. + * @return True if the operation completed successfully. Note that + * if this method returns true, you should not attempt to access + * the resolver class you pass it after this call, as depending upon + * the request given, the object may be deleted! + */ + bool AddResolver(Resolver* r, bool cached); /** Add a command to this server's command parser + * @param f A Command command handler object to add + * @throw ModuleException Will throw ModuleExcption if the command already exists */ - void AddCommand(command_t *f); + void AddCommand(Command *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 user The user to send error messages to + */ + void SendMode(const std::vector& 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. */ - void SendMode(const char **parameters, int pcnt, userrec *user); + 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. - * This operates identically to the global function match(), - * except for that it takes std::string arguments rather than - * const char* ones. + /** 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. */ - bool MatchText(const std::string &sliteral, const std::string &spattern); + 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 */ - bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* 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 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, userrec* user); - - /** Add a gline and apply it - */ - void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); - - /** Add a qline and apply it - */ - void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname); - - /** Add a zline and apply it - */ - void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr); - - /** Add a kline and apply it - */ - void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); - - /** Add an eline - */ - void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); - - /** Delete a gline - */ - bool DelGLine(const std::string &hostmask); - - /** Delete a qline - */ - bool DelQLine(const std::string &nickname); + bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user); - /** Delete a zline + /** 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 DelZLine(const std::string &ipaddr); + bool IsValidMask(const std::string &mask); - /** Delete a kline - */ - bool DelKLine(const std::string &hostmask); - - /** Delete an eline - */ - bool DelELine(const std::string &hostmask); - - /** Return true if the given parameter is a valid nick!user@host mask - */ - bool IsValidMask(const std::string &mask); - - /** Add an InspSocket class to the active set - */ - void AddSocket(InspSocket* sock); - - /** Remove an InspSocket class from the active set at next time around the loop + /** Rehash the local server */ - void RemoveSocket(InspSocket* sock); + void RehashServer(); - /** Delete a socket immediately without waiting for the next iteration of the mainloop + /** 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() */ - void DelSocket(InspSocket* sock); + Channel* GetChannelIndex(long index); - /** Rehash the local server + /** 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 */ - void RehashServer(); + void DumpText(User* user, const std::string &LinePrefix, std::stringstream &TextStream); - /** Return the channel whos index number matches that provided + /** 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 */ - chanrec* GetChannelIndex(long index); + void DumpText(User* user, const std::string &text); - /** Dump text to a user target, splitting it appropriately to fit + /** 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 */ - void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream); + void DumpText(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4); /** Check if the given nickmask matches too many users, send errors to the given user + * @param nick A nickmask to match against + * @param user A user to send error text to + * @return True if the nick matches too many users */ - bool NickMatchesEveryone(const std::string &nick, userrec* user); + bool NickMatchesEveryone(const std::string &nick, User* user); /** Check if the given IP mask matches too many users, send errors to the given user + * @param ip An ipmask to match against + * @param user A user to send error text to + * @return True if the ip matches too many users */ - bool IPMatchesEveryone(const std::string &ip, userrec* user); + bool IPMatchesEveryone(const std::string &ip, User* user); /** Check if the given hostmask matches too many users, send errors to the given user + * @param mask A hostmask to match against + * @param user A user to send error text to + * @return True if the host matches too many users */ - bool HostMatchesEveryone(const std::string &mask, userrec* user); + bool HostMatchesEveryone(const std::string &mask, User* user); /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s + * @param str A string containing a time in the form 1y2w3d4h6m5s + * (one year, two weeks, three days, four hours, six minutes and five seconds) + * @return The total number of seconds */ - long Duration(const char* str); + 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 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 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); + /** 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(); /** Returns the full version string of this ircd + * @return The version string */ std::string GetVersionString(); /** Attempt to write the process id to a given file + * @param filename The PID file to attempt to write to + * @return This function may bail if the file cannot be written */ void WritePID(const std::string &filename); - /** Returns text describing the last module error + /** This constructor initialises all the subsystems and reads the config file. + * @param argc The argument count passed to main() + * @param argv The argument list passed to main() + * @throw If anything is thrown from here and makes it to + * you, you should probably just give up and go home. Yes, really. + * It's that bad. Higher level classes should catch any non-fatal exceptions. */ - char* ModuleError(); + InspIRCd(int argc, char** argv); - /** Load a given module file + /** Send a line of WHOIS data to a user. + * @param user user to send the line to + * @param dest user being WHOISed + * @param numeric Numeric to send + * @param text Text of the numeric */ - bool LoadModule(const char* filename); + void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text); - /** Unload a given module file + /** Send a line of WHOIS data to a user. + * @param user user to send the line to + * @param dest user being WHOISed + * @param numeric Numeric to send + * @param format Format string for the numeric + * @param ... Parameters for the format string */ - bool UnloadModule(const char* filename); + void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6); - /** This constructor initialises all the subsystems and reads the config file. + /** Handle /STATS */ - InspIRCd(int argc, char** argv); + void DoStats(char statschar, User* user, string_list &results); + + /** Handle /WHOIS + */ + void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick); + + /** Quit a user for excess flood, and if they are not + * fully registered yet, temporarily zline their IP. + * @param current user to quit + */ + caller1 FloodQuitUser; - /** Do one iteration of the mainloop + /** Restart the server. + * This function will not return. If an error occurs, + * it will throw an instance of CoreException. + * @param reason The restart reason to show to all clients + * @throw CoreException An instance of CoreException indicating the error from execv(). */ - void DoOneIteration(bool process_module_sockets); + void Restart(const std::string &reason); - /** Output a log message to the ircd.log file + /** Prepare the ircd for restart or shutdown. + * This function unloads all modules which can be unloaded, + * closes all open sockets, and closes the logfile. */ - void Log(int level, const char* text, ...); + void Cleanup(); - /** Output a log message to the ircd.log file + /** 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 Log(int level, const std::string &text); + 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); /** Begin execution of the server. * NOTE: this function NEVER returns. Internally, - * after performing some initialisation routines, - * it will repeatedly call DoOneIteration in a loop. + * it will repeatedly loop. + * @return The return value for this function is undefined. */ 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); + + char* GetReadBuffer() + { + return this->ReadBuffer; + } }; -#endif +ENTRYPOINT; +template +class CommandModule : public Module +{ + Cmd cmd; + public: + CommandModule(InspIRCd* me) : Module(me), cmd(me, this) + { + me->AddCommand(&cmd); + } + + Version GetVersion() + { + return Version(cmd.command, VF_VENDOR); + } +}; + +#endif