2019-10-29 13:32:38 +08:00
|
|
|
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
2019-01-24 16:43:03 +08:00
|
|
|
// See the LICENCE file in the repository root for full licence text.
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2022-06-17 15:37:17 +08:00
|
|
|
#nullable disable
|
|
|
|
|
2016-10-07 21:51:10 +08:00
|
|
|
using System;
|
|
|
|
using System.Collections.Generic;
|
2017-08-21 16:43:26 +08:00
|
|
|
using System.Diagnostics;
|
2016-10-07 21:51:10 +08:00
|
|
|
using System.Linq;
|
2019-06-20 22:01:39 +08:00
|
|
|
using osu.Framework.Allocation;
|
2022-03-08 08:19:35 +08:00
|
|
|
using osu.Framework.Bindables;
|
2016-10-07 21:51:10 +08:00
|
|
|
using osu.Framework.Graphics;
|
|
|
|
using osu.Framework.Graphics.Containers;
|
2017-09-14 14:43:47 +08:00
|
|
|
using osu.Game.Graphics.Cursor;
|
2021-05-26 14:59:29 +08:00
|
|
|
using osu.Game.Online.Chat;
|
2019-12-16 07:59:06 +08:00
|
|
|
using osuTK.Graphics;
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2017-05-12 13:21:57 +08:00
|
|
|
namespace osu.Game.Overlays.Chat
|
2016-10-07 21:51:10 +08:00
|
|
|
{
|
2018-07-10 00:30:41 +08:00
|
|
|
public class DrawableChannel : Container
|
2016-10-07 21:51:10 +08:00
|
|
|
{
|
2018-07-10 00:30:41 +08:00
|
|
|
public readonly Channel Channel;
|
2019-10-22 08:11:19 +08:00
|
|
|
protected FillFlowContainer ChatLineFlow;
|
2021-02-01 04:37:52 +08:00
|
|
|
private ChannelScrollContainer scroll;
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2020-03-23 11:03:33 +08:00
|
|
|
private bool scrollbarVisible = true;
|
|
|
|
|
|
|
|
public bool ScrollbarVisible
|
|
|
|
{
|
|
|
|
set
|
|
|
|
{
|
|
|
|
if (scrollbarVisible == value) return;
|
|
|
|
|
|
|
|
scrollbarVisible = value;
|
|
|
|
if (scroll != null)
|
|
|
|
scroll.ScrollbarVisible = value;
|
|
|
|
}
|
|
|
|
}
|
2019-12-16 07:48:22 +08:00
|
|
|
|
2018-07-10 00:30:41 +08:00
|
|
|
public DrawableChannel(Channel channel)
|
2016-10-07 21:51:10 +08:00
|
|
|
{
|
2018-07-10 00:30:41 +08:00
|
|
|
Channel = channel;
|
2016-10-07 23:43:06 +08:00
|
|
|
RelativeSizeAxes = Axes.Both;
|
2019-06-20 22:01:39 +08:00
|
|
|
}
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2022-03-08 08:19:35 +08:00
|
|
|
private Bindable<Message> highlightedMessage;
|
|
|
|
|
2019-06-20 22:01:39 +08:00
|
|
|
[BackgroundDependencyLoader]
|
2020-01-20 00:56:01 +08:00
|
|
|
private void load()
|
2019-06-20 22:01:39 +08:00
|
|
|
{
|
2019-08-14 09:53:47 +08:00
|
|
|
Child = new OsuContextMenuContainer
|
2016-10-07 21:51:10 +08:00
|
|
|
{
|
2019-08-14 09:53:47 +08:00
|
|
|
RelativeSizeAxes = Axes.Both,
|
|
|
|
Masking = true,
|
2021-02-01 04:37:52 +08:00
|
|
|
Child = scroll = new ChannelScrollContainer
|
2016-10-07 21:51:10 +08:00
|
|
|
{
|
2020-03-23 11:03:33 +08:00
|
|
|
ScrollbarVisible = scrollbarVisible,
|
2017-02-18 03:08:28 +08:00
|
|
|
RelativeSizeAxes = Axes.Both,
|
2019-08-14 09:53:47 +08:00
|
|
|
// Some chat lines have effects that slightly protrude to the bottom,
|
|
|
|
// which we do not want to mask away, hence the padding.
|
|
|
|
Padding = new MarginPadding { Bottom = 5 },
|
2019-10-22 08:11:19 +08:00
|
|
|
Child = ChatLineFlow = new FillFlowContainer
|
2016-10-07 21:51:10 +08:00
|
|
|
{
|
2022-06-07 08:37:46 +08:00
|
|
|
Padding = new MarginPadding { Horizontal = 10 },
|
2019-08-14 09:53:47 +08:00
|
|
|
RelativeSizeAxes = Axes.X,
|
|
|
|
AutoSizeAxes = Axes.Y,
|
|
|
|
Direction = FillDirection.Vertical,
|
|
|
|
}
|
|
|
|
},
|
2016-10-07 23:43:06 +08:00
|
|
|
};
|
2022-03-08 08:19:35 +08:00
|
|
|
|
2022-03-08 09:43:40 +08:00
|
|
|
newMessagesArrived(Channel.Messages);
|
2018-12-03 17:13:10 +08:00
|
|
|
|
|
|
|
Channel.NewMessagesArrived += newMessagesArrived;
|
|
|
|
Channel.MessageRemoved += messageRemoved;
|
|
|
|
Channel.PendingMessageResolved += pendingMessageResolved;
|
2022-03-08 09:43:40 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
protected override void LoadComplete()
|
|
|
|
{
|
|
|
|
base.LoadComplete();
|
2018-12-03 17:13:10 +08:00
|
|
|
|
2022-03-08 08:19:35 +08:00
|
|
|
highlightedMessage = Channel.HighlightedMessage.GetBoundCopy();
|
2022-03-11 04:06:58 +08:00
|
|
|
highlightedMessage.BindValueChanged(_ => processMessageHighlighting(), true);
|
|
|
|
}
|
2022-03-05 04:21:29 +08:00
|
|
|
|
2022-03-11 04:06:58 +08:00
|
|
|
/// <summary>
|
|
|
|
/// Processes any pending message in <see cref="highlightedMessage"/>.
|
|
|
|
/// </summary>
|
2022-03-11 23:34:22 +08:00
|
|
|
// ScheduleAfterChildren is for ensuring the scroll flow has updated with any new chat lines.
|
2022-03-11 23:32:32 +08:00
|
|
|
private void processMessageHighlighting() => SchedulerAfterChildren.AddOnce(() =>
|
2022-03-11 04:06:58 +08:00
|
|
|
{
|
|
|
|
if (highlightedMessage.Value == null)
|
|
|
|
return;
|
2022-03-08 09:43:40 +08:00
|
|
|
|
2022-03-16 17:38:01 +08:00
|
|
|
var chatLine = chatLines.FirstOrDefault(c => c.Message.Equals(highlightedMessage.Value));
|
2022-03-11 04:06:58 +08:00
|
|
|
if (chatLine == null)
|
|
|
|
return;
|
2022-03-08 08:19:35 +08:00
|
|
|
|
2022-03-11 04:06:58 +08:00
|
|
|
float center = scroll.GetChildPosInContent(chatLine, chatLine.DrawSize / 2) - scroll.DisplayableContent / 2;
|
|
|
|
scroll.ScrollTo(Math.Clamp(center, 0, scroll.ScrollableExtent));
|
|
|
|
chatLine.Highlight();
|
|
|
|
|
|
|
|
highlightedMessage.Value = null;
|
|
|
|
});
|
2022-03-05 04:21:29 +08:00
|
|
|
|
2016-10-07 21:51:10 +08:00
|
|
|
protected override void Dispose(bool isDisposing)
|
|
|
|
{
|
|
|
|
base.Dispose(isDisposing);
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2018-07-10 00:30:41 +08:00
|
|
|
Channel.NewMessagesArrived -= newMessagesArrived;
|
|
|
|
Channel.MessageRemoved -= messageRemoved;
|
|
|
|
Channel.PendingMessageResolved -= pendingMessageResolved;
|
2016-10-07 21:51:10 +08:00
|
|
|
}
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2018-12-21 16:54:12 +08:00
|
|
|
protected virtual ChatLine CreateChatLine(Message m) => new ChatLine(m);
|
|
|
|
|
2022-06-04 23:11:49 +08:00
|
|
|
protected virtual DaySeparator CreateDaySeparator(DateTimeOffset time) => new DaySeparator(time);
|
2019-10-22 05:44:58 +08:00
|
|
|
|
2022-03-08 09:43:40 +08:00
|
|
|
private void newMessagesArrived(IEnumerable<Message> newMessages) => Schedule(() =>
|
2022-03-08 08:19:35 +08:00
|
|
|
{
|
2022-03-08 09:43:40 +08:00
|
|
|
if (newMessages.Min(m => m.Id) < chatLines.Max(c => c.Message.Id))
|
2020-04-29 14:23:28 +08:00
|
|
|
{
|
|
|
|
// there is a case (on initial population) that we may receive past messages and need to reorder.
|
|
|
|
// easiest way is to just combine messages and recreate drawables (less worrying about day separators etc.)
|
2022-03-08 09:43:40 +08:00
|
|
|
newMessages = newMessages.Concat(chatLines.Select(c => c.Message)).OrderBy(m => m.Id).ToList();
|
2020-04-29 14:23:28 +08:00
|
|
|
ChatLineFlow.Clear();
|
|
|
|
}
|
2019-10-29 13:33:05 +08:00
|
|
|
|
2018-07-10 00:30:41 +08:00
|
|
|
// Add up to last Channel.MAX_HISTORY messages
|
2022-03-08 09:43:40 +08:00
|
|
|
var displayMessages = newMessages.Skip(Math.Max(0, newMessages.Count() - Channel.MAX_HISTORY));
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2019-10-22 23:14:22 +08:00
|
|
|
Message lastMessage = chatLines.LastOrDefault()?.Message;
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2019-10-22 23:16:17 +08:00
|
|
|
foreach (var message in displayMessages)
|
2019-10-22 05:44:58 +08:00
|
|
|
{
|
2022-11-21 12:51:49 +08:00
|
|
|
addDaySeparatorIfRequired(lastMessage, message);
|
2019-10-22 05:44:58 +08:00
|
|
|
|
2019-10-22 23:16:17 +08:00
|
|
|
ChatLineFlow.Add(CreateChatLine(message));
|
|
|
|
lastMessage = message;
|
|
|
|
}
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2019-10-22 23:14:22 +08:00
|
|
|
var staleMessages = chatLines.Where(c => c.LifetimeEnd == double.MaxValue).ToArray();
|
2022-11-23 17:49:51 +08:00
|
|
|
|
2019-10-29 13:32:38 +08:00
|
|
|
int count = staleMessages.Length - Channel.MAX_HISTORY;
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2019-10-29 14:45:41 +08:00
|
|
|
if (count > 0)
|
2017-02-20 20:10:23 +08:00
|
|
|
{
|
2019-10-29 14:45:41 +08:00
|
|
|
for (int i = 0; i < count; i++)
|
|
|
|
expireAndAdjustScroll(staleMessages[i]);
|
|
|
|
|
2022-11-23 17:49:51 +08:00
|
|
|
removeAdjacentDaySeparators();
|
2017-02-20 20:10:23 +08:00
|
|
|
}
|
2019-10-29 13:33:05 +08:00
|
|
|
|
2021-02-01 04:37:52 +08:00
|
|
|
// due to the scroll adjusts from old messages removal above, a scroll-to-end must be enforced,
|
|
|
|
// to avoid making the container think the user has scrolled back up and unwantedly disable auto-scrolling.
|
2022-03-08 09:43:40 +08:00
|
|
|
if (newMessages.Any(m => m is LocalMessage))
|
2021-02-02 14:16:10 +08:00
|
|
|
scroll.ScrollToEnd();
|
2022-03-11 04:06:58 +08:00
|
|
|
|
|
|
|
processMessageHighlighting();
|
2022-03-08 09:43:40 +08:00
|
|
|
});
|
|
|
|
|
|
|
|
private void pendingMessageResolved(Message existing, Message updated) => Schedule(() =>
|
|
|
|
{
|
|
|
|
var found = chatLines.LastOrDefault(c => c.Message == existing);
|
|
|
|
|
|
|
|
if (found != null)
|
|
|
|
{
|
|
|
|
Trace.Assert(updated.Id.HasValue, "An updated message was returned with no ID.");
|
|
|
|
|
2022-08-26 14:19:05 +08:00
|
|
|
ChatLineFlow.Remove(found, false);
|
2022-03-08 09:43:40 +08:00
|
|
|
found.Message = updated;
|
2022-11-21 12:51:49 +08:00
|
|
|
|
|
|
|
addDaySeparatorIfRequired(chatLines.LastOrDefault()?.Message, updated);
|
2022-03-08 09:43:40 +08:00
|
|
|
ChatLineFlow.Add(found);
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
2022-11-21 12:51:49 +08:00
|
|
|
private void addDaySeparatorIfRequired(Message lastMessage, Message message)
|
|
|
|
{
|
|
|
|
if (lastMessage == null || lastMessage.Timestamp.ToLocalTime().Date != message.Timestamp.ToLocalTime().Date)
|
2022-11-21 13:01:10 +08:00
|
|
|
{
|
|
|
|
// A day separator is displayed even if no messages are in the channel.
|
|
|
|
// If there are no messages after it, the simplest way to ensure it is fresh is to remove it
|
|
|
|
// and add a new one instead.
|
|
|
|
if (ChatLineFlow.LastOrDefault() is DaySeparator ds)
|
|
|
|
ChatLineFlow.Remove(ds, true);
|
|
|
|
|
2022-11-21 12:51:49 +08:00
|
|
|
ChatLineFlow.Add(CreateDaySeparator(message.Timestamp));
|
2022-11-23 17:49:51 +08:00
|
|
|
|
|
|
|
removeAdjacentDaySeparators();
|
2022-11-21 13:01:10 +08:00
|
|
|
}
|
2022-11-21 12:51:49 +08:00
|
|
|
}
|
|
|
|
|
2022-11-23 17:49:51 +08:00
|
|
|
private void removeAdjacentDaySeparators()
|
|
|
|
{
|
|
|
|
// remove all adjacent day separators after stale message removal
|
|
|
|
for (int i = 0; i < ChatLineFlow.Count - 1; i++)
|
|
|
|
{
|
|
|
|
if (!(ChatLineFlow[i] is DaySeparator)) break;
|
|
|
|
if (!(ChatLineFlow[i + 1] is DaySeparator)) break;
|
|
|
|
|
|
|
|
expireAndAdjustScroll(ChatLineFlow[i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
private void expireAndAdjustScroll(Drawable d)
|
|
|
|
{
|
|
|
|
scroll.OffsetScrollPosition(-d.DrawHeight);
|
|
|
|
d.Expire();
|
|
|
|
}
|
|
|
|
|
2022-03-08 09:43:40 +08:00
|
|
|
private void messageRemoved(Message removed) => Schedule(() =>
|
|
|
|
{
|
|
|
|
chatLines.FirstOrDefault(c => c.Message == removed)?.FadeColour(Color4.Red, 400).FadeOut(600).Expire();
|
|
|
|
});
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2019-10-22 23:14:22 +08:00
|
|
|
private IEnumerable<ChatLine> chatLines => ChatLineFlow.Children.OfType<ChatLine>();
|
2016-10-07 21:51:10 +08:00
|
|
|
}
|
2017-05-11 22:10:48 +08:00
|
|
|
}
|