X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=7728bb55b16935b0b5bd1efd76d68c6320b16704;hb=9db7af579c46a9f0379fdf71fb773a0a76a94846;hp=b0f856c902342e85bb4d4e50ca866a5413cfd9d0;hpb=43847ec9c7e1a195163eb4c529f1c92fd1ace0a4;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index b0f856c90..7728bb55b 100644 --- a/include/channels.h +++ b/include/channels.h @@ -3,7 +3,7 @@ * +------------------------------------+ * * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -14,6 +14,8 @@ #ifndef __CHANNELS_H__ #define __CHANNELS_H__ +#include "membership.h" + /** RFC1459 channel modes */ enum ChannelModes { @@ -29,11 +31,12 @@ enum ChannelModes { /* Forward declarations - needed */ class User; +struct ModResult; /** 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 : public classbase +class HostItem { public: /** Time the item was added @@ -60,22 +63,9 @@ class BanItem : public HostItem */ typedef std::list BanList; -/** 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; - +typedef std::map CustomModeList; /** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o */ @@ -85,43 +75,20 @@ enum UserChannelModes { UCMODE_HOP = 4 /* Halfopped user */ }; -/** A stored prefix and its rank - */ -typedef std::pair prefixtype; - -/** A list of prefixes set on a user in a channel - */ -typedef std::vector pfxcontainer; - -/** A list of users with zero or more prefixes set on them - */ -typedef std::map > prefixlist; - /** Holds all relevent information for a channel. - * This class represents a channel, and contains its name, modes, time created, topic, topic set time, + * This class represents a channel, and contains its name, modes, topic, topic set time, * etc, and an instance of the BanList type. */ class CoreExport Channel : public Extensible { - private: - - /** Pointer to creator object - */ - InspIRCd* ServerInstance; - /** Connect a Channel to a User */ - static Channel* ForceChan(InspIRCd* Instance, Channel* Ptr, User* user, const std::string &privs, bool bursting); + static Channel* ForceChan(Channel* Ptr, User* user, const std::string &privs, bool bursting, bool created); /** Set default modes for the channel on creation */ void SetDefaultModes(); - /** A list of prefixes associated with each user in the channel - * (e.g. &%+ etc) - */ - prefixlist prefixes; - /** Maximum number of bans (cached) */ int maxbans; @@ -130,12 +97,16 @@ class CoreExport Channel : public Extensible /** Creates a channel record and initialises it with default values * @throw Nothing at present. */ - Channel(InspIRCd* Instance, const std::string &name, time_t ts); + Channel(const std::string &name, time_t ts); /** The channel's name. */ std::string name; /* CHANMAX */ + /** Time that the object was instantiated (used for TS calculation etc) + */ + time_t age; + /** Modes for the channel. * This is not a null terminated string! It is a bitset where * each item in it represents if a mode is set. For example @@ -144,33 +115,9 @@ class CoreExport Channel : public Extensible */ std::bitset<64> modes; - /** 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; - - /** Opped users. - * 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_op_userlist; - - /** Halfopped users. - * 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_halfop_userlist; - - /** Voiced users. - * There are four user lists, one for - * all the users, one for the ops, one for - * the halfops and another for the voices. + /** User list. */ - CUList internal_voice_userlist; + UserMembList userlist; /** Parameters for custom modes. * One for each custom mode letter. @@ -182,11 +129,6 @@ class CoreExport Channel : public Extensible */ std::string topic; /* MAXTOPIC */ - /** Creation time. - * This is a timestamp (TS) value. - */ - time_t created; - /** Time topic was set. * If no topic was ever set, this will be equal to Channel::created */ @@ -200,25 +142,26 @@ class CoreExport Channel : public Extensible /** 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 SetMode(char mode,bool mode_on); - /** Sets or unsets the parameters for a custom mode in a channels info + /** Sets or unsets a custom mode in the 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 + * @param parameter The parameter string to associate with this mode character. + * If it is empty, the mode is unset; if it is nonempty, the mode is set. */ - void SetModeParam(char mode,const char* parameter,bool mode_on); - + void SetModeParam(char mode, std::string parameter); + /** 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); + inline bool IsModeSet(char mode) { return modes[mode-'A']; } + /** Returns the parameter for a custom mode on a channel. * @param mode The mode character you wish to query @@ -255,22 +198,7 @@ class CoreExport Channel : public Extensible * 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(User* user); - - /** Add a user pointer to the internal reference list of opped users - * @param user The user to add - */ - void AddOppedUser(User* user); - - /** Add a user pointer to the internal reference list of halfopped users - * @param user The user to add - */ - void AddHalfoppedUser(User* user); - - /** Add a user pointer to the internal reference list of voiced users - * @param user The user to add - */ - void AddVoicedUser(User* user); + Membership* AddUser(User* user); /** Delete a user pointer to the internal reference list * @param user The user to delete @@ -278,21 +206,6 @@ class CoreExport Channel : public Extensible */ unsigned long DelUser(User* user); - /** Delete a user pointer to the internal reference list of opped users - * @param user The user to delete - */ - void DelOppedUser(User* user); - - /** Delete a user pointer to the internal reference list of halfopped users - * @param user The user to delete - */ - void DelHalfoppedUser(User* user); - - /** Delete a user pointer to the internal reference list of voiced users - * @param user The user to delete - */ - void DelVoicedUser(User* user); - /** Obtain the internal reference list * The internal reference list contains a list of User*. * These are used for rapid comparison to determine @@ -302,22 +215,7 @@ class CoreExport Channel : public Extensible * * @return This function returns pointer to a map of User pointers (CUList*). */ - CUList* GetUsers(); - - /** Obtain the internal reference list of opped users - * @return This function returns pointer to a map of User pointers (CUList*). - */ - CUList* GetOppedUsers(); - - /** Obtain the internal reference list of halfopped users - * @return This function returns pointer to a map of User pointers (CUList*). - */ - CUList* GetHalfoppedUsers(); - - /** Obtain the internal reference list of voiced users - * @return This function returns pointer to a map of User pointers (CUList*). - */ - CUList* GetVoicedUsers(); + const UserMembList* GetUsers(); /** Returns true if the user given is on the given channel. * @param The user to look for @@ -325,6 +223,8 @@ class CoreExport Channel : public Extensible */ bool HasUser(User* user); + Membership* GetUser(User* user); + /** 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) @@ -341,7 +241,7 @@ class CoreExport Channel : public Extensible * @return The number of users left on the channel. If this is zero * when the method returns, you MUST delete the Channel immediately! */ - long ServerKickUser(User* user, const char* reason, bool triggerevents, const char* servername = NULL); + long ServerKickUser(User* user, const char* reason, const std::string& servername = ""); /** Part a user from this channel with the given reason. * If the reason field is NULL, no reason will be sent. @@ -361,7 +261,7 @@ class CoreExport Channel : public Extensible * 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 Channel* JoinUser(InspIRCd* ServerInstance, User *user, const char* cn, bool override, const char* key, bool bursting, time_t TS = 0); + static Channel* JoinUser(User *user, const char* cn, bool override, const char* key, bool bursting, time_t TS = 0); /** Write to a channel, from a user, using va_args for text * @param user User whos details to prefix the line with @@ -381,13 +281,13 @@ class CoreExport Channel : public Extensible * @param text A printf-style format string which builds the output line without prefix * @param ... Zero or more POD type */ - void WriteChannelWithServ(const char* ServName, const char* text, ...) CUSTOM_PRINTF(3, 4); + void WriteChannelWithServ(const std::string& ServName, const char* text, ...) CUSTOM_PRINTF(3, 4); /** 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); + void WriteChannelWithServ(const std::string& ServName, const std::string &text); /** Write to all users on a channel except a specific user, using va_args for text. * Internally, this calls WriteAllExcept(). @@ -430,6 +330,8 @@ class CoreExport Channel : public Extensible * @param text A std::string containing the output line without prefix */ void WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const std::string& text); + /** Write a line of text that already includes the source */ + void RawWriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const std::string& text); /** Returns the maximum number of bans allowed to be set on this channel * @return The maximum number of bans allowed @@ -445,28 +347,14 @@ class CoreExport Channel : public Extensible /** Spool the NAMES list for this channel to the given user * @param user The user to spool the NAMES list to - * @param ulist The user list to send, NULL to use the - * channel's default names list of everyone */ - void UserList(User *user, CUList* ulist = NULL); + void UserList(User *user); /** Get the number of invisible users on this channel * @return Number of invisible users */ int CountInvisible(); - /** Get a users status on this channel - * @param user The user to look up - * @return One of STATUS_OP, STATUS_HOP, STATUS_VOICE, or zero. - */ - int GetStatus(User *user); - - /** Get a users status on this channel in a bitmask - * @param user The user to look up - * @return A bitmask containing zero or more of STATUS_OP, STATUS_HOP, STATUS_VOICE - */ - int GetStatusFlags(User *user); - /** Get a users prefix on this channel in a string. * @param user The user to look up * @return A character array containing the prefix string. @@ -514,10 +402,9 @@ class CoreExport Channel : public Extensible * the channel (to grant ops to them) * @param user The user to associate the privilage with * @param prefix The prefix character to associate - * @param prefix_rank The rank (value) of this prefix character * @param adding True if adding the prefix, false when removing */ - void SetPrefix(User* user, char prefix, unsigned int prefix_rank, bool adding); + void SetPrefix(User* user, char prefix, bool adding); /** Check if a user is banned on this channel * @param user A user to check against the banlist @@ -525,16 +412,13 @@ class CoreExport Channel : public Extensible */ bool IsBanned(User* user); - /** Check whether an extban of a given type matches - * a given user for this channel. - * @param u The user to match bans against - * @param type The type of extban to check + /** Check a single ban for match */ - bool IsExtBanned(User *u, char type); + bool CheckBan(User* user, const std::string& banmask); - /** Overloaded version to check whether a particular string is extbanned + /** Get the status of an "action" type extban */ - bool IsExtBanned(const std::string &str, char type); + ModResult GetExtBanStatus(User *u, char type); /** Clears the cached max bans value */