chatterino2
Code Issues

Migrate /mods command to helix API (#4103)

Browse Source 
Co-authored-by: Felanbird <41973452+Felanbird@users.noreply.github.com>
Co-authored-by: Rasmus Karlsson <rasmus.karlsson@pajlada.com>
This commit is contained in:
Colton Clemmer
2022-11-05 06:20:12 -05:00
committed by GitHub
parent aac9ea53d0
commit e531161c7f
9 changed files with 375 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/providers/twitch/api/Helix.cpp
+136
View File
@@ -6,6 +6,14 @@
#include <QJsonDocument>
#include <magic_enum.hpp>
namespace {
using namespace chatterino;
static constexpr auto NUM_MODERATORS_TO_FETCH_PER_REQUEST = 100;
} // namespace
namespace chatterino {
static IHelix *instance = nullptr;
@@ -1859,6 +1867,115 @@ void Helix::fetchChatters(
.execute();
}
void Helix::onFetchModeratorsSuccess(
std::shared_ptr<std::vector<HelixModerator>> finalModerators,
QString broadcasterID, int maxModeratorsToFetch,
ResultCallback<std::vector<HelixModerator>> successCallback,
FailureCallback<HelixGetModeratorsError, QString> failureCallback,
HelixModerators moderators)
{
qCDebug(chatterinoTwitch)
<< "Fetched " << moderators.moderators.size() << " moderators";
std::for_each(moderators.moderators.begin(), moderators.moderators.end(),
[finalModerators](auto mod) {
finalModerators->push_back(mod);
});
if (moderators.cursor.isEmpty() ||
finalModerators->size() >= maxModeratorsToFetch)
{
// Done paginating
successCallback(*finalModerators);
return;
}
this->fetchModerators(
broadcasterID, NUM_MODERATORS_TO_FETCH_PER_REQUEST, moderators.cursor,
[=](auto moderators) {
this->onFetchModeratorsSuccess(
finalModerators, broadcasterID, maxModeratorsToFetch,
successCallback, failureCallback, moderators);
},
failureCallback);
}
// https://dev.twitch.tv/docs/api/reference#get-moderators
void Helix::fetchModerators(
QString broadcasterID, int first, QString after,
ResultCallback<HelixModerators> successCallback,
FailureCallback<HelixGetModeratorsError, QString> failureCallback)
{
using Error = HelixGetModeratorsError;
QUrlQuery urlQuery;
urlQuery.addQueryItem("broadcaster_id", broadcasterID);
urlQuery.addQueryItem("first", QString::number(first));
if (!after.isEmpty())
{
urlQuery.addQueryItem("after", after);
}
this->makeRequest("moderation/moderators", urlQuery)
.onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200)
{
qCWarning(chatterinoTwitch)
<< "Success result for getting moderators was "
<< result.status() << "but we expected it to be 200";
}
auto response = result.parseJson();
successCallback(HelixModerators(response));
return Success;
})
.onError([failureCallback](auto result) {
auto obj = result.parseJson();
auto message = obj.value("message").toString();
switch (result.status())
{
case 400: {
failureCallback(Error::Forwarded, message);
}
break;
case 401: {
if (message.startsWith("Missing scope",
Qt::CaseInsensitive))
{
failureCallback(Error::UserMissingScope, message);
}
else if (message.contains("OAuth token"))
{
failureCallback(Error::UserNotAuthorized, message);
}
else
{
failureCallback(Error::Forwarded, message);
}
}
break;
case 403: {
failureCallback(Error::UserNotAuthorized, message);
}
break;
default: {
qCDebug(chatterinoTwitch)
<< "Unhandled error data:" << result.status()
<< result.getData() << obj;
failureCallback(Error::Unknown, message);
}
break;
}
})
.execute();
}
// Ban/timeout a user
// https://dev.twitch.tv/docs/api/reference#ban-user
void Helix::banUser(QString broadcasterID, QString moderatorID, QString userID,
@@ -2106,6 +2223,25 @@ void Helix::getChatters(
fetchSuccess(fetchSuccess), failureCallback);
}
// https://dev.twitch.tv/docs/api/reference#get-moderators
void Helix::getModerators(
QString broadcasterID, int maxModeratorsToFetch,
ResultCallback<std::vector<HelixModerator>> successCallback,
FailureCallback<HelixGetModeratorsError, QString> failureCallback)
{
auto finalModerators = std::make_shared<std::vector<HelixModerator>>();
// Initiate the recursive calls
this->fetchModerators(
broadcasterID, NUM_MODERATORS_TO_FETCH_PER_REQUEST, "",
[=](auto moderators) {
this->onFetchModeratorsSuccess(
finalModerators, broadcasterID, maxModeratorsToFetch,
successCallback, failureCallback, moderators);
},
failureCallback);
}
// List the VIPs of a channel
// https://dev.twitch.tv/docs/api/reference#get-vips
void Helix::getChannelVIPs(
src/providers/twitch/api/Helix.hpp
+69 -3
View File
@@ -332,8 +332,13 @@ struct HelixChatSettings {
};
struct HelixVip {
// Twitch ID of the user
QString userId;
// Display name of the user
QString userName;
// Login name of the user
QString userLogin;
explicit HelixVip(const QJsonObject &jsonObject)
@@ -367,9 +372,29 @@ struct HelixChatters {
}
};
// TODO(jammehcow): when implementing mod list, just alias HelixVip to HelixMod
// as they share the same model.
// Alternatively, rename base struct to HelixUser or something and alias both
using HelixModerator = HelixVip;
struct HelixModerators {
std::vector<HelixModerator> moderators;
QString cursor;
HelixModerators() = default;
explicit HelixModerators(const QJsonObject &jsonObject)
: cursor(jsonObject.value("pagination")
.toObject()
.value("cursor")
.toString())
{
const auto &data = jsonObject.value("data").toArray();
for (const auto &mod : data)
{
HelixModerator moderator(mod.toObject());
this->moderators.push_back(moderator);
}
}
};
enum class HelixAnnouncementColor {
Blue,
@@ -553,6 +578,15 @@ enum class HelixGetChattersError {
Forwarded,
};
enum class HelixGetModeratorsError {
Unknown,
UserMissingScope,
UserNotAuthorized,
// The error message is forwarded directly from the Twitch API
Forwarded,
};
enum class HelixListVIPsError { // /vips
Unknown,
UserMissingScope,
@@ -854,6 +888,14 @@ public:
ResultCallback<HelixChatters> successCallback,
FailureCallback<HelixGetChattersError, QString> failureCallback) = 0;
// Get moderators from the `broadcasterID` channel
// This will follow the returned cursor
// https://dev.twitch.tv/docs/api/reference#get-moderators
virtual void getModerators(
QString broadcasterID, int maxModeratorsToFetch,
ResultCallback<std::vector<HelixModerator>> successCallback,
FailureCallback<HelixGetModeratorsError, QString> failureCallback) = 0;
// https://dev.twitch.tv/docs/api/reference#get-vips
virtual void getChannelVIPs(
QString broadcasterID,
@@ -1130,6 +1172,15 @@ public:
ResultCallback<HelixChatters> successCallback,
FailureCallback<HelixGetChattersError, QString> failureCallback) final;
// Get moderators from the `broadcasterID` channel
// This will follow the returned cursor
// https://dev.twitch.tv/docs/api/reference#get-moderators
void getModerators(
QString broadcasterID, int maxModeratorsToFetch,
ResultCallback<std::vector<HelixModerator>> successCallback,
FailureCallback<HelixGetModeratorsError, QString> failureCallback)
final;
// https://dev.twitch.tv/docs/api/reference#get-vips
void getChannelVIPs(
QString broadcasterID,
@@ -1162,6 +1213,21 @@ protected:
ResultCallback<HelixChatters> successCallback,
FailureCallback<HelixGetChattersError, QString> failureCallback);
// Recursive boy
void onFetchModeratorsSuccess(
std::shared_ptr<std::vector<HelixModerator>> finalModerators,
QString broadcasterID, int maxModeratorsToFetch,
ResultCallback<std::vector<HelixModerator>> successCallback,
FailureCallback<HelixGetModeratorsError, QString> failureCallback,
HelixModerators moderators);
// Get moderator list - This method is what actually runs the API request
// https://dev.twitch.tv/docs/api/reference#get-moderators
void fetchModerators(
QString broadcasterID, int first, QString after,
ResultCallback<HelixModerators> successCallback,
FailureCallback<HelixGetModeratorsError, QString> failureCallback);
private:
NetworkRequest makeRequest(QString url, QUrlQuery urlQuery);