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 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
//! WebSocket protocol implementation based on [Tokio] runtime. For building //! WebSocket server or client. //! //! yarws = Yet Another Rust WebSocket library //! //! Tls (wss:// enpoints) are supported in connect (since version 0.2.0). //! //! Lib is passing all [autobahn] tests. Including those for compressed //! messages. Per message deflate is implemented for incoming messages. Lib can //! receive compressed messages. Currently all outgoing messages are sent //! uncompressed. //! //! //! # Examples //! //! ## Server: //! ``` //! # use yarws::{Server, Error}; //! # async fn server() -> Result<(), Error> { //! let addr = "127.0.0.1:9001"; //! let mut listener = Server::new(addr).bind().await?; //! while let Some(mut socket) = listener.accept().await { //! tokio::spawn(async move { //! while let Some(msg) = socket.recv().await { //! socket.send(msg).await.unwrap(); //! } //! }); //! }; //! # Ok(()) //! # } //! ``` //! This is an example of echo server. We are replying with the same message on //! each incoming message. //! Second line starts listening for WebSocket connections on an ip:port. //! Each client is represented by [`Socket`] returned from [`accept`]. //! For each client we are looping while messages arrive and replying with the //! same message. //! For the complete echo server example please take a look at //! [examples/echo_server.rs]. //! //! ## Client: //! ``` //! # use yarws::{Client, Error}; //! # async fn client() -> Result<(), Error> { //! let url = "ws://127.0.0.1:9001"; //! let mut socket = Client::new(url).connect().await?; //! while let Some(msg) = socket.recv().await { //! socket.send(msg).await?; //! } //! # Ok(()) //! # } //! ``` //! This is example of an echo client. //! [`connect`] method returns [`Socket`] which is used to send and receive //! messages. //! Looping on recv returns each incoming message until socket is closed. //! Here in loop we reply with the same message. //! For the complete client example refer to [examples/client.rs]. //! //! //! //! # Testing //! Run client with external echo server. //! ```shell //! cargo run --example client -- ws://echo.websocket.org //! ``` //! Client will send few messages of different sizes and expect to get the same //! in return. //! If everything went fine will finish without error. //! //! To run same client on our server. First start server: //! ```shell //! cargo run --example echo_server //! ``` //! Then in other terminal run client: //! ```shell //! cargo run --example client //! ``` //! If it is in trace log mode server will log type and size of every message it //! receives. //! //! ## websocat test tool //! You can use [websocat] to connect to the server and test communication. //! First start server: //! ```shell //! cargo run --example echo_server //! ``` //! Then in other terminal run websocat: //! ```shell //! websocat -E --linemode-strip-newlines ws://127.0.0.1:9001 //! ``` //! Type you message press enter to send it and server will reply with the same //! message. //! For more exciting server run it in with reverse flag: //! ```shell //! cargo run --bin echo_server -- --reverse //! ``` //! and than use websocat to send text messages. //! //! # Autobahn tests //! Ensure that you have [wstest] autobahn-testsuite test tool installed: //! ```shell //! pip install autobahntestsuite //! ``` //! Start echo_server: //! ```shell //! cargo run --bin echo_server //! ``` //! In another terminal run server tests and view results: //! ```shell //! cd autobahn //! wstest -m fuzzingclient //! open reports/server/index.html //! ``` //! //! For testing client implementation first start autobahn server suite: //! ```shell //! wstest -m fuzzingserver //! ``` //! Then in another terminal run client tests and view results: //! ```shell //! cargo run --bin autobahn_client //! open autobahn/reports/client/index.html //! ``` //! For development purpose there is automation for running autobahn test suite //! and showing results: //! ```shell //! cargo run --bin autobahn_server_test //! ``` //! you can use run that in development on every file change with cargo-watch: //! ```shell //! cargo watch -x 'run --bin autobahn_server_test' //! ``` //! //! # Chat server example //! Simple example of server accepting text messages and distributing them to //! the all connected clients. //! First start chat server: //! ```shell //! cargo run --bin chat_server //! ``` //! Then in browser development console connect to the server and send chat //! messages: //! ```javascript //! var socket = new WebSocket('ws://127.0.0.1:9001'); //! var msgNo = 0; //! var interval; //! socket.addEventListener('open', function (event) { //! console.log('open'); //! socket.send("new client"); //! interval = setInterval(function() { //! msgNo++; //! socket.send("message: " + msgNo); //! }, 1000); //! }); //! socket.addEventListener('message', function (event) { //! console.log('chat', event.data); //! }); //! socket.addEventListener('close', function (event) { //! console.log('closed'); //! clearInterval(interval); //! }); //! ``` //! Start multiple browser tabs with the same code running. //! You can disconnect from the server with: `socket.close();`. //! //! # References //! [WebSocket Protocol] IETF RFC 6455 //! [MDN writing WebSocket servers] //! //! [WebSocket Protocol]: https://tools.ietf.org/html/rfc6455 //! [MDN writing WebSocket servers]: https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers //! //! [`Socket`]: struct.Socket.html //! [`accept`]: struct.Server.html#method.accept //! [examples/client.rs]: https://github.com/ianic/yarws/blob/master/examples/client.rs //! [examples/echo_server.rs]: https://github.com/ianic/yarws/blob/master/examples/echo_server.rs //! [websocat]: https://github.com/vi/websocat //! [wstest]: https://github.com/crossbario/autobahn-testsuite //! [autobahn]: https://github.com/crossbario/autobahn-testsuite //! [cargo-watch]: https://github.com/passcod/cargo-watch //! [Tokio]: https://tokio.rs use native_tls; use slog::Logger; use std::collections::HashMap; use std::str; use tokio; use tokio::io; use tokio::io::{AsyncRead, AsyncWrite}; use tokio::net::TcpListener; use tokio::net::TcpStream; use tokio::spawn; use tokio::stream::StreamExt; use tokio::sync::mpsc; use tokio::sync::mpsc::{Receiver, Sender}; use tokio_tls::TlsStream; #[macro_use] extern crate slog; #[macro_use] extern crate failure; #[cfg(test)] #[macro_use] extern crate hex_literal; mod http; pub mod log; mod stream; mod ws; use stream::Stream; /// Binds tcp listener to the provided addr (ip:port). pub async fn bind(addr: &str) -> Result<Listener, Error> { Ok(Server::new(addr).bind().await?) } /// Connects to the WebSocket server and on success returns `Socket`. pub async fn connect(url: &str) -> Result<Socket, Error> { Ok(Client::new(url).connect().await?) } async fn connect_tls(tcp_stream: TcpStream, url: &Url) -> Result<TlsStream<TcpStream>, Error> { let connector = native_tls::TlsConnector::new()?; let connector = tokio_tls::TlsConnector::from(connector); let stream = connector.connect(&url.domain, tcp_stream).await?; Ok(stream) } async fn connect_stream<T>( raw_stream: T, url: &Url, headers: Option<HashMap<String, String>>, log: Logger, ) -> Result<Socket, Error> where T: AsyncWrite + AsyncRead + std::marker::Send + 'static, { let stream = Stream::new(raw_stream); let (stream, deflate_supported) = http::connect(stream, &url, headers).await?; // upgrade tcp to ws let (rx, tx) = ws::start(stream, true, deflate_supported, log.clone()).await; // start ws return Ok(Socket { rx, tx, no: 1 }); } /// Creates WebSocket client side of the connection. /// /// Uses [builder] pattern for configuring client. /// Start with new set options and finish with connect. /// ``` /// # use yarws::{Client, Error}; /// # async fn client() -> Result<(), Error> { /// let url = "wss://echo.websocket.org"; /// let mut socket = Client::new(url) /// .default_logger() /// .cookie("session_id", "1266DE23-C5F4-4AA8-4684-2A417B899421") /// .header("Origin", "https://websocket.org") /// .connect() /// .await? /// .into_text(); /// # Ok(()) /// # } /// ``` /// [builder]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html pub struct Client { url: String, log: Logger, headers: HashMap<String, String>, cookies: HashMap<String, String>, } impl Client { pub fn new(url: &str) -> Self { Client { url: url.to_owned(), log: log::null(), headers: HashMap::new(), cookies: HashMap::new(), } } pub fn default_logger(mut self) -> Client { self.log = log::config(); self } pub fn logger(mut self, log: Logger) -> Client { self.log = log; self } pub fn header(mut self, key: &str, value: &str) -> Client { self.headers.insert(key.to_owned(), value.to_owned()); self } pub fn cookie(mut self, key: &str, value: &str) -> Client { self.cookies.insert(key.to_owned(), value.to_owned()); self } fn cookies_to_header(&mut self) { if self.cookies.len() == 0 { return; } let mut cookie = String::new(); for (key, value) in self.cookies.iter() { cookie.push_str(&key); cookie.push_str("="); cookie.push_str(&value); cookie.push_str("; "); } self.headers.insert("Cookie".to_owned(), cookie); } pub async fn connect(mut self) -> Result<Socket, Error> { self.cookies_to_header(); let url = parse_url(&self.url)?; let tcp_stream = TcpStream::connect(&url.addr).await?; // establish tcp connection if url.wss { let tls_stream = connect_tls(tcp_stream, &url).await?; // tcp -> tls return Ok(connect_stream(tls_stream, &url, Some(self.headers), self.log).await?); } Ok(connect_stream(tcp_stream, &url, Some(self.headers), self.log).await?) } } /// Represent a WebSocket connection. Used for sending and receiving messages. #[derive(Debug)] pub struct Socket { pub no: usize, tx: Sender<ws::Msg>, rx: Receiver<ws::Msg>, } impl Socket { /// Receives Msg from the other side of the Socket connection. /// None is returned if the socket is closed. /// /// # Examples /// /// Usually used in while loop: /// ``` /// # use yarws::{Client, Error}; /// # async fn client() -> Result<(), Error> { /// # let url = "ws://127.0.0.1:9001"; /// # let mut socket = Client::new(url).connect().await?; /// while let Some(msg) = socket.recv().await { /// // process msg /// } /// # Ok(()) /// # } /// ``` pub async fn recv(&mut self) -> Option<Msg> { Socket::recv_one(&mut self.rx, &mut self.tx, false).await } async fn recv_one(rx: &mut Receiver<ws::Msg>, tx: &mut Sender<ws::Msg>, text_only: bool) -> Option<Msg> { loop { match rx.recv().await { None => return None, // channel exhausted Some(ws_msg) => match ws_msg { ws::Msg::Text(text) => return Some(Msg::Text(text)), ws::Msg::Binary(payload) => { if text_only { // send close and return if let Err(_) = tx.send(ws::Msg::Close(0)).await {} return None; } return Some(Msg::Binary(payload)); } ws::Msg::Close(_) => { if let Err(_) = tx.send(ws_msg).await {} return None; } ws::Msg::Ping(payload) => { if let Err(_) = tx.send(ws::Msg::Pong(payload)).await { return None; } } ws::Msg::Pong(_) => (), }, } } } /// Sends Msg to the other side of the Socket connection. /// Errors if the socket is already closed. /// /// # Examples /// Echo example. /// Receive Msgs and replay with the same Msg. /// ``` /// # use yarws::{Socket, Error}; /// async fn echo(mut socket: Socket) -> Result<(), Error> { /// while let Some(msg) = socket.recv().await { /// socket.send(msg).await?; /// } /// Ok(()) /// } /// ``` pub async fn send(&mut self, msg: Msg) -> Result<(), Error> { self.tx.send(msg.into_ws_msg()).await?; Ok(()) } /// Transforms Socket into pair of mpsc channels for sending/receiving Msgs. /// /// In some cases it is more convenient to have channels instead of calling /// methods. Ownership of each side of the channel can be moved to the /// different function. pub async fn into_channel(self) -> (Sender<Msg>, Receiver<Msg>) { let (tx, mut i_rx): (Sender<Msg>, Receiver<Msg>) = mpsc::channel(1); let (mut i_tx, rx): (Sender<Msg>, Receiver<Msg>) = mpsc::channel(1); let mut ws_rx = self.rx; let mut ws_tx = self.tx.clone(); spawn(async move { while let Some(msg) = Socket::recv_one(&mut ws_rx, &mut ws_tx, false).await { if let Err(_) = i_tx.send(msg).await { break; } } }); let mut ws_tx = self.tx; spawn(async move { while let Some(msg) = i_rx.recv().await { if let Err(_) = ws_tx.send(msg.into_ws_msg()).await { break; } } }); (tx, rx) } /// Transforms Socket into TextSocket which is more convenient for handling /// text only messages. pub fn into_text(self) -> TextSocket { TextSocket { no: self.no, tx: self.tx, rx: self.rx, } } } /// Represent a WebSocket connection. Used for sending and receiving text only /// messages. /// /// Each incoming message is transformed into String. Eventual other types of /// the messages (binary) are ignored. pub struct TextSocket { pub no: usize, tx: Sender<ws::Msg>, rx: Receiver<ws::Msg>, } impl TextSocket { pub async fn send(&mut self, text: &str) -> Result<(), Error> { self.tx.send(ws::Msg::Text(text.to_owned())).await?; Ok(()) } /// Receives String from the other side of the Socket connection. /// None is returned if the socket is closed. pub async fn recv(&mut self) -> Option<String> { TextSocket::recv_one(&mut self.rx, &mut self.tx).await } /// Sends String to the other side of the Socket connection. /// Errors if the socket is already closed. pub async fn try_recv(&mut self) -> Result<String, Error> { match self.recv().await { None => Err(Error::SocketClosed), Some(v) => Ok(v), } } async fn recv_one(mut rx: &mut Receiver<ws::Msg>, mut tx: &mut Sender<ws::Msg>) -> Option<String> { match Socket::recv_one(&mut rx, &mut tx, true).await { Some(Msg::Text(text)) => return Some(text), _ => None, } } /// Transforms Socket into pair of mpsc channels for sending/receiving /// Strings. pub async fn into_channel(self) -> (Sender<String>, Receiver<String>) { let (tx, mut i_rx): (Sender<String>, Receiver<String>) = mpsc::channel(1); let (mut i_tx, rx): (Sender<String>, Receiver<String>) = mpsc::channel(1); let mut ws_rx = self.rx; let mut ws_tx = self.tx.clone(); spawn(async move { while let Some(text) = TextSocket::recv_one(&mut ws_rx, &mut ws_tx).await { if let Err(_) = i_tx.send(text).await { break; } } }); let mut ws_tx = self.tx; spawn(async move { while let Some(text) = i_rx.recv().await { if let Err(_) = ws_tx.send(ws::Msg::Text(text)).await { break; } } }); (tx, rx) } } /// Message exchanged between library and application. /// /// Can be text or binary. Text messages are valid UTF-8 strings. Binary of /// course can be anything. Web servers will typically send text messages. pub enum Msg { Text(String), Binary(Vec<u8>), } impl Msg { /// Converts to Msg used in `ws` module. fn into_ws_msg(self) -> ws::Msg { match self { Msg::Text(text) => ws::Msg::Text(text), Msg::Binary(vec) => ws::Msg::Binary(vec), } } } /// Creates server side of the WebSocket connection. /// /// Errors if binding can't be started. In most cases because port is /// already used, but other errors could occur also; too many open files, /// incorrect addr. /// /// # Examples /// ## create listener /// Uses [builder] pattern for setting options. /// Start with new set options and finish with bind. /// ``` /// # use yarws::{Server, Error, log}; /// # async fn client() -> Result<(), Error> { /// # let log = log::config(); /// let addr = "localhost:9001"; /// let mut listener = Server::new(addr) /// .logger(log) /// .bind() /// .await?; /// # Ok(()) /// # } /// ``` /// ## accept connections /// ``` /// # use yarws::{Server, Error}; /// # async fn server() -> Result<(), Error> { /// # let addr = "127.0.0.1:9001"; /// # let mut listener = Server::new(addr).bind().await?; /// while let Some(mut socket) = listener.accept().await { /// tokio::spawn(async move { /// // handle socket /// # while let Some(msg) = socket.recv().await { /// # socket.send(msg).await.unwrap(); /// # } /// }); /// }; /// # Ok(()) /// # } /// ``` /// [builder]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html pub struct Server { addr: String, log: Logger, } impl Server { pub fn new(addr: &str) -> Self { Server { addr: addr.to_owned(), log: log::null(), } } pub fn default_logger(mut self) -> Server { self.log = log::config(); self } pub fn logger(mut self, log: Logger) -> Server { self.log = log; self } pub async fn bind(self) -> Result<Listener, Error> { let listener = TcpListener::bind(self.addr).await?; Ok(Listener::new(listener, self.log).await) } } /// Accepts WebSocket connections, creates [`Socket`] for each. /// /// [`Socket`]: struct.Socket.html pub struct Listener { rx: Receiver<Socket>, } impl Listener { async fn new(listener: TcpListener, log: Logger) -> Self { Listener { rx: Listener::listen(listener, log).await, } } /// Returns `Socket` for successfully established WebSocket connection. /// Loop over this method to handle all incoming connections. /// # Examples /// ``` /// # use yarws::{Server, Error}; /// # async fn server() -> Result<(), Error> { /// # let addr = "127.0.0.1:9001"; /// # let mut listener = Server::new(addr).bind().await?; /// while let Some(mut socket) = listener.accept().await { /// # tokio::spawn(async move { /// # while let Some(msg) = socket.recv().await { /// # socket.send(msg).await.unwrap(); /// # } /// # }); /// }; /// # Ok(()) /// # } pub async fn accept(&mut self) -> Option<Socket> { self.rx.recv().await } // Listens for incoming tcp connections. Upgrades them to WebSocket and // feeds socket_tx channel with Socket for each established connection. async fn listen(mut listener: TcpListener, log: Logger) -> Receiver<Socket> { let (socket_tx, socket_rx): (Sender<Socket>, Receiver<Socket>) = mpsc::channel(1); spawn(async move { let mut conn_no = 0; let mut incoming = listener.incoming(); while let Some(conn) = incoming.next().await { match conn { Ok(stream) => { conn_no += 1; let log = log.new(o!("conn" => conn_no)); spawn_accept(stream, socket_tx.clone(), conn_no, log).await; } Err(e) => error!(log, "accept error: {}", e), } } }); socket_rx } } async fn spawn_accept(stream: TcpStream, socket_tx: Sender<Socket>, no: usize, log: Logger) { spawn(async move { if let Err(e) = accept(stream, socket_tx, no, log.clone()).await { error!(log, "{}", e); } }); } // Upgrades tcp connection to the WebSocket, starts ws handler and returns new // Socket through socket_tx channel. async fn accept(tcp_stream: TcpStream, mut socket_tx: Sender<Socket>, no: usize, log: Logger) -> Result<(), Error> { let stream = Stream::new(tcp_stream); let (stream, deflate_supported) = http::accept(stream).await?; let (rx, tx) = ws::start(stream, false, deflate_supported, log).await; let socket = Socket { no, tx, rx }; socket_tx.send(socket).await?; Ok(()) } #[derive(Fail, Debug)] /// Definition of all errors returned from the library. pub enum Error { #[fail(display = "invalid upgrade request")] InvalidUpgradeRequest, #[fail(display = "IO error: {}", error)] IoError { error: io::Error }, #[fail(display = "fail to send Msg: {}", error)] MsgSendError { error: mpsc::error::SendError<ws::Msg> }, #[fail(display = "fail to send bytes: {}", error)] RawSendError { error: mpsc::error::SendError<Vec<u8>> }, #[fail(display = "fail to send socket: {}", error)] SocketSendError { error: mpsc::error::SendError<Socket> }, #[fail(display = "wrong header: {}", _0)] WrongHeader(String), #[fail(display = "inflate failed: {}", _0)] InflateFailed(String), #[fail(display = "text payload not a valid utf-8 string: {}", _0)] TextPayloadNotValidUTF8(std::str::Utf8Error), #[fail(display = "failed to parse url: {} error: {}", url, error)] UrlParseError { url: String, error: url::ParseError }, #[fail(display = "socket closed")] SocketClosed, #[fail(display = "tls error: {}", error)] TlsError { error: native_tls::Error }, } impl From<io::Error> for Error { fn from(e: io::Error) -> Self { Error::IoError { error: e } } } impl From<mpsc::error::SendError<ws::Msg>> for Error { fn from(e: mpsc::error::SendError<ws::Msg>) -> Self { Error::MsgSendError { error: e } } } impl From<mpsc::error::SendError<Vec<u8>>> for Error { fn from(e: mpsc::error::SendError<Vec<u8>>) -> Self { Error::RawSendError { error: e } } } impl From<mpsc::error::SendError<Socket>> for Error { fn from(e: mpsc::error::SendError<Socket>) -> Self { Error::SocketSendError { error: e } } } impl From<std::str::Utf8Error> for Error { fn from(e: std::str::Utf8Error) -> Self { Error::TextPayloadNotValidUTF8(e) } } impl From<native_tls::Error> for Error { fn from(e: native_tls::Error) -> Self { Error::TlsError { error: e } } } #[doc(hidden)] pub struct Url { addr: String, path: String, domain: String, wss: bool, } fn parse_url(u: &str) -> Result<Url, Error> { let url = match match url::Url::parse(u) { Err(url::ParseError::RelativeUrlWithoutBase) => { let url = "ws://".to_owned() + u; url::Url::parse(&url) } other => other, } { Err(e) => Err(Error::UrlParseError { url: u.to_owned(), error: e, }), Ok(v) => Ok(v), }?; let host = url.host_str().unwrap_or(""); let addr = format!("{}:{}", host, url.port_or_known_default().unwrap_or(0)); let path = match url.query() { Some(q) => format!("{}?{}", url.path(), q), None => url.path().to_owned(), }; let wss = url.scheme() == "wss"; let u = Url { wss: wss, addr: addr, path: path, domain: host.to_owned(), }; Ok(u) } #[cfg(test)] mod tests { use super::*; #[test] fn test_parse_url() { let url = parse_url("ws://localhost:9001/path?pero=zdero").unwrap(); assert_eq!("localhost:9001", url.addr); assert_eq!("/path?pero=zdero", url.path); assert!(!url.wss); let url = parse_url("ws://localhost:9001/path").unwrap(); assert_eq!("localhost:9001", url.addr); assert_eq!("/path", url.path); assert!(!url.wss); let url = parse_url("ws://localhost/path").unwrap(); assert_eq!("localhost:80", url.addr); assert_eq!("/path", url.path); assert!(!url.wss); let url = parse_url("localhost/path").unwrap(); assert_eq!("localhost:80", url.addr); assert_eq!("/path", url.path); assert!(!url.wss); let url = parse_url("pero://localhost/path").unwrap(); assert_eq!("localhost:0", url.addr); assert_eq!("/path", url.path); assert!(!url.wss); let url = parse_url("wss://localhost:9001/path").unwrap(); assert_eq!("localhost:9001", url.addr); assert_eq!("/path", url.path); assert!(url.wss); let url = parse_url("wss://echo.websocket.org/path").unwrap(); assert_eq!("echo.websocket.org:443", url.addr); assert_eq!("echo.websocket.org", url.domain); assert_eq!("/path", url.path); assert!(url.wss); } }