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

invenio_app_rdm/communities_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.
+"""Communtiies UI module."""

invenio_app_rdm/communities_ui/searchapp.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2018-2021 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_communities_records_config": partial(
+            search_app_config,
+            config_name="COMMUNITIES_RECORDS_SEARCH",
+            available_facets=current_app.config["RDM_FACETS"],
+            sort_options=current_app.config["RDM_SORT_OPTIONS"],
+            headers={"Accept": "application/vnd.inveniordm.v1+json"},
+            pagination_options=(10, 20),
+        ),
+    }

invenio_app_rdm/communities_ui/sitemap.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+# Copyright (C) 2025 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.
+
+"""Community sitemap content."""
+
+from invenio_base import invenio_url_for
+from invenio_communities.proxies import current_communities
+from invenio_search.api import RecordsSearchV2
+from invenio_sitemap import SitemapSection, format_to_w3c
+
+
+class SitemapSectionOfCommunities(SitemapSection):
+    """Defines the Sitemap entries for Communities."""
+
+    def iter_entities(self):
+        """Iterate over objects."""
+        communities_scan = (
+            RecordsSearchV2(index=current_communities.service.record_cls.index._name)
+            .filter("term", **{"access.visibility": "public"})
+            .filter("term", deletion_status="P")
+            .sort("-updated")
+            # Using preserve_order is fine.
+            # Using Point in Time is a recommended alternative but not
+            # particularly better than this one for our needs. See
+            # https://opensearch.org/docs/latest/search-plugins/searching-data/point-in-time/
+            .params(preserve_order=True)
+            # In keeping with original: only page is looked for
+            # (curation policy is not most relevant)
+            .source(["slug", "updated", "metadata.page"])
+            .scan()
+        )
+
+        for community in communities_scan:
+            yield {
+                "slug": community.slug,
+                "updated": community.updated,
+                "loc": invenio_url_for(
+                    "invenio_app_rdm_communities.communities_detail",
+                    pid_value=community.slug,
+                ),
+            }
+
+            if "page" in community.get("metadata", {}):
+                yield {
+                    "slug": community.slug,
+                    "updated": community.updated,
+                    "loc": invenio_url_for(
+                        "invenio_communities.communities_about",
+                        pid_value=community.slug,
+                    ),
+                }
+
+    def to_dict(self, entity):
+        """To dict used in sitemap."""
+        return {
+            "loc": entity["loc"],
+            "lastmod": format_to_w3c(entity["updated"]),
+        }

invenio_app_rdm/communities_ui/templates/semantic-ui/invenio_communities/collections/collection.html

