Use ONC for Cellular APN and SimLock in Settings

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.
@@ skipping 18 matching lines @@
    * @param {string} key The property key.
    * @param {string} type (Optional) The type of property to get as defined in
    *                      GetManagedTypes:
    *                      'ACTIVE' (default)  - gets the active value
    *                      'TRANSLATED' - gets the traslated or active value
    *                      'RECOMMENDED' - gets the recommended value
    * @return {*} The property value or undefined.
    */
   function getManagedValue(data, key, type) {
     var property = getManagedProperty(data, key);
-    if (typeof property != 'object')
+    if (Array.isArray(property) || typeof property != 'object')
       return property;
     if (type == GetManagedTypes.RECOMMENDED)
       return getRecommendedValue(property);
     if (type == GetManagedTypes.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);
+    // If no Active value is defined, return the effective value if present.
+    var effective = getEffectiveValue(property);
+    if (effective != undefined)
+      return effective;
+    // Otherwise this is an Object but not a Managed one.
+    return 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'];
@@ skipping 34 matching lines @@
       var keyComponent = key.substr(0, index);
       if (!(keyComponent in data))
         return undefined;
       data = data[keyComponent];
       key = key.substr(index + 1);
     }
     return data[key];
   }
 
   /**
+   * Set the value of a property in dictionary |data| that includes ONC
+   * managed properties, e.g. setManagedValue(data, 'Name', 'MyNetwork').
+   * See notes for getManagedProperty.
+   * @param {object} data The properties dictionary.
+   * @param {string} key The property key.
+   * @param {string} value The property value to set.
+   */
+  function setManagedProperty(data, key, value) {
+    while (true) {
+      var index = key.indexOf('.');
+      if (index < 0)
+        break;
+      var keyComponent = key.substr(0, index);
+      if (!(keyComponent in data))
+        data[keyComponent] = {};
+      data = data[keyComponent];
+      key = key.substr(index + 1);
+    }
+    if (!(key in data) ||
+        (typeof data[key] != 'object') ||
+        (!('Active' in data[key]) && !('Effective' in data[key]))) {
+      data[key] = value;
+    } else {
+      var effective = data[key]['Effective'];
+      assert(effective != 'UserPolicy' || data[key]['UserEditable']);
+      assert(effective != 'DevicePolicy' || data[key]['DeviceEditable']);
+      // For now, just uodare the active value. TODO(stevenjb): Eventually we
+      // should update the 'UserSetting' and 'Effective' properties correctly
+      // and send that back to Chrome.
+      data[key]['Active'] = value;
+    }
+  }
+
+  /**
    * 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++) {
       el.hidden = hidden;
     }
   }
@@ skipping 151 matching lines @@
 
       $('cellular-apn-use-default').addEventListener('click', function(event) {
         var data = $('connection-state').data;
         var apnSelector = $('select-apn');
 
         if (data.userApnIndex != -1) {
           apnSelector.remove(data.userApnIndex);
           data.userApnIndex = -1;
         }
 
-        if (data.providerApnList.value.length > 0) {
-          var iApn = 0;
-          var defaultApn = data.providerApnList.value[iApn];
-          data.apn.apn = stringFromValue(defaultApn.apn);
-          data.apn.username = stringFromValue(defaultApn.username);
-          data.apn.password = stringFromValue(defaultApn.password);
+        var activeApn;
+        var iApn = -1;
+        var apnList = getManagedValue(data, 'Cellular.APNList');
+        if (apnList != undefined && apnList.length > 0) {
+          iApn = 0;
+          var defaultApn = apnList[iApn];
+          activeApn['AccessPointName'] =

[Vitaly Pavlenko, 2014/09/07 05:25:15]

Could you please explain, why |activeApn| is defined and is an object at this
point? I see only declaration on line 313, according to which it seems to be
"undefined" at line 319.

[stevenjb, 2014/09/08 17:48:22]

activeApn will either be 'undefined' or will be a valid APN object when it is
used in line 328. We set it to 'undefined' rather than providing a special
'unsetManagedProperty' method for simplicity.

[Dan Beam, 2014/09/08 20:32:14]

i think what vitalyp@ means is:

  var activeApn;  // undefined
  if (...) {
    activeApn['AccessPointName']  // undefined['key'] should blow up
  }

[stevenjb, 2014/09/09 00:47:49]

Ah, I see, right, we have to define activeApn as a dictionary here. I will fix
this in https://codereview.chromium.org/547703004/, thanks!

+              stringFromValue(defaultApn['AccessPointName']);
+          activeApn['Username'] = stringFromValue(defaultApn['Username']);
+          activeApn['Password'] = stringFromValue(defaultApn['Password']);
           chrome.send('setApn', [data.servicePath,
-                                 data.apn.apn,
-                                 data.apn.username,
-                                 data.apn.password]);
-          apnSelector.selectedIndex = iApn;
-          data.selectedApn = iApn;
-        } else {
-          data.apn.apn = '';
-          data.apn.username = '';
-          data.apn.password = '';
-          apnSelector.selectedIndex = -1;
-          data.selectedApn = -1;
+                                 activeApn['AccessPointName'],
+                                 activeApn['Username'],
+                                 activeApn['Password']]);
         }
+        setManagedProperty(data, 'Cellular.APN', activeApn);
+        apnSelector.selectedIndex = iApn;
+        data.selectedApn = iApn;
+
         updateHidden('.apn-list-view', false);
         updateHidden('.apn-details-view', true);
       });
 
       $('cellular-apn-set').addEventListener('click', function(event) {
         if ($('cellular-apn').value == '')
           return;
 
         var data = $('connection-state').data;
         var apnSelector = $('select-apn');
 
-        data.apn.apn = stringFromValue($('cellular-apn').value);
-        data.apn.username = stringFromValue($('cellular-apn-username').value);
-        data.apn.password = stringFromValue($('cellular-apn-password').value);
-        data.userApn = {
-          'apn': data.apn.apn,
-          'username': data.apn.username,
-          'password': data.apn.password
-        };
+        var activeApn = {};
+        activeApn['AccessPointName'] =
+            stringFromValue($('cellular-apn').value);
+        activeApn['Username'] =
+            stringFromValue($('cellular-apn-username').value);
+        activeApn['Password'] =
+            stringFromValue($('cellular-apn-password').value);
+        setManagedProperty(data, 'Cellular.APN', activeApn);
+        data.userApn = activeApn;
         chrome.send('setApn', [data.servicePath,
-                               data.apn.apn,
-                               data.apn.username,
-                               data.apn.password]);
+                               activeApn['AccessPointName'],
+                               activeApn['Username'],
+                               activeApn['Password']]);
 
         if (data.userApnIndex != -1) {
           apnSelector.remove(data.userApnIndex);
           data.userApnIndex = -1;
         }
 
         var option = document.createElement('option');
-        option.textContent = data.apn.apn;
+        option.textContent = activeApn['AccessPointName'];
         option.value = -1;
         option.selected = true;
         apnSelector.add(option, apnSelector[apnSelector.length - 1]);
         data.userApnIndex = apnSelector.length - 2;
         data.selectedApn = data.userApnIndex;
 
         updateHidden('.apn-list-view', false);
         updateHidden('.apn-details-view', true);
       });
 
       $('cellular-apn-cancel').addEventListener('click', function(event) {
         $('select-apn').selectedIndex = $('connection-state').data.selectedApn;
         updateHidden('.apn-list-view', false);
         updateHidden('.apn-details-view', true);
       });
 
       $('select-apn').addEventListener('change', function(event) {
         var data = $('connection-state').data;
         var apnSelector = $('select-apn');
+        var apnDict;
         if (apnSelector[apnSelector.selectedIndex].value != -1) {
-          var apnList = data.providerApnList.value;
+          var apnList = getManagedValue(data, 'Cellular.APNList');
+          var apnIndex = apnSelector.selectedIndex;
+          assert(apnIndex < apnList.length);
+          apnDict = apnList[apnIndex];
           chrome.send('setApn', [data.servicePath,
-              stringFromValue(apnList[apnSelector.selectedIndex].apn),
-              stringFromValue(apnList[apnSelector.selectedIndex].username),
-              stringFromValue(apnList[apnSelector.selectedIndex].password)]
-          );
-          data.selectedApn = apnSelector.selectedIndex;
+                                 stringFromValue(apnDict['AccessPointName']),
+                                 stringFromValue(apnDict['Username']),
+                                 stringFromValue(apnDict['Password'])]);
+          data.selectedApn = apnIndex;
         } else if (apnSelector.selectedIndex == data.userApnIndex) {
+          apnDict = data.userApn;
           chrome.send('setApn', [data.servicePath,
-                                 stringFromValue(data.userApn.apn),
-                                 stringFromValue(data.userApn.username),
-                                 stringFromValue(data.userApn.password)]);
+                                 stringFromValue(apnDict['AccessPointName']),
+                                 stringFromValue(apnDict['Username']),
+                                 stringFromValue(apnDict['Password'])]);
           data.selectedApn = apnSelector.selectedIndex;
         } else {
-          $('cellular-apn').value = stringFromValue(data.apn.apn);
-          $('cellular-apn-username').value = stringFromValue(data.apn.username);
-          $('cellular-apn-password').value = stringFromValue(data.apn.password);
+          apnDict = getManagedValue(data, 'Cellular.APN');
+          $('cellular-apn').value = stringFromValue(apnDict['AccessPointName']);
+          $('cellular-apn-username').value =
+              stringFromValue(apnDict['Username']);
+          $('cellular-apn-password').value =
+              stringFromValue(apnDict['Password']);
 
           updateHidden('.apn-list-view', true);
           updateHidden('.apn-details-view', false);
         }
       });
 
       $('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,
@@ skipping 638 matching lines @@
       $('activation-state').textContent = data.activationState;
 
       $('buyplan-details').hidden = !data.showBuyButton;
       $('view-account-details').hidden = !data.showViewAccountButton;
 
       $('activate-details').hidden = !data.showActivateButton;
       if (data.showActivateButton)
         $('details-internet-login').hidden = true;
 
       if (detailsPage.gsm) {
-        // TODO(stevenjb): Use managed properties for policy controlled values.
-        var lockEnabled = data.simCardLockEnabled.value;
+        var lockEnabled =
+            getManagedValue(data, 'Cellular.SIMLockStatus.LockEnabled');
         $('sim-card-lock-enabled').checked = lockEnabled;
         $('change-pin').hidden = !lockEnabled;
       }
     }
 
     $('connection-state').data = data;
   };
 
   DetailsInternetPage.showDetailedInfo = function(data) {
     var detailsPage = DetailsInternetPage.getInstance();
@@ skipping 289 matching lines @@
         $('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;
+        var activeApn = getManagedValue(data, 'Cellular.APN');

[pneubeck (no reviews), 2014/10/20 16:48:04]

while looking for the VPN hostname cause, I saw that this CL didn't update the
internet_detail.html, which refers to 'providerApnList' in the
controlled-setting-indicator.

Similarly, I fear that several other controlled-setting-indicators were not
updated.

[stevenjb, 2014/10/20 18:11:21]

crbug.com/425164

+        var lastGoodApn = getManagedValue(data, 'Cellular.LastGoodAPN');
+        var apnList = getManagedValue(data, 'Cellular.APNList');
         for (var i = 0; i < apnList.length; i++) {
+          var apnDict = apnList[i];
           var option = document.createElement('option');
-          var localizedName = apnList[i].localizedName;
-          var name = localizedName ? localizedName : apnList[i].name;
-          var apn = apnList[i].apn;
-          option.textContent = name ? (name + ' (' + apn + ')') : apn;
+          var localizedName = apnDict['LocalizedName'];
+          var name = localizedName ? localizedName : apnDict['Name'];
+          var accessPointName = apnDict['AccessPointName'];
+          option.textContent =
+              name ? (name + ' (' + accessPointName + ')') : accessPointName;
           option.value = i;
-          // data.apn and data.lastGoodApn will always be defined, however
-          // data.apn.apn and data.lastGoodApn.apn may not be. This is not a
-          // problem, as apnList[i].apn will always be defined and the
-          // comparisons below will work as expected.
-          if ((data.apn.apn == apn &&
-               data.apn.username == apnList[i].username &&
-               data.apn.password == apnList[i].password) ||
-              (!data.apn.apn &&
-               data.lastGoodApn.apn == apn &&
-               data.lastGoodApn.username == apnList[i].username &&
-               data.lastGoodApn.password == apnList[i].password)) {
+          // If this matches the active Apn, or LastGoodApn, set it as the
+          // selected Apn.
+          if ((activeApn != undefined &&
+               activeApn['AccessPointName'] == accessPointName &&
+               activeApn['Username'] == apnDict['Username'] &&
+               activeApn['Password'] == apnDict['Password']) ||
+              ((activeApn == undefined || !activeApn['AccessPointName']) &&
+                lastGoodApn != undefined &&
+                lastGoodApn['AccessPointName'] == accessPointName &&
+                lastGoodApn['Username'] == apnDict['Username'] &&
+                lastGoodApn['Password'] == apnDict['Password'])) {
             data.selectedApn = i;
           }
           // Insert new option before "other" option.
           apnSelector.add(option, otherOption);
         }
-        if (data.selectedApn == -1 && data.apn.apn) {
+        if (data.selectedApn == -1 &&
+            activeApn != undefined && activeApn['AccessPointName']) {
           var option = document.createElement('option');
-          option.textContent = data.apn.apn;
+          option.textContent = activeApn['AccessPointName'];
           option.value = -1;
           apnSelector.add(option, otherOption);
           data.selectedApn = apnSelector.length - 2;
           data.userApnIndex = data.selectedApn;
         }
         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;
+        var lockEnabled =
+            getManagedValue(data, 'Cellular.SIMLockStatus.LockEnabled');
         $('sim-card-lock-enabled').checked = lockEnabled;
         $('change-pin').hidden = !lockEnabled;
       }
       $('auto-connect-network-cellular').checked =
           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;
@@ skipping 59 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
   };
 });