From 92386fc48856888235cef586e49198620bb666ce Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Thu, 21 Mar 2019 18:41:29 +0100 Subject: [PATCH 01/13] Hello world! --- .gitignore | 3 + Cargo.toml | 11 ++ examples/hello_bot.rs | 74 +++++++++++ src/avatar.rs | 65 ++++++++++ src/lib.rs | 286 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 439 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 examples/hello_bot.rs create mode 100644 src/avatar.rs create mode 100644 src/lib.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..693699042b1a8ccf697636d3cd34b200f3a8278b --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/target +**/*.rs.bk +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000000000000000000000000000000000000..916a6d1d6ff6c5dfaa0e99cb34842c97a1737293 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,11 @@ +[package] +name = "xmpp" +version = "0.3.0" +authors = ["Emmanuel Gil Peyrot "] +edition = "2018" + +[dependencies] +tokio-xmpp = "1" +xmpp-parsers = "0.13" +futures = "0.1" +tokio = "0.1" diff --git a/examples/hello_bot.rs b/examples/hello_bot.rs new file mode 100644 index 0000000000000000000000000000000000000000..db5f412731123ad7bac78dba9c7cdb55eb457cd8 --- /dev/null +++ b/examples/hello_bot.rs @@ -0,0 +1,74 @@ +// Copyright (c) 2019 Emmanuel Gil Peyrot +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +use futures::{Future, Stream, sync::mpsc}; +use std::env::args; +use std::process::exit; +use std::str::FromStr; +use tokio::runtime::current_thread::Runtime; +use xmpp_parsers::{Jid, message::MessageType}; +use xmpp::{ClientBuilder, ClientType, ClientFeature, Event}; + +fn main() { + let args: Vec = args().collect(); + if args.len() != 5 { + println!("Usage: {} ", args[0]); + exit(1); + } + let jid = &args[1]; + let password = &args[2]; + let room_jid = &args[3]; + let nick: &str = &args[4]; + + // tokio_core context + let mut rt = Runtime::new().unwrap(); + + let (value_tx, value_rx) = mpsc::unbounded(); + + // Client instance + let (client, mut agent) = ClientBuilder::new(jid, password) + .set_client(ClientType::Bot, "xmpp-rs") + .set_website("https://gitlab.com/xmpp-rs/xmpp-rs") + .enable_feature(ClientFeature::Avatars) + .build(value_tx) + .unwrap(); + + let forwarder = value_rx.for_each(|evt: Event| { + match evt { + Event::Online => { + println!("Online."); + let room_jid = Jid::from_str(room_jid).unwrap().with_resource(nick); + agent.join_room(room_jid, "en", "Yet another bot!"); + }, + Event::Disconnected => { + println!("Disconnected."); + return Err(()); + }, + Event::RoomJoined(jid) => { + println!("Joined room {}.", jid); + agent.send_message(jid.into_bare_jid(), MessageType::Groupchat, "en", "Hello world!"); + }, + Event::AvatarRetrieved(jid, path) => { + println!("Received avatar for {} in {}.", jid, path); + }, + } + Ok(()) + }) + .map_err(|e| println!("{:?}", e)); + + // Start polling + match rt.block_on(client + .select2(forwarder) + .map(|_| ()) + .map_err(|_| ()) + ) { + Ok(_) => (), + Err(e) => { + println!("Fatal: {:?}", e); + () + } + } +} diff --git a/src/avatar.rs b/src/avatar.rs new file mode 100644 index 0000000000000000000000000000000000000000..9368bc8496f469b487868c3c048b1f201ed143d6 --- /dev/null +++ b/src/avatar.rs @@ -0,0 +1,65 @@ +// Copyright (c) 2019 Emmanuel Gil Peyrot +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +use futures::{Sink, sync::mpsc}; +use std::fs::{create_dir_all, File}; +use std::io::{self, Write}; +use tokio_xmpp::Packet; +use xmpp_parsers::{ + avatar::{Data, Metadata}, + iq::Iq, + ns, + pubsub::{ + event::Item, + pubsub::{Items, PubSub}, + NodeName, + }, + Jid, TryFrom, +}; +use crate::Event; + +pub(crate) fn handle_metadata_pubsub_event(from: &Jid, tx: &mut mpsc::UnboundedSender, items: Vec) { + for item in items { + let payload = item.payload.clone().unwrap(); + if payload.is("metadata", ns::AVATAR_METADATA) { + // TODO: do something with these metadata. + let _metadata = Metadata::try_from(payload).unwrap(); + let iq = download_avatar(from); + tx.start_send(Packet::Stanza(iq.into())).unwrap(); + } + } +} + +fn download_avatar(from: &Jid) -> Iq { + Iq::from_get("coucou", PubSub::Items(Items { + max_items: None, + node: NodeName(String::from(ns::AVATAR_DATA)), + subid: None, + items: Vec::new(), + })) + .with_to(from.clone()) +} + +pub(crate) fn handle_data_pubsub_iq(from: &Jid, tx: &mut mpsc::UnboundedSender, items: Items) { + for item in items.items { + if let Some(id) = item.id.clone() { + if let Some(payload) = &item.payload { + let data = Data::try_from(payload.clone()).unwrap(); + let filename = save_avatar(from, id.0, &data.data).unwrap(); + tx.unbounded_send(Event::AvatarRetrieved(from.clone(), filename)).unwrap(); + } + } + } +} + +fn save_avatar(from: &Jid, id: String, data: &[u8]) -> io::Result { + let directory = format!("data/{}", from); + let filename = format!("data/{}/{}", from, id); + create_dir_all(directory)?; + let mut file = File::create(&filename)?; + file.write_all(data)?; + Ok(filename) +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000000000000000000000000000000000000..56eda8a482e21bab9af055200233e5c2246ca0cb --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,286 @@ +// Copyright (c) 2019 Emmanuel Gil Peyrot +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +use std::str::FromStr; +use futures::{Future,Stream, Sink, sync::mpsc}; +use tokio_xmpp::{ + Client as TokioXmppClient, + Event as TokioXmppEvent, + Packet, +}; +use xmpp_parsers::{ + caps::{compute_disco, hash_caps, Caps}, + disco::{DiscoInfoQuery, DiscoInfoResult, Feature, Identity}, + hashes::Algo, + iq::{Iq, IqType}, + message::{Message, MessageType, Body}, + muc::{ + Muc, + user::{MucUser, Status}, + }, + ns, + presence::{Presence, Type as PresenceType}, + pubsub::{ + event::PubSubEvent, + pubsub::PubSub, + }, + stanza_error::{StanzaError, ErrorType, DefinedCondition}, + Jid, JidParseError, TryFrom, +}; + +mod avatar; + +#[derive(Debug)] +pub enum ClientType { + Bot, + Pc, +} + +impl Default for ClientType { + fn default() -> Self { + ClientType::Bot + } +} + +impl ToString for ClientType { + fn to_string(&self) -> String { + String::from( + match self { + ClientType::Bot => "bot", + ClientType::Pc => "pc", + } + ) + } +} + +#[derive(PartialEq)] +pub enum ClientFeature { + Avatars, +} + +pub enum Event { + Online, + Disconnected, + AvatarRetrieved(Jid, String), + RoomJoined(Jid), +} + +#[derive(Default)] +pub struct ClientBuilder<'a> { + jid: &'a str, + password: &'a str, + website: String, + disco: (ClientType, String), + features: Vec, +} + +impl ClientBuilder<'_> { + pub fn new<'a>(jid: &'a str, password: &'a str) -> ClientBuilder<'a> { + ClientBuilder { + jid, + password, + website: String::from("https://gitlab.com/xmpp-rs/tokio-xmpp"), + disco: (ClientType::default(), String::from("tokio-xmpp")), + features: vec![], + } + } + + pub fn set_client(mut self, type_: ClientType, name: &str) -> Self { + self.disco = (type_, String::from(name)); + self + } + + pub fn set_website(mut self, url: &str) -> Self { + self.website = String::from(url); + self + } + + pub fn enable_feature(mut self, feature: ClientFeature) -> Self { + self.features.push(feature); + self + } + + fn make_disco(&self) -> DiscoInfoResult { + let identities = vec![Identity::new("client", self.disco.0.to_string(), + "en", self.disco.1.to_string())]; + let mut features = vec![ + Feature::new(ns::DISCO_INFO), + ]; + if self.features.contains(&ClientFeature::Avatars) { + features.push(Feature::new(format!("{}+notify", ns::AVATAR_METADATA))); + } + DiscoInfoResult { + node: None, + identities, + features, + extensions: vec![], + } + } + + fn make_initial_presence(disco: &DiscoInfoResult, node: &str) -> Presence { + let caps_data = compute_disco(disco); + let hash = hash_caps(&caps_data, Algo::Sha_1).unwrap(); + let caps = Caps::new(node, hash); + + let mut presence = Presence::new(PresenceType::None); + presence.add_payload(caps); + presence + } + + pub fn build(self, mut app_tx: mpsc::UnboundedSender) -> Result<(Box>, Client), JidParseError> { + let disco = self.make_disco(); + let node = self.website; + let (sender_tx, sender_rx) = mpsc::unbounded(); + + let client = TokioXmppClient::new(self.jid, self.password)?; + let (sink, stream) = client.split(); + + let reader = { + let mut sender_tx = sender_tx.clone(); + let jid = self.jid.to_owned(); + stream.for_each(move |event| { + // Helper function to send an iq error. + let send_error = |to, id, type_, condition, text: &str| { + let error = StanzaError::new(type_, condition, "en", text); + let iq = Iq::from_error(id, error) + .with_to(to) + .into(); + sender_tx.unbounded_send(Packet::Stanza(iq)).unwrap(); + }; + + match event { + TokioXmppEvent::Online => { + let presence = ClientBuilder::make_initial_presence(&disco, &node).into(); + let packet = Packet::Stanza(presence); + sender_tx.unbounded_send(packet) + .unwrap(); + app_tx.unbounded_send(Event::Online).unwrap(); + } + TokioXmppEvent::Disconnected => { + app_tx.unbounded_send(Event::Disconnected).unwrap(); + } + TokioXmppEvent::Stanza(stanza) => { + if stanza.is("iq", "jabber:client") { + let iq = Iq::try_from(stanza).unwrap(); + if let IqType::Get(payload) = iq.payload { + if payload.is("query", ns::DISCO_INFO) { + let query = DiscoInfoQuery::try_from(payload); + match query { + Ok(query) => { + let mut disco_info = disco.clone(); + disco_info.node = query.node; + let iq = Iq::from_result(iq.id, Some(disco_info)) + .with_to(iq.from.unwrap()) + .into(); + sender_tx.unbounded_send(Packet::Stanza(iq)).unwrap(); + }, + Err(err) => { + send_error(iq.from.unwrap(), iq.id, ErrorType::Modify, DefinedCondition::BadRequest, &format!("{}", err)); + }, + } + } else { + // We MUST answer unhandled get iqs with a service-unavailable error. + send_error(iq.from.unwrap(), iq.id, ErrorType::Cancel, DefinedCondition::ServiceUnavailable, "No handler defined for this kind of iq."); + } + } else if let IqType::Result(Some(payload)) = iq.payload { + if payload.is("pubsub", ns::PUBSUB) { + let pubsub = PubSub::try_from(payload).unwrap(); + let from = + iq.from.clone().unwrap_or(Jid::from_str(&jid).unwrap()); + if let PubSub::Items(items) = pubsub { + if items.node.0 == ns::AVATAR_DATA { + avatar::handle_data_pubsub_iq(&from, &mut app_tx, items); + } + } + } + } else if let IqType::Set(_) = iq.payload { + // We MUST answer unhandled set iqs with a service-unavailable error. + send_error(iq.from.unwrap(), iq.id, ErrorType::Cancel, DefinedCondition::ServiceUnavailable, "No handler defined for this kind of iq."); + } + } else if stanza.is("message", "jabber:client") { + let message = Message::try_from(stanza).unwrap(); + let from = message.from.clone().unwrap(); + for child in message.payloads { + if child.is("event", ns::PUBSUB_EVENT) { + let event = PubSubEvent::try_from(child).unwrap(); + if let PubSubEvent::PublishedItems { node, items } = event { + if node.0 == ns::AVATAR_METADATA { + avatar::handle_metadata_pubsub_event(&from, &mut sender_tx, items); + } + } + } + } + } else if stanza.is("presence", "jabber:client") { + let presence = Presence::try_from(stanza).unwrap(); + let from = presence.from.clone().unwrap(); + for payload in presence.payloads.into_iter() { + let muc_user = match MucUser::try_from(payload) { + Ok(muc_user) => muc_user, + _ => continue + }; + for status in muc_user.status.into_iter() { + if status == Status::SelfPresence { + app_tx.unbounded_send(Event::RoomJoined(from.clone())).unwrap(); + break; + } + } + } + } else if stanza.is("error", "http://etherx.jabber.org/streams") { + println!("Received a fatal stream error: {}", String::from(&stanza)); + } else { + panic!("Unknown stanza: {}", String::from(&stanza)); + } + } + } + + Ok(()) + }) + }; + + let sender = sender_rx + .map_err(|e| panic!("Sink error: {:?}", e)) + .forward(sink) + .map(|(rx, mut sink)| { + drop(rx); + let _ = sink.close(); + }); + + let future = reader.select(sender) + .map(|_| ()) + .map_err(|_| ()); + + let agent = Client { + sender_tx, + }; + + Ok((Box::new(future), agent)) + } +} + +pub struct Client { + sender_tx: mpsc::UnboundedSender, +} + +impl Client { + pub fn join_room(&mut self, room: Jid, lang: &str, status: &str) { + let mut presence = Presence::new(PresenceType::None) + .with_to(Some(room)) + .with_payloads(vec![Muc::new().into()]); + presence.set_status(String::from(lang), String::from(status)); + let presence = presence.into(); + self.sender_tx.unbounded_send(Packet::Stanza(presence)) + .unwrap(); + } + + pub fn send_message(&mut self, recipient: Jid, type_: MessageType, lang: &str, text: &str) { + let mut message = Message::new(Some(recipient)); + message.type_ = type_; + message.bodies.insert(String::from(lang), Body(String::from(text))); + let message = message.into(); + self.sender_tx.unbounded_send(Packet::Stanza(message)) + .unwrap(); + } +} From 08af035eb1ab012c73bc56d2aeb911524b2b4a84 Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Sat, 1 Jun 2019 17:56:46 +0200 Subject: [PATCH 02/13] Add contact list support --- examples/hello_bot.rs | 10 ++++++++++ src/lib.rs | 15 ++++++++++++++- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/examples/hello_bot.rs b/examples/hello_bot.rs index db5f412731123ad7bac78dba9c7cdb55eb457cd8..e21e1490f88c7c3350dfc5d8fdd2e47a39daa5e0 100644 --- a/examples/hello_bot.rs +++ b/examples/hello_bot.rs @@ -33,6 +33,7 @@ fn main() { .set_client(ClientType::Bot, "xmpp-rs") .set_website("https://gitlab.com/xmpp-rs/xmpp-rs") .enable_feature(ClientFeature::Avatars) + .enable_feature(ClientFeature::ContactList) .build(value_tx) .unwrap(); @@ -47,6 +48,15 @@ fn main() { println!("Disconnected."); return Err(()); }, + Event::ContactAdded(contact) => { + println!("Contact {:?} added.", contact); + }, + Event::ContactRemoved(contact) => { + println!("Contact {:?} removed.", contact); + }, + Event::ContactChanged(contact) => { + println!("Contact {:?} changed.", contact); + }, Event::RoomJoined(jid) => { println!("Joined room {}.", jid); agent.send_message(jid.into_bare_jid(), MessageType::Groupchat, "en", "Hello world!"); diff --git a/src/lib.rs b/src/lib.rs index 56eda8a482e21bab9af055200233e5c2246ca0cb..aca578f613c3cfb908fe9c607d14dfad95afad64 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -27,6 +27,7 @@ use xmpp_parsers::{ event::PubSubEvent, pubsub::PubSub, }, + roster::{Roster, Item as RosterItem}, stanza_error::{StanzaError, ErrorType, DefinedCondition}, Jid, JidParseError, TryFrom, }; @@ -59,11 +60,15 @@ impl ToString for ClientType { #[derive(PartialEq)] pub enum ClientFeature { Avatars, + ContactList, } pub enum Event { Online, Disconnected, + ContactAdded(RosterItem), + ContactRemoved(RosterItem), + ContactChanged(RosterItem), AvatarRetrieved(Jid, String), RoomJoined(Jid), } @@ -158,6 +163,9 @@ impl ClientBuilder<'_> { sender_tx.unbounded_send(packet) .unwrap(); app_tx.unbounded_send(Event::Online).unwrap(); + let iq = Iq::from_get("roster", Roster { ver: None, items: vec![] }) + .into(); + sender_tx.unbounded_send(Packet::Stanza(iq)).unwrap(); } TokioXmppEvent::Disconnected => { app_tx.unbounded_send(Event::Disconnected).unwrap(); @@ -186,7 +194,12 @@ impl ClientBuilder<'_> { send_error(iq.from.unwrap(), iq.id, ErrorType::Cancel, DefinedCondition::ServiceUnavailable, "No handler defined for this kind of iq."); } } else if let IqType::Result(Some(payload)) = iq.payload { - if payload.is("pubsub", ns::PUBSUB) { + if payload.is("query", ns::ROSTER) { + let roster = Roster::try_from(payload).unwrap(); + for item in roster.items.into_iter() { + app_tx.unbounded_send(Event::ContactAdded(item)).unwrap(); + } + } else if payload.is("pubsub", ns::PUBSUB) { let pubsub = PubSub::try_from(payload).unwrap(); let from = iq.from.clone().unwrap_or(Jid::from_str(&jid).unwrap()); From 3f056813edb806a30bab2320cbb6336600d50c9d Mon Sep 17 00:00:00 2001 From: Marcin Mielniczuk Date: Fri, 5 Jul 2019 18:59:05 +0200 Subject: [PATCH 03/13] Simplify the API by removing explicit channels. --- examples/hello_bot.rs | 32 ++++++++----------- src/avatar.rs | 28 +++++++++++------ src/lib.rs | 72 +++++++++++++++++++++++++++++++++---------- 3 files changed, 86 insertions(+), 46 deletions(-) diff --git a/examples/hello_bot.rs b/examples/hello_bot.rs index e21e1490f88c7c3350dfc5d8fdd2e47a39daa5e0..2d8aae6d6bbe5869c0e3ea6b4da128df37618ed7 100644 --- a/examples/hello_bot.rs +++ b/examples/hello_bot.rs @@ -4,7 +4,7 @@ // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. -use futures::{Future, Stream, sync::mpsc}; +use futures::prelude::*; use std::env::args; use std::process::exit; use std::str::FromStr; @@ -26,18 +26,19 @@ fn main() { // tokio_core context let mut rt = Runtime::new().unwrap(); - let (value_tx, value_rx) = mpsc::unbounded(); // Client instance - let (client, mut agent) = ClientBuilder::new(jid, password) + let (mut agent, stream) = ClientBuilder::new(jid, password) .set_client(ClientType::Bot, "xmpp-rs") .set_website("https://gitlab.com/xmpp-rs/xmpp-rs") .enable_feature(ClientFeature::Avatars) .enable_feature(ClientFeature::ContactList) - .build(value_tx) + .build() .unwrap(); - let forwarder = value_rx.for_each(|evt: Event| { + // We return either Some(Error) if an error was encountered + // or None, if we were simply disconnected + let handler = stream.map_err(Some).for_each(|evt: Event| { match evt { Event::Online => { println!("Online."); @@ -46,7 +47,7 @@ fn main() { }, Event::Disconnected => { println!("Disconnected."); - return Err(()); + return Err(None); }, Event::ContactAdded(contact) => { println!("Contact {:?} added.", contact); @@ -66,19 +67,10 @@ fn main() { }, } Ok(()) - }) - .map_err(|e| println!("{:?}", e)); + }); - // Start polling - match rt.block_on(client - .select2(forwarder) - .map(|_| ()) - .map_err(|_| ()) - ) { - Ok(_) => (), - Err(e) => { - println!("Fatal: {:?}", e); - () - } - } + rt.block_on(handler).unwrap_or_else(|e| match e { + Some(e) => println!("Error: {:?}", e), + None => println!("Disconnected."), + }); } diff --git a/src/avatar.rs b/src/avatar.rs index 9368bc8496f469b487868c3c048b1f201ed143d6..b0e1f444b0cda5bc569e8fb5bc0b916493909e5e 100644 --- a/src/avatar.rs +++ b/src/avatar.rs @@ -4,7 +4,8 @@ // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. -use futures::{Sink, sync::mpsc}; +use crate::Event; +use futures::{sync::mpsc, Sink}; use std::fs::{create_dir_all, File}; use std::io::{self, Write}; use tokio_xmpp::Packet; @@ -19,7 +20,6 @@ use xmpp_parsers::{ }, Jid, TryFrom, }; -use crate::Event; pub(crate) fn handle_metadata_pubsub_event(from: &Jid, tx: &mut mpsc::UnboundedSender, items: Vec) { for item in items { @@ -43,16 +43,24 @@ fn download_avatar(from: &Jid) -> Iq { .with_to(from.clone()) } -pub(crate) fn handle_data_pubsub_iq(from: &Jid, tx: &mut mpsc::UnboundedSender, items: Items) { - for item in items.items { - if let Some(id) = item.id.clone() { - if let Some(payload) = &item.payload { +// The return value of this function will be simply pushed to a Vec in the caller function, +// so it makes no sense to allocate a Vec here - we're lazy instead +pub(crate) fn handle_data_pubsub_iq<'a>( + from: &'a Jid, + items: &'a Items, +) -> impl IntoIterator + 'a { + let from = from.clone(); + items + .items + .iter() + .filter_map(move |item| match (&item.id, &item.payload) { + (Some(id), Some(payload)) => { let data = Data::try_from(payload.clone()).unwrap(); - let filename = save_avatar(from, id.0, &data.data).unwrap(); - tx.unbounded_send(Event::AvatarRetrieved(from.clone(), filename)).unwrap(); + let filename = save_avatar(&from, id.0.clone(), &data.data).unwrap(); + Some(Event::AvatarRetrieved(from.clone(), filename)) } - } - } + _ => None, + }) } fn save_avatar(from: &Jid, id: String, data: &[u8]) -> io::Result { diff --git a/src/lib.rs b/src/lib.rs index aca578f613c3cfb908fe9c607d14dfad95afad64..0f0afe857359649593105fcac007413a0aa6d40c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -34,6 +34,8 @@ use xmpp_parsers::{ mod avatar; +pub type Error = tokio_xmpp::Error; + #[derive(Debug)] pub enum ClientType { Bot, @@ -135,19 +137,35 @@ impl ClientBuilder<'_> { presence } - pub fn build(self, mut app_tx: mpsc::UnboundedSender) -> Result<(Box>, Client), JidParseError> { + pub fn build( + self, + ) -> Result<(Agent, impl Stream), JidParseError> { + let client = TokioXmppClient::new(self.jid, self.password)?; + Ok(self.build_impl(client)) + } + + // This function is meant to be used for testing build + pub(crate) fn build_impl( + self, + stream: S, + ) -> (Agent, impl Stream) + where + S: Stream + + Sink, + { let disco = self.make_disco(); let node = self.website; let (sender_tx, sender_rx) = mpsc::unbounded(); - let client = TokioXmppClient::new(self.jid, self.password)?; + let client = stream; let (sink, stream) = client.split(); let reader = { let mut sender_tx = sender_tx.clone(); let jid = self.jid.to_owned(); - stream.for_each(move |event| { + stream.map(move |event| { // Helper function to send an iq error. + let mut events = Vec::new(); let send_error = |to, id, type_, condition, text: &str| { let error = StanzaError::new(type_, condition, "en", text); let iq = Iq::from_error(id, error) @@ -162,13 +180,13 @@ impl ClientBuilder<'_> { let packet = Packet::Stanza(presence); sender_tx.unbounded_send(packet) .unwrap(); - app_tx.unbounded_send(Event::Online).unwrap(); + events.push(Event::Online); let iq = Iq::from_get("roster", Roster { ver: None, items: vec![] }) .into(); sender_tx.unbounded_send(Packet::Stanza(iq)).unwrap(); } TokioXmppEvent::Disconnected => { - app_tx.unbounded_send(Event::Disconnected).unwrap(); + events.push(Event::Disconnected); } TokioXmppEvent::Stanza(stanza) => { if stanza.is("iq", "jabber:client") { @@ -197,7 +215,7 @@ impl ClientBuilder<'_> { if payload.is("query", ns::ROSTER) { let roster = Roster::try_from(payload).unwrap(); for item in roster.items.into_iter() { - app_tx.unbounded_send(Event::ContactAdded(item)).unwrap(); + events.push(Event::ContactAdded(item)); } } else if payload.is("pubsub", ns::PUBSUB) { let pubsub = PubSub::try_from(payload).unwrap(); @@ -205,7 +223,8 @@ impl ClientBuilder<'_> { iq.from.clone().unwrap_or(Jid::from_str(&jid).unwrap()); if let PubSub::Items(items) = pubsub { if items.node.0 == ns::AVATAR_DATA { - avatar::handle_data_pubsub_iq(&from, &mut app_tx, items); + let new_events = avatar::handle_data_pubsub_iq(&from, &items); + events.extend(new_events); } } } @@ -236,7 +255,7 @@ impl ClientBuilder<'_> { }; for status in muc_user.status.into_iter() { if status == Status::SelfPresence { - app_tx.unbounded_send(Event::RoomJoined(from.clone())).unwrap(); + events.push(Event::RoomJoined(from.clone())); break; } } @@ -249,8 +268,9 @@ impl ClientBuilder<'_> { } } - Ok(()) + futures::stream::iter_ok(events) }) + .flatten() }; let sender = sender_rx @@ -259,25 +279,45 @@ impl ClientBuilder<'_> { .map(|(rx, mut sink)| { drop(rx); let _ = sink.close(); + None }); - let future = reader.select(sender) - .map(|_| ()) - .map_err(|_| ()); + // TODO is this correct? + // Some(Error) means a real error + // None means the end of the sender stream and can be ignored + let future = reader + .map(Some) + .select(sender.into_stream()) + .filter_map(|x| x); - let agent = Client { - sender_tx, - }; + let agent = Agent { sender_tx }; - Ok((Box::new(future), agent)) + (agent, future) } } pub struct Client { sender_tx: mpsc::UnboundedSender, + stream: Box>, } impl Client { + pub fn get_agent(&self) -> Agent { + Agent { + sender_tx: self.sender_tx.clone(), + } + } + + pub fn listen(self) -> Box> { + self.stream + } +} + +pub struct Agent { + sender_tx: mpsc::UnboundedSender, +} + +impl Agent { pub fn join_room(&mut self, room: Jid, lang: &str, status: &str) { let mut presence = Presence::new(PresenceType::None) .with_to(Some(room)) From c69140b05eb7036ad099fbe6d316d256d3334883 Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Thu, 25 Jul 2019 15:03:22 +0200 Subject: [PATCH 04/13] Add missing dyn on Future trait object, and deny that. --- src/lib.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 0f0afe857359649593105fcac007413a0aa6d40c..851783187836b9f521629beb86e35590885ee68d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -4,6 +4,8 @@ // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. +#![deny(bare_trait_objects)] + use std::str::FromStr; use futures::{Future,Stream, Sink, sync::mpsc}; use tokio_xmpp::{ @@ -298,7 +300,7 @@ impl ClientBuilder<'_> { pub struct Client { sender_tx: mpsc::UnboundedSender, - stream: Box>, + stream: Box>, } impl Client { @@ -308,7 +310,7 @@ impl Client { } } - pub fn listen(self) -> Box> { + pub fn listen(self) -> Box> { self.stream } } From 88041550b993305e29f341402ec141719c475c80 Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Fri, 14 Jun 2019 00:41:21 +0200 Subject: [PATCH 05/13] Check that the received roster is from our own account. --- src/lib.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 851783187836b9f521629beb86e35590885ee68d..8a4454b0780a039b2f742bce79dd947008b74c90 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -183,6 +183,7 @@ impl ClientBuilder<'_> { sender_tx.unbounded_send(packet) .unwrap(); events.push(Event::Online); + // TODO: only send this when the ContactList feature is enabled. let iq = Iq::from_get("roster", Roster { ver: None, items: vec![] }) .into(); sender_tx.unbounded_send(Packet::Stanza(iq)).unwrap(); @@ -214,7 +215,9 @@ impl ClientBuilder<'_> { send_error(iq.from.unwrap(), iq.id, ErrorType::Cancel, DefinedCondition::ServiceUnavailable, "No handler defined for this kind of iq."); } } else if let IqType::Result(Some(payload)) = iq.payload { - if payload.is("query", ns::ROSTER) { + // TODO: move private iqs like this one somewhere else, for + // security reasons. + if payload.is("query", ns::ROSTER) && iq.from.is_none() { let roster = Roster::try_from(payload).unwrap(); for item in roster.items.into_iter() { events.push(Event::ContactAdded(item)); From 68b389277ef79e222c74c0322413df225c50f85e Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Thu, 25 Jul 2019 15:36:45 +0200 Subject: [PATCH 06/13] Add the missing license file. --- Cargo.toml | 1 + LICENSE | 373 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 374 insertions(+) create mode 100644 LICENSE diff --git a/Cargo.toml b/Cargo.toml index 916a6d1d6ff6c5dfaa0e99cb34842c97a1737293..e5189705edff3528aa20ccdf798b1904cc8dafbe 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,7 @@ name = "xmpp" version = "0.3.0" authors = ["Emmanuel Gil Peyrot "] +license = "MPL-2.0" edition = "2018" [dependencies] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..14e2f777f6c395e7e04ab4aa306bbcc4b0c1120e --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. From 9df465d940af23f407b6c72777131bfe76bc0b73 Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Thu, 25 Jul 2019 15:37:00 +0200 Subject: [PATCH 07/13] Add various metadata to Cargo.toml. --- Cargo.toml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index e5189705edff3528aa20ccdf798b1904cc8dafbe..e769b6559a0b7e3595425db084b92db1182999e4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,11 @@ name = "xmpp" version = "0.3.0" authors = ["Emmanuel Gil Peyrot "] +description = "High-level XMPP library" +homepage = "https://gitlab.com/linkmauve/xmpp-rs" +repository = "https://gitlab.com/linkmauve/xmpp-rs" +keywords = ["xmpp", "jabber", "chat", "messaging", "bot"] +categories = ["network-programming"] license = "MPL-2.0" edition = "2018" From 8e0bcaed145146ead7be97460d3d780dd8785534 Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Thu, 25 Jul 2019 15:11:39 +0200 Subject: [PATCH 08/13] Autojoin MUCs from bookmarks. When the JoinRooms ClientFeature is enabled, we want to automatically receive bookmarks and join them when they are added. --- examples/hello_bot.rs | 27 ++++++++------- src/lib.rs | 78 +++++++++++++++++++++++++++++++------------ 2 files changed, 71 insertions(+), 34 deletions(-) diff --git a/examples/hello_bot.rs b/examples/hello_bot.rs index 2d8aae6d6bbe5869c0e3ea6b4da128df37618ed7..e374bf681de29552f1f7198efb0eee7b5f39553c 100644 --- a/examples/hello_bot.rs +++ b/examples/hello_bot.rs @@ -7,32 +7,30 @@ use futures::prelude::*; use std::env::args; use std::process::exit; -use std::str::FromStr; use tokio::runtime::current_thread::Runtime; -use xmpp_parsers::{Jid, message::MessageType}; +use xmpp_parsers::message::MessageType; use xmpp::{ClientBuilder, ClientType, ClientFeature, Event}; fn main() { let args: Vec = args().collect(); - if args.len() != 5 { - println!("Usage: {} ", args[0]); + if args.len() != 3 { + println!("Usage: {} ", args[0]); exit(1); } let jid = &args[1]; let password = &args[2]; - let room_jid = &args[3]; - let nick: &str = &args[4]; // tokio_core context let mut rt = Runtime::new().unwrap(); - // Client instance let (mut agent, stream) = ClientBuilder::new(jid, password) .set_client(ClientType::Bot, "xmpp-rs") .set_website("https://gitlab.com/xmpp-rs/xmpp-rs") + .set_default_nick("bot") .enable_feature(ClientFeature::Avatars) .enable_feature(ClientFeature::ContactList) + .enable_feature(ClientFeature::JoinRooms) .build() .unwrap(); @@ -42,26 +40,31 @@ fn main() { match evt { Event::Online => { println!("Online."); - let room_jid = Jid::from_str(room_jid).unwrap().with_resource(nick); - agent.join_room(room_jid, "en", "Yet another bot!"); }, Event::Disconnected => { println!("Disconnected."); return Err(None); }, Event::ContactAdded(contact) => { - println!("Contact {:?} added.", contact); + println!("Contact {} added.", contact.jid); }, Event::ContactRemoved(contact) => { - println!("Contact {:?} removed.", contact); + println!("Contact {} removed.", contact.jid); }, Event::ContactChanged(contact) => { - println!("Contact {:?} changed.", contact); + println!("Contact {} changed.", contact.jid); + }, + Event::OpenRoomBookmark(bookmark) => { + println!("Joining room “{}” ({})…", bookmark.name, bookmark.jid); + agent.join_room(bookmark.jid, bookmark.nick, bookmark.password, "en", "Yet another bot!"); }, Event::RoomJoined(jid) => { println!("Joined room {}.", jid); agent.send_message(jid.into_bare_jid(), MessageType::Groupchat, "en", "Hello world!"); }, + Event::RoomLeft(jid) => { + println!("Left room {}.", jid); + }, Event::AvatarRetrieved(jid, path) => { println!("Received avatar for {} in {}.", jid, path); }, diff --git a/src/lib.rs b/src/lib.rs index 8a4454b0780a039b2f742bce79dd947008b74c90..93089b674bc061310790ae9903b953986a14dfc9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -7,6 +7,8 @@ #![deny(bare_trait_objects)] use std::str::FromStr; +use std::rc::Rc; +use std::cell::RefCell; use futures::{Future,Stream, Sink, sync::mpsc}; use tokio_xmpp::{ Client as TokioXmppClient, @@ -14,6 +16,11 @@ use tokio_xmpp::{ Packet, }; use xmpp_parsers::{ + bookmarks::{ + Autojoin, + Conference as ConferenceBookmark, + Storage as Bookmarks, + }, caps::{compute_disco, hash_caps, Caps}, disco::{DiscoInfoQuery, DiscoInfoResult, Feature, Identity}, hashes::Algo, @@ -65,8 +72,10 @@ impl ToString for ClientType { pub enum ClientFeature { Avatars, ContactList, + JoinRooms, } +#[derive(Debug)] pub enum Event { Online, Disconnected, @@ -74,7 +83,9 @@ pub enum Event { ContactRemoved(RosterItem), ContactChanged(RosterItem), AvatarRetrieved(Jid, String), + OpenRoomBookmark(ConferenceBookmark), RoomJoined(Jid), + RoomLeft(Jid), } #[derive(Default)] @@ -82,6 +93,7 @@ pub struct ClientBuilder<'a> { jid: &'a str, password: &'a str, website: String, + default_nick: String, disco: (ClientType, String), features: Vec, } @@ -92,6 +104,7 @@ impl ClientBuilder<'_> { jid, password, website: String::from("https://gitlab.com/xmpp-rs/tokio-xmpp"), + default_nick: String::from("xmpp-rs"), disco: (ClientType::default(), String::from("tokio-xmpp")), features: vec![], } @@ -107,6 +120,11 @@ impl ClientBuilder<'_> { self } + pub fn set_default_nick(mut self, nick: &str) -> Self { + self.default_nick = String::from(nick); + self + } + pub fn enable_feature(mut self, feature: ClientFeature) -> Self { self.features.push(feature); self @@ -121,6 +139,9 @@ impl ClientBuilder<'_> { if self.features.contains(&ClientFeature::Avatars) { features.push(Feature::new(format!("{}+notify", ns::AVATAR_METADATA))); } + if self.features.contains(&ClientFeature::JoinRooms) { + features.push(Feature::new(format!("{}+notify", ns::BOOKMARKS))); + } DiscoInfoResult { node: None, identities, @@ -225,7 +246,7 @@ impl ClientBuilder<'_> { } else if payload.is("pubsub", ns::PUBSUB) { let pubsub = PubSub::try_from(payload).unwrap(); let from = - iq.from.clone().unwrap_or(Jid::from_str(&jid).unwrap()); + iq.from.clone().unwrap_or_else(|| Jid::from_str(&jid).unwrap()); if let PubSub::Items(items) = pubsub { if items.node.0 == ns::AVATAR_DATA { let new_events = avatar::handle_data_pubsub_iq(&from, &items); @@ -246,6 +267,21 @@ impl ClientBuilder<'_> { if let PubSubEvent::PublishedItems { node, items } = event { if node.0 == ns::AVATAR_METADATA { avatar::handle_metadata_pubsub_event(&from, &mut sender_tx, items); + } else if node.0 == ns::BOOKMARKS { + // TODO: Check that our bare JID is the sender. + assert_eq!(items.len(), 1); + let item = items.clone().pop().unwrap(); + let payload = item.payload.clone().unwrap(); + let bookmarks = match Bookmarks::try_from(payload) { + Ok(bookmarks) => bookmarks, + // XXX: Don’t panic… + Err(err) => panic!("… {}", err), + }; + for bookmark in bookmarks.conferences { + if bookmark.autojoin == Autojoin::True { + events.push(Event::OpenRoomBookmark(bookmark)); + } + } } } } @@ -295,38 +331,36 @@ impl ClientBuilder<'_> { .select(sender.into_stream()) .filter_map(|x| x); - let agent = Agent { sender_tx }; + let agent = Agent { + sender_tx, + default_nick: Rc::new(RefCell::new(self.default_nick)), + }; (agent, future) } } -pub struct Client { - sender_tx: mpsc::UnboundedSender, - stream: Box>, -} - -impl Client { - pub fn get_agent(&self) -> Agent { - Agent { - sender_tx: self.sender_tx.clone(), - } - } - - pub fn listen(self) -> Box> { - self.stream - } -} - pub struct Agent { sender_tx: mpsc::UnboundedSender, + default_nick: Rc>, } impl Agent { - pub fn join_room(&mut self, room: Jid, lang: &str, status: &str) { + pub fn join_room(&mut self, room: Jid, nick: Option, password: Option, + lang: &str, status: &str) { + let mut muc = Muc::new(); + if let Some(password) = password { + muc = muc.with_password(password); + } + // TODO: change room into a BareJid, which requires an update of jid, which requires an + // update of xmpp-parsers, which requires an update of tokio-xmpp… + assert_eq!(room.resource, None); + + let nick = nick.unwrap_or_else(|| self.default_nick.borrow().clone()); + let room_jid = room.with_resource(nick); let mut presence = Presence::new(PresenceType::None) - .with_to(Some(room)) - .with_payloads(vec![Muc::new().into()]); + .with_to(Some(room_jid)); + presence.add_payload(muc); presence.set_status(String::from(lang), String::from(status)); let presence = presence.into(); self.sender_tx.unbounded_send(Packet::Stanza(presence)) From d989974f692051e14800dd3bca1930ba7b49080b Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Thu, 25 Jul 2019 17:42:30 +0200 Subject: [PATCH 09/13] =?UTF-8?q?Don=E2=80=99t=20download=20avatars=20agai?= =?UTF-8?q?n=20if=20they=20are=20already=20present=20on=20the=20fs.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/avatar.rs | 34 +++++++++++++++++++++++++++------- src/lib.rs | 3 ++- 2 files changed, 29 insertions(+), 8 deletions(-) diff --git a/src/avatar.rs b/src/avatar.rs index b0e1f444b0cda5bc569e8fb5bc0b916493909e5e..56aac06a39d157b644a2b1d906467c12bd0f41bd 100644 --- a/src/avatar.rs +++ b/src/avatar.rs @@ -6,7 +6,7 @@ use crate::Event; use futures::{sync::mpsc, Sink}; -use std::fs::{create_dir_all, File}; +use std::fs::{self, File}; use std::io::{self, Write}; use tokio_xmpp::Packet; use xmpp_parsers::{ @@ -18,19 +18,39 @@ use xmpp_parsers::{ pubsub::{Items, PubSub}, NodeName, }, + hashes::Hash, Jid, TryFrom, }; -pub(crate) fn handle_metadata_pubsub_event(from: &Jid, tx: &mut mpsc::UnboundedSender, items: Vec) { +// TODO: Update xmpp-parsers to get this function for free on Hash. +fn hash_to_hex(hash: &Hash) -> String { + let mut bytes = vec![]; + for byte in hash.hash.iter() { + bytes.push(format!("{:02x}", byte)); + } + bytes.join("") +} + +pub(crate) fn handle_metadata_pubsub_event(from: &Jid, tx: &mut mpsc::UnboundedSender, items: Vec) -> impl IntoIterator { + let mut events = Vec::new(); for item in items { let payload = item.payload.clone().unwrap(); if payload.is("metadata", ns::AVATAR_METADATA) { - // TODO: do something with these metadata. - let _metadata = Metadata::try_from(payload).unwrap(); - let iq = download_avatar(from); - tx.start_send(Packet::Stanza(iq.into())).unwrap(); + let metadata = Metadata::try_from(payload).unwrap(); + for info in metadata.infos { + let filename = format!("data/{}/{}", from, hash_to_hex(&*info.id)); + let metadata = fs::metadata(filename.clone()).unwrap(); + // TODO: Also check the hash. + if info.bytes as u64 == metadata.len() { + events.push(Event::AvatarRetrieved(from.clone(), filename)); + } else { + let iq = download_avatar(from); + tx.start_send(Packet::Stanza(iq.into())).unwrap(); + } + } } } + events } fn download_avatar(from: &Jid) -> Iq { @@ -66,7 +86,7 @@ pub(crate) fn handle_data_pubsub_iq<'a>( fn save_avatar(from: &Jid, id: String, data: &[u8]) -> io::Result { let directory = format!("data/{}", from); let filename = format!("data/{}/{}", from, id); - create_dir_all(directory)?; + fs::create_dir_all(directory)?; let mut file = File::create(&filename)?; file.write_all(data)?; Ok(filename) diff --git a/src/lib.rs b/src/lib.rs index 93089b674bc061310790ae9903b953986a14dfc9..20fd1efd120a6cfa4c67d91a31f29b77c46f192c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -266,7 +266,8 @@ impl ClientBuilder<'_> { let event = PubSubEvent::try_from(child).unwrap(); if let PubSubEvent::PublishedItems { node, items } = event { if node.0 == ns::AVATAR_METADATA { - avatar::handle_metadata_pubsub_event(&from, &mut sender_tx, items); + let new_events = avatar::handle_metadata_pubsub_event(&from, &mut sender_tx, items); + events.extend(new_events); } else if node.0 == ns::BOOKMARKS { // TODO: Check that our bare JID is the sender. assert_eq!(items.len(), 1); From b6369741cdf14655310fd98cd59a977fa0f1fccd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Wed, 11 Sep 2019 16:11:32 +0200 Subject: [PATCH 10/13] Update tokio-xmpp to 1.0.1 and xmpp-parsers to 0.15 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maxime “pep” Buquet --- Cargo.toml | 4 ++-- examples/hello_bot.rs | 4 ++-- src/avatar.rs | 3 ++- src/lib.rs | 19 ++++++++++--------- 4 files changed, 16 insertions(+), 14 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index e769b6559a0b7e3595425db084b92db1182999e4..a9def97c99fa7cf963c671cbac104bd1ead19bfe 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,7 @@ license = "MPL-2.0" edition = "2018" [dependencies] -tokio-xmpp = "1" -xmpp-parsers = "0.13" +tokio-xmpp = "1.0.1" +xmpp-parsers = "0.15" futures = "0.1" tokio = "0.1" diff --git a/examples/hello_bot.rs b/examples/hello_bot.rs index e374bf681de29552f1f7198efb0eee7b5f39553c..dcfd060d573eabd7ca3595acc67ffe0de32da088 100644 --- a/examples/hello_bot.rs +++ b/examples/hello_bot.rs @@ -8,7 +8,7 @@ use futures::prelude::*; use std::env::args; use std::process::exit; use tokio::runtime::current_thread::Runtime; -use xmpp_parsers::message::MessageType; +use xmpp_parsers::{message::MessageType, Jid}; use xmpp::{ClientBuilder, ClientType, ClientFeature, Event}; fn main() { @@ -60,7 +60,7 @@ fn main() { }, Event::RoomJoined(jid) => { println!("Joined room {}.", jid); - agent.send_message(jid.into_bare_jid(), MessageType::Groupchat, "en", "Hello world!"); + agent.send_message(Jid::Bare(jid), MessageType::Groupchat, "en", "Hello world!"); }, Event::RoomLeft(jid) => { println!("Left room {}.", jid); diff --git a/src/avatar.rs b/src/avatar.rs index 56aac06a39d157b644a2b1d906467c12bd0f41bd..4c6e588c06429f686f4b6644b814d1797d7ae7a3 100644 --- a/src/avatar.rs +++ b/src/avatar.rs @@ -6,6 +6,7 @@ use crate::Event; use futures::{sync::mpsc, Sink}; +use std::convert::TryFrom; use std::fs::{self, File}; use std::io::{self, Write}; use tokio_xmpp::Packet; @@ -19,7 +20,7 @@ use xmpp_parsers::{ NodeName, }, hashes::Hash, - Jid, TryFrom, + Jid, }; // TODO: Update xmpp-parsers to get this function for free on Hash. diff --git a/src/lib.rs b/src/lib.rs index 20fd1efd120a6cfa4c67d91a31f29b77c46f192c..a5b6e33757ac502adb62c4fef2381efb7eac3471 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -9,6 +9,7 @@ use std::str::FromStr; use std::rc::Rc; use std::cell::RefCell; +use std::convert::TryFrom; use futures::{Future,Stream, Sink, sync::mpsc}; use tokio_xmpp::{ Client as TokioXmppClient, @@ -38,7 +39,7 @@ use xmpp_parsers::{ }, roster::{Roster, Item as RosterItem}, stanza_error::{StanzaError, ErrorType, DefinedCondition}, - Jid, JidParseError, TryFrom, + Jid, BareJid, FullJid, JidParseError, }; mod avatar; @@ -84,8 +85,8 @@ pub enum Event { ContactChanged(RosterItem), AvatarRetrieved(Jid, String), OpenRoomBookmark(ConferenceBookmark), - RoomJoined(Jid), - RoomLeft(Jid), + RoomJoined(BareJid), + RoomLeft(BareJid), } #[derive(Default)] @@ -289,7 +290,10 @@ impl ClientBuilder<'_> { } } else if stanza.is("presence", "jabber:client") { let presence = Presence::try_from(stanza).unwrap(); - let from = presence.from.clone().unwrap(); + let from: BareJid = match presence.from.clone().unwrap() { + Jid::Full(FullJid { node, domain, .. }) => BareJid { node, domain }, + Jid::Bare(bare) => bare, + }; for payload in presence.payloads.into_iter() { let muc_user = match MucUser::try_from(payload) { Ok(muc_user) => muc_user, @@ -347,20 +351,17 @@ pub struct Agent { } impl Agent { - pub fn join_room(&mut self, room: Jid, nick: Option, password: Option, + pub fn join_room(&mut self, room: BareJid, nick: Option, password: Option, lang: &str, status: &str) { let mut muc = Muc::new(); if let Some(password) = password { muc = muc.with_password(password); } - // TODO: change room into a BareJid, which requires an update of jid, which requires an - // update of xmpp-parsers, which requires an update of tokio-xmpp… - assert_eq!(room.resource, None); let nick = nick.unwrap_or_else(|| self.default_nick.borrow().clone()); let room_jid = room.with_resource(nick); let mut presence = Presence::new(PresenceType::None) - .with_to(Some(room_jid)); + .with_to(Some(Jid::Full(room_jid))); presence.add_payload(muc); presence.set_status(String::from(lang), String::from(status)); let presence = presence.into(); From b1e8b9ee58c82cd1ae243d1c257d3006d23354dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Wed, 11 Sep 2019 16:25:20 +0200 Subject: [PATCH 11/13] derive Clone for Agent MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This can be required when dealing with async code. I'm happy for you to show me other ways if you think it's not necessary. Signed-off-by: Maxime “pep” Buquet --- src/lib.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/lib.rs b/src/lib.rs index a5b6e33757ac502adb62c4fef2381efb7eac3471..7731db56eb36b35677e633dcd53749f468770d46 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -345,6 +345,7 @@ impl ClientBuilder<'_> { } } +#[derive(Clone)] pub struct Agent { sender_tx: mpsc::UnboundedSender, default_nick: Rc>, From cbce8a5e7f3ed406a50f3b0b42bfd56f3e3f6220 Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Fri, 13 Sep 2019 00:19:53 +0200 Subject: [PATCH 12/13] Fix avatar retrieval. --- src/avatar.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/avatar.rs b/src/avatar.rs index 4c6e588c06429f686f4b6644b814d1797d7ae7a3..1b95b762c40e31a66f1f0d90129e6f182c42567b 100644 --- a/src/avatar.rs +++ b/src/avatar.rs @@ -40,9 +40,12 @@ pub(crate) fn handle_metadata_pubsub_event(from: &Jid, tx: &mut mpsc::UnboundedS let metadata = Metadata::try_from(payload).unwrap(); for info in metadata.infos { let filename = format!("data/{}/{}", from, hash_to_hex(&*info.id)); - let metadata = fs::metadata(filename.clone()).unwrap(); + let file_length = match fs::metadata(filename.clone()) { + Ok(metadata) => metadata.len(), + Err(_) => 0, + }; // TODO: Also check the hash. - if info.bytes as u64 == metadata.len() { + if info.bytes as u64 == file_length { events.push(Event::AvatarRetrieved(from.clone(), filename)); } else { let iq = download_avatar(from); From 2bf4b5d331dd08ec321974c11c08948f1e0ae33a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Thu, 12 Sep 2019 23:05:04 +0200 Subject: [PATCH 13/13] Add pep. as author MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maxime “pep” Buquet --- Cargo.toml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index a9def97c99fa7cf963c671cbac104bd1ead19bfe..fc327514edf4079c8de4b7a04b18aa3063891137 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,10 @@ [package] name = "xmpp" version = "0.3.0" -authors = ["Emmanuel Gil Peyrot "] +authors = [ + "Emmanuel Gil Peyrot ", + "Maxime “pep” Buquet ", +] description = "High-level XMPP library" homepage = "https://gitlab.com/linkmauve/xmpp-rs" repository = "https://gitlab.com/linkmauve/xmpp-rs"