]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/channels.h
Fix m_testcommand which tries to use an undefined pointer as ServerInstance
[user/henk/code/inspircd.git] / include / channels.h
index e69122521cfc2cefed26ff138d891681ee5dae1c..a85e69dd1ec02a02415196a033672910ea7022a6 100644 (file)
@@ -2,12 +2,9 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
@@ -66,30 +63,10 @@ class BanItem : public HostItem
 {
 };
 
-/** A subclass of HostItem designed to hold channel exempts (+e)
- */
-class ExemptItem : public HostItem
-{
-};
-
-/** A subclass of HostItem designed to hold channel invites (+I)
- */
-class InviteItem : public HostItem
-{
-};
-
 /** Holds a complete ban list
  */
 typedef std::vector<BanItem>   BanList;
 
-/** Holds a complete exempt list
- */
-typedef std::vector<ExemptItem>        ExemptList;
-
-/** Holds a complete invite list
- */
-typedef std::vector<InviteItem>        InviteList;
-
 /** A list of users on a channel
  */
 typedef std::map<userrec*,userrec*> CUList;
@@ -115,33 +92,6 @@ enum UserChannelModes {
        UCMODE_HOP     = 4
 };
 
-/** Holds a user's modes on a channel
- * This class associates a users privilages with a channel by creating a pointer link between
- * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
- * has on the channel, such as op, voice, etc.
- */
-class ucrec : public classbase
-{
- public:
-       /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
-        * If this value is zero, the user has no privilages upon the channel.
-        */
-       char uc_modes;
-
-       /** Points to the channel record where the given modes apply.
-        * If the record is not in use, this value will be NULL.
-        */
-       chanrec *channel;
-
-       /** Constructor for ucrec
-        */
-       ucrec() : uc_modes(0), channel(NULL) { /* stub */ }
-
-       /** Destructor for ucrec
-        */
-       virtual ~ucrec() { /* stub */ }
-};
-
 class InspIRCd;
 
 /** A stored prefix and its rank
@@ -170,7 +120,7 @@ class chanrec : public Extensible
 
        /** Connect a chanrec to a userrec
         */
-       static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr,ucrec *a,userrec* user, int created);
+       static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr, userrec* user, const std::string &privs);
 
        prefixlist prefixes;
 
@@ -415,7 +365,7 @@ class chanrec : public Extensible
 
        /** Write to a channel, from a server, using va_args for text
         * @param ServName Server name to prefix the line with
-        * @param text A printf-style format string which builds the output line without prefi
+        * @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, ...);
@@ -426,20 +376,47 @@ class chanrec : public Extensible
         */
        void WriteChannelWithServ(const char* ServName, const std::string &text);
 
-       /** Write to all users on a channel except a specific user, using va_args for text
+       /** Write to all users on a channel except a specific user, using va_args for text.
+        * Internally, this calls WriteAllExcept().
+        * @param user User whos details to prefix the line with, and to omit from receipt of the message
+        * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
+        * use the nick!user@host of the user.
+        * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
+        * @param text A printf-style format string which builds the output line without prefix
+        * @param ... Zero or more POD type
+        */
+       void WriteAllExceptSender(userrec* user, bool serversource, char status, char* text, ...);
+
+       /** 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
+        * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
+        * use the nick!user@host of the user.          
         * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
-        * @param text A printf-style format string which builds the output line without prefi
+        * @param except_list A list of users NOT to send the text to
+        * @param text A printf-style format string which builds the output line without prefix
         * @param ... Zero or more POD type
         */
-       void WriteAllExceptSender(userrec* user, char status, char* text, ...);
+       void WriteAllExcept(userrec* user, bool serversource, char status, CUList &except_list, char* text, ...);
+
+       /** Write to all users on a channel except a specific user, using std::string for text.
+        * Internally, this calls WriteAllExcept().
+        * @param user User whos details to prefix the line with, and to omit from receipt of the message
+        * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
+        * use the nick!user@host of the user.          
+        * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
+        * @param text A std::string containing the output line without prefix
+        */
+       void WriteAllExceptSender(userrec* user, bool serversource, char status, const std::string& text);
 
-       /** Write to all users on a channel except a specific user, using std::string for text
+       /** Write to all users on a channel except a list of users, using std::string for text
         * @param user User whos details to prefix the line with, and to omit from receipt of the message
+        * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
+        * use the nick!user@host of the user.          
         * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
+        * @param except_list A list of users NOT to send the text to
         * @param text A std::string containing the output line without prefix
         */
-       void WriteAllExceptSender(userrec* user, char status, const std::string& text);
+       void WriteAllExcept(userrec* 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
@@ -490,7 +467,9 @@ class chanrec : public Extensible
 
        /** Return all of a users mode prefixes into a char* string.
         * @param user The user to look up
-        * @return A list of all prefix characters. There is no gauranteed order of prefixes.
+        * @return A list of all prefix characters. The prefixes will always
+        * be in rank order, greatest first, as certain IRC clients require
+        * this when multiple prefixes are used names lists.
         */
        const char* GetAllPrefixChars(userrec* user);
 
@@ -525,6 +504,12 @@ class chanrec : public Extensible
         */
        void SetPrefix(userrec* user, char prefix, unsigned int prefix_rank, bool adding);
 
+       /** Check if a user is banned on this channel
+        * @param user A user to check against the banlist
+        * @returns True if the user given is banned
+        */
+       bool IsBanned(userrec* user);
+
        /** Destructor for chanrec
         */
        virtual ~chanrec() { /* stub */ }