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

invenio_app_rdm/upgrade_scripts/migrate_7_0_to_8_0.py

@@ -0,0 +1,153 @@
+# -*- coding: utf-8 -*-
+#
+# 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.
+
+"""Record migration script from InvenioRDM 7.0 to 8.0.
+
+Disclaimer: This script is intended to be executed *only once*, namely when
+upgrading from InvenioRDM 7.0 to 8.0!
+If this script is executed at any other time, probably the best case scenario
+is that nothing happens!
+"""
+
+from pathlib import Path
+
+import invenio_rdm_records.fixtures as fixtures
+from click import echo, secho
+from invenio_access.permissions import system_identity
+from invenio_db import db
+from invenio_rdm_records.fixtures import (
+    PrioritizedVocabulariesFixtures,
+    VocabulariesFixture,
+)
+from invenio_vocabularies.proxies import current_service as vocabulary_svc
+
+
+def execute_upgrade():
+    """Execute the upgrade from InvenioRDM 7.0 to 8.0.
+
+    Please read the disclaimer on this module before thinking about executing
+    this function!
+    """
+
+    def update_license(license_dict):
+        """Update the stored vocabulary with the new icon."""
+        try:
+            echo(f"Updating license: {license_dict['id']}... ", nl=False)
+            license_ = vocabulary_svc.read(
+                system_identity, ("licenses", license_dict["id"])
+            )._obj
+
+            # NOTE: we don't use the service update method here because we
+            # want to evade validation errors, and the migration guide tells
+            # the users to completely rebuild the search indices anyway
+            # and we pop the '$schema' because it might be outdated and is
+            # a constant field anyway
+            license_["icon"] = license_dict["icon"]
+            license_.pop("$schema", None)
+            license_.commit()
+            secho("OK", fg="green")
+
+        except Exception as e:
+            secho("Error", fg="red")
+            return f"Error updating license '{license_dict['id']}': {e}"
+
+        return None
+
+    def update_licenses_from_fixture(fixture):
+        """Use the given fixture to update the license vocabularies."""
+        errors = []
+        did_load_licenses = False
+
+        for id_, entry in fixture.read():
+            if id_ == "licenses":
+                for license_dict in entry.iterate(ignore=[]):
+                    did_load_licenses = True
+                    error = update_license(license_dict)
+                    if error:
+                        errors.append(error)
+
+        return did_load_licenses, errors
+
+    # let the prioritized vocabularies fixture take care of the
+    # path building and entrypoint definition, etc.
+    dir_ = Path(fixtures.__file__).parent
+    pf = PrioritizedVocabulariesFixtures(
+        system_identity,
+        app_data_folder=Path("./app_data"),
+        pkg_data_folder=(dir_ / "data"),
+        filename="vocabularies.yaml",
+    )
+
+    errors = []
+    licenses_loaded = False
+
+    # we're checking the same places as the prioritized vocabularies fixtures,
+    # and in the same order
+    # 1: check the app_data directory for the invenio instance
+    app_data_yaml_file = pf._app_data_folder / pf._filename
+    if app_data_yaml_file.exists():
+        app_data_fixture = VocabulariesFixture(system_identity, app_data_yaml_file)
+        licenses_loaded, errs = update_licenses_from_fixture(app_data_fixture)
+        errors.extend(errs)
+
+    # 2: check the entry points
+    extensions = [ep.load() for ep in pf._entry_points()]
+    for module in extensions:
+        directory = Path(module.__file__).parent
+        filepath = directory / pf._filename
+        vocab_list = pf.peek_vocabularies(filepath)
+
+        # check if the entry points define something for licenses
+        if not licenses_loaded and "licenses" in vocab_list:
+            extension_fixture = VocabulariesFixture(system_identity, filepath)
+            licenses_loaded, errs = update_licenses_from_fixture(extension_fixture)
+            errors.extend(errs)
+
+    # 3: check the default vocabularies from rdm-records
+    pkg_data_yaml_file = pf._pkg_data_folder / pf._filename
+    if not licenses_loaded and pkg_data_yaml_file.exists():
+        pkg_data_fixture = VocabulariesFixture(system_identity, pkg_data_yaml_file)
+        licenses_loaded, errs = update_licenses_from_fixture(pkg_data_fixture)
+        errors.extend(errs)
+
+    success = not errors
+
+    # give feedback on the operation
+    if not licenses_loaded:
+        secho(
+            "Warning: No licenses were upgraded, which is unexpected.",
+            fg="yellow",
+        )
+
+    if success:
+        db.session.commit()
+        secho(
+            "Data migration completed, please rebuild the search indices now.",
+            fg="green",
+        )
+
+    else:
+        db.session.rollback()
+        secho(
+            "Upgrade aborted due to the following errors:",
+            fg="red",
+            err=True,
+        )
+
+        for error in errors:
+            secho(error, fg="red", err=True)
+
+        msg = (
+            "The changes have been rolled back. "
+            "Please fix the above listed errors and try the upgrade again",
+        )
+        secho(msg, fg="yellow", err=True)
+
+
+# if the script is executed on its own, perform the upgrade
+if __name__ == "__main__":
+    execute_upgrade()

