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

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/audit_logs.html

@@ -0,0 +1,14 @@
+{#
+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.
+#}
+
+{% extends "invenio_administration/search.html" %}
+
+
+{% block javascript %}
+    {{ super() }}
+    {{ webpack['invenio-audit-logs-administration.js'] }}
+{% endblock %}

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/domains_search.html

@@ -0,0 +1,13 @@
+{#
+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.
+#}
+
+{% extends "invenio_administration/search.html" %}
+
+{% block javascript %}
+  {{ super() }}
+  {{ webpack['invenio-domains-administration.js'] }}
+{% endblock %}

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/records/drafts.html

@@ -0,0 +1,14 @@
+{#
+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.
+#}
+
+{% extends "invenio_administration/search.html" %}
+
+
+{% block javascript %}
+  {{ super() }}
+  {{ webpack['invenio-drafts-administration.js'] }}
+{% endblock %}

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/records/records.html

@@ -0,0 +1,14 @@
+{#
+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.
+#}
+
+{% extends "invenio_administration/search.html" %}
+
+
+{% block javascript %}
+  {{ super() }}
+  {{ webpack['invenio-records-administration.js'] }}
+{% endblock %}

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/requests.html

@@ -0,0 +1,14 @@
+{#
+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.
+#}
+
+{% extends "invenio_administration/search.html" %}
+
+
+{% block javascript %}
+  {{ super() }}
+  {{ webpack['invenio-requests-administration.js'] }}
+{% endblock %}

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/requests_details.html

@@ -0,0 +1,93 @@
+{#
+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.
+#}
+
+{% extends admin_base_template %}
+
+{% from "invenio_requests/macros/request_header.html" import inclusion_request_header %}
+
+{% set title = invenio_request.title %}
+
+{% block page_title %}{% endblock page_title %}
+
+{% block admin_page_content %}
+  {% set title = _("Request ") %}
+  {{ super() }}
+  {%- block request_body %}
+    <div class="ui container request-detail-page">
+      {%- block request_header %}
+        {% set back_button_url = url_for("administration.requests") %}
+        {{
+            inclusion_request_header(
+                back_button_url=back_button_url,
+                back_button_text=_("Back to requests"),
+                request=invenio_request,
+                accepted=request_is_accepted
+            )
+        }}
+
+        {%- if "payload" in invenio_request %}
+          <div class="twelve wide column mt-10">
+            <p><strong>{{ _("Reason:") }}</strong> {{ invenio_request["payload"]["reason_label"] }}</p>
+            {%- if invenio_request["payload"]["comment"] %}
+              <p><strong>{{ _("Justification:") }}</strong> {{ invenio_request["payload"]["comment"] }}</p>
+            {%- endif %}
+          </div>
+        {%- endif %}
+
+        <div class="ui divider"></div>
+      {%- endblock request_header %}
+
+    {%- block request_timeline %}
+    <div id="request-detail"
+         data-record='{{ invenio_request | tojson }}'
+         data-default-query-config='{{ dict(size=config["REQUESTS_TIMELINE_PAGE_SIZE"]) | tojson }}'
+         data-user-avatar='{{ user_avatar | tojson }}'
+         data-permissions='{{ permissions | tojson }}'
+         data-config='{{ dict(allowGroupReviewers=config["USERS_RESOURCES_GROUPS_ENABLED"], enableReviewers=config["REQUESTS_REVIEWERS_ENABLED"], maxReviewers=config["REQUESTS_REVIEWERS_MAX_NUMBER"]) | tojson }}'
+    >{# react app root #}
+      <div class="ui grid">
+        <div class="stretched row">
+          <div class="thirteen wide column">
+            <div class="ui">
+              <div class="ui fluid placeholder">
+                <div class="image header">
+                  <div class="line"></div>
+                  <div class="line"></div>
+                </div>
+                <div class="paragraph">
+                  {% for i in range(6) %}
+                    <div class="line"></div>
+                  {% endfor %}
+                </div>
+              </div>
+            </div>
+          </div>
+          <div class="three wide column">
+            {% for i in range(6) %}
+              <div class="ui fluid placeholder">
+                <div class="image header">
+                  <div class="line"></div>
+                  <div class="line"></div>
+                </div>
+              </div>
+              <div class="ui divider"></div>
+            {% endfor %}
+          </div>
+        </div>
+      </div>
+    </div>
+    {%- endblock request_timeline %}
+
+    </div>
+  {% endblock request_body %}
+{% endblock admin_page_content %}
+
+{% block javascript %}
+  {{ super() }}
+  {% include config.THEME_JAVASCRIPT_TEMPLATE %}
+  {{ webpack['invenio-requests-base.js'] }}
+{% endblock %}

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/user_moderation.html

@@ -0,0 +1,14 @@
+{#
+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.
+#}
+
+{% extends "invenio_administration/search.html" %}
+
+
+{% block javascript %}
+  {{ super() }}
+  {{ webpack['invenio-users-moderation-administration.js'] }}
+{% endblock %}

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/user_moderation_details.html

@@ -0,0 +1,14 @@
+{#
+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.
+#}
+
+{% extends "invenio_administration/details.html" %}
+
+
+{% block javascript %}
+  {{ super () }}
+  {{ webpack['invenio-users-moderation-administration.js'] }}
+{% endblock %}

invenio_app_rdm/administration/templates/semantic-ui/invenio_app_rdm/administration/users_search.html

@@ -0,0 +1,14 @@
+{#
+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.
+#}
+
+{% extends "invenio_administration/search.html" %}
+
+
+{% block javascript %}
+  {{ super() }}
+  {{ webpack['invenio-users-administration.js'] }}
+{% endblock %}

invenio_app_rdm/administration/user_moderation/__init__.py

@@ -0,0 +1,11 @@
+# -*- 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.
+"""User moderation administration module."""
+
+from .user_moderation import UserModerationListView, UserModerationRequestDetailView
+
+__all__ = ("UserModerationListView", "UserModerationRequestDetailView")

invenio_app_rdm/administration/user_moderation/user_moderation.py

@@ -0,0 +1,175 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023-2025 CERN.
+# 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 view module for user moderation."""
+
+from functools import partial
+
+from flask import current_app
+from invenio_administration.views.base import (
+    AdminResourceDetailView,
+    AdminResourceListView,
+)
+from invenio_i18n import lazy_gettext as _
+from invenio_requests.customizations.user_moderation import UserModerationRequest
+from invenio_search_ui.searchconfig import search_app_config
+
+
+class UserModerationListView(AdminResourceListView):
+    """User moderation admin search view."""
+
+    api_endpoint = "/requests"
+    extension_name = "invenio-requests"
+    name = "moderation"
+    resource_config = "requests_resource"
+    request_headers = {"Accept": "application/vnd.inveniordm.v1+json"}
+    title = _("User Moderation")
+    menu_label = _("Users")
+    category = _("Moderation")
+    pid_path = "id"
+    icon = "users"
+    template = "invenio_app_rdm/administration/user_moderation.html"
+    order = 2
+
+    display_search = True
+    display_delete = False
+    display_create = False
+    display_edit = False
+
+    item_field_list = {
+        # custom display of the values - only declared to create columns
+        "expanded.topic.user": {
+            "text": _("User"),
+            "order": 2,
+            "width": 4,
+        },
+        # custom display of the values - only declared to create columns
+        "expanded.topic.user.profile.email": {
+            "text": _("Email"),
+            "order": 3,
+            "width": 2,
+        },
+        # custom display of the values - only declared to create columns
+        "domain": {
+            "text": _("Email domain"),
+            "order": 4,
+            "width": 2,
+        },
+        # custom display of the values - only declared to create columns
+        "activity": {
+            "text": _("Activity"),
+            "order": 5,
+            "width": 4,
+        },
+        "status": {
+            "text": _("Status"),
+            "order": 6,
+            "width": 2,
+        },
+    }
+
+    actions = {
+        "accept": {
+            "text": _("Approve"),
+            "payload_schema": None,
+            "order": 1,
+        },
+        "decline": {
+            "text": _("Block"),
+            "payload_schema": None,
+            "order": 2,
+        },
+    }
+    search_config_name = "REQUESTS_USER_MODERATION_SEARCH"
+    search_facets_config_name = "REQUESTS_USER_MODERATION_FACETS"
+    search_sort_config_name = "REQUESTS_USER_MODERATION_SORT_OPTIONS"
+
+    @property
+    def request_type(self):
+        """Request type property."""
+        request_type = self.resource.service.request_type_registry.lookup(
+            "user-moderation"
+        )
+        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(
+            "user-moderation"
+        )
+        # 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", UserModerationRequest.type_id],
+            ],
+            pagination_options=(20, 50),
+            default_size=20,
+        )
+
+
+class UserModerationRequestDetailView(AdminResourceDetailView):
+    """Admin community detail view."""
+
+    url = "/moderation/<pid_value>"
+    extension_name = "invenio-requests"
+    api_endpoint = "/requests"
+    name = "user-moderation-details"
+    resource_config = "requests_resource"
+    title = _("User moderation")
+
+    display_delete = False
+    display_edit = False
+
+    list_view_name = "communities"
+    pid_path = "id"
+    request_headers = {"Accept": "application/json"}
+    template = "invenio_app_rdm/administration/user_moderation_details.html"
+
+    @classmethod
+    def get_service_schema(cls):
+        """Get marshmallow schema of the assigned service."""
+        request_type = cls.resource.service.request_type_registry.lookup(
+            "user-moderation"
+        )
+        # handle dynamic schema class declaration for requests
+        schema_cls = request_type.marshmallow_schema()
+        schema = schema_cls()
+        return schema
+
+    item_field_list = {
+        "id": {
+            "text": _("ID"),
+            "order": 1,
+        },
+        "topic.user": {
+            "text": _("User"),
+            "order": 3,
+        },  # TODO we should resolve the user. But this is fetched from the API.
+        # TODO can we dereference somehow?
+        "created": {"text": _("Created"), "order": 2},
+        "is_open": {"text": _("Open"), "order": 4},
+    }

invenio_app_rdm/administration/users/__init__.py

@@ -0,0 +1,12 @@
+# -*- 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 administration module for user resources."""
+
+from .users import UsersDetailView, UsersListView
+
+__all__ = ("UsersDetailView", "UsersListView")

invenio_app_rdm/administration/users/users.py

@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023-2024 CERN.
+# 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 users view module."""
+
+from functools import partial
+
+from flask import current_app
+from invenio_administration.views.base import (
+    AdminResourceDetailView,
+    AdminResourceListView,
+)
+from invenio_i18n import lazy_gettext as _
+from invenio_search_ui.searchconfig import search_app_config
+
+USERS_ITEM_LIST = {
+    "user": {"text": _("User"), "order": 2, "width": 3},
+    "username": {"text": _("Username"), "order": 3, "width": 2},
+    "email": {"text": _("Email"), "order": 4, "width": 2},
+    "status": {"text": _("Status"), "order": 5, "width": 1},
+    "created": {"text": _("Created"), "order": 6, "width": 1},
+    "updated": {"text": _("Updated"), "order": 6, "width": 1},
+    "links": {"text": "", "order": 7, "width": 1},
+}
+
+USERS_ITEM_DETAIL = {
+    "id": {"text": _("ID"), "order": 1, "width": 1},
+    "username": {"text": _("Username"), "order": 3, "width": 2},
+    "email": {"text": _("Email"), "order": 4, "width": 1},
+    "domain": {"text": _("Domain "), "order": 5, "width": 1},
+    "status": {"text": _("Status"), "order": 6, "width": 1},
+    "visibility": {"text": _("Visibility"), "order": 7, "width": 1},
+    "active": {"text": _("Active"), "order": 8, "width": 1},
+    "confirmed_at": {"text": _("Confirmed at"), "order": 9, "width": 1},
+    "verified_at": {"text": _("Verified at"), "order": 10, "width": 1},
+    "blocked_at": {"text": _("Blocked at"), "order": 11, "width": 1},
+    "created": {"text": _("Created"), "order": 12, "width": 2},
+    "updated": {"text": _("Updated"), "order": 13, "width": 2},
+}
+
+
+# List of the columns displayed on the user list and user details
+
+
+class UsersListView(AdminResourceListView):
+    """Configuration for users sets list view."""
+
+    api_endpoint = "/users/all"
+    extension_name = "invenio-users-resources"
+    name = "users"
+    resource_config = "users_resource"
+    title = _("User management")
+    menu_label = _("Users")
+    category = _("User management")
+    pid_path = "id"
+    icon = "users"
+
+    display_search = True
+    display_delete = False
+    display_edit = False
+    display_create = False
+
+    item_field_list = USERS_ITEM_LIST
+
+    search_config_name = "USERS_RESOURCES_SEARCH"
+    search_sort_config_name = "USERS_RESOURCES_SORT_OPTIONS"
+    search_facets_config_name = "USERS_RESOURCES_SEARCH_FACETS"
+    template = "invenio_app_rdm/administration/users_search.html"
+
+    # These actions are not connected on the frontend -
+    # TODO: missing permission based links in resource
+    actions = {
+        "approve": {
+            "text": _("Approve"),
+            "payload_schema": None,
+            "order": 1,
+        },
+        "restore": {
+            "text": _("Restore"),
+            "payload_schema": None,
+            "order": 2,
+        },
+        "block": {
+            "text": _("Block"),
+            "payload_schema": None,
+            "order": 2,
+        },
+        "Deactivate": {
+            "text": _("Suspend"),
+            "payload_schema": None,
+            "order": 2,
+        },
+    }
+
+    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_active", 1]],
+            hidden_params=[],
+            pagination_options=(20, 50),
+            default_size=20,
+        )
+
+
+class UsersDetailView(AdminResourceDetailView):
+    """Configuration for users sets detail view."""
+
+    url = "/users/<pid_value>"
+    api_endpoint = "/users/"
+    search_request_headers = {"Accept": "application/json"}
+    extension_name = "invenio-users-resources"
+    name = "User details"
+    resource_config = "users_resource"
+    title = _("User details")
+    display_delete = False
+    display_edit = False
+
+    pid_path = "username"
+    item_field_list = USERS_ITEM_DETAIL

invenio_app_rdm/administration/views/__init__.py

@@ -0,0 +1,11 @@
+# -*- 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.
+"""Administration views module."""
+
+from .ui import create_ui_blueprint
+
+__all__ = ("create_ui_blueprint",)

invenio_app_rdm/administration/views/ui.py

@@ -0,0 +1,21 @@
+# -*- 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.
+"""Administration ui views module."""
+
+from flask import Blueprint
+
+
+def create_ui_blueprint(app):
+    """Register blueprint routes on app."""
+    blueprint = Blueprint(
+        "invenio_app_rdm_administration",
+        __name__,
+        template_folder="../templates",
+        static_folder="../static",
+    )
+
+    return blueprint

invenio_app_rdm/cli.py

@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-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.
+
+"""Command-line tools for invenio app rdm."""
+
+import click
+from flask.cli import with_appcontext
+from invenio_access.permissions import system_identity
+from invenio_records_resources.proxies import current_service_registry
+
+from .fixtures import FixturesEngine, Pages
+
+
+@click.group()
+def rdm():
+    """Invenio app rdm commands."""
+
+
+@rdm.group()
+def pages():
+    """Static pages."""
+
+
+@pages.command("create")
+@click.option(
+    "-f",
+    "--force",
+    "force",
+    default=False,
+    is_flag=True,
+    show_default=True,
+    help="Creates static pages.",
+)
+@with_appcontext
+def create_static_pages(force):
+    """Create static pages."""
+    click.secho("Creating static pages...", fg="green")
+
+    Pages().run(force=force)
+
+    click.secho("Created static pages!", fg="green")
+
+
+@rdm.command("fixtures")
+@with_appcontext
+def create_fixtures():
+    """Create the fixtures."""
+    click.secho("Creating required fixtures...", fg="green")
+
+    FixturesEngine().run()
+
+    click.secho("Created required fixtures!", fg="green")
+
+
+@rdm.command("rebuild-all-indices")
+@click.option("-o", "--order", default="")
+@with_appcontext
+def rebuild_all_indices(order):
+    """Schedule reindexing of (all) items for search with optional selecting and ordering."""
+    services = current_service_registry._services
+    service_names = services.keys()
+    services_to_reindex = order.split(",") if order else service_names
+
+    for service_to_reindex in services_to_reindex:
+        if service_to_reindex not in service_names:
+            click.secho(
+                f"Service: '{service_to_reindex}' is not part of available services that can be reindexed",  # noqa
+                fg="red",
+            )
+            click.secho(
+                f"You can chose out of these services: {' , '.join(service_names)}",
+                fg="red",
+            )
+            return
+
+    click.secho("Scheduling bulk indexing.", fg="yellow")
+    for service_to_reindex in services_to_reindex:
+        service = services[service_to_reindex]
+        if hasattr(service, "rebuild_index"):
+            click.echo(f"Reindexing {service_to_reindex}... ", nl=False)
+            try:
+                service.rebuild_index(system_identity)
+            except NotImplementedError:
+                click.secho(
+                    f"{service_to_reindex} does not use the search cluster, skipping.",
+                    fg="green",
+                )
+                continue
+            else:
+                # success
+                click.secho("Done.", fg="green")