Big refactoring number 2

- Clean separation between GUI, core functions and manager in-between
- Data source discovery rules in dataclasses with proper regexes
- Transfer of data sources via stored data
- Remove unnecessary path twiddling based on OS
- Use pathlib everywhere possible
- Less classes more functions #42
- Lots of renamings for clarity
- Qt6 compatible enums
- ...

Author: jk-wg

README.md

@@ -33,8 +33,9 @@ To install the plugin manually just copy the folder into your QGIS profile direc
 - Importing (spatial) bookmarks
 - Importing (data source) favourites
 - Importing plugins
-- Importing expression functions
-- Importing models & scripts
+- Importing expressions
+- Importing models
+- Importing scripts
 - Importing some symbology types & label settings
 - Importing QGIS UI settings (e.g. hidden toolbar items)
 

profile_manager/datasources/bookmarks.py

@@ -0,0 +1,74 @@
+from pathlib import Path
+
+from lxml import etree as et
+
+
+def import_bookmarks(source_bookmark_file: Path, target_bookmark_file: Path):
+    """Imports spatial bookmarks from source to target file.
+
+    Spatial bookmarks are stored in bookmarks.xml, e.g.:
+    <Bookmarks>
+        <Bookmark id="..." group="" extent="POLYGON((...))" name="Test Bookmark">
+            <spatialrefsys nativeFormat="Wkt">
+            ...
+            </spatialrefsys>
+        </Bookmark>
+        ...
+    </Bookmarks>
+
+    TODO The deduplication seems garbage
+
+    Args:
+        source_bookmark_file: Path of bookmarks file to import from
+        target_bookmark_file: Path of bookmarks file to import to
+    """
+    # get the element tree of the source file
+    source_tree = et.parse(source_bookmark_file, et.XMLParser(remove_blank_text=True))
+
+    # check if target file exists
+    if not target_bookmark_file.is_file():
+        with open(target_bookmark_file, "w") as new_file:
+            new_file.write("<Bookmarks></Bookmarks>")
+
+    # get the element tree of the target file
+    # fill if empty
+    target_tree = et.parse(target_bookmark_file, et.XMLParser(remove_blank_text=True))
+
+    # find all bookmark elements
+    source_root_tag = source_tree.findall("Bookmark")
+
+    # get the root element "Bookmarks"  # TODO comment does not seem to fit the code?
+    target_tree_root = target_tree.getroot()
+
+    # Remove duplicate entries to prevent piling data
+    target_tree_root = remove_duplicates(source_root_tag, target_tree, target_tree_root)
+
+    # append the elements
+    for element in source_root_tag:
+        target_tree_root.append(element)
+
+    # overwrite the xml file
+    et.ElementTree(target_tree_root).write(
+        target_bookmark_file,
+        pretty_print=True,
+        encoding="utf-8",
+        xml_declaration=True,
+    )
+
+
+def remove_duplicates(
+    source_root_tag: list[et.Element],
+    target_tree: et.ElementTree,
+    target_tree_root: et.Element,
+):
+    """Removes bookmarks from target that exist in the (to be imported) source too."""
+    # TODO FIXME this only checks the name of the bookmarks which will lead to false positives
+    #            it is ok and supported by QGIS to have the same name for multiple bookmarks
+    #            TODO compare the complete content of the xml node!
+    target_root_tag = target_tree.findall("Bookmark")
+    for source_element in source_root_tag:
+        for target_element in target_root_tag:
+            if source_element.attrib["name"] == target_element.attrib["name"]:
+                target_tree_root.remove(target_element)
+
+    return target_tree_root

profile_manager/datasources/bookmarks/__init__.py

@@ -1,11 +1,9 @@
 from configparser import RawConfigParser
-from os import path
+from pathlib import Path
 from shutil import copy2
 
-from profile_manager.utils import adjust_to_operating_system
 
-
-def import_customizations(source_profile_path: str, target_profile_path: str):
+def import_customizations(source_profile_path: Path, target_profile_path: Path):
     """Imports UI customizations from source to target profile.
 
     Copies the whole QGISCUSTOMIZATION3.ini file and also transfers the [UI] section from QGIS3.ini if available
@@ -19,25 +17,18 @@ def import_customizations(source_profile_path: str, target_profile_path: str):
     ...
 
     Args:
-        TODO
+        source_profile_path: Path of profile directory to import from
+        target_profile_path: Path of profile directory to import to
     """
     # Copy (overwrite) the QGISCUSTOMIZATION3.ini if exist
-    source_customini_path = adjust_to_operating_system(
-        source_profile_path + "QGIS/QGISCUSTOMIZATION3.ini"
-    )
-    target_customini_path = adjust_to_operating_system(
-        target_profile_path + "QGIS/QGISCUSTOMIZATION3.ini"
-    )
-    if path.exists(source_customini_path):
+    source_customini_path = source_profile_path / "QGIS" / "QGISCUSTOMIZATION3.ini"
+    target_customini_path = target_profile_path / "QGIS" / "QGISCUSTOMIZATION3.ini"
+    if source_customini_path.exists():
         copy2(source_customini_path, target_customini_path)
 
     # Copy [UI] section from QGIS3.ini
-    source_qgis3ini_path = adjust_to_operating_system(
-        source_profile_path + "QGIS/QGIS3.ini"
-    )
-    target_qgis3ini_path = adjust_to_operating_system(
-        target_profile_path + "QGIS/QGIS3.ini"
-    )
+    source_qgis3ini_path = source_profile_path / "QGIS" / "QGIS3.ini"
+    target_qgis3ini_path = target_profile_path / "QGIS" / "QGIS3.ini"
 
     source_ini_parser = RawConfigParser()
     source_ini_parser.optionxform = str  # str = case-sensitive option names