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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
//! rust websocket toolkit

#![warn(missing_docs)]
#![cfg_attr(docrs, feature(doc_auto_cfg))]

use std::collections::HashMap;

/// websocket error definitions
pub mod errors;
/// websocket transport unit
pub mod frame;
/// build connection & read/write frame utils
pub mod protocol;

/// frame codec impl
pub mod codec;
/// connection helper function
pub mod connector;

/// helper message definition
mod message;
pub use message::*;
#[cfg(feature = "simple")]
/// simple api to create websocket connection
pub mod simple;
#[cfg(feature = "simple")]
pub use simple::ClientConfig;

/// helper stream definition
pub mod stream;

/// some helper extension
pub mod extension;

/// helper builder to construct websocket client
#[derive(Debug, Clone)]
pub struct ClientBuilder {
    protocols: Vec<String>,
    extensions: Vec<String>,
    #[cfg_attr(not(any(feature = "sync", feature = "async")), allow(dead_code))]
    version: u8,
    headers: HashMap<String, String>,
}

impl Default for ClientBuilder {
    fn default() -> Self {
        Self {
            protocols: vec![],
            extensions: vec![],
            headers: HashMap::new(),
            version: 13,
        }
    }
}

impl ClientBuilder {
    /// create builder with websocket url
    pub fn new() -> Self {
        Default::default()
    }

    /// add protocols
    pub fn protocol(mut self, protocol: String) -> Self {
        self.protocols.push(protocol);
        self
    }

    /// set extension in handshake http header
    ///
    /// **NOTE** it will clear protocols set by `protocol` method
    pub fn protocols(self, protocols: Vec<String>) -> Self {
        Self { protocols, ..self }
    }

    /// add protocols
    pub fn extension(mut self, extension: String) -> Self {
        self.extensions.push(extension);
        self
    }

    /// set extension in handshake http header
    ///
    /// **NOTE** it will clear protocols set by `protocol` method
    pub fn extensions(self, extensions: Vec<String>) -> Self {
        Self { extensions, ..self }
    }

    /// set websocket version, default 13
    pub fn version(self, version: u8) -> Self {
        Self { version, ..self }
    }

    /// add initial request header
    pub fn header<K: ToString, V: ToString>(mut self, name: K, value: V) -> Self {
        self.headers.insert(name.to_string(), value.to_string());
        self
    }

    /// set initial request headers
    ///
    /// **NOTE** it will clear header set by previous `header` method
    pub fn headers(self, headers: HashMap<String, String>) -> Self {
        Self { headers, ..self }
    }
}

#[cfg(feature = "sync")]
mod blocking {
    use std::{
        io::{Read, Write},
        net::TcpStream,
    };

    use crate::{
        connector::{get_scheme, tcp_connect},
        errors::WsError,
        protocol::{handle_handshake, req_handshake},
        ClientBuilder, ServerBuilder,
    };

    impl ClientBuilder {
        /// perform protocol handshake & check server response
        pub fn connect<C, F>(&self, uri: http::Uri, check_fn: F) -> Result<C, WsError>
        where
            F: FnMut(String, http::Response<()>, TcpStream) -> Result<C, WsError>,
        {
            let mode = get_scheme(&uri)?;
            if matches!(mode, crate::protocol::Mode::WSS) {
                panic!("can not perform ssl connection, use `rustls_connect` or `native_tls_connect` instead");
            }
            let stream = tcp_connect(&uri)?;
            self.with_stream(uri, stream, check_fn)
        }

        #[cfg(feature = "sync_tls_rustls")]
        /// perform protocol handshake via ssl with default certs & check server response
        pub fn rustls_connect<C, F>(&self, uri: http::Uri, check_fn: F) -> Result<C, WsError>
        where
            F: FnMut(
                String,
                http::Response<()>,
                rustls_connector::rustls::StreamOwned<
                    rustls_connector::rustls::ClientConnection,
                    TcpStream,
                >,
            ) -> Result<C, WsError>,
        {
            use crate::connector::{get_host, wrap_rustls};
            let mode = get_scheme(&uri)?;
            if matches!(mode, crate::protocol::Mode::WSS) {
                panic!("can not perform not ssl connection, use `connect` instead");
            }
            let stream = tcp_connect(&uri)?;
            let stream = wrap_rustls(stream, get_host(&uri)?, vec![])?;
            self.with_stream(uri, stream, check_fn)
        }

