X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=1b44a7be6fa7c5e47509c07c649032277142d8ef;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=37f0eb431f4ae0dd271736d8d4544875e46c0d92;hpb=173bc63cb59bbf19e73d1b823e3e9423c9f79860;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index 37f0eb431..1b44a7be6 100644 --- a/include/channels.h +++ b/include/channels.h @@ -1,10 +1,13 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2013-2016, 2018 Attila Molnar + * Copyright (C) 2012-2013, 2017-2020 Sadie Powell + * Copyright (C) 2012 Robby * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2007 Robin Burchell - * Copyright (C) 2007 Dennis Friis - * Copyright (C) 2003-2007 Craig Edwards + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2007, 2009 Dennis Friis + * Copyright (C) 2003-2006, 2008, 2010 Craig Edwards * * This file is part of InspIRCd. InspIRCd is free software: you can * redistribute it and/or modify it under the terms of the GNU General Public @@ -30,12 +33,18 @@ * This class contains a single element in a channel list, such as a banlist. */ -/** Holds all relevent information for a channel. +/** Holds all relevant information for a channel. * 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(); @@ -51,9 +60,9 @@ class CoreExport Channel : public Extensible, public InviteBase * 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 @@ -84,7 +93,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. @@ -132,21 +141,24 @@ class CoreExport Channel : public Extensible, public InviteBase /** 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 * * @return The number of users on this channel */ - long GetUserCounter() const { return userlist.size(); } + size_t GetUserCounter() const { return userlist.size(); } /** 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, + * an arbitrary pointer compared to other users by its memory address, * as this is a very fast 32 or 64 bit integer comparison. */ Membership* AddUser(User* user); @@ -166,7 +178,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 @@ -181,7 +193,7 @@ class CoreExport Channel : public Extensible, public InviteBase * @param victimiter Iterator to the user being kicked, must be valid * @param reason The reason for the kick */ - void KickUser(User* src, const UserMembIter& victimiter, const std::string& reason); + 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 @@ -190,7 +202,7 @@ class CoreExport Channel : public Extensible, public InviteBase */ void KickUser(User* src, User* user, const std::string& reason) { - UserMembIter it = userlist.find(user); + MemberMap::iterator it = userlist.find(user); if (it != userlist.end()) KickUser(src, it, reason); } @@ -199,8 +211,9 @@ class CoreExport Channel : public Extensible, public InviteBase * 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. @@ -215,95 +228,34 @@ class CoreExport Channel : public Extensible, public InviteBase /** Join a user to an existing channel, without doing any permission checks * @param user The user to join to the channel - * @param privs Priviliges (prefix mode letters) to give to this user, may be NULL + * @param privs Privileges (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 */ 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 - * @param text A printf-style format string which builds the output line without prefix - * @param ... Zero or more POD types - */ - void WriteChannel(User* user, const char* text, ...) CUSTOM_PRINTF(3, 4); - - /** Write to a channel, from a user, using std::string for text - * @param user User whos details to prefix the line with - * @param text A std::string containing the output line without prefix - */ - void WriteChannel(User* user, const std::string &text); - - /** Write to a channel, from a server, using va_args for text - * @param ServName Server name to prefix the line with - * @param text A printf-style format string which builds the output line without prefix - * @param ... Zero or more POD type - */ - 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 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(). - * @param user User whos details to prefix the line with, and to omit from receipt of the message - * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise, - * use the nick!user\@host of the user. + /** Write to all users on a channel except some users + * @param protoev Event to send, may contain any number of messages. * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone - * @param text A printf-style format string which builds the output line without prefix - * @param ... Zero or more POD type + * @param except_list List of users not to send to */ - void WriteAllExceptSender(User* user, bool serversource, char status, const char* text, ...) CUSTOM_PRINTF(5, 6); + void Write(ClientProtocol::Event& protoev, char status = 0, const CUList& except_list = CUList()); - /** Write to all users on a channel except a list of users, using va_args for text - * @param user User whos details to prefix the line with, and to omit from receipt of the message - * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise, - * use the nick!user\@host of the user. + /** Write to all users on a channel except some users. + * @param protoevprov Protocol event provider for the message. + * @param msg Message to send. * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone - * @param except_list A list of users NOT to send the text to - * @param text A printf-style format string which builds the output line without prefix - * @param ... Zero or more POD type + * @param except_list List of users not to send to */ - void WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const char* text, ...) CUSTOM_PRINTF(6, 7); - - /** Write to all users on a channel except a specific user, using std::string for text. - * Internally, this calls WriteAllExcept(). - * @param user User whos details to prefix the line with, and to omit from receipt of the message - * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise, - * use the nick!user\@host of the user. - * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone - * @param text A std::string containing the output line without prefix - */ - void WriteAllExceptSender(User* user, bool serversource, char status, const std::string& text); - - /** Write to all users on a channel except a list of users, using std::string for text - * @param user User whos details to prefix the line with, and to omit from receipt of the message - * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise, - * use the nick!user\@host of the user. - * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone - * @param except_list A list of users NOT to send the text to - * @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); + void Write(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg, char status = 0, const CUList& except_list = CUList()); /** Return the channel's modes with parameters. - * @param showkey If this is set to true, the actual key is shown, - * otherwise it is replaced with '<KEY>' + * @param showsecret If this is set to true, the value of secret parameters + * are shown, otherwise they are replaced with '<name>'. * @return The channel mode string */ - 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 - * @param isinside If true, the user is inside the channel, if not then false - */ - void UserList(User* user, bool isinside = true); + const char* ChanModes(bool showsecret); /** Get the value of a users prefix on this channel. * @param user The user to look up @@ -331,6 +283,13 @@ 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 + * @param status The minimum status rank to send this message to. + */ + void WriteNotice(const std::string& text, char status = 0); + void WriteRemoteNotice(const std::string& text, char status = 0); }; inline bool Channel::HasUser(User* user)