From 84c3779376b5bd8428716a218bda6f71c8452503 Mon Sep 17 00:00:00 2001
From: Ducica <34883098+Ducica@users.noreply.github.com>
Date: Fri, 22 Nov 2024 10:25:05 +0100
Subject: [PATCH] cached deposit page view permissions to session (#257)

* cached deposit page view permissions to session

* reduced cognitive complexity of permission checking func

* permission to view deposit page  returns false in case user is not logged in

* added typing
---
 oarepo_ui/ext.py   |   5 +++
 oarepo_ui/utils.py | 105 ++++++++++++++++++++++++++++++++++++++++++++-
 setup.cfg          |   2 +-
 3 files changed, 109 insertions(+), 3 deletions(-)

diff --git a/oarepo_ui/ext.py b/oarepo_ui/ext.py
index af9cfa82..90920cbe 100644
--- a/oarepo_ui/ext.py
+++ b/oarepo_ui/ext.py
@@ -5,6 +5,9 @@
 from flask import Response, current_app
 from importlib_metadata import entry_points
 from invenio_base.utils import obj_or_import_string
+from flask_login import user_logged_in, user_logged_out
+from .utils import clear_view_deposit_page_permission_from_session
+
 
 import oarepo_ui.cli  # noqa
 from oarepo_ui.resources.templating.catalog import OarepoCatalog as Catalog
@@ -90,6 +93,8 @@ def __init__(self, app=None):
     def init_app(self, app):
         self.init_config(app)
         app.extensions["oarepo_ui"] = OARepoUIState(app)
+        user_logged_in.connect(clear_view_deposit_page_permission_from_session)
+        user_logged_out.connect(clear_view_deposit_page_permission_from_session)
 
     def init_config(self, app):
         """Initialize configuration."""
diff --git a/oarepo_ui/utils.py b/oarepo_ui/utils.py
index 3bbff477..a8a49644 100644
--- a/oarepo_ui/utils.py
+++ b/oarepo_ui/utils.py
@@ -1,9 +1,58 @@
+"""Oarepo ui utils module."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Optional, overload
+
+from flask import current_app, g, session
+from flask_login import current_user
+from invenio_base.utils import obj_or_import_string
 from marshmallow import Schema, fields
 from marshmallow.schema import SchemaMeta
 from marshmallow_utils.fields import NestedAttribute
 
+if TYPE_CHECKING:
+    from invenio_records_resources.services.records import RecordService
+
+
+@overload
+def dump_empty(schema_or_field: Schema) -> dict: ...
+
+
+@overload
+def dump_empty(schema_or_field: SchemaMeta) -> dict: ...
+
+
+@overload
+def dump_empty(schema_or_field: fields.List) -> list: ...
+
+
+@overload
+def dump_empty(schema_or_field: fields.Nested | NestedAttribute) -> dict: ...
+
+
+@overload
+def dump_empty(schema_or_field: fields.Str) -> str: ...
+
+
+@overload
+def dump_empty(schema_or_field: fields.Dict) -> dict: ...
+
 
-def dump_empty(schema_or_field):
+@overload
+def dump_empty(schema_or_field: object) -> None: ...
+
+
+def dump_empty(
+    schema_or_field: Schema
+    | SchemaMeta
+    | fields.List
+    | fields.Nested
+    | NestedAttribute
+    | fields.Str
+    | fields.Dict
+    | object,
+) -> dict | list | str | None:
     """Return a full json-compatible dict of schema representation with empty values."""
     if isinstance(schema_or_field, (Schema,)):
         schema = schema_or_field
@@ -15,7 +64,6 @@ def dump_empty(schema_or_field):
         schema = schema_or_field()
         return {k: dump_empty(v) for (k, v) in schema.fields.items()}
     if isinstance(schema_or_field, fields.List):
-        # return [dump_empty(schema_or_field.inner)]
         return []
     if isinstance(schema_or_field, (NestedAttribute, fields.Nested)):
         field = schema_or_field
@@ -28,3 +76,56 @@ def dump_empty(schema_or_field):
     if isinstance(schema_or_field, fields.Dict):
         return {}
     return None
+
+
+view_deposit_page_permission_key: str = "view_deposit_page_permission"
+
+
+def can_view_deposit_page() -> bool:
+    """Check if the current user can view the deposit page."""
+    permission_to_deposit: bool = False
+
+    if not current_user.is_authenticated:
+        return False
+
+    if view_deposit_page_permission_key in session:
+        return bool(session[view_deposit_page_permission_key])
+
+    repository_search_resources: list[dict[str, str]] = current_app.config.get(
+        "GLOBAL_SEARCH_MODELS", []
+    )
+
+    if not repository_search_resources:
+        return False
+
+    for search_resource in repository_search_resources:
+        search_resource_service: Optional[str] = search_resource.get(
+            "model_service", None
+        )
+        search_resource_config: Optional[str] = search_resource.get(
+            "service_config", None
+        )
+
+        if search_resource_service and search_resource_config:
+            try:
+                service_def: Any = obj_or_import_string(search_resource_service)
+                service_cfg: Any = obj_or_import_string(search_resource_config)
+
+                # Instantiate service and check permission
+                service: RecordService = service_def(service_cfg())
+                permission_to_deposit = service.check_permission(
+                    g.identity, "view_deposit_page", record=None
+                )
+                if permission_to_deposit:
+                    break
+            except ImportError:
+                continue
+
+    # Cache permission result in session
+    session[view_deposit_page_permission_key] = permission_to_deposit
+    return permission_to_deposit
+
+
+def clear_view_deposit_page_permission_from_session(*args: Any, **kwargs: Any) -> None:
+    """Clear the cached permission for viewing the deposit page from the session."""
+    session.pop(view_deposit_page_permission_key, None)
diff --git a/setup.cfg b/setup.cfg
index 06abe68e..3dd59e07 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-ui
-version = 5.2.26
+version = 5.2.27
 description = UI module for invenio 3.5+
 long_description = file: README.md
 long_description_content_type = text/markdown