X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=76b60466887fe0ab6ac1b686a2cc7a386d2b4e5c;hb=90639721625b5da867effc7dd4adec003c1bd3b4;hp=c3658c6b0c71ce65eb749da880e32fb6a929dfe5;hpb=b2f5fc1e32971532c9f302884007e645ea3c38ce;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index c3658c6b0..76b604668 100644 --- a/include/channels.h +++ b/include/channels.h @@ -24,13 +24,17 @@ #include #include +/** RFC1459 channel modes + */ enum ChannelModes { - CM_TOPICLOCK = 1, - CM_NOEXTERNAL = 2, - CM_INVITEONLY = 4, - CM_MODERATED = 8, - CM_SECRET = 16, - CM_PRIVATE = 32 + CM_TOPICLOCK = 't'-65, + CM_NOEXTERNAL = 'n'-65, + CM_INVITEONLY = 'i'-65, + CM_MODERATED = 'm'-65, + CM_SECRET = 's'-65, + CM_PRIVATE = 'p'-65, + CM_KEY = 'k'-65, + CM_LIMIT = 'l'-65 }; class userrec; @@ -49,25 +53,18 @@ class HostItem : public classbase 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 @@ -86,6 +83,19 @@ typedef std::vector ExemptList; */ typedef std::vector InviteList; +/** A list of users on a channel + */ +typedef std::map CUList; + +/** Shorthand for CUList::iterator + */ +typedef CUList::iterator CUListIter; +typedef CUList::const_iterator CUListConstIter; + +/** A list of custom modes parameters on a channel + */ +typedef std::map CustomModeList; + /** 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. @@ -96,27 +106,32 @@ class chanrec : public Extensible /** The channels name. */ char name[CHANMAX]; /* channel name */ - /** Custom modes for the channel. - * Plugins may use this field in any way they see fit. + /** 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 custom_modes[64]; /* modes handled by modules */ + char modes[64]; - /** User list (casted to char*'s to stop forward declaration stuff) - * (chicken and egg scenario!) + /** User lists + * There are four user lists, one for + * all the users, one for the ops, one for + * the halfops and another for the voices. */ - std::map internal_userlist; - std::map internal_op_userlist; - std::map internal_halfop_userlist; - std::map internal_voice_userlist; + CUList internal_userlist; + CUList internal_op_userlist; + CUList internal_halfop_userlist; + CUList internal_voice_userlist; /** Parameters for custom modes */ - std::map custom_mode_params; + CustomModeList custom_mode_params; /** Channel topic. * If this is an empty string, no channel topic is set. */ - char topic[MAXBUF]; + char topic[MAXTOPIC]; /** Creation time. */ time_t created; @@ -141,7 +156,7 @@ class chanrec : public Extensible /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols */ - char binarymodes; + //char binarymodes; /** The list of all bans set on the channel. */ @@ -160,11 +175,11 @@ class chanrec : public Extensible */ void SetCustomModeParam(char mode,char* parameter,bool mode_on); - /** Returns true if a custom mode is set on a channel + /** Returns true if a mode is set on a channel * @param mode The mode character you wish to query * @return True if the custom mode is set, false if otherwise */ - bool IsCustomModeSet(char mode); + bool IsModeSet(char mode); /** Returns the parameter for a custom mode on a channel. * @param mode The mode character you wish to query @@ -188,47 +203,50 @@ class chanrec : public Extensible long GetUserCounter(); /** Add a user pointer to the internal reference list - * @param castuser This should be a pointer to a userrec, casted to char* + * @param user The user to add * * The data inserted into the reference list is a table as it is * an arbitary pointer compared to other users by its memory address, * as this is a very fast 32 or 64 bit integer comparison. */ - void AddUser(char* castuser); - void AddOppedUser(char* castuser); - void AddHalfoppedUser(char* castuser); - void AddVoicedUser(char* castuser); + void AddUser(userrec* user); + void AddOppedUser(userrec* user); + void AddHalfoppedUser(userrec* user); + void AddVoicedUser(userrec* user); /** Delete a user pointer to the internal reference list - * @param castuser This should be a pointer to a userrec, casted to char* - * - * The data removed from the reference list is a table as it is - * an arbitary pointer compared to other users by its memory address, - * as this is a very fast 32 or 64 bit integer comparison. + * @param user The user to delete + * @return number of users left on the channel */ - void DelUser(char* castuser); - void DelOppedUser(char* castuser); - void DelHalfoppedUser(char* castuser); - void DelVoicedUser(char* castuser); - - /** Obrain the internal reference list - * The internal reference list contains a list of userrec* - * cast to char*. These are used for rapid comparison to determine + unsigned long DelUser(userrec* user); + void DelOppedUser(userrec* user); + void DelHalfoppedUser(userrec* user); + void DelVoicedUser(userrec* user); + + /** 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. * The resulting pointer to the vector should be considered * readonly and only modified via AddUser and DelUser. * - * @return This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references + * @return This function returns pointer to a map of userrec pointers (CUList*). */ - std::map *GetUsers(); - std::map *GetOppedUsers(); - std::map *GetHalfoppedUsers(); - std::map *GetVoicedUsers(); + CUList* GetUsers(); + CUList* GetOppedUsers(); + CUList* GetHalfoppedUsers(); + CUList* GetVoicedUsers(); + + /** Returns true if the user given is on the given channel. + */ + bool HasUser(userrec* user); /** Creates a channel record and initialises it with default values */ chanrec(); + /** Destructor for chanrec + */ virtual ~chanrec() { /* stub */ } }; @@ -258,7 +276,12 @@ class ucrec : public classbase */ chanrec *channel; + /** Constructor for ucrec + */ ucrec() : uc_modes(0), channel(NULL) { /* stub */ } + + /** Destructor for ucrec + */ virtual ~ucrec() { /* stub */ } }; @@ -268,4 +291,3 @@ void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason); void server_kick_channel(userrec* user, chanrec* Ptr, char* reason, bool triggerevents); #endif -