Prepared buildtools for Safari

packagerSafari.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,
+# 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 os
+import re
+import json
+import ConfigParser
+from urlparse import urlparse
+
+from packager import readMetadata, getDefaultFileName, getBuildVersion, getTemplate, Files
+from packagerChrome import convertJS, convertFirstRunPage, importGeckoLocales, getIgnoredFiles, getPackageFiles, defaultLocale
+
+def processFile(path, data, params):
+  return data
+
+def createManifest(params, files):
+  template = getTemplate('Info.plist.tmpl', autoEscape=True)
+  metadata = params['metadata']
+  catalog = json.loads(files['_locales/%s/messages.json' % defaultLocale])
+
+  def parse_section(section, depth=1):
+    result = {}
+
+    if not metadata.has_section(section):
+      return result
+
+    for opt in metadata.options(section):
+      bits = opt.split('_', depth)
+      key = bits.pop().replace('_', ' ').title()
+      val = metadata.get(section, opt)
+
+      try:
+        val = int(val)
+      except ValueError:
+        try:
+          val = float(val)
+        except ValueError:
+          pass
+
+      reduce(lambda d, x: d.setdefault(x, {}), bits, result)[key] = val
+
+    return result
+
+  def get_optional(*args):
+    try:
+      return metadata.get(*args)
+    except ConfigParser.Error:
+      return None
+
+  allowedDomains = set()
+  allowAllDomains = False
+  allowSecurePages = False
+
+  for perm in metadata.get('general', 'permissions').split():
+    if perm == '<all_urls>':
+      allowAllDomains = True
+      allowSecurePages = True
+      continue
+
+    url = urlparse(perm)
+
+    if url.scheme == 'https':
+      allowSecurePages = True
+    elif url.scheme != 'http':
+      continue
+
+    if '*' in url.hostname:
+      allowAllDomains = True
+      continue
+
+    allowedDomains.add(url.hostname)
+
+  return template.render(
+    basename=metadata.get('general', 'basename'),
+    version=params['version'],
+    shortVersion=metadata.get('general', 'version'),
+    releaseBuild=params['releaseBuild'],
+    name=catalog['name']['message'],
+    description=catalog['description']['message'],
+    author=get_optional('general', 'author'),
+    homepage=get_optional('general', 'homepage'),
+    updateURL=get_optional('general', 'updateURL'),
+    allowedDomains=allowedDomains,
+    allowAllDomains=allowAllDomains,
+    allowSecurePages=allowSecurePages,
+    startScripts=(get_optional('contentScripts', 'document_start') or '').split(),
+    endScripts=  (get_optional('contentScripts', 'document_end'  ) or '').split(),

[Felix Dahlke, 2013/10/15 22:46:11]

I'd prefer to have no whitespace after endScripts= as well as after
'document_end', that'd be consistent with the surrounding code.

[Sebastian Noack, 2013/10/16 08:52:23]

I found it more readable when the identical parts in those two lines are
aligned. But if it doesn't match our coding convention I'll change it.

+    menus=parse_section('menus', 2),
+    toolbarItems=parse_section('toolbar_items'),
+    popovers=parse_section('popovers')
+  ).encode('utf-8')
+
+def createBackgroundPage(params):
+  template = getTemplate('background.html.tmpl')

[Felix Dahlke, 2013/10/15 22:46:11]

Wladimir suggested to use autoEscape=True here, did you consider that? Sounds
reasonable.

[Sebastian Noack, 2013/10/16 08:52:23]

I added autoescaping for Info.plist.tmpl and just forgot to add it here too.
I'll fix that.

+  return template.render(
+    backgroundScripts=params['metadata'].get(
+      'general', 'backgroundScripts'
+    ).split()
+  ).encode('utf-8')
+
+def createInfoModule(params):
+  template = getTemplate('safariInfo.js.tmpl')
+  return template.render(params).encode('utf-8');
+
+def createSignedXarArchive(outFile, files, keyFile):
+  import subprocess
+  import tempfile
+  import shutil
+  import M2Crypto
+
+  # write files to temporary directory and create a xar archive
+  dirname = tempfile.mkdtemp()
+  try:
+    for filename, contents in files.iteritems():
+      path = os.path.join(dirname, filename)
+
+      try:
+        os.makedirs(os.path.dirname(path))
+      except OSError:
+        pass
+
+      with open(path, 'wb') as file:
+        file.write(contents)
+
+    subprocess.check_output(
+      ['xar', '-czf', os.path.abspath(outFile), '--distribution'] + os.listdir(dirname),
+      cwd=dirname
+    )
+  finally:
+    shutil.rmtree(dirname)
+
+  certificate_filenames = []
+  try:
+    # load key and certificates from the all-in-one key file
+    # and write each certificate in DER format to a seperate
+    # temporary file, that they can be passed to xar
+    bio = M2Crypto.BIO.openfile(keyFile)
+    try:
+      key = M2Crypto.RSA.load_key_bio(bio)
+
+      bio.reset()
+      while True:
+        try:
+          cert = M2Crypto.X509.load_cert_bio(bio)
+        except M2Crypto.X509.X509Error:
+          break
+
+        fd, filename = tempfile.mkstemp()
+        try:
+          certificate_filenames.append(filename)
+          os.write(fd, cert.as_der())
+        finally:
+          os.close(fd)
+    finally:
+      bio.close()
+
+    # add certificates and placeholder signature
+    # to the xar archive, and get data to sign
+    fd, digestinfo_filename = tempfile.mkstemp()
+    os.close(fd)
+    try:
+      subprocess.check_call(
+        [
+          'xar', '--sign', '-f', outFile,
+          '--digestinfo-to-sign', digestinfo_filename,
+          '--sig-size', str(len(key.private_encrypt('', M2Crypto.RSA.pkcs1_padding)))
+        ] + [
+          arg for cert in certificate_filenames for arg in ('--cert-loc', cert)
+        ]
+      )
+
+      with open(digestinfo_filename, 'rb') as file:
+        digestinfo = file.read()
+    finally:
+      os.unlink(digestinfo_filename)
+  finally:
+    for filename in certificate_filenames:
+      os.unlink(filename)
+
+  # sign data and inject signature into xar archive
+  fd, signature_filename = tempfile.mkstemp()
+  try:
+    try:
+      os.write(fd, key.private_encrypt(
+        digestinfo,
+        M2Crypto.RSA.pkcs1_padding
+      ))
+    finally:
+      os.close(fd)
+
+    subprocess.check_call(['xar', '--inject-sig', signature_filename, '-f', outFile])
+  finally:
+    os.unlink(signature_filename)
+
+def createBuild(baseDir, type, outFile=None, buildNum=None, releaseBuild=False, keyFile=None):
+  metadata = readMetadata(baseDir, type)
+  version = getBuildVersion(baseDir, metadata, releaseBuild, buildNum)
+
+  if not outFile:
+    outFile = getDefaultFileName(baseDir, metadata, version, 'safariextz' if keyFile else 'zip')
+
+  params = {
+    'type': type,
+    'baseDir': baseDir,
+    'releaseBuild': releaseBuild,
+    'version': version,
+    'devenv': False,
+    'metadata': metadata,
+  }
+
+  files = Files(getPackageFiles(params), getIgnoredFiles(params),
+                process=lambda path, data: processFile(path, data, 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)
+
+  files['lib/info.js'] = createInfoModule(params)
+  files['background.html'] = createBackgroundPage(params)
+  files['Info.plist'] = createManifest(params, files)
+
+  dirname = metadata.get('general', 'basename') + '.safariextension'
+  for filename in files.keys():
+    files[os.path.join(dirname, filename)] = files.pop(filename)
+
+  if keyFile:
+    createSignedXarArchive(outFile, files, keyFile)
+  else:
+    files.zip(outFile)