feat(entity_editing): enable primary source selection during modification

This commit introduces the ability for users to specify a primary source when saving changes to an existing entity via the 'about' page.

- Added a dialog that prompts the user for a primary source URL when saving changes. Users can optionally save this URL as their new default.
- Updated the `/apply_changes` API endpoint to receive and process `primary_source` and `save_default_source` parameters from the request.
- Integrated the `Editor.set_primary_source` method to apply the chosen source to the editing session before saving changes.
- Refactored primary source handling in the entity creation workflow to use the same dialog component.
- Centralized primary source logic by utilizing functions from `primary_source_utils` in both `api.py` and `entity.py`.
- Resolved an issue in `/apply_changes` where the request data could be a list instead of a dictionary.

Author: arcangelo7

heritrace/editor.py

@@ -308,3 +308,17 @@ def to_posix_timestamp(self, value: str | datetime | None) -> float | None:
         elif isinstance(value, str):
             dt = datetime.fromisoformat(value)
             return dt.timestamp()
+
+    def set_primary_source(self, source: str | URIRef) -> None:
+        """
+        Set the primary source for this editor instance.
+        
+        This will affect all future operations performed by this editor.
+        
+        Args:
+            source: The primary source URI to use
+        """
+        if source:
+            if not isinstance(source, URIRef):
+                source = URIRef(source)
+            self.source = source

heritrace/routes/api.py

@@ -19,6 +19,7 @@
 from heritrace.utils.strategies import (OrphanHandlingStrategy,
                                         ProxyHandlingStrategy)
 from heritrace.utils.uri_utils import generate_unique_uri
+from heritrace.utils.primary_source_utils import save_user_default_primary_source
 from rdflib import RDF, XSD, Graph, URIRef
 from resources.datatypes import DATATYPE_MAPPING
 import validators
@@ -458,14 +459,42 @@ def format_entities(entities, is_intermediate=False):
 @api_bp.route("/apply_changes", methods=["POST"])
 @login_required
 def apply_changes():
+    """Apply changes to entities.
+
+    Request body:
+    {
+        "subject": (str) Main entity URI being modified,
+        "changes": (list) List of changes to apply,
+        "primary_source": (str) Primary source to use for provenance,
+        "save_default_source": (bool) Whether to save primary_source as default for current user,
+        "affected_entities": (list) Entities potentially affected by delete operations,
+        "delete_affected": (bool) Whether to delete affected entities
+    }
+
+    Responses:
+    200 OK: Changes applied successfully
+    400 Bad Request: Invalid request or validation error
+    500 Internal Server Error: Server error while applying changes
+    """
     try:
-        # Remove all debug logging statements
-        changes = request.json
-        subject = changes[0]["subject"]
-        affected_entities = changes[0].get("affected_entities", [])
-        delete_affected = changes[0].get("delete_affected", False)
+        changes = request.get_json()
+        
+        if not changes:
+            return jsonify({"error": "No request data provided"}), 400
+
+        first_change = changes[0] if changes else {}
+        subject = first_change.get("subject")
+        affected_entities = first_change.get("affected_entities", [])
+        delete_affected = first_change.get("delete_affected", False)
+        primary_source = first_change.get("primary_source")
+        save_default_source = first_change.get("save_default_source", False)
+        
+        if primary_source and not validators.url(primary_source):
+            return jsonify({"error": "Invalid primary source URL"}), 400
+        
+        if save_default_source and primary_source and validators.url(primary_source):
+            save_user_default_primary_source(current_user.orcid, primary_source)
 
-        # Tieni traccia delle entità già eliminate per evitare duplicazioni
         deleted_entities = set()
         editor = Editor(
             get_dataset_endpoint(),
@@ -477,13 +506,14 @@ def apply_changes():
             dataset_is_quadstore=current_app.config["DATASET_IS_QUADSTORE"],
         )
 
-        # Se c'è un'operazione di eliminazione completa dell'entità, includiamo le entità referenzianti
+        if primary_source and validators.url(primary_source):
+            editor.set_primary_source(primary_source)
+        
         has_entity_deletion = any(
             change["action"] == "delete" and not change.get("predicate") 
             for change in changes
         )
 
