X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=aa34ceb3cd98f9ec04e2e67d2d4458ad7fe23dd5;hb=a7543c881be4c900b68a54714de7c1e677acbb09;hp=65f3948fe7d742b1c2c12643f4d0fee75cc7532d;hpb=ced58c3be3f1da8dcf70c3904e5fe4bdaabf0e3d;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index 65f3948fe..aa34ceb3c 100644 --- a/include/channels.h +++ b/include/channels.h @@ -24,6 +24,8 @@ #include #include +/** RFC1459 channel modes + */ enum ChannelModes { CM_TOPICLOCK = 't'-65, CM_NOEXTERNAL = 'n'-65, @@ -36,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. @@ -43,33 +46,32 @@ 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 */ } virtual ~HostItem() { /* stub */ } }; -// banlist is inherited from HostList mainly for readability -// reasons only - /** A subclass of HostItem designed to hold channel bans (+b) */ class BanItem : public HostItem { }; -// same with this... - /** A subclass of HostItem designed to hold channel exempts (+e) */ class ExemptItem : public HostItem { }; -// and this... - /** A subclass of HostItem designed to hold channel invites (+I) */ class InviteItem : public HostItem @@ -88,30 +90,83 @@ typedef std::vector ExemptList; */ typedef std::vector InviteList; -class userrec; - /** A list of users on a channel */ typedef std::map CUList; +/** Shorthand for CUList::iterator + */ +typedef CUList::iterator CUListIter; + +/** Shorthand for CUList::const_iterator + */ +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 */ } +}; + + /** 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: + + /** Connect a chanrec to a userrec + */ + static chanrec* ForceChan(chanrec* Ptr,ucrec *a,userrec* user, int created); + public: /** The channels name. */ - char name[CHANMAX]; /* channel name */ - /** Custom modes for the channel. - * Plugins may use this field in any way they see fit. + 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 + * for mode +A, index 0. Use modechar-65 to calculate which + * field to check. */ - char modes[64]; /* modes handled by modules */ + char modes[64]; /** User lists * There are four user lists, one for @@ -119,8 +174,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 @@ -152,11 +216,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; @@ -165,14 +225,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 @@ -209,20 +269,44 @@ 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); - /** Obrain the internal reference list + /** Obtain the internal reference list * The internal reference list contains a list of userrec*. * These are used for rapid comparison to determine * channel membership for PRIVMSG, NOTICE, QUIT, PART etc. @@ -232,53 +316,115 @@ 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(); - virtual ~chanrec() { /* stub */ } -}; + /** 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! + */ + 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(userrec *user, const char* cn, bool override, const char* key = ""); -/** 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 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 */ - 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, char* text, ...); + + /** 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 */ - chanrec *channel; + void WriteChannel(userrec* user, const std::string &text); - ucrec() : uc_modes(0), channel(NULL) { /* stub */ } - virtual ~ucrec() { /* stub */ } -}; + /** 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 + */ + void WriteChannelWithServ(const char* ServName, const char* text, ...); -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); + /** 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 + */ + void WriteChannelWithServ(const char* ServName, const std::string &text); -#endif + /** 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 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, 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 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, char status, const std::string& text); + + /** Destructor for chanrec + */ + virtual ~chanrec() { /* stub */ } +}; +#endif