Changes to Chrome build process

packagerChrome.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus build tools,
 # Copyright (C) 2006-2012 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 61 matching lines @@
   if metadata.has_option('general', 'icons'):
     icons = {}
     iconsDir = baseDir
     for dir in metadata.get('general', 'icons').split('/')[0:-1]:
       iconsDir = os.path.join(iconsDir, dir)
 
     prefix, suffix = metadata.get('general', 'icons').split('/')[-1].split('?', 1)
     for file in os.listdir(iconsDir):
       path = os.path.join(iconsDir, file)
       if os.path.isfile(path) and file.startswith(prefix) and file.endswith(suffix):
         size = file[len(prefix):-len(suffix)]

[Felix Dahlke, 2013/01/11 12:24:16]

How about using a regex here?

if os.path.isfile(path):
  match = re.match(prefix + r'(.*)' + suffix, file)
  if match:
    size = match.group(0)

It's a bit longer vertically, but I bet easier to maintain. Your call.

[Wladimir Palant, 2013/01/11 14:45:39]

As soon as we add the required escaping (prefix and suffix can be anything,
could include special characters like e.g. ".") and the missing ^ and $ things
won't be simple at all any more. No, regexps are a pretty bad choice if you need
to do string comparison.

[Felix Dahlke, 2013/01/11 14:47:55]

Right, forgot about the escaping. I suppose it's better this way.

         if not re.search(r'\D', size):
           icons[size] = os.path.relpath(path, baseDir).replace('\\', '/')
 
     templateData['icons'] = icons
 
   if metadata.has_option('general', 'permissions'):
     templateData['permissions'] = re.split(r'\s+', metadata.get('general', 'permissions'))
     if params['experimentalAPI']:
       templateData['permissions'].append('experimental')
 
   if metadata.has_option('general', 'backgroundScripts'):
     templateData['backgroundScripts'] = re.split(r'\s+', metadata.get('general', 'backgroundScripts'))
+    if params['devenv']:
+      templateData['backgroundScripts'].append('devenvPoller__.js')
 
   if metadata.has_option('general', 'webAccessible'):
     templateData['webAccessible'] = re.split(r'\s+', metadata.get('general', 'webAccessible'))
 
   if metadata.has_section('contentScripts'):
     contentScripts = []
     for run_at, scripts in metadata.items('contentScripts'):
       contentScripts.append({
         'matches': ['http://*/*', 'https://*/*'],
         'js': re.split(r'\s+', scripts),
         'run_at': run_at,
         'all_frames': True,
       })
     templateData['contentScripts'] = contentScripts
 
   manifest = template.render(templateData)
 
   # Normalize JSON structure
   licenseComment = re.compile(r'/\*.*?\*/', re.S)
   data = json.loads(re.sub(licenseComment, '', manifest, 1))
   if '_dummy' in data:
     del data['_dummy']
   manifest = json.dumps(data, sort_keys=True, indent=2)
 
   return manifest.encode('utf-8')
+
+def createPoller(params):
+  env = jinja2.Environment(loader=jinja2.FileSystemLoader(buildtools.__path__[0]))
+  env.filters.update({'json': json.dumps})
+  template = env.get_template('chromeDevenvPoller__.js.tmpl')
+  return template.render(params).encode('utf-8');
 
 def readFile(params, files, path):
   ignoredFiles = getIgnoredFiles(params)
   if os.path.isdir(path):
     for file in os.listdir(path):
       if file in ignoredFiles:
         continue
       readFile(params, files, os.path.join(path, file))
   else:
     file = open(path, 'rb')
     data = file.read()
     file.close()
 
     name = os.path.relpath(path, params['baseDir']).replace('\\', '/')
     files[name] = data
 
 def convertJS(params, files):
+  from jshydra.abp_rewrite import doRewrite
   baseDir = params['baseDir']
