-
-
Notifications
You must be signed in to change notification settings - Fork 23
/
mod.rs
376 lines (348 loc) · 16.8 KB
/
mod.rs
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
mod event_loop;
mod pool_connection;
use crate::client::event_loop::{ClientLoopCommand, ClientLoopWorker};
use crate::config::ClientConfig;
use crate::error::Error;
use crate::irc;
use crate::login::LoginCredentials;
use crate::message::commands::ServerMessage;
use crate::message::IRCMessage;
use crate::message::{IRCTags, PrivmsgMessage};
use crate::transport::Transport;
use crate::validate::validate_login;
use std::collections::HashSet;
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::{mpsc, oneshot};
/// A send-only handle to control the Twitch IRC Client.
#[derive(Debug)]
pub struct TwitchIRCClient<T: Transport, L: LoginCredentials> {
// we use an Arc<>.
// the client loop has to also hold a handle to this sender to be able to feed itself
// with commands as well. (e.g. to rejoin channels)
// the client loop gets a Weak<> (a weak reference) and this client holds strong
// references. That means when the last client handle is dropped, the client loop
// exits, because the underlying mpsc::UnboundedSender will be dropped.
// The client will then also no longer be able to send "itself" messages, because
// it always only holds a Weak<> and has to check whether the weak reference is still
// valid before sending itself messages.
client_loop_tx: Arc<mpsc::UnboundedSender<ClientLoopCommand<T, L>>>,
}
// we have to implement Debug and Clone manually, the derive macro places
// the requirement `T: Clone` which we cannot currently satisfy and don't need
impl<T: Transport, L: LoginCredentials> Clone for TwitchIRCClient<T, L> {
fn clone(&self) -> Self {
TwitchIRCClient {
client_loop_tx: self.client_loop_tx.clone(),
}
}
}
impl<T: Transport, L: LoginCredentials> TwitchIRCClient<T, L> {
/// Create a new client from the given configuration.
///
/// Note this method is not side-effect-free - a background task will be spawned
/// as a result of calling this function.
pub fn new(
config: ClientConfig<L>,
) -> (
mpsc::UnboundedReceiver<ServerMessage>,
TwitchIRCClient<T, L>,
) {
let config = Arc::new(config);
let (client_loop_tx, client_loop_rx) = mpsc::unbounded_channel();
let client_loop_tx = Arc::new(client_loop_tx);
let (client_incoming_messages_tx, client_incoming_messages_rx) = mpsc::unbounded_channel();
ClientLoopWorker::spawn(
config,
// the worker gets only a weak reference
Arc::downgrade(&client_loop_tx),
client_loop_rx,
client_incoming_messages_tx,
);
(
client_incoming_messages_rx,
TwitchIRCClient { client_loop_tx },
)
}
}
impl<T: Transport, L: LoginCredentials> TwitchIRCClient<T, L> {
/// Connect to Twitch IRC without joining any channels.
///
/// **You typically do not need to call this method.** This is only provided for the rare
/// case that one would only want to receive incoming whispers without joining channels
/// or ever sending messages out. If your application joins channels during startup,
/// calling `.connect()` is superfluous, as the client will automatically open the necessary
/// connections when you join channels or send messages.
pub async fn connect(&self) {
let (return_tx, return_rx) = oneshot::channel();
self.client_loop_tx
.send(ClientLoopCommand::Connect {
return_sender: return_tx,
})
.unwrap();
// unwrap: ClientLoopWorker should not die before all sender handles have been dropped
return_rx.await.unwrap()
}
/// Send an arbitrary IRC message to one of the connections in the connection pool.
///
/// An error is returned in case the message could not be sent over the picked connection.
pub async fn send_message(&self, message: IRCMessage) -> Result<(), Error<T, L>> {
let (return_tx, return_rx) = oneshot::channel();
self.client_loop_tx
.send(ClientLoopCommand::SendMessage {
message,
return_sender: return_tx,
})
.unwrap();
// unwrap: ClientLoopWorker should not die before all sender handles have been dropped
return_rx.await.unwrap()
}
/// Send a `PRIVMSG`-type IRC message to a Twitch channel. The `message` can be a normal
/// chat message or a chat command like `/ban` or similar.
///
/// If you want to just send a normal chat message, `say()` should be preferred since it
/// prevents commands like `/ban` from accidentally being executed.
pub async fn privmsg(&self, channel_login: String, message: String) -> Result<(), Error<T, L>> {
self.send_message(irc!["PRIVMSG", format!("#{}", channel_login), message])
.await
}
/// Ban a user with an optional reason from the given Twitch channel.
///
/// Note that this will not throw an error if the target user is already banned, doesn't exist
/// or if the logged-in user does not have the required permission to ban the user. An error
/// is only returned if something prevented the command from being sent over the wire.
pub async fn ban(
&self,
channel_login: String,
target_login: &str,
reason: Option<&str>,
) -> Result<(), Error<T, L>> {
let command = match reason {
Some(reason) => format!("/ban {} {}", target_login, reason),
None => format!("/ban {}", target_login),
};
self.privmsg(channel_login, command).await
}
/// Unban a user from the given Twitch channel.
///
/// Note that this will not throw an error if the target user is not currently banned, doesn't exist
/// or if the logged-in user does not have the required permission to unban the user. An error
/// is only returned if something prevented the command from being sent over the wire.
pub async fn unban(
&self,
channel_login: String,
target_login: &str,
) -> Result<(), Error<T, L>> {
self.privmsg(channel_login, format!("/unban {}", target_login))
.await
}
/// Timeout a user in the given Twitch channel.
///
/// Note that this will not throw an error if the target user is banned, doesn't exist
/// or if the logged-in user does not have the required permission to timeout the user. An error
/// is only returned if something prevented the command from being sent over the wire.
pub async fn timeout(
&self,
channel_login: String,
target_login: &str,
duration: Duration,
reason: Option<&str>,
) -> Result<(), Error<T, L>> {
let command = match reason {
Some(reason) => format!(
"/timeout {} {} {}",
target_login,
duration.as_secs(),
reason
),
None => format!("/timeout {} {}", target_login, duration.as_secs()),
};
self.privmsg(channel_login, command).await
}
/// Remove the timeout from a user in the given Twitch channel.
///
/// Note that this will not throw an error if the target user is banned, not currently timed
/// out, doesn't exist or if the logged-in user does not have the required permission to remove
/// the timeout from the user. An error is only returned if something prevented the command from
/// being sent over the wire.
pub async fn untimeout(
&self,
channel_login: String,
target_login: &str,
) -> Result<(), Error<T, L>> {
self.privmsg(channel_login, format!("/untimeout {}", target_login))
.await
}
/// Say a chat message in the given Twitch channel.
///
/// This method automatically prevents commands from being executed. For example
/// `say("a_channel", "/ban a_user") would not actually ban a user, instead it would
/// send that exact message as a normal chat message instead.
///
/// No particular filtering is performed on the message. If the message is too long for chat,
/// it will not be cut short or split into multiple messages (what happens is determined
/// by the behaviour of the Twitch IRC server).
pub async fn say(&self, channel_login: String, message: String) -> Result<(), Error<T, L>> {
self.say_in_response(channel_login, message, None).await
}
/// Say a chat message in the given Twitch channel, but send it as a response to another message if `reply_to_id` is specified.
///
/// Behaves the same as `say()` when `reply_to_id` is None, but tags the original message and it's sender if specified.
pub async fn say_in_response(
&self,
channel_login: String,
message: String,
reply_to_id: Option<String>,
) -> Result<(), Error<T, L>> {
let mut tags = IRCTags::new();
if let Some(id) = reply_to_id {
tags.0.insert("reply-parent-msg-id".to_string(), Some(id));
}
let irc_message = IRCMessage::new(
tags,
None,
"PRIVMSG".to_string(),
vec![format!("#{}", channel_login), format!(". {}", message)], // The prefixed "." prevents commands from being executed
);
self.send_message(irc_message).await
}
/// Replies to a given `PrivmsgMessage`, tagging the original message and it's sender.
///
/// Similarly to `say()`, this method strips the message of executing commands, but does not filter out messages which are too long.
/// Refer to `say()` for the exact behaviour.
pub async fn reply_to_privmsg(
&self,
message: String,
reply_to: &PrivmsgMessage,
) -> Result<(), Error<T, L>> {
self.say_in_response(
reply_to.channel_login.clone(),
message,
Some(reply_to.message_id.clone()),
)
.await
}
/// Join the given Twitch channel (When a channel is joined, the client will receive messages
/// sent to it).
///
/// **This method panics if a channel login of invalid format is passed to it.** (As determined
/// by [crate::validate::validate_login].) If you are dealing with unsanitized
/// user input, you must manually call this validate function before calling this function,
/// in order to avoid panicking your program.
///
/// The client will internally ensure that there has always been at least _an attempt_ to join
/// this channel. However this does not necessarily mean the join is always successful.
///
/// If the given `channel_login` does not exist (or is suspended) then the IRC server
/// will ignore the `JOIN` and you will not be joined to the given channel (what channel would
/// you even expect to join if the channel does not exist?).
///
/// However, the client listens for a server-side confirmation to this `JOIN` command.
/// If the server confirms that the `JOIN` was successful, then the client saves this information.
/// This information can be queried using `get_channel_status()`.
///
/// If you later issue another `join()` call, and the server previously confirmed the successful
/// joining of `channel_login`, then no message will be sent out.
///
/// However if the server *did not* confirm the successful `JOIN` command previously, then the
/// `JOIN` is attempted again.
///
/// You can use this mechanism to e.g. periodically re-try `JOIN`ing a given channel if
/// joining to freshly created channels or freshly renamed channels is a concern in your application.
///
/// Another note on Twitch behaviour: If a channel gets suspended, the `JOIN` membership stays
/// active as long as the connection with that `JOIN` membership stays active. For this reason,
/// there is no special logic or handling required for when a channel gets suspended.
/// (The `JOIN` membership in that channel will continue to count as confirmed for as long
/// as the connection stays alive. If the connection fails, the "confirmed" status for that
/// channel is reset, and the client will automatically attempt to re-join that channel on a
/// different or new connection.
/// Unless an answer is again received by the server, the `join()` will then make attempts again
/// to join that channel.
pub fn join(&self, channel_login: String) {
if let Err(e) = validate_login(&channel_login) {
panic!("TwitchIRCClient.login: Channel login `{}` is forbidden: does not pass basic format validation ({})", channel_login, e);
}
self.client_loop_tx
.send(ClientLoopCommand::Join { channel_login })
.unwrap();
}
/// Instruct the client to only be connected to these channels. Channels currently joined
/// but not in the given set are parted, and channels in the set that are not currently
/// joined are joined.
///
/// **This method panics if a channel login of invalid format is passed to it.** (As determined
/// by [crate::validate::validate_login].) If you are dealing with unsanitized
/// user input, you must manually call this validate function before calling this function,
/// in order to avoid panicking your program.
///
/// For further semantics about join and parts, see the documentation for [TwitchIRCClient::join].
pub fn set_wanted_channels(&self, channels: HashSet<String>) {
for channel_login in channels.iter() {
if let Err(e) = validate_login(channel_login) {
panic!("TwitchIRCClient.set_wanted_channels: Channel login `{}` is forbidden: does not pass basic format validation ({})", channel_login, e);
}
}
self.client_loop_tx
.send(ClientLoopCommand::SetWantedChannels { channels })
.unwrap();
}
/// Query the client for what status a certain channel is in.
///
/// Returns two booleans: The first indicates whether a channel is `wanted`. This is true
/// if the last operation for this channel was a `join()` method, or alternatively whether
/// it was included in the set of channels in a `set_wanted_channels` call.
///
/// The second boolean indicates whether this channel is currently joined server-side.
/// (This is purely based on `JOIN` and `PART` messages being received from the server).
///
/// Note that any combination of `true` and `false` is possible here.
///
/// For example, `(true, false)` could indicate that the `JOIN` message to join this channel is currently
/// being sent or already sent, but no response confirming the `JOIN` has been received yet.
/// **Note this status can also mean that the server did not answer the `JOIN` request because
/// the channel did not exist/was suspended or similar conditions.**
///
/// `(false, true)` might on the other hand (similarly) that a `PART` message is sent but not
/// answered yet by the server.
///
/// `(true, true)` confirms that the channel is currently successfully joined in a normal fashion.
///
/// `(false, false)` is returned for a channel that has not been joined previously at all
/// or where a previous `PART` command has completed.
pub async fn get_channel_status(&self, channel_login: String) -> (bool, bool) {
// channel_login format sanity check not really needed here, the code will deal with arbitrary strings just fine
let (return_tx, return_rx) = oneshot::channel();
self.client_loop_tx
.send(ClientLoopCommand::GetChannelStatus {
channel_login,
return_sender: return_tx,
})
.unwrap();
// unwrap: ClientLoopWorker should not die before all sender handles have been dropped
return_rx.await.unwrap()
}
/// Part (leave) a channel, to stop receiving messages sent to that channel.
///
/// This has the same semantics as `join()`. Similarly, a `part()` call will have no effect
/// if the channel is not currently joined.
pub fn part(&self, channel_login: String) {
// channel_login format sanity check not really needed here, the code will deal with arbitrary strings just fine
self.client_loop_tx
.send(ClientLoopCommand::Part { channel_login })
.unwrap();
}
/// Ping a random connection. This does not await the `PONG` response from Twitch.
/// The future resolves once the `PING` command is sent to the wire.
/// An error is returned in case the message could not be sent over the picked connection.
pub async fn ping(&self) -> Result<(), Error<T, L>> {
let (return_tx, return_rx) = oneshot::channel();
self.client_loop_tx
.send(ClientLoopCommand::Ping {
return_sender: return_tx,
})
.unwrap();
// unwrap: ClientLoopWorker should not die before all sender handles have been dropped
return_rx.await.unwrap()
}
}