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
// Buttplug Client Websocket Connector
//
// The big thing to understand here is that we'll only ever need one connection.
// Just one. No more, no less. So there's no real reason to futz with trying to
// get async clients going here other than to lose us a thread, which means we
// shouldn't really need to wait for any network library to update to futures
// 0.3. For now, we can:
//
// - Create a futures channel, retain the receiver in the main thread.
// - Create a ws channel, retain a sender in the main thread
// - Create a thread (for the ws), hand it a sender from the futures channel
// - In ws thread, spin up the connection, waiting on success response in
//   our main thread as a future.
// - Continue on our way with the two channels, happy to know we don't have to
//   wait for networking libraries to get on our futures 0.3 level.

use super::{
  ButtplugClientConnectionFuture,
  ButtplugClientConnectionStateShared,
  ButtplugClientConnector,
  ButtplugClientConnectorError,
  ButtplugRemoteClientConnectorHelper,
  ButtplugRemoteClientConnectorMessage,
  ButtplugRemoteClientConnectorSender,
};
use crate::{
  core::messages::{ButtplugClientInMessage, ButtplugClientOutMessage, ButtplugMessage},
  util::future::ButtplugMessageStateShared,
};
use async_std::{
  sync::{channel, Receiver, Sender},
  task,
};
use async_trait::async_trait;
#[cfg(feature = "client-ws-ssl")]
use openssl::ssl::{SslConnector, SslMethod, SslStream, SslVerifyMode};
use std::thread;
#[cfg(feature = "client-ws-ssl")]
use url::Url;
#[cfg(feature = "client-ws-ssl")]
use ws::util::TcpStream;
use ws::{CloseCode, Handler, Handshake, Message};

struct InternalClient {
  connector_waker: ButtplugClientConnectionStateShared,
  buttplug_out: Sender<ButtplugRemoteClientConnectorMessage>,
  #[allow(dead_code)]
  bypass_cert_verify: bool,
}

impl Handler for InternalClient {
  fn on_open(&mut self, _: Handshake) -> ws::Result<()> {
    info!("Opened websocket");
    self.connector_waker.lock().unwrap().set_reply(Ok(()));
    Ok(())
  }

  fn on_message(&mut self, msg: Message) -> ws::Result<()> {
    info!("Got message: {}", msg);
    let out = self.buttplug_out.clone();
    task::spawn(async move {
      out
        .send(ButtplugRemoteClientConnectorMessage::Text(msg.to_string()))
        .await;
    });
    ws::Result::Ok(())
  }

  fn on_close(&mut self, _code: CloseCode, _reason: &str) {
    info!("Websocket closed : {}", _reason);
    let out = self.buttplug_out.clone();
    // One rather horrible way to get a copy of the reason to pass along.
    let r = (&(*_reason).to_owned()).clone();
    task::spawn(async move {
      out
        .send(ButtplugRemoteClientConnectorMessage::Close(r))
        .await;
    });
  }

  fn on_error(&mut self, err: ws::Error) {
    info!("The server encountered an error: {:?}", err);
    self
      .connector_waker
      .lock()
      .unwrap()
      .set_reply(Err(ButtplugClientConnectorError::new(
        &(format!("{}", err)),
      )));
  }

  #[cfg(feature = "client-ws-ssl")]
  fn upgrade_ssl_client(&mut self, sock: TcpStream, _: &Url) -> ws::Result<SslStream<TcpStream>> {
    let mut builder = SslConnector::builder(SslMethod::tls()).map_err(|e| {
      ws::Error::new(
        ws::ErrorKind::Internal,
        format!("Failed to upgrade client to SSL: {}", e),
      )
    })?;

    if self.bypass_cert_verify {
      builder.set_verify(SslVerifyMode::empty());
    }

    let connector = builder.build();
    connector
      .configure()
      .unwrap()
      .use_server_name_indication(false)
      .verify_hostname(false)
      .connect("", sock)
      .map_err(From::from)
  }
}

pub struct ButtplugWebsocketClientConnector {
  helper: ButtplugRemoteClientConnectorHelper,
  ws_thread: Option<thread::JoinHandle<()>>,
  recv: Option<Receiver<ButtplugClientOutMessage>>,
  address: String,
  bypass_cert_verify: bool,
}

impl ButtplugWebsocketClientConnector {
  pub fn new(address: &str, bypass_cert_verify: bool) -> Self {
    let (send, recv) = channel(256);
    ButtplugWebsocketClientConnector {
      helper: ButtplugRemoteClientConnectorHelper::new(send),
      ws_thread: None,
      recv: Some(recv),
      address: address.to_owned(),
      bypass_cert_verify,
    }
  }
}

pub struct ButtplugWebsocketWrappedSender {
  sender: ws::Sender,
}

unsafe impl Send for ButtplugWebsocketWrappedSender {
}
unsafe impl Sync for ButtplugWebsocketWrappedSender {
}

impl ButtplugWebsocketWrappedSender {
  pub fn new(send: ws::Sender) -> Self {
    Self { sender: send }
  }
}

