1use std::mem::replace;
2use std::str::FromStr;
3use tokio::net::TcpStream;
4use tokio_io::{AsyncRead, AsyncWrite};
5use tokio_tls::TlsStream;
6use futures::{Future, Stream, Poll, Async, Sink, StartSend, AsyncSink, done};
7use minidom::Element;
8use jid::{Jid, JidParseError};
9use sasl::common::{Credentials, ChannelBinding};
10use idna;
11
12use super::xmpp_codec::Packet;
13use super::xmpp_stream;
14use super::starttls::{NS_XMPP_TLS, StartTlsClient};
15use super::happy_eyeballs::Connecter;
16use super::event::Event;
17use super::{Error, ProtocolError};
18
19mod auth;
20use self::auth::ClientAuth;
21mod bind;
22use self::bind::ClientBind;
23
24/// XMPP client connection and state
25pub struct Client {
26 /// The client's current Jabber-Id
27 pub jid: Jid,
28 state: ClientState,
29}
30
31type XMPPStream = xmpp_stream::XMPPStream<TlsStream<TcpStream>>;
32const NS_JABBER_CLIENT: &str = "jabber:client";
33
34enum ClientState {
35 Invalid,
36 Disconnected,
37 Connecting(Box<Future<Item=XMPPStream, Error=Error>>),
38 Connected(XMPPStream),
39}
40
41impl Client {
42 /// Start a new XMPP client
43 ///
44 /// Start polling the returned instance so that it will connect
45 /// and yield events.
46 pub fn new(jid: &str, password: &str) -> Result<Self, JidParseError> {
47 let jid = Jid::from_str(jid)?;
48 let password = password.to_owned();
49 let connect = Self::make_connect(jid.clone(), password.clone());
50 Ok(Client {
51 jid,
52 state: ClientState::Connecting(Box::new(connect)),
53 })
54 }
55
56 fn make_connect(jid: Jid, password: String) -> impl Future<Item=XMPPStream, Error=Error> {
57 let username = jid.node.as_ref().unwrap().to_owned();
58 let jid1 = jid.clone();
59 let jid2 = jid.clone();
60 let password = password;
61 done(idna::domain_to_ascii(&jid.domain))
62 .map_err(|_| Error::Idna)
63 .and_then(|domain|
64 done(Connecter::from_lookup(&domain, "_xmpp-client._tcp", 5222))
65 .map_err(Error::Connection)
66 )
67 .and_then(|connecter|
68 connecter
69 .map_err(Error::Connection)
70 ).and_then(move |tcp_stream|
71 xmpp_stream::XMPPStream::start(tcp_stream, jid1, NS_JABBER_CLIENT.to_owned())
72 ).and_then(|xmpp_stream| {
73 if Self::can_starttls(&xmpp_stream) {
74 Ok(Self::starttls(xmpp_stream))
75 } else {
76 Err(Error::Protocol(ProtocolError::NoTls))
77 }
78 }).and_then(|starttls|
79 // TODO: flatten?
80 starttls
81 ).and_then(|tls_stream|
82 XMPPStream::start(tls_stream, jid2, NS_JABBER_CLIENT.to_owned())
83 ).and_then(move |xmpp_stream|
84 done(Self::auth(xmpp_stream, username, password))
85 // TODO: flatten?
86 ).and_then(|auth| auth)
87 .and_then(|xmpp_stream| {
88 Self::bind(xmpp_stream)
89 }).and_then(|xmpp_stream| {
90 // println!("Bound to {}", xmpp_stream.jid);
91 Ok(xmpp_stream)
92 })
93 }
94
95 fn can_starttls<S>(stream: &xmpp_stream::XMPPStream<S>) -> bool {
96 stream.stream_features
97 .get_child("starttls", NS_XMPP_TLS)
98 .is_some()
99 }
100
101 fn starttls<S: AsyncRead + AsyncWrite>(stream: xmpp_stream::XMPPStream<S>) -> StartTlsClient<S> {
102 StartTlsClient::from_stream(stream)
103 }
104
105 fn auth<S: AsyncRead + AsyncWrite>(stream: xmpp_stream::XMPPStream<S>, username: String, password: String) -> Result<ClientAuth<S>, Error> {
106 let creds = Credentials::default()
107 .with_username(username)
108 .with_password(password)
109 .with_channel_binding(ChannelBinding::None);
110 ClientAuth::new(stream, creds)
111 }
112
113 fn bind<S: AsyncWrite>(stream: xmpp_stream::XMPPStream<S>) -> ClientBind<S> {
114 ClientBind::new(stream)
115 }
116}
117
118impl Stream for Client {
119 type Item = Event;
120 type Error = Error;
121
122 fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
123 let state = replace(&mut self.state, ClientState::Invalid);
124
125 match state {
126 ClientState::Invalid =>
127 Err(Error::InvalidState),
128 ClientState::Disconnected =>
129 Ok(Async::Ready(None)),
130 ClientState::Connecting(mut connect) => {
131 match connect.poll() {
132 Ok(Async::Ready(stream)) => {
133 self.state = ClientState::Connected(stream);
134 Ok(Async::Ready(Some(Event::Online)))
135 },
136 Ok(Async::NotReady) => {
137 self.state = ClientState::Connecting(connect);
138 Ok(Async::NotReady)
139 },
140 Err(e) =>
141 Err(e),
142 }
143 },
144 ClientState::Connected(mut stream) => {
145 // Poll sink
146 match stream.poll_complete() {
147 Ok(Async::NotReady) => (),
148 Ok(Async::Ready(())) => (),
149 Err(e) =>
150 return Err(e)?,
151 };
152
153 // Poll stream
154 match stream.poll() {
155 Ok(Async::Ready(None)) => {
156 // EOF
157 self.state = ClientState::Disconnected;
158 Ok(Async::Ready(Some(Event::Disconnected)))
159 },
160 Ok(Async::Ready(Some(Packet::Stanza(stanza)))) => {
161 self.state = ClientState::Connected(stream);
162 Ok(Async::Ready(Some(Event::Stanza(stanza))))
163 },
164 Ok(Async::NotReady) |
165 Ok(Async::Ready(_)) => {
166 self.state = ClientState::Connected(stream);
167 Ok(Async::NotReady)
168 },
169 Err(e) =>
170 Err(e)?,
171 }
172 },
173 }
174 }
175}
176
177impl Sink for Client {
178 type SinkItem = Element;
179 type SinkError = Error;
180
181 fn start_send(&mut self, item: Self::SinkItem) -> StartSend<Self::SinkItem, Self::SinkError> {
182 match self.state {
183 ClientState::Connected(ref mut stream) =>
184 match stream.start_send(Packet::Stanza(item)) {
185 Ok(AsyncSink::NotReady(Packet::Stanza(stanza))) =>
186 Ok(AsyncSink::NotReady(stanza)),
187 Ok(AsyncSink::NotReady(_)) =>
188 panic!("Client.start_send with stanza but got something else back"),
189 Ok(AsyncSink::Ready) => {
190 Ok(AsyncSink::Ready)
191 },
192 Err(e) =>
193 Err(e)?,
194 },
195 _ =>
196 Ok(AsyncSink::NotReady(item)),
197 }
198 }
199
200 fn poll_complete(&mut self) -> Poll<(), Self::SinkError> {
201 match self.state {
202 ClientState::Connected(ref mut stream) =>
203 stream.poll_complete()
204 .map_err(|e| e.into()),
205 _ =>
206 Ok(Async::Ready(())),
207 }
208 }
209}