From 9495432b8fe79accbd51a6119006b0edd58c60fe Mon Sep 17 00:00:00 2001
From: Michael H <Sinbad@michaelhall.tech>
Date: Mon, 3 Sep 2018 22:59:59 -0400
Subject: [PATCH] More mention filtering (#2081)

* more filters

* note to future people touching this

* chan mentions were almost missed...

* Swap strategies as the previous escaped the mention, while still pinging the user/role
---
 redbot/cogs/mod/mod.py              |  5 ++++-
 redbot/core/utils/common_filters.py | 22 ++++++++++++++++++++++
 2 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/redbot/cogs/mod/mod.py b/redbot/cogs/mod/mod.py
index 320793501..09e0ecb36 100644
--- a/redbot/cogs/mod/mod.py
+++ b/redbot/cogs/mod/mod.py
@@ -12,7 +12,7 @@ from .checks import mod_or_voice_permissions, admin_or_voice_permissions, bot_ha
 from redbot.core.utils.mod import is_mod_or_superior, is_allowed_by_hierarchy, get_audit_reason
 from .log import log
 
-from redbot.core.utils.common_filters import filter_invites
+from redbot.core.utils.common_filters import filter_invites, filter_various_mentions
 
 _ = Translator("Mod", __file__)
 
@@ -1323,9 +1323,11 @@ class Mod:
         if roles is not None:
             data.add_field(name=_("Roles"), value=roles, inline=False)
         if names:
+            # May need sanitizing later, but mentions do not ping in embeds currently
             val = filter_invites(", ".join(names))
             data.add_field(name=_("Previous Names"), value=val, inline=False)
         if nicks:
+            # May need sanitizing later, but mentions do not ping in embeds currently
             val = filter_invites(", ".join(nicks))
             data.add_field(name=_("Previous Nicknames"), value=val, inline=False)
         if voice_state and voice_state.channel:
@@ -1369,6 +1371,7 @@ class Mod:
             msg += "\n"
             msg += ", ".join(nicks)
         if msg:
+            msg = filter_various_mentions(msg)
             await ctx.send(msg)
         else:
             await ctx.send(_("That user doesn't have any recorded name or nickname change."))
diff --git a/redbot/core/utils/common_filters.py b/redbot/core/utils/common_filters.py
index ca7040e3f..cf71f5558 100644
--- a/redbot/core/utils/common_filters.py
+++ b/redbot/core/utils/common_filters.py
@@ -7,6 +7,7 @@ __all__ = [
     "filter_urls",
     "filter_invites",
     "filter_mass_mentions",
+    "filter_various_mentions",
 ]
 
 # regexes
@@ -16,6 +17,7 @@ INVITE_URL_RE = re.compile(r"(discord.gg|discordapp.com/invite|discord.me)(\S+)"
 
 MASS_MENTION_RE = re.compile(r"(@)(?=everyone|here)")  # This only matches the @ for sanitizing
 
+OTHER_MENTION_RE = re.compile(r"(<)(@[!&]?|#)(\d+>)")
 
 # convenience wrappers
 def filter_urls(to_filter: str) -> str:
@@ -79,3 +81,23 @@ def filter_mass_mentions(to_filter: str) -> str:
 
     """
     return MASS_MENTION_RE.sub("@\u200b", to_filter)
+
+
+def filter_various_mentions(to_filter: str) -> str:
+    """
+    Get a string with role, user, and channel mentions sanitized.
+
+    This is mainly for use on user display names, not message content,
+    and should be applied sparingly.
+
+    Parameters
+    ----------
+    to_filter : str
+        The string to filter.
+
+    Returns
+    -------
+    str
+        The sanitized string.
+    """
+    return OTHER_MENTION_RE.sub(r"\1\\\2\3", to_filter)