@@ -0,0 +1,60 @@
+{# -*- coding: utf-8 -*-
+
+This file is part of Invenio.
+Copyright (C) 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.
+#}
+
+{% extends "invenio_communities/details/base.html" %}
+{% from "invenio_communities/collections/macros.html" import render_depth_one_collection %}
+
+{% set active_community_header_menu_item= 'browse' %}
+
+{%- block javascript %}
+{{ super() }}
+{{ webpack['invenio-app-rdm-collections-search.js'] }}
+{%- endblock %}
+
+{%- block page_body %}
+{{ super() }}
+{% set root_collection=collection[collection.root] %}
+<div class="ui container fluid page-subheader rel p-10 mr-0-mobile ml-0-mobile">
+  <div class="collection-header ui container">
+    <h1 class="ui medium header">
+      {%- if logo -%}
+        <img src="{{ logo }}" width="45" height="45" alt="Collection logo"/>
+      {%- endif -%}
+      <div class="content">{{ root_collection.title }}</div>
+    </h1>
+  </div>
+</div>
+<!-- Breadcrumbs -->
+<div class="ui container mb-0">
+  <div class="ui breadcrumb">
+    <a class="section"
+      href="{{ url_for('invenio_app_rdm_communities.communities_browse', pid_value=community.slug ) }}">
+      {{ _("Browse") }}
+    </a>
+    <i class="angle right icon divider mr-0" aria-hidden="true"></i>
+
+    {% if root_collection.breadcrumbs %}
+    {%- for breadcrumb in root_collection.breadcrumbs -%}
+    <a class="section" href="{{ breadcrumb.link }}">
+      {{ breadcrumb.title }}
+    </a>
+    {% if not loop.last %}
+    <i class="angle right icon divider mr-0" aria-hidden="true"></i>
+    {% endif %}
+    {%- endfor -%}
+    {%- endif -%}
+  </div>
+</div>
+<div class="ui divider mt-10 mb-0" aria-hidden="true"></div>
+<!-- Collection record search -->
+<div id="collection-search"
+  data-invenio-search-config='{{search_app_collection_config(app_id="InvenioAppRDM.CollectionsSearch", endpoint=root_collection["links"]["search"]) | tojson }}'
+  data-permissions='{{ permissions | tojson }}'>
+</div>
+{%- endblock page_body %}

invenio_app_rdm/communities_ui/templates/semantic-ui/invenio_communities/collections/macros.html

@@ -0,0 +1,43 @@
+{% macro render_depth_one_collection(community, tree, collection) %}
+{% set root_collection=collection[collection.root] %}
+<div class="ui mt-0 mb-0 rel-ml-1">
+  <div class="content rel-mb-1">
+    {% set logo_url = url_for("static", filename="images/collections/" ~ root_collection.slug ~ ".jpg") %}
+    <div class="ui grid">
+      <div class="twelve wide column middle aligned left floated">
+        <div class="flex align-items-center">
+          <img class="computer only rel-mr-1" src="{{ logo_url }}" width="45" height="auto" alt=""
+            onerror="null;"/>
+          <h4 class="theme-primary-text mt-0">
+            <a
+              href='{{ url_for("invenio_app_rdm_communities.community_collection", pid_value=community.slug, collection_slug=root_collection.slug, tree_slug=tree.slug )}}'>
+              {{ root_collection.title }}
+            </a>
+          </h4>
+        </div>
+      </div>
+      <div class="four wide column collection-number middle aligned left floated">
+        <label class="ui small label middle aligned">{{ "{:,}".format(root_collection.num_records) }}</label>
+      </div>
+    </div>
+
+
+  </div>
+  {%- if root_collection.children -%}
+  <div class="content">
+    {%- for child_id in root_collection.children -%}
+    {% set child_collection = collection[child_id] %}
+    <div class="ui container mb-0 mt-0 rel-ml-1">
+      <h5 class="theme-primary-text">
+        <a href='{{ url_for("invenio_app_rdm_communities.community_collection", pid_value=community.slug,
+          collection_slug=child_collection.slug, tree_slug=tree.slug )}}'>
+          {{ child_collection.title }}
+        </a>
+        <label class="ui tiny text-muted">{{ "(" ~ "{:,}".format(child_collection.num_records) ~ ")"}}</label>
+      </h5>
+    </div>
+    {%- endfor -%}
+  </div>
+  {%- endif -%}
+</div>
+{%- endmacro %}

invenio_app_rdm/communities_ui/templates/semantic-ui/invenio_communities/details/browse/index.html

