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

invenio_vocabularies/services/service.py

@@ -0,0 +1,189 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 CERN.
+# Copyright (C) 2021 Northwestern University.
+# Copyright (C) 2024 University of Münster.
+# Copyright (C) 2025 Graz University of Technology.
+#
+# 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 service."""
+
+import sqlalchemy as sa
+from invenio_cache import current_cache
+from invenio_records_resources.services import LinksTemplate, RecordService
+from invenio_records_resources.services.base.utils import map_search_params
+from invenio_records_resources.services.records.schema import ServiceSchemaWrapper
+from invenio_records_resources.services.uow import unit_of_work
+from invenio_search.engine import dsl
+
+from ..records.models import VocabularyType
+from .tasks import process_datastream
+
+
+class VocabularyTypeService(RecordService):
+    """Vocabulary type service."""
+
+    def rebuild_index(self, identity, uow=None):
+        """Raise error since services are not backed by search indices."""
+        raise NotImplementedError()
+
+    def search(self, identity, params=None):
+        """Search for vocabulary types entries."""
+        self.require_permission(identity, "list_vocabularies")
+
+        filters = []
+        search_params = map_search_params(self.config.search, params)
+
+        query_param = search_params["q"]
+        if query_param:
+            filters.append(
+                # NOTE: Even though we only have one field, we use `or_` to
+                # allow for future expansion where multiple fields might be searched.
+                sa.or_(
+                    VocabularyType.id.ilike(f"%{query_param}%"),
+                )
+            )
+
+        vocabulary_types = (
+            VocabularyType.query.filter(*filters)
+            .order_by(
+                search_params["sort_direction"](
+                    sa.text(",".join(search_params["sort"]))
+                )
+            )
+            .paginate(
+                page=search_params["page"],
+                per_page=search_params["size"],
+                error_out=False,
+            )
+        )
+
+        return self.config.result_list_cls(
+            self,
+            identity,
+            vocabulary_types,
+            search_params,
+            links_tpl=LinksTemplate(self.config.links_search, context={"args": params}),
+            links_item_tpl=self.links_item_tpl,
+        )
+
+
+class VocabulariesService(RecordService):
+    """Vocabulary service."""
+
+    @property
+    def task_schema(self):
+        """Returns the data schema instance."""
+        return ServiceSchemaWrapper(self, schema=self.config.task_schema)
+
+    @unit_of_work()
+    def create_type(self, identity, id, pid_type, uow=None):
+        """Create a new vocabulary type."""
+        self.require_permission(identity, "manage")
+        type_ = VocabularyType.create(id=id, pid_type=pid_type)
+        return type_
+
+    def search(
+        self, identity, params=None, search_preference=None, type=None, **kwargs
+    ):
+        """Search for vocabulary entries."""
+        self.require_permission(identity, "search")
+
+        # If not found, NoResultFound is raised (caught by the resource).
+        vocabulary_type = VocabularyType.query.filter_by(id=type).one()
+
+        # Prepare and execute the search
+        params = params or {}
+        search_result = self._search(
+            "search",
+            identity,
+            params,
+            search_preference,
+            extra_filter=dsl.Q("term", type__id=vocabulary_type.id),
+            **kwargs,
+        ).execute()
+
+        return self.result_list(
+            self,
+            identity,
+            search_result,
+            params,
+            links_tpl=LinksTemplate(
+                self.config.links_search,
+                context={
+                    "args": params,
+                    "type": vocabulary_type.id,
+                },
+            ),
+            links_item_tpl=self.links_item_tpl,
+        )
+
+    def read_all(self, identity, fields, type, cache=True, extra_filter="", **kwargs):
+        """Search for records matching the querystring."""
+        cache_key = type + "_" + str(extra_filter) + "_" + "-".join(fields)
+        results = current_cache.get(cache_key)
+        search_query = dsl.Q("match_all")
+
+        if not results:
+            # If not found, NoResultFound is raised (caught by the resource).
+            vocabulary_type = VocabularyType.query.filter_by(id=type).one()
+            vocab_id_filter = dsl.Q("term", type__id=vocabulary_type.id)
+            if extra_filter:
+                vocab_id_filter = vocab_id_filter & extra_filter
+            results = self._read_many(
+                identity, search_query, fields, extra_filter=vocab_id_filter, **kwargs
+            )
+            if cache:
+                # ES DSL Response is not pickable.
+                # If saved in cache serialization wont work with to_dict()
+                current_cache.set(cache_key, results.to_dict())
+
+        else:
+            search = self.create_search(
+                identity=identity,
+                record_cls=self.record_cls,
+                search_opts=self.config.search,
+                permission_action="search",
+            ).query(search_query)
+
+            results = dsl.response.Response(search, results)
+
+        return self.result_list(self, identity, results)
+
+    def read_many(self, identity, type, ids, fields=None, **kwargs):
+        """Search for records matching the querystring filtered by ids."""
+        search_query = dsl.Q("match_all")
+        vocabulary_type = VocabularyType.query.filter_by(id=type).one()
+        vocab_id_filter = dsl.Q("term", type__id=vocabulary_type.id)
+        filters = []
+
+        for id_ in ids:
+            filters.append(dsl.Q("term", **{"id": id_}))
+        filter = dsl.Q("bool", minimum_should_match=1, should=filters)
+        filter = filter & vocab_id_filter
+        results = self._read_many(
+            identity, search_query, fields, extra_filter=filter, **kwargs
+        )
+
+        return self.result_list(self, identity, results)
+
+    def launch(self, identity, data):
+        """Create a task.
+
+        FIXME: This is a PoC. The final implementation should resemble
+        the PIDs, having a sub-service and a manager. If persistance is
+        added UoW should be used.
+        """
+        self.require_permission(identity, "manage")
+        task_config, _ = self.task_schema.load(
+            data,
+            context={"identity": identity},  # FIXME: is this needed
+            raise_errors=True,
+        )
+        process_datastream.delay(task_config)
+
+        # 202 if accepted, otherwise it will be caught by an error handler
+        return True

