Issue 356 - Update devbuild in the Chrome Web Store

sitescripts/extensions/bin/createNightlies.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # 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/>.
 
 """
 
 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 tempfile, re, shutil, urlparse, pipes, time, base64
+import tempfile, re, shutil, urlparse, pipes, time, urllib2, struct
 from datetime import datetime
 from urllib import urlencode
-from urllib2 import urlopen
 from xml.dom.minidom import parse as parseXml
 from sitescripts.utils import get_config, setupStderr, get_template
 from sitescripts.extensions.utils import compareVersions, Configuration
 
 MAX_BUILDS = 50
 
 
 class NightlyBuild(object):
   """
     Performs the build process for an extension,
@@ skipping 345 matching lines @@
     subprocess.check_call(command)
 
     try:
       import buildtools.build as build
       outputPath = os.path.join(self.config.docsDirectory, self.basename)
       build.generateDocs(self.tempdir, None, [("-t", docsdir), ("-q", "")], [outputPath], self.config.type)
     finally:
       shutil.rmtree(docsdir, ignore_errors=True)
 
   def uploadToChromeWebStore(self):
-    import M2Crypto
-
-    # log in with the Google Developer Service Account
-    # https://developers.google.com/accounts/docs/OAuth2ServiceAccount#creatingjwt
-
-    base64encode = lambda data: base64.urlsafe_b64encode(data).rstrip('=')
-    now = int(time.mktime(time.gmtime()))
-
-    jwt = '%s.%s' % (
-      base64encode(json.dumps({
-        'alg': 'RS256',
-        'typ': 'JWT',
-      })),
-      base64encode(json.dumps({
-         'iss': self.config.serviceAccountEmail,
-         'scope': 'https://www.googleapis.com/auth/chromewebstore',
-         'aud':'https://accounts.google.com/o/oauth2/token',
-         'exp': now + 3600, # fails if less than about an hour
-         'iat': now,
-      })),
-    )
-
-    jwt = '%s.%s' % (jwt, base64encode(
-      M2Crypto.RSA.load_key(self.config.serviceAccountKey).sign(
-        hashlib.sha256(jwt).digest(), 'sha256'
-      )
-    ))
-
-    response = json.load(urlopen(
+    # use refresh token to obtain a valid access token
+    # https://developers.google.com/accounts/docs/OAuth2WebServer#refresh
+
+    response = json.load(urllib2.urlopen(
       'https://accounts.google.com/o/oauth2/token',
 
       urlencode([
-        ('grant_type', 'urn:ietf:params:oauth:grant-type:jwt-bearer'),
-        ('assertion', jwt),
+        ('refresh_token', self.config.refreshToken),
+        ('client_id', self.config.clientID),
+        ('client_secret', self.config.clientSecret),
+        ('grant_type', 'refresh_token'),
       ])
     ))

[Wladimir Palant, 2014/04/20 06:47:53]

Check for error responses?

[Sebastian Noack, 2014/04/20 16:03:08]

This API uses standard HTTP  error codes, which are automatically converted into
Python exceptions by urllib2.

 
     # upload a new version with the Chrome Web Store API
     # https://developer.chrome.com/webstore/using_webstore_api#uploadexisitng
 
-    subprocess.check_call([

[Sebastian Noack, 2014/04/19 16:15:34]

I use curl instead of urllib here, because urllib doesn't support file uploads.

[Wladimir Palant, 2014/04/20 06:47:53]

We do file uploads with urllib in buildtools/localeTools.py - not pretty but
better than calling an external application.

[Sebastian Noack, 2014/04/20 16:03:08]

It was actually easier to use urllib2 as I thought, since the API doesn't
actually require a multipart request.

-      'curl', 'https://www.googleapis.com/upload/chromewebstore/v1.1/items/' + self.config.galleryID
-
-      '--header', 'Authorization: %s %s' % (response['token_type'], response['access_token'])
-      '--header', 'x-goog-api-version: 2',
-      '--request',  'PUT',
-      '--upload-file', self.path,
-      '--silent',
-    ])

[Wladimir Palant, 2014/04/20 06:47:53]

Here as well - please check for error responses, if something goes wrong we
should know.

[Sebastian Noack, 2014/04/20 16:03:08]

Done.

+    request = urllib2.Request('https://www.googleapis.com/upload/chromewebstore/v1.1/items/' + self.config.galleryID)
+    request.get_method = lambda: 'PUT'
+    request.add_header('Authorization', '%s %s' % (response['token_type'], response['access_token']))
+    request.add_header('x-goog-api-version', '2')
+
+    with open(self.path, 'rb') as file:
+      if file.read(8) != 'Cr24\x02\x00\x00\x00':
+        raise Exception('not a chrome extension or unknown CRX version')
+
+      # skip public key and signature
+      file.seek(sum(struct.unpack('<II', file.read(8))), os.SEEK_CUR)
+
+      request.add_header('Content-Length', os.fstat(file.fileno()).st_size - file.tell())
+      request.add_data(file)
+
+      response = json.load(urllib2.urlopen(request))
+
+    if response['uploadState'] == 'FAILURE':
+      raise Exception(response['itemError'])
 
   def run(self):
     """
       Run the nightly build process for one extension
     """
     try:
       if self.config.type == 'ie':
         # We cannot build IE builds, simply list the builds already in
         # the directory. Basename has to be deduced from the repository name.
         self.basename = os.path.basename(self.config.repository)
@@ skipping 28 matching lines @@
 
       if self.config.type == 'ie':
         self.writeIEUpdateManifest(versions)
 
       # update index page
       self.updateIndex(versions)
 
       # update nightlies config
       self.config.latestRevision = self.revision
 
-      if self.config.type == 'chrome':

[Wladimir Palant, 2014/04/20 06:47:53]

This step needs to be optional, only if the necessary config options are present
- it should be possible to test things locally without triggering an upload
every time.

[Sebastian Noack, 2014/04/20 16:03:08]

Done.

+      if self.type == 'chrome' and self.config.clientID and self.config.clientSecret and self.config.refreshToken:
         self.uploadToChromeWebStore()
     finally:
       # clean up
       if self.tempdir:
         shutil.rmtree(self.tempdir, ignore_errors=True)
 
 
 def main():
   """
     main function for createNightlies.py
@@ skipping 17 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()