invenio_app_rdm/upgrade_scripts/migrate_8_0_to_9_0.py

@@ -0,0 +1,98 @@
+# -*- 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 8.0 to 9.0.
+
+Disclaimer: This script is intended to be executed *only once*, namely when
+upgrading from InvenioRDM 8.0 to 9.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_rdm_records.records.api import RDMRecord
+
+
+def execute_upgrade():
+    """Execute the upgrade from InvenioRDM 8.0 to 9.0.
+
+    Please read the disclaimer on this module before thinking about executing
+    this function!
+    """
+
+    def update_funding_field(record):
+        try:
+            echo(f"Updating record: {record['id']}... ", nl=False)
+            for funding in record.metadata.get("funding", []):
+                award = funding.get("award", {})
+                funder = funding.get("funder", {})
+                if award.get("identifier") and award.get("scheme"):
+                    award_identifier = award.pop("identifier")
+                    award_scheme = award.pop("scheme")
+                    funding["award"]["identifiers"] = [
+                        {"identifier": award_identifier, "scheme": award_scheme}
+                    ]
+                if funder.get("identifier") and funder.get("scheme"):
+                    funder.pop("identifier")
+                    funder.pop("scheme")
+                if award.get("title", ""):
+                    award_title = award.pop("title")
+                    funding["award"]["title"] = {"en": award_title}
+                if funder.get("title", ""):
+                    funder.pop("title")
+            secho("OK", fg="green")
+            return record
+        except Exception as e:
+            secho("Error {}".format(repr(e)), fg="red")
+            return None
+
+    errors = []
+
+    records = RDMRecord.model_cls.query.all()
+    for record in records:
+        r = RDMRecord(record.data, model=record)
+        r["$schema"] = "local://records/record-v5.0.0.json"
+        res = update_funding_field(r)
+        if res is None:
+            errors.append("Record {} failed to update funding".format(r.id))
+        else:
+            r = res
+            r.commit()
+
+    success = not errors
+
+    if success:
+        echo("Committing to DB", nl=True)
+        db.session.commit()
+        secho(
+            "Data migration completed, please rebuild the search indices now.",
+            fg="green",
+        )
+
+    else:
+        echo("Rollback", nl=True)
+        db.session.rollback()
+        secho(
+            "Upgrade aborted due to the following errors:",
+            fg="red",
+            err=True,
+        )
+
+        for error in errors:
+            secho(error, fg="red", err=True)
+
+        msg = (
+            "The changes have been rolled back. "
+            "Please fix the above listed errors and try the upgrade again",
+        )
+        secho(msg, fg="yellow", err=True)
+
+
+# if the script is executed on its own, perform the upgrade
+if __name__ == "__main__":
+    execute_upgrade()

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