[Release] Chat plugin for permissions

[SgtLegend]

Hi guys and girls,

This is a very small release and probably won't relate to many, I had a request to update a simple plugin originally developed by @8q4s8, this release/update contain some changes that make it dynamic so you can now freely use the groups you have assigned through the permissions plugin on your server.

PLEASE NOTE
You will need to download the attached version of the permissions plugin for this plugin to work correctly!

So what does this plugin do?
This plugin will allow you to highlight the groups you've set for the chat plugin, for example instead of a boring name and message you could have the following:

[<group>] <name>: <message>

What commands can I use?

!chat - Disables the chat plugin for all clients
!toggletag - Toggles the plugin for the client who used the command

See the below for the installation instructions.

1. Copy the configuration defaults below and place them in your sv_config.ini
   
2. Assign "GroupsToUse" a comma separated list of the groups you want highlighted in the chat
   
3. Next use the naming convention MessageFor<group name here>, for example if the group name is Masters the configuration key would be MessageForMasters
   
4. For each group you can enter a custom message that appears in the chat as for example above, see the default configuration for examples
   
5. Enjoy!
   

Configuration help

Code:

{0} = Group name
{1} = Client name
{2} = Original message entered by the client

sv_config.ini:

Code:

[ChatPlugin]
// Disable the plugin for all clients by default?
DisableChatPlugin=false
// The groups to use for the chat plugin
GroupsToUse=Admin,Moderators
// The messages for the groups specified
MessageForAdmin=^1[^4{0}^1] ^7{1}^7: {2}
MessageForModerators=[^2{0}] ^7{1}^7: {2}

Changelog:

Spoiler (Click to View)

v1.0
- Bug fixes
- Updated the OnSay check so it now respects team chats
- Updated the permissions plugin
- Discontinued support for v0.2-0.4

v0.4
- Minor updates
- Implemented a new version of the permissions plugin that includes an API include of custom changes

v0.3
- Fixed a bug for groups that use *EVERYONE* or *ALL*
- Attached an updated version of the permissions plugin which stops a double up of the chat for clients whom aren't in the admin group

v0.2
- Mainstream release

v0.1
- Initial creation by @8q4s8

Source Code:

CSHARP Code

using Addon;
using System.Collections.Generic;
using System.Text.RegularExpressions;
 
namespace ChatPlugin
{
    public class ChatPlugin : CPlugin
    {
        private readonly Dictionary<string, string> _groups = new Dictionary<string, string>();
        private readonly Dictionary<string, string> _xuids = new Dictionary<string, string>();
        private readonly Dictionary<string, bool> _chat = new Dictionary<string, bool>();
        private const string DefaultGroups = "Admin,Moderator";
        private const string InvalidGroupValueRegExp = @"\*(EVERYONE|ALL)\*";
        private string[] _groupsToUse;
        private bool _togglechat;
 
        /// <summary>
        /// Executes when the MW3 server loads
        /// </summary>
        public override void OnServerLoad()
        {
            ServerPrint("[ChatPlugin] By 8Q4S8 loaded!");
            ServerPrint("[ChatPlugin] Updated by SgtLegend on May 12, 2013");
 
            // Set the default state of the plugin
            bool.TryParse(GetServerCFG("ChatPlugin", "DisableChatPlugin", "false"), out _togglechat);
 
            // Get the configuration values we need
            _groupsToUse = GetServerCFG("ChatPlugin", "GroupsToUse", DefaultGroups).Split(',');
 
            if (_groupsToUse.Length == 0) return;
            foreach (string group in _groupsToUse)
            {
                // Add the group to a storage array
                if (!_groups.ContainsKey(group))
                {
                    _groups.Add(group, GetServerCFG("ChatPlugin", "MessageFor" + group, "[^2{0}^7] ^7{1}^7: {2}"));
                }
 
                // Extract the xuids for the specified group
                string xuidsForGroup = GetServerCFG("Permission", group + "_xuids", "");
 
                if (Regex.Match(xuidsForGroup, InvalidGroupValueRegExp, RegexOptions.IgnoreCase).Success) continue;
                string[] xuids = xuidsForGroup.Split(',');
 
                if (xuids.Length == 0) continue;
                foreach (string xuid in xuids)
                {
                    if (!_xuids.ContainsKey(xuid))
                    {
                        _xuids.Add(xuid, group);
                    }
                }
            }
        }
 
