xmpp 0.7.0

High-level XMPP library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

// Copyright (c) 2023 xmpp-rs contributors.
//
// 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 alloc::sync::Arc;
use std::collections::HashMap;
use std::path::{Path, PathBuf};
#[cfg(feature = "escape-hatch")]
use tokio::io;
use tokio::sync::RwLock;

use crate::{
    Config, Error, Event, RoomNick, event_loop,
    jid::{BareJid, FullJid, Jid},
    message, muc,
    parsers::disco::DiscoInfoResult,
    upload,
};
use tokio_xmpp::Client as TokioXmppClient;
#[cfg(feature = "escape-hatch")]
use tokio_xmpp::{Stanza, stanzastream::StanzaToken};

pub struct Agent {
    pub(crate) client: TokioXmppClient,
    config: Arc<RwLock<Config>>,
    pub(crate) disco: DiscoInfoResult,
    pub(crate) uploads: Vec<(String, Jid, PathBuf)>,
    pub(crate) awaiting_disco_bookmarks_type: bool,
    // Mapping of room->nick
    pub(crate) rooms_joined: HashMap<BareJid, RoomNick>,
    pub(crate) rooms_joining: HashMap<BareJid, RoomNick>,
    pub(crate) rooms_leaving: HashMap<BareJid, RoomNick>,
}

impl Agent {
    pub fn new(client: TokioXmppClient, config: Config, disco: DiscoInfoResult) -> Agent {
        Agent {
            client,
            config: Arc::new(RwLock::new(config)),
            disco,
            uploads: Vec::new(),
            awaiting_disco_bookmarks_type: false,
            rooms_joined: HashMap::new(),
            rooms_joining: HashMap::new(),
            rooms_leaving: HashMap::new(),
        }
    }

    /// Reset the agent configuration to the provided Config struct
    // TODO: refresh everything that is affected by this reset?
    pub async fn set_config(&mut self, config: Config) {
        let mut c = self.config.write().await;
        *c = config;
    }

    pub async fn get_config(&self) -> Config {
        self.config.read().await.clone()
    }

    pub async fn disconnect(self) -> Result<(), Error> {
        self.client.send_end().await
    }

    #[cfg(feature = "escape-hatch")]
    pub async fn send_stanza<S: Into<Stanza>>(&mut self, st: S) -> Result<StanzaToken, io::Error> {
        self.client.send_stanza(st.into()).await
    }

    pub async fn join_room<'a>(&mut self, settings: muc::room::JoinRoomSettings<'a>) {
        muc::room::join_room(self, settings).await
    }

    /// Request to leave a chatroom.
    ///
    /// If successful, an [Event::RoomLeft] event will be produced. This method does not remove the room
    /// from bookmarks nor remove the autojoin flag. See [muc::room::leave_room] for more information.
    pub async fn leave_room<'a>(&mut self, settings: muc::room::LeaveRoomSettings<'a>) {
        muc::room::leave_room(self, settings).await
    }

    pub async fn send_raw_message<'a>(&mut self, settings: message::send::RawMessageSettings<'a>) {
        message::send::send_raw_message(self, settings).await
    }

    pub async fn send_message<'a>(&mut self, settings: message::send::MessageSettings<'a>) {
        message::send::send_message(self, settings).await
    }

    pub async fn send_room_message<'a>(&mut self, settings: muc::room::RoomMessageSettings<'a>) {
        muc::room::send_room_message(self, settings).await
    }

    pub async fn send_room_private_message<'a>(
        &mut self,
        settings: muc::private_message::RoomPrivateMessageSettings<'a>,
    ) {
        muc::private_message::send_room_private_message(self, settings).await
    }

    /// Wait for new events, or Error::Disconnected when connection is closed and will not reconnect.
    pub async fn wait_for_events(&mut self) -> Vec<Event> {
        event_loop::wait_for_events(self).await
    }

    pub async fn upload_file_with(&mut self, service: &str, path: &Path) {
        upload::send::upload_file_with(self, service, path).await
    }

    /// Get the bound jid of the client.
    ///
    /// If the client is not connected, this will be None.
    pub fn bound_jid(&self) -> Option<&FullJid> {
        self.client.bound_jid()
    }
}