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 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/media/router/discovery/mdns/cast_media_sink_service_impl.h"
#include <algorithm>
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/rand_util.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/time/default_clock.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/media/router/discovery/mdns/media_sink_util.h"
#include "chrome/browser/media/router/media_router_feature.h"
#include "chrome/browser/net/system_network_context_manager.h" // nogncheck
#include "components/media_router/common/discovery/media_sink_internal.h"
#include "components/media_router/common/media_sink.h"
#include "components/media_router/common/mojom/media_router.mojom.h"
#include "components/media_router/common/providers/cast/channel/cast_channel_enum.h"
#include "components/media_router/common/providers/cast/channel/cast_device_capability.h"
#include "components/media_router/common/providers/cast/channel/cast_socket_service.h"
#include "components/net_log/chrome_net_log.h"
#include "content/public/browser/browser_thread.h"
#include "net/base/backoff_entry.h"
#include "net/base/net_errors.h"
namespace media_router {
namespace {
constexpr char kLoggerComponent[] = "CastMediaSinkServiceImpl";
MediaSinkInternal CreateCastSinkFromDialSink(
const MediaSinkInternal& dial_sink) {
const std::string& friendly_name = dial_sink.sink().name();
// Replace the "dial:" prefix with "cast:".
std::string sink_id =
CastMediaSinkServiceImpl::GetCastSinkIdFromDial(dial_sink.sink().id());
// Note that the real sink icon will be determined later using information
// from the opened cast channel.
MediaSink sink(sink_id, friendly_name, SinkIconType::CAST,
mojom::MediaRouteProviderId::CAST);
CastSinkExtraData extra_data;
extra_data.ip_endpoint =
net::IPEndPoint(dial_sink.dial_data().ip_address, kCastControlPort);
extra_data.model_name = dial_sink.dial_data().model_name;
extra_data.discovery_type = CastDiscoveryType::kDial;
return MediaSinkInternal(sink, extra_data);
}
std::string EnumToString(MediaRouterChannelError error) {
switch (error) {
case MediaRouterChannelError::UNKNOWN:
return "UNKNOWN";
case MediaRouterChannelError::AUTHENTICATION:
return "AUTHENTICATION";
case MediaRouterChannelError::CONNECT:
return "CONNECT";
case MediaRouterChannelError::GENERAL_CERTIFICATE:
return "GENERAL_CERTIFICATE";
case MediaRouterChannelError::CERTIFICATE_TIMING:
return "CERTIFICATE_TIMING";
case MediaRouterChannelError::NETWORK:
return "NETWORK";
case MediaRouterChannelError::CONNECT_TIMEOUT:
return "CONNECT_TIMEOUT";
case MediaRouterChannelError::PING_TIMEOUT:
return "PING_TIMEOUT";
case MediaRouterChannelError::TOTAL_COUNT:
NOTREACHED();
}
}
MediaRouterChannelError RecordError(cast_channel::ChannelError channel_error,
cast_channel::LastError last_error) {
MediaRouterChannelError error_code = MediaRouterChannelError::UNKNOWN;
switch (channel_error) {
// TODO(crbug.com/41345758): Add in errors for transient socket and timeout
// errors, but only after X number of occurences.
case cast_channel::ChannelError::UNKNOWN:
error_code = MediaRouterChannelError::UNKNOWN;
break;
case cast_channel::ChannelError::AUTHENTICATION_ERROR:
error_code = MediaRouterChannelError::AUTHENTICATION;
break;
case cast_channel::ChannelError::CONNECT_ERROR:
error_code = MediaRouterChannelError::CONNECT;
break;
case cast_channel::ChannelError::CONNECT_TIMEOUT:
error_code = MediaRouterChannelError::CONNECT_TIMEOUT;
break;
case cast_channel::ChannelError::PING_TIMEOUT:
error_code = MediaRouterChannelError::PING_TIMEOUT;
break;
default:
// Do nothing and let the standard launch failure issue surface.
break;
}
// If we have details, we may override the generic error codes set above.
// TODO(crbug.com/41345758): Expand and refine below as we see more actual
// reports.
// General certificate errors
if ((last_error.challenge_reply_error ==
cast_channel::ChallengeReplyError::PEER_CERT_EMPTY ||
last_error.challenge_reply_error ==
cast_channel::ChallengeReplyError::FINGERPRINT_NOT_FOUND ||
last_error.challenge_reply_error ==
cast_channel::ChallengeReplyError::CERT_PARSING_FAILED ||
last_error.challenge_reply_error ==
cast_channel::ChallengeReplyError::CANNOT_EXTRACT_PUBLIC_KEY) ||
net::IsCertificateError(last_error.net_return_value) ||
last_error.channel_event ==
cast_channel::ChannelEvent::SSL_SOCKET_CONNECT_FAILED ||
last_error.channel_event ==
cast_channel::ChannelEvent::SEND_AUTH_CHALLENGE_FAILED ||
last_error.channel_event ==
cast_channel::ChannelEvent::AUTH_CHALLENGE_REPLY_INVALID) {
error_code = MediaRouterChannelError::GENERAL_CERTIFICATE;
}
// Certificate timing errors
if (last_error.channel_event ==
cast_channel::ChannelEvent::SSL_CERT_EXCESSIVE_LIFETIME ||
last_error.net_return_value == net::ERR_CERT_DATE_INVALID) {
error_code = MediaRouterChannelError::CERTIFICATE_TIMING;
}
// Network/firewall access denied
if (last_error.net_return_value == net::ERR_NETWORK_ACCESS_DENIED) {
error_code = MediaRouterChannelError::NETWORK;
}
// Authentication errors (assumed active ssl manipulation)
if (last_error.challenge_reply_error ==
cast_channel::ChallengeReplyError::CERT_NOT_SIGNED_BY_TRUSTED_CA ||
last_error.challenge_reply_error ==
cast_channel::ChallengeReplyError::SIGNED_BLOBS_MISMATCH) {
error_code = MediaRouterChannelError::AUTHENTICATION;
}
CastAnalytics::RecordDeviceChannelError(error_code);
return error_code;
}
// Max allowed values
constexpr int kMaxConnectTimeoutInSeconds = 30;
constexpr int kMaxLivenessTimeoutInSeconds = 60;
// Max failure count allowed for a Cast channel.
constexpr int kMaxFailureCount = 100;
bool IsNetworkIdUnknownOrDisconnected(const std::string& network_id) {
return network_id == DiscoveryNetworkMonitor::kNetworkIdUnknown ||
network_id == DiscoveryNetworkMonitor::kNetworkIdDisconnected;
}
// Updates |existing_sink| with properties from |new_sink|. The relevant
// properties are sink name and capabilities (and icon type, by association).
// This method is only called with a |new_sink| discovered by mDNS. As such,
// |discovery_type| is also updated to kMdns.
void UpdateCastSink(const MediaSinkInternal& new_sink,
MediaSinkInternal* existing_sink) {
existing_sink->sink().set_name(new_sink.sink().name());
auto capabilities = new_sink.cast_data().capabilities;
existing_sink->cast_data().capabilities = capabilities;
existing_sink->sink().set_icon_type(GetCastSinkIconType(capabilities));
existing_sink->cast_data().discovery_type = CastDiscoveryType::kMdns;
}
} // namespace
// static
constexpr int CastMediaSinkServiceImpl::kMaxDialSinkFailureCount;
// static
MediaSink::Id CastMediaSinkServiceImpl::GetCastSinkIdFromDial(
const MediaSink::Id& dial_sink_id) {
DCHECK_EQ("dial:", dial_sink_id.substr(0, 5));
// Replace the "dial:" prefix with "cast:".
return "cast:" + dial_sink_id.substr(5);
}
// static
MediaSink::Id CastMediaSinkServiceImpl::GetDialSinkIdFromCast(
const MediaSink::Id& cast_sink_id) {
DCHECK_EQ("cast:", cast_sink_id.substr(0, 5));
// Replace the "cast:" prefix with "dial:".
return "dial:" + cast_sink_id.substr(5);
}
CastMediaSinkServiceImpl::CastMediaSinkServiceImpl(
const OnSinksDiscoveredCallback& callback,
cast_channel::CastSocketService* cast_socket_service,
DiscoveryNetworkMonitor* network_monitor,
DialMediaSinkServiceImpl* dial_media_sink_service,
bool allow_all_ips)
: MediaSinkServiceBase(callback),
cast_socket_service_(cast_socket_service),
network_monitor_(network_monitor),
allow_all_ips_(allow_all_ips),
dial_media_sink_service_(dial_media_sink_service),
task_runner_(cast_socket_service_->task_runner()),
clock_(base::DefaultClock::GetInstance()) {
DETACH_FROM_SEQUENCE(sequence_checker_);
DCHECK(cast_socket_service_);
DCHECK(network_monitor_);
backoff_policy_ = {
// Number of initial errors (in sequence) to ignore before going into
// exponential backoff.
0,
// Initial delay (in ms) once backoff starts. It should be longer than
// Cast
// socket's liveness timeout |kConnectLivenessTimeoutSecs| (10 seconds).
retry_params_.initial_delay_in_milliseconds,
// Factor by which the delay will be multiplied on each subsequent
// failure.
retry_params_.multiply_factor,
// Fuzzing percentage: 50% will spread delays randomly between 50%--100%
// of
// the nominal time.
0.5, // 50%
// Maximum delay (in ms) during exponential backoff.
30 * 1000, // 30 seconds
// Time to keep an entry from being discarded even when it has no
// significant state, -1 to never discard. (Not applicable.)
-1,
// False means that initial_delay_ms is the first delay once we start
// exponential backoff, i.e., there is no delay after subsequent
// successful
// requests.
false,
};
}
CastMediaSinkServiceImpl::~CastMediaSinkServiceImpl() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (dial_media_sink_service_) {
dial_media_sink_service_->RemoveObserver(this);
}
network_monitor_->RemoveObserver(this);
cast_socket_service_->RemoveObserver(this);
}
void CastMediaSinkServiceImpl::SetClockForTest(base::Clock* clock) {
clock_ = clock;
}
void CastMediaSinkServiceImpl::Start() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
cast_socket_service_->AddObserver(this);
// This call to |GetNetworkId| ensures that we get the current network ID at
// least once during startup in case |AddObserver| occurs after the first
// round of notifications has already been dispatched.
network_monitor_->GetNetworkId(base::BindOnce(
&CastMediaSinkServiceImpl::OnNetworksChanged, GetWeakPtr()));
network_monitor_->AddObserver(this);
if (dial_media_sink_service_) {
dial_media_sink_service_->AddObserver(this);
}
std::vector<MediaSinkInternal> test_sinks = GetFixedIPSinksFromCommandLine();
if (!test_sinks.empty()) {
OpenChannels(test_sinks, SinkSource::kMdns);
}
}
void CastMediaSinkServiceImpl::RecordDeviceCounts() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
metrics_.RecordDeviceCountsIfNeeded(GetSinks().size(),
known_ip_endpoints_.size());
}
void CastMediaSinkServiceImpl::DiscoverSinksNow() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!dial_media_sink_service_) {
return;
}
// Re-sync sinks from DialMediaSinkService. It's possible that a
// DIAL-discovered sink was added here earlier, but was removed due to flaky
// network. This gives CastMediaSinkServiceImpl an opportunity to recover even
// if mDNS is not working for some reason.
for (const auto& sink : dial_media_sink_service_->GetSinks()) {
TryConnectDialDiscoveredSink(sink.second);
}
}
void CastMediaSinkServiceImpl::OpenChannelsWithRandomizedDelay(
const std::vector<MediaSinkInternal>& cast_sinks,
SinkSource sink_source) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Add a random backoff between 0s to 5s before opening channels to prevent
// different browser instances connecting to the same receiver at the same
// time.
task_runner()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&CastMediaSinkServiceImpl::OpenChannels, GetWeakPtr(),
cast_sinks, sink_source),
base::RandTimeDeltaUpTo(base::Seconds(5)));
}
void CastMediaSinkServiceImpl::OpenChannels(
const std::vector<MediaSinkInternal>& cast_sinks,
SinkSource sink_source) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
known_ip_endpoints_.clear();
for (const auto& cast_sink : cast_sinks) {
known_ip_endpoints_.insert(cast_sink.cast_data().ip_endpoint);
OpenChannel(cast_sink, nullptr, sink_source, base::DoNothing(),
CreateCastSocketOpenParams(cast_sink));
}
StartTimer();
}
void CastMediaSinkServiceImpl::OnError(const cast_channel::CastSocket& socket,
cast_channel::ChannelError error_state) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
cast_channel::LastError last_error =
cast_socket_service_->GetLogger()->GetLastError(socket.id());
MediaRouterChannelError error_code = RecordError(error_state, last_error);
net::IPEndPoint ip_endpoint = socket.ip_endpoint();
// Need a PostTask() here because RemoveSocket() will release the memory of
// |socket|. Need to make sure all tasks on |socket| finish before deleting
// the object.
int socket_id = socket.id();
task_runner_->PostNonNestableTask(
FROM_HERE,
base::BindOnce(
base::IgnoreResult(&cast_channel::CastSocketService::RemoveSocket),
base::Unretained(cast_socket_service_), socket_id));
// Remove existing cast sink from |sinks|. It will be added back if
// it can be successfully reconnected.
const auto& sinks = GetSinks();
auto sink_it = std::ranges::find(sinks, socket_id, [](const auto& entry) {
return entry.second.cast_data().cast_channel_id;
});
auto sink_id = sink_it == sinks.end() ? "" : sink_it->first;
LoggerList::GetInstance()->Log(
LoggerImpl::Severity::kError, mojom::LogCategory::kDiscovery,
kLoggerComponent,
base::StrCat({"Media Router Channel Error: ", EnumToString(error_code),
". channel_id: ", base::NumberToString(socket_id),
". IP endpoint: ", ip_endpoint.ToString()}),
sink_id, "", "");
if (sink_it == sinks.end()) {
return;
}
MediaSinkInternal sink = sink_it->second;
// If socket is not opened yet, then |OnChannelOpened()| will handle the
// retry.
if (socket.ready_state() != cast_channel::ReadyState::CONNECTING) {
task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&CastMediaSinkServiceImpl::OpenChannel, GetWeakPtr(),
sink, nullptr, SinkSource::kConnectionRetryOnError,
base::DoNothing(), CreateCastSocketOpenParams(sink)));
}
}
void CastMediaSinkServiceImpl::OnMessage(
const cast_channel::CastSocket& socket,
const openscreen::cast::proto::CastMessage& message) {}
void CastMediaSinkServiceImpl::OnReadyStateChanged(
const cast_channel::CastSocket& socket) {}
void CastMediaSinkServiceImpl::OnNetworksChanged(
const std::string& network_id) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Although DiscoveryNetworkMonitor guarantees this condition won't be true
// from its Observer interface, the callback from |AddNetworkChangeObserver|
// could cause this to happen.
if (network_id == current_network_id_) {
return;
}
std::string last_network_id = current_network_id_;
current_network_id_ = network_id;
dial_sink_failure_count_.clear();
if (!IsNetworkIdUnknownOrDisconnected(last_network_id)) {
std::vector<MediaSinkInternal> current_sinks;
for (const auto& entry : GetSinks()) {
// AccessCode sinks should not be cached because of expiration -- this is
// handled elsewhere instead.
CastDiscoveryType type = entry.second.cast_data().discovery_type;
if (type != CastDiscoveryType::kAccessCodeManualEntry &&
type != CastDiscoveryType::kAccessCodeRememberedDevice) {
current_sinks.push_back(entry.second);
}
}
sink_cache_[last_network_id] = std::move(current_sinks);
}
LoggerList::GetInstance()->Log(
LoggerImpl::Severity::kError, mojom::LogCategory::kDiscovery,
kLoggerComponent,
base::StringPrintf("Network ID changed from \"%s\" to \"%s\".",
last_network_id.c_str(), current_network_id_.c_str()),
"", "", "");
// TODO(imcheng): Maybe this should clear |sinks_| and call |StartTimer()|
// so it is more responsive?
if (IsNetworkIdUnknownOrDisconnected(network_id)) {
return;
}
auto cache_entry = sink_cache_.find(network_id);
// Check if we have any cached sinks for this network ID.
if (cache_entry == sink_cache_.end()) {
return;
}
OpenChannelsWithRandomizedDelay(cache_entry->second,
SinkSource::kNetworkCache);
}
cast_channel::CastSocketOpenParams
CastMediaSinkServiceImpl::CreateCastSocketOpenParams(
const MediaSinkInternal& sink) {
int connect_timeout_in_seconds = open_params_.connect_timeout_in_seconds;
int liveness_timeout_in_seconds = open_params_.liveness_timeout_in_seconds;
int delta_in_seconds = open_params_.dynamic_timeout_delta_in_seconds;
auto it = failure_count_map_.find(sink.sink().id());
if (it != failure_count_map_.end()) {
int failure_count = it->second;
connect_timeout_in_seconds =
std::min(connect_timeout_in_seconds + failure_count * delta_in_seconds,
kMaxConnectTimeoutInSeconds);
liveness_timeout_in_seconds =
std::min(liveness_timeout_in_seconds + failure_count * delta_in_seconds,
kMaxLivenessTimeoutInSeconds);
}
// TODO(crbug.com/41371793): Switching cast socket implementation to use
// network service will allow us to get back NetLog.
return cast_channel::CastSocketOpenParams(
sink.cast_data().ip_endpoint, base::Seconds(connect_timeout_in_seconds),
base::Seconds(liveness_timeout_in_seconds),
base::Seconds(open_params_.ping_interval_in_seconds),
/*CastDeviceCapabilitySet*/ {});
}
void CastMediaSinkServiceImpl::OpenChannel(
const MediaSinkInternal& cast_sink,
std::unique_ptr<net::BackoffEntry> backoff_entry,
SinkSource sink_source,
ChannelOpenedCallback callback,
cast_channel::CastSocketOpenParams open_params) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
const net::IPEndPoint& ip_endpoint = cast_sink.cast_data().ip_endpoint;
if (!allow_all_ips_ && ip_endpoint.address().IsPubliclyRoutable()) {
LoggerList::GetInstance()->Log(
LoggerImpl::Severity::kWarning, mojom::LogCategory::kDiscovery,
kLoggerComponent,
base::StrCat({"Did not open a channel to the IP endpoint: ",
ip_endpoint.ToString(),
" because it is publicly "
"routable."}),
cast_sink.sink().id(), "", "");
if (callback) {
std::move(callback).Run(false);
}
return;
}
// Erase the entry from |dial_sink_failure_count_| since the device is now
// known to be a Cast device.
const MediaSink::Id& sink_id = cast_sink.sink().id();
if (sink_source != SinkSource::kDial) {
dial_sink_failure_count_.erase(sink_id);
}
// If there already is a connected sink whose IP endpoint stayed the same,
// then there's no need to reopen a socket. We just update the sink info.
const MediaSinkInternal* existing_sink = GetSinkById(sink_id);
if (sink_source != SinkSource::kConnectionRetryOnError && existing_sink &&
existing_sink->cast_data().ip_endpoint == ip_endpoint) {
// This update is only performed if |sink_source| is kMdns. In particular,
// DIAL-discovered
// sinks contain incomplete information which should not be used for
// updates.
if (sink_source != SinkSource::kMdns) {
if (callback) {
std::move(callback).Run(true);
}
return;
}
if (existing_sink->sink().name() == cast_sink.sink().name() &&
existing_sink->cast_data().capabilities ==
cast_sink.cast_data().capabilities) {
if (callback) {
std::move(callback).Run(true);
}
return;
}
// Merge new fields into copy of existing sink to retain cast_channel_id.
MediaSinkInternal existing_sink_copy = *existing_sink;
UpdateCastSink(cast_sink, &existing_sink_copy);
AddOrUpdateSink(existing_sink_copy);
if (callback) {
std::move(callback).Run(true);
}
return;
}
if (!pending_for_open_ip_endpoints_.insert(ip_endpoint).second) {
if (callback) {
std::move(callback).Run(false);
}
return;
}
cast_socket_service_->OpenSocket(
base::BindRepeating([] {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
return g_browser_process->system_network_context_manager()
->GetContext();
}),
open_params,
base::BindOnce(&CastMediaSinkServiceImpl::OnChannelOpened, GetWeakPtr(),
cast_sink, std::move(backoff_entry), sink_source,
clock_->Now(), std::move(callback), open_params));
}
void CastMediaSinkServiceImpl::OnChannelOpened(
const MediaSinkInternal& cast_sink,
std::unique_ptr<net::BackoffEntry> backoff_entry,
SinkSource sink_source,
base::Time start_time,
ChannelOpenedCallback callback,
cast_channel::CastSocketOpenParams open_params,
cast_channel::CastSocket* socket) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(socket);
pending_for_open_ip_endpoints_.erase(cast_sink.cast_data().ip_endpoint);
bool succeeded = socket->error_state() == cast_channel::ChannelError::NONE;
if (backoff_entry) {
backoff_entry->InformOfRequest(succeeded);
}
CastAnalytics::RecordDeviceChannelOpenDuration(succeeded,
clock_->Now() - start_time);
if (succeeded) {
OnChannelOpenSucceeded(cast_sink, socket, sink_source, std::move(callback));
} else {
OnChannelErrorMayRetry(cast_sink, std::move(backoff_entry),
socket->error_state(), sink_source,
std::move(callback), std::move(open_params));
}
}
void CastMediaSinkServiceImpl::OnChannelErrorMayRetry(
MediaSinkInternal cast_sink,
std::unique_ptr<net::BackoffEntry> backoff_entry,
cast_channel::ChannelError error_state,
SinkSource sink_source,
ChannelOpenedCallback callback,
cast_channel::CastSocketOpenParams open_params) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
const MediaSink::Id& sink_id = cast_sink.sink().id();
const net::IPEndPoint& ip_endpoint = cast_sink.cast_data().ip_endpoint;
if (sink_source == SinkSource::kDial) {
++dial_sink_failure_count_[sink_id];
}
int failure_count = ++failure_count_map_[sink_id];
failure_count_map_[sink_id] = std::min(failure_count, kMaxFailureCount);
if (!backoff_entry) {
backoff_entry = std::make_unique<net::BackoffEntry>(&backoff_policy_);
}
if (backoff_entry->failure_count() >= retry_params_.max_retry_attempts) {
OnChannelOpenFailed(ip_endpoint, cast_sink, std::move(callback));
CastAnalytics::RecordCastChannelConnectResult(
MediaRouterChannelConnectResults::FAILURE);
return;
}
const base::TimeDelta delay = backoff_entry->GetTimeUntilRelease();
task_runner_->PostDelayedTask(
FROM_HERE,
base::BindOnce(&CastMediaSinkServiceImpl::OpenChannel, GetWeakPtr(),
cast_sink, std::move(backoff_entry), sink_source,
std::move(callback), std::move(open_params)),
delay);
}
void CastMediaSinkServiceImpl::OnChannelOpenSucceeded(
MediaSinkInternal cast_sink,
cast_channel::CastSocket* socket,
SinkSource sink_source,
ChannelOpenedCallback callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(socket);
CastAnalytics::RecordCastChannelConnectResult(
MediaRouterChannelConnectResults::SUCCESS);
CastSinkExtraData& extra_data = cast_sink.cast_data();
// Manually set device capabilities for sinks discovered via DIAL as DIAL
// discovery does not provide capability info.
if (cast_sink.cast_data().discovery_type == CastDiscoveryType::kDial) {
extra_data.capabilities.Put(cast_channel::CastDeviceCapability::kAudioOut);
if (!socket->audio_only()) {
extra_data.capabilities.Put(
cast_channel::CastDeviceCapability::kVideoOut);
}
// We can now set the proper icon type now that capabilities is determined.
cast_sink.sink().set_icon_type(
GetCastSinkIconType(extra_data.capabilities));
}
extra_data.cast_channel_id = socket->id();
// Add or update existing cast sink.
const MediaSink::Id& sink_id = cast_sink.sink().id();
const MediaSinkInternal* existing_sink = GetSinkById(sink_id);
if (!existing_sink) {
metrics_.RecordCastSinkDiscoverySource(sink_source);
} else {
if (existing_sink->cast_data().discovery_type == CastDiscoveryType::kDial &&
cast_sink.cast_data().discovery_type != CastDiscoveryType::kDial) {
metrics_.RecordCastSinkDiscoverySource(SinkSource::kDialMdns);
}
}
AddOrUpdateSink(cast_sink);
failure_count_map_.erase(sink_id);
// To maintain the invariant that an IPEndpoint appears in at most one entry
// in the sink list, we will remove the sink (if any) that has the same
// IPEndPoint but different sink ID.
const net::IPEndPoint& ip_endpoint = extra_data.ip_endpoint;
const auto& sinks = GetSinks();
auto old_sink_it = std::ranges::find_if(
sinks, [&cast_sink, &ip_endpoint](const auto& entry) {
return entry.first != cast_sink.sink().id() &&
entry.second.cast_data().ip_endpoint == ip_endpoint;
});
if (old_sink_it != sinks.end()) {
RemoveSink(old_sink_it->second);
}
// Certain classes of Cast sinks support advertising via SSDP but do not
// properly implement the rest of the DIAL protocol. If we successfully open
// a Cast channel to a device that came from DIAL, remove it from
// |dial_media_sink_service_|. This ensures the device shows up as a Cast sink
// only.
if (dial_media_sink_service_) {
dial_media_sink_service_->RemoveSinkById(GetDialSinkIdFromCast(sink_id));
}
if (callback) {
std::move(callback).Run(true);
}
}
void CastMediaSinkServiceImpl::OnChannelOpenFailed(
const net::IPEndPoint& ip_endpoint,
const MediaSinkInternal& sink,
ChannelOpenedCallback callback) {
if (callback) {
std::move(callback).Run(false);
}
// Check that the IPEndPoints match before removing, as it is possible that
// the sink was reconnected under a different IP before this method is
// called.
const MediaSinkInternal* existing_sink = GetSinkById(sink.sink().id());
if (!existing_sink ||
!(ip_endpoint == existing_sink->cast_data().ip_endpoint)) {
return;
}
LoggerList::GetInstance()->Log(
LoggerImpl::Severity::kError, mojom::LogCategory::kDiscovery,
kLoggerComponent,
base::StrCat({"Failed to open the channel. IP endpoint: ",
ip_endpoint.ToString(), ". channel_id: ",
base::NumberToString(existing_sink->cast_channel_id())}),
sink.sink().id(), "", "");
RemoveSink(sink);
}
void CastMediaSinkServiceImpl::OnSinkAddedOrUpdated(
const MediaSinkInternal& sink) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
TryConnectDialDiscoveredSink(sink);
}
void CastMediaSinkServiceImpl::OnSinkRemoved(const MediaSinkInternal& sink) {
// No-op.
}
void CastMediaSinkServiceImpl::TryConnectDialDiscoveredSink(
const MediaSinkInternal& dial_sink) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Dual discovery should not try to open cast channel for non-Cast device.
if (IsProbablyNonCastDevice(dial_sink)) {
return;
}
MediaSinkInternal sink = CreateCastSinkFromDialSink(dial_sink);
if (GetSinkById(sink.sink().id())) {
metrics_.RecordCastSinkDiscoverySource(SinkSource::kMdnsDial);
// Sink is a Cast device; remove from |dial_media_sink_service_| to prevent
// duplicates.
if (dial_media_sink_service_) {
dial_media_sink_service_->RemoveSink(dial_sink);
}
return;
}
if (HasSinkWithIPAddress(dial_sink.dial_data().ip_address)) {
// We're already connected to a Cast sink whose ID is different from that of
// |dial_sink| but has the same IP address. In this case we do not try to
// reopen a channel because that'd be redundant and would cause a teardown
// of any existing session.
return;
}
OpenChannel(sink, nullptr, SinkSource::kDial, base::DoNothing(),
CreateCastSocketOpenParams(sink));
}
bool CastMediaSinkServiceImpl::IsProbablyNonCastDevice(
const MediaSinkInternal& dial_sink) const {
auto it = dial_sink_failure_count_.find(
GetCastSinkIdFromDial(dial_sink.sink().id()));
return it != dial_sink_failure_count_.end() &&
it->second >= kMaxDialSinkFailureCount;
}
void CastMediaSinkServiceImpl::OpenChannelsNow(
const std::vector<MediaSinkInternal>& cast_sinks) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
OpenChannels(cast_sinks, SinkSource::kConnectionRetry);
}
void CastMediaSinkServiceImpl::SetCastAllowAllIPs(bool allow_all_ips) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
allow_all_ips_ = allow_all_ips;
}
bool CastMediaSinkServiceImpl::HasSink(const MediaSink::Id& sink_id) {
return base::Contains(GetSinks(), sink_id);
}
void CastMediaSinkServiceImpl::DisconnectAndRemoveSink(
const MediaSinkInternal& sink) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
RemoveSink(sink);
// Need a PostTask() here because CloseSocket() will release the memory of
// |socket|. Need to make sure all tasks on |socket| finish before deleting
// the object.
task_runner_->PostNonNestableTask(
FROM_HERE,
base::BindOnce(
base::IgnoreResult(&cast_channel::CastSocketService::CloseSocket),
base::Unretained(cast_socket_service_),
sink.cast_data().cast_channel_id));
}
bool CastMediaSinkServiceImpl::HasSinkWithIPAddress(
const net::IPAddress& ip_address) const {
return base::Contains(GetSinks(), ip_address, [](const auto& sink) {
return sink.second.cast_data().ip_endpoint.address();
});
}
} // namespace media_router
|