invenio-vocabularies 9.1.2__py2.py3-none-any.whl

invenio_vocabularies/records/systemfields/relations.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-2024 CERN.
+#
+# Invenio-Records-Resources is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Relations system fields."""
+
+from flask import current_app
+from invenio_records.systemfields import RelationsField
+from werkzeug.utils import cached_property
+
+from ..api import Vocabulary
+
+
+class CustomFieldsRelation(RelationsField):
+    """Relation field to manage custom fields.
+
+    Iterates through all configured custom fields and collects the ones
+    defining a relation dependency e.g vocabularies.
+    """
+
+    def __init__(self, fields_var):
+        """Initialize the field."""
+        super().__init__()
+        self._fields_var = fields_var
+
+    @cached_property
+    def _fields(self):
+        """Loads custom fields relations from config."""
+        custom_fields = current_app.config.get(self._fields_var, {})
+
+        relations = {}
+        for cf in custom_fields:
+            if getattr(cf, "relation_cls", None):
+                relations[cf.name] = cf.relation_cls(
+                    f"custom_fields.{cf.name}",
+                    keys=cf.field_keys,
+                    pid_field=cf.pid_field,
+                    cache_key=cf.vocabulary_id,
+                )
+
+        return relations
+
+    def __set__(self, instance, values):
+        """Setting the attribute."""
+        raise ValueError(
+            f"This field can only be set through config ({self._fields_var})"
+        )

invenio_vocabularies/resources/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2024 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Resources module."""
+
+from invenio_vocabularies.resources.schema import L10NString, VocabularyL10Schema
+
+from .config import VocabulariesResourceConfig, VocabularyTypeResourceConfig
+from .resource import VocabulariesAdminResource, VocabulariesResource
+
+__all__ = (
+    "VocabularyL10Schema",
+    "L10NString",
+    "VocabulariesResourceConfig",
+    "VocabularyTypeResourceConfig",
+    "VocabulariesAdminResource",
+    "VocabulariesResource",
+)

invenio_vocabularies/resources/config.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 CERN.
+# Copyright (C) 2024 University of Münster.
+#
+# Invenio-Vocabularies is free software; you can redistringibute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Resources config."""
+
+import marshmallow as ma
+from flask_resources import (
+    BaseListSchema,
+    HTTPJSONException,
+    JSONSerializer,
+    MarshmallowSerializer,
+    ResourceConfig,
+    ResponseHandler,
+    create_error_handler,
+)
+from invenio_records_resources.resources import (
+    RecordResource,
+    RecordResourceConfig,
+    SearchRequestArgsSchema,
+)
+from invenio_records_resources.resources.errors import ErrorHandlersMixin
+from invenio_records_resources.resources.records.args import SearchRequestArgsSchema
+from invenio_records_resources.resources.records.headers import etag_headers
+from invenio_records_resources.services.base.config import ConfiguratorMixin
+
+from .serializer import VocabularyL10NItemSchema
+
+
+class VocabularySearchRequestArgsSchema(SearchRequestArgsSchema):
+    """Vocabularies search request parameters."""
+
+    tags = ma.fields.Str()
+    active = ma.fields.Boolean()
+    status = ma.fields.Boolean()
+
+
+class VocabulariesResourceConfig(RecordResourceConfig):
+    """Vocabulary resource configuration."""
+
+    blueprint_name = "vocabularies"
+    url_prefix = "/vocabularies"
+    routes = {
+        "list": "/<type>",
+        "item": "/<type>/<pid_value>",
+        "tasks": "/tasks",
+    }
+
+    request_view_args = {
+        "pid_value": ma.fields.Str(),
+        "type": ma.fields.Str(required=True),
+    }
+
+    request_search_args = VocabularySearchRequestArgsSchema
+
+    response_handlers = {
+        "application/json": ResponseHandler(JSONSerializer(), headers=etag_headers),
+        "application/vnd.inveniordm.v1+json": ResponseHandler(
+            MarshmallowSerializer(
+                format_serializer_cls=JSONSerializer,
+                object_schema_cls=VocabularyL10NItemSchema,
+                list_schema_cls=BaseListSchema,
+            ),
+            headers=etag_headers,
+        ),
+    }
+
+
+class VocabularyTypeResourceConfig(ResourceConfig, ConfiguratorMixin):
+    """Vocabulary list resource config."""
+
+    # /vocabulary/vocabulary_id
+    # Blueprint configuration
+    blueprint_name = "vocabulary_types"
+    url_prefix = "/vocabularies"
+
+    routes = {"list": "/"}
+
+    # Request parsing
+    request_read_args = {}
+    request_view_args = {
+        "pid_value": ma.fields.String,
+        "type": ma.fields.String,
+    }
+    request_search_args = VocabularySearchRequestArgsSchema
+
+    error_handlers = {
+        **ErrorHandlersMixin.error_handlers,
+        # TODO: Add custom error handlers here
+    }
+    response_handlers = {
+        "application/json": ResponseHandler(JSONSerializer(), headers=etag_headers),
+        "application/vnd.inveniordm.v1+json": ResponseHandler(
+            MarshmallowSerializer(
+                format_serializer_cls=JSONSerializer,
+                object_schema_cls=VocabularyL10NItemSchema,
+                list_schema_cls=BaseListSchema,
+            ),
+            headers=etag_headers,
+        ),
+    }

