Catch image decorator asset when packaging, provided it is relative to project folder

Author: nirvn

libqfieldsync/offline_converter.py

@@ -19,6 +19,7 @@
  ***************************************************************************/
 """
 
+import shutil
 import sys
 import tempfile
 from enum import Enum
@@ -53,7 +54,6 @@
 from .project import ProjectConfiguration, ProjectProperties
 from .utils.file_utils import (
     copy_attachments,
-    copy_multifile,
     set_relative_embed_layer_symbols_on_project,
 )
 from .utils.logger import logger
@@ -200,6 +200,10 @@ def _convert(self, project: QgsProject) -> None:
             xml_elements_to_preserve
         )
 
+        # Additional project files, such as image decoration, to be copied to the converted project
+        project_path = Path(project.fileName()).parent
+        additional_project_files = []
+
         # Create a new temporary `QgsProject` instance just to make sure that `theMapCanvas`
         # XML object is properly set within the XML document. Using a new `QgsProject`
         # instead of the singleton `QgsProject.instance()` allows using the read flags.
@@ -208,6 +212,25 @@ def _convert(self, project: QgsProject) -> None:
         tmp_project.read(tmp_project_filename, read_flags)
         tmp_project.readProject.disconnect(on_original_project_read)
 
+        # Insure the image decoration asset is copied if present and relative to the project path
+        image_decoration_path, _ = tmp_project.readEntry("Image", "/ImagePath", "")
+        if image_decoration_path:
+            image_decoration_path = Path(image_decoration_path)
+            if not image_decoration_path.is_absolute():
+                image_decoration_path = project_path.joinpath(
+                    image_decoration_path
+                ).resolve()
+
+            if image_decoration_path.is_file() and image_decoration_path.is_relative_to(
+                project_path
+            ):
+                additional_project_files.append(str(image_decoration_path))
+
+        # copy project plugin if present
+        plugin_file = Path("{}.qml".format(str(self.original_filename)[:-4]))
+        if plugin_file.exists():
+            additional_project_files.append(str(plugin_file))
+
         # NOTE force delete the `QgsProject`, otherwise the `QgsApplication` might be deleted by the time the project is garbage collected
         del tmp_project
 
@@ -315,6 +338,16 @@ def _convert(self, project: QgsProject) -> None:
 
         self._check_canceled()
 
+        # copy additional project files (e.g. layout images, symbology images, etc)
+        for additional_project_file in additional_project_files:
+            additional_project_file_path = Path(additional_project_file)
+            relative_path = additional_project_file_path.relative_to(project_path)
+            destination_file = self._export_filename.parent.joinpath(
+                relative_path
+            ).resolve()
+            destination_file.parent.mkdir(parents=True, exist_ok=True)
+            shutil.copy(additional_project_file, str(destination_file))
+
         # save the offline project twice so that the offline plugin can "know" that it's a relative path
         QgsProject.instance().write(str(export_project_filename))
 
@@ -337,15 +370,6 @@ def _convert(self, project: QgsProject) -> None:
                 Path(source_dir),
             )
 
-        # copy project plugin if present
-        plugin_file = Path("{}.qml".format(str(self.original_filename)[:-4]))
-        if plugin_file.exists():
-            self._check_canceled()
-
-            copy_multifile(
-                plugin_file, export_project_filename.parent.joinpath(plugin_file.name)
-            )
-
         if offline_layers:
             bbox = None
             if self.project_configuration.offline_copy_only_aoi: