Merge pull request #15967 from tbrose/chat-mention-fix

Check word boundaries during username mention matching

osu.Game.Tests/Online/Chat/MessageNotifierTest.cs

@@ -0,0 +1,90 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using NUnit.Framework;
+using osu.Game.Online.Chat;
+
+namespace osu.Game.Tests.Online.Chat
+{
+    [TestFixture]
+    public class MessageNotifierTest
+    {
+        [Test]
+        public void TestContainsUsernameMidlinePositive()
+        {
+            Assert.IsTrue(MessageNotifier.CheckContainsUsername("This is a test message", "Test"));
+        }
+
+        [Test]
+        public void TestContainsUsernameStartOfLinePositive()
+        {
+            Assert.IsTrue(MessageNotifier.CheckContainsUsername("Test message", "Test"));
+        }
+
+        [Test]
+        public void TestContainsUsernameEndOfLinePositive()
+        {
+            Assert.IsTrue(MessageNotifier.CheckContainsUsername("This is a test", "Test"));
+        }
+
+        [Test]
+        public void TestContainsUsernameMidlineNegative()
+        {
+            Assert.IsFalse(MessageNotifier.CheckContainsUsername("This is a testmessage for notifications", "Test"));
+        }
+
+        [Test]
+        public void TestContainsUsernameStartOfLineNegative()
+        {
+            Assert.IsFalse(MessageNotifier.CheckContainsUsername("Testmessage", "Test"));
+        }
+
+        [Test]
+        public void TestContainsUsernameEndOfLineNegative()
+        {
+            Assert.IsFalse(MessageNotifier.CheckContainsUsername("This is a notificationtest", "Test"));
+        }
+
+        [Test]
+        public void TestContainsUsernameBetweenInterpunction()
+        {
+            Assert.IsTrue(MessageNotifier.CheckContainsUsername("Hello 'test'-message", "Test"));
+        }
+
+        [Test]
+        public void TestContainsUsernameUnicode()
+        {
+            Assert.IsTrue(MessageNotifier.CheckContainsUsername("Test \u0460\u0460 message", "\u0460\u0460"));
+        }
+
+        [Test]
+        public void TestContainsUsernameUnicodeNegative()
+        {
+            Assert.IsFalse(MessageNotifier.CheckContainsUsername("Test ha\u0460\u0460o message", "\u0460\u0460"));
+        }
+
+        [Test]
+        public void TestContainsUsernameSpecialCharactersPositive()
+        {
+            Assert.IsTrue(MessageNotifier.CheckContainsUsername("Test [#^-^#] message", "[#^-^#]"));
+        }
+
+        [Test]
+        public void TestContainsUsernameSpecialCharactersNegative()
+        {
+            Assert.IsFalse(MessageNotifier.CheckContainsUsername("Test pad[#^-^#]oru message", "[#^-^#]"));
+        }
+
+        [Test]
+        public void TestContainsUsernameAtSign()
+        {
+            Assert.IsTrue(MessageNotifier.CheckContainsUsername("@username hi", "username"));
+        }
+
+        [Test]
+        public void TestContainsUsernameColon()
+        {
+            Assert.IsTrue(MessageNotifier.CheckContainsUsername("username: hi", "username"));
+        }
+    }
+}

osu.Game/Online/Chat/MessageNotifier.cs

@@ -1,10 +1,10 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-using System;
 using System.Collections.Generic;
 using System.Collections.Specialized;
 using System.Linq;
+using System.Text.RegularExpressions;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
@@ -120,16 +120,21 @@ namespace osu.Game.Online.Chat
 
         private void checkForMentions(Channel channel, Message message)
         {
-            if (!notifyOnUsername.Value || !checkContainsUsername(message.Content, localUser.Value.Username)) return;
+            if (!notifyOnUsername.Value || !CheckContainsUsername(message.Content, localUser.Value.Username)) return;
 
             notifications.Post(new MentionNotification(message.Sender.Username, channel));
         }
 
         /// <summary>
-        /// Checks if <paramref name="message"/> contains <paramref name="username"/>.
+        /// Checks if <paramref name="message"/> mentions <paramref name="username"/>.
         /// This will match against the case where underscores are used instead of spaces (which is how osu-stable handles usernames with spaces).
         /// </summary>
-        private static bool checkContainsUsername(string message, string username) => message.Contains(username, StringComparison.OrdinalIgnoreCase) || message.Contains(username.Replace(' ', '_'), StringComparison.OrdinalIgnoreCase);
+        public static bool CheckContainsUsername(string message, string username)
+        {
+            string fullName = Regex.Escape(username);
+            string underscoreName = Regex.Escape(username.Replace(' ', '_'));
+            return Regex.IsMatch(message, $@"(^|\W)({fullName}|{underscoreName})($|\W)", RegexOptions.IgnoreCase);
+        }
 
         public class PrivateMessageNotification : OpenChannelNotification
         {