* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2010 InspIRCd Development Team
* See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
#define __CHANNELS_H__
#include "membership.h"
-
-/** RFC1459 channel modes
- */
-enum ChannelModes {
- CM_TOPICLOCK = 't'-65, /* +t: Only operators can change topic */
- CM_NOEXTERNAL = 'n'-65, /* +n: Only users in the channel can message it */
- CM_INVITEONLY = 'i'-65, /* +i: Invite only */
- CM_MODERATED = 'm'-65, /* +m: Only voices and above can talk */
- CM_SECRET = 's'-65, /* +s: Secret channel */
- CM_PRIVATE = 'p'-65, /* +p: Private channel */
- CM_KEY = 'k'-65, /* +k: Keyed channel */
- CM_LIMIT = 'l'-65 /* +l: Maximum user limit */
-};
-
-/* Forward declarations - needed */
-class User;
-struct ModResult;
+#include "mode.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.
{
};
-/** Holds a complete ban list
- */
-typedef std::list<BanItem> BanList;
-
-/** A list of custom modes parameters on a channel
- */
-typedef std::map<char,std::string> CustomModeList;
-
-/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
- */
-enum UserChannelModes {
- UCMODE_OP = 1, /* Opped user */
- UCMODE_VOICE = 2, /* Voiced user */
- UCMODE_HOP = 4 /* Halfopped user */
-};
-
/** 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.
*/
int maxbans;
+ /** 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.
+ */
+ std::bitset<64> modes;
+
+ /** Parameters for custom modes.
+ * One for each custom mode letter.
+ */
+ CustomModeList custom_mode_params;
+
public:
/** Creates a channel record and initialises it with default values
* @throw Nothing at present.
/** The channel's name.
*/
- std::string name; /* CHANMAX */
+ std::string name;
/** 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 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.
- */
- std::bitset<64> modes;
-
/** User list.
*/
UserMembList userlist;
- /** Parameters for custom modes.
- * One for each custom mode letter.
- */
- CustomModeList custom_mode_params;
-
/** Channel topic.
* If this is an empty string, no channel topic is set.
*/
- std::string topic; /* MAXTOPIC */
+ std::string topic;
/** Time topic was set.
* If no topic was ever set, this will be equal to Channel::created
* @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(ModeHandler* mode, bool value);
void SetMode(char mode,bool mode_on);
/** Sets or unsets a custom mode in the channels info
* @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, std::string parameter);
+ 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']; }
/** Returns the parameter for a custom mode on a channel.
* @return The parameter for this mode is returned, or an empty string
*/
std::string GetModeParameter(char mode);
+ std::string GetModeParameter(ModeHandler* mode);
/** Sets the channel topic.
* @param u The user setting the topic
* @param src The source of the kick
* @param user The user being kicked (must be on this channel)
* @param reason The reason for the kick
- * @return The number of users left on the channel. If this is zero
- * when the method returns, you MUST delete the Channel immediately!
*/
void KickUser(User *src, User *user, const char* reason);
- /** Make the server kick user from this channel with the given reason.
- * @param user The user being kicked (must be on this channel)
- * @param reason The reason for the kick
- * @param triggerevents True if you wish this kick to trigger module events
- * @return The number of users left on the channel. If this is zero
- * when the method returns, you MUST delete the Channel immediately!
- */
- void 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 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!
*/
void PartUser(User *user, std::string &reason);
* @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
*/
- void SetPrefix(User* user, char prefix, bool adding);
+ 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
/** Clears the cached max bans value
*/
void ResetMaxBans();
-
- /** Destructor for Channel
- */
- virtual ~Channel() { /* stub */ }
};
#endif
projects / user / henk / code / inspircd.git / blobdiff