Add support for enabling/disabling automatic update check

Author: anjaldoshi

Source/AutoUpdater.cpp

@@ -24,6 +24,7 @@
 
 #include "AutoUpdater.h"
 #include "CoreServices.h"
+#include "MainWindow.h"
 #ifdef _WIN32
 #include <windows.h>
 #include <shellapi.h>
@@ -32,6 +33,7 @@
 //==============================================================================
 LatestVersionCheckerAndUpdater::LatestVersionCheckerAndUpdater()
     : Thread ("VersionChecker")
+    , mainWindow(nullptr)
 {
 }
 
@@ -41,11 +43,12 @@ LatestVersionCheckerAndUpdater::~LatestVersionCheckerAndUpdater()
     clearSingletonInstance();
 }
 
-void LatestVersionCheckerAndUpdater::checkForNewVersion (bool background)
+void LatestVersionCheckerAndUpdater::checkForNewVersion (bool background, MainWindow* mw)
 {
     if (! isThreadRunning())
     {
         backgroundCheck = background;
+        mainWindow = mw;
         startThread (3);
     }
 }
@@ -179,7 +182,7 @@ void LatestVersionCheckerAndUpdater::run()
 class UpdateDialog  : public Component
 {
 public:
-    UpdateDialog (const String& newVersion, const String& releaseNotes)
+    UpdateDialog (const String& newVersion, const String& releaseNotes, bool automaticVerCheck)
     {
         titleLabel.setText ("Open Ephys GUI version " + newVersion, dontSendNotification);
         titleLabel.setFont (Font("Fira Sans", "SemiBold", 18.0f));
@@ -203,11 +206,13 @@ class UpdateDialog  : public Component
         addAndMakeVisible (cancelButton);
         cancelButton.onClick = [this]
         {
-            // ProjucerApplication::getApp().setAutomaticVersionCheckingEnabled (! dontAskAgainButton.getToggleState());
-            exitModalStateWithResult (-1);
+            if(dontAskAgainButton.getToggleState())
+                exitModalStateWithResult (-1);
+            else
+                exitModalStateWithResult(0);
         };
 
-        dontAskAgainButton.setToggleState (false, dontSendNotification);
+        dontAskAgainButton.setToggleState (!automaticVerCheck, dontSendNotification);
         addAndMakeVisible (dontAskAgainButton);
 
 #if JUCE_MAC
@@ -251,14 +256,15 @@ class UpdateDialog  : public Component
     }
 
     static std::unique_ptr<DialogWindow> launchDialog (const String& newVersionString,
-                                                       const String& releaseNotes)
+                                                       const String& releaseNotes,
+                                                       bool automaticVerCheck)
     {
         DialogWindow::LaunchOptions options;
 
         options.dialogTitle = "Download Open Ephys GUI version " + newVersionString + "?";
         options.resizable = false;
 
-        auto* content = new UpdateDialog (newVersionString, releaseNotes);
+        auto* content = new UpdateDialog (newVersionString, releaseNotes, automaticVerCheck);
         options.content.set (content, true);
 
         std::unique_ptr<DialogWindow> dialog (options.create());
@@ -319,7 +325,9 @@ void LatestVersionCheckerAndUpdater::askUserAboutNewVersion (const String& newVe
                                                              const String& releaseNotes,
                                                              const Asset& asset)
 {
-    dialogWindow = UpdateDialog::launchDialog (newVersionString, releaseNotes);
+    dialogWindow = UpdateDialog::launchDialog (newVersionString,
+                                               releaseNotes,
+                                               mainWindow->automaticVersionChecking);
 
     if (auto* mm = ModalComponentManager::getInstance())
     {
@@ -328,6 +336,10 @@ void LatestVersionCheckerAndUpdater::askUserAboutNewVersion (const String& newVe
                                                            {
                                                                if (result == 1)
                                                                     askUserForLocationToDownload (asset);
+                                                                else if(result == -1)
+                                                                    mainWindow->automaticVersionChecking = false;
+                                                                else if(result == 0)
+                                                                    mainWindow->automaticVersionChecking = true;
 
                                                                 dialogWindow.reset();
                                                             }));

Source/AutoUpdater.h

@@ -26,6 +26,7 @@
 
 #include "../JuceLibraryCode/JuceHeader.h"
 
+class MainWindow;
 class DownloadThread;
 
 class LatestVersionCheckerAndUpdater   : public DeletedAtShutdown,
@@ -42,7 +43,7 @@ class LatestVersionCheckerAndUpdater   : public DeletedAtShutdown,
         const int size;
     };
 
-    void checkForNewVersion (bool isBackgroundCheck);
+    void checkForNewVersion (bool isBackgroundCheck, MainWindow* mw);
 
     //==============================================================================
     JUCE_DECLARE_SINGLETON_SINGLETHREADED_MINIMAL (LatestVersionCheckerAndUpdater)
@@ -56,6 +57,7 @@ class LatestVersionCheckerAndUpdater   : public DeletedAtShutdown,
 
     //==============================================================================
     bool backgroundCheck = false;
+    MainWindow* mainWindow;
 
     std::unique_ptr<DownloadThread> downloader;
     std::unique_ptr<Component> dialogWindow;

Source/MainWindow.cpp

@@ -25,6 +25,7 @@
 #include "Utils/OpenEphysHttpServer.h"
 #include "UI/UIComponent.h"
 #include "UI/EditorViewport.h"
+#include "AutoUpdater.h"
 #include <stdio.h>
 
 
@@ -59,6 +60,7 @@ MainWindow::MainWindow(const File& fileToLoad)
 	shouldReloadOnStartup = true;
 	shouldEnableHttpServer = true;
 	openDefaultConfigWindow = false;
+	automaticVersionChecking = true;
 
 	// Create ProcessorGraph and AudioComponent, and connect them.
 	// Callbacks will be set by the play button in the control panel
@@ -160,6 +162,9 @@ MainWindow::MainWindow(const File& fileToLoad)
 		disableHttpServer();
 	}
 