-  hydraDir = os.path.join(baseDir, 'jshydra')
-  sys.path.append(hydraDir)
-  try:
-    import abp_rewrite
-    for file, sources in params['metadata'].items('convert_js'):
-      dirsep = file.find('/')
-      if dirsep >= 0:
-        # Not a top-level file, make sure it is inside an included director
-        dirname = file[0:dirsep]
-        if os.path.join(baseDir, dirname) not in getPackageFiles(params):
-          continue
-
-      sourceFiles = re.split(r'\s+', sources)
-      args = []
-      try:
-        argsStart = sourceFiles.index('--arg')
-        args = sourceFiles[argsStart + 1:]
-        sourceFiles = sourceFiles[0:argsStart]
-      except ValueError:
-        pass
-
-      sourceFiles = map(lambda f: os.path.abspath(os.path.join(baseDir, f)), sourceFiles)
-      files[file] = abp_rewrite.doRewrite(sourceFiles, args)
-  finally:
-    sys.path.remove(hydraDir)
+
+  for file, sources in params['metadata'].items('convert_js'):
+    dirsep = file.find('/')
+    if dirsep >= 0:
+      # Not a top-level file, make sure it is inside an included directory
+      dirname = file[0:dirsep]
+      if os.path.join(baseDir, dirname) not in getPackageFiles(params):
+        continue
+
+    sourceFiles = re.split(r'\s+', sources)
+    args = []
+    try:
+      argsStart = sourceFiles.index('--arg')
+      args = sourceFiles[argsStart + 1:]
+      sourceFiles = sourceFiles[0:argsStart]
+    except ValueError:
+      pass
+
+    sourceFiles = map(lambda f: os.path.abspath(os.path.join(baseDir, f)), sourceFiles)
+    files[file] = doRewrite(sourceFiles, args)
 
 def packFiles(files):
   buffer = StringIO()
   zip = ZipFile(buffer, 'w', ZIP_DEFLATED)
   for file, data in files.iteritems():
     zip.writestr(file, data)
   zip.close()
   return buffer.getvalue()
 
 def signBinary(zipdata, keyFile):
@@ skipping 42 matching lines @@
     'devenv': devenv,
     'metadata': metadata,
   }
 
   files = {}
   files['manifest.json'] = createManifest(params)
   for path in getPackageFiles(params):
     if os.path.exists(path):
       readFile(params, files, path)
 
-  if metadata.has_section('convert_js') and os.path.isdir(os.path.join(baseDir, 'jshydra')):
+  if metadata.has_section('convert_js'):
     convertJS(params, files)
+
+  if devenv:
+    files['devenvPoller__.js'] = createPoller(params)
 
   zipdata = packFiles(files)
   signature = None
   pubkey = None
   if keyFile != None:
     signature = signBinary(zipdata, keyFile)
     pubkey = getPublicKey(keyFile)
   writePackage(outFile, pubkey, signature, zipdata)
 
 def createDevEnv(baseDir):
   fileBuffer = StringIO()
   createBuild(baseDir, outFile=fileBuffer, devenv=True, releaseBuild=True)
   zip = ZipFile(StringIO(fileBuffer.getvalue()), 'r')
   zip.extractall(os.path.join(baseDir, 'devenv'))
   zip.close()
+
+  print 'Development environment created, waiting for connections from active extensions...'
+  metadata = readMetadata(baseDir)
+  connections = [0]
+
+  import SocketServer, time, thread
+
+  class ConnectionHandler(SocketServer.BaseRequestHandler):
+    def handle(self):
+      connections[0] += 1
+      self.request.sendall('HTTP/1.0 OK\nConnection: close\n\n%s' % metadata.get('general', 'basename'))
+
+  server = SocketServer.TCPServer(('localhost', 43816), ConnectionHandler)
+
+  def shutdown_server(server):
+    time.sleep(10)
+    server.shutdown()
+  thread.start_new_thread(shutdown_server, (server,))
+  server.serve_forever()
+
+  if connections[0] == 0:
+    print 'Warning: No incoming connections, extension probably not active in the browser yet'
+  else:
+    print 'Handled %i connection(s)' % connections[0]