class HostItem : public classbase
{
public:
+ /** Time the item was added
+ */
time_t set_time;
+ /** Who added the item
+ */
char set_by[NICKMAX];
+ /** The actual item data
+ */
char data[MAXBUF];
HostItem() { /* stub */ }
/** 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
/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
- * needs to come AFTER struct chanrec */
+ */
enum UserChannelModes {
UCMODE_OP = 1,
UCMODE_VOICE = 2,
virtual ~ucrec() { /* stub */ }
};
+class InspIRCd;
+
+/** 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<userrec*, 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,
{
private:
+ /** Pointer to creator object
+ */
+ InspIRCd* ServerInstance;
+
/** Connect a chanrec to a userrec
*/
- static chanrec* ForceChan(chanrec* Ptr,ucrec *a,userrec* user, int created);
+ static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr,ucrec *a,userrec* user, int created);
+
+ prefixlist prefixes;
public:
/** The channels name.
*/
- char name[CHANMAX]; /* channel name */
+ char name[CHANMAX];
+
/** Modes for the channel.
* This is not a null terminated string! It is a hash where
* each item in it represents if a mode is set. For example
* the halfops and another for the voices.
*/
CUList internal_userlist;
+
+ /** Opped users
+ */
CUList internal_op_userlist;
+
+ /** Halfopped users
+ */
CUList internal_halfop_userlist;
+
+ /** Voiced users
+ */
CUList internal_voice_userlist;
/** Parameters for custom modes
* If this value is an empty string, there is no channel key in place.
*/
char key[32];
-
- /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
- */
- //char binarymodes;
-
+
/** The list of all bans set on the channel.
*/
BanList bans;
* as this is a very fast 32 or 64 bit integer comparison.
*/
void AddUser(userrec* user);
+
+ /** Add a user pointer to the internal reference list of opped users
+ * @param user The user to add
+ */
void AddOppedUser(userrec* user);
+
+ /** Add a user pointer to the internal reference list of halfopped users
+ * @param user The user to add
+ */
void AddHalfoppedUser(userrec* user);
+
+ /** Add a user pointer to the internal reference list of voiced users
+ * @param user The user to add
+ */
void AddVoicedUser(userrec* user);
/** Delete a user pointer to the internal reference list
* @param user The user to delete
- * @return number of users left on the channel
+ * @return number of users left on the channel after deletion of the user
*/
unsigned long DelUser(userrec* user);
+
+ /** Delete a user pointer to the internal reference list of opped users
+ * @param user The user to delete
+ */
void DelOppedUser(userrec* user);
+
+ /** Delete a user pointer to the internal reference list of halfopped users
+ * @param user The user to delete
+ */
void DelHalfoppedUser(userrec* user);
+
+ /** Delete a user pointer to the internal reference list of voiced users
+ * @param user The user to delete
+ */
void DelVoicedUser(userrec* user);
/** Obtain the internal reference list
* @return This function returns pointer to a map of userrec pointers (CUList*).
*/
CUList* GetUsers();
+
+ /** Obtain the internal reference list of opped users
+ * @return This function returns pointer to a map of userrec pointers (CUList*).
+ */
CUList* GetOppedUsers();
+
+ /** Obtain the internal reference list of halfopped users
+ * @return This function returns pointer to a map of userrec pointers (CUList*).
+ */
CUList* GetHalfoppedUsers();
+
+ /** Obtain the internal reference list of voiced users
+ * @return This function returns pointer to a map of userrec pointers (CUList*).
+ */
CUList* GetVoicedUsers();
/** Returns true if the user given is on the given channel.
+ * @param The user to look for
+ * @return True if the user is on this channel
*/
bool HasUser(userrec* user);
/** Creates a channel record and initialises it with default values
+ * @throw Nothing at present.
*/
- chanrec();
+ chanrec(InspIRCd* Instance);
/** Make src kick user from this channel with the given reason.
* @param src The source of the kick
* 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 chanrec* JoinUser(userrec *user, const char* cn, bool override, const char* key = "");
+ static chanrec* JoinUser(InspIRCd* ServerInstance, userrec *user, const char* cn, bool override, const char* key = "");
+ /** Write to a channel, from a user, using va_args for text
+ * @param user User whos details to prefix the line with
+ * @param text A printf-style format string which builds the output line without prefix
+ * @param ... Zero or more POD types
+ */
void WriteChannel(userrec* user, char* text, ...);
+
+ /** Write to a channel, from a user, using std::string for text
+ * @param user User whos details to prefix the line with
+ * @param text A std::string containing the output line without prefix
+ */
void WriteChannel(userrec* user, const std::string &text);
+
+ /** 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 ... Zero or more POD type
+ */
void WriteChannelWithServ(const char* ServName, const char* text, ...);
+
+ /** 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);
+
+ /** Write to all users on a channel except a specific user, using va_args for text
+ * @param user User whos details to prefix the line with, and to omit from receipt of the message
+ * @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 ... Zero or more POD type
+ */
void WriteAllExceptSender(userrec* user, char status, char* text, ...);
+
+ /** Write to all users on a channel except a specific user, using std::string for text
+ * @param user User whos details to prefix the line with, and to omit from receipt of the message
+ * @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, char status, const std::string& text);
+ /** Returns the maximum number of bans allowed to be set on this channel
+ * @return The maximum number of bans allowed
+ */
+ long GetMaxBans();
+
+ /** Return the channel's modes with parameters.
+ * @param showkey If this is set to true, the actual key is shown,
+ * otherwise it is replaced with '<KEY>'
+ * @return The channel mode string
+ */
+ char* ChanModes(bool showkey);
+
+ /** Spool the NAMES list for this channel to the given user
+ * @param user The user to spool the NAMES list to
+ */
+ void UserList(userrec *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(userrec *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(userrec *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.
+ * Unlike GetStatus and GetStatusFlags which will only return the
+ * core specified modes @, % and + (op, halfop and voice), GetPrefixChar
+ * will also return module-defined prefixes. If the user has to prefix,
+ * an empty but non-null string is returned. If the user has multiple
+ * prefixes, the highest is returned. If you do not recognise the prefix
+ * character you can get, you can deal with it in a 'proprtional' manner
+ * compared to known prefixes, using GetPrefixValue().
+ */
+ const char* GetPrefixChar(userrec *user);
+
+ /** 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. 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);
+
+ /** Get the value of a users prefix on this channel.
+ * @param user The user to look up
+ * @return The module or core-defined value of the users prefix.
+ * The values for op, halfop and voice status are constants in
+ * mode.h, and are OP_VALUE, HALFOP_VALUE, and VOICE_VALUE respectively.
+ * If the value you are given does not match one of these three, it is
+ * a module-defined mode, and it should be compared in proportion to
+ * these three constants. For example a value greater than OP_VALUE
+ * is a prefix of greater 'worth' than ops, and a value less than
+ * VOICE_VALUE is of lesser 'worth' than a voice.
+ */
+ unsigned int GetPrefixValue(userrec* user);
+
+ /** This method removes all prefix characters from a user.
+ * It will not inform the user or the channel of the removal of prefixes,
+ * and should be used when the user parts or quits.
+ * @param user The user to remove all prefixes from
+ */
+ void RemoveAllPrefixes(userrec* user);
+
+ /** Add a prefix character to a user.
+ * Only the core should call this method, usually from
+ * within the mode parser or when the first user joins
+ * 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(userrec* user, char prefix, unsigned int prefix_rank, bool adding);
+
/** Destructor for chanrec
*/
virtual ~chanrec() { /* stub */ }
projects / user / henk / code / inspircd.git / blobdiff