        #[cfg(feature = "sync_tls_native")]
        /// perform protocol handshake via ssl with default certs & check server response
        pub fn native_tls_connect<C, F>(&self, uri: http::Uri, check_fn: F) -> Result<C, WsError>
        where
            F: FnMut(
                String,
                http::Response<()>,
                native_tls::TlsStream<TcpStream>,
            ) -> Result<C, WsError>,
        {
            use crate::connector::{get_host, wrap_native_tls};
            let mode = get_scheme(&uri)?;
            if matches!(mode, crate::protocol::Mode::WSS) {
                panic!("can not perform not ssl connection, use `connect` instead");
            }
            let stream = tcp_connect(&uri)?;
            let stream = wrap_native_tls(stream, get_host(&uri)?, vec![])?;
            self.with_stream(uri, stream, check_fn)
        }

        /// ## Low level api
        /// perform protocol handshake & check server response
        pub fn with_stream<C, F, S>(
            &self,
            uri: http::Uri,
            mut stream: S,
            mut check_fn: F,
        ) -> Result<C, WsError>
        where
            S: Read + Write,
            F: FnMut(String, http::Response<()>, S) -> Result<C, WsError>,
        {
            get_scheme(&uri)?;
            let (key, resp) = req_handshake(
                &mut stream,
                &uri,
                &self.protocols,
                &self.extensions,
                self.version,
                self.headers.clone(),
            )?;
            check_fn(key, resp, stream)
        }
    }

    impl ServerBuilder {
        /// wait for protocol handshake from client
        /// checking handshake & construct server
        pub fn accept<F1, F2, T, C, S>(
            mut stream: S,
            mut handshake_handler: F1,
            mut codec_factory: F2,
        ) -> Result<C, WsError>
        where
            S: Read + Write,
            F1: FnMut(
                http::Request<()>,
            ) -> Result<
                (http::Request<()>, http::Response<T>),
                (http::Response<T>, WsError),
            >,
            F2: FnMut(http::Request<()>, S) -> Result<C, WsError>,
            T: ToString + std::fmt::Debug,
        {
            let req = handle_handshake(&mut stream)?;
            match handshake_handler(req) {
                Err((resp, e)) => {
                    write_resp(resp, &mut stream)?;
                    return Err(e);
                }
                Ok((req, resp)) => {
                    write_resp(resp, &mut stream)?;
                    codec_factory(req, stream)
                }
            }
        }
    }

    fn write_resp<S, T>(resp: http::Response<T>, stream: &mut S) -> Result<(), WsError>
    where
        S: Read + Write,
        T: ToString + std::fmt::Debug,
    {
        let mut resp_lines = vec![format!("{:?} {}", resp.version(), resp.status())];
        resp.headers().iter().for_each(|(k, v)| {
            resp_lines.push(format!("{}: {}", k, v.to_str().unwrap_or_default()))
        });
        resp_lines.push("\r\n".to_string());
        stream.write_all(resp_lines.join("\r\n").as_bytes())?;
        tracing::debug!("{:?}", &resp);
        Ok(if resp.status() != http::StatusCode::SWITCHING_PROTOCOLS {
            return Err(WsError::HandShakeFailed(resp.body().to_string()));
        })
    }
}

#[cfg(feature = "async")]
mod non_blocking {
    use http;
    use std::fmt::Debug;

    use tokio::{
        io::{AsyncRead, AsyncWrite, AsyncWriteExt},
        net::TcpStream,
    };

    use crate::{
        connector::async_tcp_connect,
        errors::WsError,
        protocol::{async_handle_handshake, async_req_handshake},
        ServerBuilder,
    };

    use super::ClientBuilder;

    impl ClientBuilder {
        /// perform protocol handshake & check server response
        pub async fn async_connect<C, F>(&self, uri: http::Uri, check_fn: F) -> Result<C, WsError>
        where
            F: FnMut(String, http::Response<()>, TcpStream) -> Result<C, WsError>,
        {
            let stream = async_tcp_connect(&uri).await?;
            self.async_with_stream(uri, stream, check_fn).await
        }

