clc: add clc sync message

Author: jrcastro2

assets/js/components/record_details/clc_sync.js

@@ -21,7 +21,6 @@ export class CLCSync extends Component {
       clcSyncRecord: null,
       loading: false,
       error: null,
-      synced: null,
       autoSync: null,
       showSuccess: false,
     };
@@ -30,6 +29,7 @@ export class CLCSync extends Component {
   get shouldRenderComponent() {
     const { record, permissions } = this.props;
     const recordManagementAppDiv = document.getElementById("recordManagement");
+
     const allowedResourceTypes = JSON.parse(
       recordManagementAppDiv.dataset.allowedResourceTypes
     );
@@ -41,36 +41,21 @@ export class CLCSync extends Component {
     return isTypeAllowed && permissions.can_moderate;
   }
 
-  fetchSyncRecord = async () => {
-    const { record } = this.props;
-    try {
-      this.cancellableRequest = withCancel(
-        http.get(`/api/clc/${record.parent.id}`)
-      );
-      const response = await this.cancellableRequest.promise;
-      const data = response.data;
-      if (data) {
-        this.setState({
-          synced: true,
-          clcSyncRecord: data,
-          autoSync: data.auto_sync,
-        });
-      }
-    } catch (error) {
-      this.setState({ synced: false });
-    }
-  };
-
   componentWillUnmount() {
     if (this.cancellableRequest) {
       this.cancellableRequest.cancel();
     }
   }
 
   componentDidMount() {
-    if (this.shouldRenderComponent) {
-      this.fetchSyncRecord();
-    }
+    const recordManagementAppDiv = document.getElementById("recordManagement");
+    const clcSyncRecord = JSON.parse(
+      recordManagementAppDiv.dataset.clcSyncEntry
+    );
+    this.setState({
+      clcSyncRecord: clcSyncRecord,
+      autoSync: clcSyncRecord.auto_sync,
+    });
   }
 
   syncWithCLC = async (payload, existingId = null) => {
@@ -121,7 +106,6 @@ export class CLCSync extends Component {
       this.setState({
         autoSync: clcRecordData.auto_sync,
         clcSyncRecord: clcRecordData,
-        synced: true,
       });
       this.setSuccessMessage();
     } catch (error) {
@@ -149,7 +133,6 @@ export class CLCSync extends Component {
       this.setState({
         autoSync: clcRecordData.auto_sync,
         clcSyncRecord: clcRecordData,
-        synced: newAutoSync,
       });
       if (newAutoSync) {
         this.setSuccessMessage();
@@ -183,8 +166,7 @@ export class CLCSync extends Component {
   };
 
   render() {
-    const { error, loading, synced, autoSync, clcSyncRecord } = this.state;
-    const { record, permissions } = this.props;
+    const { error, loading, autoSync, clcSyncRecord } = this.state;
 
     if (!this.shouldRenderComponent) {
       return null;
@@ -221,7 +203,7 @@ export class CLCSync extends Component {
             icon
             size="tiny"
             loading={loading}
-            disabled={loading || !synced}
+            disabled={loading || !autoSync}
             onClick={this.handleClick}
             labelPosition="left"
           >

invenio.cfg

@@ -59,6 +59,8 @@ from cds_rdm.components import SubjectsValidationComponent
 from cds_rdm.pids import validate_optional_doi_transitions
 from cds_rdm.views import frontpage_view_function
 
+from invenio_app_rdm.config import APP_RDM_DETAIL_SIDE_BAR_TEMPLATES as DEFAULT_SIDE_BAR_TEMPLATES
+
 
 def _(x):  # needed to avoid start time failure with lazy strings
     return x
@@ -509,3 +511,12 @@ _APP_RDM_STATS_EVENTS["record-view"]["params"]["suffix"] = "%Y"
 # Override the index_interval to be year
 _APP_RDM_STATS_AGGREGATIONS["file-download-agg"]["params"]["index_interval"] = "year"
 _APP_RDM_STATS_AGGREGATIONS["record-view-agg"]["params"]["index_interval"] = "year"
+
+
+APP_RDM_RECORD_LANDING_PAGE_TEMPLATE = "cds_rdm/records/detail.html"
+
+# Replace the manage menu template
+APP_RDM_DETAIL_SIDE_BAR_TEMPLATES = [
+    "cds_rdm/records/manage_menu.html" if template == "invenio_app_rdm/records/details/side_bar/manage_menu.html" else template
+    for template in DEFAULT_SIDE_BAR_TEMPLATES
+]

site/cds_rdm/clc_sync/services/service.py

@@ -46,7 +46,7 @@ def _clc_import(self, data):
 
         if not record_data or not auto_sync:
             return  # Skip
-        resource = record_data.get("metadata", {}).get("resource_type", {}).get("id")
+        resource = record_data["metadata"]["resource_type"]["id"]
         if not any(
             resource.startswith(allowed)
             for allowed in current_app.config["CLC_SYNC_ALLOWED_RESOURCE_TYPES"]

site/cds_rdm/clc_sync/services/utils.py

@@ -12,8 +12,8 @@
 
 def clc_import(record_data):
     """Import a record to CLC."""
-    clc_url = current_app.config.get("CLC_URL_SYNC")
-    clc_token = current_app.config.get("CDS_ILS_IMPORTER_API_KEY")
+    clc_url = current_app.config["CLC_URL_SYNC"]
+    clc_token = current_app.config["CDS_ILS_IMPORTER_API_KEY"]
     clc_payload = {
         "data": record_data,
         "mode": "IMPORT",

site/cds_rdm/config.py

@@ -22,7 +22,6 @@
         },
     },
 }
-
 """Facets/aggregations for CLC user sync results."""
 
 CLC_SYNC_DEFAULT_QUEUE = None

site/cds_rdm/ext.py

@@ -10,6 +10,7 @@
 from cds_rdm.clc_sync.resources.resource import CLCSyncResource
 from cds_rdm.clc_sync.services.config import CLCSyncServiceConfig
 from cds_rdm.clc_sync.services.service import CLCSyncService
+from cds_rdm.utils import get_clc_sync_entry
 
 from . import config
 
@@ -32,6 +33,7 @@ def init_app(self, app):
         """Flask application initialization."""
         self.init_services(app)
         self.init_resources(app)
+        app.jinja_env.globals["get_clc_sync_entry"] = get_clc_sync_entry
         return app
 
     def init_services(self, app):

site/cds_rdm/templates/semantic-ui/cds_rdm/records/detail.html

@@ -0,0 +1,31 @@
+{#
+    Copyright (C) 2025 CERN.
+  
+    CDS-RDM is free software; you can redistribute it and/or modify it
+    under the terms of the MIT License; see LICENSE file for more details.
+#}
+
+{%- extends "invenio_app_rdm/records/detail.html" %}
+
+{%- set clc_sync_entry = get_clc_sync_entry(record) %}
+
+{%- block after_record_content -%}
+{# After record content hook #}
+{% if clc_sync_entry %}
+<div class="ui info message">
+    <div class="description">
+        {{ _("To loan this literature, see Library holdings in the") }} 
+        <a href="{{ clc_sync_entry.clc_url }}" target="_blank">
+            {{ _("CERN Library Catalogue") }}
+        </a>
+        {{ _("website.") }}
+    </div>
+</div>
+{% endif %}
+{%- endblock after_record_content -%}
+
+{%- block record_manage_data_attributes -%}
+{{ super() }}
+data-allowed-resource-types='{{ config.CLC_SYNC_ALLOWED_RESOURCE_TYPES | tojson }}'
+data-clc-sync-entry='{{ clc_sync_entry | tojson | safe }}'
+{%- endblock record_manage_data_attributes -%}

site/cds_rdm/templates/semantic-ui/cds_rdm/records/manage_menu.html

@@ -0,0 +1,14 @@
+{#
+  Copyright (C) 2022-2024 CERN.
+  
+  Invenio RDM Records is free software; you can redistribute it and/or modify
+  it under the terms of the MIT License; see LICENSE file for more details.
+#}
+
+{% extends "invenio_app_rdm/records/details/side_bar/manage_menu.html" %}
+
+{%- block record_manage_data_attributes -%}
+{{ super() }}
+data-allowed-resource-types='{{ config.CLC_SYNC_ALLOWED_RESOURCE_TYPES | tojson }}'
+data-clc-sync-entry='{{ clc_sync_entry | tojson | safe }}'
+{%- endblock record_manage_data_attributes -%}

site/cds_rdm/utils.py

@@ -13,6 +13,8 @@
 from invenio_access.permissions import system_identity
 from invenio_records_resources.services.errors import ValidationError
 
+from cds_rdm.clc_sync.proxies import current_clc_sync_service
+
 
 class NamesUtils:
     """Names utilities."""
@@ -284,3 +286,21 @@ def merge(self, name_source, name_dest):
             )
             # Update the name_dest value
             self.service.update(system_identity, name_dest.get("id"), name_dest)
+
+
+def get_clc_sync_entry(record):
+    """Get the CLC sync entry for the record.
+
+    :param record: The record to get the CLC sync entry for.
+    :return: The CLC sync entry.
+    """
+    try:
+        clc_sync_entry = current_clc_sync_service.read(
+            system_identity,
+            record.get("parent", {}).get(
+                "id",
+            ),
+        ).to_dict()
+        return clc_sync_entry
+    except Exception as e:
+        return None