Merge pull request #1 from DosMike/develop

Improved Color Formatting

Author: DosMike

README.md

@@ -35,6 +35,7 @@ As mentioned above, MCP implements compatibility layers for Simple Chat-Processo
 I want to emphasise here that I am only implementing API compatibility, not feature pairity! In addition you can switch the transport method from using SayText2 packets to TextMsg packets (system/plugin messages).
 Simple Chat-Processor also had the quirk that the Post call was only called if the message was changed. I have an optional fix for that in place, that you can enable in the config as well.
 The compatibility options for `Custom-ChatColors` and `HexTags` will try to read the clients chat colors back into MCP for other plugins to access.
+In case you still encounter weird issues with external plugins that reliably format chat messages manually or through a compatibility layer, you can turn on the `External Formatting` option and check if things improve.
 
 By Default MCP will also perform input sanitation that brings chat messages back in-line with vanilla behaviour. Native colors are not actually allowed by games by default, neither are empty messages.
 The `Trim All Whitespaces` option will catch unicode spaces as well, to properly block messages without content.
@@ -53,6 +54,7 @@ The config can be found at `addons/sourcemod/config/metachatprocessor.cfg`:
 		"Custom-ChatColors"	"1"
 		"HexTags"		"1"
 		"Fix Post Calls"	"0"
+		"External Formatting" "0"
 	}
 	// Transport defines the message channel/type. You should probably keep it at SayText.
 	// Possible values: [ PrintToChat , SayText ]

scripting/MetaChatProcessor.sp

@@ -24,12 +24,12 @@
 #pragma semicolon 1
 #pragma newdecls required
 
-#define PLUGIN_VERSION "23w05a"
+#define PLUGIN_VERSION "23w29a"
 
 public Plugin myinfo = {
 	name = "Meta Chat Processor",
-	author = "reBane, based on SCP Redux, Chat-Processor and Cider",
-	description = "Process chat and allows other plugins to manipulate chat.",
+	author = "reBane",
+	description = "Process chat and allows other plugins to manipulate chat, based on SCP Redux, Chat-Processor and Cider",
 	version = PLUGIN_VERSION,
 	url = "https://forums.alliedmods.net/showthread.php?t=337455"
 };
