// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef EXTENSIONS_BROWSER_API_NETWORKING_PRIVATE_NETWORKING_PRIVATE_SERVICE_CLIENT_H_
#define EXTENSIONS_BROWSER_API_NETWORKING_PRIVATE_NETWORKING_PRIVATE_SERVICE_CLIENT_H_
#include <stdint.h>
#include <memory>
#include <string>
#include <vector>
#include "base/containers/id_map.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "base/values.h"
#include "components/wifi/wifi_service.h"
#include "extensions/browser/api/networking_private/networking_private_delegate.h"
#include "services/network/public/cpp/network_connection_tracker.h"
namespace base {
class SequencedTaskRunner;
}
namespace extensions {
// Windows / Mac NetworkingPrivateApi implementation. This implements
// NetworkingPrivateDelegate, making WiFiService calls on the worker thead.
// It also observes |OnNetworkChanged| notifications and posts them to
// WiFiService on the worker thread. Created and called from the UI thread.
class NetworkingPrivateServiceClient
: public NetworkingPrivateDelegate,
network::NetworkConnectionTracker::NetworkConnectionObserver {
public:
// Takes ownership of |wifi_service| which is accessed and deleted on the
// worker thread. The deletion task is posted from the destructor.
explicit NetworkingPrivateServiceClient(
std::unique_ptr<wifi::WiFiService> wifi_service);
~NetworkingPrivateServiceClient() override;
NetworkingPrivateServiceClient(const NetworkingPrivateServiceClient&) =
delete;
NetworkingPrivateServiceClient& operator=(
const NetworkingPrivateServiceClient&) = delete;
// KeyedService
void Shutdown() override;
// NetworkingPrivateDelegate
void GetProperties(const std::string& guid,
PropertiesCallback callback) override;
void GetManagedProperties(const std::string& guid,
PropertiesCallback callback) override;
void GetState(const std::string& guid,
DictionaryCallback success_callback,
FailureCallback failure_callback) override;
void SetProperties(const std::string& guid,
base::Value::Dict properties_dict,
bool allow_set_shared_config,
VoidCallback success_callback,
FailureCallback failure_callback) override;
void CreateNetwork(bool shared,
base::Value::Dict properties_dict,
StringCallback success_callback,
FailureCallback failure_callback) override;
void ForgetNetwork(const std::string& guid,
bool allow_forget_shared_config,
VoidCallback success_callback,
FailureCallback failure_callback) override;
void GetNetworks(const std::string& network_type,
bool configured_only,
bool visible_only,
int limit,
NetworkListCallback success_callback,
FailureCallback failure_callback) override;
void StartConnect(const std::string& guid,
VoidCallback success_callback,
FailureCallback failure_callback) override;
void StartDisconnect(const std::string& guid,
VoidCallback success_callback,
FailureCallback failure_callback) override;
void GetCaptivePortalStatus(const std::string& guid,
StringCallback success_callback,
FailureCallback failure_callback) override;
void UnlockCellularSim(const std::string& guid,
const std::string& pin,
const std::string& puk,
VoidCallback success_callback,
FailureCallback failure_callback) override;
void SetCellularSimState(const std::string& guid,
bool require_pin,
const std::string& current_pin,
const std::string& new_pin,
VoidCallback success_callback,
FailureCallback failure_callback) override;
void SelectCellularMobileNetwork(const std::string& guid,
const std::string& network_id,
VoidCallback success_callback,
FailureCallback failure_callback) override;
void GetEnabledNetworkTypes(EnabledNetworkTypesCallback callback) override;
void GetDeviceStateList(DeviceStateListCallback callback) override;
void GetGlobalPolicy(GetGlobalPolicyCallback callback) override;
void GetCertificateLists(GetCertificateListsCallback callback) override;
void EnableNetworkType(const std::string& type,
BoolCallback callback) override;
void DisableNetworkType(const std::string& type,
BoolCallback callback) override;
void RequestScan(const std::string& type, BoolCallback callback) override;
void AddObserver(NetworkingPrivateDelegateObserver* observer) override;
void RemoveObserver(NetworkingPrivateDelegateObserver* observer) override;
// NetworkConnectionTracker::NetworkConnectionObserver implementation.
void OnConnectionChanged(network::mojom::ConnectionType type) override;
private:
// Callbacks to extension api function objects. Keep reference to API object
// and are released in ShutdownOnUIThread. Run when WiFiService calls back
// into NetworkingPrivateServiceClient's callback wrappers.
using ServiceCallbacksID = int32_t;
struct ServiceCallbacks {
ServiceCallbacks();
~ServiceCallbacks();
DictionaryCallback get_properties_callback;
VoidCallback start_connect_callback;
VoidCallback start_disconnect_callback;
VoidCallback set_properties_callback;
StringCallback create_network_callback;
NetworkListCallback get_visible_networks_callback;
FailureCallback failure_callback;
ServiceCallbacksID id;
};
using ServiceCallbacksMap = base::IDMap<std::unique_ptr<ServiceCallbacks>>;
// Callback wrappers.
void AfterGetProperties(PropertiesCallback callback,
const std::string& network_guid,
std::unique_ptr<base::Value::Dict> properties,
const std::string* error);
void AfterGetState(ServiceCallbacksID callback_id,
const std::string& network_guid,
std::unique_ptr<base::Value::Dict> properties,
const std::string* error);
void AfterSetProperties(ServiceCallbacksID callback_id,
const std::string* error);
void AfterCreateNetwork(ServiceCallbacksID callback_id,
const std::string* network_guid,
const std::string* error);
void AfterGetVisibleNetworks(ServiceCallbacksID callback_id,
std::unique_ptr<base::Value::List> networks);
void AfterStartConnect(ServiceCallbacksID callback_id,
const std::string* error);
void AfterStartDisconnect(ServiceCallbacksID callback_id,
const std::string* error);
void OnNetworksChangedEventOnUIThread(
const wifi::WiFiService::NetworkGuidList& network_guid_list);
void OnNetworkListChangedEventOnUIThread(
const wifi::WiFiService::NetworkGuidList& network_guid_list);
// Add new |ServiceCallbacks| to |callbacks_map_|.
ServiceCallbacks* AddServiceCallbacks();
// Removes ServiceCallbacks for |callback_id| from |callbacks_map_|.
void RemoveServiceCallbacks(ServiceCallbacksID callback_id);
// Callbacks to run when callback is called from WiFiService.
ServiceCallbacksMap callbacks_map_;
// Observers to Network Events.
base::ObserverList<NetworkingPrivateDelegateObserver>::Unchecked
network_events_observers_;
// Interface to WiFiService. Used and deleted on the worker thread.
std::unique_ptr<wifi::WiFiService> wifi_service_;
// Task runner for worker tasks.
scoped_refptr<base::SequencedTaskRunner> task_runner_;
// Use WeakPtrs for callbacks from |wifi_service_|.
base::WeakPtrFactory<NetworkingPrivateServiceClient> weak_factory_{this};
};
} // namespace extensions
#endif // EXTENSIONS_BROWSER_API_NETWORKING_PRIVATE_NETWORKING_PRIVATE_SERVICE_CLIENT_H_