invenio_vocabularies/resources/resource.py

@@ -0,0 +1,156 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2024 CERN.
+# Copyright (C) 2024 Uni Münster.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Vocabulary resource."""
+
+import json
+
+import marshmallow as ma
+from flask import g
+from flask_resources import (
+    BaseListSchema,
+    JSONSerializer,
+    MarshmallowSerializer,
+    ResponseHandler,
+    resource_requestctx,
+    response_handler,
+)
+from invenio_access.permissions import system_identity
+from invenio_records_resources.resources import (
+    RecordResource,
+    RecordResourceConfig,
+    SearchRequestArgsSchema,
+)
+from invenio_records_resources.resources.records.headers import etag_headers
+from invenio_records_resources.resources.records.resource import (
+    request_data,
+    request_headers,
+    request_search_args,
+    request_view_args,
+    route,
+)
+from invenio_records_resources.resources.records.utils import search_preference
+from marshmallow import fields
+
+from .serializer import VocabularyL10NItemSchema
+
+
+#
+# Resource
+#
+class VocabulariesResource(RecordResource):
+    """Resource for generic vocabularies.
+
+    Provide the API /api/vocabularies/
+    """
+
+    def create_url_rules(self):
+        """Create the URL rules for the record resource."""
+        routes = self.config.routes
+        rules = super().create_url_rules()
+
+        rules.append(
+            route("POST", routes["tasks"], self.launch),
+        )
+        return rules
+
+    @request_search_args
+    @request_view_args
+    @response_handler(many=True)
+    def search(self):
+        """Perform a search over the items."""
+        hits = self.service.search(
+            identity=g.identity,
+            params=resource_requestctx.args,
+            type=resource_requestctx.view_args["type"],
+            search_preference=search_preference(),
+        )
+        return hits.to_dict(), 200
+
+    @request_view_args
+    @request_data
+    @response_handler()
+    def create(self):
+        """Create an item."""
+        item = self.service.create(
+            g.identity,
+            resource_requestctx.data or {},
+        )
+        return item.to_dict(), 201
+
+    @request_view_args
+    @response_handler()
+    def read(self):
+        """Read an item."""
+        pid_value = (
+            resource_requestctx.view_args["type"],
+            resource_requestctx.view_args["pid_value"],
+        )
+        item = self.service.read(g.identity, pid_value)
+        return item.to_dict(), 200
+
+    @request_headers
+    @request_view_args
+    @request_data
+    @response_handler()
+    def update(self):
+        """Update an item."""
+        pid_value = (
+            resource_requestctx.view_args["type"],
+            resource_requestctx.view_args["pid_value"],
+        )
+        item = self.service.update(
+            g.identity,
+            pid_value,
+            resource_requestctx.data,
+            revision_id=resource_requestctx.headers.get("if_match"),
+        )
+        return item.to_dict(), 200
+
+    @request_headers
+    @request_view_args
+    def delete(self):
+        """Delete an item."""
+        pid_value = (
+            resource_requestctx.view_args["type"],
+            resource_requestctx.view_args["pid_value"],
+        )
+        self.service.delete(
+            g.identity,
+            pid_value,
+            revision_id=resource_requestctx.headers.get("if_match"),
+        )
+        return "", 204
+
+    @request_data
+    def launch(self):
+        """Create a task."""
+        self.service.launch(g.identity, resource_requestctx.data or {})
+        return "", 202
+
+
+class VocabulariesAdminResource(RecordResource):
+    """Resource for vocabularies admin interface."""
+
+    def create_url_rules(self):
+        """Create the URL rules for the record resource."""
+        routes = self.config.routes
+
+        rules = [route("GET", routes["list"], self.search)]
+
+        return rules
+
+    @request_search_args
+    @response_handler(many=True)
+    def search(self):
+        """Return information about _all_ vocabularies."""
+        identity = g.identity
+        hits = self.service.search(identity, params=resource_requestctx.args)
+
+        return hits.to_dict(), 200

