Migrate /ban and /timeout to Helix API (#4049)

src/controllers/commands/CommandController.cpp

@@ -2511,6 +2511,195 @@ void CommandController::initialize(Settings &, Paths &paths)
             });
         return "";
     });
+
+    auto formatBanTimeoutError =
+        [](const char *operation, HelixBanUserError error,
+           const QString &message, const QString &userDisplayName) -> QString {
+        using Error = HelixBanUserError;
+
+        QString errorMessage = QString("Failed to %1 user - ").arg(operation);
+
+        switch (error)
+        {
+            case Error::ConflictingOperation: {
+                errorMessage += "There was a conflicting ban operation on "
+                                "this user. Please try again.";
+            }
+            break;
+
+            case Error::Forwarded: {
+                errorMessage += message;
+            }
+            break;
+
+            case Error::Ratelimited: {
+                errorMessage += "You are being ratelimited by Twitch. Try "
+                                "again in a few seconds.";
+            }
+            break;
+
+            case Error::TargetBanned: {
+                // Equivalent IRC error
+                errorMessage = QString("%1 is already banned in this channel.")
+                                   .arg(userDisplayName);
+            }
+            break;
+
+            case Error::UserMissingScope: {
+                // TODO(pajlada): Phrase MISSING_REQUIRED_SCOPE
+                errorMessage += "Missing required scope. "
+                                "Re-login with your "
+                                "account and try again.";
+            }
+            break;
+
+            case Error::UserNotAuthorized: {
+                // TODO(pajlada): Phrase MISSING_PERMISSION
+                errorMessage += "You don't have permission to "
+                                "perform that action.";
+            }
+            break;
+
+            case Error::Unknown: {
+                errorMessage += "An unknown error has occurred.";
+            }
+            break;
+        }
+        return errorMessage;
+    };
+
+    this->registerCommand("/timeout", [formatBanTimeoutError](
+                                          const QStringList &words,
+                                          auto channel) {
+        const auto *usageStr =
+            "Usage: \"/timeout <username> [duration][time unit] [reason]\" - "
+            "Temporarily prevent a user from chatting. Duration (optional, "
+            "default=10 minutes) must be a positive integer; time unit "
+            "(optional, default=s) must be one of s, m, h, d, w; maximum "
+            "duration is 2 weeks. Combinations like 1d2h are also allowed. "
+            "Reason is optional and will be shown to the target user and other "
+            "moderators. Use \"/untimeout\" to remove a timeout.";
+        if (words.size() < 2)
+        {
+            channel->addMessage(makeSystemMessage(usageStr));
+            return "";
+        }
+
+        auto currentUser = getApp()->accounts->twitch.getCurrent();
+        if (currentUser->isAnon())
+        {
+            channel->addMessage(
+                makeSystemMessage("You must be logged in to timeout someone!"));
+            return "";
+        }
+
+        auto *twitchChannel = dynamic_cast<TwitchChannel *>(channel.get());
+        if (twitchChannel == nullptr)
+        {
+            channel->addMessage(makeSystemMessage(
+                QString("The /timeout command only works in Twitch channels")));
+            return "";
+        }
+
+        auto target = words.at(1);
+        stripChannelName(target);
+
+        int duration = 10 * 60;  // 10min
+        if (words.size() >= 3)
+        {
+            duration = (int)parseDurationToSeconds(words.at(2));
+            if (duration <= 0)
+            {
+                channel->addMessage(makeSystemMessage(usageStr));
+                return "";
+            }
+        }
+        auto reason = words.mid(3).join(' ');
+
+        getHelix()->getUserByName(
+            target,
+            [channel, currentUser, twitchChannel, target, duration, reason,
+             formatBanTimeoutError](const auto &targetUser) {
+                getHelix()->banUser(
+                    twitchChannel->roomId(), currentUser->getUserId(),
+                    targetUser.id, duration, reason,
+                    [] {
+                        // No response for timeouts, they're emitted over pubsub/IRC instead
+                    },
+                    [channel, target, targetUser, formatBanTimeoutError](
+                        auto error, auto message) {
+                        auto errorMessage = formatBanTimeoutError(
+                            "timeout", error, message, targetUser.displayName);
+                        channel->addMessage(makeSystemMessage(errorMessage));
+                    });
+            },
+            [channel, target] {
+                // Equivalent error from IRC
+                channel->addMessage(makeSystemMessage(
+                    QString("Invalid username: %1").arg(target)));
+            });
+
+        return "";
+    });
+
+    this->registerCommand("/ban", [formatBanTimeoutError](
+                                      const QStringList &words, auto channel) {
+        const auto *usageStr =
+            "Usage: \"/ban <username> [reason]\" - Permanently prevent a user "
+            "from chatting. Reason is optional and will be shown to the target "
+            "user and other moderators. Use \"/unban\" to remove a ban.";
+        if (words.size() < 2)
+        {
+            channel->addMessage(makeSystemMessage(usageStr));
+            return "";
+        }
+
+        auto currentUser = getApp()->accounts->twitch.getCurrent();
+        if (currentUser->isAnon())
+        {
+            channel->addMessage(
+                makeSystemMessage("You must be logged in to ban someone!"));
+            return "";
+        }
+
+        auto *twitchChannel = dynamic_cast<TwitchChannel *>(channel.get());
+        if (twitchChannel == nullptr)
+        {
+            channel->addMessage(makeSystemMessage(
+                QString("The /ban command only works in Twitch channels")));
+            return "";
+        }
+
+        auto target = words.at(1);
+        stripChannelName(target);
+
+        auto reason = words.mid(2).join(' ');
+
+        getHelix()->getUserByName(
+            target,
+            [channel, currentUser, twitchChannel, target, reason,
+             formatBanTimeoutError](const auto &targetUser) {
+                getHelix()->banUser(
+                    twitchChannel->roomId(), currentUser->getUserId(),
+                    targetUser.id, boost::none, reason,
+                    [] {
+                        // No response for bans, they're emitted over pubsub/IRC instead
+                    },
+                    [channel, target, targetUser, formatBanTimeoutError](
+                        auto error, auto message) {
+                        auto errorMessage = formatBanTimeoutError(
+                            "ban", error, message, targetUser.displayName);
+                        channel->addMessage(makeSystemMessage(errorMessage));
+                    });
+            },
+            [channel, target] {
+                // Equivalent error from IRC
+                channel->addMessage(makeSystemMessage(
+                    QString("Invalid username: %1").arg(target)));
+            });
+
+        return "";
+    });
 }
 
 void CommandController::save()