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
//! `GET /_matrix/client/*/rooms/{roomId}/messages`
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.2/client-server-api/#get_matrixclientv3roomsroomidmessages
use js_int::{uint, UInt};
use ruma_common::{
api::ruma_api,
events::{AnyRoomEvent, AnyStateEvent},
serde::Raw,
RoomId,
};
use serde::{Deserialize, Serialize};
use crate::filter::{IncomingRoomEventFilter, RoomEventFilter};
ruma_api! {
metadata: {
description: "Get message events for a room.",
method: GET,
name: "get_message_events",
r0_path: "/_matrix/client/r0/rooms/:room_id/messages",
stable_path: "/_matrix/client/v3/rooms/:room_id/messages",
rate_limited: false,
authentication: AccessToken,
added: 1.0,
}
request: {
/// The room to get events from.
#[ruma_api(path)]
pub room_id: &'a RoomId,
/// The token to start returning events from.
///
/// This token can be obtained from a `prev_batch` token returned for each room by the
/// sync endpoint, or from a `start` or `end` token returned by a previous request to
/// this endpoint.
///
/// If this is `None`, the server will return messages from the start or end of the
/// history visible to the user, depending on the value of [`dir`][Self::dir].
///
/// *Note: This field is marked required in v1.2 of the specification, but that is
/// changing, most likely as part of v1.3. To frontload the breaking change, this field
/// is optional already even though v1.2 is the latest version at the time of writing.
/// The specification change can be found [here].*
///
/// [here]: https://github.com/matrix-org/matrix-spec/pull/1002
#[ruma_api(query)]
pub from: Option<&'a str>,
/// The token to stop returning events at.
///
/// This token can be obtained from a `prev_batch` token returned for each room by the
/// sync endpoint, or from a `start` or `end` token returned by a previous request to
/// this endpoint.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub to: Option<&'a str>,
/// The direction to return events from.
#[ruma_api(query)]
pub dir: Direction,
/// The maximum number of events to return.
///
/// Default: `10`.
#[ruma_api(query)]
#[serde(default = "default_limit", skip_serializing_if = "is_default_limit")]
pub limit: UInt,
/// A [`RoomEventFilter`] to filter returned events with.
#[ruma_api(query)]
#[serde(
with = "ruma_common::serde::json_string",
default,
skip_serializing_if = "RoomEventFilter::is_empty"
)]
pub filter: RoomEventFilter<'a>,
}
#[derive(Default)]
response: {
/// The token the pagination starts from.
pub start: String,
/// The token the pagination ends at.
#[serde(skip_serializing_if = "Option::is_none")]
pub end: Option<String>,
/// A list of room events.
#[serde(default)]
pub chunk: Vec<Raw<AnyRoomEvent>>,
/// A list of state events relevant to showing the `chunk`.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub state: Vec<Raw<AnyStateEvent>>,
}
error: crate::Error
}
impl<'a> Request<'a> {
/// Creates a new `Request` with the given parameters.
///
/// All other parameters will be defaulted.
pub fn new(room_id: &'a RoomId, from: &'a str, dir: Direction) -> Self {
Self {
room_id,
from: Some(from),
to: None,
dir,
limit: default_limit(),
filter: RoomEventFilter::default(),
}
}
/// Creates a new `Request` with the given room ID and from token, and `dir` set to
/// `Backward`.
pub fn backward(room_id: &'a RoomId, from: &'a str) -> Self {
Self::new(room_id, from, Direction::Backward)
}
/// Creates a new `Request` with the given room ID and from token, and `dir` set to
/// `Forward`.
pub fn forward(room_id: &'a RoomId, from: &'a str) -> Self {
Self::new(room_id, from, Direction::Forward)
}
/// Creates a new `Request` to fetch messages from the very start of the available history
/// for a given room.
pub fn from_start(room_id: &'a RoomId) -> Self {
Self {
room_id,
from: None,
to: None,
dir: Direction::Forward,
limit: default_limit(),
filter: RoomEventFilter::default(),
}
}
/// Creates a new `Request` to fetch messages from the very end of the available history for
/// a given room.
pub fn from_end(room_id: &'a RoomId) -> Self {
Self {
room_id,
from: None,
to: None,
dir: Direction::Backward,
limit: default_limit(),
filter: RoomEventFilter::default(),
}
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Default::default()
}
}
fn default_limit() -> UInt {
uint!(10)
}
#[allow(clippy::trivially_copy_pass_by_ref)]
fn is_default_limit(val: &UInt) -> bool {
*val == default_limit()
}
/// The direction to return events from.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[allow(clippy::exhaustive_enums)]
pub enum Direction {
/// Return events backwards in time from the requested `from` token.
#[serde(rename = "b")]
Backward,
/// Return events forwards in time from the requested `from` token.
#[serde(rename = "f")]
Forward,
}
#[cfg(all(test, feature = "client"))]
mod tests {
use js_int::uint;
use ruma_common::{
api::{MatrixVersion, OutgoingRequest, SendAccessToken},
room_id,
};
use super::{Direction, Request};
use crate::filter::{LazyLoadOptions, RoomEventFilter};
#[test]
fn serialize_some_room_event_filter() {
let room_id = room_id!("!roomid:example.org");
let rooms = &[room_id.to_owned()];
let filter = RoomEventFilter {
lazy_load_options: LazyLoadOptions::Enabled { include_redundant_members: true },
rooms: Some(rooms),
not_rooms: &[
room_id!("!room:example.org").to_owned(),
room_id!("!room2:example.org").to_owned(),
room_id!("!room3:example.org").to_owned(),
],
not_types: &["type".into()],
..Default::default()
};
let req = Request {
room_id,
from: Some("token"),
to: Some("token2"),
dir: Direction::Backward,
limit: uint!(0),
filter,
};
let request: http::Request<Vec<u8>> = req
.try_into_http_request(
"https://homeserver.tld",
SendAccessToken::IfRequired("auth_tok"),
&[MatrixVersion::V1_1],
)
.unwrap();
assert_eq!(
"from=token\
&to=token2\
&dir=b\
&limit=0\
&filter=%7B%22not_types%22%3A%5B%22type%22%5D%2C%22not_rooms%22%3A%5B%22%21room%3Aexample.org%22%2C%22%21room2%3Aexample.org%22%2C%22%21room3%3Aexample.org%22%5D%2C%22rooms%22%3A%5B%22%21roomid%3Aexample.org%22%5D%2C%22lazy_load_members%22%3Atrue%2C%22include_redundant_members%22%3Atrue%7D",
request.uri().query().unwrap()
);
}
#[test]
fn serialize_default_room_event_filter() {
let room_id = room_id!("!roomid:example.org");
let req = Request {
room_id,
from: Some("token"),
to: Some("token2"),
dir: Direction::Backward,
limit: uint!(0),
filter: RoomEventFilter::default(),
};
let request = req
.try_into_http_request::<Vec<u8>>(
"https://homeserver.tld",
SendAccessToken::IfRequired("auth_tok"),
&[MatrixVersion::V1_1],
)
.unwrap();
assert_eq!("from=token&to=token2&dir=b&limit=0", request.uri().query().unwrap(),);
}
}
}