Some work about adaptive color scheme for Web UI (PR #19901)
http://[316:c51a:62a3:8b9::4]/d4708/qBittorrent/src/branch/adaptive-webui
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
392 lines
13 KiB
392 lines
13 KiB
/* |
|
* Bittorrent Client using Qt and libtorrent. |
|
* Copyright (C) 2019, 2021 Prince Gupta <jagannatharjun11@gmail.com> |
|
* |
|
* This program is free software; you can redistribute it and/or |
|
* modify it under the terms of the GNU General Public License |
|
* as published by the Free Software Foundation; either version 2 |
|
* of the License, or (at your option) any later version. |
|
* |
|
* This program is distributed in the hope that it will be useful, |
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
* GNU General Public License for more details. |
|
* |
|
* You should have received a copy of the GNU General Public License |
|
* along with this program; if not, write to the Free Software |
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, |
|
* USA. |
|
* |
|
* In addition, as a special exception, the copyright holders give permission to |
|
* link this program with the OpenSSL project's "OpenSSL" library (or with |
|
* modified versions of it that use the same license as the "OpenSSL" library), |
|
* and distribute the linked executables. You must obey the GNU General Public |
|
* License in all respects for all of the code used other than "OpenSSL". If |
|
* you modify file(s), you may extend this exception to your version of the |
|
* file(s), but you are not obligated to do so. If you do not wish to do so, |
|
* delete this exception statement from your version. |
|
*/ |
|
|
|
#include "uithememanager.h" |
|
|
|
#include <QApplication> |
|
#include <QDir> |
|
#include <QFile> |
|
#include <QJsonDocument> |
|
#include <QJsonObject> |
|
#include <QPalette> |
|
#include <QResource> |
|
|
|
#include "base/global.h" |
|
#include "base/logger.h" |
|
#include "base/path.h" |
|
#include "base/preferences.h" |
|
#include "base/utils/fs.h" |
|
|
|
namespace |
|
{ |
|
const Path DEFAULT_ICONS_DIR {u":icons"_qs}; |
|
const QString CONFIG_FILE_NAME {QStringLiteral("config.json")}; |
|
const QString STYLESHEET_FILE_NAME {QStringLiteral("stylesheet.qss")}; |
|
|
|
// Directory used by stylesheet to reference internal resources |
|
// for example `icon: url(:/uitheme/file.svg)` will be expected to |
|
// point to a file `file.svg` in root directory of CONFIG_FILE_NAME |
|
const QString STYLESHEET_RESOURCES_DIR {QStringLiteral(":/uitheme")}; |
|
|
|
const Path THEME_ICONS_DIR {u"icons"_qs}; |
|
|
|
Path findIcon(const QString &iconId, const Path &dir) |
|
{ |
|
const Path pathSvg = dir / Path(iconId + QLatin1String(".svg")); |
|
if (pathSvg.exists()) |
|
return pathSvg; |
|
|
|
const Path pathPng = dir / Path(iconId + QLatin1String(".png")); |
|
if (pathPng.exists()) |
|
return pathPng; |
|
|
|
return {}; |
|
} |
|
|
|
QByteArray readFile(const Path &filePath) |
|
{ |
|
QFile file {filePath.data()}; |
|
if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) |
|
{ |
|
LogMsg(UIThemeManager::tr("UITheme - Failed to open \"%1\". Reason: %2") |
|
.arg(filePath.filename(), file.errorString()) |
|
, Log::WARNING); |
|
return {}; |
|
} |
|
|
|
return file.readAll(); |
|
} |
|
|
|
class QRCThemeSource final : public UIThemeSource |
|
{ |
|
public: |
|
QByteArray readStyleSheet() override |
|
{ |
|
return readFile(m_qrcThemeDir / Path(STYLESHEET_FILE_NAME)); |
|
} |
|
|
|
QByteArray readConfig() override |
|
{ |
|
return readFile(m_qrcThemeDir / Path(CONFIG_FILE_NAME)); |
|
} |
|
|
|
Path iconPath(const QString &iconId) const override |
|
{ |
|
return findIcon(iconId, m_qrcIconsDir); |
|
} |
|
|
|
private: |
|
const Path m_qrcThemeDir {u":/uitheme"_qs}; |
|
const Path m_qrcIconsDir = m_qrcThemeDir / THEME_ICONS_DIR; |
|
}; |
|
|
|
class FolderThemeSource final : public UIThemeSource |
|
{ |
|
public: |
|
explicit FolderThemeSource(const Path &folderPath) |
|
: m_folder {folderPath} |
|
, m_iconsDir {m_folder / THEME_ICONS_DIR} |
|
{ |
|
} |
|
|
|
QByteArray readStyleSheet() override |
|
{ |
|
QByteArray styleSheetData = readFile(m_folder / Path(STYLESHEET_FILE_NAME)); |
|
return styleSheetData.replace(STYLESHEET_RESOURCES_DIR.toUtf8(), m_folder.data().toUtf8()); |
|
} |
|
|
|
QByteArray readConfig() override |
|
{ |
|
return readFile(m_folder / Path(CONFIG_FILE_NAME)); |
|
} |
|
|
|
Path iconPath(const QString &iconId) const override |
|
{ |
|
return findIcon(iconId, m_iconsDir); |
|
} |
|
|
|
private: |
|
const Path m_folder; |
|
const Path m_iconsDir; |
|
}; |
|
|
|
|
|
std::unique_ptr<UIThemeSource> createUIThemeSource(const Path &themePath) |
|
{ |
|
if (themePath.filename() == CONFIG_FILE_NAME) |
|
return std::make_unique<FolderThemeSource>(themePath); |
|
|
|
if ((themePath.hasExtension(QLatin1String(".qbtheme"))) |
|
&& QResource::registerResource(themePath.data(), QLatin1String("/uitheme"))) |
|
{ |
|
return std::make_unique<QRCThemeSource>(); |
|
} |
|
|
|
return nullptr; |
|
} |
|
} |
|
|
|
UIThemeManager *UIThemeManager::m_instance = nullptr; |
|
|
|
void UIThemeManager::freeInstance() |
|
{ |
|
delete m_instance; |
|
m_instance = nullptr; |
|
} |
|
|
|
void UIThemeManager::initInstance() |
|
{ |
|
if (!m_instance) |
|
m_instance = new UIThemeManager; |
|
} |
|
|
|
UIThemeManager::UIThemeManager() |
|
: m_useCustomTheme(Preferences::instance()->useCustomUITheme()) |
|
#if (defined(Q_OS_UNIX) && !defined(Q_OS_MACOS)) |
|
, m_useSystemTheme(Preferences::instance()->useSystemIconTheme()) |
|
#endif |
|
{ |
|
if (m_useCustomTheme) |
|
{ |
|
const Path themePath = Preferences::instance()->customUIThemePath(); |
|
m_themeSource = createUIThemeSource(themePath); |
|
if (!m_themeSource) |
|
{ |
|
LogMsg(tr("Failed to load UI theme from file: \"%1\"").arg(themePath.toString()), Log::WARNING); |
|
} |
|
else |
|
{ |
|
loadColorsFromJSONConfig(); |
|
applyPalette(); |
|
applyStyleSheet(); |
|
} |
|
} |
|
} |
|
|
|
UIThemeManager *UIThemeManager::instance() |
|
{ |
|
return m_instance; |
|
} |
|
|
|
void UIThemeManager::applyStyleSheet() const |
|
{ |
|
qApp->setStyleSheet(QString::fromUtf8(m_themeSource->readStyleSheet())); |
|
} |
|
|
|
QIcon UIThemeManager::getIcon(const QString &iconId, const QString &fallback) const |
|
{ |
|
#if (defined(Q_OS_UNIX) && !defined(Q_OS_MACOS)) |
|
if (m_useSystemTheme) |
|
{ |
|
QIcon icon = QIcon::fromTheme(iconId); |
|
if (icon.name() != iconId) |
|
icon = QIcon::fromTheme(fallback, QIcon(getIconPathFromResources(iconId, fallback).toString())); |
|
return icon; |
|
} |
|
#endif |
|
|
|
// Cache to avoid rescaling svg icons |
|
// And don't cache system icons because users might change them at run time |
|
const auto iter = m_iconCache.find(iconId); |
|
if (iter != m_iconCache.end()) |
|
return *iter; |
|
|
|
const QIcon icon {getIconPathFromResources(iconId, fallback).data()}; |
|
m_iconCache[iconId] = icon; |
|
return icon; |
|
} |
|
|
|
QIcon UIThemeManager::getFlagIcon(const QString &countryIsoCode) const |
|
{ |
|
if (countryIsoCode.isEmpty()) return {}; |
|
|
|
const QString key = countryIsoCode.toLower(); |
|
const auto iter = m_flagCache.find(key); |
|
if (iter != m_flagCache.end()) |
|
return *iter; |
|
|
|
const QIcon icon {QLatin1String(":/icons/flags/") + key + QLatin1String(".svg")}; |
|
m_flagCache[key] = icon; |
|
return icon; |
|
} |
|
|
|
QColor UIThemeManager::getColor(const QString &id, const QColor &defaultColor) const |
|
{ |
|
return m_colors.value(id, defaultColor); |
|
} |
|
|
|
#ifndef Q_OS_MACOS |
|
QIcon UIThemeManager::getSystrayIcon() const |
|
{ |
|
const TrayIcon::Style style = Preferences::instance()->trayIconStyle(); |
|
switch (style) |
|
{ |
|
#if defined(Q_OS_UNIX) |
|
case TrayIcon::Style::Normal: |
|
return QIcon::fromTheme(QLatin1String("qbittorrent-tray")); |
|
case TrayIcon::Style::MonoDark: |
|
return QIcon::fromTheme(QLatin1String("qbittorrent-tray-dark")); |
|
case TrayIcon::Style::MonoLight: |
|
return QIcon::fromTheme(QLatin1String("qbittorrent-tray-light")); |
|
#else |
|
case TrayIcon::Style::Normal: |
|
return getIcon(QLatin1String("qbittorrent-tray")); |
|
case TrayIcon::Style::MonoDark: |
|
return getIcon(QLatin1String("qbittorrent-tray-dark")); |
|
case TrayIcon::Style::MonoLight: |
|
return getIcon(QLatin1String("qbittorrent-tray-light")); |
|
#endif |
|
default: |
|
break; |
|
} |
|
|
|
// As a failsafe in case the enum is invalid |
|
return getIcon(QLatin1String("qbittorrent-tray")); |
|
} |
|
#endif |
|
|
|
Path UIThemeManager::getIconPath(const QString &iconId) const |
|
{ |
|
#if (defined(Q_OS_UNIX) && !defined(Q_OS_MACOS)) |
|
if (m_useSystemTheme) |
|
{ |
|
Path path = Utils::Fs::tempPath() / Path(iconId + QLatin1String(".png")); |
|
if (!path.exists()) |
|
{ |
|
const QIcon icon = QIcon::fromTheme(iconId); |
|
if (!icon.isNull()) |
|
icon.pixmap(32).save(path.toString()); |
|
else |
|
path = getIconPathFromResources(iconId); |
|
} |
|
|
|
return path; |
|
} |
|
#endif |
|
return getIconPathFromResources(iconId, {}); |
|
} |
|
|
|
Path UIThemeManager::getIconPathFromResources(const QString &iconId, const QString &fallback) const |
|
{ |
|
if (m_useCustomTheme && m_themeSource) |
|
{ |
|
const Path customIcon = m_themeSource->iconPath(iconId); |
|
if (!customIcon.isEmpty()) |
|
return customIcon; |
|
|
|
if (!fallback.isEmpty()) |
|
{ |
|
const Path fallbackIcon = m_themeSource->iconPath(fallback); |
|
if (!fallbackIcon.isEmpty()) |
|
return fallbackIcon; |
|
} |
|
} |
|
|
|
return findIcon(iconId, DEFAULT_ICONS_DIR); |
|
} |
|
|
|
void UIThemeManager::loadColorsFromJSONConfig() |
|
{ |
|
const QByteArray config = m_themeSource->readConfig(); |
|
if (config.isEmpty()) |
|
return; |
|
|
|
QJsonParseError jsonError; |
|
const QJsonDocument configJsonDoc = QJsonDocument::fromJson(config, &jsonError); |
|
if (jsonError.error != QJsonParseError::NoError) |
|
{ |
|
LogMsg(tr("\"%1\" has invalid format. Reason: %2").arg(CONFIG_FILE_NAME, jsonError.errorString()), Log::WARNING); |
|
return; |
|
} |
|
if (!configJsonDoc.isObject()) |
|
{ |
|
LogMsg(tr("\"%1\" has invalid format. Reason: %2").arg(CONFIG_FILE_NAME, tr("Root JSON value is not an object")), Log::WARNING); |
|
return; |
|
} |
|
|
|
const QJsonObject colors = configJsonDoc.object().value(u"colors").toObject(); |
|
for (auto color = colors.constBegin(); color != colors.constEnd(); ++color) |
|
{ |
|
const QColor providedColor(color.value().toString()); |
|
if (!providedColor.isValid()) |
|
{ |
|
LogMsg(tr("Invalid color for ID \"%1\" is provided by theme").arg(color.key()), Log::WARNING); |
|
continue; |
|
} |
|
m_colors.insert(color.key(), providedColor); |
|
} |
|
} |
|
|
|
void UIThemeManager::applyPalette() const |
|
{ |
|
struct ColorDescriptor |
|
{ |
|
QString id; |
|
QPalette::ColorRole colorRole; |
|
QPalette::ColorGroup colorGroup; |
|
}; |
|
|
|
const ColorDescriptor paletteColorDescriptors[] = |
|
{ |
|
{QLatin1String("Palette.Window"), QPalette::Window, QPalette::Normal}, |
|
{QLatin1String("Palette.WindowText"), QPalette::WindowText, QPalette::Normal}, |
|
{QLatin1String("Palette.Base"), QPalette::Base, QPalette::Normal}, |
|
{QLatin1String("Palette.AlternateBase"), QPalette::AlternateBase, QPalette::Normal}, |
|
{QLatin1String("Palette.Text"), QPalette::Text, QPalette::Normal}, |
|
{QLatin1String("Palette.ToolTipBase"), QPalette::ToolTipBase, QPalette::Normal}, |
|
{QLatin1String("Palette.ToolTipText"), QPalette::ToolTipText, QPalette::Normal}, |
|
{QLatin1String("Palette.BrightText"), QPalette::BrightText, QPalette::Normal}, |
|
{QLatin1String("Palette.Highlight"), QPalette::Highlight, QPalette::Normal}, |
|
{QLatin1String("Palette.HighlightedText"), QPalette::HighlightedText, QPalette::Normal}, |
|
{QLatin1String("Palette.Button"), QPalette::Button, QPalette::Normal}, |
|
{QLatin1String("Palette.ButtonText"), QPalette::ButtonText, QPalette::Normal}, |
|
{QLatin1String("Palette.Link"), QPalette::Link, QPalette::Normal}, |
|
{QLatin1String("Palette.LinkVisited"), QPalette::LinkVisited, QPalette::Normal}, |
|
{QLatin1String("Palette.Light"), QPalette::Light, QPalette::Normal}, |
|
{QLatin1String("Palette.Midlight"), QPalette::Midlight, QPalette::Normal}, |
|
{QLatin1String("Palette.Mid"), QPalette::Mid, QPalette::Normal}, |
|
{QLatin1String("Palette.Dark"), QPalette::Dark, QPalette::Normal}, |
|
{QLatin1String("Palette.Shadow"), QPalette::Shadow, QPalette::Normal}, |
|
{QLatin1String("Palette.WindowTextDisabled"), QPalette::WindowText, QPalette::Disabled}, |
|
{QLatin1String("Palette.TextDisabled"), QPalette::Text, QPalette::Disabled}, |
|
{QLatin1String("Palette.ToolTipTextDisabled"), QPalette::ToolTipText, QPalette::Disabled}, |
|
{QLatin1String("Palette.BrightTextDisabled"), QPalette::BrightText, QPalette::Disabled}, |
|
{QLatin1String("Palette.HighlightedTextDisabled"), QPalette::HighlightedText, QPalette::Disabled}, |
|
{QLatin1String("Palette.ButtonTextDisabled"), QPalette::ButtonText, QPalette::Disabled} |
|
}; |
|
|
|
QPalette palette = qApp->palette(); |
|
for (const ColorDescriptor &colorDescriptor : paletteColorDescriptors) |
|
{ |
|
const QColor defaultColor = palette.color(colorDescriptor.colorGroup, colorDescriptor.colorRole); |
|
const QColor newColor = getColor(colorDescriptor.id, defaultColor); |
|
palette.setColor(colorDescriptor.colorGroup, colorDescriptor.colorRole, newColor); |
|
} |
|
qApp->setPalette(palette); |
|
}
|
|
|