X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fchannels.h;h=6c92f08014ebe0db937b4060eb2effd4018a3b9d;hb=383caa90d568d8d997a9624a9e6174ddc1a9a3da;hp=5186822e13339ec5c91cf8447ef84af19734434c;hpb=8b864c8a828d6ca97b5ec15fa7bf8fcc35027294;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/channels.h b/include/channels.h index 5186822e1..6c92f0801 100644 --- a/include/channels.h +++ b/include/channels.h @@ -66,30 +66,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 BanList; -/** Holds a complete exempt list - */ -typedef std::vector ExemptList; - -/** Holds a complete invite list - */ -typedef std::vector InviteList; - /** A list of users on a channel */ typedef std::map CUList; @@ -144,8 +124,16 @@ class ucrec : public classbase class InspIRCd; +/** A stored prefix and its rank + */ typedef std::pair prefixtype; + +/** A list of prefixes set on a user in a channel + */ typedef std::vector pfxcontainer; + +/** A list of users with zero or more prefixes set on them + */ typedef std::map > prefixlist; /** Holds all relevent information for a channel. @@ -420,18 +408,22 @@ class chanrec : public Extensible /** 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 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 ... Zero or more POD type */ - void WriteAllExceptSender(userrec* user, char status, char* text, ...); + void WriteAllExceptSender(userrec* user, bool serversource, 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 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, char status, const std::string& text); + void WriteAllExceptSender(userrec* user, bool serversource, 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 @@ -446,7 +438,7 @@ class chanrec : public Extensible char* ChanModes(bool showkey); /** Spool the NAMES list for this channel to the given user - * @param The user to spool the NAMES list to + * @param user The user to spool the NAMES list to */ void UserList(userrec *user); @@ -456,25 +448,75 @@ class chanrec : public Extensible int CountInvisible(); /** Get a users status on this channel - * @param The user to look up + * @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 The user to look up + * @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 status on this channel in a string - * @param The user to look up - * @return A character array containing the string "@", "%", "+" or "" + /** 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 */ - const char* GetStatusChar(userrec *user); - 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 */ }