+	if(automaticVersionChecking)
+		LatestVersionCheckerAndUpdater::getInstance()->checkForNewVersion (true, this);
+
 }
 
 MainWindow::~MainWindow()
@@ -267,6 +272,7 @@ void MainWindow::saveWindowBounds()
 	xml->setAttribute("version", JUCEApplication::getInstance()->getApplicationVersion());
 	xml->setAttribute("shouldReloadOnStartup", shouldReloadOnStartup);
 	xml->setAttribute("shouldEnableHttpServer", shouldEnableHttpServer);
+	xml->setAttribute("automaticVersionChecking", automaticVersionChecking);
 
 	XmlElement* bounds = new XmlElement("BOUNDS");
 	bounds->setAttribute("x",getScreenX());
@@ -330,6 +336,7 @@ void MainWindow::loadWindowBounds()
 
 		shouldReloadOnStartup = xml->getBoolAttribute("shouldReloadOnStartup", false);
 		shouldEnableHttpServer = xml->getBoolAttribute("shouldEnableHttpServer", false);
+		automaticVersionChecking = xml->getBoolAttribute("automaticVersionChecking", true);
 
 		for (auto* e : xml->getChildIterator())
 		{

Source/MainWindow.h

@@ -68,8 +68,12 @@ class MainWindow   : public DocumentWindow
     /** Determines whether the ProcessorGraph http server is enabled. */
     bool shouldEnableHttpServer;
 
+    /** Determines whether the default config selection window needs to open on startup. */
     bool openDefaultConfigWindow;
 
+    /** Determines whether the Auto Updater needs to run on startup. */
+    bool automaticVersionChecking;
+
     /** Ends the process() callbacks and disables all processors.*/
 	void shutDownGUI();
 

Source/UI/UIComponent.cpp

@@ -863,7 +863,7 @@ bool UIComponent::perform(const InvocationInfo& info)
 
 		case checkForUpdates:
 			{
-				LatestVersionCheckerAndUpdater::getInstance()->checkForNewVersion (false);
+				LatestVersionCheckerAndUpdater::getInstance()->checkForNewVersion (false, mainWindow);
 				break;
 			}