-        # Import entity con l'opzione per includere le entità referenzianti se necessario
         editor = import_entity_graph(
             editor, 
             subject, 
@@ -494,12 +524,10 @@ def apply_changes():
         graph_uri = None
         if editor.dataset_is_quadstore:
             for quad in editor.g_set.quads((URIRef(subject), None, None, None)):
-                # Ottieni direttamente l'identificatore del grafo
                 graph_context = quad[3]
                 graph_uri = get_graph_uri_from_context(graph_context)
                 break
 
-        # Gestisci prima le creazioni
         temp_id_to_uri = {}
         for change in changes:
             if change["action"] == "create":
@@ -514,7 +542,6 @@ def apply_changes():
                         parent_entity_type=None,
                     )
 
-        # Poi gestisci le altre modifiche
         orphan_strategy = current_app.config.get(
             "ORPHAN_HANDLING_STRATEGY", OrphanHandlingStrategy.KEEP
         )

heritrace/routes/entity.py

@@ -32,15 +32,15 @@
 from heritrace.utils.uri_utils import generate_unique_uri
 from heritrace.utils.virtuoso_utils import (VIRTUOSO_EXCLUDED_GRAPHS,
                                             is_virtuoso)
+from heritrace.utils.primary_source_utils import (get_default_primary_source,
+                                                 save_user_default_primary_source)
 from rdflib import RDF, XSD, ConjunctiveGraph, Graph, Literal, URIRef
 from resources.datatypes import DATATYPE_MAPPING
 from SPARQLWrapper import JSON
 from time_agnostic_library.agnostic_entity import AgnosticEntity
 
 entity_bp = Blueprint("entity", __name__)
 
-USER_DEFAULT_SOURCE_KEY = "user:{user_id}:default_primary_source"
-
 
 @entity_bp.route("/about/<path:subject>")
 @login_required
