invenio-app-rdm 8.0.0.dev9__py2.py3-none-any.whl → 14.0.0b4.dev4__py2.py3-none-any.whl

invenio_app_rdm/upgrade_scripts/migrate_9_0_to_10_0.py

@@ -0,0 +1,43 @@
+# -*- 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.
+
+"""Record migration script from InvenioRDM 9.0 to 10.0.
+
+Disclaimer: This script is intended to be executed *only once*, namely when
+upgrading from InvenioRDM 9.0 to 10.0!
+If this script is executed at any other time, probably the best case scenario
+is that nothing happens!
+"""
+
+from click import echo, secho
+from invenio_db import db
+from invenio_oaiserver.models import OAISet
+
+
+def execute_upgrade():
+    """Execute the upgrade from InvenioRDM 9.0 to 10.0.
+
+    Please read the disclaimer on this module before thinking about executing
+    this function!
+    """
+    system_created_sets = OAISet.query.filter(OAISet.spec.like("community-%")).all()
+
+    for system_created_set in system_created_sets:
+        echo(f"Updating record: {system_created_set.id}... ", nl=True)
+        system_created_set.system_created = True
+
+    echo("Committing to DB", nl=True)
+    db.session.commit()
+    secho(
+        "Data migration completed.",
+        fg="green",
+    )
+
+
+# if the script is executed on its own, perform the upgrade
+if __name__ == "__main__":
+    execute_upgrade()

invenio_app_rdm/users/schemas.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023 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.
+
+"""RDM User Schemas."""
+
+from invenio_users_resources.services.schemas import (
+    NotificationPreferences,
+    UserPreferencesSchema,
+    UserSchema,
+)
+from marshmallow import fields
+
+
+class UserPreferencesNotificationsSchema(UserPreferencesSchema):
+    """Schema extending preferences with notification preferences for model validation."""
+
+    notifications = fields.Nested(NotificationPreferences)
+
+
+class NotificationsUserSchema(UserSchema):
+    """Schema extending preferences with notification preferences for user service."""
+
+    preferences = fields.Nested(UserPreferencesNotificationsSchema)

invenio_app_rdm/users_ui/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+# Copyright (C) 2022 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.
+
+"""RDM User dashboard module."""

invenio_app_rdm/users_ui/searchapp.py

@@ -0,0 +1,53 @@
+# -*- 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.
+
+"""Configuration helper for React-SearchKit."""
+
+from functools import partial
+
+from flask import current_app
+from invenio_search_ui.searchconfig import search_app_config
+
+
+def search_app_context():
+    """Search app context processor."""
+    return {
+        "search_app_rdm_user_uploads_config": partial(
+            search_app_config,
+            "RDM_SEARCH_DRAFTS",
+            current_app.config["RDM_FACETS"],
+            current_app.config["RDM_SORT_OPTIONS"],
+            "/api/user/records",
+            {"Accept": "application/vnd.inveniordm.v1+json"},
+            pagination_options=(10, 20),
+            initial_filters=[
+                ["shared_with_me", "false"],
+            ],
+        ),
+        "search_app_rdm_user_communities_config": partial(
+            search_app_config,
+            "RDM_SEARCH_USER_COMMUNITIES",
+            current_app.config["COMMUNITIES_FACETS"],
+            current_app.config["RDM_SORT_OPTIONS"],
+            "/api/user/communities",
+            {"Accept": "application/vnd.inveniordm.v1+json"},
+            pagination_options=(10, 20),
+        ),
+        "search_app_rdm_user_requests_config": partial(
+            search_app_config,
+            "RDM_SEARCH_USER_REQUESTS",
+            current_app.config["REQUESTS_FACETS"],
+            current_app.config["RDM_SORT_OPTIONS"],
+            "/api/user/requests",
+            {"Accept": "application/json"},
+            initial_filters=[
+                ["is_open", "true"],
+                ["shared_with_me", "false"],
+            ],
+            hidden_params=[["expand", "1"]],
+        ),
+    }

invenio_app_rdm/users_ui/templates/semantic-ui/invenio_app_rdm/users/base.html

