X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fchannels.h;h=a6568cb1e8198ffd25ccd286725cf7d427b09b32;hb=c73881748324fb454153c2d0fd85e8b80996b2b7;hp=6080cda98182cb4e82fbe279434184f1c04d1a33;hpb=3ffb95a12391eac5cf89549af9e790362fbfc075;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index 6080cda98..a6568cb1e 100644 --- a/include/channels.h +++ b/include/channels.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. * E-mail: * * @@ -14,14 +14,26 @@ * --------------------------------------------------- */ +#ifndef __CHANNELS_H__ +#define __CHANNELS_H__ + #include "inspircd_config.h" #include "base.h" #include #include #include +#include + +enum ChannelModes { + CM_TOPICLOCK = 1, + CM_NOEXTERNAL = 2, + CM_INVITEONLY = 4, + CM_MODERATED = 8, + CM_SECRET = 16, + CM_PRIVATE = 32 +}; -#ifndef __CHANNELS_H__ -#define __CHANNELS_H__ +class userrec; /** 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. @@ -62,19 +74,6 @@ class InviteItem : public HostItem { }; - -/** Holds a custom parameter to a module-defined channel mode - * e.g. for +L this would hold the channel name. - */ - -class ModeParameter : public classbase -{ - public: - char mode; - char parameter[MAXBUF]; - char channel[CHANMAX]; -}; - /** Holds a complete ban list */ typedef std::vector BanList; @@ -87,6 +86,16 @@ typedef std::vector ExemptList; */ typedef std::vector InviteList; +class userrec; + +/** A list of users on a channel + */ +typedef std::map CUList; + +/** 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. @@ -100,21 +109,26 @@ class chanrec : public Extensible /** Custom modes for the channel. * Plugins may use this field in any way they see fit. */ - char custom_modes[MAXMODES]; /* modes handled by modules */ + char custom_modes[64]; /* modes handled by modules */ - /** Count of users on the channel used for fast user counting + /** 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. */ - long users; + CUList internal_userlist; + CUList internal_op_userlist; + CUList internal_halfop_userlist; + CUList internal_voice_userlist; - /** User list (casted to char*'s to stop forward declaration stuff) - * (chicken and egg scenario!) + /** Parameters for custom modes */ - std::vector internal_userlist; - + 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; @@ -130,108 +144,97 @@ class chanrec : public Extensible /** Contains the channel user limit. * If this value is zero, there is no limit in place. */ - long limit; + short int limit; /** Contains the channel key. * If this value is an empty string, there is no channel key in place. */ char key[32]; - /** Nonzero if the mode +t is set. - */ - short int topiclock; - - /** Nonzero if the mode +n is set. - */ - short int noexternal; - - /** Nonzero if the mode +i is set. - */ - short int inviteonly; - - /** Nonzero if the mode +m is set. - */ - short int moderated; - - /** Nonzero if the mode +s is set. - * This value cannot be set at the same time as chanrec::c_private + /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols */ - short int secret; - - /** Nonzero if the mode +p is set. - * This value cannot be set at the same time as chanrec::secret - */ - short int c_private; + //char binarymodes; /** The list of all bans set on the channel. */ BanList bans; /** Sets or unsets a custom mode in the channels info + * @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); /** 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); /** Returns true if a custom 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); /** Returns the parameter for a custom mode on a channel. + * @param mode The mode character you wish to query + * * For example if "+L #foo" is set, and you pass this method * 'L', it will return '#foo'. If the mode is not set on the * channel, or the mode has no parameters associated with it, * it will return an empty string. + * + * @return The parameter for this mode is returned, or an empty string */ std::string GetModeParameter(char mode); - /** Increment the channel "user counter" - * The channel user counter is a reference counter which - * holds the number of users on the channel. If it decremented - * to 0 then the channel is removed from the system. - */ - void IncUserCounter(); - - /** Decrement the channel "user counter" - * The channel user counter is a reference counter which - * holds the number of users on the channel. If it decremented - * to 0 then the channel is removed from the system. - * Modules may alter the reference count to hold channels open - * which have no users and would normally be deleted once empty. - */ - void DecUserCounter(); - /** Obtain the channel "user counter" * This returns the channel reference counter, which is initialized * to 0 when the channel is created and incremented/decremented * upon joins, parts quits and kicks. + * + * @return The number of users on this channel */ long GetUserCounter(); /** Add a user pointer to the internal reference list + * @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 AddUser(userrec* user); + void AddOppedUser(userrec* user); + void AddHalfoppedUser(userrec* user); + void AddVoicedUser(userrec* user); /** Delete a user pointer to the internal reference list - * 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); + unsigned long DelUser(userrec* user); + void DelOppedUser(userrec* user); + void DelHalfoppedUser(userrec* user); + void DelVoicedUser(userrec* user); /** 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 + * 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 pointer to a map of userrec pointers (CUList*). */ - std::vector *GetUsers(); + CUList* GetUsers(); + CUList* GetOppedUsers(); + CUList* GetHalfoppedUsers(); + CUList* GetVoicedUsers(); + + bool HasUser(userrec* user); /** Creates a channel record and initialises it with default values */ @@ -240,14 +243,13 @@ class chanrec : public Extensible virtual ~chanrec() { /* stub */ } }; -/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o +/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o * needs to come AFTER struct chanrec */ - -#define UCMODE_OP 1 -#define UCMODE_VOICE 2 -#define UCMODE_HOP 4 -#define UCMODE_PROTECT 8 -#define UCMODE_FOUNDER 16 +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 @@ -260,16 +262,21 @@ class ucrec : public classbase /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values. * If this value is zero, the user has no privilages upon the channel. */ - long uc_modes; + 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; - ucrec() { /* stub */ } + ucrec() : uc_modes(0), channel(NULL) { /* stub */ } virtual ~ucrec() { /* stub */ } }; +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); + #endif