Make network settings functions more closely match networkingPrivate

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

 // 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.
 
 // require: onc_data.js
 
 // NOTE(stevenjb): This code is in the process of being converted to be
 // compatible with the networkingPrivate extension API:
 // * The network property dictionaries are being converted to use ONC values.
 // * chrome.send calls will be replaced with an API object that simulates the
 //   networkingPrivate API. See network_config.js.
 // See crbug.com/279351 for more info.
 
 /** @typedef {{address: (string|undefined),
  *             gateway: (string|undefined),
  *             nameServers: (string|undefined),
  *             netmask: (string|undefined),
  *             prefixLength: (number|undefined)}}
  * @see chrome/browser/ui/webui/options/chromeos/internet_options_handler.cc
  */
 var IPInfo;
 
 /**
  * InternetDetailedInfo argument passed to showDetailedInfo.
  * @see chrome/browser/ui/webui/options/chromeos/internet_options_handler.cc
  * @typedef {{
- *   deviceConnected: (boolean|undefined),
- *   errorMessage: (string|undefined),
  *   servicePath: string,
  *   showCarrierSelect: (boolean|undefined),
  *   showViewAccountButton: (boolean|undefined)
  * }}
  */
 var InternetDetailedInfo;
 
 cr.define('options.internet', function() {
   var OncData = cr.onc.OncData;
   var Page = cr.ui.pageManager.Page;
@@ skipping 135 matching lines @@
    * @extends {cr.ui.pageManager.Page}
    */
   function DetailsInternetPage() {
     // Cached Apn properties
     this.userApnIndex_ = -1;
     this.selectedApnIndex_ = -1;
     this.userApn_ = {};
     // We show the Proxy configuration tab for remembered networks and when
     // configuring a proxy from the login screen.
     this.showProxy_ = false;
-    // TODO(stevenjb): Use networkingPrivate.getNetworks to set this.
-    this.deviceConnected_ = false;
+    // In Chrome we sometimes want to enable the Cellular carrier select UI.
+    this.showCarrierSelect_ = false;
+    // In Chrome we sometimes want to show the 'View Account' button.
+    this.showViewAccountButton_ = false;
+
     Page.call(this, 'detailsInternetPage', '', 'details-internet-page');
   }
 
   cr.addSingletonGetter(DetailsInternetPage);
 
   DetailsInternetPage.prototype = {
     __proto__: Page.prototype,
 
     /** @override */
     initializePage: function() {
       Page.prototype.initializePage.call(this);
       this.initializePageContents_();
       this.showNetworkDetails_();
     },
 
     /**
      * Auto-activates the network details dialog if network information
      * is included in the URL.
      */
     showNetworkDetails_: function() {
       var servicePath = parseQueryParams(window.location).servicePath;
       if (!servicePath || !servicePath.length)
         return;
-      var networkType = '';  // ignored for 'options'
-      chrome.send('networkCommand', [networkType, servicePath, 'options']);
+      var networkType = '';  // ignored for 'sendDetails'
+      chrome.send('networkCommand', [networkType, servicePath, 'sendDetails']);
     },
 
     /**
      * Initializes the contents of the page.
      */
     initializePageContents_: function() {
       $('details-internet-dismiss').addEventListener('click', function(event) {
         DetailsInternetPage.setDetails();
       });
 
@@ skipping 39 matching lines @@
       $('select-apn').addEventListener('change', function(event) {
         DetailsInternetPage.getInstance().selectApn_();
       });
 
       $('sim-card-lock-enabled').addEventListener('click', function(event) {
         var newValue = $('sim-card-lock-enabled').checked;
         // Leave value as is because user needs to enter PIN code first.
         // When PIN will be entered and value changed,
         // we'll update UI to reflect that change.
         $('sim-card-lock-enabled').checked = !newValue;
-        chrome.send('setSimCardLock', [newValue]);
+        var operation = newValue ? 'setLocked' : 'setUnlocked';
+        chrome.send('simOperation', [operation]);
       });
       $('change-pin').addEventListener('click', function(event) {
-        chrome.send('changePin');
+        chrome.send('simOperation', ['changePin']);
       });
 
       // Proxy
       ['proxy-host-single-port',
        'secure-proxy-port',
        'socks-port',
        'ftp-proxy-port',
        'proxy-host-port'
       ].forEach(function(id) {
         options.PrefPortNumber.decorate($(id));
@@ skipping 154 matching lines @@
     },
 
     /**
      * Update details page controls.
      */
     updateControls: function() {
       var onc = this.onc_;
       if (onc == undefined)
         return;  // May get called from a pref update before initialized.
 
-      // Only show ipconfig section if network is connected OR if nothing on
-      // this device is connected. This is so that you can fix the ip configs
-      // if you can't connect to any network.
-      // TODO(stevenjb): Support IP configuration (and improve the display)
-      // for non connected networks.
-
-      var connected = onc.getActiveValue('ConnectionState') == 'Connected';
-      $('ipconfig-section').hidden = !connected && this.deviceConnected_;
-      $('ipconfig-dns-section').hidden = !connected && this.deviceConnected_;
+      // Always show the ipconfig section. TODO(stevenjb): Improve the display
+      // for unconnected networks. Currently the IP address fields may be
+      // blank if the network is not connected.
+      $('ipconfig-section').hidden = false;
+      $('ipconfig-dns-section').hidden = false;
 
       // Network type related.
       updateHidden('#details-internet-page .cellular-details',
                    this.type_ != 'Cellular');
       updateHidden('#details-internet-page .wifi-details',
                    this.type_ != 'WiFi');
       updateHidden('#details-internet-page .wimax-details',
                    this.type_ != 'Wimax');
       updateHidden('#details-internet-page .vpn-details', this.type_ != 'VPN');
       updateHidden('#details-internet-page .proxy-details', !this.showProxy_);
@@ skipping 180 matching lines @@
           (this.type_ == 'Wimax' || this.type_ == 'VPN'))) {
         $('details-internet-configure').hidden = false;
       } else {
         $('details-internet-configure').hidden = true;
       }
     },
 
     /**
      * Helper method called from showDetailedInfo and updateConnectionData.
      * Updates the connection state property and account / sim card links.
-     * @param {InternetDetailedInfo} data
      * @private
      */
-    updateDetails_: function(data) {
+    updateDetails_: function() {
       var onc = this.onc_;
 
-      if ('deviceConnected' in data)
-        this.deviceConnected_ = data.deviceConnected;
-
       var connectionStateString = onc.getTranslatedValue('ConnectionState');
       $('connection-state').textContent = connectionStateString;
 
       var type = this.type_;
       var showViewAccount = false;
       var showActivate = false;
       if (type == 'WiFi') {
         $('wifi-connection-state').textContent = connectionStateString;
       } else if (type == 'Wimax') {
         $('wimax-connection-state').textContent = connectionStateString;
       } else if (type == 'Cellular') {
         $('activation-state').textContent =
             onc.getTranslatedValue('Cellular.ActivationState');
         if (onc.getActiveValue('Cellular.Family') == 'GSM') {
           var lockEnabled =
               onc.getActiveValue('Cellular.SIMLockStatus.LockEnabled');
           $('sim-card-lock-enabled').checked = lockEnabled;
           $('change-pin').hidden = !lockEnabled;
         }
-        showViewAccount = data.showViewAccountButton;
+        showViewAccount = this.showViewAccountButton_;
         var activationState = onc.getActiveValue('Cellular.ActivationState');
         showActivate = activationState == 'NotActivated' ||
             activationState == 'PartiallyActivated';
       }
 
       $('view-account-details').hidden = !showViewAccount;
       $('activate-details').hidden = !showActivate;
       // If activation is not complete, hide the login button.
       if (showActivate)
         $('details-internet-login').hidden = true;
@@ skipping 328 matching lines @@
   DetailsInternetPage.updateCarrier = function() {
     DetailsInternetPage.showCarrierChangeSpinner(false);
   };
 
   DetailsInternetPage.loginFromDetails = function() {
     var detailsPage = DetailsInternetPage.getInstance();
     if (detailsPage.type_ == 'WiFi')
       sendChromeMetricsAction('Options_NetworkConnectToWifi');
     else if (detailsPage.type_ == 'VPN')
       sendChromeMetricsAction('Options_NetworkConnectToVPN');
-    chrome.send('networkCommand',
-                [detailsPage.type_, detailsPage.servicePath_, 'connect']);
+    // TODO(stevenjb): chrome.networkingPrivate.disableNetworkType
+    chrome.send('startConnect', [detailsPage.servicePath_]);
     PageManager.closeOverlay();
   };
 
   DetailsInternetPage.disconnectNetwork = function() {
     var detailsPage = DetailsInternetPage.getInstance();
     if (detailsPage.type_ == 'WiFi')
       sendChromeMetricsAction('Options_NetworkDisconnectWifi');
     else if (detailsPage.type_ == 'VPN')
       sendChromeMetricsAction('Options_NetworkDisconnectVPN');
-    chrome.send('networkCommand',
-                [detailsPage.type_, detailsPage.servicePath_, 'disconnect']);
+    // TODO(stevenjb): chrome.networkingPrivate.startDisconnect
+    chrome.send('startDisconnect', [detailsPage.servicePath_]);
     PageManager.closeOverlay();
   };
 
   DetailsInternetPage.configureNetwork = function() {
     var detailsPage = DetailsInternetPage.getInstance();
     chrome.send('networkCommand',
                 [detailsPage.type_, detailsPage.servicePath_, 'configure']);
     PageManager.closeOverlay();
   };
 
   DetailsInternetPage.activateFromDetails = function() {
     var detailsPage = DetailsInternetPage.getInstance();
     if (detailsPage.type_ == 'Cellular') {
       chrome.send('networkCommand',
                   [detailsPage.type_, detailsPage.servicePath_, 'activate']);
     }
     PageManager.closeOverlay();
   };
 
+  /**
+   * Event handler called when the details page is closed. Sends changed
+   * properties to Chrome and closes the overlay.
+   */
   DetailsInternetPage.setDetails = function() {
     var detailsPage = DetailsInternetPage.getInstance();
     var type = detailsPage.type_;
     var servicePath = detailsPage.servicePath_;
     if (type == 'WiFi') {
       sendCheckedIfEnabled(servicePath,
                            'setPreferNetwork',
                            'prefer-network-wifi',
                            'Options_NetworkSetPrefer');
       sendCheckedIfEnabled(servicePath,
@@ skipping 43 matching lines @@
                 [servicePath,
                  Boolean($('ip-automatic-configuration-checkbox').checked),
                  $('ip-address').model.value || '',
                  $('ip-netmask').model.value || '',
                  $('ip-gateway').model.value || '',
                  nameServerType,
                  userNameServers.join(',')]);
     PageManager.closeOverlay();
   };
 
+  /**
+   * Event handler called when the name server type changes.
+   * @param {string} type The selected name sever type, 'automatic', 'google',
+   *                      or 'user'.
+   */
   DetailsInternetPage.updateNameServerDisplay = function(type) {
     var editable = type == 'user';
     var fields = [$('ipconfig-dns1'), $('ipconfig-dns2'),
                   $('ipconfig-dns3'), $('ipconfig-dns4')];
     for (var i = 0; i < fields.length; ++i) {
       fields[i].editable = editable;
     }
     if (editable)
       $('ipconfig-dns1').focus();
 
@@ skipping 12 matching lines @@
         userDns.removeAttribute('selected');
         break;
       case 'user':
         automaticDns.removeAttribute('selected');
         googleDns.removeAttribute('selected');
         userDns.setAttribute('selected', '');
         break;
     }
   };
 
-  DetailsInternetPage.updateConnectionData = function(update) {
+  /**
+   * Method called from Chrome with a dictionary of non ONC configuration
+   * properties, including the HUID and service path to be used for requiesting

[armansito, 2014/09/16 16:40:41]

nit: requiesting -> requesting

[stevenjb, 2014/09/16 17:32:57]

Done.

+   * the ONC properites. Note: currently GUID is only used to confirm that the

[armansito, 2014/09/16 16:40:41]

nit: properites -> properties

[stevenjb, 2014/09/16 17:32:58]

Done.

+   * selected network still exists. It will be used instead of servicePath
+   * once switching to the networkingPrivate API (see TODO below).
+   * @param {InternetDetailedInfo} info
+   */
+  DetailsInternetPage.showDetailedInfo = function(info) {
+    if (!('GUID' in info)) {
+      // No network was found for, close the overlay.
+      PageManager.closeOverlay();
+      return;
+    }
+    var detailsPage = DetailsInternetPage.getInstance();
+    detailsPage.servicePath_ = info.servicePath;
+    detailsPage.showCarrierSelect_ = info.showCarrierSelect;
+    detailsPage.showViewAccountButton_ = info.showViewAccountButton;
+    // Ask Chrome to call sendNetworkDetails with the ONC properties.
+    // TODO(stevenjb): Use networkingPrivate.getManagedProperties(info.guid).
+    chrome.send('getManagedProperties', [info.servicePath]);
+  };
+
+  /**
+   * Method called from Chrome when the ONC properties for the displayed
+   * network may have changed.
+   * @param {Object} update The updated ONC dictionary for the network.
+   */
+  DetailsInternetPage.updateConnectionData = function(oncData) {
     var detailsPage = DetailsInternetPage.getInstance();
     if (!detailsPage.visible)
       return;
 
-    if (update.servicePath != detailsPage.servicePath_)
+    if (oncData.servicePath != detailsPage.servicePath_)
       return;
 
     // Update our cached data object.
-    var onc = detailsPage.onc_;
-    onc.updateData(update);
+    detailsPage.onc_ = new OncData(oncData);
 
     detailsPage.populateHeader_();
     detailsPage.updateConnectionButtonVisibilty_();
-    detailsPage.updateDetails_(update);
+    detailsPage.updateDetails_();
   };
 
   /**
-   * @param {InternetDetailedInfo} data
+   * Method called from Chrome when the initial dictionary of ONC configuration
+   * properties is avaliable.
+   * @param {Object} oncData Dictionary of ONC properties.
    */
-  DetailsInternetPage.showDetailedInfo = function(data) {
-    var onc = new OncData(data);
+  DetailsInternetPage.sendNetworkDetails = function(oncData) {
+    var onc = new OncData(oncData);
 
     var detailsPage = DetailsInternetPage.getInstance();
     detailsPage.onc_ = onc;
     var type = onc.getActiveValue('Type');
     detailsPage.type_ = type;
-    detailsPage.servicePath_ = data.servicePath;
 
     sendShowDetailsMetrics(type, onc.getActiveValue('ConnectionState'));
 
     detailsPage.populateHeader_();
     detailsPage.updateConnectionButtonVisibilty_();
-    detailsPage.updateDetails_(data);
+    detailsPage.updateDetails_();
 
     // TODO(stevenjb): Some of the setup below should be moved to
     // updateDetails_() so that updates are reflected in the UI.
 
     // Only show proxy for remembered networks.
     var remembered = onc.getSource() != 'None';
     if (remembered) {
       detailsPage.showProxy_ = true;
       // Inform Chrome which network to use for proxy configuration.
       chrome.send('selectNetwork', [detailsPage.servicePath_]);
@@ skipping 204 matching lines @@
       $('auto-connect-network-wimax').disabled = !remembered;
       var identity = onc.getActiveValue('Wimax.EAP.Identity');
       setOrHideParent('wimax-eap-identity', identity);
       $('wimax-signal-strength').textContent = strengthString;
     } else if (type == 'Cellular') {
       OptionsPage.showTab($('cellular-conn-nav-tab'));
 
       var isGsm = onc.getActiveValue('Cellular.Family') == 'GSM';
 
       var currentCarrierIndex = -1;
-      if (data.showCarrierSelect) {
+      if (this.showCarrierSelect_) {
         var currentCarrier =
             isGsm ? CarrierGenericUMTS : onc.getActiveValue('Cellular.Carrier');
         var supportedCarriers =
             onc.getActiveValue('Cellular.SupportedCarriers');
         for (var c1 = 0; c1 < supportedCarriers.length; ++c1) {
           if (supportedCarriers[c1] == currentCarrier) {
             currentCarrierIndex = c1;
             break;
           }
         }
@@ skipping 10 matching lines @@
         }
       }
       if (currentCarrierIndex == -1)
         $('service-name').textContent = networkName;
 
       $('network-technology').textContent =
           onc.getActiveValue('Cellular.NetworkTechnology');
       $('roaming-state').textContent =
           onc.getTranslatedValue('Cellular.RoamingState');
       $('cellular-restricted-connectivity').textContent = restrictedString;
-      if ('errorMessage' in data)
-        $('error-state').textContent = data.errorMessage;
+      // 'errorMessage' is a non ONC property added by Chrome.
+      $('error-state').textContent = onc.getActiveValue('errorMessage');
       $('manufacturer').textContent =
           onc.getActiveValue('Cellular.Manufacturer');
       $('model-id').textContent = onc.getActiveValue('Cellular.ModelID');
       $('firmware-revision').textContent =
           onc.getActiveValue('Cellular.FirmwareRevision');
       $('hardware-revision').textContent =
           onc.getActiveValue('Cellular.HardwareRevision');
       $('mdn').textContent = onc.getActiveValue('Cellular.MDN');
 
       // Show ServingOperator properties only if available.
@@ skipping 95 matching lines @@
 
     // Don't show page name in address bar and in history to prevent people
     // navigate here by hand and solve issue with page session restore.
     PageManager.showPageByName('detailsInternetPage', false);
   };
 
   return {
     DetailsInternetPage: DetailsInternetPage
   };
 });