Issue 2625 - [cms] Crowdin synchronisation script

cms/sources.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2015 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
 import codecs
+from collections import OrderedDict
 import ConfigParser
 import json
 import os
 from StringIO import StringIO
 import subprocess
 import urlparse
 import zipfile
 import logging
 
 class Source:
@@ skipping 133 matching lines @@
     config = self.read_config()
     try:
       page = config.get("locale_overrides", page)
     except ConfigParser.Error:
       pass
     return self.has_file(self.locale_filename(locale, page))
 
   def read_locale(self, locale, page):
     default_locale = self.read_config().get("general", "defaultlocale")
     if locale == default_locale:
-      result = {}
+      result = OrderedDict()

[kzar, 2015/06/15 14:24:28]

This is required to keep the correct order of page strings uploaded to Crowdin.
Otherwise I found a lot of context was lost when viewing a page's strings in
Crowdin.

[Wladimir Palant, 2015/06/29 19:05:38]

Crowdin isn't very good at keeping that order but it won't hurt...

[kzar, 2015/07/02 12:33:13]

I found that it does help in practice for our website.

     else:
-      result = dict(self.read_locale(default_locale, page))
+      result = OrderedDict(self.read_locale(default_locale, page))
 
     if self.has_locale(locale, page):
       filedata = self.read_file(self.locale_filename(locale, page))
       localedata = json.loads(filedata)
       for key, value in localedata.iteritems():
         result[key] = value["message"]
 
     return result
 
   #
@@ skipping 102 matching lines @@
         path = os.path.join(dir, filename)
         if os.path.isfile(path):
           result.append(relpath + filename)
         elif os.path.isdir(path):
           do_list(path, relpath + filename + "/")
     do_list(self.get_path(subdir), "")
     return result
 
   def get_cache_dir(self):
     return os.path.join(self._dir, "cache")