feat(auth): add support for device code grant flow

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Minor: Remove incognito browser support for `opera/launcher` (this should no longer be a thing). (#5805)
 - Minor: Remove incognito browser support for `iexplore`, because internet explorer is EOL. (#5810)
 - Minor: When (re-)connecting, visible channels are now joined first. (#5850)
+- Minor: Added support for the "Device code grant flow" for authentication. (#5680)
 - Minor: Added the ability to filter on messages by the author's user ID (example: `author.user_id == "22484632"`). (#5862)
 - Minor: Improved error messaging of the `/clip` command. (#5879)
 - Bugfix: Fixed a potential way to escape the Lua Plugin sandbox. (#5846)

src/Application.cpp

@@ -236,7 +236,9 @@ void Application::initialize(Settings &settings, const Paths &paths)
 
     // XXX: Loading Twitch badges after Helix has been initialized, which only happens after
     // the AccountController initialize has been called
-    this->twitchBadges->loadTwitchBadges();
+    this->accounts->twitch.requestCurrent([this](const auto &) {
+        this->twitchBadges->loadTwitchBadges();
+    });
 
 #ifdef CHATTERINO_HAVE_PLUGINS
     this->plugins->initialize(settings);
@@ -271,7 +273,9 @@ void Application::initialize(Settings &settings, const Paths &paths)
     {
         this->initNm(paths);
     }
-    this->twitchPubSub->initialize();
+    this->accounts->twitch.requestCurrent([this](const auto &) {
+        this->twitchPubSub->initialize();
+    });
 
     this->initBttvLiveUpdates();
     this->initSeventvEventAPI();

src/common/ChatterinoSetting.hpp

@@ -111,7 +111,6 @@ class EnumStringSetting : public pajlada::Settings::Setting<QString>
         _registerSetting(this->getData());
     }
 
-    template <typename T2>
     EnumStringSetting<Enum> &operator=(Enum newValue)
     {
         this->setValue(qmagicenum::enumNameString(newValue).toLower());
@@ -138,6 +137,21 @@ class EnumStringSetting : public pajlada::Settings::Setting<QString>
             .value_or(this->defaultValue);
     }
 
+    static Enum get(const std::string &path, Enum defaultValue)
+    {
+        EnumStringSetting<Enum> setting(path, defaultValue);
+
+        return setting.getEnum();
+    }
+
+    static void set(const std::string &path, Enum newValue,
+                    Enum defaultValue = static_cast<Enum>(0))
+    {
+        EnumStringSetting<Enum> setting(path, defaultValue);
+
+        setting = newValue;
+    }
+
     Enum defaultValue;
 
     using pajlada::Settings::Setting<QString>::operator==;

src/common/LinkParser.cpp

@@ -1,7 +1,7 @@
 #define QT_NO_CAST_FROM_ASCII  // avoids unexpected implicit casts
 #include "common/LinkParser.hpp"
 
-#include "util/QCompareCaseInsensitive.hpp"
+#include "util/QCompareTransparent.hpp"
 
 #include <QFile>
 #include <QString>

src/controllers/notifications/NotificationController.hpp

@@ -2,7 +2,7 @@
 
 #include "common/ChatterinoSetting.hpp"
 #include "common/SignalVector.hpp"
-#include "util/QCompareCaseInsensitive.hpp"
+#include "util/QCompareTransparent.hpp"
 
 #include <QTimer>
 

src/messages/MessageBuilder.cpp

@@ -2036,6 +2036,55 @@ MessagePtr MessageBuilder::makeLowTrustUpdateMessage(
     return builder.release();
 }
 
+MessagePtrMut MessageBuilder::makeAccountExpiredMessage(
+    const QString &expirationText)
+{
+    auto loginPromptText = u"Try adding your account again."_s;
+
+    MessageBuilder builder;
+    auto text = expirationText % ' ' % loginPromptText;
+    builder->messageText = text;
+    builder->searchText = text;
+    builder->flags.set(MessageFlag::System,
+                       MessageFlag::DoNotTriggerNotification);
+
+    builder.emplace<TimestampElement>();
+    builder.emplace<TextElement>(expirationText, MessageElementFlag::Text,
+                                 MessageColor::System);
+    builder
+        .emplace<TextElement>(loginPromptText, MessageElementFlag::Text,
+                              MessageColor::Link)
+        ->setLink({Link::OpenAccountsPage, {}});
+
+    return builder.release();
+}
+
+MessagePtrMut MessageBuilder::makeMissingScopesMessage(
+    const QString &missingScopes)
+{
+    auto warnText = u"Your account is missing the following permission(s): " %
+                    missingScopes %
+                    u". Some features might not work correctly.";
+    auto linkText = u"Consider re-adding your account."_s;
+
+    MessageBuilder builder;
+    auto text = warnText % ' ' % linkText;
+    builder->messageText = text;
+    builder->searchText = text;
+    builder->flags.set(MessageFlag::System,
+                       MessageFlag::DoNotTriggerNotification);
+
+    builder.emplace<TimestampElement>();
+    builder.emplace<TextElement>(warnText, MessageElementFlag::Text,
+                                 MessageColor::System);
+    builder
+        .emplace<TextElement>(linkText, MessageElementFlag::Text,
+                              MessageColor::Link)
+        ->setLink({Link::OpenAccountsPage, {}});
+
+    return builder.release();
+}
+
 MessagePtrMut MessageBuilder::makeClearChatMessage(const QDateTime &now,
                                                    const QString &actor,
                                                    uint32_t count)

src/messages/MessageBuilder.hpp

@@ -263,6 +263,11 @@ class MessageBuilder
                                             const QVariantMap &tags,
                                             const QTime &time);
 
+    static MessagePtrMut makeAccountExpiredMessage(
+        const QString &expirationText);
+
+    static MessagePtrMut makeMissingScopesMessage(const QString &missingScopes);
+
     /// "Chat has been cleared by a moderator." or "{actor} cleared the chat."
     /// @param actor The user who cleared the chat (empty if unknown)
     /// @param count How many times this message has been received already

src/providers/irc/IrcConnection2.cpp

@@ -53,7 +53,7 @@ IrcConnection::IrcConnection(QObject *parent)
         else
         {
             qCDebug(chatterinoIrc) << "Reconnecting";
-            this->open();
+            this->connectAndInitializeRequested();
         }
     });
 

src/providers/irc/IrcConnection2.hpp

@@ -12,6 +12,8 @@ namespace chatterino {
 
 class IrcConnection : public Communi::IrcConnection
 {
+    Q_OBJECT
+
 public:
     IrcConnection(QObject *parent = nullptr);
     ~IrcConnection() override;
@@ -31,6 +33,11 @@ class IrcConnection : public Communi::IrcConnection
     virtual void open();
     virtual void close();
 
+signals:
+    /// Emitted when this connection intends to be connected.
+    /// The server should initialize this connection an open it.
+    void connectAndInitializeRequested();
+
 private:
     QTimer pingTimer_;
     QTimer reconnectTimer_;

src/providers/twitch/IrcMessageHandler.cpp

@@ -229,29 +229,10 @@ MessagePtr parseNoticeMessage(Communi::IrcNoticeMessage *message)
 
     if (message->content().startsWith("Login auth", Qt::CaseInsensitive))
     {
-        const auto linkColor = MessageColor(MessageColor::Link);
-        const auto accountsLink = Link(Link::OpenAccountsPage, QString());
         const auto curUser = getApp()->getAccounts()->twitch.getCurrent();
-        const auto expirationText = QString("Login expired for user \"%1\"!")
-                                        .arg(curUser->getUserName());
-        const auto loginPromptText = QString("Try adding your account again.");
 
-        MessageBuilder builder;
-        auto text = QString("%1 %2").arg(expirationText, loginPromptText);
-        builder.message().messageText = text;
-        builder.message().searchText = text;
-        builder.message().flags.set(MessageFlag::System);
-        builder.message().flags.set(MessageFlag::DoNotTriggerNotification);
-
-        builder.emplace<TimestampElement>();
-        builder.emplace<TextElement>(expirationText, MessageElementFlag::Text,
-                                     MessageColor::System);
-        builder
-            .emplace<TextElement>(loginPromptText, MessageElementFlag::Text,
-                                  linkColor)
-            ->setLink(accountsLink);
-
-        return builder.release();
+        return MessageBuilder::makeAccountExpiredMessage(
+            u"Login expired for user \"" % curUser->getUserName() % u"\"!");
     }
 
     if (message->content().startsWith("You are permanently banned "))

src/providers/twitch/TwitchAccount.cpp

@@ -30,14 +30,74 @@ namespace chatterino {
 
 using namespace literals;
 
-TwitchAccount::TwitchAccount(const QString &username, const QString &oauthToken,
-                             const QString &oauthClient, const QString &userID)
+std::optional<TwitchAccountData> TwitchAccountData::loadRaw(
+    const std::string &key)
+{
+    using QStringSetting = pajlada::Settings::Setting<QString>;
+
+    auto username = QStringSetting::get("/accounts/" + key + "/username");
+    auto userID = QStringSetting::get("/accounts/" + key + "/userID");
+    auto clientID = QStringSetting::get("/accounts/" + key + "/clientID");
+    auto oauthToken = QStringSetting::get("/accounts/" + key + "/oauthToken");
+
+    if (username.isEmpty() || userID.isEmpty() || clientID.isEmpty() ||
+        oauthToken.isEmpty())
+    {
+        return std::nullopt;
+    }
+
+    auto accountType = EnumStringSetting<TwitchAccount::Type>::get(
+        "/accounts/" + key + "/accountType",
+        TwitchAccount::Type::ImplicitGrant);
+    auto refreshToken =
+        QStringSetting::get("/accounts/" + key + "/refreshToken");
+    auto expiresAtStr = QStringSetting::get("/accounts/" + key + "/expiresAt");
+    QDateTime expiresAt;
+    if (accountType == TwitchAccount::Type::DeviceAuth)
+    {
+        expiresAt = QDateTime::fromString(expiresAtStr, Qt::ISODate);
+    }
+
+    return TwitchAccountData{
+        .username = username.trimmed(),
+        .userID = userID.trimmed(),
+        .clientID = clientID.trimmed(),
+        .oauthToken = oauthToken.trimmed(),
+        .ty = accountType,
+        .refreshToken = refreshToken,
+        .expiresAt = expiresAt,
+    };
+}
+
+void TwitchAccountData::save() const
+{
+    using QStringSetting = pajlada::Settings::Setting<QString>;
+
+    auto basePath = "/accounts/uid" + this->userID.toStdString();
+    QStringSetting::set(basePath + "/username", this->username);
+    QStringSetting::set(basePath + "/userID", this->userID);
+    QStringSetting::set(basePath + "/clientID", this->clientID);
+    QStringSetting::set(basePath + "/oauthToken", this->oauthToken);
+    EnumStringSetting<TwitchAccount::Type>::set(basePath + "/accountType",
+                                                this->ty);
+    QStringSetting::set(basePath + "/refreshToken", this->refreshToken);
+    if (this->ty == TwitchAccount::Type::DeviceAuth)
+    {
+        QStringSetting::set(basePath + "/expiresAt",
+                            this->expiresAt.toString(Qt::ISODate));
+    }
+}
+
+TwitchAccount::TwitchAccount(const TwitchAccountData &data)
     : Account(ProviderId::Twitch)
-    , oauthClient_(oauthClient)
-    , oauthToken_(oauthToken)
-    , userName_(username)
-    , userId_(userID)
-    , isAnon_(username == ANONYMOUS_USERNAME)
+    , oauthClient_(data.clientID)
+    , oauthToken_(data.oauthToken)
+    , userName_(data.username)
+    , userId_(data.userID)
+    , type_(data.ty)
+    , refreshToken_(data.refreshToken)
+    , expiresAt_(data.expiresAt)
+    , isAnon_(data.username == ANONYMOUS_USERNAME)
     , emoteSets_(std::make_shared<TwitchEmoteSetMap>())
     , emotes_(std::make_shared<EmoteMap>())
 {
@@ -70,6 +130,21 @@ const QString &TwitchAccount::getUserId() const
     return this->userId_;
 }
 
+const QString &TwitchAccount::refreshToken() const
+{
+    return this->refreshToken_;
+}
+
+const QDateTime &TwitchAccount::expiresAt() const
+{
+    return this->expiresAt_;
+}
+
+TwitchAccount::Type TwitchAccount::type() const
+{
+    return this->type_;
+}
+
 QColor TwitchAccount::color()
 {
     return this->color_.get();
@@ -80,28 +155,39 @@ void TwitchAccount::setColor(QColor color)
     this->color_.set(std::move(color));
 }
 
-bool TwitchAccount::setOAuthClient(const QString &newClientID)
+bool TwitchAccount::setData(const TwitchAccountData &data)
 {
-    if (this->oauthClient_.compare(newClientID) == 0)
-    {
-        return false;
-    }
+    assert(this->userName_ == data.username && this->userId_ == data.userID);
 
-    this->oauthClient_ = newClientID;
-
-    return true;
-}
+    bool anyUpdate = false;
 
-bool TwitchAccount::setOAuthToken(const QString &newOAuthToken)
-{
-    if (this->oauthToken_.compare(newOAuthToken) == 0)
+    if (this->oauthToken_ != data.oauthToken)
     {
-        return false;
+        this->oauthToken_ = data.oauthToken;
+        anyUpdate = true;
+    }
+    if (this->oauthClient_ != data.clientID)
+    {
+        this->oauthClient_ = data.clientID;
+        anyUpdate = true;
+    }
+    if (this->refreshToken_ != data.refreshToken)
+    {
+        this->refreshToken_ = data.refreshToken;
+        anyUpdate = true;
+    }
+    if (this->expiresAt_ != data.expiresAt)
+    {
+        this->expiresAt_ = data.expiresAt;
+        anyUpdate = true;
+    }
+    if (this->type_ != data.ty)
+    {
+        this->type_ = data.ty;
+        anyUpdate = true;
     }
 
-    this->oauthToken_ = newOAuthToken;
-
-    return true;
+    return anyUpdate;
 }
 
 bool TwitchAccount::isAnon() const