X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmodules.h;h=caea6e4210ebd6f909c91da9f39e8a9923f80d29;hb=38c9d65253a67dbe13c77792027a9db601735813;hp=d0195bd1b87166d4dada1b360670bddc1fdb4e64;hpb=05e460e96cdd03f94587c0e0c5792c75d3dfa440;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/modules.h b/include/modules.h index d0195bd1b..caea6e421 100644 --- a/include/modules.h +++ b/include/modules.h @@ -1,34 +1,70 @@ -/* - - - -*/ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #ifndef __PLUGIN_H #define __PLUGIN_H +// log levels + #define DEBUG 10 #define VERBOSE 20 #define DEFAULT 30 #define SPARSE 40 #define NONE 50 +// used with OnExtendedMode() method of modules + #define MT_CHANNEL 1 #define MT_CLIENT 2 #define MT_SERVER 3 +// used with OnAccessCheck() method of modules + +#define ACR_DEFAULT 0 // Do default action (act as if the module isnt even loaded) +#define ACR_DENY 1 // deny the action +#define ACR_ALLOW 2 // allow the action + +#define AC_KICK 0 // a user is being kicked +#define AC_DEOP 1 // a user is being deopped +#define AC_OP 2 // a user is being opped +#define AC_VOICE 3 // a user is being voiced +#define AC_DEVOICE 4 // a user is being devoiced +#define AC_HALFOP 5 // a user is being halfopped +#define AC_DEHALFOP 6 // a user is being dehalfopped +#define AC_INVITE 7 // a user is being invited +#define AC_GENERAL_MODE 8 // a user channel mode is being changed + #include "dynamic.h" #include "base.h" #include "ctables.h" #include #include +#include /** Low level definition of a FileReader classes file cache area */ typedef std::deque file_cache; typedef file_cache string_list; +/** Holds a list of users in a channel + */ +typedef std::deque chanuserlist; + + // This #define allows us to call a method in all // loaded modules in a readable simple way, e.g.: // 'FOREACH_MOD OnConnect(user);' @@ -44,12 +80,12 @@ typedef file_cache string_list; #define FOREACH_RESULT(x) { MOD_RESULT = 0; \ for (int i = 0; i <= MODCOUNT; i++) { \ int res = modules[i]->x ; \ - if (res) { \ + if (res != 0) { \ MOD_RESULT = res; \ break; \ } \ } \ - } + } // ********************************************************************************************* @@ -157,9 +193,11 @@ class Module : public classbase * This method is the lowest level of handler available to a module. It will be called with raw * data which is passing through a connected socket. If you wish, you may munge this data by changing * the string parameter "raw". If you do this, after your function exits it will immediately be - * cut down to 510 characters plus a carriage return and linefeed. + * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where + * inbound is set to true) the value of user will be the userrec of the connection sending the + * data. This is not possible for outbound data because the data may be being routed to multiple targets. */ - virtual void OnServerRaw(std::string &raw, bool inbound); + virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user); /** Called whenever an extended mode is to be processed. * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being @@ -170,12 +208,13 @@ class Module : public classbase * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. * You must cast this value yourself to make use of it. */ - virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms); + virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms); /** Called whenever a user is about to join a channel, before any processing is done. - * Returning any nonzero value from this function stops the process immediately, causing no + * Returning a value of 1 from this function stops the process immediately, causing no * output to be sent to the user by the core. If you do this you must produce your own numerics, - * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. + * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from + * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc. * * IMPORTANT NOTE! * @@ -199,7 +238,7 @@ class Module : public classbase * It is purposefully not possible to modify any info that has already been output, or halt the list. * You must write a 371 numeric to the user, containing your info in the following format: * - * :information here + * <nick> :information here */ virtual void OnInfo(userrec* user); @@ -207,7 +246,14 @@ class Module : public classbase * The source parameter contains the details of the user who issued the WHOIS command, and * the dest parameter contains the information of the user they are whoising. */ - virtual void Module::OnWhois(userrec* source, userrec* dest); + virtual void OnWhois(userrec* source, userrec* dest); + + /** Called whenever a user is about to invite another user into a channel, before any processing is done. + * Returning 1 from this function stops the process immediately, causing no + * output to be sent to the user by the core. If you do this you must produce your own numerics, + * notices etc. This is useful for modules which may want to filter invites to channels. + */ + virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel); /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. * Returning any nonzero value from this function stops the process immediately, causing no @@ -217,7 +263,7 @@ class Module : public classbase * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details * of where the message is destined to be sent. */ - virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::String text); + virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text); /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done. * Returning any nonzero value from this function stops the process immediately, causing no @@ -227,7 +273,53 @@ class Module : public classbase * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details * of where the message is destined to be sent. */ - virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::String text); + virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text); + + /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc. + * Please note that although you can see remote nickchanges through this function, you should + * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. + * check user->server before taking any action (including returning nonzero from the method). + * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your + * module to generate some meaninful output. + */ + virtual int OnUserPreNick(userrec* user, std::string newnick); + + /** Called before an action which requires a channel privilage check. + * This function is called before many functions which check a users status on a channel, for example + * before opping a user, deopping a user, kicking a user, etc. + * There are several values for access_type which indicate for what reason access is being checked. + * These are:

