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
|
// Copyright 2019 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 "osp/public/presentation/presentation_receiver.h"
#include <algorithm>
#include <memory>
#include "osp/impl/presentation/presentation_common.h"
#include "osp/msgs/osp_messages.h"
#include "osp/public/message_demuxer.h"
#include "osp/public/network_service_manager.h"
#include "osp/public/protocol_connection_server.h"
#include "platform/api/time.h"
#include "util/osp_logging.h"
#include "util/trace_logging.h"
namespace openscreen {
namespace osp {
namespace {
msgs::PresentationConnectionCloseEvent_reason GetEventCloseReason(
Connection::CloseReason reason) {
switch (reason) {
case Connection::CloseReason::kDiscarded:
return msgs::PresentationConnectionCloseEvent_reason::
kConnectionObjectDiscarded;
case Connection::CloseReason::kError:
return msgs::PresentationConnectionCloseEvent_reason::
kUnrecoverableErrorWhileSendingOrReceivingMessage;
case Connection::CloseReason::kClosed: // fallthrough
default:
return msgs::PresentationConnectionCloseEvent_reason::kCloseMethodCalled;
}
}
msgs::PresentationTerminationEvent_reason GetEventTerminationReason(
TerminationReason reason) {
switch (reason) {
case TerminationReason::kReceiverUserTerminated:
return msgs::PresentationTerminationEvent_reason::
kUserTerminatedViaReceiver;
case TerminationReason::kReceiverShuttingDown:
return msgs::PresentationTerminationEvent_reason::kReceiverPoweringDown;
case TerminationReason::kReceiverPresentationUnloaded:
return msgs::PresentationTerminationEvent_reason::
kReceiverAttemptedToNavigate;
case TerminationReason::kReceiverPresentationReplaced:
return msgs::PresentationTerminationEvent_reason::
kReceiverReplacedPresentation;
case TerminationReason::kReceiverIdleTooLong:
return msgs::PresentationTerminationEvent_reason::kReceiverIdleTooLong;
case TerminationReason::kReceiverError:
return msgs::PresentationTerminationEvent_reason::kReceiverCrashed;
case TerminationReason::kReceiverTerminateCalled:
return msgs::PresentationTerminationEvent_reason::
kReceiverCalledTerminate;
default:
return msgs::PresentationTerminationEvent_reason::kUnknown;
}
}
Error WritePresentationInitiationResponse(
const msgs::PresentationStartResponse& response,
ProtocolConnection* connection) {
return connection->WriteMessage(response,
msgs::EncodePresentationStartResponse);
}
Error WritePresentationConnectionOpenResponse(
const msgs::PresentationConnectionOpenResponse& response,
ProtocolConnection* connection) {
return connection->WriteMessage(
response, msgs::EncodePresentationConnectionOpenResponse);
}
Error WritePresentationTerminationEvent(
const msgs::PresentationTerminationEvent& event,
ProtocolConnection* connection) {
return connection->WriteMessage(event,
msgs::EncodePresentationTerminationEvent);
}
Error WritePresentationTerminationResponse(
const msgs::PresentationTerminationResponse& response,
ProtocolConnection* connection) {
return connection->WriteMessage(response,
msgs::EncodePresentationTerminationResponse);
}
Error WritePresentationUrlAvailabilityResponse(
const msgs::PresentationUrlAvailabilityResponse& response,
ProtocolConnection* connection) {
return connection->WriteMessage(
response, msgs::EncodePresentationUrlAvailabilityResponse);
}
} // namespace
ErrorOr<size_t> Receiver::OnStreamMessage(uint64_t endpoint_id,
uint64_t connection_id,
msgs::Type message_type,
const uint8_t* buffer,
size_t buffer_size,
Clock::time_point now) {
TRACE_SCOPED(TraceCategory::kPresentation, "Receiver::OnStreamMessage");
switch (message_type) {
case msgs::Type::kPresentationUrlAvailabilityRequest: {
TRACE_SCOPED(TraceCategory::kPresentation,
"kPresentationUrlAvailabilityRequest");
OSP_VLOG << "got presentation-url-availability-request";
msgs::PresentationUrlAvailabilityRequest request;
ssize_t decode_result = msgs::DecodePresentationUrlAvailabilityRequest(
buffer, buffer_size, &request);
if (decode_result < 0) {
OSP_LOG_WARN << "Presentation-url-availability-request parse error: "
<< decode_result;
TRACE_SET_RESULT(Error::Code::kParseError);
return Error::Code::kParseError;
}
msgs::PresentationUrlAvailabilityResponse response;
response.request_id = request.request_id;
response.url_availabilities = delegate_->OnUrlAvailabilityRequest(
request.watch_id, request.watch_duration, std::move(request.urls));
msgs::CborEncodeBuffer buffer;
WritePresentationUrlAvailabilityResponse(
response, GetProtocolConnection(endpoint_id).get());
return decode_result;
}
case msgs::Type::kPresentationStartRequest: {
TRACE_SCOPED(TraceCategory::kPresentation, "kPresentationStartRequest");
OSP_VLOG << "got presentation-start-request";
msgs::PresentationStartRequest request;
const ssize_t result =
msgs::DecodePresentationStartRequest(buffer, buffer_size, &request);
if (result < 0) {
OSP_LOG_WARN << "Presentation-initiation-request parse error: "
<< result;
TRACE_SET_RESULT(Error::Code::kParseError);
return Error::Code::kParseError;
}
OSP_LOG_INFO << "Got an initiation request for: " << request.url;
PresentationID presentation_id(std::move(request.presentation_id));
if (!presentation_id) {
msgs::PresentationStartResponse response;
response.request_id = request.request_id;
response.result =
msgs::PresentationStartResponse_result::kInvalidPresentationId;
Error write_error = WritePresentationInitiationResponse(
response, GetProtocolConnection(endpoint_id).get());
if (!write_error.ok()) {
TRACE_SET_RESULT(write_error);
return write_error;
}
return result;
}
auto& response_list = queued_responses_[presentation_id];
QueuedResponse queued_response{
/* .type = */ QueuedResponse::Type::kInitiation,
/* .request_id = */ request.request_id,
/* .connection_id = */ this->GetNextConnectionId(),
/* .endpoint_id = */ endpoint_id};
response_list.push_back(std::move(queued_response));
const bool starting = delegate_->StartPresentation(
Connection::PresentationInfo{presentation_id, request.url},
endpoint_id, request.headers);
if (starting)
return result;
queued_responses_.erase(presentation_id);
msgs::PresentationStartResponse response;
response.request_id = request.request_id;
response.result = msgs::PresentationStartResponse_result::kUnknownError;
Error write_error = WritePresentationInitiationResponse(
response, GetProtocolConnection(endpoint_id).get());
if (!write_error.ok()) {
TRACE_SET_RESULT(write_error);
return write_error;
}
return result;
}
case msgs::Type::kPresentationConnectionOpenRequest: {
TRACE_SCOPED(TraceCategory::kPresentation,
"kPresentationConnectionOpenRequest");
OSP_VLOG << "Got a presentation-connection-open-request";
msgs::PresentationConnectionOpenRequest request;
const ssize_t result = msgs::DecodePresentationConnectionOpenRequest(
buffer, buffer_size, &request);
if (result < 0) {
OSP_LOG_WARN << "Presentation-connection-open-request parse error: "
<< result;
TRACE_SET_RESULT(Error::Code::kParseError);
return Error::Code::kParseError;
}
PresentationID presentation_id(std::move(request.presentation_id));
// TODO(jophba): add logic to queue presentation connection open
// (and terminate connection)
// requests to check against when a presentation starts, in case
// we get a request right before the beginning of the presentation.
if (!presentation_id || started_presentations_.find(presentation_id) ==
started_presentations_.end()) {
msgs::PresentationConnectionOpenResponse response;
response.request_id = request.request_id;
response.result = msgs::PresentationConnectionOpenResponse_result::
kInvalidPresentationId;
Error write_error = WritePresentationConnectionOpenResponse(
response, GetProtocolConnection(endpoint_id).get());
if (!write_error.ok()) {
TRACE_SET_RESULT(write_error);
return write_error;
}
return result;
}
// TODO(btolsch): We would also check that connection_id isn't already
// requested/in use but since the spec has already shifted to a
// receiver-chosen connection ID, we'll ignore that until we change our
// CDDL messages.
std::vector<QueuedResponse>& responses =
queued_responses_[presentation_id];
responses.emplace_back(
QueuedResponse{QueuedResponse::Type::kConnection, request.request_id,
this->GetNextConnectionId(), endpoint_id});
bool connecting = delegate_->ConnectToPresentation(
request.request_id, presentation_id, endpoint_id);
if (connecting)
return result;
responses.pop_back();
if (responses.empty())
queued_responses_.erase(presentation_id);
msgs::PresentationConnectionOpenResponse response;
response.request_id = request.request_id;
response.result =
msgs::PresentationConnectionOpenResponse_result::kUnknownError;
Error write_error = WritePresentationConnectionOpenResponse(
response, GetProtocolConnection(endpoint_id).get());
if (!write_error.ok()) {
TRACE_SET_RESULT(write_error);
return write_error;
}
return result;
}
case msgs::Type::kPresentationTerminationRequest: {
TRACE_SCOPED(TraceCategory::kPresentation,
"kPresentationTerminationRequest");
OSP_VLOG << "got presentation-termination-request";
msgs::PresentationTerminationRequest request;
const ssize_t result = msgs::DecodePresentationTerminationRequest(
buffer, buffer_size, &request);
if (result < 0) {
OSP_LOG_WARN << "Presentation-termination-request parse error: "
<< result;
TRACE_SET_RESULT(Error::Code::kParseError);
return Error::Code::kParseError;
}
PresentationID presentation_id(std::move(request.presentation_id));
OSP_LOG_INFO << "Got termination request for: " << presentation_id;
auto presentation_entry = started_presentations_.find(presentation_id);
if (presentation_id &&
presentation_entry != started_presentations_.end()) {
TerminationReason reason =
(request.reason == msgs::PresentationTerminationRequest_reason::
kUserTerminatedViaController)
? TerminationReason::kControllerTerminateCalled
: TerminationReason::kControllerUserTerminated;
presentation_entry->second.terminate_request_id = request.request_id;
delegate_->TerminatePresentation(presentation_id, reason);
msgs::PresentationTerminationResponse response;
response.request_id = request.request_id;
response.result = msgs::PresentationTerminationResponse_result::
kInvalidPresentationId;
Error write_error = WritePresentationTerminationResponse(
response, GetProtocolConnection(endpoint_id).get());
if (!write_error.ok()) {
TRACE_SET_RESULT(write_error);
return write_error;
}
return result;
}
TerminationReason reason =
(request.reason == msgs::PresentationTerminationRequest_reason::
kControllerCalledTerminate)
? TerminationReason::kControllerTerminateCalled
: TerminationReason::kControllerUserTerminated;
presentation_entry->second.terminate_request_id = request.request_id;
delegate_->TerminatePresentation(presentation_id, reason);
return result;
}
default:
TRACE_SET_RESULT(Error::Code::kUnknownMessageType);
return Error::Code::kUnknownMessageType;
}
}
// TODO(crbug.com/openscreen/31): Remove singletons in the embedder API and
// protocol implementation layers and in presentation_connection, as well as
// unit tests. static
Receiver* Receiver::Get() {
static Receiver& receiver = *new Receiver();
return &receiver;
}
void Receiver::Init() {
if (!connection_manager_) {
connection_manager_ =
std::make_unique<ConnectionManager>(GetServerDemuxer());
}
}
void Receiver::Deinit() {
connection_manager_.reset();
}
void Receiver::SetReceiverDelegate(ReceiverDelegate* delegate) {
OSP_DCHECK(!delegate_ || !delegate);
delegate_ = delegate;
MessageDemuxer* demuxer = GetServerDemuxer();
if (delegate_) {
availability_watch_ = demuxer->SetDefaultMessageTypeWatch(
msgs::Type::kPresentationUrlAvailabilityRequest, this);
initiation_watch_ = demuxer->SetDefaultMessageTypeWatch(
msgs::Type::kPresentationStartRequest, this);
connection_watch_ = demuxer->SetDefaultMessageTypeWatch(
msgs::Type::kPresentationConnectionOpenRequest, this);
return;
}
StopWatching(&availability_watch_);
StopWatching(&initiation_watch_);
StopWatching(&connection_watch_);
std::vector<std::string> presentations_to_remove(
started_presentations_.size());
for (auto& it : started_presentations_) {
presentations_to_remove.push_back(it.first);
}
for (auto& presentation_id : presentations_to_remove) {
OnPresentationTerminated(presentation_id,
TerminationReason::kReceiverShuttingDown);
}
}
Error Receiver::OnPresentationStarted(const std::string& presentation_id,
Connection* connection,
ResponseResult result) {
auto queued_responses_entry = queued_responses_.find(presentation_id);
if (queued_responses_entry == queued_responses_.end())
return Error::Code::kNoStartedPresentation;
auto& responses = queued_responses_entry->second;
if ((responses.size() != 1) ||
(responses.front().type != QueuedResponse::Type::kInitiation)) {
return Error::Code::kPresentationAlreadyStarted;
}
QueuedResponse& initiation_response = responses.front();
msgs::PresentationStartResponse response;
response.request_id = initiation_response.request_id;
auto protocol_connection =
GetProtocolConnection(initiation_response.endpoint_id);
auto* raw_protocol_connection_ptr = protocol_connection.get();
OSP_VLOG << "presentation started with protocol_connection id: "
<< protocol_connection->id();
if (result != ResponseResult::kSuccess) {
response.result = msgs::PresentationStartResponse_result::kUnknownError;
queued_responses_.erase(queued_responses_entry);
return WritePresentationInitiationResponse(response,
raw_protocol_connection_ptr);
}
response.result = msgs::PresentationStartResponse_result::kSuccess;
response.connection_id = connection->connection_id();
Presentation& presentation = started_presentations_[presentation_id];
presentation.endpoint_id = initiation_response.endpoint_id;
connection->OnConnected(initiation_response.connection_id,
initiation_response.endpoint_id,
std::move(protocol_connection));
presentation.connections.push_back(connection);
connection_manager_->AddConnection(connection);
presentation.terminate_watch = GetServerDemuxer()->WatchMessageType(
initiation_response.endpoint_id,
msgs::Type::kPresentationTerminationRequest, this);
queued_responses_.erase(queued_responses_entry);
return WritePresentationInitiationResponse(response,
raw_protocol_connection_ptr);
}
Error Receiver::OnConnectionCreated(uint64_t request_id,
Connection* connection,
ResponseResult result) {
const auto presentation_id = connection->presentation_info().id;
ErrorOr<QueuedResponseIterator> connection_response =
GetQueuedResponse(presentation_id, request_id);
if (connection_response.is_error()) {
return connection_response.error();
}
connection->OnConnected(
connection_response.value()->connection_id,
connection_response.value()->endpoint_id,
NetworkServiceManager::Get()
->GetProtocolConnectionServer()
->CreateProtocolConnection(connection_response.value()->endpoint_id));
started_presentations_[presentation_id].connections.push_back(connection);
connection_manager_->AddConnection(connection);
msgs::PresentationConnectionOpenResponse response;
response.request_id = request_id;
response.result = msgs::PresentationConnectionOpenResponse_result::kSuccess;
response.connection_id = connection->connection_id();
auto protocol_connection =
GetProtocolConnection(connection_response.value()->endpoint_id);
WritePresentationConnectionOpenResponse(response, protocol_connection.get());
DeleteQueuedResponse(presentation_id, connection_response.value());
return Error::None();
}
Error Receiver::CloseConnection(Connection* connection,
Connection::CloseReason reason) {
std::unique_ptr<ProtocolConnection> protocol_connection =
GetProtocolConnection(connection->endpoint_id());
if (!protocol_connection)
return Error::Code::kNoActiveConnection;
msgs::PresentationConnectionCloseEvent event;
event.connection_id = connection->connection_id();
event.reason = GetEventCloseReason(reason);
event.has_error_message = false;
msgs::CborEncodeBuffer buffer;
return protocol_connection->WriteMessage(
event, msgs::EncodePresentationConnectionCloseEvent);
}
Error Receiver::OnPresentationTerminated(const std::string& presentation_id,
TerminationReason reason) {
auto presentation_entry = started_presentations_.find(presentation_id);
if (presentation_entry == started_presentations_.end())
return Error::Code::kNoStartedPresentation;
Presentation& presentation = presentation_entry->second;
presentation.terminate_watch = MessageDemuxer::MessageWatch();
std::unique_ptr<ProtocolConnection> protocol_connection =
GetProtocolConnection(presentation.endpoint_id);
if (!protocol_connection)
return Error::Code::kNoActiveConnection;
for (auto* connection : presentation.connections)
connection->OnTerminated();
if (presentation.terminate_request_id) {
// TODO(btolsch): Also timeout if this point isn't reached.
msgs::PresentationTerminationResponse response;
response.request_id = presentation.terminate_request_id;
response.result = msgs::PresentationTerminationResponse_result::kSuccess;
started_presentations_.erase(presentation_entry);
return WritePresentationTerminationResponse(response,
protocol_connection.get());
}
msgs::PresentationTerminationEvent event;
event.presentation_id = presentation_id;
event.reason = GetEventTerminationReason(reason);
started_presentations_.erase(presentation_entry);
return WritePresentationTerminationEvent(event, protocol_connection.get());
}
void Receiver::OnConnectionDestroyed(Connection* connection) {
auto presentation_entry =
started_presentations_.find(connection->presentation_info().id);
if (presentation_entry == started_presentations_.end())
return;
std::vector<Connection*>& connections =
presentation_entry->second.connections;
auto past_the_end =
std::remove(connections.begin(), connections.end(), connection);
// An additional call to "erase" is necessary to actually adjust the size
// of the vector.
connections.erase(past_the_end, connections.end());
connection_manager_->RemoveConnection(connection);
}
Receiver::Receiver() = default;
Receiver::~Receiver() = default;
void Receiver::DeleteQueuedResponse(const std::string& presentation_id,
Receiver::QueuedResponseIterator response) {
auto entry = queued_responses_.find(presentation_id);
entry->second.erase(response);
if (entry->second.empty())
queued_responses_.erase(entry);
}
ErrorOr<Receiver::QueuedResponseIterator> Receiver::GetQueuedResponse(
const std::string& presentation_id,
uint64_t request_id) const {
auto entry = queued_responses_.find(presentation_id);
if (entry == queued_responses_.end()) {
OSP_LOG_WARN << "connection created for unknown request";
return Error::Code::kUnknownRequestId;
}
const std::vector<QueuedResponse>& responses = entry->second;
Receiver::QueuedResponseIterator it =
std::find_if(responses.begin(), responses.end(),
[request_id](const QueuedResponse& response) {
return response.request_id == request_id;
});
if (it == responses.end()) {
OSP_LOG_WARN << "connection created for unknown request";
return Error::Code::kUnknownRequestId;
}
return it;
}
uint64_t Receiver::GetNextConnectionId() {
static uint64_t request_id = 0;
return request_id++;
}
} // namespace osp
} // namespace openscreen
|