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

invenio_app_rdm/__init__.py

@@ -1,13 +1,22 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2019 CERN.
-# Copyright (C) 2019 Northwestern University.
+# Copyright (C) 2019-2025 CERN.
+# Copyright (C) 2019-2022 Northwestern University.
+# Copyright (C) 2024-2025 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 App RDM."""
 
-from .version import __version__
+# Note, that dev versions must have an extra dot compared to alpha/beta/rc
+# versions in the version string. Examples:
+#
+# Correct: "1.0.0.dev0" and "1.0.0a1" and "1.0.0rc1"
+# Incorrect: "1.0.0dev0" and "1.0.0.a1" and "1.0.0.rc1"
+#
+# See PEP 0440 for details - https://www.python.org/dev/peps/pep-0440
+
+__version__ = "14.0.0b4.dev4"
 
-__all__ = ('__version__', )
+__all__ = ("__version__",)

invenio_app_rdm/administration/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023 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.
+
+"""Invenio app rdm administration module."""

invenio_app_rdm/administration/audit_logs/__init__.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 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.
+
+"""Audit logs administration module."""
+
+from .audit_logs import AuditLogListView
+
+__all__ = "AuditLogListView"

invenio_app_rdm/administration/audit_logs/audit_logs.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 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.
+
+"""Invenio administration view module for audit logs."""
+from flask import current_app
+from invenio_administration.views.base import AdminResourceListView
+from invenio_i18n import lazy_gettext as _
+
+
+class AuditLogListView(AdminResourceListView):
+    """Audit logs admin search view."""
+
+    api_endpoint = "/audit-logs/"
+    extension_name = "invenio-audit-logs"
+    name = "audit-logs"
+    resource_config = "audit_log_resource"
+
+    title = "Audit Logs"
+    menu_label = "Audit Logs"
+    category = "Logs"
+    pid_path = "id"
+    icon = "file alternate"
+    template = "invenio_app_rdm/administration/audit_logs.html"
+    order = 1
+    search_request_headers = {"Accept": "application/vnd.inveniordm.v1+json"}
+
+    display_search = True
+    display_delete = False
+    display_create = False
+    display_edit = False
+
+    item_field_list = {
+        "resource.type": {
+            "text": _("Resource"),
+            "order": 1,
+            "width": 2,
+        },
+        "resource.id": {
+            "text": _("Resource ID"),
+            "order": 2,
+        },
+        "action": {
+            "text": _("Action"),
+            "order": 3,
+        },
+        "user.id": {
+            "text": _("User"),
+            "order": 4,
+        },
+        "created": {
+            "text": _("Created"),
+            "order": 5,
+        },
+    }
+
+    actions = {
+        "view_log": {
+            "text": _("View Log"),
+            "payload_schema": None,
+            "order": 1,
+        },
+        "view_changes": {
+            "text": _("View Changes"),
+            "payload_schema": None,
+            "order": 2,
+            "show_for": ["record.publish"],
+        },
+    }
+
+    search_config_name = "AUDIT_LOGS_SEARCH"
+    search_facets_config_name = "AUDIT_LOGS_FACETS"
+    search_sort_config_name = "AUDIT_LOGS_SORT_OPTIONS"
+
+    @staticmethod
+    def disabled():
+        """Disable the view on demand."""
+        return not current_app.config["AUDIT_LOGS_ENABLED"]

invenio_app_rdm/administration/domains/__init__.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 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.
+
+"""Invenio administration module for user resources."""
+
+from .domains import (
+    DomainsCreateView,
+    DomainsDetailView,
+    DomainsEditView,
+    DomainsListView,
+)
+
+__all__ = (
+    "DomainsCreateView",
+    "DomainsDetailView",
+    "DomainsEditView",
+    "DomainsListView",
+)

