Merge pull request #11 from zSeriesGuy/beta

v1.2.3

Author: zSeriesGuy

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v1.2.3 (2019-10-21)
+* Add support to ensure only one instance of SpeakReader is running.
+* Add exception handler for Google OutOfRange exception. Streaming limit is 5 minutes.
+* Run file cleanup if days changes in management console settings.
+* Upgrade packages.
+
 ## v1.2.2 (2019-10-19)
 * Add settings and process for deleting logs, transcripts, and recordings after a specified number of days.
 

requirements.in

@@ -20,3 +20,4 @@ passlib
 wheel
 samplerate
 apscheduler
+psutil

requirements.txt

@@ -8,7 +8,7 @@ apscheduler==3.6.1
 azure-cognitiveservices-speech==1.7.0 ; sys_platform in "win32 macos" or (sys_platform == "linux" and platform_machine in "AMD64")
 cachetools==3.1.1         # via google-auth
 certifi==2019.9.11        # via requests
-cffi==1.13.0              # via samplerate
+cffi==1.13.1              # via samplerate
 chardet==3.0.4            # via requests
 cheroot==8.2.1            # via cherrypy
 cherrypy==18.3.0
@@ -34,6 +34,7 @@ passlib==1.7.1
 pip-tools==4.2.0
 portend==2.5
 protobuf==3.10.0          # via google-api-core, googleapis-common-protos
+psutil==5.6.3
 pyasn1-modules==0.2.7     # via google-auth
 pyasn1==0.4.7             # via pyasn1-modules, rsa
 pyaudio==0.2.11

speakreader/googleTranscribe.py

@@ -5,6 +5,7 @@
 
 try:
     from google.cloud import speech
+    from google.api_core import exceptions
     is_supported = True
 except ImportError:
     is_supported = False
@@ -51,26 +52,29 @@ def transcribe(self):
 
         responses = self.client.streaming_recognize(self.streaming_config, requests)
 
-        for response in responses:
-            if not response.results:
-                continue
+        try:
+            for response in responses:
+                if not response.results:
+                    continue
 
-            result = response.results[0]
+                result = response.results[0]
 
-            if not result.is_final and not speakreader.CONFIG.SHOW_INTERIM_RESULTS:
-                continue
+                if not result.is_final and not speakreader.CONFIG.SHOW_INTERIM_RESULTS:
+                    continue
 
-            if not result.alternatives:
-                continue
+                if not result.alternatives:
+                    continue
 
-            if not result.is_final and result.stability < 0.75:
-                continue
+                if not result.is_final and result.stability < 0.75:
+                    continue
 
-            transcript = {
-                'transcript': result.alternatives[0].transcript,
-                'is_final': result.is_final,
-            }
+                transcript = {
+                    'transcript': result.alternatives[0].transcript,
+                    'is_final': result.is_final,
+                }
 
-            yield transcript
-
-        logger.debug("googleTranscribe.transcribe Exiting")
+                yield transcript
+            logger.debug("googleTranscribe.transcribe Exiting")
+        except exceptions.OutOfRange:
+            logger.debug("googleTranscribe.transcribe OutOfRange Exception: Time Limit Exceeded. Restarting.")
+            pass

speakreader/microphoneStream.py

@@ -122,7 +122,7 @@ def __enter__(self):
                 stream_callback=self._fill_buff,
             )
         except OSError:
-            print("microphone __enter__.OSError")
+            logger.error("microphone __enter__.OSError")
             self.closed = True
             raise Exception("Microphone Not Functioning")
 
@@ -132,6 +132,8 @@ def __enter__(self):
         return self
 
     def __exit__(self, type, value, traceback):
+        if self.closed:
+            return
         logger.debug('MicrophoneStream.exit ENTER')
         self._audio_stream.stop_stream()
         self._audio_stream.close()

speakreader/transcribeEngine.py

@@ -95,11 +95,11 @@ def start(self):
 
     def stop(self):
         if self._ONLINE:
+            self._ONLINE = False
             self.microphoneStream.stop()
             self.transcriptQueue.put_nowait(self.OFFLINE_MESSAGE)
             self._transcribeThread.join()
             self.queueManager.transcriptHandler.setFileName(None)
-            self._ONLINE = False
 
     def shutdown(self):
         self.stop()
@@ -141,12 +141,14 @@ def run(self):
         self.transcriptQueue.put_nowait(self.ONLINE_MESSAGE)
         self._ONLINE = True
 