impl ButtplugRemoteClientConnectorSender for ButtplugWebsocketWrappedSender {
  fn send(&self, msg: ButtplugClientInMessage) {
    let m = msg.as_protocol_json();
    debug!("Sending message: {}", m);
    match self.sender.send(m) {
      Ok(_) => {}
      Err(err) => error!("{}", err),
    }
  }

  fn close(&self) {
    match self.sender.close(CloseCode::Normal) {
      Ok(_) => {}
      Err(err) => error!("{}", err),
    }
  }
}

#[async_trait]
impl ButtplugClientConnector for ButtplugWebsocketClientConnector {
  async fn connect(&mut self) -> Result<(), ButtplugClientConnectorError> {
    let send = self.helper.get_remote_send();
    let fut = ButtplugClientConnectionFuture::default();
    let waker = fut.get_state_clone();
    let addr = self.address.clone();
    let verify = self.bypass_cert_verify;
    self.ws_thread = Some(thread::spawn(move || {
      let ret = ws::connect(addr, move |out| {
        let bp_out = send.clone();
        // Get our websocket sender back to the main thread
        task::spawn(async move {
          bp_out
            .send(ButtplugRemoteClientConnectorMessage::Sender(Box::new(
              ButtplugWebsocketWrappedSender::new(out.clone()),
            )))
            .await;
        });
        // Go ahead and create our internal client
        InternalClient {
          buttplug_out: send.clone(),
          connector_waker: waker.clone(),
          bypass_cert_verify: verify,
        }
      });
      match ret {
        Ok(_) => {}
        Err(err) => error!("{}", err),
      }
    }));

    let read_future = self.helper.get_recv_future();

    // TODO This should be part of the ButtplugClientInternalLoop
    task::spawn(async {
      read_future.await;
    });

    fut.await
  }

  async fn disconnect(&mut self) -> Result<(), ButtplugClientConnectorError> {
    self.helper.close().await;
    Ok(())
  }

  async fn send(&mut self, msg: ButtplugClientInMessage, state: &ButtplugMessageStateShared) {
    self.helper.send(&msg, state).await;
  }

  fn get_event_receiver(&mut self) -> Receiver<ButtplugClientOutMessage> {
    // This will panic if we've already taken the receiver.
    self.recv.take().unwrap()
  }
}

#[cfg(test)]
mod test {
  use super::ButtplugWebsocketClientConnector;
  use crate::client::connectors::ButtplugClientConnector;
  use async_std::task;
  use env_logger;

  // Only run these tests when we know there's an external server up to reply

  #[test]
  #[ignore]
  fn test_websocket() {
    let _ = env_logger::builder().is_test(true).try_init();
    task::block_on(async {
      assert!(
        ButtplugWebsocketClientConnector::new("ws://localhost:12345", false)
          .connect()
          .await
          .is_ok()
      );
    })
  }

  // #[test]
  // #[ignore]
  // fn test_client_websocket() {
  //     let _ = env_logger::builder().is_test(true).try_init();
  //     task::block_on(async {
  //         info!("connecting");
  //         assert!(ButtplugClient::run(
  //             "test client",
  //             ButtplugWebsocketClientConnector::new("ws://localhost:12345", false),
  //             |mut client| {
  //                 async move {
  //                     info!("connected");
  //                     assert!(client.start_scanning().await.is_ok());
  //                     info!("scanning!");
  //                     info!("starting event loop!");
  //                     while client.connected() {
  //                         info!("Waiting for event!");
  //                         match client.wait_for_event().await.unwrap() {
  //                             ButtplugClientEvent::DeviceAdded(ref mut d) => {
  //                                 info!("Got device! {}", d.name);
  //                                 if d.allowed_messages.contains_key("VibrateCmd") {
  //                                     assert!(d
  //                                         .vibrate(VibrateCommand::Speed(1.0))
  //                                         .await
  //                                         .is_ok());
  //                                     info!("Should be vibrating!");
  //                                     task::sleep(Duration::from_secs(1)).await;
  //                                     assert!(d.stop().await.is_ok());
  //                                     // assert!(client.disconnect().await.is_ok());
  //                                     task::sleep(Duration::from_secs(1)).await;
  //                                     break;
  //                                 }
  //                             }
  //                             ButtplugClientEvent::ServerDisconnect => {
  //                                 assert!(false, "Server disconnected!");
  //                                 break;
  //                             }
  //                             _ => info!("Got something else!"),
  //                         }
  //                     }
  //                     info!("Trying to get device again!");
  //                     let mut d = client.devices().await.unwrap();
  //                     if d.len() > 0 && d[0].allowed_messages.contains_key("VibrateCmd") {
  //                         assert!(d[0].vibrate(VibrateCommand::Speed(1.0)).await.is_ok());
  //                         info!("Should be vibrating!");
  //                         task::sleep(Duration::from_secs(1)).await;
  //                         assert!(d[0].stop().await.is_ok());
  //                         assert!(client.disconnect().await.is_ok());
  //                         task::sleep(Duration::from_secs(1)).await;
  //                     }
  //                 }
  //             }
  //         )
  //         .await
  //         .is_ok());
  //     })
  // }
}