Bug fix copytree and user notify voice update

- Fixing a bug with copytree to make it compatible on Python < 3.8
- Checking for updates in installed voice and notifying user

Author: krishnshyam

globalPlugins/hear2readng_global_plugin/__init__.py

@@ -10,6 +10,9 @@
 # this is a slightly modified version of the corresponding file in the sonata
 # project (https://github.com/mush42/sonata-nvda)
 
+from threading import Thread
+from urllib import request
+
 import core
 import globalPluginHandler
 import gui
@@ -22,6 +25,10 @@
 from globalPlugins.hear2readng_global_plugin.english_settings import (
     EnglishSpeechSettingsDialog,
 )
+from globalPlugins.hear2readng_global_plugin.utils import (
+    H2RNG_VOICE_LIST_URL,
+    parse_server_voices,
+)
 from globalPlugins.hear2readng_global_plugin.voice_manager import (
     Hear2ReadNGVoiceManagerDialog,
 )
@@ -35,7 +42,7 @@ def __init__(self, *args, **kwargs):
         self.__voice_manager_shown = False
         curr_synth_name = getSynth().name
         self._voice_checker = lambda: wx.CallLater(2000, 
-                                                    self._perform_voice_check)
+                                                    self._perform_checks)
         core.postNvdaStartup.register(self._voice_checker)
 
         # if "Hear2Read NG" not in curr_synth_name:
@@ -47,7 +54,7 @@ def __init__(self, *args, **kwargs):
             4,
             wx.ID_ANY,
             # Translators: label of a menu item
-            _("Hear2Read Voice Downloader..."),
+            _("Hear2Read Voice Manager..."),
             # Translators: Hear2Read Indic's voice manager menu item help
             _("Open the voice manager to download Hear2Read Indic voices"),
         )
@@ -138,16 +145,75 @@ def on_no_voices(self, curr_synth_name):
                 wx.YES_NO | wx.ICON_WARNING,):
                 wx.CallAfter(self.on_manager)
 
+    def on_voice_update(self, lang):
+
+        if self.__voice_manager_shown:# or gui.isModalMessageBoxActive():
+            return
+        
+        if wx.YES == gui.messageBox(
+                # Translators: message telling the user that no voice is installed
+                _(
+                    f"Update found for installed {lang} Hear2Read voice.\n"
+                    "Updated voice is available in the Hear2Read voice manager.\n"
+                    "Do you want to open the voice manager now?"
+                ),
+                # Translators: title of a message telling the user that no Hear2Read Indic voice was found
+                _("Hear2Read Voice Update"),
+                wx.YES_NO | wx.ICON_INFORMATION,):
+            wx.CallAfter(self.on_manager)
+
+    def _perform_checks(self):
+        
+        self._perform_voice_check()
+        
+        if self.__voice_manager_shown:
+            return
+        
+        self._perform_voice_update_check()
+
     # @gui.blockAction.when(gui.blockAction.Context.MODAL_DIALOG_OPEN)         
     def _perform_voice_check(self):
-        if self.__voice_manager_shown:# or gui.isModalMessageBoxActive():
+        if self.__voice_manager_shown:
             return
 
         if not any(Hear2ReadNGVoiceManagerDialog.get_installed_voices()):
             curr_synth_name = getSynth().name
             # queueHandler.queueFunction(queueHandler.eventQueue, self.on_no_voices, curr_synth_name)
             self.on_no_voices(curr_synth_name)
 
+    
+    def _perform_voice_update_check(self):
+        """Populated the list of voices available on the server. Modifies the 
+        class attribute server_voices, a list of Voice objects. The operation
+        is done in a background thread while a BusyInfo is displayed.
+        """
+        # fetch_complete_event = Event()
+        if self.__voice_manager_shown:# or gui.isModalMessageBoxActive():
+            return
+
+        def fetch():
+            """Main function to fetch the voice list from the server. Sets the
+            server_error_event/network_error_event attribute in case of failure 
+            """
+            try:
+                with request.urlopen(H2RNG_VOICE_LIST_URL) as response:
+                    resp_str = response.read().decode('utf-8')
+                    server_voices = parse_server_voices(resp_str)
+                    if server_voices:
+                        installed_voices = Hear2ReadNGVoiceManagerDialog.get_installed_voices()
+                        for iso, installed_voice in installed_voices.items():
+                            server_voice = server_voices.get(iso, None)
+                            if server_voice and server_voice.id != installed_voice.id:
+                                log.info(f"checking update on {installed_voice.id}, found: {server_voice.id}")
+                                self.on_voice_update(server_voice.display_name)
+                                return
+            except Exception as e:
+                log.warn(f"Hear2Read unable to access internet to check voice updates: {e}")
+            # finally:
+            #     fetch_complete_event.set()
+
+        Thread(target=fetch).start()
+
     def terminate(self):
         try:
             gui.mainFrame.sysTrayIcon.menu.DestroyItem(self.itemHandle)

globalPlugins/hear2readng_global_plugin/utils.py

@@ -4,6 +4,7 @@
 
 import os
 import shutil
