1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
|
// Copyright (c) 2012 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.
#include "chrome/browser/extensions/api/dial/dial_registry.h"
#include <memory>
#include <utility>
#include "base/memory/ptr_util.h"
#include "base/stl_util.h"
#include "base/strings/string_number_conversions.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/extensions/api/dial/dial_api.h"
#include "chrome/browser/extensions/api/dial/dial_device_data.h"
#include "chrome/browser/extensions/api/dial/dial_service.h"
#include "chrome/common/extensions/api/dial.h"
#include "components/net_log/chrome_net_log.h"
#include "content/public/browser/browser_thread.h"
using base::Time;
using base::TimeDelta;
using content::BrowserThread;
using net::NetworkChangeNotifier;
namespace extensions {
namespace api {
namespace dial {
DialRegistry::DialRegistry(Observer* dial_api,
const base::TimeDelta& refresh_interval,
const base::TimeDelta& expiration,
const size_t max_devices)
: num_listeners_(0),
registry_generation_(0),
last_event_registry_generation_(0),
label_count_(0),
refresh_interval_delta_(refresh_interval),
expiration_delta_(expiration),
max_devices_(max_devices),
dial_api_(dial_api) {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
DCHECK_GT(max_devices_, 0U);
NetworkChangeNotifier::AddNetworkChangeObserver(this);
}
DialRegistry::~DialRegistry() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
NetworkChangeNotifier::RemoveNetworkChangeObserver(this);
}
std::unique_ptr<DialService> DialRegistry::CreateDialService() {
DCHECK(g_browser_process->net_log());
return base::MakeUnique<DialServiceImpl>(g_browser_process->net_log());
}
void DialRegistry::ClearDialService() {
dial_.reset();
}
base::Time DialRegistry::Now() const {
return Time::Now();
}
void DialRegistry::OnListenerAdded() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
if (++num_listeners_ == 1) {
VLOG(2) << "Listener added; starting periodic discovery.";
StartPeriodicDiscovery();
}
// Event listeners with the current device list.
// TODO(crbug.com/576817): Rework the DIAL API so we don't need to have extra
// behaviors when adding listeners.
SendEvent();
}
void DialRegistry::OnListenerRemoved() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
DCHECK_GT(num_listeners_, 0);
if (--num_listeners_ == 0) {
VLOG(2) << "Listeners removed; stopping periodic discovery.";
StopPeriodicDiscovery();
}
}
GURL DialRegistry::GetDeviceDescriptionURL(const std::string& label) const {
const auto device_it = device_by_label_map_.find(label);
if (device_it != device_by_label_map_.end())
return device_it->second->device_description_url();
return GURL();
}
void DialRegistry::AddDeviceForTest(const DialDeviceData& device_data) {
std::unique_ptr<DialDeviceData> test_data =
base::MakeUnique<DialDeviceData>(device_data);
device_by_label_map_.insert(
std::make_pair(device_data.label(), test_data.get()));
device_by_id_map_.insert(
std::make_pair(device_data.device_id(), std::move(test_data)));
}
bool DialRegistry::ReadyToDiscover() {
if (num_listeners_ == 0) {
dial_api_->OnDialError(DIAL_NO_LISTENERS);
return false;
}
if (NetworkChangeNotifier::IsOffline()) {
dial_api_->OnDialError(DIAL_NETWORK_DISCONNECTED);
return false;
}
if (NetworkChangeNotifier::IsConnectionCellular(
NetworkChangeNotifier::GetConnectionType())) {
dial_api_->OnDialError(DIAL_CELLULAR_NETWORK);
return false;
}
return true;
}
bool DialRegistry::DiscoverNow() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
if (!ReadyToDiscover()) {
return false;
}
if (!dial_) {
dial_api_->OnDialError(DIAL_UNKNOWN);
return false;
}
if (!dial_->HasObserver(this))
NOTREACHED() << "DiscoverNow() called without observing dial_";
// Force increment |registry_generation_| to ensure an event is sent even if
// the device list did not change.
bool started = dial_->Discover();
if (started)
++registry_generation_;
return started;
}
void DialRegistry::StartPeriodicDiscovery() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
if (!ReadyToDiscover() || dial_)
return;
dial_ = CreateDialService();
dial_->AddObserver(this);
DoDiscovery();
repeating_timer_.Start(FROM_HERE,
refresh_interval_delta_,
this,
&DialRegistry::DoDiscovery);
}
void DialRegistry::DoDiscovery() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
DCHECK(dial_);
VLOG(2) << "About to discover!";
dial_->Discover();
}
void DialRegistry::StopPeriodicDiscovery() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
if (!dial_)
return;
repeating_timer_.Stop();
dial_->RemoveObserver(this);
ClearDialService();
}
bool DialRegistry::PruneExpiredDevices() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
bool pruned_device = false;
DeviceByLabelMap::iterator it = device_by_label_map_.begin();
while (it != device_by_label_map_.end()) {
auto* device = it->second;
if (IsDeviceExpired(*device)) {
VLOG(2) << "Device " << device->label() << " expired, removing";
// Make a copy of the device ID here since |device| will be destroyed
// during erase().
std::string device_id = device->device_id();
const size_t num_erased_by_id = device_by_id_map_.erase(device_id);
DCHECK_EQ(1U, num_erased_by_id);
device_by_label_map_.erase(it++);
pruned_device = true;
} else {
++it;
}
}
return pruned_device;
}
bool DialRegistry::IsDeviceExpired(const DialDeviceData& device) const {
Time now = Now();
// Check against our default expiration timeout.
Time default_expiration_time = device.response_time() + expiration_delta_;
if (now > default_expiration_time)
return true;
// Check against the device's cache-control header, if set.
if (device.has_max_age()) {
Time max_age_expiration_time =
device.response_time() + TimeDelta::FromSeconds(device.max_age());
if (now > max_age_expiration_time)
return true;
}
return false;
}
void DialRegistry::Clear() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
device_by_id_map_.clear();
device_by_label_map_.clear();
registry_generation_++;
}
void DialRegistry::MaybeSendEvent() {
// Send an event if the device list has changed since the last event.
bool needs_event = last_event_registry_generation_ < registry_generation_;
VLOG(2) << "lerg = " << last_event_registry_generation_ << ", rg = "
<< registry_generation_ << ", needs_event = " << needs_event;
if (needs_event)
SendEvent();
}
void DialRegistry::SendEvent() {
DeviceList device_list;
for (DeviceByLabelMap::const_iterator it = device_by_label_map_.begin();
it != device_by_label_map_.end(); ++it) {
device_list.push_back(*(it->second));
}
dial_api_->OnDialDeviceEvent(device_list);
// Reset watermark.
last_event_registry_generation_ = registry_generation_;
}
std::string DialRegistry::NextLabel() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
return base::IntToString(++label_count_);
}
void DialRegistry::OnDiscoveryRequest(DialService* service) {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
MaybeSendEvent();
}
void DialRegistry::OnDeviceDiscovered(DialService* service,
const DialDeviceData& device) {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
// Adds |device| to our list of devices or updates an existing device, unless
// |device| is a duplicate. Returns true if the list was modified and
// increments the list generation.
auto device_data = base::MakeUnique<DialDeviceData>(device);
DCHECK(!device_data->device_id().empty());
DCHECK(device_data->label().empty());
bool did_modify_list = false;
DeviceByIdMap::iterator lookup_result =
device_by_id_map_.find(device_data->device_id());
if (lookup_result != device_by_id_map_.end()) {
VLOG(2) << "Found device " << device_data->device_id() << ", merging";
// Already have previous response. Merge in data from this response and
// track if there were any API visible changes.
did_modify_list = lookup_result->second->UpdateFrom(*device_data);
} else {
did_modify_list = MaybeAddDevice(std::move(device_data));
}
if (did_modify_list)
registry_generation_++;
VLOG(2) << "did_modify_list = " << did_modify_list
<< ", generation = " << registry_generation_;
}
bool DialRegistry::MaybeAddDevice(std::unique_ptr<DialDeviceData> device_data) {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
if (device_by_id_map_.size() == max_devices_) {
VLOG(1) << "Maximum registry size reached. Cannot add device.";
return false;
}
device_data->set_label(NextLabel());
DialDeviceData* device_data_ptr = device_data.get();
device_by_id_map_[device_data_ptr->device_id()] = std::move(device_data);
device_by_label_map_[device_data_ptr->label()] = device_data_ptr;
VLOG(2) << "Added device, id = " << device_data_ptr->device_id()
<< ", label = " << device_data_ptr->label();
return true;
}
void DialRegistry::OnDiscoveryFinished(DialService* service) {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
if (PruneExpiredDevices())
registry_generation_++;
MaybeSendEvent();
}
void DialRegistry::OnError(DialService* service,
const DialService::DialServiceErrorCode& code) {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
switch (code) {
case DialService::DIAL_SERVICE_SOCKET_ERROR:
dial_api_->OnDialError(DIAL_SOCKET_ERROR);
break;
case DialService::DIAL_SERVICE_NO_INTERFACES:
dial_api_->OnDialError(DIAL_NO_INTERFACES);
break;
default:
NOTREACHED();
dial_api_->OnDialError(DIAL_UNKNOWN);
break;
}
}
void DialRegistry::OnNetworkChanged(
NetworkChangeNotifier::ConnectionType type) {
switch (type) {
case NetworkChangeNotifier::CONNECTION_NONE:
if (dial_) {
VLOG(2) << "Lost connection, shutting down discovery and clearing"
<< " list.";
dial_api_->OnDialError(DIAL_NETWORK_DISCONNECTED);
StopPeriodicDiscovery();
// TODO(justinlin): As an optimization, we can probably keep our device
// list around and restore it if we reconnected to the exact same
// network.
Clear();
MaybeSendEvent();
}
break;
case NetworkChangeNotifier::CONNECTION_2G:
case NetworkChangeNotifier::CONNECTION_3G:
case NetworkChangeNotifier::CONNECTION_4G:
case NetworkChangeNotifier::CONNECTION_ETHERNET:
case NetworkChangeNotifier::CONNECTION_WIFI:
case NetworkChangeNotifier::CONNECTION_UNKNOWN:
case NetworkChangeNotifier::CONNECTION_BLUETOOTH:
if (!dial_) {
VLOG(2) << "Connection detected, restarting discovery.";
StartPeriodicDiscovery();
}
break;
}
}
} // namespace dial
} // namespace api
} // namespace extensions
|