        #[cfg(feature = "async_tls_rustls")]
        /// perform protocol handshake via ssl with default certs & check server response
        pub async fn async_rustls_connect<C, F>(
            &self,
            uri: http::Uri,
            check_fn: F,
        ) -> Result<C, WsError>
        where
            F: FnMut(
                String,
                http::Response<()>,
                tokio_rustls::client::TlsStream<tokio::net::TcpStream>,
            ) -> Result<C, WsError>,
        {
            use crate::connector::{async_wrap_rustls, get_host};
            let mode = crate::connector::get_scheme(&uri)?;
            if matches!(mode, crate::protocol::Mode::WSS) {
                panic!("can not perform not ssl connection, use `connect` instead");
            }
            let stream = async_tcp_connect(&uri).await?;
            let stream = async_wrap_rustls(stream, get_host(&uri)?, vec![]).await?;
            self.async_with_stream(uri, stream, check_fn).await
        }

        #[cfg(feature = "async_tls_native")]
        /// perform protocol handshake via ssl with default certs & check server response
        pub async fn async_native_tls_connect<C, F>(
            &self,
            uri: http::Uri,
            check_fn: F,
        ) -> Result<C, WsError>
        where
            F: FnMut(
                String,
                http::Response<()>,
                tokio_native_tls::TlsStream<TcpStream>,
            ) -> Result<C, WsError>,
        {
            use crate::connector::{async_wrap_native_tls, get_host};
            let mode = crate::connector::get_scheme(&uri)?;
            if matches!(mode, crate::protocol::Mode::WSS) {
                panic!("can not perform not ssl connection, use `connect` instead");
            }
            let stream = async_tcp_connect(&uri).await?;
            let stream = async_wrap_native_tls(stream, get_host(&uri)?, vec![]).await?;
            self.async_with_stream(uri, stream, check_fn).await
        }

        /// async version of connect
        ///
        /// perform protocol handshake & check server response
        pub async fn async_with_stream<C, F, S>(
            &self,
            uri: http::Uri,
            mut stream: S,
            mut check_fn: F,
        ) -> Result<C, WsError>
        where
            S: AsyncRead + AsyncWrite + Unpin,
            F: FnMut(String, http::Response<()>, S) -> Result<C, WsError>,
        {
            let (key, resp) = async_req_handshake(
                &mut stream,
                &uri,
                &self.protocols,
                &self.extensions,
                self.version,
                self.headers.clone(),
            )
            .await?;
            check_fn(key, resp, stream)
        }
    }

    impl ServerBuilder {
        /// async version
        ///
        /// wait for protocol handshake from client
        /// checking handshake & construct server
        pub async fn async_accept<F1, F2, T, C, S>(
            mut stream: S,
            mut handshake_handler: F1,
            mut codec_factory: F2,
        ) -> Result<C, WsError>
        where
            S: AsyncRead + AsyncWrite + Unpin,
            F1: FnMut(
                http::Request<()>,
            ) -> Result<
                (http::Request<()>, http::Response<T>),
                (http::Response<T>, WsError),
            >,
            F2: FnMut(http::Request<()>, S) -> Result<C, WsError>,
            T: ToString + Debug,
        {
            let req = async_handle_handshake(&mut stream).await?;
            match handshake_handler(req) {
                Ok((req, resp)) => {
                    async_write_resp(resp, &mut stream).await?;
                    codec_factory(req, stream)
                }
                Err((resp, e)) => {
                    async_write_resp(resp, &mut stream).await?;
                    return Err(e);
                }
            }
        }
    }

    async fn async_write_resp<S, T>(resp: http::Response<T>, stream: &mut S) -> Result<(), WsError>
    where
        S: AsyncRead + AsyncWrite + Unpin,
        T: ToString + Debug,
    {
        let mut resp_lines = vec![format!("{:?} {}", resp.version(), resp.status())];
        resp.headers().iter().for_each(|(k, v)| {
            resp_lines.push(format!("{}: {}", k, v.to_str().unwrap_or_default()))
        });
        resp_lines.push("\r\n".to_string());
        stream.write_all(resp_lines.join("\r\n").as_bytes()).await?;
        tracing::debug!("{:?}", &resp);
        Ok(if resp.status() != http::StatusCode::SWITCHING_PROTOCOLS {
            return Err(WsError::HandShakeFailed(resp.body().to_string()));
        })
    }
}

/// helper struct to config & construct websocket server
pub struct ServerBuilder {}