X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=76b60466887fe0ab6ac1b686a2cc7a386d2b4e5c;hb=8f9d0a68cd77b6a78eccfa7df9c1045d453ce581;hp=b60ee6cadfc2bea9cf3ca1430b15c580cc1e0adc;hpb=61b45c935dbb50c280970c9f431fd1c7ef4eb680;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index b60ee6cad..76b604668 100644 --- a/include/channels.h +++ b/include/channels.h @@ -1,15 +1,43 @@ -/* +/* +------------------------------------+ + * | 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__ +/** RFC1459 channel modes + */ +enum ChannelModes { + 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; /** 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. @@ -25,32 +53,24 @@ 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 { }; - /** Holds a complete ban list */ typedef std::vector BanList; @@ -63,24 +83,55 @@ 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. */ -class chanrec : public classbase +class chanrec : public Extensible { 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. + /** 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[MAXMODES]; /* modes handled by modules */ + char modes[64]; + + /** 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; @@ -96,66 +147,116 @@ class chanrec : public classbase /** 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. + /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols */ - 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 - */ - 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 parameterrs for a custom mode in a channels info + /** 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 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 IsModeSet(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 + */ + 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(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); + + /** 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 pointer to a map of userrec pointers (CUList*). + */ + 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 */ } }; -/* 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 @@ -168,16 +269,25 @@ 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 */ } + /** Constructor for ucrec + */ + ucrec() : uc_modes(0), channel(NULL) { /* stub */ } + + /** Destructor for ucrec + */ virtual ~ucrec() { /* stub */ } }; -#endif +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