summaryrefslogtreecommitdiff
path: root/src/plugins/rpc.rs
blob: 1195dfc615f851fbd2c165289112bf5d951951f6 (plain)
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
/*
 * meli - plugins
 *
 * Copyright 2019 Manos Pitsidianakis
 *
 * This file is part of meli.
 *
 * meli is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * meli is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with meli. If not, see <http://www.gnu.org/licenses/>.
 */

use super::*;

#[derive(Debug)]
pub struct RpcChannel {
    stream: UnixStream,
    session: Uuid,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct PluginGreeting {
    version: String,
}

impl RpcChannel {
    pub fn new(stream: UnixStream, session: &Uuid) -> Result<RpcChannel> {
        let mut ret = RpcChannel {
            stream,
            session: *session,
        };
        let greeting: PluginGreeting = ret.from_read().map_err(|err| {
            MeliError::new(format!("Could not get correct plugin greeting: {}", err))
        })?;
        debug!(&greeting);
        //if greeting.version != "dev" {
        //    return Err("Plugin is not compatible with our API (dev)".into());
        //}
        ret.write_ref(&rmpv::ValueRef::String(session.to_string().as_str().into()))?;
        debug!(ret.expect_ack())?;
        Ok(ret)
    }

    pub fn expect_ack(&mut self) -> Result<()> {
        debug!("expect_ack()");
        let ack: u32 = debug!(rmp_serde::decode::from_read(&mut self.stream))
            .map_err(|_| MeliError::new("Plugin did not return ACK."))?;
        if 0x6 == ack {
            Ok(())
        } else {
            Err(MeliError::new("Plugin did not return ACK."))
        }
    }

    pub fn ack(&mut self) -> Result<()> {
        debug!("ack()");
        debug!(rmpv::encode::write_value_ref(
            &mut self.stream,
            &rmpv::ValueRef::Integer(0x6.into())
        ))
        .map_err(|err| MeliError::new(err.to_string()))?;
        let _ = self.stream.flush();
        Ok(())
    }

    pub fn write_ref(&mut self, value_ref: &rmpv::ValueRef) -> Result<()> {
        debug!("write_ref() {:?}", value_ref);
        debug!(rmpv::encode::write_value_ref(&mut self.stream, value_ref))
            .map_err(|err| MeliError::new(err.to_string()))?;
        let _ = self.stream.flush();
        Ok(())
    }

    pub fn read(&mut self) -> Result<rmpv::Value> {
        debug!("read()");
        let ret: RpcResult = debug!(rmp_serde::decode::from_read(&mut self.stream))
            .map_err(|err| MeliError::new(err.to_string()))?;
        let _ = self.stream.flush();
        self.ack()?;
        debug!("read() ret={:?}", &ret);
        ret.into()
    }

    pub fn from_read<T>(&mut self) -> Result<T>
    where
        T: core::fmt::Debug + serde::de::DeserializeOwned,
    {
        debug!("from_read()");
        let ret: Result<T> = debug!(rmp_serde::decode::from_read(&mut self.stream))
            .map_err(|err| MeliError::new(err.to_string()));
        let _ = self.stream.flush();
        self.ack()?;
        debug!("read() ret={:?}", &ret);
        ret
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "t", content = "c")]
enum RpcResult {
    Ok(rmpv::Value),
    Err(String),
}

impl RpcResult {
    fn into(self) -> Result<rmpv::Value> {
        match self {
            RpcResult::Ok(v) => Ok(v),
            RpcResult::Err(err) => Err(MeliError::new(err)),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "t", content = "c")]
pub enum PluginResult<T: core::fmt::Debug + Clone> {
    Ok(T),
    Err(String),
}

impl<T: core::fmt::Debug + Clone + serde::Serialize + serde::de::DeserializeOwned> Into<Result<T>>
    for PluginResult<T>
{
    fn into(self) -> Result<T> {
        match self {
            PluginResult::Ok(v) => Ok(v),
            PluginResult::Err(err) => Err(MeliError::new(err)),
        }
    }
}