/** 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
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);
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 prefix on this channel in a string.
- * @param The user to look up
+ * @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
*/
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 The user to look up
+ * @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.
/** 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 The user to remove all prefixes from
+ * @param user The user to remove all prefixes from
*/
void RemoveAllPrefixes(userrec* 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 The user to associate the privilage with
+ * @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);
+ /** 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 */ }