X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=2aff3f7a87f5f9e6da81b5da30bda0077ab62988;hb=3624c137a6db85eaab0372550c9dca79d6d21e55;hp=aa23d881664418b523077ca382bc01921c8d0dcf;hpb=bfaf7e3b27981a5144faba6d17c6e29fac735dbb;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index aa23d8816..2aff3f7a8 100644 --- a/include/channels.h +++ b/include/channels.h @@ -1,191 +1,99 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2003-2007 Craig Edwards * - * 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 . */ -#ifndef __CHANNELS_H__ -#define __CHANNELS_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 */ -}; +#pragma once -/* Forward declarations - needed */ -class User; +#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 -{ - public: - /** Time the item was added - */ - time_t set_time; - /** Who added the item - */ - char set_by[NICKMAX]; - /** The actual item data - */ - char data[MAXBUF]; - - HostItem() { /* stub */ } - virtual ~HostItem() { /* stub */ } -}; - -/** A subclass of HostItem designed to hold channel bans (+b) - */ -class BanItem : public HostItem -{ -}; - -/** Holds a complete ban list - */ -typedef std::vector BanList; - -/** A list of users on a channel - */ -typedef std::map CUList; - -/** Shorthand for CUList::iterator - */ -typedef CUList::iterator CUListIter; - -/** Shorthand for CUList::const_iterator - */ -typedef CUList::const_iterator CUListConstIter; - -/** A list of custom modes parameters on a channel - */ -typedef std::map 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 */ -}; - -/** A stored prefix and its rank - */ -typedef std::pair prefixtype; - -/** A list of prefixes set on a user in a channel - */ -typedef std::vector pfxcontainer; - -/** A list of users with zero or more prefixes set on them - */ -typedef std::map > 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 +class CoreExport Channel : public Extensible, public InviteBase { - 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); - /** 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; - - 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); - - /** The channel's name. - */ - char name[CHANMAX]; - /** 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]; + std::bitset<64> modes; - /** 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. + /** Parameters for custom modes. + * One for each custom mode letter. */ - CUList internal_userlist; + CustomModeList custom_mode_params; - /** 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. + /** 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 UserMembIter to remove, must be valid */ - CUList internal_op_userlist; + void DelUser(const UserMembIter& membiter); - /** 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. + public: + /** Creates a channel record and initialises it with default values + * @throw Nothing at present. */ - CUList internal_halfop_userlist; + Channel(const std::string &name, time_t ts); - /** 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. + /** 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. */ - CUList internal_voice_userlist; + void CheckDestroy(); - /** Parameters for custom modes. - * One for each custom mode letter. + /** The channel's name. */ - CustomModeList custom_mode_params; + std::string name; - /** Channel topic. - * If this is an empty string, no channel topic is set. + /** Time that the object was instantiated (used for TS calculation etc) + */ + time_t age; + + /** User list. */ - char topic[MAXTOPIC]; + UserMembList userlist; - /** Creation time. - * This is a timestamp (TS) value. + /** Channel topic. + * If this is an empty string, no channel topic is set. */ - time_t created; + std::string topic; /** Time topic was set. * If no topic was ever set, this will be equal to Channel::created @@ -195,61 +103,57 @@ class CoreExport Channel : public Extensible /** 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 + * @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 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(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 */ - bool IsModeSet(char mode); + 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 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 - * 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(); + long GetUserCounter() const { return userlist.size(); } /** Add a user pointer to the internal reference list * @param user The user to add @@ -258,43 +162,13 @@ class CoreExport Channel : public Extensible * 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 * @return number of users left on the channel after deletion of the user */ - 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); + void DelUser(User* user); /** Obtain the internal reference list * The internal reference list contains a list of User*. @@ -305,73 +179,56 @@ class CoreExport Channel : public Extensible * * @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() const { return &userlist; } /** 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); + 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) * @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! + * @param srcmemb The membership of the user who does the kick, can be NULL */ - long ServerKickUser(User* user, const char* reason, bool triggerevents); + void KickUser(User* src, User* user, const std::string& reason, Membership* srcmemb = NULL); /** 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 - * @return The number of users left on the channel. If this is zero - * when the method returns, you MUST delete the Channel immediately! + * @param reason The part reason */ - long PartUser(User *user, const char* reason = NULL); + void PartUser(User *user, std::string &reason); - /* Join a user to a channel. May be a channel that doesnt exist yet. + /** 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 cn The channel name to join to. Does not have to exist. + * @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 may be NULL. + * If the user could not be joined to a channel, the return value is 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(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 True if this channel was just created by a local user (passed to modules in the OnUserJoin hook) + */ + void 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, ...); + 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 @@ -384,41 +241,41 @@ class CoreExport Channel : public Extensible * @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, ...); + 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 */ - void WriteAllExceptSender(User* user, bool serversource, char status, const char* text, ...); + 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. + * 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, ...); + 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. + * 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 */ @@ -427,48 +284,26 @@ class CoreExport Channel : public Extensible /** 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 */ void WriteAllExcept(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 - */ - long GetMaxBans(); + /** 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 */ - char* ChanModes(bool showkey); + const char* ChanModes(bool showkey); /** 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); - - /** 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); + void UserList(User *user); /** Get a users prefix on this channel in a string. * @param user The user to look up @@ -504,23 +339,16 @@ class CoreExport Channel : public Extensible */ unsigned int GetPrefixValue(User* user); - /** This method removes all prefix characters from a user. - * It will not inform the user or the channel of the removal of prefixes, - * and should be used when the user parts or quits. - * @param user The user to remove all prefixes from - */ - void RemoveAllPrefixes(User* user); - /** Add a prefix character to a user. * Only the core should call this method, usually from * within the mode parser or when the first user joins * 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 @@ -528,13 +356,16 @@ class CoreExport Channel : public Extensible */ bool IsBanned(User* user); - /** Clears the cached max bans value + /** Check a single ban for match */ - void ResetMaxBans(); + bool CheckBan(User* user, const std::string& banmask); - /** Destructor for Channel + /** Get the status of an "action" type extban */ - virtual ~Channel() { /* stub */ } + ModResult GetExtBanStatus(User *u, char type); }; -#endif +inline bool Channel::HasUser(User* user) +{ + return (userlist.find(user) != userlist.end()); +}