[Fixes #13645] Multilang: update API output payload

etj · etj · commit 170c965b1ed9 · 2025-11-26T10:44:29.000+01:00
diff --git a/geonode/base/api/mixins.py b/geonode/base/api/mixins.py
diff --git a/geonode/base/api/serializers.py b/geonode/base/api/serializers.py
@@ -29,6 +29,7 @@
 from django.contrib.auth import get_user_model
 from django.db.models.query import QuerySet
 from geonode.assets.utils import get_default_asset, is_asset_deletable
+from geonode.metadata.multilang.serializers import MultiLangOutputMixin
 from geonode.people import Roles
 from django.http import QueryDict
 from deprecated import deprecated
@@ -597,7 +598,7 @@ def to_representation(self, instance):
         return ret
 
 
-class ResourceBaseSerializer(DynamicModelSerializer):
+class ResourceBaseSerializer(MultiLangOutputMixin, DynamicModelSerializer):
     pk = serializers.CharField(read_only=True)
     uuid = serializers.CharField(read_only=True)
     resource_type = serializers.CharField(required=False)
diff --git a/geonode/documents/api/views.py b/geonode/documents/api/views.py
@@ -27,16 +27,15 @@
 from geonode import settings
 
 from geonode.assets.utils import create_asset_and_link
-from geonode.base.api.filters import DynamicSearchFilter, ExtentFilter
-from geonode.base.api.mixins import AdvertisedListMixin
+from geonode.base.api.filters import DynamicSearchFilter, ExtentFilter, AdvertisedFilter
 from geonode.base.api.pagination import GeoNodeApiPagination
 from geonode.base.api.permissions import UserHasPerms
+from geonode.base.api.serializers import ResourceBaseSerializer
 from geonode.base.api.views import base_linked_resources, ApiPresetsInitializer
 from geonode.base import enumerations
 from geonode.documents.api.exceptions import DocumentException
 from geonode.documents.models import Document
-
-from geonode.base.api.serializers import ResourceBaseSerializer
+from geonode.metadata.multilang.views import MultiLangViewMixin
 from geonode.resource.utils import resourcebase_post_save
 from geonode.storage.manager import StorageManager
 from geonode.resource.manager import resource_manager
@@ -50,7 +49,7 @@
 logger = logging.getLogger(__name__)
 
 
-class DocumentViewSet(ApiPresetsInitializer, DynamicModelViewSet, AdvertisedListMixin):
+class DocumentViewSet(ApiPresetsInitializer, MultiLangViewMixin, DynamicModelViewSet):
     """
     API endpoint that allows documents to be viewed or edited.
     """
@@ -64,6 +63,7 @@ class DocumentViewSet(ApiPresetsInitializer, DynamicModelViewSet, AdvertisedList
         DynamicFilterBackend,
         DynamicSortingFilter,
         DynamicSearchFilter,
+        AdvertisedFilter,
         ExtentFilter,
         DocumentPermissionsFilter,
     ]
diff --git a/geonode/geoapps/api/views.py b/geonode/geoapps/api/views.py
@@ -21,22 +21,24 @@
 
 from rest_framework.permissions import IsAuthenticatedOrReadOnly
 
-from geonode.base.api.filters import DynamicSearchFilter, ExtentFilter
-from geonode.base.api.mixins import AdvertisedListMixin
+from geonode.base.api.filters import DynamicSearchFilter, ExtentFilter, AdvertisedFilter
 from geonode.base.api.pagination import GeoNodeApiPagination
 from geonode.base.api.permissions import UserHasPerms
 from geonode.base.api.views import ApiPresetsInitializer
 from geonode.geoapps.models import GeoApp
+from geonode.metadata.multilang.views import MultiLangViewMixin
+
 
 from .serializers import GeoAppSerializer
 from .permissions import GeoAppPermissionsFilter
 
 import logging
 
+
 logger = logging.getLogger(__name__)
 
 
-class GeoAppViewSet(ApiPresetsInitializer, DynamicModelViewSet, AdvertisedListMixin):
+class GeoAppViewSet(ApiPresetsInitializer, MultiLangViewMixin, DynamicModelViewSet):
     """
     API endpoint that allows geoapps to be viewed or edited.
     """
@@ -50,6 +52,7 @@ class GeoAppViewSet(ApiPresetsInitializer, DynamicModelViewSet, AdvertisedListMi
         DynamicFilterBackend,
         DynamicSortingFilter,
         DynamicSearchFilter,
+        AdvertisedFilter,
         ExtentFilter,
         GeoAppPermissionsFilter,
     ]
diff --git a/geonode/indexing/manager.py b/geonode/indexing/manager.py
@@ -4,7 +4,7 @@
 from django.conf import settings
 
 from geonode.indexing.models import ResourceIndex
-import geonode.metadata.multilang as multi
+import geonode.metadata.multilang.utils as multi
 
 logger = logging.getLogger(__name__)
 
diff --git a/geonode/layers/api/views.py b/geonode/layers/api/views.py
@@ -25,15 +25,15 @@
 from rest_framework.permissions import IsAuthenticatedOrReadOnly, IsAuthenticated
 from rest_framework.response import Response
 
-from geonode.base.api.filters import DynamicSearchFilter, ExtentFilter
-from geonode.base.api.mixins import AdvertisedListMixin
+from geonode.base.api.filters import DynamicSearchFilter, ExtentFilter, AdvertisedFilter
 from geonode.base.api.pagination import GeoNodeApiPagination
 from geonode.base.api.permissions import UserHasPerms
 from geonode.base.api.views import ApiPresetsInitializer
 from geonode.layers.api.exceptions import GeneralDatasetException, InvalidDatasetException, InvalidMetadataException
 from geonode.layers.metadata import parse_metadata
 from geonode.layers.models import Dataset
 from geonode.maps.api.serializers import SimpleMapLayerSerializer, SimpleMapSerializer
+from geonode.metadata.multilang.views import MultiLangViewMixin
 from geonode.resource.utils import update_resource
 from geonode.resource.manager import resource_manager
 from rest_framework.exceptions import NotFound
@@ -61,7 +61,7 @@
 logger = logging.getLogger(__name__)
 
 
-class DatasetViewSet(ApiPresetsInitializer, DynamicModelViewSet, AdvertisedListMixin):
+class DatasetViewSet(ApiPresetsInitializer, MultiLangViewMixin, DynamicModelViewSet):
     """
     API endpoint that allows layers to be viewed or edited.
     """
@@ -75,6 +75,7 @@ class DatasetViewSet(ApiPresetsInitializer, DynamicModelViewSet, AdvertisedListM
         DynamicFilterBackend,
         DynamicSortingFilter,
         DynamicSearchFilter,
+        AdvertisedFilter,
         ExtentFilter,
         DatasetPermissionsFilter,
     ]
diff --git a/geonode/maps/api/views.py b/geonode/maps/api/views.py
@@ -28,8 +28,7 @@
 from rest_framework.response import Response
 
 from geonode.base import register_event
-from geonode.base.api.filters import DynamicSearchFilter, ExtentFilter
-from geonode.base.api.mixins import AdvertisedListMixin
+from geonode.base.api.filters import DynamicSearchFilter, ExtentFilter, AdvertisedFilter
 from geonode.base.api.pagination import GeoNodeApiPagination
 from geonode.base.api.permissions import UserHasPerms
 from geonode.base.api.views import ApiPresetsInitializer
@@ -41,13 +40,14 @@
 from geonode.maps.contants import _PERMISSION_MSG_SAVE
 from geonode.maps.models import Map
 from geonode.maps.signals import map_changed_signal
+from geonode.metadata.multilang.views import MultiLangViewMixin
 from geonode.resource.manager import resource_manager
 from geonode.utils import resolve_object
 
 logger = logging.getLogger(__name__)
 
 
-class MapViewSet(ApiPresetsInitializer, DynamicModelViewSet, AdvertisedListMixin):
+class MapViewSet(ApiPresetsInitializer, MultiLangViewMixin, DynamicModelViewSet):
     """
     API endpoint that allows maps to be viewed or edited.
     """
@@ -61,6 +61,7 @@ class MapViewSet(ApiPresetsInitializer, DynamicModelViewSet, AdvertisedListMixin
         DynamicFilterBackend,
         DynamicSortingFilter,
         DynamicSearchFilter,
+        AdvertisedFilter,
         ExtentFilter,
         MapPermissionsFilter,
     ]
diff --git a/geonode/metadata/api/views.py b/geonode/metadata/api/views.py
@@ -39,6 +39,7 @@
 from geonode.metadata.handlers.abstract import MetadataHandler
 from geonode.metadata.i18n import get_localized_label
 from geonode.metadata.manager import metadata_manager
+from geonode.metadata.multilang import utils as multi
 from geonode.people.utils import get_available_users
 
 logger = logging.getLogger(__name__)
@@ -66,12 +67,7 @@ def list(self, request, *args, **kwargs):
     # A pk argument is set for futured multiple schemas
     @action(detail=False, methods=["get"], url_path=r"schema(?:/(?P<pk>\d+))?", url_name="schema")
     def schema(self, request, pk=None):
-        """
-        The user is able to export her/his keys with
-        resource scope.
-        """
-
-        lang = request.query_params.get("lang", get_language_from_request(request)[:2])
+        lang = multi.get_language(request)
         schema = metadata_manager.get_schema(lang)
 
         if schema:
diff --git a/geonode/metadata/handlers/multilang.py b/geonode/metadata/handlers/multilang.py
@@ -23,7 +23,7 @@
 
 from geonode.metadata.handlers.abstract import MetadataHandler
 from geonode.metadata.handlers.sparse import sparse_field_registry
-import geonode.metadata.multilang as multi
+import geonode.metadata.multilang.utils as multi
 
 logger = logging.getLogger(__name__)
 
diff --git a/geonode/metadata/multilang.py b/geonode/metadata/multilang.py
diff --git a/geonode/metadata/multilang/serializers.py b/geonode/metadata/multilang/serializers.py
@@ -0,0 +1,23 @@
+import logging
+
+from django.conf import settings
+from rest_framework import serializers
+
+
+logger = logging.getLogger(__name__)
+
+
+class MultiLangOutputMixin(serializers.BaseSerializer):
+
+    def to_representation(self, instance):
+
+        representation = super().to_representation(instance)
+
+        if settings.MULTILANG_FIELDS and hasattr(instance, "_multilang_sparse_prefetch"):
+            for sparse in instance._multilang_sparse_prefetch:
+                base_field_name = sparse.name[:-13]  # name_multilang_xx
+                if base_field_name in representation:
+                    logger.debug(f"setting into {instance} field {base_field_name} --> {sparse.value}")
+                    representation[base_field_name] = sparse.value
+
+        return representation
diff --git a/geonode/metadata/multilang/utils.py b/geonode/metadata/multilang/utils.py
@@ -0,0 +1,50 @@
+from django.conf import settings
+
+
+def get_2letters_languages():
+    """
+    Return the list of languages in settings.LANGUAGES
+    with the default language as first element
+    """
+    langs = [lang.split("-")[0] for lang, _ in settings.LANGUAGES]
+    i = langs.index(settings.LANGUAGE_CODE)
+    if i != 0:
+        langs.pop(i)
+        langs.insert(0, settings.LANGUAGE_CODE)
+    return langs
+
+
+def get_multilang_field_names(base_name):
+    return ((lang, get_multilang_field_name(base_name, lang)) for lang in get_2letters_languages())
+
+
+def get_multilang_fields_for_lang(lang):
+    return [get_multilang_field_name(field_name, lang) for field_name in settings.MULTILANG_FIELDS]
+
+
+def get_multilang_field_name(base_name, lang):
+    return f"{base_name}_multilang_{lang}"
+
+
+def get_pg_language(lang):
+    return settings.MULTILANG_POSTGRES_LANGS.get(lang, None) or settings.MULTILANG_POSTGRES_LANGS.get(None)
+
+
+def get_default_language():
+    return settings.LANGUAGE_CODE
+
+
+def get_language(request):
+    if request:
+        language = request.query_params.get("lang", None)  # explicit query param
+        if not language:
+            language = getattr(request, "LANGUAGE_CODE", None)  # LocaleMiddleware
+        if not language:
+            language = request.headers.get("Accept-Language", "").split(",")[0]
+    else:
+        language = get_default_language()
+
+    if language and "-" in language:
+        language = language.split("-")[0]  # normalize
+
+    return language
diff --git a/geonode/metadata/multilang/views.py b/geonode/metadata/multilang/views.py
@@ -0,0 +1,36 @@
+import logging
+
+from django.db.models import Prefetch
+
+from geonode.metadata.models import SparseField
+from geonode.metadata.multilang import utils as multi
+
+
+logger = logging.getLogger(__name__)
+
+
+class MultiLangViewMixin:
+    """
+    View mixin to enrich the queryset of ResourceBase-like models
+    by prefetching localized fields and attaching them dynamically.
+    """
+
+    def get_queryset(self):
+        """Adds a Prefetch to include localized fields in one query."""
+        lang = multi.get_language(getattr(self, "request", None))
+        field_names = multi.get_multilang_fields_for_lang(lang)
+
+        qs = super().get_queryset()
+
+        if not field_names:
+            return qs
+
+        # Prefetch all localized rows for this language
+        prefetch = Prefetch(
+            "sparsefield_set",  # this must match related_name on FK
+            queryset=SparseField.objects.filter(name__in=field_names),
+            to_attr="_multilang_sparse_prefetch",
+        )
+
+        qs = qs.prefetch_related(prefetch)
+        return qs