        /// <summary>
        /// Executes when a player types something into the chat
        /// </summary>
        /// <param name="message"></param>
        /// <param name="client"></param>
        /// <param name="teamchat"></param>
        /// <returns></returns>
        public override ChatType OnSay(string message, ServerClient client, bool teamchat)
        {
            if (!message.StartsWith("!") && !teamchat && !_togglechat && !_chat[client.XUID] && _xuids.ContainsKey(client.XUID))
            {
                foreach (KeyValuePair<string, string> group in _groups)
                {
                    if (_xuids[client.XUID] == group.Key && !string.IsNullOrEmpty(group.Value))
                    {
                        ServerSay(string.Format(group.Value, group.Key, client.Name, message), true);
                        return ChatType.ChatNone;
                    }
                }
            }
 
            // Toggle the plugin for all the clients on the server
            if (message.ToLower() == "!chat")
            {
                _togglechat = !_togglechat;
                return ChatType.ChatNone;
            }
 
            // Toggle the plugin for the client that typed this command
            if (message.ToLower() == "!toggletag")
            {
                _chat[client.XUID] = !_chat[client.XUID];
                return ChatType.ChatNone;
            }
 
            return ChatType.ChatContinue;
        }
 
        /// <summary>
        /// Executes when a player joins the server
        /// </summary>
        /// <param name="client"></param>
        public override void OnPlayerConnect(ServerClient client)
        {
            if (!_chat.ContainsKey(client.XUID))
            {
                _chat.Add(client.XUID, false);
            }
 
            AddClientToChatXuiDsList(client.XUID);
        }
 
        /// <summary>
        /// Tries to find the group for the user that has just joined the server
        /// </summary>
        /// <param name="xuid"></param>
        private void AddClientToChatXuiDsList(string xuid)
        {
            string[] userGroups = GetServerCFG("ChatPlugin", "GroupsToUse", DefaultGroups).Split(',');
 
            if (userGroups.Length == 0) return;
            foreach (string group in userGroups)
            {
                string xuidsForGroup = GetServerCFG("Permission", group + "_xuids", "");
 
                if (Regex.Match(xuidsForGroup, InvalidGroupValueRegExp, RegexOptions.IgnoreCase).Success &&
                    !_xuids.ContainsKey(xuid))
                {
                    _xuids.Add(xuid, group);
                }
            }
        }
    }
}

Credits:
@8q4s8 - Original plugin creator
@Pozzuh - For the permissions plugin
@Nukem - For such a great code base to work with

Apart from the commands above the plugin will work its magic in the background without any input been required by the client. Enjoy!


  ChatPlugin-1.0.zip (Size: 3.09 KB / Downloads: 161)
  aaaPermissionPlugin.zip (Size: 3.69 KB / Downloads: 117)

[Dr3am95]

Thanks and nice one.

[8q4s8]

Nice plugin and thanks for the credits. You should attach the "fixed" aaaPermissionPlugin too or the plugin only works for admins.

[SgtLegend]

Released a new version that fixes a bug and implements the new permissions plugin

[hillbilly]

other 1 was crashing my server u come across that in any bugs/code glitches?

i have to ask did you actually test it?? because its doing the same thing as it was before when i edited it ie:

Bonemind's ingame RCON v0.7.5 BETA loaded
Error: The XUID: is in multiple groups
Error: The XUID: is in multiple groups

[SgtLegend]

I tested the plugin after every change and it worked perfectly fine for me, the multiple XUID group errors are coming from another plugin as my code simply ignores someone who is in two groups.

Apart from that I released both versions with around 1-2 hours testing each.

[hillbilly]

odd redid a new sv.config now it ok, just hope it doesn't crash me server like before.

[MADD_DOGG]

in ur code this _groups.Add(group, GetServerCFG("ChatPlugin", "MessageFor" + group, "[^2{0}] ^7{1}^7: {2}"));
makes the first [ of mod is white and the rest green i changed it to _groups.Add(group, GetServerCFG("ChatPlugin", "MessageFor" + group, "^2[{0}] ^7{1}^7: {2}")); not all of [Moderator] is green just thought i would point it out

[SgtLegend]

v0.4 has been released, you will need to download the permissions plugin again as it has been updated to a newer version which is explained in the change log.

[SgtLegend]

Released an update guys and girls, it includes some bug fixes and an update which sees team chats exempt from the chat plugin.

See the change log for all the details and please make sure you grab the latest version of the permissions plugin attached.