Show update progress in launcher window

Author: spmccormack

res/layout/window_launcher.ui

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>697</width>
-    <height>565</height>
+    <height>629</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -70,36 +70,43 @@
          <number>100</number>
         </property>
         <property name="bottomMargin">
-         <number>0</number>
+         <number>20</number>
         </property>
         <item>
-         <layout class="QHBoxLayout" name="horizontalLayout_10">
-          <property name="sizeConstraint">
-           <enum>QLayout::SetDefaultConstraint</enum>
-          </property>
+         <layout class="QVBoxLayout" name="verticalLayout_3">
+          <item>
+           <widget class="QProgressBar" name="progress_updating">
+            <property name="maximum">
+             <number>0</number>
+            </property>
+            <property name="value">
+             <number>0</number>
+            </property>
+           </widget>
+          </item>
           <item>
-           <widget class="QLabel" name="lbl_update">
-            <property name="font">
-             <font>
-              <weight>50</weight>
-              <italic>false</italic>
-              <bold>false</bold>
-              <underline>false</underline>
-              <strikeout>false</strikeout>
-             </font>
+           <widget class="QLabel" name="lbl_updating">
+            <property name="enabled">
+             <bool>true</bool>
             </property>
             <property name="text">
-             <string>Updates are available.</string>
+             <string>PyMODA is updating. It's safe to exit while the update is in progress.</string>
             </property>
             <property name="alignment">
-             <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
+             <set>Qt::AlignCenter</set>
             </property>
            </widget>
           </item>
           <item>
-           <widget class="QPushButton" name="btn_update">
+           <widget class="QLabel" name="lbl_update_complete">
+            <property name="styleSheet">
+             <string notr="true">color:blue;</string>
+            </property>
             <property name="text">
-             <string>Update now</string>
+             <string>Update complete! Restart PyMODA to finish the process.</string>
+            </property>
+            <property name="alignment">
+             <set>Qt::AlignCenter</set>
             </property>
            </widget>
           </item>

src/gui/windows/launcher/LauncherWindow.py

@@ -26,7 +26,7 @@
 from PyQt5 import uic
 from PyQt5.QtCore import Qt
 from PyQt5.QtGui import QPixmap, QKeySequence
-from PyQt5.QtWidgets import QMessageBox, QShortcut, QLabel
+from PyQt5.QtWidgets import QMessageBox, QShortcut, QLabel, QProgressBar
 from pymodalib.utils.matlab_runtime import RuntimeStatus
 
 import utils
@@ -40,7 +40,6 @@
 from updater.check import is_version_newer
 from utils import args
 from utils.os_utils import OS
-from utils.qutils import retain_size_when_hidden
 from utils.settings import Settings
 from utils.shortcuts import create_shortcut
 
@@ -68,6 +67,7 @@ def __init__(self, parent):
         self.update_thread.extracting_signal.connect(self.on_extract_finished)
         self.update_thread.copy_finished_signal.connect(self.on_copy_finished)
         self.update_thread.error_signal.connect(self.on_update_error)
+        self.update_thread.download_progress_signal.connect(self.on_download_progress)
 
         super(LauncherWindow, self).__init__(parent)
 
@@ -84,8 +84,8 @@ def __init__(self, parent):
         self.update_shortcut_force.activated.connect(self.force_show_update)
 
         self.updating = False
-        self.update_status = UpdateStatus.NOT_AVAILABLE
-        self.update_statusbar()
+        self.current_update_status = UpdateStatus.NOT_AVAILABLE
+        self.update_status_ui()
 
         self.pymoda_has_set_cache_var = False
         self.reload_settings()
@@ -119,17 +119,15 @@ def setup_ui(self) -> None:
         # TODO: check for Matlab runtime, but show less intrusive message.
         # self.check_matlab_runtime()
 
-        self.lbl_update.hide()
+        self.lbl_updating.setVisible(False)
+        self.progress_updating.setVisible(False)
+        self.lbl_update_complete.setVisible(False)
 
-        self.btn_update.hide()
-        self.btn_update.clicked.connect(self.on_update_clicked)
         self.btn_settings.clicked.connect(self.on_settings_clicked)
 
         self.lbl_update_status = QLabel("")
         self.statusBar().addPermanentWidget(self.lbl_update_status)
 
-        retain_size_when_hidden(self.btn_update)
-
         if args.create_shortcut():
             logging.info("Creating desktop shortcut silently.")
             self.create_shortcut(silent=True)
@@ -167,19 +165,43 @@ async def check_if_updated(self) -> None:
 
             msgbox.exec()
 
-    def update_statusbar(self) -> None:
-        status = self.update_status
+    def update_status_ui(self) -> None:
+        status = self.current_update_status
 
         if status is UpdateStatus.NOT_AVAILABLE:
             self.lbl_update_status.setText("No updates available.")
+            self.progress_updating.setVisible(False)
+            self.lbl_updating.setVisible(False)
+            self.lbl_update_complete.setVisible(False)
         elif status is UpdateStatus.DOWNLOADING:
             self.lbl_update_status.setText("Downloading update...")
+            self.lbl_updating.setVisible(True)
+            self.progress_updating.setVisible(True)
         elif status is UpdateStatus.FINISHED:
             self.lbl_update_status.setText(
                 "Update installed, will activate on next launch."
             )
+            self.lbl_updating.setVisible(False)
+            self.progress_updating.setVisible(False)
+            self.lbl_update_complete.setVisible(True)
         elif status is UpdateStatus.ERROR:
             self.lbl_update_status.setText("Error while updating; see log for details.")
