simple-chatprocessor.sp 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. /**
  2. * [CSRD] Simple Chat Processor
  3. *
  4. * Simple Chat Processor almost-compatible library for TF2.
  5. * Attempts to fix the one-recipient SayText2 messages, and does not depend on server-side
  6. * localization nonsense (everyone sees "(TEAM)" and "(DEAD)" in their language).
  7. */
  8. #pragma semicolon 1
  9. #include <sourcemod>
  10. #include <sdkhooks>
  11. #include <sdktools_voice>
  12. #pragma newdecls required
  13. #define PLUGIN_VERSION "0.1.4"
  14. public Plugin myinfo = {
  15. name = "[CSRD] Simple Chat Processor",
  16. author = "nosoop (based off of Simple Plugins' implementation)",
  17. description = "Simple Chat Processor almost-compatible library for TF2-specific fixes.",
  18. version = PLUGIN_VERSION,
  19. url = "https://git.csrd.science/"
  20. }
  21. #define PACKED_TOKEN_DELIMITER ":"
  22. #define CHATFLAGS_INVALID 0b0000
  23. #define CHATFLAGS_ALL 0b0001
  24. #define CHATFLAGS_TEAM 0b0010
  25. #define CHATFLAGS_SPEC 0b0100
  26. #define CHATFLAGS_DEAD 0b1000
  27. public APLRes AskPluginLoad2(Handle hPluginSelf, bool late, char[] error, int maxlen) {
  28. MarkNativeAsOptional("GetUserMessageType");
  29. CreateNative("GetMessageFlags", Native_GetMessageFlags);
  30. RegPluginLibrary("scp");
  31. return APLRes_Success;
  32. }
  33. // Holds player-unique messages sent in the current frame.
  34. StringMap g_QueuedMessages[MAXPLAYERS+1];
  35. Handle g_fwdOnChatMessage, g_fwdOnChatMessagePost;
  36. int g_ChatFlags;
  37. public void OnPluginStart() {
  38. UserMsg umSayText2 = GetUserMessageId("SayText2");
  39. if (umSayText2 != INVALID_MESSAGE_ID) {
  40. HookUserMessage(umSayText2, OnSayText2, true);
  41. } else {
  42. SetFailState("Game does not use SayText2.");
  43. }
  44. g_fwdOnChatMessage = CreateGlobalForward("OnChatMessage", ET_Hook, Param_CellByRef,
  45. Param_Cell, Param_String, Param_String);
  46. g_fwdOnChatMessagePost = CreateGlobalForward("OnChatMessage_Post", ET_Ignore, Param_Cell,
  47. Param_Cell, Param_String, Param_String);
  48. for (int i = 1; i < MaxClients; i++) {
  49. if (IsClientInGame(i)) {
  50. OnClientPutInServer(i);
  51. }
  52. }
  53. }
  54. public void OnClientPutInServer(int client) {
  55. g_QueuedMessages[client] = new StringMap();
  56. SDKHook(client, SDKHook_PostThink, OnClientThinkPost);
  57. }
  58. public void OnClientDisconnect(int client) {
  59. if (g_QueuedMessages[client] && g_QueuedMessages[client].Size > 0) {
  60. // delete remaining queued messages, don't bother sending
  61. StringMapSnapshot messages = g_QueuedMessages[client].Snapshot();
  62. for (int m = 0; m < messages.Length; m++) {
  63. char packedMessage[192];
  64. messages.GetKey(m, packedMessage, sizeof(packedMessage));
  65. ArrayList clientList;
  66. g_QueuedMessages[client].GetValue(packedMessage, clientList);
  67. delete clientList;
  68. }
  69. delete messages;
  70. g_QueuedMessages[client].Clear();
  71. }
  72. delete g_QueuedMessages[client];
  73. }
  74. public Action OnSayText2(UserMsg id, Handle buffer, const int[] clients, int nClients,
  75. bool reliable, bool init) {
  76. BfRead bitbuf = view_as<BfRead>(buffer);
  77. int author = bitbuf.ReadByte();
  78. if (!author) {
  79. return Plugin_Continue;
  80. }
  81. bitbuf.ReadByte(); // bChat, unused?
  82. char localizationToken[32];
  83. bitbuf.ReadString(localizationToken, sizeof(localizationToken));
  84. if (StrContains(localizationToken, "TF_Chat_") == -1) {
  85. return Plugin_Continue;
  86. }
  87. if (!ParseChatMessageFlags(localizationToken)) {
  88. return Plugin_Continue;
  89. }
  90. char name[MAX_NAME_LENGTH];
  91. bitbuf.ReadString(name, sizeof(name));
  92. char message[128];
  93. bitbuf.ReadString(message, sizeof(message));
  94. /**
  95. * Pack messages based on localization token and message.
  96. * Any new similar usermessages in the same frame (matching message and flags) get their
  97. * recipients added to the same entry.
  98. */
  99. char packedMessage[192];
  100. Format(packedMessage, sizeof(packedMessage), "%s" ... PACKED_TOKEN_DELIMITER ... "%s",
  101. localizationToken, message);
  102. ArrayList recipients;
  103. if (!g_QueuedMessages[author].GetValue(packedMessage, recipients)) {
  104. recipients = new ArrayList();
  105. g_QueuedMessages[author].SetValue(packedMessage, recipients);
  106. }
  107. for (int i = 0; i < nClients; i++) {
  108. recipients.Push(clients[i]);
  109. }
  110. return Plugin_Handled;
  111. }
  112. public void OnClientThinkPost(int author) {
  113. /**
  114. * Iterate through all queued messages from OnSayText2
  115. */
  116. if (g_QueuedMessages[author].Size == 0) {
  117. return;
  118. }
  119. StringMapSnapshot messages = g_QueuedMessages[author].Snapshot();
  120. for (int m = 0; m < messages.Length; m++) {
  121. char packedMessage[192], localizationToken[32], message[128];
  122. messages.GetKey(m, packedMessage, sizeof(packedMessage));
  123. ArrayList clientList;
  124. g_QueuedMessages[author].GetValue(packedMessage, clientList);
  125. // unpack localization and message from key
  126. int d = SplitString(packedMessage, PACKED_TOKEN_DELIMITER, localizationToken,
  127. sizeof(localizationToken));
  128. strcopy(message, sizeof(message), packedMessage[d]);
  129. char name[MAX_NAME_LENGTH + 1];
  130. GetClientName(author, name, sizeof(name));
  131. // Prepare chat message flags.
  132. g_ChatFlags = ParseChatMessageFlags(localizationToken);
  133. // Forward call.
  134. Action forwardResult = ForwardOnChatMessage(author, clientList, name, sizeof(name),
  135. message, sizeof(message));
  136. // Proceed to display message on continue or changed, else drop message.
  137. if (forwardResult < Plugin_Handled) {
  138. // convert ArrayList to client array
  139. int clients[MAXPLAYERS + 1], nClients;
  140. for (int i = 0; i < clientList.Length; i++) {
  141. int recipient = clientList.Get(i);
  142. // display to author and players that did not mute the author
  143. if (ShouldTransmitMessage(author, recipient)) {
  144. clients[nClients++] = recipient;
  145. }
  146. }
  147. SayText(author, clients, nClients, localizationToken, name, message);
  148. ForwardOnChatMessagePost(author, clientList, name, message);
  149. }
  150. delete clientList;
  151. g_ChatFlags = CHATFLAGS_INVALID;
  152. }
  153. delete messages;
  154. g_QueuedMessages[author].Clear();
  155. }
  156. Action ForwardOnChatMessage(int &author, ArrayList clientList, char[] name, int nameLength,
  157. char[] message, int messageLength) {
  158. Action forwardResult;
  159. Call_StartForward(g_fwdOnChatMessage);
  160. Call_PushCellRef(author);
  161. Call_PushCell(clientList);
  162. Call_PushStringEx(name, nameLength,
  163. SM_PARAM_STRING_UTF8 | SM_PARAM_STRING_COPY, SM_PARAM_COPYBACK);
  164. Call_PushStringEx(message, messageLength,
  165. SM_PARAM_STRING_UTF8 | SM_PARAM_STRING_COPY, SM_PARAM_COPYBACK);
  166. int error = Call_Finish(forwardResult);
  167. if (error) {
  168. ThrowNativeError(error, "Forward failed");
  169. return Plugin_Stop;
  170. }
  171. return forwardResult;
  172. }
  173. bool ShouldTransmitMessage(int author, int recipient) {
  174. return recipient == author || !IsClientMuted(recipient, author);
  175. }
  176. void ForwardOnChatMessagePost(int author, ArrayList clientList, const char[] name,
  177. const char[] message) {
  178. Call_StartForward(g_fwdOnChatMessagePost);
  179. Call_PushCell(author);
  180. Call_PushCell(clientList);
  181. Call_PushString(name);
  182. Call_PushString(message);
  183. int error = Call_Finish();
  184. if (error) {
  185. ThrowNativeError(error, "Forward failed");
  186. }
  187. }
  188. public int Native_GetMessageFlags(Handle hPlugin, int argc) {
  189. return g_ChatFlags;
  190. }
  191. int ParseChatMessageFlags(const char[] localizationToken) {
  192. int chatFlags;
  193. if (StrContains(localizationToken, "all", false) != -1) {
  194. // send to all players, living and dead
  195. chatFlags |= CHATFLAGS_ALL;
  196. }
  197. if (StrContains(localizationToken, "team", false) != -1) {
  198. // send only to players on the same team
  199. chatFlags |= CHATFLAGS_TEAM;
  200. }
  201. if (StrContains(localizationToken, "spec", false) != -1) {
  202. // send only to players in spec
  203. chatFlags |= CHATFLAGS_SPEC;
  204. }
  205. if (StrContains(localizationToken, "dead", false) != -1) {
  206. // send to dead players and team members only
  207. chatFlags |= CHATFLAGS_DEAD;
  208. }
  209. return chatFlags;
  210. }
  211. void SayText(int author, int[] clients, int nClients,
  212. const char[] localizationToken, const char[] name, const char[] message) {
  213. Handle buffer = StartMessage("SayText2", clients, nClients,
  214. USERMSG_RELIABLE | USERMSG_BLOCKHOOKS);
  215. BfWrite bitbuf = view_as<BfWrite>(buffer);
  216. bitbuf.WriteByte(author);
  217. bitbuf.WriteByte(true);
  218. bitbuf.WriteString(localizationToken);
  219. bitbuf.WriteString(name);
  220. bitbuf.WriteString(message);
  221. EndMessage();
  222. }