X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=a6568cb1e8198ffd25ccd286725cf7d427b09b32;hb=c73881748324fb454153c2d0fd85e8b80996b2b7;hp=c9cdd7b31e5409354a7825971314051b1fe1fb21;hpb=73b9d0c5cb02f0ea8350de28bc3687e0af70ea0f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index c9cdd7b31..a6568cb1e 100644 --- a/include/channels.h +++ b/include/channels.h @@ -1,35 +1,44 @@ -/* - -$Log$ -Revision 1.1 2003/01/23 19:45:58 brain -Initial revision - -Revision 1.7 2003/01/22 00:44:26 brain -Added documentation comments - -Revision 1.6 2003/01/21 21:11:17 brain -Added documentation - -Revision 1.5 2003/01/16 20:11:55 brain -fixed some ugly pointer bugs (thanks dblack and a|KK|y!) - -Revision 1.4 2003/01/15 22:47:44 brain -Changed user and channel structs to classes (finally) +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * InspIRCd is copyright (C) 2002-2006 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 __CHANNELS_H__ +#define __CHANNELS_H__ #include "inspircd_config.h" +#include "base.h" #include #include +#include +#include -#ifndef __CHANNELS_H__ -#define __CHANNELS_H__ +enum ChannelModes { + CM_TOPICLOCK = 1, + CM_NOEXTERNAL = 2, + CM_INVITEONLY = 4, + CM_MODERATED = 8, + CM_SECRET = 16, + CM_PRIVATE = 32 +}; + +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. */ -class HostItem +class HostItem : public classbase { public: time_t set_time; @@ -65,24 +74,33 @@ class InviteItem : public HostItem { }; - /** Holds a complete ban list */ -typedef vector BanList; +typedef std::vector BanList; /** Holds a complete exempt list */ -typedef vector ExemptList; +typedef std::vector ExemptList; /** Holds a complete invite list */ -typedef vector InviteList; +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. */ -class chanrec +class chanrec : public Extensible { public: /** The channels name. @@ -91,11 +109,26 @@ class chanrec /** 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 */ + + /** 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. + */ + CUList internal_userlist; + CUList internal_op_userlist; + CUList internal_halfop_userlist; + CUList internal_voice_userlist; + + /** Parameters for custom modes + */ + 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; @@ -111,89 +144,139 @@ class chanrec /** 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. + /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols */ - short int topiclock; + //char binarymodes; - /** Nonzero if the mode +n is set. + /** The list of all bans set on the channel. */ - short int noexternal; + BanList bans; - /** Nonzero if the mode +i is set. + /** 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 */ - short int inviteonly; - - /** Nonzero if the mode +m is set. + 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 */ - short int moderated; - - /** Nonzero if the mode +s is set. - * This value cannot be set at the same time as chanrec::c_private + 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); + + /** 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 */ - short int secret; - - /** Nonzero if the mode +p is set. - * This value cannot be set at the same time as chanrec::secret + 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. */ - short int c_private; - - /** The list of all bans set on the channel. + 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 user The user to delete + * @return number of users left on the channel + */ + 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*. + * 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*). */ - BanList bans; + CUList* GetUsers(); + CUList* GetOppedUsers(); + CUList* GetHalfoppedUsers(); + CUList* GetVoicedUsers(); + + bool HasUser(userrec* user); /** Creates a channel record and initialises it with default values */ - chanrec() - { - strcpy(name,""); - strcpy(custom_modes,""); - strcpy(topic,""); - strcpy(setby,""); - strcpy(key,""); - created = topicset = limit = 0; - topiclock = noexternal = inviteonly = moderated = secret = c_private = false; - } + chanrec(); 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 * 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 +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. */ - 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