invenio-app-rdm 5.0.0.dev0__py2.py3-none-any.whl → 14.0.0b4.dev4__py2.py3-none-any.whl

invenio_app_rdm/records_ui/utils.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020 CERN.
+# Copyright (C) 2020-2025 CERN.
 # Copyright (C) 2020 Northwestern University.
 # Copyright (C) 2021 TU Wien.
 #
@@ -9,9 +9,22 @@
 
 """Utility functions."""
 
+from datetime import datetime, timezone
+from itertools import chain
+
+from flask import current_app
+from invenio_access.permissions import system_identity
+from invenio_rdm_records.records.api import RDMRecord
+from invenio_rdm_records.requests.record_deletion import RecordDeletion
+from invenio_rdm_records.services.config import (
+    FileModificationPolicyEvaluator,
+    RDMRecordDeletionPolicy,
+)
 from invenio_records.dictutils import dict_set
 from invenio_records.errors import MissingModelError
 from invenio_records_files.api import FileObject
+from invenio_requests.proxies import current_requests_service
+from invenio_search.api import dsl
 
 
 def previewer_record_file_factory(pid, record, filename):
@@ -23,7 +36,7 @@ def previewer_record_file_factory(pid, record, filename):
     :returns: Previewer compatible File object or ``None`` if not found.
     """
     try:
-        if not (hasattr(record, 'files') and record.files):
+        if not (hasattr(record, "files") and record.files):
             return None
     except MissingModelError:
         return None
@@ -55,3 +68,115 @@ def set_default_value(record_dict, value, path, default_prefix="metadata"):
         path = "{}.{}".format(default_prefix, path)
 
     dict_set(record_dict, path, value)
+
+
+def get_external_resources(record):
+    """Generate external resources from the record."""
+    result = []
+    resources_cfg = current_app.config["APP_RDM_RECORD_LANDING_PAGE_EXTERNAL_LINKS"]
+    for cfg in resources_cfg:
+        try:
+            res = cfg["render"](record)
+            if res:
+                result.append(res)
+        except Exception:
+            pass
+    return list(chain.from_iterable(result))
+
+
+def dump_external_resource(
+    url, title, section, icon=None, subtitle=None, template=None
+):
+    """Dumps a external resource dictionary."""
+    return {
+        "content": {
+            "url": url,
+            "title": title,
+            "subtitle": subtitle,
+            "icon": icon,
+            "section": section,
+        },
+        "template": template,
+    }
+
+
+def get_existing_deletion_request(record_id):
+    """Return the self HTML link of the existing open deletion request for the record."""
+    existing_requests = current_requests_service.search(
+        system_identity,
+        extra_filter=dsl.Q(
+            "bool",
+            must=[
+                dsl.Q("term", **{"topic.record": record_id}),
+                dsl.Q("term", **{"type": RecordDeletion.type_id}),
+                dsl.Q("term", **{"is_open": True}),
+            ],
+        ),
+    )
+    if existing_requests.total > 0:
+        return list(existing_requests)[0]["links"]["self_html"]
+
+
+def evaluate_record_deletion(record: RDMRecord, identity):
+    """Evaluate whether a given record can be deleted by an identity."""
+    rec_del = RDMRecordDeletionPolicy().evaluate(identity, record)
+
+    immediate, request = rec_del["immediate_deletion"], rec_del["request_deletion"]
+    rd_enabled = immediate.enabled or request.enabled
+    rd_valid_user = immediate.valid_user or request.valid_user
+    rd_allowed = immediate.allowed or request.allowed
+
+    if rd_allowed:
+        record_deletion = {
+            "enabled": rd_enabled,
+            "valid_user": rd_valid_user,
+            "allowed": rd_allowed,
+            "recordDeletion": rec_del,
+            "checklist": (
+                current_app.config["RDM_IMMEDIATE_RECORD_DELETION_CHECKLIST"]
+                if immediate.allowed
+                else current_app.config["RDM_REQUEST_RECORD_DELETION_CHECKLIST"]
+            ),
+            "context": {
+                "files": record.files.count,
+                "internalDoi": record.pids.get("doi", {}).get("provider") != "external",
+            },
+        }
+    else:
+        record_deletion = {
+            "enabled": rd_enabled,
+            "valid_user": rd_valid_user,
+            "allowed": rd_allowed,
+        }
+    record_deletion["existing_request"] = (
+        # We show existing requests to valid users (even if they are not allowed to delete a record anymore).
+        get_existing_deletion_request(record.pid.pid_value)
+        if rd_valid_user
+        else None
+    )
+
+    return record_deletion
+
+
+def evaluate_file_modification(record, identity):
+    """Evaluate whether a given record file's can be edited by an identity."""
+    file_mod = FileModificationPolicyEvaluator().evaluate(identity, record)
+
+    file_mod = file_mod["immediate_file_modification"]
+
+    file_modification = {
+        "enabled": file_mod.enabled,
+        "valid_user": file_mod.valid_user,
+        "allowed": file_mod.allowed,
+    }
+
+    if file_mod.allowed:
+        file_modification["fileModification"] = file_mod
+        created = record.created.replace(tzinfo=timezone.utc)
+        modification_until = created + current_app.config.get(
+            "RDM_FILE_MODIFICATION_PERIOD"
+        )
+        days_until = (modification_until - datetime.now(timezone.utc)).days
+        file_modification["context"] = {"days_until": days_until}
+
+    return file_modification

