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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
use crate::signaldrequest::SignaldRequestBuilder;
use crate::signaldrequest::SignaldRequest;
use std::time::{Instant, Duration};
use bus::{BusReader};
use std::sync::mpsc::RecvTimeoutError::Timeout;
use std::sync::mpsc::RecvTimeoutError;
use crate::signaldresponse::{SignaldResponse, ResponseType};
use crate::signald::FilterType::{Id, Type};
use crate::signaldresponse::ResponseType::BusUpdate;
use crate::socket::Socket;
use crate::socket::signaldsocket::SignaldSocket;

pub static SOCKET_PATH: &'static str = "/var/run/signald/signald.sock";

pub enum FilterType {
    Id(String),
    Type(ResponseType)
}

pub struct Signald {
    // The signald socket
    // socket: Box<dyn Socket + Send + Sync>,
    socket: SignaldSocket,
    // A count of all the sent messages on this socket
    message_count: u32,
}
impl Signald {

    /// Connect the default Signald socket
    pub fn connect() -> Signald {
        Signald::connect_path(&SOCKET_PATH)
    }
    /// Connect to a custom Signald socket
    pub fn connect_path(socket_path: &str) -> Self {
        let socket: SignaldSocket = SignaldSocket::connect(socket_path.to_string(), 100);

        Self {
            // socket: Box::new(socket),
            socket: socket,
            message_count: 0,
        }
    }
    /// Send a signald request on the socket
    pub fn send_request(&mut self, request: &SignaldRequest) {
        self.message_count += 1;
        self.socket.send_request(&request);
    }

    // Signald messages
    // Todo: add attachments, etc
    /// Send a message to the socket
    pub async fn send(&mut self, username: String, recipient_number: String, message_body: Option<String>) {
        let mut request_builder = SignaldRequestBuilder::new();
        request_builder.set_type("send".to_string());
        request_builder.set_username(username);
        request_builder.set_recipient_number(recipient_number);
        if let Some(i) = message_body {
            request_builder.set_message_body(i);
        }

        let request = request_builder.build();
        self.send_request(&request);
    }

    /// Enable receiving user events such as received messages
    pub async fn subscribe(&mut self, username: String) -> Result<SignaldResponse, RecvTimeoutError> {
        let id = self.message_count.to_string();

        let mut request_builder = SignaldRequestBuilder::new();
        request_builder.set_type("subscribe".to_string());
        request_builder.set_username(username);
        request_builder.set_id(id.clone());
        let request = request_builder.build();

        self.send_request(&request);
        self.wait_for_request(Id(id)).await
    }
    /// Disable receiving user events such as received messages
    pub async fn unsubscribe(&mut self, username: String) -> Result<SignaldResponse, RecvTimeoutError> {
        let id = self.message_count.to_string();

        let mut request_builder = SignaldRequestBuilder::new();
        request_builder.set_type("unsubscribe".to_string());
        request_builder.set_username(username);
        request_builder.set_id(id.clone());
        let request = request_builder.build();

        self.send_request(&request);
        self.wait_for_request(Id(id)).await
    }
    /// Link an existing signal account
    pub async fn link(&mut self) -> Result<SignaldResponse, RecvTimeoutError> {
        let id = self.message_count.to_string();

        let mut request_builder = SignaldRequestBuilder::new();
        request_builder.set_type("link".to_string());
        request_builder.set_id(id.clone());
        let request = request_builder.build();

        self.send_request(&request);
        self.wait_for_request(Id(id)).await
    }
    /// Get the current signald version
    pub async fn version(&mut self) -> Result<SignaldResponse, RecvTimeoutError> {
        let id = self.message_count.to_string();

        let mut request_builder = SignaldRequestBuilder::new();
        request_builder.set_type("version".to_string());
        request_builder.set_id(id.clone());
        let request = request_builder.build();

        self.send_request(&request);
        self.wait_for_request(Type(ResponseType::Version(None))).await
    }
    /// Query all the user's contacts
    pub async fn list_contacts(&mut self, username: String) -> Result<SignaldResponse, RecvTimeoutError> {
        let id = self.message_count.to_string();

        let mut request_builder = SignaldRequestBuilder::new();
        request_builder.set_type("list_contacts".to_string());
        request_builder.set_username(username);
        request_builder.set_id(id.clone());
        let request = request_builder.build();

        self.send_request(&request);
        self.wait_for_request(Id(id)).await
    }
    /// Send a contact sync request to the other devices on this account
    pub fn sync_contacts(&mut self, username: String) {
        let mut request_builder = SignaldRequestBuilder::new();
        request_builder.set_type("sync_contacts".to_string());
        request_builder.set_username(username);
        request_builder.set_id(self.message_count.to_string());
        let request = request_builder.build();

        self.send_request(&request);
    }
    /// Get a response stream that returns every received message on the socket
    pub fn get_rx(&mut self) -> BusReader<SignaldResponse> {
        self.socket.get_rx()
    }

    /// Get a response from the bus with a matching id or type
    /// Returns a RecvTimeoutError if the message took more than 3 seconds to return
    async fn wait_for_request(&mut self, filter: FilterType) -> Result<SignaldResponse, RecvTimeoutError> {
        // The max possible time to receive a message
        let end = Instant::now() + Duration::from_millis(3000);
        let mut rx = self.socket.get_rx();

        let result = rx.iter()
            // Stop the receiver once the time is over, this keeps updating thanks to the update messages in systemdsocket
            .take_while(|_| Instant::now() < end )
            .find(|response| {
                // The systemdsocket sends an 'update' message each second, don't parse this
                if let BusUpdate = response.data { return false; }

                Signald::filter_request(&filter, &response)
            });

        // When no results are found within the time limit, an error is returned
        match result {
            Some(x) => {
                Ok(x)
            },
            None => {
                Err(Timeout)
            }
        }

    }

    fn filter_request(filter: &FilterType, message: &SignaldResponse) -> bool {
        match filter {
            // Filter on id
            Id(req_id) => {
                match &message.id {
                    Some(s) => {
                        return s == req_id.as_str();
                    },
                    None => {
                        false
                    }
                }
            }
            // Filter on response type
            Type(req_type) => {
                let disc1 = std::mem::discriminant(req_type);
                let disc2 = std::mem::discriminant(&message.data);
                return disc1 == disc2;
            }
        }
    }

}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_filter_request_id_success() {
        let id = "test".to_string();

        let message = SignaldResponse {
            id: Some(id.clone()),
            data: ResponseType::Subscribed
        };

        assert!(Signald::filter_request(&Id(id), &message));
    }

    #[test]
    fn test_filter_request_id_wrong() {
        let id = "test".to_string();

        let message = SignaldResponse {
            id: Some(id.clone()),
            data: ResponseType::Subscribed
        };

        assert!(!Signald::filter_request(&Id("INCORRECT_ID".to_string()), &message));
    }

    #[test]
    fn test_filter_request_type_correct() {
        let message = SignaldResponse {
            id: None,
            data: ResponseType::Subscribed
        };

        assert!(Signald::filter_request(&Type(ResponseType::Subscribed), &message));
    }

    #[test]
    fn test_filter_request_type_wrong() {
        let message = SignaldResponse {
            id: None,
            data: ResponseType::Subscribed
        };

        assert!(!Signald::filter_request(&Type(ResponseType::Unsubscribed), &message));
    }
}