Merge lp:~raoul-snyman/openlp/ios-remote-i18n-script into lp:~danielborges93/openlp/ios-remote

[Raoul Snyman]

Add a script to help with translation files. This script needs Python 3 to work.

To run the script, you need to open a terminal and go to the "scripts" directory. Then run it like this:

 $ /path/to/python3 translation_utils.py

If you want to know which arguments there are, run the script with the --help option (shorthand is -h):

 $ python3 translation_utils.py --help

To only download and use 100% complete translations, use the --only-complete option (shorthand is -c):

 $ python3 translation_utls.py --only-complete

[Daniel Borges (danielborges93)]

Xcode system uses a hyphen to identify regional languages, like pt-BR. The script downloads the languages using an underscore, like pt_BR.

review: Needs Fixing

[Daniel Borges (danielborges93)]

review: Approve

=== added directory 'Remote/Resources/Settings.bundle/es.lproj'
=== added file 'Remote/Resources/Settings.bundle/es.lproj/Root.strings'
Binary files Remote/Resources/Settings.bundle/es.lproj/Root.strings	1970-01-01 00:00:00 +0000 and Remote/Resources/Settings.bundle/es.lproj/Root.strings	2017-02-20 19:47:03 +0000 differ
=== added directory 'Remote/Resources/Settings.bundle/hu.lproj'
=== added file 'Remote/Resources/Settings.bundle/hu.lproj/Root.strings'
Binary files Remote/Resources/Settings.bundle/hu.lproj/Root.strings	1970-01-01 00:00:00 +0000 and Remote/Resources/Settings.bundle/hu.lproj/Root.strings	2017-02-20 19:47:03 +0000 differ
=== added directory 'Remote/Resources/Settings.bundle/lt.lproj'
=== added file 'Remote/Resources/Settings.bundle/lt.lproj/Root.strings'
Binary files Remote/Resources/Settings.bundle/lt.lproj/Root.strings	1970-01-01 00:00:00 +0000 and Remote/Resources/Settings.bundle/lt.lproj/Root.strings	2017-02-20 19:47:03 +0000 differ
=== added directory 'Remote/Resources/Settings.bundle/nb.lproj'
=== added file 'Remote/Resources/Settings.bundle/nb.lproj/Root.strings'
Binary files Remote/Resources/Settings.bundle/nb.lproj/Root.strings	1970-01-01 00:00:00 +0000 and Remote/Resources/Settings.bundle/nb.lproj/Root.strings	2017-02-20 19:47:03 +0000 differ
=== added directory 'Remote/Resources/es.lproj'
=== added file 'Remote/Resources/es.lproj/Localizable.strings'
Binary files Remote/Resources/es.lproj/Localizable.strings	1970-01-01 00:00:00 +0000 and Remote/Resources/es.lproj/Localizable.strings	2017-02-20 19:47:03 +0000 differ
=== added directory 'Remote/Resources/hu.lproj'
=== added file 'Remote/Resources/hu.lproj/Localizable.strings'
Binary files Remote/Resources/hu.lproj/Localizable.strings	1970-01-01 00:00:00 +0000 and Remote/Resources/hu.lproj/Localizable.strings	2017-02-20 19:47:03 +0000 differ
=== added directory 'Remote/Resources/lt.lproj'
=== added file 'Remote/Resources/lt.lproj/Localizable.strings'
Binary files Remote/Resources/lt.lproj/Localizable.strings	1970-01-01 00:00:00 +0000 and Remote/Resources/lt.lproj/Localizable.strings	2017-02-20 19:47:03 +0000 differ
=== added directory 'Remote/Resources/nb.lproj'
=== added file 'Remote/Resources/nb.lproj/Localizable.strings'
Binary files Remote/Resources/nb.lproj/Localizable.strings	1970-01-01 00:00:00 +0000 and Remote/Resources/nb.lproj/Localizable.strings	2017-02-20 19:47:03 +0000 differ
=== added directory 'scripts'
=== added file 'scripts/translation_utils.py'
--- scripts/translation_utils.py	1970-01-01 00:00:00 +0000
+++ scripts/translation_utils.py	2017-02-20 19:47:03 +0000
@@ -0,0 +1,187 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection                                      #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2017 OpenLP Developers                                   #
+# --------------------------------------------------------------------------- #
+# 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 Foundation; version 2 of the License.                              #
+#                                                                             #
+# This program is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with this program; if not, write to the Free Software Foundation, Inc., 59  #
+# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
+###############################################################################
+
+"""
+This script is used to maintain the translation files in OpenLP. It downloads
+the latest translation files from the Transifex translation server, updates the
+local translation files from both the source code and the files from Transifex,
+and can also generate the compiled translation files.
+
+Create New Language
+-------------------
+
+To create a new language, simply run this script with the ``-c`` command line
+option::
+
+    @:~$ ./translation_utils.py -c
+
+Update Translation Files
+------------------------
+
+The best way to update the translations is to download the files from Transifex,
+and then update the local files using both the downloaded files and the source.
+This is done easily via the ``-d``, ``-p`` and ``-u`` options::
+
+    @:~$ ./translation_utils.py -dpu
+
+"""
+from argparse import ArgumentParser
+from getpass import getpass
+import base64
+import glob
+import json
+import os
+import sys
+import urllib.error
+import urllib.parse
+import urllib.request
+import webbrowser
+
+SERVER_URL = 'http://www.transifex.com/api/2/project/openlp/resource/ios-remote-11/'
+BASE_PATH = os.path.abspath(os.path.join('..', os.path.dirname(__file__)))
+LANG_DIR = '{lang}.lproj'
+LOCALIZED_PATH = os.path.join(BASE_PATH, 'Remote', 'Resources')
+SETTINGS_PATH = os.path.join(LOCALIZED_PATH, 'Settings.bundle')
+
+
+verbose_mode = False
+quiet_mode = False
+
+
+def print_quiet(text, linefeed=True):
+    """
+    This method checks to see if we are in quiet mode, and if not prints ``text`` out.
+
+    :param text: The text to print.
+    :param linefeed: Linefeed required
+    """
+    global quiet_mode
+    if not quiet_mode:
+        if linefeed:
+            print(text)
+        else:
+            print(text, end=' ')
+
+
+def print_verbose(text):
+    """
+    This method checks to see if we are in verbose mode, and if so prints  ``text`` out.
+
+    :param text: The text to print.
+    """
+    global verbose_mode, quiet_mode
+    if not quiet_mode and verbose_mode:
+        print('    %s' % text)
+
+
+def extract_settings_strings(localized_file, language):
+    """
+    Extract the settings strings from Localized.strings and put them into Root.strings
+    """
+    print_verbose('Extracting settings for {lang}'.format(lang=language))
+    file_path = os.path.join(SETTINGS_PATH, LANG_DIR.format(lang=language))
+    if not os.path.exists(file_path):
+        os.makedirs(file_path)
+    settings_file = os.path.join(file_path, 'Root.strings')
+    with open(localized_file, 'r', encoding='utf-16') as localized, open(settings_file, 'w', encoding='utf-16') as settings:
+        for line in localized:
+            if line.startswith('// Root.strings') or line.startswith('"settings.'):
+                settings.write(line)
+
+
+def download_translations(username, password, is_only_complete):
+    """
+    This method downloads the translation files from Transifex.
+    """
+    print_quiet('Download translation files from Transifex')
+    if not username:
+        username = input('Transifex username: ')
+    if not password:
+        password = getpass('Transifex password: ')
+    # First get the list of languages
+    base64string = base64.encodebytes(('%s:%s' % (username, password)).encode())[:-1]
+    auth_header = 'Basic %s' % base64string.decode()
+    request = urllib.request.Request(SERVER_URL + '?details')
+    request.add_header('Authorization', auth_header)
+    print_verbose('Downloading list of languages from: %s' % SERVER_URL)
+    try:
+        json_response = urllib.request.urlopen(request)
+    except urllib.error.HTTPError:
+        print_quiet('Username or password incorrect.')
+        return False
+    json_dict = json.loads(json_response.read().decode())
+    languages = [lang['code'] for lang in json_dict['available_languages']]
+    print_verbose('Languages: {}'.format(', '.join(languages)))
+    for language in languages:
+        if is_only_complete:
+            stats_url = SERVER_URL + 'stats/{lang}/'.format(lang=language)
+            request = urllib.request.Request(stats_url)
+            request.add_header('Authorization', auth_header)
+            response = urllib.request.urlopen(request)
+            json_dict = json.loads(response.read().decode())
+            print_verbose('Translation completion for {}: {}'.format(language, json_dict['completed']))
+            if json_dict['completed'] != '100%':
+                continue
+        lang_url = SERVER_URL + 'translation/%s/?file' % language
+        request = urllib.request.Request(lang_url)
+        request.add_header('Authorization', auth_header)
+        file_path = os.path.join(LOCALIZED_PATH, LANG_DIR.format(lang=language))
+        if not os.path.exists(file_path):
+            os.makedirs(file_path)
+        filename = os.path.join(file_path, 'Localizable.strings')
+        print_verbose('Get Translation File: %s' % filename)
+        response = urllib.request.urlopen(request)
+        with open(filename, 'wb') as localized_file:
+            localized_file.write(response.read())
+        extract_settings_strings(filename, language)
+    print_quiet('   Done.')
+
+
+def main():
+    global verbose_mode, quiet_mode, username, password, if_complete
+    # Set up command line options.
+    parser = ArgumentParser()
+    parser.add_argument('-u', '--username', dest='username', metavar='USERNAME',
+                        help='Transifex username, used for authentication')
+    parser.add_argument('-p', '--password', dest='password', metavar='PASSWORD',
+                        help='Transifex password, used for authentication')
+    parser.add_argument('-c', '--only-complete', dest='only_complete', action='store_true',
+                        help='only download translations that are complete')
+    parser.add_argument('-v', '--verbose', dest='verbose', action='store_true',
+                        help='show extra information while processing translations')
+    parser.add_argument('-q', '--quiet', dest='quiet', action='store_true',
+                        help='suppress all output other than errors')
+    args = parser.parse_args()
+    # Create and populate the command stack
+    verbose_mode = args.verbose
+    quiet_mode = args.quiet
+    # Process the commands
+    download_translations(args.username, args.password, args.only_complete)
+
+
+if __name__ == '__main__':
+    if os.path.split(os.path.abspath('.'))[1] != 'scripts':
+        print('You need to run this script from the scripts directory.')
+    else:
+        if not main():
+            sys.exit(1)