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])) {

[pneubeck (no reviews), 2014/08/22 08:55:32]

Active might not be present if the value from Shill is not translated back,
which should be legitimate in some cases.

Checking 'Active' and 'Effective' should be sufficiently safe.

[stevenjb, 2014/08/22 17:08:43]

Done.

+      data[key] = value;
+    } else {
+      // For now, just uodare the active value. TODO(stevenjb): Possibly check

[pneubeck (no reviews), 2014/08/22 08:55:32]

typo: uodare -> update

[stevenjb, 2014/08/22 17:08:43]

Done.

+      // the policy attributes and update appropriately.
+      data[key]['Active'] = value;

[pneubeck (no reviews), 2014/08/22 08:55:32]

If I get it right, then you want to use the ONC properties in |data| to store
the transient state of the UI?

To be consistent with the data structure as it is received initially from C++,
this should update:

'Active' = value
if (value != undefined) {
  'UserSetting' = value
  'Effective' = 'UserSetting'
} else {
  remove 'UserSetting'
  if ('Effective' == 'UserSetting') {
    // In general, this case is problematic, as 'Effective' should now be set to
something else than 'UserSetting'.
    // For Cellular where you know that there is no policy, you could just
remove the 'Effective' field.
  }
}
Maybe you want to double-check that 'UserEditable' or 'DeviceEditable' was true
and fail otherwise.


A more reliable approach might be to send the update request to C++, and let C++
send a new dictionary (the whole one or only for this value) to JS. That way you
would get information about whether the setting could be actually applied and
you would not have to fake the data structure.

[stevenjb, 2014/08/22 17:08:43]

My intention was to do something better than clobber any ONC properties, but not
as thorough as you describe (thus the TODO). This is only designed to update the
locally cached value.

I will add a couple of asserts, but we certainly don't want to do a round-trip
here, that's a level of refactoring I think we should avoid until we have
eliminated the C++ glue code.

+    }
+  }
+
+  /**
    * 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['APN'] = stringFromValue(defaultApn['APN']);
+          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['APN'],
+                                 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['APN'] = 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['APN'],
+                               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['APN'];
         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');
         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);
+          var 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['Name']),

[armansito, 2014/08/22 00:56:45]

Shouldn't this be 'APN' rather than 'Name'?

[stevenjb, 2014/08/22 17:08:43]

Done.

+                                 stringFromValue(apnDict['Username']),
+                                 stringFromValue(apnDict['Password'])]);
+          data.selectedApn = apnIndex;
         } else if (apnSelector.selectedIndex == data.userApnIndex) {
           chrome.send('setApn', [data.servicePath,
                                  stringFromValue(data.userApn.apn),
                                  stringFromValue(data.userApn.username),
                                  stringFromValue(data.userApn.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);
+          var activeApn = getManagedValue(data, 'Cellular.APN');
+          $('cellular-apn').value = stringFromValue(activeApn['APN']);
+          $('cellular-apn-username').value =
+              stringFromValue(activeApn['Username']);
+          $('cellular-apn-password').value =
+              stringFromValue(activeApn['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 276 matching lines @@
       updateHidden('#details-internet-page .cdma-only', false);
 
       // Show IMEI/ESN/MEID/MIN/PRL only if they are available.
       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 = getManagedValue(data, 'Cellular.GSM');
+      var family = getManagedValue(data, 'Cellular.Family');
       detailsPage.gsm = family == 'GSM';
       if (detailsPage.gsm) {
         $('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');
+        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;
+          var localizedName = apnDict['LocalizedName'];
+          var name = localizedName ? localizedName : apnDict['Name'];
+          var apn = apnDict['APN'];
           option.textContent = name ? (name + ' (' + apn + ')') : apn;
           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['APN'] == apn &&
+               activeApn['Username'] == apnDict['Username'] &&
+               activeApn['Password'] == apnDict['Password']) ||
+              ((activeApn == undefined || !activeApn['APN']) &&
+                lastGoodApn != undefined &&
+                lastGoodApn['APN'] == apn &&
+                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['APN']) {
           var option = document.createElement('option');
-          option.textContent = data.apn.apn;
+          option.textContent = activeApn['APN'];
           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
   };
 });