From ad21098bf2aac54d52595933cc03964fc6480ab6 Mon Sep 17 00:00:00 2001 From: Nerixyz Date: Sat, 26 Oct 2024 14:57:29 +0200 Subject: [PATCH 1/4] refactor: deduplicate irc parsing --- src/CMakeLists.txt | 6 + src/common/Channel.cpp | 26 +- src/common/Channel.hpp | 28 +- src/common/enums/MessageContext.hpp | 13 + src/messages/MessageSimilarity.cpp | 51 ++ src/messages/MessageSimilarity.hpp | 73 ++ src/messages/MessageSink.hpp | 58 ++ src/providers/recentmessages/Impl.cpp | 24 +- src/providers/twitch/IrcMessageHandler.cpp | 844 ++++-------------- src/providers/twitch/IrcMessageHandler.hpp | 20 +- src/providers/twitch/TwitchChannel.cpp | 4 +- src/providers/twitch/TwitchIrcServer.cpp | 2 +- src/util/VectorMessageSink.cpp | 86 ++ src/util/VectorMessageSink.hpp | 36 + .../IrcMessageHandler/announcement.json | 1 + .../IrcMessageHandler/reply-child.json | 3 +- .../shared-chat-announcement.json | 1 + .../IrcMessageHandler/sub-message.json | 1 + tests/src/IrcMessageHandler.cpp | 20 +- 19 files changed, 565 insertions(+), 732 deletions(-) create mode 100644 src/common/enums/MessageContext.hpp create mode 100644 src/messages/MessageSimilarity.cpp create mode 100644 src/messages/MessageSimilarity.hpp create mode 100644 src/messages/MessageSink.hpp create mode 100644 src/util/VectorMessageSink.cpp create mode 100644 src/util/VectorMessageSink.hpp diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 9d7134b97..74a7f8cff 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -39,6 +39,7 @@ set(SOURCE_FILES common/WindowDescriptors.cpp common/WindowDescriptors.hpp + common/enums/MessageContext.hpp common/enums/MessageOverflow.hpp common/network/NetworkCommon.cpp @@ -281,6 +282,9 @@ set(SOURCE_FILES messages/MessageElement.cpp messages/MessageElement.hpp messages/MessageFlag.hpp + messages/MessageSimilarity.cpp + messages/MessageSimilarity.hpp + messages/MessageSink.hpp messages/MessageThread.cpp messages/MessageThread.hpp @@ -526,6 +530,8 @@ set(SOURCE_FILES util/Twitch.hpp util/TypeName.hpp util/Variant.hpp + util/VectorMessageSink.cpp + util/VectorMessageSink.hpp util/WidgetHelpers.cpp util/WidgetHelpers.hpp util/WindowsHelper.cpp diff --git a/src/common/Channel.cpp b/src/common/Channel.cpp index ef778bad1..18f55c02b 100644 --- a/src/common/Channel.cpp +++ b/src/common/Channel.cpp @@ -3,7 +3,9 @@ #include "Application.hpp" #include "messages/Message.hpp" #include "messages/MessageBuilder.hpp" +#include "messages/MessageSimilarity.hpp" #include "providers/twitch/IrcMessageHandler.hpp" +#include "providers/twitch/TwitchIrcServer.hpp" #include "singletons/Emotes.hpp" #include "singletons/Logging.hpp" #include "singletons/Settings.hpp" @@ -121,10 +123,10 @@ void Channel::addSystemMessage(const QString &contents) this->addMessage(msg, MessageContext::Original); } -void Channel::addOrReplaceTimeout(MessagePtr message) +void Channel::addOrReplaceTimeout(MessagePtr message, QTime now) { addOrReplaceChannelTimeout( - this->getMessageSnapshot(), std::move(message), QTime::currentTime(), + this->getMessageSnapshot(), std::move(message), now, [this](auto /*idx*/, auto msg, auto replacement) { this->replaceMessage(msg, replacement); }, @@ -287,10 +289,15 @@ void Channel::clearMessages() } MessagePtr Channel::findMessage(QString messageID) +{ + return this->findMessageByID(messageID); +} + +MessagePtr Channel::findMessageByID(QStringView messageID) { MessagePtr res; - if (auto msg = this->messages_.rfind([&messageID](const MessagePtr &msg) { + if (auto msg = this->messages_.rfind([messageID](const MessagePtr &msg) { return msg->id == messageID; }); msg) @@ -301,6 +308,19 @@ MessagePtr Channel::findMessage(QString messageID) return res; } +void Channel::applySimilarityFilters(const MessagePtr &message) const +{ + setSimilarityFlags(message, this->messages_.getSnapshot()); +} + +MessageSinkTraits Channel::sinkTraits() const +{ + return { + MessageSinkTrait::AddMentionsToGlobalChannel, + MessageSinkTrait::RequiresKnownChannelPointReward, + }; +} + bool Channel::canSendMessage() const { return false; diff --git a/src/common/Channel.hpp b/src/common/Channel.hpp index ac90573ff..86037e6c8 100644 --- a/src/common/Channel.hpp +++ b/src/common/Channel.hpp @@ -1,8 +1,10 @@ #pragma once +#include "common/enums/MessageContext.hpp" #include "controllers/completion/TabCompletionModel.hpp" #include "messages/LimitedQueue.hpp" #include "messages/MessageFlag.hpp" +#include "messages/MessageSink.hpp" #include #include @@ -26,15 +28,7 @@ enum class TimeoutStackStyle : int { Default = DontStackBeyondUserMessage, }; -/// Context of the message being added to a channel -enum class MessageContext { - /// This message is the original - Original, - /// This message is a repost of a message that has already been added in a channel - Repost, -}; - -class Channel : public std::enable_shared_from_this +class Channel : public std::enable_shared_from_this, public MessageSink { public: // This is for Lua. See scripts/make_luals_meta.py @@ -55,7 +49,7 @@ public: }; explicit Channel(const QString &name, Type type); - virtual ~Channel(); + ~Channel() override; // SIGNALS pajlada::Signals::Signal @@ -85,8 +79,9 @@ public: // overridingFlags can be filled in with flags that should be used instead // of the message's flags. This is useful in case a flag is specific to a // type of split - void addMessage(MessagePtr message, MessageContext context, - std::optional overridingFlags = std::nullopt); + void addMessage( + MessagePtr message, MessageContext context, + std::optional overridingFlags = std::nullopt) final; void addMessagesAtStart(const std::vector &messages_); void addSystemMessage(const QString &contents); @@ -94,8 +89,8 @@ public: /// Inserts the given messages in order by Message::serverReceivedTime. void fillInMissingMessages(const std::vector &messages); - void addOrReplaceTimeout(MessagePtr message); - void disableAllMessages(); + void addOrReplaceTimeout(MessagePtr message, QTime now) final; + void disableAllMessages() final; void replaceMessage(MessagePtr message, MessagePtr replacement); void replaceMessage(size_t index, MessagePtr replacement); void deleteMessage(QString messageID); @@ -104,9 +99,14 @@ public: void clearMessages(); MessagePtr findMessage(QString messageID); + MessagePtr findMessageByID(QStringView messageID) final; bool hasMessages() const; + void applySimilarityFilters(const MessagePtr &message) const final; + + MessageSinkTraits sinkTraits() const final; + // CHANNEL INFO virtual bool canSendMessage() const; virtual bool isWritable() const; // whether split input will be usable diff --git a/src/common/enums/MessageContext.hpp b/src/common/enums/MessageContext.hpp new file mode 100644 index 000000000..669e55315 --- /dev/null +++ b/src/common/enums/MessageContext.hpp @@ -0,0 +1,13 @@ +#pragma once + +namespace chatterino { + +/// Context of the message being added to a channel +enum class MessageContext { + /// This message is the original + Original, + /// This message is a repost of a message that has already been added in a channel + Repost, +}; + +} // namespace chatterino diff --git a/src/messages/MessageSimilarity.cpp b/src/messages/MessageSimilarity.cpp new file mode 100644 index 000000000..3019aea67 --- /dev/null +++ b/src/messages/MessageSimilarity.cpp @@ -0,0 +1,51 @@ +#include "messages/MessageSimilarity.hpp" + +#include +#include + +namespace chatterino::similarity::detail { + +float relativeSimilarity(QStringView str1, QStringView str2) +{ + using SizeType = QStringView::size_type; + + // Longest Common Substring Problem + std::vector> tree(str1.size(), + std::vector(str2.size(), 0)); + int z = 0; + + for (SizeType i = 0; i < str1.size(); ++i) + { + for (SizeType j = 0; j < str2.size(); ++j) + { + if (str1[i] == str2[j]) + { + if (i == 0 || j == 0) + { + tree[i][j] = 1; + } + else + { + tree[i][j] = tree[i - 1][j - 1] + 1; + } + z = std::max(tree[i][j], z); + } + else + { + tree[i][j] = 0; + } + } + } + + // ensure that no div by 0 + if (z == 0) + { + return 0.F; + } + + auto div = std::max<>({static_cast(1), str1.size(), str2.size()}); + + return float(z) / float(div); +} + +} // namespace chatterino::similarity::detail diff --git a/src/messages/MessageSimilarity.hpp b/src/messages/MessageSimilarity.hpp new file mode 100644 index 000000000..562e574ad --- /dev/null +++ b/src/messages/MessageSimilarity.hpp @@ -0,0 +1,73 @@ +#pragma once + +#include "Application.hpp" +#include "controllers/accounts/AccountController.hpp" +#include "messages/Message.hpp" +#include "providers/twitch/TwitchAccount.hpp" +#include "singletons/Settings.hpp" + +#include + +namespace chatterino::similarity::detail { + +float relativeSimilarity(QStringView str1, QStringView str2); + +float inMessages(const MessagePtr &msg, + const std::ranges::bidirectional_range auto &messages) +{ + float similarityPercent = 0.0F; + + for (const auto &prevMsg : + messages | std::views::reverse | + std::views::take(getSettings()->hideSimilarMaxMessagesToCheck)) + { + if (prevMsg->parseTime.secsTo(QTime::currentTime()) >= + getSettings()->hideSimilarMaxDelay) + { + break; + } + if (getSettings()->hideSimilarBySameUser && + msg->loginName != prevMsg->loginName) + { + continue; + } + similarityPercent = std::max( + similarityPercent, + relativeSimilarity(msg->messageText, prevMsg->messageText)); + } + + return similarityPercent; +} + +} // namespace chatterino::similarity::detail + +namespace chatterino { + +void setSimilarityFlags(const MessagePtr &message, + const std::ranges::bidirectional_range auto &messages) +{ + if (getSettings()->similarityEnabled) + { + bool isMyself = + message->loginName == + getApp()->getAccounts()->twitch.getCurrent()->getUserName(); + bool hideMyself = getSettings()->hideSimilarMyself; + + if (isMyself && !hideMyself) + { + return; + } + + if (similarity::detail::inMessages(message, messages) > + getSettings()->similarityPercentage) + { + message->flags.set(MessageFlag::Similar); + if (getSettings()->colorSimilarDisabled) + { + message->flags.set(MessageFlag::Disabled); + } + } + } +} + +} // namespace chatterino diff --git a/src/messages/MessageSink.hpp b/src/messages/MessageSink.hpp new file mode 100644 index 000000000..07e7101a5 --- /dev/null +++ b/src/messages/MessageSink.hpp @@ -0,0 +1,58 @@ +#pragma once + +#include "common/enums/MessageContext.hpp" +#include "messages/MessageFlag.hpp" + +#include + +class QStringView; +class QTime; + +namespace chatterino { + +struct Message; +using MessagePtr = std::shared_ptr; + +enum class MessageSinkTrait : uint8_t { + None = 0, + AddMentionsToGlobalChannel = 1 << 0, + RequiresKnownChannelPointReward = 1 << 1, +}; +using MessageSinkTraits = FlagsEnum; + +/// A generic interface for a managed buffer of `Message`s +class MessageSink +{ +public: + virtual ~MessageSink() = default; + + /// Add a message to this sink + /// + /// @param message The message to add (non-null) + /// @param ctx The context in which this message is being added. + /// @param overridingFlags + virtual void addMessage( + MessagePtr message, MessageContext ctx, + std::optional overridingFlags = std::nullopt) = 0; + + /// Adds a timeout message or merges it into an existing one + virtual void addOrReplaceTimeout(MessagePtr clearchatMessage, + QTime now) = 0; + + /// Flags all messages as `Disabled` + virtual void disableAllMessages() = 0; + + /// Searches for similar messages and flags this message as similar + /// (based on the current settings). + virtual void applySimilarityFilters(const MessagePtr &message) const = 0; + + /// @brief Searches for a message by an ID + /// + /// If there is no message found, an empty shared-pointer is returned. + virtual MessagePtr findMessageByID(QStringView id) = 0; + + /// + virtual MessageSinkTraits sinkTraits() const = 0; +}; + +} // namespace chatterino diff --git a/src/providers/recentmessages/Impl.cpp b/src/providers/recentmessages/Impl.cpp index 410a34aac..4605204eb 100644 --- a/src/providers/recentmessages/Impl.cpp +++ b/src/providers/recentmessages/Impl.cpp @@ -3,7 +3,9 @@ #include "common/Env.hpp" #include "messages/MessageBuilder.hpp" #include "providers/twitch/IrcMessageHandler.hpp" +#include "providers/twitch/TwitchChannel.hpp" #include "util/Helpers.hpp" +#include "util/VectorMessageSink.hpp" #include #include @@ -40,7 +42,13 @@ std::vector parseRecentMessages( std::vector buildRecentMessages( std::vector &messages, Channel *channel) { - std::vector allBuiltMessages; + VectorMessageSink sink({}, MessageFlag::RecentMessage); + + auto *twitchChannel = dynamic_cast(channel); + if (!twitchChannel) + { + return {}; + } for (auto *message : messages) { @@ -58,24 +66,16 @@ std::vector buildRecentMessages( auto msg = makeSystemMessage( QLocale().toString(msgDate, QLocale::LongFormat), QTime(0, 0)); - msg->flags.set(MessageFlag::RecentMessage); - allBuiltMessages.emplace_back(msg); + sink.addMessage(msg, MessageContext::Original); } } - auto builtMessages = IrcMessageHandler::parseMessageWithReply( - channel, message, allBuiltMessages); - - for (const auto &builtMessage : builtMessages) - { - builtMessage->flags.set(MessageFlag::RecentMessage); - allBuiltMessages.emplace_back(builtMessage); - } + IrcMessageHandler::parseMessageInto(message, sink, twitchChannel); message->deleteLater(); } - return allBuiltMessages; + return std::move(sink).takeMessages(); } // Returns the URL to be used for querying the Recent Messages API for the diff --git a/src/providers/twitch/IrcMessageHandler.cpp b/src/providers/twitch/IrcMessageHandler.cpp index 0c345da83..9a230bf9b 100644 --- a/src/providers/twitch/IrcMessageHandler.cpp +++ b/src/providers/twitch/IrcMessageHandler.cpp @@ -7,24 +7,21 @@ #include "common/QLogging.hpp" #include "controllers/accounts/AccountController.hpp" #include "controllers/ignores/IgnoreController.hpp" -#include "messages/LimitedQueue.hpp" #include "messages/Link.hpp" #include "messages/Message.hpp" #include "messages/MessageBuilder.hpp" #include "messages/MessageColor.hpp" #include "messages/MessageElement.hpp" +#include "messages/MessageSink.hpp" #include "messages/MessageThread.hpp" -#include "providers/twitch/ChannelPointReward.hpp" #include "providers/twitch/TwitchAccount.hpp" #include "providers/twitch/TwitchAccountManager.hpp" #include "providers/twitch/TwitchChannel.hpp" #include "providers/twitch/TwitchHelpers.hpp" #include "providers/twitch/TwitchIrcServer.hpp" -#include "singletons/Resources.hpp" #include "singletons/Settings.hpp" #include "singletons/StreamerMode.hpp" #include "singletons/WindowManager.hpp" -#include "util/ChannelHelpers.hpp" #include "util/FormatTime.hpp" #include "util/Helpers.hpp" #include "util/IrcHelpers.hpp" @@ -34,7 +31,6 @@ #include #include -#include using namespace chatterino::literals; @@ -165,50 +161,6 @@ ChannelPtr channelOrEmptyByTarget(const QString &target, return server.getChannelOrEmpty(channelName); } -float relativeSimilarity(const QString &str1, const QString &str2) -{ - // Longest Common Substring Problem - std::vector> tree(str1.size(), - std::vector(str2.size(), 0)); - int z = 0; - - for (int i = 0; i < str1.size(); ++i) - { - for (int j = 0; j < str2.size(); ++j) - { - if (str1[i] == str2[j]) - { - if (i == 0 || j == 0) - { - tree[i][j] = 1; - } - else - { - tree[i][j] = tree[i - 1][j - 1] + 1; - } - if (tree[i][j] > z) - { - z = tree[i][j]; - } - } - else - { - tree[i][j] = 0; - } - } - } - - // ensure that no div by 0 - if (z == 0) - { - return 0.F; - } - - auto div = std::max(1, std::max(str1.size(), str2.size())); - - return float(z) / float(div); -} - QMap parseBadges(const QString &badgesString) { QMap badges; @@ -232,106 +184,6 @@ struct ReplyContext { MessagePtr parent; }; -[[nodiscard]] ReplyContext getReplyContext( - TwitchChannel *channel, Communi::IrcMessage *message, - const std::vector &otherLoaded) -{ - ReplyContext ctx; - - const auto &tags = message->tags(); - if (const auto it = tags.find("reply-thread-parent-msg-id"); - it != tags.end()) - { - const QString replyID = it.value().toString(); - auto threadIt = channel->threads().find(replyID); - std::shared_ptr rootThread; - if (threadIt != channel->threads().end()) - { - auto owned = threadIt->second.lock(); - if (owned) - { - // Thread already exists (has a reply) - checkThreadSubscription(tags, message->nick(), owned); - ctx.thread = owned; - rootThread = owned; - } - } - - if (!rootThread) - { - MessagePtr foundMessage; - - // Thread does not yet exist, find root reply and create thread. - // Linear search is justified by the infrequent use of replies - for (const auto &otherMsg : otherLoaded) - { - if (otherMsg->id == replyID) - { - // Found root reply message - foundMessage = otherMsg; - break; - } - } - - if (!foundMessage) - { - // We didn't find the reply root message in the otherLoaded messages - // which are typically the already-parsed recent messages from the - // Recent Messages API. We could have a really old message that - // still exists being replied to, so check for that here. - foundMessage = channel->findMessage(replyID); - } - - if (foundMessage) - { - std::shared_ptr newThread = - std::make_shared(foundMessage); - checkThreadSubscription(tags, message->nick(), newThread); - - ctx.thread = newThread; - rootThread = newThread; - // Store weak reference to thread in channel - channel->addReplyThread(newThread); - } - } - - if (const auto parentIt = tags.find("reply-parent-msg-id"); - parentIt != tags.end()) - { - const QString parentID = parentIt.value().toString(); - if (replyID == parentID) - { - if (rootThread) - { - ctx.parent = rootThread->root(); - } - } - else - { - auto parentThreadIt = channel->threads().find(parentID); - if (parentThreadIt != channel->threads().end()) - { - auto thread = parentThreadIt->second.lock(); - if (thread) - { - ctx.parent = thread->root(); - } - } - else - { - auto parent = channel->findMessage(parentID); - if (parent) - { - ctx.parent = parent; - } - } - } - } - } - - return ctx; -} - std::optional parseClearChatMessage( Communi::IrcMessage *message) { @@ -370,9 +222,9 @@ std::optional parseClearChatMessage( } /** - * Parse a single IRC NOTICE message into 0 or more Chatterino messages + * Parse a single IRC NOTICE message into a Chatterino message **/ -std::vector parseNoticeMessage(Communi::IrcNoticeMessage *message) +MessagePtr parseNoticeMessage(Communi::IrcNoticeMessage *message) { assert(message != nullptr); @@ -400,7 +252,7 @@ std::vector parseNoticeMessage(Communi::IrcNoticeMessage *message) linkColor) ->setLink(accountsLink); - return {builder.release()}; + return builder.release(); } if (message->content().startsWith("You are permanently banned ")) @@ -410,256 +262,19 @@ std::vector parseNoticeMessage(Communi::IrcNoticeMessage *message) if (message->tags().value("msg-id") == "msg_timedout") { - std::vector builtMessage; - QString remainingTime = formatTime(message->content().split(" ").value(5)); QString formattedMessage = QString("You are timed out for %1.") .arg(remainingTime.isEmpty() ? "0s" : remainingTime); - builtMessage.emplace_back(makeSystemMessage( - formattedMessage, calculateMessageTime(message).time())); - - return builtMessage; + return makeSystemMessage(formattedMessage, + calculateMessageTime(message).time()); } // default case - std::vector builtMessages; - - builtMessages.emplace_back(makeSystemMessage( - message->content(), calculateMessageTime(message).time())); - - return builtMessages; -} - -/** - * Parse a single IRC USERNOTICE message into 0 or more Chatterino messages - **/ -std::vector parseUserNoticeMessage(Channel *channel, - Communi::IrcMessage *message) -{ - assert(channel != nullptr); - assert(message != nullptr); - - std::vector builtMessages; - - auto tags = message->tags(); - auto parameters = message->parameters(); - - QString msgType = tags.value("msg-id").toString(); - bool mirrored = msgType == "sharedchatnotice"; - if (mirrored) - { - msgType = tags.value("source-msg-id").toString(); - } - else - { - auto rIt = tags.find("room-id"); - auto sIt = tags.find("source-room-id"); - if (rIt != tags.end() && sIt != tags.end()) - { - mirrored = rIt.value().toString() != sIt.value().toString(); - } - } - - if (mirrored && msgType != "announcement") - { - // avoid confusing broadcasters with user payments to other channels - return {}; - } - - QString content; - if (parameters.size() >= 2) - { - content = parameters[1]; - } - - if (isIgnoredMessage({ - .message = content, - .twitchUserID = tags.value("user-id").toString(), - .isMod = channel->isMod(), - .isBroadcaster = channel->isBroadcaster(), - })) - { - return {}; - } - - if (SPECIAL_MESSAGE_TYPES.contains(msgType)) - { - // Messages are not required, so they might be empty - if (!content.isEmpty()) - { - MessageParseArgs args; - args.trimSubscriberUsername = true; - args.allowIgnore = false; - - auto [built, highlight] = MessageBuilder::makeIrcMessage( - channel, message, args, content, 0); - if (built) - { - built->flags.set(MessageFlag::Subscription); - built->flags.unset(MessageFlag::Highlighted); - if (mirrored) - { - built->flags.set(MessageFlag::SharedMessage); - } - builtMessages.emplace_back(std::move(built)); - } - } - } - - auto it = tags.find("system-msg"); - - if (it != tags.end()) - { - // By default, we return value of system-msg tag - QString messageText = it.value().toString(); - - if (msgType == "bitsbadgetier") - { - messageText = - QString("%1 just earned a new %2 Bits badge!") - .arg(tags.value("display-name").toString(), - kFormatNumbers( - tags.value("msg-param-threshold").toInt())); - } - else if (msgType == "announcement") - { - messageText = "Announcement"; - } - else if (msgType == "raid") - { - auto login = tags.value("login").toString(); - auto displayName = tags.value("msg-param-displayName").toString(); - - if (!login.isEmpty() && !displayName.isEmpty()) - { - MessageColor color = MessageColor::System; - if (auto colorTag = tags.value("color").value(); - colorTag.isValid()) - { - color = MessageColor(colorTag); - } - - auto b = MessageBuilder( - raidEntryMessage, parseTagString(messageText), login, - displayName, color, calculateMessageTime(message).time()); - - b->flags.set(MessageFlag::Subscription); - if (mirrored) - { - b->flags.set(MessageFlag::SharedMessage); - } - - auto newMessage = b.release(); - builtMessages.emplace_back(newMessage); - return builtMessages; - } - } - else if (msgType == "subgift") - { - if (auto monthsIt = tags.find("msg-param-gift-months"); - monthsIt != tags.end()) - { - int months = monthsIt.value().toInt(); - if (months > 1) - { - auto plan = tags.value("msg-param-sub-plan").toString(); - QString name = - ANONYMOUS_GIFTER_ID == tags.value("user-id").toString() - ? "An anonymous user" - : tags.value("display-name").toString(); - messageText = - QString("%1 gifted %2 months of a Tier %3 sub to %4!") - .arg(name, QString::number(months), - plan.isEmpty() ? '1' : plan.at(0), - tags.value("msg-param-recipient-display-name") - .toString()); - - if (auto countIt = tags.find("msg-param-sender-count"); - countIt != tags.end()) - { - int count = countIt.value().toInt(); - if (count > months) - { - messageText += - QString( - " They've gifted %1 months in the channel.") - .arg(QString::number(count)); - } - } - } - } - } - else if (msgType == "sub" || msgType == "resub") - { - if (auto tenure = tags.find("msg-param-multimonth-tenure"); - tenure != tags.end() && tenure.value().toInt() == 0) - { - int months = - tags.value("msg-param-multimonth-duration").toInt(); - if (months > 1) - { - int tier = tags.value("msg-param-sub-plan").toInt() / 1000; - messageText = - QString( - "%1 subscribed at Tier %2 for %3 months in advance") - .arg(tags.value("display-name").toString(), - QString::number(tier), - QString::number(months)); - if (msgType == "resub") - { - int cumulative = - tags.value("msg-param-cumulative-months").toInt(); - messageText += - QString(", reaching %1 months cumulatively so far!") - .arg(QString::number(cumulative)); - } - else - { - messageText += "!"; - } - } - } - } - - auto b = MessageBuilder(systemMessage, parseTagString(messageText), - calculateMessageTime(message).time()); - b->flags.set(MessageFlag::Subscription); - if (mirrored) - { - b->flags.set(MessageFlag::SharedMessage); - } - - auto newMessage = b.release(); - builtMessages.emplace_back(newMessage); - } - - return builtMessages; -} - -/** - * Parse a single IRC PRIVMSG into 0-1 Chatterino messages - */ -std::vector parsePrivMessage(Channel *channel, - Communi::IrcPrivateMessage *message) -{ - assert(channel != nullptr); - assert(message != nullptr); - - std::vector builtMessages; - MessageParseArgs args; - args.isAction = message->isAction(); - auto [built, alert] = MessageBuilder::makeIrcMessage(channel, message, args, - message->content(), 0); - if (built) - { - builtMessages.emplace_back(std::move(built)); - MessageBuilder::triggerHighlights(channel, alert); - } - - return builtMessages; + return makeSystemMessage(message->content(), + calculateMessageTime(message).time()); } } // namespace @@ -674,65 +289,27 @@ IrcMessageHandler &IrcMessageHandler::instance() return instance; } -std::vector IrcMessageHandler::parseMessageWithReply( - Channel *channel, Communi::IrcMessage *message, - std::vector &otherLoaded) +void IrcMessageHandler::parseMessageInto(Communi::IrcMessage *message, + MessageSink &sink, + TwitchChannel *channel) { - std::vector builtMessages; - auto command = message->command(); if (command == u"PRIVMSG"_s) { - auto *privMsg = dynamic_cast(message); - auto *tc = dynamic_cast(channel); - if (!tc) - { - return parsePrivMessage(channel, privMsg); - } - - QString content = privMsg->content(); - int messageOffset = stripLeadingReplyMention(privMsg->tags(), content); - MessageParseArgs args; - auto tags = privMsg->tags(); - if (const auto it = tags.find("custom-reward-id"); it != tags.end()) - { - args.channelPointRewardId = it.value().toString(); - } - args.isAction = privMsg->isAction(); - - auto replyCtx = getReplyContext(tc, message, otherLoaded); - auto [built, alert] = MessageBuilder::makeIrcMessage( - channel, message, args, content, messageOffset, replyCtx.thread, - replyCtx.parent); - - if (built) - { - builtMessages.emplace_back(built); - MessageBuilder::triggerHighlights(channel, alert); - } - - if (message->tags().contains(u"pinned-chat-paid-amount"_s)) - { - auto ptr = MessageBuilder::buildHypeChatMessage(privMsg); - if (ptr) - { - builtMessages.emplace_back(std::move(ptr)); - } - } - - return builtMessages; + parsePrivMessageInto( + dynamic_cast(message), sink, channel); } - - if (command == u"USERNOTICE"_s) + else if (command == u"USERNOTICE"_s) { - return parseUserNoticeMessage(channel, message); + parseUserNoticeMessageInto(message, sink, channel); } if (command == u"NOTICE"_s) { - return parseNoticeMessage( - dynamic_cast(message)); + sink.addMessage(parseNoticeMessage( + dynamic_cast(message)), + MessageContext::Original); } if (command == u"CLEARCHAT"_s) @@ -740,32 +317,20 @@ std::vector IrcMessageHandler::parseMessageWithReply( auto cc = parseClearChatMessage(message); if (!cc) { - return builtMessages; + return; } auto &clearChat = *cc; if (clearChat.disableAllMessages) { - builtMessages.emplace_back(std::move(clearChat.message)); + sink.addMessage(std::move(clearChat.message), + MessageContext::Original); } else { - addOrReplaceChannelTimeout( - otherLoaded, std::move(clearChat.message), - calculateMessageTime(message).time(), - [&](auto idx, auto /*msg*/, auto &&replacement) { - replacement->flags.set(MessageFlag::RecentMessage); - otherLoaded[idx] = replacement; - }, - [&](auto &&msg) { - builtMessages.emplace_back(msg); - }, - false); + sink.addOrReplaceTimeout(std::move(clearChat.message), + calculateMessageTime(message).time()); } - - return builtMessages; } - - return builtMessages; } void IrcMessageHandler::handlePrivMessage(Communi::IrcPrivateMessage *message, @@ -778,32 +343,41 @@ void IrcMessageHandler::handlePrivMessage(Communi::IrcPrivateMessage *message, } auto *twitchChannel = dynamic_cast(chan.get()); - - if (twitchChannel != nullptr) + if (!twitchChannel) { - auto currentUser = getApp()->getAccounts()->twitch.getCurrent(); - if (message->tag("user-id") == currentUser->getUserId()) + return; + } + + parsePrivMessageInto(message, *twitchChannel, twitchChannel); +} + +void IrcMessageHandler::parsePrivMessageInto( + Communi::IrcPrivateMessage *message, MessageSink &sink, + TwitchChannel *channel) +{ + auto currentUser = getApp()->getAccounts()->twitch.getCurrent(); + if (message->tag("user-id") == currentUser->getUserId()) + { + auto badgesTag = message->tag("badges"); + if (badgesTag.isValid()) { - auto badgesTag = message->tag("badges"); - if (badgesTag.isValid()) - { - auto parsedBadges = parseBadges(badgesTag.toString()); - twitchChannel->setMod(parsedBadges.contains("moderator")); - twitchChannel->setVIP(parsedBadges.contains("vip")); - twitchChannel->setStaff(parsedBadges.contains("staff")); - } + auto parsedBadges = parseBadges(badgesTag.toString()); + channel->setMod(parsedBadges.contains("moderator")); + channel->setVIP(parsedBadges.contains("vip")); + channel->setStaff(parsedBadges.contains("staff")); } } - this->addMessage(message, chan, unescapeZeroWidthJoiner(message->content()), - twitchServer, false, message->isAction()); + addMessage(message, sink, channel, + unescapeZeroWidthJoiner(message->content()), false, + message->isAction()); if (message->tags().contains(u"pinned-chat-paid-amount"_s)) { auto ptr = MessageBuilder::buildHypeChatMessage(message); if (ptr) { - chan->addMessage(ptr, MessageContext::Original); + sink.addMessage(ptr, MessageContext::Original); } } } @@ -900,7 +474,8 @@ void IrcMessageHandler::handleClearChatMessage(Communi::IrcMessage *message) return; } - chan->addOrReplaceTimeout(std::move(clearChat.message)); + chan->addOrReplaceTimeout(std::move(clearChat.message), + calculateMessageTime(message).time()); // refresh all getApp()->getWindows()->repaintVisibleChatWidgets(chan.get()); @@ -1039,11 +614,24 @@ void IrcMessageHandler::handleWhisperMessage(Communi::IrcMessage *ircMessage) void IrcMessageHandler::handleUserNoticeMessage(Communi::IrcMessage *message, ITwitchIrcServer &twitchServer) +{ + auto target = message->parameter(0); + auto *channel = dynamic_cast( + twitchServer.getChannelOrEmpty(target).get()); + if (!channel) + { + return; + } + parseUserNoticeMessageInto(message, *channel, channel); +} + +void IrcMessageHandler::parseUserNoticeMessageInto(Communi::IrcMessage *message, + MessageSink &sink, + TwitchChannel *channel) { auto tags = message->tags(); auto parameters = message->parameters(); - auto target = parameters[0]; QString msgType = tags.value("msg-id").toString(); bool mirrored = msgType == "sharedchatnotice"; if (mirrored) @@ -1072,12 +660,11 @@ void IrcMessageHandler::handleUserNoticeMessage(Communi::IrcMessage *message, content = parameters[1]; } - auto chn = twitchServer.getChannelOrEmpty(target); if (isIgnoredMessage({ .message = content, .twitchUserID = tags.value("user-id").toString(), - .isMod = chn->isMod(), - .isBroadcaster = chn->isBroadcaster(), + .isMod = channel->isMod(), + .isBroadcaster = channel->isBroadcaster(), })) { return; @@ -1088,7 +675,7 @@ void IrcMessageHandler::handleUserNoticeMessage(Communi::IrcMessage *message, // Messages are not required, so they might be empty if (!content.isEmpty()) { - this->addMessage(message, chn, content, twitchServer, true, false); + addMessage(message, sink, channel, content, true, false); } } @@ -1136,25 +723,7 @@ void IrcMessageHandler::handleUserNoticeMessage(Communi::IrcMessage *message, } auto newMessage = b.release(); - QString channelName; - - if (message->parameters().size() < 1) - { - return; - } - - if (!trimChannelName(message->parameter(0), channelName)) - { - return; - } - - auto chan = twitchServer.getChannelOrEmpty(channelName); - - if (!chan->isEmpty()) - { - chan->addMessage(newMessage, MessageContext::Original); - } - + sink.addMessage(newMessage, MessageContext::Original); return; } } @@ -1235,124 +804,104 @@ void IrcMessageHandler::handleUserNoticeMessage(Communi::IrcMessage *message, } auto newMessage = b.release(); - QString channelName; - - if (message->parameters().size() < 1) - { - return; - } - - if (!trimChannelName(message->parameter(0), channelName)) - { - return; - } - - auto chan = twitchServer.getChannelOrEmpty(channelName); - - if (!chan->isEmpty()) - { - chan->addMessage(newMessage, MessageContext::Original); - } + sink.addMessage(newMessage, MessageContext::Original); } } void IrcMessageHandler::handleNoticeMessage(Communi::IrcNoticeMessage *message) { - auto builtMessages = parseNoticeMessage(message); + auto msg = parseNoticeMessage(message); - for (const auto &msg : builtMessages) + QString channelName; + if (!trimChannelName(message->target(), channelName) || + channelName == "jtv") { - QString channelName; - if (!trimChannelName(message->target(), channelName) || - channelName == "jtv") - { - // Notice wasn't targeted at a single channel, send to all twitch - // channels - getApp()->getTwitch()->forEachChannelAndSpecialChannels( - [msg](const auto &c) { - c->addMessage(msg, MessageContext::Original); - }); + // Notice wasn't targeted at a single channel, send to all twitch + // channels + getApp()->getTwitch()->forEachChannelAndSpecialChannels( + [msg](const auto &c) { + c->addMessage(msg, MessageContext::Original); + }); + return; + } + + auto channel = getApp()->getTwitch()->getChannelOrEmpty(channelName); + + if (channel->isEmpty()) + { + qCDebug(chatterinoTwitch) + << "[IrcManager:handleNoticeMessage] Channel" << channelName + << "not found in channel manager"; + return; + } + + QString tags = message->tags().value("msg-id").toString(); + if (tags == "usage_delete") + { + channel->addSystemMessage( + "Usage: /delete - Deletes the specified message. " + "Can't take more than one argument."); + } + else if (tags == "bad_delete_message_error") + { + channel->addSystemMessage( + "There was a problem deleting the message. " + "It might be from another channel or too old to delete."); + } + else if (tags == "host_on" || tags == "host_target_went_offline") + { + bool hostOn = (tags == "host_on"); + QStringList parts = msg->messageText.split(QLatin1Char(' ')); + if ((hostOn && parts.size() != 3) || (!hostOn && parts.size() != 7)) + { return; } - - auto channel = getApp()->getTwitch()->getChannelOrEmpty(channelName); - - if (channel->isEmpty()) + auto &hostedChannelName = hostOn ? parts[2] : parts[0]; + if (hostedChannelName.size() < 2) { - qCDebug(chatterinoTwitch) - << "[IrcManager:handleNoticeMessage] Channel" << channelName - << "not found in channel manager"; return; } - - QString tags = message->tags().value("msg-id").toString(); - if (tags == "usage_delete") + if (hostOn) { - channel->addSystemMessage( - "Usage: /delete - Deletes the specified message. " - "Can't take more than one argument."); + hostedChannelName.chop(1); } - else if (tags == "bad_delete_message_error") - { - channel->addSystemMessage( - "There was a problem deleting the message. " - "It might be from another channel or too old to delete."); - } - else if (tags == "host_on" || tags == "host_target_went_offline") - { - bool hostOn = (tags == "host_on"); - QStringList parts = msg->messageText.split(QLatin1Char(' ')); - if ((hostOn && parts.size() != 3) || (!hostOn && parts.size() != 7)) - { - return; - } - auto &hostedChannelName = hostOn ? parts[2] : parts[0]; - if (hostedChannelName.size() < 2) - { - return; - } - if (hostOn) - { - hostedChannelName.chop(1); - } - channel->addMessage(MessageBuilder::makeHostingSystemMessage( - hostedChannelName, hostOn), - MessageContext::Original); - } - else if (tags == "room_mods" || tags == "vips_success") - { - // /mods and /vips - // room_mods: The moderators of this channel are: ampzyh, antichriststollen, apa420, ... - // vips_success: The VIPs of this channel are: 8008, aiden, botfactory, ... + channel->addMessage( + MessageBuilder::makeHostingSystemMessage(hostedChannelName, hostOn), + MessageContext::Original); + } + else if (tags == "room_mods" || tags == "vips_success") + { + // /mods and /vips + // room_mods: The moderators of this channel are: ampzyh, antichriststollen, apa420, ... + // vips_success: The VIPs of this channel are: 8008, aiden, botfactory, ... - QString noticeText = msg->messageText; - if (tags == "vips_success") - { - // this one has a trailing period, need to get rid of it. - noticeText.chop(1); - } - - QStringList msgParts = noticeText.split(':'); - MessageBuilder builder; - - auto *tc = dynamic_cast(channel.get()); - assert(tc != nullptr && - "IrcMessageHandler::handleNoticeMessage. Twitch specific " - "functionality called in non twitch channel"); - - auto users = msgParts.at(1) - .mid(1) // there is a space before the first user - .split(", "); - users.sort(Qt::CaseInsensitive); - channel->addMessage(MessageBuilder::makeListOfUsersMessage( - msgParts.at(0), users, tc), - MessageContext::Original); - } - else + QString noticeText = msg->messageText; + if (tags == "vips_success") { - channel->addMessage(msg, MessageContext::Original); + // this one has a trailing period, need to get rid of it. + noticeText.chop(1); } + + QStringList msgParts = noticeText.split(':'); + MessageBuilder builder; + + auto *tc = dynamic_cast(channel.get()); + assert(tc != nullptr && + "IrcMessageHandler::handleNoticeMessage. Twitch specific " + "functionality called in non twitch channel"); + + auto users = msgParts.at(1) + .mid(1) // there is a space before the first user + .split(", "); + users.sort(Qt::CaseInsensitive); + channel->addMessage( + MessageBuilder::makeListOfUsersMessage(msgParts.at(0), users, tc), + MessageContext::Original); + } + else + { + channel->addMessage(msg, MessageContext::Original); } } @@ -1405,76 +954,12 @@ void IrcMessageHandler::handlePartMessage(Communi::IrcMessage *message) } } -float IrcMessageHandler::similarity( - const MessagePtr &msg, const LimitedQueueSnapshot &messages) -{ - float similarityPercent = 0.0F; - int checked = 0; - - for (int i = 1; i <= messages.size(); ++i) - { - if (checked >= getSettings()->hideSimilarMaxMessagesToCheck) - { - break; - } - const auto &prevMsg = messages[messages.size() - i]; - if (prevMsg->parseTime.secsTo(QTime::currentTime()) >= - getSettings()->hideSimilarMaxDelay) - { - break; - } - if (getSettings()->hideSimilarBySameUser && - msg->loginName != prevMsg->loginName) - { - continue; - } - ++checked; - similarityPercent = std::max( - similarityPercent, - relativeSimilarity(msg->messageText, prevMsg->messageText)); - } - - return similarityPercent; -} - -void IrcMessageHandler::setSimilarityFlags(const MessagePtr &message, - const ChannelPtr &channel) -{ - if (getSettings()->similarityEnabled) - { - bool isMyself = - message->loginName == - getApp()->getAccounts()->twitch.getCurrent()->getUserName(); - bool hideMyself = getSettings()->hideSimilarMyself; - - if (isMyself && !hideMyself) - { - return; - } - - if (IrcMessageHandler::similarity(message, - channel->getMessageSnapshot()) > - getSettings()->similarityPercentage) - { - message->flags.set(MessageFlag::Similar, true); - if (getSettings()->colorSimilarDisabled) - { - message->flags.set(MessageFlag::Disabled, true); - } - } - } -} - void IrcMessageHandler::addMessage(Communi::IrcMessage *message, - const ChannelPtr &chan, - const QString &originalContent, - ITwitchIrcServer &server, bool isSub, + MessageSink &sink, TwitchChannel *channel, + const QString &originalContent, bool isSub, bool isAction) { - if (chan->isEmpty()) - { - return; - } + assert(channel); MessageParseArgs args; if (isSub) @@ -1483,14 +968,12 @@ void IrcMessageHandler::addMessage(Communi::IrcMessage *message, args.trimSubscriberUsername = true; } - if (chan->isBroadcaster()) + if (channel->isBroadcaster()) { args.isStaffOrBroadcaster = true; } args.isAction = isAction; - auto *channel = dynamic_cast(chan.get()); - const auto &tags = message->tags(); QString rewardId; if (const auto it = tags.find("custom-reward-id"); it != tags.end()) @@ -1506,7 +989,10 @@ void IrcMessageHandler::addMessage(Communi::IrcMessage *message, rewardId = msgId; } } - if (!rewardId.isEmpty() && !channel->isChannelPointRewardKnown(rewardId)) + if (!rewardId.isEmpty() && + sink.sinkTraits().has( + MessageSinkTrait::RequiresKnownChannelPointReward) && + !channel->isChannelPointRewardKnown(rewardId)) { // Need to wait for pubsub reward notification qCDebug(chatterinoTwitch) << "TwitchChannel reward added ADD " @@ -1539,7 +1025,7 @@ void IrcMessageHandler::addMessage(Communi::IrcMessage *message, else { // Thread does not yet exist, find root reply and create thread. - auto root = channel->findMessage(replyID); + auto root = sink.findMessageByID(replyID); if (root) { // Found root reply message @@ -1577,7 +1063,7 @@ void IrcMessageHandler::addMessage(Communi::IrcMessage *message, } else { - auto parent = channel->findMessage(parentID); + auto parent = sink.findMessageByID(parentID); if (parent) { replyCtx.parent = parent; @@ -1600,7 +1086,7 @@ void IrcMessageHandler::addMessage(Communi::IrcMessage *message, msg->flags.unset(MessageFlag::Highlighted); } - IrcMessageHandler::setSimilarityFlags(msg, chan); + sink.applySimilarityFilters(msg); if (!msg->flags.has(MessageFlag::Similar) || (!getSettings()->hideSimilar && @@ -1612,17 +1098,15 @@ void IrcMessageHandler::addMessage(Communi::IrcMessage *message, const auto highlighted = msg->flags.has(MessageFlag::Highlighted); const auto showInMentions = msg->flags.has(MessageFlag::ShowInMentions); - if (highlighted && showInMentions) + if (highlighted && showInMentions && + sink.sinkTraits().has(MessageSinkTrait::AddMentionsToGlobalChannel)) { - server.getMentionsChannel()->addMessage(msg, - MessageContext::Original); + getApp()->getTwitch()->getMentionsChannel()->addMessage( + msg, MessageContext::Original); } - chan->addMessage(msg, MessageContext::Original); - if (auto *chatters = dynamic_cast(chan.get())) - { - chatters->addRecentChatter(msg->displayName); - } + sink.addMessage(msg, MessageContext::Original); + channel->addRecentChatter(msg->displayName); } } diff --git a/src/providers/twitch/IrcMessageHandler.hpp b/src/providers/twitch/IrcMessageHandler.hpp index ba6d2d983..73d81e022 100644 --- a/src/providers/twitch/IrcMessageHandler.hpp +++ b/src/providers/twitch/IrcMessageHandler.hpp @@ -16,6 +16,7 @@ struct Message; using MessagePtr = std::shared_ptr; class TwitchChannel; class TwitchMessageBuilder; +class MessageSink; struct ClearChatMessage { MessagePtr message; @@ -33,30 +34,35 @@ public: * Parse an IRC message into 0 or more Chatterino messages * Takes previously loaded messages into consideration to add reply contexts **/ - static std::vector parseMessageWithReply( - Channel *channel, Communi::IrcMessage *message, - std::vector &otherLoaded); + static void parseMessageInto(Communi::IrcMessage *message, + MessageSink &sink, TwitchChannel *channel); void handlePrivMessage(Communi::IrcPrivateMessage *message, ITwitchIrcServer &twitchServer); + static void parsePrivMessageInto(Communi::IrcPrivateMessage *message, + MessageSink &sink, TwitchChannel *channel); void handleRoomStateMessage(Communi::IrcMessage *message); void handleClearChatMessage(Communi::IrcMessage *message); void handleClearMessageMessage(Communi::IrcMessage *message); void handleUserStateMessage(Communi::IrcMessage *message); - void handleWhisperMessage(Communi::IrcMessage *ircMessage); + void handleWhisperMessage(Communi::IrcMessage *ircMessage); void handleUserNoticeMessage(Communi::IrcMessage *message, ITwitchIrcServer &twitchServer); + static void parseUserNoticeMessageInto(Communi::IrcMessage *message, + MessageSink &sink, + TwitchChannel *channel); void handleNoticeMessage(Communi::IrcNoticeMessage *message); void handleJoinMessage(Communi::IrcMessage *message); void handlePartMessage(Communi::IrcMessage *message); - void addMessage(Communi::IrcMessage *message, const ChannelPtr &chan, - const QString &originalContent, ITwitchIrcServer &server, - bool isSub, bool isAction); + static void addMessage(Communi::IrcMessage *message, MessageSink &sink, + TwitchChannel *channel, + const QString &originalContent, bool isSub, + bool isAction); private: static float similarity(const MessagePtr &msg, diff --git a/src/providers/twitch/TwitchChannel.cpp b/src/providers/twitch/TwitchChannel.cpp index 93ac4519c..86d26c249 100644 --- a/src/providers/twitch/TwitchChannel.cpp +++ b/src/providers/twitch/TwitchChannel.cpp @@ -452,8 +452,8 @@ void TwitchChannel::addChannelPointReward(const ChannelPointReward &reward) if (reward.id == msg.rewardID) { IrcMessageHandler::instance().addMessage( - msg.message.get(), shared_from_this(), - msg.originalContent, *server, false, false); + msg.message.get(), *this, this, msg.originalContent, + false, false); return true; } return false; diff --git a/src/providers/twitch/TwitchIrcServer.cpp b/src/providers/twitch/TwitchIrcServer.cpp index 9ca93f6fd..9e2fe2fbf 100644 --- a/src/providers/twitch/TwitchIrcServer.cpp +++ b/src/providers/twitch/TwitchIrcServer.cpp @@ -312,7 +312,7 @@ void TwitchIrcServer::initialize() postToThread([chan, action] { MessageBuilder msg(action); msg->flags.set(MessageFlag::PubSub); - chan->addOrReplaceTimeout(msg.release()); + chan->addOrReplaceTimeout(msg.release(), QTime::currentTime()); }); }); diff --git a/src/util/VectorMessageSink.cpp b/src/util/VectorMessageSink.cpp new file mode 100644 index 000000000..06f2ad316 --- /dev/null +++ b/src/util/VectorMessageSink.cpp @@ -0,0 +1,86 @@ +#include "util/VectorMessageSink.hpp" + +#include "messages/MessageSimilarity.hpp" +#include "util/ChannelHelpers.hpp" + +#include + +namespace chatterino { + +VectorMessageSink::VectorMessageSink(MessageSinkTraits traits, + MessageFlags additionalFlags) + : additionalFlags(additionalFlags) + , traits(traits) {}; +VectorMessageSink::~VectorMessageSink() = default; + +void VectorMessageSink::addMessage(MessagePtr message, MessageContext ctx, + std::optional overridingFlags) +{ + assert(!overridingFlags.has_value()); + assert(ctx == MessageContext::Original); + + message->flags.set(this->additionalFlags); + this->messages_.emplace_back(std::move(message)); +} + +void VectorMessageSink::addOrReplaceTimeout(MessagePtr clearchatMessage, + QTime now) +{ + addOrReplaceChannelTimeout( + this->messages_, std::move(clearchatMessage), now, + [&](auto idx, auto /*msg*/, auto &&replacement) { + replacement->flags.set(this->additionalFlags); + this->messages_[idx] = replacement; + }, + [&](auto &&msg) { + this->messages_.emplace_back(msg); + }, + false); +} + +void VectorMessageSink::disableAllMessages() +{ + if (this->additionalFlags.has(MessageFlag::RecentMessage)) + { + return; // don't disable recent messages + } + + for (const auto &msg : this->messages_) + { + msg->flags.set(MessageFlag::Disabled); + } +} + +void VectorMessageSink::applySimilarityFilters(const MessagePtr &message) const +{ + setSimilarityFlags(message, this->messages_); +} + +MessagePtr VectorMessageSink::findMessageByID(QStringView id) +{ + for (const auto &msg : this->messages_ | std::views::reverse) + { + if (msg->id == id) + { + return msg; + } + } + return {}; +} + +const std::vector &VectorMessageSink::messages() const +{ + return this->messages_; +} + +std::vector VectorMessageSink::takeMessages() && +{ + return std::move(this->messages_); +} + +MessageSinkTraits VectorMessageSink::sinkTraits() const +{ + return this->traits; +} + +} // namespace chatterino diff --git a/src/util/VectorMessageSink.hpp b/src/util/VectorMessageSink.hpp new file mode 100644 index 000000000..c4ffcfa9c --- /dev/null +++ b/src/util/VectorMessageSink.hpp @@ -0,0 +1,36 @@ +#pragma once + +#include "messages/MessageSink.hpp" + +namespace chatterino { + +class VectorMessageSink final : public MessageSink +{ +public: + VectorMessageSink(MessageSinkTraits traits = {}, + MessageFlags additionalFlags = {}); + ~VectorMessageSink() override; + + void addMessage( + MessagePtr message, MessageContext ctx, + std::optional overridingFlags = std::nullopt) override; + void addOrReplaceTimeout(MessagePtr clearchatMessage, QTime now) override; + + void disableAllMessages() override; + + void applySimilarityFilters(const MessagePtr &message) const override; + + MessagePtr findMessageByID(QStringView id) override; + + MessageSinkTraits sinkTraits() const override; + + const std::vector &messages() const; + std::vector takeMessages() &&; + +private: + std::vector messages_; + MessageFlags additionalFlags; + MessageSinkTraits traits; +}; + +} // namespace chatterino diff --git a/tests/snapshots/IrcMessageHandler/announcement.json b/tests/snapshots/IrcMessageHandler/announcement.json index b3ddfd2e6..06b21210c 100644 --- a/tests/snapshots/IrcMessageHandler/announcement.json +++ b/tests/snapshots/IrcMessageHandler/announcement.json @@ -180,6 +180,7 @@ } ], "flags": "Collapsed|Subscription", + "highlightColor": "#64c466ff", "id": "8c26e1ab-b50c-4d9d-bc11-3fd57a941d90", "localizedName": "", "loginName": "supinic", diff --git a/tests/snapshots/IrcMessageHandler/reply-child.json b/tests/snapshots/IrcMessageHandler/reply-child.json index 8862f7738..be8a17317 100644 --- a/tests/snapshots/IrcMessageHandler/reply-child.json +++ b/tests/snapshots/IrcMessageHandler/reply-child.json @@ -80,7 +80,7 @@ "trailingSpace": true, "type": "SingleLineTextElement", "words": [ - "a" + "b" ] }, { @@ -169,6 +169,7 @@ "localizedName": "", "loginName": "nerixyz", "messageText": "c", + "replyParent": "474f19ab-a1b0-410a-877a-5b0e2ae8be6d", "replyThread": { "replies": [ "474f19ab-a1b0-410a-877a-5b0e2ae8be6d", diff --git a/tests/snapshots/IrcMessageHandler/shared-chat-announcement.json b/tests/snapshots/IrcMessageHandler/shared-chat-announcement.json index a6877c365..f612fd720 100644 --- a/tests/snapshots/IrcMessageHandler/shared-chat-announcement.json +++ b/tests/snapshots/IrcMessageHandler/shared-chat-announcement.json @@ -256,6 +256,7 @@ } ], "flags": "Collapsed|Subscription|SharedMessage", + "highlightColor": "#64c466ff", "id": "01cd601f-bc3f-49d5-ab4b-136fa9d6ec22", "localizedName": "", "loginName": "lahoooo", diff --git a/tests/snapshots/IrcMessageHandler/sub-message.json b/tests/snapshots/IrcMessageHandler/sub-message.json index fd74777c5..98c787647 100644 --- a/tests/snapshots/IrcMessageHandler/sub-message.json +++ b/tests/snapshots/IrcMessageHandler/sub-message.json @@ -243,6 +243,7 @@ } ], "flags": "Collapsed|Subscription", + "highlightColor": "#64c466ff", "id": "db25007f-7a18-43eb-9379-80131e44d633", "localizedName": "", "loginName": "ronni", diff --git a/tests/src/IrcMessageHandler.cpp b/tests/src/IrcMessageHandler.cpp index a80e928ef..11a9b65f4 100644 --- a/tests/src/IrcMessageHandler.cpp +++ b/tests/src/IrcMessageHandler.cpp @@ -27,6 +27,7 @@ #include "singletons/Emotes.hpp" #include "Test.hpp" #include "util/IrcHelpers.hpp" +#include "util/VectorMessageSink.hpp" #include #include @@ -53,7 +54,7 @@ namespace { /// /// When adding a test, start with `{ "input": "..." }` and set this to `true` /// to generate an initial snapshot. Make sure to verify the output! -constexpr bool UPDATE_SNAPSHOTS = false; +constexpr bool UPDATE_SNAPSHOTS = true; const QString IRC_CATEGORY = u"IrcMessageHandler"_s; @@ -572,19 +573,14 @@ TEST_P(TestIrcMessageHandlerP, Run) { auto channel = makeMockTwitchChannel(u"pajlada"_s, *snapshot); - std::vector prevMessages; + VectorMessageSink sink; for (auto prevInput : snapshot->param("prevMessages").toArray()) { auto *ircMessage = Communi::IrcMessage::fromData( prevInput.toString().toUtf8(), nullptr); ASSERT_NE(ircMessage, nullptr); - auto builtMessages = IrcMessageHandler::parseMessageWithReply( - channel.get(), ircMessage, prevMessages); - for (const auto &builtMessage : builtMessages) - { - prevMessages.emplace_back(builtMessage); - } + IrcMessageHandler::parseMessageInto(ircMessage, sink, channel.get()); delete ircMessage; } @@ -592,13 +588,13 @@ TEST_P(TestIrcMessageHandlerP, Run) Communi::IrcMessage::fromData(snapshot->inputUtf8(), nullptr); ASSERT_NE(ircMessage, nullptr); - auto builtMessages = IrcMessageHandler::parseMessageWithReply( - channel.get(), ircMessage, prevMessages); + auto firstAddedMsg = sink.messages().size(); + IrcMessageHandler::parseMessageInto(ircMessage, sink, channel.get()); QJsonArray got; - for (const auto &msg : builtMessages) + for (auto i = firstAddedMsg; i < sink.messages().size(); i++) { - got.append(msg->toJson()); + got.append(sink.messages()[i]->toJson()); } delete ircMessage; From 7b5a21d088d8db9afa73e333754db0e8c29269f7 Mon Sep 17 00:00:00 2001 From: Nerixyz Date: Sat, 26 Oct 2024 18:11:05 +0200 Subject: [PATCH 2/4] fix: formatting and changelog xd --- CHANGELOG.md | 1 + src/util/VectorMessageSink.cpp | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 189ebadcf..9adbcd399 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -113,6 +113,7 @@ - Dev: Refactored static `MessageBuilder` helpers to standalone functions. (#5652) - Dev: Decoupled reply parsing from `MessageBuilder`. (#5660, #5668) - Dev: Refactored IRC message building. (#5663) +- Dev: Unified parsing of historic and live IRC messages. (#5678) ## 2.5.1 diff --git a/src/util/VectorMessageSink.cpp b/src/util/VectorMessageSink.cpp index 06f2ad316..3911fee89 100644 --- a/src/util/VectorMessageSink.cpp +++ b/src/util/VectorMessageSink.cpp @@ -10,7 +10,7 @@ namespace chatterino { VectorMessageSink::VectorMessageSink(MessageSinkTraits traits, MessageFlags additionalFlags) : additionalFlags(additionalFlags) - , traits(traits) {}; + , traits(traits){}; VectorMessageSink::~VectorMessageSink() = default; void VectorMessageSink::addMessage(MessagePtr message, MessageContext ctx, From 417cdbc009a0469f1f19e1b8e64d062113eea0c3 Mon Sep 17 00:00:00 2001 From: Nerixyz Date: Sat, 26 Oct 2024 18:27:47 +0200 Subject: [PATCH 3/4] good thing i added that --- tests/src/IrcMessageHandler.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/src/IrcMessageHandler.cpp b/tests/src/IrcMessageHandler.cpp index 11a9b65f4..8ed4ee568 100644 --- a/tests/src/IrcMessageHandler.cpp +++ b/tests/src/IrcMessageHandler.cpp @@ -54,7 +54,7 @@ namespace { /// /// When adding a test, start with `{ "input": "..." }` and set this to `true` /// to generate an initial snapshot. Make sure to verify the output! -constexpr bool UPDATE_SNAPSHOTS = true; +constexpr bool UPDATE_SNAPSHOTS = false; const QString IRC_CATEGORY = u"IrcMessageHandler"_s; From 8eec1da317d7b9ae7aa4368109393b99450279f5 Mon Sep 17 00:00:00 2001 From: Nerixyz Date: Sun, 27 Oct 2024 14:17:28 +0100 Subject: [PATCH 4/4] feedback --- src/messages/MessageSimilarity.cpp | 74 +++++++++++++++++++++++++- src/messages/MessageSimilarity.hpp | 66 +---------------------- src/messages/MessageSink.hpp | 10 +++- src/providers/twitch/TwitchChannel.cpp | 2 - 4 files changed, 83 insertions(+), 69 deletions(-) diff --git a/src/messages/MessageSimilarity.cpp b/src/messages/MessageSimilarity.cpp index 3019aea67..2f8157d6b 100644 --- a/src/messages/MessageSimilarity.cpp +++ b/src/messages/MessageSimilarity.cpp @@ -1,9 +1,17 @@ #include "messages/MessageSimilarity.hpp" +#include "Application.hpp" +#include "controllers/accounts/AccountController.hpp" +#include "messages/LimitedQueueSnapshot.hpp" // IWYU pragma: keep +#include "providers/twitch/TwitchAccount.hpp" +#include "singletons/Settings.hpp" + #include #include -namespace chatterino::similarity::detail { +namespace { + +using namespace chatterino; float relativeSimilarity(QStringView str1, QStringView str2) { @@ -48,4 +56,66 @@ float relativeSimilarity(QStringView str1, QStringView str2) return float(z) / float(div); } -} // namespace chatterino::similarity::detail +template +float inMessages(const MessagePtr &msg, const T &messages) +{ + float similarityPercent = 0.0F; + + for (const auto &prevMsg : + messages | std::views::reverse | + std::views::take(getSettings()->hideSimilarMaxMessagesToCheck)) + { + if (prevMsg->parseTime.secsTo(QTime::currentTime()) >= + getSettings()->hideSimilarMaxDelay) + { + break; + } + if (getSettings()->hideSimilarBySameUser && + msg->loginName != prevMsg->loginName) + { + continue; + } + similarityPercent = std::max( + similarityPercent, + relativeSimilarity(msg->messageText, prevMsg->messageText)); + } + + return similarityPercent; +} + +} // namespace + +namespace chatterino { + +template +void setSimilarityFlags(const MessagePtr &message, const T &messages) +{ + if (getSettings()->similarityEnabled) + { + bool isMyself = + message->loginName == + getApp()->getAccounts()->twitch.getCurrent()->getUserName(); + bool hideMyself = getSettings()->hideSimilarMyself; + + if (isMyself && !hideMyself) + { + return; + } + + if (inMessages(message, messages) > getSettings()->similarityPercentage) + { + message->flags.set(MessageFlag::Similar); + if (getSettings()->colorSimilarDisabled) + { + message->flags.set(MessageFlag::Disabled); + } + } + } +} + +template void setSimilarityFlags>( + const MessagePtr &msg, const std::vector &messages); +template void setSimilarityFlags>( + const MessagePtr &msg, const LimitedQueueSnapshot &messages); + +} // namespace chatterino diff --git a/src/messages/MessageSimilarity.hpp b/src/messages/MessageSimilarity.hpp index 562e574ad..54d0214d7 100644 --- a/src/messages/MessageSimilarity.hpp +++ b/src/messages/MessageSimilarity.hpp @@ -1,73 +1,11 @@ #pragma once -#include "Application.hpp" -#include "controllers/accounts/AccountController.hpp" #include "messages/Message.hpp" -#include "providers/twitch/TwitchAccount.hpp" -#include "singletons/Settings.hpp" #include - -namespace chatterino::similarity::detail { - -float relativeSimilarity(QStringView str1, QStringView str2); - -float inMessages(const MessagePtr &msg, - const std::ranges::bidirectional_range auto &messages) -{ - float similarityPercent = 0.0F; - - for (const auto &prevMsg : - messages | std::views::reverse | - std::views::take(getSettings()->hideSimilarMaxMessagesToCheck)) - { - if (prevMsg->parseTime.secsTo(QTime::currentTime()) >= - getSettings()->hideSimilarMaxDelay) - { - break; - } - if (getSettings()->hideSimilarBySameUser && - msg->loginName != prevMsg->loginName) - { - continue; - } - similarityPercent = std::max( - similarityPercent, - relativeSimilarity(msg->messageText, prevMsg->messageText)); - } - - return similarityPercent; -} - -} // namespace chatterino::similarity::detail - namespace chatterino { -void setSimilarityFlags(const MessagePtr &message, - const std::ranges::bidirectional_range auto &messages) -{ - if (getSettings()->similarityEnabled) - { - bool isMyself = - message->loginName == - getApp()->getAccounts()->twitch.getCurrent()->getUserName(); - bool hideMyself = getSettings()->hideSimilarMyself; - - if (isMyself && !hideMyself) - { - return; - } - - if (similarity::detail::inMessages(message, messages) > - getSettings()->similarityPercentage) - { - message->flags.set(MessageFlag::Similar); - if (getSettings()->colorSimilarDisabled) - { - message->flags.set(MessageFlag::Disabled); - } - } - } -} +template +void setSimilarityFlags(const MessagePtr &message, const T &messages); } // namespace chatterino diff --git a/src/messages/MessageSink.hpp b/src/messages/MessageSink.hpp index 07e7101a5..b44690ead 100644 --- a/src/messages/MessageSink.hpp +++ b/src/messages/MessageSink.hpp @@ -1,6 +1,7 @@ #pragma once #include "common/enums/MessageContext.hpp" +#include "common/FlagsEnum.hpp" #include "messages/MessageFlag.hpp" #include @@ -15,7 +16,14 @@ using MessagePtr = std::shared_ptr; enum class MessageSinkTrait : uint8_t { None = 0, + + /// Messages with the `Highlighted` and `ShowInMentions` flags should be + /// added to the global mentions channel when encountered. AddMentionsToGlobalChannel = 1 << 0, + + /// A channel-point redemption whose reward is not yet known should not be + /// added to this sink, but queued in the corresponding TwitchChannel + /// (`addQueuedRedemption`). RequiresKnownChannelPointReward = 1 << 1, }; using MessageSinkTraits = FlagsEnum; @@ -51,7 +59,7 @@ public: /// If there is no message found, an empty shared-pointer is returned. virtual MessagePtr findMessageByID(QStringView id) = 0; - /// + /// Behaviour to be exercised when parsing/building messages for this sink. virtual MessageSinkTraits sinkTraits() const = 0; }; diff --git a/src/providers/twitch/TwitchChannel.cpp b/src/providers/twitch/TwitchChannel.cpp index 86d26c249..00bd8c117 100644 --- a/src/providers/twitch/TwitchChannel.cpp +++ b/src/providers/twitch/TwitchChannel.cpp @@ -1356,8 +1356,6 @@ void TwitchChannel::loadRecentMessages() { msgs.push_back(msg); } - - tc->addRecentChatter(msg->displayName); } getApp()->getTwitch()->getMentionsChannel()->fillInMissingMessages(