]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/channels.h
As we have an enum for type, why not ..use it?
[user/henk/code/inspircd.git] / include / channels.h
index b9983ed88f13a43e662b81252a72df49145b123b..9c231008a3ce28cb8a9bfb079c1bc7120a5610af 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
 #ifndef __CHANNELS_H__
 #define __CHANNELS_H__
 
-#include "inspircd_config.h"
-#include "base.h"
-#include <time.h>
-#include <vector>
-#include <string>
-#include <map>
-
 /** RFC1459 channel modes
  */
 enum ChannelModes {
@@ -36,7 +29,6 @@ enum ChannelModes {
 
 /* Forward declarations - needed */
 class User;
-class Channel;
 
 /** 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.
@@ -49,10 +41,10 @@ class HostItem : public classbase
        time_t set_time;
        /** Who added the item
         */
-       char set_by[NICKMAX];
+       std::string set_by;
        /** The actual item data
         */
-       char data[MAXBUF];
+       std::string data;
 
        HostItem() { /* stub */ }
        virtual ~HostItem() { /* stub */ }
@@ -135,17 +127,22 @@ class CoreExport Channel : public Extensible
        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];
+       std::string 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 
@@ -183,7 +180,7 @@ class CoreExport Channel : public Extensible
        /** Channel topic.
         * If this is an empty string, no channel topic is set.
         */
-       char topic[MAXTOPIC];
+       std::string topic; /* MAXTOPIC */
 
        /** Creation time.
         * This is a timestamp (TS) value.
@@ -198,17 +195,7 @@ 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.
         */
@@ -245,6 +232,13 @@ class CoreExport Channel : public Extensible
          */
        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
@@ -331,11 +325,6 @@ class CoreExport Channel : public Extensible
         */
        bool HasUser(User* user);
 
-       /** Creates a channel record and initialises it with default values
-        * @throw Nothing at present.
-        */
-       Channel(InspIRCd* Instance);
-
        /** 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)
@@ -352,16 +341,16 @@ class CoreExport Channel : public Extensible
         * @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);
+       long ServerKickUser(User* user, const char* reason, bool triggerevents, const char* servername = 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
+        * @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.
@@ -379,7 +368,7 @@ class CoreExport Channel : public Extensible
         * @param text A printf-style format string which builds the output line without prefix
         * @param ... Zero or more POD types
         */
-       void WriteChannel(User* user, 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
@@ -392,7 +381,7 @@ 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 char* 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
@@ -409,7 +398,7 @@ 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 WriteAllExceptSender(User* user, bool serversource, char status, 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
@@ -420,7 +409,7 @@ 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 WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, 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().
@@ -536,6 +525,17 @@ class CoreExport Channel : public Extensible
         */
        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
+        */
+       bool IsExtBanned(User *u, char type);
+
+       /** Overloaded version to check whether a particular string is extbanned
+        */
+       bool IsExtBanned(const std::string &str, char type);
+
        /** Clears the cached max bans value
         */
        void ResetMaxBans();