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

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview ONC Data support class. Wraps a dictionary object containing
   7  * ONC managed or unmanaged dictionaries. Supports nested dictionaries,
   8  * e.g. data.getManagedProperty('VPN.Type').
   9  */
  10
  11 cr.exportPath('cr.onc');
  12
  13 cr.define('cr.onc', function() {
  14   'use strict';
  15
  16   /**
  17    * @constructor
  18    */
  19   function OncData(data) {
  20     this.data_ = data;
  21   }
  22
  23   OncData.prototype = {
  24
  25     /**
  26      * Returns either a managed property dictionary or an unmanaged value.
  27      * @param {string} key The property key.
  28      * @return {?} The property value or dictionary if it exists, otherwise
  29      *     undefined.
  30      */
  31     getManagedProperty: function(key) {
  32       var data = this.data_;
  33       while (true) {
  34         var index = key.indexOf('.');
  35         if (index < 0)
  36           break;
  37         var keyComponent = key.substr(0, index);
  38         if (!(keyComponent in data))
  39           return undefined;
  40         data = data[keyComponent];
  41         key = key.substr(index + 1);
  42       }
  43       return data[key];
  44     },
  45
  46     /**
  47      * Sets the value of a property. Currently only supports unmanaged
  48      * properties.
  49      * @param {string} key The property key.
  50      * @param {?} value The property value to set.
  51      */
  52     setProperty: function(key, value) {
  53       var data = this.data_;
  54       while (true) {
  55         var index = key.indexOf('.');
  56         if (index < 0)
  57           break;
  58         var keyComponent = key.substr(0, index);
  59         if (!(keyComponent in data))
  60           data[keyComponent] = {};
  61         data = data[keyComponent];
  62         key = key.substr(index + 1);
  63       }
  64       if (!(key in data) ||
  65           (typeof data[key] != 'object') ||
  66           (!('Active' in data[key]) && !('Effective' in data[key]))) {
  67         data[key] = value;
  68       } else {
  69         var effective = data[key]['Effective'];
  70         assert(effective != 'UserPolicy' || data[key]['UserEditable']);
  71         assert(effective != 'DevicePolicy' || data[key]['DeviceEditable']);
  72         // For now, just update the active value. TODO(stevenjb): Eventually we
  73         // should update the 'UserSetting' and 'Effective' properties correctly
  74         // and send that back to Chrome.
  75         data[key]['Active'] = value;
  76       }
  77     },
  78
  79     /**
  80      * Gets the active value of a property.
  81      * @param {string} key The property key.
  82      * @return {?} The property value or undefined.
  83      */
  84     getActiveValue: function(key) {
  85       var property = this.getManagedProperty(key);
  86       if (Array.isArray(property) || typeof property != 'object')
  87         return property;
  88       // Otherwise get the Active value (default behavior).
  89       if ('Active' in property)
  90         return property['Active'];
  91       // If no Active value is defined, return the effective value if present.
  92       var effective = this.getEffectiveValueFromProperty_(
  93           /** @type {Object} */(property));
  94       if (effective != undefined)
  95         return effective;
  96       // Otherwise this is an Object but not a Managed one.
  97       return property;
  98     },
  99
 100     /**
 101      * Gets the translated ONC value from the result of getActiveValue() using
 102      * loadTimeData. If no translation exists, returns the untranslated value.
 103      * @param {string} key The property key.
 104      * @return {?} The translation if available or the value if not.
 105      */
 106     getTranslatedValue: function(key) {
 107       var value = this.getActiveValue(key);
 108       if (typeof value != 'string')
 109         return value;
 110       var oncString = 'Onc' + key + value;
 111       // Handle special cases
 112       if (key == 'Name' && this.getActiveValue('Type') == 'Ethernet')
 113         return loadTimeData.getString('ethernetName');
 114       if (key == 'VPN.Type' && value == 'L2TP-IPsec') {
 115         var auth = this.getActiveValue('VPN.IPsec.AuthenticationType');
 116         if (auth != undefined)
 117           oncString += auth;
 118       }
 119       oncString = oncString.replace(/\./g, '-');
 120       if (loadTimeData.valueExists(oncString))
 121         return loadTimeData.getString(oncString);
 122       return value;
 123     },
 124
 125     /**
 126      * Gets the recommended value of a property.
 127      * @param {string} key The property key.
 128      * @return {?} The property value or undefined.
 129      */
 130     getRecommendedValue: function(key) {
 131       var property = this.getManagedProperty(key);
 132       if (Array.isArray(property) || typeof property != 'object')
 133         return undefined;
 134       if (property['UserEditable'])
 135         return property['UserPolicy'];
 136       if (property['DeviceEditable'])
 137         return property['DevicePolicy'];
 138       // No value recommended by policy.
 139       return undefined;
 140     },
 141
 142     /**
 143      * Returns the Source of this configuration. If undefined returns 'None'.
 144      * @return {string} The configuration source: 'None', 'User', 'Device',
 145      *                  'UserPolicy', or 'DevicePolicy'.
 146      */
 147     getSource: function() {
 148       var source = this.getActiveValue('Source');
 149       if (source == undefined)
 150         return 'None';
 151       assert(typeof source == 'string');
 152       return source;
 153     },
 154
 155     /**
 156      * Returns the WiFi security type (defaults to 'None').
 157      * @return {string} The security type.
 158      */
 159     getWiFiSecurity: function() {
 160       var security = this.getActiveValue('WiFi.Security');
 161       if (security == undefined)
 162         return 'None';
 163       assert(typeof security == 'string');
 164       return security;
 165     },
 166
 167     /**
 168      * Get the effective value from a Managed property ONC dictionary.
 169      * @param {Object} property The managed property ONC dictionary.
 170      * @return {?} The effective value or undefined.
 171      * @private
 172      */
 173     getEffectiveValueFromProperty_: function(property) {
 174       if ('Effective' in property) {
 175         var effective = property.Effective;
 176         if (effective in property)
 177           return property[effective];
 178       }
 179       return undefined;
 180     },
 181
 182     /**
 183      * Returns the complete ONC dictionary.
 184      */
 185     getData: function() {
 186       return this.data_;
 187     }
 188   };
 189
 190   return {
 191     OncData: OncData
 192   };
 193 });