Issue 399 - Added support for Safari to updateDownloadLinks

sitescripts/extensions/bin/updateDownloadLinks.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2014 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 10 matching lines @@
 
   This script generates a list of extensions and saves these with download links
   and version information
 """
 
 import sys, os, re, urllib, urllib2, urlparse, subprocess, time
 import xml.dom.minidom as dom
 from ConfigParser import SafeConfigParser
 from StringIO import StringIO
 from sitescripts.utils import get_config, get_template
-from sitescripts.extensions.utils import compareVersions, Configuration
+from sitescripts.extensions.utils import compareVersions, Configuration, getSafariCertificateID
 from buildtools.packagerGecko import KNOWN_APPS
 
 def urlencode(value):
   return urllib.quote(value.encode('utf-8'), '')
 
 def urlopen(url, attempts=3):
   """
   Tries to open a particular URL, retries on failure.
   """
   for i in range(attempts):
@@ skipping 57 matching lines @@
 
 def getLocalLink(repo):
   """
   gets the link for the newest download of an add-on in the local downloads
   repository
   """
   url = repo.downloadsURL
 
   highestURL = None
   highestVersion = None
-  prefix = os.path.basename(repo.repository) + '-'
+
+  if repo.type == 'android':
+    prefix = os.path.basename(repo.repository)
+  else:
+    prefix = readRawMetadata(repo).get('general', 'basename')
+  prefix += '-'
   suffix = repo.packageSuffix
 
   # go through the downloads repository looking for downloads matching this extension
   command = ['hg', 'locate', '-R', repo.downloadsRepo, '-r', 'default']
   result = subprocess.check_output(command)
   for fileName in result.splitlines():
     if fileName.startswith(prefix) and fileName.endswith(suffix):
       version = fileName[len(prefix):len(fileName) - len(suffix)]
       if highestVersion == None or compareVersions(version, highestVersion) > 0:
         highestURL = urlparse.urljoin(url, fileName)
@@ skipping 43 matching lines @@
       continue
     if not result.has_section(repo.repositoryName):
       result.add_section(repo.repositoryName)
     result.set(repo.repositoryName, "downloadURL", downloadURL)
     result.set(repo.repositoryName, "version", version)
 
     qrcode = getQRCode(downloadURL)
     if qrcode != None:
       result.set(repo.repositoryName, "qrcode", qrcode)
 
+def readRawMetadata(repo, version='tip'):
+  files = subprocess.check_output(['hg', '-R', repo.repository, 'locate', '-r', version]).splitlines()
+  if 'metadata.%s' % repo.type in files:
+    command = ['hg', '-R', repo.repository, 'cat', '-r', version, os.path.join(repo.repository, 'metadata.%s' % repo.type)]
+    result = subprocess.check_output(command)
+  else:
+    # Fall back to platform-independent metadata file for now
+    command = ['hg', '-R', repo.repository, 'cat', '-r', version, os.path.join(repo.repository, 'metadata')]
+    result = subprocess.check_output(command)

[Wladimir Palant, 2014/04/30 11:50:57]

Nit: You only copied that code but |result = subprocess.check_output(command)|
can be performed after the if block - it's being done on both branches.

[Sebastian Noack, 2014/04/30 12:21:45]

Even better, just generating the manifest filename with a conditional branch. So
we also don't need to duplicate the command line.

+
+  parser = SafeConfigParser()
+  parser.readfp(StringIO(result))
+
+  return parser
+
 def readMetadata(repo, version):
   """
   reads extension ID and compatibility information from metadata file in the
   extension's repository
   """
   if repo.type == 'android':
     command = ['hg', '-R', repo.repository, 'id', '-r', version, '-n']
     result = subprocess.check_output(command)
     revision = re.sub(r'\D', '', result)
 
     command = ['hg', '-R', repo.repository, 'cat', '-r', version, os.path.join(repo.repository, 'AndroidManifest.xml')]
     result = subprocess.check_output(command)
     manifest = dom.parseString(result)
     usesSdk = manifest.getElementsByTagName('uses-sdk')[0]
 
     return {
       'revision': revision,
       'minSdkVersion': usesSdk.attributes["android:minSdkVersion"].value,
     }
+  elif repo.type == 'safari':
+    metadata = readRawMetadata(repo, version)
+    return {
+      'certificateID': getSafariCertificateID(repo.keyFile),
+      'version': version,
+      'shortVersion': version,
+      'basename': metadata.get('general', 'basename'),
+    }
   else:

[Wladimir Palant, 2014/04/30 11:50:57]

Nit: Please check |repo.type == 'gecko'| explicitly here, we do it in newer code
now. We should throw an exception for unknown repository types.

[Sebastian Noack, 2014/04/30 12:21:45]

Done.

-    files = subprocess.check_output(['hg', '-R', repo.repository, 'locate', '-r', version]).splitlines()
-    if 'metadata.%s' % repo.type in files:
-      command = ['hg', '-R', repo.repository, 'cat', '-r', version, os.path.join(repo.repository, 'metadata.%s' % repo.type)]
-      result = subprocess.check_output(command)
-    else:
-      # Fall back to platform-independent metadata file for now
-      command = ['hg', '-R', repo.repository, 'cat', '-r', version, os.path.join(repo.repository, 'metadata')]
-      result = subprocess.check_output(command)
-
-    parser = SafeConfigParser()
-    parser.readfp(StringIO(result))
-
+    metadata = readRawMetadata(repo, version)
     result = {
-      'extensionID': parser.get('general', 'id'),
+      'extensionID': metadata.get('general', 'id'),
       'version': version,
       'compat': []
     }
     for key, value in KNOWN_APPS.iteritems():
-      if parser.has_option('compat', key):
-        minVersion, maxVersion = parser.get('compat', key).split('/')
+      if metadata.has_option('compat', key):
+        minVersion, maxVersion = metadata.get('compat', key).split('/')
         result['compat'].append({'id': value, 'minVersion': minVersion, 'maxVersion': maxVersion})
     return result
 
 def writeUpdateManifest(links):
   """
   writes an update manifest for all Gecko extensions and Android apps
   """
 
-  extensions = {'gecko': [], 'android': []}
+  extensions = {'gecko': [], 'android': [], 'safari': []}
   for repo in Configuration.getRepositoryConfigurations():
     if repo.type not in extensions or not links.has_section(repo.repositoryName):
       continue
     data = readMetadata(repo, links.get(repo.repositoryName, 'version'))
     data['updateURL'] = links.get(repo.repositoryName, 'downloadURL')
     if data['updateURL'].startswith(repo.downloadsURL):
       data['updateURL'] += "?update"
     extensions[repo.type].append(data)
 
   if len(extensions['android']) > 1:
@@ skipping 13 matching lines @@
   result = SafeConfigParser()
   getDownloadLinks(result)
   file = open(get_config().get('extensions', 'downloadLinksFile'), 'wb')
   result.write(file)
   file.close()
 
   writeUpdateManifest(result)
 
 if __name__ == "__main__":
   updateLinks()