// 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 "remoting/protocol/jingle_messages.h"
#include "base/logging.h"
#include "base/strings/string_number_conversions.h"
#include "remoting/base/constants.h"
#include "remoting/protocol/content_description.h"
#include "remoting/protocol/name_value_map.h"
#include "third_party/libjingle/source/talk/xmllite/xmlelement.h"
using buzz::QName;
using buzz::XmlElement;
namespace remoting {
namespace protocol {
const char kJabberNamespace[] = "jabber:client";
const char kJingleNamespace[] = "urn:xmpp:jingle:1";
const char kP2PTransportNamespace[] = "http://www.google.com/transport/p2p";
namespace {
const char kEmptyNamespace[] = "";
const char kXmlNamespace[] = "http://www.w3.org/XML/1998/namespace";
const int kPortMin = 1000;
const int kPortMax = 65535;
const NameMapElement<JingleMessage::ActionType> kActionTypes[] = {
{ JingleMessage::SESSION_INITIATE, "session-initiate" },
{ JingleMessage::SESSION_ACCEPT, "session-accept" },
{ JingleMessage::SESSION_TERMINATE, "session-terminate" },
{ JingleMessage::SESSION_INFO, "session-info" },
{ JingleMessage::TRANSPORT_INFO, "transport-info" },
};
const NameMapElement<JingleMessage::Reason> kReasons[] = {
{ JingleMessage::SUCCESS, "success" },
{ JingleMessage::DECLINE, "decline" },
{ JingleMessage::CANCEL, "cancel" },
{ JingleMessage::GENERAL_ERROR, "general-error" },
{ JingleMessage::INCOMPATIBLE_PARAMETERS, "incompatible-parameters" },
};
bool ParseCandidate(const buzz::XmlElement* element,
JingleMessage::NamedCandidate* candidate) {
DCHECK(element->Name() == QName(kP2PTransportNamespace, "candidate"));
const std::string& name = element->Attr(QName(kEmptyNamespace, "name"));
const std::string& address = element->Attr(QName(kEmptyNamespace, "address"));
const std::string& port_str = element->Attr(QName(kEmptyNamespace, "port"));
const std::string& type = element->Attr(QName(kEmptyNamespace, "type"));
const std::string& protocol =
element->Attr(QName(kEmptyNamespace, "protocol"));
const std::string& username =
element->Attr(QName(kEmptyNamespace, "username"));
const std::string& password =
element->Attr(QName(kEmptyNamespace, "password"));
const std::string& preference_str =
element->Attr(QName(kEmptyNamespace, "preference"));
const std::string& generation_str =
element->Attr(QName(kEmptyNamespace, "generation"));
int port;
double preference;
int generation;
if (name.empty() || address.empty() || !base::StringToInt(port_str, &port) ||
port < kPortMin || port > kPortMax || type.empty() || protocol.empty() ||
username.empty() || password.empty() ||
!base::StringToDouble(preference_str, &preference) ||
!base::StringToInt(generation_str, &generation)) {
return false;
}
candidate->name = name;
candidate->candidate.set_address(talk_base::SocketAddress(address, port));
candidate->candidate.set_type(type);
candidate->candidate.set_protocol(protocol);
candidate->candidate.set_username(username);
candidate->candidate.set_password(password);
candidate->candidate.set_preference(static_cast<float>(preference));
candidate->candidate.set_generation(generation);
return true;
}
XmlElement* FormatCandidate(const JingleMessage::NamedCandidate& candidate) {
XmlElement* result =
new XmlElement(QName(kP2PTransportNamespace, "candidate"));
result->SetAttr(QName(kEmptyNamespace, "name"), candidate.name);
result->SetAttr(QName(kEmptyNamespace, "address"),
candidate.candidate.address().ipaddr().ToString());
result->SetAttr(QName(kEmptyNamespace, "port"),
base::IntToString(candidate.candidate.address().port()));
result->SetAttr(QName(kEmptyNamespace, "type"), candidate.candidate.type());
result->SetAttr(QName(kEmptyNamespace, "protocol"),
candidate.candidate.protocol());
result->SetAttr(QName(kEmptyNamespace, "username"),
candidate.candidate.username());
result->SetAttr(QName(kEmptyNamespace, "password"),
candidate.candidate.password());
result->SetAttr(QName(kEmptyNamespace, "preference"),
base::DoubleToString(candidate.candidate.preference()));
result->SetAttr(QName(kEmptyNamespace, "generation"),
base::IntToString(candidate.candidate.generation()));
return result;
}
} // namespace
JingleMessage::NamedCandidate::NamedCandidate() {
}
JingleMessage::NamedCandidate::NamedCandidate(
const std::string& name,
const cricket::Candidate& candidate)
: name(name),
candidate(candidate) {
}
// static
bool JingleMessage::IsJingleMessage(const buzz::XmlElement* stanza) {
return stanza->Name() == QName(kJabberNamespace, "iq") &&
stanza->Attr(QName(std::string(), "type")) == "set" &&
stanza->FirstNamed(QName(kJingleNamespace, "jingle")) != NULL;
}
// static
std::string JingleMessage::GetActionName(ActionType action) {
return ValueToName(kActionTypes, action);
}
JingleMessage::JingleMessage()
: action(UNKNOWN_ACTION),
reason(UNKNOWN_REASON) {
}
JingleMessage::JingleMessage(
const std::string& to_value,
ActionType action_value,
const std::string& sid_value)
: to(to_value),
action(action_value),
sid(sid_value),
reason(UNKNOWN_REASON) {
}
JingleMessage::~JingleMessage() {
}
bool JingleMessage::ParseXml(const buzz::XmlElement* stanza,
std::string* error) {
if (!IsJingleMessage(stanza)) {
*error = "Not a jingle message";
return false;
}
const XmlElement* jingle_tag =
stanza->FirstNamed(QName(kJingleNamespace, "jingle"));
if (!jingle_tag) {
*error = "Not a jingle message";
return false;
}
from = stanza->Attr(QName(kEmptyNamespace, "from"));
to = stanza->Attr(QName(kEmptyNamespace, "to"));
initiator = jingle_tag->Attr(QName(kEmptyNamespace, "initiator"));
std::string action_str = jingle_tag->Attr(QName(kEmptyNamespace, "action"));
if (action_str.empty()) {
*error = "action attribute is missing";
return false;
}
if (!NameToValue(kActionTypes, action_str, &action)) {
*error = "Unknown action " + action_str;
return false;
}
sid = jingle_tag->Attr(QName(kEmptyNamespace, "sid"));
if (sid.empty()) {
*error = "sid attribute is missing";
return false;
}
if (action == SESSION_INFO) {
// session-info messages may contain arbitrary information not
// defined by the Jingle protocol. We don't need to parse it.
const XmlElement* child = jingle_tag->FirstElement();
if (child) {
// session-info is allowed to be empty.
info.reset(new XmlElement(*child));
} else {
info.reset(NULL);
}
return true;
}
const XmlElement* reason_tag =
jingle_tag->FirstNamed(QName(kJingleNamespace, "reason"));
if (reason_tag && reason_tag->FirstElement()) {
if (!NameToValue(kReasons, reason_tag->FirstElement()->Name().LocalPart(),
&reason)) {
reason = UNKNOWN_REASON;
}
}
if (action == SESSION_TERMINATE)
return true;
const XmlElement* content_tag =
jingle_tag->FirstNamed(QName(kJingleNamespace, "content"));
if (!content_tag) {
*error = "content tag is missing";
return false;
}
std::string content_name = content_tag->Attr(QName(kEmptyNamespace, "name"));
if (content_name != ContentDescription::kChromotingContentName) {
*error = "Unexpected content name: " + content_name;
return false;
}
description.reset(NULL);
if (action == SESSION_INITIATE || action == SESSION_ACCEPT) {
const XmlElement* description_tag = content_tag->FirstNamed(
QName(kChromotingXmlNamespace, "description"));
if (!description_tag) {
*error = "Missing chromoting content description";
return false;
}
description = ContentDescription::ParseXml(description_tag);
if (!description.get()) {
*error = "Failed to parse content description";
return false;
}
}
candidates.clear();
const XmlElement* transport_tag = content_tag->FirstNamed(
QName(kP2PTransportNamespace, "transport"));
if (transport_tag) {
QName qn_candidate(kP2PTransportNamespace, "candidate");
for (const XmlElement* candidate_tag =
transport_tag->FirstNamed(qn_candidate);
candidate_tag != NULL;
candidate_tag = candidate_tag->NextNamed(qn_candidate)) {
NamedCandidate candidate;
if (!ParseCandidate(candidate_tag, &candidate)) {
*error = "Failed to parse candidates";
return false;
}
candidates.push_back(candidate);
}
}
return true;
}
scoped_ptr<buzz::XmlElement> JingleMessage::ToXml() const {
scoped_ptr<XmlElement> root(
new XmlElement(QName("jabber:client", "iq"), true));
DCHECK(!to.empty());
root->AddAttr(QName(kEmptyNamespace, "to"), to);
if (!from.empty())
root->AddAttr(QName(kEmptyNamespace, "from"), from);
root->SetAttr(QName(kEmptyNamespace, "type"), "set");
XmlElement* jingle_tag =
new XmlElement(QName(kJingleNamespace, "jingle"), true);
root->AddElement(jingle_tag);
jingle_tag->AddAttr(QName(kEmptyNamespace, "sid"), sid);
const char* action_attr = ValueToName(kActionTypes, action);
if (!action_attr)
LOG(FATAL) << "Invalid action value " << action;
jingle_tag->AddAttr(QName(kEmptyNamespace, "action"), action_attr);
if (action == SESSION_INFO) {
if (info.get())
jingle_tag->AddElement(new XmlElement(*info.get()));
return root.Pass();
}
if (action == SESSION_INITIATE)
jingle_tag->AddAttr(QName(kEmptyNamespace, "initiator"), initiator);
if (reason != UNKNOWN_REASON) {
XmlElement* reason_tag = new XmlElement(QName(kJingleNamespace, "reason"));
jingle_tag->AddElement(reason_tag);
const char* reason_string =
ValueToName(kReasons, reason);
if (!reason_string)
LOG(FATAL) << "Invalid reason: " << reason;
reason_tag->AddElement(new XmlElement(
QName(kJingleNamespace, reason_string)));
}
if (action != SESSION_TERMINATE) {
XmlElement* content_tag =
new XmlElement(QName(kJingleNamespace, "content"));
jingle_tag->AddElement(content_tag);
content_tag->AddAttr(QName(kEmptyNamespace, "name"),
ContentDescription::kChromotingContentName);
content_tag->AddAttr(QName(kEmptyNamespace, "creator"), "initiator");
if (description.get())
content_tag->AddElement(description->ToXml());
XmlElement* transport_tag =
new XmlElement(QName(kP2PTransportNamespace, "transport"), true);
content_tag->AddElement(transport_tag);
for (std::list<NamedCandidate>::const_iterator it = candidates.begin();
it != candidates.end(); ++it) {
transport_tag->AddElement(FormatCandidate(*it));
}
}
return root.Pass();
}
JingleMessageReply::JingleMessageReply()
: type(REPLY_RESULT),
error_type(NONE) {
}
JingleMessageReply::JingleMessageReply(ErrorType error)
: type(error != NONE ? REPLY_ERROR : REPLY_RESULT),
error_type(error) {
}
JingleMessageReply::JingleMessageReply(ErrorType error,
const std::string& text_value)
: type(REPLY_ERROR),
error_type(error),
text(text_value) {
}
JingleMessageReply::~JingleMessageReply() { }
scoped_ptr<buzz::XmlElement> JingleMessageReply::ToXml(
const buzz::XmlElement* request_stanza) const {
scoped_ptr<XmlElement> iq(
new XmlElement(QName(kJabberNamespace, "iq"), true));
iq->SetAttr(QName(kEmptyNamespace, "to"),
request_stanza->Attr(QName(kEmptyNamespace, "from")));
iq->SetAttr(QName(kEmptyNamespace, "id"),
request_stanza->Attr(QName(kEmptyNamespace, "id")));
if (type == REPLY_RESULT) {
iq->SetAttr(QName(kEmptyNamespace, "type"), "result");
return iq.Pass();
}
DCHECK_EQ(type, REPLY_ERROR);
iq->SetAttr(QName(kEmptyNamespace, "type"), "error");
for (const buzz::XmlElement* child = request_stanza->FirstElement();
child != NULL; child = child->NextElement()) {
iq->AddElement(new buzz::XmlElement(*child));
}
buzz::XmlElement* error =
new buzz::XmlElement(QName(kJabberNamespace, "error"));
iq->AddElement(error);
std::string type;
std::string error_text;
QName name;
switch (error_type) {
case BAD_REQUEST:
type = "modify";
name = QName(kJabberNamespace, "bad-request");
break;
case NOT_IMPLEMENTED:
type = "cancel";
name = QName(kJabberNamespace, "feature-bad-request");
break;
case INVALID_SID:
type = "modify";
name = QName(kJabberNamespace, "item-not-found");
error_text = "Invalid SID";
break;
case UNEXPECTED_REQUEST:
type = "modify";
name = QName(kJabberNamespace, "unexpected-request");
break;
case UNSUPPORTED_INFO:
type = "modify";
name = QName(kJabberNamespace, "feature-not-implemented");
break;
default:
NOTREACHED();
}
if (!text.empty())
error_text = text;
error->SetAttr(QName(kEmptyNamespace, "type"), type);
// If the error name is not in the standard namespace, we have
// to first add some error from that namespace.
if (name.Namespace() != kJabberNamespace) {
error->AddElement(
new buzz::XmlElement(QName(kJabberNamespace, "undefined-condition")));
}
error->AddElement(new buzz::XmlElement(name));
if (!error_text.empty()) {
// It's okay to always use English here. This text is for
// debugging purposes only.
buzz::XmlElement* text_elem =
new buzz::XmlElement(QName(kJabberNamespace, "text"));
text_elem->SetAttr(QName(kXmlNamespace, "lang"), "en");
text_elem->SetBodyText(error_text);
error->AddElement(text_elem);
}
return iq.Pass();
}
} // namespace protocol
} // namespace remoting