[AppRemoting] Break out AppRemoting shared module (re-land).

remoting/webapp/build-webapp.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Creates a directory with with the unpacked contents of the remoting webapp.
 
 The directory will contain a copy-of or a link-to to all remoting webapp
 resources.  This includes HTML/JS and any plugin binaries. The script also
 massages resulting files appropriately with host plugin data. Finally,
@@ skipping 102 matching lines @@
                 service_environment, use_gcd):
   """Does the main work of building the webapp directory and zipfile.
 
   Args:
     buildtype: the type of build ("Official", "Release" or "Dev").
     destination: A string with path to directory where the webapp will be
                  written.
     zipfile: A string with path to the zipfile to create containing the
              contents of |destination|.
     manifest_template: jinja2 template file for manifest.
-    webapp_type: webapp type ("v1", "v2", "v2_pnacl" or "app_remoting").
+    webapp_type: webapp type:
+                 For DesktopRemoting: "v1", "v2" or "v2_pnacl"
+                 For AppRemoting: "app_remoting" or "shared_module"
     appid: A string with the Remoting Application Id (only used for app
            remoting webapps). If supplied, it defaults to using the
            test API server.
     app_client_id: The OAuth2 client ID for the webapp.
     app_name: A string with the name of the application.
     app_description: A string with the description of the application.
     app_capabilities: A set of strings naming the capabilities that should be
                       enabled for this application.
     manifest_key: The manifest key for the webapp.
     files: An array of strings listing the paths for resources to include
@@ skipping 71 matching lines @@
                                       os.path.split(current_locale)[1])
       os.mkdir(destination_dir, 0775)
       shutil.copy2(current_locale, destination_file)
     elif extension == '.pak':
       destination_file = os.path.join(remoting_locales,
                                       os.path.split(current_locale)[1])
       shutil.copy2(current_locale, destination_file)
     else:
       raise Exception('Unknown extension: ' + current_locale)
 
+  is_app_remoting_webapp = webapp_type == 'app_remoting'
+  is_app_remoting_shared_module = webapp_type == 'shared_module'
+  is_app_remoting = is_app_remoting_webapp or is_app_remoting_shared_module
+  is_prod_service_environment = service_environment == 'vendor' or \
+                                service_environment == 'prod' or \
+                                service_environment == 'prod-testing'
+  is_desktop_remoting = not is_app_remoting
+
   # Set client plugin type.
   # TODO(wez): Use 'native' in app_remoting until b/17441659 is resolved.
-  client_plugin = 'pnacl' if webapp_type == 'v2_pnacl' else 'native'
-  findAndReplace(os.path.join(destination, 'plugin_settings.js'),
-                 "'CLIENT_PLUGIN_TYPE'", "'" + client_plugin + "'")
+  if not is_app_remoting_webapp:
+    client_plugin = 'pnacl' if webapp_type == 'v2_pnacl' else 'native'
+    findAndReplace(os.path.join(destination, 'plugin_settings.js'),
+                   "'CLIENT_PLUGIN_TYPE'", "'" + client_plugin + "'")
 
   # Allow host names for google services/apis to be overriden via env vars.
   oauth2AccountsHost = os.environ.get(
       'OAUTH2_ACCOUNTS_HOST', 'https://accounts.google.com')
   oauth2ApiHost = os.environ.get(
       'OAUTH2_API_HOST', 'https://www.googleapis.com')
   directoryApiHost = os.environ.get(
       'DIRECTORY_API_HOST', 'https://www.googleapis.com')
 
-  is_app_remoting_webapp = webapp_type == 'app_remoting'
-  is_prod_service_environment = service_environment == 'vendor' or \
-                                service_environment == 'prod' or \
-                                service_environment == 'prod-testing'
-  if is_app_remoting_webapp:
+  if is_app_remoting:
     appRemotingApiHost = os.environ.get(
         'APP_REMOTING_API_HOST', None)
     appRemotingApplicationId = os.environ.get(
         'APP_REMOTING_APPLICATION_ID', None)
 
     # Release/Official builds are special because they are what we will upload
     # to the web store.  The checks below will validate that prod builds are
     # being generated correctly (no overrides) and with the correct buildtype.
     # They also verify that folks are not accidentally building dev/test/staging
     # apps for release (no impersonation) instead of dev.
     if is_prod_service_environment and buildtype == 'Dev':
       raise Exception("Prod environment cannot be built for 'dev' builds")
 
     if buildtype != 'Dev':
       if not is_prod_service_environment:
         raise Exception('Invalid service_environment targeted for '
                         + buildtype + ': ' + service_environment)
       if appid != None:
         raise Exception('Cannot pass in an appid for '
                         + buildtype + ' builds: ' + service_environment)
       if appRemotingApiHost != None:
         raise Exception('Cannot set APP_REMOTING_API_HOST env var for '
                         + buildtype + ' builds')
       if appRemotingApplicationId != None:
         raise Exception('Cannot set APP_REMOTING_APPLICATION_ID env var for '
                         + buildtype + ' builds')
 
     # If an Application ID was set (either from service_environment variable or
     # from a command line argument), hardcode it, otherwise get it at runtime.
-    effectiveAppId = appRemotingApplicationId or appid
-    if effectiveAppId:
-      appRemotingApplicationId = "'" + effectiveAppId + "'"
-    else:
-      appRemotingApplicationId = "chrome.i18n.getMessage('@@extension_id')"
-    findAndReplace(os.path.join(destination, 'plugin_settings.js'),
-                   "'APP_REMOTING_APPLICATION_ID'", appRemotingApplicationId)
+    if is_app_remoting_webapp:
+      effectiveAppId = appRemotingApplicationId or appid
+      if effectiveAppId:
+        appRemotingApplicationId = "'" + effectiveAppId + "'"
+      else:
+        appRemotingApplicationId = "chrome.i18n.getMessage('@@extension_id')"
+      findAndReplace(os.path.join(destination, 'arv_main.js'),
+                     "'APP_REMOTING_APPLICATION_ID'", appRemotingApplicationId)
 
   oauth2BaseUrl = oauth2AccountsHost + '/o/oauth2'
   oauth2ApiBaseUrl = oauth2ApiHost + '/oauth2'
   directoryApiBaseUrl = directoryApiHost + '/chromoting/v1'
 
-  if is_app_remoting_webapp:
+  if is_app_remoting:
     # Set the apiary endpoint and then set the endpoint version
     if not appRemotingApiHost:
       if is_prod_service_environment:
         appRemotingApiHost = 'https://www.googleapis.com'
       else:
         appRemotingApiHost = 'https://www-googleapis-test.sandbox.google.com'
 
-    if service_environment == 'dev':
+    # TODO(garykac) Currently, the shared module is always set up for the
+    # dev service_environment. Update build so that the dev environment can
+    # be controlled by the app stub rather than hard-coded into the shared
+    # module.
+    if service_environment == 'dev' or is_app_remoting_shared_module:
       appRemotingServicePath = '/appremoting/v1beta1_dev'
     elif service_environment == 'test':
       appRemotingServicePath = '/appremoting/v1beta1'
     elif service_environment == 'staging':
       appRemotingServicePath = '/appremoting/v1beta1_staging'
     elif service_environment == 'vendor':
       appRemotingServicePath = '/appremoting/v1beta1_vendor'
     elif service_environment == 'prod':
       appRemotingServicePath = '/appremoting/v1beta1'
     elif service_environment == 'prod-testing':
       appRemotingServicePath = '/appremoting/v1beta1_prod_testing'
     else:
       raise Exception('Unknown service environment: ' + service_environment)
     appRemotingApiBaseUrl = appRemotingApiHost + appRemotingServicePath
   else:
     appRemotingApiBaseUrl = ''
 
-  replaceBool(destination, 'USE_GCD', use_gcd)
-  replaceString(destination, 'OAUTH2_BASE_URL', oauth2BaseUrl)
-  replaceString(destination, 'OAUTH2_API_BASE_URL', oauth2ApiBaseUrl)
-  replaceString(destination, 'DIRECTORY_API_BASE_URL', directoryApiBaseUrl)
-  if is_app_remoting_webapp:
-    replaceString(destination, 'APP_REMOTING_API_BASE_URL',
-                  appRemotingApiBaseUrl)
+  # TODO(garykac) replaceString (et al.) implictly update plugin_settings.js,
+  # which doesn't exist for the app stub. We need to move app-specific
+  # AppRemoting options into arv_main.js.
+  if not is_app_remoting_webapp:
+    replaceBool(destination, 'USE_GCD', use_gcd)
+    replaceString(destination, 'OAUTH2_BASE_URL', oauth2BaseUrl)
+    replaceString(destination, 'OAUTH2_API_BASE_URL', oauth2ApiBaseUrl)
+    replaceString(destination, 'DIRECTORY_API_BASE_URL', directoryApiBaseUrl)
+    if is_app_remoting:
+      replaceString(destination, 'APP_REMOTING_API_BASE_URL',
+                    appRemotingApiBaseUrl)
 
   # Substitute hosts in the manifest's CSP list.
   # Ensure we list the API host only once if it's the same for multiple APIs.
   googleApiHosts = ' '.join(set([oauth2ApiHost, directoryApiHost]))
 
   # WCS and the OAuth trampoline are both hosted on talkgadget. Split them into
   # separate suffix/prefix variables to allow for wildcards in manifest.json.
   talkGadgetHostSuffix = os.environ.get(
       'TALK_GADGET_HOST_SUFFIX', 'talkgadget.google.com')
   talkGadgetHostPrefix = os.environ.get(
@@ skipping 17 matching lines @@
   oauth2RedirectBaseUrlJson = oauth2RedirectHostJson + oauth2RedirectPath
   if buildtype == 'Official':
     oauth2RedirectUrlJs = ("'" + oauth2RedirectBaseUrlJs +
                            "/rel/' + chrome.i18n.getMessage('@@extension_id')")
     oauth2RedirectUrlJson = oauth2RedirectBaseUrlJson + '/rel/*'
   else:
     oauth2RedirectUrlJs = "'" + oauth2RedirectBaseUrlJs + "/dev'"
     oauth2RedirectUrlJson = oauth2RedirectBaseUrlJson + '/dev*'
   thirdPartyAuthUrlJs = oauth2RedirectBaseUrlJs + '/thirdpartyauth'
   thirdPartyAuthUrlJson = oauth2RedirectBaseUrlJson + '/thirdpartyauth*'
-  replaceString(destination, 'TALK_GADGET_URL', talkGadgetBaseUrl)
-  findAndReplace(os.path.join(destination, 'plugin_settings.js'),
-                 "'OAUTH2_REDIRECT_URL'", oauth2RedirectUrlJs)
+  xmppServer = os.environ.get('XMPP_SERVER', 'talk.google.com:443')
 
-  # Configure xmpp server and directory bot settings in the plugin.
-  replaceBool(
-      destination, 'XMPP_SERVER_USE_TLS',
-      getenvBool('XMPP_SERVER_USE_TLS', True))
-  xmppServer = os.environ.get('XMPP_SERVER', 'talk.google.com:443')
-  replaceString(destination, 'XMPP_SERVER', xmppServer)
-  replaceString(destination, 'DIRECTORY_BOT_JID',
-                os.environ.get('DIRECTORY_BOT_JID',
-                               'remoting@bot.talk.google.com'))
-  replaceString(destination, 'THIRD_PARTY_AUTH_REDIRECT_URL',
-                thirdPartyAuthUrlJs)
+  if not is_app_remoting_webapp:
+    replaceString(destination, 'TALK_GADGET_URL', talkGadgetBaseUrl)
+    findAndReplace(os.path.join(destination, 'plugin_settings.js'),
+                   "'OAUTH2_REDIRECT_URL'", oauth2RedirectUrlJs)
+
+    # Configure xmpp server and directory bot settings in the plugin.
+    replaceBool(
+        destination, 'XMPP_SERVER_USE_TLS',
+        getenvBool('XMPP_SERVER_USE_TLS', True))
+    replaceString(destination, 'XMPP_SERVER', xmppServer)
+    replaceString(destination, 'DIRECTORY_BOT_JID',
+                  os.environ.get('DIRECTORY_BOT_JID',
+                                 'remoting@bot.talk.google.com'))
+    replaceString(destination, 'THIRD_PARTY_AUTH_REDIRECT_URL',
+                  thirdPartyAuthUrlJs)
 
   # Set the correct API keys.
   # For overriding the client ID/secret via env vars, see google_api_keys.py.
   apiClientId = google_api_keys.GetClientID('REMOTING')
   apiClientSecret = google_api_keys.GetClientSecret('REMOTING')
   apiKey = google_api_keys.GetAPIKeyRemoting()
 
   if is_app_remoting_webapp and buildtype != 'Dev':
     if not app_client_id:
       raise Exception('Invalid app_client_id passed in: "' +
           app_client_id + '"')
     apiClientIdV2 = app_client_id + '.apps.googleusercontent.com'
   else:
     apiClientIdV2 = google_api_keys.GetClientID('REMOTING_IDENTITY_API')
 
-  replaceString(destination, 'API_CLIENT_ID', apiClientId)
-  replaceString(destination, 'API_CLIENT_SECRET', apiClientSecret)
-  replaceString(destination, 'API_KEY', apiKey)
+  if not is_app_remoting_webapp:
+    replaceString(destination, 'API_CLIENT_ID', apiClientId)
+    replaceString(destination, 'API_CLIENT_SECRET', apiClientSecret)
+    replaceString(destination, 'API_KEY', apiKey)
 
   # Write the application capabilities.
-  appCapabilities = ','.join(
-      ['remoting.ClientSession.Capability.' + x for x in app_capabilities])
-  findAndReplace(os.path.join(destination, 'app_capabilities.js'),
-                 "'APPLICATION_CAPABILITIES'", appCapabilities)
+  if is_app_remoting_webapp:
+    appCapabilities = ','.join(
+        ['remoting.ClientSession.Capability.' + x for x in app_capabilities])
+    findAndReplace(os.path.join(destination, 'arv_main.js'),
+                   "'APPLICATION_CAPABILITIES'", appCapabilities)
 
   # Use a consistent extension id for dev builds.
   # AppRemoting builds always use the dev app id - the correct app id gets
   # written into the manifest later.
   if is_app_remoting_webapp:
     if buildtype != 'Dev':
       if not manifest_key:
         raise Exception('Invalid manifest_key passed in: "' +
             manifest_key + '"')
       manifestKey = '"key": "' + manifest_key + '",'
@@ skipping 64 matching lines @@
   parser.add_argument('--use_gcd', choices=['0', '1'], default='0')
 
   args = parser.parse_args()
   args.use_gcd = (args.use_gcd != '0')
   args.app_capabilities = set(args.app_capabilities)
   return buildWebApp(**vars(args))
 
 
 if __name__ == '__main__':
   sys.exit(main())