src/gui/uithemedialog.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2023-2024  Vladimir Golovnev <glassez@yandex.ru>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #include "uithemedialog.h"
  30
  31 #include <QColor>
  32 #include <QColorDialog>
  33 #include <QFileDialog>
  34 #include <QJsonDocument>
  35 #include <QJsonObject>
  36 #include <QLabel>
  37 #include <QMenu>
  38 #include <QMessageBox>
  39
  40 #include "base/3rdparty/expected.hpp"
  41 #include "base/global.h"
  42 #include "base/logger.h"
  43 #include "base/path.h"
  44 #include "base/profile.h"
  45 #include "base/utils/fs.h"
  46 #include "base/utils/io.h"
  47 #include "uithemecommon.h"
  48 #include "utils.h"
  49
  50 #include "ui_uithemedialog.h"
  51
  52 #define SETTINGS_KEY(name) u"GUI/UIThemeDialog/" name
  53
  54 namespace
  55 {
  56     Path userConfigPath()
  57     {
  58         return specialFolderLocation(SpecialFolder::Config) / Path(u"themes/default"_s);
  59     }
  60
  61     Path defaultIconPath(const QString &iconID, [[maybe_unused]] const ColorMode colorMode)
  62     {
  63         return Path(u":icons"_s) / Path(iconID + u".svg");
  64     }
  65 }
  66
  67 class ColorWidget final : public QLabel
  68 {
  69     Q_DISABLE_COPY_MOVE(ColorWidget)
  70     Q_DECLARE_TR_FUNCTIONS(ColorWidget)
  71
  72 public:
  73     explicit ColorWidget(const QColor &currentColor, const QColor &defaultColor, QWidget *parent = nullptr)
  74         : QLabel(parent)
  75         , m_defaultColor {defaultColor}
  76         , m_currentColor {currentColor}
  77     {
  78         setObjectName(u"colorWidget"_s);
  79         setFrameShape(QFrame::Box);
  80         setFrameShadow(QFrame::Plain);
  81         setAlignment(Qt::AlignCenter);
  82
  83         applyColor(currentColor);
  84     }
  85
  86     QColor currentColor() const
  87     {
  88         return m_currentColor;
  89     }
  90
  91 private:
  92     void mouseDoubleClickEvent([[maybe_unused]] QMouseEvent *event) override
  93     {
  94         showColorDialog();
  95     }
  96
  97     void contextMenuEvent([[maybe_unused]] QContextMenuEvent *event) override
  98     {
  99         QMenu *menu = new QMenu(this);
 100         menu->setAttribute(Qt::WA_DeleteOnClose);
 101
 102         menu->addAction(tr("Edit..."), this, &ColorWidget::showColorDialog);
 103         menu->addAction(tr("Reset"), this, &ColorWidget::resetColor);
 104
 105         menu->popup(QCursor::pos());
 106     }
 107
 108     void setCurrentColor(const QColor &color)
 109     {
 110         if (m_currentColor == color)
 111             return;
 112
 113         m_currentColor = color;
 114         applyColor(m_currentColor);
 115     }
 116
 117     void resetColor()
 118     {
 119         setCurrentColor(m_defaultColor);
 120     }
 121
 122     void applyColor(const QColor &color)
 123     {
 124         if (color.isValid())
 125         {
 126             setStyleSheet(u"#colorWidget { background-color: %1; }"_s.arg(color.name()));
 127             setText({});
 128         }
 129         else
 130         {
 131             setStyleSheet({});
 132             setText(tr("System"));
 133         }
 134     }
 135
 136     void showColorDialog()
 137     {
 138         auto *dialog = new QColorDialog(m_currentColor, this);
 139         dialog->setAttribute(Qt::WA_DeleteOnClose);
 140         connect(dialog, &QDialog::accepted, this, [this, dialog]
 141         {
 142             setCurrentColor(dialog->currentColor());
 143         });
 144
 145         dialog->open();
 146     }
 147
 148     const QColor m_defaultColor;
 149     QColor m_currentColor;
 150 };
 151
 152 class IconWidget final : public QLabel
 153 {
 154     Q_DISABLE_COPY_MOVE(IconWidget)
 155     Q_DECLARE_TR_FUNCTIONS(IconWidget)
 156
 157 public:
 158     explicit IconWidget(const Path &currentPath, const Path &defaultPath, QWidget *parent = nullptr)
 159         : QLabel(parent)
 160         , m_defaultPath {defaultPath}
 161     {
 162         setObjectName(u"iconWidget"_s);
 163         setAlignment(Qt::AlignCenter);
 164
 165         setCurrentPath(currentPath);
 166     }
 167
 168     Path currentPath() const
 169     {
 170         return m_currentPath;
 171     }
 172
 173 private:
 174     void mouseDoubleClickEvent([[maybe_unused]] QMouseEvent *event) override
 175     {
 176         showFileDialog();
 177     }
 178
 179     void contextMenuEvent([[maybe_unused]] QContextMenuEvent *event) override
 180     {
 181         QMenu *menu = new QMenu(this);
 182         menu->setAttribute(Qt::WA_DeleteOnClose);
 183
 184         menu->addAction(tr("Browse..."), this, &IconWidget::showFileDialog);
 185         menu->addAction(tr("Reset"), this, &IconWidget::resetIcon);
 186
 187         menu->popup(QCursor::pos());
 188     }
 189
 190     void setCurrentPath(const Path &path)
 191     {
 192         if (m_currentPath == path)
 193             return;
 194
 195         m_currentPath = path;
 196         showIcon(m_currentPath);
 197     }
 198
 199     void resetIcon()
 200     {
 201         setCurrentPath(m_defaultPath);
 202     }
 203
 204     void showIcon(const Path &iconPath)
 205     {
 206         const QIcon icon {iconPath.data()};
 207         setPixmap(icon.pixmap(Utils::Gui::smallIconSize()));
 208     }
 209
 210     void showFileDialog()
 211     {
 212         auto *dialog = new QFileDialog(this, tr("Select icon")
 213                 , QDir::homePath(), (tr("Supported image files") + u" (*.svg *.png)"));
 214         dialog->setFileMode(QFileDialog::ExistingFile);
 215         dialog->setAttribute(Qt::WA_DeleteOnClose);
 216         connect(dialog, &QDialog::accepted, this, [this, dialog]
 217         {
 218             const Path iconPath {dialog->selectedFiles().value(0)};
 219             setCurrentPath(iconPath);
 220         });
 221
 222         dialog->open();
 223     }
 224
 225     const Path m_defaultPath;
 226     Path m_currentPath;
 227 };
 228
 229 UIThemeDialog::UIThemeDialog(QWidget *parent)
 230     : QDialog(parent)
 231     , m_ui {new Ui::UIThemeDialog}
 232     , m_storeDialogSize {SETTINGS_KEY(u"Size"_s)}
 233 {
 234     m_ui->setupUi(this);
 235
 236     connect(m_ui->buttonBox, &QDialogButtonBox::accepted, this, &QDialog::accept);
 237     connect(m_ui->buttonBox, &QDialogButtonBox::rejected, this, &QDialog::reject);
 238
 239     loadColors();
 240     loadIcons();
 241
 242     if (const QSize dialogSize = m_storeDialogSize; dialogSize.isValid())
 243         resize(dialogSize);
 244 }
 245
 246 UIThemeDialog::~UIThemeDialog()
 247 {
 248     m_storeDialogSize = size();
 249     delete m_ui;
 250 }
 251
 252 void UIThemeDialog::accept()
 253 {
 254     QDialog::accept();
 255
 256     bool hasError = false;
 257     if (!storeColors())
 258         hasError = true;
 259     if (!storeIcons())
 260         hasError = true;
 261
 262     if (hasError)
 263     {
 264         QMessageBox::critical(this, tr("UI Theme Configuration.")
 265                 , tr("The UI Theme changes could not be fully applied. The details can be found in the Log."));
 266     }
 267 }
 268
 269 void UIThemeDialog::loadColors()
 270 {
 271     const QHash<QString, UIThemeColor> defaultColors = defaultUIThemeColors();
 272     const QList<QString> colorIDs = std::invoke([](auto &&list) { list.sort(); return list; }, defaultColors.keys());
 273     int row = 2;
 274     for (const QString &id : colorIDs)
 275     {
 276         if (id == u"Log.Normal")
 277             qDebug() << "!!!!!!!";
 278         m_ui->colorsLayout->addWidget(new QLabel(id), row, 0);
 279
 280         const UIThemeColor &defaultColor = defaultColors.value(id);
 281
 282         auto *lightColorWidget = new ColorWidget(m_defaultThemeSource.getColor(id, ColorMode::Light), defaultColor.light, this);
 283         m_lightColorWidgets.insert(id, lightColorWidget);
 284         m_ui->colorsLayout->addWidget(lightColorWidget, row, 2);
 285
 286         auto *darkColorWidget = new ColorWidget(m_defaultThemeSource.getColor(id, ColorMode::Dark), defaultColor.dark, this);
 287         m_darkColorWidgets.insert(id, darkColorWidget);
 288         m_ui->colorsLayout->addWidget(darkColorWidget, row, 4);
 289
 290         ++row;
 291     }
 292 }
 293
 294 void UIThemeDialog::loadIcons()
 295 {
 296     const QSet<QString> defaultIcons = defaultUIThemeIcons();
 297     const QList<QString> iconIDs = std::invoke([](auto &&list) { list.sort(); return list; }
 298             , QList<QString>(defaultIcons.cbegin(), defaultIcons.cend()));
 299     int row = 2;
 300     for (const QString &id : iconIDs)
 301     {
 302         m_ui->iconsLayout->addWidget(new QLabel(id), row, 0);
 303
 304         auto *lightIconWidget = new IconWidget(m_defaultThemeSource.getIconPath(id, ColorMode::Light)
 305                 , defaultIconPath(id, ColorMode::Light), this);
 306         m_lightIconWidgets.insert(id, lightIconWidget);
 307         m_ui->iconsLayout->addWidget(lightIconWidget, row, 2);
 308
 309         auto *darkIconWidget = new IconWidget(m_defaultThemeSource.getIconPath(id, ColorMode::Dark)
 310                 , defaultIconPath(id, ColorMode::Dark), this);
 311         m_darkIconWidgets.insert(id, darkIconWidget);
 312         m_ui->iconsLayout->addWidget(darkIconWidget, row, 4);
 313
 314         ++row;
 315     }
 316 }
 317
 318 bool UIThemeDialog::storeColors()
 319 {
 320     QJsonObject userConfig;
 321     userConfig.insert(u"version", 2);
 322
 323     const QHash<QString, UIThemeColor> defaultColors = defaultUIThemeColors();
 324     const auto addColorOverrides = [this, &defaultColors, &userConfig](const ColorMode colorMode)
 325     {
 326         const QHash<QString, ColorWidget *> &colorWidgets = (colorMode == ColorMode::Light)
 327                 ? m_lightColorWidgets : m_darkColorWidgets;
 328
 329         QJsonObject colors;
 330         for (auto it = colorWidgets.cbegin(); it != colorWidgets.cend(); ++it)
 331         {
 332             const QString &colorID = it.key();
 333             const QColor &defaultColor = (colorMode == ColorMode::Light)
 334                     ? defaultColors.value(colorID).light : defaultColors.value(colorID).dark;
 335             const QColor &color = it.value()->currentColor();
 336             if (color != defaultColor)
 337                 colors.insert(it.key(), color.name());
 338         }
 339
 340         if (!colors.isEmpty())
 341             userConfig.insert(((colorMode == ColorMode::Light) ? KEY_COLORS_LIGHT : KEY_COLORS_DARK), colors);
 342     };
 343
 344     addColorOverrides(ColorMode::Light);
 345     addColorOverrides(ColorMode::Dark);
 346
 347     const QByteArray configData = QJsonDocument(userConfig).toJson();
 348     const nonstd::expected<void, QString> result = Utils::IO::saveToFile((userConfigPath() / Path(CONFIG_FILE_NAME)), configData);
 349     if (!result)
 350     {
 351         const QString error = tr("Couldn't save UI Theme configuration. Reason: %1").arg(result.error());
 352         LogMsg(error, Log::WARNING);
 353         return false;
 354     }
 355
 356     return true;
 357 }
 358
 359 bool UIThemeDialog::storeIcons()
 360 {
 361     bool hasError = false;
 362
 363     const auto updateIcons = [this, &hasError](const ColorMode colorMode)
 364     {
 365         const QHash<QString, IconWidget *> &iconWidgets = (colorMode == ColorMode::Light)
 366                 ? m_lightIconWidgets : m_darkIconWidgets;
 367         const Path subdirPath = (colorMode == ColorMode::Light)
 368                 ? Path(u"icons/light"_s) : Path(u"icons/dark"_s);
 369
 370         for (auto it = iconWidgets.cbegin(); it != iconWidgets.cend(); ++it)
 371         {
 372             const QString &id = it.key();
 373             const Path &path = it.value()->currentPath();
 374             if (path == m_defaultThemeSource.getIconPath(id, colorMode))
 375                 continue;
 376
 377             const Path &userIconPathBase = userConfigPath() / subdirPath / Path(id);
 378
 379             if (const Path oldIconPath = userIconPathBase + u".svg"
 380                     ; path.exists() && !Utils::Fs::removeFile(oldIconPath))
 381             {
 382                 const QString error = tr("Couldn't remove icon file. File: %1.").arg(oldIconPath.toString());
 383                 LogMsg(error, Log::WARNING);
 384                 hasError = true;
 385                 continue;
 386             }
 387
 388             if (const Path oldIconPath = userIconPathBase + u".png"
 389                     ; path.exists() && !Utils::Fs::removeFile(oldIconPath))
 390             {
 391                 const QString error = tr("Couldn't remove icon file. File: %1.").arg(oldIconPath.toString());
 392                 LogMsg(error, Log::WARNING);
 393                 hasError = true;
 394                 continue;
 395             }
 396
 397             if (const Path targetPath = userIconPathBase + path.extension()
 398                     ; !Utils::Fs::copyFile(path, targetPath))
 399             {
 400                 const QString error = tr("Couldn't copy icon file. Source: %1. Destination: %2.")
 401                         .arg(path.toString(), targetPath.toString());
 402                 LogMsg(error, Log::WARNING);
 403                 hasError = true;
 404             }
 405         }
 406     };
 407
 408     updateIcons(ColorMode::Light);
 409     updateIcons(ColorMode::Dark);
 410
 411     return !hasError;
 412 }