-/*
-
-$Log$
-Revision 1.2 2003/01/26 23:52:59 brain
-Modified documentation for base classes
-Added base classes
-
-Revision 1.1.1.1 2003/01/23 19:45:58 brain
-InspIRCd second source tree
-
-Revision 1.7 2003/01/22 00:44:26 brain
-Added documentation comments
-
-Revision 1.6 2003/01/21 21:11:17 brain
-Added documentation
-
-Revision 1.5 2003/01/16 20:11:55 brain
-fixed some ugly pointer bugs (thanks dblack and a|KK|y!)
-
-Revision 1.4 2003/01/15 22:47:44 brain
-Changed user and channel structs to classes (finally)
-
-
-*/
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+ * E-mail:
+ * <brain@chatspike.net>
+ * <Craig@chatspike.net>
+ *
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ * the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
#include "inspircd_config.h"
#include "base.h"
#include <time.h>
#include <vector>
+#include <string>
#ifndef __CHANNELS_H__
#define __CHANNELS_H__
+#define CM_TOPICLOCK 1
+#define CM_NOEXTERNAL 2
+#define CM_INVITEONLY 4
+#define CM_MODERATED 8
+#define CM_SECRET 16
+#define CM_PRIVATE 32
+
+class userrec;
+
/** 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.
*/
};
+/** Holds a custom parameter to a module-defined channel mode
+ * e.g. for +L this would hold the channel name.
+ */
+
+class ModeParameter : public classbase
+{
+ public:
+ char mode;
+ char parameter[MAXBUF];
+ char channel[CHANMAX];
+};
+
/** Holds a complete ban list
*/
-typedef vector<BanItem> BanList;
+typedef std::vector<BanItem> BanList;
/** Holds a complete exempt list
*/
-typedef vector<ExemptItem> ExemptList;
+typedef std::vector<ExemptItem> ExemptList;
/** Holds a complete invite list
*/
-typedef vector<InviteItem> InviteList;
+typedef std::vector<InviteItem> InviteList;
/** Holds all relevent information for a channel.
* This class represents a channel, and contains its name, modes, time created, topic, topic set time,
* etc, and an instance of the BanList type.
*/
-class chanrec : public classbase
+class chanrec : public Extensible
{
public:
/** The channels name.
* Plugins may use this field in any way they see fit.
*/
char custom_modes[MAXMODES]; /* modes handled by modules */
+
+ /** User list (casted to char*'s to stop forward declaration stuff)
+ * (chicken and egg scenario!)
+ */
+ std::vector<char*> internal_userlist;
+
/** Channel topic.
* If this is an empty string, no channel topic is set.
*/
/** Contains the channel user limit.
* If this value is zero, there is no limit in place.
*/
- long limit;
+ short int limit;
/** Contains the channel key.
* If this value is an empty string, there is no channel key in place.
*/
char key[32];
- /** Nonzero if the mode +t is set.
+ /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
*/
- short int topiclock;
+ char binarymodes;
- /** Nonzero if the mode +n is set.
+ /** The list of all bans set on the channel.
*/
- short int noexternal;
+ BanList bans;
- /** Nonzero if the mode +i is set.
+ /** 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
*/
- short int inviteonly;
-
- /** Nonzero if the mode +m is set.
+ void SetCustomMode(char mode,bool mode_on);
+
+ /** Sets or unsets the parameters for a custom mode in a 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
*/
- short int moderated;
-
- /** Nonzero if the mode +s is set.
- * This value cannot be set at the same time as chanrec::c_private
+ void SetCustomModeParam(char mode,char* parameter,bool mode_on);
+
+ /** Returns true if a custom 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 IsCustomModeSet(char mode);
+
+ /** Returns the parameter for a custom mode on a channel.
+ * @param mode The mode character you wish to query
+ *
+ * For example if "+L #foo" is set, and you pass this method
+ * 'L', it will return '#foo'. If the mode is not set on the
+ * channel, or the mode has no parameters associated with it,
+ * it will return an empty string.
+ *
+ * @return The parameter for this mode is returned, or an empty string
+ */
+ std::string GetModeParameter(char mode);
+
+ /** Obtain the channel "user counter"
+ * This returns the channel reference counter, which is initialized
+ * to 0 when the channel is created and incremented/decremented
+ * upon joins, parts quits and kicks.
+ *
+ * @return The number of users on this channel
*/
- short int secret;
-
- /** Nonzero if the mode +p is set.
- * This value cannot be set at the same time as chanrec::secret
+ long GetUserCounter();
+
+ /** Add a user pointer to the internal reference list
+ * @param castuser This should be a pointer to a userrec, casted to char*
+ *
+ * The data inserted into the reference list is a table as it is
+ * an arbitary pointer compared to other users by its memory address,
+ * as this is a very fast 32 or 64 bit integer comparison.
*/
- short int c_private;
-
- /** The list of all bans set on the channel.
+ void AddUser(char* castuser);
+
+ /** Delete a user pointer to the internal reference list
+ * @param castuser This should be a pointer to a userrec, casted to char*
+ *
+ * The data removed from the reference list is a table as it is
+ * an arbitary pointer compared to other users by its memory address,
+ * as this is a very fast 32 or 64 bit integer comparison.
+ */
+ void DelUser(char* castuser);
+
+ /** Obrain the internal reference list
+ * The internal reference list contains a list of userrec*
+ * cast to char*. These are used for rapid comparison to determine
+ * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
+ * The resulting pointer to the vector should be considered
+ * readonly and only modified via AddUser and DelUser.
+ *
+ * @return This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references
*/
- BanList bans;
+ std::vector<char*> *GetUsers();
/** Creates a channel record and initialises it with default values
*/
- chanrec()
- {
- strcpy(name,"");
- strcpy(custom_modes,"");
- strcpy(topic,"");
- strcpy(setby,"");
- strcpy(key,"");
- created = topicset = limit = 0;
- topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
- }
+ chanrec();
virtual ~chanrec() { /* stub */ }
};
/** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
* If this value is zero, the user has no privilages upon the channel.
*/
- long uc_modes;
+ 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.
virtual ~ucrec() { /* stub */ }
};
+chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override);
+chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local);
+void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason);
+
#endif
projects / user / henk / code / inspircd.git / blobdiff