Prepared buildtools for Safari

packagerChrome.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus build tools,
 # Copyright (C) 2006-2013 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,
@@ skipping 16 matching lines @@
   result = set(('store.description',))
 
   # Hack: ignore all lib subdirectories
   libDir = os.path.join(params['baseDir'], 'lib')
   for file in os.listdir(libDir):
     if os.path.isdir(os.path.join(libDir, file)):
       result.add(file)
   return result
 
 def getPackageFiles(params):
-  result = set(('_locales', 'icons', 'jquery-ui', 'lib', 'skin', 'ui',))
+  result = set(('_locales', 'icons', 'jquery-ui', 'lib', 'skin', 'ui', 'ext'))
 
   if params['devenv']:
     result.add('qunit')
 
   baseDir = params['baseDir']
   for file in os.listdir(baseDir):
     if file.endswith('.js') or file.endswith('.html') or file.endswith('.xml'):
       result.add(file)
   return result
 
@@ skipping 105 matching lines @@
       pass
 
     # Source files of the conversion shouldn't be part of the build
     for sourceFile in sourceFiles:
       if sourceFile in files:
         del files[sourceFile]
 
     sourceFiles = map(lambda f: os.path.abspath(os.path.join(baseDir, f)), sourceFiles)
     files[file] = doRewrite(sourceFiles, args)
 
+def convertFirstRunPage(params, files):
+  import jinja2
+
+  env = jinja2.Environment(
+    block_start_string='<!-- {%',
+    block_end_string='%} -->',
+    variable_start_string='<!-- {{',
+    variable_end_string='}} -->',
+    comment_start_string='<-- {#',
+    comment_end_string='#} -->',
+
+    trim_blocks=True,
+    lstrip_blocks=True
+  )
+
+  files['firstRun.html'] = env.from_string(files['firstRun.html']).render(type=params['type'])

[Wladimir Palant, 2013/10/30 13:36:01]

Hardcoding the file here that needs to be passed through jinja2 is quite a hack.
I guess the best solution would be a metadata section:

[preprocess]
firstRun.html =
foo.html =

The code dealing with it should be part of the shared code in packager.py, a
method Files.preprocess(self, filenames, params) I guess - all packagers can
call that one. Also, it should be kept generic - meaning that params should be
passed as template parameters, as with all templates. Also, trim_blocks and
lstrip_blocks shouldn't be set, this can be done explicitly in the template if
necessary. A TODO comment is required explaining that special tag syntax is
meant to be removed. And finally, autoescaping needs to be enabled automatically
for any files with .html or .xml file extension (not enabling autoescaping is a
huge footgun).

+
 def importGeckoLocales(params, files):
   import localeTools
 
   localeCodeMapping = {
     'ar': 'ar',
     'bg': 'bg',
     'ca': 'ca',
     'cs': 'cs',
     'da': 'da',
     'de': 'de',
@@ skipping 99 matching lines @@
       'pt': 'pt_PT',
     }
     for chromeLocale, operaLocale in operaMapping.iteritems():
       chromeFile = '_locales/%s/messages.json' % chromeLocale
       operaFile = '_locales/%s/messages.json' % operaLocale if operaLocale != None else None
       if chromeFile in files:
         if operaFile != None:
           files[operaFile] = files[chromeFile]
         del files[chromeFile]
 
-    # Hack: Replace "Chrome" by "Opera" in the locales
+  if params['type'] in ('opera', 'safari'):
+    # Hack: Replace "Chrome" by "Opera" or "Safari" in the locales
     for path, data in files.iteritems():
       if path.startswith("_locales/") and path.endswith("/messages.json"):
-        files[path] = re.sub(r"\bChrome\b", "Opera", data)
+        # Hack: There is exactly one text (in the first run page) that contains
+        # "Google Chrome" and means Google Chrome, even though it is only shown
+        # on Safari.
+        files[path] = re.sub(r"\b(?<!Google )Chrome\b", params['type'].capitalize(), data)

[Wladimir Palant, 2013/10/30 13:36:01]

Ouch, we should really get rid of this hack... How about the following approach:

* Change "enable_only_the" string into "Enable only the filter lists you need.
Too many can make your browser unresponsive."
* Replace "description" string by description-chrome, description-opera and
description-safari.
* Make the description string configurable in the metadata file:

[general]
description = __MSG_description-chrome__

Would be great if we could make these changes for the current translation round.

[Sebastian Noack, 2013/10/30 16:12:10]

I don't like that hack too, and would like to see that going to be replaced by a
proper solution. But I think we should do so after the Safari release.

[Wladimir Palant, 2013/10/30 16:21:38]

Actually, given that you made the hack likely to explode in translations - I
think that we should fix it *before* the Safari release (it's a trivial change).

 
 def signBinary(zipdata, keyFile):
   import M2Crypto
   if not os.path.exists(keyFile):
     M2Crypto.RSA.gen_key(1024, 65537, callback=lambda x: None).save_key(keyFile, cipher=None)
   key = M2Crypto.EVP.load_key(keyFile)
   key.sign_init()
   key.sign_update(zipdata)
   return key.final()
 
@@ skipping 32 matching lines @@
   files = Files(getPackageFiles(params), getIgnoredFiles(params),
                 process=lambda path, data: processFile(path, data, params))
   files['manifest.json'] = createManifest(params)
   if metadata.has_section('mapping'):
     files.readMappedFiles(metadata.items('mapping'))
   files.read(baseDir)
 
   if metadata.has_section('convert_js'):
     convertJS(params, files)
 
+  if metadata.has_section('convert_img'):
+    from imageConversion import convertImages
+    convertImages(params, files)
+
+  if 'firstRun.html' in files:
+    convertFirstRunPage(params, files)
+
   if metadata.has_section('import_locales'):
     importGeckoLocales(params, files)
 
   if devenv:
     files['devenvPoller__.js'] = createPoller(params)
 
   if (metadata.has_option('general', 'backgroundScripts') and
       'lib/info.js' in re.split(r'\s+', metadata.get('general', 'backgroundScripts')) and
       'lib/info.js' not in files):
     files['lib/info.js'] = createInfoModule(params)
@@ skipping 31 matching lines @@
   def shutdown_server(server):
     time.sleep(10)
     server.shutdown()
   thread.start_new_thread(shutdown_server, (server,))
   server.serve_forever()
 
   if connections[0] == 0:
     print 'Warning: No incoming connections, extension probably not active in the browser yet'
   else:
     print 'Handled %i connection(s)' % connections[0]