+ * AC_KICK (0) - A user is being kicked
+ * AC_DEOP (1) - a user is being deopped
+ * AC_OP (2) - a user is being opped
+ * AC_VOICE (3) - a user is being voiced
+ * AC_DEVOICE (4) - a user is being devoiced
+ * AC_HALFOP (5) - a user is being halfopped
+ * AC_DEHALFOP (6) - a user is being dehalfopped
+ * AC_INVITE (7) - a user is being invited
+ * AC_GENERAL_MODE (8) - a user channel mode is being changed

+ * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes + * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow + * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be + * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the + * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type + * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined). + */ + + virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type); + /** Called during a netburst to sync user data. + * This is called during the netburst on a per-user basis. You should use this call to up any special + * user-related things which are implemented by your module, e.g. sending listmodes. You may return + * multiple commands in the string_list. + */ + virtual string_list OnUserSync(userrec* user); + + /** Called during a netburst to sync channel data. + * This is called during the netburst on a per-channel basis. You should use this call to up any special + * channel-related things which are implemented by your module, e.g. sending listmodes. You may return + * multiple commands in the string_list. + */ + virtual string_list OnChannelSync(chanrec* chan); }; @@ -275,6 +367,16 @@ class Server : public classbase /** Sends text from a user to another user. * This method writes a line of text to a user, with a user's nick/ident * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) + * If you specify NULL as the source, then the data will originate from the + * local server, e.g. instead of: + * + * :user!ident@host TEXT + * + * The format will become: + * + * :localserver TEXT + * + * Which is useful for numerics and server notices to single users, etc. */ virtual void SendTo(userrec* Source, userrec* Dest, std::string s); /** Sends text from a user to a channel (mulicast). @@ -307,6 +409,10 @@ class Server : public classbase * Nicks for unregistered connections will return false. */ virtual bool IsNick(std::string nick); + /** Returns a count of the number of users on a channel. + * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel. + */ + virtual int CountUsers(chanrec* c); /** Attempts to look up a nick and return a pointer to it. * This function will return NULL if the nick does not exist. */ @@ -320,6 +426,10 @@ class Server : public classbase * representing the user's privilages upon the channel you specify. */ virtual std::string ChanMode(userrec* User, chanrec* Chan); + /** Checks if a user is on a channel. + * This function will return true or false to indicate if user 'User' is on channel 'Chan'. + */ + virtual bool IsOnChannel(userrec* User, chanrec* Chan); /** Returns the server name of the server where the module is loaded. */ virtual std::string GetServerName(); @@ -332,7 +442,7 @@ class Server : public classbase * server where the module is loaded. */ virtual Admin GetAdmin(); - /** Adds an extended mode letter which is parsed by a module + /** Adds an extended mode letter which is parsed by a module. * This allows modules to add extra mode letters, e.g. +x for hostcloak. * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to * indicate wether the mode is a channel mode, a client mode, or a server mode. @@ -352,6 +462,29 @@ class Server : public classbase */ virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); + /** Adds an extended mode letter which is parsed by a module and handled in a list fashion. + * This call is used to implement modes like +q and +a. The characteristics of these modes are + * as follows: + * + * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL + * + * (2) They always take exactly one parameter when being added or removed + * + * (3) They can be set multiple times, usually on users in channels + * + * (4) The mode and its parameter are NOT stored in the channels modes structure + * + * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, + * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access + * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered + * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' + * (in for example +a) you must use Server::Find to locate the user the mode is operating on. + * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. + * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, + * so the above example would become '+aa one three' after processing. + */ + virtual bool AddExtendedListMode(char modechar); + /** Adds a command to the command table. * This allows modules to add extra commands into the command table. You must place a function within your * module which is is of type handlerfunc: @@ -410,14 +543,14 @@ class Server : public classbase * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. * On failure, the result is NULL. */ - virtual chanrec* Server::JoinUserToChannel(userrec* user, std::string cname, std::string key); + virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); /** Forces a user to part a channel. * This is similar to svspart and can be used to implement redirection, etc. * Although the return value of this function is a pointer to a channel record, the returned data is * undefined and should not be read or written to. This behaviour may be changed in a future version. */ - virtual chanrec* Server::PartUserFromChannel(userrec* user, std::string cname, std::string reason); + virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); /** Forces a user nickchange. * This command works similarly to SVSNICK, and can be used to implement Q-lines etc. @@ -437,8 +570,62 @@ class Server : public classbase * action after calling this method is to immediately bail from your handler. */ virtual void QuitUser(userrec* user, std::string reason); + + /** Matches text against a glob pattern. + * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com + * Returns true if the literal successfully matches the pattern, false if otherwise. + */ + virtual bool MatchText(std::string sliteral, std::string spattern); + + /** Calls the handler for a command, either implemented by the core or by another module. + * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, + * KICK etc, or even as a method of callback. By defining command names that are untypeable + * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers. + * The first parameter to this method is the name of the command handler you wish to call, e.g. + * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand(). + * The second parameter is an array of parameters, and the third parameter is a count of parameters + * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the + * functiom will silently ignore it. The final parameter is the user executing the command handler, + * used for privilage checks, etc. + */ + virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); + + /** Change displayed hostname of a user. + * You should always call this method to change a user's host rather than writing directly to the + * dhost member of userrec, as any change applied via this method will be propogated to any + * linked servers. + */ + virtual void ChangeHost(userrec* user, std::string host); + + /** Change GECOS (fullname) of a user. + * You should always call this method to change a user's GECOS rather than writing directly to the + * fullname member of userrec, as any change applied via this method will be propogated to any + * linked servers. + */ + virtual void ChangeGECOS(userrec* user, std::string gecos); + + /** Returns true if the servername you give is ulined. + * ULined servers have extra privilages. They are allowed to change nicknames on remote servers, + * change modes of clients which are on remote servers and set modes of channels where there are + * no channel operators for that channel on the ulined server, amongst other things. Ulined server + * data is also broadcast across the mesh at all times as opposed to selectively messaged in the + * case of normal servers, as many ulined server types (such as services) do not support meshed + * links and must operate in this manner. + */ + virtual bool IsUlined(std::string server); + + /** Fetches the userlist of a channel. This function must be here and not a member of userrec or + * chanrec due to include constraints. + */ + virtual chanuserlist GetUsers(chanrec* chan); + }; +#define CONF_NOT_A_NUMBER 0x000010 +#define CONF_NOT_UNSIGNED 0x000080 +#define CONF_VALUE_NOT_FOUND 0x000100 +#define CONF_FILE_NOT_FOUND 0x000200 + /** Allows reading of values from configuration files * This class allows a module to read from either the main configuration file (inspircd.conf) or from * a module-specified configuration file. It may either be instantiated with one parameter or none. @@ -448,9 +635,17 @@ class Server : public classbase class ConfigReader : public classbase { protected: - /** The filename of the configuration file, as set by the constructor. + /** The contents of the configuration file + * This protected member should never be accessed by a module (and cannot be accessed unless the + * core is changed). It will contain a pointer to the configuration file data with unneeded data + * (such as comments) stripped from it. */ - std::string fname; + std::stringstream *cache; + /** Used to store errors + */ + bool readerror; + long error; + public: /** Default constructor. * This constructor initialises the ConfigReader class to read the inspircd.conf file @@ -470,6 +665,26 @@ class ConfigReader : public classbase * exist in the config file, index indicates which of the values to retrieve. */ std::string ReadValue(std::string tag, std::string name, int index); + /** Retrieves a boolean value from the config file. + * This method retrieves a boolean value from the config file. Where multiple copies of the tag + * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes" + * and "true" in the config file count as true to ReadFlag, and any other value counts as false. + */ + bool ReadFlag(std::string tag, std::string name, int index); + /** Retrieves an integer value from the config file. + * This method retrieves an integer value from the config file. Where multiple copies of the tag + * exist in the config file, index indicates which of the values to retrieve. Any invalid integer + * values in the tag will cause the objects error value to be set, and any call to GetError() will + * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. + * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError() + * will return CONF_NOT_UNSIGNED + */ + long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); + /** Returns the last error to occur. + * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. + * A call to GetError() resets the error flag back to 0. + */ + long GetError(); /** Counts the number of times a given tag appears in the config file. * This method counts the number of times a tag appears in a config file, for use where * there are several tags of the same kind, e.g. with opers and connect types. It can be @@ -478,9 +693,17 @@ class ConfigReader : public classbase */ int Enumerate(std::string tag); /** Returns true if a config file is valid. - * This method is unimplemented and will always return true. + * This method is partially implemented and will only return false if the config + * file does not exist or could not be opened. */ bool Verify(); + + /** Returns the number of items within a tag. + * For example if the tag was <test tag="blah" data="foo"> then this + * function would return 2. Spaces and newlines both qualify as valid seperators + * between values. + */ + int EnumerateValues(std::string tag, int index); }; @@ -499,28 +722,37 @@ class FileReader : public classbase * after constructing the class this way. */ FileReader(); + /** Secondary constructor. * This method initialises the class with a file loaded into it ready for GetLine and * and other methods to be called. If the file could not be loaded, FileReader::FileSize * returns 0. */ FileReader(std::string filename); + /** Default destructor. * This deletes the memory allocated to the file. */ ~FileReader(); + /** Used to load a file. * This method loads a file into the class ready for GetLine and * and other methods to be called. If the file could not be loaded, FileReader::FileSize * returns 0. */ void LoadFile(std::string filename); + + /** Returns true if the file exists + * This function will return false if the file could not be opened. + */ + bool Exists(); + /** Retrieve one line from the file. * This method retrieves one line from the text file. If an empty non-NULL string is returned, * the index was out of bounds, or the line had no data on it. */ - bool Exists(); std::string GetLine(int x); + /** Returns the size of the file in lines. * This method returns the number of lines in the read file. If it is 0, no lines have been * read into memory, either because the file is empty or it does not exist, or cannot be