oarepo-runtime 1.5.92__tar.gz → 1.5.94__tar.gz

{oarepo_runtime-1.5.92/oarepo_runtime.egg-info → oarepo_runtime-1.5.94}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: oarepo-runtime
-Version: 1.5.92
+Version: 1.5.94
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

oarepo_runtime-1.5.94/oarepo_runtime/services/permissions/__init__.py

@@ -0,0 +1,3 @@
+from .generators import IfDraftType, RecordOwners, UserWithRole
+
+__all__ = ("RecordOwners", "UserWithRole", "IfDraftType")

{oarepo_runtime-1.5.92 → oarepo_runtime-1.5.94}/oarepo_runtime/services/permissions/generators.py

@@ -1,7 +1,14 @@
+from typing import Literal
+
+from flask import current_app
 from flask_principal import RoleNeed, UserNeed
-from invenio_records_permissions.generators import Generator
+from invenio_records_permissions.generators import (
+    ConditionalGenerator,
+    Disable,
+    Generator,
+)
 from invenio_search.engine import dsl
-from flask import current_app
+
 
 class RecordOwners(Generator):
     """Allows record owners."""
@@ -12,7 +19,7 @@ class RecordOwners(Generator):
             # 'record' is required, so if not passed we default to empty array,
             # i.e. superuser-access.
             return []
-        if current_app.config.get('INVENIO_RDM_ENABLED', False):
+        if current_app.config.get("INVENIO_RDM_ENABLED", False):
             owners = getattr(record.parent.access, "owned_by", None)
             if owners is not None:
                 owners_list = owners if isinstance(owners, list) else [owners]
@@ -27,11 +34,12 @@ class RecordOwners(Generator):
         """Filters for current identity as owner."""
         users = [n.value for n in identity.provides if n.method == "id"]
         if users:
-            if current_app.config.get('INVENIO_RDM_ENABLED', False):
+            if current_app.config.get("INVENIO_RDM_ENABLED", False):
                 return dsl.Q("terms", **{"parent.access.owned_by.user": users})
             else:
                 return dsl.Q("terms", **{"parent.owners.user": users})
 
+
 class UserWithRole(Generator):
     def __init__(self, *roles):
         self.roles = roles
@@ -46,3 +54,49 @@ class UserWithRole(Generator):
             if provide.method == "role" and provide.value in self.roles:
                 return dsl.Q("match_all")
         return dsl.Q("match_none")
+
+
+class IfDraftType(ConditionalGenerator):
+    def __init__(
+        self,
+        draft_types: list[
+            Literal["initial"] | Literal["metadata"] | Literal["new_version"]
+        ]
+        | Literal["initial"]
+        | Literal["metadata"]
+        | Literal["new_version"],
+        then_=None,
+        else_=None,
+    ):
+        if not isinstance(draft_types, (list, tuple)):
+            draft_types = [draft_types]
+        self._draft_types = draft_types
+        if not then_:
+            then_ = [Disable()]
+        if not else_:
+            else_ = [Disable()]
+        if not isinstance(then_, (list, tuple)):
+            then_ = [then_]
+        if not isinstance(else_, (list, tuple)):
+            else_ = [else_]
+        super().__init__(then_, else_)
+
+    def _condition(self, record=None, **kwargs):
+        if not record:
+            return False
+
+        index = record.versions.index
+        is_latest = record.versions.is_latest
+        is_draft = record.is_draft
+
+        if not is_draft:
+            return False
+
+        if index == 1 and not is_latest:
+            draft_type = "initial"
+        elif index > 1 and not is_latest:
+            draft_type = "new_version"
+        else:
+            draft_type = "metadata"
+
+        return draft_type in self._draft_types

{oarepo_runtime-1.5.92 → oarepo_runtime-1.5.94}/oarepo_runtime/services/schema/marshmallow.py

@@ -1,10 +1,12 @@
 import typing
 
-import marshmallow as ma
+from invenio_rdm_records.services.schemas.record import RDMRecordSchema
 from invenio_records_resources.services.records.schema import (
     BaseRecordSchema as InvenioBaseRecordSchema,
 )
 
