invenio-app-rdm 8.0.0.dev9__py2.py3-none-any.whl → 14.0.0b4.dev4__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

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# 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 .oai_sets import OAICustomSets
+from .pages import StaticPages
+
+
+class Pages:
+    """Pages engine."""
+
+    def run(self, force=False):
+        """Run the pages loading."""
+        dir_ = Path(__file__).parent
+        app_data_folder = Path(current_app.instance_path) / "app_data"
+        app_pages_folder = app_data_folder / "pages"
+        data_folder = dir_ / "data"
+        pages_folder = dir_ / "pages"
+        StaticPages(
+            [app_data_folder, data_folder],
+            "pages.yaml",
+            [app_pages_folder, pages_folder],
+            force,
+        ).load()
+
+
+class FixturesEngine:
+    """Basic fixtures engine."""
+
+    def run(self):
+        """Run the fixtures loading."""
+        dir_ = Path(__file__).parent
+        app_data_folder = Path(current_app.instance_path) / "app_data"
+        app_pages_folder = app_data_folder / "pages"
+        data_folder = dir_ / "data"
+        pages_folder = dir_ / "pages"
+        OAICustomSets(
+            [app_data_folder, data_folder],
+            "oai_sets.yaml",
+        ).load()
+
+        StaticPages(
+            [app_data_folder, data_folder],
+            "pages.yaml",
+            [app_pages_folder, pages_folder],
+            force=True,
+        ).load()

invenio_app_rdm/fixtures/data/oai_sets.yaml

@@ -0,0 +1,6 @@
+- name: "OpenAIRE"
+  spec: "openaire"
+  search_pattern: "access.files:public AND metadata.resource_type.id:(publication OR poster OR presentation)"
+- name: "OpenAIRE Data"
+  spec: "openaire_data"
+  search_pattern: "metadata.resource_type.id:dataset"

invenio_app_rdm/fixtures/oai_sets.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+#
+# 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.
+
+"""OAI-PMH custom sets."""
+
+from invenio_access.permissions import system_identity
+from invenio_rdm_records.fixtures.fixture import FixtureMixin
+from invenio_rdm_records.proxies import current_oaipmh_server_service
+
+
+class OAICustomSets(FixtureMixin):
+    """OAI-PMH custom sets."""
+
+    def create(self, entry):
+        """Create an OAI set."""
+        current_oaipmh_server_service.create(system_identity, entry)

invenio_app_rdm/fixtures/pages/.gitkeep

@@ -0,0 +1 @@
+# This file exists only to add templates/ folder to git repository.

invenio_app_rdm/fixtures/pages.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+#
+# 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
+
+
+class StaticPages(FixtureMixin):
+    """Static pages."""
+
+    def __init__(self, search_paths, filename, pages_path, force=False):
+        """Initialize the fixture."""
+        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."""
+        if self._force:
+            current_pages_service.delete_all(system_identity)
+
+        super().load()
+        db.session.commit()
+
+    def page_data(self, page, lang):
+        """Returns content of template."""
+        for path in self._pages_path:
+            filepath = Path(str(path / page) + "." + lang)
+
+            if not filepath.exists():
+                filepath = path / page
+
+                if not filepath.exists():
+                    continue
+
+            return Path(filepath).read_bytes().decode("utf8")
+
+    def create(self, entry):
+        """Load a single page."""
+        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/previewer/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2022 data-futures.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""InvenioRDM previewers."""