@@ -53,6 +53,8 @@ def about(subject):
     """
     # Get necessary services and configurations
     change_tracking_config = get_change_tracking_config()
+    
+    default_primary_source = get_default_primary_source(current_user.orcid)
 
     # Initialize agnostic entity and get its history
     agnostic_entity = AgnosticEntity(
@@ -203,24 +205,19 @@ def about(subject):
         is_deleted=is_deleted,
         context=context_snapshot,
         linked_resources=linked_resources,
+        default_primary_source=default_primary_source,
     )
 
 
 @entity_bp.route("/create-entity", methods=["GET", "POST"])
 @login_required
 def create_entity():
+    """
+    Create a new entity in the dataset.
+    """
     form_fields = get_form_fields()
 
-    user_default_source = None
-    if current_user.is_authenticated:
-        key = USER_DEFAULT_SOURCE_KEY.format(user_id=current_user.orcid)
-        try:
-            user_default_source = current_app.redis_client.get(key)
-        except Exception as e:
-            current_app.logger.error(f"Failed to get user default primary source from Redis: {e}")
-            user_default_source = None # Ensure it's None on error
-    
-    default_primary_source = user_default_source or current_app.config["PRIMARY_SOURCE"]
+    default_primary_source = get_default_primary_source(current_user.orcid)
 
     entity_types = sorted(
         [
@@ -274,12 +271,7 @@ def create_entity():
             return jsonify({"status": "error", "errors": [gettext("Invalid primary source URL provided")]}), 400
 
         if save_default_source and primary_source and validators.url(primary_source):
-            try:
-                key = USER_DEFAULT_SOURCE_KEY.format(user_id=current_user.orcid)
-                current_app.redis_client.set(key, primary_source)
-                current_app.logger.info(f"Saved new default primary source for user {current_user.orcid}: {primary_source}")
-            except Exception as e:
-                current_app.logger.error(f"Failed to save user default primary source to Redis: {e}")
+            save_user_default_primary_source(current_user.orcid, primary_source)
 
         editor = Editor(
             get_dataset_endpoint(),

heritrace/static/js/creation_workflow.js

@@ -152,12 +152,18 @@ function initializeMandatoryElements(container) {
     });
 }
 
-// Function to initialize the form based on the selected entity type
 function initializeForm() {
     let selectedUri;
     if ($('#entity_type').length) {
-        // In create_entity.jinja
         selectedUri = $('#entity_type').val();
+
+        if (!selectedUri) {
+            selectedUri = $('#entity_type option:not(:disabled):first').val();
+            if (selectedUri) {
+                $('#entity_type').val(selectedUri);
+            }
+        }
+
         $('#entity_type option').prop('selected', function() {
             return this.value === selectedUri;
         });

heritrace/templates/create_entity.jinja

@@ -92,6 +92,7 @@
 
 <script src="{{ url_for('static', filename='js/creation_workflow.js') }}"></script>
 {% include 'top_level_search.jinja' %}
+{% include 'primary_source_handler.jinja' %}
 <script>
     window.dataset_db_triplestore = {{ dataset_db_triplestore | tojson | safe }};
     window.dataset_db_text_index_enabled = {{ dataset_db_text_index_enabled | tojson | safe }};
@@ -418,105 +419,10 @@
                 return;
             }
 
-            Swal.fire({
-                title: '{{ _("Enter Primary Source") }}',
-                html: `
-                    <p>{{ _("Please provide the URL of the primary source for this entity, or leave blank if not applicable") }}</p>
-                    <div class="mb-2"><strong id="primary-source-label">{{ _("Current Default:") }}</strong></div>
-                    <div id="primary-source-preview" class="default-source-preview p-2 border rounded bg-light">
-                        <span class="spinner-border spinner-border-sm" role="status" aria-hidden="true"></span>
-                        {{ _("Loading preview...") }}
-                    </div>
-                `,
-                input: 'url',
-                inputValue: '{{ default_primary_source }}',
-                inputPlaceholder: 'Enter the URL',
-                showCancelButton: true,
-                confirmButtonText: '{{ _("Confirm and Create") }}',
-                cancelButtonText: '{{ _("Cancel") }}',
-                footer: `
-                    <div class="form-check" style="text-align: left;">
-                        <input type="checkbox" class="form-check-input" id="save-default-source">
-                        <label class="form-check-label" for="save-default-source">{{ _("Save this URL as my default primary source") }}</label>
-                    </div>
-                `,
-                didOpen: () => {
-                    const previewContainer = $('#primary-source-preview');
-                    const swalInput = Swal.getInput();
-                    const defaultSourceUrl = '{{ default_primary_source }}';
-                    const labelContainer = $('#primary-source-label');
-                    
-                    const updatePrimarySourcePreview = (url) => {
-                        const previewContainer = $('#primary-source-preview');
-                        const labelContainer = $('#primary-source-label');
-                        const originalDefaultSource = '{{ default_primary_source }}';
-
-                        if (!url) {
-                            labelContainer.text('{{ _("Source (Optional):") }}');
-                        } else if (url === originalDefaultSource) {
-                            labelContainer.text('{{ _("Current Default:") }}');
-                        } else {
-                            labelContainer.text('{{ _("Preview:") }}');
-                        }
-
-                        if (!url) {
-                            previewContainer.html('{{ _("No primary source will be recorded.") }}');
-                            return;
-                        }
-
-                        if (!validateUrl(url)) {
-                            previewContainer.html('{{ _("Enter a valid URL or leave blank") }}');
-                            return;
-                        }
-
-                        previewContainer.html(
-                            `<span class="spinner-border spinner-border-sm" role="status" aria-hidden="true"></span> {{ _("Loading...") }}`
-                        );
-                        $.ajax({
-                            url: '{{ url_for("api.format_source_api") }}',
-                            type: 'POST',
-                            contentType: 'application/json',
-                            data: JSON.stringify({ url: url }),
-                            success: function(response) {
-                                previewContainer.html(response.formatted_html);
-                            },
-                            error: function() {
-                                previewContainer.html(`<a href="${url}" target="_blank">${url}</a> <small class="text-danger">(${ '{{ _("Preview failed to load") }}' })</small>`);
-                            }
-                        });
-                    };
-
-                    const debouncedUpdatePreview = debounce(updatePrimarySourcePreview, 500);
-
-                    if (defaultSourceUrl) {
-                       updatePrimarySourcePreview(defaultSourceUrl);
-                    } else {
-                        previewContainer.html('{{ _("No default source set") }}');
-                        labelContainer.text('{{ _("Source:") }}');
-                    }
-
-                    if (swalInput) {
-                        $(swalInput).on('input', function() {
-                            debouncedUpdatePreview($(this).val());
-                        });
-                    }
-                },
-                inputValidator: (value) => {
-                    if (!value) {
-                        return null;
-                    }
-                    try {
-                        new URL(value);
-                    } catch (_) {
-                        return '{{ _("Please enter a valid URL or leave blank.") }}';
-                    }
-                    return null;
-                }
-            }).then((result) => {
-                if (result.isConfirmed) {
-                    const primarySourceUrl = result.value;
-                    const saveAsDefault = $('#save-default-source').is(':checked');
-
+            showPrimarySourceDialog({
+                defaultPrimarySource: '{{ default_primary_source }}',
+                formatSourceApiUrl: '{{ url_for("api.format_source_api") }}',
+                onConfirm: function(primarySourceUrl, saveAsDefault) {
                     let structuredData = {};
 
                     if ('{{shacl}}' === 'True') {

heritrace/templates/entity/about.jinja

@@ -226,13 +226,16 @@
 </div>
 {# End New Similar Resources Section #}
 
+{% include 'primary_source_handler.jinja' %}
 <script>
     let originalOrder = {};
     const optional_values = {{ optional_values|tojson|safe }};
     const shacl = {{ shacl|tojson|safe }};
 
     const entity_type = "{{ entity_type }}";
     const subject = "{{ subject }}";
+    const default_primary_source = "{{ default_primary_source }}";
+    const format_source_api_url = "{{ url_for('api.format_source_api') }}";
 
     window.dataset_db_triplestore = {{ dataset_db_triplestore | tojson | safe }};
     window.dataset_db_text_index_enabled = {{ dataset_db_text_index_enabled | tojson | safe }};
@@ -889,14 +892,29 @@
                 });
                 return;
             }
+            
             processOrphanCheck(pendingChanges, entity_type, function(affectedEntities, shouldDelete) {
                 // Aggiorna il primo elemento di pendingChanges con le informazioni sulle entità affette
                 if (affectedEntities && affectedEntities.length > 0) {
                     pendingChanges[0].affected_entities = affectedEntities;
                     pendingChanges[0].delete_affected = shouldDelete;
                 }
-                applyChangesToEntity(pendingChanges, function() {
-                    window.location.href = "{{ url_for('entity.about', subject=subject) }}";
+                
+                // Use the new primary source dialog
+                showPrimarySourceDialog({
+                    defaultPrimarySource: default_primary_source,
+                    formatSourceApiUrl: format_source_api_url,
+                    onConfirm: function(primarySourceUrl, saveAsDefault) {
+                        // Add primary source information to the first change
+                        if (pendingChanges.length > 0) {
+                            pendingChanges[0].primary_source = primarySourceUrl;
+                            pendingChanges[0].save_default_source = saveAsDefault;
+                        }
+                        
+                        applyChangesToEntity(pendingChanges, function() {
+                            window.location.href = "{{ url_for('entity.about', subject=subject) }}";
+                        });
+                    }
                 });
             });
         });
@@ -935,14 +953,12 @@ $(document).ready(function() {
             limit: 5 // Adjust limit as needed
         },
         success: function(response) {
-            console.log("API Response:", response); // Log the whole response
             loadingIndicator.remove();
             if (response.status === 'success' && response.results && response.results.length > 0) {
                 similarResourcesContainer.empty(); // Clear previous results
                 noSimilarResourcesMessage.hide();
 
                 response.results.forEach(function(simRes, index) {
-                    console.log(`Processing item ${index}:`, simRes);
                     let typesHtml = '';
                     if (simRes.types && simRes.types.length > 0) {
                         // Use the pre-fetched type_labels from the API response
@@ -953,7 +969,6 @@ $(document).ready(function() {
                     let compareUrl = "{{ url_for('merge.compare_and_merge', subject='SUBJECT_PLACEHOLDER', other_subject='OTHER_PLACEHOLDER') }}";
                     compareUrl = compareUrl.replace('SUBJECT_PLACEHOLDER', encodeURIComponent(subjectUri));
                     compareUrl = compareUrl.replace('OTHER_PLACEHOLDER', encodeURIComponent(simRes.uri));
-                    console.log(compareUrl);
                     const itemHtml = `
                         <div class="list-group-item" style="position: relative;">
                             <div class="d-flex flex-wrap gap-2 justify-content-between align-items-start">