From 69bdac9936cd981679a8f5d2bf15b7873292b83f Mon Sep 17 00:00:00 2001
From: Mm2PL <mm2pl+gh@kotmisia.pl>
Date: Sat, 30 Mar 2024 12:28:49 +0100
Subject: [PATCH] Add `reward.cost` `reward.id`, `reward.title` filter
 variables (#5275)

---
 CHANGELOG.md                                  |  1 +
 src/controllers/filters/lang/Filter.cpp       | 12 ++++++++++++
 src/controllers/filters/lang/Filter.hpp       |  3 +++
 src/controllers/filters/lang/Tokenizer.hpp    |  6 +++++-
 src/messages/Message.hpp                      |  3 +++
 src/providers/twitch/TwitchMessageBuilder.cpp |  2 ++
 src/widgets/helper/ChannelView.cpp            | 14 ++++++++++++++
 7 files changed, 40 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1ce0f4f60..b82b51b8a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -50,6 +50,7 @@
 - Minor: Image links now reflect the scale of their image instead of an internal label. (#5201)
 - Minor: IPC files are now stored in the Chatterino directory instead of system directories on Windows. (#5226)
 - Minor: 7TV emotes now have a 4x image rather than a 3x image. (#5209)
+- Minor: Add `reward.cost` `reward.id`, `reward.title` filter variables. (#5275)
 - Bugfix: Fixed an issue where certain emojis did not send to Twitch chat correctly. (#4840)
 - Bugfix: Fixed the `/shoutout` command not working with usernames starting with @'s (e.g. `/shoutout @forsen`). (#4800)
 - Bugfix: Fixed capitalized channel names in log inclusion list not being logged. (#4848)
diff --git a/src/controllers/filters/lang/Filter.cpp b/src/controllers/filters/lang/Filter.cpp
index 7ae61991a..ef0cfd15c 100644
--- a/src/controllers/filters/lang/Filter.cpp
+++ b/src/controllers/filters/lang/Filter.cpp
@@ -120,6 +120,18 @@ ContextMap buildContextMap(const MessagePtr &m, chatterino::Channel *channel)
             vars["channel.live"] = false;
         }
     }
+    if (m->reward != nullptr)
+    {
+        vars["reward.title"] = m->reward->title;
+        vars["reward.cost"] = m->reward->cost;
+        vars["reward.id"] = m->reward->id;
+    }
+    else
+    {
+        vars["reward.title"] = "";
+        vars["reward.cost"] = -1;
+        vars["reward.id"] = "";
+    }
     return vars;
 }
 
diff --git a/src/controllers/filters/lang/Filter.hpp b/src/controllers/filters/lang/Filter.hpp
index c8afbd769..01d7a765e 100644
--- a/src/controllers/filters/lang/Filter.hpp
+++ b/src/controllers/filters/lang/Filter.hpp
@@ -48,6 +48,9 @@ static const QMap<QString, Type> MESSAGE_TYPING_CONTEXT = {
     {"flags.monitored", Type::Bool},
     {"message.content", Type::String},
     {"message.length", Type::Int},
+    {"reward.title", Type::String},
+    {"reward.cost", Type::Int},
+    {"reward.id", Type::String},
 };
 
 ContextMap buildContextMap(const MessagePtr &m, chatterino::Channel *channel);
diff --git a/src/controllers/filters/lang/Tokenizer.hpp b/src/controllers/filters/lang/Tokenizer.hpp
index 2fbc5fd95..6ca9d373c 100644
--- a/src/controllers/filters/lang/Tokenizer.hpp
+++ b/src/controllers/filters/lang/Tokenizer.hpp
@@ -35,7 +35,11 @@ static const QMap<QString, QString> validIdentifiersMap = {
     {"flags.restricted", "restricted message?"},
     {"flags.monitored", "monitored message?"},
     {"message.content", "message text"},
-    {"message.length", "message length"}};
+    {"message.length", "message length"},
+    {"reward.title", "point reward title"},
+    {"reward.cost", "point reward cost"},
+    {"reward.id", "point reward id"},
+};
 
 // clang-format off
 static const QRegularExpression tokenRegex(
diff --git a/src/messages/Message.hpp b/src/messages/Message.hpp
index b9e0b2321..bdbe120dd 100644
--- a/src/messages/Message.hpp
+++ b/src/messages/Message.hpp
@@ -1,6 +1,7 @@
 #pragma once
 
 #include "common/FlagsEnum.hpp"
+#include "providers/twitch/ChannelPointReward.hpp"
 #include "util/QStringHash.hpp"
 
 #include <magic_enum/magic_enum.hpp>
@@ -107,6 +108,8 @@ struct Message {
     std::vector<std::unique_ptr<MessageElement>> elements;
 
     ScrollbarHighlight getScrollBarHighlight() const;
+
+    std::shared_ptr<ChannelPointReward> reward = nullptr;
 };
 
 }  // namespace chatterino
diff --git a/src/providers/twitch/TwitchMessageBuilder.cpp b/src/providers/twitch/TwitchMessageBuilder.cpp
index 88c0f671e..524d0375d 100644
--- a/src/providers/twitch/TwitchMessageBuilder.cpp
+++ b/src/providers/twitch/TwitchMessageBuilder.cpp
@@ -1625,6 +1625,8 @@ void TwitchMessageBuilder::appendChannelPointRewardMessage(
     builder->message().messageText = textList.join(" ");
     builder->message().searchText = textList.join(" ");
     builder->message().loginName = reward.user.login;
+
+    builder->message().reward = std::make_shared<ChannelPointReward>(reward);
 }
 
 void TwitchMessageBuilder::liveMessage(const QString &channelName,
diff --git a/src/widgets/helper/ChannelView.cpp b/src/widgets/helper/ChannelView.cpp
index 9c45c6d9a..2795e5ffe 100644
--- a/src/widgets/helper/ChannelView.cpp
+++ b/src/widgets/helper/ChannelView.cpp
@@ -268,6 +268,20 @@ void addHiddenContextMenuItems(QMenu *menu,
         jsonObject["searchText"] = message->searchText;
         jsonObject["messageText"] = message->messageText;
         jsonObject["flags"] = qmagicenum::enumFlagsName(message->flags.value());
+        if (message->reward)
+        {
+            QJsonObject reward;
+            reward["id"] = message->reward->id;
+            reward["title"] = message->reward->title;
+            reward["cost"] = message->reward->cost;
+            reward["isUserInputRequired"] =
+                message->reward->isUserInputRequired;
+            jsonObject["reward"] = reward;
+        }
+        else
+        {
+            jsonObject["reward"] = QJsonValue();
+        }
 
         jsonDocument.setObject(jsonObject);