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

invenio_app_rdm/redirector/resource.py

@@ -0,0 +1,106 @@
+# -*- 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.
+"""Invenio RDM redirector resource."""
+
+from flask import redirect, request
+from flask_resources import Resource, ResourceConfig, route
+from invenio_records_resources.services.base.config import ConfiguratorMixin, FromConfig
+
+
+class RedirectorResource(Resource):
+    """Redirector resource class.
+
+    Usage:
+
+    * Example 1 (target as an absolute url)::
+
+        REDIRECTOR_RULES = {
+            <endpoint_name>: {
+                'source': 'https://johndoe.com',
+                'target': 'https://targeturl.com',
+            }
+        }
+
+    * Example 2 (target as a callback that returns a string)::
+
+        def my_callback():
+            from flask import url_for
+            return url_for('some_view_name')
+
+        REDIRECTOR_RULES = {
+            <endpoint_name>: {
+                'source': 'https://johndoe.com',
+                'target': my_callback,
+            }
+        }
+
+    * Example 3 (target is a callback that returns a tuple)::
+
+        def my_callback():
+            url = url_for('some_view_name')
+            # Redirection HTTP status code is 302
+            return (url, 302)
+
+        REDIRECTOR_RULES = {
+            <endpoint_name>: {
+                'source': 'https://johndoe.com',
+                'target': my_callback,
+            }
+        }
+    """
+
+    def __init__(self, config):
+        """Instantiates redirector resource, storing the redirection rules."""
+        super().__init__(config)
+        self.rules = self.config.rules
+
+    def create_url_rules(self):
+        """Generates a list of rules, based on flask_resources.route. View methods are generated using a factory."""
+        url_rules = []
+        for endpoint, rule in self.rules.items():
+            source = rule["source"]
+            url_rules.append(
+                route(
+                    method="GET",
+                    rule=source,
+                    view_meth=self.redirect_view_factory,
+                    endpoint=endpoint,
+                    rule_options=rule.get("rule_options"),
+                )
+            )
+        return url_rules
+
+    def redirect_view_factory(self):
+        """Factory to create views which redirect requests to a URL."""
+        bp_endpoint = request.url_rule.endpoint
+
+        # Strip BP name prefix from endpoint
+        endpoint_name = bp_endpoint.replace(f"{self.config.blueprint_name}.", "")
+        triggered_rule = self.rules[endpoint_name]
+        target = triggered_rule["target"]
+        redirect_url = target
+        code = 301
+
+        # Retrieve url from target if it's a method
+        if callable(target):
+            target_output = redirect_url()
+            if type(target_output) == tuple:
+                redirect_url, code = target_output
+            else:
+                redirect_url = target_output
+
+        # Redirect to target
+        return redirect(redirect_url, code)
+
+
+class RedirectorConfig(ResourceConfig, ConfiguratorMixin):
+    """Redirector config. Sets rules to config['REDIRECTOR_RULES'] if any."""
+
+    # Blueprint configuration
+    blueprint_name = "invenio_redirector"
+
+    rules = FromConfig("REDIRECTOR_RULES", {})

invenio_app_rdm/redirector/views.py

@@ -0,0 +1,18 @@
+# -*- 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.
+"""Invenio RDM redirector."""
+
+from __future__ import absolute_import, print_function
+
+from .resource import RedirectorConfig, RedirectorResource
+
+
+def create_blueprint(app):
+    """Creates a blueprint for the redirector resource."""
+    resource = RedirectorResource(RedirectorConfig.build(app))
+    blueprint = resource.as_blueprint()
+    return blueprint

invenio_app_rdm/requests_ui/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019-2022 CERN.
+# Copyright (C) 2019-2022 Northwestern University.
+# Copyright (C)      2022 TU Wien.
+#
+# 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 UI module."""

invenio_app_rdm/requests_ui/templates/semantic-ui/invenio_requests/community-inclusion/index.html

