remoting/webapp/build-webapp.py

   1 #!/usr/bin/env python
   2 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
   3 # Use of this source code is governed by a BSD-style license that can be
   4 # found in the LICENSE file.
   5
   6 """Creates a directory with with the unpacked contents of the remoting webapp.
   7
   8 The directory will contain a copy-of or a link-to to all remoting webapp
   9 resources.  This includes HTML/JS and any plugin binaries. The script also
  10 massages resulting files appropriately with host plugin data. Finally,
  11 a zip archive for all of the above is produced.
  12 """
  13
  14 # Python 2.5 compatibility
  15 from __future__ import with_statement
  16
  17 import argparse
  18 import io
  19 import os
  20 import platform
  21 import re
  22 import shutil
  23 import subprocess
  24 import sys
  25 import time
  26 import zipfile
  27
  28 # Update the module path, assuming that this script is in src/remoting/webapp,
  29 # and that the google_api_keys module is in src/google_apis. Note that
  30 # sys.path[0] refers to the directory containing this script.
  31 if __name__ == '__main__':
  32   sys.path.append(
  33       os.path.abspath(os.path.join(sys.path[0], '../../google_apis')))
  34 import google_api_keys
  35
  36
  37 def findAndReplace(filepath, findString, replaceString):
  38   """Does a search and replace on the contents of a file."""
  39   oldFilename = os.path.basename(filepath) + '.old'
  40   oldFilepath = os.path.join(os.path.dirname(filepath), oldFilename)
  41   os.rename(filepath, oldFilepath)
  42   with open(oldFilepath) as input:
  43     with open(filepath, 'w') as output:
  44       for s in input:
  45         output.write(s.replace(findString, replaceString))
  46   os.remove(oldFilepath)
  47
  48
  49 def createZip(zip_path, directory):
  50   """Creates a zipfile at zip_path for the given directory."""
  51   zipfile_base = os.path.splitext(os.path.basename(zip_path))[0]
  52   zip = zipfile.ZipFile(zip_path, 'w', zipfile.ZIP_DEFLATED)
  53   for (root, dirs, files) in os.walk(directory):
  54     for f in files:
  55       full_path = os.path.join(root, f)
  56       rel_path = os.path.relpath(full_path, directory)
  57       zip.write(full_path, os.path.join(zipfile_base, rel_path))
  58   zip.close()
  59
  60
  61 def replaceString(destination, placeholder, value):
  62   findAndReplace(os.path.join(destination, 'plugin_settings.js'),
  63                  "'" + placeholder + "'", "'" + value + "'")
  64
  65
  66 def replaceBool(destination, placeholder, value):
  67   # Look for a "!!" in the source code so the expession we're
  68   # replacing looks like a boolean to the compiler.  A single "!"
  69   # would satisfy the compiler but might confused human readers.
  70   findAndReplace(os.path.join(destination, 'plugin_settings.js'),
  71                  "!!'" + placeholder + "'", 'true' if value else 'false')
  72
  73
  74 def parseBool(boolStr):
  75   """Tries to parse a string as a boolean value.
  76
  77   Returns a bool on success; raises ValueError on failure.
  78   """
  79   lower = boolStr.tolower()
  80   if lower in ['0', 'false']: return False
  81   if lower in ['1', 'true']: return True
  82   raise ValueError('not a boolean string {!r}'.format(boolStr))
  83
  84
  85 def getenvBool(name, defaultValue):
  86   """Gets an environment value as a boolean."""
  87   rawValue = os.environ.get(name)
  88   if rawValue is None:
  89     return defaultValue
  90   try:
  91     return parseBool(rawValue)
  92   except ValueError:
  93     raise Exception('Value of ${} must be boolean!'.format(name))
  94
  95
  96 def processJinjaTemplate(input_file, include_paths, output_file, context):
  97   jinja2_path = os.path.normpath(
  98       os.path.join(os.path.abspath(__file__),
  99                    '../../../third_party/jinja2'))
 100   sys.path.append(os.path.split(jinja2_path)[0])
 101   import jinja2
 102   (template_path, template_name) = os.path.split(input_file)
 103   include_paths = [template_path] + include_paths
 104   env = jinja2.Environment(loader=jinja2.FileSystemLoader(include_paths))
 105   template = env.get_template(template_name)
 106   rendered = template.render(context)
 107   io.open(output_file, 'w', encoding='utf-8').write(rendered)
 108
 109 def buildWebApp(buildtype, version, destination, zip_path,
 110                 manifest_template, webapp_type, appid, app_client_id, app_name,
 111                 app_description, app_capabilities, manifest_key, files,
 112                 files_listfile, locales_listfile, jinja_paths,
 113                 service_environment, use_gcd):
 114   """Does the main work of building the webapp directory and zipfile.
 115
 116   Args:
 117     buildtype: the type of build ("Official", "Release" or "Dev").
 118     destination: A string with path to directory where the webapp will be
 119                  written.
 120     zipfile: A string with path to the zipfile to create containing the
 121              contents of |destination|.
 122     manifest_template: jinja2 template file for manifest.
 123     webapp_type: webapp type ("v1", "v2", "v2_pnacl" or "app_remoting").
 124     appid: A string with the Remoting Application Id (only used for app
 125            remoting webapps). If supplied, it defaults to using the
 126            test API server.
 127     app_client_id: The OAuth2 client ID for the webapp.
 128     app_name: A string with the name of the application.
 129     app_description: A string with the description of the application.
 130     app_capabilities: A set of strings naming the capabilities that should be
 131                       enabled for this application.
 132     manifest_key: The manifest key for the webapp.
 133     files: An array of strings listing the paths for resources to include
 134            in this webapp.
 135     files_listfile: The name of a file containing a list of files, one per
 136                     line, identifying the resources to include in this webapp.
 137                     This is an alternate to specifying the files directly via
 138                     the 'files' option. The files listed in this file are
 139                     appended to the files passed via the 'files' option, if any.
 140     locales_listfile: The name of a file containing a list of locales, one per
 141                       line, which are copied, along with their directory
 142                       structure, from the _locales directory down.
 143     jinja_paths: An array of paths to search for {%include} directives in
 144                  addition to the directory containing the manifest template.
 145     service_environment: Used to point the webapp to one of the
 146                          dev/test/staging/prod/prod-testing environments
 147     use_gcd: True if GCD support should be enabled.
 148   """
 149
 150   # Load the locales files from the locales_listfile.
 151   if not locales_listfile:
 152     raise Exception('You must specify a locales_listfile')
 153   locales = []
 154   with open(locales_listfile) as input:
 155     for s in input:
 156       locales.append(s.rstrip())
 157
 158   # Load the files from the files_listfile.
 159   if files_listfile:
 160     with open(files_listfile) as input:
 161       for s in input:
 162         files.append(s.rstrip())
 163
 164   # Ensure a fresh directory.
 165   try:
 166     shutil.rmtree(destination)
 167   except OSError:
 168     if os.path.exists(destination):
 169       raise
 170     else:
 171       pass
 172   os.mkdir(destination, 0775)
 173
 174   if buildtype != 'Official' and buildtype != 'Release' and buildtype != 'Dev':
 175     raise Exception('Unknown buildtype: ' + buildtype)
 176
 177   jinja_context = {
 178     'webapp_type': webapp_type,
 179     'buildtype': buildtype,
 180   }
 181
 182   # Copy all the files.
 183   for current_file in files:
 184     destination_file = os.path.join(destination, os.path.basename(current_file))
 185
 186     # Process *.jinja2 files as jinja2 templates
 187     if current_file.endswith(".jinja2"):
 188       destination_file = destination_file[:-len(".jinja2")]
 189       processJinjaTemplate(current_file, jinja_paths,
 190                            destination_file, jinja_context)
 191     else:
 192       shutil.copy2(current_file, destination_file)
 193
 194   # Copy all the locales, preserving directory structure
 195   destination_locales = os.path.join(destination, '_locales')
 196   os.mkdir(destination_locales, 0775)
 197   remoting_locales = os.path.join(destination, 'remoting_locales')
 198   os.mkdir(remoting_locales, 0775)
 199   for current_locale in locales:
 200     extension = os.path.splitext(current_locale)[1]
 201     if extension == '.json':
 202       locale_id = os.path.split(os.path.split(current_locale)[0])[1]
 203       destination_dir = os.path.join(destination_locales, locale_id)
 204       destination_file = os.path.join(destination_dir,
 205                                       os.path.split(current_locale)[1])
 206       os.mkdir(destination_dir, 0775)
 207       shutil.copy2(current_locale, destination_file)
 208     elif extension == '.pak':
 209       destination_file = os.path.join(remoting_locales,
 210                                       os.path.split(current_locale)[1])
 211       shutil.copy2(current_locale, destination_file)
 212     else:
 213       raise Exception('Unknown extension: ' + current_locale)
 214
 215   # Set client plugin type.
 216   # TODO(wez): Use 'native' in app_remoting until b/17441659 is resolved.
 217   client_plugin = 'pnacl' if webapp_type == 'v2_pnacl' else 'native'
 218   findAndReplace(os.path.join(destination, 'plugin_settings.js'),
 219                  "'CLIENT_PLUGIN_TYPE'", "'" + client_plugin + "'")
 220
 221   # Allow host names for google services/apis to be overriden via env vars.
 222   oauth2AccountsHost = os.environ.get(
 223       'OAUTH2_ACCOUNTS_HOST', 'https://accounts.google.com')
 224   oauth2ApiHost = os.environ.get(
 225       'OAUTH2_API_HOST', 'https://www.googleapis.com')
 226   directoryApiHost = os.environ.get(
 227       'DIRECTORY_API_HOST', 'https://www.googleapis.com')
 228
 229   is_app_remoting_webapp = webapp_type == 'app_remoting'
 230   is_prod_service_environment = service_environment == 'prod' or \
 231                                 service_environment == 'prod-testing'
 232   if is_app_remoting_webapp:
 233     appRemotingApiHost = os.environ.get(
 234         'APP_REMOTING_API_HOST', None)
 235     appRemotingApplicationId = os.environ.get(
 236         'APP_REMOTING_APPLICATION_ID', None)
 237
 238     # Release/Official builds are special because they are what we will upload
 239     # to the web store.  The checks below will validate that prod builds are
 240     # being generated correctly (no overrides) and with the correct buildtype.
 241     # They also verify that folks are not accidentally building dev/test/staging
 242     # apps for release (no impersonation) instead of dev.
 243     if is_prod_service_environment and buildtype == 'Dev':
 244       raise Exception("Prod environment cannot be built for 'dev' builds")
 245
 246     if buildtype != 'Dev':
 247       if not is_prod_service_environment:
 248         raise Exception('Invalid service_environment targeted for '
 249                         + buildtype + ': ' + service_environment)
 250       if 'out/Release' not in destination and 'out\Release' not in destination:
 251         raise Exception('Prod builds must be placed in the out/Release folder')
 252       if appid != None:
 253         raise Exception('Cannot pass in an appid for '
 254                         + buildtype + ' builds: ' + service_environment)
 255       if appRemotingApiHost != None:
 256         raise Exception('Cannot set APP_REMOTING_API_HOST env var for '
 257                         + buildtype + ' builds')
 258       if appRemotingApplicationId != None:
 259         raise Exception('Cannot set APP_REMOTING_APPLICATION_ID env var for '
 260                         + buildtype + ' builds')
 261
 262     # If an Application ID was set (either from service_environment variable or
 263     # from a command line argument), hardcode it, otherwise get it at runtime.
 264     effectiveAppId = appRemotingApplicationId or appid
 265     if effectiveAppId:
 266       appRemotingApplicationId = "'" + effectiveAppId + "'"
 267     else:
 268       appRemotingApplicationId = "chrome.i18n.getMessage('@@extension_id')"
 269     findAndReplace(os.path.join(destination, 'plugin_settings.js'),
 270                    "'APP_REMOTING_APPLICATION_ID'", appRemotingApplicationId)
 271
 272   oauth2BaseUrl = oauth2AccountsHost + '/o/oauth2'
 273   oauth2ApiBaseUrl = oauth2ApiHost + '/oauth2'
 274   directoryApiBaseUrl = directoryApiHost + '/chromoting/v1'
 275
 276   if is_app_remoting_webapp:
 277     # Set the apiary endpoint and then set the endpoint version
 278     if not appRemotingApiHost:
 279       if is_prod_service_environment:
 280         appRemotingApiHost = 'https://www.googleapis.com'
 281       else:
 282         appRemotingApiHost = 'https://www-googleapis-test.sandbox.google.com'
 283
 284     if service_environment == 'dev':
 285       appRemotingServicePath = '/appremoting/v1beta1_dev'
 286     elif service_environment == 'test':
 287       appRemotingServicePath = '/appremoting/v1beta1'
 288     elif service_environment == 'staging':
 289       appRemotingServicePath = '/appremoting/v1beta1_staging'
 290     elif service_environment == 'prod':
 291       appRemotingServicePath = '/appremoting/v1beta1'
 292     elif service_environment == 'prod-testing':
 293       appRemotingServicePath = '/appremoting/v1beta1_prod_testing'
 294     else:
 295       raise Exception('Unknown service environment: ' + service_environment)
 296     appRemotingApiBaseUrl = appRemotingApiHost + appRemotingServicePath
 297   else:
 298     appRemotingApiBaseUrl = ''
 299
 300   replaceBool(destination, 'USE_GCD', use_gcd)
 301   replaceString(destination, 'OAUTH2_BASE_URL', oauth2BaseUrl)
 302   replaceString(destination, 'OAUTH2_API_BASE_URL', oauth2ApiBaseUrl)
 303   replaceString(destination, 'DIRECTORY_API_BASE_URL', directoryApiBaseUrl)
 304   if is_app_remoting_webapp:
 305     replaceString(destination, 'APP_REMOTING_API_BASE_URL',
 306                   appRemotingApiBaseUrl)
 307
 308   # Substitute hosts in the manifest's CSP list.
 309   # Ensure we list the API host only once if it's the same for multiple APIs.
 310   googleApiHosts = ' '.join(set([oauth2ApiHost, directoryApiHost]))
 311
 312   # WCS and the OAuth trampoline are both hosted on talkgadget. Split them into
 313   # separate suffix/prefix variables to allow for wildcards in manifest.json.
 314   talkGadgetHostSuffix = os.environ.get(
 315       'TALK_GADGET_HOST_SUFFIX', 'talkgadget.google.com')
 316   talkGadgetHostPrefix = os.environ.get(
 317       'TALK_GADGET_HOST_PREFIX', 'https://chromoting-client.')
 318   oauth2RedirectHostPrefix = os.environ.get(
 319       'OAUTH2_REDIRECT_HOST_PREFIX', 'https://chromoting-oauth.')
 320
 321   # Use a wildcard in the manifest.json host specs if the prefixes differ.
 322   talkGadgetHostJs = talkGadgetHostPrefix + talkGadgetHostSuffix
 323   talkGadgetBaseUrl = talkGadgetHostJs + '/talkgadget/'
 324   if talkGadgetHostPrefix == oauth2RedirectHostPrefix:
 325     talkGadgetHostJson = talkGadgetHostJs
 326   else:
 327     talkGadgetHostJson = 'https://*.' + talkGadgetHostSuffix
 328
 329   # Set the correct OAuth2 redirect URL.
 330   oauth2RedirectHostJs = oauth2RedirectHostPrefix + talkGadgetHostSuffix
 331   oauth2RedirectHostJson = talkGadgetHostJson
 332   oauth2RedirectPath = '/talkgadget/oauth/chrome-remote-desktop'
 333   oauth2RedirectBaseUrlJs = oauth2RedirectHostJs + oauth2RedirectPath
 334   oauth2RedirectBaseUrlJson = oauth2RedirectHostJson + oauth2RedirectPath
 335   if buildtype == 'Official':
 336     oauth2RedirectUrlJs = ("'" + oauth2RedirectBaseUrlJs +
 337                            "/rel/' + chrome.i18n.getMessage('@@extension_id')")
 338     oauth2RedirectUrlJson = oauth2RedirectBaseUrlJson + '/rel/*'
 339   else:
 340     oauth2RedirectUrlJs = "'" + oauth2RedirectBaseUrlJs + "/dev'"
 341     oauth2RedirectUrlJson = oauth2RedirectBaseUrlJson + '/dev*'
 342   thirdPartyAuthUrlJs = oauth2RedirectBaseUrlJs + '/thirdpartyauth'
 343   thirdPartyAuthUrlJson = oauth2RedirectBaseUrlJson + '/thirdpartyauth*'
 344   replaceString(destination, 'TALK_GADGET_URL', talkGadgetBaseUrl)
 345   findAndReplace(os.path.join(destination, 'plugin_settings.js'),
 346                  "'OAUTH2_REDIRECT_URL'", oauth2RedirectUrlJs)
 347
 348   # Configure xmpp server and directory bot settings in the plugin.
 349   replaceBool(
 350       destination, 'XMPP_SERVER_USE_TLS',
 351       getenvBool('XMPP_SERVER_USE_TLS', True))
 352   xmppServer = os.environ.get('XMPP_SERVER',
 353                                'talk.google.com:443')
 354   replaceString(destination, 'XMPP_SERVER', xmppServer)
 355   replaceString(destination, 'DIRECTORY_BOT_JID',
 356                 os.environ.get('DIRECTORY_BOT_JID',
 357                                'remoting@bot.talk.google.com'))
 358   replaceString(destination, 'THIRD_PARTY_AUTH_REDIRECT_URL',
 359                 thirdPartyAuthUrlJs)
 360
 361   # Set the correct API keys.
 362   # For overriding the client ID/secret via env vars, see google_api_keys.py.
 363   apiClientId = google_api_keys.GetClientID('REMOTING')
 364   apiClientSecret = google_api_keys.GetClientSecret('REMOTING')
 365   apiKey = google_api_keys.GetAPIKeyRemoting()
 366
 367   if is_app_remoting_webapp and buildtype != 'Dev':
 368     if not app_client_id:
 369       raise Exception('Invalid app_client_id passed in: "' +
 370           app_client_id + '"')
 371     apiClientIdV2 = app_client_id + '.apps.googleusercontent.com'
 372   else:
 373     apiClientIdV2 = google_api_keys.GetClientID('REMOTING_IDENTITY_API')
 374
 375   replaceString(destination, 'API_CLIENT_ID', apiClientId)
 376   replaceString(destination, 'API_CLIENT_SECRET', apiClientSecret)
 377   replaceString(destination, 'API_KEY', apiKey)
 378
 379   # Write the application capabilities.
 380   appCapabilities = ','.join(
 381       ['remoting.ClientSession.Capability.' + x for x in app_capabilities])
 382   findAndReplace(os.path.join(destination, 'app_capabilities.js'),
 383                  "'APPLICATION_CAPABILITIES'", appCapabilities)
 384
 385   # Use a consistent extension id for dev builds.
 386   # AppRemoting builds always use the dev app id - the correct app id gets
 387   # written into the manifest later.
 388   if is_app_remoting_webapp:
 389     if buildtype != 'Dev':
 390       if not manifest_key:
 391         raise Exception('Invalid manifest_key passed in: "' +
 392             manifest_key + '"')
 393       manifestKey = '"key": "' + manifest_key + '",'
 394     else:
 395       manifestKey = '"key": "remotingdevbuild",'
 396   elif buildtype != 'Official':
 397     # TODO(joedow): Update the chromoting webapp GYP entries to include keys.
 398     manifestKey = '"key": "remotingdevbuild",'
 399   else:
 400     manifestKey = ''
 401
 402   # Generate manifest.
 403   if manifest_template:
 404     context = {
 405         'webapp_type': webapp_type,
 406         'FULL_APP_VERSION': version,
 407         'MANIFEST_KEY_FOR_UNOFFICIAL_BUILD': manifestKey,
 408         'OAUTH2_REDIRECT_URL': oauth2RedirectUrlJson,
 409         'TALK_GADGET_HOST': talkGadgetHostJson,
 410         'THIRD_PARTY_AUTH_REDIRECT_URL': thirdPartyAuthUrlJson,
 411         'REMOTING_IDENTITY_API_CLIENT_ID': apiClientIdV2,
 412         'OAUTH2_BASE_URL': oauth2BaseUrl,
 413         'OAUTH2_API_BASE_URL': oauth2ApiBaseUrl,
 414         'DIRECTORY_API_BASE_URL': directoryApiBaseUrl,
 415         'APP_REMOTING_API_BASE_URL': appRemotingApiBaseUrl,
 416         'OAUTH2_ACCOUNTS_HOST': oauth2AccountsHost,
 417         'GOOGLE_API_HOSTS': googleApiHosts,
 418         'APP_NAME': app_name,
 419         'APP_DESCRIPTION': app_description,
 420         'OAUTH_GDRIVE_SCOPE': '',
 421         'USE_GCD': use_gcd,
 422         'XMPP_SERVER': xmppServer,
 423     }
 424     if 'GOOGLE_DRIVE' in app_capabilities:
 425       context['OAUTH_GDRIVE_SCOPE'] = ('https://docs.google.com/feeds/ '
 426                                        'https://www.googleapis.com/auth/drive')
 427     processJinjaTemplate(manifest_template,
 428                          jinja_paths,
 429                          os.path.join(destination, 'manifest.json'),
 430                          context)
 431
 432   # Make the zipfile.
 433   createZip(zip_path, destination)
 434
 435   return 0
 436
 437
 438 def main():
 439   parser = argparse.ArgumentParser()
 440   parser.add_argument('buildtype')
 441   parser.add_argument('version')
 442   parser.add_argument('destination')
 443   parser.add_argument('zip_path')
 444   parser.add_argument('manifest_template')
 445   parser.add_argument('webapp_type')
 446   parser.add_argument('files', nargs='*', metavar='file', default=[])
 447   parser.add_argument('--app_name', metavar='NAME')
 448   parser.add_argument('--app_description', metavar='TEXT')
 449   parser.add_argument('--app_capabilities',
 450                       nargs='*', default=[], metavar='CAPABILITY')
 451   parser.add_argument('--appid')
 452   parser.add_argument('--app_client_id', default='')
 453   parser.add_argument('--manifest_key', default='')
 454   parser.add_argument('--files_listfile', default='', metavar='PATH')
 455   parser.add_argument('--locales_listfile', default='', metavar='PATH')
 456   parser.add_argument('--jinja_paths', nargs='*', default=[], metavar='PATH')
 457   parser.add_argument('--service_environment', default='', metavar='ENV')
 458   parser.add_argument('--use_gcd', choices=['0', '1'], default='0')
 459
 460   args = parser.parse_args()
 461   args.use_gcd = (args.use_gcd != '0')
 462   args.app_capabilities = set(args.app_capabilities)
 463   return buildWebApp(**vars(args))
 464
 465
 466 if __name__ == '__main__':
 467   sys.exit(main())