X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=37f0eb431f4ae0dd271736d8d4544875e46c0d92;hb=173bc63cb59bbf19e73d1b823e3e9423c9f79860;hp=4fb3e48dc8117149b493050263bb991016364a53;hpb=f2cdf27dd9c45f91f4184b81ea3b9be7c5d88173;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index 4fb3e48dc..37f0eb431 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,24 +34,17 @@ * 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 InviteBase { /** 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. @@ -63,7 +57,9 @@ class CoreExport Channel : public Extensible, public InviteBase public: /** Creates a channel record and initialises it with default values - * @throw Nothing at present. + * @param name The name of the channel + * @param ts The creation time of the channel + * @throw CoreException if this channel name is in use */ Channel(const std::string &name, time_t ts); @@ -111,21 +107,13 @@ 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); - void SetModeParam(char 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(char mode) { return modes[mode-'A']; } - 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); /** Returns the parameter for a custom mode on a channel. * @param mode The mode character you wish to query @@ -137,8 +125,9 @@ class CoreExport Channel : public Extensible, public InviteBase * * @return The parameter for this mode is returned, or an empty string */ - std::string GetModeParameter(char mode); 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. @@ -177,7 +166,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 UserMembList& GetUsers() const { return userlist; } /** Returns true if the user given is on the given channel. * @param user The user to look for @@ -189,11 +178,22 @@ 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 - * @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, const UserMembIter& 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 + */ + void KickUser(User* src, User* user, const std::string& reason) + { + UserMembIter 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. @@ -218,8 +218,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 @@ -300,29 +301,9 @@ class CoreExport Channel : public Extensible, public InviteBase /** Spool the NAMES list for this channel to the given user * @param user The user to spool the NAMES list to + * @param isinside If true, the user is inside the channel, if not then false */ - void UserList(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. - * Unlike GetStatus and GetStatusFlags which will only return the - * core specified modes @, % and + (op, halfop and voice), GetPrefixChar - * will also return module-defined prefixes. If the user has to prefix, - * an empty but non-null string is returned. If the user has multiple - * prefixes, the highest is returned. If you do not recognise the prefix - * character you can get, you can deal with it in a 'proprtional' manner - * compared to known prefixes, using GetPrefixValue(). - */ - const char* GetPrefixChar(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); + void UserList(User* user, bool isinside = true); /** Get the value of a users prefix on this channel. * @param user The user to look up @@ -337,17 +318,6 @@ class CoreExport Channel : public Extensible, public InviteBase */ unsigned int GetPrefixValue(User* user); - /** Add a prefix character to a user. - * Only the core should call this method, usually from - * within the mode parser or when the first user joins - * the channel (to grant ops to them) - * @param user The user to associate the privilage with - * @param prefix The prefix character to associate - * @param adding True if adding the prefix, false when removing - * @return True if a change was made - */ - bool 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 * @returns True if the user given is banned @@ -367,3 +337,34 @@ inline bool Channel::HasUser(User* user) { return (userlist.find(user) != userlist.end()); } + +inline std::string Channel::GetModeParameter(ChanModeReference& mode) +{ + if (!mode) + return ""; + 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) + return false; + return IsModeSet(*mode); +}