Merge lp:~dpm/ubuntu-sso-client/i18n into lp:ubuntu-sso-client

[David Planella]

This merge proposal adds internationalization support to ubuntu-sso-client for bug 616515.

In order to do this I've adapted setup.py file to use python-distutils-extra to make use of its i18n commands. I've also added the gettext calls to relevant strings and added the po folder to contain translations.

I've checked that translatable strings are extracted correctly and a template is created with './setup.py build_i18n', but I'll leave further testing of the application and the build system to the Ubuntu One team. This patch should give you an idea of what is needed to implement i18n support.

A couple of notes:

* I've set the same translation domain in several places (see gettext.texdomain('ubuntu-sso-client')). I guess it would be best to define that in one single place, as we did with ubuntuone-client, but I'll leave this up to you.

* I guess the Ubuntu package will need a new dependency on python-distutils-extra

* I've noticed that there is an e-mail screenshot in the code. I'm not sure how this is used, but if it's shown in the UI, that's rather useless for users who don't speak English. Please consider using translatable text instead.

[David Planella (dpm)]

After talking with Naty on IRC, she'll be working on this and include some of the changes in a next branch, as some of the files (e.g. auth.py) have now become obsolete very recently.

review: Disapprove

Unmerged revisions

578. By David Planella on 2010-08-19

Fixed the whitespace in some strings

577. By David Planella on 2010-08-19

Added i18n support and adapted setup.py for python-distutils-extra usage

=== modified file 'bin/ubuntu-sso-login'
--- bin/ubuntu-sso-login	2010-08-05 21:12:57 +0000
+++ bin/ubuntu-sso-login	2010-08-19 14:15:56 +0000
@@ -25,6 +25,8 @@
 import sys
 import gettext
 #from ubuntu import clientdefs
+from gettext import gettext as _
+gettext.textdomain('ubuntu-sso-client')
 
 import dbus.service
 
@@ -39,9 +41,6 @@
 gtk.gdk.threads_init()
 DBusGMainLoop(set_as_default=True)
 
-_ = gettext.gettext
-ngettext = gettext.ngettext
-
 OAUTH_REALM = "https://ubuntuone.com"
 OAUTH_CONSUMER = "ubuntuone"
 
@@ -181,8 +180,8 @@
             from desktopcouch.records.server import CouchDatabase
         except ImportError:
             # desktopcouch is not installed
-            logger.debug(_("Not adding desktopcouch pairing since"
-                " desktopcouch is not installed"))
+            logger.debug("Not adding desktopcouch pairing since"
+                " desktopcouch is not installed")
             return
         # Check whether there is already a record of the Ubuntu One service
         db = CouchDatabase("management", create=True)
@@ -200,14 +199,14 @@
         for row in results:
             found = True
             if row.value == 1:
-                logger.debug(_("Not adding desktopcouch pairing since"
-                " the user has explicitly unpaired with Ubuntu One"))
+                logger.debug("Not adding desktopcouch pairing since"
+                " the user has explicitly unpaired with Ubuntu One")
             else:
-                logger.debug(_("Not adding desktopcouch pairing since"
-                " we are already paired"))
+                logger.debug("Not adding desktopcouch pairing since"
+                " we are already paired")
         if not found:
             put_static_paired_service(None, "ubuntuone")
-            logger.debug(_("Pairing desktopcouch with Ubuntu One"))
+            logger.debug("Pairing desktopcouch with Ubuntu One")
 
     def main(self):
         """Starts the gtk main loop."""
@@ -226,7 +225,7 @@
     name = bus.request_name(DBUS_BUS_NAME,
                             dbus.bus.NAME_FLAG_DO_NOT_QUEUE)
     if name == dbus.bus.REQUEST_NAME_REPLY_EXISTS:
-        print _("Ubuntu One login manager already running, quitting")
+        print "Ubuntu One login manager already running, quitting"
         sys.exit(0)
 
     from twisted.internet import gtk2reactor
 
=== added directory 'po'
=== added file 'po/POTFILES.in'
--- po/POTFILES.in	1970-01-01 00:00:00 +0000
+++ po/POTFILES.in	2010-08-19 14:15:56 +0000
@@ -0,0 +1,5 @@
+bin/ubuntu-sso-login
+ubuntu_sso/auth.py
+ubuntu_sso/keyring.py
+ubuntu_sso/gui.py
+[type: gettext/glade] data/ui.glade
 