+            self.lbl_updating.setVisible(False)
+            self.progress_updating.setVisible(False)
+
+    def on_download_progress(self, value: float) -> None:
+        """
+        Called to update the download progress bar.
+        """
+        progress: QProgressBar = self.progress_updating
+
+        progress.setVisible(True)
+        progress.setRange(0, 100)
+        progress.setValue(value)
+
+        if value > 100:
+            progress.setRange(0, 0)
+            progress.setValue(0)
 
     def check_matlab_runtime(self) -> None:
         """
@@ -370,28 +392,28 @@ def start_background_update(self) -> None:
             self.updating = True
             self.settings.set_update_in_progress(True)
 
-            self.update_statusbar()
+            self.update_status_ui()
         except:
             warnings.warn("Cannot start update thread more than once.", RuntimeWarning)
 
     def on_download_finished(self) -> None:
-        self.update_status = UpdateStatus.DOWNLOADING
-        self.update_statusbar()
+        self.current_update_status = UpdateStatus.DOWNLOADING
+        self.update_status_ui()
 
     def on_extract_finished(self) -> None:
-        self.update_statusbar()
+        self.update_status_ui()
 
     def on_copy_finished(self) -> None:
-        self.update_status = UpdateStatus.FINISHED
+        self.current_update_status = UpdateStatus.FINISHED
 
         self.settings.set_update_in_progress(False)
         self.updating = False
 
-        self.update_statusbar()
+        self.update_status_ui()
 
     def on_update_error(self) -> None:
         self.updating = False
         self.settings.set_update_in_progress(False)
 
-        self.update_status = UpdateStatus.ERROR
-        self.update_statusbar()
+        self.current_update_status = UpdateStatus.ERROR
+        self.update_status_ui()

src/updater/UpdateThread.py

@@ -54,7 +54,9 @@ def do_update(self) -> None:
         if not self.release_tag:
             return logging.error("No release tag.")
 
-        self.updater = Updater.get_instance(self.release_tag)
+        self.updater = Updater.get_instance(
+            self.release_tag, self.download_progress_signal
+        )
 
         if self.updater.is_version_present():
             return logging.warning(

src/updater/Updater.py

@@ -31,7 +31,8 @@
 
 
 class Updater(ABC):
-    def __init__(self, tag: str):
+    def __init__(self, tag: str, progress_signal):
+        self.progress_signal = progress_signal
         self.tag = tag
 
     @abstractmethod
@@ -91,7 +92,11 @@ def download_archive(self, release_tag: str) -> None:
 
         url = self._download_url()
         with urlopen(url) as response:
-            chunked_download(filename="pymoda-temp.zip", response=response)
+            chunked_download(
+                filename="pymoda-temp.zip",
+                response=response,
+                progress_signal=self.progress_signal,
+            )
 
     def extract_archive(self) -> None:
         try:
@@ -108,6 +113,10 @@ def move_files(self) -> None:
         launcher_dir = launcher.get_launcher_directory()
 
         os.rename(join("pymoda-temp", "PyMODA"), join("pymoda-temp", self.tag))
+
+        if self.tag in os.listdir(launcher_dir):
+            shutil.rmtree(join(launcher_dir, self.tag))
+
         shutil.move(join("pymoda-temp", self.tag), launcher_dir)
 
 
@@ -123,7 +132,11 @@ def download_launcher(self) -> None:
 
         if url:
             with urlopen(url) as response:
-                chunked_download(filename="launcher-temp", response=response)
+                chunked_download(
+                    filename="launcher-temp",
+                    response=response,
+                    progress_signal=self.progress_signal,
+                )
 
         try:
             os.remove(join(launcher_dir, "launcher"))
@@ -145,7 +158,11 @@ def download_archive(self, release_tag: str) -> None:
         url = self._download_url()
 
         with urlopen(url) as response:
-            chunked_download(filename="pymoda-temp.tar.gz", response=response)
+            chunked_download(
+                filename="pymoda-temp.tar.gz",
+                response=response,
+                progress_signal=self.progress_signal,
+            )
 
     def extract_archive(self) -> None:
         try:
@@ -162,32 +179,42 @@ def extract_archive(self) -> None:
 class LinuxUpdater(NixUpdater):
     def move_files(self) -> None:
         launcher_dir = launcher.get_launcher_directory()
+
+        if self.tag in os.listdir(launcher_dir):
+            shutil.rmtree(join(launcher_dir, self.tag))
+
         shutil.move(join("pymoda-temp", "PyMODA"), join(launcher_dir, self.tag))
 
 
 class MacUpdater(NixUpdater):
     def move_files(self) -> None:
         launcher_dir = launcher.get_launcher_directory()
+
+        if self.tag in os.listdir(launcher_dir):
+            shutil.rmtree(join(launcher_dir, self.tag))
+
         shutil.move("pymoda-temp", join(launcher_dir, self.tag))
 
 
-def get_instance(tag) -> Updater:
+def get_instance(tag, progress_signal) -> Updater:
     """
     Creates the Updater for the current OS.
 
     Parameters
     ----------
     tag : str
         The release tag of the latest release.
+    progress_signal : pyqtSignal
+        Signal which emits the download progress.
 
     Returns
     -------
     Updater
         The Updater for the current OS.
     """
     if OS.is_windows():
-        return WindowsUpdater(tag)
+        return WindowsUpdater(tag, progress_signal)
     elif OS.is_linux():
-        return LinuxUpdater(tag)
+        return LinuxUpdater(tag, progress_signal)
     else:
-        return MacUpdater(tag)
+        return MacUpdater(tag, progress_signal)