Vocabulary item view

invenio_vocabularies/administration/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 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.
+
+"""Invenio administration views module for vocabularies."""

invenio_vocabularies/administration/views/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2021 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.
+
+"""Invenio administration views module for Vocabularies."""

invenio_vocabularies/administration/views/vocabularies.py

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2021 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.
+
+"""Vocabularies admin interface."""
+from flask import current_app
+from invenio_administration.views.base import AdminResourceListView
+
+
+class VocabulariesListView(AdminResourceListView):
+    """Configuration for vocabularies list view."""
+
+    api_endpoint = "/vocabularies/"
+    name = "vocabulary-types"
+    menu_label = "Vocabulary Types"
+    resource_config = "vocabulary_admin_resource"
+    search_request_headers = {"Accept": "application/json"}
+    title = "Vocabulary Types"
+    category = "Site management"
+
+    pid_path = "id"
+    icon = "exchange"
+    template = "invenio_administration/search.html"
+
+    display_search = True
+    display_delete = False
+    display_edit = False
+    display_create = False
+
+    item_field_list = {
+        "id": {"text": "Name", "order": 1},
+        "count": {"text": "Number of entries", "order": 2},
+    }
+
+    search_config_name = "VOCABULARIES_TYPES_SEARCH"
+    search_facets_config_name = "VOCABULARIES_TYPES_FACETS"
+    search_sort_config_name = "VOCABULARIES_TYPES_SORT_OPTIONS"
+
+
+class VocabularyDetailsListView(AdminResourceListView):
+    """Configuration for vocabularies list view."""
+
+    def get_api_endpoint(self, pid_value=None):
+        """Overwrite get_api_endpoint to accept pid_value."""
+        if pid_value in current_app.config.get(
+            "VOCABULARIES_CUSTOM_VOCABULARY_TYPES", []
+        ):
+            return f"/api/{pid_value}"
+        else:
+            return f"/api/vocabularies/{pid_value}"
+
+    def get_context(self, **kwargs):
+        """Create details view context."""
+        search_conf = self.init_search_config(**kwargs)
+        schema = self.get_service_schema()
+        serialized_schema = self._schema_to_json(schema)
+        pid_value = kwargs.get("pid_value", "")
+        return {
+            "search_config": search_conf,
+            "title": f"{pid_value.capitalize()} vocabulary items",
+            "name": self.name,
+            "resource_schema": serialized_schema,
+            "fields": self.item_field_list,
+            "display_search": self.display_search,
+            "display_create": self.display_create,
+            "display_edit": self.display_edit,
+            "display_delete": self.display_delete,
+            "display_read": self.display_read,
+            "actions": self.serialize_actions(),
+            "pid_path": self.pid_path,
+            "pid_value": pid_value,
+            "create_ui_endpoint": self.get_create_view_endpoint(),
+            "list_ui_endpoint": self.get_list_view_endpoint(),
+            "resource_name": (
+                self.resource_name if self.resource_name else self.pid_path
+            ),
+        }
+
+    name = "vocabulary-type-items"
+    url = "/vocabulary-types/<pid_value>"
+
+    api_endpoint = "/vocabularies/"
+
+    # INFO name of the resource's list view name, enables navigation between items view and types view.
+    list_view_name = "vocabulary-types"
+
+    resource_config = "vocabulary_admin_resource"
+    search_request_headers = {"Accept": "application/json"}
+
+    pid_path = "id"
+
+    # INFO only if disabled() (as a function) it's not in the sidebar, see https://github.com/inveniosoftware/invenio-administration/blob/main/invenio_administration/menu/menu.py#L54
+    disabled = lambda _: True
+
+    template = "invenio_administration/search.html"
+
+    display_delete = False
+    display_create = False
+    display_edit = True
+    display_search = True
+
+    # TODO: It would be nicer to choose the correct column depending on the vocabulary
+    # TODO: It would ne nicer to use the title's translation in the currently selected language and fall back to English if this doesn't exist
+    item_field_list = {
+        "name": {"text": "Name", "order": 0},
+        "title['en']": {"text": "Title [en]", "order": 1},
+        "subject": {"text": "Subject", "order": 2},
+        "created": {"text": "Created", "order": 3},
+    }
+
+    search_config_name = "VOCABULARIES_TYPES_ITEMS_SEARCH"
+    search_facets_config_name = "VOCABULARIES_TYPES_ITEMS_FACETS"
+    search_sort_config_name = "VOCABULARIES_TYPES_ITEMS_SORT_OPTIONS"

invenio_vocabularies/config.py

@@ -25,8 +25,8 @@
 )
 from .datastreams.transformers import XMLTransformer
 from .datastreams.writers import ServiceWriter, YamlWriter
-from .resources.resource import VocabulariesResourceConfig
-from .services.service import VocabulariesServiceConfig
+from .resources import VocabulariesResourceConfig
+from .services.config import VocabulariesServiceConfig
 
 VOCABULARIES_RESOURCE_CONFIG = VocabulariesResourceConfig
 """Configure the resource."""
@@ -103,6 +103,15 @@
 }
 """Names allowed identifier schemes."""
 
