urls: integrate invenio_url_for

Author: fenekku

invenio_rdm_records/oaiserver/services/config.py

@@ -10,11 +10,10 @@
 from invenio_i18n import lazy_gettext as _
 from invenio_oaiserver.models import OAISet
 from invenio_records_resources.services import ServiceConfig
-from invenio_records_resources.services.base import Link
-from invenio_records_resources.services.records.links import pagination_links
+from invenio_records_resources.services.base import EndpointLink
+from invenio_records_resources.services.records.links import pagination_endpoint_links
 from sqlalchemy import asc, desc
 
-from ..services.links import OAIPMHSetLink
 from ..services.permissions import OAIPMHServerPermissionPolicy
 from ..services.results import (
     OAIMetadataFormatItem,
@@ -90,21 +89,74 @@ class OAIPMHServerServiceConfig(ServiceConfig):
     metadata_format_schema = OAIPMHMetadataFormat
 
     links_item = {
-        "self": OAIPMHSetLink("{+api}/oaipmh/sets/{id}"),
-        "oai-listrecords": OAIPMHSetLink(
-            "{+ui}/oai2d?verb=ListRecords&metadataPrefix=oai_dc&set={spec}"
+        "self": EndpointLink(
+            "oaipmh-server.read",
+            vars=lambda obj, vars_: vars_.update({"id": obj.id}),
+            params=["id"],
         ),
-        "oai-listidentifiers": OAIPMHSetLink(
-            "{+ui}/oai2d?verb=ListIdentifiers&metadataPrefix=oai_dc&set={spec}"
+        "oai-listrecords": EndpointLink(
+            "invenio_oaiserver.response",
+            vars=lambda obj, vars_: vars_.update(
+                {
+                    # querystring parameters
+                    "args": {
+                        "verb": "ListRecords",
+                        "metadataPrefix": "oai_dc",
+                        "set": obj.spec,
+                    }
+                }
+            ),
+        ),
+        "oai-listidentifiers": EndpointLink(
+            "invenio_oaiserver.response",
+            vars=lambda obj, vars_: vars_.update(
+                {
+                    "args": {
+                        "verb": "ListIdentifiers",
+                        "metadataPrefix": "oai_dc",
+                        "set": obj.spec,
+                    }
+                }
+            ),
         ),
     }
 
     links_search = {
-        **pagination_links("{+api}/oaipmh/sets{?args*}"),
-        "oai-listsets": Link("{+ui}/oai2d?verb=ListSets"),
-        "oai-listrecords": Link("{+ui}/oai2d?verb=ListRecords&metadataPrefix=oai_dc"),
-        "oai-listidentifiers": Link(
-            "{+ui}/oai2d?verb=ListIdentifiers&metadataPrefix=oai_dc"
+        **pagination_endpoint_links("oaipmh-server.search"),
+        "oai-listsets": EndpointLink(
+            "invenio_oaiserver.response",
+            vars=lambda obj, vars_: vars_.update({"args": {"verb": "ListSets"}}),
+        ),
+        "oai-listrecords": EndpointLink(
+            "invenio_oaiserver.response",
+            vars=lambda obj, vars_: vars_.update(
+                {
+                    "args": {
+                        "verb": "ListRecords",
+                        "metadataPrefix": "oai_dc",
+                    }
+                }
+            ),
+        ),
+        "oai-listidentifiers": EndpointLink(
+            "invenio_oaiserver.response",
+            vars=lambda obj, vars_: vars_.update(
+                {
+                    "args": {
+                        "verb": "ListIdentifiers",
+                        "metadataPrefix": "oai_dc",
+                    }
+                }
+            ),
+        ),
+        "oai-identify": EndpointLink(
+            "invenio_oaiserver.response",
+            vars=lambda obj, vars_: vars_.update(
+                {
+                    "args": {
+                        "verb": "Identify",
+                    }
+                }
+            ),
         ),
-        "oai-identify": Link("{+ui}/oai2d?verb=Identify"),
     }

invenio_rdm_records/oaiserver/services/links.py

@@ -568,7 +568,7 @@ class RDMCommunityRecordsResourceConfig(RecordResourceConfig, ConfiguratorMixin)
 class RDMRecordCommunitiesResourceConfig(CommunityResourceConfig, ConfiguratorMixin):
     """Record communities resource config."""
 
-    blueprint_name = "records-community"
+    blueprint_name = "record_communities"
     url_prefix = "/records"
     routes = {
         "list": "/<pid_value>/communities",
@@ -586,7 +586,7 @@ class RDMRecordCommunitiesResourceConfig(CommunityResourceConfig, ConfiguratorMi
 class RDMRecordRequestsResourceConfig(ResourceConfig, ConfiguratorMixin):
     """Record communities resource config."""
 
-    blueprint_name = "records-requests"
+    blueprint_name = "record_requests"
     url_prefix = "/records"
     routes = {"list": "/<record_pid>/requests"}
 

invenio_rdm_records/resources/config.py

@@ -15,6 +15,7 @@
 
 from flask import abort, current_app, g, redirect, url_for
 from flask_resources import Resource, resource_requestctx, response_handler, route
+from invenio_base import invenio_url_for
 from invenio_drafts_resources.resources import RecordResource
 from invenio_records_resources.resources.errors import ErrorHandlersMixin
 from invenio_records_resources.resources.records.resource import (
@@ -29,8 +30,6 @@
 from invenio_stats import current_stats
 from sqlalchemy.exc import NoResultFound
 
-from .urls import record_url_for
-
 
 def response_header_signposting(f):
     """Add signposting link to view's reponse headers.
@@ -44,8 +43,7 @@ def response_header_signposting(f):
     @wraps(f)
     def inner(*args, **kwargs):
         pid_value = resource_requestctx.view_args["pid_value"]
-        signposting_link = record_url_for(_app="api", pid_value=pid_value)
-
+        signposting_link = invenio_url_for("records.read", pid_value=pid_value)
         response = f(*args, **kwargs)
         if response.status_code != 200:
             return response

invenio_rdm_records/resources/resources.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2021-2024 CERN.
-# Copyright (C) 2021 Northwestern University.
+# Copyright (C) 2021-2025 Northwestern University.
 # Copyright (C) 2023 Graz University of Technology.
 # Copyright (C) 2023 Caltech.
 #
@@ -15,6 +15,7 @@
 from flask import current_app
 from flask_resources.serializers import BaseSerializerSchema
 from invenio_access.permissions import system_identity
+from invenio_base import invenio_url_for
 from invenio_i18n import lazy_gettext as _
 from marshmallow import Schema, ValidationError, fields, missing, post_dump, validate
 from marshmallow_utils.fields import SanitizedUnicode
@@ -458,7 +459,9 @@ def get_related_identifiers(self, obj):
         communities = obj.get("parent", {}).get("communities", {}).get("entries", [])
         for community in communities:
             slug = community.get("slug")
-            url = f"{current_app.config['SITE_UI_URL']}/communities/{slug}"
+            url = invenio_url_for(
+                "invenio_app_rdm_communities.communities_home", pid_value=slug
+            )
             serialized_identifiers.append(
                 {
                     "relatedIdentifier": url,

invenio_rdm_records/resources/serializers/datacite/schema.py

@@ -1,14 +1,15 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2023-2024 CERN.
+# Copyright (C) 2025 Northwestern University.
 #
 # 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.
 
 """Dcat based Schema for Invenio RDM Records."""
 
 import idutils
-from flask import current_app
+from invenio_base import invenio_url_for
 from marshmallow import ValidationError, fields, missing, validate
 from marshmallow_utils.html import sanitize_unicode
 
@@ -32,7 +33,11 @@ def get_files(self, obj):
             file_name = sanitize_unicode(
                 value["key"]
             )  # There can be inconsistencies in the file name i.e. if the file name consists of invalid XML characters
-            url = f"{current_app.config['SITE_UI_URL']}/records/{record_id}/files/{file_name}"
+            url = invenio_url_for(
+                "invenio_app_rdm_records.record_file_download",
+                pid_value=record_id,
+                filename=file_name,
+            )
             access_url = None
             if "doi" in obj["pids"]:
                 access_url = idutils.to_url(

invenio_rdm_records/resources/serializers/dcat/schema.py

@@ -9,8 +9,8 @@
 
 import bleach
 import idutils
-from flask import current_app
 from flask_resources.serializers import BaseSerializerSchema
+from invenio_base import invenio_url_for
 from marshmallow import fields, missing
 from pydash import py_
 
@@ -103,7 +103,11 @@ def get_relations(self, obj):
         communities = obj.get("parent", {}).get("communities", {}).get("entries", [])
         for community in communities:
             slug = community["slug"]
-            url = f"{current_app.config['SITE_UI_URL']}/communities/{slug}"
+            url = invenio_url_for(
+                "invenio_app_rdm_communities.communities_home",
+                pid_value=slug,
+            )
+
             rels.append(self._transform_identifier(url, "url"))
 
         # Parent doi

invenio_rdm_records/resources/serializers/dublincore/schema.py

@@ -10,8 +10,8 @@
 import bleach
 from dateutil.parser import parse
 from dojson.contrib.to_marc21.fields.bdleader import to_leader
-from flask import current_app
 from flask_resources.serializers import BaseSerializerSchema
+from invenio_base import invenio_url_for
 from marshmallow import fields, missing
 from marshmallow_utils.html import sanitize_unicode
 from pydash import py_
@@ -134,7 +134,12 @@ def get_files(self, obj):
         files = []
         for file_entry in files_entries.values():
             file_name = sanitize_unicode(file_entry["key"])
-            url = f"{current_app.config['SITE_UI_URL']}/records/{record_id}/files/{file_name}"
+            url = invenio_url_for(
+                "invenio_app_rdm_records.record_file_download",
+                pid_value=record_id,
+                filename=file_name,
+            )
+
             file_ = {
                 "s": str(file_entry["size"]),  # file size
                 "z": file_entry["checksum"],  # check sum

invenio_rdm_records/resources/serializers/marcxml/schema.py

@@ -9,9 +9,9 @@
 """Signposting schemas."""
 
 import idutils
+from invenio_base import invenio_url_for
 from marshmallow import Schema, fields, missing, post_dump
 
-from ...urls import download_url_for
 from ..utils import get_vocabulary_props
 
 
@@ -83,7 +83,11 @@ def serialize_item(self, obj, **kwargs):
 
         result = [
             {
-                "href": download_url_for(pid_value=obj["id"], filename=entry["key"]),
+                "href": invenio_url_for(
+                    "invenio_app_rdm_records.record_file_download",
+                    pid_value=obj["id"],
+                    filename=entry["key"],
+                ),
                 "type": entry["mimetype"],
             }
             for entry in file_entries.values()
@@ -197,7 +201,11 @@ class ContentResourceSchema(Schema):
     def serialize_anchor(self, obj, **kwargs):
         """Serialize to download url."""
         pid_value = self.context["record_dict"]["id"]
-        return download_url_for(pid_value=pid_value, filename=obj["key"])
+        return invenio_url_for(
+            "invenio_app_rdm_records.record_file_download",
+            pid_value=pid_value,
+            filename=obj["key"],
+        )
 
     def serialize_collection(self, obj, **kwargs):
         """Serialize to record landing page url."""