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

invenio_app_rdm/ext.py

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023-2024 Graz University of Technology.
+#
+# Invenio App 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.
+
+"""Invenio Research Data Management."""
+
+import warnings
+from datetime import timedelta
+
+from flask import request
+from flask_menu import current_menu
+from invenio_i18n import lazy_gettext as _
+
+from .communities_ui.views.ui import _show_browse_page
+
+
+def _is_branded_community():
+    """Function used to check if community is branded."""
+    community = request.community
+    if community.get("theme", {}).get("enabled", False):
+        return True
+    return False
+
+
+def finalize_app(app):
+    """Finalize app."""
+    init_menu(app)
+    init_config(app)
+
+
+def init_config(app):
+    """Initialize configuration."""
+    record_doi_required = bool(
+        app.config["RDM_PERSISTENT_IDENTIFIERS"].get("doi", {}).get("required")
+    )
+    parent_doi_required = bool(
+        app.config["RDM_PARENT_PERSISTENT_IDENTIFIERS"].get("doi", {}).get("required")
+    )
+
+    if record_doi_required != parent_doi_required:
+        raise Exception(
+            "Config variables RDM_PERSISTENT_IDENTIFIERS.doi.required and "
+            "RDM_PARENT_PERSISTENT_IDENTIFIERS.doi.required must be set to the same value."
+        )
+
+    if "COMMUNITIES_GROUPS_ENABLED" in app.config:
+        warnings.warn(
+            "COMMUNITIES_GROUPS_ENABLED config variable is deprecated. Please use USERS_RESOURCES_GROUPS_ENABLED "
+            "instead. For now, COMMUNITIES_GROUPS_ENABLED value will be taken into account and features related to "
+            "groups will be disabled if this was the intention.",
+            DeprecationWarning,
+        )
+
+        if not app.config["COMMUNITIES_GROUPS_ENABLED"]:
+            app.config["USERS_RESOURCES_GROUPS_ENABLED"] = False
+
+    # validate grace period
+    grace_period = app.config["RDM_RECORDS_RESTRICTION_GRACE_PERIOD"]
+    if not isinstance(grace_period, timedelta) or grace_period.total_seconds() < 0:
+        raise TypeError(
+            "RDM_RECORDS_RESTRICTION_GRACE_PERIOD config value must be of type datetime.timedelta with a "
+            "duration greater than or equal to 0. "
+        )
+
+
+def init_menu(app):
+    """Init menu."""
+    current_menu.submenu("actions.deposit").register(
+        endpoint="invenio_app_rdm_users.uploads",
+        text=_("My dashboard"),
+        order=1,
+    )
+
+    current_menu.submenu("plus.deposit").register(
+        endpoint="invenio_app_rdm_records.deposit_create",
+        text=_("New upload"),
+        order=1,
+    )
+
+    current_menu.submenu("notifications.requests").register(
+        "invenio_app_rdm_users.requests",
+        order=1,
+    )
+
+    user_dashboard = current_menu.submenu("dashboard")
+    # set dashboard-config to its default
+    user_dashboard_menu_config = {
+        "uploads": {
+            "endpoint": "invenio_app_rdm_users.uploads",
+            "text": _("Uploads"),
+            "order": 1,
+        },
+        "communities": {
+            "endpoint": "invenio_app_rdm_users.communities",
+            "text": _("Communities"),
+            "order": 2,
+        },
+        "requests": {
+            "endpoint": "invenio_app_rdm_users.requests",
+            "text": _("Requests"),
+            "order": 3,
+        },
+    }
+
+    # apply dashboard-config overrides
+    for submenu_name, submenu_kwargs in app.config[
+        "USER_DASHBOARD_MENU_OVERRIDES"
+    ].items():
+        if submenu_name not in user_dashboard_menu_config:
+            raise ValueError(
+                f"attempting to override dashboard's submenu `{submenu_name}`, "
+                "but dashboard has no registered submenu of that name"
+            )
+        user_dashboard_menu_config[submenu_name].update(submenu_kwargs)
+
+    # register dashboard-menus
+    for submenu_name, submenu_kwargs in user_dashboard_menu_config.items():
+        user_dashboard.submenu(submenu_name).register(**submenu_kwargs)
+
+    communities = current_menu.submenu("communities")
+    communities.submenu("home").register(
+        "invenio_app_rdm_communities.communities_home",
+        text=_("Home"),
+        order=5,
+        visible_when=_is_branded_community,
+        expected_args=["pid_value"],
+        **dict(icon="home", permissions="can_read"),
+    )
+    communities.submenu("browse").register(
+        endpoint="invenio_app_rdm_communities.communities_browse",
+        text=_("Browse"),
+        order=15,
+        visible_when=_show_browse_page,
+        expected_args=["pid_value"],
+        **{"icon": "list", "permissions": "can_read"},
+    )
+    communities.submenu("search").register(
+        "invenio_app_rdm_communities.communities_detail",
+        text=_("Records"),
+        order=10,
+        expected_args=["pid_value"],
+        **dict(icon="search", permissions=True),
+    )
+    communities.submenu("submit").register(
+        "invenio_app_rdm_communities.community_static_page",
+        text=_("Submit"),
+        order=15,
+        visible_when=_is_branded_community,
+        endpoint_arguments_constructor=lambda: {
+            "pid_value": request.view_args["pid_value"],
+            "page_slug": "how-to-submit",
+        },
+        **dict(icon="upload", permissions="can_read"),
+    )

