Add support to save and update recovery config

Author: anjaldoshi

Source/CoreServices.cpp

@@ -241,6 +241,20 @@ namespace CoreServices
 		return std::move(dir);
 	}
 
+	File getSavedStateDirectory() {
+#if defined(__APPLE__)
+    	File dir = File::getSpecialLocation(File::userApplicationDataDirectory).getChildFile("Application Support/open-ephys");
+#elif _WIN32
+    	File dir = File::getSpecialLocation(File::commonApplicationDataDirectory).getChildFile("Open Ephys");
+#else
+		File dir = File::getSpecialLocation(File::userApplicationDataDirectory).getChildFile(".open-ephys");;
+#endif
+		if (!dir.isDirectory()) {
+			dir.createDirectory();
+		}
+    	return std::move(dir);
+	}
+
 	String getGUIVersion()
 	{
 #define XSTR_DEF(s) #s

Source/CoreServices.h

@@ -129,6 +129,9 @@ PLUGIN_API const char* getApplicationResource(const char* name, int& size);
 /** Gets the default directory for user-initiated file saving/loading */
 PLUGIN_API File getDefaultUserSaveDirectory();
 
+/** Gets the save directory for GUI-related file saving/loading */
+PLUGIN_API File getSavedStateDirectory();
+
 /** Gets the GUI version */
 PLUGIN_API String getGUIVersion();
 

Source/MainWindow.cpp

@@ -27,19 +27,6 @@
 #include <stdio.h>
 //-----------------------------------------------------------------------
 
-static inline File getSavedStateDirectory() {
-#if defined(__APPLE__)
-    File dir = File::getSpecialLocation(File::userApplicationDataDirectory).getChildFile("Application Support/open-ephys");
-#elif _WIN32
-    File dir = File::getSpecialLocation(File::commonApplicationDataDirectory).getChildFile("Open Ephys");
-#else
-	File dir = File::getSpecialLocation(File::userApplicationDataDirectory).getChildFile(".open-ephys");;
-#endif
-	if (!dir.isDirectory()) {
-        dir.createDirectory();
-    }
-    return std::move(dir);
-}
 
 	MainWindow::MainWindow(const File& fileToLoad)
 : DocumentWindow(JUCEApplication::getInstance()->getApplicationName(),
@@ -91,11 +78,31 @@ static inline File getSavedStateDirectory() {
     }
 	else if (shouldReloadOnStartup)
 	{
-		File file = getSavedStateDirectory().getChildFile("lastConfig.xml");
-		ui->getEditorViewport()->loadState(file);
-	}
-
+		File lastConfig = CoreServices::getSavedStateDirectory().getChildFile("lastConfig.xml");
+		File recoveryConfig = CoreServices::getSavedStateDirectory().getChildFile("recoveryConfig.xml");
 
+		if(lastConfig.existsAsFile())
+		{
+			if(compareConfigFiles(lastConfig, recoveryConfig))
+			{
+				std::cout << "Loading last config.\n" << std::endl;
+				ui->getEditorViewport()->loadState(lastConfig);
+			}
+			else
+			{
+				bool loadRecovery = AlertWindow::showOkCancelBox(AlertWindow::WarningIcon, "Reloading Settings",
+																"It looks like the GUI crashed during your last run, " 
+																"causing the configured settings to not save properly. "
+																"Do you want to load the recovery config instead?",
+																"Yes", "No");
+				
+				if(loadRecovery)
+					ui->getEditorViewport()->loadState(recoveryConfig);
+				else
+					ui->getEditorViewport()->loadState(lastConfig);
+			}
+		}
+	}
 
 }
 
@@ -114,8 +121,10 @@ MainWindow::~MainWindow()
 	UIComponent* ui = (UIComponent*) getContentComponent();
 	ui->disableDataViewport();
 
-	File file = getSavedStateDirectory().getChildFile("lastConfig.xml");
-	ui->getEditorViewport()->saveState(file);
+	File lastConfig = CoreServices::getSavedStateDirectory().getChildFile("lastConfig.xml");
+	File recoveryConfig = CoreServices::getSavedStateDirectory().getChildFile("recoveryConfig.xml");
+	ui->getEditorViewport()->saveState(lastConfig);
+	ui->getEditorViewport()->saveState(recoveryConfig);
 
 	setMenuBar(0);
 
@@ -148,7 +157,7 @@ void MainWindow::saveWindowBounds()
 	std::cout << "Saving window bounds." << std::endl;
 	std::cout << std::endl;
 
