Large assets refactor, plus adding recovery ability (~/.openshot_qt/recovery/). Introduced a new @assets path placeholder which is replaced by the project's dynamic asset path. This allows for external renaming of assets folder + project file. Also simplifies 'Save As', as we no longer have hard-coded absolute paths to assets folders. Also, once a project is saved/loaded, Titles and Thumbnails are saved inside the new assets folder (instead of inside our temp ~/.openshot_qt/ folders).

Author: jonoomph

src/classes/app.py

@@ -27,18 +27,17 @@
  along with OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.
  """
 
+import atexit
 import os
-import sys
 import platform
+import sys
 import traceback
-import atexit
-from uuid import uuid4
-from PyQt5.QtWidgets import QApplication, QStyleFactory, QMessageBox
-from PyQt5.QtGui import QPalette, QColor, QFontDatabase, QFont
-from PyQt5.QtCore import Qt
-from PyQt5.QtCore import QT_VERSION_STR
+
 from PyQt5.QtCore import PYQT_VERSION_STR
-from PyQt5.QtCore import pyqtSlot
+from PyQt5.QtCore import QT_VERSION_STR
+from PyQt5.QtCore import Qt
+from PyQt5.QtGui import QPalette, QColor, QFontDatabase, QFont
+from PyQt5.QtWidgets import QApplication, QStyleFactory, QMessageBox
 
 try:
     # Enable High-DPI resolutions
@@ -102,7 +101,7 @@ def __init__(self, *args, mode=None):
             log.info("pyqt5 version: %s" % PYQT_VERSION_STR)
         except Exception:
             pass
-			
+
         # Setup application
         self.setApplicationName('openshot')
         self.setApplicationVersion(info.SETUP['version'])
@@ -255,6 +254,7 @@ def run(self):
         # return exit result
         return res
 
+
 # Log the session's end
 @atexit.register
 def onLogTheEnd():
@@ -268,4 +268,3 @@ def onLogTheEnd():
         log.info("================================================")
     except Exception:
         pass
-

src/classes/assets.py

@@ -0,0 +1,75 @@
+"""
+ @file
+ @brief This file generates the path for a project's assets
+ @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/>.
+ """
+
+import os
+from classes import info, settings
+from classes.logger import log
+
+
+def get_assets_path(file_path=None, create_paths=True):
+    """Get and/or create the current assets path. This path is used for thumbnail and blender files,
+    and is unique to each project. For example: `Project1.osp` would use `Project1_assets` folder."""
+    if not file_path:
+        return info.USER_PATH
+
+    try:
+        # Generate asset folder name, max 30 chars of filename + "_assets"
+        file_path = file_path
+        asset_filename = os.path.splitext(os.path.basename(file_path))[0]
+        asset_folder_name = asset_filename[:30] + "_assets"
+        asset_path = os.path.join(os.path.dirname(file_path), asset_folder_name)
+
+        # Create asset folder, if necessary
+        if create_paths:
+            if not os.path.exists(asset_path):
+                os.mkdir(asset_path)
+                log.info("Asset dir created as {}".format(asset_path))
+            else:
+                log.info("Using existing asset folder {}".format(asset_path))
+
+            # Create asset thumbnails folder
+            asset_thumbnails_folder = os.path.join(asset_path, "thumbnail")
+            if not os.path.exists(asset_thumbnails_folder):
+                os.mkdir(asset_thumbnails_folder)
+                log.info("New thumbnails folder: {}".format(asset_thumbnails_folder))
+
+            # Create asset title folder
+            asset_titles_folder = os.path.join(asset_path, "title")
+            if not os.path.exists(asset_titles_folder):
+                os.mkdir(asset_titles_folder)
+                log.info("New titles folder: {}".format(asset_titles_folder))
+
+            # Create asset blender folder
+            asset_blender_folder = os.path.join(asset_path, "blender")
+            if not os.path.exists(asset_blender_folder):
+                os.mkdir(asset_blender_folder)
+                log.info("New blender folder: {}".format(asset_blender_folder))
+
+        return asset_path
+
+    except Exception as ex:
+        log.error("Error while getting/creating asset folder {}: {}".format(asset_path, ex))

src/classes/importers/edl.py

@@ -111,7 +111,6 @@ def create_clip(context, track):
     clip.data["file_id"] = file.id
     clip.data["title"] = context.get("clip_path", "")
     clip.data["layer"] = track.data.get("number", 1000000)
-    clip.data["image"] = thumb_path
     if video_ctx and not audio_ctx:
         # Only video
         clip.data["position"] = timecodeToSeconds(video_ctx.get("timeline_position", "00:00:00:00"), fps_num, fps_den)
@@ -280,4 +279,4 @@ def import_edl():
 
             # Update the preview and reselect current frame in properties
             get_app().window.refreshFrameSignal.emit()
-            get_app().window.propertyTableView.select_frame(get_app().window.preview_thread.player.Position())
+            get_app().window.propertyTableView.select_frame(get_app().window.preview_thread.player.Position())

src/classes/importers/final_cut_pro.py

@@ -153,7 +153,6 @@ def import_xml():
                     clip.data["file_id"] = file.id
                     clip.data["title"] = clip_element.getElementsByTagName("name")[0].childNodes[0].nodeValue
                     clip.data["layer"] = track.data.get("number", 1000000)
-                    clip.data["image"] = thumb_path
                     clip.data["position"] = float(clip_element.getElementsByTagName("start")[0].childNodes[0].nodeValue) / fps_float
                     clip.data["start"] = float(clip_element.getElementsByTagName("in")[0].childNodes[0].nodeValue) / fps_float
                     clip.data["end"] = float(clip_element.getElementsByTagName("out")[0].childNodes[0].nodeValue) / fps_float
@@ -196,4 +195,4 @@ def import_xml():
 
                 # Update the preview and reselect current frame in properties
                 get_app().window.refreshFrameSignal.emit()
-                get_app().window.propertyTableView.select_frame(get_app().window.preview_thread.player.Position())
+                get_app().window.propertyTableView.select_frame(get_app().window.preview_thread.player.Position())

src/classes/info.py

@@ -43,8 +43,8 @@
 HOME_PATH = os.path.join(os.path.expanduser("~"))
 USER_PATH = os.path.join(HOME_PATH, ".openshot_qt")
 BACKUP_PATH = os.path.join(USER_PATH)
+RECOVERY_PATH = os.path.join(USER_PATH, "recovery")
 BLENDER_PATH = os.path.join(USER_PATH, "blender")
-ASSETS_PATH = os.path.join(USER_PATH, "assets")
 RESOURCES_PATH =  os.path.join(PATH, "resources")
 THUMBNAIL_PATH = os.path.join(USER_PATH, "thumbnail")
 CACHE_PATH = os.path.join(USER_PATH, "cache")
@@ -60,8 +60,9 @@
 USER_DEFAULT_PROJECT = os.path.join(USER_PATH, "default.project")
 
 # Create PATHS if they do not exist (this is where temp files are stored... such as cached thumbnails)
-for folder in [USER_PATH, THUMBNAIL_PATH, CACHE_PATH, BLENDER_PATH, ASSETS_PATH, TITLE_PATH, PROFILES_PATH, IMAGES_PATH,
-               TRANSITIONS_PATH, EXPORT_TESTS, BACKUP_PATH, USER_PROFILES_PATH, USER_PRESETS_PATH, PREVIEW_CACHE_PATH]:
+for folder in [USER_PATH, THUMBNAIL_PATH, CACHE_PATH, BLENDER_PATH, TITLE_PATH, PROFILES_PATH, IMAGES_PATH,
+               TRANSITIONS_PATH, EXPORT_TESTS, BACKUP_PATH, USER_PROFILES_PATH, USER_PRESETS_PATH, PREVIEW_CACHE_PATH,
+               RECOVERY_PATH]:
     if not os.path.exists(folder.encode("UTF-8")):
         os.makedirs(folder, exist_ok=True)
 

src/classes/json_data.py

@@ -33,6 +33,7 @@
 import os
 import re
 
+from classes.assets import get_assets_path
 from classes.logger import log
 from classes import info
 
@@ -162,15 +163,19 @@ def replace_string_to_absolute(self, match):
 
         # Find absolute path of file (if needed)
         utf_path = json.loads('"%s"' % path, encoding="utf-8")  # parse bytestring into unicode string
-        if "@transitions" not in utf_path:
-            # Convert path to the correct relative path (based on the existing folder)
-            new_path = os.path.abspath(os.path.join(path_context.get("existing_project_folder", ""), utf_path))
+        if "@transitions" in utf_path:
+            new_path = path.replace("@transitions", os.path.join(info.PATH, "transitions"))
+            new_path = json.dumps(new_path)  # Escape backslashes
+            return '"%s": %s' % (key, new_path)
+
+        elif "@assets" in utf_path:
+            new_path = path.replace("@assets", path_context["new_project_assets"])
             new_path = json.dumps(new_path)  # Escape backslashes
             return '"%s": %s' % (key, new_path)
 
-        # Determine if @transitions path is found
         else:
-            new_path = path.replace("@transitions", os.path.join(info.PATH, "transitions"))
+            # Convert path to the correct relative path
+            new_path = os.path.abspath(os.path.join(path_context.get("new_project_folder", ""), utf_path))
             new_path = json.dumps(new_path)  # Escape backslashes
             return '"%s": %s' % (key, new_path)
 
@@ -180,6 +185,8 @@ def convert_paths_to_absolute(self, file_path, data):
             # Get project folder
             path_context["new_project_folder"] = os.path.dirname(file_path)
             path_context["existing_project_folder"] = os.path.dirname(file_path)
+            path_context["new_project_assets"] = get_assets_path(file_path, create_paths=False)
+            path_context["existing_project_assets"] = get_assets_path(file_path, create_paths=False)
 
             # Optimized regex replacement
             data = re.sub(path_regex, self.replace_string_to_absolute, data)
@@ -213,6 +220,16 @@ def replace_string_to_relative(self, match):
             new_path = json.dumps(new_path)  # Escape backslashes
             return '"%s": %s' % (key, new_path)
 
+        # Determine if @assets path is found
+        elif path_context["new_project_assets"] in folder_path:
+            # Yes, this is an OpenShot transitions
+            folder_path = folder_path.replace(path_context["new_project_assets"], "@assets")
+
+            # Convert path to @transitions/ path
+            new_path = os.path.join(folder_path, file_path).replace("\\", "/")
+            new_path = json.dumps(new_path)  # Escape backslashes
+            return '"%s": %s' % (key, new_path)
+
         # Find absolute path of file (if needed)
         else:
             # Convert path to the correct relative path (based on the existing folder)
@@ -232,9 +249,12 @@ def convert_paths_to_relative(self, file_path, previous_path, data):
         try:
             # Get project folder
             path_context["new_project_folder"] = os.path.dirname(file_path)
+            path_context["new_project_assets"] = get_assets_path(file_path, create_paths=False)
             path_context["existing_project_folder"] = os.path.dirname(file_path)
-            if previous_path:
+            path_context["existing_project_assets"] = get_assets_path(file_path, create_paths=False)
+            if previous_path and file_path != previous_path:
                 path_context["existing_project_folder"] = os.path.dirname(previous_path)
+                path_context["existing_project_assets"] = get_assets_path(previous_path, create_paths=False)
 
             # Optimized regex replacement
             data = re.sub(path_regex, self.replace_string_to_relative, data)