invenio_app_rdm/fixtures/__init__.py

@@ -11,8 +11,8 @@ from pathlib import Path
 
 from flask import current_app
 
-from invenio_app_rdm.fixtures.oai_sets import OAICustomSets
-from invenio_app_rdm.fixtures.pages import StaticPages
+from .oai_sets import OAICustomSets
+from .pages import StaticPages
 
 
 class Pages:

invenio_app_rdm/fixtures/pages.py

@@ -1,17 +1,21 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2022 CERN.
+# Copyright (C) 2022-2025 CERN.
+# Copyright (C) 2025 University of Münster.
 #
 # Invenio App 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.
 
 """Static pages."""
+
 from pathlib import Path
 
 from flask import current_app
 from invenio_access.permissions import system_identity
 from invenio_db import db
+from invenio_i18n.proxies import current_i18n
 from invenio_pages.proxies import current_pages_service
+from invenio_pages.records.errors import PageNotFoundError
 from invenio_rdm_records.fixtures.fixture import FixtureMixin
 
 
@@ -23,6 +27,7 @@ class StaticPages(FixtureMixin):
         super().__init__(search_paths, filename)
         self._force = force
         self._pages_path = pages_path
+        self._supported_languages = current_i18n.get_languages()
 
     def load(self):
         """Load the static pages."""
@@ -32,23 +37,40 @@ class StaticPages(FixtureMixin):
         super().load()
         db.session.commit()
 
-    def page_data(self, page):
+    def page_data(self, page, lang):
         """Returns content of template."""
         for path in self._pages_path:
-            filepath = path / page
+            filepath = Path(str(path / page) + "." + lang)
 
             if not filepath.exists():
-                continue
+                filepath = path / page
+
+                if not filepath.exists():
+                    continue
 
             return Path(filepath).read_bytes().decode("utf8")
 
     def create(self, entry):
         """Load a single page."""
-        data = {
-            "url": entry.pop("url"),
-            "title": entry.get("title"),
-            "content": self.page_data(entry.get("template")),
-            "description": entry.get("description"),
-            "template_name": current_app.config["PAGES_DEFAULT_TEMPLATE"],
-        }
-        current_pages_service.create(system_identity, data)
+        url = entry["url"]
+        for lang in self._supported_languages:
+            try:
+                current_pages_service.read_by_url(system_identity, url, lang[0])
+            except PageNotFoundError:
+                data = {
+                    "url": url,
+                    "title": entry.get("title", ""),
+                    # content is optional as it can be added later from the administration panel
+                    "content": (
+                        self.page_data(entry["template"], lang[0])
+                        if entry.get("template")
+                        else ""
+                    ),
+                    "lang": lang[0],
+                    "description": entry.get("description", ""),
+                    "template_name": entry.get(
+                        "template_name",
+                        current_app.config["PAGES_DEFAULT_TEMPLATE"],
+                    ),
+                }
+                current_pages_service.create(system_identity, data)

invenio_app_rdm/records_ui/searchapp.py