-	File file = getSavedStateDirectory().getChildFile("windowState.xml");
+	File file = CoreServices::getSavedStateDirectory().getChildFile("windowState.xml");
 
 	XmlElement* xml = new XmlElement("MAINWINDOW");
 
@@ -194,7 +203,7 @@ void MainWindow::loadWindowBounds()
 	std::cout << "Loading window bounds." << std::endl;
 	std::cout << std::endl;
 
-	File file = getSavedStateDirectory().getChildFile("windowState.xml");
+	File file = CoreServices::getSavedStateDirectory().getChildFile("windowState.xml");
 
 	XmlDocument doc(file);
 	XmlElement* xml = doc.getDocumentElement();
@@ -261,3 +270,43 @@ void MainWindow::loadWindowBounds()
 	}
 	// return "Everything went ok.";
 }
+
+
+bool MainWindow::compareConfigFiles(File file1, File file2)
+{
+	XmlDocument lcDoc(file1);
+	XmlDocument rcDoc(file2);
+	
+	std::unique_ptr<XmlElement> lcXml (lcDoc.getDocumentElement());
+	std::unique_ptr<XmlElement> rcXml (rcDoc.getDocumentElement());
+
+	if(rcXml == 0 || ! rcXml->hasTagName("SETTINGS"))
+	{
+		std::cout << "Recovery config is inavlid. Loading lastConfig.xml" << std::endl;
+	}
+
+	auto lcSig = lcXml->getChildByName("SIGNALCHAIN");
+	auto rcSig = rcXml->getChildByName("SIGNALCHAIN");
+
+	if(lcSig == nullptr)
+	{
+		if(rcSig != nullptr)
+			return false;
+	}
+	else
+	{
+		if(rcSig != nullptr)
+		{
+			if(!lcSig->isEquivalentTo(rcSig, false))
+				return false;
+		}
+	}
+
+	auto lcAudio = lcXml->getChildByName("Audio");
+	auto rcAudio = rcXml->getChildByName("Audio");
+
+	if(!lcAudio->isEquivalentTo(rcAudio, false))
+		return false;
+
+	return true;
+}

Source/MainWindow.h

@@ -74,6 +74,10 @@ class MainWindow   : public DocumentWindow
         from which the GUI is run. */
     void loadWindowBounds();
 
+    /** Checks whether the signal chains of both the config files (lastConfig.xml & recoveryConfig.xml) 
+     *  match or not. */
+    bool compareConfigFiles(File file1, File file2);
+
     /** A pointer to the application's AudioComponent (owned by the MainWindow). */
     ScopedPointer<AudioComponent> audioComponent;
 

Source/Processors/AudioNode/AudioEditor.cpp

@@ -24,6 +24,7 @@
 #include "AudioEditor.h"
 #include "../../Audio/AudioComponent.h"
 #include "../../AccessClass.h"
+#include "../../UI/EditorViewport.h"
 #include "../../UI/LookAndFeel/MaterialSliderLookAndFeel.h"
 
 
@@ -325,6 +326,9 @@ AudioConfigurationWindow::~AudioConfigurationWindow()
 
 void AudioConfigurationWindow::closeButtonPressed()
 {
+    File recoveryFile = CoreServices::getSavedStateDirectory().getChildFile("recoveryConfig.xml");
+    AccessClass::getEditorViewport()->saveState(recoveryFile);
+
     controlButton->setToggleState (false, dontSendNotification);
     setVisible (false);
 }

Source/Processors/Editors/GenericEditor.cpp

@@ -552,11 +552,12 @@ void GenericEditor::update()
             drawerButton->setVisible(true);
     }
 
-
-
     updateVisualizer(); // does nothing unless this method
     // has been implemented
 
+    File recoveryFile = CoreServices::getSavedStateDirectory().getChildFile("recoveryConfig.xml");
+    AccessClass::getEditorViewport()->saveState(recoveryFile);
+
 }
 
 const DataChannel* GenericEditor::getChannel(int chan) const

Source/UI/SignalChainManager.cpp

@@ -25,6 +25,8 @@
 
 #include "EditorViewport.h"
 
+#include "../AccessClass.h"
+
 #include <iostream>
 
 SignalChainManager::SignalChainManager
@@ -557,4 +559,7 @@ void SignalChainManager::updateProcessorSettings()
 			}
 		}
 	}
+
+    File recoveryFile = CoreServices::getSavedStateDirectory().getChildFile("recoveryConfig.xml");
+    AccessClass::getEditorViewport()->saveState(recoveryFile);
 }