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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
use crate::{models, prelude::*};
use async_tungstenite::tungstenite::Message;
use futures_util::{SinkExt, StreamExt};
use log::{debug, error};
use reqwest::{
header::{self, HeaderMap, HeaderValue},
Client, Method,
};
use serde::de::DeserializeOwned;
use serde_json::json;
use std::str::FromStr;
#[derive(Debug)]
pub struct AuthenticationData {
pub(crate) login_id: Option<String>,
pub(crate) password: Option<String>,
pub(crate) token: Option<String>,
}
impl AuthenticationData {
pub fn from_password(login_id: &str, password: &str) -> Self {
Self {
login_id: Some(login_id.to_owned()),
password: Some(password.to_owned()),
token: None,
}
}
pub fn from_access_token(token: &str) -> Self {
Self {
login_id: None,
password: None,
token: Some(token.to_owned()),
}
}
pub fn using_password(&self) -> bool {
self.password.is_some()
}
pub fn using_token(&self) -> bool {
self.token.is_some()
}
}
#[derive(Debug)]
pub struct Mattermost {
pub(crate) instance_url: String,
pub(crate) authentication_data: AuthenticationData,
pub(crate) client: Client,
pub(crate) auth_token: Option<String>,
}
impl Mattermost {
pub fn new(instance_url: &str, authentication_data: AuthenticationData) -> Self {
let auth_token = authentication_data.token.clone();
Self {
instance_url: instance_url.to_owned(),
authentication_data,
client: Client::new(),
auth_token,
}
}
pub async fn store_session_token(&mut self) -> Result<(), ApiError> {
if self.authentication_data.using_token() {
debug!("Using personal access token; getting a session token is a no-op");
return Ok(());
}
debug!("Getting a session token from login_id and password");
let url = format!("{}/api/v4/users/login", self.instance_url);
let resp = self
.client
.post(&url)
.json(&json!({
"login_id": self.authentication_data.login_id.as_ref().unwrap(),
"password": self.authentication_data.password.as_ref().unwrap(),
}))
.send()
.await?;
let session_token = resp
.headers()
.get("Token")
.ok_or_else(|| ApiError::CouldNotGetToken(resp.status().as_u16()))?;
self.auth_token = Some(session_token.to_str()?.to_string());
debug!("Session token retrieved and stored");
Ok(())
}
fn request_headers(&self) -> Result<HeaderMap, ApiError> {
let mut map = HeaderMap::new();
map.insert(header::ACCEPT, HeaderValue::from_static("application/json"));
map.insert(
header::CONTENT_TYPE,
HeaderValue::from_static("application/json"),
);
map.insert(
header::AUTHORIZATION,
HeaderValue::from_str(&format!(
"Bearer {}",
self.auth_token.as_ref().ok_or(ApiError::MissingAuthToken)?
))?,
);
Ok(map)
}
pub async fn query<T: DeserializeOwned>(
&self,
method: &str,
endpoint: &str,
query: Option<&[(&str, &str)]>,
body: Option<&str>,
) -> Result<T, ApiError> {
let url = format!("{}/api/v4/{}", self.instance_url, endpoint);
debug!(
"Making {} request to {} with query {:?}",
method, url, query
);
let mut req_builder = self
.client
.request(Method::from_str(method)?, &url)
.headers(self.request_headers()?)
.query(query.unwrap_or(&[]));
req_builder = match body {
Some(b) => req_builder.body(b.to_owned()),
None => req_builder,
};
let resp = self.client.execute(req_builder.build()?).await?;
if !resp.status().is_success() {
error!(
"Got status {} when requesting data from {}",
resp.status(),
url
);
let status = resp.status().as_u16();
if let Ok(text) = resp.text().await {
if let Ok(data) = serde_json::from_str::<MattermostError>(&text) {
return Err(ApiError::MattermostApiError(data));
}
}
return Err(ApiError::StatusCodeError(status));
}
Ok(resp.json().await?)
}
pub async fn connect_to_websocket<H: WebsocketHandler + 'static>(
&mut self,
handler: H,
) -> Result<(), ApiError> {
let url = format!("{}/api/v4/websocket", self.instance_url).replace("https", "wss");
let (mut stream, _response) = async_tungstenite::tokio::connect_async(url).await?;
stream
.send(Message::Text(serde_json::to_string(&json!({
"seq": 1,
"action": "authentication_challenge",
"data": {
"token": self.auth_token.as_ref().unwrap()
}
}))?))
.await?;
loop {
if let Some(event) = stream.next().await {
match event {
Ok(message) => match message {
Message::Text(text) => {
if !text.contains("seq_reply") {
match serde_json::from_str(&text) {
Ok(as_struct) => handler.callback(as_struct).await,
Err(e) => error!("Could not parse websocket event JSON: {}", e),
}
}
}
Message::Binary(_) => debug!("Websocket binary message"),
Message::Ping(_) => debug!("Websocket ping message"),
Message::Pong(_) => debug!("Websocket pong message"),
Message::Close(_) => break,
},
Err(e) => {
error!("Error getting data from websocket: {}", e);
}
}
};
}
Ok(())
}
pub async fn get_team(&self, id: &str) -> Result<models::TeamInformation, ApiError> {
self.query("GET", &format!("teams/{}", id), None, None)
.await
}
pub async fn get_team_by_name(&self, name: &str) -> Result<models::TeamInformation, ApiError> {
self.query("GET", &format!("teams/name/{}", name), None, None)
.await
}
pub async fn get_teams(&self) -> Result<Vec<models::TeamInformation>, ApiError> {
self.query("GET", "teams", None, None).await
}
pub async fn get_team_unreads_for(
&self,
user_id: &str,
) -> Result<Vec<models::TeamsUnreadInformation>, ApiError> {
self.query(
"GET",
&format!("users/{}/teams/unread", user_id),
None,
None,
)
.await
}
pub async fn get_team_unreads_for_in(
&self,
user_id: &str,
team_id: &str,
) -> Result<models::TeamsUnreadInformation, ApiError> {
self.query(
"GET",
&format!("users/{}/teams/{}/unread", user_id, team_id),
None,
None,
)
.await
}
pub async fn get_all_channels(
&self,
not_associated_to_group: Option<&str>,
page: Option<u64>,
per_page: Option<u64>,
exclude_default_channels: Option<bool>,
exclude_policy_constrained: Option<bool>,
) -> Result<Vec<models::ChannelInformation>, ApiError> {
let mut query: Vec<(&str, String)> = Vec::new();
if let Some(v) = not_associated_to_group {
query.push(("not_associated_to_group", v.to_owned()));
}
if let Some(v) = page {
query.push(("page", v.to_string()));
}
if let Some(v) = per_page {
query.push(("per_page", v.to_string()));
}
if let Some(v) = exclude_default_channels {
query.push(("exclude_default_channels", v.to_string()));
}
if let Some(v) = exclude_policy_constrained {
query.push(("exclude_policy_constrained", v.to_string()));
}
let query: Vec<(&str, &str)> = query.iter().map(|(a, b)| (*a, &**b)).collect();
self.query("GET", "channels", Some(&query), None).await
}
pub async fn get_channel(
&self,
channel_id: &str,
) -> Result<models::ChannelInformation, ApiError> {
self.query("GET", &format!("channels/{}", channel_id), None, None)
.await
}
pub async fn get_public_channels(
&self,
team_id: &str,
) -> Result<Vec<models::ChannelInformation>, ApiError> {
self.query("GET", &format!("teams/{}/channels", team_id), None, None)
.await
}
}