Add Command to Set Logging/Filter Rules at Runtime

CHANGELOG.md

@@ -15,6 +15,7 @@
 - Bugfix: Fixed Ctrl+Backspace not working after Select All in chat search popup. (#4461)
 - Bugfix: Fixed crash when scrolling up really fast. (#4621)
 - Dev: Added the ability to control the `followRedirect` mode for requests. (#4594)
+- Dev: Added command to set Qt's logging filter/rules at runtime (`/c2:loggingrules`). (#4637)
 
 ## 2.4.3
 

src/CMakeLists.txt

@@ -60,6 +60,8 @@ set(SOURCE_FILES
         controllers/accounts/AccountModel.cpp
         controllers/accounts/AccountModel.hpp
 
+        controllers/commands/builtin/chatterino/Debugging.cpp
+        controllers/commands/builtin/chatterino/Debugging.hpp
         controllers/commands/builtin/twitch/ChatSettings.cpp
         controllers/commands/builtin/twitch/ChatSettings.hpp
         controllers/commands/builtin/twitch/ShieldMode.cpp

src/controllers/commands/CommandController.cpp

@@ -7,6 +7,7 @@
 #include "common/QLogging.hpp"
 #include "common/SignalVector.hpp"
 #include "controllers/accounts/AccountController.hpp"
+#include "controllers/commands/builtin/chatterino/Debugging.hpp"
 #include "controllers/commands/builtin/twitch/ChatSettings.hpp"
 #include "controllers/commands/builtin/twitch/ShieldMode.hpp"
 #include "controllers/commands/Command.hpp"
@@ -3211,6 +3212,8 @@ void CommandController::initialize(Settings &, Paths &paths)
 
     this->registerCommand("/shield", &commands::shieldModeOn);
     this->registerCommand("/shieldoff", &commands::shieldModeOff);
+
+    this->registerCommand("/c2:loggingrules", &commands::setLoggingRules);
 }
 
 void CommandController::save()

src/controllers/commands/builtin/chatterino/Debugging.cpp

@@ -0,0 +1,44 @@
+#include "controllers/commands/builtin/chatterino/Debugging.hpp"
+
+#include "common/Channel.hpp"
+#include "controllers/commands/CommandContext.hpp"
+#include "messages/MessageBuilder.hpp"
+
+#include <QLoggingCategory>
+#include <QString>
+
+namespace chatterino::commands {
+
+QString setLoggingRules(const CommandContext &ctx)
+{
+    if (ctx.words.size() < 2)
+    {
+        ctx.channel->addMessage(makeSystemMessage(
+            "Usage: /c2:loggingrules <rules...>. To enable debug logging for "
+            "all "
+            "categories from chatterino, use 'chatterino.*.debug=true'. For "
+            "the format on the rules, see "
+            "https://doc.qt.io/qt-6/"
+            "qloggingcategory.html#configuring-categories"));
+        return {};
+    }
+
+    QLoggingCategory::setFilterRules(
+        QList(ctx.words.begin() + 1, ctx.words.end()).join('\n'));
+
+    auto message = QStringLiteral("Updated filter rules.");
+
+    if (!qgetenv("QT_LOGGING_RULES").isEmpty())
+    {
+        message += QStringLiteral(
+            " Warning: Logging rules were previously set by the "
+            "QT_LOGGING_RULES environment variable. This might cause "
+            "interference - see: "
+            "https://doc.qt.io/qt-6/qloggingcategory.html#setFilterRules");
+    }
+
+    ctx.channel->addMessage(makeSystemMessage(message));
+    return "";
+}
+
+}  // namespace chatterino::commands

src/controllers/commands/builtin/chatterino/Debugging.hpp

@@ -0,0 +1,15 @@
+#pragma once
+
+class QString;
+
+namespace chatterino {
+
+struct CommandContext;
+
+namespace commands {
+
+    QString setLoggingRules(const CommandContext &ctx);
+
+}  // namespace commands
+
+}  // namespace chatterino