invenio-app-rdm 12.0.0.dev8__py2.py3-none-any.whl → 14.0.0b1.dev8__py2.py3-none-any.whl

invenio_app_rdm/records_ui/views/__init__.py

@@ -10,33 +10,43 @@
 """Views related to records and deposits."""
 
 from flask import Blueprint
+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 deposit_create, deposit_edit
+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,
@@ -44,7 +54,9 @@ from .records import (
     record_file_preview,
     record_from_pid,
     record_latest,
+    record_media_file_download,
     record_permission_denied_error,
+    record_thumbnail,
     record_tombstone_error,
 )
 
@@ -55,6 +67,7 @@ from .records import (
 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",
@@ -64,13 +77,17 @@ 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,
+        )
     )
 
     rdm_records_ext = app.extensions["invenio-rdm-records"]
@@ -78,33 +95,65 @@ def create_blueprint(app):
     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(
-        routes["record_export"],
-        view_func=record_export,
+        **create_url_rule(
+            routes["record_export"],
+            default_view_func=record_export,
+        )
     )
 
     blueprint.add_url_rule(
-        routes["record_file_preview"],
-        view_func=record_file_preview,
+        **create_url_rule(
+            routes["record_file_preview"],
+            default_view_func=record_file_preview,
+        )
     )
 
     blueprint.add_url_rule(
-        routes["record_file_download"],
-        view_func=record_file_download,
+        **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["deposit_create"],
-        view_func=deposit_create,
+        **create_url_rule(
+            routes["record_media_file_download"],
+            default_view_func=record_media_file_download,
+        )
     )
 
     blueprint.add_url_rule(
-        routes["deposit_edit"],
-        view_func=deposit_edit,
+        **create_url_rule(
+            routes["deposit_create"],
+            default_view_func=deposit_create,
+        )
+    )
+
+    blueprint.add_url_rule(
+        **create_url_rule(
+            routes["deposit_edit"],
+            default_view_func=deposit_edit,
+        )
+    )
+
+    blueprint.add_url_rule(
+        **create_url_rule(
+            communities_routes["upload"],
+            default_view_func=community_upload,
+        )
     )
 
     # Register error handlers
@@ -113,9 +162,15 @@ def create_blueprint(app):
     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
     )
+    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)
@@ -130,6 +185,9 @@ def create_blueprint(app):
     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)

invenio_app_rdm/records_ui/views/decorators.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2019-2021 CERN.
-# Copyright (C) 2019-2021 Northwestern University.
+# Copyright (C) 2019-2025 CERN.
+# Copyright (C) 2019-2025 Northwestern University.
 # Copyright (C)      2021 TU Wien.
 #
 # Invenio App RDM is free software; you can redistribute it and/or modify it
@@ -11,12 +11,19 @@
 
 from functools import wraps
 
-from flask import g, request
+from flask import current_app, g, make_response, redirect, request, session, url_for
+from flask_login import login_required
+from invenio_base import invenio_url_for
 from invenio_communities.communities.resources.serializer import (
     UICommunityJSONSerializer,
 )
 from invenio_communities.proxies import current_communities
+from invenio_pidstore.errors import PIDDoesNotExistError
 from invenio_rdm_records.proxies import current_rdm_records
+from invenio_rdm_records.resources.serializers.signposting import (
+    FAIRSignpostingProfileLvl1Serializer,
+)
+from invenio_rdm_records.services.errors import RecordDeletedException
 from invenio_records_resources.services.errors import PermissionDeniedError
 from sqlalchemy.orm.exc import NoResultFound
 
@@ -31,11 +38,21 @@ def files_service():
     return current_rdm_records.records_service.files
 
 
+def media_files_service():
+    """Get the record files service."""
+    return current_rdm_records.records_media_files_service.files
+
+
 def draft_files_service():
     """Get the record files service."""
     return current_rdm_records.records_service.draft_files
 
 
