subcommunities: create check config for project funding on request

accept

* Creates (or updates) the check config metadata rule when a
  subcommunity is accepted to the parent community.

Author: slint

site/zenodo_rdm/subcommunities/request.py

@@ -6,8 +6,11 @@
 # it under the terms of the MIT License; see LICENSE file for more details.
 """Subcommunities request implementation for ZenodoRDM."""
 
+from copy import deepcopy
+
 import invenio_communities.notifications.builders as notifications
 from invenio_access.permissions import system_identity
+from invenio_checks.models import CheckConfig, Severity
 from invenio_communities.proxies import current_communities
 from invenio_communities.subcommunities.services.request import (
     AcceptSubcommunity,
@@ -23,10 +26,11 @@
     current_community_records_service,
     current_rdm_records,
 )
-from invenio_records_resources.services.uow import RecordCommitOp
+from invenio_records_resources.services.uow import ModelCommitOp, RecordCommitOp
 from invenio_requests.customizations import actions
 from invenio_requests.customizations.event_types import CommentEventType
 from invenio_requests.proxies import current_events_service
+from invenio_vocabularies.contrib.awards.api import Award
 from marshmallow import fields
 
 
@@ -42,6 +46,80 @@ def _add_community_records(child_id, parent_id, uow):
     )
 
 
+FUNDING_RULE_TEMPLATE = {
+    "id": "funding:project",
+    "title": "Project Funding",
+    "message": "Submissions must have the __AWARD_ACRONYM__ (__AWARD_NUMBER__) grant/award",
+    "description": 'You are submitting to an EU project community for __AWARD_ACRONYM__ (__AWARD_NUMBER__) and you must therefore add the grant/award. <a href="/communities/eu/pages/open-science" target="_blank">Learn more</a>',
+    "level": "error",
+    "checks": [
+        {
+            "type": "list",
+            "operator": "any",
+            "path": "metadata.funding",
+            "predicate": {
+                "type": "comparison",
+                "left": {"type": "field", "path": "award.id"},
+                "operator": "==",
+                "right": None,
+            },
+        }
+    ],
+}
+
+
+def _add_subcommunity_funding_check(request, subcommunity, uow):
+    """Add a check to the subcommunity to ensure project funding is specified."""
+    project_id = request.get("payload", {}).get("project_id")
+    if not project_id:
+        return
+    # Resolve the project ID to get the award acronym and number
+    award = Award.pid.resolve(project_id)
+    award_acronym = award["acronym"]
+    award_number = award["number"]
+
+    # Update the award information in the rule template
+    funding_rule = deepcopy(FUNDING_RULE_TEMPLATE)
+
+    funding_rule["checks"][0]["predicate"]["right"] = project_id
+    message = funding_rule["message"]
+    message = message.replace("__AWARD_ACRONYM__", award_acronym)
+    message = message.replace("__AWARD_NUMBER__", award_number)
+    funding_rule["message"] = message
+
+    description = funding_rule["description"]
+    description = description.replace("__AWARD_ACRONYM__", award_acronym)
+    description = description.replace("__AWARD_NUMBER__", award_number)
+    funding_rule["description"] = description
+
+    # Create or update the check config on the subcommunity
+    check_config = CheckConfig.query.filter_by(
+        community_id=subcommunity.id, check_id="metadata"
+    ).one_or_none()
+    if check_config:
+        params = check_config.params or {}
+        rules = params.get("rules", [])
+        for rule in rules:
+            if rule["id"] == funding_rule["id"]:
+                rule.update(funding_rule)
+                break
+        else:  # If the rule was not found, append it
+            rules.append(funding_rule)
+        params["rules"] = rules
+
+        # Set the field on the model to trigger an UPDATE
+        check_config.params = params
+    else:
+        check_config = CheckConfig(
+            community_id=subcommunity.id,
+            check_id="metadata",
+            params={"rules": [funding_rule]},
+            severity=Severity.INFO,
+            enabled=True,
+        )
+    uow.register(ModelCommitOp(check_config))
+
+
 def _update_subcommunity_funding(request, subcommunity, uow):
     """Update the subcommunity funding metadata."""
     project_id = request.get("payload", {}).get("project_id")
@@ -67,15 +145,17 @@ class SubcommunityAcceptAction(AcceptSubcommunity):
 
     def execute(self, identity, uow):
         """Execute approve action."""
-        to_be_moved = self.request.topic.resolve().id
-        move_to = self.request.receiver.resolve().id
+        subcommunity = self.request.topic.resolve()
+        parent = self.request.receiver.resolve()
+
+        _add_community_records(subcommunity.id, parent.id, uow)
+        _add_subcommunity_funding_check(self.request, subcommunity, uow)
 
-        _add_community_records(to_be_moved, move_to, uow)
         super().execute(identity, uow)
 
 
 class SubcommunityCreateAction(actions.CreateAndSubmitAction):
-    """Represents an create action used to create a subcommunity request.
+    """Represents a create action used to create a subcommunity request.
 
     Zenodo re-implementation of the create action, to also create the system comment.
     """
@@ -94,7 +174,7 @@ def execute(self, identity, uow):
             payload={
                 "content": f"""
             <p>
-            We have created your community for your project <a href='/communities/{subcommunity.slug}'>{subcommunity['metadata']['title']}</a>.
+            We have created your community for your project <a href='/communities/{subcommunity.slug}'>{subcommunity["metadata"]["title"]}</a>.
             </p>
 
             <p>
@@ -192,6 +272,7 @@ def execute(self, identity, uow):
 
         _add_community_records(child.id, parent.id, uow)
         _update_subcommunity_funding(self.request, child, uow)
+        _add_subcommunity_funding_check(self.request, child, uow)
         # moving the community is handled by super()
 
         super().execute(identity, uow)
@@ -212,6 +293,7 @@ def execute(self, identity, uow):
         )
 
         _update_subcommunity_funding(self.request, child, uow)
+        _add_subcommunity_funding_check(self.request, child, uow)
 
         super().execute(identity, uow)