buttplug 0.0.2-beta.1

Buttplug Intimate Hardware Control Library
Documentation 
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

// Buttplug Rust Source Code File - See https://buttplug.io for more info.
//
// Copyright 2016-2019 Nonpolynomial Labs LLC. All rights reserved.
//
// Licensed under the BSD 3-Clause license. See LICENSE file in the project root
// for full license information.

//! Handles client sessions, as well as discovery and communication with hardware.

pub mod device_manager;

use crate::core::errors::*;
use crate::core::messages;
use crate::core::messages::ButtplugMessage;
use crate::core::messages::ButtplugMessageUnion;
use async_std::sync::Sender;

/// Represents a ButtplugServer.
pub struct ButtplugServer {
    server_name: String,
    server_spec_version: u32,
    client_spec_version: Option<u32>,
    client_name: Option<String>,
    max_ping_time: u32,
    _event_sender: Sender<ButtplugMessageUnion>,
}

impl ButtplugServer {
    pub fn new(
        name: &str,
        max_ping_time: u32,
        _event_sender: Sender<ButtplugMessageUnion>,
    ) -> Self {
        Self {
            server_name: name.to_string(),
            server_spec_version: 1,
            client_name: None,
            client_spec_version: None,
            max_ping_time,
            _event_sender,
        }
    }

    pub async fn send_message(
        &mut self,
        msg: &ButtplugMessageUnion,
    ) -> Result<ButtplugMessageUnion, ButtplugError> {
        match msg {
            ButtplugMessageUnion::RequestServerInfo(ref _s) => self.perform_handshake(_s),
            ButtplugMessageUnion::StartScanning(_) => self.start_scanning().await.map_or_else(
                || Result::Ok(ButtplugMessageUnion::Ok(messages::Ok::new(msg.get_id()))),
                Result::Err,
            ),
            ButtplugMessageUnion::StopScanning(_) => self.stop_scanning().await.map_or_else(
                || Result::Ok(ButtplugMessageUnion::Ok(messages::Ok::new(msg.get_id()))),
                Result::Err,
            ),
            _ => Result::Ok(ButtplugMessageUnion::Ok(messages::Ok::new(msg.get_id()))),
        }
    }

    fn perform_handshake(
        &mut self,
        msg: &messages::RequestServerInfo,
    ) -> Result<ButtplugMessageUnion, ButtplugError> {
        if self.server_spec_version < msg.message_version {
            return Result::Err(ButtplugError::ButtplugHandshakeError(
                ButtplugHandshakeError {
                    message: format!(
                        "Server version ({}) must be equal to or greater than client version ({}).",
                        self.server_spec_version, msg.message_version
                    ),
                },
            ));
        }
        self.client_name = Option::Some(msg.client_name.clone());
        self.client_spec_version = Option::Some(msg.message_version);
        Result::Ok(
            messages::ServerInfo::new(
                &self.server_name,
                self.server_spec_version,
                self.max_ping_time,
            )
            .as_union(),
        )
    }

    async fn start_scanning(&self) -> Option<ButtplugError> {
        None
    }

    async fn stop_scanning(&self) -> Option<ButtplugError> {
        None
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use async_std::{sync::channel, task};

    async fn test_server_setup(msg_union: &messages::ButtplugMessageUnion) -> ButtplugServer {
        let (send, _) = channel(256);
        let mut server = ButtplugServer::new("Test Server", 0, send);
        assert_eq!(server.server_name, "Test Server");
        match server.send_message(&msg_union).await.unwrap() {
            ButtplugMessageUnion::ServerInfo(_s) => {
                assert_eq!(_s, messages::ServerInfo::new("Test Server", 1, 0))
            }
            _ => assert!(false, "Should've received ok"),
        }
        server
    }

    #[test]
    fn test_server_handshake() {
        let msg = messages::RequestServerInfo::new("Test Client", 1);
        let msg_union = ButtplugMessageUnion::RequestServerInfo(msg);
        task::block_on(async {
            let server = test_server_setup(&msg_union).await;
            assert_eq!(server.client_name.unwrap(), "Test Client");
        });
    }

    #[test]
    fn test_server_version_lt() {
        let msg = messages::RequestServerInfo::new("Test Client", 0);
        let msg_union = ButtplugMessageUnion::RequestServerInfo(msg);
        task::block_on(async {
            test_server_setup(&msg_union).await;
        });
    }

    #[test]
    fn test_server_version_gt() {
        let (send, _) = channel(256);
        let mut server = ButtplugServer::new("Test Server", 0, send);
        let msg = messages::RequestServerInfo::new("Test Client", server.server_spec_version + 1);
        let msg_union = ButtplugMessageUnion::RequestServerInfo(msg);
        task::block_on(async {
            assert!(
                server.send_message(&msg_union).await.is_err(),
                "Client having higher version than server should fail"
            );
        });
    }
}