+import marshmallow as ma
+
 
 class BaseRecordSchema(InvenioBaseRecordSchema):
     """Base record schema - in addition to invenio exposes $schema as well."""
@@ -12,6 +14,12 @@ class BaseRecordSchema(InvenioBaseRecordSchema):
     _schema = ma.fields.Str(attribute="$schema", data_key="$schema")
 
 
+class RDMBaseRecordSchema(RDMRecordSchema):
+    """Base record schema - in addition to invenio exposes $schema as well."""
+
+    _schema = ma.fields.Str(attribute="$schema", data_key="$schema")
+
+
 class DictOnlySchema(ma.Schema):
     def get_attribute(self, obj: typing.Any, attr: str, default: typing.Any):
         if not isinstance(attr, int) and "." in attr:

{oarepo_runtime-1.5.92 → oarepo_runtime-1.5.94}/oarepo_runtime/services/schema/ui.py

@@ -5,6 +5,12 @@ import marshmallow as ma
 from babel.dates import format_date
 from babel_edtf import format_edtf
 from flask import current_app
+from invenio_rdm_records.records.systemfields.access.field.record import (
+    AccessStatusEnum,
+)
+from invenio_rdm_records.resources.serializers.ui.fields import (
+    UIObjectAccessStatus as InvenioUIObjectAccessStatus,
+)
 from marshmallow_utils.fields import (
     BabelGettextDictField,
     FormatDate,
@@ -15,6 +21,9 @@ from marshmallow_utils.fields import (
 from marshmallow_utils.fields.babel import BabelFormatField
 
 from oarepo_runtime.i18n import gettext
+from oarepo_runtime.i18n import lazy_gettext as _
+
+from .marshmallow import RDMBaseRecordSchema
 
 
 def current_default_locale():
@@ -131,3 +140,43 @@ class InvenioUISchema(ma.Schema):
     links = ma.fields.Raw(dump_only=True)
     revision_id = ma.fields.Integer(dump_only=True)
     expanded = ma.fields.Raw(dump_only=True)
+
+
+# seems not possible to avoid, as they have this hardcoded in their object,
+# and translation keys are i.e. open, which gets translated to otevret
+class UIObjectAccessStatus(InvenioUIObjectAccessStatus):
+    @property
+    def title(self):
+        """Access status title."""
+        return {
+            AccessStatusEnum.OPEN: _("access.status.open"),
+            AccessStatusEnum.EMBARGOED: _("access.status.embargoed"),
+            AccessStatusEnum.RESTRICTED: _("access.status.restricted"),
+            AccessStatusEnum.METADATA_ONLY: _("access.status.metadata-only"),
+        }.get(self.access_status)
+
+
+class AccessStatusField(ma.fields.Field):
+    """Record access status."""
+
+    def _serialize(self, value, attr, obj, **kwargs):
+        """Serialise access status."""
+        record_access_dict = obj.get("access")
+        _files = obj.get("files", {})
+        has_files = _files is not None and _files.get("enabled", False)
+        if record_access_dict:
+            record_access_status_ui = UIObjectAccessStatus(
+                record_access_dict, has_files
+            )
+            return {
+                "id": record_access_status_ui.id,
+                "title_l10n": record_access_status_ui.title,
+                "description_l10n": record_access_status_ui.description,
+                "icon": record_access_status_ui.icon,
+                "embargo_date_l10n": record_access_status_ui.embargo_date,
+                "message_class": record_access_status_ui.message_class,
+            }
+
+
+class InvenioRDMUISchema(InvenioUISchema, RDMBaseRecordSchema):
+    is_draft = ma.fields.Boolean(dump_only=True)

{oarepo_runtime-1.5.92 → oarepo_runtime-1.5.94}/oarepo_runtime/services/search.py

@@ -2,11 +2,16 @@ import dataclasses
 import inspect
 from typing import List
 
+from invenio_rdm_records.services.config import (
+    RDMSearchDraftsOptions as BaseRDMSearchDraftsOptions,
+)
+from invenio_rdm_records.services.config import RDMSearchOptions as BaseRDMSearchOptions
 from invenio_records_resources.proxies import current_service_registry
 from invenio_records_resources.services.records import (
     SearchOptions as InvenioSearchOptions,
 )
 from invenio_records_resources.services.records.params import (
+    FacetsParam,
     PaginationParam,
     QueryStrParam,
     SortParam,
@@ -17,9 +22,10 @@ from invenio_search.engine import dsl
 # TODO: integrate this to invenio_records_resources.services.records and remove SearchOptions class
 from oarepo_runtime.i18n import lazy_gettext as _
 from oarepo_runtime.records.systemfields.icu import ICUSuggestField
+from oarepo_runtime.utils.functools import class_property
 
 from .facets.params import GroupedFacetsParam
-from invenio_rdm_records.services.config import RDMSearchOptions, RDMSearchDraftsOptions
+
 try:
     from invenio_i18n import get_locale
 except ImportError:
@@ -47,13 +53,16 @@ class FuzzySuggestQueryParser(SuggestQueryParser):
         return dsl.Q("bool", should=[multi_match_with_bool_prefix, multi_match_fuzzy])
 
 
-class SearchOptions(InvenioSearchOptions):
-    params_interpreters_cls = [
-        QueryStrParam,
-        PaginationParam,
-        SortParam,
-        GroupedFacetsParam,
-    ]
+class SearchOptionsMixin:
+    @class_property
+    def params_interpreters_cls(cls):
+        """Replaces FacetsParam with GroupedFacetsParam."""
+        param_interpreters = [*super(SearchOptionsMixin, cls).params_interpreters_cls]
+        # replace FacetsParam with GroupedFacetsParam
+        for idx, interpreter in enumerate(param_interpreters):
+            if interpreter == FacetsParam:
+                param_interpreters[idx] = GroupedFacetsParam
+        return param_interpreters
 
     sort_options = {
         "title": dict(
@@ -75,6 +84,53 @@ class SearchOptions(InvenioSearchOptions):
     }
 
 
+class SearchOptionsDraftMixin(SearchOptionsMixin):
+    sort_options = {
+        "bestmatch": dict(
+            title=_("Best match"),
+            fields=["_score"],  # search defaults to desc on `_score` field
+        ),
+        "updated-desc": dict(
+            title=_("Recently updated"),
+            fields=["-updated"],
+        ),
+        "updated-asc": dict(
+            title=_("Least recently updated"),
+            fields=["updated"],
+        ),
+        "newest": dict(
+            title=_("Newest"),
+            fields=["-created"],
+        ),
+        "oldest": dict(
+            title=_("Oldest"),
+            fields=["created"],
+        ),
+        "version": dict(
+            title=_("Version"),
+            fields=["-versions.index"],
+        ),
+    }
+
+
+class SearchOptions(SearchOptionsMixin, InvenioSearchOptions):
+    # TODO: should be changed
+    params_interpreters_cls = [
+        QueryStrParam,
+        PaginationParam,
+        SortParam,
+        GroupedFacetsParam,
+    ]
+
+
+class RDMSearchOptions(SearchOptionsMixin, BaseRDMSearchOptions):
+    pass
+
+
+class RDMSearchDraftsOptions(SearchOptionsDraftMixin, BaseRDMSearchDraftsOptions):
+    pass
+
+
 @dataclasses.dataclass
 class SuggestField:
     field: str
@@ -188,14 +244,17 @@ class ICUSortOptions:
             }
         return ret
 
+
 class I18nSearchOptions(SearchOptions):
     extra_sort_options = {}
     record_cls = None
 
+
 class I18nRDMSearchOptions(RDMSearchOptions):
     extra_sort_options = {}
     record_cls = None
 
+
 class I18nRDMDraftsSearchOptions(RDMSearchDraftsOptions):
     extra_sort_options = {}
     record_cls = None

{oarepo_runtime-1.5.92 → oarepo_runtime-1.5.94}/oarepo_runtime/translations/cs/LC_MESSAGES/messages.po

@@ -51,3 +51,19 @@ msgstr "Ne"
 #, python-format
 msgid "Invalid value %(identifier)s of identifier type %(type)s"
 msgstr "%(type)s: Neplatná hodnota '%(identifier)s'"
+
+#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:152
+msgid "access.status.open"
+msgstr "otevřený přístup"
+
+#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:153
+msgid "access.status.embargoed"
+msgstr "odložené zpřístupnění"
+
+#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:154
+msgid "access.status.restricted"
+msgstr "omezený přístup"
+
+#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:155
+msgid "access.status.metadata-only"
+msgstr "pouze metadata"

{oarepo_runtime-1.5.92 → oarepo_runtime-1.5.94}/oarepo_runtime/translations/en/LC_MESSAGES/messages.po

@@ -50,3 +50,19 @@ msgstr ""
 #, python-format
 msgid "Invalid value %(identifier)s of identifier type %(type)s"
 msgstr ""
+
+#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:152
+msgid "access.status.open"
+msgstr "open access"
+
+#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:153
+msgid "access.status.embargoed"
+msgstr "embargoed access"
+
+#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:154
+msgid "access.status.restricted"
+msgstr "restricted access"
+
+#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:155
+msgid "access.status.metadata-only"
+msgstr "metadata only access"

oarepo_runtime-1.5.94/oarepo_runtime/translations/messages.pot

@@ -0,0 +1,72 @@
+# Translations template for PROJECT.
+# Copyright (C) 2025 ORGANIZATION
+# This file is distributed under the same license as the PROJECT project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PROJECT VERSION\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2025-02-17 10:27+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/search.py:71
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/search.py:175
+msgid "By Title"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/search.py:75
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/translations/default_translations.py:5
+msgid "Best match"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/search.py:79
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/translations/default_translations.py:3
+msgid "Newest"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/search.py:83
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/translations/default_translations.py:4
+msgid "Oldest"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/schema/ui.py:132
+msgid "True"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/schema/ui.py:132
+msgid "False"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/schema/ui.py:152
+msgid "access.status.open"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/schema/ui.py:153
+msgid "access.status.embargoed"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/schema/ui.py:154
+msgid "access.status.restricted"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/schema/ui.py:155
+msgid "access.status.metadata-only"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/services/schema/validation.py:31
+#, python-format
+msgid "Invalid value %(identifier)s of identifier type %(type)s"
+msgstr ""
+
+#: /home/dusanst/Projects/oarepo-runtime/oarepo_runtime/translations/default_translations.py:6
+msgid "Contact"
+msgstr ""
+

{oarepo_runtime-1.5.92 → oarepo_runtime-1.5.94/oarepo_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: oarepo-runtime
-Version: 1.5.92
+Version: 1.5.94
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo_runtime-1.5.92 → oarepo_runtime-1.5.94}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-runtime
-version = 1.5.92
+version = 1.5.94
 description = A set of runtime extensions of Invenio repository
 authors = Alzbeta Pokorna
 readme = README.md

oarepo_runtime-1.5.92/oarepo_runtime/services/permissions/__init__.py

@@ -1,3 +0,0 @@
-from .generators import RecordOwners, UserWithRole
-
-__all__ = ("RecordOwners", "UserWithRole")

oarepo_runtime-1.5.92/oarepo_runtime/translations/messages.pot

@@ -1,56 +0,0 @@
-# Translations template for PROJECT.
-# Copyright (C) 2024 ORGANIZATION
-# This file is distributed under the same license as the PROJECT project.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: PROJECT VERSION\n"
-"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2024-11-28 10:16+0100\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.15.0\n"
-
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/search.py:60
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/search.py:146
-msgid "By Title"
-msgstr ""
-
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/search.py:64
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/translations/default_translations.py:5
-msgid "Best match"
-msgstr ""
-
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/search.py:68
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/translations/default_translations.py:3
-msgid "Newest"
-msgstr ""
-
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/search.py:72
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/translations/default_translations.py:4
-msgid "Oldest"
-msgstr ""
-
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:123
-msgid "True"
-msgstr ""
-
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/ui.py:123
-msgid "False"
-msgstr ""
-
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/services/schema/validation.py:19
-#, python-format
-msgid "Invalid value %(identifier)s of identifier type %(type)s"
-msgstr ""
-
-#: /Users/m/w/cesnet/oarepo-runtime/oarepo_runtime/translations/default_translations.py:6
-msgid "Contact"
-msgstr ""
-