Add i18n object to roundupdb.Database

This makes the i18n object accessible everywhere (including in detectors
where localized error messages were impossible). See issue2551184

Author: schlatterbeck

doc/developers.txt

@@ -290,6 +290,22 @@ Template markup examples:
       fine) % fine"
     />
 
+Detectors and extensions
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+The correct ``i18n`` objects gets automatically injected in the hyperdb.
+In a detector you can access the i18n object and do translation like
+this::
+
+  def statusfail(db, cl, nodeid, newvalues):
+    _ = db.i18n.gettext
+    raise ValueError(_("this does not work"))
+
+  def init(db):
+    # fire before changes are made
+    db.status.audit('create', statusfail)
+
+
 Extracting Translatable Messages
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

roundup/admin.py

@@ -30,7 +30,7 @@
 import roundup.instance
 from roundup.configuration import (CoreConfig, NoConfigError,
                                    ParsingOptionError, UserConfig)
-from roundup.i18n import _
+from roundup.i18n import _, get_translation
 from roundup.exceptions import UsageError
 from roundup.anypy.my_input import my_input
 from roundup.anypy.strings import repr_export
@@ -1719,6 +1719,11 @@ def run_command(self, args):
         # only open the database once!
         if not self.db:
             self.db = tracker.open(self.name)
+            # dont use tracker.config["TRACKER_LANGUAGE"] here as the
+            # cli operator likely wants to have i18n as set in the
+            # environment.
+            # This is needed to fetch the locale's of the tracker's home dir.
+            self.db.i18n = get_translation (tracker_home = tracker.tracker_home)
 
         self.db.tx_Source = 'cli'
 

roundup/backends/back_anydbm.py

