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
+from packagerChrome import convertJS, 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):
@@ skipping 47 matching lines @@
       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'],
+    description=catalog['description_safari']['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.

+    endScripts=(get_optional('contentScripts', 'document_end') or '').split(),
     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.

+  template = getTemplate('background.html.tmpl', autoEscape=True)
   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');
+  return template.render(params).encode('utf-8')
+
+def fixAbsoluteUrls(files):
+  for filename, content in files.iteritems():
+    if os.path.splitext(filename)[1].lower() == '.html':
+      files[filename] = re.sub(
+        r'(<[^<>]*?\b(?:href|src)\s*=\s*["\']?)\/+',
+        r'\1' + '/'.join(['..'] * filename.count('/') + ['']),
+        content, re.S | re.I
+      )
 
 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:
@@ skipping 100 matching lines @@
     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('preprocess'):
+    files.preprocess(
+      [f for f, _ in metadata.items('preprocess')],
+      {'needsExt': True}
+    )
 
   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)
+
+  fixAbsoluteUrls(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)