@@ -0,0 +1,21 @@
+{#
+  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.
+#}
+{%- extends config.BASE_TEMPLATE %}
+
+{%- block page_body %}
+
+  {%- block user_dashboard_header %}
+  {% include "invenio_app_rdm/users/header.html" %}
+  {%- endblock user_dashboard_header %}
+
+  <div class="ui container rel-mt-2">
+    {%- block user_dashboard_body %}
+    {%- endblock user_dashboard_body %}
+  </div>
+
+{%- endblock page_body %}

invenio_app_rdm/users_ui/templates/semantic-ui/invenio_app_rdm/users/communities.html

@@ -0,0 +1,25 @@
+{#
+  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.
+#}
+{%- set title = _("Communities") %}
+{%- extends "invenio_app_rdm/users/base.html" %}
+
+{% set active_dashboard_menu_item = 'communities' %}
+
+{%- block javascript %}
+{{ super() }}
+{{ webpack['invenio-app-rdm-user-communities.js'] }}
+{%- endblock javascript %}
+
+{%- block user_dashboard_body %}
+  <div
+    id="invenio-search-config"
+    data-invenio-search-config='{{ search_app_rdm_user_communities_config(app_id="InvenioAppRdm.DashboardCommunities") | tojson }}'
+    data-can-create-community='{{ can_create_community | tojson }}'
+  >
+  </div>
+{%- endblock user_dashboard_body %}

invenio_app_rdm/users_ui/templates/semantic-ui/invenio_app_rdm/users/header.html

@@ -0,0 +1,46 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2022-2024 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.
+#}
+
+<div class="ui container fluid page-subheader-outer shadowless with-submenu ml-0-mobile mr-0-mobile mb-0 pb-0 rel-pt-2" id="dashboard-user-header-container">
+  <div class="ui container page-subheader flex justify-space-between align-items-center">
+    <div class="ui items unstackable m-0">
+      <div class="item">
+        <div class="ui image dashboard-header-avatar">
+          <img src="{{ user_avatar }}" alt="" />
+        </div>
+        <div class="middle aligned content rel-pl-1">
+          <h1 class="ui medium header" aria-label="{{ _('Your dashboard') }}">{{ current_userprofile.full_name or current_user.username or current_userprofile.email or _('Anonymous user')}}</h1>
+          {% if current_userprofile.affiliations %}
+            <div class="meta">{{ current_userprofile.affiliations }}</div>
+          {% endif %}
+        </div>
+      </div>
+    </div>
+    {% if active_dashboard_menu_item == "uploads" %}
+      <a class="ui tiny button positive left labeled icon m-0" href={{ url_for("invenio_app_rdm_records.deposit_create") }}>
+        <i class="upload icon" aria-hidden="true"></i>
+        {{ _('New upload') }}
+      </a>
+    {% endif %}
+
+    {% if active_dashboard_menu_item == "communities" %}
+      <a class="ui tiny button positive left labeled icon m-0" href={{ url_for("invenio_communities.communities_new") }}>
+        <i class="plus icon" aria-hidden="true"></i>
+        {{ _('New community') }}
+      </a>
+    {% endif %}
+  </div>
+  <div class="ui container secondary pointing menu page-subheader pl-0">
+  {% for item in current_menu.submenu('dashboard').children if item.visible %}
+  <a
+    class="item {{ 'active' if active_dashboard_menu_item == item.name }} {{ 'disabled' if not item.url }}"
+    href="{{ item.url }}">{{ item.text }}</a>
+  {% endfor %}
+</div>
+</div>

invenio_app_rdm/users_ui/templates/semantic-ui/invenio_app_rdm/users/requests.html

@@ -0,0 +1,24 @@
+{#
+  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.
+#}
+{%- set title = _("Requests") %}
+{%- extends "invenio_app_rdm/users/base.html" %}
+
+{% set active_dashboard_menu_item = 'requests' %}
+
+{%- block javascript %}
+{{ super() }}
+{{ webpack['invenio-app-rdm-user-requests.js'] }}
+{%- endblock javascript %}
+
+{%- block user_dashboard_body %}
+  <div
+    id="invenio-search-config"
+    data-invenio-search-config='{{ search_app_rdm_user_requests_config(app_id="InvenioAppRdm.DashboardRequests") | tojson }}'
+  >
+  </div>
+{%- endblock user_dashboard_body %}

invenio_app_rdm/users_ui/templates/semantic-ui/invenio_app_rdm/users/uploads.html

@@ -0,0 +1,25 @@
+{#
+  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.
+#}
+{%- set title = _("Uploads") %}
+{%- extends "invenio_app_rdm/users/base.html" %}
+
+{% set active_dashboard_menu_item = 'uploads' %}
+
+{%- block javascript %}
+{{ super() }}
+{{ webpack['invenio-app-rdm-user-uploads.js'] }}
+{%- endblock javascript %}
+
+{%- block user_dashboard_body %}
+  <div
+    id="invenio-search-config"
+    data-invenio-search-config='{{ search_app_rdm_user_uploads_config(app_id="InvenioAppRdm.DashboardUploads") | tojson }}'
+  >
+
+</div>
+{%- endblock user_dashboard_body %}

invenio_app_rdm/users_ui/views/__init__.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2016-2022 CERN.
+# Copyright (C) 2022 Northwestern University.
+#
+# 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.
+
+"""Community views."""
+
+from .ui import create_ui_blueprint
+
+__all__ = ("create_ui_blueprint",)

invenio_app_rdm/users_ui/views/dashboard.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 CERN.
+# Copyright (C) 2022 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.
+
+"""RDM User dashboard views."""
+
+from flask import g, render_template
+from flask_login import current_user, login_required
+from invenio_communities.proxies import current_communities
+from invenio_users_resources.proxies import current_user_resources
+
+from ...records_ui.views.deposits import get_search_url
+
+
+@login_required
+def uploads():
+    """Display user dashboard page."""
+    url = current_user_resources.users_service.links_item_tpl.expand(
+        g.identity, current_user
+    )["avatar"]
+    return render_template(
+        "invenio_app_rdm/users/uploads.html",
+        searchbar_config=dict(searchUrl=get_search_url()),
+        user_avatar=url,
+    )
+
+
+@login_required
+def requests():
+    """Display user dashboard page."""
+    url = current_user_resources.users_service.links_item_tpl.expand(
+        g.identity, current_user
+    )["avatar"]
+    return render_template(
+        "invenio_app_rdm/users/requests.html",
+        searchbar_config=dict(searchUrl=get_search_url()),
+        user_avatar=url,
+    )
+
+
+@login_required
+def communities():
+    """Display user dashboard page."""
+    url = current_user_resources.users_service.links_item_tpl.expand(
+        g.identity, current_user
+    )["avatar"]
+    can_create_community = current_communities.service.check_permission(
+        g.identity, "create"
+    )
+    return render_template(
+        "invenio_app_rdm/users/communities.html",
+        searchbar_config=dict(searchUrl=get_search_url()),
+        user_avatar=url,
+        can_create_community=can_create_community,
+    )

invenio_app_rdm/users_ui/views/ui.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2016-2021 CERN.
+# Copyright (C) 2023-2024 Graz University of Technology.
+#
+# 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.
+
+"""Communities UI views."""
+
+from flask import Blueprint, current_app, render_template
+from flask_login import current_user
+
+from ..searchapp import search_app_context
+from .dashboard import communities, requests, uploads
+
+
+#
+# Error handlers
+#
+def not_found_error(error):
+    """Handler for 'Not Found' errors."""
+    return render_template(current_app.config["THEME_404_TEMPLATE"]), 404
+
+
+def record_permission_denied_error(error):
+    """Handle permission denier error on record views."""
+    if not current_user.is_authenticated:
+        # trigger the flask-login unauthorized handler
+        return current_app.login_manager.unauthorized()
+    return render_template(current_app.config["THEME_403_TEMPLATE"]), 403
+
+
+#
+# Registration
+#
+def create_ui_blueprint(app):
+    """Register blueprint routes on app."""
+    routes = app.config.get("APP_RDM_USER_DASHBOARD_ROUTES")
+
+    blueprint = Blueprint(
+        "invenio_app_rdm_users",
+        __name__,
+        template_folder="../templates",
+        static_folder="../static",
+    )
+
+    blueprint.add_url_rule(
+        routes["uploads"],
+        view_func=uploads,
+    )
+
+    # Settings tab routes
+    blueprint.add_url_rule(
+        routes["communities"],
+        view_func=communities,
+    )
+
+    blueprint.add_url_rule(
+        routes["requests"],
+        view_func=requests,
+    )
+
+    # Register context processor
+    blueprint.app_context_processor(search_app_context)
+
+    return blueprint

invenio_app_rdm/utils/files.py

@@ -0,0 +1,120 @@
+# -*- 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.
+
+"""Files utilities."""
+
+from __future__ import absolute_import, print_function
+
+from datetime import datetime
+
+import sqlalchemy as sa
+from flask import current_app
+from flask_mail import Message
+from invenio_files_rest.models import FileInstance
+from invenio_rdm_records.records.models import RDMDraftMetadata, RDMRecordMetadata
+from pytz import utc
+
+
+def checksum_verification_files_query():
+    """Return a FileInstance query taking into account file URI prefixes."""
+    files = FileInstance.query
+    uri_prefixes = current_app.config.get(
+        "FILES_REST_CHECKSUM_VERIFICATION_URI_PREFIXES"
+    )
+    if uri_prefixes:
+        files = files.filter(
+            sa.or_(*[FileInstance.uri.startswith(p) for p in uri_prefixes])
+        )
+    return files
+
+
+def render_email_from_context(template, context):
+    """Renders a template using a provided context."""
+    template = current_app.jinja_env.get_or_select_template(template)
+    return template.render(context)
+
+
+def generate_integrity_report_entries(files):
+    """Generates the report entries."""
+    entries = []
+    for file in files:
+        entry = _generate_report_entry(file)
+        entries.append(entry)
+    return entries
+
+
+def _generate_report_entry(file):
+    """Generates a single report for a file."""
+    entry = {"file": file}
+    for o in file.objects:
+        entry["filename"] = o.key
+
+        # Find records/drafts for the files
+        draft = get_draft_from_bucket(o.bucket_id)
+        if draft and draft.json:
+            entry["draft"] = draft.json
+        else:
+            record = get_record_from_bucket(o.bucket_id)
+            if record and record.json:
+                entry["record"] = record.json
+    return entry
+
+
+def get_record_from_bucket(bucket_id):
+    """Retrieve a record from a bucket id."""
+    return RDMRecordMetadata.query.filter_by(bucket_id=bucket_id).one_or_none()
+
+
+def get_draft_from_bucket(bucket_id):
+    """Retrieve a draft from a bucket id."""
+    return RDMDraftMetadata.query.filter_by(bucket_id=bucket_id).one_or_none()
+
+
+def get_report_subject():
+    """Retrieves the integrity report e-mail's subject."""
+    subject = current_app.config.get(
+        "APP_RDM_FILES_INTEGRITY_REPORT_SUBJECT", "Files integrity report"
+    )
+    now = datetime.now(tz=utc).strftime("%Y-%m-%d %H:%M:%S")
+    subject += f" [{now}]"
+    return subject
+
+
+def get_report_template():
+    """Retrieves the template name to be used in the files integrity report."""
+    tpl = current_app.config["APP_RDM_FILES_INTEGRITY_REPORT_TEMPLATE"]
+    return tpl
+
+
+def render_report_email(files):
+    """Renders the report e-mail from a list of files."""
+    entries = generate_integrity_report_entries(files)
+    tpl = get_report_template()
+    context = {"entries": entries}
+    return render_email_from_context(tpl, context)
+
+
+def send_integrity_report_email(files):
+    """Sends an e-mail with a report on the provided files.
+
+    APP configs ('MAIL_DEFAULT_SENDER', 'APP_RDM_ADMIN_EMAIL_RECIPIENT') must be set.
+    Oherwise a warning is logged.
+    """
+    try:
+        if files:
+            subject = get_report_subject()
+            body = render_report_email(files)
+            sender = current_app.config["MAIL_DEFAULT_SENDER"]
+            admin_email = current_app.config["APP_RDM_ADMIN_EMAIL_RECIPIENT"]
+            recipients = admin_email
+            if not isinstance(admin_email, list):
+                recipients = [admin_email]
+            mail_ext = current_app.extensions["mail"]
+            msg = Message(subject, sender=sender, recipients=recipients, body=body)
+            mail_ext.send(msg)
+    except Exception as e:
+        current_app.logger.error("Integrity report not sent. Error: {}".format(str(e)))

invenio_app_rdm/views.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019-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.
+
+"""General views and view utilities."""
+
+
+def create_url_rule(rule, default_view_func):
+    """Generate rule from string or tuple."""
+    # TODO: We want to deprecate the use of this kind of "string or 2-tuple" config
+    #       values, and directly use dictionaries that map exactly to the parameters
+    #       that `Blueprint.add_url_rule(...)` accepts, with some sane defaults.
+    if isinstance(rule, tuple):
+        path, view_func = rule
+
+        return {"rule": path, "view_func": view_func}
+    else:
+        return {"rule": rule, "view_func": default_view_func}