Networking.config: Implementation of the NetworkingConfigService

extensions/browser/api/networking_config/networking_config_service.h

+// 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.
+
+#ifndef CHROME_BROWSER_EXTENSIONS_API_NETWORKING_CONFIG_NETWORKING_CONFIG_SERVICE_H_
+#define CHROME_BROWSER_EXTENSIONS_API_NETWORKING_CONFIG_NETWORKING_CONFIG_SERVICE_H_

[stevenjb, 2015/01/29 17:51:35]

Fix all header guards.

[cschuet (SLOW), 2015/01/30 12:33:34]

Done.

+
+#include <map>
+#include <string>
+
+#include "base/memory/scoped_ptr.h"
+#include "base/scoped_observer.h"
+#include "components/keyed_service/core/keyed_service.h"
+#include "extensions/browser/event_router.h"
+#include "extensions/browser/extension_registry.h"
+#include "extensions/browser/extension_registry_observer.h"
+
+namespace extensions {
+

[stevenjb, 2015/01/29 17:51:35]

Brief comment describing the purpose of this class. Also, it's not clear from
the class name + description whether this is intended to implement the entire
networking_config API, or just the captive portal authentication portion. We
should make that clear.

[cschuet (SLOW), 2015/01/30 12:33:34]

Done.

+class NetworkingConfigService : public ExtensionRegistryObserver,
+                                public KeyedService {
+ public:
+  class EventDelegate {
+   public:
+    EventDelegate() {}
+    virtual ~EventDelegate() {}
+    virtual bool HasExtensionRegisteredForEvent(
+        const std::string& extension_id) const = 0;
+
+   private:
+    DISALLOW_COPY_AND_ASSIGN(EventDelegate);
+  };
+
+  // Indicates the authentication state of the portal.
+  enum AuthenticationState { NOTRY, TRYING, SUCCESS, REJECTED, FAILED };
+
+  // Provides information about the current authentication state of the portal.
+  struct AuthenticationResult {
+    AuthenticationResult();
+    ExtensionId extension_id;
+    std::string guid;
+    AuthenticationState authentication_state;

[stevenjb, 2015/01/29 17:51:35]

optional nit: We can now use:
authentication_state = NetworkingConfigService::NOTRY;
in the declaration. See Non-Static Class Member Initializers in
http://chromium-cpp.appspot.com/

[cschuet (SLOW), 2015/01/30 12:33:34]

Acknowledged.

+  };
+
+  // Note: |extension_registry| must outlive this class.
+  explicit NetworkingConfigService(scoped_ptr<EventDelegate> event_delegate,
+                                   ExtensionRegistry* extension_registry);

[stevenjb, 2015/01/29 17:51:35]

no explicit

[cschuet (SLOW), 2015/01/30 12:33:34]

Done.

+  ~NetworkingConfigService() override;
+
+  // ExtensionRegistryObserver
+  void OnExtensionUnloaded(content::BrowserContext* browser_context,
+                           const Extension* extension,
+                           UnloadedExtensionInfo::Reason reason) override;
+
+  // Returns the extension id registered for |hex_ssid|. If no extension is
+  // registered for this |hex_ssid|, the function returns an empty string.
+  // |hex_ssid|: SSID in hex encoding.
+  std::string GetExtensionIdForHexSsid(std::string hex_ssid) const;

[stevenjb, 2015/01/29 17:51:35]

nit: Is this the primary way we are going to determine whether or not a network
has an associated extension? If so we might want to name this 'Find' or 'Lookup.
'Get' kind of implies that it is expected or at least likely that the thing
being gotten exists.

[cschuet (SLOW), 2015/01/30 12:33:34]

Done.

+
+  // Returns true if the extension with id |extension_id| registered for
+  // |onCaptivePortalDetected| events, otherwise false.
+  bool HasExtensionRegisteredForEvent(std::string extension_id) const;
+
+  // Registers |hex_ssid| as being handled by the extension with extension ID
+  // |extension_id|. Returns true on success and false if another extension
+  // already registered for |hex_ssid|.
+  // |hex_ssid|:     SSID in hex encoding of the network to be registered.
+  // |extension_id|: extension ID of the extension handling captive portal
+  //                 authentication for this network.
+  bool RegisterHexSsid(std::string hex_ssid, const std::string& extension_id);

[stevenjb, 2015/01/29 17:51:35]

Are the above two methods going to be limited to captive portal events? If so,
we should rename the methods, if not we should update the comments to just refer
to 'events'.

[cschuet (SLOW), 2015/01/30 12:33:34]

I think that IsRegisteredForCaptivePortalEvent should be a captive portal
specific method, while RegisterHexSsid registers an SSID for a network in
general. In the future, when we implement more of the networking config
functionality, we will have to make the signature of this function richer to
give the extension the possibility to specify which events it is interested in.
Done.

+
+  // Unregisters extension with the ID |extension_id| removing all associated
+  // HexSSIDs from the map.
+  // |extension_id|: ID identifying the extenion to be removed
+  void UnregisterExtension(const std::string& extensionId);
+
+  // Returns the current AuthenticationResult.
+  const AuthenticationResult& GetAuthenticationResult() const;
+
+  // Sets the authentication_state to NOTRY and clears all other fields.
+  void ResetAuthenticationResult();
+
+  // Sets the current AuthenticationResult.
+  void SetAuthenticationResult(
+      const AuthenticationResult& authentication_result);
+
+ private:
+  AuthenticationResult authentication_result_;
+
+  ScopedObserver<ExtensionRegistry, ExtensionRegistryObserver>
+      registry_observer_;
+
+  scoped_ptr<EventDelegate> event_delegate_;
+
+  // This map associates a given hex encoded SSID to an extension entry.
+  std::map<std::string, std::string> hex_ssid_to_extension_id_;
+};
+
+}  // namespace extensions
+
+#endif  // CHROME_BROWSER_EXTENSIONS_API_NETWORKING_CONFIG_NETWORKING_CONFIG_SERVICE_H_