invenio_app_rdm/records_ui/views/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2019-2021 CERN.
-# Copyright (C) 2019-2021 Northwestern University.
+# Copyright (C) 2019-2022 Northwestern University.
 # Copyright (C)      2021 TU Wien.
 #
 # Invenio App RDM is free software; you can redistribute it and/or modify it
@@ -10,17 +10,55 @@
 """Views related to records and deposits."""
 
 from flask import Blueprint
-from invenio_pidstore.errors import PIDDeletedError, PIDDoesNotExistError, \
-    PIDUnregistered
-from invenio_records_resources.services.errors import PermissionDeniedError
-
-from .deposits import deposit_create, deposit_edit, deposit_search
-from .filters import can_list_files, doi_identifier, has_previewable_files, \
-    make_files_preview_compatible, order_entries, pid_url, \
-    select_preview_file, to_previewer_files, vocabulary_title
-from .records import not_found_error, record_detail, record_export, \
-    record_file_download, record_file_preview, record_from_pid, \
-    record_latest, record_permission_denied_error, record_tombstone_error
+from invenio_drafts_resources.resources.records.errors import DraftNotCreatedError
+from invenio_pidstore.errors import (
+    PIDDeletedError,
+    PIDDoesNotExistError,
+    PIDUnregistered,
+)
+from invenio_rdm_records.services.errors import RecordDeletedException
+from invenio_records_resources.services.errors import (
+    FileKeyNotFoundError,
+    PermissionDeniedError,
+    RecordPermissionDeniedError,
+)
+from sqlalchemy.orm.exc import NoResultFound
+
+from invenio_app_rdm.views import create_url_rule
+
+from ..searchapp import search_app_context
+from .deposits import community_upload, deposit_create, deposit_edit
+from .filters import (
+    can_list_files,
+    compact_number,
+    custom_fields_search,
+    get_scheme_label,
+    has_images,
+    has_previewable_files,
+    localize_number,
+    make_files_preview_compatible,
+    namespace_url,
+    order_entries,
+    pid_url,
+    select_preview_file,
+    to_previewer_files,
+    transform_record,
+    truncate_number,
+)
+from .records import (
+    draft_not_found_error,
+    not_found_error,
+    record_detail,
+    record_export,
+    record_file_download,
+    record_file_preview,
+    record_from_pid,
+    record_latest,
+    record_media_file_download,
+    record_permission_denied_error,
+    record_thumbnail,
+    record_tombstone_error,
+)
 
 
 #
@@ -29,6 +67,7 @@ from .records import not_found_error, record_detail, record_export, \
 def create_blueprint(app):
     """Register blueprint routes on app."""
     routes = app.config.get("APP_RDM_ROUTES")
