]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/channels.h
Remove unneeded Extensible inheritance and remove "age" field from classbase
[user/henk/code/inspircd.git] / include / channels.h
index 0d4c4813c28e114d17275f6e1a4a7d5cf843e39f..e471e30cbe91dc3099cefaff55c43bfd3150864c 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.
@@ -58,7 +58,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 +74,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 +98,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 +111,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
         */
@@ -136,30 +136,34 @@ class CoreExport Channel : public Extensible
         */
        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.
         */
-       unsigned 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.
         */
@@ -182,11 +186,6 @@ class CoreExport Channel : public Extensible
         */
        std::string topic; /* MAXTOPIC */
 
-       /** Creation time.
-        * This is a timestamp (TS) value.
-        */
-       time_t created;
-
        /** Time topic was set.
         * If no topic was ever set, this will be equal to Channel::created
         */
@@ -197,33 +196,23 @@ class CoreExport Channel : public Extensible
         */
        std::string 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.
-        */
-       std::string key; /* 32 */
-
        /** 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
@@ -242,6 +231,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,7 +340,7 @@ 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, const char* servername = NULL);
+       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.
@@ -433,6 +429,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
@@ -532,12 +530,14 @@ class CoreExport Channel : public Extensible
         * a given user for this channel.
         * @param u The user to match bans against
         * @param type The type of extban to check
+        * @returns 1 = exempt, 0 = no match, -1 = banned
         */
-       bool IsExtBanned(User *u, char type);
+       int GetExtBanStatus(User *u, char type);
 
        /** Overloaded version to check whether a particular string is extbanned
+        * @returns 1 = exempt, 0 = no match, -1 = banned
         */
-       bool IsExtBanned(const std::string &str, char type);
+       int GetExtBanStatus(const std::string &str, char type);
 
        /** Clears the cached max bans value
         */
@@ -548,4 +548,18 @@ class CoreExport Channel : public Extensible
        virtual ~Channel() { /* stub */ }
 };
 
+static inline int banmatch_reduce(int v1, int v2)
+{
+       int a1 = abs(v1);
+       int a2 = abs(v2);
+       if (a1 > a2)
+               return v1;
+       else if (a2 > a1)
+               return v2;
+       else if (v1 > v2)
+               return v1;
+       // otherwise v2 > v1 or equal
+       return v2;
+}
+
 #endif