]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/channels.h
Change Extensible to use strongly typed entries
[user/henk/code/inspircd.git] / include / channels.h
index 3419e4c69c0ef8abb63a84c1853e3acac0f9e58c..dfbe06c270a26eab1a450f558ff1b0260e966826 100644 (file)
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
@@ -29,6 +29,7 @@ enum ChannelModes {
 
 /* Forward declarations - needed */
 class User;
+struct ModResult;
 
 /** 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.
@@ -41,10 +42,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 */ }
@@ -58,7 +59,7 @@ class BanItem : public HostItem
 
 /** Holds a complete ban list
  */
-typedef std::vector<BanItem>   BanList;
+typedef std::list<BanItem>     BanList;
 
 /** A list of users on a channel
  */
@@ -74,7 +75,7 @@ typedef CUList::const_iterator CUListConstIter;
 
 /** A list of custom modes parameters on a channel
  */
-typedef std::map<char,char*> CustomModeList;
+typedef std::map<char,std::string> CustomModeList;
 
 
 /** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
@@ -98,7 +99,7 @@ typedef std::vector<prefixtype> pfxcontainer;
 typedef std::map<User*, std::vector<prefixtype> > 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
@@ -111,7 +112,7 @@ class CoreExport Channel : public Extensible
 
        /** Connect a Channel to a User
         */
-       static Channel* ForceChan(InspIRCd* Instance, Channel* Ptr, User* user, const std::string &privs, bool bursting);
+       static Channel* ForceChan(InspIRCd* Instance, Channel* Ptr, User* user, const std::string &privs, bool bursting, bool created);
 
        /** Set default modes for the channel on creation
         */
@@ -134,32 +135,36 @@ class CoreExport Channel : public Extensible
 
        /** The channel's name.
         */
-       char name[CHANMAX];
+       std::string name; /* CHANMAX */
+
+       /** 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 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 
+        * There are four user lists, one for
         * all the users, one for the ops, one for
         * the halfops and another for the voices.
         */
        CUList internal_userlist;
 
        /** Opped users.
-        * There are four user lists, one for 
+        * There are four user lists, one for
         * all the users, one for the ops, one for
         * the halfops and another for the voices.
         */
        CUList internal_op_userlist;
 
        /** Halfopped users.
-        * There are four user lists, one for 
+        * There are four user lists, one for
         * all the users, one for the ops, one for
         * the halfops and another for the voices.
         */
@@ -180,12 +185,7 @@ class CoreExport Channel : public Extensible
        /** Channel topic.
         * If this is an empty string, no channel topic is set.
         */
-       char topic[MAXTOPIC];
-
-       /** Creation time.
-        * This is a timestamp (TS) value.
-        */
-       time_t created;
+       std::string topic; /* MAXTOPIC */
 
        /** Time topic was set.
         * If no topic was ever set, this will be equal to Channel::created
@@ -195,40 +195,31 @@ 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
         */
        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(char mode, 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']; }
+
 
        /** Returns the parameter for a custom mode on a channel.
          * @param mode The mode character you wish to query
@@ -242,6 +233,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
@@ -344,16 +342,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, 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.
@@ -371,7 +369,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
@@ -384,7 +382,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
@@ -401,7 +399,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
@@ -412,7 +410,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().
@@ -433,6 +431,8 @@ class CoreExport Channel : public Extensible
         * @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);
+       /** 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);
 
        /** Returns the maximum number of bans allowed to be set on this channel
         * @return The maximum number of bans allowed
@@ -528,6 +528,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
+        */
+       ModResult GetExtBanStatus(User *u, char type);
+
+       /** Overloaded version to check whether a particular string is extbanned
+        */
+       ModResult GetExtBanStatus(const std::string &str, char type);
+
        /** Clears the cached max bans value
         */
        void ResetMaxBans();