@@ -0,0 +1,59 @@
+{# -*- coding: utf-8 -*-
+
+This file is part of Invenio.
+Copyright (C) 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.
+#}
+
+{% extends "invenio_communities/details/base.html" %}
+{% from "invenio_communities/collections/macros.html" import render_depth_one_collection %}
+
+{% set active_community_header_menu_item= 'browse' %}
+{% set subcommunities_endpoint = community["links"]["subcommunities"] %}
+{% set community_slug = community["slug"] %}
+{% set can_have_children = community["children"]["allow"] %}
+
+{%- block javascript %}
+{{ super() }}
+{{ webpack['invenio-communities-browse.js'] }}
+{%- endblock %}
+
+{%- block page_body %}
+{{ super() }}
+{%- for tree_id, ctree in trees.items() -%}
+<div class="ui container theme-font rel-mt-3 rel-mb-2">
+  <h1 class="ui medium header mb-0 align-self-center">{{ ctree.title }}</h1>
+  <div class="ui divider mt-0"></div>
+  <div class="ui relaxed grid stackable">
+    {%- for collection in ctree.collections -%}
+    <div class="four wide column">
+      {{ render_depth_one_collection(community, ctree, collection) }}
+    </div>
+    {%- endfor -%}
+  </div>
+</div>
+{%- endfor -%}
+<div class="ui container theme-font communities-frontpage rel-mt-3 rel-mb-2">
+  <div class="flex">
+    <h1 class="ui medium header mb-0 align-self-center">{{ config.get("APP_RDM_SUBCOMMUNITIES_LABEL", _("Subcommunities")) }}</h1>
+    {% if can_have_children %}
+    <a class="align-self-center rel-ml-1"
+        href="{{url_for('invenio_communities.communities_subcommunities', pid_value=community_slug)}}">
+        {{ _('See all')}}
+    </a>
+    {% endif %}
+  </div>
+  <div class="ui divider mt-0"></div>
+  {% if can_have_children %}
+    <div id="subcommunities-container" data-api-endpoint='{{ subcommunities_endpoint }}'></div>
+  {% else %}
+    <div class="ui icon message"><i aria-hidden="true" class="info icon"></i>
+        <div class="content">
+            <div class="header">{{ _('This community has no subcommunities') }}</div>
+        </div>
+    </div>
+  {% endif %}
+</div>
+{%- endblock page_body %}

invenio_app_rdm/communities_ui/templates/semantic-ui/invenio_communities/records/index.html

@@ -0,0 +1,24 @@
+{# -*- coding: utf-8 -*-
+
+  This file is part of Invenio.
+  Copyright (C) 2016-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.
+#}
+
+{% extends "invenio_communities/details/base.html" %}
+
+{%- set title = _("Search ") + community.metadata.title -%}
+
+{%- block javascript %}
+    {{ super() }}
+    {{ webpack['invenio-app-rdm-community-records-search.js'] }}
+{%- endblock %}
+
+{%- block page_body %}
+{{ super() }}
+<div data-invenio-search-config='{{
+  search_app_communities_records_config(app_id="InvenioCommunities.DetailsSearch",
+  endpoint=endpoint) | tojson }}'></div>
+{%- endblock page_body %}

invenio_app_rdm/communities_ui/views/__init__.py

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

invenio_app_rdm/communities_ui/views/communities.py

