Issue 1144 - Generate IE update manifests

sitescripts/extensions/bin/createNightlies.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,
 # 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/>.
 
 """
 
 Nightly builds generation script
 ================================
 
   This script generates nightly builds of extensions, together
   with changelogs and documentation.
 
 """
 
-import sys, os, os.path, codecs, subprocess, ConfigParser, traceback, json, hashlib
+import sys, os, os.path, subprocess, ConfigParser, traceback, json, hashlib
 import tempfile, shutil, urlparse, pipes, time, urllib2, struct
 from datetime import datetime
 from urllib import urlencode
 from xml.dom.minidom import parse as parseXml
 from sitescripts.utils import get_config, setupStderr, get_template
 from sitescripts.extensions.utils import compareVersions, Configuration, getSafariCertificateID
 
 MAX_BUILDS = 50
 
 
@@ skipping 154 matching lines @@
       os.makedirs(baseDir)
     if self.config.type == 'chrome' or self.config.type == 'opera':
       manifestPath = os.path.join(baseDir, "updates.xml")
       templateName = 'chromeUpdateManifest'
     elif self.config.type == 'safari':
       manifestPath = os.path.join(baseDir, "updates.plist")
       templateName = 'safariUpdateManifest'
     elif self.config.type == 'android':
       manifestPath = os.path.join(baseDir, "updates.xml")
       templateName = 'androidUpdateManifest'
+    elif self.config.type == 'ie':
+      manifestPath = os.path.join(baseDir, "update.json")
+      templateName = 'ieUpdateManifest'

[Wladimir Palant, 2014/07/29 11:25:18]

libabpUpdateManifest please, this format isn't specific to Internet Explorer.
Also, new settings should be documented in .sitescripts.example.

[Felix Dahlke, 2014/07/29 11:37:17]

As it is, the update manifest is IE specific, we won't have 32-bit/64-bit
variants for Android e.g. A more generic solution would be nice, but then again,
IE is the only special case we have here how I see it. Coming up with something
generic for a single use case doesn't seem wise.

     else:
       manifestPath = os.path.join(baseDir, "update.rdf")
       templateName = 'geckoUpdateManifest'
 
     template = get_template(get_config().get('extensions', templateName))
     template.stream({'extensions': [self]}).dump(manifestPath)
 
-  def writeLibabpUpdateManifest(self, updates):

[Wladimir Palant, 2014/07/29 11:25:18]

Why did you remove this function? Are you going to duplicate the logic for
Android updates?

[Felix Dahlke, 2014/07/29 11:37:17]

Do we need special logic for Android here? How I see it, we could simply replace
the current update.xml template by an Android-specific update.json template when
we switch to libadblockplus-style manifests.

-    """
-      Writes update.json file for libadblockplus
-    """
-    baseDir = os.path.join(self.config.nightliesDirectory, self.basename)
-    if not os.path.exists(baseDir):
-      os.makedirs(baseDir)
-    manifestPath = os.path.join(baseDir, "update.json")
-
-    handle = codecs.open(manifestPath, "wb", encoding="UTF-8")
-    json.dump(updates, handle, ensure_ascii=False, indent=2, separators=(",", ": "))
-    handle.close()
-
   def writeIEUpdateManifest(self, versions):
     """
       Writes update.json file for the latest IE build
     """
     if len(versions) == 0:
       return
 
-    version = versions[0]
-    packageName = self.basename + '-' + versions[0] + self.config.packageSuffix
-    updateURL = urlparse.urljoin(self.config.nightliesURL, self.basename + '/' + packageName + '?update')
-    self.writeLibabpUpdateManifest({
-      "%s/%s" % (self.basename, "msie64"): {
-        "url": updateURL.replace(".exe", "-x64.msi"),
-        "version": version,
-      },
-      "%s/%s" % (self.basename, "msie32"): {
-        "url": updateURL.replace(".exe", "-x86.msi"),
-        "version": version,
-      },
-    })
+    baseDir = os.path.join(self.config.nightliesDirectory, self.basename)
+    if not os.path.exists(baseDir):
+      os.makedirs(baseDir)
 
-    baseDir = os.path.join(self.config.nightliesDirectory, self.basename)
+    self.version = versions[0]

[Wladimir Palant, 2014/07/29 11:25:18]

This function shouldn't set any instance variables - it is a write function, it
shouldn't have any side-effects.

[Felix Dahlke, 2014/07/29 11:37:17]

True, it's a hack. How about I move this part to where we set self.basename for
IE below?

[Wladimir Palant, 2014/07/29 12:03:10]

Yes, that would make sense.

+    packageName = self.basename + '-' + self.version + self.config.packageSuffix
+    self.updateURL = urlparse.urljoin(self.config.nightliesURL, self.basename +
+                                      '/' + packageName + '?update')
+    self.name = self.basename
+    self.writeUpdateManifest()
+
     for suffix in (self.config.packageSuffix, self.config.packageSuffix.replace("-x64", "-x86")):
       linkPath = os.path.join(baseDir, '00latest%s' % suffix)
-      outputPath = os.path.join(baseDir, self.basename + '-' + versions[0] + suffix)
+      outputPath = os.path.join(baseDir, self.basename + '-' + self.version + suffix)
       if hasattr(os, 'symlink'):
         if os.path.exists(linkPath):
           os.remove(linkPath)
         os.symlink(os.path.basename(outputPath), linkPath)
       else:
         shutil.copyfile(outputPath, linkPath)
 
-
   def build(self):
     """
       run the build command in the tempdir
     """
     baseDir = os.path.join(self.config.nightliesDirectory, self.basename)
     if not os.path.exists(baseDir):
       os.makedirs(baseDir)
     outputFile = "%s-%s%s" % (self.basename, self.version, self.config.packageSuffix)
     self.path = os.path.join(baseDir, outputFile)
     self.updateURL = urlparse.urljoin(self.config.nightliesURL, self.basename + '/' + outputFile + '?update')
@@ skipping 242 matching lines @@
     except Exception, ex:
       print >>sys.stderr, "The build for %s failed:" % repo
       traceback.print_exc()
 
   file = open(nightlyConfigFile, 'wb')
   nightlyConfig.write(file)
 
 
 if __name__ == '__main__':
   main()