]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/channels.h
Make classbase and refcountbase uncopyable; expand comments on their indended uses
[user/henk/code/inspircd.git] / include / channels.h
index e471e30cbe91dc3099cefaff55c43bfd3150864c..7728bb55b16935b0b5bd1efd76d68c6320b16704 100644 (file)
@@ -14,6 +14,8 @@
 #ifndef __CHANNELS_H__
 #define __CHANNELS_H__
 
+#include "membership.h"
+
 /** RFC1459 channel modes
  */
 enum ChannelModes {
@@ -29,11 +31,12 @@ 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.
  */
-class HostItem : public classbase
+class HostItem
 {
  public:
        /** Time the item was added
@@ -60,23 +63,10 @@ class BanItem : public HostItem
  */
 typedef std::list<BanItem>     BanList;
 
-/** A list of users on a channel
- */
-typedef std::map<User*,std::string> 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<char,std::string> CustomModeList;
 
-
 /** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
  */
 enum UserChannelModes {
@@ -85,43 +75,20 @@ enum UserChannelModes {
        UCMODE_HOP      = 4     /* Halfopped user */
 };
 
-/** A stored prefix and its rank
- */
-typedef std::pair<char, unsigned int> prefixtype;
-
-/** A list of prefixes set on a user in a channel
- */
-typedef std::vector<prefixtype> pfxcontainer;
-
-/** A list of users with zero or more prefixes set on them
- */
-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, topic, topic set time,
  * etc, and an instance of the BanList type.
  */
 class CoreExport Channel : public Extensible
 {
- 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, bool created);
+       static Channel* ForceChan(Channel* Ptr, User* user, const std::string &privs, bool bursting, bool created);
 
        /** 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;
@@ -130,7 +97,7 @@ class CoreExport Channel : public Extensible
        /** Creates a channel record and initialises it with default values
         * @throw Nothing at present.
         */
-       Channel(InspIRCd* Instance, const std::string &name, time_t ts);
+       Channel(const std::string &name, time_t ts);
 
        /** The channel's name.
         */
@@ -148,33 +115,9 @@ class CoreExport Channel : public Extensible
         */
        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.
-        */
-       CUList internal_userlist;
-
-       /** 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.
-        */
-       CUList internal_op_userlist;
-
-       /** 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.
+       /** User list.
         */
-       CUList internal_halfop_userlist;
-
-       /** 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.
-        */
-       CUList internal_voice_userlist;
+       UserMembList userlist;
 
        /** Parameters for custom modes.
         * One for each custom mode letter.
@@ -217,7 +160,8 @@ class CoreExport Channel : public Extensible
          * @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
@@ -254,22 +198,7 @@ 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
@@ -277,21 +206,6 @@ class CoreExport Channel : public Extensible
         */
        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);
-
        /** Obtain the internal reference list
         * The internal reference list contains a list of User*.
         * These are used for rapid comparison to determine
@@ -301,22 +215,7 @@ 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();
 
        /** Returns true if the user given is on the given channel.
         * @param The user to look for
@@ -324,6 +223,8 @@ class CoreExport Channel : public Extensible
         */
        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)
@@ -340,7 +241,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, const char* servername = NULL);
+       long ServerKickUser(User* user, const char* reason, const std::string& servername = "");
 
        /** Part a user from this channel with the given reason.
         * If the reason field is NULL, no reason will be sent.
@@ -360,7 +261,7 @@ class CoreExport Channel : public Extensible
         * 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.
         */
-       static Channel* JoinUser(InspIRCd* ServerInstance, User *user, const char* cn, bool override, const char* key, bool bursting, time_t TS = 0);
+       static Channel* JoinUser(User *user, const char* cn, bool override, const char* key, bool bursting, time_t TS = 0);
 
        /** Write to a channel, from a user, using va_args for text
         * @param user User whos details to prefix the line with
@@ -380,13 +281,13 @@ 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, ...) CUSTOM_PRINTF(3, 4);
+       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().
@@ -446,28 +347,14 @@ class CoreExport Channel : public Extensible
 
        /** 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);
+       void UserList(User *user);
 
        /** 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);
-
        /** Get a users prefix on this channel in a string.
         * @param user The user to look up
         * @return A character array containing the prefix string.
@@ -515,10 +402,9 @@ class CoreExport Channel : public Extensible
         * 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
         */
-       void SetPrefix(User* user, char prefix, unsigned int prefix_rank, bool adding);
+       void 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
@@ -526,18 +412,13 @@ 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
-        * @returns 1 = exempt, 0 = no match, -1 = banned
+       /** Check a single ban for match
         */
-       int GetExtBanStatus(User *u, char type);
+       bool CheckBan(User* user, const std::string& banmask);
 
-       /** Overloaded version to check whether a particular string is extbanned
-        * @returns 1 = exempt, 0 = no match, -1 = banned
+       /** Get the status of an "action" type extban
         */
-       int GetExtBanStatus(const std::string &str, char type);
+       ModResult GetExtBanStatus(User *u, char type);
 
        /** Clears the cached max bans value
         */
@@ -548,18 +429,4 @@ 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