src/gui/desktopintegration.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2022  Vladimir Golovnev <glassez@yandex.ru>
   4  * Copyright (C) 2006  Christophe Dumez <chris@qbittorrent.org>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #include "desktopintegration.h"
  31
  32 #include <chrono>
  33
  34 #include <QtGlobal>
  35 #include <QMenu>
  36 #include <QTimer>
  37
  38 #ifndef Q_OS_MACOS
  39 #include <QSystemTrayIcon>
  40 #endif
  41
  42 #include "base/preferences.h"
  43 #include "uithememanager.h"
  44
  45 #ifdef Q_OS_MACOS
  46 #include "macutilities.h"
  47 #endif
  48
  49 #ifdef QBT_USES_DBUS
  50 #include "notifications/dbusnotifier.h"
  51 #endif
  52
  53 namespace
  54 {
  55 #ifdef Q_OS_MACOS
  56     DesktopIntegration *desktopIntegrationInstance = nullptr;
  57
  58     bool handleDockClicked(id self, SEL cmd, ...)
  59     {
  60         Q_UNUSED(self);
  61         Q_UNUSED(cmd);
  62
  63         Q_ASSERT(desktopIntegrationInstance);
  64         emit desktopIntegrationInstance->activationRequested();
  65
  66         return true;
  67     }
  68 #endif
  69 }
  70
  71 using namespace std::chrono_literals;
  72
  73 #define SETTINGS_KEY(name) u"GUI/" name
  74 #define NOTIFICATIONS_SETTINGS_KEY(name) (SETTINGS_KEY(u"Notifications/"_s) name)
  75
  76 DesktopIntegration::DesktopIntegration(QObject *parent)
  77     : QObject(parent)
  78     , m_storeNotificationEnabled {NOTIFICATIONS_SETTINGS_KEY(u"Enabled"_s), true}
  79 #ifdef QBT_USES_DBUS
  80     , m_storeNotificationTimeOut {NOTIFICATIONS_SETTINGS_KEY(u"Timeout"_s), -1}
  81 #endif
  82 {
  83 #ifdef Q_OS_MACOS
  84     desktopIntegrationInstance = this;
  85     MacUtils::overrideDockClickHandler(handleDockClicked);
  86 #else
  87     if (Preferences::instance()->systemTrayEnabled())
  88         createTrayIcon();
  89
  90 #ifdef QBT_USES_DBUS
  91     if (isNotificationsEnabled())
  92     {
  93         m_notifier = new DBusNotifier(this);
  94         connect(m_notifier, &DBusNotifier::messageClicked, this, &DesktopIntegration::notificationClicked);
  95     }
  96 #endif
  97 #endif
  98
  99     connect(Preferences::instance(), &Preferences::changed, this, &DesktopIntegration::onPreferencesChanged);
 100 }
 101
 102 DesktopIntegration::~DesktopIntegration()
 103 {
 104     delete m_menu;
 105 }
 106
 107 bool DesktopIntegration::isActive() const
 108 {
 109 #ifdef Q_OS_MACOS
 110     return true;
 111 #else
 112     return m_systrayIcon && QSystemTrayIcon::isSystemTrayAvailable();
 113 #endif
 114 }
 115
 116 QString DesktopIntegration::toolTip() const
 117 {
 118     return m_toolTip;
 119 }
 120
 121 void DesktopIntegration::setToolTip(const QString &toolTip)
 122 {
 123     if (m_toolTip == toolTip)
 124         return;
 125
 126     m_toolTip = toolTip;
 127 #ifndef Q_OS_MACOS
 128     if (m_systrayIcon)
 129         m_systrayIcon->setToolTip(m_toolTip);
 130 #endif
 131 }
 132
 133 QMenu *DesktopIntegration::menu() const
 134 {
 135     return m_menu;
 136 }
 137
 138 void DesktopIntegration::setMenu(QMenu *menu)
 139 {
 140     if (menu == m_menu)
 141         return;
 142
 143 #if defined Q_OS_MACOS
 144     if (m_menu)
 145         delete m_menu;
 146
 147     m_menu = menu;
 148
 149     if (m_menu)
 150         m_menu->setAsDockMenu();
 151 #elif defined Q_OS_UNIX
 152     const bool systemTrayEnabled = m_systrayIcon;
 153     if (m_menu)
 154     {
 155         if (m_systrayIcon)
 156         {
 157             delete m_systrayIcon;
 158             m_systrayIcon = nullptr;
 159         }
 160         delete m_menu;
 161     }
 162
 163     m_menu = menu;
 164
 165     if (systemTrayEnabled && !m_systrayIcon)
 166         createTrayIcon();
 167 #else
 168     if (m_menu)
 169         delete m_menu;
 170
 171     m_menu = menu;
 172
 173     if (m_systrayIcon)
 174         m_systrayIcon->setContextMenu(m_menu);
 175 #endif
 176 }
 177
 178 bool DesktopIntegration::isNotificationsEnabled() const
 179 {
 180     return m_storeNotificationEnabled;
 181 }
 182
 183 void DesktopIntegration::setNotificationsEnabled(const bool value)
 184 {
 185     if (m_storeNotificationEnabled == value)
 186         return;
 187
 188     m_storeNotificationEnabled = value;
 189
 190 #ifdef QBT_USES_DBUS
 191     if (value)
 192     {
 193         m_notifier = new DBusNotifier(this);
 194         connect(m_notifier, &DBusNotifier::messageClicked, this, &DesktopIntegration::notificationClicked);
 195     }
 196     else
 197     {
 198         delete m_notifier;
 199         m_notifier = nullptr;
 200     }
 201 #endif
 202 }
 203
 204 int DesktopIntegration::notificationTimeout() const
 205 {
 206 #ifdef QBT_USES_DBUS
 207     return m_storeNotificationTimeOut;
 208 #else
 209     return 5000;
 210 #endif
 211 }
 212
 213 #ifdef QBT_USES_DBUS
 214 void DesktopIntegration::setNotificationTimeout(const int value)
 215 {
 216     m_storeNotificationTimeOut = value;
 217 }
 218 #endif
 219
 220 void DesktopIntegration::showNotification(const QString &title, const QString &msg) const
 221 {
 222     if (!isNotificationsEnabled())
 223         return;
 224
 225 #ifdef Q_OS_MACOS
 226     MacUtils::displayNotification(title, msg);
 227 #else
 228 #ifdef QBT_USES_DBUS
 229     m_notifier->showMessage(title, msg, notificationTimeout());
 230 #else
 231     if (m_systrayIcon && QSystemTrayIcon::supportsMessages())
 232         m_systrayIcon->showMessage(title, msg, QSystemTrayIcon::Information, notificationTimeout());
 233 #endif
 234 #endif
 235 }
 236
 237 void DesktopIntegration::onPreferencesChanged()
 238 {
 239 #ifndef Q_OS_MACOS
 240     if (Preferences::instance()->systemTrayEnabled())
 241     {
 242         if (m_systrayIcon)
 243         {
 244             // Reload systray icon
 245             m_systrayIcon->setIcon(getSystrayIcon());
 246         }
 247         else
 248         {
 249             createTrayIcon();
 250         }
 251     }
 252     else
 253     {
 254         delete m_systrayIcon;
 255         m_systrayIcon = nullptr;
 256         emit stateChanged();
 257     }
 258 #endif
 259 }
 260
 261 #ifndef Q_OS_MACOS
 262 void DesktopIntegration::createTrayIcon()
 263 {
 264     Q_ASSERT(!m_systrayIcon);
 265
 266     m_systrayIcon = new QSystemTrayIcon(getSystrayIcon(), this);
 267
 268     m_systrayIcon->setToolTip(m_toolTip);
 269
 270     if (m_menu)
 271         m_systrayIcon->setContextMenu(m_menu);
 272
 273     connect(m_systrayIcon, &QSystemTrayIcon::activated, this
 274             , [this](const QSystemTrayIcon::ActivationReason reason)
 275     {
 276         if (reason == QSystemTrayIcon::Trigger)
 277             emit activationRequested();
 278     });
 279 #ifndef QBT_USES_DBUS
 280     connect(m_systrayIcon, &QSystemTrayIcon::messageClicked, this, &DesktopIntegration::notificationClicked);
 281 #endif
 282
 283     m_systrayIcon->show();
 284     emit stateChanged();
 285 }
 286
 287 QIcon DesktopIntegration::getSystrayIcon() const
 288 {
 289     const TrayIcon::Style style = Preferences::instance()->trayIconStyle();
 290     QIcon icon;
 291     switch (style)
 292     {
 293     default:
 294     case TrayIcon::Style::Normal:
 295         icon = UIThemeManager::instance()->getIcon(u"qbittorrent-tray"_s);
 296         break;
 297     case TrayIcon::Style::MonoDark:
 298         icon = UIThemeManager::instance()->getIcon(u"qbittorrent-tray-dark"_s);
 299         break;
 300     case TrayIcon::Style::MonoLight:
 301         icon = UIThemeManager::instance()->getIcon(u"qbittorrent-tray-light"_s);
 302         break;
 303     }
 304 #ifdef Q_OS_UNIX
 305     // Workaround for invisible tray icon in KDE, https://bugreports.qt.io/browse/QTBUG-53550
 306     if (qEnvironmentVariable("XDG_CURRENT_DESKTOP").compare(u"KDE", Qt::CaseInsensitive) == 0)
 307         return icon.pixmap(32);
 308 #endif
 309     return icon;
 310 }
 311 #endif // Q_OS_MACOS