mod.rs

  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, Some("_xmpp-client._tcp"), 5222))
 65            )
 66            .flatten()
 67            .and_then(move |tcp_stream|
 68                      xmpp_stream::XMPPStream::start(tcp_stream, jid1, NS_JABBER_CLIENT.to_owned())
 69            ).and_then(|xmpp_stream| {
 70                if Self::can_starttls(&xmpp_stream) {
 71                    Ok(Self::starttls(xmpp_stream))
 72                } else {
 73                    Err(Error::Protocol(ProtocolError::NoTls))
 74                }
 75            }).flatten()
 76            .and_then(|tls_stream|
 77                       XMPPStream::start(tls_stream, jid2, NS_JABBER_CLIENT.to_owned())
 78            ).and_then(move |xmpp_stream|
 79                       done(Self::auth(xmpp_stream, username, password))
 80                       // TODO: flatten?
 81            ).and_then(|auth| auth)
 82            .and_then(|xmpp_stream| {
 83                Self::bind(xmpp_stream)
 84            }).and_then(|xmpp_stream| {
 85                // println!("Bound to {}", xmpp_stream.jid);
 86                Ok(xmpp_stream)
 87            })
 88    }
 89
 90    fn can_starttls<S>(stream: &xmpp_stream::XMPPStream<S>) -> bool {
 91        stream.stream_features
 92            .get_child("starttls", NS_XMPP_TLS)
 93            .is_some()
 94    }
 95
 96    fn starttls<S: AsyncRead + AsyncWrite>(stream: xmpp_stream::XMPPStream<S>) -> StartTlsClient<S> {
 97        StartTlsClient::from_stream(stream)
 98    }
 99
100    fn auth<S: AsyncRead + AsyncWrite>(stream: xmpp_stream::XMPPStream<S>, username: String, password: String) -> Result<ClientAuth<S>, Error> {
101        let creds = Credentials::default()
102            .with_username(username)
103            .with_password(password)
104            .with_channel_binding(ChannelBinding::None);
105        ClientAuth::new(stream, creds)
106    }
107
108    fn bind<S: AsyncWrite>(stream: xmpp_stream::XMPPStream<S>) -> ClientBind<S> {
109        ClientBind::new(stream)
110    }
111}
112
113impl Stream for Client {
114    type Item = Event;
115    type Error = Error;
116
117    fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
118        let state = replace(&mut self.state, ClientState::Invalid);
119
120        match state {
121            ClientState::Invalid =>
122                Err(Error::InvalidState),
123            ClientState::Disconnected =>
124                Ok(Async::Ready(None)),
125            ClientState::Connecting(mut connect) => {
126                match connect.poll() {
127                    Ok(Async::Ready(stream)) => {
128                        self.state = ClientState::Connected(stream);
129                        Ok(Async::Ready(Some(Event::Online)))
130                    },
131                    Ok(Async::NotReady) => {
132                        self.state = ClientState::Connecting(connect);
133                        Ok(Async::NotReady)
134                    },
135                    Err(e) =>
136                        Err(e),
137                }
138            },
139            ClientState::Connected(mut stream) => {
140                // Poll sink
141                match stream.poll_complete() {
142                    Ok(Async::NotReady) => (),
143                    Ok(Async::Ready(())) => (),
144                    Err(e) =>
145                        return Err(e)?,
146                };
147
148                // Poll stream
149                match stream.poll() {
150                    Ok(Async::Ready(None)) => {
151                        // EOF
152                        self.state = ClientState::Disconnected;
153                        Ok(Async::Ready(Some(Event::Disconnected)))
154                    },
155                    Ok(Async::Ready(Some(Packet::Stanza(stanza)))) => {
156                        self.state = ClientState::Connected(stream);
157                        Ok(Async::Ready(Some(Event::Stanza(stanza))))
158                    },
159                    Ok(Async::NotReady) |
160                    Ok(Async::Ready(_)) => {
161                        self.state = ClientState::Connected(stream);
162                        Ok(Async::NotReady)
163                    },
164                    Err(e) =>
165                        Err(e)?,
166                }
167            },
168        }
169    }
170}
171
172impl Sink for Client {
173    type SinkItem = Element;
174    type SinkError = Error;
175
176    fn start_send(&mut self, item: Self::SinkItem) -> StartSend<Self::SinkItem, Self::SinkError> {
177        match self.state {
178            ClientState::Connected(ref mut stream) =>
179                match stream.start_send(Packet::Stanza(item)) {
180                    Ok(AsyncSink::NotReady(Packet::Stanza(stanza))) =>
181                        Ok(AsyncSink::NotReady(stanza)),
182                    Ok(AsyncSink::NotReady(_)) =>
183                        panic!("Client.start_send with stanza but got something else back"),
184                    Ok(AsyncSink::Ready) => {
185                        Ok(AsyncSink::Ready)
186                    },
187                    Err(e) =>
188                        Err(e)?,
189                },
190            _ =>
191                Ok(AsyncSink::NotReady(item)),
192        }
193    }
194
195    fn poll_complete(&mut self) -> Poll<(), Self::SinkError> {
196        match self.state {
197            ClientState::Connected(ref mut stream) =>
198                stream.poll_complete()
199                .map_err(|e| e.into()),
200            _ =>
201                Ok(Async::Ready(())),
202        }
203    }
204}