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
|
// Copyright 2018 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/providers/dial/dial_internal_message_util.h"
#include <array>
#include "base/base64url.h"
#include "base/hash/sha1.h"
#include "base/json/json_reader.h"
#include "base/json/json_writer.h"
#include "base/strings/escape.h"
#include "base/strings/string_number_conversions.h"
#include "components/media_router/browser/route_message_util.h"
#include "components/media_router/common/discovery/media_sink_internal.h"
#include "url/url_util.h"
namespace media_router {
namespace {
constexpr int kSequenceNumberWrap = 2 << 30;
int GetNextDialLaunchSequenceNumber() {
static int next_seq_number = 0;
next_seq_number = (next_seq_number + 1) % kSequenceNumberWrap;
return next_seq_number;
}
std::string GetNextSessionId() {
static int session_id = 0;
session_id = (session_id + 1) % kSequenceNumberWrap;
return base::NumberToString(session_id);
}
std::string DialInternalMessageTypeToString(DialInternalMessageType type) {
switch (type) {
case DialInternalMessageType::kClientConnect:
return "client_connect";
case DialInternalMessageType::kV2Message:
return "v2_message";
case DialInternalMessageType::kReceiverAction:
return "receiver_action";
case DialInternalMessageType::kNewSession:
return "new_session";
case DialInternalMessageType::kCustomDialLaunch:
return "custom_dial_launch";
case DialInternalMessageType::kDialAppInfo:
return "dial_app_info";
case DialInternalMessageType::kError:
return "error";
case DialInternalMessageType::kOther:
break;
}
NOTREACHED() << "Unknown message type: " << static_cast<int>(type);
}
DialInternalMessageType StringToDialInternalMessageType(
const std::string& str_type) {
if (str_type == "client_connect") {
return DialInternalMessageType::kClientConnect;
}
if (str_type == "v2_message") {
return DialInternalMessageType::kV2Message;
}
if (str_type == "receiver_action") {
return DialInternalMessageType::kReceiverAction;
}
if (str_type == "new_session") {
return DialInternalMessageType::kNewSession;
}
if (str_type == "custom_dial_launch") {
return DialInternalMessageType::kCustomDialLaunch;
}
if (str_type == "dial_app_info") {
return DialInternalMessageType::kDialAppInfo;
}
if (str_type == "error") {
return DialInternalMessageType::kError;
}
return DialInternalMessageType::kOther;
}
std::string DialReceiverActionToString(DialReceiverAction action) {
switch (action) {
case DialReceiverAction::kCast:
return "cast";
case DialReceiverAction::kStop:
return "stop";
}
NOTREACHED() << "Unknown DialReceiverAction: " << static_cast<int>(action);
}
std::string DialAppInfoErrorToString(DialAppInfoResultCode error) {
switch (error) {
case DialAppInfoResultCode::kNetworkError:
return "network_error";
case DialAppInfoResultCode::kParsingError:
return "parsing_error";
case DialAppInfoResultCode::kHttpError:
return "http_error";
case DialAppInfoResultCode::kOk:
case DialAppInfoResultCode::kCount:
NOTREACHED() << "Unexpected DialAppInfoResultCode: "
<< static_cast<int>(error);
}
}
} // namespace
// static
std::unique_ptr<DialInternalMessage> DialInternalMessage::From(
base::Value::Dict message,
std::string* error) {
DCHECK(error);
std::string* type_value = message.FindString("type");
if (!type_value) {
*error = "Missing type value";
return nullptr;
}
DialInternalMessageType message_type =
StringToDialInternalMessageType(*type_value);
if (message_type == DialInternalMessageType::kOther) {
*error = "Unsupported message type";
return nullptr;
}
std::string* client_id = message.FindString("clientId");
if (!client_id) {
*error = "Missing clientId";
return nullptr;
}
std::optional<base::Value> message_body;
base::Value* message_body_value = message.Find("message");
if (message_body_value) {
message_body = std::move(*message_body_value);
}
int sequence_number = message.FindInt("sequenceNumber").value_or(-1);
return std::make_unique<DialInternalMessage>(
message_type, std::move(message_body), *client_id, sequence_number);
}
DialInternalMessage::DialInternalMessage(DialInternalMessageType type,
std::optional<base::Value> body,
const std::string& client_id,
int sequence_number)
: type(type),
body(std::move(body)),
client_id(client_id),
sequence_number(sequence_number) {}
DialInternalMessage::~DialInternalMessage() = default;
// static
CustomDialLaunchMessageBody CustomDialLaunchMessageBody::From(
const DialInternalMessage& message) {
DCHECK(message.type == DialInternalMessageType::kCustomDialLaunch);
const std::optional<base::Value>& body = message.body;
if (!body || !body->is_dict()) {
return CustomDialLaunchMessageBody();
}
const std::optional<bool> do_launch = body->GetDict().FindBool("doLaunch");
if (!do_launch) {
return CustomDialLaunchMessageBody();
}
std::optional<std::string> launch_parameter;
const std::string* launch_parameter_value =
body->GetDict().FindString("launchParameter");
if (launch_parameter_value) {
launch_parameter = *launch_parameter_value;
}
return CustomDialLaunchMessageBody(*do_launch, launch_parameter);
}
CustomDialLaunchMessageBody::CustomDialLaunchMessageBody() = default;
CustomDialLaunchMessageBody::CustomDialLaunchMessageBody(
bool do_launch,
const std::optional<std::string>& launch_parameter)
: do_launch(do_launch), launch_parameter(launch_parameter) {}
CustomDialLaunchMessageBody::CustomDialLaunchMessageBody(
const CustomDialLaunchMessageBody& other) = default;
CustomDialLaunchMessageBody::~CustomDialLaunchMessageBody() = default;
DialInternalMessageUtil::DialInternalMessageUtil(const std::string& hash_token)
: hash_token_(hash_token) {}
DialInternalMessageUtil::~DialInternalMessageUtil() = default;
// static
bool DialInternalMessageUtil::IsStopSessionMessage(
const DialInternalMessage& message) {
if (message.type != DialInternalMessageType::kV2Message) {
return false;
}
const std::optional<base::Value>& body = message.body;
if (!body || !body->is_dict()) {
return false;
}
const std::string* request_type = body->GetDict().FindString("type");
return request_type && *request_type == "STOP";
}
mojom::RouteMessagePtr DialInternalMessageUtil::CreateNewSessionMessage(
const std::string& app_name,
const std::string& client_id,
const MediaSinkInternal& sink) const {
base::Value message =
CreateDialMessageCommon(DialInternalMessageType::kNewSession,
CreateNewSessionBody(app_name, sink), client_id);
return message_util::RouteMessageFromValue(std::move(message));
}
mojom::RouteMessagePtr DialInternalMessageUtil::CreateReceiverActionCastMessage(
const std::string& client_id,
const MediaSinkInternal& sink) const {
base::Value message = CreateDialMessageCommon(
DialInternalMessageType::kReceiverAction,
CreateReceiverActionBody(sink, DialReceiverAction::kCast), client_id);
return message_util::RouteMessageFromValue(std::move(message));
}
mojom::RouteMessagePtr DialInternalMessageUtil::CreateReceiverActionStopMessage(
const std::string& client_id,
const MediaSinkInternal& sink) const {
base::Value message = CreateDialMessageCommon(
DialInternalMessageType::kReceiverAction,
CreateReceiverActionBody(sink, DialReceiverAction::kStop), client_id);
return message_util::RouteMessageFromValue(std::move(message));
}
std::pair<mojom::RouteMessagePtr, int>
DialInternalMessageUtil::CreateCustomDialLaunchMessage(
const std::string& client_id,
const MediaSinkInternal& sink,
const ParsedDialAppInfo& app_info) const {
int seq_number = GetNextDialLaunchSequenceNumber();
// A CUSTOM_DIAL_LAUNCH message is the same as A DIAL_APP_INFO response except
// for the message type.
return {CreateDialAppInfoMessage(client_id, sink, app_info, seq_number,
DialInternalMessageType::kCustomDialLaunch),
seq_number};
}
mojom::RouteMessagePtr DialInternalMessageUtil::CreateDialAppInfoMessage(
const std::string& client_id,
const MediaSinkInternal& sink,
const ParsedDialAppInfo& app_info,
int sequence_number,
DialInternalMessageType type) const {
base::Value message = CreateDialMessageCommon(
type, CreateDialAppInfoBody(sink, app_info), client_id, sequence_number);
return message_util::RouteMessageFromValue(std::move(message));
}
mojom::RouteMessagePtr DialInternalMessageUtil::CreateDialAppInfoErrorMessage(
DialAppInfoResultCode result_code,
const std::string& client_id,
int sequence_number,
const std::string& error_message,
std::optional<int> http_error_code) const {
// The structure of an error message body is defined as chrome.cast.Error in
// the Cast SDK.
base::Value::Dict body;
body.Set("code", DialAppInfoErrorToString(result_code));
body.Set("description", error_message);
if (result_code == DialAppInfoResultCode::kHttpError) {
DCHECK(http_error_code);
base::Value::Dict details;
details.Set("http_error_code", *http_error_code);
body.Set("details", std::move(details));
}
base::Value message =
CreateDialMessageCommon(DialInternalMessageType::kError, std::move(body),
client_id, sequence_number);
return message_util::RouteMessageFromValue(std::move(message));
}
base::Value::Dict DialInternalMessageUtil::CreateReceiver(
const MediaSinkInternal& sink) const {
base::Value::Dict receiver;
std::string label = base::SHA1HashString(sink.sink().id() + hash_token_);
base::Base64UrlEncode(label, base::Base64UrlEncodePolicy::OMIT_PADDING,
&label);
receiver.Set("label", base::Value(label));
receiver.Set("friendlyName",
base::Value(base::EscapeForHTML(sink.sink().name())));
receiver.Set("capabilities", base::Value::List());
receiver.Set("volume", base::Value());
receiver.Set("isActiveInput", base::Value());
receiver.Set("displayStatus", base::Value());
receiver.Set("receiverType", base::Value("dial"));
receiver.Set("ipAddress",
base::Value(sink.dial_data().ip_address.ToString()));
return receiver;
}
base::Value::Dict DialInternalMessageUtil::CreateReceiverActionBody(
const MediaSinkInternal& sink,
DialReceiverAction action) const {
base::Value::Dict message_body;
message_body.Set("receiver", CreateReceiver(sink));
message_body.Set("action", base::Value(DialReceiverActionToString(action)));
return message_body;
}
base::Value::Dict DialInternalMessageUtil::CreateNewSessionBody(
const std::string& app_name,
const MediaSinkInternal& sink) const {
base::Value::Dict message_body;
message_body.Set("sessionId", base::Value(GetNextSessionId()));
message_body.Set("appId", base::Value(""));
message_body.Set("displayName", base::Value(app_name));
message_body.Set("statusText", base::Value(""));
message_body.Set("appImages", base::Value::List());
message_body.Set("receiver", CreateReceiver(sink));
message_body.Set("senderApps", base::Value::List());
message_body.Set("namespaces", base::Value::List());
message_body.Set("media", base::Value::List());
message_body.Set("status", base::Value("connected"));
message_body.Set("transportId", base::Value(""));
return message_body;
}
base::Value::Dict DialInternalMessageUtil::CreateDialAppInfoBody(
const MediaSinkInternal& sink,
const ParsedDialAppInfo& app_info) const {
base::Value::Dict message_body;
message_body.Set("receiver", CreateReceiver(sink));
message_body.Set("appState",
base::Value(DialAppStateToString(app_info.state)));
base::Value::Dict extra_data;
for (const auto& key_value : app_info.extra_data) {
extra_data.Set(key_value.first, base::Value(key_value.second));
}
message_body.Set("extraData", std::move(extra_data));
return message_body;
}
base::Value DialInternalMessageUtil::CreateDialMessageCommon(
DialInternalMessageType type,
base::Value::Dict body,
const std::string& client_id,
int sequence_number) const {
base::Value::Dict message;
message.Set("type", base::Value(DialInternalMessageTypeToString(type)));
message.Set("message", std::move(body));
message.Set("clientId", base::Value(client_id));
message.Set("sequenceNumber", base::Value(sequence_number));
message.Set("timeoutMillis", base::Value(0));
return base::Value(std::move(message));
}
} // namespace media_router
|