@@ -0,0 +1,14 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2023 CERN.
+
+  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.
+#}
+
+{#
+  Renders the request details page when including a published record in a community.
+#}
+
+{% extends "invenio_requests/community-submission/index.html" %}

invenio_app_rdm/requests_ui/templates/semantic-ui/invenio_requests/community-invitation/community_dashboard.html

@@ -0,0 +1,38 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2022 CERN.
+
+  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.
+#}
+{% set title = invenio_request.title %}
+{% extends "invenio_requests/details/index.html" %}
+{% from "invenio_requests/macros/request_header.html" import invitation_request_header %}
+
+{% set active_community_header_menu_item = 'members' %}
+{% set active_members_menu_item = 'invitations' %}
+
+{% block request_header %}
+  {% set back_button_url = url_for("invenio_communities.invitations", pid_value=invenio_request.created_by.community) %}
+  {{
+    invitation_request_header(
+      back_button_url=back_button_url,
+      back_button_text=_("Back to invitations"),
+      request=invenio_request
+    )
+  }}
+{% endblock %}
+
+
+{% block settings_body %}
+  <div class="sixteen wide mobile sixteen wide tablet thirteen wide computer column right floated">
+    {% block request_body %}
+      {{ super() }}
+    {% endblock request_body %}
+  </div>
+{% endblock %}
+
+{% block page_body %}
+  {{ super.super() }}
+{% endblock page_body %}

invenio_app_rdm/requests_ui/templates/semantic-ui/invenio_requests/community-invitation/user_dashboard.html

@@ -0,0 +1,26 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2022 CERN.
+
+  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.
+#}
+{% set title = invenio_request.title %}
+{% extends "invenio_requests/details/index.html" %}
+{% from "invenio_requests/macros/request_header.html" import invitation_request_header %}
+
+
+{% block request_header %}
+  {% set back_button_url = url_for("invenio_app_rdm_users.requests") %}
+  {{
+    invitation_request_header(
+      back_button_url=back_button_url,
+      back_button_text=_("Back to requests"),
+      request=invenio_request,
+      accepted=request_is_accepted
+    )
+  }}
+{% endblock %}
+
+{% set active_dashboard_menu_item = 'requests' %}

invenio_app_rdm/requests_ui/templates/semantic-ui/invenio_requests/community-submission/index.html

@@ -0,0 +1,129 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2016-2025 CERN.
+
+  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.
+#}
+
+{#
+  Renders the request details page when publishing a draft and including it in a community.
+#}
+
+{% extends "invenio_requests/details/index.html" %}
+
+{% set active_dashboard_menu_item = 'requests' %}
+{% set active_community_header_menu_item = 'requests' %}
+
+{%- block request_header %}
+  {% if is_user_dashboard %}
+    {% set back_button_url = url_for("invenio_app_rdm_users.requests") %}
+  {% elif community %}
+    {% set back_button_url = url_for("invenio_communities.communities_requests", pid_value=community.id) %}
+  {% else %}
+    {#
+        if you access from a secret link there is no dashboard or community
+            /access/requests/<id>?token=<token>
+        back button is not rendered if there is no URL
+    #}
+    {% set back_button_url = "" %}
+  {% endif %}
+  {% from "invenio_requests/macros/request_header.html" import inclusion_request_header %}
+  {{ inclusion_request_header(
+      request=invenio_request,
+      record=record,
+      accepted=request_is_accepted,
+      back_button_url=back_button_url,
+      back_button_text=_("Back to requests")
+    ) }}
+{%- endblock request_header %}
+
+{% block request_timeline %}
+  <div
+    class="ui container rdm-tab-container fluid rel-pt-2 ml-0-mobile mr-0-mobile"
+    id="request-community-submission-tab-container"
+  >
+    <div
+      class="ui secondary pointing menu rdm-tab-menu"
+      id="request-community-submission-tab"
+    >
+      <a
+        class="active item"
+        data-tab="conversation"
+        role="tab"
+        aria-selected="true"
+        aria-controls="conversation-tab-panel"
+        id="conversation-tab"
+      >
+        {{ _("Conversation") }}
+      </a>
+
+      {% if record_ui %}
+        <a
+          role="tab"
+          class="item"
+          data-tab="record"
+          aria-selected="false"
+          aria-controls="record-tab-panel"
+          id="record-tab"
+        >
+          {{ _("Record") }}
+        </a>
+      {% endif %}
+
+      {% if checks %}
+        <a
+          role="tab"
+          class="item"
+          data-tab="checks"
+          aria-selected="false"
+          aria-controls="checks-tab-panel"
+          id="checks-tab"
+        >
+          <i class="{% include 'invenio_checks/requests/overall_severity_level.html' %}"></i> {{ _("Checks") }}
+        </a>
+      {% endif %}
+    </div>
+
+    <div
+      class="ui bottom attached tab segment active borderless p-0"
+      data-tab="conversation"
+      role="tabpanel"
+      aria-labelledby="conversation-tab"
+      id="conversation-tab-panel"
+    >
+      {{ super() }}
+    </div>
+
+    {% if checks %}
+      <div
+        class="ui bottom attached tab segment borderless"
+        data-tab="checks"
+        role="tabpanel"
+        aria-labelledby="checks-tab"
+        id="checks-tab-panel"
+        hidden="hidden"
+      >
+        {% include "invenio_checks/requests/details.html" %}
+      </div>
+    {% endif %}
+
+    {# The record tab content needs to be last since the HTML structure is complex and breaks following tab contents #}
+    {% if record_ui %}
+      <div
+        class="ui bottom attached tab segment borderless"
+        data-tab="record"
+        role="tabpanel"
+        aria-labelledby="record-tab"
+        id="record-tab-panel"
+        hidden="hidden"
+      >
+        {% set use_theme_basic_template = false %}
+        {% set preview_submission_request = true %}
+        {% include config.APP_RDM_RECORD_LANDING_PAGE_TEMPLATE %}
+      </div>
+    {% endif %}
+
+  </div>
+{% endblock request_timeline %}

invenio_app_rdm/requests_ui/templates/semantic-ui/invenio_requests/file-modification/index.html

@@ -0,0 +1,88 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2016-2025 CERN.
+
+  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.
+#}
+
+{% extends "invenio_requests/details/index.html" %}
+
+{% set active_dashboard_menu_item = 'requests' %}
+{% set active_community_header_menu_item = 'requests' %}
+
+{%- block request_header %}
+    {% set back_button_url = url_for("invenio_app_rdm_users.requests") %}
+  {% from "invenio_requests/macros/request_header.html" import inclusion_request_header %}
+  {{ inclusion_request_header(
+      request=invenio_request,
+      record=record,
+      accepted=request_is_accepted,
+      back_button_url=back_button_url,
+      back_button_text=_("Back to requests")
+    ) }}
+{%- endblock request_header %}
+
+{% block request_timeline %}
+  <div
+    class="ui container rdm-tab-container fluid rel-pt-2 ml-0-mobile mr-0-mobile"
+    id="request-request-deletion-tab-container"
+  >
+    <div
+      class="ui secondary pointing menu rdm-tab-menu"
+      id="request-deletion-request-tab"
+    >
+      <a
+        class="active item"
+        data-tab="conversation"
+        role="tab"
+        aria-selected="true"
+        aria-controls="conversation-tab-panel"
+        id="conversation-tab"
+      >
+        {{ _("Conversation") }}
+      </a>
+
+      {% if record_ui %}
+        <a
+          role="tab"
+          class="item"
+          data-tab="record"
+          aria-selected="false"
+          aria-controls="record-tab-panel"
+          id="record-tab"
+        >
+          {{ _("Record") }}
+        </a>
+      {% endif %}
+    </div>
+
+    <div
+      class="ui bottom attached tab segment active borderless p-0"
+      data-tab="conversation"
+      role="tabpanel"
+      aria-labelledby="conversation-tab"
+      id="conversation-tab-panel"
+    >
+      {{ super() }}
+    </div>
+
+    {# The record tab content needs to be last since the HTML structure is complex and breaks following tab contents #}
+    {% if record_ui %}
+      <div
+        class="ui bottom attached tab segment borderless"
+        data-tab="record"
+        role="tabpanel"
+        aria-labelledby="record-tab"
+        id="record-tab-panel"
+        hidden="hidden"
+      >
+        {% set use_theme_basic_template = false %}
+        {% set preview_submission_request = true %}
+        {% include config.APP_RDM_RECORD_LANDING_PAGE_TEMPLATE %}
+      </div>
+    {% endif %}
+
+  </div>
+{% endblock request_timeline %}

invenio_app_rdm/requests_ui/templates/semantic-ui/invenio_requests/guest-access-request/index.html

@@ -0,0 +1,66 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2023 TU Wien.
+
+  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.
+#}
+
+{# allows to have conversation/record tab #}
+{% extends "invenio_requests/community-submission/index.html" %}
+
+{% set title = _("Access request") %}
+
+{% from "invenio_requests/macros/request_header.html" import inclusion_request_header %}
+
+{% block page_body %}
+  {%- if not (current_user and current_user.is_authenticated) %}
+    <div class=rel-mt-2>
+      {{ super.super() }}
+    </div>
+  {% else %}
+    {{ super.super() }}
+  {% endif %}
+  {%- block request_body %}
+    <div class="ui container request-detail-page">
+
+      {%- block request_header %}
+        {%- if current_user and current_user.is_authenticated %}
+          {# only display the header for the receiver #}
+          {%- set back_button_url = url_for("invenio_app_rdm_users.requests") %}
+          {{ inclusion_request_header(
+            back_button_url=back_button_url,
+            back_button_text=_("Back to requests"),
+            request=invenio_request,
+            accepted=request_is_accepted
+          ) }}
+
+        {%- else %}
+          <div class="ui grid rel-mt-2">
+            <div class="twelve wide column">
+              <strong>Access level:</strong>
+              {{ invenio_request.payload.permission }}
+
+            </div>
+            <div id="request-actions" class="four wide column text-align-right">
+            </div>
+          </div>
+        {%- endif %}
+
+        <div class="ui container rel-mt-2">
+          {%- block user_dashboard_body %}
+          {%- endblock user_dashboard_body %}
+        </div>
+
+        <div class="ui divider"></div>
+
+      {%- endblock request_header %}
+
+      {%- block request_timeline %}
+        {{ super() }}
+      {%- endblock request_timeline %}
+
+    </div>
+  {% endblock request_body %}
+{% endblock page_body %}

invenio_app_rdm/requests_ui/templates/semantic-ui/invenio_requests/macros/request_header.html

@@ -0,0 +1,78 @@
+{%- from "invenio_app_rdm/records/macros/creatibutors.html" import show_creatibutors %}
+
+{% macro invitation_request_header(back_button_url=None, back_button_text=None, request=None, accepted=False) %}
+  {#
+    Renders the member invitation request header block with:
+    - a back button
+    - a `View community` button, when accepted
+    - the request's title
+  #}
+  <div class="flex wrap space-between">
+    {% if back_button_url and back_button_text %}
+      <div class="mb-10">
+        <a href="{{ back_button_url }}"
+            class="ui small button labeled icon rel-mr-1">
+          <i class="ui icon left arrow" aria-hidden="true"></i>
+          {{ back_button_text }}
+        </a>
+      </div>
+    {% endif %}
+
+    <div id="request-actions" class="flex align-items-center ml-auto mb-10">
+      {% if accepted %}
+        <a href="{{ url_for("invenio_app_rdm_communities.communities_detail", pid_value=request.topic.community) }}"
+           class="ui small button">
+          {{ _("View Community") }}
+        </a>
+      {% endif %}
+    </div>
+  </div>
+
+  <h2 class="ui header">{{ request.title }}</h2>
+  <p class="ui header">{{ request.description|safe }}</p>
+
+  <div class="ui divider"></div>
+{% endmacro %}
+
+{% macro inclusion_request_header(back_button_url=None, back_button_text=None, request=None, record=None, accepted=False) %}
+{#
+  Renders the record inclusion request header block with:
+  - a back button
+  - a `View record` button, when accepted
+  - the request's title
+  - the record's creators, when record is passed
+#}
+  <div class="computer-flex-header rel-mt-2">
+    {% if back_button_url and back_button_text %}
+      <div class="mb-10">
+        <a href="{{ back_button_url }}"
+            class="ui small button labeled icon rel-mr-1">
+          <i class="ui icon left arrow" aria-hidden="true"></i>
+          {{ back_button_text }}
+        </a>
+      </div>
+    {% endif %}
+
+    <div id="request-actions" class="flex align-items-start ml-auto mb-10">
+      {% if accepted and record %}
+        <a href="{{ url_for('invenio_app_rdm_records.record_detail', pid_value=request.topic.record) }}"
+           class="ui small button"
+           rel="noopener noreferrer" target="_blank"
+           title="{{ _('Opens in new tab') }}"
+        >
+          {{ _("View record") }}
+        </a>
+      {% endif %}
+    </div>
+  </div>
+
+  <div class="rel-mt-2">
+    <h2 class="ui header request-header">{{ request.title }}</h2>
+    <p class="ui header">{{ request.description|safe }}</p>
+    {% if record %}
+      <ul class="creatibutors" aria-label="{{ _('Creators') }}">
+        {{ show_creatibutors(record.metadata.creators) }}
+      </ul>
+    {% endif %}
+  </div>
+{% endmacro %}

invenio_app_rdm/requests_ui/templates/semantic-ui/invenio_requests/record-deletion/index.html

@@ -0,0 +1,95 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2016-2025 CERN.
+
+  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.
+#}
+
+{% extends "invenio_requests/details/index.html" %}
+
+{% set active_dashboard_menu_item = 'requests' %}
+{% set active_community_header_menu_item = 'requests' %}
+
+{%- block request_header %}
+    {% set back_button_url = url_for("invenio_app_rdm_users.requests") %}
+  {% from "invenio_requests/macros/request_header.html" import inclusion_request_header %}
+  {{ inclusion_request_header(
+      request=invenio_request,
+      record=record,
+      accepted=request_is_accepted,
+      back_button_url=back_button_url,
+      back_button_text=_("Back to requests")
+    ) }}
+
+    <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>
+{%- endblock request_header %}
+
+{% block request_timeline %}
+  <div
+    class="ui container rdm-tab-container fluid rel-pt-2 ml-0-mobile mr-0-mobile"
+    id="request-request-deletion-tab-container"
+  >
+    <div
+      class="ui secondary pointing menu rdm-tab-menu"
+      id="request-deletion-request-tab"
+    >
+      <a
+        class="active item"
+        data-tab="conversation"
+        role="tab"
+        aria-selected="true"
+        aria-controls="conversation-tab-panel"
+        id="conversation-tab"
+      >
+        {{ _("Conversation") }}
+      </a>
+
+      {% if record_ui %}
+        <a
+          role="tab"
+          class="item"
+          data-tab="record"
+          aria-selected="false"
+          aria-controls="record-tab-panel"
+          id="record-tab"
+        >
+          {{ _("Record") }}
+        </a>
+      {% endif %}
+    </div>
+
+    <div
+      class="ui bottom attached tab segment active borderless p-0"
+      data-tab="conversation"
+      role="tabpanel"
+      aria-labelledby="conversation-tab"
+      id="conversation-tab-panel"
+    >
+      {{ super() }}
+    </div>
+
+    {# The record tab content needs to be last since the HTML structure is complex and breaks following tab contents #}
+    {% if record_ui %}
+      <div
+        class="ui bottom attached tab segment borderless"
+        data-tab="record"
+        role="tabpanel"
+        aria-labelledby="record-tab"
+        id="record-tab-panel"
+        hidden="hidden"
+      >
+        {% set use_theme_basic_template = false %}
+        {% set preview_submission_request = true %}
+        {% include config.APP_RDM_RECORD_LANDING_PAGE_TEMPLATE %}
+      </div>
+    {% endif %}
+
+  </div>
+{% endblock request_timeline %}