Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Command to Set Logging/Filter Rules at Runtime #4637

Merged
merged 10 commits into from
May 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Unversioned

- Dev: Added command to set Qt's logging filter/rules at runtime (`/c2-set-logging-rules`). (#4637)

## 2.4.4

- Minor: Added a Send button in the input box so you can click to send a message. This is disabled by default and can be enabled with the "Show send message button" setting. (#4607)
Expand Down
2 changes: 2 additions & 0 deletions src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/controllers/commands/CommandController.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -3211,6 +3212,8 @@ void CommandController::initialize(Settings &, Paths &paths)

this->registerCommand("/shield", &commands::shieldModeOn);
this->registerCommand("/shieldoff", &commands::shieldModeOff);

this->registerCommand("/c2-set-logging-rules", &commands::setLoggingRules);
}

void CommandController::save()
Expand Down
45 changes: 45 additions & 0 deletions src/controllers/commands/builtin/chatterino/Debugging.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
#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 {
pajlada marked this conversation as resolved.
Show resolved Hide resolved

QString setLoggingRules(const CommandContext &ctx)
{
if (ctx.words.size() < 2)
{
ctx.channel->addMessage(makeSystemMessage(
"Usage: /c2-set-logging-rules <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 {};
Nerixyz marked this conversation as resolved.
Show resolved Hide resolved
}

auto filterRules = ctx.words.mid(1).join('\n');

QLoggingCategory::setFilterRules(filterRules);
Mm2PL marked this conversation as resolved.
Show resolved Hide resolved

auto message =
QStringLiteral("Updated filter rules to '%1'.").arg(filterRules);

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
15 changes: 15 additions & 0 deletions src/controllers/commands/builtin/chatterino/Debugging.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#pragma once

class QString;

namespace chatterino {

struct CommandContext;

} // namespace chatterino

namespace chatterino::commands {

QString setLoggingRules(const CommandContext &ctx);

} // namespace chatterino::commands