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

//! **Glitch in the Matrix** is a set of (minimal) [Matrix](http://matrix.org/) bindings for Rust.
//! It has a number of limitations at present, and is not recommended for production use. Still,
//! it is provided in the hope that it might be useful.
//!
//! Licensed under the [Unlicense](http://unlicense.org/).


extern crate serde;
#[macro_use] extern crate serde_derive;
#[macro_use] extern crate serde_json;
extern crate hyper;
#[macro_use] extern crate error_chain;

pub mod errors {
    error_chain! {
        types {
            MatrixError, MatrixErrorKind, ResultExt, MatrixResult;
        }
        foreign_links {
            Hyper(::hyper::error::Error);
            Serde(::serde_json::Error);
            Io(::std::io::Error);
        }
        errors {
            HttpCode(c: ::hyper::status::StatusCode) {
                display("HTTP error: {}", c.canonical_reason().unwrap_or("unknown"))
            }
            BadRequest(e: super::types::BadRequestReply) {
                display("Bad request: {:?}", e)
            }
        }
    }
}
pub mod types;

use errors::*;
use errors::MatrixErrorKind::*;
use types::*;
use hyper::method::Method;
use Method::*;
use hyper::client::{Response, RequestBuilder};

/// A connection to a Matrix homeserver.
pub struct MatrixClient {
    hyper: hyper::Client,
    access_token: String,
    user_id: String,
    url: String,
    last_batch: Option<String>,
    set_presence: bool,
    txnid: u32
}
impl MatrixClient {
    /// Log in to a Matrix homeserver, and return a client object.
    pub fn login(username: &str, password: &str, url: &str) -> MatrixResult<Self> {
        let client = hyper::Client::new();
        let mut resp = client.post(&format!("{}/_matrix/client/r0/login", url))
            .body(&json!({
                "type": "m.login.password",
                "user": username,
                "password": password
            }).to_string())
            .send()?;
        Self::handle_errs(&mut resp)?;
        let rpl = serde_json::from_reader::<_, LoginReply>(resp)?;
        Ok(MatrixClient {
            hyper: client,
            access_token: rpl.access_token,
            user_id: rpl.user_id,
            url: url.to_string(),
            last_batch: None,
            set_presence: true,
            txnid: 0
        })
    }
    fn handle_errs(resp: &mut Response) -> MatrixResult<()> {
        if !resp.status.is_success() {
            let st = resp.status.clone();
            if let Ok(e) = serde_json::from_reader::<_, BadRequestReply>(resp) {
                bail!(BadRequest(e));
            }
            else {
                bail!(HttpCode(st));
            }
        }
        Ok(())
    }
    /// Send a message to a room ID.
    pub fn send(&mut self, roomid: &str, msg: Message) -> MatrixResult<SendReply> {
        let body = serde_json::to_value(&msg)?;
        let uri = format!("/rooms/{}/send/m.room.message/{}",
                          roomid,
                          self.txnid);
        self.txnid += 1;
        let mut resp = self.req(Put, &uri, vec![])
            .body(&body.to_string())
            .send()?;
        Self::handle_errs(&mut resp)?;
        let rpl = serde_json::from_reader(resp)?;
        Ok(rpl)
    }
    /// Get the client's MXID.
    pub fn user_id(&self) -> &str {
        &self.user_id
    }
    /// Set whether polling the `sync` API marks us as online.
    pub fn set_set_presence(&mut self, v: bool) {
        self.set_presence = v;
    }
    /// Ascertain whether polling the `sync` API marks us as online.
    pub fn set_presence(&self) -> bool {
        self.set_presence
    }
    /// Poll the Matrix server for new events since the last call to `sync()`.
    ///
    /// It is recommended to call this in a loop. The Matrix server will block
    /// until new events arrive, up to a given timeout value.
    pub fn sync(&mut self, timeout: u64) -> MatrixResult<SyncReply> {
        let mut params = vec![];
        params.push(format!("set_presence={}", if self.set_presence {
            "online"
        } else { "offline" }));
        if let Some(ref b) = self.last_batch {
            params.push(format!("since={}", b));
            params.push(format!("timeout={}", timeout));
        }
        let mut resp = self.req(Get, "/sync", params).send()?;
        Self::handle_errs(&mut resp)?;
        let rpl = serde_json::from_reader::<_, SyncReply>(resp)?;
        self.last_batch = Some(rpl.next_batch.clone());
        Ok(rpl)
    }
    /// Make an arbitrary HTTP request to the Matrix API.
    ///
    /// - `/_matrix/client/r0` is filled in for you, so your `endpoint` is something like `/sync`.
    /// - `params` is a list of `key=value` HTTP parameters, like `timeout=30`.
    ///
    /// Returns a `RequestBuilder` which you can use for your own nefarious ends.
    pub fn req(&mut self, meth: Method, endpoint: &str, params: Vec<String>) -> RequestBuilder {
        self.hyper.request(meth,
                           &format!("{}/_matrix/client/r0{}?access_token={}{}{}",
                                    self.url,
                                    endpoint,
                                    &self.access_token,
                                    if params.len() == 0 { "" } else { "&" },
                                    params.join("&")
                           ))
    }
}
impl Drop for MatrixClient {
    /// Invalidates our access token, so we don't have millions of devices.
    fn drop(&mut self) {
        let _ = self.req(Post, "/logout", vec![]).send();
    }
}