Add setting to show notifications when downloads complete or fail

Author: JonathanFeenstra

src/downloadmanager.cpp

@@ -42,6 +42,7 @@ along with Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
 #include <QHttp2Configuration>
 #include <QInputDialog>
 #include <QMessageBox>
+#include <QSystemTrayIcon>
 #include <QTextDocument>
 #include <QTimer>
 
@@ -1365,7 +1366,11 @@ QString DownloadManager::getDisplayName(int index) const
   }
 
   DownloadInfo* info = m_ActiveDownloads.at(index);
+  return displayNameByInfo(info);
+}
 
+QString DownloadManager::displayNameByInfo(const DownloadInfo* info) const
+{
   QTextDocument doc;
   if (!info->m_FileInfo->name.isEmpty()) {
     doc.setHtml(info->m_FileInfo->name);
@@ -1789,6 +1794,11 @@ void DownloadManager::nxmDescriptionAvailable(QString, int, QVariant userData,
   info->m_FileInfo->modName = doc.toPlainText();
   if (info->m_FileInfo->fileID != 0) {
     setState(info, STATE_READY);
+    if (m_OrganizerCore->settings().interface().showDownloadNotifications()) {
+      m_OrganizerCore->showNotification(
+          tr("Download complete"),
+          tr("%1 is ready to be installed.").arg(displayNameByInfo(info)));
+    }
   } else {
     setState(info, STATE_FETCHINGFILEINFO);
   }
@@ -2278,6 +2288,12 @@ void DownloadManager::downloadFinished(int index)
           emit showMessage(tr("Download failed: %1 (%2)")
                                .arg(reply->errorString())
                                .arg(reply->error()));
+          if (m_OrganizerCore->settings().interface().showDownloadNotifications()) {
+            m_OrganizerCore->showNotification(
+                tr("Download failed"),
+                tr("%1 failed to download.").arg(displayNameByInfo(info)),
+                QSystemTrayIcon::MessageIcon::Critical);
+          }
         }
         error = true;
         setState(info, STATE_ERROR);

src/downloadmanager.h

@@ -588,6 +588,8 @@ private slots:
 
   DownloadInfo* downloadInfoByID(unsigned int id);
 
+  QString displayNameByInfo(const DownloadInfo* info) const;
+
   void removePending(QString gameName, int modID, int fileID);
 
   static QString getFileTypeString(int fileType);

src/iuserinterface.h

@@ -4,6 +4,7 @@
 #include "modinfodialogfwd.h"
 #include <QMainWindow>
 #include <QMenu>
+#include <QSystemTrayIcon>
 #include <delayedfilewriter.h>
 #include <ipluginmodpage.h>
 #include <iplugintool.h>
@@ -27,6 +28,10 @@ class IUserInterface
   virtual MOBase::DelayedFileWriterBase& archivesWriter() = 0;
 
   virtual QMainWindow* mainWindow() = 0;
+
+  virtual void showNotification(const QString& title, const QString& message,
+                                QSystemTrayIcon::MessageIcon icon =
+                                    QSystemTrayIcon::MessageIcon::Information) = 0;
 };
 
 #endif  // IUSERINTERFACE_H

src/mainwindow.cpp

@@ -139,6 +139,7 @@ along with Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
 #include <QShortcut>
 #include <QSize>
 #include <QSizePolicy>
+#include <QSystemTrayIcon>
 #include <QTime>
 #include <QTimer>
 #include <QToolButton>
@@ -2259,6 +2260,12 @@ QMainWindow* MainWindow::mainWindow()
   return this;
 }
 
+void MainWindow::showNotification(const QString& title, const QString& message,
+                                  QSystemTrayIcon::MessageIcon icon)
+{
+  m_SystemTrayManager->showNotification(title, message, icon);
+}
+
 void MainWindow::on_tabWidget_currentChanged(int index)
 {
   QWidget* currentWidget = ui->tabWidget->widget(index);

src/mainwindow.h

@@ -78,6 +78,7 @@ class DirectoryEntry;
 #include <QProcess>
 #include <QString>
 #include <QStringList>
+#include <QSystemTrayIcon>
 #include <QTime>
 #include <QTimer>
 #include <QVariant>
@@ -156,6 +157,10 @@ class MainWindow : public QMainWindow, public IUserInterface
     return m_ArchiveListWriter;
   }
 