-        with self.microphoneStream as stream:
-            while not stream.closed:
-                responses = transcribeService.transcribe()
-                self.process_responses(responses)
-
-            logger.info("Transcription Engine Stream Closed")
+        try:
+            with self.microphoneStream as stream:
+                while self._ONLINE:
+                    responses = transcribeService.transcribe()
+                    self.process_responses(responses)
+                logger.info("Transcription Engine Stream Closed")
+        except Exception as e:
+            logger.error(e)
 
         self.transcriptFile.close()
         self.transcriptQueue.put_nowait(self.OFFLINE_MESSAGE)

speakreader/version.py

@@ -1,3 +1,3 @@
 PRODUCT = 'SpeakReader'
-VERSION_RELEASE = 'v1.2.2'
+VERSION_RELEASE = 'v1.2.3'
 GITHUB_BRANCH = 'master'

speakreader/webserve.py

@@ -150,6 +150,7 @@ def configUpdate(self, **kwargs):
         restartTranscribeEngine = False
         restartSpeakReader = False
         logout = False
+        cleanup = False
 
         checked_configs = [
             "start_transcribe_on_startup",
@@ -220,9 +221,17 @@ def configUpdate(self, **kwargs):
         if kwargs['http_username'] != speakreader.CONFIG.HTTP_USERNAME or set_http_password:
             logout = True
 
+        if kwargs.get('log_retention_days') != speakreader.CONFIG.LOG_RETENTION_DAYS \
+        or kwargs.get('transcript_retention_days') != speakreader.CONFIG.TRANSCRIPT_RETENTION_DAYS \
+        or kwargs.get('recording_retention_days') != speakreader.CONFIG.RECORDING_RETENTION_DAYS:
+            cleanup = True
+
         speakreader.CONFIG.process_kwargs(kwargs)
         speakreader.CONFIG.write()
 
+        if cleanup:
+            self.SR.cleanup_files()
+
         if restartSpeakReader:
             #self.restart()
             return {'portchanged': True}

start.py

@@ -35,6 +35,7 @@
 import time
 import tzlocal
 import threading
+import psutil
 
 import speakreader
 from speakreader import logger, config, SpeakReader
@@ -51,8 +52,6 @@ def main():
 
     DAEMON = False
     NOFORK = False
-    CREATEPID = False
-    PIDFILE = None
 
     QUIET = False
     VERBOSE = False
@@ -67,6 +66,7 @@ def main():
     PLATFORM_PROCESSOR = processor()
     PLATFORM_MACHINE = machine()
     PLATFORM_IS_64BITS = sys.maxsize > 2**32
+    SYS_PLATFORM = sys.platform
 
     # Fixed paths to application
     if hasattr(sys, 'frozen'):
@@ -76,19 +76,26 @@ def main():
 
     PROG_DIR = os.path.dirname(FULL_PATH)
 
-    SYS_PLATFORM = sys.platform
-    SYS_ENCODING = None
+    # Ensure only one instance of SpeakReader running.
+    PIDFILE = os.path.join(PROG_DIR, 'pidfile')
+    myPid = os.getpid()
+    if os.path.exists(PIDFILE) and os.path.isfile(PIDFILE):
+        for p in psutil.process_iter():
+            if 'python' in p.name() and p.pid != myPid:
+                for f in p.open_files():
+                    if f.path == PIDFILE:
+                        logger.error("SpeakReader is already Running. Exiting.")
+                        sys.exit(0)
+
+    myPidFile = open(PIDFILE, 'w+')
+    myPidFile.write(str(myPid))
+    myPidFile.flush()
 
     try:
         locale.setlocale(locale.LC_ALL, "")
-        SYS_LANGUAGE, SYS_ENCODING = locale.getdefaultlocale()
     except (locale.Error, IOError):
         pass
 
-    # for OSes that are poorly configured I'll just force UTF-8
-    if not SYS_ENCODING or SYS_ENCODING in ('ANSI_X3.4-1968', 'US-ASCII', 'ASCII'):
-        SYS_ENCODING = 'UTF-8'
-
     try:
         SYS_TIMEZONE = str(tzlocal.get_localzone())
         SYS_UTC_OFFSET = datetime.datetime.now(pytz.timezone(SYS_TIMEZONE)).strftime('%z')
@@ -116,8 +123,6 @@ def main():
         '--config', help='Specify a config file to use')
     parser.add_argument(
         '--nolaunch', action='store_true', help='Prevent browser from launching on startup')
