-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * Copyright (C) 2013-2016, 2018 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012-2013, 2017-2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2003-2006, 2008, 2010 Craig Edwards <brain@inspircd.org>
*
- * ---------------------------------------------------
+ * 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/>.
*/
-#ifndef __CHANNELS_H__
-#define __CHANNELS_H__
-
-#include "inspircd_config.h"
-#include "base.h"
-#include <time.h>
-#include <vector>
-#include <string>
-#include <map>
-/** RFC1459 channel modes
- */
-enum ChannelModes {
- CM_TOPICLOCK = 't'-65,
- CM_NOEXTERNAL = 'n'-65,
- CM_INVITEONLY = 'i'-65,
- CM_MODERATED = 'm'-65,
- CM_SECRET = 's'-65,
- CM_PRIVATE = 'p'-65,
- CM_KEY = 'k'-65,
- CM_LIMIT = 'l'-65
-};
+#pragma once
-class userrec;
+#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 */ }
-};
-
-/** A subclass of HostItem designed to hold channel bans (+b)
- */
-class BanItem : public HostItem
-{
-};
-
-/** A subclass of HostItem designed to hold channel exempts (+e)
- */
-class ExemptItem : public HostItem
-{
-};
-
-/** A subclass of HostItem designed to hold channel invites (+I)
+/** 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 InviteItem : public HostItem
+class CoreExport Channel : public Extensible
{
-};
-
-/** Holds a complete ban list
- */
-typedef std::vector<BanItem> BanList;
-
-/** Holds a complete exempt list
- */
-typedef std::vector<ExemptItem> ExemptList;
-
-/** Holds a complete invite list
- */
-typedef std::vector<InviteItem> InviteList;
+ public:
+ /** A map of Memberships on a channel keyed by User pointers
+ */
+ typedef std::map<User*, insp::aligned_storage<Membership> > MemberMap;
-/** A list of users on a channel
- */
-typedef std::map<userrec*,userrec*> CUList;
+ private:
+ /** Set default modes for the channel on creation
+ */
+ void SetDefaultModes();
-/** A list of custom modes parameters on a channel
- */
-typedef std::map<char,char*> CustomModeList;
+ /** 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;
+
+ /** 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);
-/** 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 Extensible
-{
public:
- /** The channels name.
+ /** 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
*/
- char name[CHANMAX]; /* channel name */
- /** Modes for the channel.
- * This is not a null terminated string! It is a hash 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.
+ Channel(const std::string &name, time_t ts);
+
+ /** 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.
*/
- char modes[64];
+ void CheckDestroy();
- /** 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.
+ /** The channel's name.
*/
- CUList internal_userlist;
- CUList internal_op_userlist;
- CUList internal_halfop_userlist;
- CUList internal_voice_userlist;
+ std::string name;
+
+ /** Time that the object was instantiated (used for TS calculation etc)
+ */
+ time_t age;
- /** Parameters for custom modes
+ /** User list.
*/
- CustomModeList custom_mode_params;
+ MemberMap userlist;
/** Channel topic.
* If this is an empty string, no channel topic is set.
*/
- char topic[MAXTOPIC];
- /** 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.
- */
- short int limit;
-
- /** Contains the channel key.
- * If this value is an empty string, there is no channel key in place.
- */
- char key[32];
-
- /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
- */
- //char binarymodes;
-
- /** 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
+ * @param value True if you want to set the mode or false if you want to remove it
*/
- void SetCustomMode(char mode,bool mode_on);
+ void SetMode(ModeHandler* mode, bool value);
- /** Sets or unsets the parameters for a custom mode in a 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
- */
- void SetCustomModeParam(char mode,char* parameter,bool mode_on);
-
/** 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);
+ 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
+ * '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(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.
+ * @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, time_t topicts, const std::string* setter = NULL);
/** Obtain the channel "user counter"
- * This returns the channel reference counter, which is initialized
- * to 0 when the channel is created and incremented/decremented
- * upon joins, parts quits and kicks.
+ * This returns the number of users on this channel
*
* @return The number of users on this channel
*/
- long GetUserCounter();
+ 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.
*/
- void AddUser(userrec* user);
- void AddOppedUser(userrec* user);
- void AddHalfoppedUser(userrec* user);
- void AddVoicedUser(userrec* user);
+ Membership* AddUser(User* user);
- /** Delete a user pointer to the internal reference list
+ /** Delete a user pointer to the internal reference list
* @param user The user to delete
- * @return number of users left on the channel
- */
- unsigned long DelUser(userrec* user);
- void DelOppedUser(userrec* user);
- void DelHalfoppedUser(userrec* user);
- void DelVoicedUser(userrec* user);
+ */
+ void DelUser(User* user);
/** Obtain the internal reference list
- * The internal reference list contains a list of userrec*.
+ * 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 userrec pointers (CUList*).
+ * @return This function returns pointer to a map of User pointers (CUList*).
*/
- CUList* GetUsers();
- CUList* GetOppedUsers();
- CUList* GetHalfoppedUsers();
- CUList* GetVoicedUsers();
+ 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
*/
- bool HasUser(userrec* user);
+ bool HasUser(User* user);
- /** Creates a channel record and initialises it with default values
+ 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
*/
- chanrec();
+ void KickUser(User* src, const MemberMap::iterator& victimiter, const std::string& reason);
- /** Destructor for chanrec
+ /** 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
*/
- virtual ~chanrec() { /* stub */ }
-};
+ 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
+ */
+ 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.
+ * @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 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);
-/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
- * needs to come AFTER struct chanrec */
-enum UserChannelModes {
- UCMODE_OP = 1,
- UCMODE_VOICE = 2,
- UCMODE_HOP = 4
-};
-
-/** 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.
+ /** 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 except_list List of users not to send to
*/
- char 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 Write(ClientProtocol::Event& protoev, char status = 0, const CUList& except_list = CUList());
+
+ /** 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 List of users not to send to
*/
- chanrec *channel;
+ void Write(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg, char status = 0, const CUList& except_list = CUList());
- /** Constructor for ucrec
+ /** Return the channel's modes with parameters.
+ * @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 showsecret);
+
+ /** 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.
*/
- ucrec() : uc_modes(0), channel(NULL) { /* stub */ }
+ unsigned int GetPrefixValue(User* user);
- /** Destructor for ucrec
+ /** 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
*/
- virtual ~ucrec() { /* stub */ }
+ bool IsBanned(User* user);
+
+ /** Check a single ban for match
+ */
+ bool CheckBan(User* user, const std::string& banmask);
+
+ /** 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);
};
-chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override);
-chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local);
-void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason);
-void server_kick_channel(userrec* user, chanrec* Ptr, char* reason, bool triggerevents);
+inline bool Channel::HasUser(User* user)
+{
+ return (userlist.find(user) != userlist.end());
+}
-#endif
+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