include/channels.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2003-2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #pragma once
  24
  25 #include "membership.h"
  26 #include "mode.h"
  27
  28 /** Holds an entry for a ban list, exemption list, or invite list.
  29  * This class contains a single element in a channel list, such as a banlist.
  30  */
  31
  32 /** Holds all relevent information for a channel.
  33  * This class represents a channel, and contains its name, modes, topic, topic set time,
  34  * etc, and an instance of the BanList type.
  35  */
  36 class CoreExport Channel : public Extensible, public InviteBase
  37 {
  38         /** Connect a Channel to a User
  39          */
  40         static Channel* ForceChan(Channel* Ptr, User* user, const std::string &privs, bool bursting, bool created);
  41
  42         /** Set default modes for the channel on creation
  43          */
  44         void SetDefaultModes();
  45
  46         /** Modes for the channel.
  47          * This is not a null terminated string! It is a bitset where
  48          * each item in it represents if a mode is set. For example
  49          * for mode +A, index 0. Use modechar-65 to calculate which
  50          * field to check.
  51          */
  52         std::bitset<64> modes;
  53
  54         /** Parameters for custom modes.
  55          * One for each custom mode letter.
  56          */
  57         CustomModeList custom_mode_params;
  58
  59  public:
  60         /** Creates a channel record and initialises it with default values
  61          * @throw Nothing at present.
  62          */
  63         Channel(const std::string &name, time_t ts);
  64
  65         /** The channel's name.
  66          */
  67         std::string name;
  68
  69         /** Time that the object was instantiated (used for TS calculation etc)
  70         */
  71         time_t age;
  72
  73         /** User list.
  74          */
  75         UserMembList userlist;
  76
  77         /** Channel topic.
  78          * If this is an empty string, no channel topic is set.
  79          */
  80         std::string topic;
  81
  82         /** Time topic was set.
  83          * If no topic was ever set, this will be equal to Channel::created
  84          */
  85         time_t topicset;
  86
  87         /** The last user to set the topic.
  88          * If this member is an empty string, no topic was ever set.
  89          */
  90         std::string setby; /* 128 */
  91
  92         /** Sets or unsets a custom mode in the channels info
  93          * @param mode The mode character to set or unset
  94          * @param value True if you want to set the mode or false if you want to remove it
  95          */
  96         void SetMode(ModeHandler* mode, bool value);
  97         void SetMode(char mode,bool mode_on);
  98
  99         /** Sets or unsets a custom mode in the channels info
 100          * @param mode The mode character to set or unset
 101          * @param parameter The parameter string to associate with this mode character.
 102          * If it is empty, the mode is unset; if it is nonempty, the mode is set.
 103          */
 104         void SetModeParam(ModeHandler* mode, const std::string& parameter);
 105         void SetModeParam(char mode, const std::string& parameter);
 106
 107         /** Returns true if a mode is set on a channel
 108           * @param mode The mode character you wish to query
 109           * @return True if the custom mode is set, false if otherwise
 110           */
 111         inline bool IsModeSet(char mode) { return modes[mode-'A']; }
 112         inline bool IsModeSet(ModeHandler* mode) { return modes[mode->GetModeChar()-'A']; }
 113
 114
 115         /** Returns the parameter for a custom mode on a channel.
 116           * @param mode The mode character you wish to query
 117           *
 118           * For example if "+L #foo" is set, and you pass this method
 119           * 'L', it will return '\#foo'. If the mode is not set on the
 120           * channel, or the mode has no parameters associated with it,
 121           * it will return an empty string.
 122           *
 123           * @return The parameter for this mode is returned, or an empty string
 124           */
 125         std::string GetModeParameter(char mode);
 126         std::string GetModeParameter(ModeHandler* mode);
 127
 128         /** Sets the channel topic.
 129          * @param u The user setting the topic
 130          * @param t The topic to set it to. Non-const, as it may be modified by a hook.
 131          * @param forceset If set to true then all access checks will be bypassed.
 132          */
 133         int SetTopic(User *u, std::string &t, bool forceset = false);
 134
 135         /** Obtain the channel "user counter"
 136          * This returns the channel reference counter, which is initialized
 137          * to 0 when the channel is created and incremented/decremented
 138          * upon joins, parts quits and kicks.
 139          *
 140          * @return The number of users on this channel
 141          */
 142         long GetUserCounter();
 143
 144         /** Add a user pointer to the internal reference list
 145          * @param user The user to add
 146          *
 147          * The data inserted into the reference list is a table as it is
 148          * an arbitary pointer compared to other users by its memory address,
 149          * as this is a very fast 32 or 64 bit integer comparison.
 150          */
 151         Membership* AddUser(User* user);
 152
 153         /** Delete a user pointer to the internal reference list
 154          * @param user The user to delete
 155          * @return number of users left on the channel after deletion of the user
 156          */
 157         void DelUser(User* user);
 158
 159         /** Obtain the internal reference list
 160          * The internal reference list contains a list of User*.
 161          * These are used for rapid comparison to determine
 162          * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
 163          * The resulting pointer to the vector should be considered
 164          * readonly and only modified via AddUser and DelUser.
 165          *
 166          * @return This function returns pointer to a map of User pointers (CUList*).
 167          */
 168         const UserMembList* GetUsers();
 169
 170         /** Returns true if the user given is on the given channel.
 171          * @param user The user to look for
 172          * @return True if the user is on this channel
 173          */
 174         bool HasUser(User* user);
 175
 176         Membership* GetUser(User* user);
 177
 178         /** Make src kick user from this channel with the given reason.
 179          * @param src The source of the kick
 180          * @param user The user being kicked (must be on this channel)
 181          * @param reason The reason for the kick
 182          */
 183         void KickUser(User *src, User *user, const char* reason);
 184
 185         /** Part a user from this channel with the given reason.
 186          * If the reason field is NULL, no reason will be sent.
 187          * @param user The user who is parting (must be on this channel)
 188          * @param reason The part reason
 189          */
 190         void PartUser(User *user, std::string &reason);
 191
 192         /* Join a user to a channel. May be a channel that doesnt exist yet.
 193          * @param user The user to join to the channel.
 194          * @param channame The channel name to join to. Does not have to exist.
 195          * @param key The key of the channel, if given
 196          * @param override If true, override all join restrictions such as +bkil
 197          * @return A pointer to the Channel the user was joined to. A new Channel may have
 198          * been created if the channel did not exist before the user was joined to it.
 199          * If the user could not be joined to a channel, the return value may be NULL.
 200          */
 201         static Channel* JoinUser(User *user, std::string channame, bool override, const std::string& key, bool bursting, time_t TS = 0);
 202
 203         /** Write to a channel, from a user, using va_args for text
 204          * @param user User whos details to prefix the line with
 205          * @param text A printf-style format string which builds the output line without prefix
 206          * @param ... Zero or more POD types
 207          */
 208         void WriteChannel(User* user, const char* text, ...) CUSTOM_PRINTF(3, 4);
 209
 210         /** Write to a channel, from a user, using std::string for text
 211          * @param user User whos details to prefix the line with
 212          * @param text A std::string containing the output line without prefix
 213          */
 214         void WriteChannel(User* user, const std::string &text);
 215
 216         /** Write to a channel, from a server, using va_args for text
 217          * @param ServName Server name to prefix the line with
 218          * @param text A printf-style format string which builds the output line without prefix
 219          * @param ... Zero or more POD type
 220          */
 221         void WriteChannelWithServ(const std::string& ServName, const char* text, ...) CUSTOM_PRINTF(3, 4);
 222
 223         /** Write to a channel, from a server, using std::string for text
 224          * @param ServName Server name to prefix the line with
 225          * @param text A std::string containing the output line without prefix
 226          */
 227         void WriteChannelWithServ(const std::string& ServName, const std::string &text);
 228
 229         /** Write to all users on a channel except a specific user, using va_args for text.
 230          * Internally, this calls WriteAllExcept().
 231          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 232          * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
 233          * use the nick!user\@host of the user.
 234          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 235          * @param text A printf-style format string which builds the output line without prefix
 236          * @param ... Zero or more POD type
 237          */
 238         void WriteAllExceptSender(User* user, bool serversource, char status, const char* text, ...) CUSTOM_PRINTF(5, 6);
 239
 240         /** Write to all users on a channel except a list of users, using va_args for text
 241          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 242          * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
 243          * use the nick!user\@host of the user.
 244          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 245          * @param except_list A list of users NOT to send the text to
 246          * @param text A printf-style format string which builds the output line without prefix
 247          * @param ... Zero or more POD type
 248          */
 249         void WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const char* text, ...) CUSTOM_PRINTF(6, 7);
 250
 251         /** Write to all users on a channel except a specific user, using std::string for text.
 252          * Internally, this calls WriteAllExcept().
 253          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 254          * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
 255          * use the nick!user\@host of the user.
 256          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 257          * @param text A std::string containing the output line without prefix
 258          */
 259         void WriteAllExceptSender(User* user, bool serversource, char status, const std::string& text);
 260
 261         /** Write to all users on a channel except a list of users, using std::string for text
 262          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 263          * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
 264          * use the nick!user\@host of the user.
 265          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 266          * @param except_list A list of users NOT to send the text to
 267          * @param text A std::string containing the output line without prefix
 268          */
 269         void WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const std::string& text);
 270         /** Write a line of text that already includes the source */
 271         void RawWriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const std::string& text);
 272
 273         /** Return the channel's modes with parameters.
 274          * @param showkey If this is set to true, the actual key is shown,
 275          * otherwise it is replaced with '&lt;KEY&gt;'
 276          * @return The channel mode string
 277          */
 278         char* ChanModes(bool showkey);
 279
 280         /** Spool the NAMES list for this channel to the given user
 281          * @param user The user to spool the NAMES list to
 282          */
 283         void UserList(User *user);
 284
 285         /** Get the number of invisible users on this channel
 286          * @return Number of invisible users
 287          */
 288         int CountInvisible();
 289
 290         /** Get a users prefix on this channel in a string.
 291          * @param user The user to look up
 292          * @return A character array containing the prefix string.
 293          * Unlike GetStatus and GetStatusFlags which will only return the
 294          * core specified modes @, % and + (op, halfop and voice), GetPrefixChar
 295          * will also return module-defined prefixes. If the user has to prefix,
 296          * an empty but non-null string is returned. If the user has multiple
 297          * prefixes, the highest is returned. If you do not recognise the prefix
 298          * character you can get, you can deal with it in a 'proprtional' manner
 299          * compared to known prefixes, using GetPrefixValue().
 300          */
 301         const char* GetPrefixChar(User *user);
 302
 303         /** Return all of a users mode prefixes into a char* string.
 304          * @param user The user to look up
 305          * @return A list of all prefix characters. The prefixes will always
 306          * be in rank order, greatest first, as certain IRC clients require
 307          * this when multiple prefixes are used names lists.
 308          */
 309         const char* GetAllPrefixChars(User* user);
 310
 311         /** Get the value of a users prefix on this channel.
 312          * @param user The user to look up
 313          * @return The module or core-defined value of the users prefix.
 314          * The values for op, halfop and voice status are constants in
 315          * mode.h, and are OP_VALUE, HALFOP_VALUE, and VOICE_VALUE respectively.
 316          * If the value you are given does not match one of these three, it is
 317          * a module-defined mode, and it should be compared in proportion to
 318          * these three constants. For example a value greater than OP_VALUE
 319          * is a prefix of greater 'worth' than ops, and a value less than
 320          * VOICE_VALUE is of lesser 'worth' than a voice.
 321          */
 322         unsigned int GetPrefixValue(User* user);
 323
 324         /** This method removes all prefix characters from a user.
 325          * It will not inform the user or the channel of the removal of prefixes,
 326          * and should be used when the user parts or quits.
 327          * @param user The user to remove all prefixes from
 328          */
 329         void RemoveAllPrefixes(User* user);
 330
 331         /** Add a prefix character to a user.
 332          * Only the core should call this method, usually  from
 333          * within the mode parser or when the first user joins
 334          * the channel (to grant ops to them)
 335          * @param user The user to associate the privilage with
 336          * @param prefix The prefix character to associate
 337          * @param adding True if adding the prefix, false when removing
 338          * @return True if a change was made
 339          */
 340         bool SetPrefix(User* user, char prefix, bool adding);
 341
 342         /** Check if a user is banned on this channel
 343          * @param user A user to check against the banlist
 344          * @returns True if the user given is banned
 345          */
 346         bool IsBanned(User* user);
 347
 348         /** Check a single ban for match
 349          */
 350         bool CheckBan(User* user, const std::string& banmask);
 351
 352         /** Get the status of an "action" type extban
 353          */
 354         ModResult GetExtBanStatus(User *u, char type);
 355 };