Use Managed properties for Preferred and Provider.

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.
 
 // 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.
 
 cr.define('options.internet', function() {
   var Page = cr.ui.pageManager.Page;
   var PageManager = cr.ui.pageManager.PageManager;
   /** @const */ var ArrayDataModel = cr.ui.ArrayDataModel;
   /** @const */ var IPAddressField = options.internet.IPAddressField;
 
   /**
-   * Helper function to get the "Active" value of a property from a dictionary
-   * that includes ONC managed properties, e.g. getActiveValue(data, 'Name').
-   * We use (data, key) instead of getActiveValue(data[key]) so that we can
-   * (possibly) add ONC key validation once all properties use ONC.
+   * Gets the value of a property from a dictionary |data| that includes ONC
+   * managed properties, e.g. getManagedValue(data, 'Name'). See notes for
+   * getManagedProperty.
    * @param {object} data The properties dictionary.
    * @param {string} key The property key.
-   * @return {*} the property value or undefined.
+   * @param {string} type (Optional) The type of property to get:
+   *                      'active' (default)  - gets the active value

[pneubeck (no reviews), 2014/08/19 19:26:37]

These type strings could be more enum like (e.g. use string constants) or to
simplify the semantics provide separate functions for each case: getActiveValue,
getRecommendedValue, ...

[stevenjb, 2014/08/19 23:20:17]

The reason I didn't use separate functions was to avoid code duplication. I
could use wrapper functions I suppose, but I think an enum-like dictionary would
make sense here.

+   *                      'translated' - gets the traslated or active value
+   *                      'recommended' - gets the recommended value
+   * @return {*} The property value or undefined.
    */
-  function getActiveValue(data, key) {
-    if (!(key in data))
-      return undefined;
-    var property = data[key];
+  function getManagedValue(data, key, type) {
+    var property = getManagedProperty(data, key);
     if (typeof property != 'object')
       return property;
+    if (type == 'recommended')
+      return getRecommendedValue(property);
+    if (type == 'translated' && 'Translated' in property)
+      return property['Translated'];
+    // Otherwise get the Active value (defalt behavior).
     if ('Active' in property)
       return property['Active'];
+    // If no Active value is defined, return the effective value.
+    return getEffectiveValue(property);
+  }
+
+  /**
+   * Get the recommended value from a Managed property ONC dictionary.
+   * @param {object} property The managed property ONC dictionary.
+   * @return {*} the effective value or undefined.
+   */
+  function getRecommendedValue(property) {
+    if (property['UserEditable'])
+      return property['UserPolicy'];
+    if (property['DeviceEditable'])
+      return property['DevicePolicy'];
+    // No value recommended by policy.
+    return undefined;
+  }
+
+  /**
+   * Get the effective value from a Managed property ONC dictionary.
+   * @param {object} property The managed property ONC dictionary.
+   * @return {*} The effective value or undefined.
+   */
+  function getEffectiveValue(property) {
     if ('Effective' in property) {
       var effective = property.Effective;
       if (effective in property)
         return property[effective];
     }
     return undefined;
   }
 
   /**
-   * Helper function for nested ONC properties, e.g. data[WiFi][Strength].
-   * @param {object|string} property The property which must ether be
-   *   a dictionary object or not be present.
-   * @return {*} the property value or undefined.
+   * Gets either a managed property dictionary or an unmanaged value from
+   * dictionary |data| that includes ONC managed properties. This supports
+   * nested dictionaries, e.g. getManagedProperty(data, 'VPN.Type').
+   * @param {object} data The properties dictionary.
+   * @param {string} key The property key.
+   * @return {*} The property value or dictionary if it exists, otherwise
+   *             undefined.
    */
-  function getActiveDictionaryValue(data, dict, key) {
-    if (!(dict in data))
-      return undefined;
-    return getActiveValue(data[dict], key);
+  function getManagedProperty(data, key) {
+    while (true) {
+      var index = key.indexOf('.');
+      if (index < 0)
+        break;
+      var keyComponent = key.substr(0, index);
+      if (!(keyComponent in data))
+        return undefined;
+      data = data[keyComponent];
+      key = key.substr(index + 1);
+    }
+    return data[key];
   }
 
   /**
    * Helper function to set hidden attribute for elements matching a selector.
    * @param {string} selector CSS selector for extracting a list of elements.
    * @param {bool} hidden New hidden value.
    */
   function updateHidden(selector, hidden) {
     var elements = cr.doc.querySelectorAll(selector);
     for (var i = 0, el; el = elements[i]; i++) {
@@ skipping 65 matching lines @@
     return loadTimeData.getString('OncStateUnknown');
   }
 
   /**
    * Returns the display name for the network represented by 'data'.
    * @param {Object} data The network ONC dictionary.
    */
   function getNetworkName(data) {
     if (data.type == 'Ethernet')
       return loadTimeData.getString('ethernetName');
-    return getActiveValue(data, 'Name');
+    return getManagedValue(data, 'Name');
   }
 
   /////////////////////////////////////////////////////////////////////////////
   // DetailsInternetPage class:
 
   /**
    * Encapsulated handling of ChromeOS internet details overlay page.
    * @constructor
    */
   function DetailsInternetPage() {
@@ skipping 752 matching lines @@
   DetailsInternetPage.updateConnectionButtonVisibilty = function(data) {
     if (data.type == 'Ethernet') {
       // Ethernet can never be connected or disconnected and can always be
       // configured (e.g. to set security).
       $('details-internet-login').hidden = true;
       $('details-internet-disconnect').hidden = true;
       $('details-internet-configure').hidden = false;
       return;
     }
 
-    var connectState = getActiveValue(data, 'ConnectionState');
+    var connectState = getManagedValue(data, 'ConnectionState');
     if (connectState == 'NotConnected') {
       $('details-internet-login').hidden = false;
       // Connecting to an unconfigured network might trigger certificate
       // installation UI. Until that gets handled here, always enable the
       // Connect button.
       $('details-internet-login').disabled = false;
       $('details-internet-disconnect').hidden = true;
     } else {
       $('details-internet-login').hidden = true;
       $('details-internet-disconnect').hidden = false;
     }
 
-    var connectable = getActiveValue(data, 'Connectable');
+    var connectable = getManagedValue(data, 'Connectable');
     if (connectState != 'Connected' &&
         (!connectable || this.hasSecurity ||
         (data.type == 'Wimax' || data.type == 'VPN'))) {
       $('details-internet-configure').hidden = false;
     } else {
       $('details-internet-configure').hidden = true;
     }
   };
 
   DetailsInternetPage.updateConnectionData = function(update) {
     var detailsPage = DetailsInternetPage.getInstance();
     if (!detailsPage.visible)
       return;
 
     var data = $('connection-state').data;
     if (!data)
       return;
 
     if (update.servicePath != data.servicePath)
       return;
 
     // Update our cached data object.
     updateDataObject(data, update);
 
-    var connectionState = getActiveValue(data, 'ConnectionState');
+    var connectionState = getManagedValue(data, 'ConnectionState');
     var connectionStateString = networkOncStateString(connectionState);
     detailsPage.deviceConnected = data.deviceConnected;
     detailsPage.connected = connectionState == 'Connected';
     $('connection-state').textContent = connectionStateString;
 
     this.updateConnectionButtonVisibilty(data);
 
     if (data.type == 'WiFi') {
       $('wifi-connection-state').textContent = connectionStateString;
     } else if (data.type == 'Wimax') {
@@ skipping 15 matching lines @@
         $('change-pin').hidden = !lockEnabled;
       }
     }
 
     $('connection-state').data = data;
   };
 
   DetailsInternetPage.showDetailedInfo = function(data) {
     var detailsPage = DetailsInternetPage.getInstance();
 
-    data.type = getActiveValue(data, 'Type');  // Get Active Type value.
+    data.type = getManagedValue(data, 'Type');  // Get Active Type value.
 
     // Populate header
     $('network-details-title').textContent = getNetworkName(data);
-    var connectionState = getActiveValue(data, 'ConnectionState');
+    var connectionState = getManagedValue(data, 'ConnectionState');
     var connectionStateString = networkOncStateString(connectionState);
     detailsPage.connected = connectionState == 'Connected';
     $('network-details-subtitle-status').textContent = connectionStateString;
     var typeKey = null;
     switch (data.type) {
       case 'Ethernet':
         typeKey = 'ethernetTitle';
         break;
       case 'WiFi':
         typeKey = 'wifiTitle';
@@ skipping 123 matching lines @@
       nameServerModels.push({value: nameServersUser[i] || ''});
 
     $(data.nameServerType + '-dns-radio').checked = true;
     configureAddressField($('ipconfig-dns1'), nameServerModels[0]);
     configureAddressField($('ipconfig-dns2'), nameServerModels[1]);
     configureAddressField($('ipconfig-dns3'), nameServerModels[2]);
     configureAddressField($('ipconfig-dns4'), nameServerModels[3]);
 
     DetailsInternetPage.updateNameServerDisplay(data.nameServerType);
 
-    var macAddress = getActiveValue(data, 'MacAddress');
+    var macAddress = getManagedValue(data, 'MacAddress');
     if (macAddress) {
       $('hardware-address').textContent = macAddress;
       $('hardware-address-row').style.display = 'table-row';
     } else {
       // This is most likely a device without a hardware address.
       $('hardware-address-row').style.display = 'none';
     }
 
     var setOrHideParent = function(field, property) {
       if (property) {
         $(field).textContent = property;
         $(field).parentElement.hidden = false;
       } else {
         $(field).parentElement.hidden = true;
       }
     };
 
     var networkName = getNetworkName(data);
 
     // Signal strength as percentage (for WiFi and Wimax).
     var signalStrength;
     if (data.type == 'WiFi' || data.type == 'Wimax') {
-      signalStrength =
-          getActiveDictionaryValue(data, data.type, 'SignalStrength');
+      signalStrength = getManagedValue(data, data.type + '.SignalStrength');
     }
     if (!signalStrength)
       signalStrength = 0;
     var strengthFormat = loadTimeData.getString('inetSignalStrengthFormat');
     var strengthString = strengthFormat.replace('$1', signalStrength);
 
     detailsPage.type = data.type;
     if (data.type == 'WiFi') {
-      assert(data.WiFi, 'WiFi network has no WiFi object' + networkName);
+      assert('WiFi' in data, 'WiFi network has no WiFi object' + networkName);
       OptionsPage.showTab($('wifi-network-nav-tab'));
       detailsPage.gsm = false;
       detailsPage.shared = data.shared;
       $('wifi-connection-state').textContent = connectionStateString;
-      var ssid = getActiveDictionaryValue(data, 'WiFi', 'SSID');
+      var ssid = getManagedValue(data, 'WiFi.SSID');
       $('wifi-ssid').textContent = ssid ? ssid : networkName;
-      setOrHideParent('wifi-bssid',
-                      getActiveDictionaryValue(data, 'WiFi', 'BSSID'));
-      var security = getActiveDictionaryValue(data, 'WiFi', 'Security');
+      setOrHideParent('wifi-bssid', getManagedValue(data, 'WiFi.BSSID'));
+      var security = getManagedValue(data, 'WiFi.Security');
       if (security == 'None')
         security = undefined;
       setOrHideParent('wifi-security', security);
       // Frequency is in MHz.
-      var frequency = getActiveDictionaryValue(data, 'WiFi', 'Frequency');
+      var frequency = getManagedValue(data, 'WiFi.Frequency');
       if (!frequency)
         frequency = 0;
       var frequencyFormat = loadTimeData.getString('inetFrequencyFormat');
       frequencyFormat = frequencyFormat.replace('$1', frequency);
       $('wifi-frequency').textContent = frequencyFormat;
       $('wifi-signal-strength').textContent = strengthString;
       setOrHideParent('wifi-hardware-address',
-                      getActiveValue(data, 'MacAddress'));
+                      getManagedValue(data, 'MacAddress'));
       detailsPage.showPreferred = data.remembered;
-      $('prefer-network-wifi').checked = data.preferred.value;
+      var priority = getManagedValue(data, 'Priority');
+      $('prefer-network-wifi').checked = priority > 0;
       $('prefer-network-wifi').disabled = !data.remembered;
       $('auto-connect-network-wifi').checked =
-          getActiveValue(data, 'AutoConnect');
+          getManagedValue(data, 'AutoConnect');
       $('auto-connect-network-wifi').disabled = !data.remembered;
       detailsPage.hasSecurity = security != undefined;
     } else if (data.type == 'Wimax') {
-      assert(data.Wimax, 'Wimax network has no Wimax object' + networkName);
+      assert('Wimax' in data,
+             'Wimax network has no Wimax object' + networkName);
       OptionsPage.showTab($('wimax-network-nav-tab'));
       detailsPage.gsm = false;
       detailsPage.shared = data.shared;
       detailsPage.showPreferred = data.remembered;
       $('wimax-connection-state').textContent = connectionStateString;
       $('auto-connect-network-wimax').checked =
-          getActiveValue(data, 'AutoConnect');
+          getManagedValue(data, 'AutoConnect');
       $('auto-connect-network-wimax').disabled = !data.remembered;
       var identity;
       if (data.Wimax.EAP)
-        identity = getActiveValue(data.Wimax.EAP, 'Identity');
+        identity = getManagedValue(data.Wimax.EAP, 'Identity');
       setOrHideParent('wimax-eap-identity', identity);
       $('wimax-signal-strength').textContent = strengthString;
     } else if (data.type == 'Cellular') {
-      assert(data.Cellular,
+      assert('Cellular' in data,
              'Cellular network has no Cellular object' + networkName);
       OptionsPage.showTab($('cellular-conn-nav-tab'));
       if (data.showCarrierSelect && data.currentCarrierIndex != -1) {
         var carrierSelector = $('select-carrier');
         carrierSelector.onchange = DetailsInternetPage.handleCarrierChanged;
         carrierSelector.options.length = 0;
         for (var i = 0; i < data.carriers.length; ++i) {
           var option = document.createElement('option');
           option.textContent = data.carriers[i];
           carrierSelector.add(option);
         }
         carrierSelector.selectedIndex = data.currentCarrierIndex;
       } else {
         $('service-name').textContent = networkName;
       }
 
       $('network-technology').textContent =
-          getActiveDictionaryValue(data, 'Cellular', 'NetworkTechnology');
+          getManagedValue(data, 'Cellular.NetworkTechnology');
       $('activation-state').textContent = data.activationState;
       $('roaming-state').textContent = data.roamingState;
       $('restricted-pool').textContent = data.restrictedPool;
       $('error-state').textContent = data.errorMessage;
       $('manufacturer').textContent =
-          getActiveDictionaryValue(data, 'Cellular', 'Manufacturer');
-      $('model-id').textContent =
-          getActiveDictionaryValue(data, 'Cellular', 'ModelID');
+          getManagedValue(data, 'Cellular.Manufacturer');
+      $('model-id').textContent = getManagedValue(data, 'Cellular.ModelID');
       $('firmware-revision').textContent =
-          getActiveDictionaryValue(data, 'Cellular', 'FirmwareRevision');
+          getManagedValue(data, 'Cellular.FirmwareRevision');
       $('hardware-revision').textContent =
-          getActiveDictionaryValue(data, 'Cellular', 'HardwareRevision');
-      $('mdn').textContent = getActiveDictionaryValue(data, 'Cellular', 'MDN');
+          getManagedValue(data, 'Cellular.HardwareRevision');
+      $('mdn').textContent = getManagedValue(data, 'Cellular.MDN');
 
       // Show ServingOperator properties only if available.
-      if (data.Cellular.ServingOperator) {
-        $('operator-name').textContent =
-            getActiveValue(data.Cellular.ServingOperator, 'Name');
-        $('operator-code').textContent =
-            getActiveValue(data.Cellular.ServingOperator, 'Code');
+      var servingOperatorName =
+          getManagedValue(data, 'Cellular.ServingOperator.Name');
+      var servingOperatorCode =
+          getManagedValue(data, 'Cellular.ServingOperator.Code');
+      if (servingOperatorName != undefined &&
+          servingOperatorCode != undefined) {
+        $('operator-name').textContent = servingOperatorName;
+        $('operator-code').textContent = servingOperatorCode;
       } else {
         $('operator-name').parentElement.hidden = true;
         $('operator-code').parentElement.hidden = true;
       }
       // Make sure that GSM/CDMA specific properties that shouldn't be hidden
       // are visible.
       updateHidden('#details-internet-page .gsm-only', false);
       updateHidden('#details-internet-page .cdma-only', false);
 
       // Show IMEI/ESN/MEID/MIN/PRL only if they are available.
-      setOrHideParent('esn', getActiveDictionaryValue(data, 'Cellular', 'ESN'));
-      setOrHideParent(
-          'imei', getActiveDictionaryValue(data, 'Cellular', 'IMEI'));
-      setOrHideParent(
-          'meid', getActiveDictionaryValue(data, 'Cellular', 'MEID'));
-      setOrHideParent('min', getActiveDictionaryValue(data, 'Cellular', 'MIN'));
-      setOrHideParent(
-          'prl-version',
-          getActiveDictionaryValue(data, 'Cellular', 'PRLVersion'));
+      setOrHideParent('esn', getManagedValue(data, 'Cellular.ESN'));
+      setOrHideParent('imei', getManagedValue(data, 'Cellular.IMEI'));
+      setOrHideParent('meid', getManagedValue(data, 'Cellular.MEID'));
+      setOrHideParent('min', getManagedValue(data, 'Cellular.MIN'));
+      setOrHideParent('prl-version',
+                      getManagedValue(data, 'Cellular.PRLVersion'));
 
-      var family = getActiveDictionaryValue(data, 'Cellular', 'GSM');
+      var family = getManagedValue(data, 'Cellular.GSM');
       detailsPage.gsm = family == 'GSM';
       if (detailsPage.gsm) {
-        $('iccid').textContent =
-            getActiveDictionaryValue(data, 'Cellular', 'ICCID');
-        $('imsi').textContent =
-            getActiveDictionaryValue(data, 'Cellular', 'IMSI');
+        $('iccid').textContent = getManagedValue(data, 'Cellular.ICCID');
+        $('imsi').textContent = getManagedValue(data, 'Cellular.IMSI');
 
         var apnSelector = $('select-apn');
         // Clear APN lists, keep only last element that "other".
         while (apnSelector.length != 1)
           apnSelector.remove(0);
         var otherOption = apnSelector[0];
         data.selectedApn = -1;
         data.userApnIndex = -1;
         var apnList = data.providerApnList.value;
         for (var i = 0; i < apnList.length; i++) {
@@ skipping 29 matching lines @@
         }
         apnSelector.selectedIndex = data.selectedApn;
         updateHidden('.apn-list-view', false);
         updateHidden('.apn-details-view', true);
         // TODO(stevenjb): Used managed properties for policy controlled value.
         var lockEnabled = data.simCardLockEnabled.value;
         $('sim-card-lock-enabled').checked = lockEnabled;
         $('change-pin').hidden = !lockEnabled;
       }
       $('auto-connect-network-cellular').checked =
-          getActiveValue(data, 'AutoConnect');
+          getManagedValue(data, 'AutoConnect');
       $('auto-connect-network-cellular').disabled = false;
 
       $('buyplan-details').hidden = !data.showBuyButton;
       $('view-account-details').hidden = !data.showViewAccountButton;
       $('activate-details').hidden = !data.showActivateButton;
       if (data.showActivateButton) {
         $('details-internet-login').hidden = true;
       }
     } else if (data.type == 'VPN') {
       OptionsPage.showTab($('vpn-nav-tab'));
       detailsPage.gsm = false;
       $('inet-service-name').textContent = networkName;
-      $('inet-provider-type').textContent = data.providerType;
-      $('inet-username').textContent = data.username;
+      $('inet-provider-type').textContent =
+          getManagedValue(data, 'VPN.Type', 'translated');
+      var providerType = getManagedValue(data, 'VPN.Type', 'active');
+      var providerKey = 'VPN.' + providerType;
+      $('inet-username').textContent =
+          getManagedValue(data, providerKey + '.Username');
       var inetServerHostname = $('inet-server-hostname');
-      inetServerHostname.value = data.serverHostname.value;
+      inetServerHostname.value = getManagedValue(data, 'VPN.Host');
       inetServerHostname.resetHandler = function() {
         PageManager.hideBubble();
-        inetServerHostname.value = data.serverHostname.recommendedValue;
+        var recommended = getManagedValue(data, 'VPN.Host', 'recommended');
+        if (recommended)

[pneubeck (no reviews), 2014/08/19 19:26:37]

... recommended != undefined

[stevenjb, 2014/08/19 23:20:17]

Sigh. Thanks. Done.

+          inetServerHostname.value = recommended;
       };
       $('auto-connect-network-vpn').checked =
-          getActiveValue(data, 'AutoConnect');
+          getManagedValue(data, 'AutoConnect');
       $('auto-connect-network-vpn').disabled = false;
     } else {
       OptionsPage.showTab($('internet-nav-tab'));
     }
 
     // Update controlled option indicators.
     var indicators = cr.doc.querySelectorAll(
         '#details-internet-page .controlled-setting-indicator');
     for (var i = 0; i < indicators.length; i++) {
-      var attributeName =
-          indicators[i].hasAttribute('managed') ? 'managed' : 'data';
+      var managed = indicators[i].hasAttribute('managed');
+      var attributeName = managed ? 'managed' : 'data';
       var propName = indicators[i].getAttribute(attributeName);
-      if (!propName || !data[propName])
+      if (!propName)
+        continue;
+      var propValue =
+          managed ? getManagedProperty(data, propName) : data[propName];
+      if (propValue == undefined)
         continue;
       var event;
-      if (attributeName == 'managed')
-        event = detailsPage.createManagedEvent_(propName, data[propName]);
+      if (managed)
+        event = detailsPage.createManagedEvent_(propName, propValue);
       else
-        event = detailsPage.createControlledEvent_(propName, data[propName]);
+        event = detailsPage.createControlledEvent_(propName, propValue);
       indicators[i].handlePrefChange(event);
       var forElement = $(indicators[i].getAttribute('for'));
       if (forElement) {
         if (event.value.controlledBy == 'policy')
           forElement.disabled = true;
         if (forElement.resetHandler)
           indicators[i].resetHandler = forElement.resetHandler;
       }
     }
 
     detailsPage.updateControls();
 
     // 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
   };
 });