invenio_app_rdm/administration/domains/domains.py

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 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.
+
+"""Invenio administration domains view module."""
+
+from invenio_administration.views.base import (
+    AdminResourceCreateView,
+    AdminResourceDetailView,
+    AdminResourceEditView,
+    AdminResourceListView,
+)
+from invenio_i18n import lazy_gettext as _
+
+
+class DomainAdminMixin:
+    """Common admin properties."""
+
+    resource_config = "domains_resource"
+    extension_name = "invenio-users-resources"
+
+    api_endpoint = "/domains"
+    pid_path = "domain"
+
+    create_view_name = "domains_create"
+    list_view_name = "domains"
+
+    display_search = True
+    display_delete = True
+    display_create = True
+    display_edit = True
+
+
+class DomainsListView(DomainAdminMixin, AdminResourceListView):
+    """Search admin view."""
+
+    name = "domains"
+    title = _("Domains")
+    menu_label = _("Domains")
+    category = _("Site management")
+    icon = "world"
+
+    item_field_list = {
+        "domain": {"text": _("Domain"), "order": 1, "width": 3},
+        "tld": {"text": _("TLD"), "order": 2, "width": 1},
+        "status_name": {"text": _("Status"), "order": 3, "width": 1},
+        "num_users": {"text": _("Users"), "order": 6, "width": 1},
+        "num_active": {"text": _("Active"), "order": 7, "width": 1},
+        "num_inactive": {"text": _("Inactive"), "order": 8, "width": 1},
+        "num_confirmed": {"text": _("Confirmed"), "order": 9, "width": 1},
+        "num_verified": {"text": _("Verified"), "order": 10, "width": 1},
+        "num_blocked": {"text": _("Blocked"), "order": 11, "width": 1},
+        "links": {"text": "", "order": 13, "width": 1},
+    }
+
+    search_config_name = "USERS_RESOURCES_DOMAINS_SEARCH"
+    search_sort_config_name = "USERS_RESOURCES_DOMAINS_SORT_OPTIONS"
+    search_facets_config_name = "USERS_RESOURCES_DOMAINS_SEARCH_FACETS"
+
+    template = "invenio_app_rdm/administration/domains_search.html"
+
+    search_request_headers = {"Accept": "application/vnd.inveniordm.v1+json"}
+
+
+class FormMixin:
+    """Mixin class for form fields."""
+
+    form_fields = {
+        "domain": {
+            "order": 1,
+            "text": _("Domain"),
+            "description": _("Domain name (all lowercase)"),
+        },
+        "status_name": {
+            "order": 2,
+            "required": True,
+            "text": _("Status"),
+            "description": _(
+                "Status of the domain. One of new (domain needs review), moderated (users in domain require moderation), verified (users in domain does not require moderation) or blocked (users cannot register using this domain)."
+            ),
+            "options": [
+                {"title_l10n": "New", "id": "new"},
+                {"title_l10n": "Moderated", "id": "moderated"},
+                {"title_l10n": "Verified", "id": "verified"},
+                {"title_l10n": "Blocked", "id": "blocked"},
+            ],
+            "placeholder": "Select a status",
+        },
+        "category_name": {
+            "order": 3,
+            "text": _("Category"),
+            "description": _("A label to categorise the domain."),
+            "options": [
+                # TODO: Needs to be dynmaically loaded from domain category table.
+                {"title_l10n": "Organization", "id": "organization"},
+                {"title_l10n": "Company", "id": "company"},
+                {"title_l10n": "Mail provider", "id": "mailprovider"},
+                {"title_l10n": "Spammer", "id": "spammer"},
+            ],
+            "placeholder": "Select a category",
+        },
+        "flagged": {
+            "order": 4,
+            "text": _("Flagged"),
+            "description": _(
+                "Used by automatic processes to flag the domain as requiring review."
+            ),
+        },
+        "flagged_source": {
+            "order": 5,
+            "text": _("Source of flag"),
+            "description": _("Which source flagged the domain."),
+        },
+    }
+
+
+class DomainsCreateView(DomainAdminMixin, FormMixin, AdminResourceCreateView):
+    """Configuration for Banner create view."""
+
+    name = "domains_create"
+    url = "/domains/create"
+    title = _("Create domain")
+
+
+class DomainsEditView(DomainAdminMixin, FormMixin, AdminResourceEditView):
+    """Domain edit view."""
+
+    name = "domains_edit"
+    url = "/domains/<pid_value>/edit"
+    title = _("Edit domain")
+
+
+class DomainsDetailView(DomainAdminMixin, AdminResourceDetailView):
+    """Domain detail view."""
+
+    url = "/domains/<pid_value>"
+    name = "domains_details"
+    title = _("Domain details")
+
+    item_field_list = {
+        "domain": {"text": _("Domain"), "order": 1},
+        "tld": {"text": _("Top-level domain"), "order": 2},
+        "status_name": {"text": _("Status"), "order": 3},
+        "category_name": {"text": _("Category"), "order": 4},
+        "flagged": {"text": _("Flagged"), "order": 5},
+        "flagged_source": {"text": _("Source of flag"), "order": 6},
+        "created": {"text": _("Created"), "order": 7},
+        "updated": {"text": _("Updated"), "order": 8},
+        "org": {"text": _("Organisation"), "order": 9},
+        "num_users": {"text": _("Users"), "order": 10},
+        "num_active": {"text": _("Active"), "order": 11},
+        "num_inactive": {"text": _("Inactive"), "order": 12},
+        "num_confirmed": {"text": _("Confirmed"), "order": 13},
+        "num_verified": {"text": _("Verified"), "order": 14},
+        "num_blocked": {"text": _("Blocked"), "order": 15},
+    }