invenio_vocabularies/resources/schema.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2024 CERN.
+# Copyright (C) 2021 Northwestern University.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Vocabulary resource schema."""
+
+from marshmallow import Schema, fields
+
+from invenio_vocabularies.resources.serializer import L10NString
+
+
+class VocabularyL10Schema(Schema):
+    """Vocabulary schema."""
+
+    id = fields.String()
+    title = L10NString(data_key="title_l10n")

invenio_vocabularies/resources/serializer.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Localization serializer for Vocabularies."""
+
+from functools import partial
+
+from flask import current_app
+from flask_resources import BaseListSchema, BaseObjectSchema
+from invenio_i18n import get_locale
+from marshmallow import fields
+from marshmallow_utils.fields import BabelGettextDictField
+
+
+def current_default_locale():
+    """Get the Flask app's default locale."""
+    if current_app:
+        return current_app.config.get("BABEL_DEFAULT_LOCALE", "en")
+    # Use english by default if not specified
+    return "en"
+
+
+L10NString = partial(BabelGettextDictField, get_locale, current_default_locale)
+
+
+class VocabularyL10NItemSchema(BaseObjectSchema):
+    """Vocabulary serializer schema."""
+
+    id = fields.String(dump_only=True)
+    title = L10NString(data_key="title_l10n")
+    description = L10NString(data_key="description_l10n")
+    props = fields.Dict(dump_only=True)
+    icon = fields.String(dump_only=True)
+    tags = fields.List(fields.Str(), dump_only=True)

invenio_vocabularies/services/__init__.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2024 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Services module."""
+
+from .config import VocabulariesServiceConfig, VocabularyTypesServiceConfig
+from .service import VocabulariesService, VocabularyTypeService
+
+__all__ = (
+    "VocabulariesService",
+    "VocabularyTypeService",
+    "VocabulariesServiceConfig",
+    "VocabularyTypesServiceConfig",
+)

invenio_vocabularies/services/components.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2021 CERN.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Vocabulary components."""
+
+from invenio_i18n import lazy_gettext as _
+from invenio_records_resources.services.records.components import ServiceComponent
+from marshmallow import ValidationError
+from sqlalchemy.orm.exc import NoResultFound
+
+from ..records.models import VocabularyType
+
+
+class VocabularyTypeComponent(ServiceComponent):
+    """Set the record's vocabulary type."""
+
+    def _set_type(self, data, record):
+        type_id = data.pop("type", None)
+        if type_id:
+            try:
+                record.type = VocabularyType.query.filter_by(id=type_id["id"]).one()
+            except NoResultFound:
+                raise ValidationError(
+                    _("The vocabulary type does not exists."),
+                    field_name="type",
+                )
+
+    def create(self, identity, data=None, record=None, **kwargs):
+        """Inject vocabulary type to the record."""
+        self._set_type(data, record)
+
+    def update(self, identity, data=None, record=None, **kwargs):
+        """Inject vocabulary type to the record."""
+        self._set_type(data, record)
+
+
+class PIDComponent(ServiceComponent):
+    """PID registration component."""
+
+    def create(self, identity, data=None, record=None, **kwargs):
+        """Create PID when record is created.."""
+        # We create the PID after all the data has been initialized. so that
+        # we can rely on having the 'id' and type set.
+        self.service.record_cls.pid.create(record)
+
+
+class ModelPIDComponent(PIDComponent):
+    """Model PID registration component."""
+
+    def update(self, identity, data=None, record=None, **kwargs):
+        """Update an existing record."""
+        record.pop("pid", None)
+        record.pop("id", None)

invenio_vocabularies/services/config.py

