Add custom image functionality for inline mod buttons.

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unversioned
 
+- Minor: Add option to customise Moderation buttons with images. (#5369)
+
 ## 2.5.1
 
 - Bugfix: Fixed links without a protocol not being clickable. (#5345)

src/CMakeLists.txt

@@ -500,6 +500,8 @@ set(SOURCE_FILES
         util/IpcQueue.hpp
         util/LayoutHelper.cpp
         util/LayoutHelper.hpp
+        util/LoadPixmap.cpp
+        util/LoadPixmap.hpp
         util/RapidjsonHelpers.cpp
         util/RapidjsonHelpers.hpp
         util/RatelimitBucket.cpp

src/controllers/moderationactions/ModerationAction.cpp

@@ -6,28 +6,11 @@
 #include "singletons/Resources.hpp"
 
 #include <QRegularExpression>
+#include <QUrl>
 
 namespace chatterino {
 
-// ModerationAction::ModerationAction(Image *_image, const QString &_action)
-//    : _isImage(true)
-//    , image(_image)
-//    , action(_action)
-//{
-//}
-
-// ModerationAction::ModerationAction(const QString &_line1, const QString
-// &_line2,
-//                                   const QString &_action)
-//    : _isImage(false)
-//    , image(nullptr)
-//    , line1(_line1)
-//    , line2(_line2)
-//    , action(_action)
-//{
-//}
-
-ModerationAction::ModerationAction(const QString &action)
+ModerationAction::ModerationAction(const QString &action, const QUrl &iconPath)
     : action_(action)
 {
     static QRegularExpression replaceRegex("[!/.]");
@@ -99,21 +82,14 @@ ModerationAction::ModerationAction(const QString &action)
             }
             this->line2_ = "w";
         }
-
-        // line1 = this->line1_;
-        // line2 = this->line2_;
-        // } else {
-        //     this->_moderationActions.emplace_back(getResources().buttonTimeout,
-        //     str);
-        // }
     }
     else if (action.startsWith("/ban "))
     {
-        this->imageToLoad_ = 1;
+        this->builtInImageToLoad_ = BuiltInImage::Ban;
     }
     else if (action.startsWith("/delete "))
     {
-        this->imageToLoad_ = 2;
+        this->builtInImageToLoad_ = BuiltInImage::TrashCan;
     }
     else
     {
@@ -124,6 +100,12 @@ ModerationAction::ModerationAction(const QString &action)
         this->line1_ = xD.mid(0, 2);
         this->line2_ = xD.mid(2, 2);
     }
+
+    if (!iconPath.isEmpty())
+    {
+        this->builtInImageToLoad_ = BuiltInImage::None;
+        this->iconPath_ = iconPath;
+    }
 }
 
 bool ModerationAction::operator==(const ModerationAction &other) const
@@ -139,19 +121,23 @@ bool ModerationAction::isImage() const
 const std::optional<ImagePtr> &ModerationAction::getImage() const
 {
     assertInGuiThread();
+    if (this->image_.has_value())
+    {
+        return this->image_;
+    }
 
-    if (this->imageToLoad_ != 0)
+    if (this->builtInImageToLoad_ == BuiltInImage::Ban)
     {
-        if (this->imageToLoad_ == 1)
-        {
-            this->image_ =
-                Image::fromResourcePixmap(getResources().buttons.ban);
-        }
-        else if (this->imageToLoad_ == 2)
-        {
-            this->image_ =
-                Image::fromResourcePixmap(getResources().buttons.trashCan);
-        }
+        this->image_ = Image::fromResourcePixmap(getResources().buttons.ban);
+    }
+    else if (this->builtInImageToLoad_ == BuiltInImage::TrashCan)
+    {
+        this->image_ =
+            Image::fromResourcePixmap(getResources().buttons.trashCan);
+    }
+    else if (!this->iconPath_.isEmpty())
+    {
+        this->image_ = Image::fromUrl({this->iconPath_.toString()});
     }
 
     return this->image_;

src/controllers/moderationactions/ModerationAction.hpp

@@ -4,6 +4,7 @@
 
 #include <pajlada/serialize.hpp>
 #include <QString>
+#include <QUrl>
 
 #include <memory>
 #include <optional>
@@ -16,7 +17,7 @@ using ImagePtr = std::shared_ptr<Image>;
 class ModerationAction
 {
 public:
-    ModerationAction(const QString &action);
+    ModerationAction(const QString &action, const QUrl &iconPath = {});
 
     bool operator==(const ModerationAction &other) const;
 
@@ -26,12 +27,25 @@ class ModerationAction
     const QString &getLine2() const;
     const QString &getAction() const;
 
+    const QUrl &iconPath() const
+    {
+        return this->iconPath_;
+    };
+
 private:
     mutable std::optional<ImagePtr> image_;
     QString line1_;
     QString line2_;
     QString action_;
-    int imageToLoad_{};
+
+    enum class BuiltInImage {
+        None,
+        Ban,
+        TrashCan,
+    };
+    BuiltInImage builtInImageToLoad_{};
+
+    QUrl iconPath_;
 };
 
 }  // namespace chatterino
@@ -46,6 +60,7 @@ struct Serialize<chatterino::ModerationAction> {
         rapidjson::Value ret(rapidjson::kObjectType);
 
         chatterino::rj::set(ret, "pattern", value.getAction(), a);
+        chatterino::rj::set(ret, "icon", value.iconPath().toString(), a);
 
         return ret;
     }
@@ -63,10 +78,12 @@ struct Deserialize<chatterino::ModerationAction> {
         }
 
         QString pattern;
-
         chatterino::rj::getSafe(value, "pattern", pattern);
 
-        return chatterino::ModerationAction(pattern);
+        QString icon;
+        chatterino::rj::getSafe(value, "icon", icon);
+
+        return chatterino::ModerationAction(pattern, QUrl(icon));
     }
 };
 

