feat: introduce emote providers

CHANGELOG.md

@@ -49,6 +49,7 @@
 - Dev: Compile time definitions for `Windows.h` are now conditional based on `WIN32` instead of `MSVC`. (#6534)
 - Dev: Refactored split container nodes to use shared pointers. (#6435)
 - Dev: Mock headers are now added as a header set if supported by CMake. (#6561)
+- Dev: Refactored emotes. (#6570)
 - Dev: Set settings directory to temporary one used in tests. (#6584)
 - Dev: Check Lua unwinding and version in tests. (#6586)
 - Dev: Added method to get the last N messages of a channel. (#6602, #6604)

mocks/CMakeLists.txt

@@ -14,6 +14,7 @@ if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
             include/mocks/ChatterinoBadges.hpp
             include/mocks/DisabledStreamerMode.hpp
             include/mocks/EmoteController.hpp
+            include/mocks/EmoteProvider.hpp
             include/mocks/EmptyApplication.hpp
             include/mocks/Helix.hpp
             include/mocks/LinkResolver.hpp

mocks/include/mocks/EmoteController.hpp

@@ -13,6 +13,12 @@ class EmoteController : public chatterino::EmoteController
         this->getEmojis()->load();
     }
 
+    void addProvider(EmoteProviderPtr provider)
+    {
+        this->providers_.emplace_back(std::move(provider));
+        this->sort();
+    }
+
     void initialize() override
     {
     }

mocks/include/mocks/EmoteProvider.hpp

@@ -0,0 +1,85 @@
+#pragma once
+
+#include "common/Channel.hpp"
+#include "controllers/emotes/EmoteProvider.hpp"
+
+#include <QStringBuilder>
+
+namespace chatterino::mock {
+
+class EmoteProvider : public chatterino::EmoteProvider
+{
+public:
+    EmoteProvider(QString name, QString id, uint32_t priority)
+        : chatterino::EmoteProvider(std::move(name), std::move(id), priority)
+    {
+    }
+
+    void setGlobalEmotes(EmoteMapPtr map)
+    {
+        this->globalEmotes_ = std::move(map);
+    }
+
+    void setChannel(const QString &name, EmoteMapPtr map)
+    {
+        this->channels[name] = std::move(map);
+    }
+
+    void setChannelFallback(EmoteMapPtr map)
+    {
+        this->channelFallback = std::move(map);
+    }
+
+    void initialize() override
+    {
+    }
+
+    void reloadGlobalEmotes(
+        std::function<void(ExpectedStr<void>)> onDone) override
+    {
+        onDone({});
+    }
+
+    void loadChannelEmotes(
+        const std::shared_ptr<Channel> &channel,
+        std::function<void(ExpectedStr<EmoteLoadResult>)> onDone,
+        LoadChannelArgs /* args */) override
+    {
+        auto it = channels.find(channel->getName());
+        if (it == this->channels.end())
+        {
+            if (this->channelFallback)
+            {
+                onDone(EmoteLoadResult{.emotes = this->channelFallback});
+            }
+            else
+            {
+                onDone(makeUnexpected("No emotes for this channel"));
+            }
+        }
+        else
+        {
+            onDone(EmoteLoadResult{.emotes = it->second});
+        }
+    }
+
+    bool supportsChannel(Channel * /*channel*/) override
+    {
+        return true;
+    }
+
+    bool hasChannelEmotes() const override
+    {
+        return true;
+    }
+
+    bool hasGlobalEmotes() const override
+    {
+        return true;
+    }
+
+    std::unordered_map<QString, EmoteMapPtr> channels;
+    EmoteMapPtr channelFallback;
+};
+
+}  // namespace chatterino::mock

src/CMakeLists.txt

@@ -163,6 +163,10 @@ set(SOURCE_FILES
 
         controllers/emotes/EmoteController.cpp
         controllers/emotes/EmoteController.hpp
+        controllers/emotes/EmoteHolder.cpp
+        controllers/emotes/EmoteHolder.hpp
+        controllers/emotes/EmoteProvider.cpp
+        controllers/emotes/EmoteProvider.hpp
 
         controllers/filters/FilterModel.cpp
         controllers/filters/FilterModel.hpp

src/common/Channel.cpp

@@ -1,6 +1,7 @@
 #include "common/Channel.hpp"
 
 #include "Application.hpp"
+#include "controllers/emotes/EmoteHolder.hpp"
 #include "messages/Message.hpp"
 #include "messages/MessageBuilder.hpp"
 #include "messages/MessageSimilarity.hpp"
@@ -435,6 +436,16 @@ void Channel::messageRemovedFromStart(const MessagePtr &msg)
 {
 }
 
+EmoteHolder *Channel::emotes()
+{
+    return this->emotes_.get();
+}
+
+const EmoteHolder *Channel::emotes() const
+{
+    return this->emotes_.get();
+}
+
 //
 // Indirect channel
 //

src/common/Channel.hpp

@@ -20,6 +20,8 @@ namespace chatterino {
 struct Message;
 using MessagePtr = std::shared_ptr<const Message>;
 
+class EmoteHolder;
+
 class Channel : public std::enable_shared_from_this<Channel>, public MessageSink
 {
 public:
@@ -122,6 +124,9 @@ class Channel : public std::enable_shared_from_this<Channel>, public MessageSink
 
     MessageSinkTraits sinkTraits() const final;
 
+    EmoteHolder *emotes();
+    const EmoteHolder *emotes() const;
+
     // CHANNEL INFO
     virtual bool canSendMessage() const;
     virtual bool isWritable() const;  // whether split input will be usable
@@ -147,6 +152,8 @@ class Channel : public std::enable_shared_from_this<Channel>, public MessageSink
     virtual void messageRemovedFromStart(const MessagePtr &msg);
     QString platform_;
 
+    std::unique_ptr<EmoteHolder> emotes_;
+
 private:
     const QString name_;
     LimitedQueue<MessagePtr> messages_;

src/common/QLogging.cpp

@@ -17,6 +17,7 @@ Q_LOGGING_CATEGORY(chatterinoCompletion, "chatterino.completion", logThreshold);
 Q_LOGGING_CATEGORY(chatterinoCrashhandler, "chatterino.crashhandler",
                    logThreshold);
 Q_LOGGING_CATEGORY(chatterinoEmoji, "chatterino.emoji", logThreshold);
+Q_LOGGING_CATEGORY(chatterinoEmotes, "chatterino.emotes", logThreshold);
 Q_LOGGING_CATEGORY(chatterinoEnv, "chatterino.env", logThreshold);
 Q_LOGGING_CATEGORY(chatterinoFfzemotes, "chatterino.ffzemotes", logThreshold);
 Q_LOGGING_CATEGORY(chatterinoHelper, "chatterino.helper", logThreshold);

src/common/QLogging.hpp

@@ -12,6 +12,7 @@ Q_DECLARE_LOGGING_CATEGORY(chatterinoCommon);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoCompletion);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoCrashhandler);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoEmoji);
+Q_DECLARE_LOGGING_CATEGORY(chatterinoEmotes);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoEnv);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoFfzemotes);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoHelper);

src/controllers/commands/builtin/twitch/SendWhisper.cpp

@@ -109,6 +109,7 @@ bool appendWhisperMessageWordsLocally(const QStringList &words)
     const auto &accemotes = *acc->accessEmotes();
     const auto *bttvemotes = app->getBttvEmotes();
     const auto *ffzemotes = app->getFfzEmotes();
+    const auto *emoteController = app->getEmotes();
     auto emote = std::optional<EmotePtr>{};
     for (int i = 2; i < words.length(); i++)
     {
@@ -134,8 +135,16 @@ bool appendWhisperMessageWordsLocally(const QStringList &words)
                 continue;
             }
         }  // bttv/ffz emote
+        {  // third party emotes
+            emote = emoteController->resolveGlobal(EmoteName{words[i]});
+            if (emote)
+            {
+                b.emplace<EmoteElement>(*emote, MessageElementFlag::Emote);
+                continue;
+            }
+        }  // third party emotes
         {  // emoji/text
-            for (auto &variant : app->getEmotes()->getEmojis()->parse(words[i]))
+            for (auto &variant : emoteController->getEmojis()->parse(words[i]))
             {
                 constexpr const static struct {
                     void operator()(EmotePtr emote, MessageBuilder &b) const

src/controllers/completion/sources/EmoteSource.cpp

@@ -4,6 +4,8 @@
 #include "controllers/accounts/AccountController.hpp"
 #include "controllers/completion/sources/Helpers.hpp"
 #include "controllers/emotes/EmoteController.hpp"
+#include "controllers/emotes/EmoteHolder.hpp"
+#include "controllers/emotes/EmoteProvider.hpp"
 #include "providers/bttv/BttvEmotes.hpp"
 #include "providers/emoji/Emojis.hpp"
 #include "providers/ffz/FfzEmotes.hpp"
@@ -13,6 +15,8 @@
 #include "providers/twitch/TwitchIrcServer.hpp"
 #include "widgets/splits/InputCompletionItem.hpp"
 
+#include <QStringBuilder>
+
 namespace chatterino::completion {
 
 namespace {
@@ -105,6 +109,20 @@ void EmoteSource::initializeFromChannel(const Channel *channel)
             auto user = getApp()->getAccounts()->twitch.getCurrent();
             addEmotes(emotes, **user->accessEmotes(), "Twitch Emote");
 
+            if (const auto *holder = tc->emotes())
+            {
+                for (const auto &data : holder->providerData())
+                {
+                    auto provider = data.provider.lock();
+                    if (!provider)
+                    {
+                        continue;
+                    }
+                    addEmotes(emotes, *data.emotes,
+                              u"Channel " % provider->name());
+                }
+            }
+
             // TODO extract "Channel {BetterTTV,7TV,FrankerFaceZ}" text into a #define.
             if (auto bttv = tc->bttvEmotes())
             {
@@ -120,6 +138,12 @@ void EmoteSource::initializeFromChannel(const Channel *channel)
             }
         }
 
+        for (const auto &provider : app->getEmotes()->getProviders())
+        {
+            addEmotes(emotes, *provider->globalEmotes(),
+                      u"Global " % provider->name());
+        }
+
         if (auto bttvG = app->getBttvEmotes()->emotes())
         {
             addEmotes(emotes, *bttvG, "Global BetterTTV");

src/controllers/emotes/EmoteController.cpp

@@ -1,5 +1,6 @@
 #include "controllers/emotes/EmoteController.hpp"
 
+#include "controllers/emotes/EmoteProvider.hpp"
 #include "providers/emoji/Emojis.hpp"
 #include "providers/twitch/TwitchEmotes.hpp"
 #include "singletons/helper/GifTimer.hpp"
@@ -18,6 +19,55 @@ void EmoteController::initialize()
 {
     this->emojis_->load();
     this->gifTimer_->initialize();
+
+    this->sort();
+
+    for (const auto &provider : this->providers_)
+    {
+        provider->initialize();
+    }
+}
+
+EmoteProviderPtr EmoteController::findProviderByName(QStringView name) const
+{
+    auto it = std::ranges::find_if(this->providers_, [&](const auto &provider) {
+        return provider->name() == name;
+    });
+    if (it == this->providers_.end())
+    {
+        return nullptr;
+    }
+    return *it;
+}
+
+EmoteProviderPtr EmoteController::findProviderByID(QStringView id) const
+{
+    auto it = std::ranges::find_if(this->providers_, [&](const auto &provider) {
+        return provider->id() == id;
+    });
+    if (it == this->providers_.end())
+    {
+        return nullptr;
+    }
+    return *it;
+}
+
+EmotePtr EmoteController::resolveGlobal(const EmoteName &query) const
+{
+    for (const auto &provider : this->providers_)
+    {
+        auto emote = provider->globalEmote(query);
+        if (emote)
+        {
+            return emote;
+        }
+    }
+    return nullptr;
+}
+
+std::span<const EmoteProviderPtr> EmoteController::getProviders() const
+{
+    return this->providers_;
 }
 
 TwitchEmotes *EmoteController::getTwitchEmotes() const
@@ -35,4 +85,11 @@ GIFTimer *EmoteController::getGIFTimer() const
     return this->gifTimer_.get();
 }
 
+void EmoteController::sort()
+{
+    std::ranges::sort(this->providers_, {}, [](const auto &provider) {
+        return provider->priority();
+    });
+}
+
 }  // namespace chatterino

src/controllers/emotes/EmoteController.hpp

@@ -1,9 +1,18 @@
 #pragma once
 
+#include "messages/Emote.hpp"
+
+#include <pajlada/signals/signal.hpp>
+
 #include <memory>
+#include <span>
+#include <vector>
 
 namespace chatterino {
 
+class EmoteProvider;
+using EmoteProviderPtr = std::shared_ptr<EmoteProvider>;
+
 class TwitchEmotes;
 class Emojis;
 class GIFTimer;
@@ -16,12 +25,24 @@ class EmoteController
 
     virtual void initialize();
 
+    EmoteProviderPtr findProviderByName(QStringView name) const;
+    EmoteProviderPtr findProviderByID(QStringView id) const;
+
+    EmotePtr resolveGlobal(const EmoteName &query) const;
+
+    std::span<const EmoteProviderPtr> getProviders() const;
+
     TwitchEmotes *getTwitchEmotes() const;
 
     Emojis *getEmojis() const;
 
     GIFTimer *getGIFTimer() const;
 
+protected:
+    void sort();
+
+    std::vector<EmoteProviderPtr> providers_;
+
 private:
     std::unique_ptr<TwitchEmotes> twitchEmotes_;
     std::unique_ptr<Emojis> emojis_;