+  void showNotification(const QString& title, const QString& message,
+                        QSystemTrayIcon::MessageIcon icon =
+                            QSystemTrayIcon::MessageIcon::Information) override;
+
 public slots:
   void refresherProgress(const DirectoryRefreshProgress* p);
 

src/organizercore.cpp

@@ -46,6 +46,7 @@
 #include <QMessageBox>
 #include <QNetworkInterface>
 #include <QProcess>
+#include <QSystemTrayIcon>
 #include <QTimer>
 #include <QUrl>
 #include <QWidget>
@@ -539,6 +540,14 @@ std::wstring OrganizerCore::getGlobalCoreDumpPath()
   return {};
 }
 
+void OrganizerCore::showNotification(const QString& message, const QString& title,
+                                     QSystemTrayIcon::MessageIcon icon)
+{
+  if (m_UserInterface) {
+    m_UserInterface->showNotification(message, title, icon);
+  }
+}
+
 void OrganizerCore::setCurrentProfile(const QString& profileName)
 {
   if ((m_CurrentProfile != nullptr) && (profileName == m_CurrentProfile->name())) {

src/organizercore.h

@@ -8,6 +8,7 @@
 #include <QSettings>
 #include <QString>
 #include <QStringList>
+#include <QSystemTrayIcon>
 #include <QThread>
 #include <QVariant>
 
@@ -360,6 +361,10 @@ class OrganizerCore : public QObject, public MOBase::IPluginDiagnose
   static void setGlobalCoreDumpType(env::CoreDumpTypes type);
   static std::wstring getGlobalCoreDumpPath();
 
+  void showNotification(
+      const QString& title, const QString& message,
+      QSystemTrayIcon::MessageIcon icon = QSystemTrayIcon::MessageIcon::Information);
+
 public:
   MOBase::IModRepositoryBridge* createNexusBridge() const;
   QString profileName() const;

src/settings.cpp

@@ -2263,6 +2263,16 @@ void InterfaceSettings::setHideDownloadsAfterInstallation(bool b)
   set(m_Settings, "Settings", "autohide_downloads", b);
 }
 
+bool InterfaceSettings::showDownloadNotifications() const
+{
+  return get<bool>(m_Settings, "Settings", "download_notifications", false);
+}
+
+void InterfaceSettings::setShowDownloadNotifications(bool b)
+{
+  set(m_Settings, "Settings", "download_notifications", b);
+}
+
 bool InterfaceSettings::hideAPICounter() const
 {
   return get<bool>(m_Settings, "Settings", "hide_api_counter", false);

src/settings.h

@@ -653,6 +653,11 @@ class InterfaceSettings
   bool hideDownloadsAfterInstallation() const;
   void setHideDownloadsAfterInstallation(bool b);
 
+  // whether to show notifications when downloads complete or fail
+  //
+  bool showDownloadNotifications() const;
+  void setShowDownloadNotifications(bool b);
+
   // whether the API counter should be hidden
   //
   bool hideAPICounter() const;

src/settingsdialog.ui

@@ -166,6 +166,19 @@
                 </property>
                </widget>
               </item>
+              <item>
+               <widget class="QCheckBox" name="showDownloadNotificationsBox">
+                <property name="toolTip">
+                 <string>Show notifications when downloads complete or fail.</string>
+                </property>
+                <property name="whatsThis">
+                 <string>Show notifications when downloads complete or fail.</string>
+                </property>
+                <property name="text">
+                 <string>Show notifications for completed or failed downloads</string>
+                </property>
+               </widget>
+              </item>
              </layout>
             </widget>
            </item>
@@ -178,10 +191,10 @@
               <item>
                <widget class="QCheckBox" name="checkForUpdates">
                 <property name="toolTip">
-                 <string>Check for Mod Organizer updates on Github on startup.</string>
+                 <string>Check for Mod Organizer updates on GitHub on startup.</string>
                 </property>
                 <property name="whatsThis">
-                 <string>Check for Mod Organizer updates on Github on startup.</string>
+                 <string>Check for Mod Organizer updates on GitHub on startup.</string>
                 </property>
                 <property name="text">
                  <string>Check for updates</string>