invenio_app_rdm/records_ui/previewer/iiif_simple.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2022 data-futures.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Simple IIIF image preview."""
+
+from os.path import splitext
+
+from flask import current_app, render_template
+from werkzeug.local import LocalProxy
+
+previewable_extensions = LocalProxy(lambda: current_app.config["IIIF_FORMATS"].keys())
+
+# extensions that can be put in <img> tag - all others converted to jpg
+native_extensions = LocalProxy(
+    lambda: current_app.config["IIIF_SIMPLE_PREVIEWER_NATIVE_EXTENSIONS"]
+)
+
+
+def can_preview(file):
+    """Check if file can be previewed by this previewer.
+
+    :param file: The file to be previewed.
+    :returns: Boolean
+    """
+    # supported_extensions list needs . prefixed -
+    supported_extensions = ["." + ext for ext in previewable_extensions]
+    return file.has_extensions(*supported_extensions)
+
+
+def preview(file):
+    """Render template.
+
+    :param file: Image file to preview.
+    :returns: Rendered template with image from IIIF service.
+    """
+    ext = splitext(file.filename)[1].lower()[1:]
+    format = ext if ext in native_extensions else "jpg"
+    size = LocalProxy(lambda: current_app.config["IIIF_SIMPLE_PREVIEWER_SIZE"])
+
+    url = f"{file.data['links']['iiif_base']}/full/{size}/0/default.{format}"
+    return render_template(
+        current_app.config["IIIF_PREVIEW_TEMPLATE"],
+        css_bundles=["iiif-simple-previewer.css"],
+        file=file,
+        file_url=url,
+    )

invenio_app_rdm/records_ui/searchapp.py

@@ -7,250 +7,64 @@
 
 """Configuration helper for React-SearchKit."""
 
-from copy import deepcopy
 from functools import partial
 
 from flask import current_app
-from invenio_rdm_records.searchconfig import OptionsSelector, \
-    SortOptionsSelector
-
-
-class SortConfig(SortOptionsSelector):
-    """Sort options for the search configuration."""
-
-    def map_option(self, key, option):
-        """Generate a RSK search option."""
-        return {
-            "sortBy": key,
-            "text": option['title']
-        }
-
-
-class FacetsConfig(OptionsSelector):
-    """Facets options for the search configuration."""
-
-    def map_option(self, key, option):
-        """Generate an RSK aggregation option."""
-        title = option.get('title', option['facet']._label)
-
-        ui = deepcopy(option['ui'])
-        ui.update({
-            'aggName': key,
-            'title': title,
-        })
-
-        # Nested facets
-        if 'childAgg' in ui:
-            ui['childAgg'].setdefault('aggName', 'inner')
-            ui['childAgg'].setdefault('title', title)
-
-        return ui
-
-
-class SearchAppConfig:
-    """Configuration generator for React-SearchKit."""
-
-    default_options = dict(
-        endpoint=None,
-        hidden_params=None,
-        app_id='rdm-search',
-        headers=None,
-        list_view=True,
-        grid_view=False,
-        pagination_options=(10, 20, 50),
-        default_size=10,
-        default_page=1,
-        facets=None,
-        sort=None,
-        initial_filters=[],
-    )
-
-    def __init__(self, configuration_options):
-        """Initialize the search configuration.
-
-        :param endpoint: The URL path to the REST API.
-        :param hidden_params: Nested arrays containing any additional query
-            parameters to be used in the search.
-        :param app_id: The string ID of the Search Application.
-        :param headers: Dictionary containing additional headers to be included
-             in the request.
-        :param list_view: Boolean enabling the list view of the results.
-        :param grid_view: Boolean enabling the grid view of the results.
-        :param pagination_options: An integer array providing the results per
-            page options.
-        :param default_size: An integer setting the default number of results
-            per page.
-        :param default_page: An integer setting the default page.
-        """
-        options = deepcopy(self.default_options)
-        options.update(configuration_options)
-        for key, value in options.items():
-            setattr(self, key, value)
-
-    @property
-    def appId(self):
-        """The React appplication id."""
-        return self.app_id
-
-    @property
-    def initialQueryState(self):
-        """Generate initialQueryState."""
-        return {
-            'hiddenParams': self.hidden_params,
-            'layout': 'list' if self.list_view else 'grid',
-            "size": self.default_size,
-            "sortBy": self.sort.default,
-            "page": self.default_page,
-            "filters": self.initial_filters,
-        }
-
-    @property
-    def searchApi(self):
-        """Generate searchAPI configuration."""
-        return {
-            "axios": {
-                "url": self.endpoint,
-                "withCredentials": True,
-                "headers": self.headers,
-            },
-            "invenio": {
-                "requestSerializer":
-                    "InvenioRecordsResourcesRequestSerializer",
-            }
-        }
-
-    @property
-    def layoutOptions(self):
-        """Generate the Layout Options.
-
-        :returns: A dict with the options for React-SearchKit JS.
-        """
-        return {
-            'listView': self.list_view,
-            'gridView': self.grid_view
-        }
-
-    @property
-    def sortOptions(self):
-        """Format sort options to be used in React-SearchKit JS.
-
-        :returns: A list of dicts with sorting options for React-SearchKit JS.
-        """
-        return list(self.sort) if self.sort is not None else []
-
-    @property
-    def aggs(self):
-        """Format the aggs configuration to be used in React-SearchKit JS.
-
-        :returns: A list of dicts for React-SearchKit JS.
-        """
-        return list(self.facets) if self.facets is not None else []
-
-    @property
-    def paginationOptions(self):
-        """Format the pagination options to be used in React-SearchKit JS."""
-        if not getattr(self, 'default_size') or \
-                self.default_size not in self.pagination_options:
-            raise ValueError(
-                'Parameter default_size should be part of pagination_options')
-        return {
-                "resultsPerPage": [
-                    {"text": str(option), "value": option}
-                    for option in self.pagination_options
-                ],
-                "defaultValue": self.default_size,
-            }
-
-    @property
-    def defaultSortingOnEmptyQueryString(self):
-        """Defines the default sorting options when there is no query."""
-        return {
-            "sortBy": self.sort.default_no_query,
-        }
-
-    @classmethod
-    def generate(cls, options, **kwargs):
-        """Create JSON config for React-Searchkit."""
-        generator_object = cls(options)
-        config = {
-            "appId": generator_object.appId,
-            "initialQueryState": generator_object.initialQueryState,
-            "searchApi": generator_object.searchApi,
-            "sortOptions": generator_object.sortOptions,
-            "aggs": generator_object.aggs,
-            "layoutOptions": generator_object.layoutOptions,
-            "sortOrderDisabled": True,
-            "paginationOptions": generator_object.paginationOptions,
-            "defaultSortingOnEmptyQueryString":
-                generator_object.defaultSortingOnEmptyQueryString
-
-        }
-        config.update(kwargs)
-        return config
-
-
-#
-# Application state context processors
-#
-def sort_config(config_name):
-    """Sort configuration."""
-    return SortConfig(
-        current_app.config['RDM_SORT_OPTIONS'],
-        current_app.config[config_name].get('sort', []),
-        current_app.config[config_name].get('sort_default', None),
-        current_app.config[config_name].get('sort_default_no_query'),
-    )
-
-
-def facets_config(config_name, available_facets):
-    """Facets configuration."""
-    return FacetsConfig(
-        available_facets,
-        current_app.config[config_name].get('facets', [])
-    )
-
-
-def search_app_config(
-    config_name, available_facets, endpoint, overrides=None, **kwargs
-):
-    """Search app config."""
-    opts = dict(
-        endpoint=endpoint,
-        headers={"Accept": "application/vnd.inveniordm.v1+json"},
-        grid_view=False,
-        sort=sort_config(config_name),
-        facets=facets_config(config_name, available_facets),
-    )
-    opts.update(kwargs)
-    overrides = overrides or {}
-    return SearchAppConfig.generate(opts, **overrides)
+from invenio_rdm_records.requests import CommunityInclusion, CommunitySubmission
+from invenio_search_ui.searchconfig import search_app_config
 
 
 def search_app_context():
     """Search app context processor."""
     return {
-        'search_app_config': partial(
+        "search_app_rdm_config": partial(
+            search_app_config,
+            "RDM_SEARCH",
+            current_app.config["RDM_FACETS"],
+            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,
-            'RDM_SEARCH',
-            current_app.config['RDM_FACETS'],
-            '/api/records'),
-        'search_app_user_uploads_config': partial(
+            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,
-            'RDM_SEARCH_DRAFTS',
-            current_app.config['RDM_FACETS'],
-            '/api/user/records'
+            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_user_communities_config': partial(
+        "search_app_rdm_record_user_communities_config": partial(
             search_app_config,
-            'RDM_SEARCH_USER_COMMUNITIES',
-            current_app.config['COMMUNITIES_FACETS'],
-            '/api/user/communities', headers={"Accept": "application/json"}),
-        'search_app_user_requests_config': partial(
+            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,
-            'RDM_SEARCH_USER_REQUESTS',
-            current_app.config['REQUESTS_FACETS'],
-            '/api/requests',
+            config_name="RDM_SEARCH",
+            available_facets=current_app.config["RDM_FACETS"],
+            sort_options=current_app.config["RDM_SORT_OPTIONS"],
             headers={"Accept": "application/json"},
-            initial_filters=[["is_open", "true"]]
-        )
+        ),
     }