// 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/jingle_glue/xmpp_signal_strategy.h"
#include "base/bind.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/single_thread_task_runner.h"
#include "base/strings/string_util.h"
#include "base/thread_task_runner_handle.h"
#include "jingle/glue/chrome_async_socket.h"
#include "jingle/glue/task_pump.h"
#include "jingle/glue/xmpp_client_socket_factory.h"
#include "jingle/notifier/base/gaia_constants.h"
#include "jingle/notifier/base/gaia_token_pre_xmpp_auth.h"
#include "net/socket/client_socket_factory.h"
#include "net/url_request/url_request_context_getter.h"
#include "third_party/libjingle/source/talk/base/thread.h"
#include "third_party/libjingle/source/talk/xmpp/prexmppauth.h"
#include "third_party/libjingle/source/talk/xmpp/saslcookiemechanism.h"
const char kDefaultResourceName[] = "chromoting";
// Use 58 seconds keep-alive interval, in case routers terminate
// connections that are idle for more than a minute.
const int kKeepAliveIntervalSeconds = 50;
// Read buffer size used by ChromeAsyncSocket for read and write buffers. Most
// of XMPP messages are smaller than 4kB.
const size_t kReadBufferSize = 4096;
const size_t kWriteBufferSize = 4096;
namespace remoting {
XmppSignalStrategy::XmppServerConfig::XmppServerConfig() {}
XmppSignalStrategy::XmppServerConfig::~XmppServerConfig() {}
XmppSignalStrategy::XmppSignalStrategy(
net::ClientSocketFactory* socket_factory,
scoped_refptr<net::URLRequestContextGetter> request_context_getter,
const XmppSignalStrategy::XmppServerConfig& xmpp_server_config)
: socket_factory_(socket_factory),
request_context_getter_(request_context_getter),
resource_name_(kDefaultResourceName),
xmpp_client_(NULL),
xmpp_server_config_(xmpp_server_config),
state_(DISCONNECTED),
error_(OK) {
#if defined(NDEBUG)
CHECK(xmpp_server_config_.use_tls);
#endif
}
XmppSignalStrategy::~XmppSignalStrategy() {
Disconnect();
// Destroying task runner will destroy XmppClient, but XmppClient may be on
// the stack and it doesn't handle this case properly, so we need to delay
// destruction.
base::ThreadTaskRunnerHandle::Get()->DeleteSoon(
FROM_HERE, task_runner_.release());
}
void XmppSignalStrategy::Connect() {
DCHECK(CalledOnValidThread());
// Disconnect first if we are currently connected.
Disconnect();
buzz::XmppClientSettings settings;
buzz::Jid login_jid(xmpp_server_config_.username);
settings.set_user(login_jid.node());
settings.set_host(login_jid.domain());
settings.set_resource(resource_name_);
settings.set_token_service(xmpp_server_config_.auth_service);
settings.set_auth_token(buzz::AUTH_MECHANISM_GOOGLE_TOKEN,
xmpp_server_config_.auth_token);
settings.set_server(talk_base::SocketAddress(
xmpp_server_config_.host, xmpp_server_config_.port));
settings.set_use_tls(
xmpp_server_config_.use_tls ? buzz::TLS_ENABLED : buzz::TLS_DISABLED);
scoped_ptr<jingle_glue::XmppClientSocketFactory> xmpp_socket_factory(
new jingle_glue::XmppClientSocketFactory(
socket_factory_, net::SSLConfig(), request_context_getter_, false));
buzz::AsyncSocket* socket = new jingle_glue::ChromeAsyncSocket(
xmpp_socket_factory.release(), kReadBufferSize, kWriteBufferSize);
task_runner_.reset(new jingle_glue::TaskPump());
xmpp_client_ = new buzz::XmppClient(task_runner_.get());
xmpp_client_->Connect(
settings, std::string(), socket, CreatePreXmppAuth(settings));
xmpp_client_->SignalStateChange
.connect(this, &XmppSignalStrategy::OnConnectionStateChanged);
xmpp_client_->engine()->AddStanzaHandler(this, buzz::XmppEngine::HL_TYPE);
xmpp_client_->Start();
SetState(CONNECTING);
}
void XmppSignalStrategy::Disconnect() {
DCHECK(CalledOnValidThread());
if (xmpp_client_) {
xmpp_client_->engine()->RemoveStanzaHandler(this);
xmpp_client_->Disconnect();
// |xmpp_client_| should be set to NULL in OnConnectionStateChanged()
// in response to Disconnect() call above.
DCHECK(xmpp_client_ == NULL);
}
}
SignalStrategy::State XmppSignalStrategy::GetState() const {
DCHECK(CalledOnValidThread());
return state_;
}
SignalStrategy::Error XmppSignalStrategy::GetError() const {
DCHECK(CalledOnValidThread());
return error_;
}
std::string XmppSignalStrategy::GetLocalJid() const {
DCHECK(CalledOnValidThread());
return xmpp_client_->jid().Str();
}
void XmppSignalStrategy::AddListener(Listener* listener) {
DCHECK(CalledOnValidThread());
listeners_.AddObserver(listener);
}
void XmppSignalStrategy::RemoveListener(Listener* listener) {
DCHECK(CalledOnValidThread());
listeners_.RemoveObserver(listener);
}
bool XmppSignalStrategy::SendStanza(scoped_ptr<buzz::XmlElement> stanza) {
DCHECK(CalledOnValidThread());
if (!xmpp_client_) {
VLOG(0) << "Dropping signalling message because XMPP "
"connection has been terminated.";
return false;
}
buzz::XmppReturnStatus status = xmpp_client_->SendStanza(stanza.release());
return status == buzz::XMPP_RETURN_OK || status == buzz::XMPP_RETURN_PENDING;
}
std::string XmppSignalStrategy::GetNextId() {
DCHECK(CalledOnValidThread());
if (!xmpp_client_) {
// If the connection has been terminated then it doesn't matter
// what Id we return.
return std::string();
}
return xmpp_client_->NextId();
}
bool XmppSignalStrategy::HandleStanza(const buzz::XmlElement* stanza) {
DCHECK(CalledOnValidThread());
ObserverListBase<Listener>::Iterator it(listeners_);
Listener* listener;
while ((listener = it.GetNext()) != NULL) {
if (listener->OnSignalStrategyIncomingStanza(stanza))
return true;
}
return false;
}
void XmppSignalStrategy::SetAuthInfo(const std::string& username,
const std::string& auth_token,
const std::string& auth_service) {
DCHECK(CalledOnValidThread());
xmpp_server_config_.username = username;
xmpp_server_config_.auth_token = auth_token;
xmpp_server_config_.auth_service = auth_service;
}
void XmppSignalStrategy::SetResourceName(const std::string &resource_name) {
DCHECK(CalledOnValidThread());
resource_name_ = resource_name;
}
void XmppSignalStrategy::OnConnectionStateChanged(
buzz::XmppEngine::State state) {
DCHECK(CalledOnValidThread());
if (state == buzz::XmppEngine::STATE_OPEN) {
keep_alive_timer_.Start(
FROM_HERE, base::TimeDelta::FromSeconds(kKeepAliveIntervalSeconds),
this, &XmppSignalStrategy::SendKeepAlive);
SetState(CONNECTED);
} else if (state == buzz::XmppEngine::STATE_CLOSED) {
// Make sure we dump errors to the log.
int subcode;
buzz::XmppEngine::Error error = xmpp_client_->GetError(&subcode);
VLOG(0) << "XMPP connection was closed: error=" << error
<< ", subcode=" << subcode;
keep_alive_timer_.Stop();
// Client is destroyed by the TaskRunner after the client is
// closed. Reset the pointer so we don't try to use it later.
xmpp_client_ = NULL;
switch (error) {
case buzz::XmppEngine::ERROR_UNAUTHORIZED:
case buzz::XmppEngine::ERROR_AUTH:
case buzz::XmppEngine::ERROR_MISSING_USERNAME:
error_ = AUTHENTICATION_FAILED;
break;
default:
error_ = NETWORK_ERROR;
}
SetState(DISCONNECTED);
}
}
void XmppSignalStrategy::SetState(State new_state) {
if (state_ != new_state) {
state_ = new_state;
FOR_EACH_OBSERVER(Listener, listeners_,
OnSignalStrategyStateChange(new_state));
}
}
void XmppSignalStrategy::SendKeepAlive() {
xmpp_client_->SendRaw(" ");
}
// static
buzz::PreXmppAuth* XmppSignalStrategy::CreatePreXmppAuth(
const buzz::XmppClientSettings& settings) {
buzz::Jid jid(settings.user(), settings.host(), buzz::STR_EMPTY);
std::string mechanism = notifier::kDefaultGaiaAuthMechanism;
if (settings.token_service() == "oauth2") {
mechanism = "X-OAUTH2";
}
return new notifier::GaiaTokenPreXmppAuth(
jid.Str(), settings.auth_token(), settings.token_service(), mechanism);
}
} // namespace remoting