invenio_vocabularies/services/tasks.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-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.
+
+"""Celery tasks."""
+
+from celery import shared_task
+from flask import current_app
+from invenio_jobs.errors import TaskExecutionPartialError
+
+from ..datastreams.factories import DataStreamFactory
+
+
+@shared_task(ignore_result=True)
+def process_datastream(config):
+    """Process a datastream from config."""
+    ds = DataStreamFactory.create(
+        readers_config=config["readers"],
+        transformers_config=config.get("transformers"),
+        writers_config=config["writers"],
+        batch_size=config.get("batch_size", 1000),
+        write_many=config.get("write_many", False),
+    )
+    entries_with_errors = 0
+    for result in ds.process():
+        if result.errors:
+            for err in result.errors:
+                current_app.logger.error(err)
+            entries_with_errors += 1
+
+    if entries_with_errors:
+        raise TaskExecutionPartialError(
+            message=f"Task execution succeeded with {entries_with_errors} entries with errors.",
+            errored_entries_count=entries_with_errors,
+        )

invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/subjects.html

@@ -0,0 +1,23 @@
+{#
+  Copyright (C) 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.
+#}
+
+{%- set subjects = field_value -%}
+{% if subjects %}
+  <ul class="ui horizontal list no-bullets subjects">
+    {%- for subject in subjects %}
+    <li class="item">
+      {%- set q = 'metadata.subjects.subject:"' + subject.subject + '"' %}
+      <a href="{{ url_for('invenio_search_ui.search', q=q) }}"
+          class="subject"
+          title="{{ _('Search results for ') + subject.subject }}"
+      >
+        {{ subject.subject }}
+      </a>
+    </li>
+    {%- endfor %}
+  </ul>
+{% endif %}

invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabularies-list.html

@@ -0,0 +1,12 @@
+{#
+    Copyright (C) 2024 Uni Münster.
+
+    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 "invenio_administration/search.html" %}
+
+  {% block javascript %}
+  {{ super() }}
+  {{ webpack['invenio-vocabularies-search.js'] }}
+{% endblock %}

invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabulary-details.html

@@ -0,0 +1,71 @@
+{#
+    Copyright (C) 2024 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.
+  #}
+  
+  {%- from "invenio_administration/macros.html" import go_back %}
+  
+  {% extends "invenio_administration/search.html" %}
+  
+  {% block admin_main_column %}
+    <main id="admin-main-content"
+          class="ten wide mobile twelve wide tablet thirteen wide computer fourteen wide widescreen column">
+  
+      <div class="ui container fluid pl-10 pr-10 pt-10 pb-10">
+        {{ go_back() }}
+      <div class="ui grid">
+        <div class="column six wide">
+          <h1 class="ui header">{{ title or name }}</h1>
+        </div>
+        <div class="column ten wide right aligned">
+          <a class="ui icon labeled button"
+              href="{{ edit_endpoint }}">
+            <i aria-hidden="true"
+                class="cog icon"></i>{{ _("Settings") }}
+          </a>
+          <a class="ui icon labeled button"
+              href="{{ create_ui_endpoint }}">
+            <i aria-hidden="true"
+                class="calendar icon"></i>{{ _("Schedule") }}
+          </a>
+          <a class="ui icon labeled button"
+              href="{{ run_endpoint }}">
+            <i aria-hidden="true"
+                class="play icon"></i>{{ _("Run now") }}
+          </a>
+        </div>
+      </div>
+        {% block admin_page_content %}
+          <div class="ui divider" aria-hidden="true"></div>
+  
+          {%- block search_app %}
+            <div
+              id="invenio-search-config"
+              data-title='{{ title | tojson }}'
+              data-resource-name='{{ resource_name | tojson }}'
+              data-invenio-search-config='{{ search_config() | tojson }}'
+              data-fields='{{ fields | tojson }}'
+              data-display-search='{{ display_search | tojson }}'
+              data-display-read='{{ display_read | tojson }}'
+              data-display-edit='{{ display_edit | tojson }}'
+              data-display-delete='{{ display_delete | tojson }}'
+              data-resource-schema='{{ resource_schema | tojson }}'
+              data-actions='{{ actions | tojson }}'
+              data-api-endpoint='{{ api_endpoint }}'
+              data-pid-path='{{ pid_path | tojson }}'
+              data-create-endpoint='{{ create_ui_endpoint }}'
+              data-list-endpoint='{{ list_ui_endpoint }}'
+            >
+            </div>
+          {%- endblock search_app %}
+        {% endblock admin_page_content %}
+      </div>
+    </main>
+  {% endblock %}
+  
+  {% block javascript %}
+    {{ super() }}
+    {{ webpack['invenio-jobs-details.js'] }}
+  {% endblock %}

invenio_vocabularies/translations/ar/LC_MESSAGES/messages.po

@@ -0,0 +1,277 @@
+# Translations template for invenio-vocabularies.
+# Copyright (C) 2025 CERN
+# This file is distributed under the same license as the
+# invenio-vocabularies project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
+# 
+# Translators:
+# Tibor Simko <tibor.simko@cern.ch>, 2021
+# Salaheddine Ben Ali <salaheddine.benali@cnudst.tn>, 2025
+# Bessem Aamira <bessemamira@gmail.com>, 2025
+# 
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: invenio-vocabularies 8.1.0\n"
+"Report-Msgid-Bugs-To: info@inveniosoftware.org\n"
+"POT-Creation-Date: 2025-07-08 20:00+0000\n"
+"PO-Revision-Date: 2021-07-13 12:40+0000\n"
+"Last-Translator: Bessem Aamira <bessemamira@gmail.com>, 2025\n"
+"Language-Team: Arabic (https://app.transifex.com/inveniosoftware/teams/23537/ar/)\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"
+"Language: ar\n"
+"Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;\n"
+
+#: invenio_vocabularies/config.py:44
+msgid "GRID"
+msgstr "GRID"
+
+#: invenio_vocabularies/config.py:45 invenio_vocabularies/config.py:126
+#: invenio_vocabularies/config.py:131
+msgid "GND"
+msgstr "GND"
+
+#: invenio_vocabularies/config.py:46 invenio_vocabularies/config.py:125
+msgid "ISNI"
+msgstr "ISNI"
+
+#: invenio_vocabularies/config.py:47
+msgid "ROR"
+msgstr "رور ROR"
+
+#: invenio_vocabularies/config.py:68
+msgid "PIC"
+msgstr ""
+
+#: invenio_vocabularies/config.py:69
+msgid "EDMO"
+msgstr ""
+
+#: invenio_vocabularies/config.py:75 invenio_vocabularies/config.py:84
+msgid "DOI"
+msgstr "المعرف الوحيد للأشياء DOI"
+
+#: invenio_vocabularies/config.py:83 invenio_vocabularies/config.py:132
+msgid "URL"
+msgstr "عنوان ويب URL"
+
+#: invenio_vocabularies/config.py:124
+msgid "ORCID"
+msgstr "أوركيد ORCID"
+
+#: invenio_vocabularies/administration/views/vocabularies.py:37
+#: invenio_vocabularies/config.py:175
+#: invenio_vocabularies/contrib/affiliations/config.py:61
+#: invenio_vocabularies/contrib/funders/config.py:60
+#: invenio_vocabularies/contrib/names/config.py:55
+#: invenio_vocabularies/contrib/subjects/config.py:70
+msgid "Name"
+msgstr "إسم"
+
+#: invenio_vocabularies/administration/views/vocabularies.py:38
+#: invenio_vocabularies/config.py:179
+msgid "Number of entries"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:30
+msgid "Process ROR affiliations"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:31
+msgid "Load ROR affiliations"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:68
+msgid "Process ROR funders"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:69
+msgid "Load ROR funders"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:106
+msgid "Import awards from OpenAIRE"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:107
+msgid "Import Awards OpenAIRE"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:141
+msgid "Update awards from CORDIS"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:142
+msgid "Update Awards CORDIS"
+msgstr ""
+
+#: invenio_vocabularies/jobs.py:169 invenio_vocabularies/jobs.py:170
+msgid "Import ORCID data"
+msgstr ""
+
+#: invenio_vocabularies/administration/views/vocabularies.py:21
+#: invenio_vocabularies/administration/views/vocabularies.py:24
+msgid "Vocabulary Types"
+msgstr ""
+
+#: invenio_vocabularies/administration/views/vocabularies.py:25
+msgid "Site management"
+msgstr "إدارة الموقع"
+
+#: invenio_vocabularies/contrib/affiliations/config.py:57
+#: invenio_vocabularies/contrib/funders/config.py:56
+#: invenio_vocabularies/contrib/names/config.py:51
+#: invenio_vocabularies/contrib/subjects/config.py:66
+#: invenio_vocabularies/services/config.py:67
+msgid "Best match"
+msgstr "أفضل تطابق "
+
+#: invenio_vocabularies/contrib/affiliations/config.py:65
+#: invenio_vocabularies/contrib/funders/config.py:64
+#: invenio_vocabularies/contrib/names/config.py:59
+#: invenio_vocabularies/contrib/subjects/config.py:74
+#: invenio_vocabularies/services/config.py:75
+msgid "Newest"
+msgstr "الأحدث"
+
+#: invenio_vocabularies/contrib/affiliations/config.py:69
+#: invenio_vocabularies/contrib/funders/config.py:68
+#: invenio_vocabularies/contrib/names/config.py:63
+#: invenio_vocabularies/contrib/subjects/config.py:78
+#: invenio_vocabularies/services/config.py:79
+msgid "Oldest"
+msgstr "الأقدم"
+
+#: invenio_vocabularies/contrib/affiliations/schema.py:41
+#: invenio_vocabularies/contrib/funders/schema.py:36
+#: invenio_vocabularies/contrib/funders/schema.py:44
+msgid "Name cannot be blank."
+msgstr "اﻹسم لا يمكن أن يكون فارغا"
+
+#: invenio_vocabularies/contrib/affiliations/schema.py:47
+#: invenio_vocabularies/contrib/awards/schema.py:69
+#: invenio_vocabularies/contrib/funders/schema.py:60
+msgid "PID cannot be blank."
+msgstr "معرف PID لا يمكن أن يكون فارغا."
+
+#: invenio_vocabularies/contrib/awards/config.py:49
+msgid "Funders"
+msgstr "ممولون"
+
+#: invenio_vocabularies/contrib/awards/datastreams.py:67
+#, python-brace-format
+msgid "Unknown OpenAIRE funder prefix {openaire_funder_prefix}"
+msgstr "OpenAIRE funder prefix غير معلوم {openaire_funder_prefix}"
+
+#: invenio_vocabularies/contrib/awards/datastreams.py:108
+#, python-brace-format
+msgid "Missing title attribute for award {award_id}"
+msgstr ""
+
+#: invenio_vocabularies/contrib/awards/datastreams.py:244
+#, python-brace-format
+msgid "No related legal basis programme found for project {project_id}"
+msgstr ""
+
+#: invenio_vocabularies/contrib/awards/schema.py:52
+msgid "Number cannot be blank."
+msgstr "الرقم لا يمكن أن يكون فارغا"
+
+#: invenio_vocabularies/contrib/awards/schema.py:100
+msgid "An existing id or either number or title must be present."
+msgstr ""
+
+#: invenio_vocabularies/contrib/awards/schema.py:118
+msgid "At least award or funder should be present."
+msgstr " يجب ان يكون هناك جائزة أو ممول على الاقل."
+
+#: invenio_vocabularies/contrib/common/ror/datastreams.py:147
+msgid "Id not found in ROR entry."
+msgstr "معرف Id غير متواجد بمدخلات سجل ROR."
+
+#: invenio_vocabularies/contrib/common/ror/datastreams.py:179
+msgid "Name with type ror_display not found in ROR entry."
+msgstr ""
+
+#: invenio_vocabularies/contrib/funders/schema.py:73
+#: invenio_vocabularies/services/schema.py:120
+msgid "Missing PID."
+msgstr "معرف PID مفقود."
+
+#: invenio_vocabularies/contrib/names/schema.py:76
+msgid ""
+"A name or the family name together with the given name must be present."
+msgstr "يجب أن يكون اللّقب أو اسم العائلة موجودا مع الاسم."
+
+#: invenio_vocabularies/contrib/names/schema.py:90
+msgid "Duplicated affiliations."
+msgstr "الانتماءات المكررة."
+
+#: invenio_vocabularies/records/models.py:84
+#, python-format
+msgid "No '%(banned_char)s' allowed in VocabularyScheme.id"
+msgstr "كل '%(banned_char)s' غير مسموحة في VocabularyScheme.id"
+
+#: invenio_vocabularies/services/components.py:29
+msgid "The vocabulary type does not exists."
+msgstr "نوع المفردات غير موجود."
+
+#: invenio_vocabularies/services/config.py:71
+msgid "Title"
+msgstr "العنوان"
+
+#: invenio_vocabularies/services/config.py:90
+msgid "ID"
+msgstr "معرّف ID"
+
+#: invenio_vocabularies/services/config.py:100
+msgid "Ascending"
+msgstr "تصاعدي"
+
+#: invenio_vocabularies/services/config.py:101
+msgid "Descending"
+msgstr "تنازلي"
+
+#: invenio_vocabularies/services/schema.py:85
+#, python-brace-format
+msgid "An existing id or a free text {ftf_name} must be present."
+msgstr "يجب أن يكون هناك معرف id موجود او نص حر {ftf_name}."
+
+#: invenio_vocabularies/services/custom_fields/subject.py:50
+msgid "Subjects"
+msgstr "المواضيع"
+
+#: invenio_vocabularies/services/custom_fields/subject.py:57
+msgid "Keywords and subjects"
+msgstr "كلمات مفتاحية و مواضيع"
+
+#: invenio_vocabularies/services/custom_fields/subject.py:59
+msgid "The subjects related to the community"
+msgstr "المواضيع المتعلقة بالمجتمع"
+
+#: invenio_vocabularies/services/custom_fields/subject.py:60
+msgid "Search for a subject by name e.g. Psychology ..."
+msgstr "إبحث عن موضوع حسب الاسم مثل: علم النفس ..."
+
+#: invenio_vocabularies/services/custom_fields/subject.py:62
+msgid "Search for subjects..."
+msgstr "البحث عن المواضيع..."
+
+#: invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/subjects.html:16
+msgid "Search results for "
+msgstr "نتائج البحث لـ"
+
+#: invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabulary-details.html:26
+msgid "Settings"
+msgstr "إعدادات"
+
+#: invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabulary-details.html:31
+msgid "Schedule"
+msgstr ""
+
+#: invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabulary-details.html:36
+msgid "Run now"
+msgstr ""