[Fixes #13800] Refact metadata i18n mechanism - use new gettext

Author: etj

geonode/base/i18n.py

@@ -119,7 +119,7 @@ def set(self, lang: str, data_key: str, data: dict, request_date: str):
                 f"Cache will not be updated for lang:{lang} key:{data_key} reqdate:{request_date} latest:{latest_date}"
             )
 
-    def clear_schema_cache(self):
+    def clear(self):
         logger.info("Clearing schema cache")
         self.lang_cache.clear()
 
@@ -128,7 +128,12 @@ class LabelResolver:
     CACHE_KEY_LABELS = "labels"
 
     def gettext(self, key, lang=None, fallback=True):
+        """
+        Return the translated text in the label Thesaurus, falling back to the PO/MO translation.
+        If fallback=False only search in the label Thesaurus, and may return None if not found
+        """
         lang = lang or get_language()
+        # TODO: implement the OVR search
         return self.get_labels(lang).get(key, None) or (_(key) if fallback else None)
 
     def get_labels(self, lang):

geonode/indexing/tests/test_invoke.py

@@ -25,6 +25,7 @@
 
 from django.test import override_settings
 
+from geonode.base.i18n import i18nCache
 from geonode.base.models import ResourceBase
 from geonode.metadata.handlers.multilang import MultiLangHandler
 from geonode.metadata.handlers.sparse import SparseHandler, SparseFieldRegistry
@@ -40,7 +41,7 @@
 class IndexingInvocationTests(GeoNodeBaseTestSupport):
 
     def setUp(self):
-        pass
+        i18nCache.clear()
 
     def tearDown(self):
         super().tearDown()

geonode/indexing/tests/test_tsindex.py

@@ -23,6 +23,7 @@
 
 from django.test import override_settings
 
+from geonode.base.i18n import i18nCache
 from geonode.indexing.manager import TSVectorIndexManager
 from geonode.tests.base import GeoNodeBaseTestSupport
 
@@ -33,7 +34,7 @@
 class IndexingTests(GeoNodeBaseTestSupport):
 
     def setUp(self):
-        pass
+        i18nCache.clear()
 
     def tearDown(self):
         super().tearDown()

geonode/metadata/handlers/abstract.py

@@ -23,11 +23,8 @@
 
 from typing_extensions import deprecated
 
-from django.utils.translation import gettext as _
-
 from geonode.base.models import ResourceBase
-from geonode.base.i18n import OVR_SUFFIX
-from geonode.metadata.manager import CONTEXT_KEY_LABELS
+from geonode.base.i18n import OVR_SUFFIX, labelResolver
 
 logger = logging.getLogger(__name__)
 
@@ -163,37 +160,26 @@ def _set_error(errors: dict, path: list, msg: str):
 
     @staticmethod
     def localize_message(context: dict, msg_code: str, msg_info: dict):
-        msg_loc: str = MetadataHandler._get_tkl_labels(context, None, msg_code)
+        msg_loc: str = labelResolver.gettext(msg_code)
         if msg_loc:
             tokens = defaultdict(lambda: "N/A", msg_info or {})
             return msg_loc.format_map(tokens)
         else:
             logger.warning(f"Missing i18n entry for key '{msg_code}' -- info is {msg_info}")
             return f"{msg_code}:{msg_info}"
 
-    @staticmethod
-    def _localize_label(context, lang: str, text: str):
-        # TODO: deprecate and use LabelResolver.gettext(...fallback=true)
-        label = MetadataHandler._get_tkl_labels(context, lang, text)
-        return label or _(text)
-
-    @staticmethod
-    def _get_tkl_labels(context, lang: str | None, text: str):
-        # TODO: deprecate and use LabelResolver.gettext(...fallback=false)
-        return context.get(CONTEXT_KEY_LABELS, {}).get(text, None)
-
     @staticmethod
     def _localize_subschema_labels(context, subschema: dict, lang: str, property_name: str = None):
         for annotation_name, synt in (
             ("title", ""),
             ("description", "__descr"),
         ):
-            if ovr := MetadataHandler._get_tkl_labels(context, lang, f"{property_name}{synt}{OVR_SUFFIX}"):
+            if ovr := labelResolver.gettext(f"{property_name}{synt}{OVR_SUFFIX}", lang, fallback=False):
                 subschema[annotation_name] = ovr
             elif annotation_name in subschema:
-                subschema[annotation_name] = MetadataHandler._localize_label(context, lang, subschema[annotation_name])
+                subschema[annotation_name] = labelResolver.gettext(subschema[annotation_name], lang)
             elif property_name:  # arrays may not have a name
-                label = MetadataHandler._get_tkl_labels(context, lang, f"{property_name}{synt}")
+                label = labelResolver.gettext(f"{property_name}{synt}", lang, fallback=False)
                 if label:
                     subschema[annotation_name] = label
 

geonode/metadata/handlers/contact.py

@@ -24,6 +24,7 @@
 from django.contrib.auth import get_user_model
 from django.utils.translation import gettext as _
 
+from geonode.base.i18n import labelResolver
 from geonode.metadata.handlers.abstract import MetadataHandler
 from geonode.people import Roles
 from geonode.resource.manager import resource_manager
@@ -66,7 +67,7 @@ def update_schema(self, jsonschema, context, lang=None):
             if role.is_multivalue:
                 contact = {
                     "type": "array",
-                    "title": self._localize_label(context, lang, role.label) + card,
+                    "title": labelResolver.gettext(role.label, lang) + card,
                     "minItems": minitems,
                     "items": {
                         "type": "object",
@@ -86,7 +87,7 @@ def update_schema(self, jsonschema, context, lang=None):
             else:
                 contact = {
                     "type": "object",
-                    "title": self._localize_label(context, lang, role.label) + card,
+                    "title": labelResolver.gettext(role.label, lang) + card,
                     "properties": {
                         "id": {
                             "type": "string",

geonode/metadata/handlers/sparse.py

@@ -26,7 +26,7 @@
 from geonode.metadata.exceptions import UnsetFieldException
 from geonode.metadata.models import SparseField
 
-from geonode.base.i18n import get_localized_tkeywords
+from geonode.base.i18n import get_localized_tkeywords, labelResolver
 
 logger = logging.getLogger(__name__)
 
@@ -78,7 +78,7 @@ def _recurse_localization(self, context, schema, lang, field_name=None):
                 self._recurse_localization(context, subschema, lang, prop_name)
         for item in schema.get("oneOf", []):
             if title := item.get("title", None):
-                item["title"] = MetadataHandler._localize_label(context, lang, title)
+                item["title"] = labelResolver.gettext(title, lang)
 
     def _recurse_thesauri_autocomplete(self, d, lang):
         if isinstance(d, dict):

geonode/metadata/manager.py

@@ -27,13 +27,12 @@
 from geonode.indexing.manager import index_manager
 from geonode.metadata.handlers.abstract import MetadataHandler
 from geonode.metadata.exceptions import UnsetFieldException
-from geonode.base.i18n import I18nCache
+from geonode.base.i18n import i18nCache
 from geonode.metadata.settings import MODEL_SCHEMA
 
 logger = logging.getLogger(__name__)
 
 CACHE_KEY_SCHEMA = "schema"
-CONTEXT_KEY_LABELS = "labels"
 
 
 class MetadataManager:
@@ -48,7 +47,6 @@ class MetadataManager:
     def __init__(self):
         self.root_schema = MODEL_SCHEMA
         self.handlers = {}
-        self._i18n_cache = I18nCache()
 
     def add_handler(self, handler_id, handler):
         self.handlers[handler_id] = handler()
@@ -61,7 +59,7 @@ def post_init(self):
             handler.post_init()
 
     def _init_schema_context(self, lang):
-        return {CONTEXT_KEY_LABELS: self._i18n_cache.get_labels(lang)}
+        return {}
 
     def build_schema(self, lang=None):
         logger.debug(f"build_schema {lang}")
@@ -86,12 +84,12 @@ def build_schema(self, lang=None):
 
     def get_schema(self, lang=None):
         lang = str(lang)
-        thesaurus_date, schema = self._i18n_cache.get_entry(lang, CACHE_KEY_SCHEMA)
+        thesaurus_date, schema = i18nCache.get_entry(lang, CACHE_KEY_SCHEMA)
         if schema is None:
             logger.info(f"Building schema for {lang}")
             schema = self.build_schema(lang)
             logger.debug("Schema built")
-            self._i18n_cache.set(lang, CACHE_KEY_SCHEMA, schema, thesaurus_date)
+            i18nCache.set(lang, CACHE_KEY_SCHEMA, schema, thesaurus_date)
         return schema
 
     def build_schema_instance(self, resource, lang=None):

geonode/metadata/tests/test_handlers.py

@@ -30,6 +30,7 @@
 
 from geonode.people import Roles
 
+from geonode.base.i18n import i18nCache
 from geonode.base.models import (
     ResourceBase,
     TopicCategory,
@@ -61,7 +62,6 @@
 from geonode.metadata.handlers.thesaurus import TKeywordsHandler
 from geonode.metadata.handlers.contact import ContactHandler, ROLE_NAMES_MAP
 from geonode.metadata.handlers.sparse import SparseHandler, sparse_field_registry
-from geonode.metadata.manager import CONTEXT_KEY_LABELS
 from geonode.metadata.models import SparseField
 from geonode.metadata.settings import MODEL_SCHEMA
 from geonode.metadata.exceptions import UnsetFieldException
@@ -74,6 +74,7 @@
 class HandlersTests(GeoNodeBaseTestSupport):
 
     def setUp(self):
+        i18nCache.clear()
         # set Json schemas
         self.model_schema = copy.deepcopy(MODEL_SCHEMA)
         self.lang = None
@@ -1376,7 +1377,7 @@ def test_tkeywords_handler_update_schema_with_thesauri(self, mock_collect_thesau
         mocked_endpoint.side_effect = lambda name, kwargs: f"/mocked/url/{kwargs['thesaurusid']}"
 
         # Call the method
-        updated_schema = self.tkeywords_handler.update_schema(schema, context={CONTEXT_KEY_LABELS: {}}, lang="en")
+        updated_schema = self.tkeywords_handler.update_schema(schema, context={}, lang="en")
 
         # Assert tkeywords property is added
         tkeywords = updated_schema["properties"].get("tkeywords")
@@ -1428,7 +1429,7 @@ def test_tkeywords_handler_update_schema_no_thesauri(self, mock_collect_thesauri
         mock_collect_thesauri.return_value = {}
 
         # Call the method
-        updated_schema = self.tkeywords_handler.update_schema(schema, context={CONTEXT_KEY_LABELS: {}}, lang="en")
+        updated_schema = self.tkeywords_handler.update_schema(schema, context={}, lang="en")
 
         # Assert tkeywords property is hidden
         tkeywords = updated_schema["properties"].get("tkeywords")
@@ -1675,7 +1676,6 @@ def test_sparse_handler_update_resource(self):
                     }
                 }
             },
-            CONTEXT_KEY_LABELS: {},
         }
 
         # Test string field

geonode/metadata/tests/test_i18n.py

@@ -23,8 +23,8 @@
 
 from geonode.metadata.handlers.sparse import SparseHandler, SparseFieldRegistry
 from geonode.metadata.manager import MetadataManager
-from geonode.base.i18n import I18N_THESAURUS_IDENTIFIER
 
+from geonode.base.i18n import I18N_THESAURUS_IDENTIFIER, i18nCache
 from geonode.base.models import (
     ThesaurusKeyword,
     ThesaurusKeywordLabel,
@@ -35,6 +35,8 @@
 class MetadataI18NTests(GeoNodeBaseTestSupport):
 
     def setUp(self):
+        i18nCache.clear()
+
         # set a single handler to speed up things
         self.sparse_registry = SparseFieldRegistry()
 

geonode/metadata/tests/test_multilang.py

@@ -25,6 +25,7 @@
 
 from django.test import override_settings
 
+from geonode.base.i18n import i18nCache
 from geonode.base.models import ResourceBase
 from geonode.metadata.handlers.multilang import MultiLangHandler
 from geonode.metadata.handlers.sparse import SparseHandler, SparseFieldRegistry
@@ -41,7 +42,7 @@
 class MetadataMultilangTests(GeoNodeBaseTestSupport):
 
     def setUp(self):
-        pass
+        i18nCache.clear()
 
     def tearDown(self):
         super().tearDown()