+import sys
 import urllib.request
 from dataclasses import dataclass
 from threading import Thread
@@ -43,6 +44,11 @@
                 "te":"Telugu", 
                 "en":"English"}
 
+# URL suffix for voice files
+H2RNG_VOICES_DOWNLOAD_HTTP = "https://hear2read.org/Hear2Read/voices-piper/"
+# voice list URL
+H2RNG_VOICE_LIST_URL = "https://hear2read.org/nvda-addon/getH2RNGVoiceNames.php"
+
 try:
     _dir=os.path.dirname(__file__.decode("mbcs"))
 except AttributeError:
@@ -53,6 +59,42 @@
 OLD_H2RNG_DATA_DIR = os.path.join(os.environ['ALLUSERSPROFILE'], 
                                   "Hear2Read-ng")
 
+def copytree_compat(src, dst):
+    """Copytree version with overwrite compatible for Python < 3.8. This is
+    copied from the answer https://stackoverflow.com/a/13814557, and has a 
+    fairly basic functionality not accounting for symlinks, which is sufficient
+    for our purposes
+
+    @param src: path to the source, to be copied from
+    @type src: string
+    @param dst: path to the destination, to be copied to
+    @type dst: string
+    """
+    if not os.path.exists(dst):
+        os.makedirs(dst)
+    for item in os.listdir(src):
+        s = os.path.join(src, item)
+        d = os.path.join(dst, item)
+        if os.path.isdir(s):
+            copytree_compat(s, d)
+        else:
+            if not os.path.exists(d) or os.stat(s).st_mtime - os.stat(d).st_mtime > 1:
+                shutil.copy2(s, d)
+
+def copytree_overwrite(src, dst):
+    """Wrapper to enable consistent behaviour in Python version < 3.8
+
+    @param src: path to the source, to be copied from
+    @type src: string
+    @param dst: path to the destination, to be copied to
+    @type dst: string
+    """
+    if sys.version_info >= (3, 8):
+        shutil.copytree(src=src, dst=dst, dirs_exist_ok=True)
+    else:
+        copytree_compat(src=src, dst=dst)
+
+
 def check_files():
     """
     Checks whether the files and directories vital to Hear2Read Indic are 
@@ -74,28 +116,6 @@ def check_files():
         if not os.listdir(H2RNG_PHONEME_DIR):
             return False
             # phonedir_is_present = True
-        
-        # if os.path.isdir(H2RNG_VOICES_DIR):
-        #     file_list = os.listdir(H2RNG_VOICES_DIR)
-            
-        #     for file_name in file_list:
-        #         parts = file_name.split(".")
-        #         if parts[-1] == "onnx" and f"{file_name}.json" in file_list:
-        #             return True
-            
-        # return wx.YES == gui.messageBox(
-        #         # Translators: message telling the user that no voice is installed
-        #         _(
-        #             "Hear2Read needs to have an Indic voice to function.\n"
-        #             "Please select a Hear2Read voice to download from the manager.\n"
-        #             "Do you want to open the voice manager now?"
-        #         ),
-        #         # Translators: title of a message telling the user that no Hear2Read Indic voice was found
-        #         _("Hear2Read Indic Voices"),
-        #         wx.YES_NO | wx.ICON_WARNING,)
-    
-                # voice_is_present = True
-                # break
 
     except Exception as e:
         log.warn(f"Hear2Read Indic check failed with exception: {e}")
@@ -105,6 +125,40 @@ def check_files():
     # return dll_is_present and phonedir_is_present and voice_is_present
 
 
+def parse_server_voices(resp_str):
+    """Parses the pipe separated file list response from the server
+
+    @param resp_str: string of pipe separated voice related files
+    @type resp_str: string
+    """
+    server_voices = {}
+    server_files = resp_str.split('|')
+    for file in server_files:
+        if file.startswith("en"):
+            continue
+        parts = file.split(".")
+        if parts[-1] == "onnx":
+            if f"{file}.json" in server_files:
+                iso_lang = parts[0].split("-")[0].split("_")[0]
+                extra = False
+                if f"{file}.zip" in server_files:
+                    extra = True
+                if iso_lang in lang_names.keys():
+                    server_voices[iso_lang] = Voice(id=parts[0], 
+                            lang_iso=iso_lang,
+                            display_name=lang_names[iso_lang],
+                            state="Download", 
+                            extra=extra)
+                else:
+                    server_voices[iso_lang] = Voice(id=parts[0], 
+                            lang_iso=iso_lang,
+                            display_name=f"Unknown Lang ({iso_lang})",
+                            state="Download", 
+                            extra=extra)
+
+    return server_voices
+
+
 def populateVoices():
     pathName = os.path.join(H2RNG_VOICES_DIR)
     voices = dict()
@@ -164,8 +218,7 @@ def move_old_voices():
 
         if os.path.isdir(old_wavs_dir):
             try:
-                shutil.copytree(src=old_wavs_dir, dst=H2RNG_WAVS_DIR, 
-                                dirs_exist_ok=True)
+                copytree_overwrite(src=old_wavs_dir, dst=H2RNG_WAVS_DIR)
             except Exception as e:
                 log.warn("Hear2Read Indic unable to copy old wav folders")
 
@@ -194,7 +247,8 @@ def move_old_voices():
 
 def onInstall():
     """A fallback that tries moving the required data files in case it wasn't
