merge in i18n updates

Author: rouilj

.hgignore

@@ -46,3 +46,4 @@ website/www/_tmp/
 website/www/COPYING.txt
 website/www/docs
 website/www/html/
+.pytest_cache

CHANGES.txt

@@ -145,6 +145,11 @@ Features:
   than 25. Also German words are long. Since there is little chance of
   fixing German to shorten their words, change indexer maxlength to 50.
   (Thomas Arendsen Hein provided patch; patch reworked John Rouillard)
+- issue2551184 - add an i18n object to the roundupdb. This makes it
+  possible to translate error messages in detectors (or actions). The
+  i18n object is now also correctly set for the mail interface:
+  previously the 'language' setting in the [mailgw] section seems to
+  have been ignored. Thanks to Marcus Priesch for the patch.
 
 2021-07-13 2.1.0
 

doc/acknowledgements.txt

@@ -10,6 +10,24 @@ ideas and everything else that helped!
 
 .. _`Announcement with changelog for current release.`: announcement.html
 
+2.2
+---
+
+2.2.0
+~~~~~
+
+Maintainer:  John Rouillard, Ralf Schlatterbeck
+
+Release Manager: John Rouillard
+
+Developer activity by changesets::
+
+    FIXME
+
+Other contributers
+
+Marcus Priesch
+
 2.1
 ---
 

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
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

doc/postgresql.txt

@@ -13,11 +13,19 @@ Prerequisites
 To use PostgreSQL as backend for storing roundup data, you should
 additionally install:
 
-1. PostgreSQL 8.x or higher - https://www.postgresql.org/
+1. PostgreSQL_ 8.x or higher
 
-2. The psycopg python interface to PostgreSQL:
+2. The psycopg_ python interface to PostgreSQL_
+
+Note that you currently need at least version 2.8 of psycopg_ -- the
+postgresql backend will work with 2.7 but if you're using the native
+postgresql indexer you need at least 2.8. Also if you want to run the
+tests, these also need 2.8. If your distribution has an older version we
+suggest that you install into a python virtual environment.
+
+.. _psycopg: https://www.psycopg.org/
+.. _PostgreSQL: https://www.postgresql.org/
 
-     https://www.psycopg.org/
 
 
 Running the PostgreSQL unit tests

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()