Add possibility to lock a project

- add column to project table
- block push
- do not count to workspace storage and project number

Author: harminius

server/mergin/sync/models.py

@@ -16,7 +16,6 @@
 from pygeodiff import GeoDiff
 from sqlalchemy import text, null, desc, nullslast
 from sqlalchemy.dialects.postgresql import ARRAY, BIGINT, UUID, JSONB, ENUM
-from sqlalchemy.orm.attributes import flag_modified
 from sqlalchemy.types import String
 from sqlalchemy.ext.hybrid import hybrid_property
 from pygeodiff.geodifflib import GeoDiffLibError
@@ -68,6 +67,7 @@ class Project(db.Model):
         db.Integer, db.ForeignKey("user.id"), nullable=True, index=True
     )
     public = db.Column(db.Boolean, default=False, index=True, nullable=False)
+    locked_until = db.Column(db.DateTime, index=True)
 
     creator = db.relationship(
         "User", uselist=False, backref=db.backref("projects"), foreign_keys=[creator_id]
@@ -88,6 +88,7 @@ def __init__(
         self.creator = creator
         self.latest_version = 0
         self.public = kwargs.get("public", False)
+        self.locked_until = None
         latest_files = LatestProjectFiles(project=self)
         db.session.add(latest_files)
 

server/mergin/sync/private_api_controller.py

@@ -6,11 +6,10 @@
 from flask import render_template, request, current_app, jsonify, abort
 from flask_login import current_user
 from sqlalchemy.orm import defer
-from sqlalchemy import text, and_, desc, asc
+from sqlalchemy import text
 
 from ..app import db
 from ..auth import auth_required
-from ..auth.models import User, UserProfile
 from .forms import AccessPermissionForm
 from .models import (
     Project,
@@ -22,7 +21,6 @@
     ProjectListSchema,
     ProjectAccessRequestSchema,
     AdminProjectSchema,
-    ProjectAccessSchema,
     ProjectAccessDetailSchema,
 )
 from .permissions import (

server/mergin/sync/public_api_controller.py

@@ -785,6 +785,11 @@ def project_push(namespace, project_name):
     changes = request.json["changes"]
     project_permission = current_app.project_handler.get_push_permission(changes)
     project = require_project(namespace, project_name, project_permission)
+    if project.locked_until:
+        abort(
+            423,
+            f"This project is currently locked. You cannot make changes to it until {project.locked_until.strftime('%Y-%m-%d %H:%M UTC')}.",
+        )
     # pass full project object to request for later use
     request.view_args["project"] = project
     ws = project.workspace
@@ -1027,6 +1032,11 @@ def push_finish(transaction_id):
         upload.changes
     )
     project = upload.project
+    if project.locked_until:
+        abort(
+            423,
+            f"This project is currently locked. You cannot make changes to it until {project.locked_until.strftime('%Y-%m-%d %H:%M UTC')}.",
+        )
     project_path = get_project_path(project)
     corrupted_files = []
 

server/mergin/sync/workspace.py

@@ -5,7 +5,7 @@
 from datetime import datetime, timedelta, timezone
 from typing import Dict, Tuple, Optional, Set, List
 from flask_login import current_user
-from sqlalchemy import Column, literal, extract
+from sqlalchemy import Column, literal, extract, and_
 from sqlalchemy.sql.operators import is_
 
 from .errors import UpdateProjectAccessError
@@ -66,7 +66,7 @@ def disk_usage(self):
 
         projects_usage_list = (
             db.session.query(Project.disk_usage)
-            .filter(Project.removed_at.is_(None))
+            .filter(Project.removed_at.is_(None), Project.locked_until.is_(None))
             .all()
         )
         return sum(p.disk_usage for p in projects_usage_list)
@@ -107,8 +107,11 @@ def project_count(self):
 
         return (
             db.session.query(Project.disk_usage)
-            .filter(Project.workspace_id == self.id)
-            .filter(Project.removed_at.is_(None))
+            .filter(
+                Project.workspace_id == self.id,
+                Project.removed_at.is_(None),
+                Project.locked_until.is_(None),
+            )
             .count()
         )
 

server/mergin/tests/test_project_controller.py

@@ -2621,3 +2621,33 @@ def test_supported_file_upload(client):
         resp.json["detail"]
         == f"Unsupported file type detected: {spoof_name}. Please remove the file or try compressing it into a ZIP file before uploading."
     )
+
+
+def test_locked_project(client, diff_project):
+    """Users cannot push to the locked project. Moreover, it does not count to the storage and project count67"""
+    # before project is locked
+    orig_p_count = diff_project.workspace.project_count()
+    orig_storage = diff_project.workspace.disk_usage()
+    # after locking the project
+    diff_project.locked_until = datetime.datetime.utcnow() + datetime.timedelta(
+        weeks=26
+    )
+    db.session.commit()
+    assert diff_project.workspace.project_count() == orig_p_count - 1
+    assert diff_project.workspace.disk_usage() == orig_storage - diff_project.disk_usage
+    # push is not possible to the locked project
+    changes = _get_changes_without_added(test_project_dir)
+    project_path = get_project_path(diff_project)
+    data = {"version": "v1", "changes": changes}
+    resp = client.post(
+        f"/v1/project/push/{project_path}",
+        data=json.dumps(data, cls=DateTimeEncoder).encode("utf-8"),
+        headers=json_headers,
+    )
+    assert resp.status_code == 423
+    # to play safe push finish is also blocked
+    upload, upload_dir = create_transaction("mergin", changes)
+    url = "/v1/project/push/finish/{}".format(upload.id)
+
+    resp = client.post(url, headers=json_headers)
+    assert resp.status_code == 423