Add types to networkigPrivate IDL

extensions/common/api/networking_private.idl

 // Copyright 2015 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.
 
 // The <code>chrome.networkingPrivate</code> API is used for configuring
 // network connections (Cellular, Ethernet, VPN, WiFi or WiMAX). This private
 // API is only valid if called from a browser or app associated with the
 // primary user. See the Open Network Configuration (ONC) documentation for
 // descriptions of properties: 
 // src/components/onc/docs/onc_spec.html, also available at 
 // http://www.chromium.org/chromium-os/chromiumos-design-docs/open-network-configuration

[pneubeck (no reviews), 2015/03/27 19:13:43]

please check what the notation for urls was

[stevenjb, 2015/03/27 22:11:14]

Done.

+//
+// NOTE: Most dictionary properties and enum values use UpperCamelCase to match
+// the ONC spec instead of the JavaScript lowerCamelCase convention.
+//
+// "State" properties describe just the ONC properties returned by

[pneubeck (no reviews), 2015/03/27 19:13:43]

an alternative naming scheme to StateProperties vs ConfigProperties
could be simply 'State' and 'Config'
like WiFiState and WiFiConfig

if it's used for both, maybe WiFiProperties

[stevenjb, 2015/03/27 22:11:15]

I think I prefer the 'Properties'. It makes it a little more explicit in the JS
what is an enum and what is a dictionary.

+// $(ref:networkingPrivate.getState) and $(ref:networkingPrivate.getNetworks).
+//
+// "Config" properties describe just the ONC properties that can be configured

[pneubeck (no reviews), 2015/03/27 19:13:43]

we'll really have to add the dictionary inheritance to the IDL parser, otherwise
this is not maintainable/scalable:

every Config dictionary will copy all members of the according State dictionary.
Hopefully IDL allows concretizing the type of a member in the derived
dictionary, otherwise this will conflict with the parallel hierarchy of State
and Config.

[stevenjb, 2015/03/27 22:11:15]

We should discuss this at some point, but it fact the Config and State
properties don't have a lot of overlap. It's the "Complete" property sets (i.e.
everything returned by Get{Managed}Properties, currently just an object) that
are a superset of the two. (Note: In the C++ code, "State" == "Complete", where
as here it refers to the result of getState. This is unfortunate, but I'm not
sure what to do about that).

+// through this API. NOTE: Not all configuration propertes are exposed at this 

[pneubeck (no reviews), 2015/03/27 19:13:43]

propertes -> properties

[stevenjb, 2015/03/27 22:11:14]

Done.

