X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=6c92f08014ebe0db937b4060eb2effd4018a3b9d;hb=2e2f1e98a6123aa1177623f92480ce7ba3c55acb;hp=2445d1188213db8afa7faf20d2209cf11e42edab;hpb=572a7b503b434367e57ba1624f415e1c472e18a2;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index 2445d1188..6c92f0801 100644 --- a/include/channels.h +++ b/include/channels.h @@ -38,6 +38,7 @@ enum ChannelModes { }; class userrec; +class chanrec; /** Holds an entry for a ban list, exemption list, or invite list. * This class contains a single element in a channel list, such as a banlist. @@ -45,8 +46,14 @@ class userrec; class HostItem : public classbase { public: + /** Time the item was added + */ time_t set_time; + /** Who added the item + */ char set_by[NICKMAX]; + /** The actual item data + */ char data[MAXBUF]; HostItem() { /* stub */ } @@ -59,48 +66,99 @@ class BanItem : public HostItem { }; -/** A subclass of HostItem designed to hold channel exempts (+e) - */ -class ExemptItem : public HostItem -{ -}; - -/** A subclass of HostItem designed to hold channel invites (+I) - */ -class InviteItem : public HostItem -{ -}; - /** Holds a complete ban list */ typedef std::vector BanList; -/** Holds a complete exempt list +/** A list of users on a channel */ -typedef std::vector ExemptList; +typedef std::map CUList; -/** Holds a complete invite list +/** Shorthand for CUList::iterator */ -typedef std::vector InviteList; +typedef CUList::iterator CUListIter; -/** A list of users on a channel +/** Shorthand for CUList::const_iterator */ -typedef std::map CUList; +typedef CUList::const_iterator CUListConstIter; /** A list of custom modes parameters on a channel */ typedef std::map CustomModeList; + +/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o + */ +enum UserChannelModes { + UCMODE_OP = 1, + UCMODE_VOICE = 2, + UCMODE_HOP = 4 +}; + +/** Holds a user's modes on a channel + * This class associates a users privilages with a channel by creating a pointer link between + * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user + * has on the channel, such as op, voice, etc. + */ +class ucrec : public classbase +{ + public: + /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values. + * If this value is zero, the user has no privilages upon the channel. + */ + char uc_modes; + + /** Points to the channel record where the given modes apply. + * If the record is not in use, this value will be NULL. + */ + chanrec *channel; + + /** Constructor for ucrec + */ + ucrec() : uc_modes(0), channel(NULL) { /* stub */ } + + /** Destructor for ucrec + */ + virtual ~ucrec() { /* stub */ } +}; + +class InspIRCd; + +/** A stored prefix and its rank + */ +typedef std::pair prefixtype; + +/** A list of prefixes set on a user in a channel + */ +typedef std::vector pfxcontainer; + +/** A list of users with zero or more prefixes set on them + */ +typedef std::map > prefixlist; + /** Holds all relevent information for a channel. * This class represents a channel, and contains its name, modes, time created, topic, topic set time, * etc, and an instance of the BanList type. */ class chanrec : public Extensible { + private: + + /** Pointer to creator object + */ + InspIRCd* ServerInstance; + + /** Connect a chanrec to a userrec + */ + static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr,ucrec *a,userrec* user, int created); + + prefixlist prefixes; + public: /** The channels name. */ - char name[CHANMAX]; /* channel name */ + char name[CHANMAX]; + /** Modes for the channel. * This is not a null terminated string! It is a hash where * each item in it represents if a mode is set. For example @@ -115,8 +173,17 @@ class chanrec : public Extensible * the halfops and another for the voices. */ CUList internal_userlist; + + /** Opped users + */ CUList internal_op_userlist; + + /** Halfopped users + */ CUList internal_halfop_userlist; + + /** Voiced users + */ CUList internal_voice_userlist; /** Parameters for custom modes @@ -148,11 +215,7 @@ class chanrec : public Extensible * If this value is an empty string, there is no channel key in place. */ char key[32]; - - /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols - */ - //char binarymodes; - + /** The list of all bans set on the channel. */ BanList bans; @@ -161,14 +224,14 @@ class chanrec : public Extensible * @param mode The mode character to set or unset * @param mode_on True if you want to set the mode or false if you want to remove it */ - void SetCustomMode(char mode,bool mode_on); + void SetMode(char mode,bool mode_on); /** Sets or unsets the parameters for a custom mode in a channels info * @param mode The mode character to set or unset * @param parameter The parameter string to associate with this mode character * @param mode_on True if you want to set the mode or false if you want to remove it */ - void SetCustomModeParam(char mode,char* parameter,bool mode_on); + void SetModeParam(char mode,const char* parameter,bool mode_on); /** Returns true if a mode is set on a channel * @param mode The mode character you wish to query @@ -205,17 +268,41 @@ class chanrec : public Extensible * as this is a very fast 32 or 64 bit integer comparison. */ void AddUser(userrec* user); + + /** Add a user pointer to the internal reference list of opped users + * @param user The user to add + */ void AddOppedUser(userrec* user); + + /** Add a user pointer to the internal reference list of halfopped users + * @param user The user to add + */ void AddHalfoppedUser(userrec* user); + + /** Add a user pointer to the internal reference list of voiced users + * @param user The user to add + */ void AddVoicedUser(userrec* user); /** Delete a user pointer to the internal reference list * @param user The user to delete - * @return number of users left on the channel + * @return number of users left on the channel after deletion of the user */ unsigned long DelUser(userrec* user); + + /** Delete a user pointer to the internal reference list of opped users + * @param user The user to delete + */ void DelOppedUser(userrec* user); + + /** Delete a user pointer to the internal reference list of halfopped users + * @param user The user to delete + */ void DelHalfoppedUser(userrec* user); + + /** Delete a user pointer to the internal reference list of voiced users + * @param user The user to delete + */ void DelVoicedUser(userrec* user); /** Obtain the internal reference list @@ -228,62 +315,211 @@ class chanrec : public Extensible * @return This function returns pointer to a map of userrec pointers (CUList*). */ CUList* GetUsers(); + + /** Obtain the internal reference list of opped users + * @return This function returns pointer to a map of userrec pointers (CUList*). + */ CUList* GetOppedUsers(); + + /** Obtain the internal reference list of halfopped users + * @return This function returns pointer to a map of userrec pointers (CUList*). + */ CUList* GetHalfoppedUsers(); + + /** Obtain the internal reference list of voiced users + * @return This function returns pointer to a map of userrec pointers (CUList*). + */ CUList* GetVoicedUsers(); /** Returns true if the user given is on the given channel. + * @param The user to look for + * @return True if the user is on this channel */ bool HasUser(userrec* user); /** Creates a channel record and initialises it with default values + * @throw Nothing at present. + */ + chanrec(InspIRCd* Instance); + + /** Make src kick user from this channel with the given reason. + * @param src The source of the kick + * @param user The user being kicked (must be on this channel) + * @param reason The reason for the kick + * @return The number of users left on the channel. If this is zero + * when the method returns, you MUST delete the chanrec immediately! */ - chanrec(); + long KickUser(userrec *src, userrec *user, const char* reason); + + /** Make the server kick user from this channel with the given reason. + * @param user The user being kicked (must be on this channel) + * @param reason The reason for the kick + * @param triggerevents True if you wish this kick to trigger module events + * @return The number of users left on the channel. If this is zero + * when the method returns, you MUST delete the chanrec immediately! + */ + long ServerKickUser(userrec* user, const char* reason, bool triggerevents); + + /** Part a user from this channel with the given reason. + * If the reason field is NULL, no reason will be sent. + * @param user The user who is parting (must be on this channel) + * @param reason The (optional) part reason + * @return The number of users left on the channel. If this is zero + * when the method returns, you MUST delete the chanrec immediately! + */ + long PartUser(userrec *user, const char* reason = NULL); + + /* Join a user to a channel. May be a channel that doesnt exist yet. + * @param user The user to join to the channel. + * @param cn The channel name to join to. Does not have to exist. + * @param key The key of the channel, if given + * @param override If true, override all join restrictions such as +bkil + * @return A pointer to the chanrec the user was joined to. A new chanrec may have + * been created if the channel did not exist before the user was joined to it. + * If the user could not be joined to a channel, the return value may be NULL. + */ + static chanrec* JoinUser(InspIRCd* ServerInstance, userrec *user, const char* cn, bool override, const char* key = ""); - /** Destructor for chanrec + /** Write to a channel, from a user, using va_args for text + * @param user User whos details to prefix the line with + * @param text A printf-style format string which builds the output line without prefix + * @param ... Zero or more POD types */ - virtual ~chanrec() { /* stub */ } -}; + void WriteChannel(userrec* user, char* text, ...); -/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o - * needs to come AFTER struct chanrec */ -enum UserChannelModes { - UCMODE_OP = 1, - UCMODE_VOICE = 2, - UCMODE_HOP = 4 -}; - -/** Holds a user's modes on a channel - * This class associates a users privilages with a channel by creating a pointer link between - * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user - * has on the channel, such as op, voice, etc. - */ -class ucrec : public classbase -{ - public: - /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values. - * If this value is zero, the user has no privilages upon the channel. + /** Write to a channel, from a user, using std::string for text + * @param user User whos details to prefix the line with + * @param text A std::string containing the output line without prefix */ - char uc_modes; - - /** Points to the channel record where the given modes apply. - * If the record is not in use, this value will be NULL. + void WriteChannel(userrec* user, const std::string &text); + + /** Write to a channel, from a server, using va_args for text + * @param ServName Server name to prefix the line with + * @param text A printf-style format string which builds the output line without prefi + * @param ... Zero or more POD type */ - chanrec *channel; + void WriteChannelWithServ(const char* ServName, const char* text, ...); - /** Constructor for ucrec + /** Write to a channel, from a server, using std::string for text + * @param ServName Server name to prefix the line with + * @param text A std::string containing the output line without prefix */ - ucrec() : uc_modes(0), channel(NULL) { /* stub */ } + void WriteChannelWithServ(const char* ServName, const std::string &text); + + /** Write to all users on a channel except a specific user, using va_args for text + * @param user User whos details to prefix the line with, and to omit from receipt of the message + * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise, + * use the nick!user@host of the user. + * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone + * @param text A printf-style format string which builds the output line without prefi + * @param ... Zero or more POD type + */ + void WriteAllExceptSender(userrec* user, bool serversource, char status, char* text, ...); + + /** Write to all users on a channel except a specific user, using std::string for text + * @param user User whos details to prefix the line with, and to omit from receipt of the message + * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise, + * use the nick!user@host of the user. + * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone + * @param text A std::string containing the output line without prefix + */ + void WriteAllExceptSender(userrec* user, bool serversource, char status, const std::string& text); - /** Destructor for ucrec + /** Returns the maximum number of bans allowed to be set on this channel + * @return The maximum number of bans allowed */ - virtual ~ucrec() { /* stub */ } -}; + long GetMaxBans(); -chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override); -chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local); -void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason); -void server_kick_channel(userrec* user, chanrec* Ptr, char* reason, bool triggerevents); + /** Return the channel's modes with parameters. + * @param showkey If this is set to true, the actual key is shown, + * otherwise it is replaced with '<KEY>' + * @return The channel mode string + */ + char* ChanModes(bool showkey); -#endif + /** Spool the NAMES list for this channel to the given user + * @param user The user to spool the NAMES list to + */ + void UserList(userrec *user); + + /** Get the number of invisible users on this channel + * @return Number of invisible users + */ + int CountInvisible(); + + /** Get a users status on this channel + * @param user The user to look up + * @return One of STATUS_OP, STATUS_HOP, STATUS_VOICE, or zero. + */ + int GetStatus(userrec *user); + + /** Get a users status on this channel in a bitmask + * @param user The user to look up + * @return A bitmask containing zero or more of STATUS_OP, STATUS_HOP, STATUS_VOICE + */ + int GetStatusFlags(userrec *user); + + /** Get a users prefix on this channel in a string. + * @param user The user to look up + * @return A character array containing the prefix string. + * Unlike GetStatus and GetStatusFlags which will only return the + * core specified modes @, % and + (op, halfop and voice), GetPrefixChar + * will also return module-defined prefixes. If the user has to prefix, + * an empty but non-null string is returned. If the user has multiple + * prefixes, the highest is returned. If you do not recognise the prefix + * character you can get, you can deal with it in a 'proprtional' manner + * compared to known prefixes, using GetPrefixValue(). + */ + const char* GetPrefixChar(userrec *user); + + /** Return all of a users mode prefixes into a char* string. + * @param user The user to look up + * @return A list of all prefix characters. The prefixes will always + * be in rank order, greatest first, as certain IRC clients require + * this when multiple prefixes are used names lists. + */ + const char* GetAllPrefixChars(userrec* user); + + /** Get the value of a users prefix on this channel. + * @param user The user to look up + * @return The module or core-defined value of the users prefix. + * The values for op, halfop and voice status are constants in + * mode.h, and are OP_VALUE, HALFOP_VALUE, and VOICE_VALUE respectively. + * If the value you are given does not match one of these three, it is + * a module-defined mode, and it should be compared in proportion to + * these three constants. For example a value greater than OP_VALUE + * is a prefix of greater 'worth' than ops, and a value less than + * VOICE_VALUE is of lesser 'worth' than a voice. + */ + unsigned int GetPrefixValue(userrec* user); + + /** This method removes all prefix characters from a user. + * It will not inform the user or the channel of the removal of prefixes, + * and should be used when the user parts or quits. + * @param user The user to remove all prefixes from + */ + void RemoveAllPrefixes(userrec* user); + + /** Add a prefix character to a user. + * Only the core should call this method, usually from + * within the mode parser or when the first user joins + * the channel (to grant ops to them) + * @param user The user to associate the privilage with + * @param prefix The prefix character to associate + * @param prefix_rank The rank (value) of this prefix character + * @param adding True if adding the prefix, false when removing + */ + void SetPrefix(userrec* user, char prefix, unsigned int prefix_rank, bool adding); + + /** Check if a user is banned on this channel + * @param user A user to check against the banlist + * @returns True if the user given is banned + */ + bool IsBanned(userrec* user); + + /** Destructor for chanrec + */ + virtual ~chanrec() { /* stub */ } +}; +#endif