// Copyright 2013 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_UTILITY_WIFI_WIFI_SERVICE_H_
#define CHROME_UTILITY_WIFI_WIFI_SERVICE_H_
#include <list>
#include <set>
#include <string>
#include <vector>
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "base/message_loop/message_loop_proxy.h"
#include "base/threading/sequenced_worker_pool.h"
#include "base/values.h"
#include "components/wifi/wifi_export.h"
namespace wifi {
// WiFiService interface used by implementation of chrome.networkingPrivate
// JavaScript extension API. All methods should be called on worker thread.
// It could be created on any (including UI) thread, so nothing expensive should
// be done in the constructor. See |NetworkingPrivateService| for wrapper
// accessible on UI thread.
class WIFI_EXPORT WiFiService {
public:
typedef std::vector<std::string> NetworkGuidList;
typedef base::Callback<
void(const NetworkGuidList& network_guid_list)> NetworkGuidListCallback;
virtual ~WiFiService() {}
// Initialize WiFiService, store |task_runner| for posting worker tasks.
virtual void Initialize(
scoped_refptr<base::SequencedTaskRunner> task_runner) = 0;
// UnInitialize WiFiService.
virtual void UnInitialize() = 0;
// Create instance of |WiFiService| for normal use.
static WiFiService* Create();
// Create instance of |WiFiService| for unit test use.
static WiFiService* CreateForTest();
// Get Properties of network identified by |network_guid|. Populates
// |properties| on success, |error| on failure.
virtual void GetProperties(const std::string& network_guid,
base::DictionaryValue* properties,
std::string* error) = 0;
// Gets the merged properties of the network with id |network_guid| from the
// sources: User settings, shared settings, user policy, device policy and
// the currently active settings. Populates |managed_properties| on success,
// |error| on failure.
virtual void GetManagedProperties(const std::string& network_guid,
base::DictionaryValue* managed_properties,
std::string* error) = 0;
// Get the cached read-only properties of the network with id |network_guid|.
// This is meant to be a higher performance function than |GetProperties|,
// which requires a round trip to query the networking subsystem. It only
// returns a subset of the properties returned by |GetProperties|. Populates
// |properties| on success, |error| on failure.
virtual void GetState(const std::string& network_guid,
base::DictionaryValue* properties,
std::string* error) = 0;
// Set Properties of network identified by |network_guid|. Populates |error|
// on failure.
virtual void SetProperties(const std::string& network_guid,
scoped_ptr<base::DictionaryValue> properties,
std::string* error) = 0;
// Creates a new network configuration from |properties|. If |shared| is true,
// share this network configuration with other users. If a matching configured
// network already exists, this will fail and populate |error|. On success
// populates the |network_guid| of the new network.
virtual void CreateNetwork(bool shared,
scoped_ptr<base::DictionaryValue> properties,
std::string* network_guid,
std::string* error) = 0;
// Get list of visible networks of |network_type| (one of onc::network_type).
// Populates |network_list| on success.
virtual void GetVisibleNetworks(const std::string& network_type,
base::ListValue* network_list) = 0;
// Request network scan. Send |NetworkListChanged| event on completion.
virtual void RequestNetworkScan() = 0;
// Start connect to network identified by |network_guid|. Populates |error|
// on failure.
virtual void StartConnect(const std::string& network_guid,
std::string* error) = 0;
// Start disconnect from network identified by |network_guid|. Populates
// |error| on failure.
virtual void StartDisconnect(const std::string& network_guid,
std::string* error) = 0;
// Get WiFi Key for network identified by |network_guid| from the
// system (if it has one) and store it in |key_data|. User privilege elevation
// may be required, and function will fail if user privileges are not
// sufficient. Populates |error| on failure.
virtual void GetKeyFromSystem(const std::string& network_guid,
std::string* key_data,
std::string* error) = 0;
// Set observers to run when |NetworksChanged| and |NetworksListChanged|
// events needs to be sent. Notifications are posted on |message_loop_proxy|.
virtual void SetEventObservers(
scoped_refptr<base::MessageLoopProxy> message_loop_proxy,
const NetworkGuidListCallback& networks_changed_observer,
const NetworkGuidListCallback& network_list_changed_observer) = 0;
// Request update of Connected Network information. Send |NetworksChanged|
// event on completion.
virtual void RequestConnectedNetworkUpdate() = 0;
protected:
WiFiService() {}
typedef int32 Frequency;
enum FrequencyEnum {
kFrequencyAny = 0,
kFrequencyUnknown = 0,
kFrequency2400 = 2400,
kFrequency5000 = 5000
};
typedef std::set<Frequency> FrequencySet;
// Network Properties, used as result of |GetProperties| and
// |GetVisibleNetworks|.
struct WIFI_EXPORT NetworkProperties {
NetworkProperties();
~NetworkProperties();
std::string connection_state;
std::string guid;
std::string name;
std::string ssid;
std::string bssid;
std::string type;
std::string security;
// |password| field is used to pass wifi password for network creation via
// |CreateNetwork| or connection via |StartConnect|. It does not persist
// once operation is completed.
std::string password;
// WiFi Signal Strength. 0..100
uint32 signal_strength;
bool auto_connect;
Frequency frequency;
FrequencySet frequency_set;
std::string json_extra; // Extra JSON properties for unit tests
scoped_ptr<base::DictionaryValue> ToValue(bool network_list) const;
// Updates only properties set in |value|.
bool UpdateFromValue(const base::DictionaryValue& value);
static std::string MacAddressAsString(const uint8 mac_as_int[6]);
static bool OrderByType(const NetworkProperties& l,
const NetworkProperties& r);
};
typedef std::list<NetworkProperties> NetworkList;
private:
DISALLOW_COPY_AND_ASSIGN(WiFiService);
};
} // namespace wifi
#endif // CHROME_UTILITY_WIFI_WIFI_SERVICE_H_