+    communities_routes = app.config.get("COMMUNITIES_ROUTES")
 
     blueprint = Blueprint(
         "invenio_app_rdm_records",
@@ -38,54 +77,83 @@ def create_blueprint(app):
 
     # Record URL rules
     blueprint.add_url_rule(
-        routes["record_detail"],
-        view_func=record_detail,
+        **create_url_rule(
+            routes["record_detail"],
+            default_view_func=record_detail,
+        )
     )
 
     blueprint.add_url_rule(
-        routes["record_latest"],
-        view_func=record_latest,
+        **create_url_rule(
+            routes["record_latest"],
+            default_view_func=record_latest,
+        )
     )
 
-    app_ext = app.extensions['invenio-rdm-records']
-    schemes = app_ext.records_service.config.pids_providers.keys()
-    schemes = ','.join(schemes)
-
+    rdm_records_ext = app.extensions["invenio-rdm-records"]
+    schemes = rdm_records_ext.records_service.config.pids_providers.keys()
+    schemes = ",".join(schemes)
     if schemes:
         blueprint.add_url_rule(
-            routes["record_from_pid"].format(schemes=schemes),
-            view_func=record_from_pid,
+            **create_url_rule(
+                routes["record_from_pid"].format(schemes=schemes),
+                default_view_func=record_from_pid,
+            )
+        )
+
+    blueprint.add_url_rule(
+        **create_url_rule(
+            routes["record_export"],
+            default_view_func=record_export,
         )
+    )
 
     blueprint.add_url_rule(
-        routes["record_export"],
-        view_func=record_export,
+        **create_url_rule(
+            routes["record_file_preview"],
+            default_view_func=record_file_preview,
+        )
     )
 
     blueprint.add_url_rule(
-        routes["record_file_preview"],
-        view_func=record_file_preview,
+        **create_url_rule(
+            routes["record_file_download"],
+            default_view_func=record_file_download,
+        )
+    )
+    blueprint.add_url_rule(
+        **create_url_rule(
+            routes["record_thumbnail"],
+            default_view_func=record_thumbnail,
+        )
     )
 
     blueprint.add_url_rule(
-        routes["record_file_download"],
-        view_func=record_file_download,
+        **create_url_rule(
+            routes["record_media_file_download"],
+            default_view_func=record_media_file_download,
+        )
     )
 
-    # Deposit URL rules
     blueprint.add_url_rule(
-        routes["deposit_search"],
-        view_func=deposit_search,
+        **create_url_rule(
+            routes["deposit_create"],
+            default_view_func=deposit_create,
+        )
     )
 
     blueprint.add_url_rule(
-        routes["deposit_create"],
-        view_func=deposit_create,
+        **create_url_rule(
+            routes["deposit_edit"],
+            default_view_func=deposit_edit,
+        )
     )
 
     blueprint.add_url_rule(
-        routes["deposit_edit"],
-        view_func=deposit_edit,
+        **create_url_rule(
+            communities_routes["upload"],
+            default_view_func=community_upload,
+        )
     )
 
     # Register error handlers
@@ -93,18 +161,35 @@ def create_blueprint(app):
     blueprint.register_error_handler(PIDDoesNotExistError, not_found_error)
     blueprint.register_error_handler(PIDUnregistered, not_found_error)
     blueprint.register_error_handler(KeyError, not_found_error)
+    blueprint.register_error_handler(FileKeyNotFoundError, not_found_error)
+    blueprint.register_error_handler(NoResultFound, not_found_error)
+    blueprint.register_error_handler(DraftNotCreatedError, draft_not_found_error)
     blueprint.register_error_handler(
-        PermissionDeniedError, record_permission_denied_error)
+        PermissionDeniedError, record_permission_denied_error
+    )
+    blueprint.register_error_handler(
+        RecordPermissionDeniedError, record_permission_denied_error
+    )
+    blueprint.register_error_handler(RecordDeletedException, record_tombstone_error)
 
     # Register template filters
     blueprint.add_app_template_filter(can_list_files)
-    blueprint.add_app_template_filter(doi_identifier)
     blueprint.add_app_template_filter(make_files_preview_compatible)
     blueprint.add_app_template_filter(pid_url)
     blueprint.add_app_template_filter(select_preview_file)
     blueprint.add_app_template_filter(to_previewer_files)
-    blueprint.add_app_template_filter(vocabulary_title)
     blueprint.add_app_template_filter(has_previewable_files)
     blueprint.add_app_template_filter(order_entries)
+    blueprint.add_app_template_filter(get_scheme_label)
+    blueprint.add_app_template_filter(has_images)
+    blueprint.add_app_template_filter(localize_number)
+    blueprint.add_app_template_filter(compact_number)
+    blueprint.add_app_template_filter(truncate_number)
+    blueprint.add_app_template_filter(namespace_url)
+    blueprint.add_app_template_filter(custom_fields_search)
+    blueprint.add_app_template_filter(transform_record)
+
+    # Register context processor
+    blueprint.app_context_processor(search_app_context)
 
     return blueprint