Merge lp:~dholbach/help-app/rewrite-links into lp:~ubuntu-touch-coreapps-drivers/help-app/trunk

[Daniel Holbach]

This piece of code will make sure we end up with translations like this:

msgid "[Take me to the FAQ!]({filename}faq.md) \n"
msgstr "[Zu den Antworten!]({filename}lang-de-faq.md) \n"

It'll ensure that the link in English (faq.md) will become lang-XX-faq.md in the translated version.

[Daniel Holbach (dholbach)]

.... on second thoughts, we might not need this. We could merge this though and use it until bug 1425010 is fixed. The code could still be useful in checking links at some stage (rogue translations breaking links).

[Daniel Holbach (dholbach)]

It should be useful though, if we use the following naming scheme:

 - index.en-us.html
 - index.de.html
 - get-in-touch.en-us.html (*)
 - get-in-touch.de.html

[David Planella (dpm)]

Good call on using polib! Looks good to me, I'd suggest going for the .$LANG.html change straight away, but if you think it makes sense to get this merged already first, sounds good to me too.

review: Approve

=== modified file 'HACKING'
--- HACKING	2015-02-23 17:00:11 +0000
+++ HACKING	2015-02-24 13:18:01 +0000
@@ -7,7 +7,8 @@
 
 Before you get started, run:
 
-	sudo apt install python-pelican po4a make bzr ubuntu-html5-ui-toolkit
+  sudo apt install python-pelican po4a make bzr \
+	ubuntu-html5-ui-toolkit python3-polib
 
 
 Editing
 
=== modified file 'edit-here/generate-translations'
--- edit-here/generate-translations	2015-02-13 14:31:20 +0000
+++ edit-here/generate-translations	2015-02-24 13:18:01 +0000
@@ -9,6 +9,7 @@
 
 def main():
     translations = Translations()
+    translations.rewrite_links()
     translations.generate_translations()
 
 
 
=== modified file 'edit-here/po/de.po'
--- edit-here/po/de.po	2015-02-24 09:19:32 +0000
+++ edit-here/po/de.po	2015-02-24 13:18:01 +0000
@@ -2,7 +2,7 @@
 # Copyright (C) YEAR Free Software Foundation, Inc.
 # This file is distributed under the same license as the PACKAGE package.
 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
+# 
 #, fuzzy
 msgid ""
 msgstr ""
@@ -33,7 +33,7 @@
 #. type: Bullet: '  * '
 #: content/pages/faq.md:7
 msgid "[Apps]({filename}apps.md)"
-msgstr "[Apps]({filename}apps.md)"
+msgstr "[Apps]({filename}lang-de-apps.md)"
 
 #. type: Bullet: '  * '
 #: content/pages/faq.md:7
@@ -68,7 +68,8 @@
 #: content/pages/index.md:9
 msgid "links to get in touch with experts and other community members"
 msgstr ""
-"Links, um mit anderen Community-Mitgliedern und Experten in Kontakt zu kommen"
+"Links, um mit anderen Community-Mitgliedern und Experten in Kontakt zu "
+"kommen"
 
 #. type: Plain text
 #: content/pages/index.md:11
@@ -80,14 +81,14 @@
 #, fuzzy, no-wrap
 #| msgid "[Take me to the FAQ!](faq.html)  \n"
 msgid "[Take me to the FAQ!]({filename}faq.md)  \n"
-msgstr "[Zu den Antworten!]({filename}faq.md)  \n"
+msgstr "[Zu den Antworten!]({filename}lang-de-faq.md)  \n"
 
 #. type: Plain text
 #: content/pages/index.md:14
 #, fuzzy
 #| msgid "[Get in touch](get-in-touch.html)"
 msgid "[Get in touch]({filename}get-in-touch.md)"
-msgstr "[Kontakt]({filename}get-in-touch.md)"
+msgstr "[Kontakt]({filename}lang-de-get-in-touch.md)"
 
 #. type: Plain text
 #: content/pages/apps.md:2
 
=== modified file 'edit-here/translations.py'
--- edit-here/translations.py	2015-02-24 13:18:00 +0000
+++ edit-here/translations.py	2015-02-24 13:18:01 +0000
@@ -2,6 +2,8 @@
 import copy
 import glob
 import os
+import polib
+import re
 import shutil
 import subprocess
 import tempfile
@@ -59,7 +61,7 @@
             args = []
             for document in documents:
                 args += ['-m', document]
-            args += ['-p', os.path.join(self.translations_dir, lang+'.po')]
+            args += ['-p', lang.file_name]
             ret = self.run('po4a-updatepo', args)
             if ret:
                 return False
@@ -69,20 +71,42 @@
         args = [
             '-k', TRANSLATION_COMPLETION_PERCENTAGE,
             '-m', doc,
-            '-p', 'po/%s.po' % lang,
+            '-p', lang.file_name,
             '-L', 'utf-8',
             ]
         return self.run('po4a-translate', args, with_output=True,
                         working_dir=os.path.join(PATH, '..'))
 
 
+class Language(object):
+    def __init__(self, po_file):
+        self.file_name = po_file
+        self.gettext_lang_code = os.path.basename(po_file).split('.po')[0]
+
+    def rewrite_links(self):
+        po_file = polib.pofile(self.file_name)
+        for entry_group in [po_file.untranslated_entries(),
+                            po_file.translated_entries(),
+                            po_file.fuzzy_entries()]:
+            for entry in entry_group:
+                if '{filename}' in entry.msgid:
+                    if not entry.msgstr:
+                        entry.msgstr = entry.msgid
+                    link = re.findall(r'\[.+?\]\(\{filename\}(.+?)\)',
+                                      entry.msgid)[0]
+                    entry.msgstr = entry.msgstr.replace(
+                        link,
+                        'lang-%s-%s' % (self.gettext_lang_code, link))
+        po_file.save(self.file_name)
+
+
 class Translations(object):
     def __init__(self):
         self._cleanup()
         self.translations_dir = os.path.abspath(os.path.join(PATH, '../po'))
-        self.available_languages = \
-            [os.path.basename(a).split('.po')[0] for a
-             in glob.glob(self.translations_dir+'/*.po')]
+        self.available_languages = []
+        for po_filename in glob.glob(self.translations_dir+'/*.po'):
+            self.available_languages += [Language(po_filename)]
         self.documents = self._find_documents()
         self.temp_dir = tempfile.mkdtemp()
         self.po4a = PO4A(self.translations_dir, self.temp_dir)
@@ -163,7 +187,11 @@
             title_line = title_line.split(metadata_tag.capitalize())[0]
             title_line = title_line.split(metadata_tag.upper())[0]
         return "%s\nLang: %s\nDate:\n\n" % \
-            (title_line, lang)
+            (title_line, lang.gettext_lang_code)
+
+    def rewrite_links(self):
+        for lang in self.available_languages:
+            lang.rewrite_links()
 
     def generate_translations(self):
         for lang in self.available_languages:
@@ -172,7 +200,8 @@
                     self._call_po4a_translate(doc, lang)
                 new_path = os.path.join(PATH, 'pages',
                                         'lang-%s-%s' %
-                                        (lang, os.path.basename(doc)))
+                                        (lang.gettext_lang_code,
+                                         os.path.basename(doc)))
                 text = self._new_header(lang, broken_title_line)
                 text += output
                 if os.path.exists(new_path):