=== modified file 'setup.py'
--- setup.py	2010-08-11 23:10:02 +0000
+++ setup.py	2010-08-19 14:15:56 +0000
@@ -19,6 +19,14 @@
 import os
 import sys
 
+try:
+    import DistUtilsExtra.auto
+except ImportError:
+    print >> sys.stderr, 'To build this program you need https://launchpad.net/python-distutils-extra'
+    sys.exit(1)
+assert DistUtilsExtra.auto.__version__ >= '2.18', 'needs DistUtilsExtra.auto >= 2.18'
+
+
 from distutils.core import setup
 from distutils.spawn import find_executable
 from distutils.command import clean, build
@@ -70,7 +78,7 @@
         clean.clean.run(self)
 
 
-setup(
+DistUtilsExtra.auto.setup(
     name='ubuntu-sso-client',
     version='0.99',
     license='GPL v3',
 
=== modified file 'ubuntu_sso/auth.py'
--- ubuntu_sso/auth.py	2010-07-27 14:01:01 +0000
+++ ubuntu_sso/auth.py	2010-08-19 14:15:56 +0000
@@ -29,6 +29,9 @@
 import subprocess
 import socket, httplib, urllib
 import sys
+import gettext
+from gettext import gettext as _
+gettext.textdomain('ubuntu-sso-client')
 
 import gnomekeyring
 from oauth import oauth
@@ -202,7 +205,7 @@
             item_id = self.keyring.item_create_sync(
                 None,
                 gnomekeyring.ITEM_GENERIC_SECRET,
-                'UbuntuOne token for %s' % self.realm,
+                _('UbuntuOne token for %s') % self.realm,
                 {'ubuntuone-realm': self.realm,
                  'oauth-consumer-key': self.consumer.key},
                 access_token.to_string(),
@@ -457,29 +460,38 @@
         if nonce and (str(nonce) == str(self.nonce) and verifier):
             self.retrieve_function(store=self.store_yes_no, verifier=verifier)
             reactor.callLater(3, self.stop)
-            return """<!doctype html>
+            return_desc = _('You should now automatically <a ' \
+        'href="%(url)s">return to %(url)s</a>.') % { 'url' : url }
+            return_page = """<!doctype html>
         <html><head><meta http-equiv="refresh"
         content="0;url=%(url)s">
         </head>
         <body>
-        <p>You should now automatically <a
-        href="%(url)s">return to %(url)s</a>.</p>
+        <p>%(return_desc)s</p>
         </body>
         </html>
-        """ % { 'url' : url }
+        """ % { 'return_desc' : return_desc }
+            return return_page
         else:
             self.retrieve_function(store=self.store_yes_no, verifier=verifier)
             reactor.callLater(3, self.stop)
             request.setResponseCode(400)
-            return """<!doctype html>
-        <html><head><title>Error</title></head>
+
+            error_title = _('Error')
+            error_h1 = _('There was an error')
+            error_desc = _('The authentication process has not succeeded.' \
+                'This may be a temporary problem; please try again in a few ' \
+                'minutes.')
+            error_page = """<!doctype html>
+        <html><head><title>%(error_title)s</title></head>
         <body>
-        <h1>There was an error</h1>
-        <p>The authentication process has not succeeded. This may be a
-        temporary problem; please try again in a few minutes.</p>
+        <h1>%(error_h1)</h1>
+        <p>%(error_desc)s</p>
         </body>
         </html>
-        """
+        """ % {'error_title': error_title, 'error_h1': error_h1, \
+            'error_desc': error_desc}
+            return error_page
 
 
 
 
=== modified file 'ubuntu_sso/gui.py'
--- ubuntu_sso/gui.py	2010-08-11 22:44:19 +0000
+++ ubuntu_sso/gui.py	2010-08-19 14:15:56 +0000
@@ -38,7 +38,9 @@
 from ubuntu_sso.logger import setupLogging
 
 
-_ = gettext.gettext
+from gettext import gettext as _
+gettext.textdomain('ubuntu-sso-client')
+
 DBusGMainLoop(set_as_default=True)
 logger = setupLogging('ubuntu_sso.gui')
 
@@ -153,8 +155,8 @@
     """Ubuntu single sign on GUI."""
 
     CAPTCHA_SOLUTION_ENTRY = _('Type the characters above')
-    CONNECT_HELP_LABEL = _('To connect this computer to') + ' %s ' + \
-                         _('enter your details below.')
+    CONNECT_HELP_LABEL = _('To connect this computer to %s ' \
+                         'enter your details below.')
     EMAIL1_ENTRY = _('Email address')
     EMAIL2_ENTRY = _('Re-type Email address')
     EMAIL_MISMATCH = _('The email addresses don\'t match, please double check '
@@ -163,11 +165,11 @@
     EMAIL_TOKEN_ENTRY = _('Enter code verification here')
     FIELD_REQUIRED = _('This field is required.')
     FORGOTTEN_PASSWORD_BUTTON = _('I\'ve forgotten my password')
-    JOIN_HEADER_LABEL = _('Create') + ' %s ' + _('account')
+    JOIN_HEADER_LABEL = _('Create  %s account')
     LOADING = _('Loading...')
     LOGIN_BUTTON_LABEL = _('Already have an account? Click here to sign in')
     LOGIN_EMAIL_ENTRY = _('Email address')
-    LOGIN_HEADER_LABEL = _('Connect to') + ' %s'
+    LOGIN_HEADER_LABEL = _('Connect to %s')
     LOGIN_PASSWORD_ENTRY = _('Password')
     NAME_ENTRY = _('Name')
     NEXT = _('Next')
 
=== modified file 'ubuntu_sso/keyring.py'
--- ubuntu_sso/keyring.py	2010-08-17 20:44:39 +0000
+++ ubuntu_sso/keyring.py	2010-08-19 14:15:56 +0000
@@ -2,7 +2,7 @@
 #
 # Authors:
 #  Andrew Higginson
-#  Alejandro J. Cura <[e-mail]>
+#  Alejandro J. Cura <[e-mail]>
 #
 # This program is free software; you can redistribute it and/or modify it under
 # the terms of the GNU General Public License as published by the Free Software
@@ -22,6 +22,10 @@
 from urllib import urlencode
 from urlparse import parse_qsl
 
+import gettext
+from gettext import gettext as _
+gettext.textdomain('ubuntu-sso-client')
+
 class Keyring(object):
 
     KEYRING_NAME = "login"
@@ -40,7 +44,7 @@
         keyring_names = gnomekeyring.list_keyring_names_sync()
         if not name in keyring_names:
             gnomekeyring.create_sync(name)
-
+
     def _get_item_id_from_name(self, sync, name):
         """
         Returns the ID for a named item
@@ -76,9 +80,9 @@
         # No need to delete the item if it already exists
 
         # A set of attributes for this credentials
-        attr = {"key-type": "Ubuntu SSO credentials",
-                "token-name": cred["name"].encode("utf8")}
-
+        attr = {"key-type": _("Ubuntu SSO credentials"),
+                "token-name": cred["name"].encode("utf8")}
+
         # Add our SSO credentials to the keyring
         gnomekeyring.item_create_sync(self.KEYRING_NAME,
                 gnomekeyring.ITEM_GENERIC_SECRET, self.app_name, attr,
@@ -95,23 +99,23 @@
         secret = self._get_item_info_from_name(self.KEYRING_NAME,
                                                self.app_name).get_secret()
         return dict(parse_qsl(secret))
-
-    def delete_ubuntusso_attr(self):
-        """
-        Delete a set of credentials from the keyring
-        """
+
+    def delete_ubuntusso_attr(self):
+        """
+        Delete a set of credentials from the keyring
+        """
         item_id = self._get_item_id_from_name(self.KEYRING_NAME,
                                               self.app_name)
-        if item_id is not None:
-            gnomekeyring.item_delete_sync(self.KEYRING_NAME, item_id)
+        if item_id is not None:
+            gnomekeyring.item_delete_sync(self.KEYRING_NAME, item_id)
 
 if __name__ == "__main__":
     kr1 = Keyring("Test key 1")
     kr2 = Keyring("Test key 2")
-
-    kr1.delete_ubuntusso_attr()
-    kr2.delete_ubuntusso_attr()
-
+
+    kr1.delete_ubuntusso_attr()
+    kr2.delete_ubuntusso_attr()
+
     d1 = {"name":"test-1", "ha":"hehddddeff", "hi":"hggehes", "ho":"he"}
     d2 = {"name":"test-2", "hi":"ho", "let's":"go"}