src/controllers/moderationactions/ModerationActionModel.cpp

@@ -1,28 +1,46 @@
 #include "controllers/moderationactions/ModerationActionModel.hpp"
 
 #include "controllers/moderationactions/ModerationAction.hpp"
+#include "messages/Image.hpp"
+#include "util/LoadPixmap.hpp"
+#include "util/PostToThread.hpp"
 #include "util/StandardItemHelper.hpp"
 
+#include <QIcon>
+#include <QPixmap>
+
 namespace chatterino {
 
 // commandmodel
 ModerationActionModel ::ModerationActionModel(QObject *parent)
-    : SignalVectorModel<ModerationAction>(1, parent)
+    : SignalVectorModel<ModerationAction>(2, parent)
 {
 }
 
 // turn a vector item into a model row
 ModerationAction ModerationActionModel::getItemFromRow(
     std::vector<QStandardItem *> &row, const ModerationAction &original)
 {
-    return ModerationAction(row[0]->data(Qt::DisplayRole).toString());
+    return ModerationAction(
+        row[Column::Command]->data(Qt::DisplayRole).toString(),
+        row[Column::Icon]->data(Qt::UserRole).toString());
 }
 
 // turns a row in the model into a vector item
 void ModerationActionModel::getRowFromItem(const ModerationAction &item,
                                            std::vector<QStandardItem *> &row)
 {
-    setStringItem(row[0], item.getAction());
+    setStringItem(row[Column::Command], item.getAction());
+    setFilePathItem(row[Column::Icon], item.iconPath());
+    if (!item.iconPath().isEmpty())
+    {
+        loadPixmapFromUrl(
+            (*item.getImage())->url(), [row](const QPixmap &pixmap) {
+                postToThread([row, pixmap]() {
+                    row[Column::Icon]->setData(pixmap, Qt::DecorationRole);
+                });
+            });
+    }
 }
 
 }  // namespace chatterino

src/controllers/moderationactions/ModerationActionModel.hpp

@@ -13,6 +13,11 @@ class ModerationActionModel : public SignalVectorModel<ModerationAction>
 public:
     explicit ModerationActionModel(QObject *parent);
 