+# configure CUSTOM_VOCABULARY_TYPES to differentiate output. Is used in VocabulariesServiceConfig
+VOCABULARIES_CUSTOM_VOCABULARY_TYPES = [
+    "names",
+    "affiliations",
+    "awards",
+    "funders",
+    "subjects",
+]
+
 VOCABULARIES_DATASTREAM_READERS = {
     "csv": CSVReader,
     "json": JsonReader,
@@ -126,3 +135,45 @@
     "yaml": YamlWriter,
 }
 """Data Streams writers."""
+
+VOCABULARIES_TYPES_SORT_OPTIONS = {
+    "name": dict(
+        title=_("Name"),
+        fields=["id"],
+    ),
+    "count": dict(
+        title=_("Number of entries"),
+        fields=["count"],
+    ),
+}
+"""Definitions of available Vocabulary types sort options. """
+
+VOCABULARIES_TYPES_SEARCH = {
+    "facets": [],
+    "sort": ["name", "count"],
+}
+"""Vocabulary type search configuration."""
+
+VOCABULARIES_TYPES_ITEMS_SORT_OPTIONS = {
+    "name": dict(
+        title=_("Name"),
+        fields=["id"],
+    ),
+    "title": dict(
+        title=_("Title"),
+        fields=["title"],
+    ),
+    "subject": dict(
+        title=_("Subject"),
+        fields=["subject"],
+    ),
+    "created": dict(
+        title=_("Created"),
+        fields=["created"],
+    ),
+}
+
+VOCABULARIES_TYPES_ITEMS_SEARCH = {
+    "facets": [],
+    "sort": ["name", "title", "subject", "created"],
+}

invenio_vocabularies/ext.py

@@ -40,8 +40,14 @@
     SubjectsService,
     SubjectsServiceConfig,
 )
-from .resources.resource import VocabulariesResource
-from .services.service import VocabulariesService
+from .resources import (
+    VocabulariesAdminResource,
+    VocabulariesResource,
+    VocabulariesResourceConfig,
+    VocabularyTypeResourceConfig,
+)
+from .services.config import VocabularyTypesServiceConfig
+from .services.service import VocabulariesService, VocabularyTypeService
 
 
 class InvenioVocabularies(object):
@@ -76,6 +82,7 @@ class ServiceConfigs:
             funders = FundersServiceConfig
             names = NamesServiceConfig
             subjects = SubjectsServiceConfig
+            vocabulary_types = VocabularyTypesServiceConfig
 
         return ServiceConfigs
 
@@ -93,9 +100,12 @@ def init_services(self, app):
         self.funders_service = FundersService(config=service_configs.funders)
         self.names_service = NamesService(config=service_configs.names)
         self.subjects_service = SubjectsService(config=service_configs.subjects)
-        self.service = VocabulariesService(
+        self.vocabularies_service = VocabulariesService(
             config=app.config["VOCABULARIES_SERVICE_CONFIG"],
         )
+        self.vocabulary_types_service = VocabularyTypeService(
+            config=service_configs.vocabulary_types
+        )
 
     def init_resource(self, app):
         """Initialize vocabulary resources."""
@@ -121,9 +131,13 @@ def init_resource(self, app):
             config=SubjectsResourceConfig,
         )
         self.resource = VocabulariesResource(
-            service=self.service,
+            service=self.vocabularies_service,
             config=app.config["VOCABULARIES_RESOURCE_CONFIG"],
         )
+        self.vocabulary_admin_resource = VocabulariesAdminResource(
+            service=self.vocabulary_types_service,
+            config=VocabularyTypeResourceConfig,
+        )
 
 
 def finalize_app(app):
@@ -153,12 +167,13 @@ def init(app):
     sregistry.register(ext.funders_service, service_id="funders")
     sregistry.register(ext.names_service, service_id="names")
     sregistry.register(ext.subjects_service, service_id="subjects")
-    sregistry.register(ext.service, service_id="vocabularies")
+    sregistry.register(ext.vocabularies_service, service_id="vocabularies")
+    sregistry.register(ext.vocabulary_types_service, service_id="vocabulary-types")
     # Register indexers
     iregistry = app.extensions["invenio-indexer"].registry
     iregistry.register(ext.affiliations_service.indexer, indexer_id="affiliations")
     iregistry.register(ext.awards_service.indexer, indexer_id="awards")
     iregistry.register(ext.funders_service.indexer, indexer_id="funders")
     iregistry.register(ext.names_service.indexer, indexer_id="names")
     iregistry.register(ext.subjects_service.indexer, indexer_id="subjects")
-    iregistry.register(ext.service.indexer, indexer_id="vocabularies")
+    iregistry.register(ext.vocabularies_service.indexer, indexer_id="vocabularies")

invenio_vocabularies/proxies.py

@@ -19,7 +19,7 @@ def _ext_proxy(attr):
     )
 
 
-current_service = _ext_proxy("service")
+current_service = _ext_proxy("vocabularies_service")
 """Proxy to the instantiated vocabulary service."""
 
 

invenio_vocabularies/resources/__init__.py

@@ -9,7 +9,14 @@
 """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",
 )