@@ -0,0 +1,206 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019-2024 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.
+"""Request views module."""
+
+from flask import abort, g, redirect, request, url_for
+from invenio_collections.errors import (
+    CollectionNotFound,
+    CollectionTreeNotFound,
+    LogoNotFoundError,
+)
+from invenio_collections.proxies import current_collections
+from invenio_communities.views.communities import (
+    HEADER_PERMISSIONS,
+    _get_roles_can_invite,
+    _get_roles_can_update,
+    render_community_theme_template,
+)
+from invenio_communities.views.decorators import pass_community
+from invenio_i18n import get_locale
+from invenio_pages.proxies import current_pages_service
+from invenio_pages.records.errors import PageNotFoundError
+from invenio_rdm_records.proxies import (
+    current_community_records_service,
+)
+from invenio_rdm_records.resources.serializers import UIJSONSerializer
+from invenio_records_resources.services.errors import PermissionDeniedError
+
+
+@pass_community(serialize=True)
+def communities_detail(pid_value, community, community_ui):
+    """Community detail page."""
+    permissions = community.has_permissions_to(HEADER_PERMISSIONS)
+    endpoint = "/api/communities/{pid_value}/records"
+
+    return render_community_theme_template(
+        "invenio_communities/records/index.html",
+        theme=community_ui.get("theme", {}),
+        community=community,
+        community_ui=community_ui,
+        # Pass permissions so we can disable partially UI components
+        # e.g Settings tab
+        permissions=permissions,
+        active_community_header_menu_item="search",
+        endpoint=endpoint.format(pid_value=community.to_dict()["id"]),
+    )
+
+
+@pass_community(serialize=True)
+def communities_home(pid_value, community, community_ui):
+    """Community home page."""
+    query_params = request.args
+    collections_service = current_collections.service
+    permissions = community.has_permissions_to(HEADER_PERMISSIONS)
+    if not permissions["can_read"]:
+        raise PermissionDeniedError()
+
+    theme_enabled = community._record.theme and community._record.theme.get(
+        "enabled", False
+    )
+
+    if query_params or not theme_enabled:
+        url = url_for(
+            "invenio_app_rdm_communities.communities_detail",
+            pid_value=community.data["slug"],
+            **request.args,
+        )
+        return redirect(url)
+
+    if theme_enabled:
+        recent_uploads = current_community_records_service.search(
+            community_id=pid_value,
+            identity=g.identity,
+            params={
+                "sort": "newest",
+                "size": 3,
+                "metrics": {
+                    "total_grants": {
+                        "name": "total_grants",
+                        "type": "cardinality",
+                        "kwargs": {"field": "metadata.funding.award.id"},
+                    },
+                    "total_data": {
+                        "name": "total_data",
+                        "type": "sum",
+                        "kwargs": {"field": "files.totalbytes"},
+                    },
+                },
+            },
+            expand=True,
+        )
+
+        collections = collections_service.list_trees(g.identity, community.id, depth=0)
+
+        # TODO resultitem does not expose aggregations except labelled facets
+        _metric_aggs = recent_uploads._results.aggregations
+        metrics = {
+            "total_records": recent_uploads.total,
+            "total_data": _metric_aggs.total_data.value,
+            "total_grants": _metric_aggs.total_grants.value,
+        }
+
+        records_ui = UIJSONSerializer().dump_list(recent_uploads.to_dict())["hits"][
+            "hits"
+        ]
+
+        return render_community_theme_template(
+            "invenio_communities/details/home/index.html",
+            theme=community_ui.get("theme", {}),
+            community=community,
+            community_ui=community_ui,
+            permissions=permissions,
+            records=records_ui,
+            metrics=metrics,
+            collections=collections.to_dict(),
+        )
+
+
+@pass_community(serialize=True)
+def communities_browse(pid_value, community, community_ui):
+    """Community browse page."""
+    permissions = community.has_permissions_to(HEADER_PERMISSIONS)
+
+    collections_service = current_collections.service
+
+    trees_ui = collections_service.list_trees(
+        g.identity, community_id=community.id, depth=2
+    ).to_dict()
+    return render_community_theme_template(
+        "invenio_communities/details/browse/index.html",
+        theme=community_ui.get("theme", {}),
+        community=community,
+        community_ui=community_ui,
+        permissions=permissions,
+        roles_can_update=_get_roles_can_update(community.id),
+        roles_can_invite=_get_roles_can_invite(community.id),
+        trees=trees_ui,
+    )
+
+
+@pass_community(serialize=True)
+def community_static_page(pid_value, community, community_ui, **kwargs):
+    """Community static page."""
+    permissions = community.has_permissions_to(HEADER_PERMISSIONS)
+    if not permissions["can_read"]:
+        raise PermissionDeniedError()
+
+    try:
+        lang = get_locale()
+        page = current_pages_service.read_by_url(
+            g.identity,
+            request.path,
+            lang=lang.language,
+        ).to_dict()
+
+    except PageNotFoundError:
+        abort(404)
+
+    return render_community_theme_template(
+        page["template_name"],
+        theme=community_ui.get("theme", {}),
+        community=community,
+        community_ui=community_ui,
+        page=page,
+        permissions=permissions,
+    )
+
+
+@pass_community(serialize=True)
+def community_collection(
+    community, community_ui, pid_value, tree_slug=None, collection_slug=None
+):
+    """Render a community collection page."""
+    collections_service = current_collections.service
+    try:
+        collection = collections_service.read(
+            identity=g.identity,
+            community_id=community.id,
+            slug=collection_slug,
+            tree_slug=tree_slug,
+        )
+    except (CollectionNotFound, CollectionTreeNotFound):
+        abort(404)
+
+    try:
+        logo = collections_service.read_logo(g.identity, collection_slug)
+    except LogoNotFoundError:
+        logo = None
+
+    collection_ui = collection.to_dict()
+    return render_community_theme_template(
+        "invenio_communities/collections/collection.html",
+        theme=community_ui.get("theme", {}),
+        community=community,
+        community_ui=community_ui,
+        collection=collection_ui,
+        # TODO _collection should not be accessed from here
+        tree=collection._collection.collection_tree,
+        logo=logo,
+        permissions=community.has_permissions_to(HEADER_PERMISSIONS),
+    )