@@ -50,12 +50,13 @@ char clientNamePrefix[MAXPLAYERS+1][MCP_MAXLENGTH_NAME];
 char clientChatColor[MAXPLAYERS+1][MCP_MAXLENGTH_COLORTAG];
 
 enum mcpCompatibility {
-	mcpCompatNone     = 0,
-	mcpCompatSCPRedux = (1<<0), // Support for SCP Redux 2.3.0 - https://forums.alliedmods.net/showpost.php?p=2629088&postcount=413
-	mcpCompatDrixevel = (1<<1), // Support for Drixevel's Chat Processor - https://forums.alliedmods.net/showthread.php?t=286913
-	mcpCompatCiderCP  = (1<<2), // Support for CiderChatProcessor - https://forums.alliedmods.net/showthread.php?p=2646798
-	mcpCompatCCC      = (1<<16), // Support for Custom Chat Colors - https://forums.alliedmods.net/showthread.php?p=1721580
-	mcpCompatHexTags  = (1<<17), // Support for HexTags - https://forums.alliedmods.net/showthread.php?p=2566623
+	mcpCompatNone      = 0,
+	mcpCompatSCPRedux  = (1<<0), // Support for SCP Redux 2.3.0 - https://forums.alliedmods.net/showpost.php?p=2629088&postcount=413
+	mcpCompatDrixevel  = (1<<1), // Support for Drixevel's Chat Processor - https://forums.alliedmods.net/showthread.php?t=286913
+	mcpCompatCiderCP   = (1<<2), // Support for CiderChatProcessor - https://forums.alliedmods.net/showthread.php?p=2646798
+	mcpCompatCCC       = (1<<16), // Support for Custom Chat Colors - https://forums.alliedmods.net/showthread.php?p=1721580
+	mcpCompatHexTags   = (1<<17), // Support for HexTags - https://forums.alliedmods.net/showthread.php?p=2566623
+	mcpCompatExtFormat = (1<<31), // Support any plugin that consistently applies tags and colors
 }
 mcpCompatibility g_compatLevel = mcpCompatNone;
 enum mcpTransportMethod {
@@ -294,7 +295,7 @@ public Action OnUserMessage_SayText2Proto(UserMsg msg_id, BfRead msg, const int[
 
 public Action OnUserMessage_SayText2BB(UserMsg msg_id, BfRead msg, const int[] players, int playersNum, bool reliable, bool init) {
 	// collect the message
-	int tmp=(g_currentMessage.listRecipients == null ? 0 : g_currentMessage.listRecipients.Length);
+	
 	g_currentMessage.Reset();
 	g_currentMessage.sender = msg.ReadByte();
 	if (!g_currentMessage.sender) return Plugin_Continue;
@@ -490,7 +491,8 @@ bool ProcessMessage() {
 	else if (result == Plugin_Changed) g_currentMessage.changed = true;
 
 	//...but default colors are added after, if missing, so i guess i'll just do it here?
-	g_currentMessage.changed |= ApplyClientChatColors(); //process colors. this applies prefix and colors if not already done
+	//process colors. this applies prefix and colors if not already done
+	g_currentMessage.changed |= ApplyClientChatColors();
 
 	//processing message hooks (late)
 	result = Call_OnChatMessage(1); //can still change colors if wanted i guess
@@ -677,7 +679,7 @@ bool ApplyClientChatColors() {
 		RemoveTextColors(g_currentMessage.message, sizeof(MessageData::message), false);
 		return true;
 	}
-	bool changed = result == Plugin_Changed;
+	bool changed = result >= Plugin_Changed;
 
 	char colTagEnd[MCP_MAXLENGTH_NATIVECOLOR];
 	//was the name formatted? does the name tag spill color onto the name?
@@ -689,13 +691,14 @@ bool ApplyClientChatColors() {
 			FormatEx(g_currentMessage.sender_display, sizeof(MessageData::sender_display), "%s\x03%s", namePrefix, g_currentMessage.sender_name);
 		}
 		//don't set changed flag here, as that's standard behaviour/colors
-	} else { //there's custom formatting going on
+	} else if (!(g_compatLevel & mcpCompatExtFormat)) {
+		//name and prefix are changed, and we are tasked to format the message
 		//we only need to concat these two
 		FormatEx(g_currentMessage.sender_display, sizeof(MessageData::sender_display), "%s%s", namePrefix, displayName);
 		changed = true;
 	}
 	//alright now let's check. normally formats prefix char with the default color, so if we have a color and it's not default, prepend to message
-	if (chatColor[0] > 1) {//not empty string, not \x01 color
+	if (chatColor[0] > 1 && !(g_compatLevel & mcpCompatExtFormat)) {//not empty string, not \x01 color
 		Format(g_currentMessage.message, sizeof(MessageData::message), "%s%s", chatColor, g_currentMessage.message);
 		changed = true;
 	}

scripting/MetaChatProcessor/compat_ccc.sp

@@ -11,6 +11,17 @@
 #include <ccc>
 #pragma newdecls required
 #define REQUIRE_PLUGIN
+#include <clientprefs>
+
+static Cookie cookieTag = null;
+static Cookie cookieName = null;
+static Cookie cookieChat = null;
+
+void mcp_ccc_init() {
+	cookieTag = RegClientCookie("ccc_toggle_tag", "Custom Chat Colors Toggle - Tag", CookieAccess_Private);
+	cookieName = RegClientCookie("ccc_toggle_name_color", "Custom Chat Colors Toggle - Name Color", CookieAccess_Private);
+	cookieChat = RegClientCookie("ccc_toggle_chat_color", "Custom Chat Colors Toggle - Chat Color", CookieAccess_Private);
+}
 
 //this will parse back colors from ccc into mcp
 // this allows other plugins to constistently fetch player colors without
@@ -21,25 +32,64 @@
 public int CCC_OnUserConfigLoaded(int client) {
 	if ((g_compatLevel & mcpCompatCCC) == mcpCompatNone) return;
 
+	LoadClientColor(client);
+}
+
+public Action CCC_OnColor(int client, const char[] message, CCC_ColorType type) {
+	if ((g_compatLevel & mcpCompatCCC) == mcpCompatNone) return Plugin_Continue;
+	
+	// because CCC toggle also uses this forward, we will always supress and handle
+	// colors ourselfs. This means we need to reload this client, condidering
+	// their CCC-T config, and skip loading stuff accordingly.
+	LoadClientColor(client);
+	return Plugin_Handled;
+}
+
+static void LoadClientColor(int client) {
 	char prefixBuffer[128];
-	//read prefix color
 	char temp[64];
 	bool tagHasAlpha;
-	int tagColor = CCC_GetColor(client, CCC_TagColor, tagHasAlpha);
-	parseColor(temp, sizeof(temp), tagColor, tagHasAlpha);
-	StrCat(prefixBuffer, sizeof(prefixBuffer), temp);
-	//read prefix tag
-	CCC_GetTag(client, temp, sizeof(temp));
-	StrCat(prefixBuffer, sizeof(prefixBuffer), temp);
-	//read name color
-	bool nameHasAlpha;
-	int nameColor = CCC_GetColor(client, CCC_NameColor, nameHasAlpha);
-	parseColor(temp, sizeof(temp), nameColor, nameHasAlpha);
-	StrCat(prefixBuffer, sizeof(prefixBuffer), temp);
-	//read chat color
-	bool chatHasAlpha;
-	int chatColor = CCC_GetColor(client, CCC_ChatColor, chatHasAlpha);
-	parseColor(temp, sizeof(temp), chatColor, chatHasAlpha);
+	
+	bool useClientTag = true;
+	bool useClientNameColor = true;
+	bool useClientChatColor = true;
+	if (cookieTag != null) {
+		// support for CCC-Toggle
+		// color should not bleed, there are defaults in CCC
+		cookieTag.Get(client, temp, sizeof(temp));
+		useClientTag = StringToInt(temp)==0;
+		cookieName.Get(client, temp, sizeof(temp));
+		useClientNameColor = StringToInt(temp)==0;
+		cookieChat.Get(client, temp, sizeof(temp));
+		useClientChatColor = StringToInt(temp)==0;
+	}
+	
+	if (useClientTag) {
+		//read prefix color
+		int tagColor = CCC_GetColor(client, CCC_TagColor, tagHasAlpha);
+		parseColor(temp, sizeof(temp), tagColor, tagHasAlpha);
+		StrCat(prefixBuffer, sizeof(prefixBuffer), temp);
+		//read prefix tag
+		CCC_GetTag(client, temp, sizeof(temp));
+		StrCat(prefixBuffer, sizeof(prefixBuffer), temp);
+	}
+	if (useClientNameColor) {
+		//read name color
+		bool nameHasAlpha;
+		int nameColor = CCC_GetColor(client, CCC_NameColor, nameHasAlpha);
+		parseColor(temp, sizeof(temp), nameColor, nameHasAlpha);
+		StrCat(prefixBuffer, sizeof(prefixBuffer), temp);
+	} else {
+		StrCat(prefixBuffer, sizeof(prefixBuffer), "\x03")
+	}
+	if (useClientChatColor) {
+		//read chat color
+		bool chatHasAlpha;
+		int chatColor = CCC_GetColor(client, CCC_ChatColor, chatHasAlpha);
+		parseColor(temp, sizeof(temp), chatColor, chatHasAlpha);
+	} else {
+		temp="\x01";
+	}
 	//copy cat
 	strcopy(clientNamePrefix[client], sizeof(clientNamePrefix[]), prefixBuffer);
 	strcopy(clientChatColor[client], sizeof(clientChatColor[]), temp);

scripting/MetaChatProcessor/pluginapi.sp

@@ -116,14 +116,19 @@ void pluginAPI_init() {
 }
 
 public void OnAllPluginsLoaded() {
-	if (g_compatLevel & mcpCompatSCPRedux)
+	if (g_compatLevel & mcpCompatSCPRedux) {
 		mcp_scp_pluginsloaded();
+		if (IsPluginLoaded("[Source 2013] Custom Chat Colors Toggle Module")) {
+			mcp_ccc_init();
+		}
+	}
 	if (g_compatLevel & mcpCompatDrixevel)
 		mcp_drixevel_pluginsloaded();
 	if (g_compatLevel & mcpCompatCiderCP)
 		mcp_cider_pluginsloaded();
 }
 
+
 // -------------------- FORWARD WRAPPER --------------------
 
 /**
@@ -157,8 +162,6 @@ static void ValidateAfterCall(const char[] stage, int error, Action& returnedAct
 	//always strip and process colors
 	if (returnedAction == Plugin_Changed) {
 		if ( (g_currentMessage.options & mcpMsgRemoveColors) == mcpMsgRemoveColors ) {
-			//remove native colors from user input, keeping tags for maybe processing
-			// changes in display name will be picked up later
 			RemoveTextColors(g_currentMessage.sender_display, sizeof(MessageData::sender_display), false);
 			g_currentMessage.changed |= RemoveTextColors(g_currentMessage.message, sizeof(MessageData::message), false);
 		}

scripting/MetaChatProcessor/utilities.sp

@@ -70,6 +70,7 @@ void LoadCompatConfig() {
 		if (kv.GetNum("Cider")>0) g_compatLevel |= mcpCompatCiderCP;
 		if (kv.GetNum("Custom-ChatColors")>0) g_compatLevel |= mcpCompatCCC;
 		if (kv.GetNum("HexTags")>0) g_compatLevel |= mcpCompatHexTags;
+		if (kv.GetNum("External Formatting")>0) g_compatLevel |= mcpCompatExtFormat;
 		g_fixCompatPostCalls = (kv.GetNum("Fix Post Calls")>0);
 		kv.GoBack();
 	} else LogError("[MCP] 'Compatibility' section missing from config");
@@ -107,7 +108,7 @@ void LoadCompatConfig() {
 
 static void GenerateDefaultConfig(KeyValues kv, const char[] path) {
 	kv.ImportFromString("config { "...
-		"Compatibility { \"SCP Redux\" 1 Drixevel 1 Cider 1 \"Custom-ChatColors\" 0 HexTags 0 \"Fix Post Calls\" 0 } "...
+		"Compatibility { \"SCP Redux\" 1 Drixevel 1 Cider 1 \"Custom-ChatColors\" 0 HexTags 0 \"Fix Post Calls\" 0 \"External Formatting\" 0 } "...
 		"Transport SayText HookMode UserMessage "...
 		"\"Input Sanitizer\" { \"Trim All Whitespaces\" 1 \"Ban On NewLine\" 1 \"Strip Native Colorcodes\" 1 } "...
 		"}");
@@ -255,4 +256,45 @@ void BuildMessageFormat(mcpSenderFlag senderflags, mcpTargetGroup targetgroup, c
 			strcopy(buffer[pos], bufferlen-pos, "Spec");
 		}
 	}
-}
+}
+
+/**
+ * Check if a plugin is loaded by name; expensive check!
+ * @param name, the name to check, (nameStrict?case sensitive+exact:case insensitive+contains)
+ * @param nameStrict, if true, the name needs to match exactly, otherwise name value needs to be contained
+ * @param author, the author to check, optional+case insensitive+(authorStrict?exact:contains)
+ * @param authorStrict, if false, author name needs to contain string, if true, author string needs to match exact
+ * @param version, if non-empty, case sensitive+exact requirement; output value for found plugin
+ * @param versionLength, max buffer size for version
+ * @return true if the plugin was found
+ */
+stock bool IsPluginLoaded(const char[] name, bool nameStrict=true, const char[] author=NULL_STRING, bool authorStrict=false, char[] version="", int versionLength=0) {
+	Handle iter = GetPluginIterator();
+	char buffer[128];
+	while (MorePlugins(iter)) {
+		Handle plugin = ReadPlugin(iter);
+		GetPluginInfo(plugin, PlInfo_Name, buffer, sizeof(buffer));
+		if (nameStrict) {
+			if (!StrEqual(buffer, name, true)) continue;
+		} else {
+			if (StrContains(buffer, name, false)==-1) continue;
+		}
+		if (!IsNullString(author)) {
+			GetPluginInfo(plugin, PlInfo_Author, buffer, sizeof(buffer));
+			if (authorStrict) {
+				if (!StrEqual(buffer, author, false)) continue;
+			} else {
+				if (StrContains(buffer, author, false)==-1) continue;
+			}
+		}
+		if (versionLength>0) {
+			GetPluginInfo(plugin, PlInfo_Version, buffer, sizeof(buffer));
+			if (version[0]!=0 && !StrEqual(buffer, version)) break;
+			strcopy(version, versionLength, buffer);
+		}
+		delete iter;
+		return true;
+	}
+	delete iter;
+	return false;
+}