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
#![cfg_attr(doc_cfg, feature(doc_cfg))]
use err_derive::Error;
use packet::{Packet, PacketType};
use std::fmt::{self, Debug, Formatter};
use std::future::Future;
use std::io;
use std::marker::PhantomData;
use std::pin::Pin;
use std::sync::Arc;
use std::time::Duration;
use tokio::io::{AsyncRead, AsyncWrite};
#[cfg(feature = "rt-async-std")]
mod rt_async_std;
#[cfg(feature = "rt-async-std")]
pub use rt_async_std::AsyncStdStream;
#[cfg(feature = "rt-tokio")]
mod rt_tokio;
mod packet;
const INITIAL_PACKET_ID: i32 = 1;
const DELAY_TIME_MILLIS: u64 = 3;
const MINECRAFT_MAX_PAYLOAD_SIZE: usize = 1413;
#[derive(Debug, Error)]
pub enum Error {
#[error(display = "authentication failed")]
Auth,
#[error(display = "command exceeds the maximum length")]
CommandTooLong,
#[error(display = "{}", _0)]
Io(#[error(source)] io::Error),
}
pub type Result<T> = std::result::Result<T, Error>;
pub struct Connection<T> {
io: T,
next_packet_id: i32,
minecraft_quirks_enabled: bool,
factorio_quirks_enabled: bool,
sleep_fn: SleepFn,
}
impl<T: AsyncRead + AsyncWrite + Unpin> Connection<T> {
pub fn builder() -> Builder<T> {
Builder::new()
}
#[cfg(any(feature = "rt-tokio", feature = "rt-async-std"))]
#[cfg_attr(doc_cfg, doc(cfg(any(feature = "rt-tokio", feature = "rt-async-std"))))]
pub async fn handshake(io: T, password: &str) -> Result<Self> {
Self::builder()
.enable_minecraft_quirks(true)
.handshake(io, password)
.await
}
pub async fn cmd(&mut self, cmd: &str) -> Result<String> {
if self.minecraft_quirks_enabled && cmd.len() > MINECRAFT_MAX_PAYLOAD_SIZE {
return Err(Error::CommandTooLong);
}
self.send(PacketType::ExecCommand, cmd).await?;
if self.minecraft_quirks_enabled {
self.sleep_fn
.call(Duration::from_millis(DELAY_TIME_MILLIS))
.await;
}
let response = self.receive_response().await?;
Ok(response)
}
async fn receive_response(&mut self) -> Result<String> {
if self.factorio_quirks_enabled {
self.receive_single_packet_response().await
} else {
self.receive_multi_packet_response().await
}
}
async fn receive_single_packet_response(&mut self) -> Result<String> {
let received_packet = self.receive_packet().await?;
Ok(received_packet.get_body().into())
}
async fn receive_multi_packet_response(&mut self) -> Result<String> {
let end_id = self.send(PacketType::ExecCommand, "").await?;
let mut result = String::new();
loop {
let received_packet = self.receive_packet().await?;
if received_packet.get_id() == end_id {
return Ok(result);
}
result += received_packet.get_body();
}
}
async fn auth(&mut self, password: &str) -> Result<()> {
self.send(PacketType::Auth, password).await?;
let received_packet = loop {
let received_packet = self.receive_packet().await?;
if received_packet.get_type() == PacketType::AuthResponse {
break received_packet;
}
};
if received_packet.is_error() {
Err(Error::Auth)
} else {
Ok(())
}
}
async fn send(&mut self, ptype: PacketType, body: &str) -> io::Result<i32> {
let id = self.generate_packet_id();
let packet = Packet::new(id, ptype, body.into());
packet.serialize(&mut self.io).await?;
Ok(id)
}
async fn receive_packet(&mut self) -> io::Result<Packet> {
Packet::deserialize(&mut self.io).await
}
fn generate_packet_id(&mut self) -> i32 {
let id = self.next_packet_id;
self.next_packet_id = self
.next_packet_id
.checked_add(1)
.unwrap_or(INITIAL_PACKET_ID);
id
}
}
#[derive(Clone)]
enum SleepFn {
#[cfg(feature = "rt-tokio")]
Tokio,
#[cfg(feature = "rt-async-std")]
AsyncStd,
#[cfg(not(any(feature = "rt-tokio", feature = "rt-async-std")))]
None,
Custom(CustomSleepFn),
}
impl Debug for SleepFn {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match self {
#[cfg(feature = "rt-tokio")]
Self::Tokio => f.write_str("tokio::time::sleep"),
#[cfg(feature = "rt-async-std")]
Self::AsyncStd => f.write_str("async_std::task::sleep"),
#[cfg(not(any(feature = "rt-tokio", feature = "rt-async-std")))]
Self::None => f.write_str("None"),
Self::Custom(_) => f.write_str("custom sleep function"),
}
}
}
type CustomSleepFn =
Arc<dyn Fn(Duration) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>;
impl SleepFn {
async fn call(&mut self, duration: Duration) {
match self {
#[cfg(feature = "rt-tokio")]
Self::Tokio => tokio::time::sleep(duration).await,
#[cfg(feature = "rt-async-std")]
Self::AsyncStd => async_std::task::sleep(duration).await,
#[cfg(not(any(feature = "rt-tokio", feature = "rt-async-std")))]
Self::None => unreachable!(),
Self::Custom(f) => f(duration).await,
}
}
}
#[derive(Debug)]
pub struct Builder<T> {
minecraft_quirks_enabled: bool,
factorio_quirks_enabled: bool,
sleep_fn: SleepFn,
_io: PhantomData<fn() -> T>,
}
impl<T> Default for Builder<T> {
fn default() -> Self {
#[cfg(feature = "rt-tokio")]
let sleep_fn = SleepFn::Tokio;
#[cfg(all(feature = "rt-async-std", not(feature = "rt-tokio")))]
let sleep_fn = SleepFn::AsyncStd;
#[cfg(not(any(feature = "rt-async-std", feature = "rt-tokio")))]
let sleep_fn = SleepFn::None;
Self {
minecraft_quirks_enabled: false,
factorio_quirks_enabled: false,
sleep_fn,
_io: PhantomData,
}
}
}
impl<T> Clone for Builder<T> {
fn clone(&self) -> Self {
Self {
minecraft_quirks_enabled: self.minecraft_quirks_enabled,
factorio_quirks_enabled: self.factorio_quirks_enabled,
sleep_fn: self.sleep_fn.clone(),
_io: PhantomData,
}
}
}
impl<T> Builder<T> {
pub fn new() -> Self {
Self::default()
}
pub fn enable_minecraft_quirks(mut self, value: bool) -> Self {
self.minecraft_quirks_enabled = value;
self
}
pub fn enable_factorio_quirks(mut self, value: bool) -> Self {
self.factorio_quirks_enabled = value;
self
}
pub fn sleep_fn<F, Fut>(mut self, f: F) -> Self
where
F: Fn(Duration) -> Fut + Send + Sync + 'static,
Fut: Future<Output = ()> + Send + 'static,
{
self.sleep_fn = SleepFn::Custom(Arc::new(move |duration| Box::pin(f(duration))));
self
}
pub async fn handshake(self, io: T, password: &str) -> Result<Connection<T>>
where
T: AsyncRead + AsyncWrite + Unpin,
{
#[cfg(not(any(feature = "rt-tokio", feature = "rt-async-std")))]
if self.minecraft_quirks_enabled && matches!(self.sleep_fn, SleepFn::None) {
panic!(
"\
Minecraft quirks mode is enabled, but no runtime or custom sleep function has been \
set. Enable one of the `rt-tokio` or `rt-async-std` feature flags, or set a custom \
sleep function with `rcon::Builder::sleep_fn`.\
"
);
}
let mut conn = Connection {
io,
next_packet_id: INITIAL_PACKET_ID,
minecraft_quirks_enabled: self.minecraft_quirks_enabled,
factorio_quirks_enabled: self.factorio_quirks_enabled,
sleep_fn: self.sleep_fn,
};
conn.auth(password).await?;
Ok(conn)
}
}