-    parser.add_argument(
-        '--pidfile', help='Create a pid file (only relevant when running as a daemon)')
     parser.add_argument(
         '--nofork', action='store_true', help='Start SpeakReader as a service, do not fork when restarting')
 
@@ -148,35 +153,6 @@ def main():
         NOFORK = True
         logger.info("SpeakReader is running as a service, it will not fork when restarted.")
 
-    if args.pidfile:
-        PIDFILE = str(args.pidfile)
-
-        # If the pidfile already exists, SpeakReader may still be running, so EXIT
-        if os.path.exists(PIDFILE):
-            try:
-                with open(PIDFILE, 'r') as fp:
-                    pid = int(fp.read())
-                os.kill(pid, 0)
-            except IOError as e:
-                raise SystemExit("Unable to read PID file: %s", e)
-            except OSError:
-                logger.warn("PID file '%s' already exists, but PID %d is not running. Ignoring PID file." %
-                            (PIDFILE, pid))
-            else:
-                # The pidfile exists and points to a live PID. SpeakReader may still be running, so exit.
-                raise SystemExit("PID file '%s' already exists. Exiting." % PIDFILE)
-
-        # The pidfile is only useful in daemon mode, make sure we can write the file properly
-        if DAEMON:
-            CREATEPID = True
-            try:
-                with open(PIDFILE, 'w') as fp:
-                    fp.write("pid\n")
-            except IOError as e:
-                raise SystemExit("Unable to write PID file: %s", e)
-        else:
-            logger.warn("Not running in daemon mode. PID file creation disabled.")
-
     # Determine which data directory and config file to use
     if args.datadir:
         DATA_DIR = args.datadir
@@ -246,7 +222,7 @@ def main():
         CONFIG.RECORDINGS_FOLDER, os.path.join(DATA_DIR, 'recordings'), 'recordings')
 
     if DAEMON:
-        daemonize(CREATEPID, PIDFILE)
+        daemonize(myPidFile)
 
     # Store the original umask
     UMASK = os.umask(0)
@@ -295,9 +271,8 @@ def main():
 
     SR.shutdown(restart=restart, update=update, checkout=checkout)
 
-    if CREATEPID:
-        logger.info("Removing pidfile %s", PIDFILE)
-        os.remove(PIDFILE)
+    myPidFile.close()
+    os.remove(PIDFILE)
 
     if restart:
         logger.info("SpeakReader is restarting...")
@@ -332,7 +307,7 @@ def main():
     sys.exit(0)
 
 
-def daemonize(CREATEPID, PIDFILE):
+def daemonize(myPidFile):
 
     if threading.activeCount() != 1:
         logger.warn(
@@ -377,12 +352,10 @@ def daemonize(CREATEPID, PIDFILE):
     os.dup2(se.fileno(), sys.stderr.fileno())
 
     pid = os.getpid()
-    logger.info(u"Daemonized to PID: %d", pid)
-
-    if CREATEPID:
-        logger.info(u"Writing PID %d to %s", pid, PIDFILE)
-        with open(PIDFILE, 'w') as fp:
-            fp.write("%s\n" % pid)
+    myPidFile.seek(0)
+    myPidFile.write(str(pid))
+    myPidFile.flush()
+    logger.info("Daemonized to PID: %d", pid)
 
 
 def check_folder_writable(folder, fallback, name):
@@ -393,17 +366,17 @@ def check_folder_writable(folder, fallback, name):
         try:
             os.makedirs(folder)
         except OSError as e:
-            logger.error(u"Could not create %s dir '%s': %s" % (name, folder, e))
+            logger.error("Could not create %s dir '%s': %s" % (name, folder, e))
             if folder != fallback:
-                logger.warn(u"Falling back to %s dir '%s'" % (name, fallback))
+                logger.warn("Falling back to %s dir '%s'" % (name, fallback))
                 return check_folder_writable(None, fallback, name)
             else:
                 return folder, None
 
     if not os.access(folder, os.W_OK):
-        logger.error(u"Cannot write to %s dir '%s'" % (name, folder))
+        logger.error("Cannot write to %s dir '%s'" % (name, folder))
         if folder != fallback:
-            logger.warn(u"Falling back to %s dir '%s'" % (name, fallback))
+            logger.warn("Falling back to %s dir '%s'" % (name, fallback))
             return check_folder_writable(None, fallback, name)
         else:
             return folder, False