CA Addon: Request UnGAG (/sorry) (#233)

* ca_remove_user_gag(): Add admin arg

* add Ungag plugin

* Add lang

* refactoring

* Add description

* refactoring №2

* fix: native ca_remove_user_gag() admin param usage

* fix: message receiver for `/sorry` cmd

* cmd rename: `/unmute` -> `/ungag`

* Rework `RequestUngag.sma`

* Use `CA_Client_Say*()` & add `CmdRouter()`

* Add `say /ungag #` cmd handling

* Add config

* remove extra CVar `ca_requestungag_admin_flag`

* increase default timeout

* lil fixes

* Ignore /sorry sender for chat info

* change default timings

* fix checks priority

* add //todo

Author: wopox1337

cstrike/addons/amxmodx/configs/plugins-ChatAdditions.ini

@@ -10,9 +10,10 @@ CA_Storage_SQLite.amxx      debug ; SQLite storage provider
  ; Extensions
 CA_Mute.amxx                    debug ; Players can choose who they can hear.
 CA_Addon_DeathMute.amxx         debug ; Alive players don't hear dead players after 5 secs
-CA_Addon_RankRestrictions.amxx  debug ; Restrict chat until you reach the rank of a statistic
+CA_Addon_RankRestrictions.amxx  debug ; Restrict chat until you reach the rank of a statistic.
 CA_Addon_VoteGag.amxx           debug ; Ability for players to vote for gag.
-CA_Gag.amxx                     debug ; Manage player chats for the admin
+CA_Addon_RequestUnGag.amxx      debug ; A player can apologize to the administration.
+CA_Gag.amxx                     debug ; Manage player chats for the admin.
 
  ; IMPORTANT: Place you chat manager below (Chat RBS plugins, Lite Translit, Colored Translit etc..)
  ; Most chat managers are not written using the correct chat handling,

cstrike/addons/amxmodx/configs/plugins/ChatAdditions/CA_Addon_RequestUnGag.cfg

@@ -0,0 +1,16 @@
+// This file was auto-generated by AMX Mod X (v1.9.0.5271)
+// Cvars for plugin "CA Addon: Request UnGAG" by "steelzzz" (CA_Addon_Request_UnGag.amxx, v6ce18b0)
+
+
+// Request ungag command
+// -
+// Default: "/sorry"
+ca_requestungag_cmd "/sorry"
+
+// delay time request ungag
+// -
+// Default: "40.0"
+// Minimum: "1.000000"
+ca_requestungag_delay "40.0"
+
+

cstrike/addons/amxmodx/data/lang/CA_Addon_RequestUngag.txt

@@ -0,0 +1,11 @@
+[ru]
+RequestUnGag_NoAccess = ^4* ^1У вас не заблокирован чат.
+RequestUnGag_TimeOut = ^4* ^1Попробуйте через %i сек.
+RequestUnGag_Requested = ^4* ^1Игрок ^4%n ^1просит снять гаг. Чтобы снять гаг, напишите: ^4/ungag %d^1
+RequestUnGag_YouRequested = ^4* ^1Вы попросили снять гаг.
+
+[en]
+RequestUnGag_NoAccess = ^4* ^1You don't have a chat block.
+RequestUnGag_TimeOut = ^4* ^1Try it in %i seconds.
+RequestUnGag_Requested = ^4* ^1The player ^4%n ^1asks to remove the gag. To remove it write: ^4/ungag %i^1
+RequestUnGag_YouRequested = ^4* ^1You asked to take off the gag.

cstrike/addons/amxmodx/scripting/CA_Addon_RequestUnGag.sma

@@ -0,0 +1,98 @@
+#include <amxmodx>
+#include <amxmisc>
+
+#include <ChatAdditions>
+#include <CA_GAG_API>
+
+#pragma ctrlchar '\'
+#pragma tabsize 2
+
+static Float: g_userNextRequestTime[MAX_PLAYERS + 1]
+
+static ca_requestungag_cmd[32],
+  Float: ca_requestungag_delay
+
+static ca_gag_access_flags_high[32], ca_gag_access_flags[32]
+
+public stock const PluginName[] = "CA Addon: Request UnGAG"
+public stock const PluginVersion[] = CA_VERSION
+public stock const PluginAuthor[] = "steelzzz"
+public stock const PluginURL[] = "github.com/ChatAdditions/ChatsAdditions_AMXX"
+public stock const PluginDescription[] = "A player can apologize to the administration"
+
+public plugin_init() {
+  register_plugin(PluginName, PluginVersion, PluginAuthor)
+  register_dictionary("CA_Addon_RequestUngag.txt")
+
+  Register_CVars()
+  AutoExecConfig(true, "CA_Addon_RequestUnGag", "ChatAdditions")
+}
+
+public Register_CVars() {
+  bind_pcvar_string(create_cvar("ca_requestungag_cmd", "/sorry",
+      .description = "Request ungag command"),
+    ca_requestungag_cmd, charsmax(ca_requestungag_cmd)
+  )
+
+  bind_pcvar_float(create_cvar("ca_requestungag_delay", "40.0",
+      .description = "delay time request ungag",
+      .has_min = true, .min_val = 1.0),
+    ca_requestungag_delay
+  )
+
+  bind_pcvar_string(get_cvar_pointer("ca_gag_access_flags_high"),
+    ca_gag_access_flags_high, charsmax(ca_gag_access_flags_high)
+  )
+
+  bind_pcvar_string(get_cvar_pointer("ca_gag_access_flags"),
+    ca_gag_access_flags, charsmax(ca_gag_access_flags)
+  )
+}
+
+// TODO: Create `_PRE` hook forward instead this.
+public CA_Client_Say(player, const message[]) {
+  if(strcmp(message, ca_requestungag_cmd) != 0)
+    return PLUGIN_CONTINUE
+
+  if(!ca_has_user_gag(player)) {
+    client_print_color(player, print_team_default, "%L", player, "RequestUnGag_NoAccess")
+
+    return PLUGIN_HANDLED
+  }
+
+  new Float: gametime = get_gametime()
+  if(g_userNextRequestTime[player] > gametime) {
+    new timeLeft = floatround(g_userNextRequestTime[player] - gametime, floatround_ceil)
+    client_print_color(player, print_team_default, "%L", player, "RequestUnGag_TimeOut", timeLeft)
+
+    return PLUGIN_HANDLED
+  }
+
+  new userID = get_user_userid(player)
+
+  new players[MAX_PLAYERS], count
+  get_players_ex(players, count, (GetPlayers_ExcludeBots | GetPlayers_ExcludeHLTV))
+
+  new accessFlagsHigh       = read_flags(ca_gag_access_flags_high)
+  new accessFlags           = read_flags(ca_gag_access_flags)
+
+  for(new i; i < count; i++) {
+    new receiver = players[i]
+
+    if(receiver == player)
+      continue
+
+    if(!(get_user_flags(receiver) & (accessFlags | accessFlagsHigh)))
+      continue
+
+    client_print_color(receiver, print_team_default, "%L",
+      receiver, "RequestUnGag_Requested",
+      player, userID
+    )
+  }
+
+  g_userNextRequestTime[player] = gametime + ca_requestungag_delay
+
+  client_print_color(player, print_team_default, "%L", player, "RequestUnGag_YouRequested")
+  return PLUGIN_HANDLED
+}

cstrike/addons/amxmodx/scripting/CA_Gag.sma

@@ -53,6 +53,9 @@ new const g_adminChatCmds[][] = {
   "amx_tsay2"
 }
 
+new const g_gagCmd[] = "gag"
+new const g_unGagCmd[] = "ungag"
+
 public stock const PluginName[] = "CA: Gag"
 public stock const PluginVersion[] = CA_VERSION
 public stock const PluginAuthor[] = "Sergey Shorokhov"
@@ -106,7 +109,6 @@ public plugin_init() {
   }
 
   register_clcmd("amx_gagmenu", "ClCmd_Gag", (accessFlags | accessFlagsHigh), .FlagManager = false)
-  register_clcmd("say", "ClCmd_Say", (accessFlags | accessFlagsHigh), .FlagManager = false)
 
   for(new i; i < sizeof g_adminChatCmds; i++)
     register_clcmd(g_adminChatCmds[i], "ClCmd_adminSay", ADMIN_CHAT);
@@ -1062,28 +1064,6 @@ public ClCmd_Gag(const id, const level, const cid) {
   return PLUGIN_HANDLED
 }
 
-public ClCmd_Say(const id, const level, const cid) {
-  new args[128]; read_args(args, charsmax(args))
-  trim(args); remove_quotes(args)
-
-  new const strFind[] = "gag"
-
-  if(strncmp(args[1], strFind, charsmax(strFind)) != 0) {
-    return PLUGIN_CONTINUE
-  }
-
-  if(!cmd_access(id, level, cid, 1)) {
-    return PLUGIN_CONTINUE
-  }
-
-  new nickname[32]
-  copy(nickname, charsmax(nickname), args[5])
-
-  MenuShow_PlayersList(id, nickname)
-
-  return PLUGIN_HANDLED
-}
-
 public ClCmd_EnterGagReason(const id, const level, const cid) {
   if(!cmd_access(id, level, cid, 1)) {
     return PLUGIN_HANDLED
@@ -1315,7 +1295,10 @@ public CA_Client_Voice(const listener, const sender) {
   return CA_SUPERCEDE
 }
 
-public CA_Client_SayTeam(id) {
+public CA_Client_SayTeam(id, const message[]) {
+  if(CmdRouter(id, message))
+    return PLUGIN_CONTINUE
+
   new bool: hasBlock = (g_currentGags[id][gd_reason][r_flags] & gagFlag_SayTeam)
 
   if(!hasBlock) {
@@ -1328,7 +1311,10 @@ public CA_Client_SayTeam(id) {
   return CA_SUPERCEDE
 }
 
-public CA_Client_Say(id) {
+public CA_Client_Say(id, const message[]) {
+  if(CmdRouter(id, message))
+    return PLUGIN_CONTINUE
+
   new bool: hasBlock = (g_currentGags[id][gd_reason][r_flags] & gagFlag_Say)
 
   if(!hasBlock) {
@@ -1659,6 +1645,48 @@ static Gag_Expired(const id) {
   client_print_color(0, print_team_default, "%L %L", LANG_PLAYER, "Gag_prefix", LANG_PLAYER, "Gag_PlayerExpiredGag", id)
 }
 
+static bool: CmdRouter(const player, const message[]) {
+  if(!(get_user_flags(player) & (read_flags(ca_gag_access_flags) | read_flags(ca_gag_access_flags_high))))
+    return false
+
+  new cmd[32], token[32]
+  strtok2(message[1], cmd, charsmax(cmd), token, charsmax(token), .trim = true)
+
+  if(strncmp(cmd, g_gagCmd, charsmax(g_gagCmd), true) == 0) {
+    MenuShow_PlayersList(player, token)
+    return true
+  }
+
+  if(strncmp(cmd, g_unGagCmd, charsmax(g_unGagCmd), true) == 0) {
+    new targetUserID = strtol(token)
+    if(targetUserID == 0)
+      return false
+
+    UnGag_ByUserID(player, targetUserID)
+    return true
+  }
+
+  return false
+}
+
+static UnGag_ByUserID(const admin, const targetUserID) {
+  new target = find_player_ex(FindPlayer_MatchUserId | FindPlayer_ExcludeBots, targetUserID)
+  if(!is_user_connected(target)) {
+      client_print_color(admin, print_team_red, "%L %L", admin, "Gag_prefix", admin, "Gag_PlayerNotConnected")
+      return
+    }
+
+  new bool: hasBlock = g_currentGags[target][gd_reason][r_flags] != gagFlag_Removed
+  if(!hasBlock) {
+    client_print_color(admin, print_team_red, "%L %L", admin, "Gag_prefix", admin, "Gag_PlayerExpiredGag", target)
+    return
+  }
+
+  GagData_Copy(g_adminTempData[admin], g_currentGags[target])
+  g_adminTempData[admin][gd_target] = target
+
+  Gag_Remove(admin, target)
+}
 
 Register_Forwards() {
   g_fwd_gag_setted = CreateMultiForward("CA_gag_setted", ET_STOP,
@@ -1722,17 +1750,18 @@ public bool: native_ca_has_user_gag(const plugin_id, const argc) {
 }
 
 public bool: native_ca_remove_user_gag(const plugin_id, const argc) {
-  enum { arg_index = 1 }
+  enum { arg_target = 1, arg_admin }
 
-  new target = get_param(arg_index)
+  new target = get_param(arg_target)
   new gag_flags_s: flags = g_currentGags[target][gd_reason][r_flags]
 
   if(flags == gagFlag_Removed) {
     return false
   }
 
-  GagData_Copy(g_adminTempData[0], g_currentGags[target])
-  g_adminTempData[0][gd_target] = target
+  new admin = get_param(arg_admin)
+  GagData_Copy(g_adminTempData[admin], g_currentGags[target])
+  g_adminTempData[admin][gd_target] = target
 
-  return Gag_Remove(0, target)
+  return Gag_Remove(admin, target)
 }

cstrike/addons/amxmodx/scripting/include/CA_GAG_API.inc

@@ -174,14 +174,15 @@ native bool: ca_has_user_gag(const index);
 /**
  * Remove client's gag data..
  *
- * @param index         Client index
+ * @param target        Target Index
+ * @param admin         Admin Index (0 - server)
  *
  * @return				      True if gag has been removed.
  * @error               If the client index is not within the range of 1 to
  *                      MaxClients, or the client is not connected, an error
  *                      will be thrown.
  */
-native bool: ca_remove_user_gag(const index);
+native bool: ca_remove_user_gag(const target, admin = 0);
 
 /**
  * Called on Gag save.