Merge lp:~henninge/launchpad/bug-456562 into lp:launchpad

[Henning Eggers]

[Henning Eggers (henninge)]

= Details =

See bug 456562.
Added two methods to access translation credits messages. This is in preparation of solving bug 128324.

== Implementation details ==

I added a class attribute to POTMsgSet to export the list of possible msgids for translation credits. This is used in getTranslationCredits to build the query.

I added a parameter to updateTranslation because it guarded against changing translation credits. This can now be overridden by setting allow_credits to True.

== Test ==

bin/test -vvt potmsgset.txt -t getTranslationCredits

== Demo/QA ==

None yet as these methods are not used yet.

[Данило Шеган (danilo)]

As I said on IRC, I don't like not_credits and not_credits_either variable naming in the getTranslationCredits test, and I wonder what that None keeps doing in credits_message_info/credits_message_ids but that's not part of this branch, so I am not blocking on it.

Everything else is great!

review: Approve

=== modified file 'lib/lp/translations/doc/potmsgset.txt'
--- lib/lp/translations/doc/potmsgset.txt	2009-10-21 10:11:01 +0000
+++ lib/lp/translations/doc/potmsgset.txt	2009-10-22 16:38:12 +0000
@@ -34,36 +34,81 @@
 is_translation_credit indicates if the POTMsgSet is translation credits. The
 property translation_credit_type contains the type of translation credits.
 
-    >>> def print_credit(credit):
-    ...     print credit.is_translation_credit
-    ...     print credit.translation_credits_type.title
+    >>> def print_credits(credits):
+    ...     print credits.is_translation_credit
+    ...     print credits.translation_credits_type.title
 
-    >>> print_credit(factory.makePOTMsgSet(potemplate))
+    >>> print_credits(factory.makePOTMsgSet(potemplate))
     False
     Not a translation credits message
 