@@ -10,6 +10,7 @@
 from functools import partial
 
 from flask import current_app
+from invenio_rdm_records.requests import CommunityInclusion, CommunitySubmission
 from invenio_search_ui.searchconfig import search_app_config
 
 
@@ -23,5 +24,47 @@ def search_app_context():
             current_app.config["RDM_SORT_OPTIONS"],
             "/api/records",
             {"Accept": "application/vnd.inveniordm.v1+json"},
+            pagination_options=(10, 20),
+        ),
+        "search_app_rdm_record_requests_config": partial(
+            search_app_config,
+            config_name="RDM_SEARCH_USER_REQUESTS",
+            available_facets=current_app.config["REQUESTS_FACETS"],
+            sort_options=current_app.config["RDM_SORT_OPTIONS"],
+            headers={"Accept": "application/json"},
+            hidden_params=[
+                ["expand", "1"],
+                ["is_open", "true"],
+                ["type", CommunityInclusion.type_id],
+                ["type", CommunitySubmission.type_id],
+            ],
+            page=1,
+            size=5,
+        ),
+        "search_app_rdm_record_communities_config": partial(
+            search_app_config,
+            config_name="RDM_SEARCH_USER_COMMUNITIES",
+            available_facets=current_app.config["COMMUNITIES_FACETS"],
+            sort_options=current_app.config["RDM_SORT_OPTIONS"],
+            headers={"Accept": "application/vnd.inveniordm.v1+json"},
+            pagination_options=(10, 20),
+        ),
+        "search_app_rdm_record_user_communities_config": partial(
+            search_app_config,
+            config_name="RDM_SEARCH_USER_COMMUNITIES",
+            available_facets=current_app.config["COMMUNITIES_FACETS"],
+            sort_options=current_app.config["RDM_SORT_OPTIONS"],
+            headers={"Accept": "application/vnd.inveniordm.v1+json"},
+            hidden_params=[
+                ["membership", "true"],
+            ],
+            pagination_options=(10, 20),
+        ),
+        "search_app_access_links_config": partial(
+            search_app_config,
+            config_name="RDM_SEARCH",
+            available_facets=current_app.config["RDM_FACETS"],
+            sort_options=current_app.config["RDM_SORT_OPTIONS"],
+            headers={"Accept": "application/json"},
         ),
     }

invenio_app_rdm/records_ui/sitemap.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+# Copyright (C) 2025 Northwestern University.
+#
+# Invenio-App-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.
+
+"""RDMRecords sitemap content."""
+
+from invenio_base import invenio_url_for
+from invenio_rdm_records.proxies import current_rdm_records_service
+from invenio_search.api import RecordsSearchV2
+from invenio_sitemap import SitemapSection, format_to_w3c
+
+
+class SitemapSectionOfRDMRecords(SitemapSection):
+    """Defines the Sitemap entries for Records."""
+
+    def iter_entities(self):
+        """Iterate over objects."""
+        records_scan = (
+            RecordsSearchV2(index=current_rdm_records_service.record_cls.index._name)
+            .filter("term", **{"access.record": "public"})
+            .filter("term", deletion_status="P")
+            .sort("-updated")
+            # Using preserve_order is fine.
+            # Using Point in Time is a recommended alternative but not
+            # particularly better than this one for our needs. See
+            # https://opensearch.org/docs/latest/search-plugins/searching-data/point-in-time/
+            .params(preserve_order=True)
+            .source(["id", "updated"])
+            .scan()
+        )
+        return records_scan
+
+    def to_dict(self, entity):
+        """To dict used in sitemap."""
+        return {
+            "loc": invenio_url_for(
+                "invenio_app_rdm_records.record_detail", pid_value=entity["id"]
+            ),
+            "lastmod": format_to_w3c(entity["updated"]),
+        }

invenio_app_rdm/records_ui/templates/semantic-ui/invenio_app_rdm/records/deposit.html