+def draft_media_files_service():
+    """Get the record files service."""
+    return current_rdm_records.records_media_files_service.draft_files
+
+
 def pass_record_latest(f):
     """Decorate a view to pass the latest version of a record."""
 
@@ -56,13 +73,27 @@ def pass_draft(expand=False):
         @wraps(f)
         def view(**kwargs):
             pid_value = kwargs.get("pid_value")
-            draft = service().read_draft(
-                id_=pid_value,
-                identity=g.identity,
-                expand=expand,
-            )
-            kwargs["draft"] = draft
-            return f(**kwargs)
+            try:
+                record_service = service()
+                draft = record_service.read_draft(
+                    id_=pid_value,
+                    identity=g.identity,
+                    expand=expand,
+                )
+                kwargs["draft"] = draft
+                kwargs["files_locked"] = draft._record.files.bucket.locked
+                return f(**kwargs)
+            except PIDDoesNotExistError:
+                # Redirect to /records/:id because users are interchangeably
+                # using /records/:id and /uploads/:id when sharing links, so in
+                # case a draft doesn't exists, when check if the record exists
+                # always.
+                return redirect(
+                    url_for(
+                        "invenio_app_rdm_records.record_detail",
+                        pid_value=pid_value,
+                    )
+                )
 
         return view
 
@@ -74,11 +105,23 @@ def pass_is_preview(f):
 
     @wraps(f)
     def view(**kwargs):
-        preview = request.args.get("preview")
-        is_preview = False
-        if preview == "1":
-            is_preview = True
-        kwargs["is_preview"] = is_preview
+        kwargs["is_preview"] = request.args.get("preview") == "1"
+        return f(**kwargs)
+
+    return view
+
+
+# TODO to be improved as a request arg schema (following the REST views)
+def pass_include_deleted(f):
+    """Decorate a view to check if it's a include deleted."""
+
+    @wraps(f)
+    def view(**kwargs):
+        deleted_arg = request.args.get("include_deleted")
+        include_deleted = False
+        if deleted_arg == "1":
+            include_deleted = True
+        kwargs["include_deleted"] = include_deleted
         return f(**kwargs)
 
     return view
@@ -112,16 +155,45 @@ def pass_record_or_draft(expand=False):
         def view(**kwargs):
             pid_value = kwargs.get("pid_value")
             is_preview = kwargs.get("is_preview")
-            read_kwargs = {"id_": pid_value, "identity": g.identity, "expand": expand}
+            include_deleted = kwargs.get("include_deleted", False)
+            read_kwargs = {
+                "id_": pid_value,
+                "identity": g.identity,
+                "expand": expand,
+            }
 
             if is_preview:
                 try:
                     record = service().read_draft(**read_kwargs)
                 except NoResultFound:
-                    record = service().read(**read_kwargs)
+                    try:
+                        record = service().read(
+                            include_deleted=include_deleted, **read_kwargs
+                        )
+                    except NoResultFound:
+                        # If the parent pid is being used we can get the id of the latest record and redirect
+                        latest_version = service().read_latest(**read_kwargs)
+                        return redirect(
+                            url_for(
+                                "invenio_app_rdm_records.record_detail",
+                                pid_value=latest_version.id,
+                                preview=1,
+                            )
+                        )
             else:
-                record = service().read(**read_kwargs)
-
+                try:
+                    record = service().read(
+                        include_deleted=include_deleted, **read_kwargs
+                    )
+                except NoResultFound:
+                    # If the parent pid is being used we can get the id of the latest record and redirect
+                    latest_version = service().read_latest(**read_kwargs)
+                    return redirect(
+                        url_for(
+                            "invenio_app_rdm_records.record_detail",
+                            pid_value=latest_version.id,
+                        )
+                    )
             kwargs["record"] = record
             return f(**kwargs)
 
@@ -130,28 +202,51 @@ def pass_record_or_draft(expand=False):
     return decorator
 
 
-def pass_file_item(f):
-    """Decorate a view to pass a file item using the files service."""
+def pass_file_item(is_media=False):
+    """Decorator to pass a file or media file item using the corresponding service."""
 