+// time, only those currently required by the Chrome Settings UI.
+// TODO(stevenjb): Provide all configuration properties and types, 
+// crbug.com/380937.
+//
 // TODO(stevenjb/pneubeck): Merge the ONC documentation with this document and
 // use it as the ONC specification.
 
 namespace networkingPrivate {
+  enum ActivationStateType {
+    Activated, Activating, NotActivated, PartiallyActivated
+  };
+
   enum CaptivePortalStatus {
     Unknown, Offline, Online, Portal, ProxyAuthRequired
   };
 
+  enum ConnectionStateType {
+    Connected, Connecting, NotConnected
+  };
+
+  enum IPConfigType {
+    DHCP, Static
+  };
+
   enum NetworkType {
     All, Bluetooth, Cellular, Ethernet, VPN, Wireless, WiFi, WiMAX
   };
 
+  dictionary APNProperties {

[pneubeck (no reviews), 2015/03/27 19:13:43]

neither Config* nor StateProperties
but this is maybe on purpose.

[stevenjb, 2015/03/27 22:11:15]

For sub-dictionaries that can be used in either I didn't specify.

+    DOMString? AccessPointName;
+    DOMString? Language;
+    DOMString? LocalizedName;
+    DOMString? Name;
+    DOMString? Password;
+    DOMString? Username;
+  };
+
+  dictionary CellularConfigProperties {
+    boolean? AutoConnect;
+    APNProperties? APN;
+  };
+
+  dictionary CellularStateProperties {
+    ActivationStateType? ActivationState;
+    DOMString? NetworkTechnology;
+    boolean? OutOfCredits;

[pneubeck (no reviews), 2015/03/27 19:13:43]

can't find this in onc_signature.cc nor onc_spec

[stevenjb, 2015/03/27 22:11:15]

Looks like we don't translate it. I think we used to use to determine whether or
not to show a "carrier info" button, but I simplified that (ridiculously
complex) logic at one point to err on the side of just showing the button.
Removed.

+    DOMString? RoamingState;
+    long? SignalStrength;
+  };
+
+  dictionary EthernetStateProperties {
+    DOMString? Authentication;

[pneubeck (no reviews), 2015/03/27 19:13:44]

mandatory

[stevenjb, 2015/03/27 22:11:15]

Done.

+  };
+
+  dictionary IPConfigProperties {

[pneubeck (no reviews), 2015/03/27 19:13:43]

neither Config* nor StateProperties
but this is maybe on purpose.

(would have to be called IPConfigConfigProperties, which is very weird)

[stevenjb, 2015/03/27 22:11:15]

Yeah, "IPConfig" is unfortunately named. I think we just live with it, even
though it is used for both State and Config.

+    DOMString? Gateway;
+    DOMString? IPAddress;
+    DOMString[]? NameServers;
+    long? RoutingPrefix;
+    DOMString? Type;
+    DOMString? WebProxyAutoDiscoveryUrl;
+  };
+
+  dictionary IPSecProperties {

[pneubeck (no reviews), 2015/03/27 19:13:44]

neither Config* nor StateProperties
but this is maybe on purpose.

[stevenjb, 2015/03/27 22:11:15]

Also on purpose.

+    DOMString? AuthenticationType;

[pneubeck (no reviews), 2015/03/27 19:13:44]

mandatory in state

[stevenjb, 2015/03/27 22:11:15]

Done.

+  };
+
+  dictionary ThirdPartyVPNProperties {

[pneubeck (no reviews), 2015/03/27 19:13:44]

neither Config* nor StateProperties
but this is maybe on purpose.

[stevenjb, 2015/03/27 22:11:14]

Correct.

+    DOMString ExtensionID;
+  };
+    
+  dictionary VPNConfigProperties {
+    boolean? AutoConnect;
+    DOMString? Host;
+    ThirdPartyVPNProperties? ThirdPartyVPN;
+    DOMString? Type;
+  };
+
+  dictionary VPNStateProperties {
+    DOMString? Type;

[pneubeck (no reviews), 2015/03/27 19:13:43]

mandatory

[stevenjb, 2015/03/27 22:11:15]

Done.

+    IPSecProperties? IPsec;
+    ThirdPartyVPNProperties? ThirdPartyVPN;
+  };
+
+  dictionary WiFiConfigProperties {
+    boolean? AutoConnect;
+    DOMString? HexSSID;
+    DOMString? HiddenSSID;

[pneubeck (no reviews), 2015/03/27 19:13:43]

must be bool not string

[stevenjb, 2015/03/27 22:11:14]

Oops. Done.

+    DOMString? Passphrase;
+    DOMString? SSID;
+    DOMString? Security;
+  };
+
+  dictionary WiFiStateProperties {
+    DOMString? Security;

[pneubeck (no reviews), 2015/03/27 19:13:43]

mandatory

[stevenjb, 2015/03/27 22:11:15]

Done.

+    long? SignalStrength;

[pneubeck (no reviews), 2015/03/27 19:13:44]

wasn't this always set, i.e. 0 for not-visible
then it should be mandatory

[stevenjb, 2015/03/27 22:11:15]

Actually, for non-visible networks we don't provide SignalStrength at all.

+  };
+
+  dictionary WiMaxConfigProperties {
+    boolean? AutoConnect;
+  };
+
+  dictionary WiMAXStateProperties {
+    long? SignalStrength;

[pneubeck (no reviews), 2015/03/27 19:13:44]

same as for wifi

[stevenjb, 2015/03/27 22:11:15]

Ditto.

+  };
+
+  dictionary NetworkConfigProperties {
+    CellularConfigProperties? Cellular;
+    DOMString? GUID;
+    IPConfigType? IPAddressConfigType;
+    DOMString? Name;
+    IPConfigType? NameServersConfigType;
+    long? Priority;
+    IPConfigProperties? StaticIPConfig;
+    NetworkType? Type;
+    VPNConfigProperties? VPN;
+    WiFiConfigProperties? WiFi;
+    WiMaxConfigProperties? WiMAX;
+  };
+
+  dictionary NetworkStateProperties {
+    CellularStateProperties? Cellular;
+    boolean? Connectable;
+    ConnectionStateType? ConnectionState;
+    EthernetStateProperties? Ethernet;
+    DOMString? ErrorState;
+    DOMString GUID;
+    DOMString? Name;
+    long? Priority;
+    DOMString? Source;
+    NetworkType Type;
+    VPNStateProperties? VPN;
+    WiFiStateProperties? WiFi;
+    WiMAXStateProperties? WiMAX;
+  };
+
   dictionary VerificationProperties {
     // A string containing a PEM-encoded (including the 'BEGIN CERTIFICATE'
     // header and 'END CERTIFICATE' footer) X.509 certificate for use in
     // verifying the signed data.
     DOMString certificate;
 
     // An array of PEM-encoded X.509 intermediate certificate authority
     // certificates. Each PEM-encoded certificate is expected to have the
     // 'BEGIN CERTIFICATE' header and 'END CERTIFICATE' footer.
     DOMString[]? intermediateCertificates;
@@ skipping 38 matching lines @@
     long? limit;
   };
 
   callback VoidCallback = void();
   callback BooleanCallback = void(boolean result);
   callback StringCallback = void(DOMString result);
   // TODO(stevenjb): Use NetworkProperties for |result| once defined.
   callback GetPropertiesCallback = void(object result);
   // TODO(stevenjb): Use ManagedNetworkProperties for |result| once defined.
   callback GetManagedPropertiesCallback = void(object result);
-  callback GetStatePropertiesCallback = void(object result);
-  callback GetNetworksCallback = void(object[] result);
+  callback GetStatePropertiesCallback = void(NetworkStateProperties result);
+  callback GetNetworksCallback = void(NetworkStateProperties[] result);
   callback GetEnabledNetworkTypesCallback = void(NetworkType[] result);
   callback CaptivePortalStatusCallback = void(CaptivePortalStatus result);
 
   // These functions all report failures via chrome.runtime.lastError.
   interface Functions {
     // Gets all the properties of the network with id networkGuid. Includes all
     // properties of the network (read-only and read/write values).
     // |networkGuid|: The identifier of the network to get properties for.
     // |callback|: Returns the properties of the network.
     static void getProperties(DOMString networkGuid,
@@ skipping 18 matching lines @@
     // |networkGuid|: The identifier of the network to get properties for.
     // |callback|: Returns the managed properties of the network.
     static void getState(DOMString networkGuid,
                          GetStatePropertiesCallback callback);
 
     // Sets the properties of the network with id networkGuid.
     // |networkGuid|: The identifier of the network to set properties for.
     // |properties|: The ONC properties to set.
     // |callback|: Called when the operation has completed.
     static void setProperties(DOMString networkGuid,
-                              object properties,
+                              NetworkConfigProperties properties,
                               optional VoidCallback callback);
 
     // Creates a new network configuration from properties. If a matching
     // configured network already exists, this will fail. Otherwise returns the
     // guid of the new network.
     // |shared|: If true, share this network configuration with other users.
     // |properties|: The ONC properties to configure the new network with.
     // |callback|: Returns the identifier of the created network.
     static void createNetwork(boolean shared,
-                              object properties,
+                              NetworkConfigProperties properties,
                               optional StringCallback callback);
 
     // Forgets a network configuration by clearing any configured properties for
     // the network with GUID 'networkGuid'. This may also include any other
     // networks with matching identifiers (e.g. WiFi SSID and Security). If no
     // such configuration exists, an error will be set and the operation will
     // fail.
     static void forgetNetwork(DOMString networkGuid,
                               optional VoidCallback callback);
 
@@ skipping 116 matching lines @@
     // Fired when the list of networks has changed.  Sends a complete list of
     // identifiers for all the current networks.
     static void onNetworkListChanged(DOMString[] changes);
 
     // Fired when a portal detection for a network completes. Sends the guid of
     // the network and the corresponding captive portal status.
     static void onPortalDetectionCompleted(DOMString networkGuid,
                                            CaptivePortalStatus status);
   };
 };