-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ * 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 program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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 "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 */
-};
+#ifndef CHANNELS_H
+#define CHANNELS_H
-/* Forward declarations - needed */
-class User;
-struct ModResult;
+#include "membership.h"
+#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.
*/
-class HostItem : public classbase
+class HostItem
{
public:
/** Time the item was added
{
};
-/** 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.
*/
-class CoreExport Channel : public Extensible
+class CoreExport Channel : public Extensible, public InviteBase
{
/** Connect a Channel to a User
*/
- static Channel* ForceChan(InspIRCd* Instance, Channel* Ptr, User* user, const std::string &privs, bool bursting, bool created);
+ static Channel* ForceChan(Channel* Ptr, User* user, const std::string &privs, bool bursting, bool created);
/** Set default modes for the channel on creation
*/
*/
int maxbans;
- public:
- /** Pointer to creator object
+ /** 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.
*/
- InspIRCd* ServerInstance;
+ 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.
*/
- Channel(InspIRCd* Instance, const std::string &name, time_t ts);
+ Channel(const std::string &name, time_t ts);
/** 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
/** 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 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.
* @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);
/** Sets the channel topic.
* @param u The user setting the topic
* @param user The user to delete
* @return number of users left on the channel after deletion of the user
*/
- unsigned long DelUser(User* user);
+ void DelUser(User* user);
/** Obtain the internal reference list
* The internal reference list contains a list of User*.
const UserMembList* GetUsers();
/** Returns true if the user given is on the given channel.
- * @param The user to look for
+ * @param user The user to look for
* @return True if the user is on this channel
*/
bool HasUser(User* user);
* @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!
*/
- long 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!
- */
- long ServerKickUser(User* user, const char* reason, const char* servername = NULL);
+ void KickUser(User *src, User *user, const char* 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 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, std::string &reason);
+ void 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 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.
+ * 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
/** 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.
+ * 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
* 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.
+ * 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
*/
/** 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.
+ * 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
* 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
+ * @return True if a change was made
*/
- void SetPrefix(User* user, char prefix, unsigned int prefix_rank, 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
*/
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
*/
- ModResult GetExtBanStatus(User *u, char type);
+ bool CheckBan(User* user, const std::string& banmask);
- /** Overloaded version to check whether a particular string is extbanned
+ /** Get the status of an "action" type extban
*/
- ModResult GetExtBanStatus(const std::string &str, char type);
+ ModResult GetExtBanStatus(User *u, char type);
/** Clears the cached max bans value
*/
void ResetMaxBans();
-
- /** Destructor for Channel
- */
- virtual ~Channel() { /* stub */ }
};
#endif
projects / user / henk / code / inspircd.git / blobdiff