-    done by installTasks.py
+    done by installTasks.py It is duplicated as importing is not available with
+    installTasks.py
 
     @raises e: raises any exceptions that can occur while transferring the data
     @return: returns True if any voices from an older version (<v1.5) have been
@@ -206,7 +260,7 @@ def onInstall():
     src_dir = os.path.join(_dir, "res")
 
     try:
-        shutil.copytree(src=src_dir, dst=H2RNG_DATA_DIR, dirs_exist_ok=True)
+        copytree_overwrite(src=src_dir, dst=H2RNG_DATA_DIR)
         shutil.rmtree(src_dir)
     except Exception as e:
         log.warn(f"Error installing Hear2Read Indic data files: {e}")

globalPlugins/hear2readng_global_plugin/voice_manager.py

@@ -18,14 +18,19 @@
 import wx
 from logHandler import log
 
+from synthDrivers._H2R_NG_Speak import H2RNG_DATA_DIR, H2RNG_VOICES_DIR
+
 from .utils import (
-    H2RNG_DATA_DIR,
-    H2RNG_VOICES_DIR,
+    # H2RNG_DATA_DIR,
+    H2RNG_VOICE_LIST_URL,
+    # H2RNG_VOICES_DIR,
+    H2RNG_VOICES_DOWNLOAD_HTTP,
     DownloadThread,
     Voice,
     check_files,
-    lang_names,
+    # lang_names,
     onInstall,
+    parse_server_voices,
     populateVoices,
 )
 
@@ -34,10 +39,6 @@
 DLL_FILE_NAME_PREFIX = "Hear2ReadNG_addon_engine"
 DOWNLOAD_SUFFIX = ".download"
 
-# URL suffix for voice files
-H2RNG_VOICES_DOWNLOAD_HTTP = "https://hear2read.org/Hear2Read/voices-piper/"
-# voice list URL
-H2RNG_VOICE_LIST_URL = "https://hear2read.org/nvda-addon/getH2RNGVoiceNames.php"
 
 # TODO remove copyright, add copyright
 # TODO rename the synth file to have no spaces(?)
@@ -529,6 +530,7 @@ def on_download_cancel(self, voice, error_message=None):
                     wx.OK | wx.ICON_WARNING
                 )
 
+    # TODO remove duplicate of utils.populateVoices
     @classmethod  
     def get_installed_voices(self):
         """Classmethod to get installed voices. Returns a dictionary of voices
@@ -561,7 +563,6 @@ def get_installed_voices(self):
 
         return installed_voices
 
-
     def get_server_voices(self):
         """Populated the list of voices available on the server. Modifies the 
         class attribute server_voices, a list of Voice objects. The operation
@@ -574,35 +575,6 @@ class attribute server_voices, a list of Voice objects. The operation
                                         parent=self)
         wx.Yield()
 
-        def parse_server_voices(resp_str):
-            """Parses the pipe separated file list response from the server
-
-            @param resp_str: string of pipe separated voice related files
-            @type resp_str: string
-            """
-            server_files = resp_str.split('|')
-            for file in server_files:
-                if file.startswith("en"):
-                    continue
-                parts = file.split(".")
-                if parts[-1] == "onnx":
-                    if f"{file}.json" in server_files:
-                        iso_lang = parts[0].split("-")[0].split("_")[0]
-                        extra = False
-                        if f"{file}.zip" in server_files:
-                            extra = True
-                        if iso_lang in lang_names.keys():
-                            self.server_voices[iso_lang] = Voice(id=parts[0], 
-                                    lang_iso=iso_lang,
-                                    display_name=lang_names[iso_lang],
-                                    state="Download", 
-                                    extra=extra)
-                        else:
-                            self.server_voices[iso_lang] = Voice(id=parts[0], 
-                                    lang_iso=iso_lang,
-                                    display_name=f"Unknown Lang ({iso_lang})",
-                                    state="Download", 
-                                    extra=extra)
 
         def dismiss_loading_dialog():
             nonlocal loading_dialog
@@ -615,7 +587,8 @@ def fetch():
             try:
                 with request.urlopen(H2RNG_VOICE_LIST_URL) as response:
                     resp_str = response.read().decode('utf-8')
-                    parse_server_voices(resp_str)
+                    self.server_voices = parse_server_voices(resp_str)
+                    # parse_server_voices(resp_str)
             except HTTPError as http_e:
                 self.server_error_event.set()
                 log.warn(f"Hear2Read http error: {http_e}")
@@ -663,4 +636,4 @@ def get_display_voices(self):
             else:
                 self.display_voices.append(local_voice)
 
-        self.display_voices.sort(key=operator.attrgetter("display_name"))
+        self.display_voices.sort(key=operator.attrgetter("display_name"))