Adding the functionality to copy the symbology raster and SVG to a

relative given path

Author: SeqLaz

libqfieldsync/offline_converter.py

@@ -49,7 +49,11 @@
 from .layer import LayerSource, SyncAction
 from .offliners import BaseOffliner
 from .project import ProjectConfiguration, ProjectProperties
-from .utils.file_utils import copy_attachments, copy_multifile
+from .utils.file_utils import (
+    copy_attachments,
+    copy_multifile,
+    update_symbol_to_project_assets,
+)
 from .utils.logger import logger
 from .utils.qgis import make_temp_qgis_file, open_project
 from .utils.xml import get_themapcanvas
@@ -280,6 +284,8 @@ def _convert(self, project: QgsProject) -> None:
             elif layer_action == SyncAction.REMOVE:
                 project.removeMapLayer(layer)
 
+            update_symbol_to_project_assets(layer, self._export_filename.parent)
+
         self.remove_empty_groups_from_layer_tree_group(project.layerTreeRoot())
 
         export_project_filename = self._export_filename

libqfieldsync/utils/file_utils.py

@@ -29,6 +29,16 @@
 from pathlib import Path
 from typing import List, Optional, Tuple, Union
 
+from qgis.core import (
+    QgsCategorizedSymbolRenderer,
+    QgsProject,
+    QgsRasterMarkerSymbolLayer,
+    QgsRuleBasedRenderer,
+    QgsSingleSymbolRenderer,
+    QgsSvgMarkerSymbolLayer,
+    QgsVectorLayer,
+    QgsWkbTypes,
+)
 from qgis.PyQt.QtCore import QCoreApplication
 
 from .exceptions import NoProjectFoundError, QFieldSyncError
@@ -216,3 +226,85 @@ def is_valid_filepath(path: str) -> bool:
             return False
 
     return True
+
+
+def update_symbol_to_project_assets(
+    layer: QgsVectorLayer, new_path: Optional[Path] = None
+) -> None:
+    """
+    Updates the paths of symbols to a relative QGIS project
+    """
+
+    if (
+        not isinstance(layer, QgsVectorLayer)
+        or layer.geometryType() != QgsWkbTypes.PointGeometry
+    ):
+        return
+
+    renderer = layer.renderer()
+
+    if not renderer:
+        return
+
+    if new_path is None:
+        project = QgsProject.instance()
+        project_home = project.homePath()
+        new_path = Path(project_home)
+    destination_dir = new_path / "assets"
+    destination_dir.mkdir(parents=True, exist_ok=True)
+
+    def update_symbol_path_assets(symbol):
+        """Updates the path of a symbol layer."""
+        if symbol is None:
+            return
+
+        for symbol_layer in symbol.symbolLayers():
+            if isinstance(
+                symbol_layer, (QgsSvgMarkerSymbolLayer, QgsRasterMarkerSymbolLayer)
+            ):
+                source_path = Path(symbol_layer.path())
+
+                try:
+                    source_path.relative_to(new_path)
+                    continue
+                except ValueError:
+                    # Proceed with copying
+                    pass
+
+                if source_path.exists():
+                    destination_path_file = destination_dir / source_path.name
+
+                    if not destination_path_file.exists():
+                        shutil.copy2(source_path, destination_path_file)
+
+                    symbol_layer.setPath(
+                        str(destination_path_file.relative_to(new_path))
+                    )
+
+            elif hasattr(symbol_layer, "subSymbol"):
+                update_symbol_path_assets(
+                    symbol_layer.subSymbol()
+                )  # Recursively for nested symbology
+
+    if isinstance(renderer, QgsSingleSymbolRenderer):
+        symbol = renderer.symbol()
+        if symbol:
+            update_symbol_path_assets(symbol)
+
+    elif isinstance(renderer, QgsRuleBasedRenderer):
+        for rule in renderer.rootRule().children():
+            if rule.symbol():
+                update_symbol_path_assets(rule.symbol())
+
+    elif isinstance(renderer, QgsCategorizedSymbolRenderer):
+        categories = renderer.categories()
+        if categories:
+            for index in range(len(categories)):
+                # Get a fresh category object each time,
+                # if not the new symbol path is not updated.
+                category = renderer.categories()[index]
+                symbol = category.symbol().clone()
+                update_symbol_path_assets(symbol)
+                renderer.updateCategorySymbol(index, symbol)
+
+    layer.setRenderer(renderer)