From 65d3e73c5d7cfc3c1f90033ab319cae70c6228b1 Mon Sep 17 00:00:00 2001 From: pajlada Date: Sun, 21 Jan 2024 12:28:20 +0100 Subject: [PATCH] refactor: mini reorganization of FfzEmotes.cpp (#5117) --- src/providers/ffz/FfzEmotes.cpp | 248 ++++++++++++++++---------------- 1 file changed, 125 insertions(+), 123 deletions(-) diff --git a/src/providers/ffz/FfzEmotes.cpp b/src/providers/ffz/FfzEmotes.cpp index f96f17a1b..dfc047535 100644 --- a/src/providers/ffz/FfzEmotes.cpp +++ b/src/providers/ffz/FfzEmotes.cpp @@ -10,147 +10,151 @@ #include "providers/twitch/TwitchChannel.hpp" #include "singletons/Settings.hpp" -namespace chatterino { namespace { - const QString CHANNEL_HAS_NO_EMOTES( - "This channel has no FrankerFaceZ channel emotes."); +using namespace chatterino; - Url getEmoteLink(const QJsonObject &urls, const QString &emoteScale) +// NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) +const auto &LOG = chatterinoFfzemotes; + +const QString CHANNEL_HAS_NO_EMOTES( + "This channel has no FrankerFaceZ channel emotes."); + +Url getEmoteLink(const QJsonObject &urls, const QString &emoteScale) +{ + auto emote = urls[emoteScale]; + if (emote.isUndefined() || emote.isNull()) { - auto emote = urls[emoteScale]; - if (emote.isUndefined() || emote.isNull()) + return {""}; + } + + assert(emote.isString()); + + return parseFfzUrl(emote.toString()); +} + +void fillInEmoteData(const QJsonObject &urls, const EmoteName &name, + const QString &tooltip, Emote &emoteData) +{ + auto url1x = getEmoteLink(urls, "1"); + auto url2x = getEmoteLink(urls, "2"); + auto url3x = getEmoteLink(urls, "4"); + + //, code, tooltip + emoteData.name = name; + emoteData.images = ImageSet{ + Image::fromUrl(url1x, 1), + url2x.string.isEmpty() ? Image::getEmpty() : Image::fromUrl(url2x, 0.5), + url3x.string.isEmpty() ? Image::getEmpty() + : Image::fromUrl(url3x, 0.25)}; + emoteData.tooltip = {tooltip}; +} + +EmotePtr cachedOrMake(Emote &&emote, const EmoteId &id) +{ + static std::unordered_map> cache; + static std::mutex mutex; + + return cachedOrMakeEmotePtr(std::move(emote), cache, mutex, id); +} + +void parseEmoteSetInto(const QJsonObject &emoteSet, const QString &kind, + EmoteMap &map) +{ + for (const auto emoteRef : emoteSet["emoticons"].toArray()) + { + const auto emoteJson = emoteRef.toObject(); + + // margins + auto id = EmoteId{QString::number(emoteJson["id"].toInt())}; + auto name = EmoteName{emoteJson["name"].toString()}; + auto author = + EmoteAuthor{emoteJson["owner"]["display_name"].toString()}; + auto urls = emoteJson["urls"].toObject(); + if (emoteJson["animated"].isObject()) { - return {""}; + // prefer animated images if available + urls = emoteJson["animated"].toObject(); } - assert(emote.isString()); + Emote emote; + fillInEmoteData(urls, name, + QString("%1
%2 FFZ Emote
By: %3") + .arg(name.string, kind, author.string), + emote); + emote.homePage = + Url{QString("https://www.frankerfacez.com/emoticon/%1-%2") + .arg(id.string) + .arg(name.string)}; - return parseFfzUrl(emote.toString()); + map[name] = cachedOrMake(std::move(emote), id); + } +} + +EmoteMap parseGlobalEmotes(const QJsonObject &jsonRoot) +{ + // Load default sets from the `default_sets` object + std::unordered_set defaultSets{}; + auto jsonDefaultSets = jsonRoot["default_sets"].toArray(); + for (auto jsonDefaultSet : jsonDefaultSets) + { + defaultSets.insert(jsonDefaultSet.toInt()); } - void fillInEmoteData(const QJsonObject &urls, const EmoteName &name, - const QString &tooltip, Emote &emoteData) + auto emotes = EmoteMap(); + + for (const auto emoteSetRef : jsonRoot["sets"].toObject()) { - auto url1x = getEmoteLink(urls, "1"); - auto url2x = getEmoteLink(urls, "2"); - auto url3x = getEmoteLink(urls, "4"); - - //, code, tooltip - emoteData.name = name; - emoteData.images = - ImageSet{Image::fromUrl(url1x, 1), - url2x.string.isEmpty() ? Image::getEmpty() - : Image::fromUrl(url2x, 0.5), - url3x.string.isEmpty() ? Image::getEmpty() - : Image::fromUrl(url3x, 0.25)}; - emoteData.tooltip = {tooltip}; - } - - EmotePtr cachedOrMake(Emote &&emote, const EmoteId &id) - { - static std::unordered_map> cache; - static std::mutex mutex; - - return cachedOrMakeEmotePtr(std::move(emote), cache, mutex, id); - } - - void parseEmoteSetInto(const QJsonObject &emoteSet, const QString &kind, - EmoteMap &map) - { - for (const auto emoteRef : emoteSet["emoticons"].toArray()) + const auto emoteSet = emoteSetRef.toObject(); + auto emoteSetID = emoteSet["id"].toInt(); + if (!defaultSets.contains(emoteSetID)) { - const auto emoteJson = emoteRef.toObject(); - - // margins - auto id = EmoteId{QString::number(emoteJson["id"].toInt())}; - auto name = EmoteName{emoteJson["name"].toString()}; - auto author = - EmoteAuthor{emoteJson["owner"]["display_name"].toString()}; - auto urls = emoteJson["urls"].toObject(); - if (emoteJson["animated"].isObject()) - { - // prefer animated images if available - urls = emoteJson["animated"].toObject(); - } - - Emote emote; - fillInEmoteData(urls, name, - QString("%1
%2 FFZ Emote
By: %3") - .arg(name.string, kind, author.string), - emote); - emote.homePage = - Url{QString("https://www.frankerfacez.com/emoticon/%1-%2") - .arg(id.string) - .arg(name.string)}; - - map[name] = cachedOrMake(std::move(emote), id); - } - } - - EmoteMap parseGlobalEmotes(const QJsonObject &jsonRoot) - { - // Load default sets from the `default_sets` object - std::unordered_set defaultSets{}; - auto jsonDefaultSets = jsonRoot["default_sets"].toArray(); - for (auto jsonDefaultSet : jsonDefaultSets) - { - defaultSets.insert(jsonDefaultSet.toInt()); + qCDebug(LOG) << "Skipping global emote set" << emoteSetID + << "as it's not part of the default sets"; + continue; } - auto emotes = EmoteMap(); - - for (const auto emoteSetRef : jsonRoot["sets"].toObject()) - { - const auto emoteSet = emoteSetRef.toObject(); - auto emoteSetID = emoteSet["id"].toInt(); - if (!defaultSets.contains(emoteSetID)) - { - qCDebug(chatterinoFfzemotes) - << "Skipping global emote set" << emoteSetID - << "as it's not part of the default sets"; - continue; - } - - parseEmoteSetInto(emoteSet, "Global", emotes); - } - - return emotes; + parseEmoteSetInto(emoteSet, "Global", emotes); } - std::optional parseAuthorityBadge(const QJsonObject &badgeUrls, - const QString &tooltip) + return emotes; +} + +std::optional parseAuthorityBadge(const QJsonObject &badgeUrls, + const QString &tooltip) +{ + std::optional authorityBadge; + + if (!badgeUrls.isEmpty()) { - std::optional authorityBadge; + auto authorityBadge1x = getEmoteLink(badgeUrls, "1"); + auto authorityBadge2x = getEmoteLink(badgeUrls, "2"); + auto authorityBadge3x = getEmoteLink(badgeUrls, "4"); - if (!badgeUrls.isEmpty()) - { - auto authorityBadge1x = getEmoteLink(badgeUrls, "1"); - auto authorityBadge2x = getEmoteLink(badgeUrls, "2"); - auto authorityBadge3x = getEmoteLink(badgeUrls, "4"); + auto authorityBadgeImageSet = ImageSet{ + Image::fromUrl(authorityBadge1x, 1), + authorityBadge2x.string.isEmpty() + ? Image::getEmpty() + : Image::fromUrl(authorityBadge2x, 0.5), + authorityBadge3x.string.isEmpty() + ? Image::getEmpty() + : Image::fromUrl(authorityBadge3x, 0.25), + }; - auto authorityBadgeImageSet = ImageSet{ - Image::fromUrl(authorityBadge1x, 1), - authorityBadge2x.string.isEmpty() - ? Image::getEmpty() - : Image::fromUrl(authorityBadge2x, 0.5), - authorityBadge3x.string.isEmpty() - ? Image::getEmpty() - : Image::fromUrl(authorityBadge3x, 0.25), - }; - - authorityBadge = std::make_shared(Emote{ - {""}, - authorityBadgeImageSet, - Tooltip{tooltip}, - authorityBadge1x, - }); - } - return authorityBadge; + authorityBadge = std::make_shared(Emote{ + .name = {""}, + .images = authorityBadgeImageSet, + .tooltip = Tooltip{tooltip}, + .homePage = authorityBadge1x, + }); } + return authorityBadge; +} } // namespace +namespace chatterino { + using namespace ffz::detail; EmoteMap ffz::detail::parseChannelEmotes(const QJsonObject &jsonRoot) @@ -218,8 +222,7 @@ void FfzEmotes::loadChannel( std::function)> vipBadgeCallback, bool manualRefresh) { - qCDebug(chatterinoFfzemotes) - << "[FFZEmotes] Reload FFZ Channel Emotes for channel" << channelID; + qCDebug(LOG) << "Reload FFZ Channel Emotes for channel" << channelID; NetworkRequest("https://api.frankerfacez.com/v1/room/id/" + channelID) @@ -275,9 +278,8 @@ void FfzEmotes::loadChannel( { // TODO: Auto retry in case of a timeout, with a delay auto errorString = result.formatError(); - qCWarning(chatterinoFfzemotes) - << "Error fetching FFZ emotes for channel" << channelID - << ", error" << errorString; + qCWarning(LOG) << "Error fetching FFZ emotes for channel" + << channelID << ", error" << errorString; shared->addMessage(makeSystemMessage( QStringLiteral("Failed to fetch FrankerFaceZ channel " "emotes. (Error: %1)")