Editor sync handling

mergin/client.py

@@ -763,7 +763,7 @@ def set_project_access(self, project_path, access):
         :param project_path: project full name (<namespace>/<name>)
         :param access: dict <readersnames, editorsnames, writersnames, ownersnames> -> list of str username we want to give access to (editorsnames are only supported on servers at version 2024.4.0 or later)
         """
-        if "editorsnames" in access and not is_version_acceptable(self.server_version(), "2024.4"):
+        if "editorsnames" in access and not self.has_editor_support():
             raise NotImplementedError("Editors are only supported on servers at version 2024.4.0 or later")
 
         if not self._user_info:
@@ -790,7 +790,7 @@ def add_user_permissions_to_project(self, project_path, usernames, permission_le
         Editor permission_level is only supported on servers at version 2024.4.0 or later.
         """
         if permission_level not in ["owner", "reader", "writer", "editor"] or (
-            permission_level == "editor" and not is_version_acceptable(self.server_version(), "2024.4")
+            permission_level == "editor" and not self.has_editor_support()
         ):
             raise ClientError("Unsupported permission level")
 
@@ -1235,3 +1235,9 @@ def download_files(
         job = download_files_async(self, project_dir, file_paths, output_paths, version=version)
         pull_project_wait(job)
         download_files_finalize(job)
+
+    def has_editor_support(self):
+        """
+        Returns whether the server version is acceptable for editor support.
+        """
+        return is_version_acceptable(self.server_version(), "2024.4.0")

mergin/client_pull.py

@@ -22,7 +22,7 @@
 
 from .common import CHUNK_SIZE, ClientError
 from .merginproject import MerginProject
-from .utils import save_to_file, get_versions_with_file_changes
+from .utils import save_to_file
 
 
 # status = download_project_async(...)
@@ -340,7 +340,7 @@ def __init__(
         mp,
         project_info,
         basefiles_to_patch,
-        user_name,
+        mc,
     ):
         self.project_path = project_path
         self.pull_changes = (
@@ -358,7 +358,7 @@ def __init__(
         self.basefiles_to_patch = (
             basefiles_to_patch  # list of tuples (relative path within project, list of diff files in temp dir to apply)
         )
-        self.user_name = user_name
+        self.mc = mc
 
     def dump(self):
         print("--- JOB ---", self.total_size, "bytes")
@@ -494,7 +494,7 @@ def pull_project_async(mc, directory):
         mp,
         server_info,
         basefiles_to_patch,
-        mc.username(),
+        mc,
     )
 
     # start download
@@ -570,7 +570,7 @@ def merge(self):
             raise ClientError("Download of file {} failed. Please try it again.".format(self.dest_file))
 
 
-def pull_project_finalize(job):
+def pull_project_finalize(job: PullJob):
     """
     To be called when pull in the background is finished and we need to do the finalization (merge chunks etc.)
 
@@ -623,7 +623,7 @@ def pull_project_finalize(job):
             raise ClientError("Cannot patch basefile {}! Please try syncing again.".format(basefile))
 
     try:
-        conflicts = job.mp.apply_pull_changes(job.pull_changes, job.temp_dir, job.user_name)
+        conflicts = job.mp.apply_pull_changes(job.pull_changes, job.temp_dir, job.project_info, job.mc)
     except Exception as e:
         job.mp.log.error("Failed to apply pull changes: " + str(e))
         job.mp.log.info("--- pull aborted")
@@ -721,7 +721,7 @@ def download_diffs_async(mc, project_directory, file_path, versions):
         mp,
         server_info,
         {},
-        mc.username(),
+        mc,
     )
 
     # start download

mergin/client_push.py

@@ -18,6 +18,7 @@
 
 from .common import UPLOAD_CHUNK_SIZE, ClientError
 from .merginproject import MerginProject
+from .editor import filter_changes
 
 
 class UploadJob:
@@ -66,7 +67,11 @@ def upload_blocking(self, mc, mp):
             mp.log.debug(f"Uploading {self.file_path} part={self.chunk_index}")
 
             headers = {"Content-Type": "application/octet-stream"}
-            resp = mc.post("/v1/project/push/chunk/{}/{}".format(self.transaction_id, self.chunk_id), data, headers)
+            resp = mc.post(
+                "/v1/project/push/chunk/{}/{}".format(self.transaction_id, self.chunk_id),
+                data,
+                headers,
+            )
             resp_dict = json.load(resp)
             mp.log.debug(f"Upload finished: {self.file_path}")
             if not (resp_dict["size"] == len(data) and resp_dict["checksum"] == checksum.hexdigest()):
@@ -91,12 +96,12 @@ def push_project_async(mc, directory):
     mp.log.info(f"--- start push {project_path}")
 
     try:
-        server_info = mc.project_info(project_path)
+        project_info = mc.project_info(project_path)
     except ClientError as err:
         mp.log.error("Error getting project info: " + str(err))
         mp.log.info("--- push aborted")
         raise
-    server_version = server_info["version"] if server_info["version"] else "v0"
+    server_version = project_info["version"] if project_info["version"] else "v0"
 
     mp.log.info(f"got project info: local version {local_version} / server version {server_version}")
 
@@ -116,6 +121,7 @@ def push_project_async(mc, directory):
         )
 
     changes = mp.get_push_changes()
+    changes = filter_changes(mc, project_info, changes)
     mp.log.debug("push changes:\n" + pprint.pformat(changes))
 
     tmp_dir = tempfile.TemporaryDirectory(prefix="mergin-py-client-")
@@ -143,7 +149,11 @@ def push_project_async(mc, directory):
     data = {"version": local_version, "changes": changes}
 
     try:
-        resp = mc.post(f"/v1/project/push/{project_path}", data, {"Content-Type": "application/json"})
+        resp = mc.post(
+            f"/v1/project/push/{project_path}",
+            data,
+            {"Content-Type": "application/json"},
+        )
     except ClientError as err:
         mp.log.error("Error starting transaction: " + str(err))
         mp.log.info("--- push aborted")

mergin/editor.py

@@ -0,0 +1,109 @@
+from itertools import filterfalse
+from typing import Callable
+
+from .utils import is_mergin_config, is_qgis_file, is_versioned_file
+
+EDITOR_ROLE_NAME = "editor"
+
+"""
+Determines whether a given file change should be disallowed based on the file path.
+
+Returns:
+    bool: True if the file change should be disallowed, False otherwise.
+"""
+disallowed_added_changes: Callable[[dict], bool] = lambda change: is_qgis_file(change["path"]) or is_mergin_config(
+    change["path"]
+)
+"""
+Determines whether a given file change should be disallowed from being updated.
+
+The function checks the following conditions:
+- If the file path matches a QGIS file
+- If the file path matches a Mergin configuration file
+- If the file is versioned and the change does not have a diff
+
+Returns:
+    bool: True if the change should be disallowed, False otherwise.
+"""
+_disallowed_updated_changes: Callable[[dict], bool] = (
+    lambda change: is_qgis_file(change["path"])
+    or is_mergin_config(change["path"])
+    or (is_versioned_file(change["path"]) and change.get("diff") is None)
+)
+"""
+Determines whether a given file change should be disallowed from being removed.
+
+The function checks if the file path of the change matches any of the following conditions:
+- The file is a QGIS file (e.g. .qgs, .qgz)
+- The file is a Mergin configuration file (mergin-config.json)
+- The file is a versioned file (.gpkg, .sqlite)
+
+If any of these conditions are met, the change is considered disallowed from being removed.
+"""
+_disallowed_removed_changes: Callable[[dict], bool] = (
+    lambda change: is_qgis_file(change["path"]) or is_mergin_config(change["path"]) or is_versioned_file(change["path"])
+)
+
+
+def is_editor_enabled(mc, project_info: dict) -> bool:
+    """
+    The function checks if the server supports editor access, and if the current user's project role matches the expected role name for editors.
+    """
+    server_support = mc.has_editor_support()
+    project_role = project_info.get("role")
+
+    return server_support and project_role == EDITOR_ROLE_NAME
+
+
+def _apply_editor_filters(changes: dict[str, list[dict]]) -> dict[str, list[dict]]:
+    """
+    Applies editor-specific filters to the changes dictionary, removing any changes to files that are not in the editor's list of allowed files.
+
+    Args:
+        changes (dict[str, list[dict]]): A dictionary containing the added, updated, and removed changes.
+
+    Returns:
+        dict[str, list[dict]]: The filtered changes dictionary.
+    """
+    added = changes.get("added", [])
+    updated = changes.get("updated", [])
+    removed = changes.get("removed", [])
+
+    # filter out files that are not in the editor's list of allowed files
+    changes["added"] = list(filterfalse(disallowed_added_changes, added))
+    changes["updated"] = list(filterfalse(_disallowed_updated_changes, updated))
+    changes["removed"] = list(filterfalse(_disallowed_removed_changes, removed))
+    return changes
+
+
+def filter_changes(mc, project_info: dict, changes: dict[str, list[dict]]) -> dict[str, list[dict]]:
+    """
+    Filters the given changes dictionary based on the editor's enabled state.
+
+    If the editor is not enabled, the changes dictionary is returned as-is. Otherwise, the changes are passed through the `_apply_editor_filters` method to apply any configured filters.
+
+    Args:
+        changes (dict[str, list[dict]]): A dictionary mapping file paths to lists of change dictionaries.
+
+    Returns:
+        dict[str, list[dict]]: The filtered changes dictionary.
+    """
+    if not is_editor_enabled(mc, project_info):
+        return changes
+    return _apply_editor_filters(changes)
+
+
+def prevent_conflicted_copy(path: str, mc, project_info: dict) -> bool:
+    """
+    Decides whether a file path should be blocked from creating a conflicted copy.
+    Note: This is used when the editor is active and attempting to modify files (e.g., .ggs) that are also updated on the server, preventing unnecessary conflict files creation.
+
+    Args:
+        path (str): The file path to check.
+        mc: The Mergin client object.
+        project_info (dict): Information about the Mergin project from server.
+
+    Returns:
+        bool: True if the file path should be prevented from ceating conflicted copy, False otherwise.
+    """
+    return is_editor_enabled(mc, project_info) and any([is_qgis_file(path), is_mergin_config(path)])