+    enum Column {
+        Command = 0,
+        Icon = 1,
+    };
+
 protected:
     // turn a vector item into a model row
     ModerationAction getItemFromRow(std::vector<QStandardItem *> &row,

src/providers/twitch/TwitchBadges.cpp

@@ -7,6 +7,7 @@
 #include "messages/Image.hpp"
 #include "providers/twitch/api/Helix.hpp"
 #include "util/DisplayBadge.hpp"
+#include "util/LoadPixmap.hpp"
 
 #include <QBuffer>
 #include <QFile>
@@ -243,44 +244,16 @@ void TwitchBadges::loadEmoteImage(const QString &name, ImagePtr image,
                                   BadgeIconCallback &&callback)
 {
     auto url = image->url().string;
-    NetworkRequest(url)
-        .concurrent()
-        .cache()
-        .onSuccess([this, name, callback, url](auto result) {
-            auto data = result.getData();
-
-            // const cast since we are only reading from it
-            QBuffer buffer(const_cast<QByteArray *>(&data));
-            buffer.open(QIODevice::ReadOnly);
-            QImageReader reader(&buffer);
-
-            if (!reader.canRead() || reader.size().isEmpty())
-            {
-                qCWarning(chatterinoTwitch)
-                    << "Can't read badge image at" << url << "for" << name
-                    << reader.errorString();
-                return;
-            }
-
-            QImage image = reader.read();
-            if (image.isNull())
-            {
-                qCWarning(chatterinoTwitch)
-                    << "Failed reading badge image at" << url << "for" << name
-                    << reader.errorString();
-                return;
-            }
+    loadPixmapFromUrl({url}, [this, name, callback, url](auto pixmap) {
+        auto icon = std::make_shared<QIcon>(pixmap);
 
-            auto icon = std::make_shared<QIcon>(QPixmap::fromImage(image));
-
-            {
-                std::unique_lock lock(this->badgesMutex_);
-                this->badgesMap_[name] = icon;
-            }
+        {
+            std::unique_lock lock(this->badgesMutex_);
+            this->badgesMap_[name] = icon;
+        }
 
-            callback(name, icon);
-        })
-        .execute();
+        callback(name, icon);
+    });
 }
 
 }  // namespace chatterino

src/util/LoadPixmap.cpp

@@ -0,0 +1,49 @@
+#include "common/network/NetworkRequest.hpp"
+#include "common/network/NetworkResult.hpp"
+#include "common/QLogging.hpp"
+#include "messages/Image.hpp"
+
+#include <QBuffer>
+#include <QImageReader>
+#include <QLoggingCategory>
+#include <QPixmap>
+
+namespace chatterino {
+
+void loadPixmapFromUrl(const Url &url, std::function<void(QPixmap)> &&callback)
+{
+    NetworkRequest(url.string)
+        .concurrent()
+        .cache()
+        .onSuccess(
+            [callback = std::move(callback), url](const NetworkResult &result) {
+                auto data = result.getData();
+
+                // const cast since we are only reading from it
+                QBuffer buffer(const_cast<QByteArray *>(&data));
+                buffer.open(QIODevice::ReadOnly);
+                QImageReader reader(&buffer);
+
+                if (!reader.canRead() || reader.size().isEmpty())
+                {
+                    qCWarning(chatterinoSettings)
+                        << "Can't read image file at" << url.string << ":"
+                        << reader.errorString();
+                    return;
+                }
+
+                QImage image = reader.read();
+                if (image.isNull())
+                {
+                    qCWarning(chatterinoSettings)
+                        << "Failed reading image at" << url.string << ":"
+                        << reader.errorString();
+                    return;
+                }
+
+                callback(QPixmap::fromImage(image));
+            })
+        .execute();
+}
+
+}  // namespace chatterino

src/util/LoadPixmap.hpp

@@ -0,0 +1,15 @@
+#pragma once
+#include "common/Aliases.hpp"
+
+#include <QPixmap>
+
+namespace chatterino {
+
+/**
+ * Loads an image from url into a QPixmap. Allows for file:// protocol links. Uses cacheing.
+ *
+ * @param callback The callback you will get the pixmap by. It will be invoked concurrently with no guarantees on which thread.
+ */
+void loadPixmapFromUrl(const Url &url, std::function<void(QPixmap)> &&callback);
+
+}  // namespace chatterino