* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
#ifndef __CHANNELS_H__
#define __CHANNELS_H__
+#include "membership.h"
+
/** RFC1459 channel modes
*/
enum ChannelModes {
/* Forward declarations - needed */
class User;
+struct ModResult;
/** 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
+class HostItem
{
public:
/** Time the item was added
time_t set_time;
/** Who added the item
*/
- char set_by[64];
+ std::string set_by;
/** The actual item data
*/
- char data[MAXBUF];
+ std::string data;
HostItem() { /* stub */ }
virtual ~HostItem() { /* stub */ }
/** Holds a complete ban list
*/
-typedef std::vector<BanItem> BanList;
-
-/** A list of users on a channel
- */
-typedef std::map<User*,std::string> CUList;
-
-/** Shorthand for CUList::iterator
- */
-typedef CUList::iterator CUListIter;
-
-/** Shorthand for CUList::const_iterator
- */
-typedef CUList::const_iterator CUListConstIter;
+typedef std::list<BanItem> BanList;
/** A list of custom modes parameters on a channel
*/
-typedef std::map<char,char*> CustomModeList;
-
+typedef std::map<char,std::string> CustomModeList;
/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
*/
UCMODE_HOP = 4 /* Halfopped user */
};
-/** A stored prefix and its rank
- */
-typedef std::pair<char, unsigned int> prefixtype;
-
-/** A list of prefixes set on a user in a channel
- */
-typedef std::vector<prefixtype> pfxcontainer;
-
-/** A list of users with zero or more prefixes set on them
- */
-typedef std::map<User*, std::vector<prefixtype> > prefixlist;
-
/** Holds all relevent information for a channel.
- * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
+ * 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
{
- private:
-
- /** Pointer to creator object
- */
- InspIRCd* ServerInstance;
-
/** Connect a Channel to a User
*/
- static Channel* ForceChan(InspIRCd* Instance, Channel* Ptr, User* user, const std::string &privs, bool bursting);
+ static Channel* ForceChan(Channel* Ptr, User* user, const std::string &privs, bool bursting, bool created);
/** Set default modes for the channel on creation
*/
void SetDefaultModes();
- /** A list of prefixes associated with each user in the channel
- * (e.g. &%+ etc)
- */
- prefixlist prefixes;
-
/** Maximum number of bans (cached)
*/
int maxbans;
/** Creates a channel record and initialises it with default values
* @throw Nothing at present.
*/
- Channel(InspIRCd* Instance, const std::string &name, time_t ts);
+ Channel(const std::string &name, time_t ts);
/** The channel's name.
*/
- char name[CHANMAX];
+ std::string name; /* CHANMAX */
+
+ /** Time that the object was instantiated (used for TS calculation etc)
+ */
+ time_t age;
/** Modes for the channel.
- * This is not a null terminated string! It is a hash where
+ * 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.
*/
- char modes[64];
-
- /** 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.
- */
- CUList internal_userlist;
-
- /** Opped users.
- * There are four user lists, one for
- * all the users, one for the ops, one for
- * the halfops and another for the voices.
- */
- CUList internal_op_userlist;
+ std::bitset<64> modes;
- /** Halfopped users.
- * There are four user lists, one for
- * all the users, one for the ops, one for
- * the halfops and another for the voices.
+ /** User list.
*/
- CUList internal_halfop_userlist;
-
- /** Voiced users.
- * There are four user lists, one for
- * all the users, one for the ops, one for
- * the halfops and another for the voices.
- */
- CUList internal_voice_userlist;
+ UserMembList userlist;
/** Parameters for custom modes.
* One for each custom mode letter.
/** Channel topic.
* If this is an empty string, no channel topic is set.
*/
- char topic[MAXTOPIC];
-
- /** Creation time.
- * This is a timestamp (TS) value.
- */
- time_t created;
+ std::string topic; /* MAXTOPIC */
/** Time topic was set.
* If no topic was ever set, this will be equal to Channel::created
/** The last user to set the topic.
* If this member is an empty string, no topic was ever set.
*/
- char 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];
+ std::string setby; /* 128 */
/** 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
*/
void SetMode(char mode,bool mode_on);
- /** Sets or unsets the parameters for a custom mode in a channels info
+ /** 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
- * @param mode_on True if you want to set the mode or false if you want to remove it
+ * @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(char mode,const char* parameter,bool mode_on);
-
+ void SetModeParam(char mode, 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
*/
- bool IsModeSet(char mode);
+ inline bool IsModeSet(char mode) { return modes[mode-'A']; }
+
/** Returns the parameter for a custom mode on a channel.
* @param mode The mode character you wish to query
*/
std::string GetModeParameter(char mode);
+ /** Sets the channel topic.
+ * @param u The user setting the topic
+ * @param t The topic to set it to. Non-const, as it may be modified by a hook.
+ * @param forceset If set to true then all access checks will be bypassed.
+ */
+ int SetTopic(User *u, std::string &t, bool forceset = false);
+
/** Obtain the channel "user counter"
* This returns the channel reference counter, which is initialized
* to 0 when the channel is created and incremented/decremented
* an arbitary pointer compared to other users by its memory address,
* as this is a very fast 32 or 64 bit integer comparison.
*/
- void AddUser(User* user);
-
- /** Add a user pointer to the internal reference list of opped users
- * @param user The user to add
- */
- void AddOppedUser(User* user);
-
- /** Add a user pointer to the internal reference list of halfopped users
- * @param user The user to add
- */
- void AddHalfoppedUser(User* user);
-
- /** Add a user pointer to the internal reference list of voiced users
- * @param user The user to add
- */
- void AddVoicedUser(User* user);
+ Membership* AddUser(User* user);
/** Delete a user pointer to the internal reference list
* @param user The user to delete
*/
unsigned long DelUser(User* user);
- /** Delete a user pointer to the internal reference list of opped users
- * @param user The user to delete
- */
- void DelOppedUser(User* user);
-
- /** Delete a user pointer to the internal reference list of halfopped users
- * @param user The user to delete
- */
- void DelHalfoppedUser(User* user);
-
- /** Delete a user pointer to the internal reference list of voiced users
- * @param user The user to delete
- */
- void DelVoicedUser(User* user);
-
/** Obtain the internal reference list
* The internal reference list contains a list of User*.
* These are used for rapid comparison to determine
*
* @return This function returns pointer to a map of User pointers (CUList*).
*/
- CUList* GetUsers();
-
- /** Obtain the internal reference list of opped users
- * @return This function returns pointer to a map of User pointers (CUList*).
- */
- CUList* GetOppedUsers();
-
- /** Obtain the internal reference list of halfopped users
- * @return This function returns pointer to a map of User pointers (CUList*).
- */
- CUList* GetHalfoppedUsers();
-
- /** Obtain the internal reference list of voiced users
- * @return This function returns pointer to a map of User pointers (CUList*).
- */
- CUList* GetVoicedUsers();
+ const UserMembList* GetUsers();
/** Returns true if the user given is on the given channel.
* @param The user to look for
*/
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 user The user being kicked (must be on this channel)
* @return The number of users left on the channel. If this is zero
* when the method returns, you MUST delete the Channel immediately!
*/
- long ServerKickUser(User* user, const char* reason, bool triggerevents, const char* servername = NULL);
+ long ServerKickUser(User* user, const char* reason, const std::string& servername = "");
/** 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 (optional) part reason
+ * @param reason The part reason
* @return The number of users left on the channel. If this is zero
* when the method returns, you MUST delete the Channel immediately!
*/
- long PartUser(User *user, const char* reason = NULL);
+ long PartUser(User *user, std::string &reason);
/* Join a user to a channel. May be a channel that doesnt exist yet.
* @param user The user to join to the channel.
* 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 may be NULL.
*/
- static Channel* JoinUser(InspIRCd* ServerInstance, User *user, const char* cn, bool override, const char* key, bool bursting, time_t TS = 0);
+ static Channel* JoinUser(User *user, const char* cn, bool override, const char* key, bool bursting, time_t TS = 0);
/** 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 type
*/
- void WriteChannelWithServ(const char* ServName, const char* text, ...) CUSTOM_PRINTF(3, 4);
+ 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 char* ServName, const std::string &text);
+ 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 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);
/** Returns the maximum number of bans allowed to be set on this channel
* @return The maximum number of bans allowed
/** Spool the NAMES list for this channel to the given user
* @param user The user to spool the NAMES list to
- * @param ulist The user list to send, NULL to use the
- * channel's default names list of everyone
*/
- void UserList(User *user, CUList* ulist = NULL);
+ void UserList(User *user);
/** Get the number of invisible users on this channel
* @return Number of invisible users
*/
int CountInvisible();
- /** Get a users status on this channel
- * @param user The user to look up
- * @return One of STATUS_OP, STATUS_HOP, STATUS_VOICE, or zero.
- */
- int GetStatus(User *user);
-
- /** Get a users status on this channel in a bitmask
- * @param user The user to look up
- * @return A bitmask containing zero or more of STATUS_OP, STATUS_HOP, STATUS_VOICE
- */
- int GetStatusFlags(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.
* the channel (to grant ops to them)
* @param user The user to associate the privilage with
* @param prefix The prefix character to associate
- * @param prefix_rank The rank (value) of this prefix character
* @param adding True if adding the prefix, false when removing
*/
- void SetPrefix(User* user, char prefix, unsigned int prefix_rank, bool adding);
+ void 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
*/
bool IsBanned(User* user);
- /** Check whether an extban of a given type matches
- * a given user for this channel.
- * @param u The user to match bans against
- * @param type The type of extban to check
+ /** Check a single ban for match
+ */
+ bool CheckBan(User* user, const std::string& banmask);
+
+ /** Get the status of an "action" type extban
*/
- bool IsExtBanned(User *u, char type);
+ ModResult GetExtBanStatus(User *u, char type);
/** Clears the cached max bans value
*/
projects / user / henk / code / inspircd.git / blobdiff