Allow users to add third-party VPNs from the settings page

chrome/browser/resources/options/chromeos/vpn_providers.js

 // Copyright 2015 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.
 
 /**
  * @fileoverview A singleton that keeps track of the VPN providers enabled in
  * the primary user's profile.
  */
 
 cr.define('options', function() {
   /**
    * @constructor
    */
   function VPNProviders() {
   }
 
   cr.addSingletonGetter(VPNProviders);
 
   VPNProviders.prototype = {
     /**
      * The VPN providers enabled in the primary user's profile. Each provider
      * has a name. Third-party VPN providers additionally have an extension ID.
      * @type {!Array<{name: string, extensionID: ?string}>}
      * @private
      */
     providers_: [],
 
     /**
+     * Observers who will be notified when the list of VPN providers changes.
+     * @type {!Array<!options.VPNProviders.Observer>}
+     */
+    observers_: [],
+
+    /**
+     * The VPN providers enabled in the primary user's profile.
+     * @type {!Array<{name: string, extensionID: ?string}>}
+     */
+    get providers() {
+      return this.providers_;
+    },
+    set providers(providers) {
+      this.providers_ = providers;
+      for (var i = 0; i < this.observers_.length; ++i)
+        this.observers_[i].onVPNProvidersChanged();
+    },
+
+    /**
+     * Adds an observer to be notified when the list of VPN providers changes.
+     * @param {!options.VPNProviders.Observer} observer The observer to add.
+     */
+    addObserver: function(observer) {
+      this.observers_.push(observer);
+    },

[stevenjb, 2015/03/19 16:02:02]

We should make this more easily compatible with extension event listeners by
passing a function callback instead of an object that is expected to have an
'onVPNProvidersChanged' function.

[bartfab (slow), 2015/03/19 16:22:05]

Done.

+
+    /**
      * Formats a network name for display purposes. If the network belongs to
      * a third-party VPN provider, the provider name is added to the network
      * name.
      * @param {cr.onc.OncData} onc ONC data describing this network.
      * @return {string} The resulting display name.
      * @private
      */
     formatNetworkName_: function(onc) {
       var networkName = onc.getTranslatedValue('Name');
       if (onc.getActiveValue('VPN.Type') != 'ThirdPartyVPN')
         return networkName;
       var extensionID = onc.getActiveValue('VPN.ThirdPartyVPN.ExtensionID');
       for (var i = 0; i < this.providers_.length; ++i) {
         if (extensionID == this.providers_[i].extensionID) {
           return loadTimeData.getStringF('vpnNameTemplate',
                                          this.providers_[i].name,
                                          networkName);
         }
       }
       return networkName;
     },
   };
 
   /**
+   * Adds an observer to be notified when the list of VPN providers changes.
+   * @param {!options.VPNProviders.Observer} observer The observer to add.
+   */
+  VPNProviders.addObserver = function(observer) {
+    VPNProviders.getInstance().addObserver(observer);
+  };
+
+  /**
    * Returns the list of VPN providers enabled in the primary user's profile.
    * @return {!Array<{name: string, extensionID: ?string}>} The list of VPN
    *     providers enabled in the primary user's profile.
    */
   VPNProviders.getProviders = function() {
-    return VPNProviders.getInstance().providers_;
+    return VPNProviders.getInstance().providers;
   };
 
   /**
    * Replaces the list of VPN providers enabled in the primary user's profile.
    * @param {!Array<{name: string, extensionID: ?string}>} providers The list
    *     of VPN providers enabled in the primary user's profile.
    */
   VPNProviders.setProviders = function(providers) {
-    VPNProviders.getInstance().providers_ = providers;
+    VPNProviders.getInstance().providers = providers;
   };
 
   /**
    * Formats a network name for display purposes. If the network belongs to a
    * third-party VPN provider, the provider name is added to the network name.
    * @param {cr.onc.OncData} onc ONC data describing this network.
    * @return {string} The resulting display name.
    */
   VPNProviders.formatNetworkName = function(onc) {
     return VPNProviders.getInstance().formatNetworkName_(onc);
   };
 
+  /**
+   * An observer of VPNProviders.
+   * @interface
+   */
+  VPNProviders.Observer = function() {};
+
+  VPNProviders.Observer.prototype = {
+    /**
+     * Called when the list of VPN providers changes.
+     */
+    onVPNProvidersChanged: function() {},
+  };

[stevenjb, 2015/03/19 16:02:02]

If we use listener functions instead of observer objects, we don't need this at
all.

[bartfab (slow), 2015/03/19 16:22:05]

Done.

+
   // Export
   return {
     VPNProviders: VPNProviders
   };
 });