/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2003-2007 Craig Edwards <craigedwards@brainbox.cc>
+ *
+ * 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
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
-$Log$
-Revision 1.2 2003/01/26 23:52:59 brain
-Modified documentation for base classes
-Added base classes
-
-Revision 1.1.1.1 2003/01/23 19:45:58 brain
-InspIRCd second source tree
-
-Revision 1.7 2003/01/22 00:44:26 brain
-Added documentation comments
-
-Revision 1.6 2003/01/21 21:11:17 brain
-Added documentation
-
-Revision 1.5 2003/01/16 20:11:55 brain
-fixed some ugly pointer bugs (thanks dblack and a|KK|y!)
-
-Revision 1.4 2003/01/15 22:47:44 brain
-Changed user and channel structs to classes (finally)
-
-
-*/
-#include "inspircd_config.h"
-#include "base.h"
-#include <time.h>
-#include <vector>
+#pragma once
-#ifndef __CHANNELS_H__
-#define __CHANNELS_H__
+#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.
*/
-class HostItem : public classbase
-{
- public:
- time_t set_time;
- char set_by[NICKMAX];
- char data[MAXBUF];
-
- HostItem() { /* stub */ }
- virtual ~HostItem() { /* stub */ }
-};
-
-// banlist is inherited from HostList mainly for readability
-// reasons only
-/** A subclass of HostItem designed to hold channel bans (+b)
+/** Holds all relevent 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 BanItem : public HostItem
+class CoreExport Channel : public Extensible
{
-};
-
-// same with this...
+ public:
+ /** A map of Memberships on a channel keyed by User pointers
+ */
+ typedef std::map<User*, insp::aligned_storage<Membership> > MemberMap;
-/** A subclass of HostItem designed to hold channel exempts (+e)
- */
-class ExemptItem : public HostItem
-{
-};
+ private:
+ /** Set default modes for the channel on creation
+ */
+ void SetDefaultModes();
-// and this...
+ /** Modes for the channel.
+ * 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<ModeParser::MODEID_MAX> modes;
-/** A subclass of HostItem designed to hold channel invites (+I)
- */
-class InviteItem : public HostItem
-{
-};
+ /** 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 MemberMap iterator to remove, must be valid
+ */
+ void DelUser(const MemberMap::iterator& membiter);
+ public:
+ /** Creates a channel record and initialises it with default values
+ * @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);
-/** Holds a complete ban list
- */
-typedef vector<BanItem> BanList;
+ /** Checks whether the channel should be destroyed, and if yes, begins
+ * the teardown procedure.
+ *
+ * If there are users on the channel or a module vetoes the deletion
+ * (OnPreChannelDelete hook) then nothing else happens.
+ * Otherwise, first the OnChannelDelete event is fired, then the channel is
+ * removed from the channel list. All pending invites are destroyed and
+ * finally the channel is added to the cull list.
+ */
+ void CheckDestroy();
-/** Holds a complete exempt list
- */
-typedef vector<ExemptItem> ExemptList;
+ /** The channel's name.
+ */
+ std::string name;
-/** Holds a complete invite list
- */
-typedef vector<InviteItem> InviteList;
+ /** Time that the object was instantiated (used for TS calculation etc)
+ */
+ time_t age;
-/** 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
-{
- 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.
+ /** User list.
*/
- char custom_modes[MAXMODES]; /* modes handled by modules */
+ MemberMap userlist;
+
/** Channel topic.
* If this is an empty string, no channel topic is set.
*/
- char topic[MAXBUF];
- /** Creation time.
- */
- time_t created;
+ std::string topic;
+
/** Time topic was set.
- * If no topic was ever set, this will be equal to chanrec::created
+ * If no topic was ever set, this will be equal to Channel::created
*/
time_t topicset;
+
/** The last user to set the topic.
* If this member is an empty string, no topic was ever set.
*/
- char setby[NICKMAX];
+ std::string setby; /* 128 */
- /** Contains the channel user limit.
- * If this value is zero, there is no limit in place.
+ /** Sets or unsets a custom mode in the channels info
+ * @param mode The mode character to set or unset
+ * @param value True if you want to set the mode or false if you want to remove it
*/
- long 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.
+ void SetMode(ModeHandler* mode, bool value);
+
+ /** 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(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
+ *
+ * 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(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.
*/
- short int topiclock;
-
- /** Nonzero if the mode +n is set.
+ void SetTopic(User* user, const std::string& topic);
+
+ /** Obtain the channel "user counter"
+ * This returns the number of users on this channel
+ *
+ * @return The number of users on this channel
*/
- short int noexternal;
-
- /** Nonzero if the mode +i is set.
+ long 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,
+ * as this is a very fast 32 or 64 bit integer comparison.
*/
- short int inviteonly;
-
- /** Nonzero if the mode +m is set.
+ Membership* AddUser(User* user);
+
+ /** Delete a user pointer to the internal reference list
+ * @param user The user to delete
+ * @return number of users left on the channel after deletion of the user
*/
- short int moderated;
-
- /** Nonzero if the mode +s is set.
- * This value cannot be set at the same time as chanrec::c_private
+ void DelUser(User* user);
+
+ /** Obtain the internal reference list
+ * The internal reference list contains a list of User*.
+ * 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 User pointers (CUList*).
*/
- short int secret;
-
- /** Nonzero if the mode +p is set.
- * This value cannot be set at the same time as chanrec::secret
+ const MemberMap& GetUsers() const { return userlist; }
+
+ /** Returns true if the user given is on the given channel.
+ * @param user The user to look for
+ * @return True if the user is on this channel
*/
- short int c_private;
-
- /** The list of all bans set on the channel.
+ 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 victimiter Iterator to the user being kicked, must be valid
+ * @param reason The reason for the kick
*/
- BanList bans;
+ void KickUser(User* src, const MemberMap::iterator& victimiter, const std::string& reason);
- /** Creates a channel record and initialises it with default values
+ /** 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
*/
- chanrec()
+ void KickUser(User* src, User* user, const std::string& reason)
{
- strcpy(name,"");
- strcpy(custom_modes,"");
- strcpy(topic,"");
- strcpy(setby,"");
- strcpy(key,"");
- created = topicset = limit = 0;
- topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
+ MemberMap::iterator it = userlist.find(user);
+ if (it != userlist.end())
+ KickUser(src, it, reason);
}
- virtual ~chanrec() { /* stub */ }
-};
+ /** 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
+ */
+ void PartUser(User *user, std::string &reason);
-/* 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
-
-/** Holds a user's modes on a channel
- * This class associates a users privilages with a channel by creating a pointer link between
- * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
- * has on the channel, such as op, voice, etc.
- */
-class ucrec : public classbase
-{
- public:
- /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
- * If this value is zero, the user has no privilages upon the channel.
+ /** 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.
+ * @param channame The channel name to join to. Does not have to exist.
+ * @param key The key of the channel, if given
+ * @param override If true, override all join restrictions such as +bkil
+ * @return A pointer to the Channel the user was joined to. A new Channel may have
+ * 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 is NULL.
+ */
+ static Channel* JoinUser(LocalUser* user, std::string channame, bool override = false, const std::string& key = "");
+
+ /** 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 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
*/
- long uc_modes;
-
- /** Points to the channel record where the given modes apply.
- * If the record is not in use, this value will be NULL.
+ 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.
+ * @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
+ */
+ void WriteAllExceptSender(User* user, bool serversource, char status, const char* text, ...) CUSTOM_PRINTF(5, 6);
+
+ /** 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.
+ * @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
+ */
+ 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);
+
+ /** 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>'
+ * @return The channel mode string
+ */
+ const char* ChanModes(bool showkey);
+
+ /** 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.
+ * The values for op, halfop and voice status are constants in
+ * mode.h, and are OP_VALUE, HALFOP_VALUE, and VOICE_VALUE respectively.
+ * If the value you are given does not match one of these three, it is
+ * a module-defined mode, and it should be compared in proportion to
+ * these three constants. For example a value greater than OP_VALUE
+ * is a prefix of greater 'worth' than ops, and a value less than
+ * VOICE_VALUE is of lesser 'worth' than a voice.
+ */
+ unsigned int GetPrefixValue(User* user);
+
+ /** 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
+ */
+ bool IsBanned(User* user);
+
+ /** Check a single ban for match
*/
- chanrec *channel;
+ bool CheckBan(User* user, const std::string& banmask);
- ucrec() { /* stub */ }
- virtual ~ucrec() { /* stub */ }
+ /** Get the status of an "action" type extban
+ */
+ ModResult GetExtBanStatus(User *u, char type);
};
-#endif
+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);
+}
projects / user / henk / code / inspircd.git / blobdiff