From 43716793b40c1a665d99d412a271a625b82d4980 Mon Sep 17 00:00:00 2001
From: sawinglogz <3787776-sawinglogz@users.noreply.gitlab.com>
Date: Sat, 4 Jan 2020 22:06:28 -0500
Subject: [PATCH] Add user alert when unexpected PRS1 data is encountered on
 import.

Also rename some variables for clarity.
---
 oscar/SleepLib/loader_plugins/prs1_loader.cpp | 30 ++++++++++++-------
 oscar/SleepLib/machine.cpp                    |  5 +++-
 oscar/SleepLib/machine.h                      |  8 +++--
 3 files changed, 28 insertions(+), 15 deletions(-)

diff --git a/oscar/SleepLib/loader_plugins/prs1_loader.cpp b/oscar/SleepLib/loader_plugins/prs1_loader.cpp
index d870e811..db283eef 100644
--- a/oscar/SleepLib/loader_plugins/prs1_loader.cpp
+++ b/oscar/SleepLib/loader_plugins/prs1_loader.cpp
@@ -720,15 +720,21 @@ int PRS1Loader::OpenMachine(const QString & path)
 
     finishAddingSessions();
 
-    // TODO: pop up a warning if m_unexpectedMessages isn't empty, based on
-    // p_profile->session->warnOnUnexpectedData pref.
-    //
-    // TODO: compare this to the list of messages previously seen for this machine
-    // and only alert if there are new ones.
-    //
-    // TODO: persist the list of previously seen messages along with the current
-    // OSCAR version number in the machine XML record. Reset the list when the
-    // OSCAR version changes.
+    if (m_unexpectedMessages.count() > 0 && p_profile->session->warnOnUnexpectedData()) {
+        // Compare this to the list of messages previously seen for this machine
+        // and only alert if there are new ones.
+        QSet<QString> newMessages = m_unexpectedMessages - m->previouslySeenUnexpectedData();
+        if (newMessages.count() > 0) {
+            // TODO: Rework the importer call structure so that this can become an
+            // emit statement to the appropriate import job.
+            QMessageBox::information(QApplication::activeWindow(),
+                                     QObject::tr("Untested Data"),
+                                     QObject::tr("Your Philips Respironics %1 (%2) generated data that OSCAR has never seen before.").arg(m->getInfo().model).arg(m->getInfo().modelnumber) +"\n\n"+
+                                     QObject::tr("The imported data may not be entirely accurate, so the developers would like a .zip copy of this machine's SD card and matching Encore .pdf reports to make sure OSCAR is handling the data correctly.")
+                                     ,QMessageBox::Ok);
+            m->previouslySeenUnexpectedData() += newMessages;
+        }
+    }
     
     return m->unsupported() ? -1 : tasks;
 }
@@ -813,9 +819,11 @@ Machine* PRS1Loader::CreateMachineFromProperties(QString propertyfile)
     
     if (!s_PRS1ModelInfo.IsTested(props)) {
         qDebug() << info.modelnumber << "untested";
-        if (p_profile->session->warnOnUntestedMachine() && !m->untested()) {
-            m->setUntested(true);  // don't warn the user more than once
+        if (p_profile->session->warnOnUntestedMachine() && m->warnOnUntested()) {
+            m->suppressWarnOnUntested();  // don't warn the user more than once
 #ifndef UNITTEST_MODE
+            // TODO: Rework the importer call structure so that this can become an
+            // emit statement to the appropriate import job.
             QMessageBox::information(QApplication::activeWindow(),
                                  QObject::tr("Machine Untested"),
                                  QObject::tr("Your Philips Respironics CPAP machine (Model %1) has not been tested yet.").arg(info.modelnumber) +"\n\n"+
diff --git a/oscar/SleepLib/machine.cpp b/oscar/SleepLib/machine.cpp
index 7ecf542f..6320f097 100644
--- a/oscar/SleepLib/machine.cpp
+++ b/oscar/SleepLib/machine.cpp
@@ -88,7 +88,10 @@ Machine::Machine(Profile *_profile, MachineID id) : profile(_profile)
     day.clear();
     highest_sessionid = 0;
     m_unsupported = false;
-    m_untested = false;
+    m_suppressUntestedWarning = false;
+    // TODO: Have the machine write m_suppressUntestedWarning and m_previousUnexpected
+    // to XML (along with the current OSCAR version number) so that they persist across
+    // application launches (but reset with each new OSCAR version).
 
     if (!id) {
         srand(time(nullptr));
diff --git a/oscar/SleepLib/machine.h b/oscar/SleepLib/machine.h
index f6610b19..fb1cdda3 100644
--- a/oscar/SleepLib/machine.h
+++ b/oscar/SleepLib/machine.h
@@ -179,8 +179,9 @@ class Machine
 
     bool unsupported() { return m_unsupported; }
     void setUnsupported(bool b) { m_unsupported = b; }
-    bool untested() { return m_untested; }
-    void setUntested(bool b) { m_untested = b; }
+    bool warnOnUntested() { return m_suppressUntestedWarning == false; }
+    void suppressWarnOnUntested() { m_suppressUntestedWarning = true; }
+    QSet<QString> & previouslySeenUnexpectedData() { return m_previousUnexpected; }
 
     inline MachineType type() const { return info.type; }
     inline QString brand() const { return info.brand; }
@@ -249,7 +250,8 @@ class Machine
     MachineInfo info;
 
     bool m_unsupported;
-    bool m_untested;
+    bool m_suppressUntestedWarning;
+    QSet<QString> m_previousUnexpected;
 
     //! \brief Contains a secondary index of day data, containing just this machines sessions
     QMap<QDate, Day *> day;