@@ -1,39 +1,82 @@
-{#
-  Copyright (C) 2020 CERN.
-  Copyright (C) 2020 Northwestern University.
-
-  Invenio App 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.
-#}
-{%- if not record.is_published and record.versions.index and record.versions.index > 1%}
+
+{%- extends config.BASE_TEMPLATE %}
+
+{%- if community and community.theme and community.theme.enabled %}
+  {%- block css %}
+  {{ super() }}
+  <link rel="stylesheet" type="text/css" href="/communities/{{community.slug}}/community-theme-{{ community.revision_id }}.css">
+  {%- if config.APP_RDM_DEPOSIT_NG_FILES_UI_ENABLED %}
+  {{ webpack['uppy-file-uploader.css'] }}
+  {%- endif %}
+  {%- endblock %}
+{%- endif %}
+
+{%- if not record.is_published and record.versions.index and record.versions.index > 1 %}
   {%- set title = _("New version") %}
 {%- elif not record.is_published %}
   {%- set title = _("New upload") %}
 {% else %}
   {%- set title = _("Edit upload") %}
 {%- endif %}
-{%- extends config.BASE_TEMPLATE %}
 
 {%- block page_body %}
+
+{%- if community_use_jinja_header %}
+{%- include "invenio_communities/details/header.html" %}
+{%- endif %}
+
   {%- if record %}
-  <input id="deposits-record" type="hidden" name="deposits-record" value='{{record | tojson }}'></input>
+    <input id="deposits-record" type="hidden" name="deposits-record"
+           value='{{ record | tojson }}'>
+
+    <input id="deposits-record-locked-files" type="hidden"
+           name="deposits-record-locked-files"
+           value='{{ files_locked | tojson }}'>
   {%- endif %}
+
   {%- if preselectedCommunity %}
-  <input id="deposits-draft-community" type="hidden" name="deposits-draft-community" value='{{preselectedCommunity | tojson }}'></input>
+    <input id="deposits-draft-community" type="hidden" name="deposits-draft-community"
+           value='{{ preselectedCommunity | tojson }}'>
   {%- endif %}
+
   {%- if files %}
-  <input id="deposits-record-files" type="hidden" name="deposits-record-files" value='{{files | tojson }}'></input>
+    <input id="deposits-record-files" type="hidden" name="deposits-record-files"
+           value='{{ files | tojson }}'>
   {%- endif %}
+
+  <input type="hidden" name="deposits-record-restriction-grace-period"
+          value='{{ config.RDM_RECORDS_RESTRICTION_GRACE_PERIOD.days | tojson }}'>
+  <input type="hidden" name="deposits-allow-record-restriction"
+          value='{{ config.RDM_RECORDS_ALLOW_RESTRICTION_AFTER_GRACE_PERIOD | tojson }}'>
+  {% if record_deletion %}
+    <input type="hidden" name="deposits-record-deletion" value='{{ record_deletion | tojson }}'>
+  {% endif %}
+  {% if file_modification %}
+    <input type="hidden" name="deposits-file-modification" value='{{ file_modification | tojson }}'>
+  {% endif %}
+  <input type="hidden" name="config-groups-enabled"
+          value='{{ config.USERS_RESOURCES_GROUPS_ENABLED | tojson }}'>
+  <input type="hidden" name="records-resources-allow-empty-files"
+          value='{{ config.RECORDS_RESOURCES_ALLOW_EMPTY_FILES | tojson }}'>
+  <input type="hidden" name="deposits-use-uppy-ui"
+          value='{{ config.APP_RDM_DEPOSIT_NG_FILES_UI_ENABLED | tojson }}'>
+
   {%- if forms_config %}
-  <input type="hidden" name="deposits-config" value='{{forms_config | tojson }}'></input>
+    <input type="hidden" name="deposits-config"
+           value='{{ forms_config | tojson }}'>
   {%- endif %}
+
   {%- if permissions %}
-  <input id="deposits-record-permissions" type="hidden" name="deposits-record-permissions" value='{{permissions | tojson }}'></input>
+    <input id="deposits-record-permissions" type="hidden"
+           name="deposits-record-permissions"
+           value='{{ permissions | tojson }}'>
   {%- endif %}
+
   <div id="deposit-form"></div>
+
 {%- endblock page_body %}
 
 {%- block javascript %}
-    {{ super() }}
-    {{ webpack['invenio-app-rdm-deposit.js'] }}
+  {{ super() }}
+  {{ webpack['invenio-app-rdm-deposit.js'] }}
 {%- endblock %}