Fix log files unlocking when closing chat

CHANGELOG.md

@@ -24,6 +24,7 @@
 - Bugfix: Fixed the input completion popup from disappearing when clicking on it on Windows and macOS. (#4876)
 - Bugfix: Fixed double-click text selection moving its position with each new message. (#4898)
 - Bugfix: Fixed an issue where notifications on Windows would contain no or an old avatar. (#4899)
+- Bugfix: Fixed log files being locked longer than needed. (#4928)
 - Dev: Fixed UTF16 encoding of `modes` file for the installer. (#4791)
 - Dev: Temporarily disable High DPI scaling on Qt6 builds on Windows. (#4767)
 - Dev: Tests now run on Ubuntu 22.04 instead of 20.04 to loosen C++ restrictions in tests. (#4774)

src/common/Channel.cpp

@@ -3,9 +3,6 @@
 #include "Application.hpp"
 #include "messages/Message.hpp"
 #include "messages/MessageBuilder.hpp"
-#include "providers/irc/IrcChannel2.hpp"
-#include "providers/irc/IrcServer.hpp"
-#include "providers/twitch/IrcMessageHandler.hpp"
 #include "singletons/Emotes.hpp"
 #include "singletons/Logging.hpp"
 #include "singletons/Settings.hpp"
@@ -32,6 +29,13 @@ Channel::Channel(const QString &name, Type type)
     , messages_(getSettings()->scrollbackSplitLimit)
     , type_(type)
 {
+    this->logFolderName_ = [this]() -> QString {
+        if (this->isTwitchChannel())
+        {
+            return "twitch";
+        }
+        return "other";
+    }();
 }
 
 Channel::~Channel()
@@ -74,6 +78,11 @@ bool Channel::hasMessages() const
     return !this->messages_.empty();
 }
 
+const QString &Channel::logFolderName()
+{
+    return this->logFolderName_;
+}
+
 LimitedQueueSnapshot<MessagePtr> Channel::getMessageSnapshot()
 {
     return this->messages_.getSnapshot();
@@ -82,26 +91,19 @@ LimitedQueueSnapshot<MessagePtr> Channel::getMessageSnapshot()
 void Channel::addMessage(MessagePtr message,
                          std::optional<MessageFlags> overridingFlags)
 {
-    auto app = getApp();
     MessagePtr deleted;
 
-    if (!overridingFlags || !overridingFlags->has(MessageFlag::DoNotLog))
+    if (getSettings()->enableLogging &&
+        (!overridingFlags || !overridingFlags->has(MessageFlag::DoNotLog)))
     {
-        QString channelPlatform("other");
-        if (this->type_ == Type::Irc)
+        if (!this->isLogInitialized_)
         {
-            auto *irc = dynamic_cast<IrcChannel *>(this);
-            if (irc != nullptr)
-            {
-                channelPlatform = QString("irc-%1").arg(
-                    irc->server()->userFriendlyIdentifier());
-            }
+            getApp()->logging->addChannel(this->name_, this->logFolderName());
+            this->isLogInitialized_ = true;
         }
-        else if (this->isTwitchChannel())
-        {
-            channelPlatform = "twitch";
-        }
-        app->logging->addMessage(this->name_, message, channelPlatform);
+
+        getApp()->logging->addMessage(this->name_, message,
+                                      this->logFolderName());
     }
 
     if (this->messages_.pushBack(message, deleted))

src/common/Channel.hpp

@@ -104,6 +104,7 @@ class Channel : public std::enable_shared_from_this<Channel>
     virtual bool shouldIgnoreHighlights() const;
     virtual bool canReconnect() const;
     virtual void reconnect();
+    virtual const QString &logFolderName();
 
     static std::shared_ptr<Channel> getEmpty();
 
@@ -118,6 +119,8 @@ class Channel : public std::enable_shared_from_this<Channel>
     const QString name_;
     LimitedQueue<MessagePtr> messages_;
     Type type_;
+    bool isLogInitialized_{false};
+    QString logFolderName_;
     QTimer clearCompletionModelTimer_;
 };
 

src/providers/irc/IrcChannel2.cpp

@@ -1,12 +1,14 @@
 #include "IrcChannel2.hpp"
 
+#include "Application.hpp"
 #include "debug/AssertInGuiThread.hpp"
 #include "messages/Message.hpp"
 #include "messages/MessageBuilder.hpp"
 #include "messages/MessageElement.hpp"
 #include "providers/irc/IrcCommands.hpp"
 #include "providers/irc/IrcMessageBuilder.hpp"
 #include "providers/irc/IrcServer.hpp"
+#include "singletons/Logging.hpp"
 #include "util/Helpers.hpp"
 
 namespace chatterino {
@@ -15,9 +17,15 @@ IrcChannel::IrcChannel(const QString &name, IrcServer *server)
     : Channel(name, Channel::Type::Irc)
     , ChannelChatters(*static_cast<Channel *>(this))
     , server_(server)
+    , logFolderName_(QString("irc-%1").arg(server->userFriendlyIdentifier()))
 {
 }
 
+IrcChannel::~IrcChannel()
+{
+    getApp()->logging->removeChannel(this->getName(), this->logFolderName());
+}
+
 void IrcChannel::sendMessage(const QString &message)
 {
     assertInGuiThread();
@@ -97,6 +105,11 @@ bool IrcChannel::canReconnect() const
     return true;
 }
 
+const QString &IrcChannel::logFolderName()
+{
+    return this->logFolderName_;
+}
+
 void IrcChannel::reconnect()
 {
     if (this->server())

src/providers/irc/IrcChannel2.hpp

@@ -12,6 +12,7 @@ class IrcChannel final : public Channel, public ChannelChatters
 {
 public:
     explicit IrcChannel(const QString &name, IrcServer *server);
+    ~IrcChannel() override;
 
     void sendMessage(const QString &message) override;
 
@@ -20,12 +21,14 @@ class IrcChannel final : public Channel, public ChannelChatters
 
     // Channel methods
     bool canReconnect() const override;
+    const QString &logFolderName() override;
     void reconnect() override;
 
 private:
     void setServer(IrcServer *server);
 
     IrcServer *server_;
+    QString logFolderName_;
 
     friend class Irc;
 };

src/providers/twitch/TwitchChannel.cpp

@@ -32,6 +32,7 @@
 #include "providers/twitch/TwitchIrcServer.hpp"
 #include "providers/twitch/TwitchMessageBuilder.hpp"
 #include "singletons/Emotes.hpp"
+#include "singletons/Logging.hpp"
 #include "singletons/Settings.hpp"
 #include "singletons/Toasts.hpp"
 #include "singletons/WindowManager.hpp"
@@ -237,6 +238,7 @@ TwitchChannel::~TwitchChannel()
         getApp()->twitch->seventvEventAPI->unsubscribeTwitchChannel(
             this->roomId());
     }
+    getApp()->logging->removeChannel(this->getName(), this->logFolderName());
 }
 
 void TwitchChannel::initialize()

src/singletons/Logging.cpp

@@ -4,9 +4,6 @@
 #include "singletons/Paths.hpp"
 #include "singletons/Settings.hpp"
 
-#include <QDir>
-#include <QStandardPaths>
-
 #include <memory>
 #include <utility>
 
@@ -36,11 +33,6 @@ void Logging::addMessage(const QString &channelName, MessagePtr message,
 {
     this->threadGuard.guard();
 
-    if (!getSettings()->enableLogging)
-    {
-        return;
-    }
-
     if (getSettings()->onlyLogListedChannels)
     {
         if (!this->onlyLogListedChannels.contains(channelName))
@@ -49,27 +41,35 @@ void Logging::addMessage(const QString &channelName, MessagePtr message,
         }
     }
 
-    auto platIt = this->loggingChannels_.find(platformName);
-    if (platIt == this->loggingChannels_.end())
+    this->loggingChannels_.at(platformName)
+        .at(channelName)
+        ->addMessage(std::move(message));
+}
+
+void Logging::addChannel(const QString &channelName,
+                         const QString &platformName)
+{
+    if (!this->loggingChannels_.contains(platformName))
     {
-        auto channel = new LoggingChannel(channelName, platformName);
-        channel->addMessage(message);
-        auto map = std::map<QString, std::unique_ptr<LoggingChannel>>();
-        this->loggingChannels_[platformName] = std::move(map);
-        auto &ref = this->loggingChannels_.at(platformName);
-        ref.emplace(channelName, std::move(channel));
-        return;
+        this->loggingChannels_.emplace(
+            platformName,
+            std::unordered_map<ChannelName, std::unique_ptr<LoggingChannel>>());
     }
-    auto chanIt = platIt->second.find(channelName);
-    if (chanIt == platIt->second.end())
+
+    if (!this->loggingChannels_.at(platformName).contains(channelName))
     {
         auto channel = new LoggingChannel(channelName, platformName);
-        channel->addMessage(message);
-        platIt->second.emplace(channelName, std::move(channel));
+        this->loggingChannels_.at(platformName)
+            .emplace(channelName, std::unique_ptr<LoggingChannel>(channel));
     }
-    else
+}
+
+void Logging::removeChannel(const QString &channelName,
+                            const QString &platformName)
+{
+    if (this->loggingChannels_.contains(platformName))
     {
-        chanIt->second->addMessage(message);
+        this->loggingChannels_.at(platformName).erase(channelName);
     }
 }
 

src/singletons/Logging.hpp

@@ -6,8 +6,8 @@
 
 #include <QString>
 
-#include <map>
 #include <memory>
+#include <unordered_map>
 #include <unordered_set>
 
 namespace chatterino {
@@ -28,12 +28,15 @@ class Logging : public Singleton
 
     void addMessage(const QString &channelName, MessagePtr message,
                     const QString &platformName);
+    void addChannel(const QString &channelName, const QString &platformName);
+    void removeChannel(const QString &channelName, const QString &platformName);
 
 private:
     using PlatformName = QString;
     using ChannelName = QString;
-    std::map<PlatformName,
-             std::map<ChannelName, std::unique_ptr<LoggingChannel>>>
+    std::unordered_map<
+        PlatformName,
+        std::unordered_map<ChannelName, std::unique_ptr<LoggingChannel>>>
         loggingChannels_;
 
     // Keeps the value of the `loggedChannels` settings