Compile chrome://settings, part 2: reduce from 950 to 400 errors

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 {{activationState: (string|undefined),
+ *             carriers: Array,
+ *             currentCarrierIndex; (number|undefined),
+ *             ipAutoConfig: boolean,
+ *             ipconfig: Object,
+ *             nameServerType: string,
+ *             restrictedPool: (string|undefined),
+ *             roamingState: (string|undefined),
+ *             savedIP: Object,
+ *             showActivateButton: (boolean|undefined)
+ *             showViewAccountButton: (boolean|undefined),
+ *             staticIP: Object}}
+ * Only the keys which had caused problems are declared in this typedef.
+ * There are many more of them.
+ * @see chrome/browser/ui/webui/options/chromeos/internet_options_handler.cc
+ */
+var InternetDetailedInfo;
+
 cr.define('options.internet', function() {
   var OncData = cr.onc.OncData;
   var Page = cr.ui.pageManager.Page;
   var PageManager = cr.ui.pageManager.PageManager;
   /** @const */ var IPAddressField = options.internet.IPAddressField;
 
+  var GetManagedTypes = {
+    ACTIVE: 0,
+    TRANSLATED: 1,
+    RECOMMENDED: 2
+  };
+
+  /**
+   * 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.
+   * @param {string=} opt_type 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, opt_type) {
+    var property = getManagedProperty(data, key);
+    if (Array.isArray(property) || typeof property != 'object')
+      return property;
+    if (opt_type == GetManagedTypes.RECOMMENDED)
+      return getRecommendedValue(property);
+    if (opt_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 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'];
+    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;
+  }
+
+  /**
+   * 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 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];
+  }
+
+  /**
+   * 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 {*} 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.
+   * @param {boolean} 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;
     }
   }
 
   /**
    * Helper function to update the properties of the data object from the
@@ skipping 20 matching lines @@
    * UI pref change handler.
    * @param {Event} e The update event.
    */
   function handlePrefUpdate(e) {
     DetailsInternetPage.getInstance().updateControls();
   }
 
   /**
    * Simple helper method for converting a field to a string. It is used to
    * easily assign an empty string from fields that may be unknown or undefined.
-   * @param {object} value that should be converted to a string.
+   * @param {Object} value that should be converted to a string.
    * @return {string} the result.
    */
   function stringFromValue(value) {
     return value ? String(value) : '';
   }
 
   /**
    * Sends the 'checked' state of a control to chrome for a network.
    * @param {string} path The service path of the network.
    * @param {string} message The message to send to chrome.
    * @param {HTMLInputElement} checkbox The checkbox storing the value to send.
    */
   function sendCheckedIfEnabled(path, message, checkbox) {
     if (!checkbox.hidden && !checkbox.disabled)
       chrome.send(message, [path, checkbox.checked ? 'true' : 'false']);
   }
 
   /////////////////////////////////////////////////////////////////////////////
   // DetailsInternetPage class:
 
   /**
    * Encapsulated handling of ChromeOS internet details overlay page.
    * @constructor
+   * @extends {cr.ui.pageManager.Page}
    */
   function DetailsInternetPage() {
-    Page.call(this, 'detailsInternetPage', null, 'details-internet-page');
+    Page.call(this, 'detailsInternetPage', '', 'details-internet-page');
   }
 
   cr.addSingletonGetter(DetailsInternetPage);
 
   DetailsInternetPage.prototype = {
     __proto__: Page.prototype,
 
     /** @override */
     initializePage: function() {
       Page.prototype.initializePage.call(this);
-      var params = parseQueryParams(window.location);
-      this.initializePageContents_(params);
-      this.showNetworkDetails_(params);
+      this.initializePageContents_();
+      this.showNetworkDetails_(parseQueryParams(window.location));
     },
 
     /**
      * Auto-activates the network details dialog if network information
      * is included in the URL.
+     * @param {Object} params
      */
     showNetworkDetails_: function(params) {

[Dan Beam, 2014/09/09 02:59:09]

remove |params| and instead:

var params = parseQueryParams(window.location);

[Vitaly Pavlenko, 2014/09/09 17:54:51]

Even "var params" can be inlined, is it ok?

       var servicePath = params.servicePath;
       if (!servicePath || !servicePath.length)
         return;
       var networkType = '';  // ignored for 'options'
       chrome.send('networkCommand', [networkType, servicePath, 'options']);
     },
 
     /**
      * Initializes the contents of the page.
      */
-    initializePageContents_: function(params) {
+    initializePageContents_: function() {
       $('details-internet-dismiss').addEventListener('click', function(event) {
         DetailsInternetPage.setDetails();
       });
 
       $('details-internet-login').addEventListener('click', function(event) {
         DetailsInternetPage.setDetails();
         DetailsInternetPage.loginFromDetails();
       });
 
       $('details-internet-disconnect').addEventListener('click',
@@ skipping 27 matching lines @@
       $('cellular-apn-use-default').addEventListener('click', function(event) {
         var data = $('connection-state').data;
         var onc = $('connection-state').onc;
         var apnSelector = $('select-apn');
 
         if (data.userApnIndex != -1) {
           apnSelector.remove(data.userApnIndex);
           data.userApnIndex = -1;
         }
 
-        var activeApn;
+        var activeApn = {};
         var iApn = -1;
         var apnList = onc.getActiveValue('Cellular.APNList');
         if (apnList != undefined && apnList.length > 0) {
           iApn = 0;
           var defaultApn = apnList[iApn];
           activeApn['AccessPointName'] =
               stringFromValue(defaultApn['AccessPointName']);
           activeApn['Username'] = stringFromValue(defaultApn['Username']);
           activeApn['Password'] = stringFromValue(defaultApn['Password']);
           chrome.send('setApn', [data.servicePath,
@@ skipping 349 matching lines @@
         var bannerText = 'proxyBanner' + controlledBy.charAt(0).toUpperCase() +
                          controlledBy.slice(1);
         $('banner-text').textContent = loadTimeData.getString(bannerText);
       }
     },
 
     /**
      * Handler for when the user clicks on the checkbox to allow a
      * single proxy usage.
      * @private
-     * @param {Event} e Click Event.
      */
-    toggleSingleProxy_: function(e) {
+    toggleSingleProxy_: function() {
       if ($('proxy-all-protocols').checked) {
         $('multi-proxy').hidden = true;
         $('single-proxy').hidden = false;
       } else {
         $('multi-proxy').hidden = false;
         $('single-proxy').hidden = true;
       }
     },
 
     /**
      * Handler for when the user clicks on the checkbox to enter
      * auto configuration URL.
      * @private
-     * @param {Event} e Click Event.
      */
-    handleAutoConfigProxy_: function(e) {
+    handleAutoConfigProxy_: function() {
       $('proxy-pac-url').disabled = !$('proxy-use-pac-url').checked;
     },
 
     /**
      * Handler for selecting a radio button that will disable the manual
      * controls.
      * @private
-     * @param {Event} e Click event.
      */
-    disableManualProxy_: function(e) {
+    disableManualProxy_: function(opt_e) {
       $('ignored-host-list').disabled = true;
       $('new-host').disabled = true;
       $('remove-host').disabled = true;
       $('add-host').disabled = true;
       $('proxy-all-protocols').disabled = true;
       $('proxy-host-name').disabled = true;
       $('proxy-host-port').disabled = true;
       $('proxy-host-single-name').disabled = true;
       $('proxy-host-single-port').disabled = true;
       $('secure-proxy-host-name').disabled = true;
       $('secure-proxy-port').disabled = true;
       $('ftp-proxy').disabled = true;
       $('ftp-proxy-port').disabled = true;
       $('socks-host').disabled = true;
       $('socks-port').disabled = true;
       $('proxy-use-pac-url').disabled = $('auto-proxy').disabled ||
                                         !$('auto-proxy').checked;
       $('proxy-pac-url').disabled = $('proxy-use-pac-url').disabled ||
                                     !$('proxy-use-pac-url').checked;
       $('auto-proxy-parms').hidden = !$('auto-proxy').checked;
       $('manual-proxy-parms').hidden = !$('manual-proxy').checked;
       chrome.send('coreOptionsUserMetricsAction',
                   ['Options_NetworkManualProxy_Disable']);
     },
 
     /**
      * Handler for selecting a radio button that will enable the manual
      * controls.
      * @private
-     * @param {Event} e Click event.
      */
-    enableManualProxy_: function(e) {
+    enableManualProxy_: function(opt_e) {
       $('ignored-host-list').redraw();
       var allDisabled = $('manual-proxy').disabled;
       $('ignored-host-list').disabled = allDisabled;
       $('new-host').disabled = allDisabled;
       $('remove-host').disabled = allDisabled;
       $('add-host').disabled = allDisabled;
       $('proxy-all-protocols').disabled = allDisabled;
       $('proxy-host-name').disabled = allDisabled;
       $('proxy-host-port').disabled = allDisabled;
       $('proxy-host-single-name').disabled = allDisabled;
@@ skipping 152 matching lines @@
     if (data.type == 'Cellular')
       chrome.send('networkCommand', [data.type, servicePath, 'activate']);
     PageManager.closeOverlay();
   };
 
   DetailsInternetPage.setDetails = function() {
     var data = $('connection-state').data;
     var servicePath = data.servicePath;
     if (data.type == 'WiFi') {
       sendCheckedIfEnabled(servicePath, 'setPreferNetwork',
-                           $('prefer-network-wifi'));
+          assertInstanceof($('prefer-network-wifi'), HTMLInputElement));
       sendCheckedIfEnabled(servicePath, 'setAutoConnect',
-                           $('auto-connect-network-wifi'));
+          assertInstanceof($('auto-connect-network-wifi'), HTMLInputElement));
     } else if (data.type == 'Wimax') {
       sendCheckedIfEnabled(servicePath, 'setAutoConnect',
-                           $('auto-connect-network-wimax'));
+          assertInstanceof($('auto-connect-network-wimax'), HTMLInputElement));
     } else if (data.type == 'Cellular') {
       sendCheckedIfEnabled(servicePath, 'setAutoConnect',
-                           $('auto-connect-network-cellular'));
+          assertInstanceof($('auto-connect-network-cellular'),
+                           HTMLInputElement));
     } else if (data.type == 'VPN') {
       chrome.send('setServerHostname',
                   [servicePath,
                    $('inet-server-hostname').value]);
       sendCheckedIfEnabled(servicePath, 'setAutoConnect',
-                           $('auto-connect-network-vpn'));
+          assertInstanceof($('auto-connect-network-vpn'), HTMLInputElement));
     }
 
     var nameServerTypes = ['automatic', 'google', 'user'];
     var nameServerType = 'automatic';
     for (var i = 0; i < nameServerTypes.length; ++i) {
       if ($(nameServerTypes[i] + '-dns-radio').checked) {
         nameServerType = nameServerTypes[i];
         break;
       }
     }
@@ skipping 110 matching lines @@
 
     this.updateConnectionButtonVisibilty(onc);
 
     if (onc.type == 'WiFi') {
       $('wifi-connection-state').textContent = connectionStateString;
     } else if (onc.type == 'Wimax') {
       $('wimax-connection-state').textContent = connectionStateString;
     } else if (onc.type == 'Cellular') {
       $('activation-state').textContent = data.activationState;
 
-      $('buyplan-details').hidden = !data.showBuyButton;
+      $('buyplan-details').hidden = true;
       $('view-account-details').hidden = !data.showViewAccountButton;
 
       $('activate-details').hidden = !data.showActivateButton;
       if (data.showActivateButton)
         $('details-internet-login').hidden = true;
 
       if (detailsPage.gsm) {
         var lockEnabled =
             onc.getActiveValue('Cellular.SIMLockStatus.LockEnabled');
         $('sim-card-lock-enabled').checked = lockEnabled;
         $('change-pin').hidden = !lockEnabled;
       }
     }
 
     $('connection-state').data = data;
     $('connection-state').onc = onc;
   };
 
+  /**
+   * @param {InternetDetailedInfo} data
+   */
   DetailsInternetPage.showDetailedInfo = function(data) {
     var detailsPage = DetailsInternetPage.getInstance();
 
     var onc = new OncData(data);
     data.type = onc.type;
 
     // Populate header
     $('network-details-title').textContent = onc.getTranslatedValue('Name');
     var connectionState = onc.getActiveValue('ConnectionState');
     var connectionStateString = onc.getTranslatedValue('ConnectionState');
@@ skipping 324 matching lines @@
         updateHidden('.apn-details-view', true);
         var lockEnabled =
             onc.getActiveValue('Cellular.SIMLockStatus.LockEnabled');
         $('sim-card-lock-enabled').checked = lockEnabled;
         $('change-pin').hidden = !lockEnabled;
       }
       $('auto-connect-network-cellular').checked =
           onc.getActiveValue('AutoConnect');
       $('auto-connect-network-cellular').disabled = false;
 
-      $('buyplan-details').hidden = !data.showBuyButton;
+      $('buyplan-details').hidden = true;
       $('view-account-details').hidden = !data.showViewAccountButton;
       $('activate-details').hidden = !data.showActivateButton;
       if (data.showActivateButton) {
         $('details-internet-login').hidden = true;
       }
     } else if (onc.type == 'VPN') {
       OptionsPage.showTab($('vpn-nav-tab'));
       detailsPage.gsm = false;
       $('inet-service-name').textContent = networkName;
       $('inet-provider-type').textContent =
@@ skipping 50 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
   };
 });