invenio_app_rdm/communities_ui/views/ui.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019-2024 CERN.
+# Copyright (C) 2019-2022 Northwestern University.
+# Copyright (C)      2022 TU Wien.
+# Copyright (C) 2023-2024 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.
+"""Communities UI blueprints module."""
+
+from flask import Blueprint, current_app, request
+from invenio_collections.searchapp import search_app_context as c_search_app_context
+from invenio_communities.errors import CommunityDeletedError
+from invenio_communities.views.ui import (
+    not_found_error,
+    record_permission_denied_error,
+    record_tombstone_error,
+)
+from invenio_pidstore.errors import PIDDeletedError, PIDDoesNotExistError
+from invenio_records_resources.services.errors import (
+    PermissionDeniedError,
+    RecordPermissionDeniedError,
+)
+
+from invenio_app_rdm.views import create_url_rule
+
+from ..searchapp import search_app_context
+from .communities import (
+    communities_browse,
+    communities_detail,
+    communities_home,
+    community_collection,
+    community_static_page,
+)
+
+
+def _show_browse_page():
+    """Whether the browse page should be visible in the menu."""
+    return (
+        current_app.config.get("COMMUNITIES_SHOW_BROWSE_MENU_ENTRY", False)
+        and request.community["children"]["allow"]
+    )
+
+
+def create_ui_blueprint(app):
+    """Register blueprint routes on app."""
+    routes = app.config["RDM_COMMUNITIES_ROUTES"]
+
+    blueprint = Blueprint(
+        "invenio_app_rdm_communities",
+        __name__,
+        template_folder="../templates",
+        static_folder="../static",
+    )
+
+    blueprint.add_url_rule(
+        **create_url_rule(routes["community-detail"], communities_detail),
+        strict_slashes=False,
+    )
+
+    blueprint.add_url_rule(
+        **create_url_rule(routes["community-home"], communities_home)
+    )
+
+    blueprint.add_url_rule(
+        **create_url_rule(routes["community-browse"], communities_browse)
+    )
+
+    blueprint.add_url_rule(
+        **create_url_rule(routes["community-static-page"], community_static_page)
+    )
+
+    blueprint.add_url_rule(
+        **create_url_rule(routes["community-collection"], community_collection)
+    )
+    # Register error handlers
+    blueprint.register_error_handler(
+        PermissionDeniedError, record_permission_denied_error
+    )
+    blueprint.register_error_handler(
+        RecordPermissionDeniedError, record_permission_denied_error
+    )
+    blueprint.register_error_handler(PIDDeletedError, record_tombstone_error)
+    blueprint.register_error_handler(CommunityDeletedError, record_tombstone_error)
+    blueprint.register_error_handler(PIDDoesNotExistError, not_found_error)
+    blueprint.register_error_handler(PIDDoesNotExistError, not_found_error)
+
+    # Register context processor
+    blueprint.app_context_processor(search_app_context)
+    blueprint.app_context_processor(c_search_app_context)
+
+    return blueprint