-    @wraps(f)
-    def view(**kwargs):
-        pid_value = kwargs.get("pid_value")
-        file_key = kwargs.get("filename")
-        is_preview = kwargs.get("is_preview")
-        read_kwargs = {"id_": pid_value, "file_key": file_key, "identity": g.identity}
+    def decorator(f):
+        @wraps(f)
+        def view(**kwargs):
+            pid_value = kwargs.get("pid_value")
+            file_key = kwargs.get("filename")
+            is_preview = kwargs.get("is_preview")
+            read_kwargs = {
+                "id_": pid_value,
+                "file_key": file_key,
+                "identity": g.identity,
+            }
+            draft_service = (
+                draft_media_files_service if is_media else draft_files_service
+            )
+            record_service = media_files_service if is_media else files_service
 
-        if is_preview:
             try:
-                item = draft_files_service().get_file_content(**read_kwargs)
-            except NoResultFound:
-                item = files_service().get_file_content(**read_kwargs)
-        else:
-            item = files_service().get_file_content(**read_kwargs)
+                if is_preview:
+                    try:
+                        item = draft_service().get_file_content(**read_kwargs)
+                    except NoResultFound:
+                        item = record_service().get_file_content(**read_kwargs)
+                else:
+                    item = record_service().get_file_content(**read_kwargs)
+
+                kwargs["file_item"] = item
+                return f(**kwargs)
+
+            except RecordDeletedException:
+                # Redirect to the record page which has proper tombstone handling
+                return redirect(
+                    url_for(
+                        "invenio_app_rdm_records.record_detail",
+                        pid_value=pid_value,
+                    ),
+                    # Use 302 (temporary) instead of 301 since records can be restored
+                    code=302,
+                )
 
-        kwargs["file_item"] = item
-        return f(**kwargs)
+        return view
 
-    return view
+    return decorator
 
 
 def pass_file_metadata(f):
@@ -209,6 +304,37 @@ def pass_record_files(f):
     return view
 
 
+def pass_record_media_files(f):
+    """Decorate a view to pass a record's media files using the files service."""
+
+    @wraps(f)
+    def view(**kwargs):
+        is_preview = kwargs.get("is_preview")
+        pid_value = kwargs.get("pid_value")
+        read_kwargs = {"id_": pid_value, "identity": g.identity}
+
+        try:
+            if is_preview:
+                try:
+                    media_files = draft_media_files_service().list_files(**read_kwargs)
+                except NoResultFound:
+                    media_files = media_files_service().list_files(**read_kwargs)
+            else:
+                media_files = media_files_service().list_files(**read_kwargs)
+
+            kwargs["media_files"] = media_files
+
+        except PermissionDeniedError:
+            # this is handled here because we don't want a 404 on the landing
+            # page when a user is allowed to read the metadata but not the
+            # files
+            kwargs["media_files"] = None
+
+        return f(**kwargs)
+
+    return view
+
+
 def pass_draft_files(f):
     """Decorate a view to pass a draft's files using the files service."""
 
@@ -218,7 +344,6 @@ def pass_draft_files(f):
             pid_value = kwargs.get("pid_value")
             files = draft_files_service().list_files(id_=pid_value, identity=g.identity)
             kwargs["draft_files"] = files
-
         except PermissionDeniedError:
             # this is handled here because we don't want a 404 on the landing
             # page when a user is allowed to read the metadata but not the
@@ -242,10 +367,156 @@ def pass_draft_community(f):
         comid = request.args.get("community")
         if comid:
             community = current_communities.service.read(id_=comid, identity=g.identity)
