X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=ee1a5120a4b1461e67c6b7e8100484a149906619;hb=4840d5e77572f42b710501912d59b5dbb6d2c2af;hp=bc8055f679eb78bb76dd2a1ecfc253e1da6669d0;hpb=7d241d39ff055fdb52ce8dc1db0058e7e9a92eb4;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index bc8055f67..ee1a5120a 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -28,6 +28,7 @@ #include #include #include +#include #include "inspircd_config.h" #include "uid.h" #include "users.h" @@ -76,7 +77,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); @@ -97,13 +98,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) @@ -230,11 +224,11 @@ typedef std::map clonemap; class InspIRCd; -DEFINE_HANDLER1(ProcessUserHandler, void, userrec*); +DEFINE_HANDLER1(ProcessUserHandler, void, User*); DEFINE_HANDLER1(IsNickHandler, bool, const char*); DEFINE_HANDLER1(IsIdentHandler, bool, const char*); -DEFINE_HANDLER1(FindDescriptorHandler, userrec*, int); -DEFINE_HANDLER1(FloodQuitUserHandler, void, userrec*); +DEFINE_HANDLER1(FindDescriptorHandler, User*, int); +DEFINE_HANDLER1(FloodQuitUserHandler, void, User*); /* Forward declaration - required */ class XLineManager; @@ -259,26 +253,6 @@ class CoreExport InspIRCd : public classbase */ char current_uid[UUID_LENGTH]; - /** Holds a string describing the last module error to occur - */ - char MODERR[MAXBUF]; - - /** Remove a ModuleFactory pointer - * @param j Index number of the ModuleFactory to remove - */ - void EraseFactory(int j); - - /** Remove a Module pointer - * @param j Index number of the Module to remove - */ - void EraseModule(int j); - - /** Move a given module to a specific slot in the list - * @param modulename The module name to relocate - * @param slot The slot to move the module into - */ - void MoveTo(std::string modulename,int slot); - /** Set up the signal handlers */ void SetSignals(); @@ -288,60 +262,29 @@ class CoreExport InspIRCd : public classbase */ bool DaemonSeed(); - /** Moves the given module to the last slot in the list - * @param modulename The module name to relocate - */ - void MoveToLast(std::string modulename); - - /** Moves the given module to the first slot in the list - * @param modulename The module name to relocate - */ - void MoveToFirst(std::string modulename); - - /** Moves one module to be placed after another in the list - * @param modulename The module name to relocate - * @param after The module name to place the module after - */ - void MoveAfter(std::string modulename, std::string after); - - /** Moves one module to be placed before another in the list - * @param modulename The module name to relocate - * @param after The module name to place the module before - */ - void MoveBefore(std::string modulename, std::string before); - - /** Iterate the list of InspSocket objects, removing ones which have timed out + /** Iterate the list of BufferedSocket objects, removing ones which have timed out * @param TIME the current time */ void DoSocketTimeouts(time_t TIME); + /** Sets up UID subsystem + */ + void InitialiseUID(); + /** Perform background user events such as PING checks - * @param TIME the current time */ - void DoBackgroundUserStuff(time_t TIME); + void DoBackgroundUserStuff(); /** 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 */ - bool AllModulesReportReady(userrec* user); - - /** Total number of modules loaded into the ircd, minus one - */ - int ModCount; + bool AllModulesReportReady(User* user); /** Logfile pathname specified on the commandline, or empty string */ char LogFileName[MAXBUF]; - /** The feature names published by various modules - */ - featurelist Features; - - /** The interface names published by various modules - */ - interfacelist Interfaces; - /** The current time, updated in the mainloop */ time_t TIME; @@ -381,7 +324,6 @@ class CoreExport InspIRCd : public classbase */ CullList GlobalCulls; - /**** Functors ****/ ProcessUserHandler HandleProcessUser; @@ -390,20 +332,20 @@ class CoreExport InspIRCd : public classbase FindDescriptorHandler HandleFindDescriptor; FloodQuitUserHandler HandleFloodQuitUser; - /** InspSocket classes pending deletion after being closed. + /** BufferedSocket classes pending deletion after being closed. * We don't delete these immediately as this may cause a segmentation fault. */ - std::map SocketCull; + std::map SocketCull; /** 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 userrec* to send the numeric replies + * 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 */ - userrec *FakeClient; + User *FakeClient; /** Returns the next available UID for this server. */ @@ -413,13 +355,13 @@ class CoreExport InspIRCd : public classbase * @param nick The nickname to find * @return A pointer to the user, or NULL if the user does not exist */ - userrec *FindUUID(const std::string &); + User *FindUUID(const std::string &); /** 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 */ - userrec *FindUUID(const char *); + User *FindUUID(const char *); /** Build the ISUPPORT string by triggering all modules On005Numeric events */ @@ -453,6 +395,11 @@ class CoreExport InspIRCd : public classbase /** Socket engine, handles socket activity events */ SocketEngine* SE; + + /** ModuleManager contains everything related to loading/unloading + * modules. + */ + ModuleManager* Modules; /** Stats class, holds miscellaneous stats counters */ @@ -472,7 +419,7 @@ class CoreExport InspIRCd : public classbase user_hash* clientlist; /** Client list stored by UUID. Contains all clients, and is updated - * automatically by the constructor and destructor of userrec. + * automatically by the constructor and destructor of User. */ user_hash* uuidlist; @@ -482,11 +429,11 @@ class CoreExport InspIRCd : public classbase /** Local client list, a vector containing only local clients */ - std::vector local_users; + std::vector local_users; /** Oper list, a vector containing all local and remote opered users */ - std::vector all_opers; + std::list all_opers; /** Map of local ip addresses for clone counting */ @@ -500,7 +447,7 @@ class CoreExport InspIRCd : public classbase */ DNS* Res; - /** Timer manager class, triggers InspTimer timer events + /** Timer manager class, triggers Timer timer events */ TimerManager* Timers; @@ -508,22 +455,6 @@ class CoreExport InspIRCd : public classbase */ XLineManager* XLines; - /** 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() - */ - ModuleList modules; - - /** 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() - */ - FactoryList factory; - - /** The time we next call our ping timeout and reg timeout checks - */ - time_t next_call; - /** Set to the current signal recieved */ int s_signal; @@ -547,13 +478,13 @@ class CoreExport InspIRCd : public classbase /** Add a user to the local clone map * @param user The user to add */ - void AddLocalClone(userrec* user); + void AddLocalClone(User* user); /** Add a user to the global clone map * @param user The user to add */ - void AddGlobalClone(userrec* user); - + void AddGlobalClone(User* user); + /** Number of users with a certain mode set on them */ int ModeCount(const char mode); @@ -568,19 +499,7 @@ class CoreExport InspIRCd : public classbase * @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; - - /** Get the total number of currently loaded modules - * @return The number of 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 - * @return A pointer to the module, or NULL if the module cannot be found - */ - 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 @@ -603,7 +522,7 @@ class CoreExport InspIRCd : public classbase 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 */ @@ -640,38 +559,34 @@ class CoreExport InspIRCd : public classbase * @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 std::string &nick); /** 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 char* nick); + User* FindNick(const char* nick); /** Find a user in the nick hash ONLY */ - userrec* FindNickOnly(const char* nick); + User* FindNickOnly(const char* nick); /** Find a user in the nick hash ONLY */ - userrec* FindNickOnly(const std::string &nick); + 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 std::string &chan); + Channel* FindChan(const std::string &chan); /** 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 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 @@ -759,11 +674,6 @@ class CoreExport InspIRCd : public classbase */ int RegisteredUserCount(); - /** Return a count of invisible (umode +i) users only - * @return The number of invisible users - */ - int InvisibleUserCount(); - /** Return a count of opered (umode +o) users only * @return The number of opers */ @@ -789,129 +699,6 @@ class CoreExport InspIRCd : public classbase */ void SendError(const std::string &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); - - /** Publish a module to an 'interface'. - * Modules which implement the same interface (the same way of communicating - * with other modules) can publish themselves to an interface, using this - * method. When they do so, they become part of a list of related or - * compatible modules, and a third module may then query for that list - * and know that all modules within that list offer the same API. - * A prime example of this is the hashing modules, which all accept the - * same types of Request class. Consider this to be similar to PublishFeature, - * except for that multiple modules may publish the same 'feature'. - * @param InterfaceName The case sensitive interface name to make available - * @param Mod a pointer to your module class - * @returns True on success, false on failure (there are currently no failure - * cases) - */ - bool PublishInterface(const std::string &InterfaceName, Module* Mod); - - /** Return a pair saying how many other modules are currently using the - * interfaces provided by module m. - * @param m The module to count usage for - * @return A pair, where the first value is the number of uses of the interface, - * and the second value is the interface name being used. - */ - std::pair GetInterfaceInstanceCount(Module* m); - - /** Mark your module as using an interface. - * If you mark your module as using an interface, then that interface - * module may not unload until your module has unloaded first. - * This can be used to prevent crashes by ensuring code you depend on - * is always in memory while your module is active. - * @param InterfaceName The interface to use - */ - void UseInterface(const std::string &InterfaceName); - - /** Mark your module as finished with an interface. - * If you used UseInterface() above, you should use this method when - * your module is finished with the interface (usually in its destructor) - * to allow the modules which implement the given interface to be unloaded. - * @param InterfaceName The interface you are finished with using. - */ - void DoneWithInterface(const std::string &InterfaceName); - - /** 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); - - /** Unpublish your module from an interface - * When your module exits, it must call this method for every interface - * it is part of so that the interfaces table is cleaned up. Only when - * the last item is deleted from an interface does the interface get - * removed. - * @param InterfaceName the interface to be removed from - * @param Mod The module to remove from the interface list - */ - bool UnpublishInterface(const std::string &InterfaceName, Module* Mod); - - /** 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); - - /** Find an 'interface'. - * An interface is a list of modules which all implement the same API. - * @param InterfaceName The Interface you wish to obtain the module - * list of. - * @return A pointer to a deque of Module*, or NULL if the interface - * does not exist. - */ - modulelist* FindInterface(const std::string &InterfaceName); - - /** Given a pointer to a Module, return its filename - * @param m The module pointer to identify - * @return The module name or an empty string - */ - const std::string& GetModuleName(Module* m); - /** Return true if a nickname is valid * @param n A nickname to verify * @return True if the nick is valid @@ -929,14 +716,13 @@ class CoreExport InspIRCd : public classbase * @param socket The file descriptor of a user * @return A pointer to the user if the user exists locally on this descriptor */ - caller1 FindDescriptor; + 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); + bool AddMode(ModeHandler* mh); /** Add a new mode watcher to this server's mode parser * @param mw The modewatcher to add @@ -969,10 +755,10 @@ class CoreExport InspIRCd : public classbase bool AddResolver(Resolver* r, bool cached); /** Add a command to this server's command parser - * @param f A command_t command handler object to add + * @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 @@ -981,7 +767,7 @@ class CoreExport InspIRCd : public classbase * @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, userrec *user); + void SendMode(const char **parameters, int pcnt, User *user); /** Match two strings using pattern matching. * This operates identically to the global function match(), @@ -999,7 +785,7 @@ class CoreExport InspIRCd : public classbase * @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, userrec* user); + CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, 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 @@ -1007,77 +793,7 @@ class CoreExport InspIRCd : public classbase * @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 - * @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); + 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 @@ -1093,35 +809,35 @@ class CoreExport InspIRCd : public classbase * @param The index number of the channel to fetch * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount() */ - chanrec* GetChannelIndex(long index); + Channel* GetChannelIndex(long index); /** 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 DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream); + void DumpText(User* User, const std::string &LinePrefix, stringstream &TextStream); /** 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 @@ -1168,23 +884,6 @@ class CoreExport InspIRCd : public classbase */ void WritePID(const std::string &filename); - /** Returns text describing the last module error - * @return The last error message to occur - */ - char* ModuleError(); - - /** Load a given module file - * @param filename The file to load - * @return True if the module was found and loaded - */ - bool LoadModule(const char* filename); - - /** Unload a given module file - * @param filename The file to unload - * @return True if the module was unloaded - */ - bool UnloadModule(const char* filename); - /** 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() @@ -1194,12 +893,6 @@ class CoreExport InspIRCd : public classbase */ InspIRCd(int argc, char** argv); - /** Do one iteration of the mainloop - * @param process_module_sockets True if module sockets are to be processed - * this time around the event loop. The is the default. - */ - void DoOneIteration(bool process_module_sockets = true); - /** 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 @@ -1223,7 +916,7 @@ class CoreExport InspIRCd : public classbase * @param numeric Numeric to send * @param text Text of the numeric */ - void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text); + void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text); /** Send a line of WHOIS data to a user. * @param user user to send the line to @@ -1232,13 +925,13 @@ class CoreExport InspIRCd : public classbase * @param format Format string for the numeric * @param ... Parameters for the format string */ - void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...); + void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...); /** 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; + caller1 FloodQuitUser; /** Restart the server. * This function will not return. If an error occurs, @@ -1271,16 +964,15 @@ class CoreExport InspIRCd : public classbase /** 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 InspSockets to be removed which are due to + /** Force all BufferedSockets to be removed which are due to * be culled. */ - void InspSocketCull(); + void BufferedSocketCull(); char* GetReadBuffer() { @@ -1289,4 +981,3 @@ class CoreExport InspIRCd : public classbase }; #endif -