Merge branch 'develop' into code-tidying

Author: ferdnyc

CONTRIBUTING.md

@@ -1,38 +1,46 @@
 ## How to contribute to OpenShot Video Editor
 
-#### **Did you find a bug?**
+### Submitting an Issue (bug report)
 
-* **Please check if this bug was already reported** by searching on GitHub under [Issues](https://github.com/OpenShot/openshot-qt/issues).
+* **Please check if this bug was already reported** by searching on GitHub under [Issues](https://github.com/OpenShot/openshot-qt/issues?q=+).
 
-* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/OpenShot/openshot-qt/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and the steps to reproduce the crash or issue.
+* If you're unable to find an existing report about the problem, [open a new issue](https://github.com/OpenShot/openshot-qt/issues/new?template=bug-report.md). Be sure to include a **title and clear description**, and fill in as much relevant information as possible. Include the steps to reproduce the crash or issue, and please note what operating system(s) you tried them on. (Some bugs only occur when using OpenShot on a particular OS.)
 
 * Please **attach log files** if you are reporting a crash. Otherwise, we will not be able to determine the cause of the crash.
 
-  _Please download our latest daily installer:_
+#### Reproducing a bug & collecting logs
 
-  1. www.openshot.org/download - click the '**Daily Builds**' button, then grab the latest build from the list.
-     (Use the buttons below to download installers for a different Operating System.)
-  2. Then enable 'Debug Mode (Verbose)' in the Preferences
-  3. Quit OpenShot and delete both log files:
-      * **Windows**: OpenShot stores its logs in your user profile directory (`%USERPROFILE%`, e.g. `C:\Users\username\`)
-        * **`%USERPROFILE%/.openshot_qt/openshot-qt.log`**
-        * **`%USERPROFILE%/.openshot_qt/libopenshot.log`**
-      * **Linux/MacOS**: OpenShot stores its logs in your home directory (`$HOME`, e.g. `/home/username/`)
-        * **`$HOME/.openshot_qt/openshot-qt.log`**
-        * **`$HOME/.openshot_qt/libopenshot.log`**
-  4. Re-launch OpenShot and trigger the crash as quickly as possible (to keep the log files small)
-  5. Attach **both** log files
+  1. _Please download our latest daily installer:_
+     www.openshot.org/download - click the '**Daily Builds**' button, then grab the latest build from the list.
+     (Use the buttons below the list to download installers for a different Operating System.)
+  2. **Only if the bug involves video playback or Export**, or if you were asked to by the OpenShot developers, enable 'Debug Mode (Verbose)' in the Preferences. Debug Mode adds no additional information for user interface or project-editing bugs.
+  3. Quit OpenShot and delete your log files, to ensure the files you submit contain only necessary information. (See below for logfile paths.)
+  4. Re-launch OpenShot and trigger the problem as quickly as possible, then immediately quit the program. This helps keeps the log files small and relevant.
+  5. Attach both log files to your issue. Github issue comments permit attaching `.log` files up to 2MB in size. You can insert the file(s) either by drag-and-drop, or using the link at the bottom of the comment edit field.
+  
+#### OpenShot log file locations  
 
-#### **Did you write a patch that fixes a bug?**
+##### Windows
+  * OpenShot stores its logs in your user profile directory (`%USERPROFILE%`, e.g. `C:\Users\username\`)
+    * **<code><var>%USERPROFILE%</var>\.openshot_qt\openshot-qt.log</code>**
+    * **<code><var>%USERPROFILE%</var>\.openshot_qt\libopenshot.log</code>**
 
-* Open a new GitHub pull request with the patch.
+##### Linux/MacOS
+  * OpenShot stores its logs in your home directory (`$HOME`, e.g. `/home/username/`)
+    * **<code><var>$HOME</var>/.openshot_qt/openshot-qt.log</code>**
+    * **<code><var>$HOME</var>/.openshot_qt/libopenshot.log</code>**
 
-* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+### Submitting a Pull Request (source code patch / bug fix)
 
-* Before submitting, please ensure your PR passes all build / compilation / and unit tests.
+* Fork the repository on Github, then create a new branch for your changes. Commit the patch(es), and finally open a new GitHub Pull Request from that branch.
 
-OpenShot Video Editor is a volunteer effort, and a labor of love. Please be patient with any issues you find, and feel free to get involved and help us fix them! 
+* Ensure the PR description clearly describes the problem and your solution. If the patch is related to an existing issue report, include the issue number in your description. Github recognizes trigger phrases such as "fixes #1234" or "closes #9999", and will automatically link your PR with the referenced issue(s).
+
+* After submitting, your PR will be run through a test build and various code-quality and style checks. Try to address any problems flagged by these checks. If OpenShot fails to build successfully with your changes, the PR cannot be merged until the problem is resolved.
 
+  Submitting "in-progress" code is fine, and can often be a good way to solicit feedback from other developers. Consider marking PRs that are unfinished or still under development with a the title that begins with "WIP", or convert the PR to draft status, to indicate to the developers that your changes are not yet ready for review.
+
+OpenShot Video Editor is a volunteer effort, and a labor of love. Please be patient with any issues you find, and feel free to get involved and help us fix them! 
 
 Thanks!
 

src/classes/app.py

@@ -35,27 +35,28 @@
 
 from PyQt5.QtCore import PYQT_VERSION_STR
 from PyQt5.QtCore import QT_VERSION_STR
-from PyQt5.QtCore import Qt
+from PyQt5.QtCore import Qt, pyqtSlot
 from PyQt5.QtGui import QPalette, QColor, QFontDatabase, QFont
 from PyQt5.QtWidgets import QApplication, QStyleFactory, QMessageBox
 
 try:
-    # QtWebEngineWidgets must be loaded prior to creating a QApplication
-    # But on systems with only WebKit, this will fail (and we ignore the failure)
-    from PyQt5.QtWebEngineWidgets import QWebEngineView  # noqa
-except ImportError:
+    # This apparently has to be done before loading QtQuick
+    # (via QtWebEgine) AND before creating the QApplication instance
+    QApplication.setAttribute(Qt.AA_ShareOpenGLContexts)
+    from OpenGL import GL  # noqa
+except (ImportError, AttributeError):
     pass
 
 try:
-    # Solution to solve QtWebEngineWidgets black screen caused by OpenGL not loaded
-    from OpenGL import GL  # noqa
+    # QtWebEngineWidgets must be loaded prior to creating a QApplication
+    # But on systems with only WebKit, this will fail (and we ignore the failure)
+    from PyQt5.QtWebEngineWidgets import QWebEngineView
 except ImportError:
     pass
 
 try:
     # Enable High-DPI resolutions
     QApplication.setAttribute(Qt.AA_EnableHighDpiScaling)
-    QApplication.setAttribute(Qt.AA_ShareOpenGLContexts)
 except AttributeError:
     pass  # Quietly fail for older Qt5 versions
 
@@ -83,7 +84,10 @@ def __init__(self, *args, mode=None):
             log.info(time.asctime().center(48))
             log.info('Starting new session'.center(48))
 
-            from classes import settings, project_data, updates, language, ui_util, logger_libopenshot
+            from classes import (
+                settings, project_data, updates, language, ui_util,
+                logger_libopenshot
+                )
             import openshot
 
             # Re-route stdout and stderr to logger
@@ -126,7 +130,7 @@ def __init__(self, *args, mode=None):
             pass
 
         # Init settings
-        self.settings = settings.SettingStore()
+        self.settings = settings.SettingStore(parent=self)
         self.settings.load()
 
         # Init and attach exception handler
@@ -250,12 +254,15 @@ def __init__(self, *args, mode=None):
 
         # Create main window
         from windows.main_window import MainWindow
-        self.window = MainWindow(mode)
+        self.window = MainWindow(mode=mode)
 
         # Reset undo/redo history
         self.updates.reset()
         self.window.updateStatusChanged(False, False)
 
+        # Connect our exit signals
+        self.aboutToQuit.connect(self.cleanup)
+
         log.info('Process command-line arguments: %s' % args)
         if len(args[0]) == 2:
             path = args[0][1]
@@ -270,24 +277,33 @@ def __init__(self, *args, mode=None):
             # Recover backup file (this can't happen until after the Main Window has completely loaded)
             self.window.RecoverBackup.emit()
 
+    def settings_load_error(self, filepath=None):
+        """Use QMessageBox to warn the user of a settings load issue"""
+        _ = self._tr
+        QMessageBox.warning(
+            None,
+            _("Settings Error"),
+            _("Error loading settings file: %(file_path)s. Settings will be reset.")
+            % {"file_path": filepath}
+            )
+
     def _tr(self, message):
         return self.translate("", message)
 
     # Start event loop
     def run(self):
         """ Start the primary Qt event loop for the interface """
+        return self.exec_()
 
-        res = self.exec_()
-
+    @pyqtSlot()
+    def cleanup(self):
+        """aboutToQuit signal handler for application exit"""
         try:
             from classes.logger import log
             self.settings.save()
         except Exception:
             log.error("Couldn't save user settings on exit.", exc_info=1)
 
-        # return exit result
-        return res
-
 
 # Log the session's end
 @atexit.register

src/classes/exceptions.py

@@ -1,26 +1,26 @@
-""" 
+"""
  @file
  @brief This file deals with unhandled exceptions
  @author Jonathan Thomas <[email protected]>
- 
+
  @section LICENSE
- 
+
  Copyright (c) 2008-2018 OpenShot Studios, LLC
  (http://www.openshotstudios.com). This file is part of
  OpenShot Video Editor (http://www.openshot.org), an open-source project
  dedicated to delivering high quality video editing and animation solutions
  to the world.
- 
+
  OpenShot Video Editor is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
- 
+
  OpenShot Video Editor is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
- 
+
  You should have received a copy of the GNU General Public License
  along with OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.
  """

src/classes/info.py

@@ -92,6 +92,9 @@
 LOG_LEVEL_FILE = 'INFO'
 LOG_LEVEL_CONSOLE = 'INFO'
 
+# Web backend selection, overridable at launch
+WEB_BACKEND = 'auto'
+
 # Languages
 CMDLINE_LANGUAGE = None
 CURRENT_LANGUAGE = 'en_US'

src/classes/settings.py

@@ -1,54 +1,64 @@
-""" 
+"""
  @file
- @brief This file loads and saves settings 
+ @brief This file loads and saves settings
  @author Noah Figg <[email protected]>
  @author Jonathan Thomas <[email protected]>
  @author Olivier Girard <[email protected]>
- 
+
  @section LICENSE
- 
+
  Copyright (c) 2008-2018 OpenShot Studios, LLC
  (http://www.openshotstudios.com). This file is part of
  OpenShot Video Editor (http://www.openshot.org), an open-source project
  dedicated to delivering high quality video editing and animation solutions
  to the world.
- 
+
  OpenShot Video Editor is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
- 
+
  OpenShot Video Editor is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
- 
+
  You should have received a copy of the GNU General Public License
  along with OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.
  """
 
 # SettingStore - class which allows getting/storing of settings, loading and saving to json
 import os
 
-from PyQt5.QtCore import QStandardPaths, QCoreApplication
-from PyQt5.QtWidgets import QMessageBox
-
-from classes.logger import log
 from classes import info
+from classes.logger import log
 from classes.json_data import JsonDataStore
 
 
 def get_settings():
-    """ Get the current QApplication's settings instance """
-    return QCoreApplication.instance().settings
+    """ Get the current application's settings instance """
+    return SettingStore.get_app().settings
 
 
 class SettingStore(JsonDataStore):
     """ This class only allows setting pre-existing keys taken from default settings file, and merges user settings
     on load, assumes default OS dir."""
 
-    def __init__(self):
-        JsonDataStore.__init__(self)
+    @classmethod
+    def save_app(cls, app_reference):
+        cls._app = app_reference
+
+    @classmethod
+    def get_app(cls):
+        if hasattr(cls, "_app"):
+            return cls._app
+        return None
+
+    def __init__(self, parent=None):
+        super().__init__()
+        # Also keep track of our parent, if defined
+        if parent:
+            SettingStore.save_app(parent)
         # Set the data type name for logging clarity (base class functions use this variable)
         self.data_type = "user settings"
         self.settings_filename = "openshot.settings"
@@ -72,8 +82,11 @@ def set(self, key, value):
         if key in user_values:
             user_values[key]["value"] = value
         else:
-            log.warn("{} key '{}' not valid. The following are valid: {}".format(self.data_type, key,
-                                                                                 list(self._data.keys())))
+            log.warn(
+                "{} key '{}' not valid. The following are valid: {}".format(
+                self.data_type, key,
+                list(self._data.keys()),
+                ))
 
     def load(self):
         """ Load user settings file from disk, merging with allowed settings in default settings file.
@@ -90,17 +103,16 @@ def load(self):
 
         # Load user settings (if found)
         if os.path.exists(os.fsencode(file_path)):
-
             # Will raise exception to caller on failure to read
             try:
                 user_settings = self.read_from_file(file_path)
             except Exception as ex:
-                log.error("Error loading settings file: %s" % ex)
-
-                _ = QCoreApplication.instance()._tr
-                QMessageBox.warning(None, _("Settings Error"),
-                                          _("Error loading settings file: %(file_path)s. Settings will be reset.") % { "file_path": file_path})
+                log.error("Error loading settings file: %s", ex)
                 user_settings = {}
+                app = SettingStore.get_app()
+                if app:
+                    # We have a parent, ask to show a message box
+                    app.settings_load_error(file_path)
 
         # Merge default and user settings, excluding settings not in default, Save settings
         self._data = self.merge_settings(default_settings, user_settings)

src/classes/thumbnail.py

@@ -107,6 +107,9 @@ def run(self):
         self.server_address = ('127.0.0.1', self.find_free_port())
         self.thumbServer = httpThumbnailServer(self.server_address, httpThumbnailHandler)
         self.thumbServer.daemon_threads = True
+        log.info(
+            "Starting thumbnail server listening on port %d",
+            self.server_address[1])
         self.thumbServer.serve_forever(0.5)
 
     def __init__(self):
@@ -128,6 +131,8 @@ def log_error(self, msg_format, *args):
 
     def do_GET(self):
         """ Process each GET request and return a value (image or file path)"""
+        mask_path = os.path.join(info.IMAGES_PATH, "mask.png")
+
         # Parse URL
         url_output = REGEX_THUMBNAIL_URL.match(self.path)
         if url_output and len(url_output.groups()) == 4:
@@ -147,6 +152,10 @@ def do_GET(self):
         only_path = url_output.group('only_path')
         no_cache = url_output.group('no_cache')
 
+        log.debug(
+            "Processing thumbnail request for %s frame %d",
+            file_id, file_frame)
+
         try:
             # Look up file data
             file = File.get(id=file_id)
@@ -155,6 +164,7 @@ def do_GET(self):
             file_path = file.absolute_path()
         except AttributeError:
             # Couldn't match file ID
+            log.debug("No ID match, returning 404")
             self.send_error(404)
             return
 
@@ -183,7 +193,13 @@ def do_GET(self):
                 overlay_path = os.path.join(info.IMAGES_PATH, "overlay.png")
 
             # Create thumbnail image
-            GenerateThumbnail(file_path, thumb_path, file_frame, 98, 64, os.path.join(info.IMAGES_PATH, "mask.png"), overlay_path)
+            GenerateThumbnail(
+                file_path,
+                thumb_path,
+                file_frame,
+                98, 64,
+                mask_path,
+                overlay_path)
 
         # Send message back to client
         if os.path.exists(thumb_path):