-            kwargs["community"] = UICommunityJSONSerializer().dump_obj(
+            kwargs["community"] = community
+            kwargs["community_ui"] = UICommunityJSONSerializer().dump_obj(
                 community.to_dict()
             )
 
         return f(**kwargs)
 
     return view
+
+
+def _get_header(rel, value, link_type=None):
+    header = f'<{value}> ; rel="{rel}"'
+    if link_type:
+        header += f' ; type="{link_type}"'
+    return header
+
+
+def _get_signposting_collection(pid_value):
+    ui_url = invenio_url_for(
+        "invenio_app_rdm_records.record_detail", pid_value=pid_value
+    )
+    return _get_header("collection", ui_url, "text/html")
+
+
+def _get_signposting_describes(pid_value):
+    ui_url = invenio_url_for(
+        "invenio_app_rdm_records.record_detail", pid_value=pid_value
+    )
+    return _get_header("describes", ui_url, "text/html")
+
+
+def _get_signposting_linkset(pid_value):
+    api_url = invenio_url_for("records.read", pid_value=pid_value)
+    return _get_header("linkset", api_url, "application/linkset+json")
+
+
+def add_signposting_landing_page(f):
+    """Add signposting links to the landing page view's response headers."""
+
+    @wraps(f)
+    def view(*args, **kwargs):
+        response = make_response(f(*args, **kwargs))
+
+        # Relies on other decorators having operated before it
+        if current_app.config[
+            "APP_RDM_RECORD_LANDING_PAGE_FAIR_SIGNPOSTING_LEVEL_1_ENABLED"
+        ]:
+            record = kwargs["record"]
+
+            signposting_headers = (
+                FAIRSignpostingProfileLvl1Serializer().serialize_object(
+                    record.to_dict()
+                )
+            )
+
+            response.headers["Link"] = signposting_headers
+        else:
+            pid_value = kwargs["pid_value"]
+            signposting_link = invenio_url_for("records.read", pid_value=pid_value)
+
+            response.headers["Link"] = (
+                f'<{signposting_link}> ; rel="linkset" ; type="application/linkset+json"'  # fmt: skip
+            )
+
+        return response
+
+    return view
+
+
+def add_signposting_content_resources(f):
+    """Add signposting links to the content resources view's response headers."""
+
+    @wraps(f)
+    def view(*args, **kwargs):
+        response = make_response(f(*args, **kwargs))
+
+        # Relies on other decorators having operated before it
+        pid_value = kwargs["pid_value"]
+
+        signposting_headers = [
+            _get_signposting_collection(pid_value),
+            _get_signposting_linkset(pid_value),
+        ]
+
+        response.headers["Link"] = " , ".join(signposting_headers)
+
+        return response
+
+    return view
+
+
+def add_signposting_metadata_resources(f):
+    """Add signposting links to the metadata resources view's response headers."""
+
+    @wraps(f)
+    def view(*args, **kwargs):
+        response = make_response(f(*args, **kwargs))
+
+        # Relies on other decorators having operated before it
+        pid_value = kwargs["pid_value"]
+
+        signposting_headers = [
+            _get_signposting_describes(pid_value),
+            _get_signposting_linkset(pid_value),
+        ]
+
+        response.headers["Link"] = " , ".join(signposting_headers)
+
+        return response
+
+    return view
+
+
+def secret_link_or_login_required():
+    """Skip login redirection check for requests with secret links.
+
+    If access has been granted via a secret link, then permissions are checked
+    in the dedicated view.
+    """
+
+    def decorator(f):
+        @wraps(f)
+        def view(**kwargs):
+            secret_link_token_arg = "token"
+            session_token = session.get(secret_link_token_arg, None)
+            if session_token is None:
+                login_required(f)
+            return f(**kwargs)
+
+        return view
+
+    return decorator
+
+
+def no_cache_response(f):
+    """Add appropriate response headers to force no caching.
+
+    This decorator is used to prevent caching of the response in the browser. This is needed
+    in the deposit form as we initialize the form with the record metadata included in the html page
+    and we don't want the browser to cache this page so that the user always gets the latest version of the record.
+    """
+
+    @wraps(f)
+    def view(*args, **kwargs):
+        response = make_response(f(*args, **kwargs))
+
+        response.cache_control.no_cache = True
+        response.cache_control.no_store = True
+        response.cache_control.must_revalidate = True
+
+        return response
+
+    return view