Merge pull request #108 from opengisch/QF-1844-Adding-check-when-the-source-is-relative-to-project-home

Ensure the layer SVG or raster symbols are within the project directory or embedd otherwise

Author: SeqLaz

libqfieldsync/offline_converter.py

@@ -54,7 +54,7 @@
 from .utils.file_utils import (
     copy_attachments,
     copy_multifile,
-    embed_layer_symbols_on_project,
+    set_relative_embed_layer_symbols_on_project,
 )
 from .utils.logger import logger
 from .utils.qgis import make_temp_qgis_file, open_project
@@ -306,9 +306,6 @@ def _convert(self, project: QgsProject) -> None:
             elif layer_action == SyncAction.REMOVE:
                 project.removeMapLayer(layer)
 
-            # Change symbol path to embedded marker
-            embed_layer_symbols_on_project(layer)
-
         self.remove_empty_groups_from_layer_tree_group(project.layerTreeRoot())
 
         export_project_filename = self._export_filename
@@ -379,6 +376,11 @@ def _convert(self, project: QgsProject) -> None:
             # Disable project options that could create problems on a portable
             # project with offline layers
             self.post_process_offline_layers()
+        # Change SVG and Raster symbols path to relative or embedded
+        for layer in QgsProject.instance().mapLayers().values():
+            set_relative_embed_layer_symbols_on_project(
+                layer, self.original_filename.parent, self._export_filename.parent
+            )
 
         self._check_canceled()
 

libqfieldsync/utils/file_utils.py

@@ -31,14 +31,14 @@
 from typing import List, Optional, Tuple, Union
 
 from qgis.core import (
+    Qgis,
     QgsCategorizedSymbolRenderer,
     QgsRasterMarkerSymbolLayer,
     QgsRuleBasedRenderer,
     QgsSingleSymbolRenderer,
     QgsSvgMarkerSymbolLayer,
     QgsSymbol,
     QgsVectorLayer,
-    QgsWkbTypes,
 )
 from qgis.PyQt.QtCore import QCoreApplication
 
@@ -229,11 +229,15 @@ def is_valid_filepath(path: str) -> bool:
     return True
 
 
-def update_symbols_to_embedded(symbol: QgsSymbol) -> None:
+def update_symbols_to_relative_embedded(
+    symbol: QgsSymbol, home_path: Path, destination_path: Path
+) -> None:
     """
-    Update SVG or Raster symbols layer to embed it in the QGIS project.
+    Update SVG or Raster symbols layer to relative path or embed it in the QGIS project.
     Args:
         symbol: The QGIS symbol (from a renderer).
+        home_path: The root of QGIS Project home path.
+        destination_path: The target directory where the exported project will be saved.
     """
     if symbol is None:
         return
@@ -255,23 +259,47 @@ def update_symbols_to_embedded(symbol: QgsSymbol) -> None:
         if not source_path.is_file():
             continue
 
-        with open(source_path, "rb") as file:
-            file_data = file.read()
-            encoded_data = base64.b64encode(file_data).decode()
+        if source_path.is_relative_to(home_path):
+            relative_path = source_path.relative_to(home_path)
+            destination_path_file = destination_path.joinpath(relative_path)
+
+            if destination_path_file.exists():
+                symbol_layer.setPath(str(relative_path))
+            else:
+                encoded_data = base64.b64encode(source_path.read_bytes()).decode()
+                symbol_layer.setPath(f"base64:{encoded_data}")
+
+        else:
+            encoded_data = base64.b64encode(source_path.read_bytes()).decode()
             symbol_layer.setPath(f"base64:{encoded_data}")
 
 
-def embed_layer_symbols_on_project(layer: QgsVectorLayer) -> None:
+def set_relative_embed_layer_symbols_on_project(
+    layer: QgsVectorLayer, project_home: Path, export_project_path: Path
+) -> None:
     """
-    Update the paths of symbols to embedded symbols in the QGIS project.
+    Update the layer style SVG or Raster symbol paths to relative or embedded them in the QGIS project file.
+
+    First try to ensure the paths are within to the QGIS project path.
+    If the resulting path is impossible, then embed the symbols in the QGIS project.
 
     Args:
         layer: The QgsVectorLayer to update.  The layer is a point layer.
+        project_home: The root of QGIS Project home path.
+        export_project_path: The target directory for the exported offline QGIS project.
     """
 
+    if Qgis.QGIS_VERSION_INT >= 33000:
+        point_geometry = Qgis.GeometryType.Point
+    else:
+        from qgis.core import QgsWkbTypes
+
+        point_geometry = QgsWkbTypes.GeometryType.PointGeometry
+
     if (
-        not isinstance(layer, QgsVectorLayer)
-        or layer.geometryType() != QgsWkbTypes.PointGeometry
+        not layer.isValid()
+        or not isinstance(layer, QgsVectorLayer)
+        or layer.geometryType() != point_geometry
     ):
         return
 
@@ -283,7 +311,9 @@ def embed_layer_symbols_on_project(layer: QgsVectorLayer) -> None:
     if isinstance(renderer, QgsSingleSymbolRenderer):
         symbol = renderer.symbol()
         if symbol:
-            update_symbols_to_embedded(symbol=symbol)
+            update_symbols_to_relative_embedded(
+                symbol, project_home, export_project_path
+            )
 
     elif isinstance(renderer, QgsRuleBasedRenderer):
         for rule in renderer.rootRule().children():
@@ -293,16 +323,23 @@ def embed_layer_symbols_on_project(layer: QgsVectorLayer) -> None:
                 continue
 
             for symbol in symbols:
-                update_symbols_to_embedded(symbol=symbol)
+                update_symbols_to_relative_embedded(
+                    symbol, project_home, export_project_path
+                )
 
     elif isinstance(renderer, QgsCategorizedSymbolRenderer):
         categories = renderer.categories()
         if categories:
             for index in range(len(categories)):
-                # Get a fresh category.  The renderer doesn't update in-place modifications.
+                # Get a fresh category.
+                # The renderer doesn't update in-place modifications on categorized.
                 category = renderer.categories()[index]
                 symbol = category.symbol().clone()
-                update_symbols_to_embedded(symbol=symbol)
+
+                update_symbols_to_relative_embedded(
+                    symbol, project_home, export_project_path
+                )
+
                 renderer.updateCategorySymbol(index, symbol)
 
     layer.setRenderer(renderer)