#include "providers/twitch/TwitchBadges.hpp" #include "common/network/NetworkRequest.hpp" #include "common/network/NetworkResult.hpp" #include "common/QLogging.hpp" #include "messages/Emote.hpp" #include "messages/Image.hpp" #include "providers/twitch/api/Helix.hpp" #include "util/DisplayBadge.hpp" #include #include #include #include #include #include #include #include #include namespace { // From Twitch docs - expected size for a badge (1x) constexpr QSize BADGE_BASE_SIZE(18, 18); } // namespace namespace chatterino { void TwitchBadges::loadTwitchBadges() { assert(this->loaded_ == false); getHelix()->getGlobalBadges( [this](auto globalBadges) { auto badgeSets = this->badgeSets_.access(); for (const auto &badgeSet : globalBadges.badgeSets) { const auto &setID = badgeSet.setID; for (const auto &version : badgeSet.versions) { const auto &emote = Emote{ .name = EmoteName{}, .images = ImageSet{ Image::fromUrl(version.imageURL1x, 1, BADGE_BASE_SIZE), Image::fromUrl(version.imageURL2x, .5, BADGE_BASE_SIZE * 2), Image::fromUrl(version.imageURL4x, .25, BADGE_BASE_SIZE * 4), }, .tooltip = Tooltip{version.title}, .homePage = version.clickURL, }; (*badgeSets)[setID][version.id] = std::make_shared(emote); } } this->loaded(); }, [this](auto error, auto message) { QString errorMessage("Failed to load global badges - "); switch (error) { case HelixGetGlobalBadgesError::Forwarded: { errorMessage += message; } break; // This would most likely happen if the service is down, or if the JSON payload returned has changed format case HelixGetGlobalBadgesError::Unknown: { errorMessage += "An unknown error has occurred."; } break; } qCWarning(chatterinoTwitch) << errorMessage; QFile file(":/twitch-badges.json"); if (!file.open(QFile::ReadOnly)) { // Despite erroring out, we still want to reach the same point // Loaded should still be set to true to not build up an endless queue, and the quuee should still be flushed. qCWarning(chatterinoTwitch) << "Error loading Twitch Badges from the local backup file"; this->loaded(); return; } auto bytes = file.readAll(); auto doc = QJsonDocument::fromJson(bytes); this->parseTwitchBadges(doc.object()); this->loaded(); }); } void TwitchBadges::parseTwitchBadges(QJsonObject root) { auto badgeSets = this->badgeSets_.access(); auto jsonSets = root.value("badge_sets").toObject(); for (auto sIt = jsonSets.begin(); sIt != jsonSets.end(); ++sIt) { auto key = sIt.key(); auto versions = sIt.value().toObject().value("versions").toObject(); for (auto vIt = versions.begin(); vIt != versions.end(); ++vIt) { auto versionObj = vIt.value().toObject(); auto emote = Emote{ .name = {""}, .images = ImageSet{ Image::fromUrl( {versionObj.value("image_url_1x").toString()}, 1, BADGE_BASE_SIZE), Image::fromUrl( {versionObj.value("image_url_2x").toString()}, .5, BADGE_BASE_SIZE * 2), Image::fromUrl( {versionObj.value("image_url_4x").toString()}, .25, BADGE_BASE_SIZE * 4), }, .tooltip = Tooltip{versionObj.value("title").toString()}, .homePage = Url{versionObj.value("click_url").toString()}, }; (*badgeSets)[key][vIt.key()] = std::make_shared(emote); } } } void TwitchBadges::loaded() { std::unique_lock loadedLock(this->loadedMutex_); assert(this->loaded_ == false); this->loaded_ = true; // Flush callback queue std::unique_lock queueLock(this->queueMutex_); // Once we have gained unique access of the queue, we can release our unique access of the loaded mutex allowing future calls to read locked_ loadedLock.unlock(); while (!this->callbackQueue_.empty()) { auto callback = this->callbackQueue_.front(); this->callbackQueue_.pop(); this->getBadgeIcon(callback.first, callback.second); } } std::optional TwitchBadges::badge(const QString &set, const QString &version) const { auto badgeSets = this->badgeSets_.access(); auto it = badgeSets->find(set); if (it != badgeSets->end()) { auto it2 = it->second.find(version); if (it2 != it->second.end()) { return it2->second; } } return std::nullopt; } std::optional TwitchBadges::badge(const QString &set) const { auto badgeSets = this->badgeSets_.access(); auto it = badgeSets->find(set); if (it != badgeSets->end()) { const auto &badges = it->second; if (!badges.empty()) { return badges.begin()->second; } } return std::nullopt; } void TwitchBadges::getBadgeIcon(const QString &name, BadgeIconCallback callback) { { std::shared_lock loadedLock(this->loadedMutex_); if (!this->loaded_) { // Badges have not been loaded yet, store callback in a queue std::unique_lock queueLock(this->queueMutex_); this->callbackQueue_.emplace(name, std::move(callback)); return; } } { std::shared_lock badgeLock(this->badgesMutex_); if (this->badgesMap_.contains(name)) { callback(name, this->badgesMap_[name]); return; } } // Split string in format "name1/version1,name2/version2" to "name1", "version1" // If not in list+version form, name will remain the same auto targetBadge = name.split(",").at(0).split("/"); const auto badge = targetBadge.size() == 2 ? this->badge(targetBadge.at(0), targetBadge.at(1)) : this->badge(targetBadge.at(0)); if (badge) { this->loadEmoteImage(name, (*badge)->images.getImage3(), std::move(callback)); } } void TwitchBadges::getBadgeIcon(const DisplayBadge &badge, BadgeIconCallback callback) { this->getBadgeIcon(badge.badgeName(), std::move(callback)); } void TwitchBadges::getBadgeIcons(const QList &badges, BadgeIconCallback callback) { for (const auto &item : badges) { this->getBadgeIcon(item, callback); } } void TwitchBadges::loadEmoteImage(const QString &name, ImagePtr image, BadgeIconCallback &&callback) { auto url = image->url().string; NetworkRequest(url) .concurrent() .cache() .onSuccess([this, name, callback, url](auto result) { auto data = result.getData(); // const cast since we are only reading from it QBuffer buffer(const_cast(&data)); buffer.open(QIODevice::ReadOnly); QImageReader reader(&buffer); if (!reader.canRead() || reader.size().isEmpty()) { qCWarning(chatterinoTwitch) << "Can't read badge image at" << url << "for" << name << reader.errorString(); return; } QImage image = reader.read(); if (image.isNull()) { qCWarning(chatterinoTwitch) << "Failed reading badge image at" << url << "for" << name << reader.errorString(); return; } auto icon = std::make_shared(QPixmap::fromImage(image)); { std::unique_lock lock(this->badgesMutex_); this->badgesMap_[name] = icon; } callback(name, icon); }) .execute(); } } // namespace chatterino