@@ -90,6 +90,7 @@ def __init__(self, config, journaltag=None):
         disabled.
         """
         FileStorage.__init__(self, config.UMASK)
+        roundupdb.Database.__init__(self)
         self.config, self.journaltag = config, journaltag
         self.dir = config.DATABASE
         self.classes = {}

roundup/backends/rdbms_common.py

@@ -170,6 +170,7 @@ def __init__(self, config, journaltag=None):
         """ Open the database and load the schema from it.
         """
         FileStorage.__init__(self, config.UMASK)
+        roundupdb.Database.__init__(self)
         self.config, self.journaltag = config, journaltag
         self.dir = config.DATABASE
         self.classes = {}

roundup/cgi/PageTemplates/TALES.py

@@ -257,16 +257,6 @@ def setSourceFile(self, source_file):
     def setPosition(self, position):
         self.position = position
 
-    def translate(self, domain, msgid, mapping=None,
-                  context=None, target_language=None, default=None):
-        if context is None:
-            context = self.contexts.get('here')
-        return getGlobalTranslationService().translate(
-            domain, msgid, mapping=mapping,
-            context=context,
-            default=default,
-            target_language=target_language)
-
 class TALESTracebackSupplement:
     """Implementation of ITracebackSupplement"""
     def __init__(self, context, expression):

roundup/cgi/client.py

@@ -387,7 +387,15 @@ def __init__(self, instance, request, env, form=None, translator=None):
         self.instance = instance
         self.request = request
         self.env = env
-        self.setTranslator(translator)
+        if translator is not None :
+            self.setTranslator(translator)
+            # XXX we should set self.language to "translator"'s language,
+            # but how to get it ?
+            self.language = ""
+        else :
+            self.setTranslator(TranslationService.NullTranslationService())
+            self.language = "" # as is the default from determine_language
+
         self.mailer = Mailer(instance.config)
         # If True the form contents wins over the database contents when
         # rendering html properties. This is set when an error occurs so
@@ -540,11 +548,13 @@ def handle_xmlrpc(self):
         # Set the charset and language, since other parts of
         # Roundup may depend upon that.
         self.determine_charset()
-        self.determine_language()
+        if self.instance.config["WEB_TRANSLATE_XMLRPC"] :
+            self.determine_language()
         # Open the database as the correct user.
         try:
             self.determine_user()
             self.db.tx_Source = "xmlrpc"
+            self.db.i18n = self.translator
         except LoginError as msg:
             output = xmlrpc_.client.dumps(
                 xmlrpc_.client.Fault(401, "%s" % msg),
@@ -594,12 +604,14 @@ def handle_xmlrpc(self):
     def handle_rest(self):
         # Set the charset and language
         self.determine_charset()
-        self.determine_language()
+        if self.instance.config["WEB_TRANSLATE_REST"] :
+            self.determine_language()
         # Open the database as the correct user.
         # TODO: add everything to RestfulDispatcher
         try:
             self.determine_user()
             self.db.tx_Source = "rest"
+            self.db.i18n = self.translator
         except LoginError as err:
             self.response_code = http_.client.UNAUTHORIZED
             output = s2b("Invalid Login - %s"%str(err))
@@ -622,7 +634,7 @@ def handle_rest(self):
             # Call csrf with xmlrpc checks enabled.
             # It will return True if everything is ok,
             # raises exception on check failure.
-            csrf_ok =  self.handle_csrf(xmlrpc=True)
+            csrf_ok = self.handle_csrf(xmlrpc=True)
         except (Unauthorised, UsageError) as msg:
             # report exception back to server
             exc_type, exc_value, exc_tb = sys.exc_info()
@@ -699,7 +711,6 @@ def inner_main(self):
         self._error_message = []
         try:
             self.determine_charset()
-            self.determine_language()
 
             try:
                 # make sure we're identified (even anonymously)
@@ -708,6 +719,9 @@ def inner_main(self):
                 # figure out the context and desired content template
                 self.determine_context()
 
+                self.determine_language()
+                self.db.i18n = self.translator
+
                 # if we've made it this far the context is to a bit of
                 # Roundup's real web interface (not a file being served up)
                 # so do the Anonymous Web Acess check now
@@ -764,6 +778,9 @@ def inner_main(self):
                 # exception or a NotModified exception.  Those
                 # exceptions will be handled by the outermost set of
                 # exception handlers.
+                self.determine_language()
+                self.db.i18n = self.translator
+
                 self.serve_file(designator)
             except SendStaticFile as file:
                 self.serve_static_file(str(file))
@@ -985,11 +1002,18 @@ def determine_language(self):
             else:
                 language = ""
 
+        if not language :
+            # default to tracker language
+            language = self.instance.config["TRACKER_LANGUAGE"]
+
+        # this maybe is not correct, as get_translation could not
+        # find desired locale and switch back to "en" but we set
+        # self.language to the desired language !
         self.language = language
-        if language:
-            self.setTranslator(TranslationService.get_translation(
-                    language,
-                    tracker_home=self.instance.config["TRACKER_HOME"]))
+
+        self.setTranslator(TranslationService.get_translation(
+                language,
+                tracker_home=self.instance.config["TRACKER_HOME"]))
 
     def authenticate_bearer_token(self, challenge):
         ''' authenticate the bearer token. Refactored from determine_user()

roundup/cgi/engine_zopetal.py

@@ -8,13 +8,11 @@
 import os
 import os.path
 
-from roundup.cgi.templating import StringIO, context, translationService, TALLoaderBase
+from roundup.cgi.templating import StringIO, context, TALLoaderBase
 from roundup.cgi.PageTemplates import PageTemplate, GlobalTranslationService
 from roundup.cgi.PageTemplates.Expressions import getEngine
 from roundup.cgi.TAL import TALInterpreter
 
-GlobalTranslationService.setGlobalTranslationService(translationService)
-
 
 class Loader(TALLoaderBase):
     templates = {}

roundup/cgi/form_parser.py

@@ -1,7 +1,7 @@
 import re, mimetypes
 
 from roundup import hyperdb, date, password
-from roundup.cgi import templating
+from roundup.cgi import templating, TranslationService
 from roundup.cgi.exceptions import FormError
 
 
@@ -38,7 +38,7 @@ def __init__(self, client):
             self._ = self.gettext = client.gettext
             self.ngettext = client.ngettext
         except AttributeError:
-            _translator = templating.translationService
+            _translator = TranslationService.get_translation()
             self._ = self.gettext = _translator.gettext
             self.ngettext = _translator.ngettext
 

roundup/cgi/templating.py

@@ -197,13 +197,7 @@ def _options(config):
 markdown = _import_markdown2() or _import_markdown() or _import_mistune()
 
 # bring in the templating support
-from roundup.cgi import TranslationService, ZTUtils
-
-### i18n services
-# this global translation service is not thread-safe.
-# it is left here for backward compatibility
-# until all Web UI translations are done via client.translator object
-translationService = TranslationService.get_translation()
+from roundup.cgi import ZTUtils
 
 def anti_csrf_nonce(client, lifetime=None):
     ''' Create a nonce for defending against CSRF attack.

roundup/configuration.py

@@ -1080,12 +1080,20 @@ def str2value(self, value):
 after the roundup web url configured in the 'tracker' section.
 If this variable is set to 'no', the xmlrpc path has no special meaning
 and will yield an error message."""),
+        (BooleanOption, 'translate_xmlrpc', 'no',
+            """Whether to enable i18n for the xmlrpc endpoint. Enable it if
+you want to enable translation based on browsers lang (if enabled), trackers
+lang (if set) or environment."""),
         (BooleanOption, 'enable_rest', "yes",
             """Whether to enable the REST API in the roundup web
 interface. By default the REST endpoint is the string 'rest' plus any
 additional REST-API parameters after the roundup web url configured in
 the tracker section. If this variable is set to 'no', the rest path has
 no special meaning and will yield an error message."""),
+        (BooleanOption, 'translate_rest', 'no',
+            """Whether to enable i18n for the rest endpoint. Enable it if
+you want to enable translation based on browsers lang (if enabled), trackers
+lang (if set) or environment."""),
         (IntegerNumberGeqZeroOption, 'api_calls_per_interval', "0",
          "Limit API calls per api_interval_in_sec seconds to\n"
          "this number.\n"