@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 CERN.
+# Copyright (C) 2024 University of Münster.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Vocabulary services configs."""
+
+import sqlalchemy as sa
+from flask import current_app
+from invenio_i18n import lazy_gettext as _
+from invenio_records_resources.services import (
+    Link,
+    RecordServiceConfig,
+    SearchOptions,
+    pagination_links,
+)
+from invenio_records_resources.services.base import ConditionalLink
+from invenio_records_resources.services.records.components import DataComponent
+from invenio_records_resources.services.records.params import (
+    FilterParam,
+    SuggestQueryParser,
+)
+
+from ..records.api import Vocabulary
+from ..records.models import VocabularyType
+from . import results
+from .components import PIDComponent, VocabularyTypeComponent
+from .permissions import PermissionPolicy
+from .schema import TaskSchema, VocabularySchema
+
+
+def is_custom_vocabulary_type(vocabulary_type, context):
+    """Check if the vocabulary type is a custom vocabulary type."""
+    return vocabulary_type["id"] in current_app.config.get(
+        "VOCABULARIES_CUSTOM_VOCABULARY_TYPES", []
+    )
+
+
+class VocabularySearchOptions(SearchOptions):
+    """Search options for vocabularies."""
+
+    params_interpreters_cls = [
+        FilterParam.factory(param="tags", field="tags"),
+    ] + SearchOptions.params_interpreters_cls
+
+    suggest_parser_cls = SuggestQueryParser.factory(
+        fields=[
+            "id.text^100",
+            "id.text._2gram",
+            "id.text._3gram",
+            "title.en^5",
+            "title.en._2gram",
+            "title.en._3gram",
+        ],
+    )
+
+    sort_default = "bestmatch"
+
+    sort_default_no_query = "title"
+
+    sort_options = {
+        "bestmatch": dict(
+            title=_("Best match"),
+            fields=["_score"],  # ES defaults to desc on `_score` field
+        ),
+        "title": dict(
+            title=_("Title"),
+            fields=["title_sort"],
+        ),
+        "newest": dict(
+            title=_("Newest"),
+            fields=["-created"],
+        ),
+        "oldest": dict(
+            title=_("Oldest"),
+            fields=["created"],
+        ),
+    }
+
+
+class VocabularyTypeSearchOptions(SearchOptions):
+    """Search options for vocabulary types."""
+
+    sort_options = {
+        "id": dict(
+            title=_("ID"),
+            fields=["id"],
+        ),
+    }
+
+    sort_default = "id"
+
+    sort_default_no_query = "id"
+
+    sort_direction_options = {
+        "asc": dict(title=_("Ascending"), fn=sa.asc),
+        "desc": dict(title=_("Descending"), fn=sa.desc),
+    }
+
+    sort_direction_default = "asc"
+
+
+class VocabulariesServiceConfig(RecordServiceConfig):
+    """Vocabulary service configuration."""
+
+    service_id = "vocabularies"
+    indexer_queue_name = "vocabularies"
+    permission_policy_cls = PermissionPolicy
+    record_cls = Vocabulary
+    schema = VocabularySchema
+    task_schema = TaskSchema
+
+    search = VocabularySearchOptions
+
+    components = [
+        # Order of components are important!
+        VocabularyTypeComponent,
+        DataComponent,
+        PIDComponent,
+    ]
+
+    links_item = {
+        "self": Link(
+            "{+api}/vocabularies/{type}/{id}",
+            vars=lambda record, vars: vars.update(
+                {
+                    "id": record.pid.pid_value,
+                    "type": record.type.id,
+                }
+            ),
+        ),
+    }
+
+    links_search = pagination_links("{+api}/vocabularies/{type}{?args*}")
+
+
+class VocabularyTypesServiceConfig(RecordServiceConfig):
+    """Vocabulary types service configuration."""
+
+    service_id = "vocabulary_types"
+    permission_policy_cls = PermissionPolicy
+    record_cls = VocabularyType
+    schema = VocabularySchema  # Works but should be VocabularyTypeSchema if this is defined at some point
+    result_list_cls = results.VocabularyTypeList
+
+    links_item = {
+        "self": ConditionalLink(
+            cond=is_custom_vocabulary_type,
+            if_=Link(
+                "{+api}/{id}",
+                vars=lambda vocab_type, vars: vars.update({"id": vocab_type["id"]}),
+            ),
+            else_=Link(
+                "{+api}/vocabularies/{id}",
+                vars=lambda vocab_type, vars: vars.update({"id": vocab_type["id"]}),
+            ),
+        )
+    }
+
+    search = VocabularyTypeSearchOptions
+
+    components = [
+        # Order of components are important!
+        VocabularyTypeComponent,
+        DataComponent,
+        PIDComponent,
+    ]
+
+    links_search = pagination_links("{+api}/vocabularies/{type}{?args*}")

invenio_vocabularies/services/custom_fields/__init__.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-2024 CERN.
+#
+# Invenio-RDM-Records is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+"""Custom Fields for InvenioRDM."""
+
+from .subject import SUBJECT_FIELDS, SUBJECT_FIELDS_UI
+from .vocabulary import VocabularyCF
+
+__all__ = [
+    "VocabularyCF",
+    "SUBJECT_FIELDS_UI",
+    "SUBJECT_FIELDS",
+]