invenio_app_rdm/administration/moderation/__init__.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 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.
+"""Requests moderation administration module."""
+
+from .requests import ModerationRequestDetailView, ModerationRequestListView
+
+__all__ = ("ModerationRequestListView", "ModerationRequestDetailView")

invenio_app_rdm/administration/moderation/requests.py

@@ -0,0 +1,175 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 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.
+"""Invenio administration view module for requests moderation."""
+
+from functools import partial
+
+from flask import current_app, g
+from flask_login import current_user
+from invenio_administration.views.base import (
+    AdminResourceDetailView,
+    AdminResourceListView,
+)
+from invenio_i18n import lazy_gettext as _
+from invenio_i18n.ext import current_i18n
+from invenio_rdm_records.requests import RecordDeletion
+from invenio_requests.proxies import current_requests
+from invenio_search_ui.searchconfig import search_app_config
+from invenio_users_resources.proxies import current_user_resources
+from invenio_vocabularies.proxies import current_service as vocabulary_service
+from marshmallow_utils.fields.babel import gettext_from_dict
+
+
+class ModerationRequestListView(AdminResourceListView):
+    """Requests moderation admin search view."""
+
+    api_endpoint = "/requests"
+    extension_name = "invenio-requests"
+    name = "requests"
+    resource_config = "requests_resource"
+    request_headers = {"Accept": "application/vnd.inveniordm.v1+json"}
+    title = _("Requests")
+    menu_label = _("Requests")
+    category = _("Moderation")
+    pid_path = "id"
+    icon = "mail"
+    template = "invenio_app_rdm/administration/requests.html"
+    order = 1
+
+    display_search = True
+    display_delete = False
+    display_create = False
+    display_edit = False
+    display_read = False
+
+    search_config_name = "APP_RDM_MODERATION_REQUEST_SEARCH"
+    search_facets_config_name = "APP_RDM_MODERATION_REQUEST_FACETS"
+    search_sort_config_name = "APP_RDM_MODERATION_REQUEST_SORT_OPTIONS"
+
+    item_field_list = {
+        "title": {"text": _("Title"), "order": 1, "width": 3},
+        "created": {"text": _("Created"), "order": 2, "width": 3},
+        "last_reply": {"text": _("Last reply"), "order": 3, "width": 3},
+    }
+
+    @property
+    def request_type(self):
+        """Request type property."""
+        request_type = self.resource.service.request_type_registry.lookup(
+            "record-deletion"
+        )
+        return request_type
+
+    @classmethod
+    def get_service_schema(cls):
+        """Get marshmallow schema of the assigned service."""
+        request_type = cls.resource.service.request_type_registry.lookup(
+            "record-deletion"
+        )
+        # handle dynamic schema class declaration for requests
+        schema_cls = request_type.marshmallow_schema()
+        schema = schema_cls()
+        return schema
+
+    @staticmethod
+    def disabled():
+        """Disable the view on demand."""
+        return False
+
+    def init_search_config(self):
+        """Build search view config."""
+        return partial(
+            search_app_config,
+            config_name=self.get_search_app_name(),
+            available_facets=current_app.config.get(self.search_facets_config_name),
+            sort_options=current_app.config[self.search_sort_config_name],
+            endpoint=self.get_api_endpoint(),
+            headers=self.get_search_request_headers(),
+            initial_filters=[["is_open", "true"]],
+            hidden_params=[
+                ["expand", "1"],
+                ["type", RecordDeletion.type_id],
+            ],
+            pagination_options=(20, 50),
+            default_size=20,
+        )
+
+
+class ModerationRequestDetailView(AdminResourceDetailView):
+    """Configuration for moderation request detail view."""
+
+    url = "/requests/<pid_value>"
+    extension_name = "invenio-requests"
+    api_endpoint = "/requests"
+    name = "request_details"
+    resource_config = "requests_resource"
+    title = _("Request details")
+    display_delete = False
+    display_edit = False
+
+    pid_path = "id"
+    template = "invenio_app_rdm/administration/requests_details.html"
+
+    @classmethod
+    def get_service_schema(cls):
+        """Get marshmallow schema of the assigned service."""
+        request_type = cls.resource.service.request_type_registry.lookup(
+            "record-deletion"
+        )
+        # handle dynamic schema class declaration for requests
+        schema_cls = request_type.marshmallow_schema()
+        schema = schema_cls()
+        return schema
+
+    def get_context(self, pid_value=None):
+        """Create details view context."""
+        name = self.name
+        schema = self.get_service_schema()
+        serialized_schema = self._schema_to_json(schema)
+        fields = self.item_field_list
+        request = current_requests.requests_service.read(
+            id_=pid_value, identity=g.identity, expand=True
+        ).to_dict()
+        avatar = current_user_resources.users_service.links_item_tpl.expand(
+            g.identity, current_user
+        )["avatar"]
+        permissions = []
+        if "reason" in request.get("payload", {}):
+            reason_title = vocabulary_service.read(
+                g.identity,
+                ("removalreasons", request["payload"]["reason"]),
+            ).to_dict()
+
+            request["payload"]["reason_label"] = gettext_from_dict(
+                reason_title["title"],
+                current_i18n.locale,
+                current_app.config.get("BABEL_DEFAULT_LOCALE", "en"),
+            )
+
+        return {
+            "invenio_request": request,
+            "user_avatar": avatar,
+            "permissions": permissions,
+            "request_headers": self.request_headers,
+            "name": name,
+            "resource_schema": serialized_schema,
+            "fields": fields,
+            "exclude_fields": self.item_field_exclude_list,
+            "ui_config": self.item_field_list,
+            "pid": pid_value,
+            "api_endpoint": self.get_api_endpoint(),
+            "title": self.title,
+            "list_endpoint": self.get_list_view_endpoint(),
+            "actions": self.serialize_actions(),
+            "pid_path": self.pid_path,
+            "display_edit": self.display_edit,
+            "display_delete": self.display_delete,
+            "list_ui_endpoint": self.get_list_view_endpoint(),
+            "resource_name": (
+                self.resource_name if self.resource_name else self.pid_path
+            ),
+        }

