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
//! `PUT /_matrix/client/*/rooms/{roomId}/send/{eventType}/{txnId}`
//!
//! Send a message event to a room.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.19/client-server-api/#put_matrixclientv3roomsroomidsendeventtypetxnid
use ruma_common::{
MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedRoomId, OwnedTransactionId,
api::{auth_scheme::AccessToken, request, response},
metadata,
serde::Raw,
};
#[cfg(feature = "unstable-msc4354")]
use ruma_events::sticky::StickyDurationMs;
use ruma_events::{AnyMessageLikeEventContent, MessageLikeEventContent, MessageLikeEventType};
use serde_json::value::to_raw_value as to_raw_json_value;
metadata! {
method: PUT,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/rooms/{room_id}/send/{event_type}/{txn_id}",
1.1 => "/_matrix/client/v3/rooms/{room_id}/send/{event_type}/{txn_id}",
}
}
/// Request type for the `create_message_event` endpoint.
#[request]
pub struct Request {
/// The room to send the event to.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
/// The type of event to send.
#[ruma_api(path)]
pub event_type: MessageLikeEventType,
/// The transaction ID for this event.
///
/// Clients should generate a unique ID across requests within the
/// same session. A session is identified by an access token, and
/// persists when the [access token is refreshed].
///
/// It will be used by the server to ensure idempotency of requests.
///
/// [access token is refreshed]: https://spec.matrix.org/v1.19/client-server-api/#refreshing-access-tokens
#[ruma_api(path)]
pub txn_id: OwnedTransactionId,
/// The event content to send.
#[ruma_api(body)]
#[serde(deserialize_with = "ruma_common::serde::deserialize_raw_object")]
pub body: Raw<AnyMessageLikeEventContent>,
/// Timestamp to use for the `origin_server_ts` of the event.
///
/// This is called [timestamp massaging] and can only be used by Appservices.
///
/// Note that this does not change the position of the event in the timeline.
///
/// [timestamp massaging]: https://spec.matrix.org/v1.19/application-service-api/#timestamp-massaging
#[ruma_api(query)]
#[serde(skip_serializing_if = "Option::is_none", rename = "ts")]
pub timestamp: Option<MilliSecondsSinceUnixEpoch>,
/// The duration to stick the event for.
///
/// Valid values are the integer range 0-3600000 (1 hour).
/// The presence of this field indicates that the event should be sticky, this
/// will give this event additional delivery guarantees.
///
/// Caller must first check that the server supports sticky events (via `/versions`),
/// or it will be no-op.
///
/// See [MSC4354 sticky events](https://github.com/matrix-org/matrix-spec-proposals/pull/4354).
#[cfg(feature = "unstable-msc4354")]
#[ruma_api(query)]
#[serde(
skip_serializing_if = "Option::is_none",
rename = "org.matrix.msc4354.sticky_duration_ms"
)]
pub sticky_duration_ms: Option<StickyDurationMs>,
}
/// Response type for the `create_message_event` endpoint.
#[response]
pub struct Response {
/// A unique identifier for the event.
pub event_id: OwnedEventId,
}
impl Request {
/// Creates a new `Request` with the given room id, transaction id and event content.
///
/// # Errors
///
/// Since `Request` stores the request body in serialized form, this function can fail if
/// `T`s [`Serialize`][serde::Serialize] implementation can fail.
pub fn new<T>(
room_id: OwnedRoomId,
txn_id: OwnedTransactionId,
content: &T,
) -> serde_json::Result<Self>
where
T: MessageLikeEventContent,
{
Ok(Self {
room_id,
txn_id,
event_type: content.event_type(),
body: Raw::from_json(to_raw_json_value(content)?),
timestamp: None,
#[cfg(feature = "unstable-msc4354")]
sticky_duration_ms: None,
})
}
/// Creates a new `Request` with the given room id, transaction id, event type and raw event
/// content.
pub fn new_raw(
room_id: OwnedRoomId,
txn_id: OwnedTransactionId,
event_type: MessageLikeEventType,
body: Raw<AnyMessageLikeEventContent>,
) -> Self {
Self {
room_id,
event_type,
txn_id,
body,
timestamp: None,
#[cfg(feature = "unstable-msc4354")]
sticky_duration_ms: None,
}
}
}
impl Response {
/// Creates a new `Response` with the given event id.
pub fn new(event_id: OwnedEventId) -> Self {
Self { event_id }
}
}
}
#[cfg(all(test, feature = "client", feature = "unstable-msc4354"))]
mod tests {
use std::borrow::Cow;
use ruma_common::{
api::{
MatrixVersion, OutgoingRequestExt as _, SupportedVersions, auth_scheme::SendAccessToken,
},
owned_room_id,
serde::Raw,
};
use ruma_events::{MessageLikeEventType, sticky::StickyDurationMs};
use serde_json::json;
#[test]
fn test_sticky_send_message_request() {
let supported = SupportedVersions {
versions: [MatrixVersion::V1_1].into(),
features: Default::default(),
};
let mut request = crate::message::send_message_event::v3::Request::new_raw(
owned_room_id!("!roomid:example.org"),
"0000".into(),
MessageLikeEventType::RoomMessage,
Raw::new(&json!({ "body": "Hello" })).unwrap().cast_unchecked(),
);
request.sticky_duration_ms = Some(StickyDurationMs::new_clamped(123_456_u32));
let http_request: http::Request<Vec<u8>> = request
.try_into_http_request(
"https://homeserver.tld",
SendAccessToken::IfRequired("auth_tok"),
Cow::Owned(supported),
)
.unwrap();
assert_eq!(
http_request.uri().query().unwrap(),
"org.matrix.msc4354.sticky_duration_ms=123456"
);
}
}
#[cfg(all(test, feature = "server", feature = "unstable-msc4354"))]
mod server_tests {
use ruma_common::{api::IncomingRequestExt as _, owned_room_id};
use super::v3::Request;
#[test]
fn deserialize_sticky_duration() {
let request = http::Request::builder()
.method("PUT")
.uri(
"/_matrix/client/v3/rooms/!roomid:example.org/send/m.room.message/0000?org.matrix.msc4354.sticky_duration_ms=123456",
)
.body(br#"{"body":"Hello"}"# as &[u8])
.unwrap();
let request = Request::try_from_http_request(
request,
&["!roomid:example.org", "m.room.message", "0000"],
)
.unwrap();
assert_eq!(request.room_id, owned_room_id!("!roomid:example.org"));
assert_eq!(request.sticky_duration_ms.map(|duration| duration.get()), Some(123_456));
}
}