// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. #nullable disable using System.Collections.Generic; using System.Collections.Specialized; using System.Diagnostics; using System.Linq; using System.Text.RegularExpressions; using osu.Framework.Allocation; using osu.Framework.Bindables; using osu.Framework.Graphics; using osu.Framework.Graphics.Sprites; using osu.Framework.Platform; using osu.Game.Configuration; using osu.Game.Graphics; using osu.Game.Online.API; using osu.Game.Online.API.Requests.Responses; using osu.Game.Overlays; using osu.Game.Overlays.Notifications; namespace osu.Game.Online.Chat { /// /// Component that handles creating and posting notifications for incoming messages. /// public partial class MessageNotifier : Component { [Resolved] private INotificationOverlay notifications { get; set; } [Resolved] private ChatOverlay chatOverlay { get; set; } [Resolved] private ChannelManager channelManager { get; set; } [Resolved] private GameHost host { get; set; } private Bindable notifyOnUsername; private Bindable notifyOnPrivateMessage; private readonly IBindable localUser = new Bindable(); private readonly IBindableList joinedChannels = new BindableList(); [BackgroundDependencyLoader] private void load(OsuConfigManager config, IAPIProvider api) { notifyOnUsername = config.GetBindable(OsuSetting.NotifyOnUsernameMentioned); notifyOnPrivateMessage = config.GetBindable(OsuSetting.NotifyOnPrivateMessage); localUser.BindTo(api.LocalUser); joinedChannels.BindTo(channelManager.JoinedChannels); } protected override void LoadComplete() { base.LoadComplete(); joinedChannels.BindCollectionChanged(channelsChanged, true); } private void channelsChanged(object sender, NotifyCollectionChangedEventArgs e) { switch (e.Action) { case NotifyCollectionChangedAction.Add: Debug.Assert(e.NewItems != null); foreach (var channel in e.NewItems.Cast()) channel.NewMessagesArrived += checkNewMessages; break; case NotifyCollectionChangedAction.Remove: Debug.Assert(e.OldItems != null); foreach (var channel in e.OldItems.Cast()) channel.NewMessagesArrived -= checkNewMessages; break; } } private void checkNewMessages(IEnumerable messages) { if (!messages.Any()) return; var channel = channelManager.JoinedChannels.SingleOrDefault(c => c.Id > 0 && c.Id == messages.First().ChannelId); if (channel == null) return; // Only send notifications if ChatOverlay or the target channel aren't visible, or if the window is unfocused if (chatOverlay.IsPresent && channelManager.CurrentChannel.Value == channel && host.IsActive.Value) return; foreach (var message in messages.OrderByDescending(m => m.Id)) { // ignore messages that already have been read if (message.Id <= channel.LastReadId) return; // ignore notifications triggered by local user's own chat messages if (message.Sender.Id == localUser.Value.Id) continue; // check for private messages first to avoid both posting two notifications about the same message if (checkForPMs(channel, message)) continue; checkForMentions(channel, message); } } /// /// Checks whether the user enabled private message notifications and whether specified is a direct message. /// /// The channel associated to the /// The message to be checked /// Whether a notification was fired. private bool checkForPMs(Channel channel, Message message) { if (!notifyOnPrivateMessage.Value || channel.Type != ChannelType.PM) return false; notifications.Post(new PrivateMessageNotification(message, channel)); return true; } private void checkForMentions(Channel channel, Message message) { if (!notifyOnUsername.Value || !CheckContainsUsername(message.Content, localUser.Value.Username)) return; notifications.Post(new MentionNotification(message, channel)); } /// /// Checks if mentions . /// This will match against the case where underscores are used instead of spaces (which is how osu-stable handles usernames with spaces). /// 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 partial class PrivateMessageNotification : HighlightMessageNotification { public PrivateMessageNotification(Message message, Channel channel) : base(message, channel) { Icon = FontAwesome.Solid.Envelope; Text = $"You received a private message from '{message.Sender.Username}'. Click to read it!"; } } public partial class MentionNotification : HighlightMessageNotification { public MentionNotification(Message message, Channel channel) : base(message, channel) { Icon = FontAwesome.Solid.At; Text = $"Your name was mentioned in chat by '{message.Sender.Username}'. Click to find out why!"; } } public abstract partial class HighlightMessageNotification : SimpleNotification { protected HighlightMessageNotification(Message message, Channel channel) { this.message = message; this.channel = channel; } private readonly Message message; private readonly Channel channel; public override bool IsImportant => false; [BackgroundDependencyLoader] private void load(OsuColour colours, ChatOverlay chatOverlay, INotificationOverlay notificationOverlay) { IconContent.Colour = colours.PurpleDark; Activated = delegate { notificationOverlay.Hide(); chatOverlay.HighlightMessage(message, channel); return true; }; } } } }