invenio_app_rdm/administration/records/__init__.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023-2024 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.
+
+"""Invenio app rdm records administration module."""
+
+from invenio_app_rdm.administration.records.records import (
+    DraftAdminListView,
+    RecordAdminListView,
+)
+
+__all__ = ("RecordAdminListView", "DraftAdminListView")

invenio_app_rdm/administration/records/records.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023-2025 CERN.
+# Copyright (C) 2023 Graz University of Technology.
+# Copyright (C) 2024 KTH Royal Institute 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 administration records and drafts list views."""
+
+from functools import partial
+
+from flask import current_app
+from invenio_administration.views.base import AdminResourceListView
+from invenio_i18n import lazy_gettext as _
+from invenio_search_ui.searchconfig import search_app_config
+
+
+class RecordAdminListView(AdminResourceListView):
+    """Configuration for the records list view."""
+
+    api_endpoint = "/records"
+    name = "records"
+    resource_config = "records_resource"
+    search_request_headers = {"Accept": "application/vnd.inveniordm.v1+json"}
+    title = _("Records")
+    menu_label = _("Records")
+    category = _("Deposits")
+    icon = "file"
+    template = "invenio_app_rdm/administration/records/records.html"
+    extension_name = "invenio-rdm-records"
+    order = 1
+
+    display_search = True
+    display_delete = False
+    display_edit = False
+    display_create = False
+
+    item_field_list = {
+        "title": {"text": _("Title"), "order": 1, "width": 6},
+        "owner": {"text": _("Owner"), "order": 2, "width": 1},
+        "created": {"text": _("Created"), "order": 4, "width": 2},
+        "files": {"text": _("Files"), "order": 5, "width": 1},
+        "stats": {"text": _("Stats"), "order": 6, "width": 1},
+    }
+
+    actions = {
+        "delete": {
+            "text": _("Delete record"),
+            "payload_schema": None,
+            "order": 1,
+        },
+        "restore": {
+            "text": _("Restore record"),
+            "payload_schema": None,
+            "order": 1,
+        },
+        "compare": {
+            "text": _("Compare revisions"),
+            "payload_schema": None,
+            "order": 1,
+        },
+    }
+
+    search_config_name = "RDM_SEARCH"
+    search_facets_config_name = "RDM_FACETS"
+    search_sort_config_name = "RDM_SORT_OPTIONS"
+
+    def _get_delete_schema(self):
+        return self.resource.service.config.schema_tombstone
+
+    @classmethod
+    def get_service_schema(cls):
+        """Get marshmallow schema of the assigned service."""
+        schema = cls.resource.service.config.schema()
+        # handle dynamic schema class declaration for requests
+        return schema
+
+    def get_actions(self):
+        """Get actions attribute."""
+        actions = super().get_actions()
+        actions["delete"]["payload_schema"] = self._get_delete_schema()
+        return actions
+
+    def init_search_config(self):
+        """Build search view config."""
+        return partial(
+            search_app_config,
+            config_name=self.get_search_app_name(),
+            available_facets=current_app.config.get(self.search_facets_config_name),
+            sort_options=current_app.config[self.search_sort_config_name],
+            endpoint=self.get_api_endpoint(),
+            headers=self.get_search_request_headers(),
+            initial_filters=[["status", "P"]],
+            hidden_params=[
+                ["expand", "1"],
+                ["include_deleted", "1"],
+            ],
+            pagination_options=(20, 50),
+            default_size=20,
+        )
+
+
+class DraftAdminListView(AdminResourceListView):
+    """Configuration for the drafts list view."""
+
+    api_endpoint = "/user/records"
+    name = "drafts"
+    resource_config = "records_resource"
+    search_request_headers = {"Accept": "application/vnd.inveniordm.v1+json"}
+    title = _("Drafts")
+    menu_label = _("Drafts")
+    category = _("Deposits")
+    icon = "upload"
+    template = "invenio_app_rdm/administration/records/drafts.html"
+    extension_name = "invenio-rdm-records"
+    order = 2
+
+    display_search = True
+    display_delete = False
+    display_edit = False
+    display_create = False
+
+    item_field_list = {
+        "title": {"text": _("Title"), "order": 1, "width": 6},
+        "owner": {"text": _("Owner"), "order": 2, "width": 1},
+        "created": {"text": _("Created"), "order": 4, "width": 2},
+        "files": {"text": _("Files"), "order": 5, "width": 1},
+        "stats": {"text": _("Stats"), "order": 6, "width": 1},
+    }
+
+    actions = {
+        "set_quota": {
+            "text": _("Set quota"),
+            "payload_schema": None,
+            "order": 1,
+        },
+    }
+
+    search_config_name = "RDM_SEARCH_DRAFTS"
+    search_facets_config_name = "RDM_FACETS"
+    search_sort_config_name = "RDM_SORT_OPTIONS"
+
+    def init_search_config(self):
+        """Build search view config."""
+        return partial(
+            search_app_config,
+            config_name=self.get_search_app_name(),
+            # records facets, not drafts to avoid published/unpublished
+            available_facets=current_app.config.get(self.search_facets_config_name),
+            sort_options=current_app.config[self.search_sort_config_name],
+            endpoint=self.get_api_endpoint(),
+            headers=self.get_search_request_headers(),
+            hidden_params=[
+                ["expand", "1"],
+                ["is_published", False],
+                ["include_deleted", "1"],
+            ],
+            pagination_options=(20, 50),
+            default_size=20,
+        )