X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=be872b7fe7bb55dca3cda73d5e466835a4e4294a;hb=754f0130893bacb2b69a32c3de9ed1b3da9659cd;hp=daf8be9e2a2e4ac561705a19191b005fc3ab0b0b;hpb=74ccc28da30896ee715504d53822f7b3ce6ec86f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index daf8be9e2..be872b7fe 100644 --- a/include/channels.h +++ b/include/channels.h @@ -24,6 +24,7 @@ #include "membership.h" #include "mode.h" +#include "parammode.h" /** 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. @@ -33,33 +34,32 @@ * 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, public InviteBase +class CoreExport Channel : public Extensible { + public: + /** A map of Memberships on a channel keyed by User pointers + */ + typedef std::map > MemberMap; + + private: /** Set default modes for the channel on creation */ void SetDefaultModes(); /** 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 - * for mode +A, index 0. Use modechar-65 to calculate which - * field to check. + * It is a bitset where each item in it represents if a mode is set. + * To see if a mode is set, inspect modes[mh->modeid] */ - std::bitset<64> modes; - - /** Parameters for custom modes. - * One for each custom mode letter. - */ - CustomModeList custom_mode_params; + std::bitset modes; /** Remove the given membership from the channel's internal map of * memberships and destroy the Membership object. * This function does not remove the channel from User::chanlist. * Since the parameter is an iterator to the target, the complexity * of this function is constant. - * @param membiter The UserMembIter to remove, must be valid + * @param membiter The MemberMap iterator to remove, must be valid */ - void DelUser(const UserMembIter& membiter); + void DelUser(const MemberMap::iterator& membiter); public: /** Creates a channel record and initialises it with default values @@ -90,7 +90,7 @@ class CoreExport Channel : public Extensible, public InviteBase /** User list. */ - UserMembList userlist; + MemberMap userlist; /** Channel topic. * If this is an empty string, no channel topic is set. @@ -113,18 +113,11 @@ class CoreExport Channel : public Extensible, public InviteBase */ void SetMode(ModeHandler* mode, bool value); - /** 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. - * If it is empty, the mode is unset; if it is nonempty, the mode is set. - */ - void SetModeParam(ModeHandler* mode, const 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 */ - inline bool IsModeSet(ModeHandler* mode) { return modes[mode->GetModeChar()-'A']; } + bool IsModeSet(ModeHandler* mode) { return ((mode->GetId() != ModeParser::MODEID_MAX) && (modes[mode->GetId()])); } bool IsModeSet(ModeHandler& mode) { return IsModeSet(&mode); } bool IsModeSet(ChanModeReference& mode); @@ -140,12 +133,16 @@ class CoreExport Channel : public Extensible, public InviteBase */ std::string GetModeParameter(ModeHandler* mode); std::string GetModeParameter(ChanModeReference& mode); + std::string GetModeParameter(ParamModeBase* pm); /** Sets the channel topic. * @param user The user setting the topic. * @param topic The topic to set it to. + * @param topicts Timestamp of the new topic. + * @param setter Setter string, may be used when the original setter is no longer online. + * If omitted or NULL, the setter string is obtained from the user. */ - void SetTopic(User* user, const std::string& topic); + void SetTopic(User* user, const std::string& topic, time_t topicts, const std::string* setter = NULL); /** Obtain the channel "user counter" * This returns the number of users on this channel @@ -178,7 +175,7 @@ class CoreExport Channel : public Extensible, public InviteBase * * @return This function returns pointer to a map of User pointers (CUList*). */ - const UserMembList* GetUsers() const { return &userlist; } + const MemberMap& GetUsers() const { return userlist; } /** Returns true if the user given is on the given channel. * @param user The user to look for @@ -190,18 +187,30 @@ class CoreExport Channel : public Extensible, public InviteBase /** 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) + * @param victimiter Iterator to the user being kicked, must be valid + * @param reason The reason for the kick + */ + void KickUser(User* src, const MemberMap::iterator& victimiter, const std::string& reason); + + /** Make src kick user from this channel with the given reason. + * @param src The source of the kick + * @param user The user being kicked * @param reason The reason for the kick - * @param srcmemb The membership of the user who does the kick, can be NULL */ - void KickUser(User* src, User* user, const std::string& reason, Membership* srcmemb = NULL); + void KickUser(User* src, User* user, const std::string& reason) + { + MemberMap::iterator it = userlist.find(user); + if (it != userlist.end()) + KickUser(src, it, reason); + } /** Part a user from this channel with the given reason. * If the reason field is NULL, no reason will be sent. * @param user The user who is parting (must be on this channel) * @param reason The part reason + * @return True if the user was on the channel and left, false if they weren't and nothing happened */ - void PartUser(User *user, std::string &reason); + bool PartUser(User* user, std::string& reason); /** Join a local user to a channel, with or without permission checks. May be a channel that doesn't exist yet. * @param user The user to join to the channel. @@ -219,8 +228,9 @@ class CoreExport Channel : public Extensible, public InviteBase * @param privs Priviliges (prefix mode letters) to give to this user, may be NULL * @param bursting True if this join is the result of a netburst (passed to modules in the OnUserJoin hook) * @param created_by_local True if this channel was just created by a local user (passed to modules in the OnUserJoin hook) + * @return A newly created Membership object, or NULL if the user was already inside the channel or if the user is a server user */ - void ForceJoin(User* user, const std::string* privs = NULL, bool bursting = false, bool created_by_local = false); + Membership* ForceJoin(User* user, const std::string* privs = NULL, bool bursting = false, bool created_by_local = false); /** Write to a channel, from a user, using va_args for text * @param user User whos details to prefix the line with @@ -299,19 +309,6 @@ class CoreExport Channel : public Extensible, public InviteBase */ const char* ChanModes(bool showkey); - /** Spool the NAMES list for this channel to the given user - * @param user The user to spool the NAMES list to - */ - void UserList(User *user); - - /** Return all of a users mode prefixes into a char* string. - * @param user The user to look up - * @return A list of all prefix characters. The prefixes will always - * be in rank order, greatest first, as certain IRC clients require - * this when multiple prefixes are used names lists. - */ - const char* GetAllPrefixChars(User* user); - /** Get the value of a users prefix on this channel. * @param user The user to look up * @return The module or core-defined value of the users prefix. @@ -338,6 +335,11 @@ class CoreExport Channel : public Extensible, public InviteBase /** Get the status of an "action" type extban */ ModResult GetExtBanStatus(User *u, char type); + + /** Write a NOTICE to all local users on the channel + * @param text Text to send + */ + void WriteNotice(const std::string& text); }; inline bool Channel::HasUser(User* user) @@ -352,6 +354,23 @@ inline std::string Channel::GetModeParameter(ChanModeReference& mode) return GetModeParameter(*mode); } +inline std::string Channel::GetModeParameter(ModeHandler* mh) +{ + std::string out; + ParamModeBase* pm = mh->IsParameterMode(); + if (pm && this->IsModeSet(pm)) + pm->GetParameter(this, out); + return out; +} + +inline std::string Channel::GetModeParameter(ParamModeBase* pm) +{ + std::string out; + if (this->IsModeSet(pm)) + pm->GetParameter(this, out); + return out; +} + inline bool Channel::IsModeSet(ChanModeReference& mode) { if (!mode)