-    >>> print_credit(factory.makePOTMsgSet(
+    >>> print_credits(factory.makePOTMsgSet(
     ...     potemplate, singular=u'translator-credits'))
     True
     Gnome credits message
 
-    >>> print_credit(factory.makePOTMsgSet(
+    >>> print_credits(factory.makePOTMsgSet(
     ...     potemplate, singular=u'translation-credits'))
     True
     Gnome credits message
 
-    >>> print_credit(factory.makePOTMsgSet(
+    >>> print_credits(factory.makePOTMsgSet(
     ...     potemplate,
     ...     singular=u'Your emails', context=u'EMAIL OF TRANSLATORS'))
     True
     KDE emails credits message
 
-    >>> print_credit(factory.makePOTMsgSet(
+    >>> print_credits(factory.makePOTMsgSet(
     ...     potemplate, singular=u'_: EMAIL OF TRANSLATORS\nYour emails'))
     True
     KDE emails credits message
 
 
+== POTMsgSet.setTranslationCreditsToTranslated ==
+
+If a message is a translation credits message, its translations must be set
+to some dummy value so that they are counted as "translated" and don't
+mess up the statistics.
+
+    >>> eo_pofile = factory.makePOFile('eo', potemplate=potemplate)
+    >>> eo_language = eo_pofile.language
+    >>> gnome_credits = factory.makePOTMsgSet(
+    ...     potemplate, singular=u'translator-credits')
+    >>> current = gnome_credits.getCurrentTranslationMessage(potemplate,
+    ...                                                      eo_language)
+    >>> print current
+    None
+    >>> login("[e-mail]")
+    >>> gnome_credits.setTranslationCreditsToTranslated(eo_pofile)
+    >>> current = gnome_credits.getCurrentTranslationMessage(potemplate,
+    ...                                                      eo_language)
+    >>> print current.msgstr0.translation
+    This is a dummy translation so that the credits are counted as translated.
+
+An imported translation credits message will already contain a translation
+and is therefore left untouched.
+
+    >>> from zope.security.proxy import removeSecurityProxy
+    >>> sr_pofile = removeSecurityProxy(factory.makePOFile('sr', potemplate=potemplate))
+    >>> sr_language = sr_pofile.language
+    >>> sr_credits = factory.makeTranslationMessage(
+    ...     potmsgset=gnome_credits, pofile=sr_pofile, is_imported=True,
+    ...     translations=[u"Some translations credits for Serbian."])
+    >>> gnome_credits.setTranslationCreditsToTranslated(sr_pofile)
+    >>> current = gnome_credits.getCurrentTranslationMessage(potemplate,
+    ...                                                      sr_language)
+    >>> print current.msgstr0.translation
+    Some translations credits for Serbian.
+
+Normal messages will be left untouched, too.
+
+    >>> potmsgset.setTranslationCreditsToTranslated(sr_language)
+    >>> current = potmsgset.getCurrentTranslationMessage(potemplate,
+    ...                                                  sr_pofile)
+    >>> print current
+    None
+
+
 == POTMsgSet.normalizeWhitespaces ==
 
 This function copies the leading and trailing whitespaces from

=== modified file 'lib/lp/translations/interfaces/potemplate.py'
--- lib/lp/translations/interfaces/potemplate.py	2009-09-15 15:30:59 +0000
+++ lib/lp/translations/interfaces/potemplate.py	2009-10-22 16:38:12 +0000
@@ -365,6 +365,13 @@
         all of them.
         """
 
+    def getTranslationCredits():
+        """Return an iterator over translation credits.
+
+        Return all `IPOTMsgSet` objects in this template that are translation
+        credits.
+        """
+
     def getPOTMsgSetsCount(current=True):
         """Return the number of POTMsgSet objects related to this object.
 

=== modified file 'lib/lp/translations/interfaces/potmsgset.py'
--- lib/lp/translations/interfaces/potmsgset.py	2009-10-21 09:54:09 +0000
+++ lib/lp/translations/interfaces/potmsgset.py	2009-10-22 16:38:12 +0000
@@ -4,7 +4,7 @@
 # pylint: disable-msg=E0211,E0213
 
 from zope.interface import Interface, Attribute
-from zope.schema import Bool, Choice, Int, Object, Text
+from zope.schema import Bool, Choice, Int, List, Object, Text
 from lazr.enum import EnumeratedType, Item
 
 from canonical.launchpad import _
@@ -112,6 +112,14 @@
             gettext uses the original English strings to identify messages.
             """))
 
+    credits_message_ids = List(
+        title=_("List of possible msgids for translation credits"),
+        readonly=True,
+        description=_("""
+            This class attribute is intended to be used to construct database
+            queries that search for credits messages.
+            """))
+
     def getCurrentDummyTranslationMessage(potemplate, language):
         """Return a DummyTranslationMessage for this message language.
 
@@ -195,7 +203,8 @@
 
     def updateTranslation(pofile, submitter, new_translations, is_imported,
                           lock_timestamp, force_suggestion=False,
-                          ignore_errors=False, force_edition_rights=False):
+                          ignore_errors=False, force_edition_rights=False,
+                          allow_credits=False):
         """Update or create a translation message using `new_translations`.
 
         :param pofile: a `POFile` to add `new_translations` to.
@@ -213,6 +222,8 @@
             should be stored even when an error is detected.
         :param force_edition_rights: A flag that 'forces' handling this
             submission as coming from an editor, even if `submitter` is not.
+        :param allow_credits: Override the protection of translation credits
+            message.
 
         If there is an error with the translations and ignore_errors is not
         True or it's not a fuzzy submit, raises gettextpo.error
@@ -319,6 +330,17 @@
             `IPOTemplate`.
         """
 
+    def setTranslationCreditsToTranslated(pofile):
+        """Set the current translation for this translation credits message.
+
+        Sets a fixed dummy string as the current translation, if this is a
+        translation credits message, so that these get counted as
+        'translated', too.
+        Credits messages that already have a translation, imported messages
+        and normal messages are left untouched.
+        :param pofile: the POFile to set this translation in.
+        """
+
     def getAllTranslationMessages():
         """Retrieve all `TranslationMessage`s for this `POTMsgSet`."""
 

=== modified file 'lib/lp/translations/model/potemplate.py'
--- lib/lp/translations/model/potemplate.py	2009-10-10 13:43:31 +0000
+++ lib/lp/translations/model/potemplate.py	2009-10-22 16:38:12 +0000
@@ -24,7 +24,7 @@
 from sqlobject import (
     BoolCol, ForeignKey, IntCol, SQLMultipleJoin, SQLObjectNotFound,
     StringCol)
-from storm.expr import Alias, And, LeftJoin, Or, SQL
+from storm.expr import Alias, And, Join, LeftJoin, Or, SQL
 from storm.info import ClassAlias
 from storm.store import Store
 from zope.component import getAdapter, getUtility
@@ -418,6 +418,23 @@
                                  orderBy=['TranslationTemplateItem.sequence'])
         return query.prejoin(['msgid_singular', 'msgid_plural'])
 
+    def getTranslationCredits(self):
+        """See `IPOTemplate`."""
+        # Find potential credits messages by the message ids.
+        store = IStore(POTemplate)
+        credits_ids = ",".join(map(quote, POTMsgSet.credits_message_ids))
+        origin1 = Join(TranslationTemplateItem,
+                       TranslationTemplateItem.potmsgset == POTMsgSet.id)
+        origin2 = Join(POMsgID, POTMsgSet.msgid_singular == POMsgID.id)
+        result = store.using(POTMsgSet, origin1, origin2).find(
+            POTMsgSet, TranslationTemplateItem.potemplate == self,
+                       "pomsgid.msgid IN (%s)" % credits_ids)
+        # Filter these candidates because is_translation_credit checks for
+        # more conditions than the special msgids.
+        for potmsgset in result:
+            if potmsgset.is_translation_credit:
+                yield potmsgset
+
     def getPOTMsgSetsCount(self, current=True):
         """See `IPOTemplate`."""
         results = self.getPOTMsgSets(current)

=== modified file 'lib/lp/translations/model/potmsgset.py'
--- lib/lp/translations/model/potmsgset.py	2009-10-21 09:54:09 +0000
+++ lib/lp/translations/model/potmsgset.py	2009-10-22 16:38:12 +0000
@@ -6,8 +6,10 @@
 __metaclass__ = type
 __all__ = ['POTMsgSet']
 
+import datetime
 import gettextpo
 import logging
+import pytz
 
 from zope.interface import implements
 from zope.component import getUtility
@@ -49,7 +51,7 @@
 
 # Msgids that indicate translation credit messages, and their
 # contexts and type.
-credit_message_ids = {
+credits_message_info = {
     # Regular gettext credits messages.
     u'translation-credits': (None, TranslationCreditsType.GNOME),
     u'translator-credits': (None, TranslationCreditsType.GNOME),
@@ -68,6 +70,10 @@
         (None, TranslationCreditsType.KDE_NAMES),
     }
 
+# String to be used as msgstr for translation credits messages.
+credits_message_str = (u'This is a dummy translation so that the '
+                       u'credits are counted as translated.')
+
 
 class POTMsgSet(SQLBase):
     implements(IPOTMsgSet)
@@ -90,6 +96,8 @@
 
     _cached_uses_english_msgids = None
 
+    credits_message_ids = credits_message_info.keys()
+
     def __storm_invalidated__(self):
         self._cached_singular_text = None
         self._cached_uses_english_msgids = None
@@ -740,7 +748,8 @@
     def updateTranslation(self, pofile, submitter, new_translations,
                           is_imported, lock_timestamp, force_shared=False,
                           force_diverged=False, force_suggestion=False,
-                          ignore_errors=False, force_edition_rights=False):
+                          ignore_errors=False, force_edition_rights=False,
+                          allow_credits=False):
         """See `IPOTMsgSet`."""
 
         just_a_suggestion, warn_about_lock_timestamp = (
@@ -752,7 +761,10 @@
 
         # If the update is on the translation credits message, yet
         # update is not is_imported, silently return.
-        if self.is_translation_credit and not is_imported:
+        deny_credits = (not allow_credits and
+                        self.is_translation_credit and
+                        not is_imported)
+        if deny_credits:
             return None
 
         # Sanitize translations
@@ -1010,11 +1022,11 @@
     @property
     def translation_credits_type(self):
         """See `IPOTMsgSet`."""
-        if self.msgid_singular.msgid not in credit_message_ids:
+        if self.msgid_singular.msgid not in credits_message_info:
             return TranslationCreditsType.NOT_CREDITS
 
         expected_context, credits_type = (
-            credit_message_ids[self.msgid_singular.msgid])
+            credits_message_info[self.msgid_singular.msgid])
         if expected_context is None or (self.context == expected_context):
             return credits_type
         return TranslationCreditsType.NOT_CREDITS
@@ -1039,6 +1051,16 @@
                 pomsgid = POMsgID(msgid=plural_form_text)
             self.msgid_plural = pomsgid
 
+    def setTranslationCreditsToTranslated(self, pofile):
+        """See `IPOTMsgSet`."""
+        if self.is_translation_credit:
+            translation = self.getSharedTranslationMessage(pofile.language)
+            if translation is None:
+                message = self.updateTranslation(pofile, pofile.owner, 
+                    [credits_message_str], False,
+                    datetime.datetime.now(pytz.UTC),
+                    allow_credits=True)
+
     def setSequence(self, potemplate, sequence):
         """See `IPOTMsgSet`."""
         self.sequence = sequence

=== modified file 'lib/lp/translations/tests/test_potemplate.py'
--- lib/lp/translations/tests/test_potemplate.py	2009-08-13 19:03:36 +0000
+++ lib/lp/translations/tests/test_potemplate.py	2009-10-22 16:38:11 +0000
@@ -65,6 +65,19 @@
             "(Expected: '%s' Got: '%s')" % (expected, result)
             )
 
+    def test_getTranslationCredits(self):
+        # getTranslationCredits returns only translation credits.
+        self.factory.makePOTMsgSet(self.potemplate, sequence=1)
+        gnome_credits = self.factory.makePOTMsgSet(
+            self.potemplate, sequence=2, singular=u"translator-credits")
+        kde_credits = self.factory.makePOTMsgSet(
+            self.potemplate, sequence=3, 
+            singular=u"Your emails", context=u"EMAIL OF TRANSLATORS")
+        self.factory.makePOTMsgSet(self.potemplate, sequence=4)
+
+        self.assertContentEqual([gnome_credits, kde_credits],
+                                self.potemplate.getTranslationCredits())
+
 
 class EquivalenceClassTestMixin:
     """Helper for POTemplate equivalence class tests."""